@qp-mongosh/shell-api 0.0.0-dev.0

package/lib/enums.d.ts

@@ -0,0 +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";

package/lib/enums.js

@@ -0,0 +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';
+//# sourceMappingURL=enums.js.map

package/lib/enums.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../src/enums.ts"],"names":[],"mappings":";;;AAAA,IAAY,cAGX;AAHD,WAAY,cAAc;IACxB,wCAAsB,CAAA;IACtB,oCAAkB,CAAA;AACpB,CAAC,EAHW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAGzB;AAED,IAAY,UAKX;AALD,WAAY,UAAU;IACpB,iCAAmB,CAAA;IACnB,uCAAyB,CAAA;IACzB,iCAAmB,CAAA;IACnB,2CAA6B,CAAA;AAC/B,CAAC,EALW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAKrB;AAED,6EAAiE;AAEpD,QAAA,mBAAmB,GAAG,CAAE,cAAc,CAAC,QAAQ,EAAE,cAAc,CAAC,MAAM,CAAE,CAAC;AACzE,QAAA,cAAc,GAAG,CAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,OAAO,EAAE,UAAU,CAAC,YAAY,EAAE,UAAU,CAAC,UAAU,CAAE,CAAC;AAC5G,QAAA,aAAa,GAAG,CAAE,oCAAY,CAAC,OAAO,EAAE,oCAAY,CAAC,OAAO,EAAE,oCAAY,CAAC,GAAG,CAAE,CAAC;AACjF,QAAA,gBAAgB,GAAG,CAAE,CAAC,EAAE,QAAQ,CAAE,CAAC;AAEnC,QAAA,YAAY,GAAG;IAC1B,CAAC,EAAE,UAAU;IACb,CAAC,EAAE,SAAS;IACZ,CAAC,EAAE,aAAa;IAChB,EAAE,EAAE,WAAW;IACf,EAAE,EAAE,WAAW;IACf,EAAE,EAAE,SAAS;IACb,GAAG,EAAE,SAAS;CACf,CAAC;AAEW,QAAA,YAAY,GAAG,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAAC;AACpD,QAAA,WAAW,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;AAClD,QAAA,aAAa,GAAG,MAAM,CAAC,GAAG,CAAC,yBAAyB,CAAC,CAAC;AAEtD,QAAA,QAAQ,GAAG,OAAO,CAAC"}

package/lib/error-codes.d.ts

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

package/lib/error-codes.js

@@ -0,0 +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;
+//# sourceMappingURL=error-codes.js.map

package/lib/error-codes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"error-codes.js","sourceRoot":"","sources":["../src/error-codes.ts"],"names":[],"mappings":";;;AAMA,SAAS,uBAAuB,CAAC,UAAkB;IACjD,OAAO;QACL,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,UAAU;KAChB,CAAC;AACJ,CAAC;AA6CC,0DAAuB;AAxCzB,IAAK,cAqCJ;AArCD,WAAK,cAAc;IAOjB,8DAA4C,CAAA;IAO5C,0DAAwC,CAAA;IAOxC,sDAAoC,CAAA;IAOpC,8CAA4B,CAAA;IAQ5B,6CAA2B,CAAA;AAC7B,CAAC,EArCI,cAAc,KAAd,cAAc,QAqClB;AAIC,wCAAc"}

package/lib/explainable-cursor.d.ts

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

package/lib/explainable-cursor.js

@@ -0,0 +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;
+//# sourceMappingURL=explainable-cursor.js.map

package/lib/explainable-cursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explainable-cursor.js","sourceRoot":"","sources":["../src/explainable-cursor.ts"],"names":[],"mappings":";;;;;;;;;;;AAAA,6CAAoD;AACpD,sDAA8B;AAE9B,mCAAsC;AAItC,IAAqB,iBAAiB,GAAtC,MAAqB,iBAAkB,SAAQ,gBAAM;IAKnD,YAAY,KAAY,EAAE,MAAc,EAAE,SAA+B;QACvE,KAAK,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC;IACzB,CAAC;IAKD,KAAK,CAAC,CAAC,mBAAW,CAAC;;QAGjB,MAAA,IAAI,CAAC,UAAU,oCAAf,IAAI,CAAC,UAAU,GAAK,MAAM,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,EAAC;QACpE,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;CACF,CAAA;AArBoB,iBAAiB;IADrC,iCAAoB;GACA,iBAAiB,CAqBrC;kBArBoB,iBAAiB"}

package/lib/explainable.d.ts

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

package/lib/explainable.js

@@ -0,0 +1,167 @@
+"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 explainable_cursor_1 = __importDefault(require("./explainable-cursor"));
+const decorators_1 = require("./decorators");
+const enums_1 = require("./enums");
+const helpers_1 = require("./helpers");
+let Explainable = class Explainable extends decorators_1.ShellApiWithMongoClass {
+    constructor(mongo, collection, verbosity) {
+        super();
+        this._mongo = mongo;
+        this._collection = collection;
+        this._verbosity = verbosity;
+    }
+    [enums_1.asPrintable]() {
+        return `Explainable(${this._collection.getFullName()})`;
+    }
+    _emitExplainableApiCall(methodName, methodArguments = {}) {
+        this._mongo._instanceState.emitApiCallWithArgs({
+            method: methodName,
+            class: 'Explainable',
+            db: this._collection._database._name,
+            coll: this._collection._name,
+            arguments: methodArguments
+        });
+    }
+    getCollection() {
+        this._emitExplainableApiCall('getCollection');
+        return this._collection;
+    }
+    getVerbosity() {
+        this._emitExplainableApiCall('getVerbosity');
+        return this._verbosity;
+    }
+    setVerbosity(verbosity) {
+        verbosity = (0, helpers_1.validateExplainableVerbosity)(verbosity);
+        this._emitExplainableApiCall('setVerbosity', { verbosity });
+        this._verbosity = verbosity;
+    }
+    async find(query, projection) {
+        this._emitExplainableApiCall('find', { query, projection });
+        const cursor = await this._collection.find(query, projection);
+        return new explainable_cursor_1.default(this._mongo, cursor, this._verbosity);
+    }
+    async aggregate(...args) {
+        var _a;
+        this._emitExplainableApiCall('aggregate', { args });
+        let options;
+        let pipeline;
+        if (Array.isArray(args[0])) {
+            pipeline = args[0];
+            options = (_a = args[1]) !== null && _a !== void 0 ? _a : {};
+        }
+        else {
+            pipeline = args;
+            options = {};
+        }
+        return await this._collection.aggregate(pipeline, {
+            ...options,
+            explain: this._verbosity
+        });
+    }
+    async count(query = {}, options = {}) {
+        this._emitExplainableApiCall('count', { query, options });
+        return (0, helpers_1.markAsExplainOutput)(await this._collection._database._runCommand({
+            explain: {
+                count: `${this._collection._name}`,
+                query,
+                ...options
+            },
+            verbosity: this._verbosity
+        }));
+    }
+    async distinct(field, query, options = {}) {
+        this._emitExplainableApiCall('distinct', { field, query, options });
+        return this._collection.distinct(field, query !== null && query !== void 0 ? query : {}, { ...options, explain: this._verbosity });
+    }
+    async findAndModify(options) {
+        this._emitExplainableApiCall('findAndModify', { options });
+        return this._collection.findAndModify({ ...options, explain: this._verbosity });
+    }
+    async findOneAndDelete(filter, options = {}) {
+        this._emitExplainableApiCall('findOneAndDelete', { filter, options });
+        return this._collection.findOneAndDelete(filter, { ...options, explain: this._verbosity });
+    }
+    async findOneAndReplace(filter, replacement, options = {}) {
+        this._emitExplainableApiCall('findOneAndReplace', { filter, options });
+        return this._collection.findOneAndReplace(filter, replacement, { ...options, explain: this._verbosity });
+    }
+    async findOneAndUpdate(filter, update, options = {}) {
+        this._emitExplainableApiCall('findOneAndUpdate', { filter, options });
+        return this._collection.findOneAndUpdate(filter, update, { ...options, explain: this._verbosity });
+    }
+    async remove(query, options = {}) {
+        this._emitExplainableApiCall('remove', { query, options });
+        options = { ...(0, helpers_1.processRemoveOptions)(options), explain: this._verbosity };
+        return this._collection.remove(query, options);
+    }
+    async update(filter, update, options = {}) {
+        this._emitExplainableApiCall('update', { filter, update, options });
+        return this._collection.update(filter, update, { ...options, explain: this._verbosity });
+    }
+    async mapReduce(map, reduce, optionsOrOutString) {
+        this._emitExplainableApiCall('mapReduce', { map, reduce, optionsOrOutString });
+        const options = { ...(0, helpers_1.processMapReduceOptions)(optionsOrOutString), explain: this._verbosity };
+        return this._collection.mapReduce(map, reduce, options);
+    }
+};
+__decorate([
+    (0, decorators_1.returnType)('ExplainableCursor'),
+    (0, decorators_1.apiVersions)([1]),
+    decorators_1.returnsPromise
+], Explainable.prototype, "find", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "aggregate", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "count", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "distinct", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "findAndModify", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "findOneAndDelete", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "findOneAndReplace", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "findOneAndUpdate", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "remove", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], Explainable.prototype, "update", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.serverVersions)(['4.4.0', enums_1.ServerVersions.latest]),
+    (0, decorators_1.apiVersions)([])
+], Explainable.prototype, "mapReduce", null);
+Explainable = __decorate([
+    decorators_1.shellApiClassDefault
+], Explainable);
+exports.default = Explainable;
+//# sourceMappingURL=explainable.js.map

package/lib/explainable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explainable.js","sourceRoot":"","sources":["../src/explainable.ts"],"names":[],"mappings":";;;;;;;;;;;AAEA,8EAAqD;AACrD,6CAOsB;AACtB,mCAAsD;AACtD,uCASmB;AAanB,IAAqB,WAAW,GAAhC,MAAqB,WAAY,SAAQ,mCAAsB;IAI7D,YAAY,KAAY,EAAE,UAAsB,EAAE,SAA+B;QAC/E,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAKD,CAAC,mBAAW,CAAC;QACX,OAAO,eAAe,IAAI,CAAC,WAAW,CAAC,WAAW,EAAE,GAAG,CAAC;IAC1D,CAAC;IASO,uBAAuB,CAAC,UAAkB,EAAE,kBAA4B,EAAE;QAChF,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,mBAAmB,CAAC;YAC7C,MAAM,EAAE,UAAU;YAClB,KAAK,EAAE,aAAa;YACpB,EAAE,EAAE,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK;YACpC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK;YAC5B,SAAS,EAAE,eAAe;SAC3B,CAAC,CAAC;IACL,CAAC;IAED,aAAa;QACX,IAAI,CAAC,uBAAuB,CAAC,eAAe,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC,WAAW,CAAC;IAC1B,CAAC;IAED,YAAY;QACV,IAAI,CAAC,uBAAuB,CAAC,cAAc,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,YAAY,CAAC,SAA+B;QAC1C,SAAS,GAAG,IAAA,sCAA4B,EAAC,SAAS,CAAC,CAAC;QACpD,IAAI,CAAC,uBAAuB,CAAC,cAAc,EAAE,EAAE,SAAS,EAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAKD,KAAK,CAAC,IAAI,CAAC,KAAgB,EAAE,UAAqB;QAChD,IAAI,CAAC,uBAAuB,CAAC,MAAM,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC,CAAC;QAE5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;QAC9D,OAAO,IAAI,4BAAiB,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACrE,CAAC;IAMD,KAAK,CAAC,SAAS,CAAC,GAAG,IAAW;;QAC5B,IAAI,CAAC,uBAAuB,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACpD,IAAI,OAAiB,CAAC;QACtB,IAAI,QAAoB,CAAC;QACzB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE;YAC1B,QAAQ,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACnB,OAAO,GAAG,MAAA,IAAI,CAAC,CAAC,CAAC,mCAAI,EAAE,CAAC;SACzB;aAAM;YACL,QAAQ,GAAG,IAAI,CAAC;YAChB,OAAO,GAAG,EAAE,CAAC;SACd;QAED,OAAO,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE;YAChD,GAAG,OAAO;YACV,OAAO,EAAE,IAAI,CAAC,UAAU;SACzB,CAAC,CAAC;IACL,CAAC;IAID,KAAK,CAAC,KAAK,CAAC,KAAK,GAAG,EAAE,EAAE,UAAwB,EAAE;QAChD,IAAI,CAAC,uBAAuB,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAE1D,OAAO,IAAA,6BAAmB,EAAC,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,WAAW,CAAC;YACtE,OAAO,EAAE;gBACP,KAAK,EAAE,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,EAAE;gBAClC,KAAK;gBACL,GAAG,OAAO;aACX;YACD,SAAS,EAAE,IAAI,CAAC,UAAU;SAC3B,CAAC,CAAC,CAAC;IACN,CAAC;IAOD,KAAK,CAAC,QAAQ,CAAC,KAAa,EAAE,KAAgB,EAAE,UAA2B,EAAE;QAC3E,IAAI,CAAC,uBAAuB,CAAC,UAAU,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACjG,CAAC;IAID,KAAK,CAAC,aAAa,CAAC,OAAwC;QAC1D,IAAI,CAAC,uBAAuB,CAAC,eAAe,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3D,OAAO,IAAI,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAClF,CAAC;IAID,KAAK,CAAC,gBAAgB,CAAC,MAAgB,EAAE,UAAmC,EAAE;QAC5E,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC7F,CAAC;IAID,KAAK,CAAC,iBAAiB,CAAC,MAAgB,EAAE,WAAqB,EAAE,UAA+D,EAAE;QAChI,IAAI,CAAC,uBAAuB,CAAC,mBAAmB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACvE,OAAO,IAAI,CAAC,WAAW,CAAC,iBAAiB,CAAC,MAAM,EAAE,WAAW,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3G,CAAC;IAID,KAAK,CAAC,gBAAgB,CAAC,MAAgB,EAAE,MAAgB,EAAE,UAA8D,EAAE;QACzH,IAAI,CAAC,uBAAuB,CAAC,kBAAkB,EAAE,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACtE,OAAO,IAAI,CAAC,WAAW,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IACrG,CAAC;IAID,KAAK,CAAC,MAAM,CAAC,KAAe,EAAE,UAAwC,EAAE;QACtE,IAAI,CAAC,uBAAuB,CAAC,QAAQ,EAAE,EAAE,KAAK,EAAE,OAAO,EAAE,CAAC,CAAC;QAC3D,OAAO,GAAG,EAAE,GAAG,IAAA,8BAAoB,EAAC,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QACzE,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IAID,KAAK,CAAC,MAAM,CAAC,MAAgB,EAAE,MAAgB,EAAE,UAAyB,EAAE;QAC1E,IAAI,CAAC,uBAAuB,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACpE,OAAO,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,GAAG,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC,CAAC;IAC3F,CAAC;IAKD,KAAK,CAAC,SAAS,CACb,GAAsB,EACtB,MAAyB,EACzB,kBAAyC;QACzC,IAAI,CAAC,uBAAuB,CAAC,WAAW,EAAE,EAAE,GAAG,EAAE,MAAM,EAAE,kBAAkB,EAAE,CAAC,CAAC;QAC/E,MAAM,OAAO,GAAG,EAAE,GAAG,IAAA,iCAAuB,EAAC,kBAAkB,CAAC,EAAE,OAAO,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1D,CAAC;CACF,CAAA;AA5GC;IAHC,IAAA,uBAAU,EAAC,mBAAmB,CAAC;IAC/B,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;IAChB,2BAAc;uCAMd;AAMD;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;4CAiBhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;wCAYhB;AAOD;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;2CAIhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;gDAIhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;mDAIhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;oDAIhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;mDAIhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;yCAKhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;yCAIhB;AAKD;IAHC,2BAAc;IACd,IAAA,2BAAc,EAAC,CAAC,OAAO,EAAE,sBAAc,CAAC,MAAM,CAAC,CAAC;IAChD,IAAA,wBAAW,EAAC,EAAE,CAAC;4CAQf;AAjKkB,WAAW;IAD/B,iCAAoB;GACA,WAAW,CAkK/B;kBAlKoB,WAAW"}

package/lib/field-level-encryption.d.ts

@@ -0,0 +1,50 @@
+/// <reference types="node" />
+import { ShellApiWithMongoClass } from './decorators';
+import { ClientEncryption as MongoCryptClientEncryption, ClientEncryptionDataKeyProvider, ClientEncryptionEncryptOptions, ClientEncryptionTlsOptions, KMSProviders, AWSEncryptionKeyOptions, AzureEncryptionKeyOptions, GCPEncryptionKeyOptions } from '@qp-mongosh/service-provider-core';
+import type { Document, BinaryType } from '@qp-mongosh/service-provider-core';
+import Cursor from './cursor';
+import { DeleteResult } from './result';
+import { asPrintable } from './enums';
+import type Mongo from './mongo';
+import { Binary } from 'qp-mongodb';
+export declare type ClientSideFieldLevelEncryptionKmsProvider = Omit<KMSProviders, 'local'> & {
+    local?: {
+        key: Buffer | string | BinaryType;
+    };
+};
+export interface ClientSideFieldLevelEncryptionOptions {
+    keyVaultClient?: Mongo;
+    keyVaultNamespace: string;
+    kmsProviders: ClientSideFieldLevelEncryptionKmsProvider;
+    schemaMap?: Document;
+    bypassAutoEncryption?: boolean;
+    explicitEncryptionOnly?: boolean;
+    tlsOptions?: {
+        [k in keyof ClientSideFieldLevelEncryptionKmsProvider]?: ClientEncryptionTlsOptions;
+    };
+}
+export declare class ClientEncryption extends ShellApiWithMongoClass {
+    _mongo: Mongo;
+    _libmongocrypt: MongoCryptClientEncryption;
+    constructor(mongo: Mongo);
+    [asPrintable](): string;
+    encrypt(encryptionId: Binary, value: any, encryptionAlgorithm: ClientEncryptionEncryptOptions['algorithm']): Promise<Binary>;
+    decrypt(encryptedValue: Binary): Promise<any>;
+}
+export declare class KeyVault extends ShellApiWithMongoClass {
+    _mongo: Mongo;
+    _clientEncryption: ClientEncryption;
+    private _keyColl;
+    constructor(clientEncryption: ClientEncryption);
+    [asPrintable](): string;
+    createKey(kms: 'local', keyAltNames?: string[]): Promise<Document>;
+    createKey(kms: ClientEncryptionDataKeyProvider, legacyMasterKey: string, keyAltNames?: string[]): Promise<Document>;
+    createKey(kms: ClientEncryptionDataKeyProvider, options: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | undefined): Promise<Document>;
+    createKey(kms: ClientEncryptionDataKeyProvider, options: AWSEncryptionKeyOptions | AzureEncryptionKeyOptions | GCPEncryptionKeyOptions | undefined, keyAltNames: string[]): Promise<Document>;
+    getKey(keyId: BinaryType): Promise<Cursor>;
+    getKeyByAltName(keyAltName: string): Promise<Cursor>;
+    getKeys(): Promise<Cursor>;
+    deleteKey(keyId: BinaryType): Promise<DeleteResult | Document>;
+    addKeyAlternateName(keyId: BinaryType, keyAltName: string): Promise<Document>;
+    removeKeyAlternateName(keyId: BinaryType, keyAltName: string): Promise<Document>;
+}

package/lib/field-level-encryption.js

@@ -0,0 +1,177 @@
+"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 });
+exports.KeyVault = exports.ClientEncryption = void 0;
+const decorators_1 = require("./decorators");
+const service_provider_core_1 = require("@qp-mongosh/service-provider-core");
+const helpers_1 = require("./helpers");
+const enums_1 = require("./enums");
+const history_1 = require("@qp-mongosh/history");
+const errors_1 = require("@qp-mongosh/errors");
+let ClientEncryption = class ClientEncryption extends decorators_1.ShellApiWithMongoClass {
+    constructor(mongo) {
+        super();
+        this._mongo = mongo;
+        const fle = mongo._serviceProvider.fle;
+        if (!fle) {
+            throw new errors_1.MongoshRuntimeError('FLE API is not available');
+        }
+        const fleOptions = { ...this._mongo._fleOptions };
+        delete fleOptions.schemaMap;
+        this._libmongocrypt = new fle.ClientEncryption(mongo._serviceProvider.getRawClient(), fleOptions);
+    }
+    [enums_1.asPrintable]() {
+        return `ClientEncryption class for ${(0, history_1.redactURICredentials)(this._mongo._uri)}`;
+    }
+    async encrypt(encryptionId, value, encryptionAlgorithm) {
+        (0, helpers_1.assertArgsDefinedType)([encryptionId, value, encryptionAlgorithm], [true, true, true], 'ClientEncryption.encrypt');
+        return await this._libmongocrypt.encrypt(value, {
+            keyId: encryptionId,
+            algorithm: encryptionAlgorithm
+        });
+    }
+    async decrypt(encryptedValue) {
+        (0, helpers_1.assertArgsDefinedType)([encryptedValue], [true], 'ClientEncryption.decrypt');
+        return await this._libmongocrypt.decrypt(encryptedValue);
+    }
+};
+__decorate([
+    decorators_1.returnsPromise
+], ClientEncryption.prototype, "encrypt", null);
+__decorate([
+    decorators_1.returnsPromise
+], ClientEncryption.prototype, "decrypt", null);
+ClientEncryption = __decorate([
+    decorators_1.shellApiClassDefault,
+    (0, decorators_1.classPlatforms)([service_provider_core_1.ReplPlatform.CLI])
+], ClientEncryption);
+exports.ClientEncryption = ClientEncryption;
+let KeyVault = class KeyVault extends decorators_1.ShellApiWithMongoClass {
+    constructor(clientEncryption) {
+        super();
+        this._mongo = clientEncryption._mongo;
+        this._clientEncryption = clientEncryption;
+        if (!this._mongo._fleOptions || !this._mongo._fleOptions.keyVaultNamespace) {
+            throw new errors_1.MongoshInvalidInputError('FLE options must be passed to the Mongo object');
+        }
+        const [db, coll] = this._mongo._fleOptions.keyVaultNamespace.split('.');
+        this._keyColl = this._mongo.getDB(db).getCollection(coll);
+    }
+    [enums_1.asPrintable]() {
+        return `KeyVault class for ${(0, history_1.redactURICredentials)(this._mongo._uri)}`;
+    }
+    async createKey(kms, masterKeyOrAltNames, keyAltNames) {
+        (0, helpers_1.assertArgsDefinedType)([kms], [true], 'KeyVault.createKey');
+        if (typeof masterKeyOrAltNames === 'string') {
+            if (kms === 'local' && masterKeyOrAltNames === '') {
+                masterKeyOrAltNames = undefined;
+            }
+            else {
+                throw new errors_1.MongoshInvalidInputError('KeyVault.createKey does not support providing masterKey as string anymore. For AWS please use createKey("aws", { region: ..., key: ... })', errors_1.CommonErrors.Deprecated);
+            }
+        }
+        else if (Array.isArray(masterKeyOrAltNames)) {
+            if (kms !== 'local') {
+                throw new errors_1.MongoshInvalidInputError('KeyVault.createKey requires masterKey to be given as second argument if KMS is not local', errors_1.CommonErrors.InvalidArgument);
+            }
+            else {
+                if (keyAltNames) {
+                    throw new errors_1.MongoshInvalidInputError('KeyVault.createKey was supplied with an array for the masterKey and keyAltNames - either specify keyAltNames as second argument or set undefined for masterKey', errors_1.CommonErrors.InvalidArgument);
+                }
+                keyAltNames = masterKeyOrAltNames;
+                masterKeyOrAltNames = undefined;
+            }
+        }
+        let options;
+        if (masterKeyOrAltNames) {
+            options = {
+                masterKey: masterKeyOrAltNames
+            };
+        }
+        if (keyAltNames) {
+            options = {
+                ...(options !== null && options !== void 0 ? options : {}),
+                keyAltNames
+            };
+        }
+        return await this._clientEncryption._libmongocrypt.createDataKey(kms, options);
+    }
+    async getKey(keyId) {
+        (0, helpers_1.assertArgsDefinedType)([keyId], [true], 'KeyVault.getKey');
+        return this._keyColl.find({ '_id': keyId });
+    }
+    async getKeyByAltName(keyAltName) {
+        (0, helpers_1.assertArgsDefinedType)([keyAltName], ['string'], 'KeyVault.getKeyByAltName');
+        return this._keyColl.find({ 'keyAltNames': keyAltName });
+    }
+    async getKeys() {
+        return this._keyColl.find({});
+    }
+    async deleteKey(keyId) {
+        (0, helpers_1.assertArgsDefinedType)([keyId], [true], 'KeyVault.deleteKey');
+        return this._keyColl.deleteOne({ '_id': keyId });
+    }
+    async addKeyAlternateName(keyId, keyAltName) {
+        (0, helpers_1.assertArgsDefinedType)([keyId, keyAltName], [true, 'string'], 'KeyVault.addKeyAlternateName');
+        return this._keyColl.findAndModify({
+            query: { '_id': keyId },
+            update: { $push: { 'keyAltNames': keyAltName }, $currentDate: { 'updateDate': true } },
+        });
+    }
+    async removeKeyAlternateName(keyId, keyAltName) {
+        (0, helpers_1.assertArgsDefinedType)([keyId, keyAltName], [true, 'string'], 'KeyVault.removeKeyAlternateName');
+        const ret = await this._keyColl.findAndModify({
+            query: { '_id': keyId },
+            update: { $pull: { 'keyAltNames': keyAltName }, $currentDate: { 'updateDate': true } }
+        });
+        if (ret !== null && ret.keyAltNames !== undefined && ret.keyAltNames.length === 1 && ret.keyAltNames[0] === keyAltName) {
+            return this._keyColl.findAndModify({
+                query: { '_id': keyId, 'keyAltNames': undefined },
+                update: { $unset: { 'keyAltNames': '' }, $currentDate: { 'updateDate': true } }
+            });
+        }
+        return ret;
+    }
+};
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], KeyVault.prototype, "createKey", null);
+__decorate([
+    (0, decorators_1.returnType)('Cursor'),
+    (0, decorators_1.apiVersions)([1]),
+    decorators_1.returnsPromise
+], KeyVault.prototype, "getKey", null);
+__decorate([
+    (0, decorators_1.returnType)('Cursor'),
+    (0, decorators_1.apiVersions)([1]),
+    decorators_1.returnsPromise
+], KeyVault.prototype, "getKeyByAltName", null);
+__decorate([
+    (0, decorators_1.returnType)('Cursor'),
+    (0, decorators_1.apiVersions)([1]),
+    decorators_1.returnsPromise
+], KeyVault.prototype, "getKeys", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], KeyVault.prototype, "deleteKey", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], KeyVault.prototype, "addKeyAlternateName", null);
+__decorate([
+    decorators_1.returnsPromise,
+    (0, decorators_1.apiVersions)([1])
+], KeyVault.prototype, "removeKeyAlternateName", null);
+KeyVault = __decorate([
+    decorators_1.shellApiClassDefault,
+    (0, decorators_1.classPlatforms)([service_provider_core_1.ReplPlatform.CLI])
+], KeyVault);
+exports.KeyVault = KeyVault;
+//# sourceMappingURL=field-level-encryption.js.map

package/lib/field-level-encryption.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"field-level-encryption.js","sourceRoot":"","sources":["../src/field-level-encryption.ts"],"names":[],"mappings":";;;;;;;;;AAAA,6CAOsB;AACtB,6EAY2C;AAK3C,uCAAkD;AAClD,mCAAsC;AACtC,iDAA2D;AAE3D,+CAAiG;AAqBjG,IAAa,gBAAgB,GAA7B,MAAa,gBAAiB,SAAQ,mCAAsB;IAI1D,YAAY,KAAY;QACtB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QAEpB,MAAM,GAAG,GAAG,KAAK,CAAC,gBAAgB,CAAC,GAAG,CAAC;QACvC,IAAI,CAAC,GAAG,EAAE;YACR,MAAM,IAAI,4BAAmB,CAAC,0BAA0B,CAAC,CAAC;SAC3D;QAGD,MAAM,UAAU,GAAG,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,CAAC;QAE5B,IAAI,CAAC,cAAc,GAAG,IAAI,GAAG,CAAC,gBAAgB,CAC5C,KAAK,CAAC,gBAAgB,CAAC,YAAY,EAAE,EACrC,UAAqC,CACtC,CAAC;IACJ,CAAC;IAED,CAAC,mBAAW,CAAC;QACX,OAAO,8BAA8B,IAAA,8BAAoB,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IAChF,CAAC;IAGD,KAAK,CAAC,OAAO,CACX,YAAoB,EACpB,KAAU,EACV,mBAAgE;QAEhE,IAAA,+BAAqB,EAAC,CAAC,YAAY,EAAE,KAAK,EAAE,mBAAmB,CAAC,EAAE,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,0BAA0B,CAAC,CAAC;QAClH,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CACtC,KAAK,EACL;YACE,KAAK,EAAE,YAAY;YACnB,SAAS,EAAE,mBAAmB;SAC/B,CACF,CAAC;IACJ,CAAC;IAGD,KAAK,CAAC,OAAO,CACX,cAAsB;QAEtB,IAAA,+BAAqB,EAAC,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,0BAA0B,CAAC,CAAC;QAC5E,OAAO,MAAM,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;IAC3D,CAAC;CACF,CAAA;AAtBC;IADC,2BAAc;+CAcd;AAGD;IADC,2BAAc;+CAMd;AAjDU,gBAAgB;IAF5B,iCAAoB;IACpB,IAAA,2BAAc,EAAC,CAAE,oCAAY,CAAC,GAAG,CAAE,CAAE;GACzB,gBAAgB,CAkD5B;AAlDY,4CAAgB;AAsD7B,IAAa,QAAQ,GAArB,MAAa,QAAS,SAAQ,mCAAsB;IAIlD,YAAY,gBAAkC;QAC5C,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC;QACtC,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAiB,EAAE;YAC1E,MAAM,IAAI,iCAAwB,CAAC,gDAAgD,CAAC,CAAC;SACtF;QACD,MAAM,CAAE,EAAE,EAAE,IAAI,CAAE,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAC1E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAC5D,CAAC;IAED,CAAC,mBAAW,CAAC;QACX,OAAO,sBAAsB,IAAA,8BAAoB,EAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;IACxE,CAAC;IAQD,KAAK,CAAC,SAAS,CACb,GAAoC,EACpC,mBAAmI,EACnI,WAAsB;QAEtB,IAAA,+BAAqB,EAAC,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC;QAE3D,IAAI,OAAO,mBAAmB,KAAK,QAAQ,EAAE;YAC3C,IAAI,GAAG,KAAK,OAAO,IAAI,mBAAmB,KAAK,EAAE,EAAE;gBAGjD,mBAAmB,GAAG,SAAS,CAAC;aACjC;iBAAM;gBACL,MAAM,IAAI,iCAAwB,CAChC,2IAA2I,EAC3I,qBAAY,CAAC,UAAU,CACxB,CAAC;aACH;SACF;aAAM,IAAI,KAAK,CAAC,OAAO,CAAC,mBAAmB,CAAC,EAAE;YAG7C,IAAI,GAAG,KAAK,OAAO,EAAE;gBACnB,MAAM,IAAI,iCAAwB,CAChC,0FAA0F,EAC1F,qBAAY,CAAC,eAAe,CAC7B,CAAC;aACH;iBAAM;gBACL,IAAI,WAAW,EAAE;oBACf,MAAM,IAAI,iCAAwB,CAChC,gKAAgK,EAChK,qBAAY,CAAC,eAAe,CAC7B,CAAC;iBACH;gBAED,WAAW,GAAG,mBAAmB,CAAC;gBAClC,mBAAmB,GAAG,SAAS,CAAC;aACjC;SACF;QAED,IAAI,OAAiE,CAAC;QACtE,IAAI,mBAAmB,EAAE;YACvB,OAAO,GAAG;gBACR,SAAS,EAAE,mBAAgF;aAC5F,CAAC;SACH;QACD,IAAI,WAAW,EAAE;YACf,OAAO,GAAG;gBACR,GAAG,CAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,CAAC;gBAClB,WAAW;aACZ,CAAC;SACH;QAED,OAAO,MAAM,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,aAAa,CAAC,GAAG,EAAE,OAAuD,CAAC,CAAC;IACjI,CAAC;IAKD,KAAK,CAAC,MAAM,CAAC,KAAiB;QAC5B,IAAA,+BAAqB,EAAC,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,iBAAiB,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IAC9C,CAAC;IAKD,KAAK,CAAC,eAAe,CAAC,UAAkB;QACtC,IAAA,+BAAqB,EAAC,CAAC,UAAU,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,0BAA0B,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,aAAa,EAAE,UAAU,EAAE,CAAC,CAAC;IAC3D,CAAC;IAKD,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAChC,CAAC;IAID,KAAK,CAAC,SAAS,CAAC,KAAiB;QAC/B,IAAA,+BAAqB,EAAC,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,oBAAoB,CAAC,CAAC;QAC7D,OAAO,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAAC;IACnD,CAAC;IAID,KAAK,CAAC,mBAAmB,CAAC,KAAiB,EAAE,UAAkB;QAC7D,IAAA,+BAAqB,EAAC,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,8BAA8B,CAAC,CAAC;QAC7F,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;YACjC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;YACvB,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE;SACvF,CAAC,CAAC;IACL,CAAC;IAID,KAAK,CAAC,sBAAsB,CAAC,KAAiB,EAAE,UAAkB;QAChE,IAAA,+BAAqB,EAAC,CAAC,KAAK,EAAE,UAAU,CAAC,EAAE,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,iCAAiC,CAAC,CAAC;QAChG,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;YAC5C,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE;YACvB,MAAM,EAAE,EAAE,KAAK,EAAE,EAAE,aAAa,EAAE,UAAU,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE;SACvF,CAAC,CAAC;QAEH,IAAI,GAAG,KAAK,IAAI,IAAI,GAAG,CAAC,WAAW,KAAK,SAAS,IAAI,GAAG,CAAC,WAAW,CAAC,MAAM,KAAK,CAAC,IAAI,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,UAAU,EAAE;YAEtH,OAAO,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC;gBACjC,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,aAAa,EAAE,SAAS,EAAE;gBACjD,MAAM,EAAE,EAAE,MAAM,EAAE,EAAE,aAAa,EAAE,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE;aAChF,CAAC,CAAC;SACJ;QACD,OAAO,GAAG,CAAC;IACb,CAAC;CACF,CAAA;AAjHC;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;yCAsDhB;AAKD;IAHC,IAAA,uBAAU,EAAC,QAAQ,CAAC;IACpB,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;IAChB,2BAAc;sCAId;AAKD;IAHC,IAAA,uBAAU,EAAC,QAAQ,CAAC;IACpB,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;IAChB,2BAAc;+CAId;AAKD;IAHC,IAAA,uBAAU,EAAC,QAAQ,CAAC;IACpB,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;IAChB,2BAAc;uCAGd;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;yCAIhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;mDAOhB;AAID;IAFC,2BAAc;IACd,IAAA,wBAAW,EAAC,CAAC,CAAC,CAAC,CAAC;sDAgBhB;AAzIU,QAAQ;IAFpB,iCAAoB;IACpB,IAAA,2BAAc,EAAC,CAAE,oCAAY,CAAC,GAAG,CAAE,CAAE;GACzB,QAAQ,CA0IpB;AA1IY,4BAAQ"}

package/lib/help.d.ts

@@ -0,0 +1,22 @@
+import { shellApiType, asPrintable } from './enums';
+declare type HelpPropertiesAttr = {
+    name?: string;
+    description: string;
+};
+export declare type HelpProperties = {
+    help: string;
+    docs?: string;
+    attr?: HelpPropertiesAttr[];
+};
+declare type HelpOptions = {
+    translate(key: string): string | undefined;
+};
+export default class Help {
+    private help;
+    private docs;
+    private attr;
+    constructor(properties: HelpProperties, options?: HelpOptions);
+    [asPrintable](): HelpProperties;
+    get [shellApiType](): string;
+}
+export {};