@qp-mongosh/shell-api 0.0.0-dev.27 → 0.0.0-dev.28

package/lib/help.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const i18n_1 = __importDefault(require("@qp-mongosh/i18n"));
-const enums_1 = require("./enums");
-const DEFAULT_TRANSLATE = i18n_1.default.translateApiHelp.bind(i18n_1.default);
-class Help {
-    constructor(properties, options = { translate: DEFAULT_TRANSLATE }) {
-        this.attr = [];
-        this.help = options.translate(properties.help);
-        this.docs = options.translate(properties.docs);
-        this.attr = (properties.attr || [])
-            .map((attr) => ({
-            name: attr.name,
-            description: options.translate(attr.description),
-        })).filter(attr => attr.description);
-    }
-    [enums_1.asPrintable]() {
-        const { help, docs, attr } = this;
-        return { help, docs, attr };
-    }
-    get [enums_1.shellApiType]() { return 'Help'; }
-}
-exports.default = Help;
-//# sourceMappingURL=help.js.map

package/lib/help.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"help.js","sourceRoot":"","sources":["../src/help.ts"],"names":[],"mappings":";;;;;AAAA,4DAAoC;AACpC,mCAAoD;AAiBpD,MAAM,iBAAiB,GAAG,cAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,cAAI,CAAC,CAAC;AAE3D,MAAqB,IAAI;IAKvB,YAAY,UAA0B,EAAE,UAAuB,EAAE,SAAS,EAAE,iBAAiB,EAAE;QAFvF,SAAI,GAAyB,EAAE,CAAC;QAGtC,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,IAAI,CAAW,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,IAAc,CAAW,CAAC;QACnE,IAAI,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,EAAE,CAAC;aAChC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YACd,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC;SACjD,CAAC,CAAC,CAAC,MAAM,CACR,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,WAAW,CACD,CAAC;IAC9B,CAAC;IAKD,CAAC,mBAAW,CAAC;QACX,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAClC,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IAC9B,CAAC;IAED,IAAI,CAAC,oBAAY,CAAC,KAAa,OAAO,MAAM,CAAC,CAAC,CAAC;CAChD;AA1BD,uBA0BC"}

package/lib/helpers.d.ts

@@ -1,71 +0,0 @@
-import type { DbOptions, Document, ExplainVerbosityLike, FindOneAndDeleteOptions, FindOneAndReplaceOptions, FindOneAndUpdateOptions, DeleteOptions, MapReduceOptions, ExplainOptions } from '@qp-mongosh/service-provider-core';
-import type Database from './database';
-import type Collection from './collection';
-import { CursorIterationResult } from './result';
-import { ReplPlatform } from '@qp-mongosh/service-provider-core';
-import { ClientSideFieldLevelEncryptionOptions } from './field-level-encryption';
-import { AutoEncryptionOptions } from 'qp-mongodb';
-import type { AbstractCursor } from './abstract-cursor';
-import type ChangeStreamCursor from './change-stream-cursor';
-import type { ShellBson } from './shell-bson';
-export declare function adaptAggregateOptions(options?: any): {
-    aggOptions: Document;
-    dbOptions: DbOptions;
-    explain?: ExplainVerbosityLike & string;
-};
-export declare function validateExplainableVerbosity(verbosity: ExplainVerbosityLike): ExplainVerbosityLike & string;
-export declare function assertArgsDefinedType(args: any[], expectedTypes: Array<true | string | Array<string | undefined>>, func?: string): void;
-export declare function assertKeysDefined(object: any, keys: string[]): void;
-export declare function adaptOptions(shellToCommand: any, additions: any, shellDoc: any): any;
-export declare function processDigestPassword(username: string, passwordDigestor: 'server' | 'client', command: {
-    pwd: string;
-}): {
-    digestPassword?: boolean;
-    pwd?: string;
-};
-export declare function getPrintableShardStatus(configDB: Database, verbose: boolean): Promise<Document>;
-export declare function getConfigDB(db: Database): Promise<Database>;
-export declare function dataFormat(bytes?: number): string;
-export declare function tsToSeconds(x: any): number;
-export declare function addHiddenDataProperty<T = any>(target: T, key: string | symbol, value: any): T;
-export declare function iterate(results: CursorIterationResult, cursor: AbstractCursor<any> | ChangeStreamCursor, batchSize: number): Promise<CursorIterationResult>;
-export declare type FindAndModifyMethodShellOptions = {
-    query: Document;
-    sort?: (FindOneAndDeleteOptions | FindOneAndReplaceOptions | FindOneAndUpdateOptions)['sort'];
-    update?: Document | Document[];
-    remove?: boolean;
-    new?: boolean;
-    fields?: Document;
-    upsert?: boolean;
-    bypassDocumentValidation?: boolean;
-    writeConcern?: Document;
-    collation?: (FindOneAndDeleteOptions | FindOneAndReplaceOptions | FindOneAndUpdateOptions)['collation'];
-    arrayFilters?: Document[];
-    explain?: ExplainVerbosityLike;
-};
-export declare type FindAndModifyShellOptions<BaseOptions extends FindOneAndReplaceOptions | FindOneAndUpdateOptions> = BaseOptions & {
-    returnOriginal?: boolean;
-    returnNewDocument?: boolean;
-    new?: boolean;
-};
-export declare function processFindAndModifyOptions<BaseOptions extends FindOneAndReplaceOptions | FindOneAndUpdateOptions>(options: FindAndModifyShellOptions<BaseOptions>): BaseOptions;
-export declare type RemoveShellOptions = DeleteOptions & {
-    justOne?: boolean;
-};
-export declare function processRemoveOptions(options: boolean | RemoveShellOptions): RemoveShellOptions;
-export declare type MapReduceShellOptions = Document | string;
-export declare function processMapReduceOptions(optionsOrOutString: MapReduceShellOptions): MapReduceOptions;
-export declare function setHideIndex(coll: Collection, index: string | Document, hidden: boolean): Promise<Document>;
-export declare function assertCLI(platform: ReplPlatform, features: string): void;
-export declare function processFLEOptions(fleOptions: ClientSideFieldLevelEncryptionOptions): AutoEncryptionOptions;
-declare type NotAPromise = {
-    [key: string]: any;
-    then?: never;
-};
-export declare function maybeMarkAsExplainOutput<T extends NotAPromise>(value: T, options: ExplainOptions): T;
-export declare function markAsExplainOutput<T extends NotAPromise>(value: T): T;
-export declare function isValidDatabaseName(name: string): boolean;
-export declare function isValidCollectionName(name: string): boolean;
-export declare function shouldRunAggregationImmediately(pipeline: Document[]): boolean;
-export declare function adjustRunCommand(cmd: Document, shellBson: ShellBson): Document;
-export {};