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

package/lib/deprecation-warning.d.ts

@@ -0,0 +1,2 @@
+export declare function printDeprecationWarning(message: string, warn?: (message?: any, ...optionalParams: any[]) => void): void;
+export declare function printWarning(message: string, warn?: (message?: any, ...optionalParams: any[]) => void): void;

package/lib/deprecation-warning.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printWarning = exports.printDeprecationWarning = void 0;
+const warningShown = new Set();
+function printDeprecationWarning(message, warn = console.warn) {
+    if (!warningShown.has(message)) {
+        warningShown.add(message);
+        warn(`DeprecationWarning: ${message}`);
+    }
+}
+exports.printDeprecationWarning = printDeprecationWarning;
+function printWarning(message, warn = console.warn) {
+    if (!warningShown.has(message)) {
+        warningShown.add(message);
+        warn(`Warning: ${message}`);
+    }
+}
+exports.printWarning = printWarning;
+//# sourceMappingURL=deprecation-warning.js.map

package/lib/deprecation-warning.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecation-warning.js","sourceRoot":"","sources":["../src/deprecation-warning.ts"],"names":[],"mappings":";;;AAAA,MAAM,YAAY,GAAgB,IAAI,GAAG,EAAE,CAAC;AAQ5C,SAAgB,uBAAuB,CACrC,OAAe,EACf,IAAI,GAAG,OAAO,CAAC,IAAI;IAEnB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QAC9B,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAI,CAAC,uBAAuB,OAAO,EAAE,CAAC,CAAC;KACxC;AACH,CAAC;AARD,0DAQC;AAED,SAAgB,YAAY,CAC1B,OAAe,EACf,IAAI,GAAG,OAAO,CAAC,IAAI;IAEnB,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE;QAC9B,YAAY,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC1B,IAAI,CAAC,YAAY,OAAO,EAAE,CAAC,CAAC;KAC7B;AACH,CAAC;AARD,oCAQC"}

package/lib/enums.d.ts

@@ -1,28 +1,28 @@
-export declare enum ServerVersions {
-    latest = "999.999.999",
-    earliest = "0.0.0"
-}
-export declare enum Topologies {
-    ReplSet = "ReplSet",
-    Standalone = "Standalone",
-    Sharded = "Sharded",
-    LoadBalanced = "LoadBalanced"
-}
-import { ReplPlatform } from '@qp-mongosh/service-provider-core';
-export declare const ALL_SERVER_VERSIONS: ServerVersions[];
-export declare const ALL_TOPOLOGIES: Topologies[];
-export declare const ALL_PLATFORMS: ReplPlatform[];
-export declare const ALL_API_VERSIONS: number[];
-export declare const CURSOR_FLAGS: {
-    2: string;
-    4: string;
-    8: string;
-    16: string;
-    32: string;
-    64: string;
-    128: string;
-};
-export declare const shellApiType: unique symbol;
-export declare const asPrintable: unique symbol;
-export declare const namespaceInfo: unique symbol;
-export declare const ADMIN_DB = "admin";
+export declare enum ServerVersions {
+    latest = "999.999.999",
+    earliest = "0.0.0"
+}
+export declare enum Topologies {
+    ReplSet = "ReplSet",
+    Standalone = "Standalone",
+    Sharded = "Sharded",
+    LoadBalanced = "LoadBalanced"
+}
+import { ReplPlatform } from '@qp-mongosh/service-provider-core';
+export declare const ALL_SERVER_VERSIONS: ServerVersions[];
+export declare const ALL_TOPOLOGIES: Topologies[];
+export declare const ALL_PLATFORMS: ReplPlatform[];
+export declare const ALL_API_VERSIONS: number[];
+export declare const CURSOR_FLAGS: {
+    2: string;
+    4: string;
+    8: string;
+    16: string;
+    32: string;
+    64: string;
+    128: string;
+};
+export declare const shellApiType: unique symbol;
+export declare const asPrintable: unique symbol;
+export declare const namespaceInfo: unique symbol;
+export declare const ADMIN_DB = "admin";

package/lib/enums.js

@@ -1,34 +1,34 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ADMIN_DB = exports.namespaceInfo = exports.asPrintable = exports.shellApiType = exports.CURSOR_FLAGS = exports.ALL_API_VERSIONS = exports.ALL_PLATFORMS = exports.ALL_TOPOLOGIES = exports.ALL_SERVER_VERSIONS = exports.Topologies = exports.ServerVersions = void 0;
-var ServerVersions;
-(function (ServerVersions) {
-    ServerVersions["latest"] = "999.999.999";
-    ServerVersions["earliest"] = "0.0.0";
-})(ServerVersions = exports.ServerVersions || (exports.ServerVersions = {}));
-var Topologies;
-(function (Topologies) {
-    Topologies["ReplSet"] = "ReplSet";
-    Topologies["Standalone"] = "Standalone";
-    Topologies["Sharded"] = "Sharded";
-    Topologies["LoadBalanced"] = "LoadBalanced";
-})(Topologies = exports.Topologies || (exports.Topologies = {}));
-const service_provider_core_1 = require("@qp-mongosh/service-provider-core");
-exports.ALL_SERVER_VERSIONS = [ServerVersions.earliest, ServerVersions.latest];
-exports.ALL_TOPOLOGIES = [Topologies.ReplSet, Topologies.Sharded, Topologies.LoadBalanced, Topologies.Standalone];
-exports.ALL_PLATFORMS = [service_provider_core_1.ReplPlatform.Compass, service_provider_core_1.ReplPlatform.Browser, service_provider_core_1.ReplPlatform.CLI];
-exports.ALL_API_VERSIONS = [0, Infinity];
-exports.CURSOR_FLAGS = {
-    2: 'tailable',
-    4: 'SlaveOk',
-    8: 'oplogReplay',
-    16: 'noTimeout',
-    32: 'awaitData',
-    64: 'exhaust',
-    128: 'partial'
-};
-exports.shellApiType = Symbol.for('@@mongosh.shellApiType');
-exports.asPrintable = Symbol.for('@@mongosh.asPrintable');
-exports.namespaceInfo = Symbol.for('@@mongosh.namespaceInfo');
-exports.ADMIN_DB = 'admin';
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ADMIN_DB = exports.namespaceInfo = exports.asPrintable = exports.shellApiType = exports.CURSOR_FLAGS = exports.ALL_API_VERSIONS = exports.ALL_PLATFORMS = exports.ALL_TOPOLOGIES = exports.ALL_SERVER_VERSIONS = exports.Topologies = exports.ServerVersions = void 0;
+var ServerVersions;
+(function (ServerVersions) {
+    ServerVersions["latest"] = "999.999.999";
+    ServerVersions["earliest"] = "0.0.0";
+})(ServerVersions = exports.ServerVersions || (exports.ServerVersions = {}));
+var Topologies;
+(function (Topologies) {
+    Topologies["ReplSet"] = "ReplSet";
+    Topologies["Standalone"] = "Standalone";
+    Topologies["Sharded"] = "Sharded";
+    Topologies["LoadBalanced"] = "LoadBalanced";
+})(Topologies = exports.Topologies || (exports.Topologies = {}));
+const service_provider_core_1 = require("@qp-mongosh/service-provider-core");
+exports.ALL_SERVER_VERSIONS = [ServerVersions.earliest, ServerVersions.latest];
+exports.ALL_TOPOLOGIES = [Topologies.ReplSet, Topologies.Sharded, Topologies.LoadBalanced, Topologies.Standalone];
+exports.ALL_PLATFORMS = [service_provider_core_1.ReplPlatform.Compass, service_provider_core_1.ReplPlatform.Browser, service_provider_core_1.ReplPlatform.CLI];
+exports.ALL_API_VERSIONS = [0, Infinity];
+exports.CURSOR_FLAGS = {
+    2: 'tailable',
+    4: 'SlaveOk',
+    8: 'oplogReplay',
+    16: 'noTimeout',
+    32: 'awaitData',
+    64: 'exhaust',
+    128: 'partial'
+};
+exports.shellApiType = Symbol.for('@@mongosh.shellApiType');
+exports.asPrintable = Symbol.for('@@mongosh.asPrintable');
+exports.namespaceInfo = Symbol.for('@@mongosh.namespaceInfo');
+exports.ADMIN_DB = 'admin';
 //# sourceMappingURL=enums.js.map

package/lib/error-codes.d.ts

@@ -1,12 +1,12 @@
-declare function blockedByDriverMetadata(apiDetails: string): {
-    driverCaused: boolean;
-    api: string;
-};
-declare enum ShellApiErrors {
-    NotConnectedToShardedCluster = "SHAPI-10001",
-    NotConnectedToReplicaSet = "SHAPI-10002",
-    NotConnectedToMongos = "SHAPI-10003",
-    NotConnected = "SHAPI-10004",
-    NotUsingFLE = "SHAPI-10005"
-}
-export { blockedByDriverMetadata, ShellApiErrors };
+declare function blockedByDriverMetadata(apiDetails: string): {
+    driverCaused: boolean;
+    api: string;
+};
+declare enum ShellApiErrors {
+    NotConnectedToShardedCluster = "SHAPI-10001",
+    NotConnectedToReplicaSet = "SHAPI-10002",
+    NotConnectedToMongos = "SHAPI-10003",
+    NotConnected = "SHAPI-10004",
+    NotUsingFLE = "SHAPI-10005"
+}
+export { blockedByDriverMetadata, ShellApiErrors };

package/lib/error-codes.js

@@ -1,20 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShellApiErrors = exports.blockedByDriverMetadata = void 0;
-function blockedByDriverMetadata(apiDetails) {
-    return {
-        driverCaused: true,
-        api: apiDetails
-    };
-}
-exports.blockedByDriverMetadata = blockedByDriverMetadata;
-var ShellApiErrors;
-(function (ShellApiErrors) {
-    ShellApiErrors["NotConnectedToShardedCluster"] = "SHAPI-10001";
-    ShellApiErrors["NotConnectedToReplicaSet"] = "SHAPI-10002";
-    ShellApiErrors["NotConnectedToMongos"] = "SHAPI-10003";
-    ShellApiErrors["NotConnected"] = "SHAPI-10004";
-    ShellApiErrors["NotUsingFLE"] = "SHAPI-10005";
-})(ShellApiErrors || (ShellApiErrors = {}));
-exports.ShellApiErrors = ShellApiErrors;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShellApiErrors = exports.blockedByDriverMetadata = void 0;
+function blockedByDriverMetadata(apiDetails) {
+    return {
+        driverCaused: true,
+        api: apiDetails
+    };
+}
+exports.blockedByDriverMetadata = blockedByDriverMetadata;
+var ShellApiErrors;
+(function (ShellApiErrors) {
+    ShellApiErrors["NotConnectedToShardedCluster"] = "SHAPI-10001";
+    ShellApiErrors["NotConnectedToReplicaSet"] = "SHAPI-10002";
+    ShellApiErrors["NotConnectedToMongos"] = "SHAPI-10003";
+    ShellApiErrors["NotConnected"] = "SHAPI-10004";
+    ShellApiErrors["NotUsingFLE"] = "SHAPI-10005";
+})(ShellApiErrors || (ShellApiErrors = {}));
+exports.ShellApiErrors = ShellApiErrors;
 //# sourceMappingURL=error-codes.js.map

package/lib/explainable-cursor.d.ts

@@ -1,11 +1,11 @@
-import Cursor from './cursor';
-import type Mongo from './mongo';
-import { asPrintable } from './enums';
-import type { ExplainVerbosityLike } from '@qp-mongosh/service-provider-core';
-export default class ExplainableCursor extends Cursor {
-    _baseCursor: Cursor;
-    _verbosity: ExplainVerbosityLike;
-    _explained: any;
-    constructor(mongo: Mongo, cursor: Cursor, verbosity: ExplainVerbosityLike);
-    [asPrintable](): Promise<any>;
-}
+import Cursor from './cursor';
+import type Mongo from './mongo';
+import { asPrintable } from './enums';
+import type { ExplainVerbosityLike } from '@qp-mongosh/service-provider-core';
+export default class ExplainableCursor extends Cursor {
+    _baseCursor: Cursor;
+    _verbosity: ExplainVerbosityLike;
+    _explained: any;
+    constructor(mongo: Mongo, cursor: Cursor, verbosity: ExplainVerbosityLike);
+    [asPrintable](): Promise<any>;
+}

package/lib/explainable-cursor.js

@@ -1,32 +1,32 @@
-"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;
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const decorators_1 = require("./decorators");
-const cursor_1 = __importDefault(require("./cursor"));
-const enums_1 = require("./enums");
-let ExplainableCursor = class ExplainableCursor extends cursor_1.default {
-    constructor(mongo, cursor, verbosity) {
-        super(mongo, cursor._cursor);
-        this._baseCursor = cursor;
-        this._verbosity = verbosity;
-        this._explained = null;
-    }
-    async [enums_1.asPrintable]() {
-        var _a;
-        (_a = this._explained) !== null && _a !== void 0 ? _a : (this._explained = await this._baseCursor.explain(this._verbosity));
-        return this._explained;
-    }
-};
-ExplainableCursor = __decorate([
-    decorators_1.shellApiClassDefault
-], ExplainableCursor);
-exports.default = ExplainableCursor;
+"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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const decorators_1 = require("./decorators");
+const cursor_1 = __importDefault(require("./cursor"));
+const enums_1 = require("./enums");
+let ExplainableCursor = class ExplainableCursor extends cursor_1.default {
+    constructor(mongo, cursor, verbosity) {
+        super(mongo, cursor._cursor);
+        this._baseCursor = cursor;
+        this._verbosity = verbosity;
+        this._explained = null;
+    }
+    async [enums_1.asPrintable]() {
+        var _a;
+        (_a = this._explained) !== null && _a !== void 0 ? _a : (this._explained = await this._baseCursor.explain(this._verbosity));
+        return this._explained;
+    }
+};
+ExplainableCursor = __decorate([
+    decorators_1.shellApiClassDefault
+], ExplainableCursor);
+exports.default = ExplainableCursor;
 //# sourceMappingURL=explainable-cursor.js.map

package/lib/explainable.d.ts

@@ -1,32 +1,32 @@
-import type Collection from './collection';
-import type Mongo from './mongo';
-import ExplainableCursor from './explainable-cursor';
-import { ShellApiWithMongoClass } from './decorators';
-import { asPrintable } from './enums';
-import { RemoveShellOptions, FindAndModifyShellOptions, FindAndModifyMethodShellOptions, MapReduceShellOptions } from './helpers';
-import type { Document, ExplainVerbosityLike, CountOptions, DistinctOptions, UpdateOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions } from '@qp-mongosh/service-provider-core';
-export default class Explainable extends ShellApiWithMongoClass {
-    _mongo: Mongo;
-    _collection: Collection;
-    _verbosity: ExplainVerbosityLike;
-    constructor(mongo: Mongo, collection: Collection, verbosity: ExplainVerbosityLike);
-    [asPrintable](): string;
-    private _emitExplainableApiCall;
-    getCollection(): Collection;
-    getVerbosity(): ExplainVerbosityLike;
-    setVerbosity(verbosity: ExplainVerbosityLike): void;
-    find(query?: Document, projection?: Document): Promise<ExplainableCursor>;
-    aggregate(pipeline: Document[], options: Document): Promise<Document>;
-    aggregate(...stages: Document[]): Promise<Document>;
-    count(query?: {}, options?: CountOptions): Promise<Document>;
-    distinct(field: string): Promise<Document>;
-    distinct(field: string, query: Document): Promise<Document>;
-    distinct(field: string, query: Document, options: DistinctOptions): Promise<Document>;
-    findAndModify(options: FindAndModifyMethodShellOptions): Promise<Document>;
-    findOneAndDelete(filter: Document, options?: FindOneAndDeleteOptions): Promise<Document>;
-    findOneAndReplace(filter: Document, replacement: Document, options?: FindAndModifyShellOptions<FindOneAndReplaceOptions>): Promise<Document>;
-    findOneAndUpdate(filter: Document, update: Document, options?: FindAndModifyShellOptions<FindOneAndUpdateOptions>): Promise<Document>;
-    remove(query: Document, options?: boolean | RemoveShellOptions): Promise<Document>;
-    update(filter: Document, update: Document, options?: UpdateOptions): Promise<Document>;
-    mapReduce(map: Function | string, reduce: Function | string, optionsOrOutString: MapReduceShellOptions): Promise<Document>;
-}
+import type Collection from './collection';
+import type Mongo from './mongo';
+import ExplainableCursor from './explainable-cursor';
+import { ShellApiWithMongoClass } from './decorators';
+import { asPrintable } from './enums';
+import { RemoveShellOptions, FindAndModifyShellOptions, FindAndModifyMethodShellOptions, MapReduceShellOptions } from './helpers';
+import type { Document, ExplainVerbosityLike, CountOptions, DistinctOptions, UpdateOptions, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions } from '@qp-mongosh/service-provider-core';
+export default class Explainable extends ShellApiWithMongoClass {
+    _mongo: Mongo;
+    _collection: Collection;
+    _verbosity: ExplainVerbosityLike;
+    constructor(mongo: Mongo, collection: Collection, verbosity: ExplainVerbosityLike);
+    [asPrintable](): string;
+    private _emitExplainableApiCall;
+    getCollection(): Collection;
+    getVerbosity(): ExplainVerbosityLike;
+    setVerbosity(verbosity: ExplainVerbosityLike): void;
+    find(query?: Document, projection?: Document): Promise<ExplainableCursor>;
+    aggregate(pipeline: Document[], options: Document): Promise<Document>;
+    aggregate(...stages: Document[]): Promise<Document>;
+    count(query?: {}, options?: CountOptions): Promise<Document>;
+    distinct(field: string): Promise<Document>;
+    distinct(field: string, query: Document): Promise<Document>;
+    distinct(field: string, query: Document, options: DistinctOptions): Promise<Document>;
+    findAndModify(options: FindAndModifyMethodShellOptions): Promise<Document>;
+    findOneAndDelete(filter: Document, options?: FindOneAndDeleteOptions): Promise<Document>;
+    findOneAndReplace(filter: Document, replacement: Document, options?: FindAndModifyShellOptions<FindOneAndReplaceOptions>): Promise<Document>;
+    findOneAndUpdate(filter: Document, update: Document, options?: FindAndModifyShellOptions<FindOneAndUpdateOptions>): Promise<Document>;
+    remove(query: Document, options?: boolean | RemoveShellOptions): Promise<Document>;
+    update(filter: Document, update: Document, options?: UpdateOptions): Promise<Document>;
+    mapReduce(map: Function | string, reduce: Function | string, optionsOrOutString: MapReduceShellOptions): Promise<Document>;
+}