@syncular/dialect-sqlite3 0.0.1-60

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @syncular/dialect-sqlite3 - node-sqlite3 dialect for sync
+ *
+ * Provides a Kysely dialect for the callback-based `sqlite3` npm package
+ * with SerializePlugin for automatic JSON serialization/deserialization.
+ * SQLite-compatible — use with @syncular/server-dialect-sqlite.
+ *
+ * Implements a custom Kysely Driver that wraps sqlite3's callback API
+ * into the promise-based interface Kysely expects.
+ */
+import { SerializePlugin } from '@syncular/core';
+import { Kysely } from 'kysely';
+import sqlite3 from 'sqlite3';
+interface Sqlite3PathOptions {
+    /** Path to SQLite database file, or ':memory:' for in-memory */
+    path: string;
+}
+interface Sqlite3InstanceOptions {
+    /** An existing sqlite3.Database instance */
+    database: sqlite3.Database;
+}
+type Sqlite3Options = Sqlite3PathOptions | Sqlite3InstanceOptions;
+/**
+ * Create a Kysely instance with node-sqlite3 dialect and SerializePlugin.
+ *
+ * @example
+ * const db = createSqlite3Db<MyDb>({ path: './data.db' });
+ * const db = createSqlite3Db<MyDb>({ path: ':memory:' });
+ */
+export declare function createSqlite3Db<T>(options: Sqlite3Options): Kysely<T>;
+export declare function createSerializePlugin(): SerializePlugin;
+export {};
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAWjD,OAAO,EAEL,MAAM,EAIP,MAAM,QAAQ,CAAC;AAChB,OAAO,OAAO,MAAM,SAAS,CAAC;AAE9B,UAAU,kBAAkB;IAC1B,gEAAgE;IAChE,IAAI,EAAE,MAAM,CAAC;CACd;AAED,UAAU,sBAAsB;IAC9B,4CAA4C;IAC5C,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;CAC5B;AAED,KAAK,cAAc,GAAG,kBAAkB,GAAG,sBAAsB,CAAC;AAElE;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAAE,OAAO,EAAE,cAAc,GAAG,MAAM,CAAC,CAAC,CAAC,CAKrE;AASD,wBAAgB,qBAAqB,IAAI,eAAe,CAEvD"}

package/dist/index.js

@@ -0,0 +1,140 @@
+/**
+ * @syncular/dialect-sqlite3 - node-sqlite3 dialect for sync
+ *
+ * Provides a Kysely dialect for the callback-based `sqlite3` npm package
+ * with SerializePlugin for automatic JSON serialization/deserialization.
+ * SQLite-compatible — use with @syncular/server-dialect-sqlite.
+ *
+ * Implements a custom Kysely Driver that wraps sqlite3's callback API
+ * into the promise-based interface Kysely expects.
+ */
+import { SerializePlugin } from '@syncular/core';
+import { CompiledQuery, Kysely, SqliteAdapter, SqliteIntrospector, SqliteQueryCompiler, } from 'kysely';
+import sqlite3 from 'sqlite3';
+/**
+ * Create a Kysely instance with node-sqlite3 dialect and SerializePlugin.
+ *
+ * @example
+ * const db = createSqlite3Db<MyDb>({ path: './data.db' });
+ * const db = createSqlite3Db<MyDb>({ path: ':memory:' });
+ */
+export function createSqlite3Db(options) {
+    return new Kysely({
+        dialect: createSqlite3Dialect(options),
+        plugins: [new SerializePlugin()],
+    });
+}
+/**
+ * Create the sqlite3 dialect directly (without SerializePlugin).
+ */
+function createSqlite3Dialect(options) {
+    return new Sqlite3Dialect(options);
+}
+export function createSerializePlugin() {
+    return new SerializePlugin();
+}
+// ---------------------------------------------------------------------------
+// Kysely Dialect implementation for node-sqlite3
+// ---------------------------------------------------------------------------
+class Sqlite3Dialect {
+    #options;
+    constructor(options) {
+        this.#options = options;
+    }
+    createAdapter() {
+        return new SqliteAdapter();
+    }
+    createDriver() {
+        return new Sqlite3Driver(this.#options);
+    }
+    createQueryCompiler() {
+        return new SqliteQueryCompiler();
+    }
+    createIntrospector(db) {
+        return new SqliteIntrospector(db);
+    }
+}
+class Sqlite3Driver {
+    #options;
+    #db;
+    constructor(options) {
+        this.#options = options;
+    }
+    async init() {
+        this.#db = await this.#resolveDatabase();
+    }
+    async acquireConnection() {
+        return new Sqlite3Connection(this.#db);
+    }
+    async beginTransaction(connection, _settings) {
+        await connection.executeQuery(CompiledQuery.raw('begin'));
+    }
+    async commitTransaction(connection) {
+        await connection.executeQuery(CompiledQuery.raw('commit'));
+    }
+    async rollbackTransaction(connection) {
+        await connection.executeQuery(CompiledQuery.raw('rollback'));
+    }
+    async releaseConnection(_connection) {
+        // Single-connection model — nothing to release.
+    }
+    async destroy() {
+        if (this.#db) {
+            await new Promise((resolve, reject) => {
+                this.#db.close((err) => (err ? reject(err) : resolve()));
+            });
+        }
+    }
+    async #resolveDatabase() {
+        if ('database' in this.#options) {
+            return this.#options.database;
+        }
+        const path = this.#options.path;
+        return new Promise((resolve, reject) => {
+            const db = new sqlite3.Database(path, (err) => {
+                if (err)
+                    reject(err);
+                else
+                    resolve(db);
+            });
+        });
+    }
+}
+class Sqlite3Connection {
+    #db;
+    constructor(db) {
+        this.#db = db;
+    }
+    async executeQuery(compiledQuery) {
+        const { sql, parameters } = compiledQuery;
+        const params = [...parameters];
+        // Determine if this is a SELECT / RETURNING query
+        const isSelect = /^\s*(select|pragma|explain|with)\b/i.test(sql);
+        const isInsert = /^\s*(insert|replace)\b/i.test(sql);
+        if (isSelect) {
+            return new Promise((resolve, reject) => {
+                this.#db.all(sql, params, (err, rows) => {
+                    if (err)
+                        return reject(err);
+                    resolve({ rows: rows ?? [] });
+                });
+            });
+        }
+        // For INSERT, UPDATE, DELETE — use run() to get lastID and changes
+        return new Promise((resolve, reject) => {
+            this.#db.run(sql, params, function (err) {
+                if (err)
+                    return reject(err);
+                resolve({
+                    rows: [],
+                    numAffectedRows: BigInt(this.changes),
+                    ...(isInsert ? { insertId: BigInt(this.lastID) } : {}),
+                });
+            });
+        });
+    }
+    streamQuery(_compiledQuery, _chunkSize) {
+        throw new Error('sqlite3 driver does not support streaming');
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;GASG;AAEH,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAWjD,OAAO,EACL,aAAa,EACb,MAAM,EACN,aAAa,EACb,kBAAkB,EAClB,mBAAmB,GACpB,MAAM,QAAQ,CAAC;AAChB,OAAO,OAAO,MAAM,SAAS,CAAC;AAc9B;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAAI,OAAuB,EAAa;IACrE,OAAO,IAAI,MAAM,CAAI;QACnB,OAAO,EAAE,oBAAoB,CAAC,OAAO,CAAC;QACtC,OAAO,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC;KACjC,CAAC,CAAC;AAAA,CACJ;AAED;;GAEG;AACH,SAAS,oBAAoB,CAAC,OAAuB,EAAkB;IACrE,OAAO,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;AAAA,CACpC;AAED,MAAM,UAAU,qBAAqB,GAAoB;IACvD,OAAO,IAAI,eAAe,EAAE,CAAC;AAAA,CAC9B;AAED,8EAA8E;AAC9E,iDAAiD;AACjD,8EAA8E;AAE9E,MAAM,cAAc;IACT,QAAQ,CAAiB;IAElC,YAAY,OAAuB,EAAE;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAAA,CACzB;IAED,aAAa,GAAmB;QAC9B,OAAO,IAAI,aAAa,EAAE,CAAC;IAAA,CAC5B;IAED,YAAY,GAAW;QACrB,OAAO,IAAI,aAAa,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAAA,CACzC;IAED,mBAAmB,GAAkB;QACnC,OAAO,IAAI,mBAAmB,EAAE,CAAC;IAAA,CAClC;IAED,kBAAkB,CAAC,EAAe,EAAwB;QACxD,OAAO,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC;IAAA,CACnC;CACF;AAED,MAAM,aAAa;IACR,QAAQ,CAAiB;IAClC,GAAG,CAA+B;IAElC,YAAY,OAAuB,EAAE;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;IAAA,CACzB;IAED,KAAK,CAAC,IAAI,GAAkB;QAC1B,IAAI,CAAC,GAAG,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;IAAA,CAC1C;IAED,KAAK,CAAC,iBAAiB,GAAgC;QACrD,OAAO,IAAI,iBAAiB,CAAC,IAAI,CAAC,GAAI,CAAC,CAAC;IAAA,CACzC;IAED,KAAK,CAAC,gBAAgB,CACpB,UAA8B,EAC9B,SAA8B,EACf;QACf,MAAM,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;IAAA,CAC3D;IAED,KAAK,CAAC,iBAAiB,CAAC,UAA8B,EAAiB;QACrE,MAAM,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;IAAA,CAC5D;IAED,KAAK,CAAC,mBAAmB,CAAC,UAA8B,EAAiB;QACvE,MAAM,UAAU,CAAC,YAAY,CAAC,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC;IAAA,CAC9D;IAED,KAAK,CAAC,iBAAiB,CAAC,WAA+B,EAAiB;QACtE,kDAAgD;IADuB,CAExE;IAED,KAAK,CAAC,OAAO,GAAkB;QAC7B,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,OAAO,CAAO,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;gBAC3C,IAAI,CAAC,GAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAAA,CAC3D,CAAC,CAAC;QACL,CAAC;IAAA,CACF;IAED,KAAK,CAAC,gBAAgB,GAA8B;QAClD,IAAI,UAAU,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YAChC,OAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAChC,CAAC;QACD,MAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC;QAChC,OAAO,IAAI,OAAO,CAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;YACxD,MAAM,EAAE,GAAG,IAAI,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC;gBAC7C,IAAI,GAAG;oBAAE,MAAM,CAAC,GAAG,CAAC,CAAC;;oBAChB,OAAO,CAAC,EAAE,CAAC,CAAC;YAAA,CAClB,CAAC,CAAC;QAAA,CACJ,CAAC,CAAC;IAAA,CACJ;CACF;AAED,MAAM,iBAAiB;IACZ,GAAG,CAAmB;IAE/B,YAAY,EAAoB,EAAE;QAChC,IAAI,CAAC,GAAG,GAAG,EAAE,CAAC;IAAA,CACf;IAED,KAAK,CAAC,YAAY,CAAI,aAA4B,EAA2B;QAC3E,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,GAAG,aAAa,CAAC;QAC1C,MAAM,MAAM,GAAG,CAAC,GAAG,UAAU,CAAC,CAAC;QAE/B,kDAAkD;QAClD,MAAM,QAAQ,GAAG,qCAAqC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QACjE,MAAM,QAAQ,GAAG,yBAAyB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAErD,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;gBACtD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAiB,EAAE,IAAS,EAAE,EAAE,CAAC;oBAC1D,IAAI,GAAG;wBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;oBAC5B,OAAO,CAAC,EAAE,IAAI,EAAE,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC;gBAAA,CAC/B,CAAC,CAAC;YAAA,CACJ,CAAC,CAAC;QACL,CAAC;QAED,qEAAmE;QACnE,OAAO,IAAI,OAAO,CAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,CAAC;YACtD,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,GAAiB,EAAE;gBACrD,IAAI,GAAG;oBAAE,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC;gBAC5B,OAAO,CAAC;oBACN,IAAI,EAAE,EAAE;oBACR,eAAe,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC;oBACrC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACvD,CAAC,CAAC;YAAA,CACJ,CAAC,CAAC;QAAA,CACJ,CAAC,CAAC;IAAA,CACJ;IAED,WAAW,CACT,cAA6B,EAC7B,UAAmB,EACoB;QACvC,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAAA,CAC9D;CACF"}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@syncular/dialect-sqlite3",
+  "version": "0.0.1-60",
+  "description": "node-sqlite3 dialect for the Syncular client",
+  "license": "MIT",
+  "author": "Benjamin Kniffler",
+  "homepage": "https://syncular.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/syncular/syncular.git",
+    "directory": "packages/dialect-sqlite3"
+  },
+  "bugs": {
+    "url": "https://github.com/syncular/syncular/issues"
+  },
+  "keywords": [
+    "sync",
+    "offline-first",
+    "realtime",
+    "database",
+    "typescript",
+    "sqlite3",
+    "node"
+  ],
+  "private": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "bun": "./src/index.ts",
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "tsgo": "tsgo --noEmit",
+    "build": "rm -rf dist && tsgo",
+    "release": "bun pm pack --destination . && npm publish ./*.tgz --tag latest && rm -f ./*.tgz"
+  },
+  "dependencies": {
+    "@syncular/core": "0.0.1",
+    "sqlite3": "^5.1.7"
+  },
+  "peerDependencies": {
+    "kysely": "^0.28.0"
+  },
+  "devDependencies": {
+    "@syncular/config": "0.0.0",
+    "kysely": "*"
+  },
+  "files": [
+    "dist",
+    "src"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,197 @@
+/**
+ * @syncular/dialect-sqlite3 - node-sqlite3 dialect for sync
+ *
+ * Provides a Kysely dialect for the callback-based `sqlite3` npm package
+ * with SerializePlugin for automatic JSON serialization/deserialization.
+ * SQLite-compatible — use with @syncular/server-dialect-sqlite.
+ *
+ * Implements a custom Kysely Driver that wraps sqlite3's callback API
+ * into the promise-based interface Kysely expects.
+ */
+
+import { SerializePlugin } from '@syncular/core';
+import type {
+  DatabaseConnection,
+  DatabaseIntrospector,
+  Dialect,
+  DialectAdapter,
+  Driver,
+  QueryCompiler,
+  QueryResult,
+  TransactionSettings,
+} from 'kysely';
+import {
+  CompiledQuery,
+  Kysely,
+  SqliteAdapter,
+  SqliteIntrospector,
+  SqliteQueryCompiler,
+} from 'kysely';
+import sqlite3 from 'sqlite3';
+
+interface Sqlite3PathOptions {
+  /** Path to SQLite database file, or ':memory:' for in-memory */
+  path: string;
+}
+
+interface Sqlite3InstanceOptions {
+  /** An existing sqlite3.Database instance */
+  database: sqlite3.Database;
+}
+
+type Sqlite3Options = Sqlite3PathOptions | Sqlite3InstanceOptions;
+
+/**
+ * Create a Kysely instance with node-sqlite3 dialect and SerializePlugin.
+ *
+ * @example
+ * const db = createSqlite3Db<MyDb>({ path: './data.db' });
+ * const db = createSqlite3Db<MyDb>({ path: ':memory:' });
+ */
+export function createSqlite3Db<T>(options: Sqlite3Options): Kysely<T> {
+  return new Kysely<T>({
+    dialect: createSqlite3Dialect(options),
+    plugins: [new SerializePlugin()],
+  });
+}
+
+/**
+ * Create the sqlite3 dialect directly (without SerializePlugin).
+ */
+function createSqlite3Dialect(options: Sqlite3Options): Sqlite3Dialect {
+  return new Sqlite3Dialect(options);
+}
+
+export function createSerializePlugin(): SerializePlugin {
+  return new SerializePlugin();
+}
+
+// ---------------------------------------------------------------------------
+// Kysely Dialect implementation for node-sqlite3
+// ---------------------------------------------------------------------------
+
+class Sqlite3Dialect implements Dialect {
+  readonly #options: Sqlite3Options;
+
+  constructor(options: Sqlite3Options) {
+    this.#options = options;
+  }
+
+  createAdapter(): DialectAdapter {
+    return new SqliteAdapter();
+  }
+
+  createDriver(): Driver {
+    return new Sqlite3Driver(this.#options);
+  }
+
+  createQueryCompiler(): QueryCompiler {
+    return new SqliteQueryCompiler();
+  }
+
+  createIntrospector(db: Kysely<any>): DatabaseIntrospector {
+    return new SqliteIntrospector(db);
+  }
+}
+
+class Sqlite3Driver implements Driver {
+  readonly #options: Sqlite3Options;
+  #db: sqlite3.Database | undefined;
+
+  constructor(options: Sqlite3Options) {
+    this.#options = options;
+  }
+
+  async init(): Promise<void> {
+    this.#db = await this.#resolveDatabase();
+  }
+
+  async acquireConnection(): Promise<DatabaseConnection> {
+    return new Sqlite3Connection(this.#db!);
+  }
+
+  async beginTransaction(
+    connection: DatabaseConnection,
+    _settings: TransactionSettings
+  ): Promise<void> {
+    await connection.executeQuery(CompiledQuery.raw('begin'));
+  }
+
+  async commitTransaction(connection: DatabaseConnection): Promise<void> {
+    await connection.executeQuery(CompiledQuery.raw('commit'));
+  }
+
+  async rollbackTransaction(connection: DatabaseConnection): Promise<void> {
+    await connection.executeQuery(CompiledQuery.raw('rollback'));
+  }
+
+  async releaseConnection(_connection: DatabaseConnection): Promise<void> {
+    // Single-connection model — nothing to release.
+  }
+
+  async destroy(): Promise<void> {
+    if (this.#db) {
+      await new Promise<void>((resolve, reject) => {
+        this.#db!.close((err) => (err ? reject(err) : resolve()));
+      });
+    }
+  }
+
+  async #resolveDatabase(): Promise<sqlite3.Database> {
+    if ('database' in this.#options) {
+      return this.#options.database;
+    }
+    const path = this.#options.path;
+    return new Promise<sqlite3.Database>((resolve, reject) => {
+      const db = new sqlite3.Database(path, (err) => {
+        if (err) reject(err);
+        else resolve(db);
+      });
+    });
+  }
+}
+
+class Sqlite3Connection implements DatabaseConnection {
+  readonly #db: sqlite3.Database;
+
+  constructor(db: sqlite3.Database) {
+    this.#db = db;
+  }
+
+  async executeQuery<R>(compiledQuery: CompiledQuery): Promise<QueryResult<R>> {
+    const { sql, parameters } = compiledQuery;
+    const params = [...parameters];
+
+    // Determine if this is a SELECT / RETURNING query
+    const isSelect = /^\s*(select|pragma|explain|with)\b/i.test(sql);
+    const isInsert = /^\s*(insert|replace)\b/i.test(sql);
+
+    if (isSelect) {
+      return new Promise<QueryResult<R>>((resolve, reject) => {
+        this.#db.all(sql, params, (err: Error | null, rows: R[]) => {
+          if (err) return reject(err);
+          resolve({ rows: rows ?? [] });
+        });
+      });
+    }
+
+    // For INSERT, UPDATE, DELETE — use run() to get lastID and changes
+    return new Promise<QueryResult<R>>((resolve, reject) => {
+      this.#db.run(sql, params, function (err: Error | null) {
+        if (err) return reject(err);
+        resolve({
+          rows: [],
+          numAffectedRows: BigInt(this.changes),
+          ...(isInsert ? { insertId: BigInt(this.lastID) } : {}),
+        });
+      });
+    });
+  }
+
+  streamQuery<R>(
+    _compiledQuery: CompiledQuery,
+    _chunkSize?: number
+  ): AsyncIterableIterator<QueryResult<R>> {
+    throw new Error('sqlite3 driver does not support streaming');
+  }
+}