@mongosh/types 1.1.0 → 1.1.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 +15 -5
- package/lib/index.js.map +1 -1
- package/package.json +2 -2
- package/src/index.ts +22 -8
package/lib/index.d.ts
CHANGED
|
@@ -4,15 +4,24 @@ export interface ApiEventArguments {
|
|
|
4
4
|
options?: object;
|
|
5
5
|
filter?: object;
|
|
6
6
|
}
|
|
7
|
-
export interface
|
|
8
|
-
method
|
|
7
|
+
export interface ApiEventWithArguments {
|
|
8
|
+
method: string;
|
|
9
9
|
class?: string;
|
|
10
10
|
db?: string;
|
|
11
11
|
coll?: string;
|
|
12
12
|
uri?: string;
|
|
13
13
|
arguments?: ApiEventArguments;
|
|
14
14
|
}
|
|
15
|
-
export interface
|
|
15
|
+
export interface ApiEvent {
|
|
16
|
+
method: string;
|
|
17
|
+
class: string;
|
|
18
|
+
deprecated: boolean;
|
|
19
|
+
isAsync: boolean;
|
|
20
|
+
callDepth: number;
|
|
21
|
+
}
|
|
22
|
+
export interface ApiWarning {
|
|
23
|
+
method: string;
|
|
24
|
+
class: string;
|
|
16
25
|
message: string;
|
|
17
26
|
}
|
|
18
27
|
export interface UseEvent {
|
|
@@ -159,13 +168,14 @@ export interface MongoshBusEventsMap {
|
|
|
159
168
|
'mongosh:update-user': (id: string, enableTelemetry: boolean) => void;
|
|
160
169
|
'mongosh:error': (error: Error, component: string) => void;
|
|
161
170
|
'mongosh:evaluate-input': (ev: EvaluateInputEvent) => void;
|
|
171
|
+
'mongosh:evaluate-started': () => void;
|
|
162
172
|
'mongosh:evaluate-finished': () => void;
|
|
163
173
|
'mongosh:use': (ev: UseEvent) => void;
|
|
164
174
|
'mongosh:getDB': (ev: UseEvent) => void;
|
|
165
175
|
'mongosh:show': (ev: ShowEvent) => void;
|
|
166
|
-
'mongosh:setCtx': (ev:
|
|
176
|
+
'mongosh:setCtx': (ev: ApiEventWithArguments) => void;
|
|
177
|
+
'mongosh:api-call-with-arguments': (ev: ApiEventWithArguments) => void;
|
|
167
178
|
'mongosh:api-call': (ev: ApiEvent) => void;
|
|
168
|
-
'mongosh:deprecated-api-call': (ev: ApiEvent) => void;
|
|
169
179
|
'mongosh:warn': (ev: ApiWarning) => void;
|
|
170
180
|
'mongosh:api-load-file': (ev: ScriptLoadFileEvent) => void;
|
|
171
181
|
'mongosh:start-loading-cli-scripts': (event: StartLoadingCliScriptsEvent) => void;
|
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,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
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mongosh/types",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.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",
|
|
@@ -31,5 +31,5 @@
|
|
|
31
31
|
"mongosh": {
|
|
32
32
|
"unitTestsOnly": true
|
|
33
33
|
},
|
|
34
|
-
"gitHead": "
|
|
34
|
+
"gitHead": "ecf5653fa1520731a3e9172550278f68f0784923"
|
|
35
35
|
}
|
package/src/index.ts
CHANGED
|
@@ -6,8 +6,8 @@ export interface ApiEventArguments {
|
|
|
6
6
|
filter?: object;
|
|
7
7
|
}
|
|
8
8
|
|
|
9
|
-
export interface
|
|
10
|
-
method
|
|
9
|
+
export interface ApiEventWithArguments {
|
|
10
|
+
method: string;
|
|
11
11
|
class?: string;
|
|
12
12
|
db?: string;
|
|
13
13
|
coll?: string;
|
|
@@ -15,7 +15,17 @@ export interface ApiEvent {
|
|
|
15
15
|
arguments?: ApiEventArguments;
|
|
16
16
|
}
|
|
17
17
|
|
|
18
|
-
export interface
|
|
18
|
+
export interface ApiEvent {
|
|
19
|
+
method: string;
|
|
20
|
+
class: string;
|
|
21
|
+
deprecated: boolean;
|
|
22
|
+
isAsync: boolean;
|
|
23
|
+
callDepth: number;
|
|
24
|
+
}
|
|
25
|
+
|
|
26
|
+
export interface ApiWarning {
|
|
27
|
+
method: string;
|
|
28
|
+
class: string;
|
|
19
29
|
message: string;
|
|
20
30
|
}
|
|
21
31
|
|
|
@@ -206,6 +216,10 @@ export interface MongoshBusEventsMap {
|
|
|
206
216
|
* Signals the start of the evaluation of user code inside Shellevaluator.
|
|
207
217
|
*/
|
|
208
218
|
'mongosh:evaluate-input': (ev: EvaluateInputEvent) => void;
|
|
219
|
+
/**
|
|
220
|
+
* Signals the initiation of the evaluation of user code in AsyncRepl (final step of the evaluation).
|
|
221
|
+
*/
|
|
222
|
+
'mongosh:evaluate-started': () => void;
|
|
209
223
|
/**
|
|
210
224
|
* Signals the completion of the evaluation of user code in AsyncRepl (final step of the evaluation)
|
|
211
225
|
* regardless of success, error, or being interrupted.
|
|
@@ -226,15 +240,15 @@ export interface MongoshBusEventsMap {
|
|
|
226
240
|
/**
|
|
227
241
|
* Signals the global context for the shell evaluation has been initialized.
|
|
228
242
|
*/
|
|
229
|
-
'mongosh:setCtx': (ev:
|
|
243
|
+
'mongosh:setCtx': (ev: ApiEventWithArguments) => void;
|
|
230
244
|
/**
|
|
231
|
-
* Signals usage of a shell API method.
|
|
245
|
+
* Signals usage of a shell API method. This includes arguments and is not suitable for telemetry.
|
|
232
246
|
*/
|
|
233
|
-
'mongosh:api-call': (ev:
|
|
247
|
+
'mongosh:api-call-with-arguments': (ev: ApiEventWithArguments) => void;
|
|
234
248
|
/**
|
|
235
|
-
* Signals usage of a
|
|
249
|
+
* Signals usage of a shell API method as an API entry point, suitable for telemetry.
|
|
236
250
|
*/
|
|
237
|
-
'mongosh:
|
|
251
|
+
'mongosh:api-call': (ev: ApiEvent) => void;
|
|
238
252
|
/**
|
|
239
253
|
* Signals an error for an operation that we can silently ignore but still warn about.
|
|
240
254
|
*/
|