commandbar 1.8.6 → 1.9.0

package/build/internal/src/middleware/helpHub.d.ts

@@ -0,0 +1,26 @@
+import { DeviceType } from '../util/operatingSystem';
+import * as t from 'io-ts';
+import { IHelpHubLauncherSettingsType, IOrganizationType } from './types';
+export declare const HelpHubLauncherPositionsV: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
+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">]>;
+export declare const HelpHubLauncherSettingsV: t.TypeC<{
+    helphub_launcher_offset_x: t.NumberC;
+    helphub_launcher_offset_y: t.NumberC;
+    helphub_launcher_anchor: t.StringC;
+    helphub_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
+    helphub_launcher_type: 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">]>;
+    helphub_mobile_launcher_offset_x: t.NumberC;
+    helphub_mobile_launcher_offset_y: t.NumberC;
+    helphub_mobile_launcher_anchor: t.StringC;
+    helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
+    helphub_mobile_launcher_type: 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">]>;
+}>;
+export declare const getHelpHubLauncherSettingKeys: (deviceType: DeviceType) => Record<string, keyof IHelpHubLauncherSettingsType>;
+export type HelpHubLauncherMergedSettings = {
+    type: IHelpHubLauncherSettingsType['helphub_launcher_type'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_type'];
+    anchor: IHelpHubLauncherSettingsType['helphub_launcher_anchor'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_anchor'];
+    position: IHelpHubLauncherSettingsType['helphub_launcher_position'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_position'];
+    offsetX: IHelpHubLauncherSettingsType['helphub_launcher_offset_x'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_offset_x'];
+    offsetY: IHelpHubLauncherSettingsType['helphub_launcher_offset_y'] | IHelpHubLauncherSettingsType['helphub_mobile_launcher_offset_y'];
+};
+export declare const getHelpHubLauncherSettings: (deviceType: DeviceType, organization: IOrganizationType) => HelpHubLauncherMergedSettings;

package/build/internal/src/middleware/helpers/actions.d.ts

@@ -20,7 +20,7 @@ export declare const LinkAction: t.IntersectionC<[t.TypeC<{
 }>, t.PartialC<{
     operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
 }>]>;
-export declare const OpenChatAction: t.TypeC<{
+export declare const OpenChatActionV: t.TypeC<{
     type: t.LiteralC<"open_chat">;
     meta: t.TypeC<{
         type: t.StringC;
@@ -29,6 +29,12 @@ export declare const OpenChatAction: t.TypeC<{
 export declare const DismissAction: t.TypeC<{
     type: t.LiteralC<"dismiss">;
 }>;
+export declare const StepBackAction: t.TypeC<{
+    type: t.LiteralC<"step_back">;
+}>;
+export declare const SnoozeAction: t.TypeC<{
+    type: t.LiteralC<"snooze">;
+}>;
 export declare const ClickAction: t.TypeC<{
     type: t.UnionC<[t.LiteralC<"click">, t.LiteralC<"clickBySelector">, t.LiteralC<"clickByXpath">]>;
     value: t.ArrayC<t.StringC>;
@@ -63,7 +69,7 @@ export declare const HelpDocAction: t.IntersectionC<[t.TypeC<{
         date: t.StringC;
     }>;
 }>]>;
-export declare const CommandAction: t.TypeC<{
+export declare const CommandActionV: t.TypeC<{
     type: t.LiteralC<"execute_command">;
     meta: t.TypeC<{
         command: t.StringC;
@@ -76,10 +82,18 @@ export declare const ClickActionNew: t.TypeC<{
     type: t.LiteralC<"click">;
     value: t.StringC;
 }>;
-export declare const NudgeAction: t.TypeC<{
+export declare const NudgeActionV: t.TypeC<{
     type: t.LiteralC<"nudge">;
     value: t.NumberC;
 }>;
+export declare const GoToNudgeStepActionV: t.TypeC<{
+    type: t.LiteralC<"go_to_step">;
+    value: t.NumberC;
+}>;
+export declare const QuestlistActionV: t.TypeC<{
+    type: t.LiteralC<"questlist">;
+    value: t.NumberC;
+}>;
 export declare const ActionV: t.UnionC<[t.TypeC<{
     type: t.LiteralC<"execute_command">;
     meta: t.TypeC<{
@@ -102,7 +116,25 @@ export declare const ActionV: t.UnionC<[t.TypeC<{
     }>;
 }>, t.TypeC<{
     type: t.LiteralC<"dismiss">;
-}>]>;
+}>, t.TypeC<{
+    type: t.LiteralC<"snooze">;
+}>, t.TypeC<{
+    type: t.LiteralC<"questlist">;
+    value: t.NumberC;
+}>, t.TypeC<{
+    type: t.LiteralC<"nudge">;
+    value: t.NumberC;
+}>, t.TypeC<{
+    type: t.LiteralC<"go_to_step">;
+    value: t.NumberC;
+}>, t.TypeC<{
+    type: t.LiteralC<"step_back">;
+}>, t.IntersectionC<[t.TypeC<{
+    type: t.LiteralC<"open_bar">;
+}>, t.PartialC<{
+    value: t.StringC;
+    categoryFilter: t.NumberC;
+}>]>]>;
 export declare const LabeledActionV: t.TypeC<{
     cta: t.StringC;
     action: t.UnionC<[t.TypeC<{
@@ -127,7 +159,25 @@ export declare const LabeledActionV: t.TypeC<{
         }>;
     }>, t.TypeC<{
         type: t.LiteralC<"dismiss">;
-    }>]>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"snooze">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"questlist">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"nudge">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"go_to_step">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"step_back">;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"open_bar">;
+    }>, t.PartialC<{
+        value: t.StringC;
+        categoryFilter: t.NumberC;
+    }>]>]>;
 }>;
 export declare const isAction: (o: string | number | LabeledAction) => o is {
     cta: string;
@@ -136,8 +186,6 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
         meta: {
             command: string;
         };
-    } | {
-        type: "no_action";
     } | {
         type: "click";
         value: string;
@@ -153,6 +201,26 @@ export declare const isAction: (o: string | number | LabeledAction) => o is {
         };
     } | {
         type: "dismiss";
+    } | {
+        type: "snooze";
+    } | {
+        type: "questlist";
+        value: number;
+    } | {
+        type: "step_back";
+    } | {
+        type: "nudge";
+        value: number;
+    } | {
+        type: "go_to_step";
+        value: number;
+    } | ({
+        type: "open_bar";
+    } & {
+        value?: string | undefined;
+        categoryFilter?: number | undefined;
+    }) | {
+        type: "no_action";
     };
 };
 export declare const RequestV: t.IntersectionC<[t.TypeC<{
@@ -180,5 +248,45 @@ export declare const RequestAction: t.TypeC<{
 }>;
 export declare const TriggerAction: t.TypeC<{
     type: t.LiteralC<"trigger">;
-    value: t.AnyC;
+    value: t.UnionC<[t.TypeC<{
+        type: t.LiteralC<"execute_command">;
+        meta: t.TypeC<{
+            command: t.StringC;
+        }>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"no_action">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"click">;
+        value: t.StringC;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"link">;
+        value: t.StringC;
+    }>, t.PartialC<{
+        operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+    }>]>, t.TypeC<{
+        type: t.LiteralC<"open_chat">;
+        meta: t.TypeC<{
+            type: t.StringC;
+        }>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"dismiss">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"snooze">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"questlist">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"nudge">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"go_to_step">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"step_back">;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"open_bar">;
+    }>, t.PartialC<{
+        value: t.StringC;
+        categoryFilter: t.NumberC;
+    }>]>]>;
 }>;

package/build/internal/src/middleware/helpers/commandTemplate.d.ts

@@ -127,7 +127,47 @@ export declare const HelpDocTemplateV: t.IntersectionC<[t.IntersectionC<[t.TypeC
 }>]>]>;
 export declare const TriggerTemplateV: t.IntersectionC<[t.TypeC<{
     type: t.LiteralC<"trigger">;
-    value: t.AnyC;
+    value: t.UnionC<[t.TypeC<{
+        type: t.LiteralC<"execute_command">;
+        meta: t.TypeC<{
+            command: t.StringC;
+        }>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"no_action">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"click">;
+        value: t.StringC;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"link">;
+        value: t.StringC;
+    }>, t.PartialC<{
+        operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+    }>]>, t.TypeC<{
+        type: t.LiteralC<"open_chat">;
+        meta: t.TypeC<{
+            type: t.StringC;
+        }>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"dismiss">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"snooze">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"questlist">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"nudge">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"go_to_step">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"step_back">;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"open_bar">;
+    }>, t.PartialC<{
+        value: t.StringC;
+        categoryFilter: t.NumberC;
+    }>]>]>;
 }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
     commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
     object: t.StringC;
@@ -243,7 +283,47 @@ export declare const TemplateV: t.UnionC<[t.IntersectionC<[t.TypeC<{
     operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"help_hub">, t.LiteralC<"blank">, t.UndefinedC]>;
 }>]>]>, t.IntersectionC<[t.TypeC<{
     type: t.LiteralC<"trigger">;
-    value: t.AnyC;
+    value: t.UnionC<[t.TypeC<{
+        type: t.LiteralC<"execute_command">;
+        meta: t.TypeC<{
+            command: t.StringC;
+        }>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"no_action">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"click">;
+        value: t.StringC;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"link">;
+        value: t.StringC;
+    }>, t.PartialC<{
+        operation: t.UnionC<[t.LiteralC<"router">, t.LiteralC<"self">, t.LiteralC<"blank">, t.UndefinedC]>;
+    }>]>, t.TypeC<{
+        type: t.LiteralC<"open_chat">;
+        meta: t.TypeC<{
+            type: t.StringC;
+        }>;
+    }>, t.TypeC<{
+        type: t.LiteralC<"dismiss">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"snooze">;
+    }>, t.TypeC<{
+        type: t.LiteralC<"questlist">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"nudge">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"go_to_step">;
+        value: t.NumberC;
+    }>, t.TypeC<{
+        type: t.LiteralC<"step_back">;
+    }>, t.IntersectionC<[t.TypeC<{
+        type: t.LiteralC<"open_bar">;
+    }>, t.PartialC<{
+        value: t.StringC;
+        categoryFilter: t.NumberC;
+    }>]>]>;
 }>, t.IntersectionC<[t.TypeC<{}>, t.PartialC<{
     commandType: t.UnionC<[t.LiteralC<"independent">, t.LiteralC<"object">, t.LiteralC<"help">]>;
     object: t.StringC;

package/build/internal/src/middleware/helpers/pushTrigger.d.ts

@@ -21,6 +21,12 @@ export declare const PushTriggerV: t.UnionC<[t.TypeC<{
     meta: t.TypeC<{
         selector: t.StringC;
     }>;
+}>, t.TypeC<{
+    type: t.LiteralC<"on_user_confusion">;
+}>, t.TypeC<{
+    type: t.LiteralC<"on_rage_click">;
+}>, t.TypeC<{
+    type: t.LiteralC<"smart_delay">;
 }>, t.TypeC<{
     type: t.LiteralC<"when_share_link_viewed">;
 }>]>;