@mongosh/types 1.10.5 → 1.10.6
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/.depcheckrc +1 -0
- package/lib/index.d.ts +10 -0
- package/lib/index.js +6 -0
- package/lib/index.js.map +1 -1
- package/package.json +4 -4
- package/src/index.ts +22 -0
package/.depcheckrc
CHANGED
package/lib/index.d.ts
CHANGED
|
@@ -137,6 +137,13 @@ export interface EditorReadVscodeExtensionsFailedEvent {
|
|
|
137
137
|
vscodeDir: string;
|
|
138
138
|
error: Error;
|
|
139
139
|
}
|
|
140
|
+
export interface FetchingUpdateMetadataEvent {
|
|
141
|
+
updateURL: string;
|
|
142
|
+
localFilePath: string;
|
|
143
|
+
}
|
|
144
|
+
export interface FetchingUpdateMetadataCompleteEvent {
|
|
145
|
+
latest: string | null;
|
|
146
|
+
}
|
|
140
147
|
export interface MongoshBusEventsMap extends ConnectEventMap {
|
|
141
148
|
'mongosh:connect': (ev: ConnectEvent) => void;
|
|
142
149
|
'mongosh:new-user': (identity: {
|
|
@@ -190,6 +197,8 @@ export interface MongoshBusEventsMap extends ConnectEventMap {
|
|
|
190
197
|
'mongosh-editor:run-edit-command': (ev: EditorRunEditCommandEvent) => void;
|
|
191
198
|
'mongosh-editor:read-vscode-extensions-done': (ev: EditorReadVscodeExtensionsDoneEvent) => void;
|
|
192
199
|
'mongosh-editor:read-vscode-extensions-failed': (ev: EditorReadVscodeExtensionsFailedEvent) => void;
|
|
200
|
+
'mongosh:fetching-update-metadata': (ev: FetchingUpdateMetadataEvent) => void;
|
|
201
|
+
'mongosh:fetching-update-metadata-complete': (ev: FetchingUpdateMetadataCompleteEvent) => void;
|
|
193
202
|
}
|
|
194
203
|
export interface MongoshBus {
|
|
195
204
|
on<K extends keyof MongoshBusEventsMap>(event: K, listener: MongoshBusEventsMap[K]): this;
|
|
@@ -226,6 +235,7 @@ export declare class CliUserConfig extends SnippetShellUserConfig {
|
|
|
226
235
|
oidcRedirectURI: undefined | string;
|
|
227
236
|
oidcTrustedEndpoints: undefined | string[];
|
|
228
237
|
browser: undefined | false | string;
|
|
238
|
+
updateURL: string;
|
|
229
239
|
}
|
|
230
240
|
export declare class CliUserConfigValidator extends SnippetShellUserConfigValidator {
|
|
231
241
|
static validate<K extends keyof CliUserConfig>(key: K, value: CliUserConfig[K]): Promise<string | null>;
|
package/lib/index.js
CHANGED
|
@@ -88,6 +88,7 @@ class CliUserConfig extends SnippetShellUserConfig {
|
|
|
88
88
|
this.oidcRedirectURI = undefined;
|
|
89
89
|
this.oidcTrustedEndpoints = undefined;
|
|
90
90
|
this.browser = undefined;
|
|
91
|
+
this.updateURL = 'https://downloads.mongodb.com/compass/mongosh.json';
|
|
91
92
|
}
|
|
92
93
|
}
|
|
93
94
|
exports.CliUserConfig = CliUserConfig;
|
|
@@ -142,6 +143,11 @@ class CliUserConfigValidator extends SnippetShellUserConfigValidator {
|
|
|
142
143
|
return `${key} must be undefined, false, or a command string`;
|
|
143
144
|
}
|
|
144
145
|
return null;
|
|
146
|
+
case 'updateURL':
|
|
147
|
+
if (typeof value !== 'string' || (value.trim() && !isValidUrl(value))) {
|
|
148
|
+
return `${key} must be a valid URL or empty`;
|
|
149
|
+
}
|
|
150
|
+
return null;
|
|
145
151
|
default:
|
|
146
152
|
return super.validate(key, value);
|
|
147
153
|
}
|
package/lib/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAiYA,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,CACnB,GAAM,EACN,KAAyB;QAEzB,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;AA/BD,4DA+BC;AAED,MAAa,sBAAuB,SAAQ,eAAe;IAA3D;;QACE,2BAAsB,GACpB,4DAA4D,CAAC;QAC/D,uBAAkB,GAAG,4BAA4B,CAAC;QAClD,oBAAe,GAAG,IAAI,CAAC;IACzB,CAAC;CAAA;AALD,wDAKC;AAED,MAAa,+BAAgC,SAAQ,wBAAwB;IAC3E,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,GAAM,EACN,KAAgC;QAEhC,QAAQ,GAAG,EAAE;YACX,KAAK,wBAAwB;gBAC3B,IACE,OAAO,KAAK,KAAK,QAAQ;oBACzB,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,EACvD;oBACA,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;AA5BD,0EA4BC;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;QAC9D,oBAAe,GAAuB,SAAS,CAAC;QAChD,yBAAoB,GAAyB,SAAS,CAAC;QACvD,YAAO,GAA+B,SAAS,CAAC;QAChD,cAAS,GAAG,oDAAoD,CAAC;IACnE,CAAC;CAAA;AAdD,sCAcC;AAED,MAAa,sBAAuB,SAAQ,+BAA+B;IACzE,MAAM,CAAC,KAAK,CAAC,QAAQ,CACnB,GAAM,EACN,KAAuB;QAEvB,QAAQ,GAAG,EAAE;YACX,KAAK,QAAQ,CAAC;YACd,KAAK,sBAAsB,CAAC;YAC5B,KAAK,wBAAwB;gBAC3B,OAAO,IAAI,CAAC;YACd,KAAK,gBAAgB;gBACnB,IACE,OAAO,KAAK,KAAK,SAAS;oBAC1B,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,GAAG,CAAC,CAAC,EACxC;oBACA,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,IACE,KAAK,KAAK,MAAM;oBAChB,KAAK,KAAK,QAAQ;oBAClB,KAAK,KAAK,eAAe,EACzB;oBACA,OAAO,GAAG,GAAG,sDAAsD,CAAC;iBACrE;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,iBAAiB;gBACpB,IACE,KAAK,KAAK,SAAS;oBACnB,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EACjD;oBACA,OAAO,GAAG,GAAG,mCAAmC,CAAC;iBAClD;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,sBAAsB;gBACzB,IACE,KAAK,KAAK,SAAS;oBACnB,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,CAAC,CAAC,EACnE;oBACA,OAAO,GAAG,GAAG,6CAA6C,CAAC;iBAC5D;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,SAAS;gBACZ,IACE,KAAK,KAAK,SAAS;oBACnB,KAAK,KAAK,KAAK;oBACf,OAAO,KAAK,KAAK,QAAQ,EACzB;oBACA,OAAO,GAAG,GAAG,gDAAgD,CAAC;iBAC/D;gBACD,OAAO,IAAI,CAAC;YACd,KAAK,WAAW;gBACd,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,EAAE;oBACrE,OAAO,GAAG,GAAG,+BAA+B,CAAC;iBAC9C;gBACD,OAAO,IAAI,CAAC;YACd;gBACE,OAAO,KAAK,CAAC,QAAQ,CACnB,GAAmC,EACnC,KAAY,CACb,CAAC;SACL;IACH,CAAC;CACF;AA5ED,wDA4EC;AAgBD,SAAS,UAAU,CAAC,GAAW;IAK7B,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;IAED,OAAO,IAAI,CAAC;AACd,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mongosh/types",
|
|
3
|
-
"version": "1.10.
|
|
3
|
+
"version": "1.10.6",
|
|
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",
|
|
@@ -39,13 +39,13 @@
|
|
|
39
39
|
"@mongodb-js/devtools-connect": "^2.3.1"
|
|
40
40
|
},
|
|
41
41
|
"devDependencies": {
|
|
42
|
-
"@mongodb-js/eslint-config-mongosh": "1.10.
|
|
42
|
+
"@mongodb-js/eslint-config-mongosh": "1.10.6",
|
|
43
43
|
"@mongodb-js/prettier-config-devtools": "^1.0.1",
|
|
44
|
-
"@mongodb-js/tsconfig-mongosh": "1.10.
|
|
44
|
+
"@mongodb-js/tsconfig-mongosh": "1.10.6",
|
|
45
45
|
"depcheck": "^1.4.3",
|
|
46
46
|
"eslint": "^7.25.0",
|
|
47
47
|
"mongodb": "^5.7.0",
|
|
48
48
|
"prettier": "^2.8.8"
|
|
49
49
|
},
|
|
50
|
-
"gitHead": "
|
|
50
|
+
"gitHead": "6bcde16381f6258d9be713998c67c48a99cfd691"
|
|
51
51
|
}
|
package/src/index.ts
CHANGED
|
@@ -165,6 +165,15 @@ export interface EditorReadVscodeExtensionsFailedEvent {
|
|
|
165
165
|
error: Error;
|
|
166
166
|
}
|
|
167
167
|
|
|
168
|
+
export interface FetchingUpdateMetadataEvent {
|
|
169
|
+
updateURL: string;
|
|
170
|
+
localFilePath: string;
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
export interface FetchingUpdateMetadataCompleteEvent {
|
|
174
|
+
latest: string | null;
|
|
175
|
+
}
|
|
176
|
+
|
|
168
177
|
export interface MongoshBusEventsMap extends ConnectEventMap {
|
|
169
178
|
/**
|
|
170
179
|
* Signals a connection to a MongoDB instance has been established
|
|
@@ -347,6 +356,13 @@ export interface MongoshBusEventsMap extends ConnectEventMap {
|
|
|
347
356
|
'mongosh-editor:read-vscode-extensions-failed': (
|
|
348
357
|
ev: EditorReadVscodeExtensionsFailedEvent
|
|
349
358
|
) => void;
|
|
359
|
+
|
|
360
|
+
/** Signals that fetching update metadata has started. */
|
|
361
|
+
'mongosh:fetching-update-metadata': (ev: FetchingUpdateMetadataEvent) => void;
|
|
362
|
+
/** Signals that fetching update metadata has completed. */
|
|
363
|
+
'mongosh:fetching-update-metadata-complete': (
|
|
364
|
+
ev: FetchingUpdateMetadataCompleteEvent
|
|
365
|
+
) => void;
|
|
350
366
|
}
|
|
351
367
|
|
|
352
368
|
export interface MongoshBus {
|
|
@@ -457,6 +473,7 @@ export class CliUserConfig extends SnippetShellUserConfig {
|
|
|
457
473
|
oidcRedirectURI: undefined | string = undefined;
|
|
458
474
|
oidcTrustedEndpoints: undefined | string[] = undefined;
|
|
459
475
|
browser: undefined | false | string = undefined;
|
|
476
|
+
updateURL = 'https://downloads.mongodb.com/compass/mongosh.json';
|
|
460
477
|
}
|
|
461
478
|
|
|
462
479
|
export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
|
|
@@ -523,6 +540,11 @@ export class CliUserConfigValidator extends SnippetShellUserConfigValidator {
|
|
|
523
540
|
return `${key} must be undefined, false, or a command string`;
|
|
524
541
|
}
|
|
525
542
|
return null;
|
|
543
|
+
case 'updateURL':
|
|
544
|
+
if (typeof value !== 'string' || (value.trim() && !isValidUrl(value))) {
|
|
545
|
+
return `${key} must be a valid URL or empty`;
|
|
546
|
+
}
|
|
547
|
+
return null;
|
|
526
548
|
default:
|
|
527
549
|
return super.validate(
|
|
528
550
|
key as keyof SnippetShellUserConfig,
|