@lovable.dev/lovsem-compiler 0.0.0 → 0.1.1

package/README.md

@@ -1 +1,25 @@
-Package registration only. The functional release is published through publish-lovsem.yml using npm trusted publishing.
+# @lovable.dev/lovsem-compiler
+
+Compiles a query against a stitched semantic model to SQL, in the browser or on
+a server. The compiler is `crates/lovsem-wasm` built as WebAssembly; the
+model comes from `@lovable.dev/lovsem`.
+
+```ts
+import { SemanticCompiler, init } from "@lovable.dev/lovsem-compiler";
+
+await init(); // in a Vite app; on a server, initSync(bytes of wasm/lovsem_wasm_bg.wasm)
+const compiler = new SemanticCompiler(repo.buildSemanticModel("sales").document);
+const sql = compiler.sql({ group_by: ["metric_time__month"], metrics: ["revenue"] }, "bigquery");
+```
+
+| Export | What it does |
+| --- | --- |
+| `init(module?)` | Loads the module; without an argument it fetches the copy the bundler emitted, which in `vite dev` needs the package kept out of `optimizeDeps` (the `semantics()` plugin does this) |
+| `initSync(bytes)` | Loads it from bytes already read |
+| `SemanticCompiler` | Compiles a model once; `sql(query, dialect)` returns SQL for `ansi` or `bigquery` |
+| `SemanticsCompileError` | Thrown with every problem found, in `problems` |
+| `SemanticQuery` and its parts | Generated from `crates/ossie-compiler` by ts-rs |
+
+`wasm/` is committed build output. After changing a crate the compiler uses,
+rebuild it with `./build-wasm.sh`, which needs `wasm-pack`, the
+`wasm32-unknown-unknown` target and binaryen's `wasm-opt` on `PATH`.

package/dist/index.d.ts

@@ -0,0 +1,130 @@
+import { InitInput } from "../wasm/lovsem_wasm.js";
+import { OssieDocument } from "@lovable.dev/lovsem";
+//#region src/generated/Direction.d.ts
+type Direction = "asc" | "desc";
+//#endregion
+//#region src/generated/FilterOperator.d.ts
+/**
+ * Comparison used by a [`FilterSpec`].
+ *
+ * Deserialized from the query JSON, so an unrecognized spelling fails there
+ * rather than silently degrading to equality. Symbol aliases are accepted for
+ * the operators that have a conventional one.
+ */
+type FilterOperator = "eq" | "ne" | "lt" | "lte" | "gt" | "gte" | "in" | "not_in" | "is_null" | "is_not_null" | "eq_field";
+//#endregion
+//#region src/generated/serde_json/JsonValue.d.ts
+type JsonValue = number | string | boolean | Array<JsonValue> | { [key in string]: JsonValue; } | null;
+//#endregion
+//#region src/generated/FilterSpec.d.ts
+/**
+ * Predicate on a field (`dataset.field`).
+ */
+type FilterSpec = {
+  /**
+   * `dataset.field`
+   */
+  field: string;
+  /**
+   * Omitted means [`FilterOperator::In`] when `value` is a JSON array and
+   * [`FilterOperator::Eq`] otherwise.
+   */
+  operator?: FilterOperator | null;
+  /**
+   * Omitted is `null`, which is what the null-checking operators expect.
+   */
+  value?: JsonValue;
+};
+//#endregion
+//#region src/generated/NullOrder.d.ts
+/**
+ * Engines disagree on where nulls sort by default, and Substrait makes the
+ * choice part of the sort direction, so it is stated rather than assumed.
+ */
+type NullOrder = "first" | "last";
+//#endregion
+//#region src/generated/OrderBy.d.ts
+/**
+ * One ordering term.
+ */
+type OrderBy = {
+  /**
+   * Something the query selects: a grouped `dataset.field` (or its bare
+   * field name) or a metric name. Not an arbitrary expression — you order
+   * by what you asked for.
+   */
+  ref: string;
+  direction?: Direction;
+  /**
+   * Where nulls sort. Omitted means they sort as greater than non-nulls:
+   * last when ascending, first when descending.
+   */
+  nulls?: NullOrder | null;
+};
+//#endregion
+//#region src/generated/SemanticQuery.d.ts
+/**
+ * Query body: `GROUP BY` fields, metrics, filters. Model identity is provided separately to [`crate::resolver::bind_query`].
+ */
+type SemanticQuery = {
+  /**
+   * Field references (`dataset.field`) for `GROUP BY`.
+   */
+  group_by?: Array<string>;
+  /**
+   * Metric names defined on the semantic model.
+   */
+  metrics?: Array<string>;
+  filters?: Array<FilterSpec>;
+  /**
+   * When no field references appear in `group_by` or filters, selects the scan target for metrics-only queries.
+   */
+  dataset?: string;
+  /**
+   * Ordering, applied to what the query selects.
+   */
+  order_by?: Array<OrderBy>;
+  /**
+   * Maximum rows to return. Omitted means all of them.
+   */
+  limit?: number;
+  /**
+   * Rows to skip before the first returned row.
+   */
+  offset?: number;
+};
+//#endregion
+//#region src/index.d.ts
+type Dialect = "ansi" | "bigquery";
+/** Every problem the compiler found with a document or a query. */
+declare class SemanticsCompileError extends Error {
+  readonly problems: string[];
+  constructor(problems: string[]);
+}
+/**
+ * Load the compiler before the first {@link SemanticCompiler}.
+ *
+ * In a browser bundled by Vite, call it without arguments: the module ships
+ * in this package and is fetched from where the bundler put it. Elsewhere pass
+ * its bytes, its URL or a compiled `WebAssembly.Module`.
+ */
+declare function init(module?: InitInput | Promise<InitInput>): Promise<void>;
+/** {@link init} from bytes already in hand, as a server reading `wasm/lovsem_wasm_bg.wasm` has. */
+declare function initSync(module: BufferSource | WebAssembly.Module): void;
+/**
+ * A stitched semantic model compiled once, to compile many queries against.
+ *
+ * Its memory is released when it is garbage collected; `free()`, or a `using`
+ * declaration, releases it sooner.
+ */
+declare class SemanticCompiler {
+  #private;
+  /** `document` is a stitched model, as `SemanticRepo.buildSemanticModel` returns it. */
+  constructor(document: OssieDocument);
+  /** The SQL that answers `query`. */
+  sql(query: SemanticQuery, dialect?: Dialect): string;
+  free(): void;
+  [Symbol.dispose](): void;
+}
+//#endregion
+export { Dialect, type Direction, type FilterOperator, type FilterSpec, type JsonValue, type NullOrder, type OrderBy, SemanticCompiler, type SemanticQuery, SemanticsCompileError, init, initSync };

package/dist/index.js

@@ -0,0 +1,71 @@
+import initWasm, { Compiler, initSync as initSync$1 } from "../wasm/lovsem_wasm.js";
+//#region src/index.ts
+/** Every problem the compiler found with a document or a query. */
+var SemanticsCompileError = class extends Error {
+	problems;
+	constructor(problems) {
+		super(problems.join("\n"));
+		this.name = "SemanticsCompileError";
+		this.problems = problems;
+	}
+};
+let loaded = false;
+/**
+* Load the compiler before the first {@link SemanticCompiler}.
+*
+* In a browser bundled by Vite, call it without arguments: the module ships
+* in this package and is fetched from where the bundler put it. Elsewhere pass
+* its bytes, its URL or a compiled `WebAssembly.Module`.
+*/
+async function init(module) {
+	await initWasm(module === void 0 ? void 0 : { module_or_path: module });
+	loaded = true;
+}
+/** {@link init} from bytes already in hand, as a server reading `wasm/lovsem_wasm_bg.wasm` has. */
+function initSync(module) {
+	initSync$1({ module });
+	loaded = true;
+}
+/**
+* A stitched semantic model compiled once, to compile many queries against.
+*
+* Its memory is released when it is garbage collected; `free()`, or a `using`
+* declaration, releases it sooner.
+*/
+var SemanticCompiler = class {
+	#compiler;
+	/** `document` is a stitched model, as `SemanticRepo.buildSemanticModel` returns it. */
+	constructor(document) {
+		if (!loaded) throw new Error("call init() or initSync() before compiling");
+		this.#compiler = unpack(() => new Compiler(JSON.stringify(document)));
+	}
+	/** The SQL that answers `query`. */
+	sql(query, dialect = "ansi") {
+		return unpack(() => this.#compiler.sql(JSON.stringify(query), dialect));
+	}
+	free() {
+		this.#compiler.free();
+	}
+	[Symbol.dispose]() {
+		this.free();
+	}
+};
+/** The compiler throws its problems as a JSON array in the error's message. */
+function unpack(run) {
+	try {
+		return run();
+	} catch (error) {
+		const problems = error instanceof Error ? problemsOf(error.message) : void 0;
+		throw problems ? new SemanticsCompileError(problems) : error;
+	}
+}
+function problemsOf(message) {
+	try {
+		const parsed = JSON.parse(message);
+		return Array.isArray(parsed) && parsed.every((p) => typeof p === "string") ? parsed : void 0;
+	} catch {
+		return;
+	}
+}
+//#endregion
+export { SemanticCompiler, SemanticsCompileError, init, initSync };

package/package.json

@@ -1,11 +1,42 @@
 {
   "name": "@lovable.dev/lovsem-compiler",
-  "version": "0.0.0",
-  "description": "Package registration for the initial OIDC-published release.",
+  "version": "0.1.1",
+  "description": "Compile queries against a Lovable project's semantic layer to SQL, in the browser or on a server, with the Rust compiler built as WebAssembly.",
+  "type": "module",
+  "sideEffects": false,
   "license": "Apache-2.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/lovablelabs/lovable.git",
     "directory": "data/lovsem/packages/lovsem-compiler"
-  }
-}
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./wasm/*": "./wasm/*"
+  },
+  "files": [
+    "dist",
+    "wasm"
+  ],
+  "dependencies": {
+    "@lovable.dev/lovsem": "0.1.0"
+  },
+  "devDependencies": {
+    "@types/node": "22.13.13",
+    "tsdown": "^0.22.5",
+    "typescript": "7.0.2",
+    "vite": "8.2.1",
+    "vitest": "^4.1.5"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "build:wasm": "./build-wasm.sh",
+    "test": "vitest run",
+    "typecheck": "tsc -p tsconfig.json",
+    "check:package": "tmp=$(mktemp -d) && pnpm pack --out \"$tmp/pkg.tgz\" && tar -xzf \"$tmp/pkg.tgz\" -C \"$tmp\" && publint \"$tmp/package\" --strict && attw \"$tmp/pkg.tgz\""
+  },
+  "types": "./dist/index.d.ts"
+}

package/wasm/lovsem_wasm.d.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * A semantic model compiled once, for compiling many queries against.
+ */
+export class Compiler {
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Compile `document`, a stitched Ossie document as JSON.
+     */
+    constructor(document: string);
+    /**
+     * The SQL for `query`, a `SemanticQuery` as JSON, in `dialect`
+     * (`ansi` or `bigquery`).
+     */
+    sql(query: string, dialect: string): string;
+}
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly __wbg_compiler_free: (a: number, b: number) => void;
+    readonly compiler_new: (a: number, b: number) => [number, number, number];
+    readonly compiler_sql: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __externref_table_dealloc: (a: number) => void;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;

package/wasm/lovsem_wasm.js

@@ -0,0 +1,287 @@
+/* @ts-self-types="./lovsem_wasm.d.ts" */
+
+/**
+ * A semantic model compiled once, for compiling many queries against.
+ */
+export class Compiler {
+    __destroy_into_raw() {
+        const ptr = this.__wbg_ptr;
+        this.__wbg_ptr = 0;
+        CompilerFinalization.unregister(this);
+        return ptr;
+    }
+    free() {
+        const ptr = this.__destroy_into_raw();
+        wasm.__wbg_compiler_free(ptr, 0);
+    }
+    /**
+     * Compile `document`, a stitched Ossie document as JSON.
+     * @param {string} document
+     */
+    constructor(document) {
+        const ptr0 = passStringToWasm0(document, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+        const len0 = WASM_VECTOR_LEN;
+        const ret = wasm.compiler_new(ptr0, len0);
+        if (ret[2]) {
+            throw takeFromExternrefTable0(ret[1]);
+        }
+        this.__wbg_ptr = ret[0];
+        CompilerFinalization.register(this, this.__wbg_ptr, this);
+        return this;
+    }
+    /**
+     * The SQL for `query`, a `SemanticQuery` as JSON, in `dialect`
+     * (`ansi` or `bigquery`).
+     * @param {string} query
+     * @param {string} dialect
+     * @returns {string}
+     */
+    sql(query, dialect) {
+        let deferred4_0;
+        let deferred4_1;
+        try {
+            let ptr0, len0, ptr1, len1;
+            try {
+                ptr0 = passStringToWasm0(query, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+                len0 = WASM_VECTOR_LEN;
+                ptr1 = passStringToWasm0(dialect, wasm.__wbindgen_malloc, wasm.__wbindgen_realloc);
+                len1 = WASM_VECTOR_LEN;
+            } catch (e) {
+                if (ptr1) { wasm.__wbindgen_free(ptr1, len1 * 1, 1); }
+                if (ptr0) { wasm.__wbindgen_free(ptr0, len0 * 1, 1); }
+                throw e;
+            }
+            const ret = wasm.compiler_sql(this.__wbg_ptr, ptr0, len0, ptr1, len1);
+            var ptr3 = ret[0];
+            var len3 = ret[1];
+            if (ret[3]) {
+                ptr3 = 0; len3 = 0;
+                throw takeFromExternrefTable0(ret[2]);
+            }
+            deferred4_0 = ptr3;
+            deferred4_1 = len3;
+            return getStringFromWasm0(ptr3, len3);
+        } finally {
+            wasm.__wbindgen_free(deferred4_0, deferred4_1, 1);
+        }
+    }
+}
+if (Symbol.dispose) Compiler.prototype[Symbol.dispose] = Compiler.prototype.free;
+function __wbg_get_imports() {
+    const import0 = {
+        __proto__: null,
+        __wbg_Error_208446807d0d1e30: function(arg0, arg1) {
+            const ret = Error(getStringFromWasm0(arg0, arg1));
+            return ret;
+        },
+        __wbg___wbindgen_throw_4c88d8bf264fd984: function(arg0, arg1) {
+            throw new Error(getStringFromWasm0(arg0, arg1));
+        },
+        __wbindgen_init_externref_table: function() {
+            const table = wasm.__wbindgen_externrefs;
+            table.set(0, undefined);
+            table.set(1024, undefined);
+            table.set(1025, null);
+            table.set(1026, true);
+            table.set(1027, false);
+        },
+    };
+    return {
+        __proto__: null,
+        "./lovsem_wasm_bg.js": import0,
+    };
+}
+
+const CompilerFinalization = (typeof FinalizationRegistry === 'undefined')
+    ? { register: () => {}, unregister: () => {} }
+    : new FinalizationRegistry(ptr => wasm.__wbg_compiler_free(ptr, 1));
+
+function getStringFromWasm0(ptr, len) {
+    ptr = ptr >>> 0;
+    return decodeText(getUint8ArrayMemory0().subarray(ptr, ptr + len));
+}
+
+let cachedUint8ArrayMemory0 = null;
+function getUint8ArrayMemory0() {
+    if (cachedUint8ArrayMemory0 === null || cachedUint8ArrayMemory0.byteLength === 0) {
+        cachedUint8ArrayMemory0 = new Uint8Array(wasm.memory.buffer);
+    }
+    return cachedUint8ArrayMemory0;
+}
+
+function passStringToWasm0(arg, malloc, realloc) {
+    if (realloc === undefined) {
+        const buf = cachedTextEncoder.encode(arg);
+        const ptr = malloc(buf.length, 1) >>> 0;
+        getUint8ArrayMemory0().subarray(ptr, ptr + buf.length).set(buf);
+        WASM_VECTOR_LEN = buf.length;
+        return ptr;
+    }
+
+    let len = arg.length;
+    let ptr = malloc(len, 1) >>> 0;
+
+    const mem = getUint8ArrayMemory0();
+
+    let offset = 0;
+
+    for (; offset < len; offset++) {
+        const code = arg.charCodeAt(offset);
+        if (code > 0x7F) break;
+        mem[ptr + offset] = code;
+    }
+    if (offset !== len) {
+        if (offset !== 0) {
+            arg = arg.slice(offset);
+        }
+        ptr = realloc(ptr, len, len = offset + arg.length * 3, 1) >>> 0;
+        const view = getUint8ArrayMemory0().subarray(ptr + offset, ptr + len);
+        const ret = cachedTextEncoder.encodeInto(arg, view);
+
+        offset += ret.written;
+        ptr = realloc(ptr, len, offset, 1) >>> 0;
+    }
+
+    WASM_VECTOR_LEN = offset;
+    return ptr;
+}
+
+function takeFromExternrefTable0(idx) {
+    const value = wasm.__wbindgen_externrefs.get(idx);
+    wasm.__externref_table_dealloc(idx);
+    return value;
+}
+
+let cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true });
+cachedTextDecoder.decode();
+const MAX_SAFARI_DECODE_BYTES = 2146435072;
+let numBytesDecoded = 0;
+function decodeText(bytes) {
+    numBytesDecoded += bytes.length;
+    if (numBytesDecoded >= MAX_SAFARI_DECODE_BYTES) {
+        cachedTextDecoder = new TextDecoder('utf-8', { ignoreBOM: true });
+        cachedTextDecoder.decode();
+        numBytesDecoded = bytes.length;
+    }
+    return cachedTextDecoder.decode(bytes);
+}
+
+const cachedTextEncoder = new TextEncoder();
+
+if (!('encodeInto' in cachedTextEncoder)) {
+    cachedTextEncoder.encodeInto = function (arg, view) {
+        const buf = cachedTextEncoder.encode(arg);
+        view.set(buf);
+        return {
+            read: arg.length,
+            written: buf.length
+        };
+    };
+}
+
+let WASM_VECTOR_LEN = 0;
+
+let wasmModule, wasmInstance, wasm;
+function __wbg_finalize_init(instance, module) {
+    wasmInstance = instance;
+    wasm = instance.exports;
+    wasmModule = module;
+    cachedUint8ArrayMemory0 = null;
+    wasm.__wbindgen_start();
+    return wasm;
+}
+
+async function __wbg_load(module, imports) {
+    if (typeof Response === 'function' && module instanceof Response) {
+        if (!module.ok) {
+            throw new Error(`failed to fetch Wasm: ${module.status} ${module.statusText} fetching '${module.url}'`);
+        }
+
+        if (typeof WebAssembly.instantiateStreaming === 'function') {
+            try {
+                return await WebAssembly.instantiateStreaming(module, imports);
+            } catch (e) {
+                const validResponse = expectedResponseType(module.type);
+
+                if (validResponse && module.headers.get('Content-Type') !== 'application/wasm') {
+                    console.warn("`WebAssembly.instantiateStreaming` failed because your server does not serve Wasm with `application/wasm` MIME type. Falling back to `WebAssembly.instantiate` which is slower. Original error:\n", e);
+
+                } else { throw e; }
+            }
+        }
+
+        const bytes = await module.arrayBuffer();
+        return await WebAssembly.instantiate(bytes, imports);
+    } else {
+        const instance = await WebAssembly.instantiate(module, imports);
+
+        if (instance instanceof WebAssembly.Instance) {
+            return { instance, module };
+        } else {
+            return instance;
+        }
+    }
+
+    function expectedResponseType(type) {
+        switch (type) {
+            case 'basic': case 'cors': case 'default': return true;
+        }
+        return false;
+    }
+}
+
+function initSync(module) {
+    if (wasm !== undefined) return wasm;
+
+
+    if (module !== undefined) {
+        if (Object.getPrototypeOf(module) === Object.prototype) {
+            ({module} = module)
+        } else {
+            console.warn('using deprecated parameters for `initSync()`; pass a single object instead')
+        }
+    }
+
+    const imports = __wbg_get_imports();
+    if (!(module instanceof WebAssembly.Module)) {
+        module = new WebAssembly.Module(module);
+    }
+    const instance = new WebAssembly.Instance(module, imports);
+    return __wbg_finalize_init(instance, module);
+}
+
+let __wbg_init_promise;
+async function __wbg_init(module_or_path) {
+    if (wasm !== undefined) return wasm;
+    if (__wbg_init_promise === undefined) {
+        __wbg_init_promise = __wbg_init_once(module_or_path);
+        __wbg_init_promise.catch(() => { __wbg_init_promise = undefined; });
+    }
+    return __wbg_init_promise;
+}
+
+async function __wbg_init_once(module_or_path) {
+
+    if (module_or_path !== undefined) {
+        if (Object.getPrototypeOf(module_or_path) === Object.prototype) {
+            ({module_or_path} = module_or_path)
+        } else {
+            console.warn('using deprecated parameters for the initialization function; pass a single object instead')
+        }
+    }
+
+    if (module_or_path === undefined) {
+        module_or_path = new URL('lovsem_wasm_bg.wasm', import.meta.url);
+    }
+    const imports = __wbg_get_imports();
+
+    if (typeof module_or_path === 'string' || (typeof Request === 'function' && module_or_path instanceof Request) || (typeof URL === 'function' && module_or_path instanceof URL)) {
+        module_or_path = fetch(module_or_path);
+    }
+
+    const { instance, module } = await __wbg_load(await module_or_path, imports);
+
+    return __wbg_finalize_init(instance, module);
+}
+
+export { initSync, __wbg_init as default };

package/wasm/lovsem_wasm_bg.wasm.d.ts

@@ -0,0 +1,12 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const __wbg_compiler_free: (a: number, b: number) => void;
+export const compiler_new: (a: number, b: number) => [number, number, number];
+export const compiler_sql: (a: number, b: number, c: number, d: number, e: number) => [number, number, number, number];
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __externref_table_dealloc: (a: number) => void;
+export const __wbindgen_start: () => void;