open-chat-studio-widget 0.1.0 → 0.2.0

package/README.md

@@ -1,62 +1,33 @@
-# Open Chat Studio Chat Component
+# Open Chat Studio Chat Widget
 
-A Web Component built with [Stencil](https://stenciljs.com/) that allows you to add a chat dialog to a web page
-that is connected to a public Open Chat Studio (OCS) bot.
+A chatbot component for Open Chat Studio.
 
-## Getting Started
+For more information, see the [Open Chat Studio documentation](https://dimagi.github.io/open-chat-studio-docs/how-to/embed/)
 
-To try this component out, run:
+<!-- Auto Generated Below -->
 
-```bash
-npm install
-npm start
-```
 
-Now load the localhost URL shown in the console in your browser.
+## Properties
 
-Note that this requires you to have OCS running locally on port 8000. 
-You will also need to set the `boturl` property on the `open-chat-studio-widget` element to the URL of a bot you have
-running locally.
+| Property              | Attribute     | Description                                            | Type                            | Default     |
+| --------------------- | ------------- | ------------------------------------------------------ | ------------------------------- | ----------- |
+| `botUrl` _(required)_ | `bot-url`     | The URL of the bot to connect to.                      | `string`                        | `undefined` |
+| `buttonText`          | `button-text` | The text to display on the button.                     | `string`                        | `"Chat"`    |
+| `expanded`            | `expanded`    | Whether the chat widget is initially expanded.         | `boolean`                       | `false`     |
+| `position`            | `position`    | The initial position of the chat widget on the screen. | `"center" \| "left" \| "right"` | `'right'`   |
+| `visible`             | `visible`     | Whether the chat widget is visible on load.            | `boolean`                       | `false`     |
 
-To build the component for production, run:
 
-```bash
-npm run build
-```
+## CSS Custom Properties
 
-To run the unit tests for the components, run:
+| Name                              | Description                      |
+| --------------------------------- | -------------------------------- |
+| `--button-background-color`       | Button background color          |
+| `--button-background-color-hover` | Button background color on hover |
+| `--button-text-color`             | Button text color                |
+| `--button-text-color-hover`       | Button text color on hover       |
 
-```bash
-npm test
-```
 
-## Making Changes
+----------------------------------------------
 
-To make changes to the component, you can edit the files in the `src/components/open-chat-studio-widget` directory. You can
-also edit the `src/index.html` file to change the page that is loaded when you run `npm start`.
-
-### Styling
-
-The component uses [Tailwind CSS](https://tailwindcss.com/) with [DaisyUI](https://daisyui.com/) for styling.
-
-## Using this component
-
-There are three strategies we recommend for using web components built with Stencil.
-
-The first step for all three of these strategies is to [publish to NPM](https://docs.npmjs.com/getting-started/publishing-npm-packages).
-
-Once you've set up your local npm account, can do this by running
-
-```
-npm publish
-```
-
-### Script tag
-
-- Put a script tag similar to this `<script type='module' src='https://unpkg.com/open-chat-studio-widget@0.0.1/dist/open-chat-studio-widget.esm.js'></script>` in the head of your index.html
-- Then you can use the element anywhere in your template, JSX, html etc
-
-### Node Modules
-- Run `npm install open-chat-studio-widget --save`
-- Put a script tag similar to this `<script type='module' src='node_modules/open-chat-studio-widget/dist/open-chat-studio-widget.esm.js'></script>` in the head of your index.html
-- Then you can use the element anywhere in your template, JSX, html etc
+*Built with [StencilJS](https://stenciljs.com/)*

package/dist/cjs/{index-3826e5a2.js → index-550ac5f9.js}

@@ -21,7 +21,7 @@ function _interopNamespace(e) {
 }
 
 const NAMESPACE = 'open-chat-studio-widget';
-const BUILD = /* open-chat-studio-widget */ { allRenderFn: true, appendChildSlotFix: false, asyncLoading: true, asyncQueue: false, attachStyles: true, cloneNodeFix: false, cmpDidLoad: false, cmpDidRender: false, cmpDidUnload: false, cmpDidUpdate: false, cmpShouldUpdate: false, cmpWillLoad: true, cmpWillRender: false, cmpWillUpdate: false, connectedCallback: false, constructableCSS: true, cssAnnotations: true, devTools: false, disconnectedCallback: false, element: false, event: false, experimentalScopedSlotChanges: false, experimentalSlotFixes: false, formAssociated: false, hasRenderFn: true, hostListener: false, hostListenerTarget: false, hostListenerTargetBody: false, hostListenerTargetDocument: false, hostListenerTargetParent: false, hostListenerTargetWindow: false, hotModuleReplacement: false, hydrateClientSide: false, hydrateServerSide: false, hydratedAttribute: false, hydratedClass: true, hydratedSelectorName: "hydrated", initializeNextTick: false, invisiblePrehydration: true, isDebug: false, isDev: false, isTesting: false, lazyLoad: true, lifecycle: true, lifecycleDOMEvents: false, member: true, method: false, mode: false, modernPropertyDecls: false, observeAttribute: true, profile: false, prop: true, propBoolean: true, propMutable: true, propNumber: false, propString: true, reflect: false, scoped: false, scopedSlotTextContentFix: false, scriptDataOpts: false, shadowDelegatesFocus: false, shadowDom: true, slot: false, slotChildNodesFix: false, slotRelocation: false, state: true, style: true, svg: false, taskQueue: true, transformTagName: false, updatable: true, vdomAttribute: true, vdomClass: true, vdomFunctional: false, vdomKey: true, vdomListener: true, vdomPropOrAttr: true, vdomRef: true, vdomRender: true, vdomStyle: true, vdomText: true, vdomXlink: true, watchCallback: false };
+const BUILD = /* open-chat-studio-widget */ { allRenderFn: true, appendChildSlotFix: false, asyncLoading: true, asyncQueue: false, attachStyles: true, cloneNodeFix: false, cmpDidLoad: false, cmpDidRender: false, cmpDidUnload: false, cmpDidUpdate: false, cmpShouldUpdate: false, cmpWillLoad: true, cmpWillRender: false, cmpWillUpdate: false, connectedCallback: false, constructableCSS: true, cssAnnotations: true, devTools: false, disconnectedCallback: false, element: false, event: false, experimentalScopedSlotChanges: false, experimentalSlotFixes: false, formAssociated: false, hasRenderFn: true, hostListener: false, hostListenerTarget: false, hostListenerTargetBody: false, hostListenerTargetDocument: false, hostListenerTargetParent: false, hostListenerTargetWindow: false, hotModuleReplacement: false, hydrateClientSide: false, hydrateServerSide: false, hydratedAttribute: false, hydratedClass: true, hydratedSelectorName: "hydrated", initializeNextTick: false, invisiblePrehydration: true, isDebug: false, isDev: false, isTesting: false, lazyLoad: true, lifecycle: true, lifecycleDOMEvents: false, member: true, method: false, mode: false, modernPropertyDecls: false, observeAttribute: true, profile: false, prop: true, propBoolean: true, propMutable: true, propNumber: false, propString: true, reflect: false, scoped: false, scopedSlotTextContentFix: false, scriptDataOpts: false, shadowDelegatesFocus: false, shadowDom: true, slot: false, slotChildNodesFix: false, slotRelocation: false, state: true, style: true, svg: true, taskQueue: true, transformTagName: false, updatable: true, vdomAttribute: true, vdomClass: true, vdomFunctional: true, vdomKey: false, vdomListener: true, vdomPropOrAttr: true, vdomRef: false, vdomRender: true, vdomStyle: false, vdomText: true, vdomXlink: false, watchCallback: false };
 
 /*
  Stencil Client Platform v4.25.3 | MIT Licensed | https://stenciljs.com
@@ -32,6 +32,10 @@ var __export = (target, all) => {
     __defProp(target, name, { get: all[name], enumerable: true });
 };
 
+// src/utils/constants.ts
+var SVG_NS = "http://www.w3.org/2000/svg";
+var HTML_NS = "http://www.w3.org/1999/xhtml";
+
 // src/client/client-host-ref.ts
 var hostRefs = /* @__PURE__ */ new WeakMap();
 var getHostRef = (ref) => hostRefs.get(ref);
@@ -93,7 +97,6 @@ var styles = /* @__PURE__ */ new Map();
 var HYDRATED_STYLE_ID = "sty-id";
 var HYDRATED_CSS = "{visibility:hidden}.hydrated{visibility:inherit}";
 var SLOT_FB_CSS = "slot-fb{display:contents}slot-fb[hidden]{display:none}";
-var XLINK_NS = "http://www.w3.org/1999/xlink";
 var win = typeof window !== "undefined" ? window : {};
 var doc = win.document || { head: {} };
 var plt = {
@@ -224,7 +227,6 @@ var uniqueTime = (key, measureText) => {
 };
 var h = (nodeName, vnodeData, ...children) => {
   let child = null;
-  let key = null;
   let simple = false;
   let lastSimple = false;
   const vNodeChildren = [];
@@ -248,9 +250,6 @@ var h = (nodeName, vnodeData, ...children) => {
   };
   walk(children);
   if (vnodeData) {
-    if (vnodeData.key) {
-      key = vnodeData.key;
-    }
     {
       const classData = vnodeData.className || vnodeData.class;
       if (classData) {
@@ -258,14 +257,18 @@ var h = (nodeName, vnodeData, ...children) => {
       }
     }
   }
+  if (typeof nodeName === "function") {
+    return nodeName(
+      vnodeData === null ? {} : vnodeData,
+      vNodeChildren,
+      vdomFnUtils
+    );
+  }
   const vnode = newVNode(nodeName, null);
   vnode.$attrs$ = vnodeData;
   if (vNodeChildren.length > 0) {
     vnode.$children$ = vNodeChildren;
   }
-  {
-    vnode.$key$ = key;
-  }
   return vnode;
 };
 var newVNode = (tag, text) => {
@@ -279,13 +282,40 @@ var newVNode = (tag, text) => {
   {
     vnode.$attrs$ = null;
   }
-  {
-    vnode.$key$ = null;
-  }
   return vnode;
 };
 var Host = {};
 var isHost = (node) => node && node.$tag$ === Host;
+var vdomFnUtils = {
+  forEach: (children, cb) => children.map(convertToPublic).forEach(cb),
+  map: (children, cb) => children.map(convertToPublic).map(cb).map(convertToPrivate)
+};
+var convertToPublic = (node) => ({
+  vattrs: node.$attrs$,
+  vchildren: node.$children$,
+  vkey: node.$key$,
+  vname: node.$name$,
+  vtag: node.$tag$,
+  vtext: node.$text$
+});
+var convertToPrivate = (node) => {
+  if (typeof node.vtag === "function") {
+    const vnodeData = { ...node.vattrs };
+    if (node.vkey) {
+      vnodeData.key = node.vkey;
+    }
+    if (node.vname) {
+      vnodeData.name = node.vname;
+    }
+    return h(node.vtag, vnodeData, ...node.vchildren || []);
+  }
+  const vnode = newVNode(node.vtag, node.vtext);
+  vnode.$attrs$ = node.vattrs;
+  vnode.$children$ = node.vchildren;
+  vnode.$key$ = node.vkey;
+  vnode.$name$ = node.vname;
+  return vnode;
+};
 var parsePropertyValue = (propValue, propType) => {
   if (propValue != null && !isComplexType(propValue)) {
     if (propType & 4 /* Boolean */) {
@@ -408,31 +438,6 @@ var setAccessor = (elm, memberName, oldValue, newValue, isSvg, flags, initialRen
         classList.remove(...oldClasses.filter((c) => c && !newClasses.includes(c)));
         classList.add(...newClasses.filter((c) => c && !oldClasses.includes(c)));
       }
-    } else if (memberName === "style") {
-      {
-        for (const prop in oldValue) {
-          if (!newValue || newValue[prop] == null) {
-            if (prop.includes("-")) {
-              elm.style.removeProperty(prop);
-            } else {
-              elm.style[prop] = "";
-            }
-          }
-        }
-      }
-      for (const prop in newValue) {
-        if (!oldValue || newValue[prop] !== oldValue[prop]) {
-          if (prop.includes("-")) {
-            elm.style.setProperty(prop, newValue[prop]);
-          } else {
-            elm.style[prop] = newValue[prop];
-          }
-        }
-      }
-    } else if (memberName === "key") ; else if (memberName === "ref") {
-      if (newValue) {
-        newValue(elm);
-      }
     } else if ((!isProp ) && memberName[0] === "o" && memberName[1] === "n") {
       if (memberName[2] === "-") {
         memberName = memberName.slice(3);
@@ -472,26 +477,15 @@ var setAccessor = (elm, memberName, oldValue, newValue, isSvg, flags, initialRen
         } catch (e) {
         }
       }
-      let xlink = false;
-      {
-        if (ln !== (ln = ln.replace(/^xlink\:?/, ""))) {
-          memberName = ln;
-          xlink = true;
-        }
-      }
       if (newValue == null || newValue === false) {
         if (newValue !== false || elm.getAttribute(memberName) === "") {
-          if (xlink) {
-            elm.removeAttributeNS(XLINK_NS, memberName);
-          } else {
+          {
             elm.removeAttribute(memberName);
           }
         }
       } else if ((!isProp || flags & 4 /* isHost */ || isSvg) && !isComplex) {
         newValue = newValue === true ? "" : newValue;
-        if (xlink) {
-          elm.setAttributeNS(XLINK_NS, memberName, newValue);
-        } else {
+        {
           elm.setAttribute(memberName, newValue);
         }
       }
@@ -559,9 +553,16 @@ var createElm = (oldParentVNode, newParentVNode, childIndex) => {
   if (newVNode2.$text$ !== null) {
     elm = newVNode2.$elm$ = doc.createTextNode(newVNode2.$text$);
   } else {
-    elm = newVNode2.$elm$ = doc.createElement(
+    if (!isSvgMode) {
+      isSvgMode = newVNode2.$tag$ === "svg";
+    }
+    elm = newVNode2.$elm$ = doc.createElementNS(
+      isSvgMode ? SVG_NS : HTML_NS,
       !useNativeShadowDom && BUILD.slotRelocation && newVNode2.$flags$ & 2 /* isSlotFallback */ ? "slot-fb" : newVNode2.$tag$
-    );
+    ) ;
+    if (isSvgMode && newVNode2.$tag$ === "foreignObject") {
+      isSvgMode = false;
+    }
     {
       updateElement(null, newVNode2, isSvgMode);
     }
@@ -573,6 +574,13 @@ var createElm = (oldParentVNode, newParentVNode, childIndex) => {
         }
       }
     }
+    {
+      if (newVNode2.$tag$ === "svg") {
+        isSvgMode = false;
+      } else if (elm.tagName === "foreignObject") {
+        isSvgMode = true;
+      }
+    }
   }
   elm["s-hn"] = hostTagName;
   return elm;
@@ -598,7 +606,6 @@ var removeVnodes = (vnodes, startIdx, endIdx) => {
     const vnode = vnodes[index];
     if (vnode) {
       const elm = vnode.$elm$;
-      nullifyVNodeRefs(vnode);
       if (elm) {
         elm.remove();
       }
@@ -608,8 +615,6 @@ var removeVnodes = (vnodes, startIdx, endIdx) => {
 var updateChildren = (parentElm, oldCh, newVNode2, newCh, isInitialRender = false) => {
   let oldStartIdx = 0;
   let newStartIdx = 0;
-  let idxInOld = 0;
-  let i2 = 0;
   let oldEndIdx = oldCh.length - 1;
   let oldStartVnode = oldCh[0];
   let oldEndVnode = oldCh[oldEndIdx];
@@ -617,7 +622,6 @@ var updateChildren = (parentElm, oldCh, newVNode2, newCh, isInitialRender = fals
   let newStartVnode = newCh[0];
   let newEndVnode = newCh[newEndIdx];
   let node;
-  let elmToMove;
   while (oldStartIdx <= oldEndIdx && newStartIdx <= newEndIdx) {
     if (oldStartVnode == null) {
       oldStartVnode = oldCh[++oldStartIdx];
@@ -646,26 +650,7 @@ var updateChildren = (parentElm, oldCh, newVNode2, newCh, isInitialRender = fals
       oldEndVnode = oldCh[--oldEndIdx];
       newStartVnode = newCh[++newStartIdx];
     } else {
-      idxInOld = -1;
       {
-        for (i2 = oldStartIdx; i2 <= oldEndIdx; ++i2) {
-          if (oldCh[i2] && oldCh[i2].$key$ !== null && oldCh[i2].$key$ === newStartVnode.$key$) {
-            idxInOld = i2;
-            break;
-          }
-        }
-      }
-      if (idxInOld >= 0) {
-        elmToMove = oldCh[idxInOld];
-        if (elmToMove.$tag$ !== newStartVnode.$tag$) {
-          node = createElm(oldCh && oldCh[newStartIdx], newVNode2, idxInOld);
-        } else {
-          patch(elmToMove, newStartVnode, isInitialRender);
-          oldCh[idxInOld] = void 0;
-          node = elmToMove.$elm$;
-        }
-        newStartVnode = newCh[++newStartIdx];
-      } else {
         node = createElm(oldCh && oldCh[newStartIdx], newVNode2, newStartIdx);
         newStartVnode = newCh[++newStartIdx];
       }
@@ -691,9 +676,6 @@ var updateChildren = (parentElm, oldCh, newVNode2, newCh, isInitialRender = fals
 };
 var isSameVnode = (leftVNode, rightVNode, isInitialRender = false) => {
   if (leftVNode.$tag$ === rightVNode.$tag$) {
-    if (!isInitialRender) {
-      return leftVNode.$key$ === rightVNode.$key$;
-    }
     if (isInitialRender && !leftVNode.$key$ && rightVNode.$key$) {
       leftVNode.$key$ = rightVNode.$key$;
     }
@@ -705,8 +687,12 @@ var patch = (oldVNode, newVNode2, isInitialRender = false) => {
   const elm = newVNode2.$elm$ = oldVNode.$elm$;
   const oldChildren = oldVNode.$children$;
   const newChildren = newVNode2.$children$;
+  const tag = newVNode2.$tag$;
   const text = newVNode2.$text$;
   if (text === null) {
+    {
+      isSvgMode = tag === "svg" ? true : tag === "foreignObject" ? false : isSvgMode;
+    }
     {
       {
         updateElement(oldVNode, newVNode2, isSvgMode);
@@ -725,16 +711,13 @@ var patch = (oldVNode, newVNode2, isInitialRender = false) => {
     ) {
       removeVnodes(oldChildren, 0, oldChildren.length - 1);
     }
+    if (isSvgMode && tag === "svg") {
+      isSvgMode = false;
+    }
   } else if (oldVNode.$text$ !== text) {
     elm.data = text;
   }
 };
-var nullifyVNodeRefs = (vNode) => {
-  {
-    vNode.$attrs$ && vNode.$attrs$.ref && vNode.$attrs$.ref(null);
-    vNode.$children$ && vNode.$children$.map(nullifyVNodeRefs);
-  }
-};
 var insertBefore = (parent, newNode, reference) => {
   {
     return parent == null ? void 0 : parent.insertBefore(newNode, reference);
@@ -1307,4 +1290,4 @@ exports.promiseResolve = promiseResolve;
 exports.registerInstance = registerInstance;
 exports.setNonce = setNonce;
 
-//# sourceMappingURL=index-3826e5a2.js.map
+//# sourceMappingURL=index-550ac5f9.js.map