components.d.ts

/* eslint-disable */
/* tslint:disable */
/**
 * This is an autogenerated file created by the Stencil compiler.
 * It contains typing information for all components that exist in this project.
 */
import { HTMLStencilElement, JSXBase } from "@stencil/core/internal";
export namespace Components {
    interface OpenChatStudioWidget {
        /**
          * Allow the user to attach files to their messages.
          * @default false
         */
        "allowAttachments": boolean;
        /**
          * Allow the user to make the chat window full screen.
          * @default true
         */
        "allowFullScreen": boolean;
        /**
          * The base URL for the API.
          * @default 'https://www.openchatstudio.com'
         */
        "apiBaseUrl"?: string;
        /**
          * The shape of the chat button. 'round' makes it circular, 'square' keeps it rectangular.
          * @default 'square'
         */
        "buttonShape": 'round' | 'square';
        /**
          * The text to display on the button.
         */
        "buttonText"?: string;
        /**
          * The ID of the chatbot to connect to.
         */
        "chatbotId": string;
        /**
          * Authentication key for embedded channels
         */
        "embedKey"?: string;
        /**
          * The text to place in the header.
         */
        "headerText": '';
        /**
          * URL of the icon to display on the button. If not provided, uses the default OCS logo.
         */
        "iconUrl"?: string;
        /**
          * The language code for the widget UI (e.g., 'en', 'es', 'fr'). Defaults to en
         */
        "language"?: string;
        /**
          * Maximum number of characters allowed in a single message (derived from the model's token limit). When set, a live counter is shown and the send button is disabled when exceeded.
         */
        "maxCharLimit"?: number;
        /**
          * The operating mode of the widget. - 'standard': Default floating window with launcher button. - 'kiosk': Fills parent container, always visible, no header or launcher button.   The parent element must establish a containing block (e.g. `position: relative`).
          * @default 'standard'
         */
        "mode": 'standard' | 'kiosk';
        /**
          * The message to display in the new chat confirmation dialog.
         */
        "newChatConfirmationMessage"?: string;
        /**
          * Optional context object to send with each message. This provides page-specific context to the bot.
         */
        "pageContext"?: Record<string, any>;
        /**
          * Whether to persist session data to local storage to allow resuming previous conversations after page reload.
          * @default true
         */
        "persistentSession": boolean;
        /**
          * Minutes since the most recent message after which the session data in local storage will expire. Set this to `0` to never expire.
          * @default 60 * 24
         */
        "persistentSessionExpire": number;
        /**
          * The initial position of the chat widget on the screen.
          * @default 'right'
         */
        "position": 'left' | 'center' | 'right';
        /**
          * Whether to show the launcher button. Set to false to hide the button and open the chat window programmatically via the `visible` property.
          * @default true
         */
        "showButton": boolean;
        /**
          * Array of starter questions that users can click to send (JSON array of strings)
         */
        "starterQuestions"?: string;
        "translationsUrl"?: string;
        /**
          * The text to display while the assistant is typing/preparing a response.
         */
        "typingIndicatorText"?: string;
        /**
          * Used to associate chat sessions with a specific user across multiple visits/sessions
         */
        "userId"?: string;
        /**
          * Display name for the user.
         */
        "userName"?: string;
        "versionNumber"?: number;
        /**
          * Whether the chat widget is visible on load.
          * @default false
         */
        "visible": boolean;
        /**
          * Welcome messages to display above starter questions (JSON array of strings)
         */
        "welcomeMessages"?: string;
    }
}
declare global {
    interface HTMLOpenChatStudioWidgetElement extends Components.OpenChatStudioWidget, HTMLStencilElement {
    }
    var HTMLOpenChatStudioWidgetElement: {
        prototype: HTMLOpenChatStudioWidgetElement;
        new (): HTMLOpenChatStudioWidgetElement;
    };
    interface HTMLElementTagNameMap {
        "open-chat-studio-widget": HTMLOpenChatStudioWidgetElement;
    }
}
declare namespace LocalJSX {
    interface OpenChatStudioWidget {
        /**
          * Allow the user to attach files to their messages.
          * @default false
         */
        "allowAttachments"?: boolean;
        /**
          * Allow the user to make the chat window full screen.
          * @default true
         */
        "allowFullScreen"?: boolean;
        /**
          * The base URL for the API.
          * @default 'https://www.openchatstudio.com'
         */
        "apiBaseUrl"?: string;
        /**
          * The shape of the chat button. 'round' makes it circular, 'square' keeps it rectangular.
          * @default 'square'
         */
        "buttonShape"?: 'round' | 'square';
        /**
          * The text to display on the button.
         */
        "buttonText"?: string;
        /**
          * The ID of the chatbot to connect to.
         */
        "chatbotId": string;
        /**
          * Authentication key for embedded channels
         */
        "embedKey"?: string;
        /**
          * The text to place in the header.
         */
        "headerText"?: '';
        /**
          * URL of the icon to display on the button. If not provided, uses the default OCS logo.
         */
        "iconUrl"?: string;
        /**
          * The language code for the widget UI (e.g., 'en', 'es', 'fr'). Defaults to en
         */
        "language"?: string;
        /**
          * Maximum number of characters allowed in a single message (derived from the model's token limit). When set, a live counter is shown and the send button is disabled when exceeded.
         */
        "maxCharLimit"?: number;
        /**
          * The operating mode of the widget. - 'standard': Default floating window with launcher button. - 'kiosk': Fills parent container, always visible, no header or launcher button.   The parent element must establish a containing block (e.g. `position: relative`).
          * @default 'standard'
         */
        "mode"?: 'standard' | 'kiosk';
        /**
          * The message to display in the new chat confirmation dialog.
         */
        "newChatConfirmationMessage"?: string;
        /**
          * Optional context object to send with each message. This provides page-specific context to the bot.
         */
        "pageContext"?: Record<string, any>;
        /**
          * Whether to persist session data to local storage to allow resuming previous conversations after page reload.
          * @default true
         */
        "persistentSession"?: boolean;
        /**
          * Minutes since the most recent message after which the session data in local storage will expire. Set this to `0` to never expire.
          * @default 60 * 24
         */
        "persistentSessionExpire"?: number;
        /**
          * The initial position of the chat widget on the screen.
          * @default 'right'
         */
        "position"?: 'left' | 'center' | 'right';
        /**
          * Whether to show the launcher button. Set to false to hide the button and open the chat window programmatically via the `visible` property.
          * @default true
         */
        "showButton"?: boolean;
        /**
          * Array of starter questions that users can click to send (JSON array of strings)
         */
        "starterQuestions"?: string;
        "translationsUrl"?: string;
        /**
          * The text to display while the assistant is typing/preparing a response.
         */
        "typingIndicatorText"?: string;
        /**
          * Used to associate chat sessions with a specific user across multiple visits/sessions
         */
        "userId"?: string;
        /**
          * Display name for the user.
         */
        "userName"?: string;
        "versionNumber"?: number;
        /**
          * Whether the chat widget is visible on load.
          * @default false
         */
        "visible"?: boolean;
        /**
          * Welcome messages to display above starter questions (JSON array of strings)
         */
        "welcomeMessages"?: string;
    }
    interface IntrinsicElements {
        "open-chat-studio-widget": OpenChatStudioWidget;
    }
}
export { LocalJSX as JSX };
declare module "@stencil/core" {
    export namespace JSX {
        interface IntrinsicElements {
            "open-chat-studio-widget": LocalJSX.OpenChatStudioWidget & JSXBase.HTMLAttributes<HTMLOpenChatStudioWidgetElement>;
        }
    }
}