@websolutespa/bom-llm 3.1.2 → 4.0.0-next.6

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @websolutespa/bom-llm
 
+## 4.0.0-next.6
+
+### Patch Changes
+
+- d0f1be7: Generated projects build and run again: externals, peer dependencies and exports.
+
+  - `bom-mixer-image` is loaded by Node, not bundled: the web apps list it in `serverExternalPackages` and leave it out of `transpilePackages`. Turbopack bundled `sharp`'s native addon through it (`non-ecmascript placeable asset`, the image route answered 500). The package has no runtime import of `next` any more (`Response.redirect`, type-only imports), so it loads in plain Node.
+    Projects: in `src/mixer/web/next.config.ts` add `serverExternalPackages: ['@websolutespa/bom-mixer-image']` and filter it out of `transpilePackages`, as the samples do.
+  - The other mixer packages import `next/server` again (no `.js`): they are transpiled by Next. `@websolutespa/test/vitest` inlines `@websolutespa/*` (`server.deps.inline`), so project tests compile them like Next does.
+  - `schema-dts` is a peer dependency (`^2.1.0`) of `bom-mixer-models`, `bom-mixer-ui` and `bom-mixer-hooks`: their published `.d.ts` imported an inlined copy of it, and generated projects failed to type check (`TS2321: Excessive stack depth` in `test-pagination.tsx`).
+  - `bom-mixer-checkout` publishes `./server` again under pnpm: a stray `publishConfig.exports` with a Windows separator replaced the exports map.
+  - `payload-plugin-search` no longer requires `@payloadcms/richtext-slate`: it was a peer used only by its own tests, auto-installed at the newest Payload version, and Payload refused to start on the version mismatch.
+  - `bom create` downloads the samples of its own release tag (falls back to `main` when the tag does not exist) and writes `^<cli version>` for every `@websolutespa` dependency, local packages included, instead of `latest`.
+  - `react-error-boundary ^6.1.6`, `@ariakit/react ^0.4.17`, `rollup-plugin-postcss ^4.0.2` everywhere.
+
 ## 3.1.2
 
 ## 3.1.1

package/README.md

@@ -1,153 +1,159 @@
-# @websolutespa/bom-llm
-
-[![npm version](https://badge.fury.io/js/%40websolutespa%2Fbom-llm.svg)](https://badge.fury.io/js/%40websolutespa%2Fbom-llm)
-
-[![status alpha](https://img.shields.io/badge/status-alpha-red.svg)](https://shields.io/)
-
-LLM module of the [BOM Repository](https://github.com/websolutespa/bom) by [websolute](https://www.websolute.com/).
-
-# Bom LLM Plugin
-
-This plugin automatically adds UI components to manage LLM Chatbot by [websolute](https://www.websolute.com/).
-
-### Requirements:
-
-- You need a personal appKey and apiKey to use this plugin, for more info contact [websolute](https://www.websolute.com/contatti)
-
-## Usage
-
-You can load the script directly via jsDelivr or installing via npm.
-
-### Using jsDelivr
-
-```html
-<script type="module" src="https://cdn.jsdelivr.net/npm/@websolutespa/bom-llm/dist/umd/index.js"></script>
-<link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/@websolutespa/bom-llm/dist/umd/index.css">
-<script>
-  document.addEventListener('DOMContentLoaded', () => {
-    if ('bomLlm' in window) {
-      const searchParams = new URLSearchParams(window.location.search);
-      const options = {
-        appKey: 'MY_APP_KEY',
-        apiKey: 'MY_API_KEY',
-        threadId: searchParams.get('llmThreadId'),
-      };
-      bomLlm(options);
-    }
-  });
-</script>
-```
-
-### Using npm
-
-Install library using npm.
-
-```bash
-npm i @websolutespa/bom-llm --save
-```
-
-Import css from node_modules.
-
-```html
-<link rel="stylesheet" href="node_modules/@websolutespa/bom-llm/dist/umd/index.css">
-```
-
-Import and consume plugin.
-
-```js
-import { bomLlm } from '@websolutespa/bom-llm';
-
-document.addEventListener('DOMContentLoaded', () => {
-  if ('bomLlm' in window) {
-    const searchParams = new URLSearchParams(window.location.search);
-    const options = {
-      appKey: 'MY_APP_KEY',
-      apiKey: 'MY_API_KEY',
-      threadId: searchParams.get('llmThreadId'),
-    };
-    // returned instance
-    const llm = bomLlm(options);
-  }
-});
-```
-
-Using imperatively.
-
-```js
-const options = {
-  appKey: 'MY_APP_KEY',
-  apiKey: 'MY_API_KEY',
-  imperative: true, // hide trigger button
-};
-const llm = bomLlm(options);
-// using open command imperatively
-setTimeout(() => {
-  llm.open();
-}, 4000);
-```
-
-Using embed tag.
-
-```html
-<llm-embed />
-```
-
-### Running test
-
-Add parameter test = true.
-
-```js
-  const searchParams = new URLSearchParams(window.location.search);
-  const options = {
-    appKey: 'MY_APP_KEY',
-    apiKey: 'MY_API_KEY',
-    threadId: searchParams.get('llmThreadId'),
-    test: true,
-  };
-  bomLlm(options);
-```
-
-### Decorate external url
-
-You can decorate every json item from the knowledgeBase customizing its external url.  
-decorateUrl method can be a promise.  
-
-```js
-  const searchParams = new URLSearchParams(window.location.search);
-  const options = {
-    appKey: 'MY_APP_KEY',
-    apiKey: 'MY_API_KEY',
-    threadId: searchParams.get('llmThreadId'),
-    decorateUrl: (item) => {
-      switch (item.type) {
-        case 'event':
-        case 'eventItem':
-          return `https://acme.com/event?id=${item.id}`;
-        default:
-          return;
-      }
-    },
-  };
-  bomLlm(options);
-```
-
-### Handling external actions
-
-You can handle the click event of the generated cta action with the onAction handler.
-
-```js
-  const searchParams = new URLSearchParams(window.location.search);
-  const options = {
-    appKey: 'MY_APP_KEY',
-    apiKey: 'MY_API_KEY',
-    threadId: searchParams.get('llmThreadId'),
-    onAction: (item) => {
-      console.log('onAction', item.id, item.title);
-    },
-  };
-  bomLlm(options);
-```
-
----
-
-##### *this library is for internal usage and not production ready*
+# @websolutespa/bom-llm
+
+[![npm version](https://badge.fury.io/js/%40websolutespa%2Fbom-llm.svg)](https://badge.fury.io/js/%40websolutespa%2Fbom-llm)
+
+[![status alpha](https://img.shields.io/badge/status-alpha-red.svg)](https://shields.io/)
+
+LLM module of the [BOM Repository](https://github.com/websolutespa/bom) by [websolute](https://www.websolute.com/).
+
+# Bom LLM Plugin
+
+This plugin automatically adds UI components to manage LLM Chatbot by [websolute](https://www.websolute.com/).
+
+### Requirements:
+
+- You need a personal appKey and apiKey to use this plugin, for more info contact [websolute](https://www.websolute.com/contatti)
+
+## Usage
+
+You can load the script directly via jsDelivr or installing via npm.
+
+### Using jsDelivr
+
+```html
+<script
+  type="module"
+  src="https://cdn.jsdelivr.net/npm/@websolutespa/bom-llm/dist/umd/index.js"
+></script>
+<link
+  rel="stylesheet"
+  href="https://cdn.jsdelivr.net/npm/@websolutespa/bom-llm/dist/umd/index.css"
+/>
+<script>
+  document.addEventListener('DOMContentLoaded', () => {
+    if ('bomLlm' in window) {
+      const searchParams = new URLSearchParams(window.location.search);
+      const options = {
+        appKey: 'MY_APP_KEY',
+        apiKey: 'MY_API_KEY',
+        threadId: searchParams.get('llmThreadId'),
+      };
+      bomLlm(options);
+    }
+  });
+</script>
+```
+
+### Using npm
+
+Install library using npm.
+
+```bash
+npm i @websolutespa/bom-llm --save
+```
+
+Import css from node_modules.
+
+```html
+<link rel="stylesheet" href="node_modules/@websolutespa/bom-llm/dist/umd/index.css" />
+```
+
+Import and consume plugin.
+
+```js
+import { bomLlm } from '@websolutespa/bom-llm';
+
+document.addEventListener('DOMContentLoaded', () => {
+  if ('bomLlm' in window) {
+    const searchParams = new URLSearchParams(window.location.search);
+    const options = {
+      appKey: 'MY_APP_KEY',
+      apiKey: 'MY_API_KEY',
+      threadId: searchParams.get('llmThreadId'),
+    };
+    // returned instance
+    const llm = bomLlm(options);
+  }
+});
+```
+
+Using imperatively.
+
+```js
+const options = {
+  appKey: 'MY_APP_KEY',
+  apiKey: 'MY_API_KEY',
+  imperative: true, // hide trigger button
+};
+const llm = bomLlm(options);
+// using open command imperatively
+setTimeout(() => {
+  llm.open();
+}, 4000);
+```
+
+Using embed tag.
+
+```html
+<llm-embed />
+```
+
+### Running test
+
+Add parameter test = true.
+
+```js
+const searchParams = new URLSearchParams(window.location.search);
+const options = {
+  appKey: 'MY_APP_KEY',
+  apiKey: 'MY_API_KEY',
+  threadId: searchParams.get('llmThreadId'),
+  test: true,
+};
+bomLlm(options);
+```
+
+### Decorate external url
+
+You can decorate every json item from the knowledgeBase customizing its external url.  
+decorateUrl method can be a promise.
+
+```js
+const searchParams = new URLSearchParams(window.location.search);
+const options = {
+  appKey: 'MY_APP_KEY',
+  apiKey: 'MY_API_KEY',
+  threadId: searchParams.get('llmThreadId'),
+  decorateUrl: (item) => {
+    switch (item.type) {
+      case 'event':
+      case 'eventItem':
+        return `https://acme.com/event?id=${item.id}`;
+      default:
+        return;
+    }
+  },
+};
+bomLlm(options);
+```
+
+### Handling external actions
+
+You can handle the click event of the generated cta action with the onAction handler.
+
+```js
+const searchParams = new URLSearchParams(window.location.search);
+const options = {
+  appKey: 'MY_APP_KEY',
+  apiKey: 'MY_API_KEY',
+  threadId: searchParams.get('llmThreadId'),
+  onAction: (item) => {
+    console.log('onAction', item.id, item.title);
+  },
+};
+bomLlm(options);
+```
+
+---
+
+##### _this library is for internal usage and not production ready_