@workglow/storage 0.0.56 → 0.0.58

package/dist/util/PollingSubscriptionManager.d.ts

@@ -0,0 +1,112 @@
+/**
+ * @license
+ * Copyright 2025 Steven Roussey <sroussey@gmail.com>
+ * SPDX-License-Identifier: Apache-2.0
+ */
+/**
+ * Configuration options for the polling subscription manager
+ */
+export interface PollingManagerOptions {
+    /** Default polling interval in milliseconds */
+    readonly defaultIntervalMs?: number;
+}
+/**
+ * A callback function that is called when changes are detected
+ */
+export type ChangeCallback<T> = (change: T) => void;
+/**
+ * A function that fetches the current state for comparison
+ */
+export type StateFetcher<Item, Key> = () => Promise<Map<Key, Item>>;
+/**
+ * A function that compares two items for equality
+ */
+export type ItemComparator<Item> = (a: Item, b: Item) => boolean;
+/**
+ * A factory function that creates change payloads
+ */
+export interface ChangePayloadFactory<Item, ChangePayload> {
+    /** Create an INSERT change payload */
+    readonly insert: (item: Item) => ChangePayload;
+    /** Create an UPDATE change payload */
+    readonly update: (oldItem: Item, newItem: Item) => ChangePayload;
+    /** Create a DELETE change payload */
+    readonly delete: (item: Item) => ChangePayload;
+}
+/**
+ * Options for subscribing to changes
+ */
+export interface PollingSubscriptionOptions {
+    /** Polling interval in milliseconds */
+    readonly intervalMs?: number;
+}
+/**
+ * Manages polling-based subscriptions efficiently by consolidating multiple
+ * subscribers into a single polling loop per interval tier.
+ *
+ * Instead of each subscription creating its own polling interval, this manager
+ * groups subscriptions by their requested polling interval and runs a single
+ * poll for each group, broadcasting changes to all subscribers in that group.
+ *
+ * @template Item - The type of items being tracked
+ * @template Key - The type of key used to identify items
+ * @template ChangePayload - The type of change payload sent to subscribers
+ */
+export declare class PollingSubscriptionManager<Item, Key, ChangePayload> {
+    /** Map of interval (ms) to interval ID and subscriber list */
+    private readonly intervals;
+    /** Current known state from last poll */
+    private lastKnownState;
+    /** Whether the manager has been initialized with a state fetch */
+    private initialized;
+    /** Function to fetch current state */
+    private readonly fetchState;
+    /** Function to compare items for equality */
+    private readonly compareItems;
+    /** Factory for creating change payloads */
+    private readonly payloadFactory;
+    /** Default polling interval */
+    private readonly defaultIntervalMs;
+    /**
+     * Creates a new PollingSubscriptionManager
+     *
+     * @param fetchState - Function that returns the current state as a Map
+     * @param compareItems - Function that compares two items for equality
+     * @param payloadFactory - Factory for creating INSERT/UPDATE/DELETE payloads
+     * @param options - Configuration options
+     */
+    constructor(fetchState: StateFetcher<Item, Key>, compareItems: ItemComparator<Item>, payloadFactory: ChangePayloadFactory<Item, ChangePayload>, options?: PollingManagerOptions);
+    /**
+     * Subscribe to changes with a specific polling interval
+     *
+     * @param callback - Function called when changes are detected
+     * @param options - Subscription options including interval
+     * @returns Unsubscribe function
+     */
+    subscribe(callback: ChangeCallback<ChangePayload>, options?: PollingSubscriptionOptions): () => void;
+    /**
+     * Initialize state and run first poll
+     */
+    private initAndPoll;
+    /**
+     * Send current state to a new subscriber
+     */
+    private pollForNewSubscriber;
+    /**
+     * Poll for changes and notify all subscribers in the given set
+     */
+    private poll;
+    /**
+     * Get the number of active subscriptions across all intervals
+     */
+    get subscriptionCount(): number;
+    /**
+     * Check if there are any active subscriptions
+     */
+    get hasSubscriptions(): boolean;
+    /**
+     * Destroy the manager and clean up all intervals
+     */
+    destroy(): void;
+}
+//# sourceMappingURL=PollingSubscriptionManager.d.ts.map

package/dist/util/PollingSubscriptionManager.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PollingSubscriptionManager.d.ts","sourceRoot":"","sources":["../../src/util/PollingSubscriptionManager.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,+CAA+C;IAC/C,QAAQ,CAAC,iBAAiB,CAAC,EAAE,MAAM,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,IAAI,CAAC;AAEpD;;GAEG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,EAAE,GAAG,IAAI,MAAM,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,IAAI,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,KAAK,OAAO,CAAC;AAEjE;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,IAAI,EAAE,aAAa;IACvD,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,aAAa,CAAC;IAC/C,sCAAsC;IACtC,QAAQ,CAAC,MAAM,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,KAAK,aAAa,CAAC;IACjE,qCAAqC;IACrC,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,IAAI,KAAK,aAAa,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC,uCAAuC;IACvC,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC9B;AAUD;;;;;;;;;;;GAWG;AACH,qBAAa,0BAA0B,CAAC,IAAI,EAAE,GAAG,EAAE,aAAa;IAC9D,8DAA8D;IAC9D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAMtB;IAEJ,yCAAyC;IACzC,OAAO,CAAC,cAAc,CAAwB;IAE9C,kEAAkE;IAClE,OAAO,CAAC,WAAW,CAAS;IAE5B,sCAAsC;IACtC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0B;IAErD,6CAA6C;IAC7C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAuB;IAEpD,2CAA2C;IAC3C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4C;IAE3E,+BAA+B;IAC/B,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAS;IAE3C;;;;;;;OAOG;gBAED,UAAU,EAAE,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,EACnC,YAAY,EAAE,cAAc,CAAC,IAAI,CAAC,EAClC,cAAc,EAAE,oBAAoB,CAAC,IAAI,EAAE,aAAa,CAAC,EACzD,OAAO,CAAC,EAAE,qBAAqB;IAQjC;;;;;;OAMG;IACH,SAAS,CACP,QAAQ,EAAE,cAAc,CAAC,aAAa,CAAC,EACvC,OAAO,CAAC,EAAE,0BAA0B,GACnC,MAAM,IAAI;IA+Cb;;OAEG;YACW,WAAW;IAoBzB;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAY5B;;OAEG;YACW,IAAI;IA0ClB;;OAEG;IACH,IAAI,iBAAiB,IAAI,MAAM,CAM9B;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,OAAO,IAAI,IAAI;CAQhB"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@workglow/storage",
   "type": "module",
-  "version": "0.0.56",
+  "version": "0.0.58",
   "description": "Storage abstraction layer for Workglow, supporting IndexedDB, PostgreSQL, and Supabase with unified interfaces.",
   "scripts": {
     "watch": "concurrently -c 'auto' 'bun:watch-*'",
@@ -20,8 +20,8 @@
     "prepare": "node -e \"const pkg=require('./package.json');pkg.exports['.'].bun='./dist/bun.js';pkg.exports['.'].types='./dist/types.d.ts';require('fs').writeFileSync('package.json',JSON.stringify(pkg,null,2))\""
   },
   "peerDependencies": {
-    "@workglow/sqlite": "0.0.56",
-    "@workglow/util": "0.0.56",
+    "@workglow/sqlite": "0.0.58",
+    "@workglow/util": "0.0.58",
     "pg": "^8.16.3",
     "@supabase/supabase-js": "^2.86.2"
   },
@@ -34,8 +34,8 @@
     }
   },
   "devDependencies": {
-    "@workglow/sqlite": "0.0.56",
-    "@workglow/util": "0.0.56",
+    "@workglow/sqlite": "0.0.58",
+    "@workglow/util": "0.0.58",
     "pg": "^8.16.3",
     "@types/pg": "^8.15.5",
     "@supabase/supabase-js": "^2.86.2",