eleventy-plugin-ai-chatbot 0.0.0-stage → 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Asyntai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,84 @@
-# Temporary Holding Version
+# eleventy-plugin-ai-chatbot
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Add the [Asyntai](https://asyntai.com) AI chat assistant to your Eleventy (11ty)
+site. It answers visitor questions from your own content, in more than 80
+languages.
+
+## Install
+
+```bash
+npm install eleventy-plugin-ai-chatbot
+```
+
+Then add the plugin in your Eleventy configuration.
+
+`eleventy.config.js` (Eleventy 3, ESM):
+
+```js
+import aiChatbot from 'eleventy-plugin-ai-chatbot';
+
+export default function (eleventyConfig) {
+  eleventyConfig.addPlugin(aiChatbot, { widgetId: 'asyntai_1a2b3c4d5e6f' });
+}
+```
+
+`.eleventy.js` (Eleventy 1, 2 or 3, CommonJS):
+
+```js
+const aiChatbot = require('eleventy-plugin-ai-chatbot');
+
+module.exports = function (eleventyConfig) {
+  eleventyConfig.addPlugin(aiChatbot, { widgetId: 'asyntai_1a2b3c4d5e6f' });
+};
+```
+
+Build the site. The chat bubble is on every page.
+
+## Where the widget ID comes from
+
+Open the Install page in your [Asyntai dashboard](https://asyntai.com/dashboard).
+The widget ID is the value of `data-asyntai-id` in the snippet shown there. It
+starts with `asyntai_`.
+
+Creating an account is free, and the Free plan is enough to try the widget.
+
+## Options
+
+| Option | Type | Default | What it does |
+| --- | --- | --- | --- |
+| `widgetId` | string | required | Your Asyntai widget ID |
+| `enableInDevelopment` | boolean | `true` | Set to `false` to keep the widget off the site during `eleventy --serve` and `--watch` |
+| `scriptUrl` | string | the Asyntai CDN | Advanced. Load the widget from another URL |
+
+A missing or malformed `widgetId` stops the build with a message that says how
+to fix it.
+
+## What the plugin does
+
+- It adds the Asyntai loader to every HTML page, just before `</body>`.
+- The loader waits for the page's `load` event, so your own content always
+  renders first.
+- Feeds, sitemaps, JSON and CSS files stay as they are.
+- A page that already has the Asyntai snippet keeps it and gets no second one.
+
+It works with every template language: Nunjucks, Liquid, Markdown, WebC and the
+rest.
+
+## Answering from your content
+
+Asyntai reads your published pages. Add your site URL in the dashboard, and the
+assistant answers from the same pages the widget sits on. You can also add extra
+documents and question and answer pairs.
+
+## Removing it
+
+Delete the `addPlugin` line and build again. The widget is gone.
+
+## Support
+
+Email [hello@asyntai.com](mailto:hello@asyntai.com), or read the
+[Eleventy guide](https://asyntai.com/documentation/integrations/eleventy/).
+
+## Licence
+
+MIT. See [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,44 @@
 {
   "name": "eleventy-plugin-ai-chatbot",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0",
+  "description": "Add the Asyntai AI chat assistant to your Eleventy (11ty) site. It answers visitor questions from your own content, in 80+ languages.",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "files": [
+    "src",
+    "README.md",
+    "LICENSE"
+  ],
+  "keywords": [
+    "eleventy-plugin",
+    "eleventy",
+    "11ty",
+    "chatbot",
+    "ai",
+    "chat",
+    "live-chat",
+    "support",
+    "customer-support",
+    "asyntai"
+  ],
+  "homepage": "https://asyntai.com/documentation/integrations/eleventy/",
+  "bugs": {
+    "url": "https://github.com/asyntai/eleventy-plugin-ai-chatbot/issues",
+    "email": "hello@asyntai.com"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/asyntai/eleventy-plugin-ai-chatbot.git"
+  },
+  "author": "Asyntai <hello@asyntai.com> (https://asyntai.com)",
+  "license": "MIT",
+  "engines": {
+    "node": ">=18.0"
+  },
+  "scripts": {
+    "test": "node tests/test_plugin.js"
+  },
+  "11ty": {
+    "compatibility": ">=1.0"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,19 @@
+export interface AsyntaiOptions {
+  /** Your Asyntai widget ID, for example `asyntai_1a2b3c4d5e6f`. Required. */
+  widgetId: string;
+  /** Set to false to keep the widget off the site during `eleventy --serve`. */
+  enableInDevelopment?: boolean;
+  /** Advanced. Load the widget script from another URL. */
+  scriptUrl?: string;
+}
+
+declare function eleventyPluginAiChatbot(eleventyConfig: any, options: AsyntaiOptions): void;
+
+declare namespace eleventyPluginAiChatbot {
+  function validateOptions(options: AsyntaiOptions): Required<AsyntaiOptions>;
+  function buildLoader(widgetId: string, scriptUrl: string): string;
+  function injectIntoHtml(html: string, tag: string): string;
+  const DEFAULT_SCRIPT_URL: string;
+}
+
+export = eleventyPluginAiChatbot;

package/src/index.js

@@ -0,0 +1,134 @@
+/**
+ * Asyntai AI chatbot for Eleventy (11ty).
+ *
+ * Adds the Asyntai chat widget to every HTML page the site builds. Eleventy has
+ * no API for scripts, so the plugin is an HTML transform: it puts the ordinary
+ * embed loader just before </body> and changes nothing else about the page.
+ *
+ * CommonJS on purpose: Eleventy 1 and 2 load plugins with require(), and
+ * Eleventy 3 loads CommonJS plugins as well.
+ */
+
+const DEFAULT_SCRIPT_URL = 'https://widget.asyntai.com/static/js/chat-widget.js';
+const WIDGET_ID_PATTERN = /^asyntai_[A-Za-z0-9]+$/;
+const NAME = 'eleventy-plugin-ai-chatbot';
+
+/**
+ * Eleventy runs the plugin before it builds anything, so a wrong option stops
+ * the build with a clear message instead of producing a site with no chat.
+ */
+function validateOptions(options) {
+  const opts = options || {};
+  const widgetId = typeof opts.widgetId === 'string' ? opts.widgetId.trim() : '';
+
+  if (!widgetId) {
+    throw new Error(
+      NAME +
+        ': "widgetId" is required. Copy it from the Install page of your ' +
+        'Asyntai dashboard, for example asyntai_1a2b3c4d5e6f.',
+    );
+  }
+  if (!WIDGET_ID_PATTERN.test(widgetId)) {
+    throw new Error(
+      NAME +
+        ': "' +
+        widgetId +
+        '" does not look like a widget ID. It starts with asyntai_, for ' +
+        'example asyntai_1a2b3c4d5e6f.',
+    );
+  }
+
+  const scriptUrl =
+    typeof opts.scriptUrl === 'string' && opts.scriptUrl.trim()
+      ? opts.scriptUrl.trim()
+      : DEFAULT_SCRIPT_URL;
+
+  return {
+    widgetId,
+    scriptUrl,
+    // Set to false to keep the widget off the site during `eleventy --serve`.
+    enableInDevelopment: opts.enableInDevelopment !== false,
+  };
+}
+
+/** JSON.stringify, safe inside an HTML <script> element. */
+function jsString(value) {
+  return JSON.stringify(value).replace(/</g, '\\u003c');
+}
+
+/**
+ * The loader waits for the page's load event before it fetches the widget.
+ * An ordinary `<script async src>` holds the load event open until its own
+ * fetch finishes, so an unreachable server would delay the host page. This
+ * pattern cannot.
+ */
+function buildLoader(widgetId, scriptUrl) {
+  return (
+    '(function(){var l=function(){' +
+    'if(document.querySelector("script[data-asyntai-id]"))return;' +
+    'var s=document.createElement("script");' +
+    's.src=' +
+    jsString(scriptUrl) +
+    ';s.async=true;' +
+    's.setAttribute("data-asyntai-id",' +
+    jsString(widgetId) +
+    ');' +
+    'document.head.appendChild(s)};' +
+    'if(document.readyState==="complete"){l()}' +
+    'else{window.addEventListener("load",l)}})();'
+  );
+}
+
+/**
+ * Puts the tag before the last </body>, or before </html> when the page has no
+ * body tag. A fragment with neither is left alone: it is not a whole page.
+ * A page that already carries an Asyntai snippet is left alone too.
+ */
+function injectIntoHtml(html, tag) {
+  if (typeof html !== 'string' || html.includes('data-asyntai-id')) {
+    return html;
+  }
+  const lower = html.toLowerCase();
+  let at = lower.lastIndexOf('</body>');
+  if (at === -1) {
+    at = lower.lastIndexOf('</html>');
+  }
+  if (at === -1) {
+    return html;
+  }
+  return html.slice(0, at) + tag + html.slice(at);
+}
+
+function isDevelopment() {
+  const mode = process.env.ELEVENTY_RUN_MODE;
+  return mode === 'serve' || mode === 'watch';
+}
+
+function eleventyPluginAiChatbot(eleventyConfig, options) {
+  const settings = validateOptions(options);
+  const tag =
+    '<script data-asyntai-loader>' +
+    buildLoader(settings.widgetId, settings.scriptUrl) +
+    '</script>';
+
+  eleventyConfig.addTransform('asyntai-ai-chatbot', function (content, legacyOutputPath) {
+    if (!settings.enableInDevelopment && isDevelopment()) {
+      return content;
+    }
+    // Eleventy 3 has this.page.outputPath; Eleventy 1 passes it as an argument.
+    const outputPath =
+      (this && this.page && this.page.outputPath) ||
+      (this && this.outputPath) ||
+      legacyOutputPath;
+    if (typeof outputPath !== 'string' || !outputPath.toLowerCase().endsWith('.html')) {
+      return content;
+    }
+    return injectIntoHtml(content, tag);
+  });
+}
+
+module.exports = eleventyPluginAiChatbot;
+module.exports.validateOptions = validateOptions;
+module.exports.buildLoader = buildLoader;
+module.exports.injectIntoHtml = injectIntoHtml;
+module.exports.DEFAULT_SCRIPT_URL = DEFAULT_SCRIPT_URL;