@qp-mongosh/shell-api 0.0.0-dev.5 → 0.0.0-dev.9

package/lib/change-stream-cursor.js

@@ -1,112 +1,112 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const decorators_1 = require("./decorators");
-const result_1 = require("./result");
-const enums_1 = require("./enums");
-const errors_1 = require("@qp-mongosh/errors");
-const helpers_1 = require("./helpers");
-let ChangeStreamCursor = class ChangeStreamCursor extends decorators_1.ShellApiWithMongoClass {
-    constructor(cursor, on, mongo) {
-        super();
-        this._currentIterationResult = null;
-        this._cursor = cursor;
-        this._on = on;
-        this._mongo = mongo;
-    }
-    async _it() {
-        if (this._cursor.closed) {
-            throw new errors_1.MongoshRuntimeError('ChangeStreamCursor is closed');
-        }
-        const result = this._currentIterationResult = new result_1.CursorIterationResult();
-        return (0, helpers_1.iterate)(result, this, await this._mongo._displayBatchSize());
-    }
-    [enums_1.asPrintable]() {
-        return `ChangeStreamCursor on ${this._on}`;
-    }
-    async close() {
-        await this._cursor.close();
-    }
-    async hasNext() {
-        await this._instanceState.printWarning('If there are no documents in the batch, hasNext will block. Use tryNext if you want to check if there ' +
-            'are any documents without waiting.');
-        return this._cursor.hasNext();
-    }
-    async tryNext() {
-        if (this._cursor.closed) {
-            throw new errors_1.MongoshRuntimeError('Cannot call tryNext on closed cursor');
-        }
-        return this._cursor.tryNext();
-    }
-    async *[Symbol.asyncIterator]() {
-        let doc;
-        while ((doc = await this.tryNext()) !== null) {
-            yield doc;
-        }
-    }
-    isClosed() {
-        return this._cursor.closed;
-    }
-    isExhausted() {
-        throw new errors_1.MongoshInvalidInputError('isExhausted is not implemented for ChangeStreams 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 isClosed. If you want to see if there are documents left in the batch, use tryNext.');
-    }
-    async itcount() {
-        let count = 0;
-        while (await this.tryNext()) {
-            count++;
-        }
-        return count;
-    }
-    async next() {
-        await this._instanceState.printWarning('If there are no documents in the batch, next will block. Use tryNext if you want to check if there are ' +
-            'any documents without waiting.');
-        return this._cursor.next();
-    }
-    getResumeToken() {
-        return this._cursor.resumeToken;
-    }
-    map() {
-        throw new errors_1.MongoshUnimplementedError('Cannot call map on a change stream cursor');
-    }
-    forEach() {
-        throw new errors_1.MongoshUnimplementedError('Cannot call forEach on a change stream cursor');
-    }
-    toArray() {
-        throw new errors_1.MongoshUnimplementedError('Cannot call toArray on a change stream cursor');
-    }
-    objsLeftInBatch() {
-        throw new errors_1.MongoshUnimplementedError('Cannot call objsLeftInBatch on a change stream cursor');
-    }
-    pretty() {
-        return this;
-    }
-};
-__decorate([
-    decorators_1.returnsPromise
-], ChangeStreamCursor.prototype, "close", null);
-__decorate([
-    decorators_1.returnsPromise,
-    decorators_1.deprecated
-], ChangeStreamCursor.prototype, "hasNext", null);
-__decorate([
-    decorators_1.returnsPromise
-], ChangeStreamCursor.prototype, "tryNext", null);
-__decorate([
-    decorators_1.returnsPromise
-], ChangeStreamCursor.prototype, "itcount", null);
-__decorate([
-    decorators_1.returnsPromise
-], ChangeStreamCursor.prototype, "next", null);
-__decorate([
-    (0, decorators_1.returnType)('ChangeStreamCursor')
-], ChangeStreamCursor.prototype, "pretty", null);
-ChangeStreamCursor = __decorate([
-    decorators_1.shellApiClassDefault
-], ChangeStreamCursor);
-exports.default = ChangeStreamCursor;
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const decorators_1 = require("./decorators");
+const result_1 = require("./result");
+const enums_1 = require("./enums");
+const errors_1 = require("@qp-mongosh/errors");
+const helpers_1 = require("./helpers");
+let ChangeStreamCursor = class ChangeStreamCursor extends decorators_1.ShellApiWithMongoClass {
+    constructor(cursor, on, mongo) {
+        super();
+        this._currentIterationResult = null;
+        this._cursor = cursor;
+        this._on = on;
+        this._mongo = mongo;
+    }
+    async _it() {
+        if (this._cursor.closed) {
+            throw new errors_1.MongoshRuntimeError('ChangeStreamCursor is closed');
+        }
+        const result = this._currentIterationResult = new result_1.CursorIterationResult();
+        return (0, helpers_1.iterate)(result, this, await this._mongo._displayBatchSize());
+    }
+    [enums_1.asPrintable]() {
+        return `ChangeStreamCursor on ${this._on}`;
+    }
+    async close() {
+        await this._cursor.close();
+    }
+    async hasNext() {
+        await this._instanceState.printWarning('If there are no documents in the batch, hasNext will block. Use tryNext if you want to check if there ' +
+            'are any documents without waiting.');
+        return this._cursor.hasNext();
+    }
+    async tryNext() {
+        if (this._cursor.closed) {
+            throw new errors_1.MongoshRuntimeError('Cannot call tryNext on closed cursor');
+        }
+        return this._cursor.tryNext();
+    }
+    async *[Symbol.asyncIterator]() {
+        let doc;
+        while ((doc = await this.tryNext()) !== null) {
+            yield doc;
+        }
+    }
+    isClosed() {
+        return this._cursor.closed;
+    }
+    isExhausted() {
+        throw new errors_1.MongoshInvalidInputError('isExhausted is not implemented for ChangeStreams 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 isClosed. If you want to see if there are documents left in the batch, use tryNext.');
+    }
+    async itcount() {
+        let count = 0;
+        while (await this.tryNext()) {
+            count++;
+        }
+        return count;
+    }
+    async next() {
+        await this._instanceState.printWarning('If there are no documents in the batch, next will block. Use tryNext if you want to check if there are ' +
+            'any documents without waiting.');
+        return this._cursor.next();
+    }
+    getResumeToken() {
+        return this._cursor.resumeToken;
+    }
+    map() {
+        throw new errors_1.MongoshUnimplementedError('Cannot call map on a change stream cursor');
+    }
+    forEach() {
+        throw new errors_1.MongoshUnimplementedError('Cannot call forEach on a change stream cursor');
+    }
+    toArray() {
+        throw new errors_1.MongoshUnimplementedError('Cannot call toArray on a change stream cursor');
+    }
+    objsLeftInBatch() {
+        throw new errors_1.MongoshUnimplementedError('Cannot call objsLeftInBatch on a change stream cursor');
+    }
+    pretty() {
+        return this;
+    }
+};
+__decorate([
+    decorators_1.returnsPromise
+], ChangeStreamCursor.prototype, "close", null);
+__decorate([
+    decorators_1.returnsPromise,
+    decorators_1.deprecated
+], ChangeStreamCursor.prototype, "hasNext", null);
+__decorate([
+    decorators_1.returnsPromise
+], ChangeStreamCursor.prototype, "tryNext", null);
+__decorate([
+    decorators_1.returnsPromise
+], ChangeStreamCursor.prototype, "itcount", null);
+__decorate([
+    decorators_1.returnsPromise
+], ChangeStreamCursor.prototype, "next", null);
+__decorate([
+    (0, decorators_1.returnType)('ChangeStreamCursor')
+], ChangeStreamCursor.prototype, "pretty", null);
+ChangeStreamCursor = __decorate([
+    decorators_1.shellApiClassDefault
+], ChangeStreamCursor);
+exports.default = ChangeStreamCursor;
 //# sourceMappingURL=change-stream-cursor.js.map

package/lib/collection.d.ts

@@ -1,95 +1,95 @@
-import Mongo from './mongo';
-import { Namespace, ShellApiWithMongoClass } from './decorators';
-import { asPrintable, namespaceInfo } from './enums';
-import { FindAndModifyShellOptions, FindAndModifyMethodShellOptions, RemoveShellOptions, MapReduceShellOptions } from './helpers';
-import { AnyBulkWriteOperation, BulkWriteOptions, CollStatsOptions, CountOptions, CountDocumentsOptions, ChangeStreamOptions, CreateIndexesOptions, DeleteOptions, DistinctOptions, Document, EstimatedDocumentCountOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions, FindOptions, InsertOneOptions, ReplaceOptions, RunCommandOptions, UpdateOptions } from '@qp-mongosh/service-provider-core';
-import { AggregationCursor, BulkWriteResult, CommandResult, Cursor, Database, DeleteResult, Explainable, InsertManyResult, InsertOneResult, UpdateResult } from './index';
-import Bulk from './bulk';
-import PlanCache from './plan-cache';
-import ChangeStreamCursor from './change-stream-cursor';
-declare type CollStatsShellOptions = CollStatsOptions & {
-    indexDetails?: boolean;
-    indexDetailsKey?: Document;
-    indexDetailsName?: string;
-};
-export default class Collection extends ShellApiWithMongoClass {
-    _mongo: Mongo;
-    _database: Database;
-    _name: string;
-    constructor(mongo: Mongo, database: Database, name: string);
-    [namespaceInfo](): Namespace;
-    [asPrintable](): string;
-    private _emitCollectionApiCall;
-    aggregate(pipeline: Document[], options: Document & {
-        explain?: never;
-    }): Promise<AggregationCursor>;
-    aggregate(pipeline: Document[], options: Document & {
-        explain: ExplainVerbosityLike;
-    }): Promise<Document>;
-    aggregate(...stages: Document[]): Promise<AggregationCursor>;
-    bulkWrite(operations: AnyBulkWriteOperation[], options?: BulkWriteOptions): Promise<BulkWriteResult>;
-    count(query?: {}, options?: CountOptions): Promise<number>;
-    countDocuments(query?: Document, options?: CountDocumentsOptions): Promise<number>;
-    deleteMany(filter: Document, options?: DeleteOptions): Promise<DeleteResult | Document>;
-    deleteOne(filter: Document, options?: DeleteOptions): Promise<DeleteResult | Document>;
-    distinct(field: string): Promise<Document>;
-    distinct(field: string, query: Document): Promise<Document>;
-    distinct(field: string, query: Document, options: DistinctOptions): Promise<Document>;
-    estimatedDocumentCount(options?: EstimatedDocumentCountOptions): Promise<number>;
-    find(query?: Document, projection?: Document, options?: FindOptions): Promise<Cursor>;
-    findAndModify(options: FindAndModifyMethodShellOptions): Promise<Document>;
-    findOne(query?: Document, projection?: Document, options?: FindOptions): Promise<Document | null>;
-    renameCollection(newName: string, dropTarget?: boolean): Promise<Document>;
-    findOneAndDelete(filter: Document, options?: FindOneAndDeleteOptions): Promise<Document>;
-    findOneAndReplace(filter: Document, replacement: Document, options?: FindAndModifyShellOptions<FindOneAndReplaceOptions>): Promise<Document>;
-    findOneAndUpdate(filter: Document, update: Document | Document[], options?: FindAndModifyShellOptions<FindOneAndUpdateOptions>): Promise<Document>;
-    insert(docs: Document | Document[], options?: BulkWriteOptions): Promise<InsertManyResult>;
-    insertMany(docs: Document[], options?: BulkWriteOptions): Promise<InsertManyResult>;
-    insertOne(doc: Document, options?: InsertOneOptions): Promise<InsertOneResult>;
-    isCapped(): Promise<boolean>;
-    remove(query: Document, options?: boolean | RemoveShellOptions): Promise<DeleteResult | Document>;
-    save(): never;
-    replaceOne(filter: Document, replacement: Document, options?: ReplaceOptions): Promise<UpdateResult>;
-    update(filter: Document, update: Document, options?: UpdateOptions & {
-        multi?: boolean;
-    }): Promise<UpdateResult | Document>;
-    updateMany(filter: Document, update: Document, options?: UpdateOptions): Promise<UpdateResult | Document>;
-    updateOne(filter: Document, update: Document, options?: UpdateOptions): Promise<UpdateResult | Document>;
-    convertToCapped(size: number): Promise<Document>;
-    _createIndexes(keyPatterns: Document[], options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<string[]>;
-    createIndexes(keyPatterns: Document[], options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<string[]>;
-    createIndex(keys: Document, options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<string>;
-    ensureIndex(keys: Document, options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<Document>;
-    getIndexes(): Promise<Document[]>;
-    getIndexSpecs(): Promise<Document[]>;
-    getIndices(): Promise<Document[]>;
-    getIndexKeys(): Promise<Document[]>;
-    dropIndexes(indexes?: string | string[] | Document | Document[]): Promise<Document>;
-    dropIndex(index: string | Document): Promise<Document>;
-    totalIndexSize(...args: any[]): Promise<number>;
-    reIndex(): Promise<Document>;
-    getDB(): Database;
-    getMongo(): Mongo;
-    dataSize(): Promise<number>;
-    storageSize(): Promise<number>;
-    totalSize(): Promise<number>;
-    drop(): Promise<boolean>;
-    exists(): Promise<Document>;
-    getFullName(): string;
-    getName(): string;
-    runCommand(commandName: string | Document, options?: RunCommandOptions): Promise<Document>;
-    explain(verbosity?: ExplainVerbosityLike): Explainable;
-    stats(originalOptions?: CollStatsShellOptions | number): Promise<Document>;
-    latencyStats(options?: Document): Promise<Document[]>;
-    initializeOrderedBulkOp(): Promise<Bulk>;
-    initializeUnorderedBulkOp(): Promise<Bulk>;
-    getPlanCache(): PlanCache;
-    mapReduce(map: Function | string, reduce: Function | string, optionsOrOutString: MapReduceShellOptions): Promise<Document>;
-    validate(options?: boolean | Document): Promise<Document>;
-    getShardVersion(): Promise<Document>;
-    getShardDistribution(): Promise<CommandResult>;
-    watch(pipeline?: Document[] | ChangeStreamOptions, options?: ChangeStreamOptions): Promise<ChangeStreamCursor>;
-    hideIndex(index: string | Document): Promise<Document>;
-    unhideIndex(index: string | Document): Promise<Document>;
-}
-export {};
+import Mongo from './mongo';
+import { Namespace, ShellApiWithMongoClass } from './decorators';
+import { asPrintable, namespaceInfo } from './enums';
+import { FindAndModifyShellOptions, FindAndModifyMethodShellOptions, RemoveShellOptions, MapReduceShellOptions } from './helpers';
+import { AnyBulkWriteOperation, BulkWriteOptions, CollStatsOptions, CountOptions, CountDocumentsOptions, ChangeStreamOptions, CreateIndexesOptions, DeleteOptions, DistinctOptions, Document, EstimatedDocumentCountOptions, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions, FindOptions, InsertOneOptions, ReplaceOptions, RunCommandOptions, UpdateOptions } from '@qp-mongosh/service-provider-core';
+import { AggregationCursor, BulkWriteResult, CommandResult, Cursor, Database, DeleteResult, Explainable, InsertManyResult, InsertOneResult, UpdateResult } from './index';
+import Bulk from './bulk';
+import PlanCache from './plan-cache';
+import ChangeStreamCursor from './change-stream-cursor';
+declare type CollStatsShellOptions = CollStatsOptions & {
+    indexDetails?: boolean;
+    indexDetailsKey?: Document;
+    indexDetailsName?: string;
+};
+export default class Collection extends ShellApiWithMongoClass {
+    _mongo: Mongo;
+    _database: Database;
+    _name: string;
+    constructor(mongo: Mongo, database: Database, name: string);
+    [namespaceInfo](): Namespace;
+    [asPrintable](): string;
+    private _emitCollectionApiCall;
+    aggregate(pipeline: Document[], options: Document & {
+        explain?: never;
+    }): Promise<AggregationCursor>;
+    aggregate(pipeline: Document[], options: Document & {
+        explain: ExplainVerbosityLike;
+    }): Promise<Document>;
+    aggregate(...stages: Document[]): Promise<AggregationCursor>;
+    bulkWrite(operations: AnyBulkWriteOperation[], options?: BulkWriteOptions): Promise<BulkWriteResult>;
+    count(query?: {}, options?: CountOptions): Promise<number>;
+    countDocuments(query?: Document, options?: CountDocumentsOptions): Promise<number>;
+    deleteMany(filter: Document, options?: DeleteOptions): Promise<DeleteResult | Document>;
+    deleteOne(filter: Document, options?: DeleteOptions): Promise<DeleteResult | Document>;
+    distinct(field: string): Promise<Document>;
+    distinct(field: string, query: Document): Promise<Document>;
+    distinct(field: string, query: Document, options: DistinctOptions): Promise<Document>;
+    estimatedDocumentCount(options?: EstimatedDocumentCountOptions): Promise<number>;
+    find(query?: Document, projection?: Document, options?: FindOptions): Promise<Cursor>;
+    findAndModify(options: FindAndModifyMethodShellOptions): Promise<Document>;
+    findOne(query?: Document, projection?: Document, options?: FindOptions): Promise<Document | null>;
+    renameCollection(newName: string, dropTarget?: boolean): Promise<Document>;
+    findOneAndDelete(filter: Document, options?: FindOneAndDeleteOptions): Promise<Document>;
+    findOneAndReplace(filter: Document, replacement: Document, options?: FindAndModifyShellOptions<FindOneAndReplaceOptions>): Promise<Document>;
+    findOneAndUpdate(filter: Document, update: Document | Document[], options?: FindAndModifyShellOptions<FindOneAndUpdateOptions>): Promise<Document>;
+    insert(docs: Document | Document[], options?: BulkWriteOptions): Promise<InsertManyResult>;
+    insertMany(docs: Document[], options?: BulkWriteOptions): Promise<InsertManyResult>;
+    insertOne(doc: Document, options?: InsertOneOptions): Promise<InsertOneResult>;
+    isCapped(): Promise<boolean>;
+    remove(query: Document, options?: boolean | RemoveShellOptions): Promise<DeleteResult | Document>;
+    save(): never;
+    replaceOne(filter: Document, replacement: Document, options?: ReplaceOptions): Promise<UpdateResult>;
+    update(filter: Document, update: Document, options?: UpdateOptions & {
+        multi?: boolean;
+    }): Promise<UpdateResult | Document>;
+    updateMany(filter: Document, update: Document, options?: UpdateOptions): Promise<UpdateResult | Document>;
+    updateOne(filter: Document, update: Document, options?: UpdateOptions): Promise<UpdateResult | Document>;
+    convertToCapped(size: number): Promise<Document>;
+    _createIndexes(keyPatterns: Document[], options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<string[]>;
+    createIndexes(keyPatterns: Document[], options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<string[]>;
+    createIndex(keys: Document, options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<string>;
+    ensureIndex(keys: Document, options?: CreateIndexesOptions, commitQuorum?: number | string): Promise<Document>;
+    getIndexes(): Promise<Document[]>;
+    getIndexSpecs(): Promise<Document[]>;
+    getIndices(): Promise<Document[]>;
+    getIndexKeys(): Promise<Document[]>;
+    dropIndexes(indexes?: string | string[] | Document | Document[]): Promise<Document>;
+    dropIndex(index: string | Document): Promise<Document>;
+    totalIndexSize(...args: any[]): Promise<number>;
+    reIndex(): Promise<Document>;
+    getDB(): Database;
+    getMongo(): Mongo;
+    dataSize(): Promise<number>;
+    storageSize(): Promise<number>;
+    totalSize(): Promise<number>;
+    drop(): Promise<boolean>;
+    exists(): Promise<Document>;
+    getFullName(): string;
+    getName(): string;
+    runCommand(commandName: string | Document, options?: RunCommandOptions): Promise<Document>;
+    explain(verbosity?: ExplainVerbosityLike): Explainable;
+    stats(originalOptions?: CollStatsShellOptions | number): Promise<Document>;
+    latencyStats(options?: Document): Promise<Document[]>;
+    initializeOrderedBulkOp(): Promise<Bulk>;
+    initializeUnorderedBulkOp(): Promise<Bulk>;
+    getPlanCache(): PlanCache;
+    mapReduce(map: Function | string, reduce: Function | string, optionsOrOutString: MapReduceShellOptions): Promise<Document>;
+    validate(options?: boolean | Document): Promise<Document>;
+    getShardVersion(): Promise<Document>;
+    getShardDistribution(): Promise<CommandResult>;
+    watch(pipeline?: Document[] | ChangeStreamOptions, options?: ChangeStreamOptions): Promise<ChangeStreamCursor>;
+    hideIndex(index: string | Document): Promise<Document>;
+    unhideIndex(index: string | Document): Promise<Document>;
+}
+export {};