@mongosh/types 1.0.6 → 1.0.7

package/AUTHORS

@@ -2,3 +2,4 @@ Anna Henningsen <anna@addaleax.net>
 Maurizio Casimirri <maurizio.cas@gmail.com>
 github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
 Michael Rose <michael_rose@gmx.de>
+Alena Khineika <alena.khineika@gmail.com>

package/lib/index.d.ts

@@ -109,6 +109,14 @@ export interface SnippetsTransformErrorEvent {
     addition: string;
     name: string;
 }
+export interface SpConnectAttemptInitializedEvent {
+    driver: {
+        name: string;
+        version: string;
+    };
+    serviceProviderVersion: string;
+    host: string;
+}
 export interface SpConnectHeartbeatFailureEvent {
     connectionId: string;
     failure: Error;
@@ -131,9 +139,25 @@ export interface SpMissingOptionalDependencyEvent {
     name: string;
     error: Error;
 }
+export interface EditorRunEditCommandEvent {
+    tmpDoc: string;
+    editor: string;
+    code: string;
+}
+export interface EditorRunEditCommandFailedEvent {
+    action: string;
+    error: string;
+}
+export interface EditorReadVscodeExtensionsDoneEvent {
+    vscodeDir: string;
+    hasMongodbExtension: boolean;
+}
+export interface EditorReadVscodeExtensionsFailedEvent {
+    action: string;
+    error: string;
+}
 export interface MongoshBusEventsMap {
     'mongosh:connect': (ev: ConnectEvent) => void;
-    'mongosh:driver-initialized': (driverMetadata: any) => void;
     'mongosh:new-user': (id: string, enableTelemetry: boolean) => void;
     'mongosh:update-user': (id: string, enableTelemetry: boolean) => void;
     'mongosh:error': (error: Error, component: string) => void;
@@ -174,6 +198,7 @@ export interface MongoshBusEventsMap {
     'mongosh-snippets:load-snippet': (ev: SnippetsLoadSnippetEvent) => void;
     'mongosh-snippets:snippet-command': (ev: SnippetsCommandEvent) => void;
     'mongosh-snippets:transform-error': (ev: SnippetsTransformErrorEvent) => void;
+    'mongosh-sp:connect-attempt-initialized': (ev: SpConnectAttemptInitializedEvent) => void;
     'mongosh-sp:connect-heartbeat-failure': (ev: SpConnectHeartbeatFailureEvent) => void;
     'mongosh-sp:connect-heartbeat-succeeded': (ev: SpConnectHeartbeatSucceededEvent) => void;
     'mongosh-sp:connect-fail-early': () => void;
@@ -182,6 +207,9 @@ export interface MongoshBusEventsMap {
     'mongosh-sp:resolve-srv-succeeded': (ev: SpResolveSrvSucceededEvent) => void;
     'mongosh-sp:reset-connection-options': () => void;
     'mongosh-sp:missing-optional-dependency': (ev: SpMissingOptionalDependencyEvent) => 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;
@@ -192,6 +220,7 @@ 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>;

package/lib/index.js

@@ -6,6 +6,7 @@ class ShellUserConfig {
         this.displayBatchSize = 20;
         this.maxTimeMS = null;
         this.enableTelemetry = false;
+        this.editor = null;
     }
 }
 exports.ShellUserConfig = ShellUserConfig;
@@ -27,6 +28,11 @@ class ShellUserConfigValidator {
                     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`;
         }

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAwVA,MAAa,eAAe;IAA5B;QACE,qBAAgB,GAAG,EAAE,CAAC;QACtB,cAAS,GAAkB,IAAI,CAAC;QAChC,oBAAe,GAAG,KAAK,CAAC;IAC1B,CAAC;CAAA;AAJD,0CAIC;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;gBACE,OAAO,GAAG,GAAG,+BAA+B,CAAC;SAChD;IACH,CAAC;CACF;AAvBD,4DAuBC;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,2BAAsB,GAAG,KAAK,CAAC;QAC/B,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;AARD,sCAQC;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,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,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;AAhCD,wDAgCC;AASD,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"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAuXA,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,2BAAsB,GAAG,KAAK,CAAC;QAC/B,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;AARD,sCAQC;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,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,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;AAhCD,wDAgCC;AASD,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": "@mongosh/types",
-  "version": "1.0.6",
+  "version": "1.0.7",
   "description": "Types for mongosh internals",
   "author": "Anna Henningsen <anna.henningsen@mongodb.com>",
   "homepage": "https://github.com/mongodb-js/mongosh/tree/main/packages/types#readme",
@@ -31,5 +31,5 @@
   "mongosh": {
     "unitTestsOnly": true
   },
-  "gitHead": "9eef48ae7aa36725d4776df7817b93713873fd1b"
+  "gitHead": "fa92af95014f84e2ae640aacbe063ec0ba62fbd1"
 }

package/src/index.ts

@@ -134,6 +134,12 @@ export interface SnippetsTransformErrorEvent {
   name: string;
 }
 
+export interface SpConnectAttemptInitializedEvent {
+  driver: { name: string, version: string };
+  serviceProviderVersion: string;
+  host: string;
+}
+
 export interface SpConnectHeartbeatFailureEvent {
   connectionId: string;
   failure: Error;
@@ -161,17 +167,33 @@ export interface SpMissingOptionalDependencyEvent {
   error: Error;
 }
 
+export interface EditorRunEditCommandEvent {
+  tmpDoc: string;
+  editor: string;
+  code: string;
+}
+
+export interface EditorRunEditCommandFailedEvent {
+  action: string;
+  error: string;
+}
+
+export interface EditorReadVscodeExtensionsDoneEvent {
+  vscodeDir: string;
+  hasMongodbExtension: boolean;
+}
+
+export interface EditorReadVscodeExtensionsFailedEvent {
+  action: string;
+  error: string;
+}
+
 export interface MongoshBusEventsMap {
   /**
    * Signals a connection to a MongoDB instance has been established
    * or the used database changed.
    */
   'mongosh:connect': (ev: ConnectEvent) => void;
-  /**
-   * Signals the creation of a new Mongo client with metadata provided
-   * by the underlying driver implementation.
-   */
-  'mongosh:driver-initialized': (driverMetadata: any) => void;
   /**
    * Signals that the shell is started by a new user.
    */
@@ -317,6 +339,8 @@ export interface MongoshBusEventsMap {
   /** Signals that a snippet has modified an error message. */
   'mongosh-snippets:transform-error': (ev: SnippetsTransformErrorEvent) => void;
 
+  /** Signals that a connection attempt is about to be performed. */
+  'mongosh-sp:connect-attempt-initialized': (ev: SpConnectAttemptInitializedEvent) => void;
   /** Signals that communicating to a specific server during connection did not succeed. */
   'mongosh-sp:connect-heartbeat-failure': (ev: SpConnectHeartbeatFailureEvent) => void;
   /** Signals that communicating to a specific server during connection succeeded. */
@@ -333,6 +357,13 @@ export interface MongoshBusEventsMap {
   'mongosh-sp:reset-connection-options': () => void;
   /** Signals that an optional dependency of the mongodb package is missing. */
   'mongosh-sp:missing-optional-dependency': (ev: SpMissingOptionalDependencyEvent) => void;
+
+  /** Signals that open external editor command was called. */
+  'mongosh-editor:run-edit-command': (ev: EditorRunEditCommandEvent) => void;
+  /** Signals that reading vscode extensions from disc succeeded. */
+  'mongosh-editor:read-vscode-extensions-done': (ev: EditorReadVscodeExtensionsDoneEvent) => void;
+  /** Signals that reading vscode extensions from disc failed. */
+  'mongosh-editor:read-vscode-extensions-failed': (ev: EditorReadVscodeExtensionsFailedEvent) => void;
 }
 
 export interface MongoshBus {
@@ -346,10 +377,11 @@ export class ShellUserConfig {
   displayBatchSize = 20;
   maxTimeMS: number | null = null;
   enableTelemetry = false;
+  editor: string | null = null;
 }
 
 export class ShellUserConfigValidator {
-  // eslint-disable-next-line @typescript-eslint/require-await
+  // eslint-disable-next-line complexity, @typescript-eslint/require-await
   static async validate<K extends keyof ShellUserConfig>(key: K, value: ShellUserConfig[K]): Promise<string | null> {
     switch (key) {
       case 'displayBatchSize':
@@ -367,6 +399,11 @@ export class ShellUserConfigValidator {
           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`;
     }