@xyo-network/module-abstract-mongodb 4.1.2 → 4.1.4

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 (4) hide show
  1. package/dist/node/Module.d.ts.map +1 -1
  2. package/dist/node/ModuleV2.d.ts.map +1 -1
  3. package/dist/node/index.d.ts +10 -148
  4. package/package.json +10 -10
package/dist/node/Module.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEhE,OAAO,EACU,mBAAmB,EAAE,yBAAyB,EAC9D,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAG9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAkB1D,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EACzD,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,EAEvE,YAAY,OAAO;sBAKC,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;oCAE9B,kBAAkB;;;+BAmBvB,kBAAkB;;IAe1C;;;OAGG;qBACoB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRA8CwxI,CAAC,6DAAwB,CAAC;4RAAyK,CAAC,6DAAwB,CAAC;;;;;;;;;;;;;;;YAlC5hJ,CAAA"}
1
+ {"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../../src/Module.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEhE,OAAO,EACU,mBAAmB,EAAE,yBAAyB,EAC9D,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,yBAAyB,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAG9F,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAkB1D,eAAO,MAAM,kBAAkB,GAC7B,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EACzD,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,EAEvE,YAAY,OAAO;sBAKC,YAAY,CAAC,yBAAyB,CAAC,GAAG,SAAS;iBACxD,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;oCAE9B,kBAAkB;;;+BAmBvB,kBAAkB;;IAe1C;;;OAGG;qBACoB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRAtDE,CAAC,6DACxC,CAAC;4RAKgE,CAAC,6DAEtD,CAAC;;;;;;;;;;;;;;;YA0Df,CAAA"}
package/dist/node/ModuleV2.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"ModuleV2.d.ts","sourceRoot":"","sources":["../../src/ModuleV2.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEhE,OAAO,EACL,qBAAqB,EAAwC,yBAAyB,EACvF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAGnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAkB1D,eAAO,MAAM,oBAAoB,GAC/B,OAAO,SAAS,qBAAqB,GAAG,qBAAqB,EAC7D,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,EAEvE,YAAY,OAAO;iBAKJ,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;+BAMnC,kBAAkB;;IAe1C;;;OAGG;wBACuB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRA0Im1D,CAAC,6DAAwB,CAAC;4RAAyK,CAAC,6DAAwB,CAAC;;;;;;;;;;;;;;;YAtH1lE,CAAA"}
1
+ {"version":3,"file":"ModuleV2.d.ts","sourceRoot":"","sources":["../../src/ModuleV2.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAEhE,OAAO,EACL,qBAAqB,EAAwC,yBAAyB,EACvF,MAAM,mCAAmC,CAAA;AAC1C,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAA;AAGnE,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAkB1D,eAAO,MAAM,oBAAoB,GAC/B,OAAO,SAAS,qBAAqB,GAAG,qBAAqB,EAC7D,OAAO,SAAS,iBAAiB,CAAC,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,EAEvE,YAAY,OAAO;iBAKJ,YAAY,CAAC,oBAAoB,CAAC,GAAG,SAAS;;+BAMnC,kBAAkB;;IAe1C;;;OAGG;wBACuB,OAAO,CAAC,IAAI,CAAC;;;;;;;;sRAtCF,CAAC,6DACvC,CAAC;4RAK0D,CAAC,6DAEtD,CAAC;;;;;;;;;;;;;;;YAkDT,CAAA"}
package/dist/node/index.d.ts CHANGED
@@ -1,148 +1,10 @@
1
- import { BaseMongoSdkPrivateConfig, BaseMongoSdk, BaseMongoSdkConfig } from '@xylabs/mongo';
2
- import { Document, IndexDescription as IndexDescription$1 } from 'mongodb';
3
- import * as _xylabs_events from '@xylabs/events';
4
- import * as _xyo_network_payload_model from '@xyo-network/payload-model';
5
- import * as _xyo_network_boundwitness_model from '@xyo-network/boundwitness-model';
6
- import * as _xylabs_promise from '@xylabs/promise';
7
- import * as _xyo_network_module_model from '@xyo-network/module-model';
8
- import { Module } from '@xyo-network/module-model';
9
- import * as _xylabs_hex from '@xylabs/hex';
10
- import * as _xyo_network_shared from '@xyo-network/shared';
11
- import { MongoDBModuleParams, MongoDBStorageClassLabels, MongoDBModuleParamsV2 } from '@xyo-network/module-model-mongodb';
12
- import { BoundWitnessWithMongoMeta, PayloadWithMongoMeta } from '@xyo-network/payload-mongodb';
13
-
14
- declare const COLLECTIONS: {
15
- AddressInfo: "address_info";
16
- ArchivistStats: "archivist_stats";
17
- BoundWitnesses: "bound_witnesses";
18
- Payloads: "payloads";
19
- Thumbnails: "thumbnails";
20
- Users: "users";
21
- };
22
-
23
- declare const getBaseMongoSdkPrivateConfig: () => BaseMongoSdkPrivateConfig;
24
- declare const getBaseMongoSdk: <T extends Document>(collection: string) => BaseMongoSdk<T>;
25
-
26
- type MongoDbConnectionStringEnvVar = 'MONGO_CONNECTION_STRING';
27
- type MongoDbEnvVars = 'MONGO_DATABASE' | 'MONGO_DOMAIN' | 'MONGO_PASSWORD' | 'MONGO_USERNAME';
28
- type MongoEnv = Record<MongoDbEnvVars | MongoDbConnectionStringEnvVar, string | undefined>;
29
- declare const getMongoDBConfig: () => MongoEnv;
30
-
31
- declare const hasMongoDBConfig: () => boolean;
32
-
33
- declare const DATABASES: {
34
- Archivist: "archivist";
35
- };
36
-
37
- declare const DefaultAggregateTimeoutMs = 10000;
38
- declare const DefaultLimit = 20;
39
- declare const DefaultMaxTimeMS = 2000;
40
- declare const DefaultOrder = "desc";
41
-
42
- /**
43
- * The index direction (1 for ascending, -1 for descending)
44
- */
45
- type IndexDirection = -1 | 1;
46
- /**
47
- * Description of index(es) to be created on a store
48
- */
49
- type IndexDescription = {
50
- /**
51
- * The key(s) to index
52
- */
53
- key: {
54
- [key: string]: IndexDirection;
55
- } | Map<string, IndexDirection>;
56
- /**
57
- * The name of the index
58
- */
59
- name?: string;
60
- /**
61
- * If true, the index must enforce uniqueness on the key
62
- */
63
- unique?: boolean;
64
- };
65
-
66
- type CollectionIndexFunction = (collectionName: string) => IndexDescription$1[];
67
-
68
- type AnyAbstractModule<TParams extends MongoDBModuleParams = MongoDBModuleParams> = abstract new (...args: any[]) => Module<TParams>;
69
-
70
- declare const MongoDBModuleMixin: <TParams extends MongoDBModuleParams = MongoDBModuleParams, TModule extends AnyAbstractModule<TParams> = AnyAbstractModule<TParams>>(ModuleBase: TModule) => ((abstract new (...args: any[]) => {
71
- _boundWitnessSdk: BaseMongoSdk<BoundWitnessWithMongoMeta> | undefined;
72
- _payloadSdk: BaseMongoSdk<PayloadWithMongoMeta> | undefined;
73
- readonly boundWitnessSdkConfig: BaseMongoSdkConfig;
74
- readonly boundWitnesses: BaseMongoSdk<BoundWitnessWithMongoMeta>;
75
- readonly jobQueue: _xyo_network_shared.JobQueue;
76
- readonly payloadSdkConfig: BaseMongoSdkConfig;
77
- readonly payloads: BaseMongoSdk<PayloadWithMongoMeta>;
78
- /**
79
- * Ensures any indexes specified within the config are created. This method should be idempotent
80
- * allowing for multiple calls without causing errors while ensuring the desired state.
81
- */
82
- ensureIndexes(): Promise<void>;
83
- address: _xylabs_hex.Address;
84
- config: TParams["config"];
85
- id: string;
86
- modName?: _xyo_network_module_model.ModuleName;
87
- params: TParams;
88
- previousHash: () => _xylabs_promise.Promisable<string | undefined>;
89
- queries: string[];
90
- query: <T extends _xyo_network_boundwitness_model.QueryBoundWitness = _xyo_network_boundwitness_model.QueryBoundWitness, TConf extends _xyo_network_module_model.ModuleConfig = _xyo_network_module_model.ModuleConfig>(query: T, payloads?: _xyo_network_payload_model.Payload[], queryConfig?: TConf) => _xylabs_promise.Promisable<_xyo_network_module_model.ModuleQueryResult>;
91
- queryable: <T extends _xyo_network_boundwitness_model.QueryBoundWitness = _xyo_network_boundwitness_model.QueryBoundWitness, TConf_1 extends _xyo_network_module_model.ModuleConfig = _xyo_network_module_model.ModuleConfig>(query: T, payloads?: _xyo_network_payload_model.Payload[], queryConfig?: TConf_1) => _xylabs_promise.Promisable<boolean>;
92
- start?: () => _xylabs_promise.Promisable<boolean>;
93
- stop?: () => _xylabs_promise.Promisable<boolean>;
94
- eventData: _xyo_network_module_model.ModuleEventData<object>;
95
- clearListeners(eventNames: keyof _xyo_network_module_model.ModuleEventData<object> | (keyof _xyo_network_module_model.ModuleEventData<object>)[]): void;
96
- emit<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventName: TEventName, eventArgs: _xyo_network_module_model.ModuleEventData<object>[TEventName]): Promise<void>;
97
- emitSerial<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventName: TEventName, eventArgs: _xyo_network_module_model.ModuleEventData<object>[TEventName]): Promise<void>;
98
- listenerCount(eventNames: keyof _xyo_network_module_model.ModuleEventData<object> | (keyof _xyo_network_module_model.ModuleEventData<object>)[]): number;
99
- off<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventNames: TEventName | TEventName[], listener: _xylabs_events.EventListener<_xyo_network_module_model.ModuleEventData<object>[TEventName]>): void;
100
- offAny(listener: _xylabs_events.EventAnyListener | Promise<void>): void;
101
- on<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventNames: TEventName | TEventName[], listener: _xylabs_events.EventListener<_xyo_network_module_model.ModuleEventData<object>[TEventName]>): _xylabs_events.EventUnsubscribeFunction;
102
- onAny(listener: _xylabs_events.EventAnyListener): _xylabs_events.EventUnsubscribeFunction;
103
- once<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventName: TEventName, listener: _xylabs_events.EventListener<_xyo_network_module_model.ModuleEventData<object>[TEventName]>): _xylabs_events.EventUnsubscribeFunction;
104
- }) & {
105
- readonly labels: MongoDBStorageClassLabels;
106
- }) & TModule;
107
-
108
- declare const MongoDBModuleMixinV2: <TParams extends MongoDBModuleParamsV2 = MongoDBModuleParamsV2, TModule extends AnyAbstractModule<TParams> = AnyAbstractModule<TParams>>(ModuleBase: TModule) => ((abstract new (...args: any[]) => {
109
- _payloadSdk: BaseMongoSdk<PayloadWithMongoMeta> | undefined;
110
- readonly jobQueue: _xyo_network_shared.JobQueue;
111
- readonly payloadSdkConfig: BaseMongoSdkConfig;
112
- readonly payloads: BaseMongoSdk<PayloadWithMongoMeta>;
113
- /**
114
- * Ensures any indexes specified within the config are created. This method should be idempotent
115
- * allowing for multiple calls without causing errors while ensuring the desired state.
116
- */
117
- ensureCollection(): Promise<void>;
118
- address: _xylabs_hex.Address;
119
- config: TParams["config"];
120
- id: string;
121
- modName?: _xyo_network_module_model.ModuleName;
122
- params: TParams;
123
- previousHash: () => _xylabs_promise.Promisable<string | undefined>;
124
- queries: string[];
125
- query: <T extends _xyo_network_boundwitness_model.QueryBoundWitness = _xyo_network_boundwitness_model.QueryBoundWitness, TConf extends _xyo_network_module_model.ModuleConfig = _xyo_network_module_model.ModuleConfig>(query: T, payloads?: _xyo_network_payload_model.Payload[], queryConfig?: TConf) => _xylabs_promise.Promisable<_xyo_network_module_model.ModuleQueryResult>;
126
- queryable: <T extends _xyo_network_boundwitness_model.QueryBoundWitness = _xyo_network_boundwitness_model.QueryBoundWitness, TConf_1 extends _xyo_network_module_model.ModuleConfig = _xyo_network_module_model.ModuleConfig>(query: T, payloads?: _xyo_network_payload_model.Payload[], queryConfig?: TConf_1) => _xylabs_promise.Promisable<boolean>;
127
- start?: () => _xylabs_promise.Promisable<boolean>;
128
- stop?: () => _xylabs_promise.Promisable<boolean>;
129
- eventData: _xyo_network_module_model.ModuleEventData<object>;
130
- clearListeners(eventNames: keyof _xyo_network_module_model.ModuleEventData<object> | (keyof _xyo_network_module_model.ModuleEventData<object>)[]): void;
131
- emit<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventName: TEventName, eventArgs: _xyo_network_module_model.ModuleEventData<object>[TEventName]): Promise<void>;
132
- emitSerial<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventName: TEventName, eventArgs: _xyo_network_module_model.ModuleEventData<object>[TEventName]): Promise<void>;
133
- listenerCount(eventNames: keyof _xyo_network_module_model.ModuleEventData<object> | (keyof _xyo_network_module_model.ModuleEventData<object>)[]): number;
134
- off<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventNames: TEventName | TEventName[], listener: _xylabs_events.EventListener<_xyo_network_module_model.ModuleEventData<object>[TEventName]>): void;
135
- offAny(listener: _xylabs_events.EventAnyListener | Promise<void>): void;
136
- on<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventNames: TEventName | TEventName[], listener: _xylabs_events.EventListener<_xyo_network_module_model.ModuleEventData<object>[TEventName]>): _xylabs_events.EventUnsubscribeFunction;
137
- onAny(listener: _xylabs_events.EventAnyListener): _xylabs_events.EventUnsubscribeFunction;
138
- once<TEventName extends keyof _xyo_network_module_model.ModuleEventData<object>>(eventName: TEventName, listener: _xylabs_events.EventListener<_xyo_network_module_model.ModuleEventData<object>[TEventName]>): _xylabs_events.EventUnsubscribeFunction;
139
- }) & {
140
- readonly labels: MongoDBStorageClassLabels;
141
- }) & TModule;
142
-
143
- declare const escapeChar = "#";
144
- declare const toDbProperty: (value: string) => string;
145
- declare const fromDbProperty: (value: string) => string;
146
-
147
- export { COLLECTIONS, DATABASES, DefaultAggregateTimeoutMs, DefaultLimit, DefaultMaxTimeMS, DefaultOrder, MongoDBModuleMixin, MongoDBModuleMixinV2, escapeChar, fromDbProperty, getBaseMongoSdk, getBaseMongoSdkPrivateConfig, getMongoDBConfig, hasMongoDBConfig, toDbProperty };
148
- export type { CollectionIndexFunction, IndexDescription, IndexDirection, MongoDbConnectionStringEnvVar, MongoDbEnvVars, MongoEnv };
1
+ export * from './Collections.ts';
2
+ export * from './config/index.ts';
3
+ export * from './Databases.ts';
4
+ export * from './Defaults.ts';
5
+ export * from './IndexDescription.ts';
6
+ export * from './Indexes/index.ts';
7
+ export * from './Module.ts';
8
+ export * from './ModuleV2.ts';
9
+ export * from './util/index.ts';
10
+ //# sourceMappingURL=index.d.ts.map
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xyo-network/module-abstract-mongodb",
3
- "version": "4.1.2",
3
+ "version": "4.1.4",
4
4
  "description": "Primary SDK for using XYO Protocol 2.0",
5
5
  "homepage": "https://xyo.network",
6
6
  "bugs": {
@@ -32,18 +32,18 @@
32
32
  "module": "dist/node/index.mjs",
33
33
  "types": "dist/node/index.d.ts",
34
34
  "dependencies": {
35
- "@xylabs/assert": "^4.13.15",
36
- "@xylabs/exists": "^4.13.15",
37
- "@xylabs/mongo": "^4.13.15",
38
- "@xylabs/static-implements": "^4.13.15",
39
- "@xyo-network/module-model-mongodb": "^4.1.2",
35
+ "@xylabs/assert": "^4.13.16",
36
+ "@xylabs/exists": "^4.13.16",
37
+ "@xylabs/mongo": "^4.13.16",
38
+ "@xylabs/static-implements": "^4.13.16",
39
+ "@xyo-network/module-model-mongodb": "^4.1.4",
40
40
  "mongodb": "~6.17.0"
41
41
  },
42
42
  "devDependencies": {
43
- "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.23",
44
- "@xylabs/tsconfig": "^7.0.0-rc.23",
45
- "@xyo-network/module-model": "^4.1.2",
46
- "@xyo-network/payload-mongodb": "^4.1.2",
43
+ "@xylabs/ts-scripts-yarn3": "^7.0.0-rc.27",
44
+ "@xylabs/tsconfig": "^7.0.0-rc.27",
45
+ "@xyo-network/module-model": "^4.1.4",
46
+ "@xyo-network/payload-mongodb": "^4.1.4",
47
47
  "tslib": "^2.8.1",
48
48
  "typescript": "^5.8.3"
49
49
  },