open-chat-studio-widget 0.4.6 → 0.4.8

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

@@ -163,6 +163,11 @@ export declare class OcsChat {
     private pauseMessagePolling;
     private resumeMessagePolling;
     private pollForMessages;
+    /**
+     * Scroll the message container to the bottom.
+     * @param forceEnd When `false`, scroll the top of the last message into view.
+     *    When `true`, scroll all the way to the end of the last message.
+     */
     private scrollToBottom;
     private focusInput;
     private handleKeyPress;

package/dist/types/components.d.ts

@@ -9,18 +9,22 @@ 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 (defaults to current origin).
+          * @default "https://chatbots.dimagi.com"
          */
         "apiBaseUrl"?: string;
         /**
           * The shape of the chat button. 'round' makes it circular, 'square' keeps it rectangular.
+          * @default 'square'
          */
         "buttonShape": 'round' | 'square';
         /**
@@ -41,18 +45,22 @@ export namespace Components {
         "iconUrl"?: string;
         /**
           * The message to display in the new chat confirmation dialog.
+          * @default "Starting a new chat will clear your current conversation. Continue?"
          */
         "newChatConfirmationMessage"?: string;
         /**
           * 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';
         /**
@@ -61,6 +69,7 @@ export namespace Components {
         "starterQuestions"?: string;
         /**
           * The text to display while the assistant is typing/preparing a response.
+          * @default "Preparing response"
          */
         "typingIndicatorText"?: string;
         /**
@@ -73,6 +82,7 @@ export namespace Components {
         "userName"?: string;
         /**
           * Whether the chat widget is visible on load.
+          * @default false
          */
         "visible": boolean;
         /**
@@ -96,18 +106,22 @@ 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 (defaults to current origin).
+          * @default "https://chatbots.dimagi.com"
          */
         "apiBaseUrl"?: string;
         /**
           * The shape of the chat button. 'round' makes it circular, 'square' keeps it rectangular.
+          * @default 'square'
          */
         "buttonShape"?: 'round' | 'square';
         /**
@@ -128,18 +142,22 @@ declare namespace LocalJSX {
         "iconUrl"?: string;
         /**
           * The message to display in the new chat confirmation dialog.
+          * @default "Starting a new chat will clear your current conversation. Continue?"
          */
         "newChatConfirmationMessage"?: string;
         /**
           * 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';
         /**
@@ -148,6 +166,7 @@ declare namespace LocalJSX {
         "starterQuestions"?: string;
         /**
           * The text to display while the assistant is typing/preparing a response.
+          * @default "Preparing response"
          */
         "typingIndicatorText"?: string;
         /**
@@ -160,6 +179,7 @@ declare namespace LocalJSX {
         "userName"?: string;
         /**
           * Whether the chat widget is visible on load.
+          * @default false
          */
         "visible"?: boolean;
         /**

package/dist/types/stencil-public-runtime.d.ts

@@ -260,6 +260,25 @@ export declare function setPlatformHelpers(helpers: {
  * @returns the base path
  */
 export declare function getAssetPath(path: string): string;
+/**
+ * Method to render a virtual DOM tree to a container element.
+ *
+ * @example
+ * ```tsx
+ * import { render } from '@stencil/core';
+ *
+ * const vnode = (
+ *   <div>
+ *     <h1>Hello, world!</h1>
+ *   </div>
+ * );
+ * render(vnode, document.body);
+ * ```
+ *
+ * @param vnode - The virtual DOM tree to render
+ * @param container - The container element to render the virtual DOM tree to
+ */
+export declare function render(vnode: VNode, container: Element): void;
 /**
  * Used to manually set the base path where assets can be found. For lazy-loaded
  * builds the asset path is automatically set and assets copied to the correct
@@ -826,7 +845,8 @@ export declare namespace JSXBase {
     }
     interface DetailsHTMLAttributes<T> extends HTMLAttributes<T> {
         open?: boolean;
-        onToggle?: (event: Event) => void;
+        name?: string;
+        onToggle?: (event: ToggleEvent) => void;
     }
     interface DelHTMLAttributes<T> extends HTMLAttributes<T> {
         cite?: string;
@@ -1532,6 +1552,13 @@ export declare namespace JSXBase {
         z?: number | string;
         zoomAndPan?: string;
     }
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ToggleEvent) */
+    interface ToggleEvent extends Event {
+        /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ToggleEvent/newState) */
+        readonly newState: string;
+        /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/ToggleEvent/oldState) */
+        readonly oldState: string;
+    }
     interface DOMAttributes<T> extends JSXAttributes<T> {
         slot?: string;
         part?: string;
@@ -1548,6 +1575,10 @@ export declare namespace JSXBase {
         onCompositionstartCapture?: (event: CompositionEvent) => void;
         onCompositionupdate?: (event: CompositionEvent) => void;
         onCompositionupdateCapture?: (event: CompositionEvent) => void;
+        onBeforeToggle?: (event: ToggleEvent) => void;
+        onBeforeToggleCapture?: (event: ToggleEvent) => void;
+        onToggle?: (event: ToggleEvent) => void;
+        onToggleCapture?: (event: ToggleEvent) => void;
         onFocus?: (event: FocusEvent) => void;
         onFocusCapture?: (event: FocusEvent) => void;
         onFocusin?: (event: FocusEvent) => void;
@@ -1566,10 +1597,6 @@ export declare namespace JSXBase {
         onSubmitCapture?: (event: Event) => void;
         onInvalid?: (event: Event) => void;
         onInvalidCapture?: (event: Event) => void;
-        onBeforeToggle?: (event: Event) => void;
-        onBeforeToggleCapture?: (event: Event) => void;
-        onToggle?: (event: Event) => void;
-        onToggleCapture?: (event: Event) => void;
         onLoad?: (event: Event) => void;
         onLoadCapture?: (event: Event) => void;
         onError?: (event: Event) => void;
@@ -1581,7 +1608,7 @@ export declare namespace JSXBase {
         onKeyUp?: (event: KeyboardEvent) => void;
         onKeyUpCapture?: (event: KeyboardEvent) => void;
         onAuxClick?: (event: MouseEvent) => void;
-        onClick?: (event: MouseEvent) => void;
+        onClick?: (event: PointerEvent) => void;
         onClickCapture?: (event: MouseEvent) => void;
         onContextMenu?: (event: MouseEvent) => void;
         onContextMenuCapture?: (event: MouseEvent) => void;
@@ -1661,6 +1688,8 @@ export declare namespace JSXBase {
         onTransitionRunCapture?: (event: TransitionEvent) => void;
         onTransitionStart?: (event: TransitionEvent) => void;
         onTransitionStartCapture?: (event: TransitionEvent) => void;
+        [key: `aria-${string}`]: string | boolean | undefined;
+        [key: `aria${string}`]: string | boolean | undefined;
     }
 }
 export interface JSXAttributes<T = Element> {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "open-chat-studio-widget",
-  "version": "0.4.6",
+  "version": "0.4.8",
   "description": "Chat component for Open Chat Studio",
   "main": "dist/index.cjs.js",
   "exports": "./dist/esm/open-chat-studio-widget.js",
@@ -29,7 +29,7 @@
     "postpublish": "npm run use:gitReadme"
   },
   "dependencies": {
-    "@stencil/core": "^4.26.0",
+    "@stencil/core": "^4.27.0",
     "dompurify": "^3.0.5",
     "js-cookie": "^3.0.5",
     "marked": "^4.3.0",

package/dist/cjs/app-globals-3a1e7e63.js

@@ -1,7 +0,0 @@
-'use strict';
-
-const globalScripts = () => {};
-
-exports.globalScripts = globalScripts;
-
-//# sourceMappingURL=app-globals-3a1e7e63.js.map

package/dist/cjs/app-globals-3a1e7e63.js.map

@@ -1 +0,0 @@
-{"file":"app-globals-3a1e7e63.js","mappings":";;AAAY,MAAC,aAAa,GAAG,MAAM;;;;","names":[],"sources":["@stencil/core/internal/app-globals"],"sourcesContent":["export const globalScripts = () => {};\n"],"version":3}