@converse/skeletor 3.1.3 → 3.1.4

package/CHANGES.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 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

@@ -159,7 +159,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 +171,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`)

package/dist/skeletor.esm.js

@@ -10907,18 +10907,18 @@ class Model extends EventEmitterObject {
         this.initialize.apply(this, arguments);
         // Reset changed after initial set
         this.changed = {};
-        // When autoSync is on, `initialized` is always a Promise so callers can
-        // uniformly `await model.initialized`. It only hydrates from storage when
+        // When autoSync is on, `hydrated` is always a Promise so callers can
+        // uniformly `await model.hydrated`. It only hydrates from storage when
         // there's something to load (storage configured and the model isn't new);
         // otherwise it's already ready and resolves immediately.
         if (this.autoSync) {
             if (getStorage(this) && !this.isNew()) {
                 __classPrivateFieldSet(this, _Model_state, 'hydrating', "f");
-                this.initialized = __classPrivateFieldGet(this, _Model_instances, "m", _Model_hydrate).call(this);
+                this.hydrated = __classPrivateFieldGet(this, _Model_instances, "m", _Model_hydrate).call(this);
             }
             else {
                 __classPrivateFieldSet(this, _Model_state, 'ready', "f");
-                this.initialized = Promise.resolve();
+                this.hydrated = Promise.resolve();
             }
         }
         else {
@@ -11091,7 +11091,7 @@ class Model extends EventEmitterObject {
         // Guard must come after arg normalization: when called as set(obj, opts),
         // fromStorage lives in `val` (second arg), not `options` (third arg).
         if (this.autoSync && __classPrivateFieldGet(this, _Model_state, "f") === 'hydrating' && !options.fromStorage) {
-            throw new Error(`Skeletor: set() called on an autoSync model before initialized resolved. Await model.initialized first.`);
+            throw new Error(`Skeletor: set() called on an autoSync model before hydration resolved. Await model.hydrated first.`);
         }
         // Run validation.
         if (!this._validate(attrs, options))
@@ -11531,11 +11531,11 @@ class Collection extends EventEmitterObject {
         if (models)
             this.reset(models, Object.assign({ silent: true }, options));
         this[Symbol.iterator] = this.values;
-        // When autoSync is on, `initialized` is always a Promise so callers can
-        // uniformly `await collection.initialized`; it resolves immediately when
+        // When autoSync is on, `hydrated` is always a Promise so callers can
+        // uniformly `await collection.hydrated`; it resolves immediately when
         // there's no storage to hydrate from.
         if (this.autoSync) {
-            this.initialized = getStorage(this) ? __classPrivateFieldGet(this, _Collection_instances, "m", _Collection_hydrate).call(this) : Promise.resolve();
+            this.hydrated = getStorage(this) ? __classPrivateFieldGet(this, _Collection_instances, "m", _Collection_hydrate).call(this) : Promise.resolve();
         }
     }
     get comparator() {
@@ -11567,7 +11567,7 @@ class Collection extends EventEmitterObject {
     }
     /**
      * 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