commandbar 1.8.7 → 1.10.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (61) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +51 -15
  2. package/build/commandbar/src/shared/services/analytics/types.d.ts +77 -0
  3. package/build/commandbar-js/src/index.d.ts +2 -2
  4. package/build/commandbar-js/src/index.js +1 -1
  5. package/build/internal/src/client/AddContextOptions.d.ts +8 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +70 -19
  7. package/build/internal/src/client/CommandBarProxySDK.d.ts +3 -3
  8. package/build/internal/src/client/CommandBarSDK.d.ts +34 -18
  9. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  10. package/build/internal/src/client/globals.d.ts +6 -0
  11. package/build/internal/src/client/symbols.d.ts +13 -6
  12. package/build/internal/src/middleware/CommandFromClientV.d.ts +88 -18
  13. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  14. package/build/internal/src/middleware/OrganizationV.d.ts +320 -22
  15. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  16. package/build/internal/src/middleware/additionalResource.d.ts +270 -27
  17. package/build/internal/src/middleware/billing.d.ts +31 -0
  18. package/build/internal/src/middleware/chat.d.ts +12933 -0
  19. package/build/internal/src/middleware/checklist.d.ts +589 -70
  20. package/build/internal/src/middleware/command.d.ts +5433 -677
  21. package/build/internal/src/middleware/detailPreview.d.ts +12 -1
  22. package/build/internal/src/middleware/endUser.d.ts +132 -0
  23. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  24. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  25. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  26. package/build/internal/src/middleware/flags.d.ts +20 -0
  27. package/build/internal/src/middleware/generics.d.ts +12 -11
  28. package/build/internal/src/middleware/helpDocsIntegration.d.ts +63 -8
  29. package/build/internal/src/middleware/helpDocsSearch.d.ts +2540 -0
  30. package/build/internal/src/middleware/helpHub.d.ts +26 -0
  31. package/build/internal/src/middleware/helpers/actions.d.ts +174 -16
  32. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +144 -2
  33. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  34. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  35. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +28 -0
  36. package/build/internal/src/middleware/helpers/rules.d.ts +318 -50
  37. package/build/internal/src/middleware/network.d.ts +27 -3
  38. package/build/internal/src/middleware/nudge.d.ts +2220 -91
  39. package/build/internal/src/middleware/organization.d.ts +2289 -152
  40. package/build/internal/src/middleware/organizationSettings.d.ts +435 -20
  41. package/build/internal/src/middleware/profile.d.ts +2 -0
  42. package/build/internal/src/middleware/recommendationSet.d.ts +489 -1007
  43. package/build/internal/src/middleware/releases.d.ts +1 -1
  44. package/build/internal/src/middleware/theme.d.ts +425 -0
  45. package/build/internal/src/middleware/types.d.ts +88 -34
  46. package/build/internal/src/middleware/user.d.ts +1 -0
  47. package/build/internal/src/util/dispatchCustomEvent.d.ts +5 -3
  48. package/build/internal/src/util/operatingSystem.d.ts +11 -0
  49. package/build/internal/src/util/sentry.d.ts +23 -0
  50. package/package.json +3 -3
  51. package/src/index.ts +2 -2
  52. package/src/init.ts +11 -6
  53. package/src/snippet.ts +2 -2
  54. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  55. package/build/internal/src/client/SentryReporter.d.ts +0 -63
  56. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  57. package/build/internal/src/middleware/chatAnalytics.d.ts +0 -2601
  58. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
  59. package/build/internal/src/middleware/helpers/endUser.d.ts +0 -11
  60. package/build/internal/src/middleware/qaPair.d.ts +0 -676
  61. package/build/internal/src/util/integrations.d.ts +0 -1
@@ -0,0 +1,20 @@
1
+ /**
2
+ * To use a Flag in the frontend, add it to the Flags type and the `defaultFlags` object below.
3
+ */
4
+ export type Flags = {
5
+ 'release-search-experiences-in-help-hub': boolean;
6
+ 'release-search-experiences-in-spotlight': boolean;
7
+ 'support-ruby-on-rails': boolean;
8
+ 'release-disable-history-events': boolean;
9
+ 'show-history-events-missing-banner': '' | string;
10
+ 'release-themes-v2': boolean;
11
+ 'release-strikes-dashboard': boolean;
12
+ 'release-authed-zendesk-image-loading': boolean;
13
+ 'release-copilot-personalities': boolean;
14
+ 'release-analytics-v2': boolean;
15
+ 'enable-pendo-open-guide-action': boolean;
16
+ 'show-incident-banner': '' | string;
17
+ 'release-behavioral-targeting': boolean;
18
+ };
19
+ export declare const defaultFlags: Flags;
20
+ export declare const fetchFlags: (orgID: string) => Promise<Flags>;
@@ -1,4 +1,5 @@
1
1
  import * as t from 'io-ts';
2
+ import * as axiosInstance from './network';
2
3
  declare function decodeToPromise<T, O, I>(validator: t.Type<T, O, I>, input: I): Promise<T>;
3
4
  export declare function decodeToPromiseExact<T, O, I>(validator: t.Type<T, O, I> & t.HasProps, input: I): Promise<T>;
4
5
  declare function decodeThrowing<T, O, I>(validator: t.Type<T, O, I>, input: I): T;
@@ -10,32 +11,32 @@ export declare const GenericBatchRequest: t.TypeC<{
10
11
  batch: t.ArrayC<t.UnknownC>;
11
12
  note: t.StringC;
12
13
  }>;
13
- declare function createObject<T, Q, O, I>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
14
- declare function createObjectWithDecoder<T, Q, O, I>(decode: (result: any) => T, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
15
- declare function readObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string): (arg0: string, params?: Record<string, string>, callbacks?: {
14
+ declare function createObject<T, Q, O, I>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
15
+ declare function createObjectWithDecoder<T, Q, O, I>(decode: (result: any) => T, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
16
+ declare function readObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (arg0: string, params?: Record<string, string>, callbacks?: {
16
17
  onSuccess?: () => void;
17
18
  onError?: (err: string) => void;
18
19
  }) => Promise<T>;
19
- declare function listObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, obj: string): (onSuccess?: () => void, onError?: (err: string) => void) => Promise<T[]>;
20
- declare function updateObject<T, O, I, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
21
- declare function deleteObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string): (id: number | string, params?: Record<string, string>, onSuccess?: () => void, onError?: (err: string) => void) => Promise<void>;
22
- declare function readObjectDetail<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, detail: string): (arg0: string, urlArgs?: {
20
+ declare function listObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, obj: string, options?: axiosInstance.FetchOptions): (onSuccess?: () => void, onError?: (err: string) => void) => Promise<T[]>;
21
+ declare function updateObject<T, O, I, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, params?: Record<string, string>, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
22
+ declare function deleteObject<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (id: number | string, params?: Record<string, string>, onSuccess?: () => void, onError?: (err: string) => void) => Promise<void>;
23
+ declare function readObjectDetail<T, O, I>(arg: t.Type<T, O, I> & t.HasProps, url: string, detail: string, options?: axiosInstance.FetchOptions): (arg0: string, urlArgs?: {
23
24
  [arg: string]: string;
24
25
  }, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
25
- declare function updateObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string): (object: Q, urlArgs?: {
26
+ declare function updateObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string, options?: axiosInstance.FetchOptions): (object: Q, urlArgs?: {
26
27
  [arg: string]: string;
27
28
  }, onSuccess?: () => void, onError?: (err: string) => void) => Promise<T>;
28
- declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string): (object: Q, onSuccess?: () => void, onError?: (err: string) => void, urlArgs?: {
29
+ declare function createObjectDetail<T, O, I, J, K, Q extends GenericObjectType>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, K, J> & t.HasProps, url: string, detail: string, options?: axiosInstance.FetchOptions): (object: Q, onSuccess?: () => void, onError?: (err: string) => void, urlArgs?: {
29
30
  [arg: string]: string;
30
31
  }) => Promise<T>;
31
32
  declare function loadIDList(ids: number[], klass: any, method?: string, urlArgs?: {
32
33
  [arg: string]: string;
33
34
  }): Promise<any[]>;
34
- declare function read<T, O, I>(output: t.Type<T, O, I> & t.HasProps, url: string): (params?: Record<string, string>, callbacks?: {
35
+ declare function read<T, O, I>(output: t.Type<T, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (params?: Record<string, string>, callbacks?: {
35
36
  onSuccess?: () => void;
36
37
  onError?: (err: string) => void;
37
38
  }) => Promise<T>;
38
- declare function update<T, O, I, Q>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string): (object: Q, params?: Record<string, string>, callbacks?: {
39
+ declare function update<T, O, I, Q>(output: t.Type<T, O, I> & t.HasProps, input: t.Type<Q, O, I> & t.HasProps, url: string, options?: axiosInstance.FetchOptions): (object: Q, params?: Record<string, string>, callbacks?: {
39
40
  onSuccess?: () => void;
40
41
  onError?: (err: string) => void;
41
42
  }) => Promise<T>;
@@ -5,7 +5,13 @@ 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
- }>, t.PartialC<{}>]>;
8
+ helphub_view_article_button_hidden: t.UnionC<[t.BooleanC, t.UndefinedC, t.NullC]>;
9
+ }>, t.PartialC<{
10
+ title: t.StringC;
11
+ icon: t.StringC;
12
+ commands_count: t.NumberC;
13
+ recent_sync_date: t.UnionC<[t.StringC, t.NullC]>;
14
+ }>]>;
9
15
  export declare class HelpDocsIntegration {
10
16
  static create: (object: {
11
17
  id: number;
@@ -15,7 +21,13 @@ export declare class HelpDocsIntegration {
15
21
  meta: {
16
22
  [x: string]: any;
17
23
  } | null;
18
- } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
24
+ helphub_view_article_button_hidden: boolean | null | undefined;
25
+ } & {
26
+ title?: string | undefined;
27
+ icon?: string | undefined;
28
+ commands_count?: number | undefined;
29
+ recent_sync_date?: string | null | undefined;
30
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
19
31
  id: number;
20
32
  organization: string;
21
33
  type: string;
@@ -23,7 +35,13 @@ export declare class HelpDocsIntegration {
23
35
  meta: {
24
36
  [x: string]: any;
25
37
  } | null;
26
- } & {}>;
38
+ helphub_view_article_button_hidden: boolean | null | undefined;
39
+ } & {
40
+ title?: string | undefined;
41
+ icon?: string | undefined;
42
+ commands_count?: number | undefined;
43
+ recent_sync_date?: string | null | undefined;
44
+ }>;
27
45
  static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
28
46
  onSuccess?: (() => void) | undefined;
29
47
  onError?: ((err: string) => void) | undefined;
@@ -35,7 +53,13 @@ export declare class HelpDocsIntegration {
35
53
  meta: {
36
54
  [x: string]: any;
37
55
  } | null;
38
- } & {}>;
56
+ helphub_view_article_button_hidden: boolean | null | undefined;
57
+ } & {
58
+ title?: string | undefined;
59
+ icon?: string | undefined;
60
+ commands_count?: number | undefined;
61
+ recent_sync_date?: string | null | undefined;
62
+ }>;
39
63
  static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
40
64
  id: number;
41
65
  organization: string;
@@ -44,7 +68,13 @@ export declare class HelpDocsIntegration {
44
68
  meta: {
45
69
  [x: string]: any;
46
70
  } | null;
47
- } & {})[]>;
71
+ helphub_view_article_button_hidden: boolean | null | undefined;
72
+ } & {
73
+ title?: string | undefined;
74
+ icon?: string | undefined;
75
+ commands_count?: number | undefined;
76
+ recent_sync_date?: string | null | undefined;
77
+ })[]>;
48
78
  static update: (object: {
49
79
  id: number;
50
80
  organization: string;
@@ -53,7 +83,13 @@ export declare class HelpDocsIntegration {
53
83
  meta: {
54
84
  [x: string]: any;
55
85
  } | null;
56
- } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
86
+ helphub_view_article_button_hidden: boolean | null | undefined;
87
+ } & {
88
+ title?: string | undefined;
89
+ icon?: string | undefined;
90
+ commands_count?: number | undefined;
91
+ recent_sync_date?: string | null | undefined;
92
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
57
93
  id: number;
58
94
  organization: string;
59
95
  type: string;
@@ -61,12 +97,31 @@ export declare class HelpDocsIntegration {
61
97
  meta: {
62
98
  [x: string]: any;
63
99
  } | null;
64
- } & {}>;
100
+ helphub_view_article_button_hidden: boolean | null | undefined;
101
+ } & {
102
+ title?: string | undefined;
103
+ icon?: string | undefined;
104
+ commands_count?: number | undefined;
105
+ recent_sync_date?: string | null | undefined;
106
+ }>;
65
107
  static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
66
108
  /** Get the status of the latest currently running sync for an integration */
67
- static readSyncStatus: (integrationName: string) => Promise<{
109
+ static readSyncStatus: (integrationId: string) => Promise<{
68
110
  running: boolean;
69
111
  numFetched: number;
70
112
  numProcessed: number;
113
+ } & {
114
+ deleting?: boolean | undefined;
115
+ }>;
116
+ }
117
+ declare const IntercomCreateConversationPayloadV: t.TypeC<{
118
+ message_id: t.StringC;
119
+ intercom_user_type: t.UnionC<[t.LiteralC<"visitor">, t.LiteralC<"user">]>;
120
+ intercom_user_id: t.UnionC<[t.StringC, t.UndefinedC]>;
121
+ }>;
122
+ export declare class IntercomIntegration {
123
+ static createConversation: (payload: t.TypeOf<typeof IntercomCreateConversationPayloadV>) => Promise<{
124
+ conversation_id?: string | undefined;
71
125
  }>;
72
126
  }
127
+ export {};