@xyo-network/module-abstract-mongodb 3.1.0 → 3.1.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 (13) hide show
  1. package/dist/browser/IndexDescription.d.ts +15 -0
  2. package/dist/browser/IndexDescription.d.ts.map +1 -1
  3. package/dist/browser/Module.d.ts +4 -0
  4. package/dist/browser/Module.d.ts.map +1 -1
  5. package/dist/neutral/IndexDescription.d.ts +15 -0
  6. package/dist/neutral/IndexDescription.d.ts.map +1 -1
  7. package/dist/neutral/Module.d.ts +4 -0
  8. package/dist/neutral/Module.d.ts.map +1 -1
  9. package/dist/node/IndexDescription.d.ts +15 -0
  10. package/dist/node/IndexDescription.d.ts.map +1 -1
  11. package/dist/node/Module.d.ts +4 -0
  12. package/dist/node/Module.d.ts.map +1 -1
  13. package/package.json +11 -11
package/dist/browser/IndexDescription.d.ts CHANGED
@@ -1,9 +1,24 @@
1
+ /**
2
+ * The index direction (1 for ascending, -1 for descending)
3
+ */
1
4
  export type IndexDirection = -1 | 1;
5
+ /**
6
+ * Description of index(es) to be created on a store
7
+ */
2
8
  export type IndexDescription = {
9
+ /**
10
+ * The key(s) to index
11
+ */
3
12
  key: {
4
13
  [key: string]: IndexDirection;
5
14
  } | Map<string, IndexDirection>;
15
+ /**
16
+ * The name of the index
17
+ */
6
18
  name?: string;
19
+ /**
20
+ * If true, the index must enforce uniqueness on the key
21
+ */
7
22
  unique?: boolean;
8
23
  };
9
24
  //# sourceMappingURL=IndexDescription.d.ts.map
package/dist/browser/IndexDescription.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAKnC,MAAM,MAAM,gBAAgB,GAAG;IAI7B,GAAG,EACC;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAC9B,GACC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAI/B,IAAI,CAAC,EAAE,MAAM,CAAA;IAIb,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
1
+ {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,EACC;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAC9B,GACC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
package/dist/browser/Module.d.ts CHANGED
@@ -31,6 +31,10 @@ export declare const MongoDBModuleMixin: <TParams extends MongoDBModuleParams =
31
31
  readonly jobQueue: import("@xyo-network/node-core-model").JobQueue;
32
32
  readonly payloadSdkConfig: BaseMongoSdkConfig;
33
33
  readonly payloads: BaseMongoSdk<PayloadWithMongoMeta>;
34
+ /**
35
+ * Ensures any indexes specified within the config are created. This method should be idempotent
36
+ * allowing for multiple calls without causing errors while ensuring the desired state.
37
+ */
34
38
  ensureIndexes(): Promise<void>;
35
39
  address: import("@xylabs/hex").Address;
36
40
  config: TParams["config"];
package/dist/browser/Module.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EACU,mBAAmB,EAAuB,yBAAyB,EACnF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC9F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAQhF,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAA;AAE3I,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;GACnC,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,2CAE9B,OAAO,8BAN6F,GAAG,EAAE;sBAWjG,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;;;;;qBAwCpC,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRApDkC,CAAC,6DAAyB,CAAA;4RAIrE,CAAC,6DAAwB,CAAC;;;;;;;;;;;;;;;YAuDxD,CAAA"}
1
+ {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EACU,mBAAmB,EAAuB,yBAAyB,EACnF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC9F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAQhF,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAA;AAE3I,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;GACnC,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,2CAE9B,OAAO,8BAN6F,GAAG,EAAE;sBAWjG,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;;;;;IAoC3D;;;OAGG;qBACoB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRApD8F,CAAC,6DAErH,CAAC;4RAIL,CAAA,6DAEN,CAAC;;;;;;;;;;;;;;;YAmDR,CAAA"}
package/dist/neutral/IndexDescription.d.ts CHANGED
@@ -1,9 +1,24 @@
1
+ /**
2
+ * The index direction (1 for ascending, -1 for descending)
3
+ */
1
4
  export type IndexDirection = -1 | 1;
5
+ /**
6
+ * Description of index(es) to be created on a store
7
+ */
2
8
  export type IndexDescription = {
9
+ /**
10
+ * The key(s) to index
11
+ */
3
12
  key: {
4
13
  [key: string]: IndexDirection;
5
14
  } | Map<string, IndexDirection>;
15
+ /**
16
+ * The name of the index
17
+ */
6
18
  name?: string;
19
+ /**
20
+ * If true, the index must enforce uniqueness on the key
21
+ */
7
22
  unique?: boolean;
8
23
  };
9
24
  //# sourceMappingURL=IndexDescription.d.ts.map
package/dist/neutral/IndexDescription.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAKnC,MAAM,MAAM,gBAAgB,GAAG;IAI7B,GAAG,EACC;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAC9B,GACC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAI/B,IAAI,CAAC,EAAE,MAAM,CAAA;IAIb,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
1
+ {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,EACC;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAC9B,GACC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
package/dist/neutral/Module.d.ts CHANGED
@@ -31,6 +31,10 @@ export declare const MongoDBModuleMixin: <TParams extends MongoDBModuleParams =
31
31
  readonly jobQueue: import("@xyo-network/node-core-model").JobQueue;
32
32
  readonly payloadSdkConfig: BaseMongoSdkConfig;
33
33
  readonly payloads: BaseMongoSdk<PayloadWithMongoMeta>;
34
+ /**
35
+ * Ensures any indexes specified within the config are created. This method should be idempotent
36
+ * allowing for multiple calls without causing errors while ensuring the desired state.
37
+ */
34
38
  ensureIndexes(): Promise<void>;
35
39
  address: import("@xylabs/hex").Address;
36
40
  config: TParams["config"];
package/dist/neutral/Module.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EACU,mBAAmB,EAAuB,yBAAyB,EACnF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC9F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAQhF,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAA;AAE3I,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;GACnC,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,2CAE9B,OAAO,8BAN6F,GAAG,EAAE;sBAWjG,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;;;;;qBAwCpC,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRApDkC,CAAC,6DAAyB,CAAA;4RAIrE,CAAC,6DAAwB,CAAC;;;;;;;;;;;;;;;YAuDxD,CAAA"}
1
+ {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EACU,mBAAmB,EAAuB,yBAAyB,EACnF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC9F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAQhF,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAA;AAE3I,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;GACnC,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,2CAE9B,OAAO,8BAN6F,GAAG,EAAE;sBAWjG,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;;;;;IAoC3D;;;OAGG;qBACoB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRApD8F,CAAC,6DAErH,CAAC;4RAIL,CAAA,6DAEN,CAAC;;;;;;;;;;;;;;;YAmDR,CAAA"}
package/dist/node/IndexDescription.d.ts CHANGED
@@ -1,9 +1,24 @@
1
+ /**
2
+ * The index direction (1 for ascending, -1 for descending)
3
+ */
1
4
  export type IndexDirection = -1 | 1;
5
+ /**
6
+ * Description of index(es) to be created on a store
7
+ */
2
8
  export type IndexDescription = {
9
+ /**
10
+ * The key(s) to index
11
+ */
3
12
  key: {
4
13
  [key: string]: IndexDirection;
5
14
  } | Map<string, IndexDirection>;
15
+ /**
16
+ * The name of the index
17
+ */
6
18
  name?: string;
19
+ /**
20
+ * If true, the index must enforce uniqueness on the key
21
+ */
7
22
  unique?: boolean;
8
23
  };
9
24
  //# sourceMappingURL=IndexDescription.d.ts.map
package/dist/node/IndexDescription.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAGA,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAKnC,MAAM,MAAM,gBAAgB,GAAG;IAI7B,GAAG,EACC;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAC9B,GACC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAI/B,IAAI,CAAC,EAAE,MAAM,CAAA;IAIb,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
1
+ {"version":3,"file":"IndexDescription.d.ts","sourceRoot":"","sources":["../../src/IndexDescription.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;AAEnC;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,GAAG,EACC;QACA,CAAC,GAAG,EAAE,MAAM,GAAG,cAAc,CAAA;KAC9B,GACC,GAAG,CAAC,MAAM,EAAE,cAAc,CAAC,CAAA;IAC/B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB,CAAA"}
package/dist/node/Module.d.ts CHANGED
@@ -31,6 +31,10 @@ export declare const MongoDBModuleMixin: <TParams extends MongoDBModuleParams =
31
31
  readonly jobQueue: import("@xyo-network/node-core-model").JobQueue;
32
32
  readonly payloadSdkConfig: BaseMongoSdkConfig;
33
33
  readonly payloads: BaseMongoSdk<PayloadWithMongoMeta>;
34
+ /**
35
+ * Ensures any indexes specified within the config are created. This method should be idempotent
36
+ * allowing for multiple calls without causing errors while ensuring the desired state.
37
+ */
34
38
  ensureIndexes(): Promise<void>;
35
39
  address: import("@xylabs/hex").Address;
36
40
  config: TParams["config"];
package/dist/node/Module.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EACU,mBAAmB,EAAuB,yBAAyB,EACnF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC9F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAQhF,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAA;AAE3I,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;GACnC,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,2CAE9B,OAAO,8BAN6F,GAAG,EAAE;sBAWjG,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;;;;;qBAwCpC,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRApDkC,CAAC,6DAAyB,CAAA;4RAIrE,CAAC,6DAAwB,CAAC;;;;;;;;;;;;;;;YAuDxD,CAAA"}
1
+ {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,EAAE,MAAM,2BAA2B,CAAA;AAClD,OAAO,EACU,mBAAmB,EAAuB,yBAAyB,EACnF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAC9F,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAQhF,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,IAAI,QAAQ,MAAM,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,CAAC,OAAO,CAAC,CAAA;AAE3I,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB;;;;;;;;;;;;;;;;;;;;GACnC,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,2CAE9B,OAAO,8BAN6F,GAAG,EAAE;sBAWjG,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;;;;;IAoC3D;;;OAGG;qBACoB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRApD8F,CAAC,6DAErH,CAAC;4RAIL,CAAA,6DAEN,CAAC;;;;;;;;;;;;;;;YAmDR,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/module-abstract-mongodb",
3
- "version": "3.1.0",
3
+ "version": "3.1.1",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -37,19 +37,19 @@
37
37
  "module": "dist/node/index.mjs",
38
38
  "types": "dist/node/index.d.ts",
39
39
  "dependencies": {
40
- "@xylabs/assert": "^4.1.0",
41
- "@xylabs/exists": "^4.1.0",
42
- "@xylabs/lodash": "^4.1.0",
43
- "@xylabs/static-implements": "^4.1.0",
44
- "@xyo-network/module-model": "^3.2.0",
45
- "@xyo-network/module-model-mongodb": "^3.1.0",
46
- "@xyo-network/payload-mongodb": "^3.1.0",
47
- "@xyo-network/sdk-xyo-mongo-js": "^3.1.0",
40
+ "@xylabs/assert": "^4.3.3",
41
+ "@xylabs/exists": "^4.3.3",
42
+ "@xylabs/lodash": "^4.3.3",
43
+ "@xylabs/static-implements": "^4.3.3",
44
+ "@xyo-network/module-model": "^3.3.2",
45
+ "@xyo-network/module-model-mongodb": "^3.1.1",
46
+ "@xyo-network/payload-mongodb": "^3.1.1",
47
+ "@xyo-network/sdk-xyo-mongo-js": "^3.1.1",
48
48
  "mongodb": "~6.8.2"
49
49
  },
50
50
  "devDependencies": {
51
- "@xylabs/ts-scripts-yarn3": "^4.1.0",
52
- "@xylabs/tsconfig": "^4.1.0",
51
+ "@xylabs/ts-scripts-yarn3": "^4.2.3",
52
+ "@xylabs/tsconfig": "^4.2.3",
53
53
  "fake-indexeddb": "^6.0.0",
54
54
  "typescript": "^5.6.3"
55
55
  },