commandbar 1.8.5 → 1.8.7

package/build/internal/src/client/EventHandler.d.ts

@@ -0,0 +1,282 @@
+import { IPushTrigger } from '../middleware/types';
+interface EventCommandDetailsBase {
+    icon: string | null;
+}
+interface EventLinkCommandDetails {
+    url: string;
+}
+export type EventCommandDetails = EventCommandDetailsBase | EventLinkCommandDetails;
+export interface AbandonedSearchEvent {
+    type: 'abandoned_search';
+    /** Event data passed for `abandoned_search` events (deadends). */
+    /** The id of the currently active command, if there is one. */
+    command?: number;
+    /** DEPRECATED. The text of the deadend. */
+    ['inputText[*]']: string;
+    /** The text of the deadend. */
+    inputText: string;
+    /** The context key of the currently active resource, if there is one. */
+    resource?: string;
+    /** The trigger for the deadend. */
+    trigger: 'Backspaced' | 'Closed with text' | 'Resetting search';
+    /** The number of {CommandOptions, ParameterOptions}, if there are any. */
+    results?: {
+        numCommands: number;
+        numRecords: number;
+    };
+    /** command_ids of previously executed commands in the session */
+    previousCommands?: string[];
+}
+export interface ClosedEvent {
+    type: 'closed';
+    /** Event data passed for `command_execution` events. */
+    /** The user's input text when the bar was closed. */
+    inputText: string;
+    /** True if this command was triggered by a shortcut. */
+    shortcut?: boolean;
+}
+export type PreviewEngagementType = 'scrolled' | 'clicked_link' | 'watched_video';
+export type HelpHubDocEngagementType = 'scrolled' | 'clicked_link' | 'watched_video' | 'opened';
+export type HelpHubEngagementType = 'search' | 'scrolled' | 'chat_started' | 'chat_closed' | 'continuation_clicked' | 'suggested_query_clicked';
+export type ChecklistEngagementType = 'expanded' | 'collapsed' | 'dismissed' | 'completed';
+export type ChecklistItemEngagementType = 'expanded' | 'completed' | 'cta_clicked' | 'skipped';
+export type EngagementType = ChecklistEngagementType | ChecklistItemEngagementType | PreviewEngagementType | HelpHubEngagementType | HelpHubDocEngagementType;
+export type PushTrigger = IPushTrigger;
+export interface ChecklistEvent {
+    type: 'questlist_shown' | 'questlist_engagement';
+    questlist: {
+        id: number;
+        trigger: PushTrigger;
+        title: string;
+        total_items: number;
+        completed_items: number;
+        completed: boolean;
+    };
+    engagement_type?: ChecklistEngagementType;
+}
+export interface ChecklistItemEvent {
+    type: 'questlist_item_engagement';
+    questlist_item: {
+        id: number;
+        questlist_id: number;
+        title: string;
+        cta?: string;
+        goal: {
+            type: 'page_visited';
+            value: string;
+        } | {
+            type: 'command_executed';
+            meta: {
+                command: string;
+            };
+        } | {
+            type: 'element_clicked';
+            value: string;
+        } | {
+            type: 'conditions_met';
+        } | {
+            type: 'cta_clicked';
+        } | {
+            type: 'event_tracked';
+        };
+        completed: boolean;
+    };
+    engagement_type: ChecklistItemEngagementType;
+}
+export interface PreviewEvent {
+    type: 'preview_shown' | 'next_step_selected' | 'preview_link_opened' | 'preview_engagement';
+    preview: {
+        preview_type: 'html' | 'markdown' | 'plaintext' | 'react' | 'video' | 'component';
+        form_factor: 'inline' | 'popover';
+        time_shown?: number;
+        source: {
+            command?: string;
+            record?: string;
+        };
+        id: string;
+    };
+}
+export interface PreviewEngagementEvent extends PreviewEvent {
+    type: 'preview_engagement';
+    engagement_type: PreviewEngagementType;
+}
+export type ChatHistory = {
+    question: string;
+    answer: {
+        message_id: number | undefined;
+        message: string;
+    } | null;
+}[];
+export interface HelpHubEvent {
+    type: 'help_hub_closed' | 'help_hub_opened' | 'help_hub_engagement';
+    helpHub: {
+        query: string | null | undefined;
+    };
+}
+type HelpHubEngagementEventExtended = {
+    engagement_type: 'search' | 'scrolled' | 'chat_started' | 'chat_closed';
+} | {
+    engagement_type: 'suggested_query_clicked';
+    suggested_query: string;
+} | {
+    engagement_type: 'continuation_clicked';
+    continuation: string;
+    chat_history: ChatHistory;
+};
+export type HelpHubEngagementEvent = HelpHubEvent & HelpHubEngagementEventExtended;
+export interface HelpHubDocEvent {
+    type: 'help_hub_doc_closed' | 'help_hub_doc_opened' | 'help_hub_doc_engagement';
+    helpHubDoc: {
+        time_shown?: number;
+        query: string | null | undefined;
+        trigger?: ExecutionEventSource;
+        command?: number | string | undefined;
+    };
+}
+export interface HelpHubDocEngagementEvent extends HelpHubDocEvent {
+    type: 'help_hub_doc_engagement';
+    engagement_type: HelpHubDocEngagementType;
+}
+export interface HelpHubDocEngagementEvent extends HelpHubDocEvent {
+    type: 'help_hub_doc_engagement';
+    engagement_type: HelpHubDocEngagementType;
+}
+export interface NudgeEvent {
+    type: 'nudge_seen' | 'nudge_clicked' | 'nudge_completed' | 'nudge_dismissed';
+    nudge: {
+        id: string;
+        slug: string;
+        template_source: string;
+        frequency_limit: 'no_limit' | 'once_per_session' | 'once_per_user' | 'until_interaction';
+        trigger: PushTrigger;
+        step: {
+            id: number;
+            title: string;
+        } | undefined;
+    };
+}
+export interface SurveyResponseEvent {
+    type: 'survey_response';
+    response: {
+        type: 'number';
+        value: number;
+        emoji?: string;
+        max: number;
+    } | {
+        type: 'string';
+        value: string;
+    };
+    nudge: NudgeEvent['nudge'];
+    status: {
+        is_preview: boolean;
+        is_live: boolean;
+    };
+}
+export type ExecutionEventSource = {
+    type: 'bar';
+} | {
+    type: 'helphub';
+} | {
+    type: 'helphub_additional_resource';
+} | {
+    type: 'helphub_recommendation';
+} | {
+    type: 'nudge';
+    id: number | string;
+} | {
+    type: 'questlist';
+    id: number;
+};
+export interface CommandExecutionEvent {
+    type: 'command_execution';
+    /** Event data passed for `command_execution` events. */
+    /** The category id of the command. Only provided if the command has a category. */
+    category?: string | number | null;
+    /** The text of the category */
+    categoryText?: string;
+    /**
+     * The unique id of the command. For commands defined via the Editor, the value will be a number. For programmatic
+     * commands, the `name` (string) provided will be used.
+     */
+    command: number | string | undefined;
+    /** The text of the command */
+    commandText: string;
+    /** The source of the command. */
+    source: string;
+    /** The source of the command execution. */
+    eventSource: ExecutionEventSource;
+    /** DEPRECATED. The text input.*/
+    ['inputText[*]']: string;
+    /** The text input.*/
+    inputText?: string;
+    /** True if this command was triggered by a shortcut. */
+    shortcut?: boolean;
+    /** Ranking order of the command option */
+    ranking?: number;
+    /** command_ids of previously executed commands in the session */
+    previousCommands?: string[];
+    /** Command types, as defined at: https://www.commandbar.com/docs/commands/overview */
+    commandType?: 'admin' | 'link' | 'script' | 'clickByXpath' | 'clickBySelector' | 'click' | 'callback' | 'builtin' | 'webhook' | 'request' | 'video' | 'helpdoc' | 'appcues' | 'trigger';
+    /** Selected arguments */
+    selections?: Record<string, unknown>;
+    commandDetails: EventCommandDetails;
+}
+export interface EndUserShortcutChangedEvent {
+    type: 'shortcut_edited';
+    /** Event data passed for `command_execution` events. */
+    /** The category id of the command. Only provided if the command has a category. */
+    category?: number | null;
+    /**
+     * The unique id of the command. For commands defined via the Editor, the value will be a number. For programmatic
+     * commands, the `name` (string) provided will be used.
+     */
+    command: number | string | undefined;
+    /** The text of the command */
+    commandText: string;
+    /** The source of the command. */
+    source: string;
+    /** The updated shortcut. */
+    oldShortcut: string;
+    newShortcut: string;
+    defaultShortcut: string;
+}
+export interface CommandSuggestionEvent {
+    type: 'command_suggestion';
+    /** The text of the suggestion. */
+    text: string;
+}
+export interface OpenedEvent {
+    type: 'opened';
+    /** Event data passed for `command_execution` events. */
+    /**
+     * The entrypoint through which the bar was opened.
+     *
+     * * `launcher`: Click on the provided CommandBar launcher
+     * * `keyboard`: Cmd/Ctrl+K
+     * * `programmatic`: Call to `window.CommandBar.open()`. Clicks on the
+     *   [commandbar-launcher](https://www.npmjs.com/package/commandbar-launcher) component register as programmatic
+     *   opens.
+     */
+    trigger: 'launcher' | 'keyboard' | 'programmatic' | 'nudge';
+    /** The placeholder showing when the user opened the bar. */
+    placeholder: string;
+}
+export type OpenedEventTrigger = OpenedEvent['trigger'];
+export interface NoResultsForQueryEvent {
+    type: 'no_results_for_query';
+    /** Event data passed for `no_results_for_query` event */
+    /** The user's input text when the no results state was reached. */
+    inputText: string;
+    eventSource: ExecutionEventSource;
+}
+export interface NoChatResponseEvent {
+    type: 'no_chat_response';
+    /** Event data passed for `no_results_for_query` event */
+    /** The user's input text when the no results state was reached. */
+    chatHistory: ChatHistory;
+}
+export type EventData = AbandonedSearchEvent | ClosedEvent | CommandExecutionEvent | CommandSuggestionEvent | NudgeEvent | OpenedEvent | NoResultsForQueryEvent | EndUserShortcutChangedEvent;
+export type EventHandler = (eventName: EventType, eventData: EventData) => void;
+export type EventSubscriber = EventHandler;
+export type EventType = 'abandoned_search' | 'command_suggestion' | 'command_execution' | 'nudge_shown' | 'nudge_clicked' | 'nudge_completed' | 'nudge_dismissed' | 'opened' | 'closed' | 'no_results_for_query' | 'client_error' | 'shortcut_edited' | 'preview_shown' | 'next_step_selected' | 'preview_link_opened' | 'preview_engagement' | 'questlist_shown' | 'questlist_engagement' | 'questlist_item_engagement' | 'help_hub_opened' | 'help_hub_closed' | 'help_hub_engagement' | 'help_hub_doc_opened' | 'help_hub_doc_closed' | 'help_hub_doc_engagement' | 'survey_response' | 'no_chat_response';
+export {};

package/build/internal/src/client/OrgConfig.d.ts

@@ -0,0 +1,5 @@
+export interface OrgConfig {
+    name?: string;
+    silent?: boolean;
+    eventAttributeBlockList?: string[];
+}

package/build/internal/src/client/SDKConfig.d.ts

@@ -0,0 +1,13 @@
+import { IConfigEndpointResponse } from '../middleware/types';
+export interface SDKConfig {
+    api: string;
+    editor: string;
+    proxy: string;
+    session: string;
+    uuid: string;
+    foobarVersion?: string;
+    airgap: boolean;
+    environment?: string;
+    version?: string;
+    config?: IConfigEndpointResponse;
+}

package/build/internal/src/client/SentryReporter.d.ts

@@ -0,0 +1,63 @@
+import { IOrganizationType } from '../middleware/types';
+import { PublicDisposable } from '../util/Disposable';
+type ExtraData = Record<string, unknown>;
+export interface UserScopeOptions {
+    configuration: {
+        uuid?: string;
+        api: string;
+        editor: string;
+        proxy: string;
+        session: string;
+    };
+    organization?: IOrganizationType;
+    organizationId: string | number;
+    organizationName?: string;
+    session: string;
+    userId?: string;
+}
+declare enum Severity {
+    Fatal = "fatal",
+    Error = "error",
+    Warning = "warning",
+    Log = "log",
+    Info = "info",
+    Debug = "debug",
+    Critical = "critical"
+}
+export interface Breadcrumb {
+    type?: string;
+    level?: Severity;
+    event_id?: string;
+    category?: string;
+    message?: string;
+    data?: {
+        [key: string]: any;
+    };
+    timestamp?: number;
+    hint?: BreadcrumbHint;
+}
+export interface BreadcrumbHint {
+    [key: string]: any;
+}
+export declare abstract class SentryReporter implements PublicDisposable {
+    _disposed: boolean;
+    breadcrumb: (breadcrumb: Breadcrumb, hint?: BreadcrumbHint) => void;
+    dispose(): void;
+    /**
+     * Report an error to Sentry. The first argument must either be a string or error object, and optionally an error
+     * object and extra data (in the form of an object) may be provided as well.
+     *
+     * If a string message is provided instead of an Error object a new Error will be generated. This will cause the
+     * stacktrace to begin at this function; for that reason it is **strongly** recommended to provide an error object
+     * so that the original stack trace can be preserved (as originalException).
+     */
+    abstract exception(message: string, err?: Error, extra?: ExtraData): void;
+    abstract exception(message: string, extra?: ExtraData): void;
+    abstract exception(err: Error, extra?: ExtraData): void;
+    /**
+     * Assigns various scope properties related to the currently active user and organization so that error events can
+     * be easily associated with them.
+     */
+    abstract setUserScope(opts: UserScopeOptions): void;
+}
+export {};

package/build/internal/src/client/globals.d.ts

@@ -0,0 +1,20 @@
+import { CommandBarClientSDK } from './CommandBarClientSDK';
+import { CommandBarSDK } from './CommandBarSDK';
+declare global {
+    interface Window {
+        CommandBar: CommandBarClientSDK;
+        _CommandBarTmpQueueProcessing: CommandBarSDK | undefined;
+    }
+}
+export { initProxySDK, getProxySDK } from './proxy';
+/**
+ * Returns the CommandBar global SDK.
+ * The SDK object might be a proxy instead if `initSDK` has not yet been called.
+ */
+export declare function getSDK(): CommandBarSDK;
+/**
+ * Returns the CommandBar global, coerced to match the client interface.
+ * The SDK object might be a proxy instead if `initSDK` has not yet been called.
+ */
+export declare function getClientSDK(): CommandBarClientSDK;
+export declare const SDK_INTERNAL_PREFIX = "__commandbar_INTERNAL_";

package/build/internal/src/client/proxy.d.ts

@@ -0,0 +1,15 @@
+import { CommandBarProxyGlobal } from './CommandBarProxySDK';
+/**
+ * Returns the "pre-boot" proxied SDK object, creating it if necessary. This object might actually be a full SDK if it
+ * was already upgraded using `initSDK`. In either case, the returned object will _not_ itself be a proxy.
+ *
+ * The proxy SDK will only be created if one of the following hold:
+ * - window.CommandBar === undefined
+ * - window.CommandBar[_disposed] === true
+ * - window.CommandBar.disposed === true
+ *
+ * Otherwise the existing value of `window.CommandBar` is returned, whatever that may be.
+ */
+export declare function getProxySDK(): CommandBarProxyGlobal;
+/** Replaces `window.CommandBar` with a new Proxy SDK object. */
+export declare function initProxySDK(): void;

package/build/internal/src/client/symbols.d.ts

@@ -0,0 +1,50 @@
+export declare const _access: unique symbol;
+export declare const _configuration: unique symbol;
+export declare const _configure: unique symbol;
+export declare const _configUser: unique symbol;
+export declare const _dispatch: unique symbol;
+export declare const _dispose: unique symbol;
+export declare const _disposed: unique symbol;
+export declare const _instanceAttributes: unique symbol;
+export declare const _isProxy: unique symbol;
+export declare const _loadEditor: unique symbol;
+export declare const _onEditorPathChange: unique symbol;
+export declare const _shareEditorRouteWithBar: unique symbol;
+export declare const _shareInitialEditorPath: unique symbol;
+export declare const _orgConfig: unique symbol;
+export declare const _perf: unique symbol;
+export declare const _programmaticTheme: unique symbol;
+export declare const _queue: unique symbol;
+export declare const _reload: unique symbol;
+export declare const _reloadCommands: unique symbol;
+export declare const _reloadOrganization: unique symbol;
+export declare const _reloadPlaceholders: unique symbol;
+export declare const _reloadNudges: unique symbol;
+export declare const _reloadHelpHub: unique symbol;
+export declare const _previewRecommendationSet: unique symbol;
+export declare const _stopRecommendationSetPreview: unique symbol;
+export declare const _previewNudge: unique symbol;
+export declare const _stopChecklistPreview: unique symbol;
+export declare const _stopNudgePreview: unique symbol;
+export declare const _previewChecklist: unique symbol;
+export declare const _reloadChecklists: unique symbol;
+export declare const _report: unique symbol;
+export declare const _reporter: unique symbol;
+export declare const _search: unique symbol;
+export declare const _setDashboard: unique symbol;
+export declare const _setPreviewMode: unique symbol;
+export declare const _setTestMode: unique symbol;
+export declare const _setEditorVisible: unique symbol;
+export declare const _shareConfig: unique symbol;
+export declare const _shareContextSettings: unique symbol;
+export declare const _shareProgrammaticCommands: unique symbol;
+export declare const _showGuide: unique symbol;
+export declare const _showMessage: unique symbol;
+export declare const _state: unique symbol;
+export declare const _unwrap: unique symbol;
+export declare const _user: unique symbol;
+export declare const _fingerprint: unique symbol;
+export declare const _userAttributes: unique symbol;
+export declare const _eventSubscriptions: unique symbol;
+export declare const _metaAttributes: unique symbol;
+export declare const _updateEditorRoute: unique symbol;