@mongosh/service-provider-core 1.10.1 → 1.10.3

package/src/readable.ts

@@ -14,7 +14,7 @@ import type {
   ReadPreferenceFromOptions,
   ReadPreferenceLike,
 } from './all-transport-types';
-import { ChangeStream, ChangeStreamOptions } from './all-transport-types';
+import type { ChangeStream, ChangeStreamOptions } from './all-transport-types';
 
 /**
  * Interface for read operations in the CRUD specification.
@@ -36,7 +36,8 @@ export default interface Readable {
     collection: string,
     pipeline: Document[],
     options?: AggregateOptions,
-    dbOptions?: DbOptions): AggregationCursor;
+    dbOptions?: DbOptions
+  ): AggregationCursor;
 
   /**
    * Run an aggregation pipeline on the DB.
@@ -74,7 +75,8 @@ export default interface Readable {
     coll: string,
     query?: Document,
     options?: CountOptions,
-    dbOptions?: DbOptions): Promise<number>;
+    dbOptions?: DbOptions
+  ): Promise<number>;
 
   /**
    * Get an exact document count from the collection.
@@ -92,7 +94,8 @@ export default interface Readable {
     collection: string,
     filter?: Document,
     options?: CountDocumentsOptions,
-    dbOptions?: DbOptions): Promise<number>;
+    dbOptions?: DbOptions
+  ): Promise<number>;
 
   /**
    * Get distinct values for the field.
@@ -112,7 +115,8 @@ export default interface Readable {
     fieldName: string,
     filter?: Document,
     options?: DistinctOptions,
-    dbOptions?: DbOptions): Promise<Document>;
+    dbOptions?: DbOptions
+  ): Promise<Document>;
 
   /**
    * Get an estimated document count from the collection.
@@ -128,7 +132,8 @@ export default interface Readable {
     database: string,
     collection: string,
     options?: EstimatedDocumentCountOptions,
-    dbOptions?: DbOptions): Promise<number>;
+    dbOptions?: DbOptions
+  ): Promise<number>;
 
   /**
    * Find documents in the collection.
@@ -146,7 +151,8 @@ export default interface Readable {
     collection: string,
     filter?: Document,
     options?: FindOptions,
-    dbOptions?: DbOptions): FindCursor;
+    dbOptions?: DbOptions
+  ): FindCursor;
 
   /**
    * Get currently known topology information.
@@ -168,7 +174,8 @@ export default interface Readable {
     database: string,
     collection: string,
     options: ListIndexesOptions,
-    dbOptions?: DbOptions): Promise<Document[]>;
+    dbOptions?: DbOptions
+  ): Promise<Document[]>;
 
   /**
    * Returns an array of collection infos
@@ -184,12 +191,15 @@ export default interface Readable {
     database: string,
     filter?: Document,
     options?: ListCollectionsOptions,
-    dbOptions?: DbOptions): Promise<Document[]>;
+    dbOptions?: DbOptions
+  ): Promise<Document[]>;
 
   /**
    * Create a ReadPreference object from a set of options
    */
-  readPreferenceFromOptions(options?: Omit<ReadPreferenceFromOptions, 'session'>): ReadPreferenceLike | undefined;
+  readPreferenceFromOptions(
+    options?: Omit<ReadPreferenceFromOptions, 'session'>
+  ): ReadPreferenceLike | undefined;
 
   /**
    * Start a change stream cursor on either the client, db, or collection.
@@ -224,6 +234,6 @@ export default interface Readable {
     indexName?: string,
     // TODO(MONGOSH-1471): use ListSearchIndexesOptions once available
     options?: Document,
-    dbOptions?: DbOptions): Promise<Document[]>;
+    dbOptions?: DbOptions
+  ): Promise<Document[]>;
 }
-

package/src/service-provider.ts

@@ -1,15 +1,19 @@
 import { MongoshInternalError } from '@mongosh/errors';
-import Admin from './admin';
-import Closable from './closable';
+import type Admin from './admin';
+import type Closable from './closable';
 import makePrintableBson from './printable-bson';
-import Readable from './readable';
-import Writable from './writable';
+import type Readable from './readable';
+import type Writable from './writable';
 import type { bson as BSON } from './index';
 
 /**
  * Interface for all service providers.
  */
-export default interface ServiceProvider extends Readable, Writable, Closable, Admin {}
+export default interface ServiceProvider
+  extends Readable,
+    Writable,
+    Closable,
+    Admin {}
 
 export class ServiceProviderCore {
   public bsonLibrary: typeof BSON;

package/src/textencoder-polyfill.spec.ts

@@ -1,11 +1,13 @@
 import { textEncodingPolyfill } from './textencoder-polyfill';
 import { expect } from 'chai';
 
-describe('TextDecoder/TextEncoder polyfill', () => {
-  it('does simplistic UTF-8 encoding/decoding', () => {
+describe('TextDecoder/TextEncoder polyfill', function () {
+  it('does simplistic UTF-8 encoding/decoding', function () {
     const { TextEncoder, TextDecoder } = textEncodingPolyfill();
     // This test was written in winter.
     const str = '☃️';
-    expect(new TextDecoder().decode(new TextEncoder().encode(str))).to.equal(str);
+    expect(new TextDecoder().decode(new TextEncoder().encode(str))).to.equal(
+      str
+    );
   });
 });

package/src/textencoder-polyfill.ts

@@ -5,9 +5,11 @@
 if (
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment
   // @ts-ignore
-  typeof TextDecoder !== 'function' || typeof TextEncoder !== 'function'
+  typeof TextDecoder !== 'function' ||
+  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+  // @ts-ignore
+  typeof TextEncoder !== 'function'
 ) {
-  // eslint-disable-next-line no-new-func
   Object.assign(Function('return this')(), textEncodingPolyfill());
 }
 

package/src/writable.ts

@@ -1,4 +1,4 @@
-import { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
+import type { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
 import type {
   Document,
   InsertOneOptions,
@@ -23,14 +23,13 @@ import type {
   RunCommandOptions,
   DbOptions,
   OrderedBulkOperation,
-  UnorderedBulkOperation
+  UnorderedBulkOperation,
 } from './all-transport-types';
 
 /**
  * Interface for write operations in the CRUD specification.
  */
 export default interface Writable {
-
   /**
    * @param {String} db - the db name
    * @param spec
@@ -104,7 +103,8 @@ export default interface Writable {
     collection: string,
     requests: AnyBulkWriteOperation[],
     options: BulkWriteOptions,
-    dbOptions?: DbOptions): Promise<BulkWriteResult>;
+    dbOptions?: DbOptions
+  ): Promise<BulkWriteResult>;
 
   /**
    * Delete multiple documents from the collection.
@@ -122,7 +122,8 @@ export default interface Writable {
     collection: string,
     filter: Document,
     options: DeleteOptions,
-    dbOptions?: DbOptions): Promise<DeleteResult>;
+    dbOptions?: DbOptions
+  ): Promise<DeleteResult>;
 
   /**
    * Delete one document from the collection.
@@ -140,7 +141,8 @@ export default interface Writable {
     collection: string,
     filter: Document,
     options: DeleteOptions,
-    dbOptions?: DbOptions): Promise<DeleteResult>;
+    dbOptions?: DbOptions
+  ): Promise<DeleteResult>;
 
   /**
    * Find one document and delete it.
@@ -158,7 +160,8 @@ export default interface Writable {
     collection: string,
     filter: Document,
     options: FindOneAndDeleteOptions,
-    dbOptions?: DbOptions): Promise<Document>;
+    dbOptions?: DbOptions
+  ): Promise<Document>;
 
   /**
    * Find one document and replace it.
@@ -178,7 +181,8 @@ export default interface Writable {
     filter: Document,
     replacement: Document,
     options: FindOneAndReplaceOptions,
-    dbOptions?: DbOptions): Promise<Document>;
+    dbOptions?: DbOptions
+  ): Promise<Document>;
 
   /**
    * Find one document and update it.
@@ -198,7 +202,8 @@ export default interface Writable {
     filter: Document,
     update: Document | Document[],
     options: FindOneAndUpdateOptions,
-    dbOptions?: DbOptions): Promise<Document>;
+    dbOptions?: DbOptions
+  ): Promise<Document>;
 
   /**
    * Insert many documents into the colleciton.
@@ -216,7 +221,8 @@ export default interface Writable {
     collection: string,
     docs: Document[],
     options: BulkWriteOptions,
-    dbOptions?: DbOptions): Promise<InsertManyResult>;
+    dbOptions?: DbOptions
+  ): Promise<InsertManyResult>;
 
   /**
    * Insert one document into the collection.
@@ -234,7 +240,8 @@ export default interface Writable {
     collection: string,
     doc: Document,
     options: InsertOneOptions,
-    dbOptions?: DbOptions): Promise<InsertOneResult>;
+    dbOptions?: DbOptions
+  ): Promise<InsertOneResult>;
 
   /**
    * Replace a document with another.
@@ -254,7 +261,8 @@ export default interface Writable {
     filter: Document,
     replacement: Document,
     options?: ReplaceOptions,
-    dbOptions?: DbOptions): Promise<UpdateResult>;
+    dbOptions?: DbOptions
+  ): Promise<UpdateResult>;
 
   /**
    * Update many document.
@@ -274,7 +282,8 @@ export default interface Writable {
     filter: Document,
     update: Document,
     options?: UpdateOptions,
-    dbOptions?: DbOptions): Promise<UpdateResult>;
+    dbOptions?: DbOptions
+  ): Promise<UpdateResult>;
 
   /**
    * Update a document.
@@ -294,7 +303,8 @@ export default interface Writable {
     filter: Document,
     update: Document,
     options?: UpdateOptions,
-    dbOptions?: DbOptions): Promise<UpdateResult>;
+    dbOptions?: DbOptions
+  ): Promise<UpdateResult>;
 
   /**
    * Adds new indexes to a collection.
@@ -311,7 +321,8 @@ export default interface Writable {
     collection: string,
     indexSpecs: Document[],
     options?: CreateIndexesOptions,
-    dbOptions?: DbOptions): Promise<string[]>;
+    dbOptions?: DbOptions
+  ): Promise<string[]>;
 
   /**
    * Drops a collection.
@@ -342,7 +353,8 @@ export default interface Writable {
     oldName: string,
     newName: string,
     options?: RenameOptions,
-    dbOptions?: DbOptions): Promise<Collection>;
+    dbOptions?: DbOptions
+  ): Promise<Collection>;
 
   /**
    * Initialize a bulk operation.
@@ -368,14 +380,14 @@ export default interface Writable {
    * @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}[],
+    specs: { name: string; definition: Document }[],
     dbOptions?: DbOptions
-  ): Promise<string[]>
+  ): Promise<string[]>;
 
   /**
    * Drops a search index.
@@ -384,13 +396,13 @@ export default interface Writable {
    * @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>
+  ): Promise<void>;
 
   /**
    * Update a search index.
@@ -400,7 +412,7 @@ export default interface Writable {
    * @param {String} indexName - The index name.
    * @param {Object} description - The update.
    * @param {DbOptions} dbOptions - The database options
-  */
+   */
   updateSearchIndex(
     database: string,
     collection: string,
@@ -408,6 +420,5 @@ export default interface Writable {
     // TODO(MONGOSH-1471): use SearchIndexDescription once available
     definition: Document,
     dbOptions?: DbOptions
-  ): Promise<void>
+  ): Promise<void>;
 }
-

package/tsconfig-lint.json

@@ -0,0 +1,5 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*"],
+  "exclude": ["node_modules", "dist", "lib"]
+}

package/tsconfig.json

@@ -1,12 +1,8 @@
 {
-  "extends": "../../config/tsconfig.base.json",
+  "extends": "@mongodb-js/tsconfig-mongosh/tsconfig.common.json",
   "compilerOptions": {
     "outDir": "./lib"
   },
-  "include": [
-    "./src/**/*"
-  ],
-  "exclude": [
-    "./src/**/*.spec.*"
-  ]
+  "include": ["src/**/*"],
+  "exclude": ["./src/**/*.spec.*"]
 }

package/tsconfig.lint.json

@@ -1,8 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "include": [
-    "./src/**/*",
-    "./test/**/*"
-  ],
-  "exclude": []
-}