@converse/skeletor 3.1.5 → 3.1.6

package/dist/skeletor.node.js

@@ -8024,7 +8024,7 @@ class PersistentStorage {
                 throw new Error("Skeletor.storage: the 'node' storage type is only available in Node.js builds. " +
                     "Import from '@converse/skeletor/node' instead of '@converse/skeletor'.");
             }
-            this.store = new NodeSQLiteStorage(this.name);
+            this.store = new NodeSQLiteStorage(this.name, PersistentStorage.nodeStorageDir ?? undefined);
             if (batchedWrites) {
                 this.store.debouncedSetItems = mergebounce((items) => this.store.setItems(items), 50, {
                     'promise': true,
@@ -8228,6 +8228,18 @@ class PersistentStorage {
 // node-only driver (and its `node:sqlite` import) never enters the browser
 // bundle; the `@converse/skeletor/node` entry sets it.
 PersistentStorage.nodeStorage = 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
+ */
+PersistentStorage.nodeStorageDir = null;
 PersistentStorage.sessionStorageInitialized = localForage.defineDriver(sessionStorageWrapper);
 PersistentStorage.localForage = localForage;
 
@@ -8235,6 +8247,7 @@ const DEFAULT_BASE_DIR = '.skeletor-storage';
 /**
  * SQLite-backed implementation of StorageDriver.
  * Uses a single table with key/value columns, storing values as JSON strings.
+ * @public
  */
 class NodeSQLiteStorage {
     ready() {

package/dist/skeletor.node.mjs

@@ -8020,7 +8020,7 @@ class PersistentStorage {
                 throw new Error("Skeletor.storage: the 'node' storage type is only available in Node.js builds. " +
                     "Import from '@converse/skeletor/node' instead of '@converse/skeletor'.");
             }
-            this.store = new NodeSQLiteStorage(this.name);
+            this.store = new NodeSQLiteStorage(this.name, PersistentStorage.nodeStorageDir ?? undefined);
             if (batchedWrites) {
                 this.store.debouncedSetItems = mergebounce((items) => this.store.setItems(items), 50, {
                     'promise': true,
@@ -8224,6 +8224,18 @@ class PersistentStorage {
 // node-only driver (and its `node:sqlite` import) never enters the browser
 // bundle; the `@converse/skeletor/node` entry sets it.
 PersistentStorage.nodeStorage = 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
+ */
+PersistentStorage.nodeStorageDir = null;
 PersistentStorage.sessionStorageInitialized = localForage.defineDriver(sessionStorageWrapper);
 PersistentStorage.localForage = localForage;
 
@@ -8231,6 +8243,7 @@ const DEFAULT_BASE_DIR = '.skeletor-storage';
 /**
  * SQLite-backed implementation of StorageDriver.
  * Uses a single table with key/value columns, storing values as JSON strings.
+ * @public
  */
 class NodeSQLiteStorage {
     ready() {

package/package.json

@@ -9,18 +9,19 @@
   "browser": "dist/skeletor.js",
   "exports": {
     ".": {
-      "types": "./dist/skeletor.d.ts",
       "node": {
+        "types": "./dist/skeletor.node.d.ts",
         "require": "./dist/skeletor.node.js",
         "import": "./dist/skeletor.node.mjs"
       },
       "default": {
+        "types": "./dist/skeletor.d.ts",
         "import": "./dist/skeletor.esm.js",
         "require": "./dist/skeletor.js"
       }
     },
     "./node": {
-      "types": "./dist/skeletor.d.ts",
+      "types": "./dist/skeletor.node.d.ts",
       "require": "./dist/skeletor.node.js",
       "import": "./dist/skeletor.node.mjs"
     }
@@ -38,7 +39,7 @@
   "contributors": [
     "JC Brand"
   ],
-  "version": "3.1.5",
+  "version": "3.1.6",
   "engines": {
     "node": ">=22.0.0"
   },
@@ -49,7 +50,7 @@
   },
   "scripts": {
     "build": "npm run prebuild && npm run build:declarations && rollup -c",
-    "build:declarations": "npm run build:types && api-extractor run --local && rm -rf dist/defs",
+    "build:declarations": "npm run build:types && api-extractor run --local && api-extractor run --local -c api-extractor.node.json && rm -rf dist/defs",
     "build:types": "tsc -p tsconfig.declarations.json",
     "check": "npm run check:types && npm run test && npm run test:node && npm run lint",
     "check:types": "tsc --noEmit",
@@ -74,6 +75,7 @@
     "dist/skeletor.node.mjs",
     "dist/skeletor.d.ts",
     "dist/skeletor.d.ts.map",
+    "dist/skeletor.node.d.ts",
     "src/**/*.ts"
   ],
   "dependencies": {

package/src/drivers/nodeSQLiteStorage.ts

@@ -9,6 +9,7 @@ const DEFAULT_BASE_DIR = '.skeletor-storage';
 /**
  * SQLite-backed implementation of StorageDriver.
  * Uses a single table with key/value columns, storing values as JSON strings.
+ * @public
  */
 export class NodeSQLiteStorage implements StorageDriver {
   private db: DatabaseSync;

package/src/index.ts

@@ -63,6 +63,7 @@ export { noConflict, Collection, EventEmitter, Model, PersistentStorage, Browser
 export { getStorage } from './helpers';
 
 export type { StorageDriver, StoreType } from './drivers/types';
+export type { NodeStorageConstructor } from './storage';
 export type {
   ClassConstructor,
   CollectionOptions,

package/src/storage.ts

@@ -36,8 +36,13 @@ const registered = new WeakSet<PersistentStorage>();
 /**
  * Constructor for a Node.js-only storage driver. Registered by the
  * `@converse/skeletor/node` entry point via {@link PersistentStorage.nodeStorage}.
+ * @public
  */
-type NodeStorageConstructor = new (name: string) => StorageDriver;
+export type NodeStorageConstructor = new (
+  name: string,
+  storageDir?: string,
+  inMemory?: boolean,
+) => StorageDriver;
 
 /**
  * @public
@@ -60,6 +65,19 @@ class PersistentStorage {
   // bundle; the `@converse/skeletor/node` entry sets it.
   static nodeStorage: NodeStorageConstructor | null = 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 = null;
+
   /** Register a storage instance with a weak reference. @public */
   static register(instance: PersistentStorage): void {
     if (registered.has(instance)) return;
@@ -128,7 +146,7 @@ class PersistentStorage {
             "Import from '@converse/skeletor/node' instead of '@converse/skeletor'.",
         );
       }
-      this.store = new NodeSQLiteStorage(this.name);
+      this.store = new NodeSQLiteStorage(this.name, PersistentStorage.nodeStorageDir ?? undefined);
       if (batchedWrites) {
         this.store.debouncedSetItems = mergebounce((items: Record<string, any>) => this.store.setItems!(items), 50, {
           'promise': true,
@@ -155,9 +173,11 @@ class PersistentStorage {
   async clear(): Promise<void> {
     await this.storeInitialized;
     await this.store.removeItem(this.name).catch((e) => console.error(e));
+
     const re = new RegExp(`^${this.name}-`);
     const keys = await this.store.keys();
     const removed_keys = keys.filter((k) => re.test(k));
+
     await Promise.all(removed_keys.map((k) => this.store.removeItem(k).catch((e) => console.error(e))));
   }