@pondpilot/flowscope-core

The TypeScript client library for FlowScope.

Overview

This package provides the high-level API for interacting with the FlowScope WebAssembly engine. It handles loading the WASM module and provides typed interfaces for analysis requests and results.

Installation

npm install @pondpilot/flowscope-core

Usage

import { initWasm, analyzeSql } from '@pondpilot/flowscope-core';

await initWasm({ wasmUrl: '/wasm/flowscope_wasm_bg.wasm' });

const result = await analyzeSql({
  sql: 'SELECT * FROM users',
  dialect: 'duckdb'
});

Lint Diagnostics

Enable linting via the options.lint field. Lint issues appear in result.issues with codes prefixed by LINT_:

const result = await analyzeSql({
  sql: 'SELECT * FROM users',
  dialect: 'postgres',
  options: { lint: { enabled: true } },
});

const lintIssues = result.issues.filter(i => i.code.startsWith('LINT_'));

See the root README for more details.