@xyo-network/module-abstract-mongodb 2.74.4 → 2.75.0

package/src/Module.ts

@@ -1,41 +1,56 @@
 import { assertEx } from '@xylabs/assert'
 import { merge } from '@xylabs/lodash'
 import { staticImplements } from '@xylabs/static-implements'
-import { AbstractModuleInstance } from '@xyo-network/module-abstract'
-import { ModuleEventData, WithLabels } from '@xyo-network/module-model'
-import { MongoDBModuleParams, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb'
+import { Module } from '@xyo-network/module-model'
+import { MongoDBModule, MongoDBModuleParams, MongoDBModuleStatic, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb'
 import { BoundWitnessWithMeta, PayloadWithMeta } from '@xyo-network/node-core-model'
 import { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js'
 
-@staticImplements<WithLabels<MongoDBStorageClassLabels>>()
-export abstract class MongoDBModule<
+import { COLLECTIONS } from './Collections'
+import { getBaseMongoSdkPrivateConfig } from './config'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type AnyAbstractModule<TParams extends MongoDBModuleParams = MongoDBModuleParams> = abstract new (...args: any[]) => Module<TParams>
+
+export const MongoDBModuleMixin = <
   TParams extends MongoDBModuleParams = MongoDBModuleParams,
-  TEventData extends ModuleEventData<object> = ModuleEventData<object>,
-> extends AbstractModuleInstance<TParams, TEventData> {
-  static labels = MongoDBStorageClassLabels
+  TModule extends AnyAbstractModule<TParams> = AnyAbstractModule<TParams>,
+>(
+  ModuleBase: TModule,
+) => {
+  @staticImplements<MongoDBModuleStatic>()
+  abstract class MongoModuleBase extends ModuleBase implements MongoDBModule {
+    static labels = MongoDBStorageClassLabels
+    _boundWitnessSdk: BaseMongoSdk<BoundWitnessWithMeta> | undefined
+    _payloadSdk: BaseMongoSdk<PayloadWithMeta> | undefined
 
-  private _boundWitnessSdk: BaseMongoSdk<BoundWitnessWithMeta> | undefined
-  private _payloadSdk: BaseMongoSdk<PayloadWithMeta> | undefined
+    get boundWitnessSdkConfig(): BaseMongoSdkConfig {
+      const config = { collection: COLLECTIONS.BoundWitnesses, ...getBaseMongoSdkPrivateConfig() }
+      return merge(config, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {
+        collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? COLLECTIONS.BoundWitnesses,
+      })
+    }
 
-  get boundWitnessSdkConfig(): BaseMongoSdkConfig {
-    return merge({}, this.params.boundWitnessSdkConfig, this.config.boundWitnessSdkConfig, {
-      collection: this.config.boundWitnessSdkConfig?.collection ?? this.params.boundWitnessSdkConfig?.collection ?? 'bound_witnesses',
-    })
-  }
+    get boundWitnesses() {
+      this._boundWitnessSdk = this._boundWitnessSdk ?? new BaseMongoSdk<BoundWitnessWithMeta>(this.boundWitnessSdkConfig)
+      return assertEx(this._boundWitnessSdk)
+    }
 
-  get boundWitnesses() {
-    this._boundWitnessSdk = this._boundWitnessSdk ?? new BaseMongoSdk<BoundWitnessWithMeta>(this.boundWitnessSdkConfig)
-    return assertEx(this._boundWitnessSdk)
-  }
+    get jobQueue() {
+      return assertEx(this.params.jobQueue, 'MongoDBModule Error: jobQueue required for this module but is not defined')
+    }
 
-  get payloadSdkConfig(): BaseMongoSdkConfig {
-    return merge({}, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {
-      collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? 'payload',
-    })
-  }
+    get payloadSdkConfig(): BaseMongoSdkConfig {
+      const config = { collection: COLLECTIONS.Payloads, ...getBaseMongoSdkPrivateConfig() }
+      return merge(config, this.params.payloadSdkConfig, this.config.payloadSdkConfig, {
+        collection: this.config.payloadSdkConfig?.collection ?? this.params.payloadSdkConfig?.collection ?? COLLECTIONS.Payloads,
+      })
+    }
 
-  get payloads() {
-    this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk<PayloadWithMeta>(this.payloadSdkConfig)
-    return assertEx(this._payloadSdk)
+    get payloads() {
+      this._payloadSdk = this._payloadSdk ?? new BaseMongoSdk<PayloadWithMeta>(this.payloadSdkConfig)
+      return assertEx(this._payloadSdk)
+    }
   }
+  return MongoModuleBase
 }

package/src/config/getBaseMongoSdk.ts

@@ -0,0 +1,20 @@
+import { assertEx } from '@xylabs/assert'
+import { BaseMongoSdk, BaseMongoSdkPrivateConfig } from '@xyo-network/sdk-xyo-mongo-js'
+import { Document } from 'mongodb'
+
+import { getMongoDBConfig } from './getMongoDBConfig'
+
+export const getBaseMongoSdkPrivateConfig = (): BaseMongoSdkPrivateConfig => {
+  const env = getMongoDBConfig()
+  return {
+    dbConnectionString: env.MONGO_CONNECTION_STRING,
+    dbDomain: assertEx(env.MONGO_DOMAIN, 'Missing Mongo Domain'),
+    dbName: assertEx(env.MONGO_DATABASE, 'Missing Mongo Database'),
+    dbPassword: assertEx(env.MONGO_PASSWORD, 'Missing Mongo Password'),
+    dbUserName: assertEx(env.MONGO_USERNAME, 'Missing Mongo Username'),
+  }
+}
+
+export const getBaseMongoSdk = <T extends Document>(collection: string) => {
+  return new BaseMongoSdk<T>({ ...getBaseMongoSdkPrivateConfig(), collection })
+}

package/src/config/getMongoDBConfig.ts

@@ -0,0 +1,18 @@
+export type MongoDbConnectionStringEnvVar = 'MONGO_CONNECTION_STRING'
+export type MongoDbEnvVars = 'MONGO_DATABASE' | 'MONGO_DOMAIN' | 'MONGO_PASSWORD' | 'MONGO_USERNAME'
+
+export type MongoEnv = Record<MongoDbEnvVars | MongoDbConnectionStringEnvVar, string | undefined>
+
+export const getMongoDBConfig = (): MongoEnv => {
+  const env: MongoEnv = {} as MongoEnv
+  if (process.env.MONGO_CONNECTION_STRING) {
+    env.MONGO_CONNECTION_STRING = process.env.MONGO_CONNECTION_STRING
+  }
+  if (process.env.MONGO_DOMAIN) {
+    env.MONGO_DATABASE = process.env.MONGO_DATABASE
+    env.MONGO_DOMAIN = process.env.MONGO_DOMAIN
+    env.MONGO_PASSWORD = process.env.MONGO_PASSWORD
+    env.MONGO_USERNAME = process.env.MONGO_USERNAME
+  }
+  return env
+}

package/src/config/hasMongoDBConfig.ts

@@ -0,0 +1,9 @@
+import { exists } from '@xylabs/exists'
+
+import { getMongoDBConfig } from './getMongoDBConfig'
+
+export const hasMongoDBConfig = (): boolean => {
+  const env = getMongoDBConfig()
+  const requiredValues = [env.MONGO_CONNECTION_STRING, env.MONGO_DATABASE, env.MONGO_DOMAIN, env.MONGO_PASSWORD, env.MONGO_USERNAME]
+  return requiredValues.every(exists)
+}

package/src/config/index.ts

@@ -0,0 +1,3 @@
+export * from './getBaseMongoSdk'
+export * from './getMongoDBConfig'
+export * from './hasMongoDBConfig'

package/src/index.ts

@@ -1,5 +1,7 @@
 export * from './Collections'
+export * from './config'
 export * from './Databases'
 export * from './Defaults'
+export * from './Indexes'
 export * from './Module'
 export * from './util'

package/dist/Collections.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Collections.d.ts","sourceRoot":"","sources":["../src/Collections.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,WAAW;;;;;;;CAOvB,CAAA"}

package/dist/Collections.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Collections.d.ts","sourceRoot":"","sources":["../src/Collections.ts"],"names":[],"mappings":"AACA,eAAO,MAAM,WAAW;;;;;;;CAOvB,CAAA"}

package/dist/Databases.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Databases.d.ts","sourceRoot":"","sources":["../src/Databases.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;CAErB,CAAA"}

package/dist/Databases.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Databases.d.ts","sourceRoot":"","sources":["../src/Databases.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,SAAS;;CAErB,CAAA"}

package/dist/Defaults.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Defaults.d.ts","sourceRoot":"","sources":["../src/Defaults.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB,QAAS,CAAA;AAC/C,eAAO,MAAM,YAAY,KAAK,CAAA;AAC9B,eAAO,MAAM,gBAAgB,OAAO,CAAA;AACpC,eAAO,MAAM,YAAY,SAAS,CAAA"}

package/dist/Defaults.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Defaults.d.ts","sourceRoot":"","sources":["../src/Defaults.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,yBAAyB,QAAS,CAAA;AAC/C,eAAO,MAAM,YAAY,KAAK,CAAA;AAC9B,eAAO,MAAM,gBAAgB,OAAO,CAAA;AACpC,eAAO,MAAM,YAAY,SAAS,CAAA"}

package/dist/Module.d.mts

@@ -1,17 +0,0 @@
-import { AbstractModuleInstance } from '@xyo-network/module-abstract';
-import { ModuleEventData } from '@xyo-network/module-model';
-import { MongoDBModuleParams, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb';
-import { BoundWitnessWithMeta } from '@xyo-network/node-core-model';
-import { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js';
-export declare abstract class MongoDBModule<TParams extends MongoDBModuleParams = MongoDBModuleParams, TEventData extends ModuleEventData<object> = ModuleEventData<object>> extends AbstractModuleInstance<TParams, TEventData> {
-    static labels: MongoDBStorageClassLabels;
-    private _boundWitnessSdk;
-    private _payloadSdk;
-    get boundWitnessSdkConfig(): BaseMongoSdkConfig;
-    get boundWitnesses(): BaseMongoSdk<BoundWitnessWithMeta>;
-    get payloadSdkConfig(): BaseMongoSdkConfig;
-    get payloads(): BaseMongoSdk<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/node-core-model").PayloadMetaBase & {
-        schema: string;
-    }>;
-}
-//# sourceMappingURL=Module.d.ts.map

package/dist/Module.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAc,MAAM,2BAA2B,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA;AAClG,OAAO,EAAE,oBAAoB,EAAmB,MAAM,8BAA8B,CAAA;AACpF,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEhF,8BACsB,aAAa,CACjC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EACzD,UAAU,SAAS,eAAe,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CACpE,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAAC;IACnD,MAAM,CAAC,MAAM,4BAA4B;IAEzC,OAAO,CAAC,gBAAgB,CAAgD;IACxE,OAAO,CAAC,WAAW,CAA2C;IAE9D,IAAI,qBAAqB,IAAI,kBAAkB,CAI9C;IAED,IAAI,cAAc,uCAGjB;IAED,IAAI,gBAAgB,IAAI,kBAAkB,CAIzC;IAED,IAAI,QAAQ;;OAGX;CACF"}

package/dist/Module.d.ts

@@ -1,17 +0,0 @@
-import { AbstractModuleInstance } from '@xyo-network/module-abstract';
-import { ModuleEventData } from '@xyo-network/module-model';
-import { MongoDBModuleParams, MongoDBStorageClassLabels } from '@xyo-network/module-model-mongodb';
-import { BoundWitnessWithMeta } from '@xyo-network/node-core-model';
-import { BaseMongoSdk, BaseMongoSdkConfig } from '@xyo-network/sdk-xyo-mongo-js';
-export declare abstract class MongoDBModule<TParams extends MongoDBModuleParams = MongoDBModuleParams, TEventData extends ModuleEventData<object> = ModuleEventData<object>> extends AbstractModuleInstance<TParams, TEventData> {
-    static labels: MongoDBStorageClassLabels;
-    private _boundWitnessSdk;
-    private _payloadSdk;
-    get boundWitnessSdkConfig(): BaseMongoSdkConfig;
-    get boundWitnesses(): BaseMongoSdk<BoundWitnessWithMeta>;
-    get payloadSdkConfig(): BaseMongoSdkConfig;
-    get payloads(): BaseMongoSdk<import("@xyo-network/payload-model").SchemaFields & import("@xyo-network/payload-model").PayloadFields & import("@xyo-network/node-core-model").PayloadMetaBase & {
-        schema: string;
-    }>;
-}
-//# sourceMappingURL=Module.d.ts.map

package/dist/Module.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Module.d.ts","sourceRoot":"","sources":["../src/Module.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,sBAAsB,EAAE,MAAM,8BAA8B,CAAA;AACrE,OAAO,EAAE,eAAe,EAAc,MAAM,2BAA2B,CAAA;AACvE,OAAO,EAAE,mBAAmB,EAAE,yBAAyB,EAAE,MAAM,mCAAmC,CAAA;AAClG,OAAO,EAAE,oBAAoB,EAAmB,MAAM,8BAA8B,CAAA;AACpF,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAA;AAEhF,8BACsB,aAAa,CACjC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB,EACzD,UAAU,SAAS,eAAe,CAAC,MAAM,CAAC,GAAG,eAAe,CAAC,MAAM,CAAC,CACpE,SAAQ,sBAAsB,CAAC,OAAO,EAAE,UAAU,CAAC;IACnD,MAAM,CAAC,MAAM,4BAA4B;IAEzC,OAAO,CAAC,gBAAgB,CAAgD;IACxE,OAAO,CAAC,WAAW,CAA2C;IAE9D,IAAI,qBAAqB,IAAI,kBAAkB,CAI9C;IAED,IAAI,cAAc,uCAGjB;IAED,IAAI,gBAAgB,IAAI,kBAAkB,CAIzC;IAED,IAAI,QAAQ;;OAGX;CACF"}