@xyo-network/module-abstract-mongodb 2.74.2

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 (49) hide show
  1. package/LICENSE +165 -0
  2. package/README.md +13 -0
  3. package/dist/Collections.d.mts +9 -0
  4. package/dist/Collections.d.mts.map +1 -0
  5. package/dist/Collections.d.ts +9 -0
  6. package/dist/Collections.d.ts.map +1 -0
  7. package/dist/Databases.d.mts +4 -0
  8. package/dist/Databases.d.mts.map +1 -0
  9. package/dist/Databases.d.ts +4 -0
  10. package/dist/Databases.d.ts.map +1 -0
  11. package/dist/Defaults.d.mts +5 -0
  12. package/dist/Defaults.d.mts.map +1 -0
  13. package/dist/Defaults.d.ts +5 -0
  14. package/dist/Defaults.d.ts.map +1 -0
  15. package/dist/Module.d.mts +17 -0
  16. package/dist/Module.d.mts.map +1 -0
  17. package/dist/Module.d.ts +17 -0
  18. package/dist/Module.d.ts.map +1 -0
  19. package/dist/docs.json +20271 -0
  20. package/dist/index.d.mts +6 -0
  21. package/dist/index.d.mts.map +1 -0
  22. package/dist/index.d.ts +6 -0
  23. package/dist/index.d.ts.map +1 -0
  24. package/dist/index.js +131 -0
  25. package/dist/index.js.map +1 -0
  26. package/dist/index.mjs +96 -0
  27. package/dist/index.mjs.map +1 -0
  28. package/dist/util/dbProperty.d.mts +4 -0
  29. package/dist/util/dbProperty.d.mts.map +1 -0
  30. package/dist/util/dbProperty.d.ts +4 -0
  31. package/dist/util/dbProperty.d.ts.map +1 -0
  32. package/dist/util/index.d.mts +3 -0
  33. package/dist/util/index.d.mts.map +1 -0
  34. package/dist/util/index.d.ts +3 -0
  35. package/dist/util/index.d.ts.map +1 -0
  36. package/dist/util/removeId.d.mts +7 -0
  37. package/dist/util/removeId.d.mts.map +1 -0
  38. package/dist/util/removeId.d.ts +7 -0
  39. package/dist/util/removeId.d.ts.map +1 -0
  40. package/package.json +73 -0
  41. package/src/Collections.ts +9 -0
  42. package/src/Databases.ts +3 -0
  43. package/src/Defaults.ts +4 -0
  44. package/src/Module.ts +41 -0
  45. package/src/index.ts +5 -0
  46. package/src/util/dbProperty.ts +5 -0
  47. package/src/util/index.ts +2 -0
  48. package/src/util/removeId.ts +8 -0
  49. package/typedoc.json +5 -0
@@ -0,0 +1,6 @@
1
+ export * from './Collections';
2
+ export * from './Databases';
3
+ export * from './Defaults';
4
+ export * from './Module';
5
+ export * from './util';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,QAAQ,CAAA"}
@@ -0,0 +1,6 @@
1
+ export * from './Collections';
2
+ export * from './Databases';
3
+ export * from './Defaults';
4
+ export * from './Module';
5
+ export * from './util';
6
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,UAAU,CAAA;AACxB,cAAc,QAAQ,CAAA"}
package/dist/index.js ADDED
@@ -0,0 +1,131 @@
1
+ "use strict";
2
+ var __defProp = Object.defineProperty;
3
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
+ var __getOwnPropNames = Object.getOwnPropertyNames;
5
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
6
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
7
+ var __export = (target, all) => {
8
+ for (var name in all)
9
+ __defProp(target, name, { get: all[name], enumerable: true });
10
+ };
11
+ var __copyProps = (to, from, except, desc) => {
12
+ if (from && typeof from === "object" || typeof from === "function") {
13
+ for (let key of __getOwnPropNames(from))
14
+ if (!__hasOwnProp.call(to, key) && key !== except)
15
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
16
+ }
17
+ return to;
18
+ };
19
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
20
+
21
+ // src/index.ts
22
+ var src_exports = {};
23
+ __export(src_exports, {
24
+ COLLECTIONS: () => COLLECTIONS,
25
+ DATABASES: () => DATABASES,
26
+ DefaultAggregateTimeoutMs: () => DefaultAggregateTimeoutMs,
27
+ DefaultLimit: () => DefaultLimit,
28
+ DefaultMaxTimeMS: () => DefaultMaxTimeMS,
29
+ DefaultOrder: () => DefaultOrder,
30
+ MongoDBModule: () => MongoDBModule,
31
+ escapeChar: () => escapeChar,
32
+ fromDbProperty: () => fromDbProperty,
33
+ removeId: () => removeId,
34
+ toDbProperty: () => toDbProperty
35
+ });
36
+ module.exports = __toCommonJS(src_exports);
37
+
38
+ // src/Collections.ts
39
+ var COLLECTIONS = {
40
+ AddressInfo: "address_info",
41
+ ArchivistStats: "archivist_stats",
42
+ BoundWitnesses: "bound_witnesses",
43
+ Payloads: "payloads",
44
+ Thumbnails: "thumbnails",
45
+ Users: "users"
46
+ };
47
+
48
+ // src/Databases.ts
49
+ var DATABASES = {
50
+ Archivist: "archivist"
51
+ };
52
+
53
+ // src/Defaults.ts
54
+ var DefaultAggregateTimeoutMs = 1e4;
55
+ var DefaultLimit = 20;
56
+ var DefaultMaxTimeMS = 2e3;
57
+ var DefaultOrder = "desc";
58
+
59
+ // src/Module.ts
60
+ var import_assert = require("@xylabs/assert");
61
+ var import_lodash = require("@xylabs/lodash");
62
+ var import_static_implements = require("@xylabs/static-implements");
63
+ var import_module_abstract = require("@xyo-network/module-abstract");
64
+ var import_module_model_mongodb = require("@xyo-network/module-model-mongodb");
65
+ var import_sdk_xyo_mongo_js = require("@xyo-network/sdk-xyo-mongo-js");
66
+ function _ts_decorate(decorators, target, key, desc) {
67
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
68
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
69
+ r = Reflect.decorate(decorators, target, key, desc);
70
+ else
71
+ for (var i = decorators.length - 1; i >= 0; i--)
72
+ if (d = decorators[i])
73
+ r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
74
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
75
+ }
76
+ __name(_ts_decorate, "_ts_decorate");
77
+ var MongoDBModule = class MongoDBModule2 extends import_module_abstract.AbstractModuleInstance {
78
+ static {
79
+ __name(this, "MongoDBModule");
80
+ }
81
+ static labels = import_module_model_mongodb.MongoDBStorageClassLabels;
82
+ _boundWitnessSdk;
83
+ _payloadSdk;
84
+ get boundWitnessSdkConfig() {
85
+ return (0, import_lodash.merge)({}, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {
86
+ collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? "bound_witnesses"
87
+ });
88
+ }
89
+ get boundWitnesses() {
90
+ this._boundWitnessSdk = this._boundWitnessSdk ?? new import_sdk_xyo_mongo_js.BaseMongoSdk(this.boundWitnessSdkConfig);
91
+ return (0, import_assert.assertEx)(this._boundWitnessSdk);
92
+ }
93
+ get payloadSdkConfig() {
94
+ return (0, import_lodash.merge)({}, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {
95
+ collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? "payload"
96
+ });
97
+ }
98
+ get payloads() {
99
+ this._payloadSdk = this._payloadSdk ?? new import_sdk_xyo_mongo_js.BaseMongoSdk(this.payloadSdkConfig);
100
+ return (0, import_assert.assertEx)(this._payloadSdk);
101
+ }
102
+ };
103
+ MongoDBModule = _ts_decorate([
104
+ (0, import_static_implements.staticImplements)()
105
+ ], MongoDBModule);
106
+
107
+ // src/util/dbProperty.ts
108
+ var escapeChar = "#";
109
+ var toDbProperty = /* @__PURE__ */ __name((value) => value.replaceAll(".", escapeChar), "toDbProperty");
110
+ var fromDbProperty = /* @__PURE__ */ __name((value) => value.replaceAll(escapeChar, "."), "fromDbProperty");
111
+
112
+ // src/util/removeId.ts
113
+ var removeId = /* @__PURE__ */ __name((payload) => {
114
+ const { _id, ...withoutId } = payload;
115
+ return withoutId;
116
+ }, "removeId");
117
+ // Annotate the CommonJS export names for ESM import in node:
118
+ 0 && (module.exports = {
119
+ COLLECTIONS,
120
+ DATABASES,
121
+ DefaultAggregateTimeoutMs,
122
+ DefaultLimit,
123
+ DefaultMaxTimeMS,
124
+ DefaultOrder,
125
+ MongoDBModule,
126
+ escapeChar,
127
+ fromDbProperty,
128
+ removeId,
129
+ toDbProperty
130
+ });
131
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/index.ts","../src/Collections.ts","../src/Databases.ts","../src/Defaults.ts","../src/Module.ts","../src/util/dbProperty.ts","../src/util/removeId.ts"],"sourcesContent":["export * from './Collections'\nexport * from './Databases'\nexport * from './Defaults'\nexport * from './Module'\nexport * from './util'\n","// TODO: By DB\nexport const COLLECTIONS = {\n AddressInfo: 'address_info' as const,\n ArchivistStats: 'archivist_stats' as const,\n BoundWitnesses: 'bound_witnesses' as const,\n Payloads: 'payloads' as const,\n Thumbnails: 'thumbnails' as const,\n Users: 'users' as const,\n}\n","export const DATABASES = {\n Archivist: 'archivist' as const,\n}\n","export const DefaultAggregateTimeoutMs = 10_000\nexport const DefaultLimit = 20\nexport const DefaultMaxTimeMS = 2000\nexport const DefaultOrder = 'desc'\n","import { assertEx } from '@xylabs/assert'\nimport { merge } from '@xylabs/lodash'\nimport { staticImplements } from '@xylabs/static-implements'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport { ModuleEventData, WithLabels } from '@xyo-network/module-model'\nimport { MongoDBModuleParams, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb'\nimport { BoundWitnessWithMeta, PayloadWithMeta } from '@xyo-network/node-core-model'\nimport { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js'\n\n@staticImplements<WithLabels<MongoDBStorageClassLabels>>()\nexport abstract class MongoDBModule<\n TParams extends MongoDBModuleParams = MongoDBModuleParams,\n TEventData extends ModuleEventData<object> = ModuleEventData<object>,\n> extends AbstractModuleInstance<TParams, TEventData> {\n static labels = MongoDBStorageClassLabels\n\n private _boundWitnessSdk: BaseMongoSdk<BoundWitnessWithMeta> | undefined\n private _payloadSdk: BaseMongoSdk<PayloadWithMeta> | undefined\n\n get boundWitnessSdkConfig(): BaseMongoSdkConfig {\n return merge({}, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {\n collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? 'bound_witnesses',\n })\n }\n\n get boundWitnesses() {\n this._boundWitnessSdk = this._boundWitnessSdk ?? new BaseMongoSdk<BoundWitnessWithMeta>(this.boundWitnessSdkConfig)\n return assertEx(this._boundWitnessSdk)\n }\n\n get payloadSdkConfig(): BaseMongoSdkConfig {\n return merge({}, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {\n collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? 'payload',\n })\n }\n\n get payloads() {\n this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk<PayloadWithMeta>(this.payloadSdkConfig)\n return assertEx(this._payloadSdk)\n }\n}\n","export const escapeChar = '#'\n\nexport const toDbProperty = (value: string) => value.replaceAll('.', escapeChar)\n\nexport const fromDbProperty = (value: string) => value.replaceAll(escapeChar, '.')\n","import { Payload } from '@xyo-network/payload-model'\nimport { OptionalId, WithId, WithoutId } from 'mongodb'\n\nexport const removeId = <T extends Payload = Payload>(payload: T | WithId<T> | WithoutId<T> | OptionalId<T>): WithoutId<T> => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { _id, ...withoutId } = payload as OptionalId<T>\n return withoutId as WithoutId<T>\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;;ACCO,IAAMA,cAAc;EACzBC,aAAa;EACbC,gBAAgB;EAChBC,gBAAgB;EAChBC,UAAU;EACVC,YAAY;EACZC,OAAO;AACT;;;ACRO,IAAMC,YAAY;EACvBC,WAAW;AACb;;;ACFO,IAAMC,4BAA4B;AAClC,IAAMC,eAAe;AACrB,IAAMC,mBAAmB;AACzB,IAAMC,eAAe;;;ACH5B,oBAAyB;AACzB,oBAAsB;AACtB,+BAAiC;AACjC,6BAAuC;AAEvC,kCAA+D;AAE/D,8BAAiD;;;;;;;;;;;;AAGjD,IAAsBC,gBAAf,MAAAA,uBAGGC,8CAAAA;SAAAA;;;EACR,OAAOC,SAASC;EAERC;EACAC;EAER,IAAIC,wBAA4C;AAC9C,eAAOC,qBAAM,CAAC,GAAG,KAAKC,OAAOF,uBAAuB,KAAKG,OAAOH,uBAAuB;MACrFI,YAAY,KAAKD,OAAOH,uBAAuBI,cAAc,KAAKF,OAAOF,uBAAuBI,cAAc;IAChH,CAAA;EACF;EAEA,IAAIC,iBAAiB;AACnB,SAAKP,mBAAmB,KAAKA,oBAAoB,IAAIQ,qCAAmC,KAAKN,qBAAqB;AAClH,eAAOO,wBAAS,KAAKT,gBAAgB;EACvC;EAEA,IAAIU,mBAAuC;AACzC,eAAOP,qBAAM,CAAC,GAAG,KAAKC,OAAOM,kBAAkB,KAAKL,OAAOK,kBAAkB;MAC3EJ,YAAY,KAAKD,OAAOK,kBAAkBJ,cAAc,KAAKF,OAAOM,kBAAkBJ,cAAc;IACtG,CAAA;EACF;EAEA,IAAIK,WAAW;AACb,SAAKV,cAAc,KAAKA,eAAe,IAAIO,qCAA8B,KAAKE,gBAAgB;AAC9F,eAAOD,wBAAS,KAAKR,WAAW;EAClC;AACF;AA9BsBL,gBAAAA,aAAAA;MADrBgB,2CAAAA;GACqBhB,aAAAA;;;ACVf,IAAMiB,aAAa;AAEnB,IAAMC,eAAe,wBAACC,UAAkBA,MAAMC,WAAW,KAAKH,UAAAA,GAAzC;AAErB,IAAMI,iBAAiB,wBAACF,UAAkBA,MAAMC,WAAWH,YAAY,GAAA,GAAhD;;;ACDvB,IAAMK,WAAW,wBAA8BC,YAAAA;AAEpD,QAAM,EAAEC,KAAK,GAAGC,UAAAA,IAAcF;AAC9B,SAAOE;AACT,GAJwB;","names":["COLLECTIONS","AddressInfo","ArchivistStats","BoundWitnesses","Payloads","Thumbnails","Users","DATABASES","Archivist","DefaultAggregateTimeoutMs","DefaultLimit","DefaultMaxTimeMS","DefaultOrder","MongoDBModule","AbstractModuleInstance","labels","MongoDBStorageClassLabels","_boundWitnessSdk","_payloadSdk","boundWitnessSdkConfig","merge","params","config","collection","boundWitnesses","BaseMongoSdk","assertEx","payloadSdkConfig","payloads","staticImplements","escapeChar","toDbProperty","value","replaceAll","fromDbProperty","removeId","payload","_id","withoutId"]}
package/dist/index.mjs ADDED
@@ -0,0 +1,96 @@
1
+ var __defProp = Object.defineProperty;
2
+ var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
3
+
4
+ // src/Collections.ts
5
+ var COLLECTIONS = {
6
+ AddressInfo: "address_info",
7
+ ArchivistStats: "archivist_stats",
8
+ BoundWitnesses: "bound_witnesses",
9
+ Payloads: "payloads",
10
+ Thumbnails: "thumbnails",
11
+ Users: "users"
12
+ };
13
+
14
+ // src/Databases.ts
15
+ var DATABASES = {
16
+ Archivist: "archivist"
17
+ };
18
+
19
+ // src/Defaults.ts
20
+ var DefaultAggregateTimeoutMs = 1e4;
21
+ var DefaultLimit = 20;
22
+ var DefaultMaxTimeMS = 2e3;
23
+ var DefaultOrder = "desc";
24
+
25
+ // src/Module.ts
26
+ import { assertEx } from "@xylabs/assert";
27
+ import { merge } from "@xylabs/lodash";
28
+ import { staticImplements } from "@xylabs/static-implements";
29
+ import { AbstractModuleInstance } from "@xyo-network/module-abstract";
30
+ import { MongoDBStorageClassLabels } from "@xyo-network/module-model-mongodb";
31
+ import { BaseMongoSdk } from "@xyo-network/sdk-xyo-mongo-js";
32
+ function _ts_decorate(decorators, target, key, desc) {
33
+ var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
34
+ if (typeof Reflect === "object" && typeof Reflect.decorate === "function")
35
+ r = Reflect.decorate(decorators, target, key, desc);
36
+ else
37
+ for (var i = decorators.length - 1; i >= 0; i--)
38
+ if (d = decorators[i])
39
+ r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
40
+ return c > 3 && r && Object.defineProperty(target, key, r), r;
41
+ }
42
+ __name(_ts_decorate, "_ts_decorate");
43
+ var MongoDBModule = class MongoDBModule2 extends AbstractModuleInstance {
44
+ static {
45
+ __name(this, "MongoDBModule");
46
+ }
47
+ static labels = MongoDBStorageClassLabels;
48
+ _boundWitnessSdk;
49
+ _payloadSdk;
50
+ get boundWitnessSdkConfig() {
51
+ return merge({}, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {
52
+ collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? "bound_witnesses"
53
+ });
54
+ }
55
+ get boundWitnesses() {
56
+ this._boundWitnessSdk = this._boundWitnessSdk ?? new BaseMongoSdk(this.boundWitnessSdkConfig);
57
+ return assertEx(this._boundWitnessSdk);
58
+ }
59
+ get payloadSdkConfig() {
60
+ return merge({}, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {
61
+ collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? "payload"
62
+ });
63
+ }
64
+ get payloads() {
65
+ this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk(this.payloadSdkConfig);
66
+ return assertEx(this._payloadSdk);
67
+ }
68
+ };
69
+ MongoDBModule = _ts_decorate([
70
+ staticImplements()
71
+ ], MongoDBModule);
72
+
73
+ // src/util/dbProperty.ts
74
+ var escapeChar = "#";
75
+ var toDbProperty = /* @__PURE__ */ __name((value) => value.replaceAll(".", escapeChar), "toDbProperty");
76
+ var fromDbProperty = /* @__PURE__ */ __name((value) => value.replaceAll(escapeChar, "."), "fromDbProperty");
77
+
78
+ // src/util/removeId.ts
79
+ var removeId = /* @__PURE__ */ __name((payload) => {
80
+ const { _id, ...withoutId } = payload;
81
+ return withoutId;
82
+ }, "removeId");
83
+ export {
84
+ COLLECTIONS,
85
+ DATABASES,
86
+ DefaultAggregateTimeoutMs,
87
+ DefaultLimit,
88
+ DefaultMaxTimeMS,
89
+ DefaultOrder,
90
+ MongoDBModule,
91
+ escapeChar,
92
+ fromDbProperty,
93
+ removeId,
94
+ toDbProperty
95
+ };
96
+ //# sourceMappingURL=index.mjs.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/Collections.ts","../src/Databases.ts","../src/Defaults.ts","../src/Module.ts","../src/util/dbProperty.ts","../src/util/removeId.ts"],"sourcesContent":["// TODO: By DB\nexport const COLLECTIONS = {\n AddressInfo: 'address_info' as const,\n ArchivistStats: 'archivist_stats' as const,\n BoundWitnesses: 'bound_witnesses' as const,\n Payloads: 'payloads' as const,\n Thumbnails: 'thumbnails' as const,\n Users: 'users' as const,\n}\n","export const DATABASES = {\n Archivist: 'archivist' as const,\n}\n","export const DefaultAggregateTimeoutMs = 10_000\nexport const DefaultLimit = 20\nexport const DefaultMaxTimeMS = 2000\nexport const DefaultOrder = 'desc'\n","import { assertEx } from '@xylabs/assert'\nimport { merge } from '@xylabs/lodash'\nimport { staticImplements } from '@xylabs/static-implements'\nimport { AbstractModuleInstance } from '@xyo-network/module-abstract'\nimport { ModuleEventData, WithLabels } from '@xyo-network/module-model'\nimport { MongoDBModuleParams, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb'\nimport { BoundWitnessWithMeta, PayloadWithMeta } from '@xyo-network/node-core-model'\nimport { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js'\n\n@staticImplements<WithLabels<MongoDBStorageClassLabels>>()\nexport abstract class MongoDBModule<\n TParams extends MongoDBModuleParams = MongoDBModuleParams,\n TEventData extends ModuleEventData<object> = ModuleEventData<object>,\n> extends AbstractModuleInstance<TParams, TEventData> {\n static labels = MongoDBStorageClassLabels\n\n private _boundWitnessSdk: BaseMongoSdk<BoundWitnessWithMeta> | undefined\n private _payloadSdk: BaseMongoSdk<PayloadWithMeta> | undefined\n\n get boundWitnessSdkConfig(): BaseMongoSdkConfig {\n return merge({}, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {\n collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? 'bound_witnesses',\n })\n }\n\n get boundWitnesses() {\n this._boundWitnessSdk = this._boundWitnessSdk ?? new BaseMongoSdk<BoundWitnessWithMeta>(this.boundWitnessSdkConfig)\n return assertEx(this._boundWitnessSdk)\n }\n\n get payloadSdkConfig(): BaseMongoSdkConfig {\n return merge({}, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {\n collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? 'payload',\n })\n }\n\n get payloads() {\n this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk<PayloadWithMeta>(this.payloadSdkConfig)\n return assertEx(this._payloadSdk)\n }\n}\n","export const escapeChar = '#'\n\nexport const toDbProperty = (value: string) => value.replaceAll('.', escapeChar)\n\nexport const fromDbProperty = (value: string) => value.replaceAll(escapeChar, '.')\n","import { Payload } from '@xyo-network/payload-model'\nimport { OptionalId, WithId, WithoutId } from 'mongodb'\n\nexport const removeId = <T extends Payload = Payload>(payload: T | WithId<T> | WithoutId<T> | OptionalId<T>): WithoutId<T> => {\n // eslint-disable-next-line @typescript-eslint/no-unused-vars\n const { _id, ...withoutId } = payload as OptionalId<T>\n return withoutId as WithoutId<T>\n}\n"],"mappings":";;;;AACO,IAAMA,cAAc;EACzBC,aAAa;EACbC,gBAAgB;EAChBC,gBAAgB;EAChBC,UAAU;EACVC,YAAY;EACZC,OAAO;AACT;;;ACRO,IAAMC,YAAY;EACvBC,WAAW;AACb;;;ACFO,IAAMC,4BAA4B;AAClC,IAAMC,eAAe;AACrB,IAAMC,mBAAmB;AACzB,IAAMC,eAAe;;;ACH5B,SAASC,gBAAgB;AACzB,SAASC,aAAa;AACtB,SAASC,wBAAwB;AACjC,SAASC,8BAA8B;AAEvC,SAA8BC,iCAAiC;AAE/D,SAASC,oBAAwC;;;;;;;;;;;;AAGjD,IAAsBC,gBAAf,MAAAA,uBAGGC,uBAAAA;SAAAA;;;EACR,OAAOC,SAASC;EAERC;EACAC;EAER,IAAIC,wBAA4C;AAC9C,WAAOC,MAAM,CAAC,GAAG,KAAKC,OAAOF,uBAAuB,KAAKG,OAAOH,uBAAuB;MACrFI,YAAY,KAAKD,OAAOH,uBAAuBI,cAAc,KAAKF,OAAOF,uBAAuBI,cAAc;IAChH,CAAA;EACF;EAEA,IAAIC,iBAAiB;AACnB,SAAKP,mBAAmB,KAAKA,oBAAoB,IAAIQ,aAAmC,KAAKN,qBAAqB;AAClH,WAAOO,SAAS,KAAKT,gBAAgB;EACvC;EAEA,IAAIU,mBAAuC;AACzC,WAAOP,MAAM,CAAC,GAAG,KAAKC,OAAOM,kBAAkB,KAAKL,OAAOK,kBAAkB;MAC3EJ,YAAY,KAAKD,OAAOK,kBAAkBJ,cAAc,KAAKF,OAAOM,kBAAkBJ,cAAc;IACtG,CAAA;EACF;EAEA,IAAIK,WAAW;AACb,SAAKV,cAAc,KAAKA,eAAe,IAAIO,aAA8B,KAAKE,gBAAgB;AAC9F,WAAOD,SAAS,KAAKR,WAAW;EAClC;AACF;AA9BsBL,gBAAAA,aAAAA;EADrBgB,iBAAAA;GACqBhB,aAAAA;;;ACVf,IAAMiB,aAAa;AAEnB,IAAMC,eAAe,wBAACC,UAAkBA,MAAMC,WAAW,KAAKH,UAAAA,GAAzC;AAErB,IAAMI,iBAAiB,wBAACF,UAAkBA,MAAMC,WAAWH,YAAY,GAAA,GAAhD;;;ACDvB,IAAMK,WAAW,wBAA8BC,YAAAA;AAEpD,QAAM,EAAEC,KAAK,GAAGC,UAAAA,IAAcF;AAC9B,SAAOE;AACT,GAJwB;","names":["COLLECTIONS","AddressInfo","ArchivistStats","BoundWitnesses","Payloads","Thumbnails","Users","DATABASES","Archivist","DefaultAggregateTimeoutMs","DefaultLimit","DefaultMaxTimeMS","DefaultOrder","assertEx","merge","staticImplements","AbstractModuleInstance","MongoDBStorageClassLabels","BaseMongoSdk","MongoDBModule","AbstractModuleInstance","labels","MongoDBStorageClassLabels","_boundWitnessSdk","_payloadSdk","boundWitnessSdkConfig","merge","params","config","collection","boundWitnesses","BaseMongoSdk","assertEx","payloadSdkConfig","payloads","staticImplements","escapeChar","toDbProperty","value","replaceAll","fromDbProperty","removeId","payload","_id","withoutId"]}
@@ -0,0 +1,4 @@
1
+ export declare const escapeChar = "#";
2
+ export declare const toDbProperty: (value: string) => string;
3
+ export declare const fromDbProperty: (value: string) => string;
4
+ //# sourceMappingURL=dbProperty.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dbProperty.d.ts","sourceRoot":"","sources":["../../src/util/dbProperty.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,MAAM,CAAA;AAE7B,eAAO,MAAM,YAAY,UAAW,MAAM,WAAsC,CAAA;AAEhF,eAAO,MAAM,cAAc,UAAW,MAAM,WAAsC,CAAA"}
@@ -0,0 +1,4 @@
1
+ export declare const escapeChar = "#";
2
+ export declare const toDbProperty: (value: string) => string;
3
+ export declare const fromDbProperty: (value: string) => string;
4
+ //# sourceMappingURL=dbProperty.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"dbProperty.d.ts","sourceRoot":"","sources":["../../src/util/dbProperty.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,UAAU,MAAM,CAAA;AAE7B,eAAO,MAAM,YAAY,UAAW,MAAM,WAAsC,CAAA;AAEhF,eAAO,MAAM,cAAc,UAAW,MAAM,WAAsC,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './dbProperty';
2
+ export * from './removeId';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA"}
@@ -0,0 +1,3 @@
1
+ export * from './dbProperty';
2
+ export * from './removeId';
3
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,YAAY,CAAA"}
@@ -0,0 +1,7 @@
1
+ import { OptionalId, WithId, WithoutId } from 'mongodb';
2
+ export declare const removeId: <T extends {
3
+ schema: string;
4
+ } = {
5
+ schema: string;
6
+ }>(payload: T | WithId<T> | WithoutId<T> | OptionalId<T>) => WithoutId<T>;
7
+ //# sourceMappingURL=removeId.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"removeId.d.ts","sourceRoot":"","sources":["../../src/util/removeId.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAEvD,eAAO,MAAM,QAAQ;;;;yEAIpB,CAAA"}
@@ -0,0 +1,7 @@
1
+ import { OptionalId, WithId, WithoutId } from 'mongodb';
2
+ export declare const removeId: <T extends {
3
+ schema: string;
4
+ } = {
5
+ schema: string;
6
+ }>(payload: T | WithId<T> | WithoutId<T> | OptionalId<T>) => WithoutId<T>;
7
+ //# sourceMappingURL=removeId.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"removeId.d.ts","sourceRoot":"","sources":["../../src/util/removeId.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,SAAS,CAAA;AAEvD,eAAO,MAAM,QAAQ;;;;yEAIpB,CAAA"}
package/package.json ADDED
@@ -0,0 +1,73 @@
1
+ {
2
+ "name": "@xyo-network/module-abstract-mongodb",
3
+ "author": {
4
+ "email": "support@xyo.network",
5
+ "name": "XYO Development Team",
6
+ "url": "https://xyo.network"
7
+ },
8
+ "bugs": {
9
+ "email": "support@xyo.network",
10
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js/issues"
11
+ },
12
+ "dependencies": {
13
+ "@xylabs/assert": "^2.11.7",
14
+ "@xylabs/lodash": "^2.11.7",
15
+ "@xylabs/static-implements": "^2.11.7",
16
+ "@xyo-network/module-abstract": "~2.74.2",
17
+ "@xyo-network/module-model": "~2.74.2",
18
+ "@xyo-network/module-model-mongodb": "~2.74.2",
19
+ "@xyo-network/node-core-model": "~2.74.2",
20
+ "@xyo-network/payload-model": "~2.74.2",
21
+ "mongodb": "^5.9.0"
22
+ },
23
+ "peerDependencies": {
24
+ "@xyo-network/sdk-xyo-mongo-js": "~2.74.2"
25
+ },
26
+ "peerDependenciesMeta": {
27
+ "@xyo-network/sdk-xyo-mongo-js": {
28
+ "optional": true
29
+ }
30
+ },
31
+ "devDependencies": {
32
+ "@xylabs/ts-scripts-yarn3": "^3.0.28",
33
+ "@xylabs/tsconfig": "^3.0.28",
34
+ "@xyo-network/sdk-xyo-mongo-js": "~2.74.2",
35
+ "fake-indexeddb": "^4.0.2",
36
+ "typescript": "^5.2.2"
37
+ },
38
+ "description": "Primary SDK for using XYO Protocol 2.0",
39
+ "docs": "dist/docs.json",
40
+ "types": "dist/index.d.ts",
41
+ "exports": {
42
+ ".": {
43
+ "require": {
44
+ "types": "./dist/index.d.ts",
45
+ "default": "./dist/index.js"
46
+ },
47
+ "import": {
48
+ "types": "./dist/index.d.mts",
49
+ "default": "./dist/index.mjs"
50
+ }
51
+ },
52
+ "./dist/docs.json": {
53
+ "default": "./dist/docs.json"
54
+ },
55
+ "./docs": {
56
+ "default": "./dist/docs.json"
57
+ },
58
+ "./package.json": "./package.json"
59
+ },
60
+ "main": "dist/index.js",
61
+ "module": "dist/index.mjs",
62
+ "homepage": "https://xyo.network",
63
+ "license": "LGPL-3.0",
64
+ "publishConfig": {
65
+ "access": "public"
66
+ },
67
+ "repository": {
68
+ "type": "git",
69
+ "url": "https://github.com/XYOracleNetwork/sdk-xyo-client-js.git"
70
+ },
71
+ "sideEffects": false,
72
+ "version": "2.74.2"
73
+ }
@@ -0,0 +1,9 @@
1
+ // TODO: By DB
2
+ export const COLLECTIONS = {
3
+ AddressInfo: 'address_info' as const,
4
+ ArchivistStats: 'archivist_stats' as const,
5
+ BoundWitnesses: 'bound_witnesses' as const,
6
+ Payloads: 'payloads' as const,
7
+ Thumbnails: 'thumbnails' as const,
8
+ Users: 'users' as const,
9
+ }
@@ -0,0 +1,3 @@
1
+ export const DATABASES = {
2
+ Archivist: 'archivist' as const,
3
+ }
@@ -0,0 +1,4 @@
1
+ export const DefaultAggregateTimeoutMs = 10_000
2
+ export const DefaultLimit = 20
3
+ export const DefaultMaxTimeMS = 2000
4
+ export const DefaultOrder = 'desc'
package/src/Module.ts ADDED
@@ -0,0 +1,41 @@
1
+ import { assertEx } from '@xylabs/assert'
2
+ import { merge } from '@xylabs/lodash'
3
+ import { staticImplements } from '@xylabs/static-implements'
4
+ import { AbstractModuleInstance } from '@xyo-network/module-abstract'
5
+ import { ModuleEventData, WithLabels } from '@xyo-network/module-model'
6
+ import { MongoDBModuleParams, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb'
7
+ import { BoundWitnessWithMeta, PayloadWithMeta } from '@xyo-network/node-core-model'
8
+ import { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js'
9
+
10
+ @staticImplements<WithLabels<MongoDBStorageClassLabels>>()
11
+ export abstract class MongoDBModule<
12
+ TParams extends MongoDBModuleParams = MongoDBModuleParams,
13
+ TEventData extends ModuleEventData<object> = ModuleEventData<object>,
14
+ > extends AbstractModuleInstance<TParams, TEventData> {
15
+ static labels = MongoDBStorageClassLabels
16
+
17
+ private _boundWitnessSdk: BaseMongoSdk<BoundWitnessWithMeta> | undefined
18
+ private _payloadSdk: BaseMongoSdk<PayloadWithMeta> | undefined
19
+
20
+ get boundWitnessSdkConfig(): BaseMongoSdkConfig {
21
+ return merge({}, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {
22
+ collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? 'bound_witnesses',
23
+ })
24
+ }
25
+
26
+ get boundWitnesses() {
27
+ this._boundWitnessSdk = this._boundWitnessSdk ?? new BaseMongoSdk<BoundWitnessWithMeta>(this.boundWitnessSdkConfig)
28
+ return assertEx(this._boundWitnessSdk)
29
+ }
30
+
31
+ get payloadSdkConfig(): BaseMongoSdkConfig {
32
+ return merge({}, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {
33
+ collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? 'payload',
34
+ })
35
+ }
36
+
37
+ get payloads() {
38
+ this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk<PayloadWithMeta>(this.payloadSdkConfig)
39
+ return assertEx(this._payloadSdk)
40
+ }
41
+ }
package/src/index.ts ADDED
@@ -0,0 +1,5 @@
1
+ export * from './Collections'
2
+ export * from './Databases'
3
+ export * from './Defaults'
4
+ export * from './Module'
5
+ export * from './util'
@@ -0,0 +1,5 @@
1
+ export const escapeChar = '#'
2
+
3
+ export const toDbProperty = (value: string) => value.replaceAll('.', escapeChar)
4
+
5
+ export const fromDbProperty = (value: string) => value.replaceAll(escapeChar, '.')
@@ -0,0 +1,2 @@
1
+ export * from './dbProperty'
2
+ export * from './removeId'
@@ -0,0 +1,8 @@
1
+ import { Payload } from '@xyo-network/payload-model'
2
+ import { OptionalId, WithId, WithoutId } from 'mongodb'
3
+
4
+ export const removeId = <T extends Payload = Payload>(payload: T | WithId<T> | WithoutId<T> | OptionalId<T>): WithoutId<T> => {
5
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
6
+ const { _id, ...withoutId } = payload as OptionalId<T>
7
+ return withoutId as WithoutId<T>
8
+ }
package/typedoc.json ADDED
@@ -0,0 +1,5 @@
1
+ {
2
+ "$schema": "https://typedoc.org/schema.json",
3
+ "entryPoints": ["src/index.ts"],
4
+ "tsconfig": "./tsconfig.typedoc.json"
5
+ }