commandbar 1.8.7 → 1.9.0

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

@@ -36,19 +36,22 @@ export declare const OrganizationSettingsV: t.TypeC<{
     bar_enabled: t.BooleanC;
     in_bar_doc_search: t.BooleanC;
     featured_item_cards: t.BooleanC;
-    helphub_ai_enabled: t.BooleanC;
     chat_system_prompt_modifier: t.StringC;
     helphub_chat_welcome_message: t.StringC;
     helphub_suggested_queries_enabled: t.BooleanC;
     helphub_continuations_enabled: t.BooleanC;
     helphub_manual_suggested_queries: t.ArrayC<t.StringC>;
-    helphub_chat_only_mode: t.BooleanC;
     helphub_enabled: t.BooleanC;
-    helphub_launcher_type: t.UnionC<[t.LiteralC<"bookOpen">, t.LiteralC<"graduationHat">, t.LiteralC<"bookClosed">, t.LiteralC<"bookmark">, t.LiteralC<"chatCircle">, t.LiteralC<"custom">, t.LiteralC<"none">]>;
+    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_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
     helphub_launcher_offset_x: t.NumberC;
     helphub_launcher_offset_y: t.NumberC;
     helphub_launcher_anchor: t.StringC;
+    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">]>;
+    helphub_mobile_launcher_position: t.UnionC<[t.LiteralC<"topRight">, t.LiteralC<"topLeft">, t.LiteralC<"bottomRight">, t.LiteralC<"bottomLeft">]>;
+    helphub_mobile_launcher_offset_x: t.NumberC;
+    helphub_mobile_launcher_offset_y: t.NumberC;
+    helphub_mobile_launcher_anchor: t.StringC;
     helphub_chat_fallback_message: t.StringC;
     helphub_chat_fallback_actions: t.ArrayC<t.TypeC<{
         cta: t.StringC;
@@ -74,11 +77,37 @@ export declare const OrganizationSettingsV: 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;
+        }>]>]>;
     }>>;
     nudge_rate_limit: t.UnionC<[t.NullC, t.NumberC]>;
     bar_hide_completed_nudges_questlists: t.BooleanC;
     nudge_rate_period: t.UnionC<[t.LiteralC<"day">, t.LiteralC<"week">, t.LiteralC<"session">]>;
+    share_link_param: t.StringC;
+    copilot_enabled: t.BooleanC;
+    /** @deprecated Replaced by the `copilot_enabled` field */
+    helphub_ai_enabled: t.BooleanC;
+    /** @deprecated Removed entirely */
+    copilot_experiences_enabled: t.BooleanC;
+    /** @deprecated Replaced by the combination of `copilot_enabled` and `helphub_enabled` */
+    helphub_chat_only_mode: t.BooleanC;
 }>;
 export declare const read: (params?: Record<string, string> | undefined, callbacks?: {
     onSuccess?: (() => void) | undefined;
@@ -120,19 +149,22 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
     bar_enabled: boolean;
     in_bar_doc_search: boolean;
     featured_item_cards: boolean;
-    helphub_ai_enabled: boolean;
     chat_system_prompt_modifier: string;
     helphub_chat_welcome_message: string;
     helphub_suggested_queries_enabled: boolean;
     helphub_continuations_enabled: boolean;
     helphub_manual_suggested_queries: string[];
-    helphub_chat_only_mode: boolean;
     helphub_enabled: boolean;
-    helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
-    helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
+    helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
+    helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
     helphub_launcher_offset_x: number;
     helphub_launcher_offset_y: number;
     helphub_launcher_anchor: string;
+    helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
+    helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
+    helphub_mobile_launcher_offset_x: number;
+    helphub_mobile_launcher_offset_y: number;
+    helphub_mobile_launcher_anchor: string;
     helphub_chat_fallback_message: string;
     helphub_chat_fallback_actions: {
         cta: string;
@@ -141,8 +173,6 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
             meta: {
                 command: string;
             };
-        } | {
-            type: "no_action";
         } | {
             type: "click";
             value: string;
@@ -158,11 +188,36 @@ export declare const read: (params?: Record<string, string> | undefined, callbac
             };
         } | {
             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";
         };
     }[];
     nudge_rate_limit: number | null;
     bar_hide_completed_nudges_questlists: boolean;
     nudge_rate_period: "day" | "week" | "session";
+    share_link_param: string;
+    copilot_enabled: boolean;
+    helphub_ai_enabled: boolean;
+    copilot_experiences_enabled: boolean;
+    helphub_chat_only_mode: boolean;
 }>;
 export declare const update: (object: {
     end_user_limit?: number | undefined;
@@ -201,19 +256,22 @@ export declare const update: (object: {
     bar_enabled?: boolean | undefined;
     in_bar_doc_search?: boolean | undefined;
     featured_item_cards?: boolean | undefined;
-    helphub_ai_enabled?: boolean | undefined;
     chat_system_prompt_modifier?: string | undefined;
     helphub_chat_welcome_message?: string | undefined;
     helphub_suggested_queries_enabled?: boolean | undefined;
     helphub_continuations_enabled?: boolean | undefined;
     helphub_manual_suggested_queries?: string[] | undefined;
-    helphub_chat_only_mode?: boolean | undefined;
     helphub_enabled?: boolean | undefined;
-    helphub_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | undefined;
-    helphub_launcher_position?: "topRight" | "topLeft" | "bottomRight" | "bottomLeft" | undefined;
+    helphub_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
+    helphub_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
     helphub_launcher_offset_x?: number | undefined;
     helphub_launcher_offset_y?: number | undefined;
     helphub_launcher_anchor?: string | undefined;
+    helphub_mobile_launcher_type?: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI" | undefined;
+    helphub_mobile_launcher_position?: "bottomRight" | "bottomLeft" | "topRight" | "topLeft" | undefined;
+    helphub_mobile_launcher_offset_x?: number | undefined;
+    helphub_mobile_launcher_offset_y?: number | undefined;
+    helphub_mobile_launcher_anchor?: string | undefined;
     helphub_chat_fallback_message?: string | undefined;
     helphub_chat_fallback_actions?: {
         cta: string;
@@ -222,8 +280,6 @@ export declare const update: (object: {
             meta: {
                 command: string;
             };
-        } | {
-            type: "no_action";
         } | {
             type: "click";
             value: string;
@@ -239,11 +295,36 @@ export declare const update: (object: {
             };
         } | {
             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";
         };
     }[] | undefined;
     nudge_rate_limit?: number | null | undefined;
     bar_hide_completed_nudges_questlists?: boolean | undefined;
     nudge_rate_period?: "day" | "week" | "session" | undefined;
+    share_link_param?: string | undefined;
+    copilot_enabled?: boolean | undefined;
+    helphub_ai_enabled?: boolean | undefined;
+    copilot_experiences_enabled?: boolean | undefined;
+    helphub_chat_only_mode?: boolean | undefined;
 }, params?: Record<string, string> | undefined, callbacks?: {
     onSuccess?: (() => void) | undefined;
     onError?: ((err: string) => void) | undefined;
@@ -284,19 +365,22 @@ export declare const update: (object: {
     bar_enabled: boolean;
     in_bar_doc_search: boolean;
     featured_item_cards: boolean;
-    helphub_ai_enabled: boolean;
     chat_system_prompt_modifier: string;
     helphub_chat_welcome_message: string;
     helphub_suggested_queries_enabled: boolean;
     helphub_continuations_enabled: boolean;
     helphub_manual_suggested_queries: string[];
-    helphub_chat_only_mode: boolean;
     helphub_enabled: boolean;
-    helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle";
-    helphub_launcher_position: "topRight" | "topLeft" | "bottomRight" | "bottomLeft";
+    helphub_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
+    helphub_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
     helphub_launcher_offset_x: number;
     helphub_launcher_offset_y: number;
     helphub_launcher_anchor: string;
+    helphub_mobile_launcher_type: "none" | "custom" | "bookOpen" | "graduationHat" | "bookClosed" | "bookmark" | "chatCircle" | "askAI";
+    helphub_mobile_launcher_position: "bottomRight" | "bottomLeft" | "topRight" | "topLeft";
+    helphub_mobile_launcher_offset_x: number;
+    helphub_mobile_launcher_offset_y: number;
+    helphub_mobile_launcher_anchor: string;
     helphub_chat_fallback_message: string;
     helphub_chat_fallback_actions: {
         cta: string;
@@ -305,8 +389,6 @@ export declare const update: (object: {
             meta: {
                 command: string;
             };
-        } | {
-            type: "no_action";
         } | {
             type: "click";
             value: string;
@@ -322,9 +404,34 @@ export declare const update: (object: {
             };
         } | {
             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";
         };
     }[];
     nudge_rate_limit: number | null;
     bar_hide_completed_nudges_questlists: boolean;
     nudge_rate_period: "day" | "week" | "session";
+    share_link_param: string;
+    copilot_enabled: boolean;
+    helphub_ai_enabled: boolean;
+    copilot_experiences_enabled: boolean;
+    helphub_chat_only_mode: boolean;
 }>;