@converse/skeletor 3.1.3 → 3.1.5

package/CHANGES.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 3.1.5 (2026-07-22)
+
+- Fix every write through the Node.js SQLite driver failing with `Record Not Found` while
+  the data was in fact stored.
+- Switch TypeScript `moduleResolution` to `bundler` and add `types` conditions to the `exports` map.
+
+## 3.1.4 (2026-06-23)
+
+- Fix the `autoSync` hydration promise clobbering a consumer's own `initialized` promise.
+  The promise that resolves once hydration is complete is now exposed as `hydrated` (on both
+  `Model` and `Collection`) instead of `initialized`. The old name collided with the common
+  convention (used by Converse.js) of setting a `model.initialized` promise inside
+  `initialize()` to track a consumer's own async setup.
+
+  Skeletor no longer sets or reads `initialized`. Await `model.hydrated` / `collection.hydrated`
+  to know when hydration is complete. If you used the autoSync `initialized` promise added
+  in 3.1.0, rename those reads to `hydrated`.
+
 ## 3.1.3 (2026-06-23)
 
 - Fix a regression (since 3.1.0) where a missing record on a `read` was treated as an error.

package/README.md

@@ -1,7 +1,13 @@
-# Skeletor
+<p align="center">
+  <img src="images/skeletor-logo.svg" alt="Skeletor" width="120" height="120">
+</p>
 
-[![XMPP Chat](https://conference.conversejs.org/muc_badge/discuss@conference.conversejs.org)](https://inverse.chat/#converse/room?jid=discuss@conference.conversejs.org)
-[![CI Tests](https://github.com/conversejs/skeletor/actions/workflows/karma-tests.yml/badge.svg)](https://github.com/conversejs/skeletor/actions/workflows/karma-tests.yml)
+<h1 align="center">Skeletor</h1>
+
+<p align="center">
+  <a href="https://chat.conversejs.org/#converse/room?jid=discuss@conference.conversejs.org"><img alt="XMPP Chat" src="https://conference.conversejs.org/muc_badge/discuss@conference.conversejs.org"></a>
+  <a href="https://github.com/conversejs/skeletor/actions/workflows/karma-tests.yml"><img alt="CI Tests" src="https://github.com/conversejs/skeletor/actions/workflows/karma-tests.yml/badge.svg"></a>
+</p>
 
 Skeletor is a lightweight, TypeScript-first reactive data library.
 
@@ -159,7 +165,7 @@ class Settings extends Model {
 }
 
 const settings = new Settings({ id: 'main' });
-await settings.initialized; // resolves when prior data has been loaded
+await settings.hydrated; // resolves when prior data has been loaded
 
 settings.attrs.theme = 'dark'; // persisted automatically (debounced)
 settings.set('lang', 'en'); // also auto-saved
@@ -171,7 +177,8 @@ settings.set('transient', true, { noAutoSave: true });
 Pending writes are debounced (see `autoSyncDelay`, default 100ms) and flushed when the
 page is hidden (`visibilitychange`) or unloaded (`pagehide`).
 
-When `autoSync` is off, `initialized` is `undefined`, but `await model.initialized` is still safe (awaiting `undefined` is a no-op), so code can await it uniformly.
+When `autoSync` is off, `hydrated` is `undefined`, but `await model.hydrated` is still safe
+(awaiting `undefined` is a no-op), so code can await it uniformly.
 
 On a `Collection`, `autoSync` is **hydrate-only**: the collection loads its stored
 state on construction but does not auto-save on `add`/`remove`/`reset`. To persist

package/dist/skeletor.d.ts

@@ -26,7 +26,7 @@ export declare class Collection<T extends Model = Model> extends EventEmitterObj
     _storage?: PersistentStorage;
     _comparator?: Comparator<T>;
     _url: string;
-    initialized?: Promise<void>;
+    hydrated?: Promise<void>;
     models: T[];
     protected _byId: Record<string, T>;
     protected _model?: new (attributes?: Partial<ModelAttributes>, options?: ModelOptions) => T;
@@ -51,7 +51,7 @@ export declare class Collection<T extends Model = Model> extends EventEmitterObj
     set browserStorage(s: PersistentStorage);
     /**
      * Override to return `true` to automatically load the collection from
-     * storage on construction. Await `initialized` to know when hydration
+     * storage on construction. Await `hydrated` to know when hydration
      * is complete.
      *
      * Note: collection `autoSync` is hydrate-only. Unlike `Model`, it does
@@ -545,7 +545,7 @@ export declare class Model<T extends ModelAttributes = ModelAttributes> extends
     cid: string;
     collection?: Collection;
     id: string | number;
-    initialized?: Promise<void>;
+    hydrated?: Promise<void>;
     validationError: string | number | null;
     /**
      * Create a new model with the specified attributes. A client id (`cid`)
@@ -860,10 +860,16 @@ export declare 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;
     };
 }