@treatwell/moleculer-essentials 2.1.1 → 2.2.1

package/dist/mixins/database.mixin.cjs

@@ -783,8 +783,16 @@ function DatabaseConnectionMixin(opts) {
       getMongoClient() {
         return this.mongoClient;
       },
-      getCollection(options) {
-        return this.getMongoClient().db(dbName).collection(collectionName, options);
+      getMongoDb(options) {
+        return this.getMongoClient().db(dbName, options);
+      },
+      getCollection(options, dbOptions) {
+        if (!collectionName) {
+          throw new Error(
+            "No collectionName was provided in DatabaseConnectionMixin"
+          );
+        }
+        return this.getMongoClient().db(dbName, dbOptions).collection(collectionName, options);
       }
     },
     created() {
@@ -809,13 +817,19 @@ function DatabaseConnectionMixin(opts) {
     async started() {
       this.logger.debug("Service connecting to mongoDB");
       await this.getMongoClient().connect();
-      this.logger.debug("Service connected to mongoDB, creating collection");
-      try {
-        await this.getMongoClient().db(dbName).createCollection(collectionName, createCollectionOptions);
-      } catch (err) {
-        if (err?.code !== 48) {
-          this.logger.error("Error while creating collection", { err });
+      if (collectionName) {
+        this.logger.debug("Service connected to mongoDB, creating collection");
+        try {
+          await this.getMongoClient().db(dbName).createCollection(collectionName, createCollectionOptions);
+        } catch (err) {
+          if (err?.code !== 48) {
+            this.logger.error("Error while creating collection", { err });
+          }
         }
+      } else {
+        this.logger.debug(
+          "Service connected to mongoDB, no collection defined"
+        );
       }
     },
     async stopped() {
@@ -991,22 +1005,30 @@ async function getIndexesDifference(collection, declaredIndexes = [], declaredSe
 }
 const DATABASE_INDEXES_MIXIN_SYNC_EVENT = "database-indexes-mixin.sync";
 function DatabaseIndexesMixin(opts) {
+  const { collectionName: mixinCollectionName, searchIndexes, indexes } = opts;
   return index$1.wrapMixin({
     methods: {
       async _syncIndexes({
+        collectionName,
         dropIndexes,
         createIndexes
       }) {
-        if (typeof this.getCollection !== "function") {
+        if (typeof this.getCollection !== "function" || typeof this.getMongoDb !== "function") {
           throw new Error(
-            "getCollection method not found, did you add the DatabaseConnectionMixin?"
+            "getCollection or getMongoDb method not found, did you add the DatabaseConnectionMixin?"
           );
         }
-        const collection = this.getCollection();
+        let collection;
+        if (collectionName) {
+          const db = this.getMongoDb();
+          collection = db.collection(collectionName);
+        } else {
+          collection = this.getCollection();
+        }
         const states = await getIndexesDifference(
           collection,
-          opts.indexes,
-          opts.searchIndexes
+          indexes,
+          searchIndexes
         );
         const notOkStates = states.filter((s) => s.status !== IndexStatus.OK);
         if (!notOkStates.length) {
@@ -1073,12 +1095,17 @@ function DatabaseIndexesMixin(opts) {
           ctx.logger.info(
             `Received sync indexes event for service ${this.name}`
           );
-          await this._syncIndexes({ createIndexes: true, dropIndexes: false });
+          await this._syncIndexes({
+            collectionName: mixinCollectionName,
+            createIndexes: true,
+            dropIndexes: false
+          });
         }
       },
       "$broker.started": {
         async handler() {
           await this._syncIndexes({
+            collectionName: mixinCollectionName,
             createIndexes: shouldAutoCreateIndexes(),
             dropIndexes: shouldAutoDropIndexes()
           });

package/dist/mixins/database.mixin.d.cts

@@ -1,4 +1,4 @@
-import { Document, ObjectId, WithoutId, InferIdType, Filter, OptionalId, WithId, CountDocumentsOptions, DeleteOptions, FindOneAndDeleteOptions, FindOptions, BulkWriteOptions, FindOneAndUpdateOptions, UpdateOptions, FindOneAndReplaceOptions, CollationOptions, CreateCollectionOptions, MongoClient, CollectionOptions, Collection, UpdateFilter, FindCursor, UpdateResult } from 'mongodb';
+import { Document, ObjectId, WithoutId, InferIdType, Filter, OptionalId, WithId, CountDocumentsOptions, DeleteOptions, FindOneAndDeleteOptions, FindOptions, BulkWriteOptions, FindOneAndUpdateOptions, UpdateOptions, FindOneAndReplaceOptions, CollationOptions, CreateCollectionOptions, MongoClient, DbOptions, Db, CollectionOptions, Collection, UpdateFilter, FindCursor, UpdateResult } from 'mongodb';
 import { ActionVisibility, Validators, Errors, Context } from 'moleculer';
 import { ZodType, ZodObject } from 'zod/v4';
 import { _ as ValidationSchema, J as JSONSchemaType, C as CustomActionSchema, P as PartialCustomServiceSchema } from '../newrelic-metrics-reporter-CmRMT4LG.cjs';
@@ -468,13 +468,14 @@ type DatabaseConnectionOptions = {
      * Name of the database to use.
      * If not specified, will use the default one (inferred from uri).
      *
-     * OVERRIDDEN by globalThis.__MONGO_DB_NAME__ if set, which is useful for tests.
+     * OVERRIDDEN by `globalThis.__MONGO_DB_NAME__` if set, which is useful for tests.
      */
     databaseName?: string;
     /**
-     * Name of the collection in the DB.
+     * Name of the collection in the DB. If undefined, will throw on `getCollection` method
+     * and will not try to create the collection.
      */
-    collectionName: string;
+    collectionName: string | undefined;
     /**
      * Collection creation options.
      * If not specified, will use the default one.
@@ -488,13 +489,14 @@ type DatabaseConnectionOptions = {
      * - process.env.MONGODB_URL
      * - 'mongodb://localhost:27017' (default)
      *
-     * OVERRIDDEN by globalThis.__MONGO_URI__ if set, which is useful for tests.
+     * OVERRIDDEN by `globalThis.__MONGO_URI__` if set, which is useful for tests.
      */
     uri?: string;
 };
 declare function DatabaseConnectionMixin<TSchema extends Record<string, unknown> = never>(opts: DatabaseConnectionOptions): PartialCustomServiceSchema<unknown, {
     getMongoClient(): MongoClient;
-    getCollection(options?: CollectionOptions): Collection<TSchema>;
+    getMongoDb(options?: DbOptions): Db;
+    getCollection(options?: CollectionOptions, dbOptions?: DbOptions): Collection<TSchema>;
 }, PartialCustomServiceSchema<unknown, {
     getStore(storeName: string): Map<string, {
         services: Set<unknown>;
@@ -790,16 +792,24 @@ type IndexState = {
 };
 
 type DatabaseIndexesOptions = {
+    /**
+     * Mostly useful when no collectionName was provided on the underlying DatabaseConnectionMixin.
+     * It allows users to have multiple DatabaseIndexesMixin on the same service.
+     *
+     * Using a different collectionName from the one specified in DatabaseConnectionMixin is NOT recommended.
+     */
+    collectionName?: string;
     indexes?: IndexTuple[];
     searchIndexes?: Record<string, SearchIndexDefinition>;
 };
 type SyncIndexesOptions = {
+    collectionName?: string;
     createIndexes: boolean;
     dropIndexes: boolean;
 };
 declare const DATABASE_INDEXES_MIXIN_SYNC_EVENT = "database-indexes-mixin.sync";
 declare function DatabaseIndexesMixin(opts: DatabaseIndexesOptions): PartialCustomServiceSchema<unknown, {
-    _syncIndexes({ dropIndexes, createIndexes, }: SyncIndexesOptions): Promise<void>;
+    _syncIndexes({ collectionName, dropIndexes, createIndexes, }: SyncIndexesOptions): Promise<void>;
     _createIndexFromState(col: Collection, state: IndexState): Promise<void>;
 }, unknown>;
 

package/dist/mixins/database.mixin.d.mts

@@ -1,4 +1,4 @@
-import { Document, ObjectId, WithoutId, InferIdType, Filter, OptionalId, WithId, CountDocumentsOptions, DeleteOptions, FindOneAndDeleteOptions, FindOptions, BulkWriteOptions, FindOneAndUpdateOptions, UpdateOptions, FindOneAndReplaceOptions, CollationOptions, CreateCollectionOptions, MongoClient, CollectionOptions, Collection, UpdateFilter, FindCursor, UpdateResult } from 'mongodb';
+import { Document, ObjectId, WithoutId, InferIdType, Filter, OptionalId, WithId, CountDocumentsOptions, DeleteOptions, FindOneAndDeleteOptions, FindOptions, BulkWriteOptions, FindOneAndUpdateOptions, UpdateOptions, FindOneAndReplaceOptions, CollationOptions, CreateCollectionOptions, MongoClient, DbOptions, Db, CollectionOptions, Collection, UpdateFilter, FindCursor, UpdateResult } from 'mongodb';
 import { ActionVisibility, Validators, Errors, Context } from 'moleculer';
 import { ZodType, ZodObject } from 'zod/v4';
 import { _ as ValidationSchema, J as JSONSchemaType, C as CustomActionSchema, P as PartialCustomServiceSchema } from '../newrelic-metrics-reporter-CmRMT4LG.mjs';
@@ -468,13 +468,14 @@ type DatabaseConnectionOptions = {
      * Name of the database to use.
      * If not specified, will use the default one (inferred from uri).
      *
-     * OVERRIDDEN by globalThis.__MONGO_DB_NAME__ if set, which is useful for tests.
+     * OVERRIDDEN by `globalThis.__MONGO_DB_NAME__` if set, which is useful for tests.
      */
     databaseName?: string;
     /**
-     * Name of the collection in the DB.
+     * Name of the collection in the DB. If undefined, will throw on `getCollection` method
+     * and will not try to create the collection.
      */
-    collectionName: string;
+    collectionName: string | undefined;
     /**
      * Collection creation options.
      * If not specified, will use the default one.
@@ -488,13 +489,14 @@ type DatabaseConnectionOptions = {
      * - process.env.MONGODB_URL
      * - 'mongodb://localhost:27017' (default)
      *
-     * OVERRIDDEN by globalThis.__MONGO_URI__ if set, which is useful for tests.
+     * OVERRIDDEN by `globalThis.__MONGO_URI__` if set, which is useful for tests.
      */
     uri?: string;
 };
 declare function DatabaseConnectionMixin<TSchema extends Record<string, unknown> = never>(opts: DatabaseConnectionOptions): PartialCustomServiceSchema<unknown, {
     getMongoClient(): MongoClient;
-    getCollection(options?: CollectionOptions): Collection<TSchema>;
+    getMongoDb(options?: DbOptions): Db;
+    getCollection(options?: CollectionOptions, dbOptions?: DbOptions): Collection<TSchema>;
 }, PartialCustomServiceSchema<unknown, {
     getStore(storeName: string): Map<string, {
         services: Set<unknown>;
@@ -790,16 +792,24 @@ type IndexState = {
 };
 
 type DatabaseIndexesOptions = {
+    /**
+     * Mostly useful when no collectionName was provided on the underlying DatabaseConnectionMixin.
+     * It allows users to have multiple DatabaseIndexesMixin on the same service.
+     *
+     * Using a different collectionName from the one specified in DatabaseConnectionMixin is NOT recommended.
+     */
+    collectionName?: string;
     indexes?: IndexTuple[];
     searchIndexes?: Record<string, SearchIndexDefinition>;
 };
 type SyncIndexesOptions = {
+    collectionName?: string;
     createIndexes: boolean;
     dropIndexes: boolean;
 };
 declare const DATABASE_INDEXES_MIXIN_SYNC_EVENT = "database-indexes-mixin.sync";
 declare function DatabaseIndexesMixin(opts: DatabaseIndexesOptions): PartialCustomServiceSchema<unknown, {
-    _syncIndexes({ dropIndexes, createIndexes, }: SyncIndexesOptions): Promise<void>;
+    _syncIndexes({ collectionName, dropIndexes, createIndexes, }: SyncIndexesOptions): Promise<void>;
     _createIndexFromState(col: Collection, state: IndexState): Promise<void>;
 }, unknown>;
 

package/dist/mixins/database.mixin.mjs

@@ -781,8 +781,16 @@ function DatabaseConnectionMixin(opts) {
       getMongoClient() {
         return this.mongoClient;
       },
-      getCollection(options) {
-        return this.getMongoClient().db(dbName).collection(collectionName, options);
+      getMongoDb(options) {
+        return this.getMongoClient().db(dbName, options);
+      },
+      getCollection(options, dbOptions) {
+        if (!collectionName) {
+          throw new Error(
+            "No collectionName was provided in DatabaseConnectionMixin"
+          );
+        }
+        return this.getMongoClient().db(dbName, dbOptions).collection(collectionName, options);
       }
     },
     created() {
@@ -807,13 +815,19 @@ function DatabaseConnectionMixin(opts) {
     async started() {
       this.logger.debug("Service connecting to mongoDB");
       await this.getMongoClient().connect();
-      this.logger.debug("Service connected to mongoDB, creating collection");
-      try {
-        await this.getMongoClient().db(dbName).createCollection(collectionName, createCollectionOptions);
-      } catch (err) {
-        if (err?.code !== 48) {
-          this.logger.error("Error while creating collection", { err });
+      if (collectionName) {
+        this.logger.debug("Service connected to mongoDB, creating collection");
+        try {
+          await this.getMongoClient().db(dbName).createCollection(collectionName, createCollectionOptions);
+        } catch (err) {
+          if (err?.code !== 48) {
+            this.logger.error("Error while creating collection", { err });
+          }
         }
+      } else {
+        this.logger.debug(
+          "Service connected to mongoDB, no collection defined"
+        );
       }
     },
     async stopped() {
@@ -989,22 +1003,30 @@ async function getIndexesDifference(collection, declaredIndexes = [], declaredSe
 }
 const DATABASE_INDEXES_MIXIN_SYNC_EVENT = "database-indexes-mixin.sync";
 function DatabaseIndexesMixin(opts) {
+  const { collectionName: mixinCollectionName, searchIndexes, indexes } = opts;
   return wrapMixin({
     methods: {
       async _syncIndexes({
+        collectionName,
         dropIndexes,
         createIndexes
       }) {
-        if (typeof this.getCollection !== "function") {
+        if (typeof this.getCollection !== "function" || typeof this.getMongoDb !== "function") {
           throw new Error(
-            "getCollection method not found, did you add the DatabaseConnectionMixin?"
+            "getCollection or getMongoDb method not found, did you add the DatabaseConnectionMixin?"
           );
         }
-        const collection = this.getCollection();
+        let collection;
+        if (collectionName) {
+          const db = this.getMongoDb();
+          collection = db.collection(collectionName);
+        } else {
+          collection = this.getCollection();
+        }
         const states = await getIndexesDifference(
           collection,
-          opts.indexes,
-          opts.searchIndexes
+          indexes,
+          searchIndexes
         );
         const notOkStates = states.filter((s) => s.status !== IndexStatus.OK);
         if (!notOkStates.length) {
@@ -1071,12 +1093,17 @@ function DatabaseIndexesMixin(opts) {
           ctx.logger.info(
             `Received sync indexes event for service ${this.name}`
           );
-          await this._syncIndexes({ createIndexes: true, dropIndexes: false });
+          await this._syncIndexes({
+            collectionName: mixinCollectionName,
+            createIndexes: true,
+            dropIndexes: false
+          });
         }
       },
       "$broker.started": {
         async handler() {
           await this._syncIndexes({
+            collectionName: mixinCollectionName,
             createIndexes: shouldAutoCreateIndexes(),
             dropIndexes: shouldAutoDropIndexes()
           });

package/package.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/treatwell/moleculer-essentials"
   },
-  "version": "2.1.1",
+  "version": "2.2.1",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.cts",