@mongosh/shell-api 3.12.0 → 3.15.0

package/lib/api-processed.d.ts

@@ -3190,6 +3190,13 @@ declare class Collection<M extends GenericServerSideSchema = GenericServerSideSc
   */
   getShardDistribution(): CommandResult<GetShardDistributionResult>;
   /*
+  Returns a document containing the shards where this collection is located as well as whether the collection itself is sharded.
+  */
+  getShardLocation(): {
+    shards: string[];
+    sharded: boolean;
+  };
+  /*
   Opens a change stream cursor on the collection
   */
   watch(pipeline?: Document_2[] | ChangeStreamOptions, options?: ChangeStreamOptions): ChangeStreamCursor;
@@ -4524,23 +4531,23 @@ declare class Cursor extends AggregateOrFindCursor<ServiceProviderFindCursor> {
   /*
   Adds OP_QUERY wire protocol flags, such as the tailable flag, to change the behavior of queries. Accepts: DBQuery.Option fields tailable, slaveOk, noTimeout, awaitData, exhaust, partial.
   */
-  addOption(optionFlagNumber: number): Cursor;
+  addOption(optionFlagNumber: number): this;
   /*
   Sets the 'allowDiskUse' option. If no argument is passed, the default is true.
   */
-  allowDiskUse(allow?: boolean): Cursor;
+  allowDiskUse(allow?: boolean): this;
   /*
   Sets the 'partial' option to true.
   */
-  allowPartialResults(): Cursor;
+  allowPartialResults(): this;
   /*
   Specifies the collation for the cursor returned by the db.collection.find(). To use, append to the db.collection.find().
   */
-  collation(spec: CollationOptions): Cursor;
+  collation(spec: CollationOptions): this;
   /*
   Adds a comment field to the query.
   */
-  comment(cmt: string): Cursor;
+  comment(cmt: string): this;
   /*
   Counts the number of documents referenced by a cursor.
   */
@@ -4552,23 +4559,23 @@ declare class Cursor extends AggregateOrFindCursor<ServiceProviderFindCursor> {
   /*
   Call this method on a query to override MongoDB’s default index selection and query optimization process. Use db.collection.getIndexes() to return the list of current indexes on a collection.
   */
-  hint(index: string): Cursor;
+  hint(index: string): this;
   /*
   Use the limit() method on a cursor to specify the maximum number of documents the cursor will return.
   */
-  limit(value: number): Cursor;
+  limit(value: number): this;
   /*
   Specifies the exclusive upper bound for a specific index in order to constrain the results of find(). max() provides a way to specify an upper bound on compound key indexes.
   */
-  max(indexBounds: Document_2): Cursor;
+  max(indexBounds: Document_2): this;
   /*
   Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)
   */
-  maxAwaitTimeMS(value: number): Cursor;
+  maxAwaitTimeMS(value: number): this;
   /*
   Specifies the inclusive lower bound for a specific index in order to constrain the results of find(). min() provides a way to specify lower bounds on compound key indexes.
   */
-  min(indexBounds: Document_2): Cursor;
+  min(indexBounds: Document_2): this;
   /*
   The next document in the cursor returned by the db.collection.find() method. NOTE: if the cursor is tailable with awaitData then hasNext will block until a document is returned. To check if a document is in the cursor's batch without waiting, use tryNext instead
   */
@@ -4576,19 +4583,19 @@ declare class Cursor extends AggregateOrFindCursor<ServiceProviderFindCursor> {
   /*
   Instructs the server to avoid closing a cursor automatically after a period of inactivity.
   */
-  noCursorTimeout(): Cursor;
+  noCursorTimeout(): this;
   /*
   Sets oplogReplay cursor flag to true.
   */
-  oplogReplay(): Cursor;
+  oplogReplay(): this;
   /*
   Append readPref() to a cursor to control how the client routes the query to members of the replica set.
   */
-  readPref(mode: ReadPreferenceLike, tagSet?: TagSet[], hedgeOptions?: HedgeOptions): Cursor;
+  readPref(mode: ReadPreferenceLike, tagSet?: TagSet[], hedgeOptions?: HedgeOptions): this;
   /*
   Modifies the cursor to return index keys rather than the documents.
   */
-  returnKey(enabled: boolean): Cursor;
+  returnKey(enabled: boolean): this;
   /*
   A count of the number of documents that match the db.collection.find() query after applying any cursor.skip() and cursor.limit() methods.
   */
@@ -4598,7 +4605,7 @@ declare class Cursor extends AggregateOrFindCursor<ServiceProviderFindCursor> {
   */
   tailable(opts?: {
     awaitData: boolean;
-  }): Cursor;
+  }): this;
   /*
   deprecated, non-functional
   */
@@ -4606,11 +4613,11 @@ declare class Cursor extends AggregateOrFindCursor<ServiceProviderFindCursor> {
   /*
   Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.
   */
-  showRecordId(): Cursor;
+  showRecordId(): this;
   /*
   Specify a read concern for the db.collection.find() method.
   */
-  readConcern(level: ReadConcernLevel): Cursor;
+  readConcern(level: ReadConcernLevel): this;
 }
 
 /** @public */
@@ -5633,6 +5640,7 @@ declare class ExplainableCursor_2 extends Cursor {
   _explained: any;
   constructor(mongo: Mongo, cursor: Cursor, verbosity: ExplainVerbosityLike);
   [asPrintable](): Promise<any>;
+  finish(): Promise<any>;
 }
 
 /** @public */
@@ -7294,6 +7302,7 @@ declare interface MongoDBOIDCLogEventsMap {
   }) => void;
   'mongodb-oidc-plugin:state-updated': (event: {
     updateId: number;
+    tokenSetId: string;
     timerDuration: number | undefined;
   }) => void;
   'mongodb-oidc-plugin:local-redirect-accessed': (event: {
@@ -7347,10 +7356,14 @@ declare interface MongoDBOIDCLogEventsMap {
   'mongodb-oidc-plugin:open-browser-complete': () => void;
   'mongodb-oidc-plugin:notify-device-flow': () => void;
   'mongodb-oidc-plugin:auth-attempt-started': (event: {
+    authStateId: string;
     flow: string;
   }) => void;
-  'mongodb-oidc-plugin:auth-attempt-succeeded': () => void;
+  'mongodb-oidc-plugin:auth-attempt-succeeded': (event: {
+    authStateId: string;
+  }) => void;
   'mongodb-oidc-plugin:auth-attempt-failed': (event: {
+    authStateId: string;
     error: string;
   }) => void;
   'mongodb-oidc-plugin:refresh-skipped': (event: {
@@ -7372,12 +7385,15 @@ declare interface MongoDBOIDCLogEventsMap {
     refreshToken: string | null;
   }) => void;
   'mongodb-oidc-plugin:skip-auth-attempt': (event: {
+    authStateId: string;
     reason: string;
   }) => void;
   'mongodb-oidc-plugin:auth-failed': (event: {
+    authStateId: string;
     error: string;
   }) => void;
   'mongodb-oidc-plugin:auth-succeeded': (event: {
+    authStateId: string;
     tokenType: string | null;
     refreshToken: string | null;
     expiresAt: string | null;
@@ -7387,6 +7403,30 @@ declare interface MongoDBOIDCLogEventsMap {
       idToken: string | undefined;
       refreshToken: string | undefined;
     };
+    forceRefreshOrReauth: boolean;
+    willRetryWithForceRefreshOrReauth: boolean;
+    tokenSetId: string;
+  }) => void;
+  'mongodb-oidc-plugin:request-token-started': (event: {
+    authStateId: string;
+    isCurrentAuthAttemptSet: boolean;
+    tokenSetId: string | undefined;
+    username: string | undefined;
+    issuer: string;
+    clientId: string;
+    requestScopes: string[] | undefined;
+  }) => void;
+  'mongodb-oidc-plugin:request-token-ended': (event: {
+    authStateId: string;
+    isCurrentAuthAttemptSet: boolean;
+    tokenSetId: string | undefined;
+    username: string | undefined;
+    issuer: string;
+    clientId: string;
+    requestScopes: string[] | undefined;
+  }) => void;
+  'mongodb-oidc-plugin:discarding-token-set': (event: {
+    tokenSetId: string;
   }) => void;
   'mongodb-oidc-plugin:destroyed': () => void;
   'mongodb-oidc-plugin:missing-id-token': () => void;

package/lib/api-raw.d.ts

@@ -2925,6 +2925,10 @@ declare class Collection<M extends GenericServerSideSchema = GenericServerSideSc
     getShardVersion(): Promise<Document_2>;
     _getShardedCollectionInfo(config: DatabaseWithSchema<M, D>, collStats: Document_2[]): Promise<Document_2>;
     getShardDistribution(): Promise<CommandResult<GetShardDistributionResult>>;
+    getShardLocation(): Promise<{
+        shards: string[];
+        sharded: boolean;
+    }>;
     watch(pipeline?: Document_2[] | ChangeStreamOptions, options?: ChangeStreamOptions): Promise<ChangeStreamCursor>;
     hideIndex(index: string | Document_2): Promise<Document_2>;
     unhideIndex(index: string | Document_2): Promise<Document_2>;
@@ -4242,30 +4246,30 @@ declare class Cursor extends AggregateOrFindCursor<ServiceProviderFindCursor> {
     constructor(mongo: Mongo, cursor: ServiceProviderFindCursor);
     toJSON(): void;
     private _addFlag;
-    addOption(optionFlagNumber: number): Cursor;
-    allowDiskUse(allow?: boolean): Cursor;
-    allowPartialResults(): Cursor;
-    collation(spec: CollationOptions): Cursor;
-    comment(cmt: string): Cursor;
+    addOption(optionFlagNumber: number): this;
+    allowDiskUse(allow?: boolean): this;
+    allowPartialResults(): this;
+    collation(spec: CollationOptions): this;
+    comment(cmt: string): this;
     count(): Promise<number>;
     hasNext(): Promise<boolean>;
-    hint(index: string): Cursor;
-    limit(value: number): Cursor;
-    max(indexBounds: Document_2): Cursor;
-    maxAwaitTimeMS(value: number): Cursor;
-    min(indexBounds: Document_2): Cursor;
+    hint(index: string): this;
+    limit(value: number): this;
+    max(indexBounds: Document_2): this;
+    maxAwaitTimeMS(value: number): this;
+    min(indexBounds: Document_2): this;
     next(): Promise<Document_2 | null>;
-    noCursorTimeout(): Cursor;
-    oplogReplay(): Cursor;
-    readPref(mode: ReadPreferenceLike, tagSet?: TagSet[], hedgeOptions?: HedgeOptions): Cursor;
-    returnKey(enabled: boolean): Cursor;
+    noCursorTimeout(): this;
+    oplogReplay(): this;
+    readPref(mode: ReadPreferenceLike, tagSet?: TagSet[], hedgeOptions?: HedgeOptions): this;
+    returnKey(enabled: boolean): this;
     size(): Promise<number>;
     tailable(opts?: {
         awaitData: boolean;
-    }): Cursor;
+    }): this;
     maxScan(): void;
-    showRecordId(): Cursor;
-    readConcern(level: ReadConcernLevel): Cursor;
+    showRecordId(): this;
+    readConcern(level: ReadConcernLevel): this;
 }
 
 /** @public */
@@ -5039,6 +5043,7 @@ declare class ExplainableCursor_2 extends Cursor {
     _explained: any;
     constructor(mongo: Mongo, cursor: Cursor, verbosity: ExplainVerbosityLike);
     [asPrintable](): Promise<any>;
+    finish(): Promise<any>;
 }
 
 /** @public */
@@ -6615,6 +6620,7 @@ declare interface MongoDBOIDCLogEventsMap {
     }) => void;
     'mongodb-oidc-plugin:state-updated': (event: {
         updateId: number;
+        tokenSetId: string;
         timerDuration: number | undefined;
     }) => void;
     'mongodb-oidc-plugin:local-redirect-accessed': (event: {
@@ -6668,10 +6674,14 @@ declare interface MongoDBOIDCLogEventsMap {
     'mongodb-oidc-plugin:open-browser-complete': () => void;
     'mongodb-oidc-plugin:notify-device-flow': () => void;
     'mongodb-oidc-plugin:auth-attempt-started': (event: {
+        authStateId: string;
         flow: string;
     }) => void;
-    'mongodb-oidc-plugin:auth-attempt-succeeded': () => void;
+    'mongodb-oidc-plugin:auth-attempt-succeeded': (event: {
+        authStateId: string;
+    }) => void;
     'mongodb-oidc-plugin:auth-attempt-failed': (event: {
+        authStateId: string;
         error: string;
     }) => void;
     'mongodb-oidc-plugin:refresh-skipped': (event: {
@@ -6693,12 +6703,15 @@ declare interface MongoDBOIDCLogEventsMap {
         refreshToken: string | null;
     }) => void;
     'mongodb-oidc-plugin:skip-auth-attempt': (event: {
+        authStateId: string;
         reason: string;
     }) => void;
     'mongodb-oidc-plugin:auth-failed': (event: {
+        authStateId: string;
         error: string;
     }) => void;
     'mongodb-oidc-plugin:auth-succeeded': (event: {
+        authStateId: string;
         tokenType: string | null;
         refreshToken: string | null;
         expiresAt: string | null;
@@ -6708,6 +6721,30 @@ declare interface MongoDBOIDCLogEventsMap {
             idToken: string | undefined;
             refreshToken: string | undefined;
         };
+        forceRefreshOrReauth: boolean;
+        willRetryWithForceRefreshOrReauth: boolean;
+        tokenSetId: string;
+    }) => void;
+    'mongodb-oidc-plugin:request-token-started': (event: {
+        authStateId: string;
+        isCurrentAuthAttemptSet: boolean;
+        tokenSetId: string | undefined;
+        username: string | undefined;
+        issuer: string;
+        clientId: string;
+        requestScopes: string[] | undefined;
+    }) => void;
+    'mongodb-oidc-plugin:request-token-ended': (event: {
+        authStateId: string;
+        isCurrentAuthAttemptSet: boolean;
+        tokenSetId: string | undefined;
+        username: string | undefined;
+        issuer: string;
+        clientId: string;
+        requestScopes: string[] | undefined;
+    }) => void;
+    'mongodb-oidc-plugin:discarding-token-set': (event: {
+        tokenSetId: string;
     }) => void;
     'mongodb-oidc-plugin:destroyed': () => void;
     'mongodb-oidc-plugin:missing-id-token': () => void;

package/lib/collection.d.ts

@@ -92,6 +92,10 @@ export declare class Collection<M extends GenericServerSideSchema = GenericServe
     getShardVersion(): Promise<Document>;
     _getShardedCollectionInfo(config: DatabaseWithSchema<M, D>, collStats: Document[]): Promise<Document>;
     getShardDistribution(): Promise<CommandResult<GetShardDistributionResult>>;
+    getShardLocation(): Promise<{
+        shards: string[];
+        sharded: boolean;
+    }>;
     watch(pipeline?: Document[] | ChangeStreamOptions, options?: ChangeStreamOptions): Promise<ChangeStreamCursor>;
     hideIndex(index: string | Document): Promise<Document>;
     unhideIndex(index: string | Document): Promise<Document>;

package/lib/collection.js

@@ -114,6 +114,7 @@ let Collection = (() => {
     let _validate_decorators;
     let _getShardVersion_decorators;
     let _getShardDistribution_decorators;
+    let _getShardLocation_decorators;
     let _watch_decorators;
     let _hideIndex_decorators;
     let _unhideIndex_decorators;
@@ -1059,6 +1060,35 @@ let Collection = (() => {
             result.Totals = totalValue;
             return new index_1.CommandResult('StatsResult', result);
         }
+        async getShardLocation() {
+            this._emitCollectionApiCall('getShardLocation', {});
+            const result = await (await this._database.aggregate([
+                {
+                    $listClusterCatalog: {
+                        shards: true,
+                    },
+                },
+                {
+                    $match: {
+                        ns: this.getFullName(),
+                    },
+                },
+                {
+                    $project: {
+                        _id: 0,
+                        shards: 1,
+                        sharded: 1,
+                    },
+                },
+            ])).toArray();
+            if (result.length > 0) {
+                return {
+                    shards: result[0].shards,
+                    sharded: result[0].sharded,
+                };
+            }
+            throw new errors_1.MongoshRuntimeError(`Error finding location information for ${this.getFullName()}`, errors_1.CommonErrors.CommandFailed);
+        }
         async watch(pipeline = [], options = {}) {
             if (!Array.isArray(pipeline)) {
                 options = pipeline;
@@ -1244,6 +1274,7 @@ let Collection = (() => {
         _validate_decorators = [decorators_1.returnsPromise, (0, decorators_1.apiVersions)([])];
         _getShardVersion_decorators = [decorators_1.returnsPromise, (0, decorators_1.topologies)([enums_1.Topologies.Sharded]), (0, decorators_1.apiVersions)([])];
         _getShardDistribution_decorators = [decorators_1.returnsPromise, (0, decorators_1.topologies)([enums_1.Topologies.Sharded]), (0, decorators_1.apiVersions)([])];
+        _getShardLocation_decorators = [decorators_1.returnsPromise, (0, decorators_1.topologies)([enums_1.Topologies.Sharded]), (0, decorators_1.apiVersions)([]), (0, decorators_1.serverVersions)(['8.0.10', enums_1.ServerVersions.latest])];
         _watch_decorators = [(0, decorators_1.serverVersions)(['3.1.0', enums_1.ServerVersions.latest]), (0, decorators_1.topologies)([enums_1.Topologies.ReplSet, enums_1.Topologies.Sharded]), (0, decorators_1.apiVersions)([1]), decorators_1.returnsPromise];
         _hideIndex_decorators = [(0, decorators_1.serverVersions)(['4.4.0', enums_1.ServerVersions.latest]), decorators_1.returnsPromise, (0, decorators_1.apiVersions)([1])];
         _unhideIndex_decorators = [(0, decorators_1.serverVersions)(['4.4.0', enums_1.ServerVersions.latest]), decorators_1.returnsPromise, (0, decorators_1.apiVersions)([1])];
@@ -1310,6 +1341,7 @@ let Collection = (() => {
         __esDecorate(_classThis, null, _validate_decorators, { kind: "method", name: "validate", static: false, private: false, access: { has: obj => "validate" in obj, get: obj => obj.validate }, metadata: _metadata }, null, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _getShardVersion_decorators, { kind: "method", name: "getShardVersion", static: false, private: false, access: { has: obj => "getShardVersion" in obj, get: obj => obj.getShardVersion }, metadata: _metadata }, null, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _getShardDistribution_decorators, { kind: "method", name: "getShardDistribution", static: false, private: false, access: { has: obj => "getShardDistribution" in obj, get: obj => obj.getShardDistribution }, metadata: _metadata }, null, _instanceExtraInitializers);
+        __esDecorate(_classThis, null, _getShardLocation_decorators, { kind: "method", name: "getShardLocation", static: false, private: false, access: { has: obj => "getShardLocation" in obj, get: obj => obj.getShardLocation }, metadata: _metadata }, null, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _watch_decorators, { kind: "method", name: "watch", static: false, private: false, access: { has: obj => "watch" in obj, get: obj => obj.watch }, metadata: _metadata }, null, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _hideIndex_decorators, { kind: "method", name: "hideIndex", static: false, private: false, access: { has: obj => "hideIndex" in obj, get: obj => obj.hideIndex }, metadata: _metadata }, null, _instanceExtraInitializers);
         __esDecorate(_classThis, null, _unhideIndex_decorators, { kind: "method", name: "unhideIndex", static: false, private: false, access: { has: obj => "unhideIndex" in obj, get: obj => obj.unhideIndex }, metadata: _metadata }, null, _instanceExtraInitializers);