fix: use own types and add documentation

Author: gagik

packages/i18n/src/locales/en_US.ts

@@ -422,6 +422,43 @@ const translations: Catalog = {
           },
         },
       },
+      ClientBulkWriteResult: {
+        help: {
+          description: 'ClientBulkWriteResult Class',
+          attributes: {
+            acknowledged: {
+              description: 'Acknowledged returned from the server',
+            },
+            insertedCount: {
+              description: 'Number of documents inserted',
+            },
+            matchedCount: {
+              description: 'Number of documents matched',
+            },
+            modifiedCount: {
+              description: 'Number of documents modified',
+            },
+            deletedCount: {
+              description: 'Number of documents deleted',
+            },
+            upsertedCount: {
+              description: 'Number of documents upserted',
+            },
+            insertResults: {
+              description:
+                'The results of each individual insert operation that was successfully performed',
+            },
+            updateResults: {
+              description:
+                'The results of each individual update operation that was successfully performed',
+            },
+            deleteResults: {
+              description:
+                'The results of each individual delete operation that was successfully performed.',
+            },
+          },
+        },
+      },
       CommandResult: {
         help: {
           description: 'CommandResult Class',
@@ -2240,6 +2277,12 @@ const translations: Catalog = {
               link: 'https://docs.mongodb.com/manual/reference/method/Mongo.startSession/',
               description: 'Starts a session for the connection.',
             },
+            bulkWrite: {
+              link: 'https://docs.mongodb.com/manual/reference/method/Mongo.bulkWrite',
+              description:
+                'Performs multiple write operations across databases and collections with controls for order of execution.',
+              example: 'db.getMongo().bulkWrite(operations, options)',
+            },
             getCollection: {
               link: 'https://docs.mongodb.com/manual/reference/method/Mongo.getCollection',
               description:

packages/service-provider-core/src/all-transport-types.ts

@@ -7,6 +7,7 @@ export type {
   BulkWriteOptions,
   BulkWriteResult,
   ClientBulkWriteResult,
+  ClientBulkWriteOptions,
   ChangeStream,
   ChangeStreamOptions,
   ClientSession,

packages/service-provider-core/src/writable.ts

@@ -1,4 +1,4 @@
-import type { ClientBulkWriteOptions, RunCursorCommandOptions } from 'mongodb';
+import type { RunCursorCommandOptions } from 'mongodb';
 import type {
   Document,
   InsertOneOptions,
@@ -12,6 +12,7 @@ import type {
   AnyBulkWriteOperation,
   AnyClientBulkWriteModel,
   ClientBulkWriteResult,
+  ClientBulkWriteOptions,
   DeleteOptions,
   DeleteResult,
   InsertManyResult,

packages/service-provider-node-driver/src/node-driver-service-provider.ts

@@ -27,6 +27,7 @@ import type {
   BulkWriteOptions,
   BulkWriteResult,
   ClientBulkWriteResult,
+  ClientBulkWriteOptions,
   ClientSessionOptions,
   Collection,
   CountDocumentsOptions,
@@ -637,7 +638,7 @@ export class NodeDriverServiceProvider
    */
   clientBulkWrite(
     models: AnyClientBulkWriteModel<Document>[],
-    options: BulkWriteOptions = {}
+    options: ClientBulkWriteOptions = {}
   ): Promise<ClientBulkWriteResult> {
     options = { ...this.baseCmdOptions, ...options };
     return this.mongoClient.bulkWrite(models, options);

packages/shell-api/src/mongo.spec.ts

@@ -35,6 +35,7 @@ import {
   startSharedTestServer,
 } from '../../../testing/integration-testing-hooks';
 import { dummyOptions } from './helpers.spec';
+import { ClientBulkWriteResult } from './result';
 
 const sampleOpts = {
   causalConsistency: false,
@@ -1051,17 +1052,19 @@ describe('Mongo', function () {
                   document: { name: 'Prince' },
                 },
               ])
-            ).deep.equals({
-              acknowledged: true,
-              insertedCount: 3,
-              upsertedCount: 0,
-              matchedCount: 0,
-              modifiedCount: 0,
-              deletedCount: 1,
-              insertResults: undefined,
-              updateResults: undefined,
-              deleteResults: undefined,
-            });
+            ).deep.equals(
+              new ClientBulkWriteResult({
+                acknowledged: true,
+                insertedCount: 3,
+                upsertedCount: 0,
+                matchedCount: 0,
+                modifiedCount: 0,
+                deletedCount: 1,
+                insertResults: undefined,
+                updateResults: undefined,
+                deleteResults: undefined,
+              })
+            );
 
             expect(
               await mongo.getDB('db').getCollection('authors').count()

packages/shell-api/src/mongo.ts

@@ -37,7 +37,7 @@ import type {
   ServerApiVersion,
   WriteConcern,
   AnyClientBulkWriteModel,
-  ClientBulkWriteResult,
+  ClientBulkWriteOptions,
 } from '@mongosh/service-provider-core';
 import type { ConnectionInfo } from '@mongosh/arg-parser';
 import {
@@ -47,6 +47,7 @@ import {
 import type Collection from './collection';
 import Database from './database';
 import type ShellInstanceState from './shell-instance-state';
+import { ClientBulkWriteResult } from './result';
 import { CommandResult } from './result';
 import { redactURICredentials } from '@mongosh/history';
 import { asPrintable, ServerVersions, Topologies } from './enums';
@@ -64,7 +65,6 @@ import { ShellApiErrors } from './error-codes';
 import type { LogEntry } from './log-entry';
 import { parseAnyLogEntry } from './log-entry';
 import type { ShellBson } from './shell-bson';
-import type { ClientBulkWriteOptions } from 'mongodb';
 
 /* Utility, inverse of Readonly<T> */
 type Mutable<T> = {
@@ -371,13 +371,35 @@ export default class Mongo extends ShellApiClass {
   @returnsPromise
   @serverVersions(['8.0.0', ServerVersions.latest])
   @apiVersions([1])
-  bulkWrite(
+  async bulkWrite(
     models: AnyClientBulkWriteModel<Document>[],
     options: ClientBulkWriteOptions = {}
   ): Promise<ClientBulkWriteResult> {
     this._emitMongoApiCall('bulkWrite', { options });
 
-    return this._serviceProvider.clientBulkWrite(models, options);
+    const {
+      acknowledged,
+      insertedCount,
+      matchedCount,
+      modifiedCount,
+      deletedCount,
+      upsertedCount,
+      insertResults,
+      updateResults,
+      deleteResults,
+    } = await this._serviceProvider.clientBulkWrite(models, options);
+
+    return new ClientBulkWriteResult({
+      acknowledged,
+      insertedCount,
+      matchedCount,
+      modifiedCount,
+      deletedCount,
+      upsertedCount,
+      insertResults,
+      updateResults,
+      deleteResults,
+    });
   }
 
   @returnsPromise

packages/shell-api/src/result.ts

@@ -25,6 +25,69 @@ export class CommandResult<T = unknown> extends ShellApiValueClass {
   }
 }
 
+export type ClientInsertResult = {
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  insertedId: any;
+};
+
+export type ClientUpdateResult = {
+  matchedCount: number;
+  modifiedCount: number;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  upsertedId?: any;
+  didUpsert: boolean;
+};
+
+export type ClientDeleteResult = {
+  deletedCount: number;
+};
+
+@shellApiClassDefault
+export class ClientBulkWriteResult extends ShellApiValueClass {
+  acknowledged: boolean;
+  insertedCount: number;
+  matchedCount: number;
+  modifiedCount: number;
+  deletedCount: number;
+  upsertedCount: number;
+  readonly insertResults?: ReadonlyMap<number, ClientInsertResult>;
+  readonly updateResults?: ReadonlyMap<number, ClientUpdateResult>;
+  readonly deleteResults?: ReadonlyMap<number, ClientDeleteResult>;
+
+  constructor({
+    acknowledged,
+    insertedCount,
+    matchedCount,
+    modifiedCount,
+    deletedCount,
+    upsertedCount,
+    insertResults,
+    updateResults,
+    deleteResults,
+  }: {
+    acknowledged: boolean;
+    insertedCount: number;
+    matchedCount: number;
+    modifiedCount: number;
+    deletedCount: number;
+    upsertedCount: number;
+    insertResults?: ReadonlyMap<number, ClientInsertResult>;
+    updateResults?: ReadonlyMap<number, ClientUpdateResult>;
+    deleteResults?: ReadonlyMap<number, ClientDeleteResult>;
+  }) {
+    super();
+    this.acknowledged = acknowledged;
+    this.insertedCount = insertedCount;
+    this.matchedCount = matchedCount;
+    this.modifiedCount = modifiedCount;
+    this.deletedCount = deletedCount;
+    this.upsertedCount = upsertedCount;
+    this.insertResults = insertResults;
+    this.updateResults = updateResults;
+    this.deleteResults = deleteResults;
+  }
+}
+
 @shellApiClassDefault
 export class BulkWriteResult extends ShellApiValueClass {
   acknowledged: boolean;