@mnaoumov/obsidian-lib 6.3.0 → 7.0.0

package/dist/lib/esm/data-stores/local-data-store.mjs

@@ -0,0 +1,170 @@
+/*
+THIS IS A GENERATED/BUNDLED FILE BY ESBUILD
+if you want to view the source, please visit the github repository of this plugin
+*/
+
+class LocalDataStore {
+  constructor(database) {
+    this.database = database;
+  }
+  database;
+  /**
+   * Opens an isolated database. Writes resolve only once their transaction commits.
+   *
+   * @param params - Store identity and optional IndexedDB implementation.
+   * @returns The connected store; close it when its owner unloads.
+   */
+  static async open(params) {
+    const name = `obsidian-lib:${JSON.stringify([params.vaultId, params.pluginId, params.storeId])}`;
+    const request = (params.factory ?? indexedDB).open(name, 1);
+    return await new Promise((resolve, reject) => {
+      request.onupgradeneeded = () => {
+        request.result.createObjectStore("records");
+      };
+      request.addEventListener("error", () => {
+        reject(new Error("Could not open local data store", { cause: request.error }));
+      });
+      request.onsuccess = () => {
+        const database = request.result;
+        database.onversionchange = () => {
+          database.close();
+        };
+        resolve(new LocalDataStore(database));
+      };
+    });
+  }
+  /**
+   * Deletes every record in this store only.
+   *
+   * @returns A promise that resolves after commit.
+   */
+  async clear() {
+    await this.run("readwrite", (store) => store.clear());
+  }
+  /**
+   * Closes this connection without deleting its records.
+   */
+  close() {
+    this.database.close();
+  }
+  /**
+   * Commits several record changes atomically without serializing the rest of the database.
+   *
+   * @param params - Writes and deletions in one transaction.
+   * @returns A promise that resolves only after all changes commit.
+   */
+  async commit(params) {
+    await this.run("readwrite", (store) => {
+      for (const key of params.removedKeys ?? []) {
+        store.delete(key);
+      }
+      for (const [key, value] of params.entries) {
+        store.put(value, key);
+      }
+      return store.count();
+    });
+  }
+  /**
+   * Deletes a record.
+   *
+   * @param key - Record key.
+   * @returns A promise that resolves after commit.
+   */
+  async delete(key) {
+    await this.run("readwrite", (store) => store.delete(key));
+  }
+  /**
+   * Reads all records in key order.
+   *
+   * @returns Detached key/value pairs.
+   */
+  async entries() {
+    const records = [];
+    await this.run("readonly", (store) => {
+      const request = store.openCursor();
+      request.onsuccess = () => {
+        const cursor = request.result;
+        if (!cursor) {
+          return;
+        }
+        if (typeof cursor.key !== "string") {
+          throw new TypeError("Local data-store key is not a string");
+        }
+        records.push([cursor.key, cursor.value]);
+        cursor.continue();
+      };
+      return request;
+    });
+    return records;
+  }
+  /**
+   * Serializes a shared-store operation across connections, windows and bundled library copies.
+   *
+   * @typeParam T - Callback result.
+   * @param callback - Work performed while holding this database's Web Lock.
+   * @returns The callback result after releasing the lock.
+   */
+  async exclusive(callback) {
+    return await window.navigator.locks.request(this.database.name, callback);
+  }
+  /**
+   * Reads a record.
+   *
+   * @param key - Record key.
+   * @returns Its value, or `undefined` when absent.
+   */
+  async get(key) {
+    return await this.run("readonly", (store) => store.get(key));
+  }
+  /**
+   * Initializes a record once, atomically across connections.
+   *
+   * @param key - Record key.
+   * @param value - Value used only when the key is absent.
+   * @returns The existing or newly committed value.
+   */
+  async getOrCreate(key, value) {
+    return await this.run("readwrite", (store) => {
+      const request = store.get(key);
+      request.onsuccess = () => {
+        if (request.result === void 0) {
+          store.put(value, key);
+        }
+      };
+      return request;
+    }).then((existing) => existing === void 0 ? value : existing);
+  }
+  /**
+   * Writes a structured-cloneable value.
+   *
+   * @param key - Record key.
+   * @param value - Value to persist.
+   * @returns A promise that resolves after commit.
+   */
+  async set(key, value) {
+    await this.run("readwrite", (store) => store.put(value, key));
+  }
+  async run(mode, action) {
+    return await new Promise((resolve, reject) => {
+      const transaction = this.database.transaction("records", mode);
+      let request;
+      try {
+        request = action(transaction.objectStore("records"));
+      } catch (error) {
+        transaction.abort();
+        reject(error instanceof Error ? error : new Error("Local data-store transaction failed", { cause: error }));
+        return;
+      }
+      transaction.oncomplete = () => {
+        resolve(request.result);
+      };
+      transaction.addEventListener("abort", () => {
+        reject(new Error("Local data-store transaction aborted", { cause: transaction.error }));
+      });
+    });
+  }
+}
+export {
+  LocalDataStore
+};
+//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": ["../../../../src/data-stores/local-data-store.ts"],
  "sourcesContent": ["/* eslint-disable n/no-unsupported-features/node-builtins -- These are Obsidian renderer Web APIs, not Node builtins. */\n/**\n * @file\n *\n * Record-based device-local persistence, isolated by vault, plugin and store.\n */\n\n/**\n * Atomic mutations of a local record store.\n */\nexport interface LocalDataStoreCommitParams {\n  /**\n   * Key/value pairs to write.\n   */\n  readonly entries: readonly (readonly [string, unknown])[];\n  /**\n   * Keys removed in the same transaction as the writes.\n   *\n   * @default `[]`\n   */\n  readonly removedKeys?: readonly string[];\n}\n\n/**\n * Parameters for opening a local store.\n */\nexport interface LocalDataStoreOpenParams {\n  /**\n   * IndexedDB implementation, injectable for tests.\n   */\n  readonly factory?: IDBFactory;\n  /**\n   * Plugin manifest id.\n   */\n  readonly pluginId: string;\n  /**\n   * Store name and schema version chosen by the consumer.\n   */\n  readonly storeId: string;\n  /**\n   * Stable, device-local vault identity; never the vault display name.\n   */\n  readonly vaultId: string;\n}\n\n/**\n * A local store holds structured-cloneable values; it never writes to the vault.\n */\nexport class LocalDataStore {\n  private constructor(private readonly database: IDBDatabase) {}\n\n  /**\n   * Opens an isolated database. Writes resolve only once their transaction commits.\n   *\n   * @param params - Store identity and optional IndexedDB implementation.\n   * @returns The connected store; close it when its owner unloads.\n   */\n  public static async open(params: LocalDataStoreOpenParams): Promise<LocalDataStore> {\n    const name = `obsidian-lib:${JSON.stringify([params.vaultId, params.pluginId, params.storeId])}`;\n    const request = (params.factory ?? indexedDB).open(name, 1);\n    return await new Promise((resolve, reject) => {\n      request.onupgradeneeded = (): void => {\n        request.result.createObjectStore('records');\n      };\n      request.addEventListener('error', (): void => {\n        reject(new Error('Could not open local data store', { cause: request.error }));\n      });\n      request.onsuccess = (): void => {\n        const database = request.result;\n        database.onversionchange = (): void => {\n          database.close();\n        };\n        resolve(new LocalDataStore(database));\n      };\n    });\n  }\n\n  /**\n   * Deletes every record in this store only.\n   *\n   * @returns A promise that resolves after commit.\n   */\n  public async clear(): Promise<void> {\n    await this.run('readwrite', (store) => store.clear());\n  }\n\n  /**\n   * Closes this connection without deleting its records.\n   */\n  public close(): void {\n    this.database.close();\n  }\n\n  /**\n   * Commits several record changes atomically without serializing the rest of the database.\n   *\n   * @param params - Writes and deletions in one transaction.\n   * @returns A promise that resolves only after all changes commit.\n   */\n  public async commit(params: LocalDataStoreCommitParams): Promise<void> {\n    await this.run('readwrite', (store) => {\n      for (const key of params.removedKeys ?? []) {\n        store.delete(key);\n      }\n      for (const [key, value] of params.entries) {\n        store.put(value, key);\n      }\n      return store.count();\n    });\n  }\n\n  /**\n   * Deletes a record.\n   *\n   * @param key - Record key.\n   * @returns A promise that resolves after commit.\n   */\n  public async delete(key: string): Promise<void> {\n    await this.run('readwrite', (store) => store.delete(key));\n  }\n\n  /**\n   * Reads all records in key order.\n   *\n   * @returns Detached key/value pairs.\n   */\n  public async entries(): Promise<[string, unknown][]> {\n    const records: [string, unknown][] = [];\n    await this.run('readonly', (store) => {\n      const request = store.openCursor();\n      request.onsuccess = (): void => {\n        const cursor = request.result;\n        if (!cursor) {\n          return;\n        }\n\n        if (typeof cursor.key !== 'string') {\n          throw new TypeError('Local data-store key is not a string');\n        }\n        records.push([cursor.key, cursor.value]);\n        cursor.continue();\n      };\n      return request;\n    });\n    return records;\n  }\n\n  /**\n   * Serializes a shared-store operation across connections, windows and bundled library copies.\n   *\n   * @typeParam T - Callback result.\n   * @param callback - Work performed while holding this database's Web Lock.\n   * @returns The callback result after releasing the lock.\n   */\n  public async exclusive<T>(callback: () => Promise<T>): Promise<T> {\n    return await window.navigator.locks.request(this.database.name, callback);\n  }\n\n  /**\n   * Reads a record.\n   *\n   * @param key - Record key.\n   * @returns Its value, or `undefined` when absent.\n   */\n  public async get(key: string): Promise<unknown> {\n    return await this.run<unknown>('readonly', (store) => store.get(key));\n  }\n\n  /**\n   * Initializes a record once, atomically across connections.\n   *\n   * @param key - Record key.\n   * @param value - Value used only when the key is absent.\n   * @returns The existing or newly committed value.\n   */\n  public async getOrCreate(key: string, value: unknown): Promise<unknown> {\n    return await this.run<unknown>('readwrite', (store) => {\n      const request = store.get(key);\n      request.onsuccess = (): void => {\n        if (request.result === undefined) {\n          store.put(value, key);\n        }\n      };\n      return request;\n    }).then((existing) => existing === undefined ? value : existing);\n  }\n\n  /**\n   * Writes a structured-cloneable value.\n   *\n   * @param key - Record key.\n   * @param value - Value to persist.\n   * @returns A promise that resolves after commit.\n   */\n  public async set(key: string, value: unknown): Promise<void> {\n    await this.run('readwrite', (store) => store.put(value, key));\n  }\n\n  private async run<T>(mode: IDBTransactionMode, action: (store: IDBObjectStore) => IDBRequest<T>): Promise<T> {\n    return await new Promise((resolve, reject) => {\n      const transaction = this.database.transaction('records', mode);\n      let request: IDBRequest<T>;\n      try {\n        request = action(transaction.objectStore('records'));\n      } catch (error) {\n        transaction.abort();\n        reject(error instanceof Error ? error : new Error('Local data-store transaction failed', { cause: error }));\n        return;\n      }\n      transaction.oncomplete = (): void => {\n        resolve(request.result);\n      };\n      transaction.addEventListener('abort', (): void => {\n        reject(new Error('Local data-store transaction aborted', { cause: transaction.error }));\n      });\n    });\n  }\n}\n\n/* eslint-enable n/no-unsupported-features/node-builtins -- These are Obsidian renderer Web APIs, not Node builtins. */\n"],
  "mappings": ";;;;;AAgDO,MAAM,eAAe;AAAA,EAClB,YAA6B,UAAuB;AAAvB;AAAA,EAAwB;AAAA,EAAxB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQrC,aAAoB,KAAK,QAA2D;AAClF,UAAM,OAAO,gBAAgB,KAAK,UAAU,CAAC,OAAO,SAAS,OAAO,UAAU,OAAO,OAAO,CAAC,CAAC;AAC9F,UAAM,WAAW,OAAO,WAAW,WAAW,KAAK,MAAM,CAAC;AAC1D,WAAO,MAAM,IAAI,QAAQ,CAAC,SAAS,WAAW;AAC5C,cAAQ,kBAAkB,MAAY;AACpC,gBAAQ,OAAO,kBAAkB,SAAS;AAAA,MAC5C;AACA,cAAQ,iBAAiB,SAAS,MAAY;AAC5C,eAAO,IAAI,MAAM,mCAAmC,EAAE,OAAO,QAAQ,MAAM,CAAC,CAAC;AAAA,MAC/E,CAAC;AACD,cAAQ,YAAY,MAAY;AAC9B,cAAM,WAAW,QAAQ;AACzB,iBAAS,kBAAkB,MAAY;AACrC,mBAAS,MAAM;AAAA,QACjB;AACA,gBAAQ,IAAI,eAAe,QAAQ,CAAC;AAAA,MACtC;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,QAAuB;AAClC,UAAM,KAAK,IAAI,aAAa,CAAC,UAAU,MAAM,MAAM,CAAC;AAAA,EACtD;AAAA;AAAA;AAAA;AAAA,EAKO,QAAc;AACnB,SAAK,SAAS,MAAM;AAAA,EACtB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,OAAO,QAAmD;AACrE,UAAM,KAAK,IAAI,aAAa,CAAC,UAAU;AACrC,iBAAW,OAAO,OAAO,eAAe,CAAC,GAAG;AAC1C,cAAM,OAAO,GAAG;AAAA,MAClB;AACA,iBAAW,CAAC,KAAK,KAAK,KAAK,OAAO,SAAS;AACzC,cAAM,IAAI,OAAO,GAAG;AAAA,MACtB;AACA,aAAO,MAAM,MAAM;AAAA,IACrB,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,OAAO,KAA4B;AAC9C,UAAM,KAAK,IAAI,aAAa,CAAC,UAAU,MAAM,OAAO,GAAG,CAAC;AAAA,EAC1D;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,UAAwC;AACnD,UAAM,UAA+B,CAAC;AACtC,UAAM,KAAK,IAAI,YAAY,CAAC,UAAU;AACpC,YAAM,UAAU,MAAM,WAAW;AACjC,cAAQ,YAAY,MAAY;AAC9B,cAAM,SAAS,QAAQ;AACvB,YAAI,CAAC,QAAQ;AACX;AAAA,QACF;AAEA,YAAI,OAAO,OAAO,QAAQ,UAAU;AAClC,gBAAM,IAAI,UAAU,sCAAsC;AAAA,QAC5D;AACA,gBAAQ,KAAK,CAAC,OAAO,KAAK,OAAO,KAAK,CAAC;AACvC,eAAO,SAAS;AAAA,MAClB;AACA,aAAO;AAAA,IACT,CAAC;AACD,WAAO;AAAA,EACT;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,UAAa,UAAwC;AAChE,WAAO,MAAM,OAAO,UAAU,MAAM,QAAQ,KAAK,SAAS,MAAM,QAAQ;AAAA,EAC1E;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAa,IAAI,KAA+B;AAC9C,WAAO,MAAM,KAAK,IAAa,YAAY,CAAC,UAAU,MAAM,IAAI,GAAG,CAAC;AAAA,EACtE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,YAAY,KAAa,OAAkC;AACtE,WAAO,MAAM,KAAK,IAAa,aAAa,CAAC,UAAU;AACrD,YAAM,UAAU,MAAM,IAAI,GAAG;AAC7B,cAAQ,YAAY,MAAY;AAC9B,YAAI,QAAQ,WAAW,QAAW;AAChC,gBAAM,IAAI,OAAO,GAAG;AAAA,QACtB;AAAA,MACF;AACA,aAAO;AAAA,IACT,CAAC,EAAE,KAAK,CAAC,aAAa,aAAa,SAAY,QAAQ,QAAQ;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,IAAI,KAAa,OAA+B;AAC3D,UAAM,KAAK,IAAI,aAAa,CAAC,UAAU,MAAM,IAAI,OAAO,GAAG,CAAC;AAAA,EAC9D;AAAA,EAEA,MAAc,IAAO,MAA0B,QAA8D;AAC3G,WAAO,MAAM,IAAI,QAAQ,CAAC,SAAS,WAAW;AAC5C,YAAM,cAAc,KAAK,SAAS,YAAY,WAAW,IAAI;AAC7D,UAAI;AACJ,UAAI;AACF,kBAAU,OAAO,YAAY,YAAY,SAAS,CAAC;AAAA,MACrD,SAAS,OAAO;AACd,oBAAY,MAAM;AAClB,eAAO,iBAAiB,QAAQ,QAAQ,IAAI,MAAM,uCAAuC,EAAE,OAAO,MAAM,CAAC,CAAC;AAC1G;AAAA,MACF;AACA,kBAAY,aAAa,MAAY;AACnC,gBAAQ,QAAQ,MAAM;AAAA,MACxB;AACA,kBAAY,iBAAiB,SAAS,MAAY;AAChD,eAAO,IAAI,MAAM,wCAAwC,EAAE,OAAO,YAAY,MAAM,CAAC,CAAC;AAAA,MACxF,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AACF;",
  "names": []
}


package/dist/lib/esm/data-stores/shared-data-store.d.mts

@@ -0,0 +1,137 @@
+/// <reference path="../library-references.d.mts" />
+/**
+ * @file
+ *
+ * Mergeable plugin data, transported as single-writer journal segments and chunked snapshots.
+ */
+import type { DataAdapter } from 'obsidian';
+import type { JsonValue } from 'type-fest';
+import type { DataStoreMergeKind } from './data-store-replica.mjs';
+import type { LocalDataStore } from './local-data-store.mjs';
+/**
+ * Parameters for opening a shared store.
+ */
+export interface SharedDataStoreOpenParams {
+    /**
+     * Device retirement interval, measured from its last acknowledgement.
+     *
+     * @default `2592000000`
+     */
+    readonly activeDeviceMilliseconds?: number;
+    /**
+     * Vault adapter.
+     */
+    readonly adapter: DataAdapter;
+    /**
+     * Configurable non-dot vault folder.
+     *
+     * @default `'Plugin data'`
+     */
+    readonly folder?: string;
+    /**
+     * Immutable merge rule; changing it requires a new store id.
+     */
+    readonly kind: DataStoreMergeKind;
+    /**
+     * Dedicated local store scoped to THIS vault, plugin and shared-store schema. The caller owns its connection.
+     */
+    readonly local: LocalDataStore;
+    /**
+     * Maximum UTF-8 bytes per file, wrapper included.
+     *
+     * @default `1000000`
+     */
+    readonly maxFileBytes?: number;
+    /**
+     * Plugin manifest id.
+     */
+    readonly pluginId: string;
+    /**
+     * Store id including the consumer's schema version.
+     */
+    readonly storeId: string;
+}
+/**
+ * A device-local query replica backed by vault files. Call `synchronize` after transport changes or periodically.
+ * No timer or event handler outlives the consumer: the consumer schedules synchronization and owns unloading.
+ */
+export declare class SharedDataStore {
+    protected readonly params: SharedDataStoreOpenParams;
+    protected readonly device: string;
+    private readonly activeDeviceMilliseconds;
+    private counter;
+    private readonly localRecords;
+    private replica;
+    private time;
+    private readonly transport;
+    private readonly vector;
+    private constructor();
+    /**
+     * Opens and synchronizes a store, restoring its device identity exclusively from IndexedDB.
+     *
+     * @param params - Persistence, transport and merge policy.
+     * @returns A synchronized query replica.
+     */
+    static open(params: SharedDataStoreOpenParams): Promise<SharedDataStore>;
+    /**
+     * Publishes a complete chunked snapshot and trims only this device's acknowledged journal segments.
+     * Retired devices rejoin by merging snapshots; tombstones remain in snapshots to prevent resurrection.
+     *
+     * @returns A promise that resolves when compaction finishes.
+     */
+    compact(): Promise<void>;
+    /**
+     * Deletes a register or removes the currently observed additions of a set member.
+     *
+     * @param key - Record key or set member. Min/max registers deliberately cannot be deleted.
+     * @returns A promise that resolves after journal publication and local commit.
+     */
+    delete(key: string): Promise<void>;
+    /**
+     * Reads the current local query replica.
+     *
+     * @returns Detached key/value pairs in deterministic order.
+     */
+    entries(): [string, unknown][];
+    /**
+     * Reads a register or set membership from the current local query replica.
+     *
+     * @param key - Record key or set member.
+     * @returns A detached value, or `undefined` when absent or deleted.
+     */
+    get(key: string): unknown;
+    /**
+     * Writes one register value, or adds a member to an observed-remove set.
+     *
+     * @param key - Record key or set member.
+     * @param value - JSON-compatible value (use `true` for a set).
+     * @returns A promise that resolves after journal publication and local commit.
+     */
+    set(key: string, value: JsonValue): Promise<void>;
+    /**
+     * Publishes a batch of register writes, split into bounded immutable segments.
+     * Segments are individually durable; a failed batch can have a published prefix and can be retried safely.
+     *
+     * @param entries - Register writes or set additions.
+     * @returns A promise that resolves after journal publication and local commit.
+     */
+    setMany(entries: readonly (readonly [string, JsonValue])[]): Promise<void>;
+    /**
+     * Merges complete snapshots and contiguous journal history, then publishes its durable acknowledgement.
+     * Partial deliveries remain pending; a later call retries them. No acknowledgement skips a missing sequence.
+     *
+     * @returns A promise that resolves after the local checkpoint and acknowledgement commit.
+     */
+    synchronize(): Promise<void>;
+    private acknowledgements;
+    private apply;
+    private change;
+    private checkpoint;
+    private deviceRoot;
+    private loadLocal;
+    private mergeCheckpoint;
+    private mergeFiles;
+    private observeClock;
+    private persist;
+    private publish;
+}