commandbar 1.9.0 → 1.10.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.
Files changed (50) hide show
  1. package/build/{internal/src/client → commandbar/src/shared/services/analytics}/EventHandler.d.ts +32 -10
  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 +4 -0
  6. package/build/internal/src/client/CommandBarClientSDK.d.ts +46 -13
  7. package/build/internal/src/client/CommandBarSDK.d.ts +17 -10
  8. package/build/internal/src/client/SDKConfig.d.ts +3 -2
  9. package/build/internal/src/client/symbols.d.ts +5 -1
  10. package/build/internal/src/middleware/CommandFromClientV.d.ts +22 -10
  11. package/build/internal/src/middleware/IRecordSettings.d.ts +3 -0
  12. package/build/internal/src/middleware/OrganizationV.d.ts +200 -6
  13. package/build/internal/src/middleware/{ResourceSettingsV.d.ts → RecordSettingsV.d.ts} +2 -2
  14. package/build/internal/src/middleware/additionalResource.d.ts +96 -15
  15. package/build/internal/src/middleware/billing.d.ts +0 -2
  16. package/build/internal/src/middleware/chat.d.ts +2196 -176
  17. package/build/internal/src/middleware/checklist.d.ts +504 -63
  18. package/build/internal/src/middleware/command.d.ts +1809 -385
  19. package/build/internal/src/middleware/endUser.d.ts +33 -5
  20. package/build/internal/src/middleware/entityChanges.d.ts +17 -0
  21. package/build/internal/src/middleware/experienceTemplate.d.ts +59 -0
  22. package/build/internal/src/middleware/experiencesSearch.d.ts +3579 -0
  23. package/build/internal/src/middleware/flags.d.ts +20 -0
  24. package/build/internal/src/middleware/helpDocsIntegration.d.ts +9 -0
  25. package/build/internal/src/middleware/helpDocsSearch.d.ts +371 -35
  26. package/build/internal/src/middleware/helpers/actions.d.ts +66 -16
  27. package/build/internal/src/middleware/helpers/commandTemplate.d.ts +70 -8
  28. package/build/internal/src/middleware/helpers/copilotPersonality.d.ts +12 -0
  29. package/build/internal/src/middleware/helpers/goals.d.ts +4 -2
  30. package/build/internal/src/middleware/helpers/pushTrigger.d.ts +22 -0
  31. package/build/internal/src/middleware/helpers/rules.d.ts +45 -36
  32. package/build/internal/src/middleware/network.d.ts +15 -0
  33. package/build/internal/src/middleware/nudge.d.ts +1103 -124
  34. package/build/internal/src/middleware/organization.d.ts +1288 -61
  35. package/build/internal/src/middleware/organizationSettings.d.ts +320 -12
  36. package/build/internal/src/middleware/profile.d.ts +2 -0
  37. package/build/internal/src/middleware/recommendationSet.d.ts +96 -15
  38. package/build/internal/src/middleware/releases.d.ts +1 -1
  39. package/build/internal/src/middleware/theme.d.ts +431 -0
  40. package/build/internal/src/middleware/types.d.ts +52 -15
  41. package/build/internal/src/middleware/user.d.ts +1 -0
  42. package/build/internal/src/util/dispatchCustomEvent.d.ts +3 -3
  43. package/build/internal/src/util/operatingSystem.d.ts +2 -4
  44. package/package.json +1 -1
  45. package/src/index.ts +2 -2
  46. package/src/init.ts +12 -6
  47. package/src/snippet.ts +2 -2
  48. package/build/internal/src/client/AnalyticsEventTypes.d.ts +0 -1
  49. package/build/internal/src/middleware/IResourceSettings.d.ts +0 -3
  50. package/build/internal/src/middleware/dashboardFlags.d.ts +0 -9
@@ -1,7 +1,7 @@
1
1
  import * as t from 'io-ts';
2
2
  import { UserProperties } from '../client/CommandBarClientSDK';
3
3
  import { IDecideResponseType, IEndUserType } from './types';
4
- export declare const QuestlistInteractionStateV: t.IntersectionC<[t.PartialC<{
4
+ export declare const ChecklistInteractionStateV: t.IntersectionC<[t.PartialC<{
5
5
  isSkipped: t.BooleanC;
6
6
  isCompleted: t.BooleanC;
7
7
  isExpanded: t.BooleanC;
@@ -20,8 +20,10 @@ export declare const NudgeInteractionStateV: t.IntersectionC<[t.PartialC<{
20
20
  nudgeCompleted: t.BooleanC;
21
21
  nudgeDismissedTs: t.ArrayC<t.NumberC>;
22
22
  nudgeCompletedTs: t.ArrayC<t.NumberC>;
23
- }>, t.PartialC<{}>]>;
24
- export declare const QuestlistInteractionsV: t.RecordC<t.NumberC, t.IntersectionC<[t.PartialC<{
23
+ }>, t.PartialC<{
24
+ stepIndexStack: t.ArrayC<t.NumberC>;
25
+ }>]>;
26
+ export declare const ChecklistInteractionsV: t.RecordC<t.NumberC, t.IntersectionC<[t.PartialC<{
25
27
  isSkipped: t.BooleanC;
26
28
  isCompleted: t.BooleanC;
27
29
  isExpanded: t.BooleanC;
@@ -40,7 +42,9 @@ export declare const NudgeInteractionsV: t.RecordC<t.NumberC, t.IntersectionC<[t
40
42
  nudgeCompleted: t.BooleanC;
41
43
  nudgeDismissedTs: t.ArrayC<t.NumberC>;
42
44
  nudgeCompletedTs: t.ArrayC<t.NumberC>;
43
- }>, t.PartialC<{}>]>>;
45
+ }>, t.PartialC<{
46
+ stepIndexStack: t.ArrayC<t.NumberC>;
47
+ }>]>>;
44
48
  export declare const UserRemotePropertiesV: t.RecordC<t.StringC, t.AnyC>;
45
49
  export declare const EndUserStoreDataV: t.TypeC<{
46
50
  hotkeys: t.AnyC;
@@ -66,7 +70,9 @@ export declare const EndUserStoreDataV: t.TypeC<{
66
70
  nudgeCompleted: t.BooleanC;
67
71
  nudgeDismissedTs: t.ArrayC<t.NumberC>;
68
72
  nudgeCompletedTs: t.ArrayC<t.NumberC>;
69
- }>, t.PartialC<{}>]>>, t.UndefinedC]>;
73
+ }>, t.PartialC<{
74
+ stepIndexStack: t.ArrayC<t.NumberC>;
75
+ }>]>>, t.UndefinedC]>;
70
76
  analytics: t.UnionC<[t.TypeC<{
71
77
  num_command_executions: t.NumberC;
72
78
  num_shortcut_command_executions: t.NumberC;
@@ -90,15 +96,37 @@ export declare const EndUserV: t.TypeC<{
90
96
  }>;
91
97
  export declare const DecideExperienceResponseV: t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>;
92
98
  export declare const DecideResponseV: t.UnionC<[t.TypeC<{
99
+ user_property_targeting: t.UnionC<[t.BooleanC, t.UndefinedC, t.NullC]>;
93
100
  nudges: t.UnionC<[t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>, t.UndefinedC, t.NullC]>;
94
101
  checklists: t.UnionC<[t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>, t.UndefinedC, t.NullC]>;
102
+ recommendation_sets: t.UnionC<[t.RecordC<t.UnionC<[t.StringC, t.NumberC]>, t.UnionC<[t.BooleanC, t.RecordC<t.StringC, t.AnyC>, t.UndefinedC, t.NullC]>>, t.UndefinedC, t.NullC]>;
95
103
  }>, t.UndefinedC, t.NullC]>;
96
104
  export declare const EndUser: {
97
105
  preferences: (_identifier: string | null | undefined, _hmac: string) => Promise<never>;
98
106
  decide: (orgId: string | number, distinctId: string | null | undefined, options: {
99
107
  properties?: UserProperties;
108
+ envOverride: {
109
+ env: string;
110
+ } | {
111
+ version: string;
112
+ } | null;
113
+ env: string | null;
114
+ version?: string;
100
115
  }) => Promise<IDecideResponseType | null>;
101
116
  identify: (orgId: string | number, distinctId: string, options: {
102
117
  properties?: UserProperties;
103
118
  }, hmac?: string) => Promise<IEndUserType | null>;
104
119
  };
120
+ export declare function getEnvOrVersion({ envOverride, env, version, }: {
121
+ envOverride?: {
122
+ env: string;
123
+ } | {
124
+ version: string;
125
+ } | null;
126
+ env?: string | null;
127
+ version?: string | null;
128
+ }): {
129
+ env: string;
130
+ } | {
131
+ version: string;
132
+ };
@@ -0,0 +1,17 @@
1
+ import * as t from 'io-ts';
2
+ export declare const EntityChangeV: t.IntersectionC<[t.TypeC<{
3
+ id: t.NumberC;
4
+ organization: t.StringC;
5
+ description: t.StringC;
6
+ }>, t.PartialC<{
7
+ changed_by: t.StringC;
8
+ created: t.StringC;
9
+ }>]>;
10
+ export declare const listEntityChanges: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
11
+ id: number;
12
+ organization: string;
13
+ description: string;
14
+ } & {
15
+ changed_by?: string | undefined;
16
+ created?: string | undefined;
17
+ })[]>;
@@ -0,0 +1,59 @@
1
+ import * as t from 'io-ts';
2
+ export declare const ExperienceTemplateV: t.TypeC<{
3
+ id: t.NumberC;
4
+ type: t.UnionC<[t.LiteralC<"announcement">, t.LiteralC<"product_tour">, t.LiteralC<"survey">]>;
5
+ data: t.RecordC<t.StringC, t.AnyC>;
6
+ }>;
7
+ export declare class ExperienceTemplate {
8
+ static decode: (data: any) => {
9
+ id: number;
10
+ type: "announcement" | "product_tour" | "survey";
11
+ data: {
12
+ [x: string]: any;
13
+ };
14
+ };
15
+ static create: (object: {
16
+ id: number;
17
+ type: "announcement" | "product_tour" | "survey";
18
+ data: {
19
+ [x: string]: any;
20
+ };
21
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
22
+ id: number;
23
+ type: "announcement" | "product_tour" | "survey";
24
+ data: {
25
+ [x: string]: any;
26
+ };
27
+ }>;
28
+ static update: (object: {
29
+ id: number;
30
+ type: "announcement" | "product_tour" | "survey";
31
+ data: {
32
+ [x: string]: any;
33
+ };
34
+ }, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
35
+ id: number;
36
+ type: "announcement" | "product_tour" | "survey";
37
+ data: {
38
+ [x: string]: any;
39
+ };
40
+ }>;
41
+ static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
42
+ static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
43
+ id: number;
44
+ type: "announcement" | "product_tour" | "survey";
45
+ data: {
46
+ [x: string]: any;
47
+ };
48
+ }[]>;
49
+ static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
50
+ onSuccess?: (() => void) | undefined;
51
+ onError?: ((err: string) => void) | undefined;
52
+ } | undefined) => Promise<{
53
+ id: number;
54
+ type: "announcement" | "product_tour" | "survey";
55
+ data: {
56
+ [x: string]: any;
57
+ };
58
+ }>;
59
+ }