open-chat-studio-widget 0.6.0 → 0.8.0

package/dist/types/components/ocs-chat/ocs-chat.d.ts

@@ -37,6 +37,18 @@ export declare class OcsChat {
      * The shape of the chat button. 'round' makes it circular, 'square' keeps it rectangular.
      */
     buttonShape: 'round' | 'square';
+    /**
+     * Whether to show the launcher button. Set to false to hide the button
+     * and open the chat window programmatically via the `visible` property.
+     */
+    showButton: boolean;
+    /**
+     * 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`).
+     */
+    mode: 'standard' | 'kiosk';
     /**
      * The text to place in the header.
      */
@@ -62,7 +74,7 @@ export declare class OcsChat {
      */
     starterQuestions?: string;
     /**
-    * Used to associate chat sessions with a specific user across multiple visits/sessions
+     * Used to associate chat sessions with a specific user across multiple visits/sessions
      */
     userId?: string;
     /**
@@ -71,6 +83,7 @@ export declare class OcsChat {
     userName?: string;
     /**
      * Whether to persist session data to local storage to allow resuming previous conversations after page reload.
+     * Ignored when `sessionId` is provided.
      */
     persistentSession: boolean;
     /**
@@ -99,11 +112,25 @@ export declare class OcsChat {
      * Optional context object to send with each message. This provides page-specific context to the bot.
      */
     pageContext?: Record<string, any>;
+    /**
+     * @internal
+     * Optional version number of the chatbot to use. Requires authentication.
+     * This is for internal use only and is not intended for public-facing widgets.
+     */
+    versionNumber?: number;
+    /**
+     * The ID of an existing chat session to connect to. When provided, the widget
+     * is bound to that session: local session persistence is disabled and the
+     * message history is loaded from the server. Intended for host pages that
+     * create the session server-side (e.g. the OCS web chat page).
+     */
+    sessionId?: string;
     error: string;
     messages: ChatMessage[];
-    sessionId?: string;
+    activeSessionId?: string;
     isLoading: boolean;
     isTyping: boolean;
+    typingProgressMessage: string;
     messageInput: string;
     currentPollTaskId: string;
     isDragging: boolean;
@@ -148,6 +175,7 @@ export declare class OcsChat {
     private chatWindowFullscreenWidth;
     private positionInitialized;
     private internalPageContext?;
+    private sessionEpoch;
     host: HTMLElement;
     componentWillLoad(): Promise<void>;
     componentDidLoad(): void;
@@ -163,6 +191,11 @@ export declare class OcsChat {
     private loadTranslationsFromUrl;
     private cleanup;
     private startSession;
+    /**
+     * Load the full message history for a session provided via the `session-id`
+     * prop, then begin regular polling.
+     */
+    private loadBoundSessionHistory;
     private uploadFiles;
     private sendMessage;
     private handleStarterQuestionClick;
@@ -186,6 +219,7 @@ export declare class OcsChat {
      * @param pageContext - The new value for the field.
      */
     pageContextHandler(): void;
+    chatbotConfigHandler(): Promise<void>;
     /**
      * Watch for changes to the `visible` attribute and update accordingly.
      *
@@ -199,6 +233,10 @@ export declare class OcsChat {
     getPositionClasses(): string;
     private getFullscreenBounds;
     getPositionStyles(): {
+        left?: undefined;
+        top?: undefined;
+        transform?: undefined;
+    } | {
         left: string;
         top: string;
         transform: string;
@@ -245,7 +283,11 @@ export declare class OcsChat {
     private saveSessionToStorage;
     private loadSessionFromStorage;
     private getOrGenerateUserId;
+    private saveVisibleState;
+    private restoreVisibleState;
     private clearSessionStorage;
+    private isKioskMode;
+    private isSessionBound;
     private isLocalStorageAvailable;
     private showConfirmationDialog;
     private hideConfirmationDialog;

package/dist/types/components.d.ts

@@ -19,7 +19,7 @@ export namespace Components {
         "allowFullScreen": boolean;
         /**
           * The base URL for the API.
-          * @default "https://www.openchatstudio.com"
+          * @default 'https://www.openchatstudio.com'
          */
         "apiBaseUrl"?: string;
         /**
@@ -51,6 +51,11 @@ export namespace Components {
           * The language code for the widget UI (e.g., 'en', 'es', 'fr'). Defaults to en
          */
         "language"?: string;
+        /**
+          * 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.
          */
@@ -60,7 +65,7 @@ export namespace Components {
          */
         "pageContext"?: Record<string, any>;
         /**
-          * Whether to persist session data to local storage to allow resuming previous conversations after page reload.
+          * Whether to persist session data to local storage to allow resuming previous conversations after page reload. Ignored when `sessionId` is provided.
           * @default true
          */
         "persistentSession": boolean;
@@ -74,6 +79,15 @@ export namespace Components {
           * @default 'right'
          */
         "position": 'left' | 'center' | 'right';
+        /**
+          * The ID of an existing chat session to connect to. When provided, the widget is bound to that session: local session persistence is disabled and the message history is loaded from the server. Intended for host pages that create the session server-side (e.g. the OCS web chat page).
+         */
+        "sessionId"?: string;
+        /**
+          * 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)
          */
@@ -91,6 +105,7 @@ export namespace Components {
           * Display name for the user.
          */
         "userName"?: string;
+        "versionNumber"?: number;
         /**
           * Whether the chat widget is visible on load.
           * @default false
@@ -127,7 +142,7 @@ declare namespace LocalJSX {
         "allowFullScreen"?: boolean;
         /**
           * The base URL for the API.
-          * @default "https://www.openchatstudio.com"
+          * @default 'https://www.openchatstudio.com'
          */
         "apiBaseUrl"?: string;
         /**
@@ -159,6 +174,11 @@ declare namespace LocalJSX {
           * The language code for the widget UI (e.g., 'en', 'es', 'fr'). Defaults to en
          */
         "language"?: string;
+        /**
+          * 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.
          */
@@ -168,7 +188,7 @@ declare namespace LocalJSX {
          */
         "pageContext"?: Record<string, any>;
         /**
-          * Whether to persist session data to local storage to allow resuming previous conversations after page reload.
+          * Whether to persist session data to local storage to allow resuming previous conversations after page reload. Ignored when `sessionId` is provided.
           * @default true
          */
         "persistentSession"?: boolean;
@@ -182,6 +202,15 @@ declare namespace LocalJSX {
           * @default 'right'
          */
         "position"?: 'left' | 'center' | 'right';
+        /**
+          * The ID of an existing chat session to connect to. When provided, the widget is bound to that session: local session persistence is disabled and the message history is loaded from the server. Intended for host pages that create the session server-side (e.g. the OCS web chat page).
+         */
+        "sessionId"?: string;
+        /**
+          * 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)
          */

package/dist/types/services/chat-session-service.d.ts

@@ -42,6 +42,7 @@ export interface ChatSessionServiceOptions {
 }
 export interface TaskPollingCallbacks {
     onMessage: (message: ChatMessage) => void;
+    onProgress?: (message: string) => void;
     onTimeout?: () => void;
     onError?: (error: Error) => void;
 }
@@ -65,12 +66,18 @@ export declare class ChatSessionService {
     private readonly taskPollingMaxAttempts;
     private readonly messagePollingIntervalMs;
     private messagePollingTimer?;
+    private static readonly MAX_HISTORY_PAGES;
     constructor(options: ChatSessionServiceOptions);
     startSession(requestBody: Record<string, unknown>): Promise<ChatStartSessionResponse>;
     sendMessage(sessionId: string, payload: Record<string, unknown>): Promise<ChatSendMessageResponse>;
     pollTaskOnce(sessionId: string, taskId: string): Promise<ChatTaskPollResponse>;
     pollTask(sessionId: string, taskId: string, callbacks: TaskPollingCallbacks): TaskPollingHandle;
     fetchMessages(sessionId: string, since?: string): Promise<ChatPollResponse>;
+    /**
+     * Fetch the complete message history for a session by paging through the
+     * poll endpoint until no more messages remain.
+     */
+    fetchAllMessages(sessionId: string): Promise<ChatMessage[]>;
     startMessagePolling(sessionId: string, callbacks: MessagePollingCallbacks): MessagePollingHandle;
     stopMessagePolling(): void;
     private getJsonHeaders;

package/dist/types/utils/markdown.d.ts

@@ -3,4 +3,12 @@
  * This is called after DOMPurify to ensure external links open in new tabs
  */
 export declare function postProcessMarkdownHTML(html: string): string;
+export declare const SANITIZE_CONFIG: {
+    ALLOWED_TAGS: string[];
+    ALLOWED_ATTR: string[];
+    ALLOWED_URI_REGEXP: RegExp;
+    ADD_ATTR: string[];
+    FORBID_TAGS: string[];
+    FORBID_ATTR: string[];
+};
 export declare function renderMarkdownSync(content: string): string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-chat-studio-widget",
-  "version": "0.6.0",
+  "version": "0.8.0",
   "description": "Chat component for Open Chat Studio",
   "main": "dist/index.cjs.js",
   "exports": "./dist/esm/open-chat-studio-widget.js",
@@ -21,6 +21,7 @@
   ],
   "scripts": {
     "test": "stencil test --spec -- --forceExit",
+    "test:security": "node --test src/utils/markdown-security.test.mjs",
     "build": "stencil build --docs",
     "start": "stencil build --dev --watch --serve",
     "generate": "stencil generate",
@@ -29,7 +30,9 @@
     "prepublishOnly": "run-s build use:npmReadme",
     "postpublish": "npm run use:gitReadme",
     "type-check": "tsc --noEmit",
-    "lint": "eslint --fix src"
+    "lint": "eslint --fix src",
+    "format": "prettier --write \"src/**/*.{ts,tsx,css}\"",
+    "format:check": "prettier --check \"src/**/*.{ts,tsx,css}\""
   },
   "dependencies": {
     "@stencil/core": "^4.27.0",
@@ -45,10 +48,12 @@
     "@types/jest": "^29.5.14",
     "@types/node": "^22.13.4",
     "autoprefixer": "^10.4.20",
+    "happy-dom": "^20.8.4",
     "jest": "^29.7.0",
     "jest-cli": "^29.7.0",
     "npm-run-all": "^4.1.5",
     "postcss-import": "^16.1.0",
+    "prettier": "^3.8.3",
     "puppeteer": "^24.2.0",
     "stencil-tailwind-plugin": "^2.0.5",
     "tailwindcss": "^4.1.12",