@mongosh/service-provider-core 1.9.0 → 1.10.0

package/AUTHORS

@@ -13,3 +13,4 @@ Leonardo Rossi <leonardo.rossi@gmail.com>
 Le Roux Bodenstein <lerouxb@gmail.com>
 Bailey Pearson <bailey.pearson@mongodb.com>
 Himanshu Singh <himanshu.singhs@outlook.in>
+Martin Rodriguez Reboredo <yakoyoku@gmail.com>

package/lib/admin.d.ts

@@ -10,6 +10,12 @@ export interface CreateEncryptedCollectionOptions {
     };
     masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions;
 }
+export interface CheckMetadataConsistencyOptions {
+    cursor?: {
+        batchSize: number;
+    };
+    checkIndexes?: 1;
+}
 export default interface Admin {
     platform: ReplPlatform;
     initialDb: string;

package/lib/all-transport-types.d.ts

@@ -1 +1 @@
-export type { AggregateOptions, AggregationCursor, AnyBulkWriteOperation, Batch, BulkWriteOptions, BulkWriteResult, ChangeStream, ChangeStreamOptions, ClientSession, CloseOptions, CollationOptions, CollStatsOptions, Collection, CommandOperationOptions, CountDocumentsOptions, CountOptions, CreateCollectionOptions, CreateIndexesOptions, ClientSessionOptions, ClusterTime, FindCursor, CursorFlag, Db, DbOptions, DeleteOptions, DeleteResult, DistinctOptions, Document, DropCollectionOptions, DropDatabaseOptions, EstimatedDocumentCountOptions, ExplainOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndUpdateOptions, FindOneAndReplaceOptions, FindOperators, FindOptions, HedgeOptions, IndexDescription, InsertManyResult, InsertOneOptions, InsertOneResult, ListCollectionsOptions, ListDatabasesOptions, ListIndexesOptions, MongoClientOptions, OrderedBulkOperation, ReadConcern, ReadConcernLike, ReadConcernLevel, ReadPreference, ReadPreferenceLike, ReadPreferenceFromOptions, ReadPreferenceMode, RenameOptions, ReplaceOptions, ResumeToken, RunCommandOptions, ServerSessionId, TagSet, TransactionOptions, UpdateOptions, UpdateResult, UnorderedBulkOperation, WriteConcern, ObjectId as ObjectIdType, Timestamp as TimestampType, Binary as BinaryType, TopologyDescription, TopologyType, ServerType, AutoEncryptionOptions, ServerApi, ServerApiVersion, MongoClient } from 'mongodb';
+export type { AggregateOptions, AggregationCursor, AnyBulkWriteOperation, Batch, BulkWriteOptions, BulkWriteResult, ChangeStream, ChangeStreamOptions, ClientSession, CloseOptions, CollationOptions, CollStatsOptions, Collection, CommandOperationOptions, CountDocumentsOptions, CountOptions, CreateCollectionOptions, CreateIndexesOptions, ClientSessionOptions, ClusterTime, FindCursor, CursorFlag, RunCommandCursor, Db, DbOptions, DeleteOptions, DeleteResult, DistinctOptions, Document, DropCollectionOptions, DropDatabaseOptions, EstimatedDocumentCountOptions, ExplainOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndUpdateOptions, FindOneAndReplaceOptions, FindOperators, FindOptions, HedgeOptions, IndexDescription, InsertManyResult, InsertOneOptions, InsertOneResult, ListCollectionsOptions, ListDatabasesOptions, ListIndexesOptions, MongoClientOptions, OrderedBulkOperation, ReadConcern, ReadConcernLike, ReadConcernLevel, ReadPreference, ReadPreferenceLike, ReadPreferenceFromOptions, ReadPreferenceMode, RenameOptions, ReplaceOptions, ResumeToken, RunCommandOptions, ServerSessionId, TagSet, TransactionOptions, UpdateOptions, UpdateResult, UnorderedBulkOperation, WriteConcern, ObjectId as ObjectIdType, Timestamp as TimestampType, Binary as BinaryType, TopologyDescription, TopologyType, ServerType, AutoEncryptionOptions, ServerApi, ServerApiVersion, MongoClient } from 'mongodb';

package/lib/index.d.ts

@@ -9,7 +9,7 @@ import ShellAuthOptions from './shell-auth-options';
 export * from './all-transport-types';
 export * from './all-fle-types';
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
-export { CreateEncryptedCollectionOptions } from './admin';
+export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions } from './admin';
 declare const bson: {
     ObjectId: typeof ObjectId;
     DBRef: typeof DBRef;

package/lib/readable.d.ts

@@ -13,4 +13,5 @@ export default interface Readable {
     listCollections(database: string, filter?: Document, options?: ListCollectionsOptions, dbOptions?: DbOptions): Promise<Document[]>;
     readPreferenceFromOptions(options?: Omit<ReadPreferenceFromOptions, 'session'>): ReadPreferenceLike | undefined;
     watch(pipeline: Document[], options: ChangeStreamOptions, dbOptions?: DbOptions, db?: string, coll?: string): ChangeStream<Document>;
+    getSearchIndexes(database: string, collection: string, indexName?: string, options?: Document, dbOptions?: DbOptions): Promise<Document[]>;
 }

package/lib/writable.d.ts

@@ -1,7 +1,9 @@
+import { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
 import type { Document, InsertOneOptions, InsertOneResult, Collection, RenameOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions, BulkWriteOptions, AnyBulkWriteOperation, DeleteOptions, DeleteResult, InsertManyResult, ReplaceOptions, UpdateResult, UpdateOptions, DropDatabaseOptions, CreateIndexesOptions, DropCollectionOptions, BulkWriteResult, RunCommandOptions, DbOptions, OrderedBulkOperation, UnorderedBulkOperation } from './all-transport-types';
 export default interface Writable {
     runCommand(db: string, spec: Document, options: RunCommandOptions, dbOptions?: DbOptions): Promise<Document>;
     runCommandWithCheck(db: string, spec: Document, options: RunCommandOptions, dbOptions?: DbOptions): Promise<Document>;
+    runCursorCommand(db: string, spec: Document, options: RunCursorCommandOptions, dbOptions?: DbOptions): RunCommandCursor;
     dropDatabase(database: string, options: DropDatabaseOptions, dbOptions?: DbOptions): Promise<Document>;
     bulkWrite(database: string, collection: string, requests: AnyBulkWriteOperation[], options: BulkWriteOptions, dbOptions?: DbOptions): Promise<BulkWriteResult>;
     deleteMany(database: string, collection: string, filter: Document, options: DeleteOptions, dbOptions?: DbOptions): Promise<DeleteResult>;
@@ -18,4 +20,10 @@ export default interface Writable {
     dropCollection(database: string, collection: string, options: DropCollectionOptions, dbOptions?: DbOptions): Promise<boolean>;
     renameCollection(database: string, oldName: string, newName: string, options?: RenameOptions, dbOptions?: DbOptions): Promise<Collection>;
     initializeBulkOp(dbName: string, collName: string, ordered: boolean, options?: BulkWriteOptions, dbOptions?: DbOptions): Promise<OrderedBulkOperation | UnorderedBulkOperation>;
+    createSearchIndexes(database: string, collection: string, specs: {
+        name: string;
+        definition: Document;
+    }[], dbOptions?: DbOptions): Promise<string[]>;
+    dropSearchIndex(database: string, collection: string, index: string, dbOptions?: DbOptions): Promise<void>;
+    updateSearchIndex(database: string, collection: string, index: string, definition: Document, dbOptions?: DbOptions): Promise<void>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mongosh/service-provider-core",
-  "version": "1.9.0",
+  "version": "1.10.0",
   "description": "MongoDB Shell Core Service Provider Package",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -37,10 +37,10 @@
     }
   },
   "dependencies": {
-    "@aws-sdk/credential-providers": "^3.262.0",
-    "@mongosh/errors": "1.9.0",
+    "@aws-sdk/credential-providers": "^3.347.1",
+    "@mongosh/errors": "1.10.0",
     "bson": "^5.2.0",
-    "mongodb": "^5.5.0",
+    "mongodb": "^5.6.0",
     "mongodb-build-info": "^1.5.0",
     "mongodb-client-encryption": "^2.8.0"
   },
@@ -58,5 +58,5 @@
       "encoding"
     ]
   },
-  "gitHead": "938c3c1cdd0f8511b40a08c22e440106d4572b2b"
+  "gitHead": "6a6f97712a596a21c61408dfb925e729306030f8"
 }

package/src/admin.ts

@@ -30,6 +30,13 @@ export interface CreateEncryptedCollectionOptions {
   masterKey?: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions;
 }
 
+export interface CheckMetadataConsistencyOptions {
+  cursor?: {
+      batchSize: number
+  },
+  checkIndexes?: 1
+}
+
 export default interface Admin {
   /**
    * What platform (Compass/CLI/Browser)

package/src/all-transport-types.ts

@@ -21,6 +21,7 @@ export type {
   ClusterTime,
   FindCursor,
   CursorFlag,
+  RunCommandCursor,
   Db,
   DbOptions,
   DeleteOptions,

package/src/index.ts

@@ -27,7 +27,7 @@ export * from './all-fle-types';
 
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
 
-export { CreateEncryptedCollectionOptions } from './admin';
+export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions } from './admin';
 
 const bson = {
   ObjectId,

package/src/readable.ts

@@ -12,7 +12,7 @@ import type {
   FindCursor,
   DbOptions,
   ReadPreferenceFromOptions,
-  ReadPreferenceLike
+  ReadPreferenceLike,
 } from './all-transport-types';
 import { ChangeStream, ChangeStreamOptions } from './all-transport-types';
 
@@ -206,5 +206,24 @@ export default interface Readable {
     db?: string,
     coll?: string
   ): ChangeStream<Document>;
+
+  /**
+   * Returns an array of documents that identify and describe the existing
+   * search indexes on the collection.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {Document} options - The command options.
+   * @param {DbOptions} dbOptions - The database options
+   *
+   * @return {Promise}
+   */
+  getSearchIndexes(
+    database: string,
+    collection: string,
+    indexName?: string,
+    // TODO(MONGOSH-1471): use ListSearchIndexesOptions once available
+    options?: Document,
+    dbOptions?: DbOptions): Promise<Document[]>;
 }
 

package/src/writable.ts

@@ -1,3 +1,4 @@
+import { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
 import type {
   Document,
   InsertOneOptions,
@@ -58,6 +59,20 @@ export default interface Writable {
     dbOptions?: DbOptions
   ): Promise<Document>;
 
+  /**
+   * @param {String} db - the db name
+   * @param spec
+   * @param options
+   * @param {DbOptions} dbOptions - The database options
+   * @return {Promise<Document>}
+   */
+  runCursorCommand(
+    db: string,
+    spec: Document,
+    options: RunCursorCommandOptions,
+    dbOptions?: DbOptions
+  ): RunCommandCursor;
+
   /**
    * Drop a database
    *
@@ -345,5 +360,54 @@ export default interface Writable {
     options?: BulkWriteOptions,
     dbOptions?: DbOptions
   ): Promise<OrderedBulkOperation | UnorderedBulkOperation>;
+
+  /**
+   * Adds new search indexes to a collection.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {Object[]} descriptions - The specs of the indexes to be created.
+   * @param {DbOptions} dbOptions - The database options
+  */
+  createSearchIndexes(
+    database: string,
+    collection: string,
+    // TODO(MONGOSH-1471): use SearchIndexDescription[] once available
+    specs: {name: string, definition: Document}[],
+    dbOptions?: DbOptions
+  ): Promise<string[]>
+
+  /**
+   * Drops a search index.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {String} indexName - The index name
+   * @param {DbOptions} dbOptions - The database options
+  */
+  dropSearchIndex(
+    database: string,
+    collection: string,
+    index: string,
+    dbOptions?: DbOptions
+  ): Promise<void>
+
+  /**
+   * Update a search index.
+   *
+   * @param {String} database - The db name.
+   * @param {String} collection - The collection name.
+   * @param {String} indexName - The index name.
+   * @param {Object} description - The update.
+   * @param {DbOptions} dbOptions - The database options
+  */
+  updateSearchIndex(
+    database: string,
+    collection: string,
+    index: string,
+    // TODO(MONGOSH-1471): use SearchIndexDescription once available
+    definition: Document,
+    dbOptions?: DbOptions
+  ): Promise<void>
 }