@syncular/dialect-pglite 0.0.1-60

package/dist/index.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @syncular/dialect-pglite - PGlite dialect for sync
+ *
+ * Provides a Kysely dialect for PGlite (in-memory/browser Postgres).
+ * Uses kysely-pglite-dialect under the hood.
+ */
+import { type PGliteWithLive } from '@electric-sql/pglite/live';
+import { Kysely } from 'kysely';
+import { PGliteDialect } from 'kysely-pglite-dialect';
+export interface PgliteOptions {
+    /** Optional data directory for persistence */
+    dataDir?: string;
+    /** Preloaded PGlite fs bundle (avoids runtime network fetches in the browser). */
+    fsBundle?: Blob | File;
+    /** Precompiled wasm module (avoids runtime network fetches in the browser). */
+    wasmModule?: WebAssembly.Module;
+    /** Optional data dir archive to initialize from (tar). */
+    loadDataDir?: Blob | File;
+    /** Optional initial memory (bytes). */
+    initialMemory?: number;
+}
+/**
+ * Extended Kysely instance that exposes the raw PGlite instance.
+ * Use this type when you need access to PGlite's native features like live queries.
+ */
+export interface PgliteDb<T> extends Kysely<T> {
+    /** Access raw PGlite instance for live queries */
+    readonly pglite: PGliteWithLive;
+}
+/**
+ * Create a Kysely instance with PGlite dialect.
+ * Synchronous version - database may not be fully ready immediately.
+ *
+ * Note: This version does NOT include the live extension or expose the raw PGlite instance.
+ * For live query support, use createPgliteDbAsync() instead.
+ *
+ * @example
+ * const db = createPgliteDb<MyDb>(); // In-memory
+ * const db = createPgliteDb<MyDb>({ dataDir: './pgdata' }); // Persistent
+ */
+export declare function createPgliteDb<T>(options?: PgliteOptions): Kysely<T>;
+/**
+ * Create a Kysely instance with PGlite dialect, waiting for database to be ready.
+ * Async version - ensures database is fully initialized before returning.
+ * Includes the live extension for reactive queries.
+ *
+ * @example
+ * const db = await createPgliteDbAsync<MyDb>(); // In-memory
+ * const db = await createPgliteDbAsync<MyDb>({ dataDir: 'idb://mydb' }); // Persistent
+ * // Access raw PGlite for live queries:
+ * db.pglite.live.incrementalQuery(...)
+ */
+export declare function createPgliteDbAsync<T>(options?: PgliteOptions): Promise<PgliteDb<T>>;
+/**
+ * Create the PGlite dialect directly.
+ */
+export declare function createPgliteDialect(options?: PgliteOptions): PGliteDialect;
+export declare function getPgliteAssetPaths(): {
+    fsBundlePath: string;
+    wasmPath: string;
+};
+//# 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;;;;;GAKG;AAGH,OAAO,EAAQ,KAAK,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAEtD,MAAM,WAAW,aAAa;IAC5B,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB,kFAAkF;IAClF,QAAQ,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAEvB,+EAA+E;IAC/E,UAAU,CAAC,EAAE,WAAW,CAAC,MAAM,CAAC;IAEhC,0DAA0D;IAC1D,WAAW,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IAE1B,uCAAuC;IACvC,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,CAAC,CAAE,SAAQ,MAAM,CAAC,CAAC,CAAC;IAC5C,kDAAkD;IAClD,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;CACjC;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,cAAc,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC,CAAC,CAAC,CAKpE;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,mBAAmB,CAAC,CAAC,EACzC,OAAO,CAAC,EAAE,aAAa,GACtB,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAoBtB;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,CAAC,EAAE,aAAa,GAAG,aAAa,CAG1E;AAGD,wBAAgB,mBAAmB,IAAI;IACrC,YAAY,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;CAClB,CAOA"}

package/dist/index.js

@@ -0,0 +1,72 @@
+/**
+ * @syncular/dialect-pglite - PGlite dialect for sync
+ *
+ * Provides a Kysely dialect for PGlite (in-memory/browser Postgres).
+ * Uses kysely-pglite-dialect under the hood.
+ */
+import { PGlite } from '@electric-sql/pglite';
+import { live } from '@electric-sql/pglite/live';
+import { Kysely } from 'kysely';
+import { PGliteDialect } from 'kysely-pglite-dialect';
+/**
+ * Create a Kysely instance with PGlite dialect.
+ * Synchronous version - database may not be fully ready immediately.
+ *
+ * Note: This version does NOT include the live extension or expose the raw PGlite instance.
+ * For live query support, use createPgliteDbAsync() instead.
+ *
+ * @example
+ * const db = createPgliteDb<MyDb>(); // In-memory
+ * const db = createPgliteDb<MyDb>({ dataDir: './pgdata' }); // Persistent
+ */
+export function createPgliteDb(options) {
+    const database = options ? new PGlite(options) : new PGlite();
+    return new Kysely({
+        dialect: new PGliteDialect(database),
+    });
+}
+/**
+ * Create a Kysely instance with PGlite dialect, waiting for database to be ready.
+ * Async version - ensures database is fully initialized before returning.
+ * Includes the live extension for reactive queries.
+ *
+ * @example
+ * const db = await createPgliteDbAsync<MyDb>(); // In-memory
+ * const db = await createPgliteDbAsync<MyDb>({ dataDir: 'idb://mydb' }); // Persistent
+ * // Access raw PGlite for live queries:
+ * db.pglite.live.incrementalQuery(...)
+ */
+export async function createPgliteDbAsync(options) {
+    const database = await PGlite.create({
+        ...options,
+        extensions: { live },
+    });
+    const db = new Kysely({
+        dialect: new PGliteDialect(database),
+    });
+    // Attach raw instance for live query access using Object.defineProperty
+    // to properly define the readonly property
+    Object.defineProperty(db, 'pglite', {
+        value: database,
+        writable: false,
+        enumerable: true,
+        configurable: false,
+    });
+    return db;
+}
+/**
+ * Create the PGlite dialect directly.
+ */
+export function createPgliteDialect(options) {
+    const database = options ? new PGlite(options) : new PGlite();
+    return new PGliteDialect(database);
+}
+// Re-export types for convenience
+export function getPgliteAssetPaths() {
+    const entry = import.meta.resolve('@electric-sql/pglite');
+    return {
+        fsBundlePath: new URL('./pglite.data', entry).pathname,
+        wasmPath: new URL('./pglite.wasm', entry).pathname,
+    };
+}
+//# 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;;;;;GAKG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,sBAAsB,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAuB,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AA4BtD;;;;;;;;;;GAUG;AACH,MAAM,UAAU,cAAc,CAAI,OAAuB,EAAa;IACpE,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;IAC9D,OAAO,IAAI,MAAM,CAAI;QACnB,OAAO,EAAE,IAAI,aAAa,CAAC,QAAQ,CAAC;KACrC,CAAC,CAAC;AAAA,CACJ;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CACvC,OAAuB,EACD;IACtB,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC;QACnC,GAAG,OAAO;QACV,UAAU,EAAE,EAAE,IAAI,EAAE;KACrB,CAAC,CAAC;IAEH,MAAM,EAAE,GAAG,IAAI,MAAM,CAAI;QACvB,OAAO,EAAE,IAAI,aAAa,CAAC,QAAQ,CAAC;KACrC,CAAC,CAAC;IAEH,wEAAwE;IACxE,2CAA2C;IAC3C,MAAM,CAAC,cAAc,CAAC,EAAE,EAAE,QAAQ,EAAE;QAClC,KAAK,EAAE,QAAQ;QACf,QAAQ,EAAE,KAAK;QACf,UAAU,EAAE,IAAI;QAChB,YAAY,EAAE,KAAK;KACpB,CAAC,CAAC;IAEH,OAAO,EAAiB,CAAC;AAAA,CAC1B;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAuB,EAAiB;IAC1E,MAAM,QAAQ,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,EAAE,CAAC;IAC9D,OAAO,IAAI,aAAa,CAAC,QAAQ,CAAC,CAAC;AAAA,CACpC;AACD,kCAAkC;AAElC,MAAM,UAAU,mBAAmB,GAGjC;IACA,MAAM,KAAK,GAAG,OAAO,IAAI,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;IAE1D,OAAO;QACL,YAAY,EAAE,IAAI,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,QAAQ;QACtD,QAAQ,EAAE,IAAI,GAAG,CAAC,eAAe,EAAE,KAAK,CAAC,CAAC,QAAQ;KACnD,CAAC;AAAA,CACH"}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@syncular/dialect-pglite",
+  "version": "0.0.1-60",
+  "description": "PGLite 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-pglite"
+  },
+  "bugs": {
+    "url": "https://github.com/syncular/syncular/issues"
+  },
+  "keywords": [
+    "sync",
+    "offline-first",
+    "realtime",
+    "database",
+    "typescript",
+    "pglite",
+    "postgres",
+    "wasm"
+  ],
+  "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": {
+    "@electric-sql/pglite": "^0.3.15",
+    "kysely-pglite-dialect": "^1.2.0"
+  },
+  "peerDependencies": {
+    "kysely": "^0.28.0"
+  },
+  "devDependencies": {
+    "@syncular/config": "0.0.0",
+    "kysely": "*"
+  },
+  "files": [
+    "dist",
+    "src"
+  ]
+}

package/src/index.ts

@@ -0,0 +1,111 @@
+/**
+ * @syncular/dialect-pglite - PGlite dialect for sync
+ *
+ * Provides a Kysely dialect for PGlite (in-memory/browser Postgres).
+ * Uses kysely-pglite-dialect under the hood.
+ */
+
+import { PGlite } from '@electric-sql/pglite';
+import { live, type PGliteWithLive } from '@electric-sql/pglite/live';
+import { Kysely } from 'kysely';
+import { PGliteDialect } from 'kysely-pglite-dialect';
+
+export interface PgliteOptions {
+  /** Optional data directory for persistence */
+  dataDir?: string;
+
+  /** Preloaded PGlite fs bundle (avoids runtime network fetches in the browser). */
+  fsBundle?: Blob | File;
+
+  /** Precompiled wasm module (avoids runtime network fetches in the browser). */
+  wasmModule?: WebAssembly.Module;
+
+  /** Optional data dir archive to initialize from (tar). */
+  loadDataDir?: Blob | File;
+
+  /** Optional initial memory (bytes). */
+  initialMemory?: number;
+}
+
+/**
+ * Extended Kysely instance that exposes the raw PGlite instance.
+ * Use this type when you need access to PGlite's native features like live queries.
+ */
+export interface PgliteDb<T> extends Kysely<T> {
+  /** Access raw PGlite instance for live queries */
+  readonly pglite: PGliteWithLive;
+}
+
+/**
+ * Create a Kysely instance with PGlite dialect.
+ * Synchronous version - database may not be fully ready immediately.
+ *
+ * Note: This version does NOT include the live extension or expose the raw PGlite instance.
+ * For live query support, use createPgliteDbAsync() instead.
+ *
+ * @example
+ * const db = createPgliteDb<MyDb>(); // In-memory
+ * const db = createPgliteDb<MyDb>({ dataDir: './pgdata' }); // Persistent
+ */
+export function createPgliteDb<T>(options?: PgliteOptions): Kysely<T> {
+  const database = options ? new PGlite(options) : new PGlite();
+  return new Kysely<T>({
+    dialect: new PGliteDialect(database),
+  });
+}
+
+/**
+ * Create a Kysely instance with PGlite dialect, waiting for database to be ready.
+ * Async version - ensures database is fully initialized before returning.
+ * Includes the live extension for reactive queries.
+ *
+ * @example
+ * const db = await createPgliteDbAsync<MyDb>(); // In-memory
+ * const db = await createPgliteDbAsync<MyDb>({ dataDir: 'idb://mydb' }); // Persistent
+ * // Access raw PGlite for live queries:
+ * db.pglite.live.incrementalQuery(...)
+ */
+export async function createPgliteDbAsync<T>(
+  options?: PgliteOptions
+): Promise<PgliteDb<T>> {
+  const database = await PGlite.create({
+    ...options,
+    extensions: { live },
+  });
+
+  const db = new Kysely<T>({
+    dialect: new PGliteDialect(database),
+  });
+
+  // Attach raw instance for live query access using Object.defineProperty
+  // to properly define the readonly property
+  Object.defineProperty(db, 'pglite', {
+    value: database,
+    writable: false,
+    enumerable: true,
+    configurable: false,
+  });
+
+  return db as PgliteDb<T>;
+}
+
+/**
+ * Create the PGlite dialect directly.
+ */
+export function createPgliteDialect(options?: PgliteOptions): PGliteDialect {
+  const database = options ? new PGlite(options) : new PGlite();
+  return new PGliteDialect(database);
+}
+// Re-export types for convenience
+
+export function getPgliteAssetPaths(): {
+  fsBundlePath: string;
+  wasmPath: string;
+} {
+  const entry = import.meta.resolve('@electric-sql/pglite');
+
+  return {
+    fsBundlePath: new URL('./pglite.data', entry).pathname,
+    wasmPath: new URL('./pglite.wasm', entry).pathname,
+  };
+}