quosdolorem/packages/service-provider-core/src/admin.ts

The MongoDB Shell

import ShellAuthOptions from './shell-auth-options';
import type {
  MongoClientOptions,
  ReadConcern,
  ReadPreference,
  WriteConcern,
  Document,
  CreateCollectionOptions,
  ClientSession,
  DbOptions,
  ClientSessionOptions,
  ListDatabasesOptions,
  AutoEncryptionOptions
} from './all-transport-types';
import type { bson as BSON } from './index';
import { ReplPlatform } from './platform';
import { FLE } from './all-fle-types';


export default interface Admin {
  /**
   * What platform (Compass/CLI/Browser)
   */
  platform: ReplPlatform;

  /**
   * The initial database
   */
  initialDb: string;

  /**
   * The BSON package
   */
  bsonLibrary: typeof BSON;

  /**
   * list databases.
   *
   * @param {String} database - The database name.
   *
   * @returns {Promise} The promise of command Documents.
   */
  listDatabases(database: string, options?: ListDatabasesOptions): Promise<Document>;

  /**
   * create a new service provider with a new connection.
   *
   * @param uri
   * @param options
   */
  getNewConnection(uri: string, options: MongoClientOptions): Promise<any>; // returns the ServiceProvider instance

  /**
   * Return the URI for the current connection, if this ServiceProvider is connected.
   */
  getURI(): string | undefined;

  /**
   * Return connection info
   */
  getConnectionInfo(): Promise<Document>;

  /**
   * Authenticate
   */
  authenticate(authDoc: ShellAuthOptions): Promise<{ ok: number }>;

  /**
   * createCollection
   */
  createCollection(
    dbName: string,
    collName: string,
    options: CreateCollectionOptions,
    dbOptions?: DbOptions): Promise<{ ok: number }>;

  /**
   * Return read preference for connection.
   */
  getReadPreference(): ReadPreference;

  /**
   * Return read concern for connection.
   */
  getReadConcern(): ReadConcern | undefined;

  /**
   * Return write concern for connection.
   */
  getWriteConcern(): WriteConcern | undefined;

  /**
   * Reset the connection to have the option specified.
   *
   * @param options
   */
  resetConnectionOptions(options: MongoClientOptions): Promise<void>;

  /**
   * Start a session.
   * @param options
   */
  startSession(options: ClientSessionOptions): ClientSession;

  /**
   * Return the raw client for use in keyVaultClient.
   */
  getRawClient(): any;

  /**
   * The FLE implementation for access to the client-side encryption API.
   */
  fle?: FLE | undefined;

  /**
   * The FLE options passed to the client, if any.
   */
  getFleOptions?: () => AutoEncryptionOptions | undefined;
}