@shaxpir/duiduidui-models 1.4.8 → 1.4.9

package/dist/index.js

@@ -15,7 +15,6 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-/// <reference path="../decs.d.ts" />
 __exportStar(require("./models"), exports);
 __exportStar(require("./repo"), exports);
 __exportStar(require("./util"), exports);

package/dist/repo/ShareSync.d.ts

@@ -21,6 +21,8 @@ export interface ShareSyncOptions {
     pingInterval?: number;
     encryptionKey?: string;
     webSocketConstructor?: any;
+    enableDurableStore?: boolean;
+    storageFactory?: () => Promise<any>;
 }
 export declare class ShareSyncFactory {
     private static INSTANCE;
@@ -40,7 +42,11 @@ export declare class ShareSync {
     private _socket;
     private _connection;
     private _listener;
+    private _storage;
+    private _durableStore;
+    private _storageFactory?;
     constructor(encryption: Encryption, options: ShareSyncOptions);
+    private initializeDurableStore;
     isDebug(): boolean;
     isOnline(): boolean;
     ping(): void;

package/dist/repo/ShareSync.js

@@ -38,6 +38,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ShareSync = exports.ShareSyncFactory = exports.ShareSyncDisposalStrategy = void 0;
 const client_1 = __importStar(require("@shaxpir/sharedb/lib/client"));
+const durable_store_1 = __importDefault(require("@shaxpir/sharedb/lib/client/durable-store"));
 const shaxpir_common_1 = require("@shaxpir/shaxpir-common");
 const reconnecting_websocket_1 = __importDefault(require("reconnecting-websocket"));
 const models_1 = require("../models");
@@ -78,9 +79,10 @@ class ShareSync {
         shareSync._debug = options.debug;
         shareSync._disposalStrategy = options.disposalStrategy;
         shareSync._opErrorCallback = options.opErrorCallback;
-        shareSync._hasDurableStore = options.namespace && options.namespace.length > 0;
+        shareSync._hasDurableStore = options.enableDurableStore === true && options.namespace && options.namespace.length > 0;
         shareSync._useDurableStoreEncryption = options.encryptionKey && options.encryptionKey.length > 0;
         shareSync._durableStoreEncryptionKey = options.encryptionKey;
+        shareSync._storageFactory = options.storageFactory;
         // Create and configure the socket.
         if (options.webSocketConstructor) {
             shareSync._socket = new reconnecting_websocket_1.default(options.urlProvider, [], { WebSocket: options.webSocketConstructor });
@@ -109,39 +111,21 @@ class ShareSync {
             updateSocketIsOpen();
             shareSync._listener.onSocketEvent('error', event);
         });
-        // Create the ShareDB connection from the socket
+        // Create the ShareDB connection from the socket (without DurableStore initially)
+        shareSync._connection = new client_1.Connection(shareSync._socket);
+        // Initialize DurableStore asynchronously if enabled
         if (shareSync._hasDurableStore) {
-            shareSync._connection = new client_1.Connection(shareSync._socket, {
-                durableStore: {
-                    namespace: options.namespace,
-                    debug: options.debug,
-                    useEncryption: shareSync._useDurableStoreEncryption,
-                    encryptionCallback: (plaintext) => {
-                        return encryption.encrypt(plaintext, shareSync._durableStoreEncryptionKey);
-                    },
-                    decryptionCallback: (cyphertext) => {
-                        return encryption.decrypt(cyphertext, shareSync._durableStoreEncryptionKey);
-                    },
-                    onReadyCallback: options.onReadyCallback,
-                    opErrorCallback: options.opErrorCallback,
-                    // Use the 'docData.meta.updated_at.utc_time' field (which is universal to all Model subclasses) as the 'version'
-                    // identifier that we use when determining if the doc in the DurableStore is up-to-date. This field won't yet
-                    // exist when the doc is newly created (since the 'doc.data' will be undefined), so in that case, we'll return
-                    // null as the version string, which will work correctly with the versioning semantics of the DurableStore.
-                    extVersionDecoder: (docData) => {
-                        if (docData &&
-                            docData.meta &&
-                            docData.meta.updated_at &&
-                            docData.meta.updated_at.utc_time) {
-                            return docData.meta.updated_at.utc_time;
-                        }
-                        return null;
-                    }
-                }
+            shareSync.initializeDurableStore(options).catch((error) => {
+                console.error('Failed to initialize DurableStore:', error);
+                shareSync._opErrorCallback && shareSync._opErrorCallback(error);
             });
         }
-        else {
-            shareSync._connection = new client_1.Connection(shareSync._socket);
+        else if (options.onReadyCallback) {
+            // If there is no DurableStore, then we can call the onReadyCallback now. However,
+            // we have to use setTimeout to invoke it, because the callback will probably want
+            // to retrieve the ShareSync instance from the factory, and because the constructor
+            // hasn't actually finished yet, the INSTANCE pointer hasn't quite been assigned yet.
+            setTimeout(options.onReadyCallback, 1);
         }
         shareSync._connection.on('error', (err) => {
             console.error(`ShareSync connection error: ${err}\n  Error code: ${err.code}\n  Error message: ${err.message}\n  Error stack: ${err.stack}\n`);
@@ -151,12 +135,43 @@ class ShareSync {
         if (options.pingInterval && typeof (options.pingInterval) === 'number') {
             setInterval(() => { shareSync.ping(); }, options.pingInterval);
         }
-        if (!shareSync._hasDurableStore && !!options.onReadyCallback) {
-            // If there is no DurableStore, then we can call the onReadyCallback now. However,
-            // we have to use setTimeout to invoke it, because the callback will probably want
-            // to retrieve the ShareSync instance from the factory, and because the constructor
-            // hasn't actually finished yet, the INSTANCE pointer hasn't quite been assigned yet.
-            setTimeout(options.onReadyCallback, 1);
+    }
+    async initializeDurableStore(options) {
+        try {
+            // Create storage implementation if factory is provided
+            if (this._storageFactory) {
+                this._storage = await this._storageFactory();
+            }
+            // Create DurableStore with the storage
+            if (this._storage) {
+                this._durableStore = new durable_store_1.default(this._storage, {
+                    debug: this._debug,
+                    // Version decoder for determining document freshness
+                    // Uses the 'docData.meta.updated_at.utc_time' field (universal to all Model subclasses)
+                    extVersionDecoder: (docData) => {
+                        if (docData &&
+                            docData.meta &&
+                            docData.meta.updated_at &&
+                            docData.meta.updated_at.utc_time) {
+                            return docData.meta.updated_at.utc_time;
+                        }
+                        return null;
+                    }
+                });
+                // Attach DurableStore to connection
+                this._connection.useDurableStore(this._durableStore);
+                // Call ready callback once DurableStore is initialized
+                if (options.onReadyCallback) {
+                    options.onReadyCallback();
+                }
+            }
+            else {
+                console.warn('DurableStore enabled but no storage factory provided');
+            }
+        }
+        catch (error) {
+            console.error('Failed to initialize DurableStore:', error);
+            throw error;
         }
     }
     isDebug() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shaxpir/duiduidui-models",
-  "version": "1.4.8",
+  "version": "1.4.9",
   "repository": {
     "type": "git",
     "url": "https://github.com/shaxpir/duiduidui-models"
@@ -16,7 +16,7 @@
     "dist/"
   ],
   "dependencies": {
-    "@shaxpir/sharedb": "^5.3.0",
+    "@shaxpir/sharedb": "^6.0.3",
     "@shaxpir/shaxpir-common": "1.3.0",
     "ot-json1": "1.0.1",
     "ot-text-unicode": "4.0.0",