@powersync/common 1.38.0 → 1.38.1

package/dist/index.d.cts

@@ -1815,12 +1815,14 @@ declare enum WatchedQueryListenerEvent {
     ON_DATA = "onData",
     ON_ERROR = "onError",
     ON_STATE_CHANGE = "onStateChange",
+    SETTINGS_WILL_UPDATE = "settingsWillUpdate",
     CLOSED = "closed"
 }
 interface WatchedQueryListener<Data> extends BaseListener {
     [WatchedQueryListenerEvent.ON_DATA]?: (data: Data) => void | Promise<void>;
     [WatchedQueryListenerEvent.ON_ERROR]?: (error: Error) => void | Promise<void>;
     [WatchedQueryListenerEvent.ON_STATE_CHANGE]?: (state: WatchedQueryState<Data>) => void | Promise<void>;
+    [WatchedQueryListenerEvent.SETTINGS_WILL_UPDATE]?: () => void;
     [WatchedQueryListenerEvent.CLOSED]?: () => void | Promise<void>;
 }
 declare const DEFAULT_WATCH_THROTTLE_MS = 30;
@@ -1886,6 +1888,7 @@ declare abstract class AbstractQueryProcessor<Data = unknown[], Settings extends
     constructor(options: AbstractQueryProcessorOptions<Data, Settings>);
     protected constructInitialState(): WatchedQueryState<Data>;
     protected get reportFetching(): boolean;
+    protected updateSettingsInternal(settings: Settings, signal: AbortSignal): Promise<void>;
     /**
      * Updates the underlying query.
      */
@@ -1899,7 +1902,7 @@ declare abstract class AbstractQueryProcessor<Data = unknown[], Settings extends
     /**
      * Configures base DB listeners and links the query to listeners.
      */
-    protected init(): Promise<void>;
+    protected init(signal: AbortSignal): Promise<void>;
     close(): Promise<void>;
     /**
      * Runs a callback and reports errors to the error listeners.
@@ -2549,7 +2552,7 @@ interface TriggerManager {
      *        },
      *        onChange: async (context) => {
      *          // Fetches the todo records that were inserted during this diff
-     *          const newTodos = await context.getAll<Database['todos']>(`
+     *          const newTodos = await context.withDiff<Database['todos']>(`
      *            SELECT
      *              todos.*
      *            FROM

package/lib/client/triggers/TriggerManager.d.ts

@@ -323,7 +323,7 @@ export interface TriggerManager {
      *        },
      *        onChange: async (context) => {
      *          // Fetches the todo records that were inserted during this diff
-     *          const newTodos = await context.getAll<Database['todos']>(`
+     *          const newTodos = await context.withDiff<Database['todos']>(`
      *            SELECT
      *              todos.*
      *            FROM

package/lib/client/watched/WatchedQuery.d.ts

@@ -65,12 +65,14 @@ export declare enum WatchedQueryListenerEvent {
     ON_DATA = "onData",
     ON_ERROR = "onError",
     ON_STATE_CHANGE = "onStateChange",
+    SETTINGS_WILL_UPDATE = "settingsWillUpdate",
     CLOSED = "closed"
 }
 export interface WatchedQueryListener<Data> extends BaseListener {
     [WatchedQueryListenerEvent.ON_DATA]?: (data: Data) => void | Promise<void>;
     [WatchedQueryListenerEvent.ON_ERROR]?: (error: Error) => void | Promise<void>;
     [WatchedQueryListenerEvent.ON_STATE_CHANGE]?: (state: WatchedQueryState<Data>) => void | Promise<void>;
+    [WatchedQueryListenerEvent.SETTINGS_WILL_UPDATE]?: () => void;
     [WatchedQueryListenerEvent.CLOSED]?: () => void | Promise<void>;
 }
 export declare const DEFAULT_WATCH_THROTTLE_MS = 30;

package/lib/client/watched/WatchedQuery.js

@@ -3,6 +3,7 @@ export var WatchedQueryListenerEvent;
     WatchedQueryListenerEvent["ON_DATA"] = "onData";
     WatchedQueryListenerEvent["ON_ERROR"] = "onError";
     WatchedQueryListenerEvent["ON_STATE_CHANGE"] = "onStateChange";
+    WatchedQueryListenerEvent["SETTINGS_WILL_UPDATE"] = "settingsWillUpdate";
     WatchedQueryListenerEvent["CLOSED"] = "closed";
 })(WatchedQueryListenerEvent || (WatchedQueryListenerEvent = {}));
 export const DEFAULT_WATCH_THROTTLE_MS = 30;

package/lib/client/watched/processors/AbstractQueryProcessor.d.ts

@@ -40,6 +40,7 @@ export declare abstract class AbstractQueryProcessor<Data = unknown[], Settings
     constructor(options: AbstractQueryProcessorOptions<Data, Settings>);
     protected constructInitialState(): WatchedQueryState<Data>;
     protected get reportFetching(): boolean;
+    protected updateSettingsInternal(settings: Settings, signal: AbortSignal): Promise<void>;
     /**
      * Updates the underlying query.
      */
@@ -53,7 +54,7 @@ export declare abstract class AbstractQueryProcessor<Data = unknown[], Settings
     /**
      * Configures base DB listeners and links the query to listeners.
      */
-    protected init(): Promise<void>;
+    protected init(signal: AbortSignal): Promise<void>;
     close(): Promise<void>;
     /**
      * Runs a callback and reports errors to the error listeners.

package/lib/client/watched/processors/AbstractQueryProcessor.js

@@ -1,4 +1,5 @@
 import { MetaBaseObserver } from '../../../utils/MetaBaseObserver.js';
+import { WatchedQueryListenerEvent } from '../WatchedQuery.js';
 /**
  * Performs underlying watching and yields a stream of results.
  * @internal
@@ -20,7 +21,7 @@ export class AbstractQueryProcessor extends MetaBaseObserver {
         this._closed = false;
         this.state = this.constructInitialState();
         this.disposeListeners = null;
-        this.initialized = this.init();
+        this.initialized = this.init(this.abortController.signal);
     }
     constructInitialState() {
         return {
@@ -34,25 +35,40 @@ export class AbstractQueryProcessor extends MetaBaseObserver {
     get reportFetching() {
         return this.options.watchOptions.reportFetching ?? true;
     }
-    /**
-     * Updates the underlying query.
-     */
-    async updateSettings(settings) {
-        this.abortController.abort();
-        await this.initialized;
+    async updateSettingsInternal(settings, signal) {
+        // This may have been aborted while awaiting or if multiple calls to `updateSettings` were made
+        if (this._closed || signal.aborted) {
+            return;
+        }
+        this.options.watchOptions = settings;
+        this.iterateListeners((l) => l[WatchedQueryListenerEvent.SETTINGS_WILL_UPDATE]?.());
         if (!this.state.isFetching && this.reportFetching) {
             await this.updateState({
                 isFetching: true
             });
         }
-        this.options.watchOptions = settings;
-        this.abortController = new AbortController();
         await this.runWithReporting(() => this.linkQuery({
-            abortSignal: this.abortController.signal,
+            abortSignal: signal,
             settings
         }));
     }
+    /**
+     * Updates the underlying query.
+     */
+    async updateSettings(settings) {
+        // Abort the previous request
+        this.abortController.abort();
+        // Keep track of this controller's abort status
+        const abortController = new AbortController();
+        // Allow this to be aborted externally
+        this.abortController = abortController;
+        await this.initialized;
+        return this.updateSettingsInternal(settings, abortController.signal);
+    }
     async updateState(update) {
+        if (this._closed) {
+            return;
+        }
         if (typeof update.error !== 'undefined') {
             await this.iterateAsyncListenersWithError(async (l) => l.onError?.(update.error));
             // An error always stops for the current fetching state
@@ -68,7 +84,7 @@ export class AbstractQueryProcessor extends MetaBaseObserver {
     /**
      * Configures base DB listeners and links the query to listeners.
      */
-    async init() {
+    async init(signal) {
         const { db } = this.options;
         const disposeCloseListener = db.registerListener({
             closing: async () => {
@@ -89,16 +105,15 @@ export class AbstractQueryProcessor extends MetaBaseObserver {
             disposeSchemaListener();
         };
         // Initial setup
-        this.runWithReporting(async () => {
-            await this.updateSettings(this.options.watchOptions);
+        await this.runWithReporting(async () => {
+            await this.updateSettingsInternal(this.options.watchOptions, signal);
         });
     }
     async close() {
-        await this.initialized;
+        this._closed = true;
         this.abortController.abort();
         this.disposeListeners?.();
         this.disposeListeners = null;
-        this._closed = true;
         this.iterateListeners((l) => l.closed?.());
         this.listeners.clear();
     }

package/lib/client/watched/processors/DifferentialQueryProcessor.js

@@ -148,6 +148,9 @@ export class DifferentialQueryProcessor extends AbstractQueryProcessor {
                             data: diff.all
                         });
                     }
+                    if (this.state.error) {
+                        partialStateUpdate.error = null;
+                    }
                     if (Object.keys(partialStateUpdate).length > 0) {
                         await this.updateState(partialStateUpdate);
                     }

package/lib/client/watched/processors/OnChangeQueryProcessor.js

@@ -58,6 +58,9 @@ export class OnChangeQueryProcessor extends AbstractQueryProcessor {
                             data: result
                         });
                     }
+                    if (this.state.error) {
+                        partialStateUpdate.error = null;
+                    }
                     if (Object.keys(partialStateUpdate).length > 0) {
                         await this.updateState(partialStateUpdate);
                     }

package/package.json

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