@converse/skeletor 3.1.4 → 3.1.5

package/src/drivers/nodeSQLiteStorage.ts

@@ -27,11 +27,6 @@ export class NodeSQLiteStorage implements StorageDriver {
     return Promise.resolve();
   }
 
-  debouncedSetItems?: {
-    (items: Record<string, any>): Promise<void>;
-    flush?: () => void;
-  };
-
   constructor(name: string, storageDir?: string, inMemory?: boolean) {
     if (inMemory) {
       this.db = new DatabaseSync(':memory:');
@@ -116,7 +111,7 @@ export class NodeSQLiteStorage implements StorageDriver {
     return Promise.resolve(rows.map((r) => r.key));
   }
 
-  setItems(items: Record<string, any>): Promise<void> {
+  setItems(items: Record<string, any>): Promise<Record<string, any>> {
     this.db.exec('BEGIN IMMEDIATE');
     try {
       for (const [key, value] of Object.entries(items)) {
@@ -137,7 +132,7 @@ export class NodeSQLiteStorage implements StorageDriver {
       }
       throw e;
     }
-    return Promise.resolve();
+    return Promise.resolve(items);
   }
 
   getItems(keys: string[]): Promise<Record<string, any>> {

package/src/drivers/types.ts

@@ -11,10 +11,16 @@ export interface StorageDriver {
   length(): Promise<number>;
   key(keyIndex: number): Promise<string | null>;
   keys(): Promise<string[]>;
-  setItems?(items: Record<string, any>): Promise<void>;
+  /**
+   * Write several items in one go. A successful write is signalled by the
+   * promise settling, not by what it resolves with: drivers may resolve with
+   * the written items (localForage does) or with nothing, and callers must
+   * treat both as success.
+   */
+  setItems?(items: Record<string, any>): Promise<Record<string, any> | void>;
   getItems?(keys: string[]): Promise<Record<string, any>>;
   debouncedSetItems?: {
-    (items: Record<string, any>): Promise<void>;
+    (items: Record<string, any>): Promise<Record<string, any> | void>;
     flush?: () => void;
   };
 }

package/src/storage.ts

@@ -8,7 +8,7 @@ import localForage from 'localforage';
 import mergebounce from 'mergebounce';
 import sessionStorageWrapper from './drivers/sessionStorage';
 import { extendPrototype as extendPrototypeWithSetItems } from 'localforage-setitems';
-import { extendPrototype as extendPrototypeWithGetItems } from '@converse/localforage-getitems/dist/localforage-getitems.es6';
+import { extendPrototype as extendPrototypeWithGetItems } from '@converse/localforage-getitems';
 import { guid } from './helpers';
 import type { Model } from './model';
 import type { Collection } from './collection';
@@ -231,31 +231,16 @@ class PersistentStorage {
         }
       }
 
-      if (resp) {
-        if (options && options.success) {
-          // When storing, we don't pass back the response (which is
-          // the set attributes returned from localforage because
-          // Skeletor sets them again on the model and due to the async
-          // nature of localforage it can cause stale attributes to be
-          // set on a model after it's been updated in the meantime.
-          const data = method === 'read' ? resp : null;
-          options.success(data, options);
-        }
-      } else if (method === 'read' && !caughtError) {
-        // A read that finds no record is a normal empty result (first run /
-        // empty storage), not an error. Resolve with `null` so the callback
-        // and promise forms of fetch() agree and a first-run read never
-        // rejects.
-        if (options && options.success) {
-          options.success(null, options);
-        }
-      } else {
-        // A genuine failure (storage threw, or a write produced no result):
-        // surface a real Error so consumers get a stack and `instanceof Error`
-        // holds.
-        if (options && options.error) {
-          options.error(caughtError ?? new Error('Record Not Found'));
-        }
+      if (caughtError) {
+        options?.error?.(caughtError);
+      } else if (options?.success) {
+        // When storing, we don't pass back the response (which is the set
+        // attributes returned from localforage) because Skeletor sets them
+        // again on the model and due to the async nature of localforage it can
+        // cause stale attributes to be set on a model after it's been updated
+        // in the meantime.
+        const data = method === 'read' ? (resp ?? null) : null;
+        options.success(data, options);
       }
     }
     localSync.__name__ = 'localSync';