@mongosh/types 1.2.3 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -64,15 +64,16 @@ export interface GlobalConfigFileLoadEvent {
64
64
  filename: string;
65
65
  found: boolean;
66
66
  }
67
- export interface MongocryptdTrySpawnEvent {
68
- spawnPath: string[];
69
- path: string;
67
+ export interface CSFLELibrarySkipEvent {
68
+ csflePath: string;
69
+ reason: string;
70
+ details?: any;
70
71
  }
71
- export interface MongocryptdErrorEvent {
72
- cause: string;
73
- error?: Error;
74
- stderr?: string;
75
- pid?: number;
72
+ export interface CSFLELibraryFoundEvent {
73
+ csflePath: string;
74
+ expectedVersion: {
75
+ versionStr: string;
76
+ };
76
77
  }
77
78
  export interface MongocryptdLogEvent {
78
79
  pid: number;
@@ -138,8 +139,14 @@ export interface EditorReadVscodeExtensionsFailedEvent {
138
139
  }
139
140
  export interface MongoshBusEventsMap extends ConnectEventMap {
140
141
  'mongosh:connect': (ev: ConnectEvent) => void;
141
- 'mongosh:new-user': (id: string) => void;
142
- 'mongosh:update-user': (id: string) => void;
142
+ 'mongosh:new-user': (identity: {
143
+ userId: string;
144
+ anonymousId: string;
145
+ }) => void;
146
+ 'mongosh:update-user': (identity: {
147
+ userId: string;
148
+ anonymousId?: string;
149
+ }) => void;
143
150
  'mongosh:error': (error: Error, component: string) => void;
144
151
  'mongosh:evaluate-input': (ev: EvaluateInputEvent) => void;
145
152
  'mongosh:evaluate-started': () => void;
@@ -159,9 +166,8 @@ export interface MongoshBusEventsMap extends ConnectEventMap {
159
166
  'mongosh:mongoshrc-mongorc-warn': () => void;
160
167
  'mongosh:eval-cli-script': () => void;
161
168
  'mongosh:eval-interrupted': () => void;
162
- 'mongosh:mongocryptd-tryspawn': (ev: MongocryptdTrySpawnEvent) => void;
163
- 'mongosh:mongocryptd-error': (ev: MongocryptdErrorEvent) => void;
164
- 'mongosh:mongocryptd-log': (ev: MongocryptdLogEvent) => void;
169
+ 'mongosh:csfle-load-skip': (ev: CSFLELibrarySkipEvent) => void;
170
+ 'mongosh:csfle-load-found': (ev: CSFLELibraryFoundEvent) => void;
165
171
  'mongosh:closed': () => void;
166
172
  'mongosh:eval-complete': () => void;
167
173
  'mongosh:autocompletion-complete': () => void;
@@ -209,6 +215,7 @@ export declare class SnippetShellUserConfigValidator extends ShellUserConfigVali
209
215
  }
210
216
  export declare class CliUserConfig extends SnippetShellUserConfig {
211
217
  userId: string;
218
+ telemetryAnonymousId: string;
212
219
  disableGreetingMessage: boolean;
213
220
  forceDisableTelemetry: boolean;
214
221
  inspectCompact: number | boolean;
package/lib/index.js CHANGED
@@ -76,6 +76,7 @@ class CliUserConfig extends SnippetShellUserConfig {
76
76
  constructor() {
77
77
  super(...arguments);
78
78
  this.userId = '';
79
+ this.telemetryAnonymousId = '';
79
80
  this.disableGreetingMessage = false;
80
81
  this.forceDisableTelemetry = false;
81
82
  this.inspectCompact = 3;
@@ -90,6 +91,7 @@ class CliUserConfigValidator extends SnippetShellUserConfigValidator {
90
91
  static async validate(key, value) {
91
92
  switch (key) {
92
93
  case 'userId':
94
+ case 'telemetryAnonymousId':
93
95
  case 'disableGreetingMessage':
94
96
  return null;
95
97
  case 'inspectCompact':
package/lib/index.js.map CHANGED
@@ -1 +1 @@
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,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;AATD,sCASC;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,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;AAjCD,wDAiCC;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"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAqVA,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 CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@mongosh/types",
3
- "version": "1.2.3",
3
+ "version": "1.4.1",
4
4
  "description": "Types for mongosh internals",
5
5
  "author": "Anna Henningsen <anna.henningsen@mongodb.com>",
6
6
  "homepage": "https://github.com/mongodb-js/mongosh/tree/main/packages/types#readme",
@@ -32,7 +32,7 @@
32
32
  "unitTestsOnly": true
33
33
  },
34
34
  "dependencies": {
35
- "@mongodb-js/devtools-connect": "^1.2.4"
35
+ "@mongodb-js/devtools-connect": "^1.4.2"
36
36
  },
37
- "gitHead": "b715268260871b62ac628cef3eb1009203a91264"
37
+ "gitHead": "4e88ce238c93af5f2eb5ad9f9e3a2ac5ef1eb2e0"
38
38
  }
package/src/index.spec.ts CHANGED
@@ -5,6 +5,7 @@ describe('config validation', () => {
5
5
  it('validates config option values', async() => {
6
6
  const { validate } = CliUserConfigValidator as any;
7
7
  expect(await validate('userId', 'foo')).to.equal(null);
8
+ expect(await validate('telemetryAnonymousId', 'foo')).to.equal(null);
8
9
  expect(await validate('disableGreetingMessage', 'foo')).to.equal(null);
9
10
  expect(await validate('inspectDepth', 'foo')).to.equal('inspectDepth must be a positive integer');
10
11
  expect(await validate('inspectDepth', -1)).to.equal('inspectDepth must be a positive integer');
package/src/index.ts CHANGED
@@ -77,16 +77,15 @@ export interface GlobalConfigFileLoadEvent {
77
77
  found: boolean;
78
78
  }
79
79
 
80
- export interface MongocryptdTrySpawnEvent {
81
- spawnPath: string[];
82
- path: string;
80
+ export interface CSFLELibrarySkipEvent {
81
+ csflePath: string;
82
+ reason: string;
83
+ details?: any;
83
84
  }
84
85
 
85
- export interface MongocryptdErrorEvent {
86
- cause: string;
87
- error?: Error;
88
- stderr?: string;
89
- pid?: number;
86
+ export interface CSFLELibraryFoundEvent {
87
+ csflePath: string;
88
+ expectedVersion: { versionStr: string };
90
89
  }
91
90
 
92
91
  export interface MongocryptdLogEvent {
@@ -176,11 +175,11 @@ export interface MongoshBusEventsMap extends ConnectEventMap {
176
175
  /**
177
176
  * Signals that the shell is started by a new user.
178
177
  */
179
- 'mongosh:new-user': (id: string) => void;
178
+ 'mongosh:new-user': (identity: { userId: string; anonymousId: string }) => void;
180
179
  /**
181
180
  * Signals a change of the user telemetry settings.
182
181
  */
183
- 'mongosh:update-user': (id: string) => void;
182
+ 'mongosh:update-user': (identity: { userId: string; anonymousId?: string }) => void;
184
183
  /**
185
184
  * Signals an error that should be logged or potentially tracked by analytics.
186
185
  */
@@ -262,17 +261,13 @@ export interface MongoshBusEventsMap extends ConnectEventMap {
262
261
  */
263
262
  'mongosh:eval-interrupted': () => void;
264
263
  /**
265
- * Signals the start of trying to spawn a `mongocryptd` process.
264
+ * Signals that a potential CSFLE library search path was skipped.
266
265
  */
267
- 'mongosh:mongocryptd-tryspawn': (ev: MongocryptdTrySpawnEvent) => void;
266
+ 'mongosh:csfle-load-skip': (ev: CSFLELibrarySkipEvent) => void;
268
267
  /**
269
- * Signals an error while interfacing with a `mongocryptd` process.
268
+ * Signals that a potential CSFLE library search path was accepted.
270
269
  */
271
- 'mongosh:mongocryptd-error': (ev: MongocryptdErrorEvent) => void;
272
- /**
273
- * Signals an event to be logged for a `mongocryptd` process.
274
- */
275
- 'mongosh:mongocryptd-log': (ev: MongocryptdLogEvent) => void;
270
+ 'mongosh:csfle-load-found': (ev: CSFLELibraryFoundEvent) => void;
276
271
  /**
277
272
  * Signals that the CLI REPL's `close` method has completed.
278
273
  * _ONLY AVAILABLE FOR TESTING._
@@ -413,6 +408,7 @@ export class SnippetShellUserConfigValidator extends ShellUserConfigValidator {
413
408
 
414
409
  export class CliUserConfig extends SnippetShellUserConfig {
415
410
  userId = '';
411
+ telemetryAnonymousId = '';
416
412
  disableGreetingMessage = false;
417
413
  forceDisableTelemetry = false;
418
414
  inspectCompact: number | boolean = 3;
@@ -427,6 +423,7 @@ export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
427
423
  static async validate<K extends keyof CliUserConfig>(key: K, value: CliUserConfig[K]): Promise<string | null> {
428
424
  switch (key) {
429
425
  case 'userId':
426
+ case 'telemetryAnonymousId':
430
427
  case 'disableGreetingMessage':
431
428
  return null; // Not modifiable by the user anyway.
432
429
  case 'inspectCompact':