@xyo-network/archivist-indexeddb 2.72.8 → 2.73.0
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.
- package/dist/{types/IndexedDbArchivist.d.ts → index.d.mts} +10 -8
- package/dist/index.d.ts +54 -0
- package/dist/index.js +137 -0
- package/dist/index.js.map +1 -0
- package/dist/index.mjs +111 -0
- package/dist/index.mjs.map +1 -0
- package/package.json +38 -25
- package/src/IndexedDbArchivist.ts +1 -1
- package/tsup.config.ts +16 -0
- package/dist/cjs/IndexedDbArchivist.js +0 -98
- package/dist/cjs/IndexedDbArchivist.js.map +0 -1
- package/dist/cjs/index.js +0 -5
- package/dist/cjs/index.js.map +0 -1
- package/dist/docs.json +0 -23207
- package/dist/esm/IndexedDbArchivist.js +0 -80
- package/dist/esm/IndexedDbArchivist.js.map +0 -1
- package/dist/esm/index.js +0 -2
- package/dist/esm/index.js.map +0 -1
- package/dist/types/IndexedDbArchivist.d.ts.map +0 -1
- package/dist/types/index.d.ts +0 -2
- package/dist/types/index.d.ts.map +0 -1
|
@@ -1,80 +0,0 @@
|
|
|
1
|
-
var IndexedDbArchivist_1;
|
|
2
|
-
import { __decorate } from "tslib";
|
|
3
|
-
import { assertEx } from '@xylabs/assert';
|
|
4
|
-
import { AbstractArchivist } from '@xyo-network/abstract-archivist';
|
|
5
|
-
import { ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, } from '@xyo-network/archivist-model';
|
|
6
|
-
import { PayloadHasher } from '@xyo-network/core';
|
|
7
|
-
import { creatableModule } from '@xyo-network/module';
|
|
8
|
-
import { clear, createStore, delMany, entries, getMany, setMany } from 'idb-keyval';
|
|
9
|
-
export const IndexedDbArchivistConfigSchema = 'network.xyo.archivist.indexeddb.config';
|
|
10
|
-
export let IndexedDbArchivist = class IndexedDbArchivist extends AbstractArchivist {
|
|
11
|
-
static { IndexedDbArchivist_1 = this; }
|
|
12
|
-
static configSchemas = [IndexedDbArchivistConfigSchema];
|
|
13
|
-
static defaultDbName = 'archivist';
|
|
14
|
-
static defaultStoreName = 'payloads';
|
|
15
|
-
_db;
|
|
16
|
-
/**
|
|
17
|
-
* The database name. If not supplied via config, it defaults
|
|
18
|
-
* to the module name (not guaranteed to be unique) and if module
|
|
19
|
-
* name is not supplied, it defaults to `archivist`. This behavior
|
|
20
|
-
* biases towards a single, isolated DB per archivist which seems to
|
|
21
|
-
* make the most sense for 99% of use cases.
|
|
22
|
-
*/
|
|
23
|
-
get dbName() {
|
|
24
|
-
return this.config?.dbName ?? this.config?.name ?? IndexedDbArchivist_1.defaultDbName;
|
|
25
|
-
}
|
|
26
|
-
get queries() {
|
|
27
|
-
return [ArchivistAllQuerySchema, ArchivistClearQuerySchema, ArchivistDeleteQuerySchema, ArchivistInsertQuerySchema, ...super.queries];
|
|
28
|
-
}
|
|
29
|
-
/**
|
|
30
|
-
* The name of the object store. If not supplied via config, it defaults
|
|
31
|
-
* to `payloads`. The limitation of the current IndexedDB wrapper we're
|
|
32
|
-
* using is that it only supports a single object store per DB. See here:
|
|
33
|
-
* https://github.com/jakearchibald/idb-keyval/blob/main/custom-stores.md#defining-a-custom-database--store-name
|
|
34
|
-
* If this becomes a problem or we need migrations/transactions, we can
|
|
35
|
-
* move to this more-flexible library, which they recommend (and who
|
|
36
|
-
* recommends them for our simple use case of key-value storage):
|
|
37
|
-
* https://www.npmjs.com/package/idb
|
|
38
|
-
*/
|
|
39
|
-
get storeName() {
|
|
40
|
-
return this.config?.storeName ?? IndexedDbArchivist_1.defaultStoreName;
|
|
41
|
-
}
|
|
42
|
-
get db() {
|
|
43
|
-
return assertEx(this._db, 'DB not initialized');
|
|
44
|
-
}
|
|
45
|
-
async allHandler() {
|
|
46
|
-
const result = await entries(this.db);
|
|
47
|
-
return result.map(([_hash, payload]) => payload);
|
|
48
|
-
}
|
|
49
|
-
async clearHandler() {
|
|
50
|
-
await clear(this.db);
|
|
51
|
-
}
|
|
52
|
-
async deleteHandler(hashes) {
|
|
53
|
-
const payloadPairs = await Promise.all((await this.get(hashes)).map(async (payload) => [await PayloadHasher.hashAsync(payload), payload]));
|
|
54
|
-
const foundHashesToDelete = payloadPairs.map(([hash, _]) => hash);
|
|
55
|
-
await delMany(foundHashesToDelete, this.db);
|
|
56
|
-
return foundHashesToDelete;
|
|
57
|
-
}
|
|
58
|
-
async getHandler(hashes) {
|
|
59
|
-
return (await getMany(hashes, this.db)).filter((result) => result !== undefined);
|
|
60
|
-
}
|
|
61
|
-
async insertHandler(payloads) {
|
|
62
|
-
const entries = await Promise.all(payloads.map(async (payload) => {
|
|
63
|
-
const hash = await PayloadHasher.hashAsync(payload);
|
|
64
|
-
return [hash, payload];
|
|
65
|
-
}));
|
|
66
|
-
await setMany(entries, this.db);
|
|
67
|
-
return payloads;
|
|
68
|
-
}
|
|
69
|
-
async startHandler() {
|
|
70
|
-
await super.startHandler();
|
|
71
|
-
// NOTE: We could defer this creation to first access but we
|
|
72
|
-
// want to fail fast here in case something is wrong
|
|
73
|
-
this._db = createStore(this.dbName, this.storeName);
|
|
74
|
-
return true;
|
|
75
|
-
}
|
|
76
|
-
};
|
|
77
|
-
IndexedDbArchivist = IndexedDbArchivist_1 = __decorate([
|
|
78
|
-
creatableModule()
|
|
79
|
-
], IndexedDbArchivist);
|
|
80
|
-
//# sourceMappingURL=IndexedDbArchivist.js.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"IndexedDbArchivist.js","sourceRoot":"","sources":["../../src/IndexedDbArchivist.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAA;AACzC,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAA;AACnE,OAAO,EACL,uBAAuB,EACvB,yBAAyB,EAEzB,0BAA0B,EAC1B,0BAA0B,GAG3B,MAAM,8BAA8B,CAAA;AACrC,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAA;AACjD,OAAO,EAAmB,eAAe,EAAE,MAAM,qBAAqB,CAAA;AAEtE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAY,MAAM,YAAY,CAAA;AAG7F,MAAM,CAAC,MAAM,8BAA8B,GAAmC,wCAAwC,CAAA;AAiB/G,WAAM,kBAAkB,GAAxB,MAAM,kBAGX,SAAQ,iBAAsC;;IAC9C,MAAM,CAAU,aAAa,GAAG,CAAC,8BAA8B,CAAC,CAAA;IAChE,MAAM,CAAC,aAAa,GAAG,WAAW,CAAA;IAClC,MAAM,CAAC,gBAAgB,GAAG,UAAU,CAAA;IAE5B,GAAG,CAAsB;IAEjC;;;;;;OAMG;IACH,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,MAAM,EAAE,MAAM,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,IAAI,oBAAkB,CAAC,aAAa,CAAA;IACrF,CAAC;IAED,IAAa,OAAO;QAClB,OAAO,CAAC,uBAAuB,EAAE,yBAAyB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;IACvI,CAAC;IACD;;;;;;;;;OASG;IACH,IAAI,SAAS;QACX,OAAO,IAAI,CAAC,MAAM,EAAE,SAAS,IAAI,oBAAkB,CAAC,gBAAgB,CAAA;IACtE,CAAC;IAED,IAAY,EAAE;QACZ,OAAO,QAAQ,CAAC,IAAI,CAAC,GAAG,EAAE,oBAAoB,CAAC,CAAA;IACjD,CAAC;IAEkB,KAAK,CAAC,UAAU;QACjC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAkB,IAAI,CAAC,EAAE,CAAC,CAAA;QACtD,OAAO,MAAM,CAAC,GAAG,CAAU,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,CAAA;IAC3D,CAAC;IAEkB,KAAK,CAAC,YAAY;QACnC,MAAM,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtB,CAAC;IAEkB,KAAK,CAAC,aAAa,CAAC,MAAgB;QACrD,MAAM,YAAY,GAAwB,MAAM,OAAO,CAAC,GAAG,CACzD,CAAC,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAA6B,KAAK,EAAE,OAAO,EAAE,EAAE,CAAC,CAAC,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC,CAC/H,CAAA;QAED,MAAM,mBAAmB,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,CAAA;QACjE,MAAM,OAAO,CAAC,mBAAmB,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAE3C,OAAO,mBAAmB,CAAA;IAC5B,CAAC;IAEkB,KAAK,CAAC,UAAU,CAAC,MAAgB;QAClD,OAAO,CAAC,MAAM,OAAO,CAAU,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,KAAK,SAAS,CAAC,CAAA;IAC3F,CAAC;IAEkB,KAAK,CAAC,aAAa,CAAC,QAAmB;QACxD,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,GAAG,CAC/B,QAAQ,CAAC,GAAG,CAA6B,KAAK,EAAE,OAAO,EAAE,EAAE;YACzD,MAAM,IAAI,GAAG,MAAM,aAAa,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;YACnD,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACxB,CAAC,CAAC,CACH,CAAA;QACD,MAAM,OAAO,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC,CAAA;QAE/B,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEkB,KAAK,CAAC,YAAY;QACnC,MAAM,KAAK,CAAC,YAAY,EAAE,CAAA;QAC1B,4DAA4D;QAC5D,oDAAoD;QACpD,IAAI,CAAC,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAA;QACnD,OAAO,IAAI,CAAA;IACb,CAAC;;AApFU,kBAAkB;IAD9B,eAAe,EAAE;GACL,kBAAkB,CAqF9B"}
|
package/dist/esm/index.js
DELETED
package/dist/esm/index.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}
|
|
@@ -1 +0,0 @@
|
|
|
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"}
|
package/dist/types/index.d.ts
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}
|