@mongosh/service-provider-core 2.2.6 → 2.2.9

package/lib/cursors.d.ts

@@ -0,0 +1,48 @@
+import type { CollationOptions, CountOptions, CursorFlag, Document, ExplainVerbosityLike, ReadConcernLike, ReadPreferenceLike, ResumeToken } from './all-transport-types';
+interface ServiceProviderBaseCursor<TSchema = Document> {
+    close(): Promise<void>;
+    hasNext(): Promise<boolean>;
+    next(): Promise<TSchema | null>;
+    tryNext(): Promise<TSchema | null>;
+    readonly closed: boolean;
+    [Symbol.asyncIterator](): AsyncGenerator<TSchema, void, void>;
+}
+export interface ServiceProviderAbstractCursor<TSchema = Document> extends ServiceProviderBaseCursor<TSchema> {
+    batchSize(number: number): void;
+    maxTimeMS(value: number): void;
+    bufferedCount(): number;
+    readBufferedDocuments(number?: number): TSchema[];
+    toArray(): Promise<TSchema[]>;
+}
+export interface ServiceProviderAggregationOrFindCursor<TSchema = Document> extends ServiceProviderAbstractCursor<TSchema> {
+    project($project: Document): void;
+    skip($skip: number): void;
+    sort($sort: Document): void;
+    explain(verbosity?: ExplainVerbosityLike): Promise<Document>;
+    addCursorFlag(flag: CursorFlag, value: boolean): void;
+    withReadPreference(readPreference: ReadPreferenceLike): this;
+    withReadConcern(readConcern: ReadConcernLike): this;
+}
+export interface ServiceProviderRunCommandCursor<TSchema = Document> extends ServiceProviderAbstractCursor<TSchema> {
+}
+export interface ServiceProviderFindCursor<TSchema = Document> extends ServiceProviderAggregationOrFindCursor<TSchema> {
+    allowDiskUse(allow?: boolean): void;
+    collation(value: CollationOptions): void;
+    comment(value: string): void;
+    maxAwaitTimeMS(value: number): void;
+    count(options?: CountOptions): Promise<number>;
+    hint(hint: string | Document): void;
+    max(max: Document): void;
+    min(min: Document): void;
+    limit(value: number): void;
+    skip(value: number): void;
+    returnKey(value: boolean): void;
+    showRecordId(value: boolean): void;
+}
+export interface ServiceProviderAggregationCursor<TSchema = Document> extends ServiceProviderAggregationOrFindCursor<TSchema> {
+}
+export interface ServiceProviderChangeStream<TSchema = Document> extends ServiceProviderBaseCursor<TSchema> {
+    next(): Promise<TSchema>;
+    readonly resumeToken: ResumeToken;
+}
+export {};

package/lib/cursors.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=cursors.js.map

package/lib/cursors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cursors.js","sourceRoot":"","sources":["../src/cursors.ts"],"names":[],"mappings":""}

package/lib/index.d.ts

@@ -10,4 +10,5 @@ export * from './all-fle-types';
 export { MapReduceOptions, FinalizeFunction } from './map-reduce-options';
 export { CreateEncryptedCollectionOptions, CheckMetadataConsistencyOptions, ConnectionInfo, } from './admin';
 export { bson } from './bson-export';
+export { ServiceProviderAbstractCursor, ServiceProviderAggregationCursor, ServiceProviderFindCursor, ServiceProviderRunCommandCursor, ServiceProviderChangeStream, } from './cursors';
 export { ServiceProvider, ShellAuthOptions, getConnectExtraInfo, ReplPlatform, DEFAULT_DB, ServiceProviderCore, bsonStringifiers, ConnectionExtraInfo, };

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,kCAAgC;AAChC,yDAA0E;AAyBxE,oGAzBwB,sCAAmB,OAyBxB;AAxBrB,kEAA0E;AAqBxE,8BArBK,sBAAmB,CAqBL;AAnBrB,MAAM,UAAU,GAAG,MAAM,CAAC;AAqBxB,gCAAU;AApBZ,qDAAoD;AAsBlD,iGAtBO,iCAAgB,OAsBP;AApBlB,wDAAsC;AACtC,kDAAgC;AAUhC,6CAAqC;AAA5B,mGAAA,IAAI,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA,kCAAgC;AAChC,yDAA0E;AAiCxE,oGAjCwB,sCAAmB,OAiCxB;AAhCrB,kEAA0E;AA6BxE,8BA7BK,sBAAmB,CA6BL;AA3BrB,MAAM,UAAU,GAAG,MAAM,CAAC;AA6BxB,gCAAU;AA5BZ,qDAAoD;AA8BlD,iGA9BO,iCAAgB,OA8BP;AA5BlB,wDAAsC;AACtC,kDAAgC;AAUhC,6CAAqC;AAA5B,mGAAA,IAAI,OAAA"}

package/lib/readable.d.ts

@@ -1,17 +1,18 @@
-import type { Document, AggregateOptions, CountOptions, CountDocumentsOptions, DistinctOptions, EstimatedDocumentCountOptions, FindOptions, ListCollectionsOptions, ListIndexesOptions, AggregationCursor, FindCursor, DbOptions, ReadPreferenceFromOptions, ReadPreferenceLike } from './all-transport-types';
-import type { ChangeStream, ChangeStreamOptions } from './all-transport-types';
+import type { Document, AggregateOptions, CountOptions, CountDocumentsOptions, DistinctOptions, EstimatedDocumentCountOptions, FindOptions, ListCollectionsOptions, ListIndexesOptions, DbOptions, ReadPreferenceFromOptions, ReadPreferenceLike } from './all-transport-types';
+import type { ChangeStreamOptions } from './all-transport-types';
+import type { ServiceProviderAggregationCursor, ServiceProviderChangeStream, ServiceProviderFindCursor } from './cursors';
 export default interface Readable {
-    aggregate(database: string, collection: string, pipeline: Document[], options?: AggregateOptions, dbOptions?: DbOptions): AggregationCursor;
-    aggregateDb(database: string, pipeline: Document[], options?: AggregateOptions, dbOptions?: DbOptions): AggregationCursor;
+    aggregate(database: string, collection: string, pipeline: Document[], options?: AggregateOptions, dbOptions?: DbOptions): ServiceProviderAggregationCursor;
+    aggregateDb(database: string, pipeline: Document[], options?: AggregateOptions, dbOptions?: DbOptions): ServiceProviderAggregationCursor;
     count(db: string, coll: string, query?: Document, options?: CountOptions, dbOptions?: DbOptions): Promise<number>;
     countDocuments(database: string, collection: string, filter?: Document, options?: CountDocumentsOptions, dbOptions?: DbOptions): Promise<number>;
     distinct(database: string, collection: string, fieldName: string, filter?: Document, options?: DistinctOptions, dbOptions?: DbOptions): Promise<Document>;
     estimatedDocumentCount(database: string, collection: string, options?: EstimatedDocumentCountOptions, dbOptions?: DbOptions): Promise<number>;
-    find(database: string, collection: string, filter?: Document, options?: FindOptions, dbOptions?: DbOptions): FindCursor;
+    find(database: string, collection: string, filter?: Document, options?: FindOptions, dbOptions?: DbOptions): ServiceProviderFindCursor;
     getTopology(): any;
     getIndexes(database: string, collection: string, options: ListIndexesOptions, dbOptions?: DbOptions): Promise<Document[]>;
     listCollections(database: string, filter?: Document, options?: ListCollectionsOptions, dbOptions?: DbOptions): Promise<Document[]>;
     readPreferenceFromOptions(options?: Omit<ReadPreferenceFromOptions, 'session'>): ReadPreferenceLike | undefined;
-    watch(pipeline: Document[], options: ChangeStreamOptions, dbOptions?: DbOptions, db?: string, coll?: string): ChangeStream<Document>;
+    watch(pipeline: Document[], options: ChangeStreamOptions, dbOptions?: DbOptions, db?: string, coll?: string): ServiceProviderChangeStream;
     getSearchIndexes(database: string, collection: string, indexName?: string, options?: Document, dbOptions?: DbOptions): Promise<Document[]>;
 }

package/lib/writable.d.ts

@@ -1,9 +1,10 @@
-import type { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
+import type { RunCursorCommandOptions } from 'mongodb';
 import type { Document, InsertOneOptions, InsertOneResult, Collection, RenameOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions, BulkWriteOptions, AnyBulkWriteOperation, DeleteOptions, DeleteResult, InsertManyResult, ReplaceOptions, UpdateResult, UpdateOptions, DropDatabaseOptions, CreateIndexesOptions, DropCollectionOptions, BulkWriteResult, RunCommandOptions, DbOptions, OrderedBulkOperation, UnorderedBulkOperation } from './all-transport-types';
+import type { ServiceProviderRunCommandCursor } from './cursors';
 export default interface Writable {
     runCommand(db: string, spec: Document, options: RunCommandOptions, dbOptions?: DbOptions): Promise<Document>;
     runCommandWithCheck(db: string, spec: Document, options: RunCommandOptions, dbOptions?: DbOptions): Promise<Document>;
-    runCursorCommand(db: string, spec: Document, options: RunCursorCommandOptions, dbOptions?: DbOptions): RunCommandCursor;
+    runCursorCommand(db: string, spec: Document, options: RunCursorCommandOptions, dbOptions?: DbOptions): ServiceProviderRunCommandCursor;
     dropDatabase(database: string, options: DropDatabaseOptions, dbOptions?: DbOptions): Promise<Document>;
     bulkWrite(database: string, collection: string, requests: AnyBulkWriteOperation[], options: BulkWriteOptions, dbOptions?: DbOptions): Promise<BulkWriteResult>;
     deleteMany(database: string, collection: string, filter: Document, options: DeleteOptions, dbOptions?: DbOptions): Promise<DeleteResult>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mongosh/service-provider-core",
-  "version": "2.2.6",
+  "version": "2.2.9",
   "description": "MongoDB Shell Core Service Provider Package",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -44,9 +44,9 @@
   },
   "dependencies": {
     "@aws-sdk/credential-providers": "^3.525.0",
-    "@mongosh/errors": "2.2.6",
+    "@mongosh/errors": "2.2.9",
     "bson": "^6.7.0",
-    "mongodb": "^6.6.2",
+    "mongodb": "^6.7.0",
     "mongodb-build-info": "^1.7.2",
     "mongodb-client-encryption": "^6.0.0"
   },
@@ -54,12 +54,12 @@
     "mongodb-client-encryption": "^6.0.0"
   },
   "devDependencies": {
-    "@mongodb-js/eslint-config-mongosh": "2.2.6",
+    "@mongodb-js/eslint-config-mongosh": "2.2.9",
     "@mongodb-js/prettier-config-devtools": "^1.0.1",
-    "@mongodb-js/tsconfig-mongosh": "2.2.6",
+    "@mongodb-js/tsconfig-mongosh": "2.2.9",
     "depcheck": "^1.4.3",
     "eslint": "^7.25.0",
     "prettier": "^2.8.8"
   },
-  "gitHead": "6d11de2ccf5cdb827d7c170d0e7d1778aa98a0bc"
+  "gitHead": "6c513596f63d4bbbcc503cedf698743178475349"
 }

package/src/cursors.ts

@@ -0,0 +1,69 @@
+import type {
+  CollationOptions,
+  CountOptions,
+  CursorFlag,
+  Document,
+  ExplainVerbosityLike,
+  ReadConcernLike,
+  ReadPreferenceLike,
+  ResumeToken,
+} from './all-transport-types';
+
+interface ServiceProviderBaseCursor<TSchema = Document> {
+  close(): Promise<void>;
+  hasNext(): Promise<boolean>;
+  next(): Promise<TSchema | null>;
+  tryNext(): Promise<TSchema | null>;
+  readonly closed: boolean;
+  [Symbol.asyncIterator](): AsyncGenerator<TSchema, void, void>;
+}
+
+export interface ServiceProviderAbstractCursor<TSchema = Document>
+  extends ServiceProviderBaseCursor<TSchema> {
+  batchSize(number: number): void;
+  maxTimeMS(value: number): void;
+  bufferedCount(): number;
+  readBufferedDocuments(number?: number): TSchema[];
+  toArray(): Promise<TSchema[]>;
+}
+
+export interface ServiceProviderAggregationOrFindCursor<TSchema = Document>
+  extends ServiceProviderAbstractCursor<TSchema> {
+  project($project: Document): void;
+  skip($skip: number): void;
+  sort($sort: Document): void;
+  explain(verbosity?: ExplainVerbosityLike): Promise<Document>;
+  addCursorFlag(flag: CursorFlag, value: boolean): void;
+  withReadPreference(readPreference: ReadPreferenceLike): this;
+  withReadConcern(readConcern: ReadConcernLike): this;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ServiceProviderRunCommandCursor<TSchema = Document>
+  extends ServiceProviderAbstractCursor<TSchema> {}
+
+export interface ServiceProviderFindCursor<TSchema = Document>
+  extends ServiceProviderAggregationOrFindCursor<TSchema> {
+  allowDiskUse(allow?: boolean): void;
+  collation(value: CollationOptions): void;
+  comment(value: string): void;
+  maxAwaitTimeMS(value: number): void;
+  count(options?: CountOptions): Promise<number>;
+  hint(hint: string | Document): void;
+  max(max: Document): void;
+  min(min: Document): void;
+  limit(value: number): void;
+  skip(value: number): void;
+  returnKey(value: boolean): void;
+  showRecordId(value: boolean): void;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export interface ServiceProviderAggregationCursor<TSchema = Document>
+  extends ServiceProviderAggregationOrFindCursor<TSchema> {}
+
+export interface ServiceProviderChangeStream<TSchema = Document>
+  extends ServiceProviderBaseCursor<TSchema> {
+  next(): Promise<TSchema>;
+  readonly resumeToken: ResumeToken;
+}

package/src/index.ts

@@ -18,6 +18,14 @@ export {
 
 export { bson } from './bson-export';
 
+export {
+  ServiceProviderAbstractCursor,
+  ServiceProviderAggregationCursor,
+  ServiceProviderFindCursor,
+  ServiceProviderRunCommandCursor,
+  ServiceProviderChangeStream,
+} from './cursors';
+
 export {
   ServiceProvider,
   ShellAuthOptions,

package/src/readable.ts

@@ -8,13 +8,16 @@ import type {
   FindOptions,
   ListCollectionsOptions,
   ListIndexesOptions,
-  AggregationCursor,
-  FindCursor,
   DbOptions,
   ReadPreferenceFromOptions,
   ReadPreferenceLike,
 } from './all-transport-types';
-import type { ChangeStream, ChangeStreamOptions } from './all-transport-types';
+import type { ChangeStreamOptions } from './all-transport-types';
+import type {
+  ServiceProviderAggregationCursor,
+  ServiceProviderChangeStream,
+  ServiceProviderFindCursor,
+} from './cursors';
 
 /**
  * Interface for read operations in the CRUD specification.
@@ -37,7 +40,7 @@ export default interface Readable {
     pipeline: Document[],
     options?: AggregateOptions,
     dbOptions?: DbOptions
-  ): AggregationCursor;
+  ): ServiceProviderAggregationCursor;
 
   /**
    * Run an aggregation pipeline on the DB.
@@ -54,7 +57,7 @@ export default interface Readable {
     pipeline: Document[],
     options?: AggregateOptions,
     dbOptions?: DbOptions
-  ): AggregationCursor;
+  ): ServiceProviderAggregationCursor;
 
   /**
    * Returns the count of documents that would match a find() query for the
@@ -152,7 +155,7 @@ export default interface Readable {
     filter?: Document,
     options?: FindOptions,
     dbOptions?: DbOptions
-  ): FindCursor;
+  ): ServiceProviderFindCursor;
 
   /**
    * Get currently known topology information.
@@ -215,7 +218,7 @@ export default interface Readable {
     dbOptions?: DbOptions,
     db?: string,
     coll?: string
-  ): ChangeStream<Document>;
+  ): ServiceProviderChangeStream;
 
   /**
    * Returns an array of documents that identify and describe the existing

package/src/writable.ts

@@ -1,4 +1,4 @@
-import type { RunCommandCursor, RunCursorCommandOptions } from 'mongodb';
+import type { RunCursorCommandOptions } from 'mongodb';
 import type {
   Document,
   InsertOneOptions,
@@ -25,6 +25,7 @@ import type {
   OrderedBulkOperation,
   UnorderedBulkOperation,
 } from './all-transport-types';
+import type { ServiceProviderRunCommandCursor } from './cursors';
 
 /**
  * Interface for write operations in the CRUD specification.
@@ -70,7 +71,7 @@ export default interface Writable {
     spec: Document,
     options: RunCursorCommandOptions,
     dbOptions?: DbOptions
-  ): RunCommandCursor;
+  ): ServiceProviderRunCommandCursor;
 
   /**
    * Drop a database