open-chat-studio-widget 0.5.3 → 0.7.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;
     /**
@@ -95,11 +107,22 @@ export declare class OcsChat {
      */
     language?: string;
     translationsUrl?: string;
+    /**
+     * 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;
     error: string;
     messages: ChatMessage[];
     sessionId?: string;
     isLoading: boolean;
     isTyping: boolean;
+    typingProgressMessage: string;
     messageInput: string;
     currentPollTaskId: string;
     isDragging: boolean;
@@ -143,6 +166,8 @@ export declare class OcsChat {
     private chatWindowWidth;
     private chatWindowFullscreenWidth;
     private positionInitialized;
+    private internalPageContext?;
+    private sessionEpoch;
     host: HTMLElement;
     componentWillLoad(): Promise<void>;
     componentDidLoad(): void;
@@ -154,6 +179,7 @@ export declare class OcsChat {
     private parseWelcomeMessages;
     private parseStarterQuestions;
     private initializeTranslations;
+    private loadInternalPageContext;
     private loadTranslationsFromUrl;
     private cleanup;
     private startSession;
@@ -174,6 +200,13 @@ export declare class OcsChat {
     private formatFileSize;
     private formatTime;
     private toggleWindowVisibility;
+    /**
+     * Watch for changes to the `pageContext` prop and sync to internal variable.
+     *
+     * @param pageContext - The new value for the field.
+     */
+    pageContextHandler(): void;
+    chatbotConfigHandler(): Promise<void>;
     /**
      * Watch for changes to the `visible` attribute and update accordingly.
      *
@@ -187,6 +220,10 @@ export declare class OcsChat {
     getPositionClasses(): string;
     private getFullscreenBounds;
     getPositionStyles(): {
+        left?: undefined;
+        top?: undefined;
+        transform?: undefined;
+    } | {
         left: string;
         top: string;
         transform: string;
@@ -233,7 +270,10 @@ export declare class OcsChat {
     private saveSessionToStorage;
     private loadSessionFromStorage;
     private getOrGenerateUserId;
+    private saveVisibleState;
+    private restoreVisibleState;
     private clearSessionStorage;
+    private isKioskMode;
     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,10 +51,19 @@ 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.
          */
         "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
@@ -70,6 +79,11 @@ export namespace Components {
           * @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)
          */
@@ -87,6 +101,7 @@ export namespace Components {
           * Display name for the user.
          */
         "userName"?: string;
+        "versionNumber"?: number;
         /**
           * Whether the chat widget is visible on load.
           * @default false
@@ -123,7 +138,7 @@ declare namespace LocalJSX {
         "allowFullScreen"?: boolean;
         /**
           * The base URL for the API.
-          * @default "https://www.openchatstudio.com"
+          * @default 'https://www.openchatstudio.com'
          */
         "apiBaseUrl"?: string;
         /**
@@ -155,10 +170,19 @@ 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.
          */
         "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
@@ -174,6 +198,11 @@ declare namespace LocalJSX {
           * @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)
          */

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;
 }

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.5.3",
+  "version": "0.7.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",