tanstack-db-pglite 1.4.1 → 1.5.0

package/README.md

@@ -38,12 +38,12 @@ export const chatsCollection = createCollection(drizzleCollectionOptions({
   prepare: async () => {
     await waitForMigrations()
   },
-  sync: async ({ write, markReady }) => {
+  sync: async ({ writeAsync, markReady }) => {
     const eventSource = new EventSource('/api/chats/sync')
 
     eventSource.onmessage = (event) => {
       const item = JSON.parse(event.data)
-      write(item)
+      writeAsync(item)
     }
 
     eventSource.addEventListener('ready', () => markReady())
@@ -94,12 +94,12 @@ export const chatsCollection = createCollection(sqlCollectionOptions({
       )
     `)
   },
-  sync: async ({ write, markReady }) => {
+  sync: async ({ writeAsync, markReady }) => {
     const eventSource = new EventSource('/api/chats/sync')
 
     eventSource.onmessage = (event) => {
       const item = JSON.parse(event.data)
-      write(item)
+      writeAsync(item)
     }
 
     eventSource.addEventListener('ready', () => markReady())

package/dist/drizzle.d.ts

@@ -1,10 +1,16 @@
 import type { StandardSchemaV1 } from '@standard-schema/spec';
-import type { CollectionConfig, DeleteMutationFnParams, InsertMutationFnParams, SyncConfig, UpdateMutationFnParams } from '@tanstack/db';
+import type { ChangeMessageOrDeleteKeyMessage, 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 { 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];
+type CustomSyncParams<Table extends PgTable> = Pick<SyncParams<Table>, 'collection' | 'markReady' | 'metadata'> & {
+    /**
+     * We created async version of "write" callback due to synchronization with PGLite
+     */
+    writeAsync: (message: ChangeMessageOrDeleteKeyMessage<Table['$inferSelect'], string>) => Promise<void>;
+};
 /**
  * Creates collection options backed by Drizzle ORM on PGlite.
  *
@@ -17,7 +23,7 @@ export declare function drizzleCollectionOptions<Table extends PgTable>({ startS
     db: PgliteDatabase<any>;
     startSync?: boolean;
     sync?: {
-        sync: (params: Pick<SyncParams<Table>, 'write' | 'collection' | 'markReady' | 'metadata'>) => Promise<(() => void) | void>;
+        sync: (params: CustomSyncParams<Table>) => Promise<(() => void) | void>;
     } & Omit<SyncConfig, 'sync'>;
     table: Table;
     primaryColumn: IndexColumn;

package/dist/drizzle.js

@@ -78,7 +78,7 @@ export function drizzleCollectionOptions({ startSync = true, ...config }) {
             return;
         }
         return config.sync.sync({
-            write: async (message) => {
+            writeAsync: async (message) => {
                 if (message.type === 'insert') {
                     await onDrizzleInsert([message.value]);
                 }

package/dist/sql.d.ts

@@ -1,10 +1,16 @@
 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';
+import type { ChangeMessageOrDeleteKeyMessage, 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];
+type CustomSyncParams<ItemType extends Record<string, unknown>> = Pick<SyncParams<ItemType>, 'collection' | 'markReady' | 'metadata'> & {
+    /**
+     * We created async version of "write" callback due to synchronization with PGLite
+     */
+    writeAsync: (message: ChangeMessageOrDeleteKeyMessage<ItemType, string>) => Promise<void>;
+};
 /**
  * Creates collection options backed by raw SQL on PGlite.
  *
@@ -17,7 +23,7 @@ export declare function sqlCollectionOptions<Schema extends StandardSchemaV1<Rec
     db: PGlite | PGliteWorker;
     startSync?: boolean;
     sync?: {
-        sync: (params: Pick<SyncParams<Output<Schema>>, 'write' | 'collection' | 'markReady' | 'metadata'>) => Promise<(() => void) | void>;
+        sync: (params: CustomSyncParams<Output<Schema>>) => Promise<(() => void) | void>;
     } & Omit<SyncConfig, 'sync'>;
     tableName: string;
     primaryKeyColumn: Extract<keyof Output<Schema>, string>;

package/dist/sql.js

@@ -64,7 +64,7 @@ export function sqlCollectionOptions({ startSync = true, ...config }) {
             return;
         }
         return config.sync.sync({
-            write: async (p) => {
+            writeAsync: async (p) => {
                 if (p.type === 'insert') {
                     await runInsert(config.db, [p.value]);
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tanstack-db-pglite",
-  "version": "1.4.1",
+  "version": "1.5.0",
   "author": "Valerii Strilets",
   "license": "MIT",
   "repository": {