{"_id":"@deliveryassured-ai/web-html-script-tag","_rev":"3-a69ea4ebe6493e8d10a340f4bb572d95","name":"@deliveryassured-ai/web-html-script-tag","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.0":{"name":"@deliveryassured-ai/web-html-script-tag","version":"1.0.0","author":{"name":"deliveryassured"},"license":"MIT","_id":"@deliveryassured-ai/web-html-script-tag@1.0.0","maintainers":[{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"}],"dist":{"shasum":"20d20a7c2fa867c5f992b17d0a49f0b7b8c2c97d","tarball":"https://registry.npmjs.org/@deliveryassured-ai/web-html-script-tag/-/web-html-script-tag-1.0.0.tgz","fileCount":4,"integrity":"sha512-wnl7bsuIUripnB4chy2VUlkmNYlqw6lCOUl8IFXaHd+jLLisRDI2DFbzVxlPpNMtmjH55RSW0+iovbk0VtuO+w==","signatures":[{"sig":"MEYCIQCimmEQfFtj9OAGjDkopagIPp+F9ZyaQxx1razCRUmS8AIhAKpgj4JgPpEnrMBM1irI7V0V/RrQXGcNGPFfEZlC2bhc","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":581772},"main":"dist/assets/index.js","type":"module","gitHead":"a5df95c53bf43b5cef186fef34ecb975df4493f4","scripts":{"dev":"vite","build":"vite build","preview":"vite preview"},"_npmUser":{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"},"_npmVersion":"10.2.4","description":"## Overview","directories":{},"_nodeVersion":"20.11.0","dependencies":{"@deliveryassured-ai/web":"^1.0.3"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.0.8"},"_npmOperationalInternal":{"tmp":"tmp/web-html-script-tag_1.0.0_1728008055670_0.8183810875595547","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@deliveryassured-ai/web-html-script-tag","version":"1.0.1","author":{"name":"deliveryassured"},"license":"MIT","_id":"@deliveryassured-ai/web-html-script-tag@1.0.1","maintainers":[{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"}],"dist":{"shasum":"2293f7a5dfe3407dc4e6afed9da70caf7064e5e5","tarball":"https://registry.npmjs.org/@deliveryassured-ai/web-html-script-tag/-/web-html-script-tag-1.0.1.tgz","fileCount":4,"integrity":"sha512-s1QGGhUtThgQO75yVbZGHEvQp3KQWPmkAEJcPAZ2BIRJ7fsubdBmDx+iLZGdhHsSWwLCCIfOqVmLqBf3l7KI9Q==","signatures":[{"sig":"MEUCICCYdWc/1b7Fs47pzCt5Fn7yUkKZm0cQCKU+7R4VZREJAiEAhH1avK6pm27hRuRGe3v3uzVR2PP3bnWjorpr0xN22CI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":595848},"main":"dist/assets/index.js","type":"module","gitHead":"a5df95c53bf43b5cef186fef34ecb975df4493f4","scripts":{"dev":"vite","build":"vite build","preview":"vite preview"},"_npmUser":{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"},"_npmVersion":"10.2.4","description":"## Overview","directories":{},"_nodeVersion":"20.11.0","dependencies":{"@deliveryassured-ai/web":"^1.0.3"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.0.8"},"_npmOperationalInternal":{"tmp":"tmp/web-html-script-tag_1.0.1_1728008908294_0.27725656862987647","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@deliveryassured-ai/web-html-script-tag","version":"1.0.2","author":{"name":"deliveryassured"},"license":"MIT","_id":"@deliveryassured-ai/web-html-script-tag@1.0.2","maintainers":[{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"}],"dist":{"shasum":"0deb2914706c4be44e428d920cb59d9217a2a8ae","tarball":"https://registry.npmjs.org/@deliveryassured-ai/web-html-script-tag/-/web-html-script-tag-1.0.2.tgz","fileCount":4,"integrity":"sha512-arU5PKqcMh/BvHUdI0N+0QbApt4ePHJ9Eyw114xvMGZGrmd/eh8/KqT33YbUFW7CkMrRFZjfPCNteY5SNZBalA==","signatures":[{"sig":"MEUCIQDHHOMmTzJKXXegd74o0KpMyRVLfxi2Us/6g9USj9rkOwIgWCO0VL2pfy4ucM+mBvQFsvNe3B4AgrDtXSuTo7GpZSM=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":595848},"main":"dist/assets/index.js","type":"module","gitHead":"a5df95c53bf43b5cef186fef34ecb975df4493f4","scripts":{"dev":"vite","build":"vite build","preview":"vite preview"},"_npmUser":{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"},"_npmVersion":"10.2.4","description":"## Overview","directories":{},"_nodeVersion":"20.11.0","dependencies":{"@deliveryassured-ai/web":"^1.0.3"},"_hasShrinkwrap":false,"devDependencies":{"vite":"^5.0.8"},"_npmOperationalInternal":{"tmp":"tmp/web-html-script-tag_1.0.2_1728010052261_0.9225920442556939","host":"s3://npm-registry-packages"}},"1.0.3":{"name":"@deliveryassured-ai/web-html-script-tag","version":"1.0.3","type":"module","main":"dist/assets/index.js","scripts":{"dev":"vite","build":"vite build","preview":"vite preview"},"author":{"name":"deliveryassured"},"license":"MIT","devDependencies":{"vite":"^5.0.8"},"dependencies":{"@deliveryassured-ai/web":"^1.0.7"},"_id":"@deliveryassured-ai/web-html-script-tag@1.0.3","gitHead":"fb492a6991554f48c5b3fbbd3136654309530d68","description":"This project integrates the Vapi client into any website, providing a voice assistant for support purposes. The Vapi client is powered by an easy-to-install JavaScript SDK, which is included in the website via a simple code snippet.","_nodeVersion":"22.11.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-xfevmkvX7TSHDXM+w3Jd5FMb3dvTm65XK2SimctAkU+QTfswqwVmrIcKgUi4Jg32YxTSFgrtrQuxUnqXT2OgQA==","shasum":"eb67acecb7dfb5db20f89b0d0bffa4ed4f3f31c0","tarball":"https://registry.npmjs.org/@deliveryassured-ai/web-html-script-tag/-/web-html-script-tag-1.0.3.tgz","fileCount":4,"unpackedSize":596734,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDa2eLD6aYJCpx6vueX47dwAxHHDjUHWVEYVduOz9/khAiAZ7TKYUjQ9kzcqPO/GsIOeOYYJtkJ2SToHLRhHjKEI2Q=="}]},"_npmUser":{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"},"directories":{},"maintainers":[{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/web-html-script-tag_1.0.3_1733198167827_0.5805028429453343"},"_hasShrinkwrap":false}},"time":{"created":"2024-10-04T02:14:15.544Z","modified":"2024-12-03T03:56:08.341Z","1.0.0":"2024-10-04T02:14:15.922Z","1.0.1":"2024-10-04T02:28:28.675Z","1.0.2":"2024-10-04T02:47:32.569Z","1.0.3":"2024-12-03T03:56:08.137Z"},"author":{"name":"deliveryassured"},"license":"MIT","description":"This project integrates the Vapi client into any website, providing a voice assistant for support purposes. The Vapi client is powered by an easy-to-install JavaScript SDK, which is included in the website via a simple code snippet.","maintainers":[{"name":"craigrichards","email":"craig.richards@deliveryassured.com.au"}],"readme":"# DeliveryAssured Client Integration\r\n\r\n## Overview\r\n\r\nThis project integrates the Vapi client into any website, providing a voice assistant for support purposes. The Vapi client is powered by an easy-to-install JavaScript SDK, which is included in the website via a simple code snippet.\r\n\r\n## Features\r\n\r\n- **Voice Assistant**: Enhance user experience with our voice assistant instantly.\r\n- **Customization**: Configure the assistant's settings to match your website's needs.\r\n- **UI Flexibility**: If needed, use the exposed CSS classes to further customize the appearance and behavior of the assistant on your webpage.\r\n\r\n## Installation\r\n\r\nTo add DeliveryAssured to your website, include the following javascript snippet in your HTML file inside a script tag:\r\n\r\n```js\r\n<script>\r\n  (function (d, t) {\r\n    var g = document.createElement(t),\r\n      s = d.getElementsByTagName(t)[0];\r\n    g.src =\r\n      \"https://cdn.jsdelivr.net/npm/@deliveryassured-ai/web-html-script-tag@latest/dist/assets/index.js\";\r\n    g.defer = true;\r\n    g.async = true;\r\n    s.parentNode.insertBefore(g, s);\r\n\r\n    g.onload = function () {\r\n      const deliveryassured = window.deliveryassuredSDK.run({\r\n        apiKey: \"\", // required Use your Public Key\r\n        assistant: assistant, // required\r\n        assistantOverrides: {}, // optional (This lets you override the assistant configuration and can be used alongside assistantId.)\r\n        config: buttonConfig // optional\r\n      });\r\n\r\n      if(deliveryassured) {\r\n        // Extend more using deliveryassured\r\n\r\n      }\r\n    };\r\n  })(document, \"script\");\r\n</script>\r\n```\r\n\r\nWhere value of assistant can be your assistant ID (Dashboard > Assistants > Select your assistant > Copy the id) or assistant config like below example.\r\n\r\n```js\r\nconst assistant = {\r\n  model: {\r\n    provider: \"openai\",\r\n    model: \"gpt-3.5-turbo\",\r\n    systemPrompt:\r\n      \"You're a versatile AI assistant named DeliveryAssured who is fun to talk with.\",\r\n  },\r\n  voice: {\r\n    provider: \"11labs\",\r\n    voiceId: \"paula\",\r\n  },\r\n  firstMessage: \"Hi, I am DeliveryAssured how can I assist you today?\",\r\n};\r\n```\r\n\r\nYou can also create squad using the assistant to handle complex workflows and tasks. For example. \r\n\r\n```js\r\n\r\nconst squad = {\r\n  \"squad\": {\r\n    \"members\": [\r\n      {\r\n        \"assistantId\": \"information-gathering-assistant-id\",\r\n        \"assistantDestinations\": [{\r\n          \"type\": \"assistant\",\r\n          \"assistantName\": \"Appointment Booking\",\r\n          \"message\": \"Please hold on while I transfer you to our appointment booking assistant.\",\r\n          \"description\": \"Transfer the user to the appointment booking assistant after they say their name.\"\r\n        }],\r\n      },\r\n      {\r\n        \"assistant\": {\r\n          \"name\": \"Appointment Booking\",\r\n        },\r\n      }\r\n    ]\r\n  }\r\n}\r\n\r\n(function (d, t) {\r\n    var g = document.createElement(t),\r\n      s = d.getElementsByTagName(t)[0];\r\n      g.src =\r\n        \"https://cdn.jsdelivr.net/npm/@deliveryassured-ai/web-html-script-tag@latest/dist/assets/index.js\";\r\n    g.defer = true;\r\n    g.async = true;\r\n    s.parentNode.insertBefore(g, s);\r\n\r\n    g.onload = function () {\r\n      const deliveryassured = window.deliveryassuredSDK.run({\r\n        apiKey: \"\", // required Use your Public Key\r\n        squad: squad, // You can pass in squad as an option to create squad.\r\n        config: buttonConfig // optional\r\n      });\r\n\r\n      if(deliveryassured) {\r\n        // Extend more using deliveryassured\r\n\r\n      }\r\n    };\r\n  })(document, \"script\");\r\n\r\n\r\n\r\n```\r\n\r\n\r\nYou can also customise the look and feel of your DeliveryAssured Support Button using the following configurations.\r\nThe button will have 3 states, `idle`, `loading` and `active`.\r\n\r\n```js\r\nconst buttonConfig = {\r\n  position: \"bottom-right\", // \"bottom\" | \"top\" | \"left\" | \"right\" | \"top-right\" | \"top-left\" | \"bottom-left\" | \"bottom-right\"\r\n  offset: \"40px\", // decide how far the button should be from the edge\r\n  width: \"50px\", // min-width of the button\r\n  height: \"50px\", // height of the button\r\n  idle: {\r\n    // button state when the call is not active.\r\n    color: `rgb(93, 254, 202)`,\r\n    type: \"pill\", // or \"round\"\r\n    title: \"Have a quick question?\", // only required in case of Pill\r\n    subtitle: \"Talk with our AI assistant\", // only required in case of pill\r\n    icon: `https://unpkg.com/lucide-static@0.321.0/icons/phone.svg`,\r\n  },\r\n  loading: {\r\n    // button state when the call is connecting\r\n    color: `rgb(93, 124, 202)`,\r\n    type: \"pill\", // or \"round\"\r\n    title: \"Connecting...\", // only required in case of Pill\r\n    subtitle: \"Please wait\", // only required in case of pill\r\n    icon: `https://unpkg.com/lucide-static@0.321.0/icons/loader-2.svg`,\r\n  },\r\n  active: {\r\n    // button state when the call is in progress or active.\r\n    color: `rgb(255, 0, 0)`,\r\n    type: \"pill\", // or \"round\"\r\n    title: \"Call is in progress...\", // only required in case of Pill\r\n    subtitle: \"End the call.\", // only required in case of pill\r\n    icon: `https://unpkg.com/lucide-static@0.321.0/icons/phone-off.svg`,\r\n  },\r\n};\r\n```\r\n\r\n## Configuration\r\n\r\nYou can customize the assistant by modifying the `assistant` object. The `apiKey` should be replaced with your unique key provided by DeliveryAssured.\r\n\r\n## UI Customization\r\n\r\nThe SDK exposes several CSS classes that can be targeted for custom styling. Here is a list of the classes you can customize:\r\n\r\n- `.deliveryassured-btn`: The main class for the DeliveryAssured button.\r\n- `.deliveryassured-btn-is-idle`: The class for the DeliveryAssured button when the call is disconnected.\r\n- `.deliveryassured-btn-is-active`: The class for the DeliveryAssured button when the call is active.\r\n- `.deliveryassured-btn-is-loading`: The class for the DeliveryAssured button when the call is connecting.\r\n- `.deliveryassured-btn-is-speaking`: The class for the DeliveryAssured button when the bot is speaking.\r\n- `.deliveryassured-btn-pill`: The class for DeliveryAssured button to set pill variant.\r\n- `.deliveryassured-btn-round`: The class for DeliveryAssured button to set round variant.\r\n\r\nYou can add custom styles to these classes to match the look and feel of your website. These are exposed in case u need some more customisations besides the `position`, `color` and `offset` config available currently.\r\n\r\n","readmeFilename":"README.md"}