@qp-mongosh/service-provider-core 0.0.0-dev.3 → 0.0.0-dev.8

package/src/admin.ts

@@ -1,119 +1,119 @@
-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;
-}
+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;
+}

package/src/all-fle-types.ts

@@ -1,17 +1,17 @@
-export type {
-  AWSEncryptionKeyOptions,
-  AzureEncryptionKeyOptions,
-  GCPEncryptionKeyOptions,
-  ClientEncryption,
-  ClientEncryptionCreateDataKeyCallback,
-  ClientEncryptionCreateDataKeyProviderOptions,
-  ClientEncryptionDataKeyProvider,
-  ClientEncryptionDecryptCallback,
-  ClientEncryptionEncryptCallback,
-  ClientEncryptionEncryptOptions,
-  ClientEncryptionOptions,
-  ClientEncryptionTlsOptions,
-  KMSProviders
-} from 'mongodb-client-encryption';
-
-export type FLE = typeof import('mongodb-client-encryption');
+export type {
+  AWSEncryptionKeyOptions,
+  AzureEncryptionKeyOptions,
+  GCPEncryptionKeyOptions,
+  ClientEncryption,
+  ClientEncryptionCreateDataKeyCallback,
+  ClientEncryptionCreateDataKeyProviderOptions,
+  ClientEncryptionDataKeyProvider,
+  ClientEncryptionDecryptCallback,
+  ClientEncryptionEncryptCallback,
+  ClientEncryptionEncryptOptions,
+  ClientEncryptionOptions,
+  ClientEncryptionTlsOptions,
+  KMSProviders
+} from 'mongodb-client-encryption';
+
+export type FLE = typeof import('mongodb-client-encryption');

package/src/all-transport-types.ts

@@ -1,80 +1,80 @@
-export type {
-  AggregateOptions,
-  AggregationCursor,
-  AnyBulkWriteOperation,
-  Batch,
-  BulkResult,
-  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,
-  MapReduceOptions,
-  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 // mostly for testing
-} from 'qp-mongodb';
+export type {
+  AggregateOptions,
+  AggregationCursor,
+  AnyBulkWriteOperation,
+  Batch,
+  BulkResult,
+  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,
+  MapReduceOptions,
+  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 // mostly for testing
+} from 'qp-mongodb';

package/src/cli-options.ts

@@ -1,49 +1,49 @@
-/**
- * Valid options that can be parsed from the command line.
- */
-export default interface CliOptions {
-  // Positional arguments:
-  connectionSpecifier?: string;
-  fileNames?: string[];
-
-  // Non-positional arguments:
-  apiDeprecationErrors?: boolean;
-  apiStrict?: boolean;
-  apiVersion?: string;
-  authenticationDatabase?: string;
-  authenticationMechanism?: string;
-  awsAccessKeyId?: string;
-  awsIamSessionToken?: string;
-  awsSecretAccessKey?: string;
-  awsSessionToken?: string;
-  db?: string;
-  eval?: string;
-  gssapiServiceName?: string;
-  sspiHostnameCanonicalization?: string;
-  sspiRealmOverride?: string;
-  help?: boolean;
-  host?: string;
-  ipv6?: boolean;
-  keyVaultNamespace?: string;
-  kmsURL?: string;
-  nodb?: boolean;
-  norc?: boolean;
-  password?: string;
-  port?: string;
-  quiet?: boolean;
-  retryWrites?: boolean;
-  shell?: boolean;
-  tls?: boolean;
-  tlsAllowInvalidCertificates?: boolean;
-  tlsAllowInvalidHostnames?: boolean;
-  tlsCAFile?: string;
-  tlsCertificateKeyFile?: string;
-  tlsCertificateKeyFilePassword?: string;
-  tlsCertificateSelector?: string;
-  tlsCRLFile?: string;
-  tlsDisabledProtocols?: boolean;
-  tlsFIPSMode?: boolean;
-  username?: string;
-  verbose?: boolean;
-  version?: boolean;
-}
+/**
+ * Valid options that can be parsed from the command line.
+ */
+export default interface CliOptions {
+  // Positional arguments:
+  connectionSpecifier?: string;
+  fileNames?: string[];
+
+  // Non-positional arguments:
+  apiDeprecationErrors?: boolean;
+  apiStrict?: boolean;
+  apiVersion?: string;
+  authenticationDatabase?: string;
+  authenticationMechanism?: string;
+  awsAccessKeyId?: string;
+  awsIamSessionToken?: string;
+  awsSecretAccessKey?: string;
+  awsSessionToken?: string;
+  db?: string;
+  eval?: string;
+  gssapiServiceName?: string;
+  sspiHostnameCanonicalization?: string;
+  sspiRealmOverride?: string;
+  help?: boolean;
+  host?: string;
+  ipv6?: boolean;
+  keyVaultNamespace?: string;
+  kmsURL?: string;
+  nodb?: boolean;
+  norc?: boolean;
+  password?: string;
+  port?: string;
+  quiet?: boolean;
+  retryWrites?: boolean;
+  shell?: boolean;
+  tls?: boolean;
+  tlsAllowInvalidCertificates?: boolean;
+  tlsAllowInvalidHostnames?: boolean;
+  tlsCAFile?: string;
+  tlsCertificateKeyFile?: string;
+  tlsCertificateKeyFilePassword?: string;
+  tlsCertificateSelector?: string;
+  tlsCRLFile?: string;
+  tlsDisabledProtocols?: boolean;
+  tlsFIPSMode?: boolean;
+  username?: string;
+  verbose?: boolean;
+  version?: boolean;
+}

package/src/closable.ts

@@ -1,14 +1,14 @@
-export default interface Closable {
-  /**
-   * Close the connection.
-   *
-   * @param {boolean} force - Whether to force close.
-   */
-  close(force: boolean): Promise<void>;
-
-  /**
-   * Suspends the connection, i.e. temporarily force-closes it
-   * and returns a function that will re-open the connection.
-   */
-  suspend(): Promise<() => Promise<void>>;
-}
+export default interface Closable {
+  /**
+   * Close the connection.
+   *
+   * @param {boolean} force - Whether to force close.
+   */
+  close(force: boolean): Promise<void>;
+
+  /**
+   * Suspends the connection, i.e. temporarily force-closes it
+   * and returns a function that will re-open the connection.
+   */
+  suspend(): Promise<() => Promise<void>>;
+}