@yydb/yydb 0.0.0 → 0.0.2

package/README.md

@@ -1,4 +1,90 @@
-# @yydb/yydb
+# `@yydb/yydb`
 
-Placeholder 0.0.0 for npm Trusted Publisher bootstrap.
-Real releases replace this from CI (`release-npm.yml`).
+**All-in-one YYDB for Node.js: CLI, embedded engine, and local `serve`.**
+
+Open a `.yydb` file with one dependency — `@yydb/yydb` spawns a private loopback server and talks to it over the YY
+wire protocol. For a **lightweight client only** (browser, renderer, or an app that already runs `yydb serve`), use
+[`@yydb/yydb-client`](../yydb-client).
+
+[![npm](https://img.shields.io/npm/v/@yydb/yydb)](https://www.npmjs.com/package/@yydb/yydb)
+[![Node.js](https://img.shields.io/node/v/@yydb/yydb)](https://www.npmjs.com/package/@yydb/yydb)
+[![Check Rust](https://github.com/yy-database/yydb/actions/workflows/check-rust.yml/badge.svg?branch=dev)](https://github.com/yy-database/yydb/actions/workflows/check-rust.yml)
+[![Check TypeScript](https://github.com/yy-database/yydb/actions/workflows/check-typescript.yml/badge.svg?branch=dev)](https://github.com/yy-database/yydb/actions/workflows/check-typescript.yml)
+
+## Install
+
+```bash
+npm install @yydb/yydb
+```
+
+Node.js 18 or newer is supported. The matching `yydb-napi` binding is installed as an optional platform dependency and
+is
+started on a private loopback endpoint when `Database.open()` runs.
+
+## Example
+
+```ts
+import {Database} from "@yydb/yydb";
+
+const db = await Database.open("./data/app.yydb");
+
+await db.ensureSchema(
+    1,
+    `table Setting {
+        @@id: uuid,
+        key: utf8,
+        value: utf8,
+    }`,
+);
+
+await db.put("theme", "dark");
+const value = await db.get("theme");
+console.log(value && new TextDecoder().decode(value));
+
+await db.close();
+```
+
+The database file is created if it does not exist. The VOS schema and its version are stored with the data, so reopening
+the file does not depend on a separate schema registry.
+
+## API
+
+```ts
+const db = await Database.open(path, options ?);
+
+await db.ensureSchema(version, vosDocument);
+await db.getSchema();
+await db.put(key, stringOrBytes);
+await db.get(key);
+await db.info();
+await db.serverVersion();
+await db.close();
+```
+
+`OpenOptions` supports `cli` (an explicit CLI script path), `port` (a preferred loopback port), and `serveArgs` (extra
+arguments forwarded to `yydb serve`). `binary` is a deprecated alias for `cli`.
+
+## Use a different package when
+
+| Need                                   | Package                                   |
+|----------------------------------------|-------------------------------------------|
+| Node all-in-one (CLI + engine + serve) | **`@yydb/yydb`** (this package)           |
+| Lightweight wire client only           | [`@yydb/yydb-client`](../yydb-client)     |
+| In-process Rust embed                  | [`yydb`](https://crates.io/crates/yydb)   |
+| Rust wire server crate (used by N-API) | [`yydb-server`](../../crates/yydb-server) |
+| Rust remote client                     | [`yydb-client`](../../crates/yydb-client) |
+
+For Electron, the main process can use `@yydb/yydb`; renderer code can use
+`@yydb/yydb-client` against the main process endpoint.
+
+## Security
+
+The managed engine listens on `127.0.0.1` and has no authentication layer. Keep the endpoint private and use the
+operating system's file permissions for the `.yydb` file.
+
+## Links
+
+- [YYDB overview](https://github.com/yy-database/yydb.rs)
+- [User guides](https://github.com/yy-database/yydb.rs/tree/dev/projects/packages/homepage/documentation/zh-hans)
+- [API documentation](https://docs.rs/yydb)
+- [License](https://github.com/yy-database/yydb.rs/blob/dev/License.md)

package/dist/cli/cli.d.ts

@@ -0,0 +1 @@
+export declare function runCli(argv: string[]): Promise<number>;

package/dist/cli/cli.js

@@ -0,0 +1,27 @@
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { createCli } from '@vmz/commander';
+import { registerGenerateCommand } from './generate-cmd.js';
+import { registerInfoCommand } from './info-cmd.js';
+import { registerInitCommand } from './init-cmd.js';
+import { registerServeCommand } from './serve-cmd.js';
+import { registerVersionCommand } from './version-cmd.js';
+function buildYydbCli() {
+    const localesRoot = join(dirname(fileURLToPath(import.meta.url)), '../../locales');
+    const cli = createCli('yydb').locales(localesRoot).intro('cli.intro');
+    registerVersionCommand(cli);
+    registerInitCommand(cli);
+    registerInfoCommand(cli);
+    registerServeCommand(cli);
+    registerGenerateCommand(cli);
+    return cli;
+}
+export async function runCli(argv) {
+    try {
+        return await buildYydbCli().parse(argv);
+    }
+    catch (error) {
+        console.error(`error: ${error instanceof Error ? error.message : String(error)}`);
+        return 1;
+    }
+}

package/dist/cli/generate-cmd.d.ts

@@ -0,0 +1,3 @@
+import type { Cli, ParsedOptions } from '@vmz/commander';
+export declare function registerGenerateCommand(cli: Cli): void;
+export declare function cmdGenerate(options: ParsedOptions): number;

package/dist/cli/generate-cmd.js

@@ -0,0 +1,25 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { generateTypeScript } from '../generator/index.js';
+import { requiredPositional, str } from './options.js';
+export function registerGenerateCommand(cli) {
+    cli.command('generate', 'cli.cmd.generate')
+        .option('-o, --output <path>', 'cli.opt.output')
+        .option('--schema-version <n>', 'cli.opt.schema-version')
+        .action((options) => cmdGenerate(options));
+}
+export function cmdGenerate(options) {
+    const input = requiredPositional(options, 'generate');
+    const output = str(options, 'output');
+    if (!output) {
+        throw new Error('generate requires --output <path>');
+    }
+    const schemaVersion = Number.parseInt(str(options, 'schema-version') ?? '1', 10);
+    const source = fs.readFileSync(input, 'utf8');
+    const ts = generateTypeScript(source, schemaVersion);
+    const outPath = path.resolve(output);
+    fs.mkdirSync(path.dirname(outPath), { recursive: true });
+    fs.writeFileSync(outPath, ts);
+    console.log(`wrote ${outPath}`);
+    return 0;
+}

package/dist/cli/info-cmd.d.ts

@@ -0,0 +1,3 @@
+import type { Cli, ParsedOptions } from '@vmz/commander';
+export declare function registerInfoCommand(cli: Cli): void;
+export declare function cmdInfo(options: ParsedOptions): number;

package/dist/cli/info-cmd.js

@@ -0,0 +1,10 @@
+import { loadNative } from '../native.js';
+import { requiredPositional } from './options.js';
+export function registerInfoCommand(cli) {
+    cli.command('info', 'cli.cmd.info').action((options) => cmdInfo(options));
+}
+export function cmdInfo(options) {
+    const dbPath = requiredPositional(options, 'info');
+    console.log(loadNative().infoText(dbPath));
+    return 0;
+}

package/dist/cli/init-cmd.d.ts

@@ -0,0 +1,3 @@
+import type { Cli, ParsedOptions } from '@vmz/commander';
+export declare function registerInitCommand(cli: Cli): void;
+export declare function cmdInit(options: ParsedOptions): number;

package/dist/cli/init-cmd.js

@@ -0,0 +1,18 @@
+import { loadNative } from '../native.js';
+import { requiredPositional, str } from './options.js';
+export function registerInitCommand(cli) {
+    cli.command('init', 'cli.cmd.init')
+        .option('--schema-version <n>', 'cli.opt.schema-version')
+        .option('--schema-file <path>', 'cli.opt.schema-file')
+        .action((options) => cmdInit(options));
+}
+export function cmdInit(options) {
+    const dbPath = requiredPositional(options, 'init');
+    const schemaVersion = Number.parseInt(str(options, 'schema-version') ?? '1', 10);
+    const schemaFile = str(options, 'schema-file');
+    const native = loadNative();
+    const schemaDocument = schemaFile ? native.readSchemaFile(schemaFile) : null;
+    native.initDb(dbPath, schemaVersion, schemaDocument);
+    console.log(`initialized ${dbPath}`);
+    return 0;
+}

package/dist/cli/options.d.ts

@@ -0,0 +1,4 @@
+import type { ParsedOptions } from '@vmz/commander';
+export declare function str(options: ParsedOptions, key: string): string | undefined;
+export declare function flag(options: ParsedOptions, key: string): boolean;
+export declare function requiredPositional(options: ParsedOptions, label: string): string;

package/dist/cli/options.js

@@ -0,0 +1,14 @@
+export function str(options, key) {
+    const value = options[key];
+    return typeof value === 'string' && value.length > 0 ? value : undefined;
+}
+export function flag(options, key) {
+    return options[key] === true;
+}
+export function requiredPositional(options, label) {
+    const value = options._[0];
+    if (!value) {
+        throw new Error(`${label} requires a path argument`);
+    }
+    return value;
+}

package/dist/cli/serve-cmd.d.ts

@@ -0,0 +1,3 @@
+import type { Cli, ParsedOptions } from '@vmz/commander';
+export declare function registerServeCommand(cli: Cli): void;
+export declare function cmdServe(options: ParsedOptions): number;

package/dist/cli/serve-cmd.js

@@ -0,0 +1,14 @@
+import { loadNative } from '../native.js';
+import { flag, requiredPositional, str } from './options.js';
+export function registerServeCommand(cli) {
+    cli.command('serve', 'cli.cmd.serve')
+        .option('--bind <host:port>', 'cli.opt.bind')
+        .option('--insecure-bind', 'cli.opt.insecure-bind')
+        .action((options) => cmdServe(options));
+}
+export function cmdServe(options) {
+    const dbPath = requiredPositional(options, 'serve');
+    const bind = str(options, 'bind') ?? '127.0.0.1:7700';
+    loadNative().serve(dbPath, bind, flag(options, 'insecure-bind'));
+    return 0;
+}

package/dist/cli/version-cmd.d.ts

@@ -0,0 +1,3 @@
+import type { Cli } from '@vmz/commander';
+export declare function registerVersionCommand(cli: Cli): void;
+export declare function cmdVersion(): number;

package/dist/cli/version-cmd.js

@@ -0,0 +1,8 @@
+import { loadNative } from '../native.js';
+export function registerVersionCommand(cli) {
+    cli.command('version', 'cli.cmd.version').action(() => cmdVersion());
+}
+export function cmdVersion() {
+    console.log(loadNative().version());
+    return 0;
+}

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/cli.js

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+import { runCli } from './cli/cli.js';
+const code = await runCli(process.argv);
+if (code !== 0) {
+    process.exitCode = code;
+}

package/dist/database.d.ts

@@ -0,0 +1,50 @@
+import { defineMicro as buildMicro, type DefinedMicro, type MicroHandle } from './micro.js';
+import type { UdfTypeDescriptor } from './udf-types.js';
+export type { SchemaVersion } from '@yydb/yydb-client';
+export interface OpenOptions {
+    /** Override CLI script path (tests / special installs). */
+    cli?: string;
+    /** @deprecated Use `cli`. */
+    binary?: string;
+    /** Prefer a specific loopback port; default = ephemeral free port. */
+    port?: number;
+    /** Extra args after `serve <path> --bind …`. */
+    serveArgs?: string[];
+}
+/**
+ * Node-facing YYDB handle. Looks like one library; owns a private loopback
+ * `yydb serve` child under the hood.
+ */
+export declare class Database {
+    readonly path: string;
+    readonly endpoint: string;
+    private client;
+    private child;
+    private readonly microRegistry;
+    private constructor();
+    /**
+     * Open (create) a `.yydb` file. Spawns the engine on `127.0.0.1` automatically.
+     */
+    static open(dbPath: string, options?: OpenOptions): Promise<Database>;
+    serverVersion(): Promise<string>;
+    info(): Promise<string>;
+    getSchema(): Promise<import("@yydb/yydb-client").SchemaVersion | null>;
+    ensureSchema(version: number, document: string): Promise<void>;
+    get(key: string): Promise<Uint8Array | null>;
+    put(key: string, value: Uint8Array | string): Promise<void>;
+    /**
+     * Build a typed session-local micro definition. Does not register it with
+     * the engine until [`registerMicro`](./database.ts) is called.
+     */
+    defineMicro<TArgs extends readonly UdfTypeDescriptor[], TReturn extends UdfTypeDescriptor>(definition: Parameters<typeof buildMicro<TArgs, TReturn>>[0]): DefinedMicro<TArgs, TReturn>;
+    /**
+     * Install a [`defineMicro`](./database.ts) definition into the current
+     * session registry and sync metadata to the private engine. Host micros are
+     * session-local and never written to `.yydb`.
+     */
+    registerMicro<TArgs extends readonly UdfTypeDescriptor[], TReturn extends UdfTypeDescriptor>(definition: DefinedMicro<TArgs, TReturn>): Promise<MicroHandle>;
+    /** Invoke a registered scalar UDF on the private engine. */
+    callScalar(name: string, version: number, args: readonly (string | number | boolean | null)[]): Promise<string | number | boolean | null>;
+    /** Stop the private engine process. */
+    close(): Promise<void>;
+}

package/dist/database.js

@@ -0,0 +1,181 @@
+import { spawn } from 'node:child_process';
+import fs from 'node:fs';
+import net from 'node:net';
+import path from 'node:path';
+import { connect } from '@yydb/yydb-client/node';
+import { defineMicro as buildMicro, MicroSessionRegistry } from './micro.js';
+import { resolveYydbCli } from './resolve-bin.js';
+function microFingerprint(name, version) {
+    const bytes = new Uint8Array(32);
+    const seed = `${name}@${version}`;
+    for (let index = 0; index < bytes.byteLength; index += 1) {
+        bytes[index] = seed.charCodeAt(index % seed.length) & 0xff;
+    }
+    return bytes;
+}
+async function freeLoopbackPort() {
+    return await new Promise((resolve, reject) => {
+        const server = net.createServer();
+        server.listen(0, '127.0.0.1', () => {
+            const address = server.address();
+            if (!address || typeof address === 'string') {
+                server.close();
+                reject(new Error('could not allocate loopback port'));
+                return;
+            }
+            const { port } = address;
+            server.close((error) => {
+                if (error)
+                    reject(error);
+                else
+                    resolve(port);
+            });
+        });
+        server.on('error', reject);
+    });
+}
+async function waitForTcp(host, port, timeoutMs) {
+    const deadline = Date.now() + timeoutMs;
+    while (Date.now() < deadline) {
+        try {
+            await new Promise((resolve, reject) => {
+                const socket = net.connect({ host, port }, () => {
+                    socket.end();
+                    resolve();
+                });
+                socket.on('error', reject);
+            });
+            return;
+        }
+        catch {
+            await new Promise((r) => setTimeout(r, 40));
+        }
+    }
+    throw new Error(`yydb engine did not accept connections on ${host}:${port}`);
+}
+/**
+ * Node-facing YYDB handle. Looks like one library; owns a private loopback
+ * `yydb serve` child under the hood.
+ */
+export class Database {
+    path;
+    endpoint;
+    client;
+    child;
+    microRegistry;
+    constructor(dbPath, endpoint, client, child) {
+        this.path = dbPath;
+        this.endpoint = endpoint;
+        this.client = client;
+        this.child = child;
+        this.microRegistry = new MicroSessionRegistry();
+        this.client.setMicroHostHandler((payload) => this.microRegistry.invokeFromWire(payload));
+    }
+    /**
+     * Open (create) a `.yydb` file. Spawns the engine on `127.0.0.1` automatically.
+     */
+    static async open(dbPath, options = {}) {
+        const resolved = path.resolve(dbPath);
+        fs.mkdirSync(path.dirname(resolved), { recursive: true });
+        const cli = options.cli ?? options.binary ?? resolveYydbCli();
+        const port = options.port ?? (await freeLoopbackPort());
+        const bind = `127.0.0.1:${port}`;
+        const args = [cli, 'serve', resolved, '--bind', bind, ...(options.serveArgs ?? [])];
+        const child = spawn(process.execPath, args, {
+            stdio: 'pipe',
+            windowsHide: true,
+        });
+        let stderr = '';
+        child.stderr?.setEncoding('utf8');
+        child.stderr?.on('data', (chunk) => {
+            stderr += chunk;
+        });
+        const exitPromise = new Promise((_, reject) => {
+            child.once('exit', (code, signal) => {
+                reject(new Error(`yydb engine exited early (code=${code}, signal=${signal}): ${stderr.trim()}`));
+            });
+            child.once('error', reject);
+        });
+        try {
+            await Promise.race([waitForTcp('127.0.0.1', port, 8000), exitPromise]);
+            const client = await connect(bind);
+            child.removeAllListeners('exit');
+            child.removeAllListeners('error');
+            child.on('exit', () => {
+                /* closed via Database.close or crash */
+            });
+            return new Database(resolved, bind, client, child);
+        }
+        catch (error) {
+            child.kill('SIGTERM');
+            throw error;
+        }
+    }
+    async serverVersion() {
+        return this.client.serverVersion();
+    }
+    async info() {
+        return this.client.info();
+    }
+    async getSchema() {
+        return this.client.getSchema();
+    }
+    async ensureSchema(version, document) {
+        await this.client.ensureSchema(version, document);
+    }
+    async get(key) {
+        return this.client.get(key);
+    }
+    async put(key, value) {
+        await this.client.put(key, value);
+    }
+    /**
+     * Build a typed session-local micro definition. Does not register it with
+     * the engine until [`registerMicro`](./database.ts) is called.
+     */
+    defineMicro(definition) {
+        return buildMicro(definition);
+    }
+    /**
+     * Install a [`defineMicro`](./database.ts) definition into the current
+     * session registry and sync metadata to the private engine. Host micros are
+     * session-local and never written to `.yydb`.
+     */
+    async registerMicro(definition) {
+        const handle = this.microRegistry.register(definition);
+        await this.client.registerMicro({
+            hostId: handle.hostId,
+            handleVersion: handle.implementationVersion,
+            udfVersion: definition.version,
+            name: definition.name,
+            functionId: handle.functionId,
+            args: definition.args.map((arg) => arg.kind),
+            returns: definition.returns.kind,
+            fingerprint: microFingerprint(definition.name, definition.version),
+        });
+        return handle;
+    }
+    /** Invoke a registered scalar UDF on the private engine. */
+    async callScalar(name, version, args) {
+        return this.client.callScalar(name, version, args);
+    }
+    /** Stop the private engine process. */
+    async close() {
+        this.client.close();
+        const child = this.child;
+        this.child = null;
+        if (!child || child.exitCode !== null || child.killed) {
+            return;
+        }
+        await new Promise((resolve) => {
+            child.once('exit', () => resolve());
+            child.kill('SIGTERM');
+            setTimeout(() => {
+                if (child.exitCode === null && !child.killed) {
+                    child.kill('SIGKILL');
+                }
+                resolve();
+            }, 2000);
+        });
+    }
+}

package/dist/generator/emit-typescript.d.ts

@@ -0,0 +1,3 @@
+import { type TsSchemaIr } from './ir.js';
+/** Generate `schema.generated.ts` source from IR. */
+export declare function emitTypeScript(ir: TsSchemaIr): string;

package/dist/generator/emit-typescript.js

@@ -0,0 +1,26 @@
+import { scalarToTs } from './ir.js';
+const BANNER = '// @generated by `yydb generate`, do not edit!';
+/** Generate `schema.generated.ts` source from IR. */
+export function emitTypeScript(ir) {
+    const lines = [BANNER];
+    lines.push(`export const APP_SCHEMA_VERSION = ${ir.schemaVersion};`);
+    lines.push(`export const APP_SCHEMA = ${JSON.stringify(ir.vosSource)};`);
+    for (const table of ir.tables) {
+        lines.push(emitInterfaceRow(table));
+    }
+    lines.push(emitInterfaceAppDb(ir));
+    lines.push(`export type AppDbTableName = keyof AppDb["tables"];`);
+    return `${lines.join('\n')}\n`;
+}
+function emitInterfaceRow(table) {
+    const lines = [`export interface ${table.name}Row {`];
+    for (const field of table.fields) {
+        lines.push(`    ${field.name}: ${scalarToTs(field.ty)};`);
+    }
+    lines.push('}');
+    return lines.join('\n');
+}
+function emitInterfaceAppDb(ir) {
+    const tableLines = ir.tables.map((table) => `        ${table.name}: ${table.name}Row;`);
+    return ['export interface AppDb {', '    tables: {', ...tableLines, '    };', '}'].join('\n');
+}

package/dist/generator/fixtures/setting.generated.d.ts

@@ -0,0 +1,13 @@
+export declare const APP_SCHEMA_VERSION = 1;
+export declare const APP_SCHEMA = "table Setting {\n    @@id: uuid,\n    key: utf8,\n    value: utf8,\n}\n";
+export interface SettingRow {
+    id: string;
+    key: string;
+    value: string;
+}
+export interface AppDb {
+    tables: {
+        Setting: SettingRow;
+    };
+}
+export type AppDbTableName = keyof AppDb['tables'];

package/dist/generator/fixtures/setting.generated.js

@@ -0,0 +1,3 @@
+// @generated by `yydb generate`, do not edit!
+export const APP_SCHEMA_VERSION = 1;
+export const APP_SCHEMA = 'table Setting {\n    @@id: uuid,\n    key: utf8,\n    value: utf8,\n}\n';

package/dist/generator/index.d.ts

@@ -0,0 +1,6 @@
+export type { SchemaField, SchemaTable, ScalarType, TsSchemaIr } from './ir.js';
+export { emitTypeScript } from './emit-typescript.js';
+export { parseVosSubset, VosParseError } from './parse-vos.js';
+/** Generate TypeScript from a VOS document. */
+export declare function generateTypeScript(vosSource: string, schemaVersion: number): string;
+export { generateTypeScript as generateTypescript };

package/dist/generator/index.js

@@ -0,0 +1,10 @@
+import { emitTypeScript } from './emit-typescript.js';
+import { parseVosSubset } from './parse-vos.js';
+export { emitTypeScript } from './emit-typescript.js';
+export { parseVosSubset, VosParseError } from './parse-vos.js';
+/** Generate TypeScript from a VOS document. */
+export function generateTypeScript(vosSource, schemaVersion) {
+    const ir = parseVosSubset(vosSource, schemaVersion);
+    return emitTypeScript(ir);
+}
+export { generateTypeScript as generateTypescript };

package/dist/generator/ir.d.ts

@@ -0,0 +1,20 @@
+/** Scalar types supported by the MVP emitter (expand with `vos-parser`). */
+export type ScalarType = 'uuid' | 'utf8' | 'bool' | 'i64' | 'f64';
+export interface SchemaField {
+    readonly name: string;
+    readonly ty: ScalarType;
+    /** True when this field is declared via `@@id`. */
+    readonly isId: boolean;
+}
+export interface SchemaTable {
+    readonly name: string;
+    readonly fields: readonly SchemaField[];
+}
+/** One schema document ready for TypeScript emission. */
+export interface TsSchemaIr {
+    /** Original VOS source (database truth embedded into generated module). */
+    readonly vosSource: string;
+    readonly schemaVersion: number;
+    readonly tables: readonly SchemaTable[];
+}
+export declare function scalarToTs(ty: ScalarType): string;

package/dist/generator/ir.js

@@ -0,0 +1,12 @@
+export function scalarToTs(ty) {
+    switch (ty) {
+        case 'uuid':
+        case 'utf8':
+            return 'string';
+        case 'bool':
+            return 'boolean';
+        case 'i64':
+        case 'f64':
+            return 'number';
+    }
+}

package/dist/generator/parse-vos.d.ts

@@ -0,0 +1,6 @@
+import type { TsSchemaIr } from './ir.js';
+export declare class VosParseError extends Error {
+    constructor(message: string);
+}
+/** Interim VOS subset parser for `yydb generate` (MVP). */
+export declare function parseVosSubset(source: string, schemaVersion: number): TsSchemaIr;

package/dist/generator/parse-vos.js

@@ -0,0 +1,149 @@
+export class VosParseError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = 'VosParseError';
+    }
+}
+/** Interim VOS subset parser for `yydb generate` (MVP). */
+export function parseVosSubset(source, schemaVersion) {
+    if (source.includes('\0')) {
+        throw new VosParseError('VOS document must not contain NUL bytes');
+    }
+    let normalized = source.startsWith('\uFEFF') ? source.slice(1) : source;
+    normalized = normalized.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
+    const lexer = new Lexer(normalized);
+    const tables = [];
+    while (!lexer.eof()) {
+        lexer.skipWsAndComments();
+        if (lexer.eof()) {
+            break;
+        }
+        tables.push(parseTable(lexer));
+    }
+    if (tables.length === 0) {
+        throw new VosParseError('expected at least one `table` declaration');
+    }
+    return {
+        vosSource: normalized,
+        schemaVersion,
+        tables,
+    };
+}
+function parseTable(lexer) {
+    lexer.expectIdent('table');
+    const name = lexer.expectAnyIdent();
+    lexer.expectPunct('{');
+    const fields = [];
+    while (true) {
+        lexer.skipWsAndComments();
+        if (lexer.eatPunct('}')) {
+            break;
+        }
+        if (lexer.eatPunct('@')) {
+            lexer.expectPunct('@');
+            const attr = lexer.expectAnyIdent();
+            if (attr !== 'id') {
+                throw new VosParseError(`unsupported table attribute \`@@${attr}\` (MVP supports \`@@id\` only)`);
+            }
+            lexer.expectPunct(':');
+            const ty = parseScalar(lexer);
+            fields.push({ name: 'id', ty, isId: true });
+        }
+        else {
+            const fieldName = lexer.expectAnyIdent();
+            lexer.expectPunct(':');
+            const ty = parseScalar(lexer);
+            fields.push({ name: fieldName, ty, isId: false });
+        }
+        lexer.skipWsAndComments();
+        lexer.eatPunct(',');
+    }
+    if (!fields.some((field) => field.isId)) {
+        throw new VosParseError(`table \`${name}\` requires \`@@id: <type>\``);
+    }
+    return { name, fields };
+}
+function parseScalar(lexer) {
+    const name = lexer.expectAnyIdent();
+    switch (name) {
+        case 'uuid':
+            return 'uuid';
+        case 'utf8':
+            return 'utf8';
+        case 'bool':
+            return 'bool';
+        case 'i64':
+            return 'i64';
+        case 'f64':
+            return 'f64';
+        default:
+            throw new VosParseError(`unsupported scalar type \`${name}\` (MVP: uuid, utf8, bool, i64, f64)`);
+    }
+}
+class Lexer {
+    src;
+    i = 0;
+    constructor(src) {
+        this.src = src;
+    }
+    eof() {
+        return this.i >= this.src.length;
+    }
+    peek() {
+        return this.src[this.i];
+    }
+    bump() {
+        const ch = this.peek();
+        if (ch === undefined) {
+            return undefined;
+        }
+        this.i += 1;
+        return ch;
+    }
+    skipWsAndComments() {
+        while (true) {
+            while (this.peek() !== undefined && /\s/.test(this.peek())) {
+                this.bump();
+            }
+            if (this.src.startsWith('//', this.i)) {
+                while (this.peek() !== undefined && this.peek() !== '\n') {
+                    this.bump();
+                }
+                continue;
+            }
+            break;
+        }
+    }
+    eatPunct(expected) {
+        this.skipWsAndComments();
+        if (this.peek() === expected) {
+            this.bump();
+            return true;
+        }
+        return false;
+    }
+    expectPunct(expected) {
+        if (!this.eatPunct(expected)) {
+            throw new VosParseError(`expected \`${expected}\` at byte ${this.i}`);
+        }
+    }
+    expectIdent(expected) {
+        const got = this.expectAnyIdent();
+        if (got !== expected) {
+            throw new VosParseError(`expected \`${expected}\`, found \`${got}\``);
+        }
+    }
+    expectAnyIdent() {
+        this.skipWsAndComments();
+        const start = this.i;
+        const first = this.peek();
+        if (first === undefined || !/[A-Za-z_]/.test(first)) {
+            throw new VosParseError(`expected identifier at byte ${this.i}`);
+        }
+        this.bump();
+        while (this.peek() !== undefined && /[A-Za-z0-9_]/.test(this.peek())) {
+            this.bump();
+        }
+        return this.src.slice(start, this.i);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { Database, type OpenOptions } from './database.js';
+export { defineMicro, type DefinedMicro, type MicroHandle, type TsMicroDefinitionInput, MicroSessionRegistry } from './micro.js';
+export { bool, i64, nullType, text, type InferUdfArgs, type InferUdfReturn, type MicroEffect, type MicroInvocationMode, type UdfScalarKind, type UdfTypeDescriptor, } from './udf-types.js';
+export { nativeBindingName, platformKey, resolveYydbBinary, resolveYydbCli } from './resolve-bin.js';

package/dist/index.js

@@ -0,0 +1,4 @@
+export { Database } from './database.js';
+export { defineMicro, MicroSessionRegistry } from './micro.js';
+export { bool, i64, nullType, text, } from './udf-types.js';
+export { nativeBindingName, platformKey, resolveYydbBinary, resolveYydbCli } from './resolve-bin.js';

package/dist/micro.d.ts

@@ -0,0 +1,63 @@
+import type { InferUdfArgs, InferUdfReturn, MicroEffect, MicroInvocationMode, UdfTypeDescriptor } from './udf-types.js';
+/** Input accepted by [`Database.defineMicro`](./database.ts). */
+export interface TsMicroDefinitionInput<TArgs extends readonly UdfTypeDescriptor[], TReturn extends UdfTypeDescriptor> {
+    readonly name: string;
+    readonly version: number;
+    readonly args: TArgs;
+    readonly returns: TReturn;
+    readonly effect: MicroEffect;
+    readonly deterministic: boolean;
+    readonly mode?: MicroInvocationMode;
+    readonly fn: (...args: InferUdfArgs<TArgs>) => InferUdfReturn<TReturn>;
+}
+/** Opaque definition produced by `defineMicro` before session registration. */
+export interface DefinedMicro<TArgs extends readonly UdfTypeDescriptor[] = readonly UdfTypeDescriptor[], TReturn extends UdfTypeDescriptor = UdfTypeDescriptor> {
+    readonly name: string;
+    readonly version: number;
+    readonly args: TArgs;
+    readonly returns: TReturn;
+    readonly effect: MicroEffect;
+    readonly deterministic: boolean;
+    readonly mode: MicroInvocationMode;
+    readonly placement: 'host';
+    readonly fn: (...args: InferUdfArgs<TArgs>) => InferUdfReturn<TReturn>;
+}
+/** Handle returned after `registerMicro` installs a micro into the session. */
+export interface MicroHandle {
+    readonly name: string;
+    readonly version: number;
+    readonly functionId: string;
+    readonly hostId: number;
+    /** Monotonic host implementation version for opaque handle checks. */
+    readonly implementationVersion: number;
+}
+type AnyDefinedMicro = DefinedMicro<readonly UdfTypeDescriptor[], UdfTypeDescriptor>;
+/**
+ * Process-local registry for JS functions behind opaque host handles.
+ * Rust keeps `host_id + function_id + version`, not the closure.
+ */
+export declare class MicroSessionRegistry {
+    readonly hostId: number;
+    private nextFunctionId;
+    private readonly byKey;
+    private readonly byFunctionId;
+    constructor(hostId?: number);
+    /** Installs a defined micro into the current session registry. */
+    register<TArgs extends readonly UdfTypeDescriptor[], TReturn extends UdfTypeDescriptor>(definition: DefinedMicro<TArgs, TReturn>): MicroHandle;
+    /** Returns a registered micro by opaque host handle. */
+    resolve(handle: MicroHandle): AnyDefinedMicro | undefined;
+    /** Invokes a registered micro from a wire `MicroHostInvoke` payload. */
+    invokeFromWire(payload: {
+        hostId: number;
+        handleVersion: number;
+        functionId: string;
+        args: readonly unknown[];
+    }): string | number | boolean | null;
+    /** Invokes a registered scalar micro (host adapter entry point). */
+    invokeScalar(handle: MicroHandle, args: unknown[]): unknown;
+    /** Lists logical names currently registered in this session. */
+    list(): string[];
+}
+/** Builds a session-local micro definition without registering it. */
+export declare function defineMicro<TArgs extends readonly UdfTypeDescriptor[], TReturn extends UdfTypeDescriptor>(input: TsMicroDefinitionInput<TArgs, TReturn>): DefinedMicro<TArgs, TReturn>;
+export {};

package/dist/micro.js

@@ -0,0 +1,160 @@
+let nextHostId = 1;
+/**
+ * Process-local registry for JS functions behind opaque host handles.
+ * Rust keeps `host_id + function_id + version`, not the closure.
+ */
+export class MicroSessionRegistry {
+    hostId;
+    nextFunctionId = 1;
+    byKey = new Map();
+    byFunctionId = new Map();
+    constructor(hostId = nextHostId++) {
+        this.hostId = hostId;
+    }
+    /** Installs a defined micro into the current session registry. */
+    register(definition) {
+        const key = logicalKey(definition.name, definition.version);
+        if (this.byKey.has(key)) {
+            throw new Error(`micro already registered: ${definition.name}@${definition.version}`);
+        }
+        const functionId = String(this.nextFunctionId++);
+        const handle = {
+            name: definition.name,
+            version: definition.version,
+            functionId,
+            hostId: this.hostId,
+            implementationVersion: 1,
+        };
+        const entry = { handle, definition: definition };
+        this.byKey.set(key, entry);
+        this.byFunctionId.set(functionId, entry);
+        return handle;
+    }
+    /** Returns a registered micro by opaque host handle. */
+    resolve(handle) {
+        if (handle.hostId !== this.hostId) {
+            return undefined;
+        }
+        return this.byFunctionId.get(handle.functionId)?.definition;
+    }
+    /** Invokes a registered micro from a wire `MicroHostInvoke` payload. */
+    invokeFromWire(payload) {
+        const handle = {
+            hostId: payload.hostId,
+            functionId: payload.functionId,
+            implementationVersion: payload.handleVersion,
+            name: '',
+            version: 0,
+        };
+        return this.invokeScalar(handle, [...payload.args]);
+    }
+    /** Invokes a registered scalar micro (host adapter entry point). */
+    invokeScalar(handle, args) {
+        const definition = this.resolve(handle);
+        if (!definition) {
+            throw new Error(`micro not found: ${handle.functionId}`);
+        }
+        if (definition.mode !== 'scalar') {
+            throw new Error(`micro ${definition.name} is not scalar mode`);
+        }
+        if (args.length !== definition.args.length) {
+            throw new Error(`micro ${definition.name} arity mismatch: expected ${definition.args.length}, got ${args.length}`);
+        }
+        validateArgTypes(definition, args);
+        const result = definition.fn(...args);
+        validateReturnType(definition.returns, result);
+        return result;
+    }
+    /** Lists logical names currently registered in this session. */
+    list() {
+        return [...this.byKey.values()].map((entry) => entry.definition.name).sort();
+    }
+}
+/** Builds a session-local micro definition without registering it. */
+export function defineMicro(input) {
+    if (!input.name.trim()) {
+        throw new Error('micro name must not be empty');
+    }
+    if (!Number.isInteger(input.version) || input.version <= 0) {
+        throw new Error('micro version must be a positive integer');
+    }
+    if (input.effect !== 'pure') {
+        throw new Error('TS micro effect must be pure in Phase 1');
+    }
+    if (!input.deterministic) {
+        throw new Error('TS micro must be deterministic in Phase 1');
+    }
+    if (typeof input.fn !== 'function') {
+        throw new Error('micro fn must be a function');
+    }
+    return {
+        name: input.name,
+        version: input.version,
+        args: input.args,
+        returns: input.returns,
+        effect: input.effect,
+        deterministic: input.deterministic,
+        mode: input.mode ?? 'scalar',
+        placement: 'host',
+        fn: input.fn,
+    };
+}
+function logicalKey(name, version) {
+    return `${name}@${version}`;
+}
+function validateArgTypes(definition, args) {
+    for (let index = 0; index < definition.args.length; index += 1) {
+        const kind = definition.args[index]?.kind;
+        const value = args[index];
+        switch (kind) {
+            case 'i64':
+                if (typeof value !== 'number' || !Number.isInteger(value)) {
+                    throw new Error(`micro ${definition.name} arg ${index} expects i64`);
+                }
+                break;
+            case 'bool':
+                if (typeof value !== 'boolean') {
+                    throw new Error(`micro ${definition.name} arg ${index} expects bool`);
+                }
+                break;
+            case 'text':
+                if (typeof value !== 'string') {
+                    throw new Error(`micro ${definition.name} arg ${index} expects text`);
+                }
+                break;
+            case 'null':
+                if (value !== null) {
+                    throw new Error(`micro ${definition.name} arg ${index} expects null`);
+                }
+                break;
+            default:
+                throw new Error(`unsupported micro arg kind: ${kind}`);
+        }
+    }
+}
+function validateReturnType(descriptor, value) {
+    switch (descriptor.kind) {
+        case 'i64':
+            if (typeof value !== 'number' || !Number.isInteger(value)) {
+                throw new Error('micro return expects i64');
+            }
+            break;
+        case 'bool':
+            if (typeof value !== 'boolean') {
+                throw new Error('micro return expects bool');
+            }
+            break;
+        case 'text':
+            if (typeof value !== 'string') {
+                throw new Error('micro return expects text');
+            }
+            break;
+        case 'null':
+            if (value !== null) {
+                throw new Error('micro return expects null');
+            }
+            break;
+        default:
+            throw new Error(`unsupported micro return kind: ${descriptor.kind}`);
+    }
+}

package/dist/native.d.ts

@@ -0,0 +1,9 @@
+export interface YydbNative {
+    version(): string;
+    serve(dbPath: string, bind: string, insecureBind?: boolean): void;
+    initDb(dbPath: string, schemaVersion: number, schemaDocument?: string | null): void;
+    infoText(dbPath: string): string;
+    readSchemaFile(schemaPath: string): string;
+}
+/** Load the platform native binding used by the `yydb` CLI. */
+export declare function loadNative(): YydbNative;

package/dist/native.js

@@ -0,0 +1,66 @@
+import { createRequire } from 'node:module';
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { nativeBindingName, platformKey } from './resolve-bin.js';
+function existsFile(filePath) {
+    try {
+        fs.accessSync(filePath, fs.constants.F_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+function loadFromPath(bindingPath) {
+    const require = createRequire(import.meta.url);
+    return require(bindingPath);
+}
+function monorepoBindingPath(key) {
+    const here = path.dirname(fileURLToPath(import.meta.url));
+    const repoRoot = path.resolve(here, '../../..');
+    const profile = process.env.YYDB_NATIVE_PROFILE === 'debug' ? 'debug' : 'release';
+    const base = path.join(repoRoot, 'target', profile);
+    const candidates = process.platform === 'win32'
+        ? [path.join(base, 'yydb_napi.dll'), path.join(base, 'yydb_napi.node')]
+        : [path.join(base, 'libyydb_napi.so'), path.join(base, 'libyydb_napi.dylib'), path.join(base, 'yydb_napi.node')];
+    for (const candidate of candidates) {
+        if (existsFile(candidate)) {
+            return candidate;
+        }
+    }
+    const staged = path.join(repoRoot, 'projects', 'packages', `yydb-${key}`, nativeBindingName(key));
+    return existsFile(staged) ? staged : null;
+}
+/** Load the platform native binding used by the `yydb` CLI. */
+export function loadNative() {
+    const fromEnv = process.env.YYDB_NATIVE?.trim();
+    if (fromEnv) {
+        if (!existsFile(fromEnv)) {
+            throw new Error(`YYDB_NATIVE points to missing binding: ${fromEnv}`);
+        }
+        return loadFromPath(path.resolve(fromEnv));
+    }
+    const key = platformKey();
+    if (key) {
+        const pkg = `@yydb/yydb-${key}`;
+        const require = createRequire(import.meta.url);
+        try {
+            const pkgJson = require.resolve(`${pkg}/package.json`);
+            const candidate = path.join(path.dirname(pkgJson), nativeBindingName(key));
+            if (existsFile(candidate)) {
+                return loadFromPath(candidate);
+            }
+        }
+        catch {
+            // optionalDependency not installed for this platform
+        }
+        const local = monorepoBindingPath(key);
+        if (local) {
+            return loadFromPath(local);
+        }
+    }
+    throw new Error('YYDB native binding not found. Install the matching optionalDependency ' +
+        `(@yydb/yydb-${key ?? '<platform>'}), set YYDB_NATIVE, or build ` +
+        '`cargo build -p yydb-napi --release` in this repo.');
+}

package/dist/resolve-bin.d.ts

@@ -0,0 +1,15 @@
+/// <reference types="node" />
+export type PlatformKey = 'win32-x64' | 'linux-x64' | 'darwin-x64' | 'darwin-arm64';
+/** Map Node platform/arch to optionalDependency package suffix. */
+export declare function platformKey(platform?: NodeJS.Platform, arch?: NodeJS.Architecture): PlatformKey | null;
+/** Native binding filename inside each `@yydb/yydb-<platform>` package. */
+export declare function nativeBindingName(key: PlatformKey): string;
+/**
+ * Resolve the TypeScript `yydb` CLI entry script.
+ * Order: `YYDB_CLI` → this package `dist/cli.js`.
+ */
+export declare function resolveYydbCli(): string;
+/**
+ * @deprecated Use {@link resolveYydbCli}. Kept for callers that still import this name.
+ */
+export declare function resolveYydbBinary(): string;

package/dist/resolve-bin.js

@@ -0,0 +1,53 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+/** Map Node platform/arch to optionalDependency package suffix. */
+export function platformKey(platform = process.platform, arch = process.arch) {
+    if (platform === 'win32' && arch === 'x64')
+        return 'win32-x64';
+    if (platform === 'linux' && arch === 'x64')
+        return 'linux-x64';
+    if (platform === 'darwin' && arch === 'x64')
+        return 'darwin-x64';
+    if (platform === 'darwin' && arch === 'arm64')
+        return 'darwin-arm64';
+    return null;
+}
+/** Native binding filename inside each `@yydb/yydb-<platform>` package. */
+export function nativeBindingName(key) {
+    return `yydb.${key}.node`;
+}
+function existsFile(filePath) {
+    try {
+        fs.accessSync(filePath, fs.constants.F_OK);
+        return true;
+    }
+    catch {
+        return false;
+    }
+}
+/**
+ * Resolve the TypeScript `yydb` CLI entry script.
+ * Order: `YYDB_CLI` → this package `dist/cli.js`.
+ */
+export function resolveYydbCli() {
+    const fromEnv = process.env.YYDB_CLI?.trim();
+    if (fromEnv) {
+        if (!existsFile(fromEnv)) {
+            throw new Error(`YYDB_CLI points to missing script: ${fromEnv}`);
+        }
+        return path.resolve(fromEnv);
+    }
+    const here = path.dirname(fileURLToPath(import.meta.url));
+    const candidate = path.join(here, 'cli.js');
+    if (!existsFile(candidate)) {
+        throw new Error('YYDB CLI script not found. Build `@yydb/yydb` (`pnpm --filter @yydb/yydb build`) or set YYDB_CLI.');
+    }
+    return candidate;
+}
+/**
+ * @deprecated Use {@link resolveYydbCli}. Kept for callers that still import this name.
+ */
+export function resolveYydbBinary() {
+    return resolveYydbCli();
+}

package/dist/udf-types.d.ts

@@ -0,0 +1,26 @@
+/** Phase-1 scalar UDF wire kinds aligned with `yydb-udf`. */
+export type UdfScalarKind = 'i64' | 'bool' | 'text' | 'null';
+/** Runtime type descriptor used in `defineMicro` contracts. */
+export interface UdfTypeDescriptor<T = unknown> {
+    readonly kind: UdfScalarKind;
+    /** Phantom type for author-side inference only. */
+    readonly _type?: T;
+}
+/** `i64` argument or return descriptor. */
+export declare function i64(): UdfTypeDescriptor<number>;
+/** `bool` argument or return descriptor. */
+export declare function bool(): UdfTypeDescriptor<boolean>;
+/** `text` argument or return descriptor. */
+export declare function text(): UdfTypeDescriptor<string>;
+/** `null` return descriptor. */
+export declare function nullType(): UdfTypeDescriptor<null>;
+/** Maps descriptor tuple types to positional argument types. */
+export type InferUdfArgs<T extends readonly UdfTypeDescriptor[]> = {
+    [K in keyof T]: T[K] extends UdfTypeDescriptor<infer V> ? V : never;
+};
+/** Maps a return descriptor to its value type. */
+export type InferUdfReturn<T extends UdfTypeDescriptor> = T extends UdfTypeDescriptor<infer V> ? V : never;
+/** Session micro effect surface (Phase 1: pure only). */
+export type MicroEffect = 'pure';
+/** Invocation mode stored with the definition for future batch host calls. */
+export type MicroInvocationMode = 'scalar' | 'batch';

package/dist/udf-types.js

@@ -0,0 +1,16 @@
+/** `i64` argument or return descriptor. */
+export function i64() {
+    return { kind: 'i64' };
+}
+/** `bool` argument or return descriptor. */
+export function bool() {
+    return { kind: 'bool' };
+}
+/** `text` argument or return descriptor. */
+export function text() {
+    return { kind: 'text' };
+}
+/** `null` return descriptor. */
+export function nullType() {
+    return { kind: 'null' };
+}

package/package.json

@@ -1,14 +1,70 @@
 {
   "name": "@yydb/yydb",
-  "version": "0.0.0",
-  "description": "Placeholder — YYDB Node product API",
-  "license": "MIT",
-  "private": false,
-  "publishConfig": {
-    "access": "public"
+  "version": "0.0.2",
+  "description": "YYDB all-in-one for Node: embedded engine, CLI, and local serve",
+  "license": "MPL-2.0",
+  "type": "module",
+  "bin": {
+    "yydb": "./dist/cli.js"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./cli": {
+      "types": "./dist/cli.d.ts",
+      "import": "./dist/cli.js"
+    },
+    "./generator": {
+      "types": "./dist/generator/index.d.ts",
+      "import": "./dist/generator/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "test": "pnpm run build && node --experimental-strip-types --test src/**/*.test.ts"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/yy-database/yydb.git"
+    "url": "git+https://github.com/yy-database/yydb.git",
+    "directory": "projects/packages/yydb"
+  },
+  "homepage": "https://github.com/yy-database/yydb/tree/dev/projects/packages/yydb#readme",
+  "bugs": {
+    "url": "https://github.com/yy-database/yydb/issues"
+  },
+  "keywords": [
+    "yydb",
+    "vos",
+    "database",
+    "embedded",
+    "typescript"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@vmz/commander": "^0.2.0",
+    "@yydb/yydb-client": "0.0.2"
+  },
+  "devDependencies": {
+    "@types/node": "^20.10.0",
+    "typescript": "~5.3.0"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@yydb/yydb-win32-x64": "0.0.2",
+    "@yydb/yydb-linux-x64": "0.0.2",
+    "@yydb/yydb-darwin-x64": "0.0.2",
+    "@yydb/yydb-darwin-arm64": "0.0.2"
   }
 }