@liip/liipgpt 3.14.0-rc.4 → 3.14.0-rc.5

package/README.md

@@ -11,15 +11,15 @@ This package provides the following:
 
 ```html
 <!-- Chat -->
-<script src="https://cdn.example.com/@liip/liipgpt/chat/liipgpt-chat.iife.js"></script>
+<script type="module" src="https://cdn.example.com/@liip/liipgpt/chat/liipgpt-chat.js"></script>
 <liipgpt-chat api-url="https://your-api.example.com/org" lang="en"></liipgpt-chat>
 
 <!-- Button -->
-<script src="https://cdn.example.com/@liip/liipgpt/button/liipgpt-button.iife.js"></script>
+<script type="module" src="https://cdn.example.com/@liip/liipgpt/button/liipgpt-button.js"></script>
 <liipgpt-button api-url="https://your-api.example.com/org" lang="en"></liipgpt-button>
 
 <!-- Search summary -->
-<script src="https://cdn.example.com/@liip/liipgpt/search-summary/liipgpt-search-summary.iife.js"></script>
+<script type="module" src="https://cdn.example.com/@liip/liipgpt/search-summary/liipgpt-search-summary.js"></script>
 <h2 id="ai-overview">AI overview</h2>
 <liipgpt-search-summary
     labelled-by="ai-overview"
@@ -30,33 +30,25 @@ This package provides the following:
 ></liipgpt-search-summary>
 ```
 
-### ESM builds (optional)
+The module build is the recommended one, and the one to reach for unless something below rules it
+out. Only a module can load code on demand, and that is most of what a widget ships: a chat flyout
+that is never opened now downloads about a quarter of what it used to.
 
-Every widget is also published as an ES module next to its IIFE bundle. Same components, same
-attributes — only the module format differs. Drop the `.iife` from the file name and add
-`type="module"`:
+| gzipped, what a browser downloads before any interaction | IIFE     | module               |
+| -------------------------------------------------------- | -------- | -------------------- |
+| chat, flyout never opened                                  | 206.2 kB | **52.4 kB**          |
+| button                                                     | 48.8 kB  | **40.2 kB**          |
+| search summary, styled through host CSS                    | 91.8 kB  | **72.8 kB**          |
 
-```html
-<!-- Chat -->
-<script type="module" src="https://cdn.example.com/@liip/liipgpt/chat/liipgpt-chat.js"></script>
-
-<!-- Button -->
-<script type="module" src="https://cdn.example.com/@liip/liipgpt/button/liipgpt-button.js"></script>
-
-<!-- Search summary -->
-<script type="module" src="https://cdn.example.com/@liip/liipgpt/search-summary/liipgpt-search-summary.js"></script>
-```
-
-Chat and button weigh the same either way. The search summary is smaller as a module: an IIFE cannot
-code-split, so its ChatConfig support had to be inlined, while the module fetches that part only when
-`use-chat-config` is set — an embed styled through host CSS downloads about a quarter less.
+The rest arrives when it is actually needed — the chat panel and engine on first open (prefetched on
+hover, so the click stays instant), a language when it is selected, an embed when the backend sends
+one. Only the language the visitor sees is ever downloaded, not all four.
 
 Importing from npm resolves to the module build as well, so `import "@liip/liipgpt/search-summary"`
 registers the element _and_ gives you the named exports (`LiipGPTSearchSummary`, `PiiChecks`) — with
 the IIFE the namespace came back empty. `require()` still resolves to the IIFE.
 
-The IIFE builds stay supported and unchanged; nothing needs to migrate. Two things to check before
-switching:
+Three things to check:
 
 - **Content-Security-Policy** — a module can load additional files from the host it was served from,
   and that host is `cdn.jsdelivr.net` for both embed variants: the fixed CDN URL points there
@@ -67,9 +59,23 @@ switching:
 - **Pin the version.** Serve the module from a version-pinned URL. With a floating "latest" URL a
   release can land between the entry and its companion files being fetched, and the two no longer
   match.
+- **Serve the whole directory if you self-host.** The entry is no longer the only file: it ships
+  alongside content-hashed companions (`chat-panel-*.js`, `de-*.js`, …) that it fetches at runtime.
+  Copying only `liipgpt-chat.js` to your own server gives you a button that never opens a chat.
+
+### IIFE build (single file)
+
+Every widget is also published as a single-file IIFE bundle, and it stays supported — existing
+embeds do not have to migrate. Drop `type="module"` and add `.iife` to the file name:
+
+```html
+<script src="https://cdn.example.com/@liip/liipgpt/chat/liipgpt-chat.iife.js"></script>
+```
 
-Subresource Integrity covers only the file you name in the tag, so the on-demand files are not
-integrity-checked. Stay on the IIFE build if you rely on SRI.
+It cannot code-split, so it always downloads everything upfront, including all four languages. Use
+it when you need **Subresource Integrity**: SRI covers only the file you name in the tag, so with a
+module the on-demand companions are not integrity-checked, while the IIFE _is_ the whole widget. It
+is also the simpler answer for a site that cannot add `cdn.jsdelivr.net` to its `script-src`.
 
 > **Note:** The standalone `@liip/liipgpt-search-summary` package is superseded by `@liip/liipgpt/search-summary` from this package.