@converse/skeletor 3.1.4 → 3.1.6

package/CHANGES.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 3.1.6 (2026-08-06)
+
+- The `'node'` store type can now be told where to put its database files, via the new
+  `PersistentStorage.nodeStorageDir`. The driver has always taken a `storageDir` argument,
+  but nothing could reach it through the string store type, so `new PersistentStorage(id, 'node')`
+  was stuck with the driver's default. That default is relative, so it resolves against
+  `process.cwd()` and an app started from two directories keeps two separate sets of state.
+  Set an absolute path (`$XDG_STATE_HOME/<app>`, say) to pin it. The default is unchanged.
+
+- Ship a separate `dist/skeletor.node.d.ts` for the `@converse/skeletor/node` entry point.
+  Both entry points pointed their `types` at the browser rollup.
+
+## 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.

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.
 

package/dist/skeletor.d.ts

@@ -762,8 +762,9 @@ export declare function noConflict(): any;
 /**
  * Constructor for a Node.js-only storage driver. Registered by the
  * `@converse/skeletor/node` entry point via {@link PersistentStorage.nodeStorage}.
+ * @public
  */
-declare type NodeStorageConstructor = new (name: string) => StorageDriver;
+export declare type NodeStorageConstructor = new (name: string, storageDir?: string, inMemory?: boolean) => StorageDriver;
 
 /**
  * @public
@@ -795,6 +796,18 @@ export declare class PersistentStorage {
     static sessionStorageInitialized: Promise<void>;
     static localForage: typeof localForage;
     static nodeStorage: NodeStorageConstructor | null;
+    /**
+     * Directory the `'node'` store type writes its database files to. The driver's
+     * own default is relative, so it resolves against `process.cwd()` and a process
+     * started from two directories ends up with two separate sets of state. Set an
+     * absolute path (`$XDG_STATE_HOME/<app>`, say) to pin it. Left `null`, the
+     * driver's default applies.
+     *
+     * Only the `'node'` string store type reads this; passing a driver instance to
+     * the constructor means you've already chosen a directory yourself.
+     * @public
+     */
+    static nodeStorageDir: string | null;
     /** Register a storage instance with a weak reference. @public */
     static register(instance: PersistentStorage): void;
     /**
@@ -860,10 +873,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;
     };
 }