@xyo-network/diviner-payload-indexeddb 3.3.0 → 3.3.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 (5) hide show
  1. package/dist/browser/Config.d.ts +16 -0
  2. package/dist/browser/Config.d.ts.map +1 -1
  3. package/dist/browser/Diviner.d.ts +23 -0
  4. package/dist/browser/Diviner.d.ts.map +1 -1
  5. package/package.json +18 -18
package/dist/browser/Config.d.ts CHANGED
@@ -3,12 +3,28 @@ import type { DivinerConfig } from '@xyo-network/diviner-model';
3
3
  export declare const IndexedDbPayloadDivinerConfigSchema: "network.xyo.diviner.payload.indexeddb.config";
4
4
  export type IndexedDbPayloadDivinerConfigSchema = typeof IndexedDbPayloadDivinerConfigSchema;
5
5
  export type IndexedDbPayloadDivinerConfig = DivinerConfig<{
6
+ /**
7
+ * The database name
8
+ */
6
9
  dbName?: string;
10
+ /**
11
+ * The version of the DB, defaults to 1
12
+ */
7
13
  dbVersion?: number;
8
14
  schema: IndexedDbPayloadDivinerConfigSchema;
15
+ /**
16
+ * The storage configuration
17
+ * // TODO: Hoist to main diviner config
18
+ */
9
19
  storage?: {
20
+ /**
21
+ * The indexes to create on the object store
22
+ */
10
23
  indexes?: IndexDescription[];
11
24
  };
25
+ /**
26
+ * The name of the object store
27
+ */
12
28
  storeName?: string;
13
29
  }>;
14
30
  //# sourceMappingURL=Config.d.ts.map
package/dist/browser/Config.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAI/D,eAAO,MAAM,mCAAmC,gDAAqD,CAAA;AACrG,MAAM,MAAM,mCAAmC,GAAG,OAAO,mCAAmC,CAAA;AAE5F,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC;IAIxD,MAAM,CAAC,EAAE,MAAM,CAAA;IAIf,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,mCAAmC,CAAA;IAK3C,OAAO,CAAC,EAAE;QAIR,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC7B,CAAA;IAID,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA"}
1
+ {"version":3,"file":"Config.d.ts","sourceRoot":"","sources":["../../src/Config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AACpE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAA;AAI/D,eAAO,MAAM,mCAAmC,gDAAqD,CAAA;AACrG,MAAM,MAAM,mCAAmC,GAAG,OAAO,mCAAmC,CAAA;AAE5F,MAAM,MAAM,6BAA6B,GAAG,aAAa,CAAC;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IACf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,MAAM,EAAE,mCAAmC,CAAA;IAC3C;;;OAGG;IACH,OAAO,CAAC,EAAE;QACR;;WAEG;QACH,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAA;KAC7B,CAAA;IACD;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB,CAAC,CAAA"}
package/dist/browser/Diviner.d.ts CHANGED
@@ -7,14 +7,37 @@ export declare class IndexedDbPayloadDiviner<TParams extends IndexedDbPayloadDiv
7
7
  static readonly configSchemas: Schema[];
8
8
  static readonly defaultConfigSchema: Schema;
9
9
  private _db;
10
+ /**
11
+ * The database name. If not supplied via config, it defaults
12
+ * to the archivist's name and if archivist's name is not supplied,
13
+ * it defaults to `archivist`. This behavior
14
+ * biases towards a single, isolated DB per archivist which seems to
15
+ * make the most sense for 99% of use cases.
16
+ */
10
17
  get dbName(): string;
18
+ /**
19
+ * The database version. If not supplied via config, it defaults to the archivist default version.
20
+ */
11
21
  get dbVersion(): number;
22
+ /**
23
+ * The name of the object store. If not supplied via config, it defaults
24
+ * to `payloads`.
25
+ */
12
26
  get storeName(): string;
13
27
  protected divineHandler(payloads?: TIn[]): Promise<TOut[]>;
14
28
  protected startHandler(): Promise<boolean>;
15
29
  private getKeyRangeValue;
16
30
  private selectBestIndex;
31
+ /**
32
+ * Checks that the desired DB/objectStore exists and is initialized to the correct version
33
+ * @returns The initialized DB or undefined if it does not exist in the desired state
34
+ */
17
35
  private tryGetInitializedDb;
36
+ /**
37
+ * Executes a callback with the initialized DB and then closes the db
38
+ * @param callback The method to execute with the initialized DB
39
+ * @returns
40
+ */
18
41
  private tryUseDb;
19
42
  }
20
43
  //# sourceMappingURL=Diviner.d.ts.map
package/dist/browser/Diviner.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAGpF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAKnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AA4BhE,qBAAa,uBAAuB,CAClC,OAAO,SAAS,6BAA6B,GAAG,6BAA6B,EAC7E,GAAG,SAAS,0BAA0B,GAAG,0BAA0B,EACnE,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACtD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAgE;IAChH,gBAAyB,mBAAmB,EAAE,MAAM,CAAsC;IAE1F,OAAO,CAAC,GAAG,CAAwC;IASnD,IAAI,MAAM,WAET;IAKD,IAAI,SAAS,WAEZ;IAMD,IAAI,SAAS,WAEZ;cAEwB,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAsEhD,YAAY;IAKrC,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,eAAe;YAwBT,mBAAmB;YA6BnB,QAAQ;CAcvB"}
1
+ {"version":3,"file":"Diviner.d.ts","sourceRoot":"","sources":["../../src/Diviner.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AACzF,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAA;AACtE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,oCAAoC,CAAA;AAGpF,OAAO,KAAK,EACV,OAAO,EAAE,MAAM,EAChB,MAAM,4BAA4B,CAAA;AAKnC,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AA4BhE,qBAAa,uBAAuB,CAClC,OAAO,SAAS,6BAA6B,GAAG,6BAA6B,EAC7E,GAAG,SAAS,0BAA0B,GAAG,0BAA0B,EACnE,IAAI,SAAS,OAAO,GAAG,OAAO,EAC9B,UAAU,SAAS,sBAAsB,CAAC,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,sBAAsB,CAChH,eAAe,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,CAAC,EACnC,GAAG,EACH,IAAI,CACL,CACD,SAAQ,cAAc,CAAC,OAAO,EAAE,GAAG,EAAE,IAAI,EAAE,UAAU,CAAC;IACtD,gBAAyB,aAAa,EAAE,MAAM,EAAE,CAAgE;IAChH,gBAAyB,mBAAmB,EAAE,MAAM,CAAsC;IAE1F,OAAO,CAAC,GAAG,CAAwC;IAEnD;;;;;;OAMG;IACH,IAAI,MAAM,WAET;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED;;;OAGG;IACH,IAAI,SAAS,WAEZ;cAEwB,aAAa,CAAC,QAAQ,CAAC,EAAE,GAAG,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC;cAsEhD,YAAY;IAKrC,OAAO,CAAC,gBAAgB;IAWxB,OAAO,CAAC,eAAe;IAoBvB;;;OAGG;YACW,mBAAmB;IAwBjC;;;;OAIG;YACW,QAAQ;CAcvB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/diviner-payload-indexeddb",
3
- "version": "3.3.0",
3
+ "version": "3.3.1",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -29,26 +29,26 @@
29
29
  "module": "dist/browser/index.mjs",
30
30
  "types": "dist/browser/index.d.ts",
31
31
  "dependencies": {
32
- "@xylabs/array": "^4.2.2",
33
- "@xylabs/assert": "^4.2.2",
34
- "@xylabs/exists": "^4.2.2",
35
- "@xylabs/hex": "^4.2.2",
36
- "@xylabs/object": "^4.2.2",
37
- "@xyo-network/archivist-indexeddb": "^3.3.0",
38
- "@xyo-network/archivist-model": "^3.3.0",
39
- "@xyo-network/diviner-model": "^3.3.0",
40
- "@xyo-network/diviner-payload-abstract": "^3.3.0",
41
- "@xyo-network/diviner-payload-model": "^3.3.0",
42
- "@xyo-network/module-model": "^3.3.0",
43
- "@xyo-network/payload-builder": "^3.3.0",
44
- "@xyo-network/payload-model": "^3.3.0",
32
+ "@xylabs/array": "^4.3.2",
33
+ "@xylabs/assert": "^4.3.2",
34
+ "@xylabs/exists": "^4.3.2",
35
+ "@xylabs/hex": "^4.3.2",
36
+ "@xylabs/object": "^4.3.2",
37
+ "@xyo-network/archivist-indexeddb": "^3.3.1",
38
+ "@xyo-network/archivist-model": "^3.3.1",
39
+ "@xyo-network/diviner-model": "^3.3.1",
40
+ "@xyo-network/diviner-payload-abstract": "^3.3.1",
41
+ "@xyo-network/diviner-payload-model": "^3.3.1",
42
+ "@xyo-network/module-model": "^3.3.1",
43
+ "@xyo-network/payload-builder": "^3.3.1",
44
+ "@xyo-network/payload-model": "^3.3.1",
45
45
  "idb": "^8.0.0"
46
46
  },
47
47
  "devDependencies": {
48
- "@xylabs/ts-scripts-yarn3": "^4.2.1",
49
- "@xylabs/tsconfig": "^4.2.1",
50
- "@xyo-network/archivist-indexeddb": "^3.3.0",
51
- "@xyo-network/node-memory": "^3.3.0",
48
+ "@xylabs/ts-scripts-yarn3": "^4.2.3",
49
+ "@xylabs/tsconfig": "^4.2.3",
50
+ "@xyo-network/archivist-indexeddb": "^3.3.1",
51
+ "@xyo-network/node-memory": "^3.3.1",
52
52
  "fake-indexeddb": "^6.0.0",
53
53
  "typescript": "^5.6.3"
54
54
  },