@powersync/common 1.21.0 → 1.22.0

package/lib/client/compilableQueryWatch.d.ts

@@ -0,0 +1,7 @@
+import { CompilableQuery } from './../types/types.js';
+import { AbstractPowerSyncDatabase, SQLWatchOptions } from './AbstractPowerSyncDatabase.js';
+export interface CompilableQueryWatchHandler<T> {
+    onResult: (results: T[]) => void;
+    onError?: (error: Error) => void;
+}
+export declare function compilableQueryWatch<T>(db: AbstractPowerSyncDatabase, query: CompilableQuery<T>, handler: CompilableQueryWatchHandler<T>, options?: SQLWatchOptions): void;

package/lib/client/compilableQueryWatch.js

@@ -0,0 +1,37 @@
+import { runOnSchemaChange } from './runOnSchemaChange.js';
+export function compilableQueryWatch(db, query, handler, options) {
+    const { onResult, onError = (e) => { } } = handler ?? {};
+    if (!onResult) {
+        throw new Error('onResult is required');
+    }
+    const watchQuery = async (abortSignal) => {
+        try {
+            const toSql = query.compile();
+            const resolvedTables = await db.resolveTables(toSql.sql, toSql.parameters, options);
+            // Fetch initial data
+            const result = await query.execute();
+            onResult(result);
+            db.onChangeWithCallback({
+                onChange: async () => {
+                    try {
+                        const result = await query.execute();
+                        onResult(result);
+                    }
+                    catch (error) {
+                        onError(error);
+                    }
+                },
+                onError
+            }, {
+                ...(options ?? {}),
+                tables: resolvedTables,
+                // Override the abort signal since we intercept it
+                signal: abortSignal
+            });
+        }
+        catch (error) {
+            onError(error);
+        }
+    };
+    runOnSchemaChange(watchQuery, db, options);
+}

package/lib/db/schema/Schema.d.ts

@@ -1,6 +1,6 @@
 import { RowType, Table } from './Table.js';
 type SchemaType = Record<string, Table<any>>;
-type SchemaTableType<S extends SchemaType> = {
+export type SchemaTableType<S extends SchemaType> = {
     [K in keyof S]: RowType<S[K]>;
 };
 /**

package/lib/index.d.ts

@@ -5,6 +5,7 @@ export * from './client/connection/PowerSyncBackendConnector.js';
 export * from './client/connection/PowerSyncCredentials.js';
 export * from './client/sync/bucket/BucketStorageAdapter.js';
 export { runOnSchemaChange } from './client/runOnSchemaChange.js';
+export { CompilableQueryWatchHandler, compilableQueryWatch } from './client/compilableQueryWatch.js';
 export { UpdateType, CrudEntry, OpId } from './client/sync/bucket/CrudEntry.js';
 export * from './client/sync/bucket/SqliteBucketStorage.js';
 export * from './client/sync/bucket/CrudBatch.js';

package/lib/index.js

@@ -5,6 +5,7 @@ export * from './client/connection/PowerSyncBackendConnector.js';
 export * from './client/connection/PowerSyncCredentials.js';
 export * from './client/sync/bucket/BucketStorageAdapter.js';
 export { runOnSchemaChange } from './client/runOnSchemaChange.js';
+export { compilableQueryWatch } from './client/compilableQueryWatch.js';
 export { UpdateType, CrudEntry } from './client/sync/bucket/CrudEntry.js';
 export * from './client/sync/bucket/SqliteBucketStorage.js';
 export * from './client/sync/bucket/CrudBatch.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@powersync/common",
-  "version": "1.21.0",
+  "version": "1.22.0",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"