@pi-r/mongodb 0.8.3 → 0.9.0

package/LICENSE

@@ -1,7 +1,7 @@
-Copyright 2024 An Pham
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Copyright 2024 An Pham
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -4,4 +4,4 @@ https://e-mc.readthedocs.io/en/latest/db/mongodb.html
 
 ### LICENSE
 
-MIT
+MIT

package/client/index.d.ts

@@ -1,12 +1,15 @@
-import type { IDbSourceClient } from '@e-mc/db/types';
-
-import type { MongoDBDataSource, MongoDBFilterValue, MongoDBSortValue } from '../types';
-
-import type { CommandOperationOptions, Document, Filter, Sort, SortDirection } from 'mongodb';
-
-declare const MongoDB: IDbSourceClient<MongoDBDataSource> & {
-    getFilterValue(query: Filter<Document> | MongoDBFilterValue, coerce?: boolean): [Filter<Document>, CommandOperationOptions?];
-    getSortValue(sort: Sort | string | MongoDBSortValue, coerce?: boolean): [Sort | string, SortDirection?];
-};
-
+import type { IModule } from '@e-mc/types/lib';
+
+import type { IDbSourceClient } from '@e-mc/db/types';
+
+import type { MongoDBDataSource, MongoDBFilterValue, MongoDBSortValue } from '../types';
+
+import type { Collection, CommandOperationOptions, Document, Filter, MongoClient, Sort, SortDirection } from 'mongodb';
+
+declare const MongoDB: IDbSourceClient<MongoDBDataSource> & {
+    getFilterValue(query: Filter<Document> | MongoDBFilterValue, coerce?: boolean): [Filter<Document>, CommandOperationOptions?];
+    getSortValue(sort: Sort | string | MongoDBSortValue, coerce?: boolean): [Sort | string, SortDirection?];
+    initCollection(this: IModule, target: MongoClient, item: Pick<MongoDBDataSource, "bulkWrite" | "client" | "command" | "name" | "table">): Promise<Collection>;
+};
+
 export = MongoDB;

package/client/index.js

@@ -4,9 +4,10 @@ exports.setCredential = setCredential;
 exports.executeQuery = executeQuery;
 exports.executeBatchQuery = executeBatchQuery;
 exports.checkTimeout = checkTimeout;
+exports.initCollection = initCollection;
 exports.getFilterValue = getFilterValue;
 exports.getSortValue = getSortValue;
-const path = require("path");
+const path = require("node:path");
 const mongodb = require("mongodb");
 const Db = require("@e-mc/db");
 const Request = require("@e-mc/request");
@@ -291,15 +292,12 @@ async function executeBatchQuery(batch, options = '', outResult) {
             continue;
         }
         item.transactionState = 1;
-        const getInstance = (target) => target.db(name, client?.db);
-        const getCollection = (target) => getInstance(target).collection(table, client?.collection);
-        const runCommand = async (target, document) => getInstance(target).command(document, client?.command);
         const credential = mongoCredential || onceCredential || getCacheObject(item);
         const cacheValue = ignoreCache === undefined ? sessionKey : Array.isArray(ignoreCache) ? { sessionKey, exclusiveOf: ignoreCache } : { sessionKey, renewCache: ignoreCache === 0 };
         const coercing = this.hasCoerce("mongodb", 'options', credential.uuidKey);
         const targetObject = typeof checkObject === 'string' ? coercing && (0, types_1.asFunction)(checkObject) : checkObject;
-        if (typeof streamRow === 'string') {
-            streamRow = coercing && (0, types_1.asFunction)(streamRow);
+        if (coercing && typeof streamRow === 'string') {
+            streamRow = (0, types_1.asFunction)(streamRow);
         }
         let queryString = '', rows, pipeline;
         if (caching && ignoreCache !== true && (!targetObject || typeof cacheObjectKey === 'string') && !streamRow) {
@@ -354,15 +352,7 @@ async function executeBatchQuery(batch, options = '', outResult) {
             let commandType;
             try {
                 const instance = mongoClient || await getConnection(item, credential);
-                if (item.command) {
-                    await Promise.all((!Array.isArray(item.command) ? [item.command] : item.command).map(async (cmd) => runCommand(instance, cmd)))
-                        .then(items => {
-                        for (const output of items) {
-                            this.addLog(this.statusType.INFO, output, "mongodb", 'runCommand');
-                        }
-                    });
-                }
-                const collection = getCollection(instance);
+                const collection = await initCollection.call(this, instance, item);
                 if (update && coercing) {
                     (0, types_1.coerceObject)(update);
                 }
@@ -518,6 +508,29 @@ async function executeBatchQuery(batch, options = '', outResult) {
 async function checkTimeout(value, limit = 0) {
     return DbPool.checkTimeout(POOL_STATE, value, limit);
 }
+async function initCollection(target, item) {
+    const db = target.db(item.name, item.client?.db);
+    if (item.command) {
+        await Promise.all((!Array.isArray(item.command) ? [item.command] : item.command).map(async (cmd) => db.command(document, cmd)))
+            .then(items => {
+            for (const output of items) {
+                this.addLog(this.statusType.INFO, output, this.moduleName, 'runCommand');
+            }
+        });
+    }
+    if (item.bulkWrite) {
+        await target.bulkWrite(item.bulkWrite, item.client?.bulkWrite).then(result => {
+            if (result.acknowledged) {
+                const { insertedCount, upsertedCount, matchedCount, modifiedCount, deletedCount } = result;
+                this.addLog(this.statusType.INFO, `inserted: ${insertedCount}, upserted: ${upsertedCount}, matched: ${matchedCount}, modified: ${modifiedCount}, deleted: ${deletedCount}`, "mongodb", 'bulkWrite');
+            }
+            else {
+                this.addLog(this.statusType.WARN, 'Operation was not acknowledged', this.moduleName, 'bulkWrite');
+            }
+        });
+    }
+    return db.collection(item.table, item.client?.collection);
+}
 function getFilterValue(query, coerce) {
     let value, options;
     if ((0, types_1.isObject)(query) && query.value && query.options) {

package/client/pool.d.ts

@@ -1,9 +1,9 @@
-import type { DbPoolConstructor } from '@e-mc/types/lib/db';
-
-import type { DbPoolCredential, MongoDBDataSource } from '../types';
-
-import type { MongoClient } from 'mongodb';
-
-declare const MongoDBPool: DbPoolConstructor<MongoDBDataSource, MongoClient, MongoClient, DbPoolCredential>;
-
+import type { DbPoolConstructor } from '@e-mc/types/lib/db';
+
+import type { DbPoolCredential, MongoDBDataSource } from '../types';
+
+import type { MongoClient } from 'mongodb';
+
+declare const MongoDBPool: DbPoolConstructor<MongoDBDataSource, MongoClient, MongoClient, DbPoolCredential>;
+
 export = MongoDBPool;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pi-r/mongodb",
-  "version": "0.8.3",
+  "version": "0.9.0",
   "description": "MongoDB client driver for E-mc.",
   "main": "client/index.js",
   "types": "client/index.d.ts",
@@ -14,16 +14,15 @@
   },
   "keywords": [
     "squared",
-    "e-mc",
-    "squared-functions"
+    "e-mc"
   ],
   "author": "An Pham <anpham6@gmail.com>",
   "license": "MIT",
   "homepage": "https://github.com/anpham6/pi-r#readme",
   "dependencies": {
-    "@e-mc/db": "^0.10.3",
-    "@e-mc/request": "^0.10.3",
-    "@e-mc/types": "^0.10.3",
-    "mongodb": "^6.9.0"
+    "@e-mc/db": "^0.11.0",
+    "@e-mc/request": "^0.11.0",
+    "@e-mc/types": "^0.11.0",
+    "mongodb": "^6.11.0"
   }
 }

package/types/index.d.ts

@@ -3,7 +3,7 @@ import type { DbDataSource } from '@e-mc/types/lib/squared';
 import type { IdentifierAction } from '@e-mc/types/lib/core';
 import type { CascadeAction, ServerAuth } from '@e-mc/types/lib/db';
 
-import type { AggregateOptions, CollectionOptions, CommandOperationOptions, DbOptions, Document, Filter, MongoClientOptions, OptionalUnlessRequiredId, RunCommandOptions, Sort, SortDirection, UpdateFilter } from 'mongodb';
+import type { AggregateOptions, ClientBulkWriteModel, ClientBulkWriteOptions, CollectionOptions, CommandOperationOptions, DbOptions, Document, Filter, MongoClientOptions, OptionalUnlessRequiredId, RunCommandOptions, Sort, SortDirection, UpdateFilter } from 'mongodb';
 
 export interface MongoDBDataSource extends DbDataSource<Filter<Document> | MongoDBFilterValue, MongoClientOptions, UpdateFilter<Document> | OptionalUnlessRequiredId<unknown>[], MongoDBCredential, string>, MongoDBClientDBOptions, CascadeAction {
     source: "mongodb";
@@ -28,12 +28,14 @@ export interface MongoDBClientDBOptions {
         db?: DbOptions;
         collection?: CollectionOptions;
         command?: RunCommandOptions;
+        bulkWrite?: ClientBulkWriteOptions;
     };
     execute?: {
         insert?: CommandOperationOptions;
         update?: CommandOperationOptions;
     };
-    command?: ArrayOf<Document>;
+    command?: Document | Document[];
+    bulkWrite?: ClientBulkWriteModel[];
     aggregate?: MongoDBAggregate | Document[];
     sort?: Sort | string | MongoDBSortValue;
 }