tanstack-db-pglite 1.1.5 → 1.1.7

package/dist/drizzle.d.ts

@@ -1,46 +1,21 @@
-import type { DeleteMutationFnParams, InsertMutationFnParams, SyncConfig, UpdateMutationFnParams } from '@tanstack/db';
+import type { StandardSchemaV1 } from '@standard-schema/spec';
+import type { CollectionConfig, DeleteMutationFnParams, InsertMutationFnParams, SyncConfig, UpdateMutationFnParams } from '@tanstack/db';
 import type { IndexColumn, PgTable } from 'drizzle-orm/pg-core';
 import type { PgliteDatabase } from 'drizzle-orm/pglite';
-import type { BuildSchema } from 'drizzle-zod';
+import type { PgliteUtils } from './utils';
+type Schema<Table extends PgTable> = StandardSchemaV1<Table['$inferSelect'], Table['$inferSelect']>;
 type SyncParams<Table extends PgTable> = Parameters<SyncConfig<Table['$inferSelect'], string>['sync']>[0];
 export declare function drizzleCollectionOptions<Table extends PgTable>({ startSync, ...config }: {
     db: PgliteDatabase<any>;
+    startSync?: boolean;
     table: Table;
     primaryColumn: IndexColumn;
+    sync?: (params: Pick<SyncParams<Table>, 'write' | 'collection'>) => Promise<void>;
+    prepare?: () => Promise<unknown> | unknown;
     onInsert?: (params: InsertMutationFnParams<Table['$inferSelect'], string>) => Promise<void>;
     onUpdate?: (params: UpdateMutationFnParams<Table['$inferSelect'], string>) => Promise<void>;
     onDelete?: (params: DeleteMutationFnParams<Table['$inferSelect'], string>) => Promise<void>;
-    startSync?: boolean;
-    prepare?: () => Promise<unknown> | unknown;
-    sync?: (params: Pick<SyncParams<Table>, 'write' | 'collection'>) => Promise<void>;
-}): {
-    startSync: true;
-    sync: {
-        sync: (params: {
-            collection: import("@tanstack/db").Collection<Table["$inferSelect"], string, any, any, any>;
-            begin: (options?: {
-                immediate?: boolean;
-            }) => void;
-            write: (message: import("@tanstack/db").ChangeMessageOrDeleteKeyMessage<Table["$inferSelect"], string>) => void;
-            commit: () => void;
-            markReady: () => void;
-            truncate: () => void;
-        }) => void;
-    };
-    gcTime: number;
-    schema: BuildSchema<"select", Table["_"]["columns"], undefined, undefined>;
-    getKey: (t: Table["$inferSelect"]) => string;
-    onInsert: (params: InsertMutationFnParams<Table["$inferSelect"], string, {
-        runSync: () => Promise<void>;
-    }>) => Promise<void>;
-    onUpdate: (params: UpdateMutationFnParams<Table["$inferSelect"], string, {
-        runSync: () => Promise<void>;
-    }>) => Promise<void>;
-    onDelete: (params: DeleteMutationFnParams<Table["$inferSelect"], string, {
-        runSync: () => Promise<void>;
-    }>) => Promise<void>;
-    utils: {
-        runSync: () => Promise<void>;
-    };
+}): CollectionConfig<Table['$inferSelect'], string, Schema<Table>, PgliteUtils> & {
+    schema: Schema<Table>;
 };
 export {};

package/dist/drizzle.js

@@ -1,6 +1,7 @@
 import { eq, inArray } from 'drizzle-orm';
 import { createSelectSchema } from 'drizzle-zod';
 export function drizzleCollectionOptions({ startSync = true, ...config }) {
+    let resolvers = Promise.withResolvers();
     // Sync params can be null while running PGLite migrations
     const { promise: syncParams, resolve: resolveSyncParams } = Promise.withResolvers();
     // eslint-disable-next-line ts/no-explicit-any
@@ -86,12 +87,12 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
             .from(config.table)
             .where(eq(config.primaryColumn, m.key))));
     }
-    const schema = createSelectSchema(config.table);
     return {
         startSync: true,
         sync: {
             sync: (params) => {
                 resolveSyncParams(params);
+                resolvers = Promise.withResolvers();
                 (async () => {
                     try {
                         await config.prepare?.();
@@ -104,6 +105,7 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
                         params.commit();
                         if (config.sync && startSync) {
                             await config.sync(await getSyncParams());
+                            resolvers.resolve(undefined);
                         }
                     }
                     finally {
@@ -113,7 +115,7 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
             },
         },
         gcTime: 0,
-        schema,
+        schema: createSelectSchema(config.table),
         getKey: t => t[config.primaryColumn.name],
         onInsert: async (params) => {
             await config.db.transaction(async (tx) => {
@@ -155,6 +157,9 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
                 await params.collection.stateWhenReady();
                 await config.sync(params);
             },
+            waitForSync: async () => {
+                await resolvers.promise;
+            },
         },
     };
 }

package/dist/sql.d.ts

@@ -1,49 +1,23 @@
 import type { PGlite } from '@electric-sql/pglite';
 import type { PGliteWorker } from '@electric-sql/pglite/worker';
 import type { StandardSchemaV1 } from '@standard-schema/spec';
-import type { DeleteMutationFnParams, InsertMutationFnParams, SyncConfig, UpdateMutationFnParams } from '@tanstack/db';
+import type { CollectionConfig, DeleteMutationFnParams, InsertMutationFnParams, SyncConfig, UpdateMutationFnParams } from '@tanstack/db';
+import type { PgliteUtils } from './utils';
 type Output<T extends StandardSchemaV1> = StandardSchemaV1.InferOutput<T>;
 type SyncParams<ItemType extends Record<string, unknown>> = Parameters<SyncConfig<ItemType, string>['sync']>[0];
 export declare function sqlCollectionOptions<Schema extends StandardSchemaV1<Record<string, unknown>>>({ startSync, ...config }: {
     db: PGlite | PGliteWorker;
+    startSync?: boolean;
     tableName: string;
     primaryKeyColumn: Extract<keyof Output<Schema>, string>;
     schema: Schema;
     getKey?: (row: Output<Schema>) => string;
+    prepare?: () => Promise<unknown> | unknown;
+    sync?: (params: Pick<SyncParams<Output<Schema>>, 'write' | 'collection'>) => Promise<void>;
     onInsert?: (params: InsertMutationFnParams<Output<Schema>, string>) => Promise<void>;
     onUpdate?: (params: UpdateMutationFnParams<Output<Schema>, string>) => Promise<void>;
     onDelete?: (params: DeleteMutationFnParams<Output<Schema>, string>) => Promise<void>;
-    startSync?: boolean;
-    prepare?: () => Promise<unknown> | unknown;
-    sync?: (params: Pick<SyncParams<Output<Schema>>, 'write' | 'collection'>) => Promise<void>;
-}): {
-    startSync: boolean;
-    sync: {
-        sync: (params: {
-            collection: import("@tanstack/db").Collection<Output<Schema>, string, any, any, any>;
-            begin: (options?: {
-                immediate?: boolean;
-            }) => void;
-            write: (message: import("@tanstack/db").ChangeMessageOrDeleteKeyMessage<Output<Schema>, string>) => void;
-            commit: () => void;
-            markReady: () => void;
-            truncate: () => void;
-        }) => void;
-    };
-    gcTime: number;
-    schema: Schema;
-    getKey: (row: Output<Schema>) => string;
-    onInsert: (params: InsertMutationFnParams<Output<Schema>, string, {
-        runSync: () => Promise<void>;
-    }>) => Promise<void>;
-    onUpdate: (params: UpdateMutationFnParams<Output<Schema>, string, {
-        runSync: () => Promise<void>;
-    }>) => Promise<void>;
-    onDelete: (params: DeleteMutationFnParams<Output<Schema>, string, {
-        runSync: () => Promise<void>;
-    }>) => Promise<void>;
-    utils: {
-        runSync: () => Promise<void>;
-    };
+}): CollectionConfig<Output<Schema>, string, Schema, PgliteUtils> & {
+    schema: typeof config.schema;
 };
 export {};

package/dist/sql.js

@@ -3,6 +3,7 @@ function quoteId(name) {
     return `"${String(name).replace(/"/g, '""')}"`;
 }
 export function sqlCollectionOptions({ startSync = true, ...config }) {
+    let resolvers = Promise.withResolvers();
     const table = quoteId(config.tableName);
     const primaryKey = quoteId(config.primaryKeyColumn);
     const getKey = config.getKey ?? ((row) => String(row[config.primaryKeyColumn]));
@@ -78,6 +79,7 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
         sync: {
             sync: (params) => {
                 resolveSyncParams(params);
+                resolvers = Promise.withResolvers();
                 (async () => {
                     try {
                         await config.prepare?.();
@@ -89,6 +91,7 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
                         params.commit();
                         if (config.sync && startSync) {
                             await config.sync(await getSyncParams());
+                            resolvers.resolve(undefined);
                         }
                     }
                     finally {
@@ -136,6 +139,9 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
                 await params.collection.stateWhenReady();
                 await config.sync(params);
             },
+            waitForSync: async () => {
+                await resolvers.promise;
+            },
         },
     };
 }

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+import type { UtilsRecord } from '@tanstack/db';
+export interface PgliteUtils extends UtilsRecord {
+    runSync: () => Promise<void>;
+    waitForSync: () => Promise<void>;
+}

package/dist/utils.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tanstack-db-pglite",
-  "version": "1.1.5",
+  "version": "1.1.7",
   "packageManager": "pnpm@10.32.1",
   "description": "",
   "author": "Valerii Strilets",