@qp-mongosh/types 0.0.0-dev.28 → 0.0.0-dev.29

package/lib/index.d.ts

@@ -0,0 +1,236 @@
+import type { ConnectEventMap } from '@mongodb-js/devtools-connect';
+export interface ApiEventArguments {
+    pipeline?: any[];
+    query?: object;
+    options?: object;
+    filter?: object;
+}
+export interface ApiEventWithArguments {
+    method: string;
+    class?: string;
+    db?: string;
+    coll?: string;
+    uri?: string;
+    arguments?: ApiEventArguments;
+}
+export interface ApiEvent {
+    method: string;
+    class: string;
+    deprecated: boolean;
+    isAsync: boolean;
+    callDepth: number;
+}
+export interface ApiWarning {
+    method: string;
+    class: string;
+    message: string;
+}
+export interface UseEvent {
+    db: string;
+}
+export interface EvaluateInputEvent {
+    input: string;
+}
+export interface ShowEvent {
+    method: string;
+}
+export interface ConnectEvent {
+    is_atlas: boolean;
+    is_localhost: boolean;
+    is_do: boolean;
+    server_version: string;
+    server_os?: string;
+    server_arch?: string;
+    is_enterprise: boolean;
+    auth_type?: string;
+    is_data_lake: boolean;
+    dl_version?: string;
+    is_genuine: boolean;
+    non_genuine_server_name: string;
+    api_version?: string;
+    api_strict?: boolean;
+    api_deprecation_errors?: boolean;
+    node_version: string;
+    uri: string;
+}
+export interface ScriptLoadFileEvent {
+    nested: boolean;
+    filename: string;
+}
+export interface StartLoadingCliScriptsEvent {
+    usesShellOption: boolean;
+}
+export interface GlobalConfigFileLoadEvent {
+    filename: string;
+    found: boolean;
+}
+export interface MongocryptdTrySpawnEvent {
+    spawnPath: string[];
+    path: string;
+}
+export interface MongocryptdErrorEvent {
+    cause: string;
+    error?: Error;
+    stderr?: string;
+    pid?: number;
+}
+export interface MongocryptdLogEvent {
+    pid: number;
+    logEntry: any;
+}
+export interface StartMongoshReplEvent {
+    version: string;
+}
+export interface SnippetsLoadedEvent {
+    installdir: string;
+}
+export interface SnippetsNpmLookupEvent {
+    existingVersion: string;
+}
+export interface SnippetsNpmDownloadActiveEvent {
+    npmMetadataURL: string;
+    npmTarballURL: string;
+}
+export interface SnippetsNpmDownloadFailedEvent {
+    npmMetadataURL: string;
+    npmTarballURL?: string;
+    status?: number;
+}
+export interface SnippetsFetchIndexEvent {
+    refreshMode: string;
+}
+export interface SnippetsFetchIndexErrorEvent {
+    action: string;
+    url?: string;
+    status?: number;
+    error?: string;
+}
+export interface SnippetsErrorEvent {
+    error: string;
+}
+export interface SnippetsRunNpmEvent {
+    args: string[];
+}
+export interface SnippetsLoadSnippetEvent {
+    source: string;
+    name: string;
+}
+export interface SnippetsCommandEvent {
+    args: string[];
+}
+export interface SnippetsTransformErrorEvent {
+    error: string;
+    addition: string;
+    name: string;
+}
+export interface EditorRunEditCommandEvent {
+    tmpDoc: string;
+    editor: string;
+    code: string;
+}
+export interface EditorReadVscodeExtensionsDoneEvent {
+    vscodeDir: string;
+    hasMongodbExtension: boolean;
+}
+export interface EditorReadVscodeExtensionsFailedEvent {
+    vscodeDir: string;
+    error: Error;
+}
+export interface MongoshBusEventsMap extends ConnectEventMap {
+    'mongosh:connect': (ev: ConnectEvent) => void;
+    'mongosh:new-user': (identity: {
+        userId: string;
+        anonymousId: string;
+    }) => void;
+    'mongosh:update-user': (identity: {
+        userId: string;
+        anonymousId?: string;
+    }) => void;
+    'mongosh:error': (error: Error, component: string) => void;
+    'mongosh:evaluate-input': (ev: EvaluateInputEvent) => void;
+    'mongosh:evaluate-started': () => void;
+    'mongosh:evaluate-finished': () => void;
+    'mongosh:use': (ev: UseEvent) => void;
+    'mongosh:getDB': (ev: UseEvent) => void;
+    'mongosh:show': (ev: ShowEvent) => void;
+    'mongosh:setCtx': (ev: ApiEventWithArguments) => void;
+    'mongosh:api-call-with-arguments': (ev: ApiEventWithArguments) => void;
+    'mongosh:api-call': (ev: ApiEvent) => void;
+    'mongosh:warn': (ev: ApiWarning) => void;
+    'mongosh:api-load-file': (ev: ScriptLoadFileEvent) => void;
+    'mongosh:start-loading-cli-scripts': (event: StartLoadingCliScriptsEvent) => void;
+    'mongosh:start-mongosh-repl': (ev: StartMongoshReplEvent) => void;
+    'mongosh:mongoshrc-load': () => void;
+    'mongosh:globalconfig-load': (ev: GlobalConfigFileLoadEvent) => void;
+    'mongosh:mongoshrc-mongorc-warn': () => void;
+    'mongosh:eval-cli-script': () => void;
+    'mongosh:eval-interrupted': () => void;
+    'mongosh:mongocryptd-tryspawn': (ev: MongocryptdTrySpawnEvent) => void;
+    'mongosh:mongocryptd-error': (ev: MongocryptdErrorEvent) => void;
+    'mongosh:mongocryptd-log': (ev: MongocryptdLogEvent) => void;
+    'mongosh:closed': () => void;
+    'mongosh:eval-complete': () => void;
+    'mongosh:autocompletion-complete': () => void;
+    'mongosh:interrupt-complete': () => void;
+    'mongosh-snippets:loaded': (ev: SnippetsLoadedEvent) => void;
+    'mongosh-snippets:npm-lookup': (ev: SnippetsNpmLookupEvent) => void;
+    'mongosh-snippets:npm-lookup-stopped': () => void;
+    'mongosh-snippets:npm-download-failed': (ev: SnippetsNpmDownloadFailedEvent) => void;
+    'mongosh-snippets:npm-download-active': (ev: SnippetsNpmDownloadActiveEvent) => void;
+    'mongosh-snippets:fetch-index': (ev: SnippetsFetchIndexEvent) => void;
+    'mongosh-snippets:fetch-cache-invalid': () => void;
+    'mongosh-snippets:fetch-index-error': (ev: SnippetsFetchIndexErrorEvent) => void;
+    'mongosh-snippets:fetch-index-done': () => void;
+    'mongosh-snippets:package-json-edit-error': (ev: SnippetsErrorEvent) => void;
+    'mongosh-snippets:spawn-child': (ev: SnippetsRunNpmEvent) => void;
+    'mongosh-snippets:load-snippet': (ev: SnippetsLoadSnippetEvent) => void;
+    'mongosh-snippets:snippet-command': (ev: SnippetsCommandEvent) => void;
+    'mongosh-snippets:transform-error': (ev: SnippetsTransformErrorEvent) => void;
+    'mongosh-sp:reset-connection-options': () => void;
+    'mongosh-editor:run-edit-command': (ev: EditorRunEditCommandEvent) => void;
+    'mongosh-editor:read-vscode-extensions-done': (ev: EditorReadVscodeExtensionsDoneEvent) => void;
+    'mongosh-editor:read-vscode-extensions-failed': (ev: EditorReadVscodeExtensionsFailedEvent) => void;
+}
+export interface MongoshBus {
+    on<K extends keyof MongoshBusEventsMap>(event: K, listener: MongoshBusEventsMap[K]): this;
+    once<K extends keyof MongoshBusEventsMap>(event: K, listener: MongoshBusEventsMap[K]): this;
+    emit<K extends keyof MongoshBusEventsMap>(event: K, ...args: MongoshBusEventsMap[K] extends (...args: infer P) => any ? P : never): unknown;
+}
+export declare class ShellUserConfig {
+    displayBatchSize: number;
+    maxTimeMS: number | null;
+    enableTelemetry: boolean;
+    editor: string | null;
+}
+export declare class ShellUserConfigValidator {
+    static validate<K extends keyof ShellUserConfig>(key: K, value: ShellUserConfig[K]): Promise<string | null>;
+}
+export declare class SnippetShellUserConfig extends ShellUserConfig {
+    snippetIndexSourceURLs: string;
+    snippetRegistryURL: string;
+    snippetAutoload: boolean;
+}
+export declare class SnippetShellUserConfigValidator extends ShellUserConfigValidator {
+    static validate<K extends keyof SnippetShellUserConfig>(key: K, value: SnippetShellUserConfig[K]): Promise<string | null>;
+}
+export declare class CliUserConfig extends SnippetShellUserConfig {
+    userId: string;
+    telemetryAnonymousId: string;
+    disableGreetingMessage: boolean;
+    forceDisableTelemetry: boolean;
+    inspectCompact: number | boolean;
+    inspectDepth: number;
+    historyLength: number;
+    showStackTraces: boolean;
+    redactHistory: 'keep' | 'remove' | 'remove-redact';
+}
+export declare class CliUserConfigValidator extends SnippetShellUserConfigValidator {
+    static validate<K extends keyof CliUserConfig>(key: K, value: CliUserConfig[K]): Promise<string | null>;
+}
+export interface ConfigProvider<T> {
+    getConfig<K extends keyof T>(key: K): Promise<T[K]>;
+    setConfig<K extends keyof T>(key: K, value: T[K]): Promise<'success' | 'ignored'>;
+    resetConfig<K extends keyof T>(key: K): Promise<'success' | 'ignored'>;
+    validateConfig<K extends keyof T>(key: K, value: T[K]): Promise<string | null>;
+    listConfigOptions(): string[] | Promise<string[]>;
+}

package/lib/index.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CliUserConfigValidator = exports.CliUserConfig = exports.SnippetShellUserConfigValidator = exports.SnippetShellUserConfig = exports.ShellUserConfigValidator = exports.ShellUserConfig = void 0;
+class ShellUserConfig {
+    constructor() {
+        this.displayBatchSize = 20;
+        this.maxTimeMS = null;
+        this.enableTelemetry = false;
+        this.editor = null;
+    }
+}
+exports.ShellUserConfig = ShellUserConfig;
+class ShellUserConfigValidator {
+    static async validate(key, value) {
+        switch (key) {
+            case 'displayBatchSize':
+                if (typeof value !== 'number' || value <= 0) {
+                    return `${key} must be a positive integer`;
+                }
+                return null;
+            case 'maxTimeMS':
+                if (value !== null && (typeof value !== 'number' || value <= 0)) {
+                    return `${key} must be null or a positive integer`;
+                }
+                return null;
+            case 'enableTelemetry':
+                if (typeof value !== 'boolean') {
+                    return `${key} must be a boolean`;
+                }
+                return null;
+            case 'editor':
+                if (typeof value !== 'string' && value !== null) {
+                    return `${key} must be a string or null`;
+                }
+                return null;
+            default:
+                return `${key} is not a known config option`;
+        }
+    }
+}
+exports.ShellUserConfigValidator = ShellUserConfigValidator;
+class SnippetShellUserConfig extends ShellUserConfig {
+    constructor() {
+        super(...arguments);
+        this.snippetIndexSourceURLs = 'https://compass.mongodb.com/mongosh/snippets-index.bson.br';
+        this.snippetRegistryURL = 'https://registry.npmjs.org';
+        this.snippetAutoload = true;
+    }
+}
+exports.SnippetShellUserConfig = SnippetShellUserConfig;
+class SnippetShellUserConfigValidator extends ShellUserConfigValidator {
+    static async validate(key, value) {
+        switch (key) {
+            case 'snippetIndexSourceURLs':
+                if (typeof value !== 'string' || value.split(';').some(url => url && !isValidUrl(url))) {
+                    return `${key} must be a ;-separated list of valid URLs`;
+                }
+                return null;
+            case 'snippetRegistryURL':
+                if (typeof value !== 'string' || !isValidUrl(value)) {
+                    return `${key} must be a valid URL`;
+                }
+                return null;
+            case 'snippetAutoload':
+                if (typeof value !== 'boolean') {
+                    return `${key} must be a boolean`;
+                }
+                return null;
+            default:
+                return super.validate(key, value);
+        }
+    }
+}
+exports.SnippetShellUserConfigValidator = SnippetShellUserConfigValidator;
+class CliUserConfig extends SnippetShellUserConfig {
+    constructor() {
+        super(...arguments);
+        this.userId = '';
+        this.telemetryAnonymousId = '';
+        this.disableGreetingMessage = false;
+        this.forceDisableTelemetry = false;
+        this.inspectCompact = 3;
+        this.inspectDepth = 6;
+        this.historyLength = 1000;
+        this.showStackTraces = false;
+        this.redactHistory = 'remove';
+    }
+}
+exports.CliUserConfig = CliUserConfig;
+class CliUserConfigValidator extends SnippetShellUserConfigValidator {
+    static async validate(key, value) {
+        switch (key) {
+            case 'userId':
+            case 'telemetryAnonymousId':
+            case 'disableGreetingMessage':
+                return null;
+            case 'inspectCompact':
+                if (typeof value !== 'boolean' && (typeof value !== 'number' || value < 0)) {
+                    return `${key} must be a boolean or a positive integer`;
+                }
+                return null;
+            case 'inspectDepth':
+            case 'historyLength':
+                if (typeof value !== 'number' || value < 0) {
+                    return `${key} must be a positive integer`;
+                }
+                return null;
+            case 'forceDisableTelemetry':
+            case 'showStackTraces':
+                if (typeof value !== 'boolean') {
+                    return `${key} must be a boolean`;
+                }
+                return null;
+            case 'redactHistory':
+                if (value !== 'keep' && value !== 'remove' && value !== 'remove-redact') {
+                    return `${key} must be one of 'keep', 'remove', or 'remove-redact'`;
+                }
+                return null;
+            default:
+                return super.validate(key, value);
+        }
+    }
+}
+exports.CliUserConfigValidator = CliUserConfigValidator;
+function isValidUrl(url) {
+    if (typeof URL === 'function') {
+        try {
+            new URL(url);
+            return true;
+        }
+        catch (_a) {
+            return false;
+        }
+    }
+    return true;
+}
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AA0VA,MAAa,eAAe;IAA5B;QACE,qBAAgB,GAAG,EAAE,CAAC;QACtB,cAAS,GAAkB,IAAI,CAAC;QAChC,oBAAe,GAAG,KAAK,CAAC;QACxB,WAAM,GAAkB,IAAI,CAAC;IAC/B,CAAC;CAAA;AALD,0CAKC;AAED,MAAa,wBAAwB;IAEnC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAkC,GAAM,EAAE,KAAyB;QACtF,QAAQ,GAAG,EAAE;YACX,KAAK,kBAAkB;gBACrB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,CAAC,EAAE;oBAC3C,OAAO,GAAG,GAAG,6BAA6B,CAAC;iBAC5C;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,WAAW;gBACd,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,IAAI,CAAC,CAAC,EAAE;oBAC/D,OAAO,GAAG,GAAG,qCAAqC,CAAC;iBACpD;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,iBAAiB;gBACpB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;oBAC9B,OAAO,GAAG,GAAG,oBAAoB,CAAC;iBACnC;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,QAAQ;gBACX,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,EAAE;oBAC/C,OAAO,GAAG,GAAG,2BAA2B,CAAC;iBAC1C;gBACD,OAAO,IAAI,CAAC;YACd;gBACE,OAAO,GAAG,GAAG,+BAA+B,CAAC;SAChD;IACH,CAAC;CACF;AA5BD,4DA4BC;AAED,MAAa,sBAAuB,SAAQ,eAAe;IAA3D;;QACE,2BAAsB,GAAG,4DAA4D,CAAC;QACtF,uBAAkB,GAAG,4BAA4B,CAAC;QAClD,oBAAe,GAAG,IAAI,CAAC;IACzB,CAAC;CAAA;AAJD,wDAIC;AAED,MAAa,+BAAgC,SAAQ,wBAAwB;IAC3E,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAyC,GAAM,EAAE,KAAgC;QACpG,QAAQ,GAAG,EAAE;YACX,KAAK,wBAAwB;gBAC3B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EAAE;oBACtF,OAAO,GAAG,GAAG,2CAA2C,CAAC;iBAC1D;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,oBAAoB;gBACvB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE;oBACnD,OAAO,GAAG,GAAG,sBAAsB,CAAC;iBACrC;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,iBAAiB;gBACpB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;oBAC9B,OAAO,GAAG,GAAG,oBAAoB,CAAC;iBACnC;gBACD,OAAO,IAAI,CAAC;YACd;gBACE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAA4B,EAAE,KAAY,CAAC,CAAC;SACrE;IACH,CAAC;CACF;AAtBD,0EAsBC;AAED,MAAa,aAAc,SAAQ,sBAAsB;IAAzD;;QACE,WAAM,GAAG,EAAE,CAAC;QACZ,yBAAoB,GAAG,EAAE,CAAC;QAC1B,2BAAsB,GAAG,KAAK,CAAC;QAC/B,0BAAqB,GAAG,KAAK,CAAC;QAC9B,mBAAc,GAAqB,CAAC,CAAC;QACrC,iBAAY,GAAG,CAAC,CAAC;QACjB,kBAAa,GAAG,IAAI,CAAC;QACrB,oBAAe,GAAG,KAAK,CAAC;QACxB,kBAAa,GAAwC,QAAQ,CAAC;IAChE,CAAC;CAAA;AAVD,sCAUC;AAED,MAAa,sBAAuB,SAAQ,+BAA+B;IAEzE,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAgC,GAAM,EAAE,KAAuB;QAClF,QAAQ,GAAG,EAAE;YACX,KAAK,QAAQ,CAAC;YACd,KAAK,sBAAsB,CAAC;YAC5B,KAAK,wBAAwB;gBAC3B,OAAO,IAAI,CAAC;YACd,KAAK,gBAAgB;gBACnB,IAAI,OAAO,KAAK,KAAK,SAAS,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,CAAC,EAAE;oBAC1E,OAAO,GAAG,GAAG,0CAA0C,CAAC;iBACzD;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,cAAc,CAAC;YACpB,KAAK,eAAe;gBAClB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,EAAE;oBAC1C,OAAO,GAAG,GAAG,6BAA6B,CAAC;iBAC5C;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,uBAAuB,CAAC;YAC7B,KAAK,iBAAiB;gBACpB,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE;oBAC9B,OAAO,GAAG,GAAG,oBAAoB,CAAC;iBACnC;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,eAAe;gBAClB,IAAI,KAAK,KAAK,MAAM,IAAI,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,eAAe,EAAE;oBACvE,OAAO,GAAG,GAAG,sDAAsD,CAAC;iBACrE;gBACD,OAAO,IAAI,CAAC;YACd;gBACE,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAmC,EAAE,KAAY,CAAC,CAAC;SAC5E;IACH,CAAC;CACF;AAlCD,wDAkCC;AAUD,SAAS,UAAU,CAAC,GAAW;IAM7B,IAAI,OAAO,GAAG,KAAK,UAAU,EAAE;QAC7B,IAAI;YAEF,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;YACb,OAAO,IAAI,CAAC;SACb;QAAC,WAAM;YACN,OAAO,KAAK,CAAC;SACd;KACF;IAGD,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@qp-mongosh/types",
-  "version": "0.0.0-dev.28",
+  "version": "0.0.0-dev.29",
   "description": "Types for mongosh internals",
   "author": "Anna Henningsen <anna.henningsen@mongodb.com>",
   "homepage": "https://github.com/mongodb-js/mongosh/tree/main/packages/types#readme",