commandbar 1.10.2 → 1.12.0

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 (54) hide show
  1. package/build/commandbar/src/shared/services/analytics/EventHandler.d.ts +9 -4
  2. package/build/commandbar/src/shared/services/analytics/event-queue.d.ts +13 -0
  3. package/build/commandbar/src/shared/services/analytics/types.d.ts +3 -3
  4. package/build/commandbar/src/shared/services/analytics/v2/client.d.ts +54 -0
  5. package/build/commandbar/src/shared/services/analytics/v2/helpers.d.ts +6 -0
  6. package/build/commandbar/src/shared/services/analytics/v2/schema.d.ts +152 -0
  7. package/build/commandbar/src/shared/services/analytics/v2/types.d.ts +4 -0
  8. package/build/commandbar-js/src/index.d.ts +2 -3
  9. package/build/commandbar-js/src/index.js +1 -1
  10. package/build/commandbar-js/src/snippet.d.ts +7 -1
  11. package/build/internal/src/client/CommandBarClientSDK.d.ts +13 -1
  12. package/build/internal/src/client/CommandBarProxySDK.d.ts +1 -4
  13. package/build/internal/src/client/CommandBarSDK.d.ts +7 -5
  14. package/build/internal/src/client/SDKConfig.d.ts +3 -1
  15. package/build/internal/src/client/globals.d.ts +1 -0
  16. package/build/internal/src/client/symbols.d.ts +3 -1
  17. package/build/internal/src/middleware/CommandFromClientV.d.ts +16 -2
  18. package/build/internal/src/middleware/OrganizationV.d.ts +44 -8
  19. package/build/internal/src/middleware/additionalResource.d.ts +9 -9
  20. package/build/internal/src/middleware/api.d.ts +181 -0
  21. package/build/internal/src/middleware/billing.d.ts +10 -0
  22. package/build/internal/src/middleware/chat.d.ts +3662 -172
  23. package/build/internal/src/middleware/checklist.d.ts +26 -10
  24. package/build/internal/src/middleware/command.d.ts +540 -140
  25. package/build/internal/src/middleware/endUser.d.ts +2 -0
  26. package/build/internal/src/middleware/experienceTemplate.d.ts +2882 -8
  27. package/build/internal/src/middleware/experiencesSearch.d.ts +233 -28
  28. package/build/internal/src/middleware/flags.d.ts +15 -1
  29. package/build/internal/src/middleware/generics.d.ts +1 -0
  30. package/build/internal/src/middleware/helpDocsIntegration.d.ts +98 -0
  31. package/build/internal/src/middleware/helpDocsSearch.d.ts +165 -20
  32. package/build/internal/src/middleware/helpDocsSync.d.ts +4 -0
  33. package/build/internal/src/middleware/helpHub.d.ts +1 -0
  34. package/build/internal/src/middleware/helpers/actions.d.ts +6 -6
  35. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +2 -2
  36. package/build/internal/src/middleware/helpers/rules.d.ts +9 -7
  37. package/build/internal/src/middleware/localizedMessage.d.ts +50 -0
  38. package/build/internal/src/middleware/network.d.ts +1 -0
  39. package/build/internal/src/middleware/nudge.d.ts +104 -24
  40. package/build/internal/src/middleware/organization.d.ts +201 -62
  41. package/build/internal/src/middleware/organizationSettings.d.ts +12 -8
  42. package/build/internal/src/middleware/profile.d.ts +8 -0
  43. package/build/internal/src/middleware/recommendationSet.d.ts +18 -9
  44. package/build/internal/src/middleware/theme.d.ts +81 -0
  45. package/build/internal/src/middleware/types.d.ts +27 -6
  46. package/build/internal/src/middleware/user.d.ts +9 -1
  47. package/build/internal/src/middleware/workflow.d.ts +85 -0
  48. package/build/internal/src/util/sentry.d.ts +2 -2
  49. package/package.json +8 -3
  50. package/src/index.ts +2 -3
  51. package/src/init.ts +32 -14
  52. package/src/snippet.ts +84 -74
  53. package/build/internal/src/client/OrgConfig.d.ts +0 -5
  54. package/build/internal/src/middleware/guide.d.ts +0 -37
package/build/internal/src/middleware/generics.d.ts CHANGED
@@ -1,5 +1,6 @@
1
1
  import * as t from 'io-ts';
2
2
  import * as axiosInstance from './network';
3
+ export declare function mkQueryString(params: Record<string, string> | undefined): string;
3
4
  declare function decodeToPromise<T, O, I>(validator: t.Type<T, O, I>, input: I): Promise<T>;
4
5
  export declare function decodeToPromiseExact<T, O, I>(validator: t.Type<T, O, I> & t.HasProps, input: I): Promise<T>;
5
6
  declare function decodeThrowing<T, O, I>(validator: t.Type<T, O, I>, input: I): T;
package/build/internal/src/middleware/helpDocsIntegration.d.ts CHANGED
@@ -5,6 +5,20 @@ export declare const HelpDocsIntegrationV: t.IntersectionC<[t.TypeC<{
5
5
  type: t.StringC;
6
6
  schedule: t.StringC;
7
7
  meta: t.UnionC<[t.RecordC<t.StringC, t.AnyC>, t.NullC]>;
8
+ audience: t.UnionC<[t.UnionC<[t.TypeC<{
9
+ type: t.LiteralC<"all_users">;
10
+ }>, t.TypeC<{
11
+ type: t.LiteralC<"rule_expression">;
12
+ expression: t.Type<import("./helpers/rules").RuleExpression, import("./helpers/rules").RuleExpression, unknown>;
13
+ }>, t.TypeC<{
14
+ type: t.LiteralC<"named_rule_reference">;
15
+ rule_reference: t.IntersectionC<[t.TypeC<{
16
+ type: t.LiteralC<"named_rule">;
17
+ rule_id: t.UnionC<[t.NumberC, t.StringC]>;
18
+ }>, t.PartialC<{
19
+ reason: t.StringC;
20
+ }>]>;
21
+ }>]>, t.NullC]>;
8
22
  helphub_view_article_button_hidden: t.UnionC<[t.BooleanC, t.UndefinedC, t.NullC]>;
9
23
  }>, t.PartialC<{
10
24
  title: t.StringC;
@@ -21,6 +35,20 @@ export declare class HelpDocsIntegration {
21
35
  meta: {
22
36
  [x: string]: any;
23
37
  } | null;
38
+ audience: {
39
+ type: "all_users";
40
+ } | {
41
+ type: "rule_expression";
42
+ expression: import("./helpers/rules").RuleExpression;
43
+ } | {
44
+ type: "named_rule_reference";
45
+ rule_reference: {
46
+ type: "named_rule";
47
+ rule_id: string | number;
48
+ } & {
49
+ reason?: string | undefined;
50
+ };
51
+ } | null;
24
52
  helphub_view_article_button_hidden: boolean | null | undefined;
25
53
  } & {
26
54
  title?: string | undefined;
@@ -35,6 +63,20 @@ export declare class HelpDocsIntegration {
35
63
  meta: {
36
64
  [x: string]: any;
37
65
  } | null;
66
+ audience: {
67
+ type: "all_users";
68
+ } | {
69
+ type: "rule_expression";
70
+ expression: import("./helpers/rules").RuleExpression;
71
+ } | {
72
+ type: "named_rule_reference";
73
+ rule_reference: {
74
+ type: "named_rule";
75
+ rule_id: string | number;
76
+ } & {
77
+ reason?: string | undefined;
78
+ };
79
+ } | null;
38
80
  helphub_view_article_button_hidden: boolean | null | undefined;
39
81
  } & {
40
82
  title?: string | undefined;
@@ -53,6 +95,20 @@ export declare class HelpDocsIntegration {
53
95
  meta: {
54
96
  [x: string]: any;
55
97
  } | null;
98
+ audience: {
99
+ type: "all_users";
100
+ } | {
101
+ type: "rule_expression";
102
+ expression: import("./helpers/rules").RuleExpression;
103
+ } | {
104
+ type: "named_rule_reference";
105
+ rule_reference: {
106
+ type: "named_rule";
107
+ rule_id: string | number;
108
+ } & {
109
+ reason?: string | undefined;
110
+ };
111
+ } | null;
56
112
  helphub_view_article_button_hidden: boolean | null | undefined;
57
113
  } & {
58
114
  title?: string | undefined;
@@ -68,6 +124,20 @@ export declare class HelpDocsIntegration {
68
124
  meta: {
69
125
  [x: string]: any;
70
126
  } | null;
127
+ audience: {
128
+ type: "all_users";
129
+ } | {
130
+ type: "rule_expression";
131
+ expression: import("./helpers/rules").RuleExpression;
132
+ } | {
133
+ type: "named_rule_reference";
134
+ rule_reference: {
135
+ type: "named_rule";
136
+ rule_id: string | number;
137
+ } & {
138
+ reason?: string | undefined;
139
+ };
140
+ } | null;
71
141
  helphub_view_article_button_hidden: boolean | null | undefined;
72
142
  } & {
73
143
  title?: string | undefined;
@@ -83,6 +153,20 @@ export declare class HelpDocsIntegration {
83
153
  meta: {
84
154
  [x: string]: any;
85
155
  } | null;
156
+ audience: {
157
+ type: "all_users";
158
+ } | {
159
+ type: "rule_expression";
160
+ expression: import("./helpers/rules").RuleExpression;
161
+ } | {
162
+ type: "named_rule_reference";
163
+ rule_reference: {
164
+ type: "named_rule";
165
+ rule_id: string | number;
166
+ } & {
167
+ reason?: string | undefined;
168
+ };
169
+ } | null;
86
170
  helphub_view_article_button_hidden: boolean | null | undefined;
87
171
  } & {
88
172
  title?: string | undefined;
@@ -97,6 +181,20 @@ export declare class HelpDocsIntegration {
97
181
  meta: {
98
182
  [x: string]: any;
99
183
  } | null;
184
+ audience: {
185
+ type: "all_users";
186
+ } | {
187
+ type: "rule_expression";
188
+ expression: import("./helpers/rules").RuleExpression;
189
+ } | {
190
+ type: "named_rule_reference";
191
+ rule_reference: {
192
+ type: "named_rule";
193
+ rule_id: string | number;
194
+ } & {
195
+ reason?: string | undefined;
196
+ };
197
+ } | null;
100
198
  helphub_view_article_button_hidden: boolean | null | undefined;
101
199
  } & {
102
200
  title?: string | undefined;
package/build/internal/src/middleware/helpDocsSearch.d.ts CHANGED
@@ -187,7 +187,7 @@ export declare const HelpDocHitV: t.TypeC<{
187
187
  }) | {
188
188
  type: "open_chat";
189
189
  meta: {
190
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
190
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
191
191
  };
192
192
  } | {
193
193
  type: "dismiss";
@@ -313,7 +313,7 @@ export declare const HelpDocHitV: t.TypeC<{
313
313
  };
314
314
  tags: string[];
315
315
  availability_rules: (({
316
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
316
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
317
317
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
318
318
  } & {
319
319
  field?: string | undefined;
@@ -342,7 +342,7 @@ export declare const HelpDocHitV: t.TypeC<{
342
342
  reason?: string | undefined;
343
343
  }))[];
344
344
  recommend_rules: (({
345
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
345
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
346
346
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
347
347
  } & {
348
348
  field?: string | undefined;
@@ -381,6 +381,20 @@ export declare const HelpDocHitV: t.TypeC<{
381
381
  availability_expression: import("./helpers/rules").RuleExpression | null;
382
382
  recommend_expression: import("./helpers/rules").RuleExpression | null;
383
383
  always_recommend: boolean;
384
+ audience: {
385
+ type: "all_users";
386
+ } | {
387
+ type: "rule_expression";
388
+ expression: import("./helpers/rules").RuleExpression;
389
+ } | {
390
+ type: "named_rule_reference";
391
+ rule_reference: {
392
+ type: "named_rule";
393
+ rule_id: string | number;
394
+ } & {
395
+ reason?: string | undefined;
396
+ };
397
+ } | null;
384
398
  confirm: string;
385
399
  shortcut: string[];
386
400
  explanation: string;
@@ -457,7 +471,7 @@ export declare const HelpDocHitV: t.TypeC<{
457
471
  }) | {
458
472
  type: "open_chat";
459
473
  meta: {
460
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
474
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
461
475
  };
462
476
  } | {
463
477
  type: "dismiss";
@@ -498,6 +512,7 @@ export declare const HelpDocHitV: t.TypeC<{
498
512
  show_in_helphub_search: boolean;
499
513
  copilot_cta_label: string;
500
514
  copilot_description: string;
515
+ copilot_use_verbatim: boolean;
501
516
  } & {
502
517
  third_party_source?: string | null | undefined;
503
518
  third_party_id?: string | null | undefined;
@@ -505,6 +520,20 @@ export declare const HelpDocHitV: t.TypeC<{
505
520
  integration?: {
506
521
  id: number;
507
522
  helphub_view_article_button_hidden: boolean | undefined;
523
+ audience: {
524
+ type: "all_users";
525
+ } | {
526
+ type: "rule_expression";
527
+ expression: import("./helpers/rules").RuleExpression;
528
+ } | {
529
+ type: "named_rule_reference";
530
+ rule_reference: {
531
+ type: "named_rule";
532
+ rule_id: string | number;
533
+ } & {
534
+ reason?: string | undefined;
535
+ };
536
+ } | undefined;
508
537
  } | null | undefined;
509
538
  }, {
510
539
  id: number;
@@ -687,7 +716,7 @@ export declare const HelpDocHitV: t.TypeC<{
687
716
  }) | {
688
717
  type: "open_chat";
689
718
  meta: {
690
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
719
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
691
720
  };
692
721
  } | {
693
722
  type: "dismiss";
@@ -813,7 +842,7 @@ export declare const HelpDocHitV: t.TypeC<{
813
842
  };
814
843
  tags: string[];
815
844
  availability_rules: (({
816
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
845
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
817
846
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
818
847
  } & {
819
848
  field?: string | undefined;
@@ -842,7 +871,7 @@ export declare const HelpDocHitV: t.TypeC<{
842
871
  reason?: string | undefined;
843
872
  }))[];
844
873
  recommend_rules: (({
845
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
874
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
846
875
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
847
876
  } & {
848
877
  field?: string | undefined;
@@ -881,6 +910,20 @@ export declare const HelpDocHitV: t.TypeC<{
881
910
  availability_expression: import("./helpers/rules").RuleExpression | null;
882
911
  recommend_expression: import("./helpers/rules").RuleExpression | null;
883
912
  always_recommend: boolean;
913
+ audience: {
914
+ type: "all_users";
915
+ } | {
916
+ type: "rule_expression";
917
+ expression: import("./helpers/rules").RuleExpression;
918
+ } | {
919
+ type: "named_rule_reference";
920
+ rule_reference: {
921
+ type: "named_rule";
922
+ rule_id: string | number;
923
+ } & {
924
+ reason?: string | undefined;
925
+ };
926
+ } | null;
884
927
  confirm: string;
885
928
  shortcut: string[];
886
929
  explanation: string;
@@ -957,7 +1000,7 @@ export declare const HelpDocHitV: t.TypeC<{
957
1000
  }) | {
958
1001
  type: "open_chat";
959
1002
  meta: {
960
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1003
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
961
1004
  };
962
1005
  } | {
963
1006
  type: "dismiss";
@@ -998,6 +1041,7 @@ export declare const HelpDocHitV: t.TypeC<{
998
1041
  show_in_helphub_search: boolean;
999
1042
  copilot_cta_label: string;
1000
1043
  copilot_description: string;
1044
+ copilot_use_verbatim: boolean;
1001
1045
  } & {
1002
1046
  third_party_source?: string | null | undefined;
1003
1047
  third_party_id?: string | null | undefined;
@@ -1005,6 +1049,20 @@ export declare const HelpDocHitV: t.TypeC<{
1005
1049
  integration?: {
1006
1050
  id: number;
1007
1051
  helphub_view_article_button_hidden: boolean | undefined;
1052
+ audience: {
1053
+ type: "all_users";
1054
+ } | {
1055
+ type: "rule_expression";
1056
+ expression: import("./helpers/rules").RuleExpression;
1057
+ } | {
1058
+ type: "named_rule_reference";
1059
+ rule_reference: {
1060
+ type: "named_rule";
1061
+ rule_id: string | number;
1062
+ } & {
1063
+ reason?: string | undefined;
1064
+ };
1065
+ } | undefined;
1008
1066
  } | null | undefined;
1009
1067
  }, any>;
1010
1068
  excerpt: t.StringC;
@@ -1194,7 +1252,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1194
1252
  }) | {
1195
1253
  type: "open_chat";
1196
1254
  meta: {
1197
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1255
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1198
1256
  };
1199
1257
  } | {
1200
1258
  type: "dismiss";
@@ -1320,7 +1378,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1320
1378
  };
1321
1379
  tags: string[];
1322
1380
  availability_rules: (({
1323
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1381
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1324
1382
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1325
1383
  } & {
1326
1384
  field?: string | undefined;
@@ -1349,7 +1407,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1349
1407
  reason?: string | undefined;
1350
1408
  }))[];
1351
1409
  recommend_rules: (({
1352
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1410
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1353
1411
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1354
1412
  } & {
1355
1413
  field?: string | undefined;
@@ -1388,6 +1446,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1388
1446
  availability_expression: import("./helpers/rules").RuleExpression | null;
1389
1447
  recommend_expression: import("./helpers/rules").RuleExpression | null;
1390
1448
  always_recommend: boolean;
1449
+ audience: {
1450
+ type: "all_users";
1451
+ } | {
1452
+ type: "rule_expression";
1453
+ expression: import("./helpers/rules").RuleExpression;
1454
+ } | {
1455
+ type: "named_rule_reference";
1456
+ rule_reference: {
1457
+ type: "named_rule";
1458
+ rule_id: string | number;
1459
+ } & {
1460
+ reason?: string | undefined;
1461
+ };
1462
+ } | null;
1391
1463
  confirm: string;
1392
1464
  shortcut: string[];
1393
1465
  explanation: string;
@@ -1464,7 +1536,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1464
1536
  }) | {
1465
1537
  type: "open_chat";
1466
1538
  meta: {
1467
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1539
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1468
1540
  };
1469
1541
  } | {
1470
1542
  type: "dismiss";
@@ -1505,6 +1577,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1505
1577
  show_in_helphub_search: boolean;
1506
1578
  copilot_cta_label: string;
1507
1579
  copilot_description: string;
1580
+ copilot_use_verbatim: boolean;
1508
1581
  } & {
1509
1582
  third_party_source?: string | null | undefined;
1510
1583
  third_party_id?: string | null | undefined;
@@ -1512,6 +1585,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1512
1585
  integration?: {
1513
1586
  id: number;
1514
1587
  helphub_view_article_button_hidden: boolean | undefined;
1588
+ audience: {
1589
+ type: "all_users";
1590
+ } | {
1591
+ type: "rule_expression";
1592
+ expression: import("./helpers/rules").RuleExpression;
1593
+ } | {
1594
+ type: "named_rule_reference";
1595
+ rule_reference: {
1596
+ type: "named_rule";
1597
+ rule_id: string | number;
1598
+ } & {
1599
+ reason?: string | undefined;
1600
+ };
1601
+ } | undefined;
1515
1602
  } | null | undefined;
1516
1603
  }, {
1517
1604
  id: number;
@@ -1694,7 +1781,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1694
1781
  }) | {
1695
1782
  type: "open_chat";
1696
1783
  meta: {
1697
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
1784
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1698
1785
  };
1699
1786
  } | {
1700
1787
  type: "dismiss";
@@ -1820,7 +1907,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1820
1907
  };
1821
1908
  tags: string[];
1822
1909
  availability_rules: (({
1823
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1910
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1824
1911
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1825
1912
  } & {
1826
1913
  field?: string | undefined;
@@ -1849,7 +1936,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1849
1936
  reason?: string | undefined;
1850
1937
  }))[];
1851
1938
  recommend_rules: (({
1852
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1939
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
1853
1940
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
1854
1941
  } & {
1855
1942
  field?: string | undefined;
@@ -1888,6 +1975,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1888
1975
  availability_expression: import("./helpers/rules").RuleExpression | null;
1889
1976
  recommend_expression: import("./helpers/rules").RuleExpression | null;
1890
1977
  always_recommend: boolean;
1978
+ audience: {
1979
+ type: "all_users";
1980
+ } | {
1981
+ type: "rule_expression";
1982
+ expression: import("./helpers/rules").RuleExpression;
1983
+ } | {
1984
+ type: "named_rule_reference";
1985
+ rule_reference: {
1986
+ type: "named_rule";
1987
+ rule_id: string | number;
1988
+ } & {
1989
+ reason?: string | undefined;
1990
+ };
1991
+ } | null;
1891
1992
  confirm: string;
1892
1993
  shortcut: string[];
1893
1994
  explanation: string;
@@ -1964,7 +2065,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
1964
2065
  }) | {
1965
2066
  type: "open_chat";
1966
2067
  meta: {
1967
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2068
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
1968
2069
  };
1969
2070
  } | {
1970
2071
  type: "dismiss";
@@ -2005,6 +2106,7 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
2005
2106
  show_in_helphub_search: boolean;
2006
2107
  copilot_cta_label: string;
2007
2108
  copilot_description: string;
2109
+ copilot_use_verbatim: boolean;
2008
2110
  } & {
2009
2111
  third_party_source?: string | null | undefined;
2010
2112
  third_party_id?: string | null | undefined;
@@ -2012,6 +2114,20 @@ export declare const SearchHelpDocsResponseV: t.TypeC<{
2012
2114
  integration?: {
2013
2115
  id: number;
2014
2116
  helphub_view_article_button_hidden: boolean | undefined;
2117
+ audience: {
2118
+ type: "all_users";
2119
+ } | {
2120
+ type: "rule_expression";
2121
+ expression: import("./helpers/rules").RuleExpression;
2122
+ } | {
2123
+ type: "named_rule_reference";
2124
+ rule_reference: {
2125
+ type: "named_rule";
2126
+ rule_id: string | number;
2127
+ } & {
2128
+ reason?: string | undefined;
2129
+ };
2130
+ } | undefined;
2015
2131
  } | null | undefined;
2016
2132
  }, any>;
2017
2133
  excerpt: t.StringC;
@@ -2213,7 +2329,7 @@ export declare class HelpDocsSearch {
2213
2329
  }) | {
2214
2330
  type: "open_chat";
2215
2331
  meta: {
2216
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2332
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2217
2333
  };
2218
2334
  } | {
2219
2335
  type: "dismiss";
@@ -2339,7 +2455,7 @@ export declare class HelpDocsSearch {
2339
2455
  };
2340
2456
  tags: string[];
2341
2457
  availability_rules: (({
2342
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2458
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2343
2459
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2344
2460
  } & {
2345
2461
  field?: string | undefined;
@@ -2368,7 +2484,7 @@ export declare class HelpDocsSearch {
2368
2484
  reason?: string | undefined;
2369
2485
  }))[];
2370
2486
  recommend_rules: (({
2371
- type: "url" | "element" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2487
+ type: "url" | "element" | "amplitude" | "context" | "hubspot" | "device_type" | "sessions" | "survey_response" | "user_property" | "event_property" | "hostname" | "executions" | "shortcuts" | "last_seen" | "first_seen" | "opens" | "deadends" | "heap" | "ab_test" | "intent" | "help_doc_interaction" | "video_interaction";
2372
2488
  operator: "includes" | "endsWith" | "startsWith" | "is" | "isTrue" | "isFalse" | "isTruthy" | "isFalsy" | "matchesRegex" | "isDefined" | "isNotDefined" | "classnameOnPage" | "idOnPage" | "selectorOnPage" | "classnameNotOnPage" | "idNotOnPage" | "selectorNotOnPage" | "doesNotInclude" | "isNot" | "isGreaterThan" | "isLessThan";
2373
2489
  } & {
2374
2490
  field?: string | undefined;
@@ -2407,6 +2523,20 @@ export declare class HelpDocsSearch {
2407
2523
  availability_expression: import("./helpers/rules").RuleExpression | null;
2408
2524
  recommend_expression: import("./helpers/rules").RuleExpression | null;
2409
2525
  always_recommend: boolean;
2526
+ audience: {
2527
+ type: "all_users";
2528
+ } | {
2529
+ type: "rule_expression";
2530
+ expression: import("./helpers/rules").RuleExpression;
2531
+ } | {
2532
+ type: "named_rule_reference";
2533
+ rule_reference: {
2534
+ type: "named_rule";
2535
+ rule_id: string | number;
2536
+ } & {
2537
+ reason?: string | undefined;
2538
+ };
2539
+ } | null;
2410
2540
  confirm: string;
2411
2541
  shortcut: string[];
2412
2542
  explanation: string;
@@ -2483,7 +2613,7 @@ export declare class HelpDocsSearch {
2483
2613
  }) | {
2484
2614
  type: "open_chat";
2485
2615
  meta: {
2486
- type: "" | "intercom" | "helpscout" | "freshdesk" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift";
2616
+ type: "" | "intercom" | "helpscout" | "freshdesk" | "freshchat" | "crisp" | "zendesk" | "liveChat" | "gist" | "olark" | "hubspot" | "drift" | "zendesk_handoff";
2487
2617
  };
2488
2618
  } | {
2489
2619
  type: "dismiss";
@@ -2524,6 +2654,7 @@ export declare class HelpDocsSearch {
2524
2654
  show_in_helphub_search: boolean;
2525
2655
  copilot_cta_label: string;
2526
2656
  copilot_description: string;
2657
+ copilot_use_verbatim: boolean;
2527
2658
  } & {
2528
2659
  third_party_source?: string | null | undefined;
2529
2660
  third_party_id?: string | null | undefined;
@@ -2531,6 +2662,20 @@ export declare class HelpDocsSearch {
2531
2662
  integration?: {
2532
2663
  id: number;
2533
2664
  helphub_view_article_button_hidden: boolean | undefined;
2665
+ audience: {
2666
+ type: "all_users";
2667
+ } | {
2668
+ type: "rule_expression";
2669
+ expression: import("./helpers/rules").RuleExpression;
2670
+ } | {
2671
+ type: "named_rule_reference";
2672
+ rule_reference: {
2673
+ type: "named_rule";
2674
+ rule_id: string | number;
2675
+ } & {
2676
+ reason?: string | undefined;
2677
+ };
2678
+ } | undefined;
2534
2679
  } | null | undefined;
2535
2680
  };
2536
2681
  excerpt: string;
package/build/internal/src/middleware/helpDocsSync.d.ts CHANGED
@@ -12,6 +12,7 @@ export declare const HelpDocsSyncV: t.IntersectionC<[t.TypeC<{
12
12
  commands: t.ArrayC<t.NumberC>;
13
13
  started: t.UnionC<[t.StringC, t.NullC]>;
14
14
  ended: t.UnionC<[t.StringC, t.NullC]>;
15
+ error: t.UnionC<[t.StringC, t.NullC]>;
15
16
  log: t.ArrayC<t.UnionC<[t.ArrayC<t.AnyC>, t.TypeC<{
16
17
  ts: t.StringC;
17
18
  type: t.StringC;
@@ -27,6 +28,7 @@ export declare class HelpDocsSync {
27
28
  commands?: number[] | undefined;
28
29
  started?: string | null | undefined;
29
30
  ended?: string | null | undefined;
31
+ error?: string | null | undefined;
30
32
  log?: (any[] | {
31
33
  ts: string;
32
34
  type: string;
@@ -40,6 +42,7 @@ export declare class HelpDocsSync {
40
42
  commands?: number[] | undefined;
41
43
  started?: string | null | undefined;
42
44
  ended?: string | null | undefined;
45
+ error?: string | null | undefined;
43
46
  log?: (any[] | {
44
47
  ts: string;
45
48
  type: string;
@@ -54,6 +57,7 @@ export declare class HelpDocsSync {
54
57
  commands?: number[] | undefined;
55
58
  started?: string | null | undefined;
56
59
  ended?: string | null | undefined;
60
+ error?: string | null | undefined;
57
61
  log?: (any[] | {
58
62
  ts: string;
59
63
  type: string;
package/build/internal/src/middleware/helpHub.d.ts CHANGED
@@ -1,6 +1,7 @@
1
1
  import { DeviceType } from '../util/operatingSystem';
2
2
  import * as t from 'io-ts';
3
3
  import { IHelpHubLauncherSettingsType, IOrganizationType } from './types';
4
+ export declare const HelpHubSearchActionsV: t.UnionC<[t.LiteralC<"search">, t.LiteralC<"ask">]>;
4
5
  export declare const HelpHubLauncherPositionsV: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
5
6
  export declare const HelpHubLauncherTypesV: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"askAI">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
6
7
  export declare const HelpHubLauncherSettingsV: t.TypeC<{