commandbar 1.7.2 → 1.7.3

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.
Files changed (32) hide show
  1. package/build/commandbar-js/src/index.js +1 -1
  2. package/build/commandbar-js/src/init.d.ts +1 -1
  3. package/build/internal/src/client/AddContextOptions.d.ts +6 -7
  4. package/build/internal/src/client/AnalyticsEventTypes.d.ts +1 -1
  5. package/build/internal/src/client/CommandBarClientSDK.d.ts +18 -29
  6. package/build/internal/src/client/CommandBarSDK.d.ts +16 -2
  7. package/build/internal/src/client/EventHandler.d.ts +81 -16
  8. package/build/internal/src/client/globals.d.ts +1 -0
  9. package/build/internal/src/client/symbols.d.ts +6 -0
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +30 -47
  11. package/build/internal/src/middleware/OrganizationV.d.ts +7 -0
  12. package/build/internal/src/middleware/ResourceSettingsV.d.ts +2 -0
  13. package/build/internal/src/middleware/checklist.d.ts +740 -0
  14. package/build/internal/src/middleware/command.d.ts +680 -977
  15. package/build/internal/src/middleware/dashboardFlags.d.ts +9 -0
  16. package/build/internal/src/middleware/detailPreview.d.ts +3 -0
  17. package/build/internal/src/middleware/helpers/actions.d.ts +84 -0
  18. package/build/internal/src/middleware/helpers/argument.d.ts +0 -120
  19. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +60 -60
  20. package/build/internal/src/middleware/helpers/endUser.d.ts +1 -0
  21. package/build/internal/src/middleware/helpers/goals.d.ts +26 -0
  22. package/build/internal/src/middleware/helpers/rules.d.ts +48 -22
  23. package/build/internal/src/middleware/helpers/tags.d.ts +7 -0
  24. package/build/internal/src/middleware/historyEvent.d.ts +0 -19
  25. package/build/internal/src/middleware/nudge.d.ts +890 -94
  26. package/build/internal/src/middleware/organization.d.ts +88 -56
  27. package/build/internal/src/middleware/skin.d.ts +13 -2
  28. package/build/internal/src/middleware/types.d.ts +29 -11
  29. package/build/internal/src/middleware/user.d.ts +2 -1
  30. package/build/internal/src/util/LocalStorage.d.ts +1 -1
  31. package/package.json +2 -3
  32. package/src/init.ts +1 -1
@@ -8,15 +8,17 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
8
8
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
9
9
  object: t.StringC;
10
10
  hoverTooltip: t.BooleanC;
11
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
12
- }>]>]>, t.IntersectionC<[t.TypeC<{
11
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
12
+ }>]>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
13
13
  type: t.LiteralC<"link">;
14
14
  value: t.StringC;
15
- }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
15
+ }>, t.PartialC<{
16
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
17
+ }>]>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
16
18
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
17
19
  object: t.StringC;
18
20
  hoverTooltip: t.BooleanC;
19
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
21
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
20
22
  }>]>]>, t.IntersectionC<[t.TypeC<{
21
23
  type: t.LiteralC<"webhook">;
22
24
  value: t.StringC;
@@ -24,7 +26,7 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
24
26
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
25
27
  object: t.StringC;
26
28
  hoverTooltip: t.BooleanC;
27
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
29
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
28
30
  }>]>]>, t.IntersectionC<[t.TypeC<{
29
31
  type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
30
32
  value: t.ArrayC<t.StringC>;
@@ -32,7 +34,7 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
32
34
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
33
35
  object: t.StringC;
34
36
  hoverTooltip: t.BooleanC;
35
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
37
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
36
38
  }>]>]>, t.IntersectionC<[t.TypeC<{
37
39
  type: t.LiteralC<"request">;
38
40
  value: t.IntersectionC<[t.TypeC<{
@@ -49,7 +51,7 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
49
51
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
50
52
  object: t.StringC;
51
53
  hoverTooltip: t.BooleanC;
52
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
54
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
53
55
  }>]>]>, t.IntersectionC<[t.TypeC<{
54
56
  type: t.LiteralC<"appcues">;
55
57
  value: t.StringC;
@@ -57,15 +59,17 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
57
59
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
58
60
  object: t.StringC;
59
61
  hoverTooltip: t.BooleanC;
60
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
61
- }>]>]>, t.IntersectionC<[t.TypeC<{
62
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
63
+ }>]>]>, t.IntersectionC<[t.IntersectionC<[t.TypeC<{
62
64
  type: t.LiteralC<"helpdoc">;
63
65
  value: t.StringC;
64
- }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
66
+ }>, t.PartialC<{
67
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.LiteralC<"help_explorer">, t.UndefinedC]>;
68
+ }>]>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
65
69
  commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
66
70
  object: t.StringC;
67
71
  hoverTooltip: t.BooleanC;
68
- operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
72
+ operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_explorer">, t.LiteralC<"blank">, t.UndefinedC]>;
69
73
  }>]>]>]>;
70
74
  text: t.StringC;
71
75
  }>, t.PartialC<{
@@ -88,11 +92,6 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
88
92
  input_type: t.StringC;
89
93
  preselected_key: t.StringC;
90
94
  label_field: t.StringC;
91
- availability_condition: t.ArrayC<t.TypeC<{
92
- field: t.StringC;
93
- operator: t.UnionC<[t.LiteralC<"==">, t.LiteralC<"!=">, t.LiteralC<"isTruthy">, t.LiteralC<"isFalsy">]>;
94
- value: t.UnionC<[t.StringC, t.UndefinedC]>;
95
- }>>;
96
95
  loaded: t.ArrayC<t.AnyC>;
97
96
  allow_create: t.BooleanC;
98
97
  allow_create_label: t.StringC;
@@ -111,11 +110,6 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
111
110
  input_type: t.StringC;
112
111
  preselected_key: t.StringC;
113
112
  label_field: t.StringC;
114
- availability_condition: t.ArrayC<t.TypeC<{
115
- field: t.StringC;
116
- operator: t.UnionC<[t.LiteralC<"==">, t.LiteralC<"!=">, t.LiteralC<"isTruthy">, t.LiteralC<"isFalsy">]>;
117
- value: t.UnionC<[t.StringC, t.UndefinedC]>;
118
- }>>;
119
113
  loaded: t.ArrayC<t.AnyC>;
120
114
  allow_create: t.BooleanC;
121
115
  allow_create_label: t.StringC;
@@ -132,11 +126,6 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
132
126
  input_type: t.StringC;
133
127
  preselected_key: t.StringC;
134
128
  label_field: t.StringC;
135
- availability_condition: t.ArrayC<t.TypeC<{
136
- field: t.StringC;
137
- operator: t.UnionC<[t.LiteralC<"==">, t.LiteralC<"!=">, t.LiteralC<"isTruthy">, t.LiteralC<"isFalsy">]>;
138
- value: t.UnionC<[t.StringC, t.UndefinedC]>;
139
- }>>;
140
129
  loaded: t.ArrayC<t.AnyC>;
141
130
  dateTimeArgumentTypeId: t.NumberC;
142
131
  allow_create: t.BooleanC;
@@ -154,11 +143,6 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
154
143
  input_type: t.StringC;
155
144
  preselected_key: t.StringC;
156
145
  label_field: t.StringC;
157
- availability_condition: t.ArrayC<t.TypeC<{
158
- field: t.StringC;
159
- operator: t.UnionC<[t.LiteralC<"==">, t.LiteralC<"!=">, t.LiteralC<"isTruthy">, t.LiteralC<"isFalsy">]>;
160
- value: t.UnionC<[t.StringC, t.UndefinedC]>;
161
- }>>;
162
146
  loaded: t.ArrayC<t.AnyC>;
163
147
  allow_create: t.BooleanC;
164
148
  allow_create_label: t.StringC;
@@ -175,11 +159,6 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
175
159
  input_type: t.StringC;
176
160
  preselected_key: t.StringC;
177
161
  label_field: t.StringC;
178
- availability_condition: t.ArrayC<t.TypeC<{
179
- field: t.StringC;
180
- operator: t.UnionC<[t.LiteralC<"==">, t.LiteralC<"!=">, t.LiteralC<"isTruthy">, t.LiteralC<"isFalsy">]>;
181
- value: t.UnionC<[t.StringC, t.UndefinedC]>;
182
- }>>;
183
162
  loaded: t.ArrayC<t.AnyC>;
184
163
  allow_create: t.BooleanC;
185
164
  allow_create_label: t.StringC;
@@ -202,11 +181,6 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
202
181
  input_type: t.StringC;
203
182
  preselected_key: t.StringC;
204
183
  label_field: t.StringC;
205
- availability_condition: t.ArrayC<t.TypeC<{
206
- field: t.StringC;
207
- operator: t.UnionC<[t.LiteralC<"==">, t.LiteralC<"!=">, t.LiteralC<"isTruthy">, t.LiteralC<"isFalsy">]>;
208
- value: t.UnionC<[t.StringC, t.UndefinedC]>;
209
- }>>;
210
184
  loaded: t.ArrayC<t.AnyC>;
211
185
  allow_create: t.BooleanC;
212
186
  allow_create_label: t.StringC;
@@ -233,30 +207,34 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
233
207
  random: t.AnyC;
234
208
  }>, t.NullC]>;
235
209
  availability_rules: t.ArrayC<t.IntersectionC<[t.TypeC<{
236
- type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
210
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"executions">, t.LiteralC<"shortcuts">, t.LiteralC<"last_seen">, t.LiteralC<"first_seen">, t.LiteralC<"sessions">, t.LiteralC<"opens">, t.LiteralC<"deadends">]>;
237
211
  operator: t.KeyofC<{
238
212
  includes: null;
239
213
  endsWith: null;
240
214
  startsWith: null;
241
215
  is: null;
242
- isTruthy: null;
243
- isFalsy: null;
244
216
  isNot: null;
245
217
  isTrue: null;
246
218
  isFalse: null;
219
+ isTruthy: null;
220
+ isFalsy: null;
247
221
  doesNotInclude: null;
248
222
  matchesRegex: null;
249
223
  isGreaterThan: null;
250
224
  isLessThan: null;
225
+ isBefore: null;
226
+ isAfter: null;
251
227
  isDefined: null;
252
228
  isNotDefined: null;
253
229
  classnameOnPage: null;
254
230
  idOnPage: null;
231
+ selectorOnPage: null;
255
232
  }>;
256
233
  }>, t.PartialC<{
257
234
  field: t.StringC;
258
235
  value: t.StringC;
259
236
  reason: t.StringC;
237
+ rule_id: t.UnionC<[t.NumberC, t.StringC]>;
260
238
  }>]>>;
261
239
  recommend_rules: t.ArrayC<t.UnionC<[t.IntersectionC<[t.TypeC<{
262
240
  type: t.LiteralC<"always">;
@@ -265,31 +243,36 @@ export declare const CommandFromClientV: t.IntersectionC<[t.TypeC<{
265
243
  field: t.UnionC<[t.UndefinedC, t.NullC]>;
266
244
  value: t.UnionC<[t.UndefinedC, t.NullC]>;
267
245
  reason: t.UnionC<[t.UndefinedC, t.NullC]>;
246
+ rule_id: t.UnionC<[t.NumberC, t.StringC]>;
268
247
  }>]>, t.IntersectionC<[t.TypeC<{
269
- type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"event_count">]>;
248
+ type: t.UnionC<[t.LiteralC<"context">, t.LiteralC<"url">, t.LiteralC<"element">, t.LiteralC<"executions">, t.LiteralC<"shortcuts">, t.LiteralC<"last_seen">, t.LiteralC<"first_seen">, t.LiteralC<"sessions">, t.LiteralC<"opens">, t.LiteralC<"deadends">]>;
270
249
  operator: t.KeyofC<{
271
250
  includes: null;
272
251
  endsWith: null;
273
252
  startsWith: null;
274
253
  is: null;
275
- isTruthy: null;
276
- isFalsy: null;
277
254
  isNot: null;
278
255
  isTrue: null;
279
256
  isFalse: null;
257
+ isTruthy: null;
258
+ isFalsy: null;
280
259
  doesNotInclude: null;
281
260
  matchesRegex: null;
282
261
  isGreaterThan: null;
283
262
  isLessThan: null;
263
+ isBefore: null;
264
+ isAfter: null;
284
265
  isDefined: null;
285
266
  isNotDefined: null;
286
267
  classnameOnPage: null;
287
268
  idOnPage: null;
269
+ selectorOnPage: null;
288
270
  }>;
289
271
  }>, t.PartialC<{
290
272
  field: t.StringC;
291
273
  value: t.StringC;
292
274
  reason: t.StringC;
275
+ rule_id: t.UnionC<[t.NumberC, t.StringC]>;
293
276
  }>]>]>>;
294
277
  availability_expression: t.ArrayC<t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>>;
295
278
  recommend_expression: t.ArrayC<t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>>;
@@ -30,6 +30,7 @@ declare const OrganizationAdditionalV: t.TypeC<{
30
30
  sort_key: t.NumberC;
31
31
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
32
32
  sortFunction: t.AnyC;
33
+ hasSearchFunction: t.BooleanC;
33
34
  default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
34
35
  render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
35
36
  showResources: t.BooleanC;
@@ -64,6 +65,7 @@ declare const OrganizationAdditionalV: t.TypeC<{
64
65
  in_bar_feedback: t.BooleanC;
65
66
  summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
66
67
  end_user_hotkeys: t.UnionC<[t.UndefinedC, t.BooleanC]>;
68
+ force_end_user_identity_verification: t.BooleanC;
67
69
  end_user_shortcuts_enabled: t.BooleanC;
68
70
  end_user_recents_enabled: t.BooleanC;
69
71
  releases_available: t.BooleanC;
@@ -78,6 +80,7 @@ declare const OrganizationAdditionalV: t.TypeC<{
78
80
  slash_filters_enabled: t.BooleanC;
79
81
  recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
80
82
  recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
83
+ show_suggested_synonyms: t.BooleanC;
81
84
  has_hotloaded_help_docs: t.BooleanC;
82
85
  }>;
83
86
  export declare const defaults: t.TypeOf<typeof OrganizationAdditionalV>;
@@ -116,6 +119,7 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
116
119
  sort_key: t.NumberC;
117
120
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
118
121
  sortFunction: t.AnyC;
122
+ hasSearchFunction: t.BooleanC;
119
123
  default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
120
124
  render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
121
125
  showResources: t.BooleanC;
@@ -150,6 +154,7 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
150
154
  in_bar_feedback: t.BooleanC;
151
155
  summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
152
156
  end_user_hotkeys: t.UnionC<[t.UndefinedC, t.BooleanC]>;
157
+ force_end_user_identity_verification: t.BooleanC;
153
158
  end_user_shortcuts_enabled: t.BooleanC;
154
159
  end_user_recents_enabled: t.BooleanC;
155
160
  releases_available: t.BooleanC;
@@ -164,7 +169,9 @@ export declare const OrganizationV: t.IntersectionC<[t.IntersectionC<[t.TypeC<{
164
169
  slash_filters_enabled: t.BooleanC;
165
170
  recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
166
171
  recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
172
+ show_suggested_synonyms: t.BooleanC;
167
173
  has_hotloaded_help_docs: t.BooleanC;
168
174
  }>]>;
169
175
  export declare type IOrganizationType = t.TypeOf<typeof OrganizationV> & unknown;
176
+ export declare const unknownOrganization: IOrganizationType;
170
177
  export {};
@@ -22,6 +22,7 @@ export declare const ResourceSettingsV: t.PartialC<{
22
22
  sort_key: t.NumberC;
23
23
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
24
24
  sortFunction: t.AnyC;
25
+ hasSearchFunction: t.BooleanC;
25
26
  default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
26
27
  render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
27
28
  showResources: t.BooleanC;
@@ -64,6 +65,7 @@ export declare const ResourceSettingsByContextKeyV: t.RecordC<t.StringC, t.Parti
64
65
  sort_key: t.NumberC;
65
66
  max_options_count: t.UnionC<[t.NumberC, t.NullC]>;
66
67
  sortFunction: t.AnyC;
68
+ hasSearchFunction: t.BooleanC;
67
69
  default_command_id: t.UnionC<[t.NumberC, t.StringC, t.UndefinedC]>;
68
70
  render_as: t.UnionC<[t.LiteralC<"list">, t.LiteralC<"grid">]>;
69
71
  showResources: t.BooleanC;