tanstack-db-pglite 1.0.0 → 1.0.2

package/README.md

@@ -1,6 +1,6 @@
 # tanstack-db-pglite
 
-A seamless integration between [TanStack DB](https://tanstack.com/db) and [PGLite](https://github.com/electric-sql/pglite) with [Drizzle ORM](https://orm.drizzle.team/) for browser-based database management, providing powerful collection management with automatic synchronization and offline-first capabilities.
+A seamless integration between [TanStack DB](https://tanstack.com/db) and [PGLite](https://github.com/electric-sql/pglite) with [Drizzle ORM](https://orm.drizzle.team/) for browser-based database management.
 
 ## Installation
 

package/dist/drizzle.d.ts

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

package/dist/drizzle.js

@@ -3,28 +3,18 @@ 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) {
+    // eslint-disable-next-line ts/no-explicit-any
+    async function onDrizzleInsert(data, tx) {
         // @ts-expect-error drizzle types
-        await config.db.insert(config.table).values(data);
+        await (tx || 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));
+    // eslint-disable-next-line ts/no-explicit-any
+    async function onDrizzleUpdate(id, changes, tx) {
+        await (tx || 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));
+    // eslint-disable-next-line ts/no-explicit-any
+    async function onDrizzleDelete(ids, tx) {
+        await (tx || config.db).delete(config.table).where(inArray(config.primaryColumn, ids));
     }
     const getSyncParams = async () => {
         const params = await syncParams;
@@ -50,6 +40,15 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
             collection: params.collection,
         };
     };
+    // Mutations should run if everything is okay inside "on" handlers
+    async function runMutations(mutations) {
+        const { begin, write, commit } = await syncParams;
+        begin();
+        mutations.forEach((m) => {
+            write({ type: m.type, value: m.modified });
+        });
+        commit();
+    }
     return {
         startSync: true,
         sync: {
@@ -76,26 +75,32 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
         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 config.db.transaction(async (tx) => {
+                await onDrizzleInsert(params.transaction.mutations.map(m => m.modified), tx);
+                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 config.db.transaction(async (tx) => {
+                await Promise.all(params.transaction.mutations.map(m => onDrizzleUpdate(m.key, m.changes, tx)));
+                await config.onUpdate?.(params);
+            });
+            await runMutations(params.transaction.mutations);
+        },
+        onDelete: async (params) => {
+            await config.db.transaction(async (tx) => {
+                await onDrizzleDelete(params.transaction.mutations.map(m => m.key), tx);
+                await config.onDelete?.(params);
+            });
             await runMutations(params.transaction.mutations);
-            return result;
         },
         utils: {
             runSync: async () => {
+                if (!config.sync) {
+                    throw new Error('Sync is not defined');
+                }
                 const params = await getSyncParams();
                 // To wait the first sync
                 await params.collection.stateWhenReady();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tanstack-db-pglite",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "packageManager": "pnpm@10.16.1",
   "description": "",
   "author": "Valerii Strilets",