@xyo-network/archivist-indexeddb 2.75.0 → 2.75.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (32) hide show
  1. package/dist/browser/IndexedDbArchivist.d.cts +52 -0
  2. package/dist/browser/IndexedDbArchivist.d.cts.map +1 -0
  3. package/dist/browser/IndexedDbArchivist.js +8 -10
  4. package/dist/browser/IndexedDbArchivist.js.map +1 -1
  5. package/dist/browser/index.d.cts +2 -0
  6. package/dist/browser/index.d.cts.map +1 -0
  7. package/dist/browser/index.js +1 -110
  8. package/dist/browser/index.js.map +1 -1
  9. package/dist/browser/sample.archivist.xyo.cjs +19 -0
  10. package/dist/browser/sample.archivist.xyo.cjs.map +1 -0
  11. package/dist/browser/sample.archivist.xyo.js +22 -0
  12. package/dist/browser/sample.archivist.xyo.js.map +1 -0
  13. package/dist/docs.json +22913 -0
  14. package/dist/node/IndexedDbArchivist.d.cts +52 -0
  15. package/dist/node/IndexedDbArchivist.d.cts.map +1 -0
  16. package/dist/node/IndexedDbArchivist.js +17 -13
  17. package/dist/node/IndexedDbArchivist.js.map +1 -1
  18. package/dist/node/IndexedDbArchivist.mjs +23 -19
  19. package/dist/node/IndexedDbArchivist.mjs.map +1 -1
  20. package/dist/node/index.d.cts +2 -0
  21. package/dist/node/index.d.cts.map +1 -0
  22. package/dist/node/index.js +119 -3
  23. package/dist/node/index.js.map +1 -1
  24. package/dist/node/index.mjs +112 -1
  25. package/dist/node/index.mjs.map +1 -1
  26. package/dist/node/sample.archivist.xyo.js +23 -0
  27. package/dist/node/sample.archivist.xyo.js.map +1 -0
  28. package/dist/node/sample.archivist.xyo.mjs +23 -0
  29. package/dist/node/sample.archivist.xyo.mjs.map +1 -0
  30. package/package.json +14 -14
  31. package/dist/browser/sample.archivist.xyo.json +0 -16
  32. package/dist/node/sample.archivist.xyo.json +0 -16
@@ -0,0 +1,52 @@
1
+ import { AbstractArchivist } from '@xyo-network/archivist-abstract';
2
+ import { ArchivistConfig, ArchivistModuleEventData, ArchivistParams } from '@xyo-network/archivist-model';
3
+ import { AnyConfigSchema } from '@xyo-network/module';
4
+ import { Payload } from '@xyo-network/payload-model';
5
+ export type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config';
6
+ export declare const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema;
7
+ export type IndexedDbArchivistConfig = ArchivistConfig<{
8
+ /**
9
+ * The database name
10
+ */
11
+ dbName?: string;
12
+ schema: IndexedDbArchivistConfigSchema;
13
+ /**
14
+ * The name of the object store
15
+ */
16
+ storeName?: string;
17
+ }>;
18
+ export type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>;
19
+ export declare class IndexedDbArchivist<TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams, TEventData extends ArchivistModuleEventData = ArchivistModuleEventData> extends AbstractArchivist<TParams, TEventData> {
20
+ static configSchemas: "network.xyo.archivist.indexeddb.config"[];
21
+ static defaultDbName: string;
22
+ static defaultStoreName: string;
23
+ private _db;
24
+ /**
25
+ * The database name. If not supplied via config, it defaults
26
+ * to the module name (not guaranteed to be unique) and if module
27
+ * name is not supplied, it defaults to `archivist`. This behavior
28
+ * biases towards a single, isolated DB per archivist which seems to
29
+ * make the most sense for 99% of use cases.
30
+ */
31
+ get dbName(): string;
32
+ get queries(): string[];
33
+ /**
34
+ * The name of the object store. If not supplied via config, it defaults
35
+ * to `payloads`. The limitation of the current IndexedDB wrapper we're
36
+ * using is that it only supports a single object store per DB. See here:
37
+ * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name
38
+ * If this becomes a problem or we need migrations/transactions, we can
39
+ * move to this more-flexible library, which they recommend (and who
40
+ * recommends them for our simple use case of key-value storage):
41
+ * https://www.npmjs.com/package/idb
42
+ */
43
+ get storeName(): string;
44
+ private get db();
45
+ protected allHandler(): Promise<Payload[]>;
46
+ protected clearHandler(): Promise<void>;
47
+ protected deleteHandler(hashes: string[]): Promise<string[]>;
48
+ protected getHandler(hashes: string[]): Promise<Payload[]>;
49
+ protected insertHandler(payloads: Payload[]): Promise<Payload[]>;
50
+ protected startHandler(): Promise<boolean>;
51
+ }
52
+ //# sourceMappingURL=IndexedDbArchivist.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"IndexedDbArchivist.d.ts","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EAGL,eAAe,EAGf,wBAAwB,EACxB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAErC,OAAO,EAAE,eAAe,EAAmB,MAAM,qBAAqB,CAAA;AACtE,OAAO,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGpD,MAAM,MAAM,8BAA8B,GAAG,wCAAwC,CAAA;AACrF,eAAO,MAAM,8BAA8B,EAAE,8BAAyE,CAAA;AAEtH,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC;IACrD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,8BAA8B,CAAA;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA;AAEF,MAAM,MAAM,wBAAwB,GAAG,eAAe,CAAC,eAAe,CAAC,wBAAwB,CAAC,CAAC,CAAA;AAEjG,qBACa,kBAAkB,CAC7B,OAAO,SAAS,wBAAwB,GAAG,wBAAwB,EACnE,UAAU,SAAS,wBAAwB,GAAG,wBAAwB,CACtE,SAAQ,iBAAiB,CAAC,OAAO,EAAE,UAAU,CAAC;IAC9C,OAAgB,aAAa,6CAAmC;IAChE,MAAM,CAAC,aAAa,SAAc;IAClC,MAAM,CAAC,gBAAgB,SAAa;IAEpC,OAAO,CAAC,GAAG,CAAsB;IAEjC;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED,IAAa,OAAO,aAEnB;IACD;;;;;;;;;OASG;IACH,IAAI,SAAS,WAEZ;IAED,OAAO,KAAK,EAAE,GAEb;cAEwB,UAAU,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;cAKhC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;cAI7B,aAAa,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;cAWlD,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAIhD,aAAa,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;cAYtD,YAAY;CAOtC"}
@@ -1,13 +1,5 @@
1
1
  var __defProp = Object.defineProperty;
2
2
  var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
3
-
4
- // src/IndexedDbArchivist.ts
5
- import { assertEx } from "@xylabs/assert";
6
- import { AbstractArchivist } from "@xyo-network/archivist-abstract";
7
- import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema } from "@xyo-network/archivist-model";
8
- import { PayloadHasher } from "@xyo-network/core";
9
- import { creatableModule } from "@xyo-network/module";
10
- import { clear, createStore, delMany, entries, getMany, setMany } from "idb-keyval";
11
3
  function _ts_decorate(decorators, target, key, desc) {
12
4
  var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
13
5
  if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
@@ -19,8 +11,14 @@ function _ts_decorate(decorators, target, key, desc) {
19
11
  return c > 3 && r && Object.defineProperty(target, key, r), r;
20
12
  }
21
13
  __name(_ts_decorate, "_ts_decorate");
22
- var IndexedDbArchivistConfigSchema = "network.xyo.archivist.indexeddb.config";
23
- var IndexedDbArchivist = class IndexedDbArchivist2 extends AbstractArchivist {
14
+ import { assertEx } from "@xylabs/assert";
15
+ import { AbstractArchivist } from "@xyo-network/archivist-abstract";
16
+ import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema } from "@xyo-network/archivist-model";
17
+ import { PayloadHasher } from "@xyo-network/core";
18
+ import { creatableModule } from "@xyo-network/module";
19
+ import { clear, createStore, delMany, entries, getMany, setMany } from "idb-keyval";
20
+ const IndexedDbArchivistConfigSchema = "network.xyo.archivist.indexeddb.config";
21
+ let IndexedDbArchivist = class IndexedDbArchivist2 extends AbstractArchivist {
24
22
  static {
25
23
  __name(this, "IndexedDbArchivist");
26
24
  }
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/IndexedDbArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistConfig,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'\n\nexport type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n schema: IndexedDbArchivistConfigSchema\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n\nexport type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static defaultDbName = 'archivist'\n static defaultStoreName = 'payloads'\n\n private _db: UseStore | undefined\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`. The limitation of the current IndexedDB wrapper we're\n * using is that it only supports a single object store per DB. See here:\n * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name\n * If this becomes a problem or we need migrations/transactions, we can\n * move to this more-flexible library, which they recommend (and who\n * recommends them for our simple use case of key-value storage):\n * https://www.npmjs.com/package/idb\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n private get db(): UseStore {\n return assertEx(this._db, 'DB not initialized')\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n const result = await entries<string, Payload>(this.db)\n return result.map<Payload>(([_hash, payload]) => payload)\n }\n\n protected override async clearHandler(): Promise<void> {\n await clear(this.db)\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n const payloadPairs: [string, Payload][] = await Promise.all(\n (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n )\n\n const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash)\n await delMany(foundHashesToDelete, this.db)\n\n return foundHashesToDelete\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n return (await getMany<Payload>(hashes, this.db)).filter((result) => result !== undefined)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const entries = await Promise.all(\n payloads.map<Promise<[string, Payload]>>(async (payload) => {\n const hash = await PayloadHasher.hashAsync(payload)\n return [hash, payload]\n }),\n )\n await setMany(entries, this.db)\n\n return payloads\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n this._db = createStore(this.dbName, this.storeName)\n return true\n }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BAEAC,4BACAC,kCAGK;AACP,SAASC,qBAAqB;AAC9B,SAA0BC,uBAAuB;AAEjD,SAASC,OAAOC,aAAaC,SAASC,SAASC,SAASC,eAAyB;;;;;;;;;;;;AAG1E,IAAMC,iCAAiE;AAiB9E,IAAaC,qBAAN,MAAAA,4BAGGC,kBAAAA;SAAAA;;;EACR,OAAgBC,gBAAgB;IAACH;;EACjC,OAAOI,gBAAgB;EACvB,OAAOC,mBAAmB;EAElBC;;;;;;;;EASR,IAAIC,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQR,oBAAmBG;EACxE;EAEA,IAAaM,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;;;;;;;EAWA,IAAIK,YAAY;AACd,WAAO,KAAKP,QAAQO,aAAad,oBAAmBI;EACtD;EAEA,IAAYW,KAAe;AACzB,WAAOC,SAAS,KAAKX,KAAK,oBAAA;EAC5B;EAEA,MAAyBY,aAAiC;AACxD,UAAMC,SAAS,MAAMC,QAAyB,KAAKJ,EAAE;AACrD,WAAOG,OAAOE,IAAa,CAAC,CAACC,OAAOC,OAAAA,MAAaA,OAAAA;EACnD;EAEA,MAAyBC,eAA8B;AACrD,UAAMC,MAAM,KAAKT,EAAE;EACrB;EAEA,MAAyBU,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMC,QAAQC,KACrD,MAAM,KAAKC,IAAIJ,MAAAA,GAASN,IAAgC,OAAOE,YAAY;MAAC,MAAMS,cAAcC,UAAUV,OAAAA;MAAUA;KAAQ,CAAA;AAG/H,UAAMW,sBAAsBN,aAAaP,IAAI,CAAC,CAACc,MAAMC,CAAAA,MAAOD,IAAAA;AAC5D,UAAME,QAAQH,qBAAqB,KAAKlB,EAAE;AAE1C,WAAOkB;EACT;EAEA,MAAyBI,WAAWX,QAAsC;AACxE,YAAQ,MAAMY,QAAiBZ,QAAQ,KAAKX,EAAE,GAAGwB,OAAO,CAACrB,WAAWA,WAAWsB,MAAAA;EACjF;EAEA,MAAyBC,cAAcC,UAAyC;AAC9E,UAAMvB,WAAU,MAAMS,QAAQC,IAC5Ba,SAAStB,IAAgC,OAAOE,YAAAA;AAC9C,YAAMY,OAAO,MAAMH,cAAcC,UAAUV,OAAAA;AAC3C,aAAO;QAACY;QAAMZ;;IAChB,CAAA,CAAA;AAEF,UAAMqB,QAAQxB,UAAS,KAAKJ,EAAE;AAE9B,WAAO2B;EACT;EAEA,MAAyBE,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAKvC,MAAMwC,YAAY,KAAKvC,QAAQ,KAAKQ,SAAS;AAClD,WAAO;EACT;AACF;AArFad,qBAAAA,aAAAA;EADZ8C,gBAAAA;GACY9C,kBAAAA;","names":["assertEx","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadHasher","creatableModule","clear","createStore","delMany","entries","getMany","setMany","IndexedDbArchivistConfigSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","defaultDbName","defaultStoreName","_db","dbName","config","name","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","db","assertEx","allHandler","result","entries","map","_hash","payload","clearHandler","clear","deleteHandler","hashes","payloadPairs","Promise","all","get","PayloadHasher","hashAsync","foundHashesToDelete","hash","_","delMany","getHandler","getMany","filter","undefined","insertHandler","payloads","setMany","startHandler","createStore","creatableModule"]}
1
+ {"version":3,"sources":["../../src/IndexedDbArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistConfig,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'\n\nexport type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n schema: IndexedDbArchivistConfigSchema\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n\nexport type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static defaultDbName = 'archivist'\n static defaultStoreName = 'payloads'\n\n private _db: UseStore | undefined\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`. The limitation of the current IndexedDB wrapper we're\n * using is that it only supports a single object store per DB. See here:\n * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name\n * If this becomes a problem or we need migrations/transactions, we can\n * move to this more-flexible library, which they recommend (and who\n * recommends them for our simple use case of key-value storage):\n * https://www.npmjs.com/package/idb\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n private get db(): UseStore {\n return assertEx(this._db, 'DB not initialized')\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n const result = await entries<string, Payload>(this.db)\n return result.map<Payload>(([_hash, payload]) => payload)\n }\n\n protected override async clearHandler(): Promise<void> {\n await clear(this.db)\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n const payloadPairs: [string, Payload][] = await Promise.all(\n (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n )\n\n const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash)\n await delMany(foundHashesToDelete, this.db)\n\n return foundHashesToDelete\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n return (await getMany<Payload>(hashes, this.db)).filter((result) => result !== undefined)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const entries = await Promise.all(\n payloads.map<Promise<[string, Payload]>>(async (payload) => {\n const hash = await PayloadHasher.hashAsync(payload)\n return [hash, payload]\n }),\n )\n await setMany(entries, this.db)\n\n return payloads\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n this._db = createStore(this.dbName, this.storeName)\n return true\n }\n}\n"],"mappings":";;;;;;;;;;;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BAEAC,4BACAC,kCAGK;AACP,SAASC,qBAAqB;AAC9B,SAA0BC,uBAAuB;AAEjD,SAASC,OAAOC,aAAaC,SAASC,SAASC,SAASC,eAAyB;AAG1E,MAAMC,iCAAiE;AAiB9E,IAAaC,qBAAN,MAAAA,4BAGGd,kBAAAA;SAAAA;;;EACR,OAAgBe,gBAAgB;IAACF;;EACjC,OAAOG,gBAAgB;EACvB,OAAOC,mBAAmB;EAElBC;;;;;;;;EASR,IAAIC,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQP,oBAAmBE;EACxE;EAEA,IAAaM,UAAU;AACrB,WAAO;MAACrB;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMkB;;EAC/H;;;;;;;;;;;EAWA,IAAIC,YAAY;AACd,WAAO,KAAKH,QAAQG,aAAaT,oBAAmBG;EACtD;EAEA,IAAYO,KAAe;AACzB,WAAOzB,SAAS,KAAKmB,KAAK,oBAAA;EAC5B;EAEA,MAAyBO,aAAiC;AACxD,UAAMC,SAAS,MAAMhB,QAAyB,KAAKc,EAAE;AACrD,WAAOE,OAAOC,IAAa,CAAC,CAACC,OAAOC,OAAAA,MAAaA,OAAAA;EACnD;EAEA,MAAyBC,eAA8B;AACrD,UAAMvB,MAAM,KAAKiB,EAAE;EACrB;EAEA,MAAyBO,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMC,QAAQC,KACrD,MAAM,KAAKC,IAAIJ,MAAAA,GAASL,IAAgC,OAAOE,YAAY;MAAC,MAAMxB,cAAcgC,UAAUR,OAAAA;MAAUA;KAAQ,CAAA;AAG/H,UAAMS,sBAAsBL,aAAaN,IAAI,CAAC,CAACY,MAAMC,CAAAA,MAAOD,IAAAA;AAC5D,UAAM9B,QAAQ6B,qBAAqB,KAAKd,EAAE;AAE1C,WAAOc;EACT;EAEA,MAAyBG,WAAWT,QAAsC;AACxE,YAAQ,MAAMrB,QAAiBqB,QAAQ,KAAKR,EAAE,GAAGkB,OAAO,CAAChB,WAAWA,WAAWiB,MAAAA;EACjF;EAEA,MAAyBC,cAAcC,UAAyC;AAC9E,UAAMnC,WAAU,MAAMwB,QAAQC,IAC5BU,SAASlB,IAAgC,OAAOE,YAAAA;AAC9C,YAAMU,OAAO,MAAMlC,cAAcgC,UAAUR,OAAAA;AAC3C,aAAO;QAACU;QAAMV;;IAChB,CAAA,CAAA;AAEF,UAAMjB,QAAQF,UAAS,KAAKc,EAAE;AAE9B,WAAOqB;EACT;EAEA,MAAyBC,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAK5B,MAAMV,YAAY,KAAKW,QAAQ,KAAKI,SAAS;AAClD,WAAO;EACT;AACF;AArFaT,qBAAAA,aAAAA;EADZR,gBAAAA;GACYQ,kBAAAA;","names":["assertEx","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadHasher","creatableModule","clear","createStore","delMany","entries","getMany","setMany","IndexedDbArchivistConfigSchema","IndexedDbArchivist","configSchemas","defaultDbName","defaultStoreName","_db","dbName","config","name","queries","storeName","db","allHandler","result","map","_hash","payload","clearHandler","deleteHandler","hashes","payloadPairs","Promise","all","get","hashAsync","foundHashesToDelete","hash","_","getHandler","filter","undefined","insertHandler","payloads","startHandler"]}
@@ -0,0 +1,2 @@
1
+ export * from './IndexedDbArchivist';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}
@@ -1,111 +1,2 @@
1
- var __defProp = Object.defineProperty;
2
- var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
3
-
4
- // src/IndexedDbArchivist.ts
5
- import { assertEx } from "@xylabs/assert";
6
- import { AbstractArchivist } from "@xyo-network/archivist-abstract";
7
- import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema } from "@xyo-network/archivist-model";
8
- import { PayloadHasher } from "@xyo-network/core";
9
- import { creatableModule } from "@xyo-network/module";
10
- import { clear, createStore, delMany, entries, getMany, setMany } from "idb-keyval";
11
- function _ts_decorate(decorators, target, key, desc) {
12
- var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
13
- if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
14
- r = Reflect.decorate(decorators, target, key, desc);
15
- else
16
- for (var i = decorators.length - 1; i >= 0; i--)
17
- if (d = decorators[i])
18
- r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
19
- return c > 3 && r && Object.defineProperty(target, key, r), r;
20
- }
21
- __name(_ts_decorate, "_ts_decorate");
22
- var IndexedDbArchivistConfigSchema = "network.xyo.archivist.indexeddb.config";
23
- var IndexedDbArchivist = class IndexedDbArchivist2 extends AbstractArchivist {
24
- static {
25
- __name(this, "IndexedDbArchivist");
26
- }
27
- static configSchemas = [
28
- IndexedDbArchivistConfigSchema
29
- ];
30
- static defaultDbName = "archivist";
31
- static defaultStoreName = "payloads";
32
- _db;
33
- /**
34
- * The database name. If not supplied via config, it defaults
35
- * to the module name (not guaranteed to be unique) and if module
36
- * name is not supplied, it defaults to `archivist`. This behavior
37
- * biases towards a single, isolated DB per archivist which seems to
38
- * make the most sense for 99% of use cases.
39
- */
40
- get dbName() {
41
- return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist2.defaultDbName;
42
- }
43
- get queries() {
44
- return [
45
- ArchivistAllQuerySchema,
46
- ArchivistClearQuerySchema,
47
- ArchivistDeleteQuerySchema,
48
- ArchivistInsertQuerySchema,
49
- ...super.queries
50
- ];
51
- }
52
- /**
53
- * The name of the object store. If not supplied via config, it defaults
54
- * to `payloads`. The limitation of the current IndexedDB wrapper we're
55
- * using is that it only supports a single object store per DB. See here:
56
- * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name
57
- * If this becomes a problem or we need migrations/transactions, we can
58
- * move to this more-flexible library, which they recommend (and who
59
- * recommends them for our simple use case of key-value storage):
60
- * https://www.npmjs.com/package/idb
61
- */
62
- get storeName() {
63
- return this.config?.storeName ?? IndexedDbArchivist2.defaultStoreName;
64
- }
65
- get db() {
66
- return assertEx(this._db, "DB not initialized");
67
- }
68
- async allHandler() {
69
- const result = await entries(this.db);
70
- return result.map(([_hash, payload]) => payload);
71
- }
72
- async clearHandler() {
73
- await clear(this.db);
74
- }
75
- async deleteHandler(hashes) {
76
- const payloadPairs = await Promise.all((await this.get(hashes)).map(async (payload) => [
77
- await PayloadHasher.hashAsync(payload),
78
- payload
79
- ]));
80
- const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash);
81
- await delMany(foundHashesToDelete, this.db);
82
- return foundHashesToDelete;
83
- }
84
- async getHandler(hashes) {
85
- return (await getMany(hashes, this.db)).filter((result) => result !== void 0);
86
- }
87
- async insertHandler(payloads) {
88
- const entries2 = await Promise.all(payloads.map(async (payload) => {
89
- const hash = await PayloadHasher.hashAsync(payload);
90
- return [
91
- hash,
92
- payload
93
- ];
94
- }));
95
- await setMany(entries2, this.db);
96
- return payloads;
97
- }
98
- async startHandler() {
99
- await super.startHandler();
100
- this._db = createStore(this.dbName, this.storeName);
101
- return true;
102
- }
103
- };
104
- IndexedDbArchivist = _ts_decorate([
105
- creatableModule()
106
- ], IndexedDbArchivist);
107
- export {
108
- IndexedDbArchivist,
109
- IndexedDbArchivistConfigSchema
110
- };
1
+ export * from "./IndexedDbArchivist";
111
2
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/IndexedDbArchivist.ts"],"sourcesContent":["import { assertEx } from '@xylabs/assert'\nimport { AbstractArchivist } from '@xyo-network/archivist-abstract'\nimport {\n ArchivistAllQuerySchema,\n ArchivistClearQuerySchema,\n ArchivistConfig,\n ArchivistDeleteQuerySchema,\n ArchivistInsertQuerySchema,\n ArchivistModuleEventData,\n ArchivistParams,\n} from '@xyo-network/archivist-model'\nimport { PayloadHasher } from '@xyo-network/core'\nimport { AnyConfigSchema, creatableModule } from '@xyo-network/module'\nimport { Payload } from '@xyo-network/payload-model'\nimport { clear, createStore, delMany, entries, getMany, setMany, UseStore } from 'idb-keyval'\n\nexport type IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\nexport const IndexedDbArchivistConfigSchema: IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config'\n\nexport type IndexedDbArchivistConfig = ArchivistConfig<{\n /**\n * The database name\n */\n dbName?: string\n schema: IndexedDbArchivistConfigSchema\n /**\n * The name of the object store\n */\n storeName?: string\n}>\n\nexport type IndexedDbArchivistParams = ArchivistParams<AnyConfigSchema<IndexedDbArchivistConfig>>\n\n@creatableModule()\nexport class IndexedDbArchivist<\n TParams extends IndexedDbArchivistParams = IndexedDbArchivistParams,\n TEventData extends ArchivistModuleEventData = ArchivistModuleEventData,\n> extends AbstractArchivist<TParams, TEventData> {\n static override configSchemas = [IndexedDbArchivistConfigSchema]\n static defaultDbName = 'archivist'\n static defaultStoreName = 'payloads'\n\n private _db: UseStore | undefined\n\n /**\n * The database name. If not supplied via config, it defaults\n * to the module name (not guaranteed to be unique) and if module\n * name is not supplied, it defaults to `archivist`. This behavior\n * biases towards a single, isolated DB per archivist which seems to\n * make the most sense for 99% of use cases.\n */\n get dbName() {\n return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist.defaultDbName\n }\n\n override get queries() {\n return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries]\n }\n /**\n * The name of the object store. If not supplied via config, it defaults\n * to `payloads`. The limitation of the current IndexedDB wrapper we're\n * using is that it only supports a single object store per DB. See here:\n * https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name\n * If this becomes a problem or we need migrations/transactions, we can\n * move to this more-flexible library, which they recommend (and who\n * recommends them for our simple use case of key-value storage):\n * https://www.npmjs.com/package/idb\n */\n get storeName() {\n return this.config?.storeName ?? IndexedDbArchivist.defaultStoreName\n }\n\n private get db(): UseStore {\n return assertEx(this._db, 'DB not initialized')\n }\n\n protected override async allHandler(): Promise<Payload[]> {\n const result = await entries<string, Payload>(this.db)\n return result.map<Payload>(([_hash, payload]) => payload)\n }\n\n protected override async clearHandler(): Promise<void> {\n await clear(this.db)\n }\n\n protected override async deleteHandler(hashes: string[]): Promise<string[]> {\n const payloadPairs: [string, Payload][] = await Promise.all(\n (await this.get(hashes)).map<Promise<[string, Payload]>>(async (payload) => [await PayloadHasher.hashAsync(payload), payload]),\n )\n\n const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash)\n await delMany(foundHashesToDelete, this.db)\n\n return foundHashesToDelete\n }\n\n protected override async getHandler(hashes: string[]): Promise<Payload[]> {\n return (await getMany<Payload>(hashes, this.db)).filter((result) => result !== undefined)\n }\n\n protected override async insertHandler(payloads: Payload[]): Promise<Payload[]> {\n const entries = await Promise.all(\n payloads.map<Promise<[string, Payload]>>(async (payload) => {\n const hash = await PayloadHasher.hashAsync(payload)\n return [hash, payload]\n }),\n )\n await setMany(entries, this.db)\n\n return payloads\n }\n\n protected override async startHandler() {\n await super.startHandler()\n // NOTE: We could defer this creation to first access but we\n // want to fail fast here in case something is wrong\n this._db = createStore(this.dbName, this.storeName)\n return true\n }\n}\n"],"mappings":";;;;AAAA,SAASA,gBAAgB;AACzB,SAASC,yBAAyB;AAClC,SACEC,yBACAC,2BAEAC,4BACAC,kCAGK;AACP,SAASC,qBAAqB;AAC9B,SAA0BC,uBAAuB;AAEjD,SAASC,OAAOC,aAAaC,SAASC,SAASC,SAASC,eAAyB;;;;;;;;;;;;AAG1E,IAAMC,iCAAiE;AAiB9E,IAAaC,qBAAN,MAAAA,4BAGGC,kBAAAA;SAAAA;;;EACR,OAAgBC,gBAAgB;IAACH;;EACjC,OAAOI,gBAAgB;EACvB,OAAOC,mBAAmB;EAElBC;;;;;;;;EASR,IAAIC,SAAS;AACX,WAAO,KAAKC,QAAQD,UAAU,KAAKC,QAAQC,QAAQR,oBAAmBG;EACxE;EAEA,IAAaM,UAAU;AACrB,WAAO;MAACC;MAAyBC;MAA2BC;MAA4BC;SAA+B,MAAMJ;;EAC/H;;;;;;;;;;;EAWA,IAAIK,YAAY;AACd,WAAO,KAAKP,QAAQO,aAAad,oBAAmBI;EACtD;EAEA,IAAYW,KAAe;AACzB,WAAOC,SAAS,KAAKX,KAAK,oBAAA;EAC5B;EAEA,MAAyBY,aAAiC;AACxD,UAAMC,SAAS,MAAMC,QAAyB,KAAKJ,EAAE;AACrD,WAAOG,OAAOE,IAAa,CAAC,CAACC,OAAOC,OAAAA,MAAaA,OAAAA;EACnD;EAEA,MAAyBC,eAA8B;AACrD,UAAMC,MAAM,KAAKT,EAAE;EACrB;EAEA,MAAyBU,cAAcC,QAAqC;AAC1E,UAAMC,eAAoC,MAAMC,QAAQC,KACrD,MAAM,KAAKC,IAAIJ,MAAAA,GAASN,IAAgC,OAAOE,YAAY;MAAC,MAAMS,cAAcC,UAAUV,OAAAA;MAAUA;KAAQ,CAAA;AAG/H,UAAMW,sBAAsBN,aAAaP,IAAI,CAAC,CAACc,MAAMC,CAAAA,MAAOD,IAAAA;AAC5D,UAAME,QAAQH,qBAAqB,KAAKlB,EAAE;AAE1C,WAAOkB;EACT;EAEA,MAAyBI,WAAWX,QAAsC;AACxE,YAAQ,MAAMY,QAAiBZ,QAAQ,KAAKX,EAAE,GAAGwB,OAAO,CAACrB,WAAWA,WAAWsB,MAAAA;EACjF;EAEA,MAAyBC,cAAcC,UAAyC;AAC9E,UAAMvB,WAAU,MAAMS,QAAQC,IAC5Ba,SAAStB,IAAgC,OAAOE,YAAAA;AAC9C,YAAMY,OAAO,MAAMH,cAAcC,UAAUV,OAAAA;AAC3C,aAAO;QAACY;QAAMZ;;IAChB,CAAA,CAAA;AAEF,UAAMqB,QAAQxB,UAAS,KAAKJ,EAAE;AAE9B,WAAO2B;EACT;EAEA,MAAyBE,eAAe;AACtC,UAAM,MAAMA,aAAAA;AAGZ,SAAKvC,MAAMwC,YAAY,KAAKvC,QAAQ,KAAKQ,SAAS;AAClD,WAAO;EACT;AACF;AArFad,qBAAAA,aAAAA;EADZ8C,gBAAAA;GACY9C,kBAAAA;","names":["assertEx","AbstractArchivist","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","PayloadHasher","creatableModule","clear","createStore","delMany","entries","getMany","setMany","IndexedDbArchivistConfigSchema","IndexedDbArchivist","AbstractArchivist","configSchemas","defaultDbName","defaultStoreName","_db","dbName","config","name","queries","ArchivistAllQuerySchema","ArchivistClearQuerySchema","ArchivistDeleteQuerySchema","ArchivistInsertQuerySchema","storeName","db","assertEx","allHandler","result","entries","map","_hash","payload","clearHandler","clear","deleteHandler","hashes","payloadPairs","Promise","all","get","PayloadHasher","hashAsync","foundHashesToDelete","hash","_","delMany","getHandler","getMany","filter","undefined","insertHandler","payloads","setMany","startHandler","createStore","creatableModule"]}
1
+ {"version":3,"sources":["../../src/index.ts"],"sourcesContent":["export * from './IndexedDbArchivist'\n"],"mappings":"AAAA,cAAc;","names":[]}
@@ -0,0 +1,19 @@
1
+ // src/sample.archivist.xyo.json
2
+ var payloads = [
3
+ {
4
+ schema: "network.xyo.test.1"
5
+ },
6
+ {
7
+ schema: "network.xyo.test.2"
8
+ },
9
+ {
10
+ schema: "network.xyo.test.3"
11
+ },
12
+ {
13
+ schema: "network.xyo.test.4"
14
+ }
15
+ ];
16
+ var sample_archivist_xyo_default = {
17
+ payloads
18
+ };
19
+ //# sourceMappingURL=sample.archivist.xyo.cjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/sample.archivist.xyo.json"],"sourcesContent":["{\n \"payloads\": [\n {\n \"schema\": \"network.xyo.test.1\"\n },\n {\n \"schema\": \"network.xyo.test.2\"\n },\n {\n \"schema\": \"network.xyo.test.3\"\n },\n {\n \"schema\": \"network.xyo.test.4\"\n }\n ]\n}"],"mappings":";AACE,eAAY;AAAA,EACV;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AACF;AAdF;AAAA,EACE;AAcF;","names":[]}
@@ -0,0 +1,22 @@
1
+ var payloads = [
2
+ {
3
+ schema: "network.xyo.test.1"
4
+ },
5
+ {
6
+ schema: "network.xyo.test.2"
7
+ },
8
+ {
9
+ schema: "network.xyo.test.3"
10
+ },
11
+ {
12
+ schema: "network.xyo.test.4"
13
+ }
14
+ ];
15
+ var sample_archivist_xyo_default = {
16
+ payloads
17
+ };
18
+ export {
19
+ sample_archivist_xyo_default as default,
20
+ payloads
21
+ };
22
+ //# sourceMappingURL=sample.archivist.xyo.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../../src/sample.archivist.xyo.json"],"sourcesContent":["{\n \"payloads\": [\n {\n \"schema\": \"network.xyo.test.1\"\n },\n {\n \"schema\": \"network.xyo.test.2\"\n },\n {\n \"schema\": \"network.xyo.test.3\"\n },\n {\n \"schema\": \"network.xyo.test.4\"\n }\n ]\n}"],"mappings":"AACE,eAAY;AAAA,EACV;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AAAA,EACA;AAAA,IACE,QAAU;AAAA,EACZ;AACF;AAdF;AAAA,EACE;AAcF;","names":[]}