commandbar 1.6.16 → 1.7.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/build/commandbar-js/src/index.d.ts +2 -0
- package/build/commandbar-js/src/index.js +2 -1
- package/build/commandbar-js/src/index.js.LICENSE.txt +14 -0
- package/build/internal/src/client/AddContextOptions.d.ts +5 -0
- package/build/internal/src/client/CommandBarClientSDK.d.ts +8 -4
- package/build/internal/src/client/CommandBarProxySDK.d.ts +2 -1
- package/build/internal/src/client/CommandBarSDK.d.ts +3 -1
- package/build/internal/src/client/EventHandler.d.ts +10 -0
- package/build/internal/src/client/symbols.d.ts +1 -0
- package/build/internal/src/middleware/CommandFromClientV.d.ts +8 -0
- package/build/internal/src/middleware/ICommandFromClientType.d.ts +1 -1
- package/build/internal/src/middleware/IResourceSettings.d.ts +1 -1
- package/build/internal/src/middleware/OrganizationV.d.ts +5 -1
- package/build/internal/src/middleware/command.d.ts +279 -271
- package/build/internal/src/middleware/detailPreview.d.ts +1 -1
- package/build/internal/src/middleware/nudge.d.ts +31 -15
- package/build/internal/src/middleware/organization.d.ts +36 -20
- package/build/internal/src/middleware/types.d.ts +50 -440
- package/package.json +9 -4
- package/src/commandbar-launcher.d.ts +7 -0
- package/src/index.ts +2 -0
- package/src/snippet.ts +5 -1
@@ -6,7 +6,7 @@ export declare const DetailPreviewObjectV: t.IntersectionC<[t.TypeC<{
|
|
6
6
|
}>, t.PartialC<{
|
7
7
|
position: t.UnionC<[t.LiteralC<"inline">, t.LiteralC<"popover">]>;
|
8
8
|
}>]>;
|
9
|
-
export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV
|
9
|
+
export declare type DetailPreviewObjectType = t.TypeOf<typeof DetailPreviewObjectV> & unknown;
|
10
10
|
export declare type DetailPreviewType = string | DetailPreviewObjectType | (string | DetailPreviewObjectType)[];
|
11
11
|
export declare type DataRowMetadata = {
|
12
12
|
type: 'command' | 'parameter';
|
@@ -21,8 +21,10 @@ export declare const NudgeV: t.IntersectionC<[t.TypeC<{
|
|
21
21
|
}>;
|
22
22
|
timeout_ms: t.UnionC<[t.NumberC, t.NullC]>;
|
23
23
|
frequency_limit: t.UnionC<[t.LiteralC<"no_limit">, t.LiteralC<"once_per_session">, t.LiteralC<"once_per_user">]>;
|
24
|
+
}>, t.PartialC<{
|
25
|
+
title: t.StringC;
|
24
26
|
is_live: t.BooleanC;
|
25
|
-
}
|
27
|
+
}>]>;
|
26
28
|
export declare class Nudge {
|
27
29
|
static decode: (data: any) => {
|
28
30
|
id: number;
|
@@ -46,8 +48,10 @@ export declare class Nudge {
|
|
46
48
|
};
|
47
49
|
timeout_ms: number | null;
|
48
50
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
49
|
-
|
50
|
-
|
51
|
+
} & {
|
52
|
+
title?: string | undefined;
|
53
|
+
is_live?: boolean | undefined;
|
54
|
+
};
|
51
55
|
static create: (object: {
|
52
56
|
id: number;
|
53
57
|
organization: string;
|
@@ -70,8 +74,10 @@ export declare class Nudge {
|
|
70
74
|
};
|
71
75
|
timeout_ms: number | null;
|
72
76
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
73
|
-
|
74
|
-
|
77
|
+
} & {
|
78
|
+
title?: string | undefined;
|
79
|
+
is_live?: boolean | undefined;
|
80
|
+
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
75
81
|
id: number;
|
76
82
|
organization: string;
|
77
83
|
slug: string;
|
@@ -93,8 +99,10 @@ export declare class Nudge {
|
|
93
99
|
};
|
94
100
|
timeout_ms: number | null;
|
95
101
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
96
|
-
|
97
|
-
|
102
|
+
} & {
|
103
|
+
title?: string | undefined;
|
104
|
+
is_live?: boolean | undefined;
|
105
|
+
}>;
|
98
106
|
static update: (object: {
|
99
107
|
id: number;
|
100
108
|
organization: string;
|
@@ -117,8 +125,10 @@ export declare class Nudge {
|
|
117
125
|
};
|
118
126
|
timeout_ms: number | null;
|
119
127
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
120
|
-
|
121
|
-
|
128
|
+
} & {
|
129
|
+
title?: string | undefined;
|
130
|
+
is_live?: boolean | undefined;
|
131
|
+
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
122
132
|
id: number;
|
123
133
|
organization: string;
|
124
134
|
slug: string;
|
@@ -140,8 +150,10 @@ export declare class Nudge {
|
|
140
150
|
};
|
141
151
|
timeout_ms: number | null;
|
142
152
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
143
|
-
|
144
|
-
|
153
|
+
} & {
|
154
|
+
title?: string | undefined;
|
155
|
+
is_live?: boolean | undefined;
|
156
|
+
}>;
|
145
157
|
static delete: (id: string | number, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
|
146
158
|
static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
|
147
159
|
id: number;
|
@@ -165,8 +177,10 @@ export declare class Nudge {
|
|
165
177
|
};
|
166
178
|
timeout_ms: number | null;
|
167
179
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
168
|
-
|
169
|
-
|
180
|
+
} & {
|
181
|
+
title?: string | undefined;
|
182
|
+
is_live?: boolean | undefined;
|
183
|
+
})[]>;
|
170
184
|
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
171
185
|
onSuccess?: (() => void) | undefined;
|
172
186
|
onError?: ((err: string) => void) | undefined;
|
@@ -192,6 +206,8 @@ export declare class Nudge {
|
|
192
206
|
};
|
193
207
|
timeout_ms: number | null;
|
194
208
|
frequency_limit: "no_limit" | "once_per_session" | "once_per_user";
|
195
|
-
|
196
|
-
|
209
|
+
} & {
|
210
|
+
title?: string | undefined;
|
211
|
+
is_live?: boolean | undefined;
|
212
|
+
}>;
|
197
213
|
}
|
@@ -41,6 +41,8 @@ export declare const OrganizationSettingsV: t.TypeC<{
|
|
41
41
|
recents_tab_instruction: t.StringC;
|
42
42
|
hotload_help_docs: t.BooleanC;
|
43
43
|
slash_filters_enabled: t.BooleanC;
|
44
|
+
recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
45
|
+
recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
|
44
46
|
}>;
|
45
47
|
export declare class Organization {
|
46
48
|
static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
|
@@ -127,6 +129,8 @@ export declare class Organization {
|
|
127
129
|
recents_tab_instruction: string;
|
128
130
|
hotload_help_docs: boolean;
|
129
131
|
slash_filters_enabled: boolean;
|
132
|
+
recents_sort_key: number | null;
|
133
|
+
recommended_sort_key: number | null;
|
130
134
|
}>;
|
131
135
|
static update: (object: {
|
132
136
|
id: string | number;
|
@@ -209,6 +213,8 @@ export declare class Organization {
|
|
209
213
|
recents_tab_instruction: string;
|
210
214
|
hotload_help_docs: boolean;
|
211
215
|
slash_filters_enabled: boolean;
|
216
|
+
recents_sort_key: number | null;
|
217
|
+
recommended_sort_key: number | null;
|
212
218
|
}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
|
213
219
|
id: string | number;
|
214
220
|
name: string;
|
@@ -290,6 +296,8 @@ export declare class Organization {
|
|
290
296
|
recents_tab_instruction: string;
|
291
297
|
hotload_help_docs: boolean;
|
292
298
|
slash_filters_enabled: boolean;
|
299
|
+
recents_sort_key: number | null;
|
300
|
+
recommended_sort_key: number | null;
|
293
301
|
}>;
|
294
302
|
static listCommands: (orgUID: string) => Promise<({
|
295
303
|
id: number;
|
@@ -299,7 +307,7 @@ export declare class Organization {
|
|
299
307
|
type: "admin";
|
300
308
|
value: string;
|
301
309
|
} & {} & {
|
302
|
-
commandType?: "object" | "
|
310
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
303
311
|
object?: string | undefined;
|
304
312
|
hoverTooltip?: boolean | undefined;
|
305
313
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -307,7 +315,7 @@ export declare class Organization {
|
|
307
315
|
type: "callback";
|
308
316
|
value: string;
|
309
317
|
} & {} & {
|
310
|
-
commandType?: "object" | "
|
318
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
311
319
|
object?: string | undefined;
|
312
320
|
hoverTooltip?: boolean | undefined;
|
313
321
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -315,7 +323,7 @@ export declare class Organization {
|
|
315
323
|
type: "link";
|
316
324
|
value: string;
|
317
325
|
} & {} & {
|
318
|
-
commandType?: "object" | "
|
326
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
319
327
|
object?: string | undefined;
|
320
328
|
hoverTooltip?: boolean | undefined;
|
321
329
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -323,7 +331,7 @@ export declare class Organization {
|
|
323
331
|
type: "click" | "clickByXpath" | "clickBySelector";
|
324
332
|
value: string[];
|
325
333
|
} & {} & {
|
326
|
-
commandType?: "object" | "
|
334
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
327
335
|
object?: string | undefined;
|
328
336
|
hoverTooltip?: boolean | undefined;
|
329
337
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -331,7 +339,7 @@ export declare class Organization {
|
|
331
339
|
type: "builtin";
|
332
340
|
value: string;
|
333
341
|
} & {} & {
|
334
|
-
commandType?: "object" | "
|
342
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
335
343
|
object?: string | undefined;
|
336
344
|
hoverTooltip?: boolean | undefined;
|
337
345
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -339,7 +347,7 @@ export declare class Organization {
|
|
339
347
|
type: "webhook";
|
340
348
|
value: string;
|
341
349
|
} & {} & {
|
342
|
-
commandType?: "object" | "
|
350
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
343
351
|
object?: string | undefined;
|
344
352
|
hoverTooltip?: boolean | undefined;
|
345
353
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -347,7 +355,7 @@ export declare class Organization {
|
|
347
355
|
type: "script";
|
348
356
|
value: string;
|
349
357
|
} & {} & {
|
350
|
-
commandType?: "object" | "
|
358
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
351
359
|
object?: string | undefined;
|
352
360
|
hoverTooltip?: boolean | undefined;
|
353
361
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -368,7 +376,7 @@ export declare class Organization {
|
|
368
376
|
onError?: string | undefined;
|
369
377
|
};
|
370
378
|
} & {} & {
|
371
|
-
commandType?: "object" | "
|
379
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
372
380
|
object?: string | undefined;
|
373
381
|
hoverTooltip?: boolean | undefined;
|
374
382
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -376,7 +384,7 @@ export declare class Organization {
|
|
376
384
|
type: "appcues";
|
377
385
|
value: string;
|
378
386
|
} & {} & {
|
379
|
-
commandType?: "object" | "
|
387
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
380
388
|
object?: string | undefined;
|
381
389
|
hoverTooltip?: boolean | undefined;
|
382
390
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -384,7 +392,7 @@ export declare class Organization {
|
|
384
392
|
type: "video";
|
385
393
|
value: string;
|
386
394
|
} & {} & {
|
387
|
-
commandType?: "object" | "
|
395
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
388
396
|
object?: string | undefined;
|
389
397
|
hoverTooltip?: boolean | undefined;
|
390
398
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -392,7 +400,7 @@ export declare class Organization {
|
|
392
400
|
type: "helpdoc";
|
393
401
|
value: string;
|
394
402
|
} & {} & {
|
395
|
-
commandType?: "object" | "
|
403
|
+
commandType?: "object" | "help" | "independent" | undefined;
|
396
404
|
object?: string | undefined;
|
397
405
|
hoverTooltip?: boolean | undefined;
|
398
406
|
operation?: "self" | "router" | "blank" | undefined;
|
@@ -547,14 +555,14 @@ export declare class Organization {
|
|
547
555
|
};
|
548
556
|
tags: string[];
|
549
557
|
availability_rules: ({
|
550
|
-
type: "url" | "
|
558
|
+
type: "url" | "element" | "context";
|
551
559
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
552
560
|
} & {
|
553
561
|
field?: string | undefined;
|
554
562
|
value?: string | undefined;
|
555
563
|
reason?: string | undefined;
|
556
564
|
})[] | (({
|
557
|
-
type: "url" | "
|
565
|
+
type: "url" | "element" | "context";
|
558
566
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
559
567
|
} & {
|
560
568
|
field?: string | undefined;
|
@@ -567,7 +575,7 @@ export declare class Organization {
|
|
567
575
|
reason?: string | undefined;
|
568
576
|
}))[];
|
569
577
|
recommend_rules: (({
|
570
|
-
type: "url" | "
|
578
|
+
type: "url" | "element" | "context";
|
571
579
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
572
580
|
} & {
|
573
581
|
field?: string | undefined;
|
@@ -581,17 +589,12 @@ export declare class Organization {
|
|
581
589
|
value?: null | undefined;
|
582
590
|
reason?: null | undefined;
|
583
591
|
}))[] | (({
|
584
|
-
type: "url" | "
|
592
|
+
type: "url" | "element" | "context";
|
585
593
|
operator: "includes" | "endsWith" | "startsWith" | "is" | "isTruthy" | "isFalsy" | "isNot" | "isTrue" | "isFalse" | "doesNotInclude" | "matchesRegex" | "isGreaterThan" | "isLessThan" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage";
|
586
594
|
} & {
|
587
595
|
field?: string | undefined;
|
588
596
|
value?: string | undefined;
|
589
597
|
reason?: string | undefined;
|
590
|
-
}) | ({
|
591
|
-
type: "named_rule";
|
592
|
-
rule_id: number;
|
593
|
-
} & {
|
594
|
-
reason?: string | undefined;
|
595
598
|
}) | ({
|
596
599
|
type: "always";
|
597
600
|
} & {
|
@@ -599,6 +602,11 @@ export declare class Organization {
|
|
599
602
|
field?: null | undefined;
|
600
603
|
value?: null | undefined;
|
601
604
|
reason?: null | undefined;
|
605
|
+
}) | ({
|
606
|
+
type: "named_rule";
|
607
|
+
rule_id: number;
|
608
|
+
} & {
|
609
|
+
reason?: string | undefined;
|
602
610
|
}))[];
|
603
611
|
availability_expression: import("./helpers/rules").RuleExpression;
|
604
612
|
recommend_expression: import("./helpers/rules").RuleExpression;
|
@@ -768,6 +776,8 @@ export declare class Organization {
|
|
768
776
|
recents_tab_instruction: string;
|
769
777
|
hotload_help_docs: boolean;
|
770
778
|
slash_filters_enabled: boolean;
|
779
|
+
recents_sort_key: number | null;
|
780
|
+
recommended_sort_key: number | null;
|
771
781
|
}>;
|
772
782
|
static updateSetting: (object: {
|
773
783
|
end_user_limit?: number | undefined;
|
@@ -796,6 +806,8 @@ export declare class Organization {
|
|
796
806
|
recents_tab_instruction?: string | undefined;
|
797
807
|
hotload_help_docs?: boolean | undefined;
|
798
808
|
slash_filters_enabled?: boolean | undefined;
|
809
|
+
recents_sort_key?: number | null | undefined;
|
810
|
+
recommended_sort_key?: number | null | undefined;
|
799
811
|
}, params?: Record<string, string> | undefined, callbacks?: {
|
800
812
|
onSuccess?: (() => void) | undefined;
|
801
813
|
onError?: ((err: string) => void) | undefined;
|
@@ -826,6 +838,8 @@ export declare class Organization {
|
|
826
838
|
recents_tab_instruction: string;
|
827
839
|
hotload_help_docs: boolean;
|
828
840
|
slash_filters_enabled: boolean;
|
841
|
+
recents_sort_key: number | null;
|
842
|
+
recommended_sort_key: number | null;
|
829
843
|
}>;
|
830
844
|
static decode: (data: any) => {
|
831
845
|
id: string | number;
|
@@ -908,5 +922,7 @@ export declare class Organization {
|
|
908
922
|
recents_tab_instruction: string;
|
909
923
|
hotload_help_docs: boolean;
|
910
924
|
slash_filters_enabled: boolean;
|
925
|
+
recents_sort_key: number | null;
|
926
|
+
recommended_sort_key: number | null;
|
911
927
|
};
|
912
928
|
}
|