commandbar 1.8.5 → 1.8.6

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

@@ -0,0 +1,330 @@
+import * as t from 'io-ts';
+export declare const OrganizationSettingsV: t.TypeC<{
+    end_user_limit: t.NumberC;
+    user_seat_limit: t.NumberC;
+    analytics_dashboard_execution_limit: t.NumberC;
+    analytics_dashboard_deadend_limit: t.NumberC;
+    silent_mode: t.BooleanC;
+    allow_event_handlers: t.BooleanC;
+    event_attribute_block_list: t.ArrayC<t.StringC>;
+    skins_limit: t.NumberC;
+    skins_field_set: t.UnionC<[t.LiteralC<"pro">, t.LiteralC<"basic">, t.LiteralC<"none">]>;
+    show_countdown_banner: t.BooleanC;
+    can_install_foobar: t.BooleanC;
+    releases_available: t.BooleanC;
+    releases_enabled: t.BooleanC;
+    releases_environments: t.ArrayC<t.StringC>;
+    in_bar_feedback: t.BooleanC;
+    force_end_user_identity_verification: t.BooleanC;
+    force_end_user_identity_verification_for_helphub: t.BooleanC;
+    summon_hotkey_override: t.UnionC<[t.StringC, t.NullC]>;
+    end_user_shortcuts_enabled: t.BooleanC;
+    fallback_commands: t.ArrayC<t.NumberC>;
+    end_user_recents_enabled: t.BooleanC;
+    tab_direction: t.UnionC<[t.LiteralC<"horizontal">, t.LiteralC<"vertical">]>;
+    recommended_tab_enabled: t.BooleanC;
+    recents_tab_enabled: t.BooleanC;
+    recommended_tab_instruction: t.StringC;
+    recents_tab_instruction: t.StringC;
+    hotload_help_docs: t.BooleanC;
+    slash_filters_enabled: t.BooleanC;
+    recents_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
+    recommended_sort_key: t.UnionC<[t.NumberC, t.NullC]>;
+    num_live_commands: t.NumberC;
+    help_center_sync: t.UnionC<[t.LiteralC<"upload-once">, t.LiteralC<"manual">, t.LiteralC<"automatic">]>;
+    show_suggested_synonyms: t.BooleanC;
+    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_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_chat_fallback_message: t.StringC;
+    helphub_chat_fallback_actions: t.ArrayC<t.TypeC<{
+        cta: t.StringC;
+        action: 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">;
+        }>]>;
+    }>>;
+    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">]>;
+}>;
+export declare const read: (params?: Record<string, string> | undefined, callbacks?: {
+    onSuccess?: (() => void) | undefined;
+    onError?: ((err: string) => void) | undefined;
+} | undefined) => Promise<{
+    end_user_limit: number;
+    user_seat_limit: number;
+    analytics_dashboard_execution_limit: number;
+    analytics_dashboard_deadend_limit: number;
+    silent_mode: boolean;
+    allow_event_handlers: boolean;
+    event_attribute_block_list: string[];
+    skins_limit: number;
+    skins_field_set: "basic" | "none" | "pro";
+    show_countdown_banner: boolean;
+    can_install_foobar: boolean;
+    releases_available: boolean;
+    releases_enabled: boolean;
+    releases_environments: string[];
+    in_bar_feedback: boolean;
+    force_end_user_identity_verification: boolean;
+    force_end_user_identity_verification_for_helphub: boolean;
+    summon_hotkey_override: string | null;
+    end_user_shortcuts_enabled: boolean;
+    fallback_commands: number[];
+    end_user_recents_enabled: boolean;
+    tab_direction: "horizontal" | "vertical";
+    recommended_tab_enabled: boolean;
+    recents_tab_enabled: boolean;
+    recommended_tab_instruction: string;
+    recents_tab_instruction: string;
+    hotload_help_docs: boolean;
+    slash_filters_enabled: boolean;
+    recents_sort_key: number | null;
+    recommended_sort_key: number | null;
+    num_live_commands: number;
+    help_center_sync: "manual" | "upload-once" | "automatic";
+    show_suggested_synonyms: boolean;
+    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_offset_x: number;
+    helphub_launcher_offset_y: number;
+    helphub_launcher_anchor: string;
+    helphub_chat_fallback_message: string;
+    helphub_chat_fallback_actions: {
+        cta: string;
+        action: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        } | {
+            type: "no_action";
+        } | {
+            type: "click";
+            value: string;
+        } | ({
+            type: "link";
+            value: string;
+        } & {
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | {
+            type: "open_chat";
+            meta: {
+                type: string;
+            };
+        } | {
+            type: "dismiss";
+        };
+    }[];
+    nudge_rate_limit: number | null;
+    bar_hide_completed_nudges_questlists: boolean;
+    nudge_rate_period: "day" | "week" | "session";
+}>;
+export declare const update: (object: {
+    end_user_limit?: number | undefined;
+    user_seat_limit?: number | undefined;
+    analytics_dashboard_execution_limit?: number | undefined;
+    analytics_dashboard_deadend_limit?: number | undefined;
+    silent_mode?: boolean | undefined;
+    allow_event_handlers?: boolean | undefined;
+    event_attribute_block_list?: string[] | undefined;
+    skins_limit?: number | undefined;
+    skins_field_set?: "basic" | "none" | "pro" | undefined;
+    show_countdown_banner?: boolean | undefined;
+    can_install_foobar?: boolean | undefined;
+    releases_available?: boolean | undefined;
+    releases_enabled?: boolean | undefined;
+    releases_environments?: string[] | undefined;
+    in_bar_feedback?: boolean | undefined;
+    force_end_user_identity_verification?: boolean | undefined;
+    force_end_user_identity_verification_for_helphub?: boolean | undefined;
+    summon_hotkey_override?: string | null | undefined;
+    end_user_shortcuts_enabled?: boolean | undefined;
+    fallback_commands?: number[] | undefined;
+    end_user_recents_enabled?: boolean | undefined;
+    tab_direction?: "horizontal" | "vertical" | undefined;
+    recommended_tab_enabled?: boolean | undefined;
+    recents_tab_enabled?: boolean | undefined;
+    recommended_tab_instruction?: string | undefined;
+    recents_tab_instruction?: string | undefined;
+    hotload_help_docs?: boolean | undefined;
+    slash_filters_enabled?: boolean | undefined;
+    recents_sort_key?: number | null | undefined;
+    recommended_sort_key?: number | null | undefined;
+    num_live_commands?: number | undefined;
+    help_center_sync?: "manual" | "upload-once" | "automatic" | undefined;
+    show_suggested_synonyms?: boolean | undefined;
+    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_offset_x?: number | undefined;
+    helphub_launcher_offset_y?: number | undefined;
+    helphub_launcher_anchor?: string | undefined;
+    helphub_chat_fallback_message?: string | undefined;
+    helphub_chat_fallback_actions?: {
+        cta: string;
+        action: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        } | {
+            type: "no_action";
+        } | {
+            type: "click";
+            value: string;
+        } | ({
+            type: "link";
+            value: string;
+        } & {
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | {
+            type: "open_chat";
+            meta: {
+                type: string;
+            };
+        } | {
+            type: "dismiss";
+        };
+    }[] | undefined;
+    nudge_rate_limit?: number | null | undefined;
+    bar_hide_completed_nudges_questlists?: boolean | undefined;
+    nudge_rate_period?: "day" | "week" | "session" | undefined;
+}, params?: Record<string, string> | undefined, callbacks?: {
+    onSuccess?: (() => void) | undefined;
+    onError?: ((err: string) => void) | undefined;
+} | undefined) => Promise<{
+    end_user_limit: number;
+    user_seat_limit: number;
+    analytics_dashboard_execution_limit: number;
+    analytics_dashboard_deadend_limit: number;
+    silent_mode: boolean;
+    allow_event_handlers: boolean;
+    event_attribute_block_list: string[];
+    skins_limit: number;
+    skins_field_set: "basic" | "none" | "pro";
+    show_countdown_banner: boolean;
+    can_install_foobar: boolean;
+    releases_available: boolean;
+    releases_enabled: boolean;
+    releases_environments: string[];
+    in_bar_feedback: boolean;
+    force_end_user_identity_verification: boolean;
+    force_end_user_identity_verification_for_helphub: boolean;
+    summon_hotkey_override: string | null;
+    end_user_shortcuts_enabled: boolean;
+    fallback_commands: number[];
+    end_user_recents_enabled: boolean;
+    tab_direction: "horizontal" | "vertical";
+    recommended_tab_enabled: boolean;
+    recents_tab_enabled: boolean;
+    recommended_tab_instruction: string;
+    recents_tab_instruction: string;
+    hotload_help_docs: boolean;
+    slash_filters_enabled: boolean;
+    recents_sort_key: number | null;
+    recommended_sort_key: number | null;
+    num_live_commands: number;
+    help_center_sync: "manual" | "upload-once" | "automatic";
+    show_suggested_synonyms: boolean;
+    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_offset_x: number;
+    helphub_launcher_offset_y: number;
+    helphub_launcher_anchor: string;
+    helphub_chat_fallback_message: string;
+    helphub_chat_fallback_actions: {
+        cta: string;
+        action: {
+            type: "execute_command";
+            meta: {
+                command: string;
+            };
+        } | {
+            type: "no_action";
+        } | {
+            type: "click";
+            value: string;
+        } | ({
+            type: "link";
+            value: string;
+        } & {
+            operation?: "self" | "router" | "blank" | undefined;
+        }) | {
+            type: "open_chat";
+            meta: {
+                type: string;
+            };
+        } | {
+            type: "dismiss";
+        };
+    }[];
+    nudge_rate_limit: number | null;
+    bar_hide_completed_nudges_questlists: boolean;
+    nudge_rate_period: "day" | "week" | "session";
+}>;

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

@@ -0,0 +1,47 @@
+import * as t from 'io-ts';
+export declare const PlaceholderV: t.IntersectionC<[t.TypeC<{
+    id: t.NumberC;
+    organization: t.StringC;
+    slug: t.StringC;
+    text: t.StringC;
+}>, t.PartialC<{}>]>;
+export declare class Placeholder {
+    static create: (object: {
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}>;
+    static update: (object: {
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}>;
+    static delete: (id: string | number, params?: Record<string, string> | undefined, onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<void>;
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<({
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {})[]>;
+    static read: (arg0: string, params?: Record<string, string> | undefined, callbacks?: {
+        onSuccess?: (() => void) | undefined;
+        onError?: ((err: string) => void) | undefined;
+    } | undefined) => Promise<{
+        id: number;
+        organization: string;
+        slug: string;
+        text: string;
+    } & {}>;
+}

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

@@ -0,0 +1,11 @@
+import * as t from 'io-ts';
+export declare const ProfileV: t.TypeC<{
+    user: t.StringC;
+    organization: t.StringC;
+}>;
+export declare class Profile {
+    static list: (onSuccess?: (() => void) | undefined, onError?: ((err: string) => void) | undefined) => Promise<{
+        user: string;
+        organization: string;
+    }[]>;
+}