tanstack-db-pglite 1.0.6 → 1.1.1

package/dist/drizzle.d.ts

@@ -1,7 +1,9 @@
 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';
-export declare function drizzleCollectionOptions<Table extends PgTable, SyncParams extends Parameters<SyncConfig<Table['$inferSelect'], string>['sync']>[0] = Parameters<SyncConfig<Table['$inferSelect'], string>['sync']>[0]>({ startSync, ...config }: {
+import type { CreateSelectSchema } from 'drizzle-zod';
+type SyncParams<Table extends PgTable> = Parameters<SyncConfig<Table['$inferSelect'], string>['sync']>[0];
+export declare function drizzleCollectionOptions<Table extends PgTable>({ startSync, ...config }: {
     db: PgliteDatabase<any>;
     table: Table;
     primaryColumn: IndexColumn;
@@ -10,9 +12,8 @@ export declare function drizzleCollectionOptions<Table extends PgTable, SyncPara
     onDelete?: (params: DeleteMutationFnParams<Table['$inferSelect'], string>) => Promise<void>;
     startSync?: boolean;
     prepare?: () => Promise<unknown> | unknown;
-    sync?: (params: Pick<SyncParams, 'write' | 'collection'>) => Promise<void>;
-}): CollectionConfig<Table['$inferSelect'], string> & {
-    utils: {
-        runSync: () => Promise<void>;
-    };
-};
+    sync?: (params: Pick<SyncParams<Table>, 'write' | 'collection'>) => Promise<void>;
+}): CollectionConfig<Table['$inferSelect'], string, ReturnType<CreateSelectSchema<Table['$inferSelect']>>, {
+    runSync: () => Promise<void>;
+}>;
+export {};

package/dist/drizzle.js

@@ -34,19 +34,20 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
     const getSyncParams = async () => {
         const params = await syncParams;
         return {
-            write: async (p) => {
+            write: async (message) => {
                 params.begin();
                 try {
-                    if (p.type === 'insert') {
-                        await onDrizzleInsert([p.value]);
+                    if (message.type === 'insert') {
+                        await onDrizzleInsert([message.value]);
                     }
-                    else if (p.type === 'update') {
-                        await onDrizzleUpdate(params.collection.getKeyFromItem(p.value), p.value);
+                    else if (message.type === 'update') {
+                        await onDrizzleUpdate(params.collection.getKeyFromItem(message.value), message.value);
                     }
-                    else if (p.type === 'delete') {
-                        await onDrizzleDelete([params.collection.getKeyFromItem(p.value)]);
+                    else if (message.type === 'delete') {
+                        const key = 'key' in message ? message.key : params.collection.getKeyFromItem(message.value);
+                        await onDrizzleDelete([key]);
                     }
-                    params.write(p);
+                    params.write(message);
                 }
                 finally {
                     params.commit();
@@ -60,7 +61,12 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
         const { begin, write, commit } = await syncParams;
         begin();
         mutations.forEach((m) => {
-            write({ type: m.type, value: m.modified });
+            if (m.type === 'delete') {
+                write({ type: 'delete', key: m.key });
+            }
+            else {
+                write({ type: m.type, value: m.modified });
+            }
         });
         commit();
     }

package/dist/index.d.ts

@@ -1 +1,2 @@
 export * from './drizzle';
+export * from './sql';

package/dist/index.js

@@ -1 +1,2 @@
 export * from './drizzle';
+export * from './sql';

package/dist/sql.d.ts

@@ -1,20 +1,24 @@
 import type { PGlite } from '@electric-sql/pglite';
+import type { PGliteWorker } from '@electric-sql/pglite/worker';
 import type { StandardSchemaV1 } from '@standard-schema/spec';
 import type { CollectionConfig, DeleteMutationFnParams, InsertMutationFnParams, SyncConfig, UpdateMutationFnParams } from '@tanstack/db';
-export declare function sqlCollectionOptions<ItemType extends Record<string, unknown>, Schema extends StandardSchemaV1<ItemType, ItemType> = StandardSchemaV1<ItemType, ItemType>, SyncParams extends Parameters<SyncConfig<ItemType, string>['sync']>[0] = Parameters<SyncConfig<ItemType, string>['sync']>[0]>({ startSync, ...config }: {
-    db: PGlite;
+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;
     tableName: string;
-    primaryKeyColumn: string;
+    primaryKeyColumn: Extract<keyof Output<Schema>, string>;
     schema: Schema;
-    getKey?: (row: ItemType) => string;
-    onInsert?: (params: InsertMutationFnParams<ItemType, string>) => Promise<void>;
-    onUpdate?: (params: UpdateMutationFnParams<ItemType, string>) => Promise<void>;
-    onDelete?: (params: DeleteMutationFnParams<ItemType, string>) => Promise<void>;
+    getKey?: (row: Output<Schema>) => string;
+    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, 'write' | 'collection'>) => Promise<void>;
-}): CollectionConfig<ItemType, string> & {
-    utils: {
-        runSync: () => Promise<void>;
-    };
+    sync?: (params: Pick<SyncParams<Output<Schema>>, 'write' | 'collection'>) => Promise<void>;
+}): CollectionConfig<Output<Schema>, string, Schema, {
+    runSync: () => Promise<void>;
+}> & {
+    schema: Schema;
 };
+export {};

package/dist/sql.js

@@ -1,4 +1,5 @@
 function quoteId(name) {
+    // eslint-disable-next-line e18e/prefer-static-regex
     return `"${String(name).replace(/"/g, '""')}"`;
 }
 export function sqlCollectionOptions({ startSync = true, ...config }) {
@@ -6,11 +7,11 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
     const primaryKey = quoteId(config.primaryKeyColumn);
     const getKey = config.getKey ?? ((row) => String(row[config.primaryKeyColumn]));
     const { promise: syncParams, resolve: resolveSyncParams } = Promise.withResolvers();
-    async function runSelect(conn) {
-        const result = await conn.query(`SELECT * FROM ${table}`);
+    async function runSelect(client) {
+        const result = await client.query(`SELECT * FROM ${table}`);
         return (result.rows ?? []);
     }
-    async function runInsert(conn, rows) {
+    async function runInsert(client, rows) {
         for (const row of rows) {
             const cols = Object.keys(row).filter(k => row[k] !== undefined);
             if (cols.length === 0)
@@ -18,21 +19,21 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
             const columns = cols.map(quoteId).join(', ');
             const placeholders = cols.map((_, i) => `$${i + 1}`).join(', ');
             const values = cols.map(c => row[c]);
-            await conn.query(`INSERT INTO ${table} (${columns}) VALUES (${placeholders})`, values);
+            await client.query(`INSERT INTO ${table} (${columns}) VALUES (${placeholders})`, values);
         }
     }
-    async function runUpdate(conn, id, changes) {
+    async function runUpdate(client, id, changes) {
         const entries = Object.entries(changes).filter(([, v]) => v !== undefined);
         if (entries.length === 0)
             return;
         const setClause = entries.map(([k], i) => `${quoteId(k)} = $${i + 1}`).join(', ');
         const params = [...entries.map(([, v]) => v), id];
-        await conn.query(`UPDATE ${table} SET ${setClause} WHERE ${primaryKey} = $${params.length}`, params);
+        await client.query(`UPDATE ${table} SET ${setClause} WHERE ${primaryKey} = $${params.length}`, params);
     }
-    async function runDelete(conn, ids) {
+    async function runDelete(client, ids) {
         if (ids.length === 0)
             return;
-        await conn.query(`DELETE FROM ${table} WHERE ${primaryKey} = ANY($1)`, [ids]);
+        await client.query(`DELETE FROM ${table} WHERE ${primaryKey} = ANY($1)`, [ids]);
     }
     const getSyncParams = async () => {
         const params = await syncParams;
@@ -47,7 +48,8 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
                         await runUpdate(config.db, params.collection.getKeyFromItem(p.value), p.value);
                     }
                     else if (p.type === 'delete') {
-                        await runDelete(config.db, [params.collection.getKeyFromItem(p.value)]);
+                        const key = 'key' in p ? p.key : params.collection.getKeyFromItem(p.value);
+                        await runDelete(config.db, [key]);
                     }
                     params.write(p);
                 }
@@ -62,12 +64,17 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
         const { begin, write, commit } = await syncParams;
         begin();
         mutations.forEach((m) => {
-            write({ type: m.type, value: m.modified });
+            if (m.type === 'delete') {
+                write({ type: 'delete', key: m.key });
+            }
+            else {
+                write({ type: m.type, value: m.modified });
+            }
         });
         commit();
     }
     return {
-        startSync: true,
+        startSync,
         sync: {
             sync: (params) => {
                 resolveSyncParams(params);
@@ -91,7 +98,6 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
             },
         },
         gcTime: 0,
-        // @ts-expect-error CollectionConfig schema type does not include StandardSchemaV1
         schema: config.schema,
         getKey,
         onInsert: async (params) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "tanstack-db-pglite",
-  "version": "1.0.6",
-  "packageManager": "pnpm@10.30.3",
+  "version": "1.1.1",
+  "packageManager": "pnpm@10.32.1",
   "description": "",
   "author": "Valerii Strilets",
   "license": "MIT",
@@ -42,10 +42,11 @@
     "drizzle-zod": "^0.8.3"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^7.6.1",
-    "eslint": "^10.0.2",
+    "@antfu/eslint-config": "^7.7.2",
+    "@standard-schema/spec": "^1.1.0",
+    "eslint": "^10.0.3",
     "jiti": "^2.6.1",
-    "taze": "^19.9.2",
+    "taze": "^19.10.0",
     "typescript": "^5.9.3"
   }
 }

package/dist/drizzle-collection-options.d.ts

@@ -1,20 +0,0 @@
-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';
-export declare function drizzleCollectionOptions<Table extends PgTable>({ startSync, ...config }: {
-    db: PgliteDatabase<any>;
-    table: Table;
-    primaryColumn: IndexColumn;
-    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;
-    sync: {
-        prepare?: () => Promise<any> | any;
-        sync: (params: Pick<Parameters<SyncConfig<Table['$inferSelect'], string>['sync']>[0], 'write' | 'collection'>) => Promise<void>;
-    };
-}): CollectionConfig<Table['$inferSelect'], string> & {
-    utils: {
-        runSync: () => Promise<void>;
-    };
-};

package/dist/drizzle-collection-options.js

@@ -1,106 +0,0 @@
-import { eq, inArray } from 'drizzle-orm';
-import { createSelectSchema } from 'drizzle-zod';
-export function drizzleCollectionOptions({ startSync = true, ...config }) {
-    // Sync params can be null while running PGLite migrations
-    const { promise: syncParams, resolve: resolveSyncParams } = Promise.withResolvers();
-    async function runMutations(mutations) {
-        const { begin, write, commit } = await syncParams;
-        begin();
-        mutations.forEach((m) => {
-            write({ type: m.type, value: m.modified });
-        });
-        commit();
-    }
-    async function onDrizzleInsert(data) {
-        // @ts-expect-error drizzle types
-        await config.db.insert(config.table).values(data);
-    }
-    async function onDrizzleUpdate(id, changes) {
-        await config.db
-            .update(config.table)
-            .set(changes)
-            .where(eq(config.primaryColumn, id));
-    }
-    async function onDrizzleDelete(ids) {
-        await config.db
-            .delete(config.table)
-            .where(inArray(config.primaryColumn, ids));
-    }
-    const getSyncParams = async () => {
-        const params = await syncParams;
-        return {
-            write: async (p) => {
-                params.begin();
-                try {
-                    if (p.type === 'insert') {
-                        await onDrizzleInsert([p.value]);
-                    }
-                    else if (p.type === 'update') {
-                        await onDrizzleUpdate(params.collection.getKeyFromItem(p.value), p.value);
-                    }
-                    else if (p.type === 'delete') {
-                        await onDrizzleDelete([params.collection.getKeyFromItem(p.value)]);
-                    }
-                    params.write(p);
-                }
-                finally {
-                    params.commit();
-                }
-            },
-            collection: params.collection,
-        };
-    };
-    return {
-        startSync: true,
-        sync: {
-            sync: async (params) => {
-                try {
-                    resolveSyncParams(params);
-                    await config.sync.prepare?.();
-                    params.begin();
-                    // @ts-expect-error drizzle types
-                    const dbs = await config.db.select().from(config.table);
-                    dbs.forEach((db) => {
-                        params.write({ type: 'insert', value: db });
-                    });
-                    params.commit();
-                    if (config.sync && startSync) {
-                        await config.sync.sync(await getSyncParams());
-                    }
-                }
-                finally {
-                    params.markReady();
-                }
-            },
-        },
-        gcTime: 0,
-        schema: createSelectSchema(config.table),
-        getKey: t => t[config.primaryColumn.name],
-        onDelete: async (params) => {
-            await onDrizzleDelete(params.transaction.mutations.map(m => m.key));
-            const result = await config.onDelete?.(params);
-            await runMutations(params.transaction.mutations);
-            return result;
-        },
-        onInsert: async (params) => {
-            await onDrizzleInsert(params.transaction.mutations.map(m => m.modified));
-            const result = await config.onInsert?.(params);
-            await runMutations(params.transaction.mutations);
-            return result;
-        },
-        onUpdate: async (params) => {
-            await Promise.all(params.transaction.mutations.map(m => onDrizzleUpdate(m.key, m.changes)));
-            const result = await config.onUpdate?.(params);
-            await runMutations(params.transaction.mutations);
-            return result;
-        },
-        utils: {
-            runSync: async () => {
-                const params = await getSyncParams();
-                // To wait the first sync
-                await params.collection.stateWhenReady();
-                await config.sync.sync(params);
-            },
-        },
-    };
-}