@mongosh/shell-api 3.22.0 → 3.24.0

package/lib/api-processed.d.ts

@@ -3,26 +3,20 @@
 import type { Agent } from 'https';
 import type { AgentConnectOpts } from 'agent-base';
 import { Binary } from 'bson';
+import type { BSON } from '@mongosh/shell-bson';
 import { BSONRegExp } from 'bson';
-import { BSONSymbol } from 'bson';
 import { BSONType } from 'bson';
-import { calculateObjectSize } from 'bson';
 import type { ClientRequest } from 'http';
-import { Code } from 'bson';
 import type { ConnectionOptions } from 'tls';
-import { DBRef } from 'bson';
 import { Decimal128 } from 'bson';
 import type { DeserializeOptions } from 'bson';
 import { Document as Document_2 } from 'bson';
 import { Double } from 'bson';
 import type { Duplex } from 'stream';
-import { EJSONOptions } from 'bson';
 import { EventEmitter } from 'events';
 import type { IncomingMessage } from 'http';
 import { Int32 } from 'bson';
 import { Long } from 'bson';
-import { MaxKey } from 'bson';
-import { MinKey } from 'bson';
 import { ObjectId } from 'bson';
 import type { ObjectIdLike } from 'bson';
 import { Readable } from 'stream';
@@ -30,6 +24,7 @@ import type { RequestOptions } from 'https';
 import type { SecureContextOptions } from 'tls';
 import type { SerializeOptions } from 'bson';
 import type { ServerResponse } from 'http';
+import { ShellBson } from '@mongosh/shell-bson';
 import type { SrvRecord } from 'dns';
 import type { TcpNetConnectOpts } from 'net';
 import { Timestamp } from 'bson';
@@ -253,32 +248,6 @@ declare abstract class AbstractCursor<TSchema = any, CursorEvents extends Abstra
   /* Excluded from this release type: transformDocument */
   /* Excluded from this release type: throwIfInitialized */
 }
-declare abstract class AbstractCursor_2<CursorType extends ServiceProviderAggregationCursor | ServiceProviderFindCursor | ServiceProviderRunCommandCursor> extends ShellApiWithMongoClass {
-  _mongo: Mongo;
-  _cursor: CursorType;
-  _transform: ((doc: any) => any) | null;
-  _currentIterationResult: CursorIterationResult | null;
-  constructor(mongo: Mongo, cursor: CursorType);
-  [asPrintable](): Promise<CursorIterationResult>;
-  _it(): Promise<CursorIterationResult>;
-  batchSize(size: number): this;
-  close(): Promise<void>;
-  forEach(f: (doc: Document_2) => void | boolean | Promise<void> | Promise<boolean>): Promise<void>;
-  hasNext(): Promise<boolean>;
-  tryNext(): Promise<Document_2 | null>;
-  _tryNext(): Promise<Document_2 | null>;
-  _canDelegateIterationToUnderlyingCursor(): boolean;
-  [Symbol.asyncIterator](): AsyncGenerator<Document_2, void, void>;
-  isClosed(): boolean;
-  isExhausted(): boolean;
-  itcount(): Promise<number>;
-  toArray(): Promise<Document_2[]>;
-  pretty(): this;
-  map(f: (doc: Document_2) => Document_2): this;
-  maxTimeMS(value: number): this;
-  next(): Promise<Document_2 | null>;
-  objsLeftInBatch(): number;
-}
 
 /** @public */
 declare type AbstractCursorEvents = {
@@ -362,6 +331,16 @@ declare interface AbstractCursorOptions extends BSONSerializeOptions {
   timeoutMode?: CursorTimeoutMode;
   /* Excluded from this release type: timeoutContext */
 }
+declare abstract class AbstractFiniteCursor<CursorType extends ServiceProviderAggregationCursor | ServiceProviderFindCursor | ServiceProviderRunCommandCursor> extends BaseCursor<CursorType> {
+  _currentIterationResult: CursorIterationResult | null;
+  constructor(mongo: Mongo, cursor: CursorType);
+  [asPrintable](): Promise<CursorIterationResult | string>;
+  _it(): Promise<CursorIterationResult>;
+  batchSize(size: number): this;
+  toArray(): Promise<Document_2[]>;
+  maxTimeMS(value: number): this;
+  objsLeftInBatch(): number;
+}
 
 /** @public */
 declare type AcceptedFields<TSchema, FieldType, AssignableType> = { readonly [key in KeysOfAType<TSchema, FieldType>]?: AssignableType };
@@ -470,7 +449,8 @@ declare class Admin {
 declare interface Admin_2 {
   platform: ReplPlatform;
   initialDb: string;
-  bsonLibrary: typeof bson;
+  bsonLibrary: BSON;
+  computeLegacyHexMD5?(str: string): Promise<string>;
   listDatabases(database: string, options?: ListDatabasesOptions): Promise<Document_2>;
   getNewConnection(uri: string, options: MongoClientOptions): Promise<any>;
   getURI(): string | undefined;
@@ -532,7 +512,7 @@ declare interface AggregateOptions extends Omit<CommandOperationOptions, 'explai
   explain?: ExplainOptions['explain'];
   /* Excluded from this release type: timeoutMode */
 }
-declare abstract class AggregateOrFindCursor<CursorType extends ServiceProviderAggregationCursor | ServiceProviderFindCursor> extends AbstractCursor_2<CursorType> {
+declare abstract class AggregateOrFindCursor<CursorType extends ServiceProviderAggregationCursor | ServiceProviderFindCursor> extends AbstractFiniteCursor<CursorType> {
   projection(spec: Document_2): this;
   skip(value: number): this;
   sort(spec: Document_2): this;
@@ -1043,6 +1023,32 @@ declare type AzureKMSProviderConfiguration = {
    */
   accessToken: string;
 };
+declare abstract class BaseCursor<CursorType extends ServiceProviderBaseCursor> extends ShellApiWithMongoClass {
+  _mongo: Mongo;
+  _cursor: CursorType;
+  _transform: ((doc: any) => any) | null;
+  _blockingWarningDisabled: boolean;
+  constructor(mongo: Mongo, cursor: CursorType);
+  close(): Promise<void>;
+  forEach(f: (doc: Document_2) => void | boolean | Promise<void> | Promise<boolean>): Promise<void>;
+  hasNext(): Promise<boolean>;
+  tryNext(): Promise<Document_2 | null>;
+  _tryNext(): Promise<Document_2 | null>;
+  _canDelegateIterationToUnderlyingCursor(): boolean;
+  [Symbol.asyncIterator](): AsyncGenerator<Document_2, void, void>;
+  isClosed(): boolean;
+  isExhausted(): boolean;
+  itcount(): Promise<number>;
+  pretty(): this;
+  map(f: (doc: Document_2) => Document_2): this;
+  next(): Promise<Document_2 | null>;
+  disableBlockWarnings(): this;
+  abstract batchSize(size: number): this;
+  abstract toArray(): Promise<Document_2[]>;
+  abstract maxTimeMS(value: number): this;
+  abstract objsLeftInBatch(): number;
+  abstract _it(): Promise<CursorIterationResult>;
+}
 declare interface BaseSocks5RequestMetadata {
   srcAddr: string;
   srcPort: number;
@@ -1079,28 +1085,6 @@ declare type BatchType = (typeof BatchType)[keyof typeof BatchType];
 
 /** @public */
 declare type BitwiseFilter = number /** numeric bit mask */ | Binary /** BinData bit mask */ | ReadonlyArray<number>;
-declare const bson: {
-  ObjectId: typeof ObjectId;
-  DBRef: typeof DBRef;
-  MaxKey: typeof MaxKey;
-  MinKey: typeof MinKey;
-  Timestamp: typeof Timestamp;
-  BSONSymbol: typeof BSONSymbol;
-  Code: typeof Code;
-  Decimal128: typeof Decimal128;
-  Int32: typeof Int32;
-  Long: typeof Long;
-  Binary: typeof Binary;
-  calculateObjectSize: typeof calculateObjectSize;
-  Double: typeof Double;
-  EJSON: {
-    parse: (text: string, options?: EJSONOptions) => any;
-    stringify: (value: any, replacer?: (number | string)[] | ((this: any, key: string, value: any) => any) | EJSONOptions, space?: string | number, options?: EJSONOptions) => string;
-    serialize: (value: any, options?: EJSONOptions) => Document_2;
-    deserialize: (ejson: Document_2, options?: EJSONOptions) => any;
-  };
-  BSONRegExp: typeof BSONRegExp;
-};
 
 /**
  * BSON Serialization options.
@@ -1532,18 +1516,12 @@ declare interface ChangeStreamCreateIndexDocument extends ChangeStreamDocumentCo
   /** Describes the type of operation represented in this change notification */
   operationType: 'createIndexes';
 }
-declare class ChangeStreamCursor extends ShellApiWithMongoClass {
-  _mongo: Mongo;
-  _cursor: ServiceProviderChangeStream<Document_2>;
+declare class ChangeStreamCursor extends BaseCursor<ServiceProviderChangeStream> {
   _currentIterationResult: CursorIterationResult | null;
   _on: string;
-  constructor(cursor: ServiceProviderChangeStream<Document_2>, on: string, mongo: Mongo);
+  constructor(cursor: ServiceProviderChangeStream, on: string, mongo: Mongo);
   _it(): Promise<CursorIterationResult>;
-  [asPrintable](): string;
-  /*
-  Instructs the server to close a cursor and free associated server resources.
-  */
-  close(): void;
+  [asPrintable](): Promise<string>;
   /*
   WARNING: on change streams this method will block unless the cursor is closed. Use tryNext to check if there are any documents in the batch. This is a breaking change
   */
@@ -1552,20 +1530,11 @@ declare class ChangeStreamCursor extends ShellApiWithMongoClass {
   If there is a document in the change stream, it will be returned. Otherwise returns null.
   */
   tryNext(): Document_2 | null;
-  [Symbol.asyncIterator](): AsyncGenerator<Document_2, void, unknown>;
-  /*
-  Returns true if the cursor is closed
-  */
-  isClosed(): boolean;
   /*
   This method is deprecated because because after closing a cursor, the remaining documents in the batch are no longer accessible. If you want to see if the cursor is closed use cursor.isClosed. If you want to see if there are documents left in the batch, use cursor.tryNext. This is a breaking change
   */
   isExhausted(): never;
   /*
-  Returns the number of documents in the current batch. NOTE: this method exhausts the cursor batch
-  */
-  itcount(): number;
-  /*
   WARNING: on change streams this method will block unless the cursor is closed. Use tryNext to get the next document in the batch. This is a breaking change
   */
   next(): Document_2;
@@ -1573,11 +1542,16 @@ declare class ChangeStreamCursor extends ShellApiWithMongoClass {
   Returns the ResumeToken of the change stream
   */
   getResumeToken(): ResumeToken;
-  map(): ChangeStreamCursor;
-  forEach(): Promise<void>;
-  toArray(): Promise<Document_2[]>;
-  objsLeftInBatch(): void;
-  pretty(): ChangeStreamCursor;
+  toArray(): never;
+  /*
+  Not available on change streams
+  */
+  batchSize(): never;
+  objsLeftInBatch(): never;
+  /*
+  Not available on change streams
+  */
+  maxTimeMS(): never;
 }
 
 /**
@@ -6265,26 +6239,6 @@ declare interface HedgeOptions {
   /** Explicitly enable or disable hedged reads. */
   enabled?: boolean;
 }
-declare class Help {
-  private help;
-  private docs;
-  private attr;
-  constructor(properties: HelpProperties, options?: HelpOptions);
-  [asPrintable](): HelpProperties;
-  get [shellApiType](): string;
-}
-declare type HelpOptions = {
-  translate(key: string): string | undefined;
-};
-declare type HelpProperties = {
-  help: string;
-  docs?: string;
-  attr?: HelpPropertiesAttr[];
-};
-declare type HelpPropertiesAttr = {
-  name?: string;
-  description: string;
-};
 
 /** @public */
 declare type Hint = string | Document_2;
@@ -6941,7 +6895,6 @@ declare interface LogComponentSeveritiesClientOptions {
   /** Optional default severity level to be used if any of the above are unset */
   default?: SeverityLevel;
 }
-declare type LongWithoutAccidentallyExposedMethods = Omit<typeof bson.Long, 'fromExtendedJSON'>;
 declare type MapReduceShellOptions = Document_2 | string;
 declare type MasterKey = AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions;
 
@@ -6997,7 +6950,7 @@ export declare class Mongo<M extends GenericServerSideSchema = GenericServerSide
   _listDatabases(opts?: ListDatabasesOptions): Promise<{
     databases: {
       name: string;
-      sizeOnDisk: number | ShellBson['Long'];
+      sizeOnDisk: number | BSON['Long']['prototype'];
       empty: boolean;
     }[];
     ok: 1;
@@ -7009,7 +6962,7 @@ export declare class Mongo<M extends GenericServerSideSchema = GenericServerSide
   getDBs(options?: ListDatabasesOptions): {
     databases: {
       name: string;
-      sizeOnDisk: number | ShellBson['Long'];
+      sizeOnDisk: number | BSON['Long']['prototype'];
       empty: boolean;
     }[];
     ok: 1;
@@ -7102,7 +7055,7 @@ export declare class Mongo<M extends GenericServerSideSchema = GenericServerSide
   /*
   Returns the hashed value for the input using the same hashing function as a hashed index.
   */
-  convertShardKeyToHashed(value: any): unknown;
+  convertShardKeyToHashed(value: any): ShellBson['Long']['prototype'];
 }
 
 /** @public */
@@ -7730,7 +7683,7 @@ declare interface MongoDBOIDCLogEventsMap {
   }) => void;
   'mongodb-oidc-plugin:skip-auth-attempt': (event: {
     authStateId: string;
-    reason: string;
+    reason: 'not-expired' | 'not-expired-refresh-failed' | 'refresh-succeeded';
   }) => void;
   'mongodb-oidc-plugin:auth-failed': (event: {
     authStateId: string;
@@ -8902,7 +8855,7 @@ declare class RunCommandCursor extends AbstractCursor {
   /* Excluded from this release type: _initialize */
   /* Excluded from this release type: getMore */
 }
-declare class RunCommandCursor_2 extends AbstractCursor_2<ServiceProviderRunCommandCursor> {
+declare class RunCommandCursor_2 extends AbstractFiniteCursor<ServiceProviderRunCommandCursor> {
   constructor(mongo: Mongo, cursor: ServiceProviderRunCommandCursor);
 }
 
@@ -9460,6 +9413,15 @@ export declare class Shard<M extends GenericServerSideSchema = GenericServerSide
   Disable balancing on a single collection in a sharded database. Does not affect balancing of other collections in a sharded cluster.
   */
   disableBalancing(ns: string): UpdateResult_2;
+  private _setAllowMigrations;
+  /*
+  Enables migrations for a specific collection. Uses `setAllowMigrations` admin command.
+  */
+  enableMigrations(ns: string): Document_2;
+  /*
+  Disables migrations for a specific collection. Uses `setAllowMigrations` admin command.
+  */
+  disableMigrations(ns: string): Document_2;
   /*
   Returns true when the balancer is enabled and false if the balancer is disabled. This does not reflect the current state of balancing operations: use sh.isBalancerRunning() to check the balancer’s current state.
   */
@@ -9643,7 +9605,7 @@ export declare class ShellApi extends ShellApiClass {
   /*
   result of the last line evaluated; use to further iterate
   */
-  it(): any;
+  it(): CursorIterationResult;
   /*
   Shell version
   */
@@ -9713,35 +9675,7 @@ declare interface ShellAuthOptions {
   digestPassword?: boolean;
   authDb?: string;
 }
-export declare type ShellBson = WithHelp<ShellBsonBase>;
-declare interface ShellBsonBase {
-  DBRef: (namespace: string, oid: any, db?: string, fields?: Document_2) => typeof bson.DBRef.prototype;
-  bsonsize: (object: any) => number;
-  MaxKey: () => typeof bson.MaxKey.prototype;
-  MinKey: () => typeof bson.MinKey.prototype;
-  ObjectId: (id?: string | number | typeof bson.ObjectId.prototype | Buffer) => typeof bson.ObjectId.prototype;
-  Timestamp: (t?: number | typeof bson.Long.prototype | {
-    t: number;
-    i: number;
-  }, i?: number) => typeof bson.Timestamp.prototype;
-  Code: (c?: string | Function, s?: any) => typeof bson.Code.prototype;
-  NumberDecimal: (s?: string) => typeof bson.Decimal128.prototype;
-  NumberInt: (v?: string) => typeof bson.Int32.prototype;
-  NumberLong: (s?: string | number) => typeof bson.Long.prototype;
-  ISODate: (input?: string) => Date;
-  BinData: (subtype: number, b64string: string) => Binary;
-  HexData: (subtype: number, hexstr: string) => Binary;
-  UUID: (hexstr?: string) => Binary;
-  MD5: (hexstr: string) => Binary;
-  Decimal128: typeof bson.Decimal128;
-  BSONSymbol: typeof bson.BSONSymbol;
-  Int32: typeof bson.Int32;
-  Long: LongWithoutAccidentallyExposedMethods;
-  Binary: typeof bson.Binary;
-  Double: typeof bson.Double;
-  EJSON: typeof bson.EJSON;
-  BSONRegExp: typeof bson.BSONRegExp;
-}
+export { ShellBson };
 declare interface ShellCliOptions {
   nodb?: boolean;
 }
@@ -9765,7 +9699,7 @@ declare class ShellConfig extends ShellApiClass {
   [asPrintable](): Promise<Map<keyof ShellUserConfig, ShellUserConfig[keyof ShellUserConfig]>>;
 }
 declare class ShellInstanceState {
-  currentCursor: Cursor | AggregationCursor_2 | ChangeStreamCursor | RunCommandCursor_2 | null;
+  currentCursor: BaseCursor<ServiceProviderBaseCursor> | null;
   currentDb: DatabaseWithSchema;
   messageBus: MongoshBus;
   initialServiceProvider: ServiceProvider;
@@ -9790,6 +9724,7 @@ declare class ShellInstanceState {
   private alreadyTransformedErrors;
   private preFetchCollectionAndDatabaseNames;
   constructor(initialServiceProvider: ServiceProvider, messageBus?: any, cliOptions?: ShellCliOptions);
+  private constructShellBson;
   fetchConnectionInfo(): Promise<ConnectionInfo_2 | undefined>;
   cachedConnectionInfo(): ConnectionInfo_2 | undefined;
   close(): Promise<void>;
@@ -10516,9 +10451,6 @@ declare interface ValidateCollectionOptions extends CommandOperationOptions {
 
 /** @public */
 declare type W = number | 'majority';
-declare type WithHelp<T> = { [prop in keyof T]: T[prop] & {
-  help?: () => Help;
-} };
 
 /** Add an _id field to an object shaped type @public */
 declare type WithId<TSchema> = EnhancedOmit<TSchema, '_id'> & {