@release0/js 1.1.0

package/README.md

@@ -0,0 +1,169 @@
+# Release0 JS library
+
+Frontend library to embed chat agents from [Release0](https://release0.com/).
+
+## Installation
+
+### Using npm
+
+To install, simply run:
+
+```bash
+npm install @release0/js
+```
+
+### Directly in your HTML
+
+```
+<script type="module">
+  import Agent from 'https://cdn.jsdelivr.net/npm/@release0/js@1.1.0/dist/web.js'
+
+  Agent.initStandard({
+    agent: 'my-agent-id',
+  })
+</script>
+
+<agent-standard style="width: 100%; height: 600px; "></agent-standard>
+```
+
+## Standard
+
+You can get the standard HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Integrations" tab of your agent.
+
+There, you can change the container dimensions. Here is a code example:
+
+```html
+<script type="module">
+  import Agent from "https://cdn.jsdelivr.net/npm/@release0/js@1.1.0/dist/web.js";
+
+  Agent.initStandard({
+    agent: "my-agent-id",
+  });
+</script>
+
+<agent-standard style="width: 100%; height: 600px; "></agent-standard>
+```
+
+This code is creating a container with a 100% width (will match parent width) and 600px height.
+
+## Popup
+
+You can get the popup HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Integrations" tab of your agent.
+
+Here is an example:
+
+```html
+<script type="module">
+  import Agent from "https://cdn.jsdelivr.net/npm/@release0/js@1.1.0/dist/web.js";
+
+  Agent.initPopup({
+    agent: "my-agent-id",
+    apiHost: "https://release0.com",
+    autoShowDelay: 3000,
+  });
+</script>
+```
+
+This code will automatically trigger the popup window after 3 seconds.
+
+### Open or Close a popup
+
+You can use these commands:
+
+```js
+Agent.open();
+```
+
+```js
+Agent.close();
+```
+
+```js
+Agent.toggle();
+```
+
+You can bind these commands on a button element, for example:
+
+```html
+<button onclick="Agent.open()">Contact us</button>
+```
+
+## Bubble
+
+You can get the bubble HTML and Javascript code by clicking on the "HTML & Javascript" button in the "Integrations" tab of your agent.
+
+Here is an example:
+
+```html
+<script type="module">
+  import Agent from "https://cdn.jsdelivr.net/npm/@release0/js@1.1.0/dist/web.js";
+
+  Agent.initBubble({
+    agent: "my-agent-id",
+    previewMessage: {
+      message: "I have a question for you!",
+      autoShowDelay: 5000,
+      avatarUrl: "https://release0.com/images/logo512.png",
+    },
+    theme: {
+      button: { backgroundColor: "#0042DA", iconColor: "#FFFFFF" },
+      previewMessage: { backgroundColor: "#ffffff", textColor: "black" },
+      chatWindow: { backgroundColor: "#ffffff" },
+    },
+  });
+</script>
+```
+
+This code will show the bubble and let a preview message appear after 5 seconds.
+
+### Open or close the preview message
+
+You can use these commands:
+
+```js
+Agent.showPreviewMessage();
+```
+
+```js
+Agent.hidePreviewMessage();
+```
+
+### Open or close the agent
+
+You can use these commands:
+
+```js
+Agent.open();
+```
+
+```js
+Agent.close();
+```
+
+```js
+Agent.toggle();
+```
+
+You can bind these commands on a button element, for example:
+
+```html
+<button onclick="Agent.open()">Contact us</button>
+```
+
+## Additional configuration
+
+You can prefill the agent variable values in your embed code by adding the `prefilledVariables` option. Here is an example:
+
+```js
+Agent.initStandard({
+  agent: "my-agent-id",
+  prefilledVariables: {
+    "Current URL": "https://my-site.com/account",
+    "User name": "John Doe",
+  },
+});
+```
+
+It will prefill the `Current URL` variable with "https://my-site.com/account" and the `User name` variable with "John Doe".
+
+Note that if your site URL contains query params (i.e. https://release0.com?User%20name=John%20Doe), the variables will automatically be injected to the agent. So you don't need to manually transfer query params to the agent embed configuration.

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@release0/js",
+  "version": "1.1.0",
+  "description": "Javascript library to display Release0 agents on your website",
+  "license": "FSL-1.1-ALv2",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": "./dist/index.js",
+    "./web": "./dist/web.js"
+  },
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup"
+  },
+  "devDependencies": {
+    "@ai-sdk/ui-utils": "0.0.46",
+    "@ark-ui/solid": "4.2.1",
+    "@fix-webm-duration/fix": "1.0.1",
+    "@stripe/stripe-js": "1.54.1",
+    "clsx": "2.1.1",
+    "dompurify": "3.0.6",
+    "ky": "1.2.4",
+    "marked": "9.0.3",
+    "partysocket": "1.0.2",
+    "solid-element": "1.9.0",
+    "solid-js": "1.9.2",
+    "@release0/blocks-bubbles": "workspace:*",
+    "@release0/blocks-inputs": "workspace:*",
+    "@release0/blocks-logic": "workspace:*",
+    "@release0/agent-engine": "workspace:*",
+    "@release0/env": "workspace:*",
+    "@release0/lib": "workspace:*",
+    "@release0/rich-text": "workspace:*",
+    "@release0/settings": "workspace:*",
+    "@release0/theme": "workspace:*",
+    "@release0/tsconfig": "workspace:*",
+    "@release0/zendesk-block": "workspace:*",
+    "@types/dompurify": "3.0.3",
+    "autoprefixer": "10.4.20",
+    "esbuild-plugin-solid": "^0.6.0",
+    "postcss": "8.4.49",
+    "tailwindcss": "3.4.16",
+    "tsup": "8.3.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}