@eeacms/volto-eea-chatbot 1.0.13 → 2.0.0

package/CHANGELOG.md

@@ -4,24 +4,38 @@ All notable changes to this project will be documented in this file. Dates are d
 
 Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
+### [2.0.0](https://github.com/eea/volto-eea-chatbot/compare/1.0.13...2.0.0) - 16 March 2026
+
+#### :rocket: New Features
+
+- feat: Volto 18 support - refs #287700 [Alin Voinea - [`e37ee8e`](https://github.com/eea/volto-eea-chatbot/commit/e37ee8e97e43c6108f336a341f31c4411fb22141)]
+
+#### :bug: Bug Fixes
+
+- fix(withOnyxData): handle API errors gracefully and set proper HTTP status codes [Claudia Ifrim - [`eec4e22`](https://github.com/eea/volto-eea-chatbot/commit/eec4e220649634714165857e5e14a6a444de4f92)]
+
+#### :house: Internal changes
+
+- style: Automated code fix [eea-jenkins - [`0579cad`](https://github.com/eea/volto-eea-chatbot/commit/0579cadfeb3f6f092f4bc66ffacebe59232e8650)]
+
+#### :hammer_and_wrench: Others
+
+- tests: Fix Sonar Qube tags - refs #297339 [Alin Voinea - [`958cd4f`](https://github.com/eea/volto-eea-chatbot/commit/958cd4f97fdd6892aa248083fb13bdf9313727bb)]
 ### [1.0.13](https://github.com/eea/volto-eea-chatbot/compare/1.0.12...1.0.13) - 4 March 2026
 
 #### :house: Internal changes
 
 - style: Automated code fix [eea-jenkins - [`8a8c3c4`](https://github.com/eea/volto-eea-chatbot/commit/8a8c3c4172a4f669661378cf1b5a3569d85609e6)]
-- chore: [JENKINSFILE] add package version in sonarqube [valentinab25 - [`535d986`](https://github.com/eea/volto-eea-chatbot/commit/535d986b7adc77743a668bc4ac63f835eef58df3)]
 
 #### :hammer_and_wrench: Others
 
 - update [Miu Razvan - [`04e6c3f`](https://github.com/eea/volto-eea-chatbot/commit/04e6c3f776bb9920b89a014cc97f8e5dbb284a48)]
 - update [Miu Razvan - [`f9e9beb`](https://github.com/eea/volto-eea-chatbot/commit/f9e9beb0676b215a50226a0db8c5be7c540f26ff)]
-- Forward client ip to onyx/llmgw requests, ref #298095 [Miu Razvan - [`e90a672`](https://github.com/eea/volto-eea-chatbot/commit/e90a672273f2220d2cced4ad53c4b3ed3f295691)]
 ### [1.0.12](https://github.com/eea/volto-eea-chatbot/compare/1.0.11...1.0.12) - 23 February 2026
 
 #### :house: Internal changes
 
 - style: Automated code fix [eea-jenkins - [`fdcd884`](https://github.com/eea/volto-eea-chatbot/commit/fdcd8848fd4c3f990ca5ea021f407487aebd6010)]
-- chore: [JENKINSFILE] use sonarqube branches [EEA Jenkins - [`3d428d7`](https://github.com/eea/volto-eea-chatbot/commit/3d428d72f32c3d05452b0961c76f5db1c416e05c)]
 
 #### :hammer_and_wrench: Others
 

package/DEVELOP.md

@@ -1,12 +1,12 @@
-# volto-addon-template
+# volto-eea-chatbot
 
 ## Develop
 
 1. Make sure you have `docker` and `docker compose` installed and running on your machine:
 
    ```Bash
-   git clone https://github.com/eea/volto-addon-template.git
-   cd volto-addon-template
+   git clone https://github.com/eea/volto-eea-chatbot.git
+   cd volto-eea-chatbot
    git checkout -b bugfix-123456 develop
    make
    make start
@@ -24,64 +24,66 @@
 
 1. Happy hacking!
 
-### Or add @eeacms/volto-addon-template to your Volto project
+### Or add @eeacms/volto-eea-chatbot to your Volto project
 
-Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
+Before starting make sure your development environment is properly set. See the official Plone documentation for [creating a project with Cookieplone](https://6.docs.plone.org/install/create-project-cookieplone.html) and [installing an add-on in development mode in Volto 18 and 19](https://6.docs.plone.org/volto/development/add-ons/install-an-add-on-dev-18.html).
 
-1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
+For new Volto 18+ projects, use Cookieplone. It includes `mrs-developer` by default.
 
-        npm install -g yo @plone/generator-volto mrs-developer
+1.  Create a new Volto project with Cookieplone
 
-1.  Create new volto app
-
-        yo @plone/volto my-volto-project --addon @eeacms/volto-addon-template --skip-install
-        cd my-volto-project
+        uvx cookieplone project
+        cd project-title
 
 1.  Add the following to `mrs.developer.json`:
 
         {
-            "volto-addon-template": {
-                "url": "https://github.com/eea/volto-addon-template.git",
-                "package": "@eeacms/volto-addon-template",
+            "volto-eea-chatbot": {
+                "output": "packages",
+                "url": "https://github.com/eea/volto-eea-chatbot.git",
+                "package": "@eeacms/volto-eea-chatbot",
                 "branch": "develop",
                 "path": "src"
             }
         }
 
-1.  Install
+1.  Add `@eeacms/volto-eea-chatbot` to the `addons` key in your project `package.json`
+
+1.  Install or refresh the project setup
 
-        make develop
-        yarn
+        make install
 
-1.  Start backend
+1.  Start backend in one terminal
 
-        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
+        make backend-start
 
-    ...wait for backend to setup and start - `Ready to handle requests`:
+    ...wait for backend to setup and start, ending with `Ready to handle requests`
 
     ...you can also check http://localhost:8080/Plone
 
-1.  Start frontend
+1.  Start frontend in a second terminal
 
-        yarn start
+        make frontend-start
 
 1.  Go to http://localhost:3000
 
 1.  Happy hacking!
 
-        cd src/addons/volto-addon-template/
+        cd packages/volto-eea-chatbot
+
+For legacy Volto 17 projects, keep using the yarn-based workflow from the Volto 17 documentation.
 
 ## Cypress
 
 To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
 
 You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
-project where you added `volto-addon-template` to `mrs.developer.json`
+project where you added `volto-eea-chatbot` to `mrs.developer.json`
 
 Go to:
 
 ```BASH
-cd src/addons/volto-addon-template/
+cd packages/volto-eea-chatbot/
 ```
 
 Start:
@@ -91,7 +93,7 @@ make
 make start
 ```
 
-This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-addon-template` block installed.
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-eea-chatbot` block installed.
 
 Open Cypress Interface:
 

package/README.md

@@ -67,6 +67,11 @@ make start
 
 Go to http://localhost:3000
 
+`make start` now defaults to Volto 18. To run the same setup against Volto 17, use:
+
+      VOLTO_VERSION=17 make
+      VOLTO_VERSION=17 make start
+
 ### Add volto-eea-chatbot to your Volto project
 
 1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
@@ -89,21 +94,28 @@ Go to http://localhost:3000
   }
   ```
 
-- If not, create one:
+- If not, create one with Cookieplone, as recommended by the official Plone documentation for Volto 18+:
 
   ```
-  npm install -g yo @plone/generator-volto
-  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-chatbot
-  cd my-volto-project
+  uvx cookieplone project
+  cd project-title
   ```
 
-1. Install new add-ons and restart Volto:
+1. Install or update dependencies, then start the project:
 
    ```
-   yarn
-   yarn start
+   make install
    ```
 
+   For a Cookieplone project, start the backend and frontend in separate terminals:
+
+   ```
+   make backend-start
+   make frontend-start
+   ```
+
+   For a legacy Volto 17 project, install the package with `yarn` and restart the frontend as usual.
+
 ## Environment Configuration
 
 To properly configure the middleware and authenticate with the Onyx service, ensure that the following environment variables are set:

package/docker-compose.yml

@@ -15,7 +15,7 @@ services:
       args:
         ADDON_NAME: "${ADDON_NAME}"
         ADDON_PATH: "${ADDON_PATH}"
-        VOLTO_VERSION: ${VOLTO_VERSION:-16}
+        VOLTO_VERSION: ${VOLTO_VERSION:-18-yarn}
     ports:
     - "3000:3000"
     - "3001:3001"

package/jest-addon.config.js

@@ -27,6 +27,20 @@ const addonName =
     ? pathParts[addonsIdx + 1]
     : path.basename(path.dirname(__filename)); // Fallback to folder name
 const addonBasePath = `src/addons/${addonName}/src`;
+const voltoSlatePath = fs.existsSync(
+  path.join(
+    __dirname,
+    '..',
+    '..',
+    '..',
+    'node_modules',
+    '@plone',
+    'volto-slate',
+    'src',
+  ),
+)
+  ? '<rootDir>/node_modules/@plone/volto-slate/src'
+  : '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src';
 
 // --- Performance caches ---
 const fileSearchCache = new Map();
@@ -421,10 +435,8 @@ module.exports = {
     '@eeacms/search/(.*)$': '<rootDir>/src/addons/volto-searchlib/searchlib/$1',
     '@eeacms/search': '<rootDir>/src/addons/volto-searchlib/searchlib',
     '@eeacms/(.*?)/(.*)$': '<rootDir>/node_modules/@eeacms/$1/src/$2',
-    '@plone/volto-slate$':
-      '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src',
-    '@plone/volto-slate/(.*)$':
-      '<rootDir>/node_modules/@plone/volto/packages/volto-slate/src/$1',
+    '@plone/volto-slate$': voltoSlatePath,
+    '@plone/volto-slate/(.*)$': `${voltoSlatePath}/$1`,
     '~/(.*)$': '<rootDir>/src/$1',
     'load-volto-addons':
       '<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-chatbot",
-  "version": "1.0.13",
+  "version": "2.0.0",
   "description": "@eeacms/volto-eea-chatbot: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/ChatBlock/hocs/withOnyxData.jsx

@@ -25,8 +25,12 @@ export default function withOnyxData(callback) {
       React.useEffect(() => {
         async function handler() {
           if (fetcher) {
-            const response = await fetcher;
-            setState({ [name]: response.body });
+            try {
+              const response = await fetcher;
+              setState({ [name]: response.body });
+            } catch (error) {
+              setState({ [`${name}-error`]: error.message, [name]: null });
+            }
           }
         }
         handler();

package/src/ChatBlock/packets/renderers/ImageToolRenderer.tsx

@@ -45,9 +45,9 @@ export const ImageToolRenderer: MessageRenderer<ImageGenerationToolPacket> = ({
               alt={image.revised_prompt}
               className={`image-shape-${image.shape || 'square'}`}
             />
-            {image.revised_prompt && (
+            {image.revised_prompt ? (
               <div className="image-prompt">{image.revised_prompt}</div>
-            )}
+            ) : null}
           </div>
         ))}
       </div>

package/src/ChatBlock/tests/AIMessage.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import { AIMessage } from '../chat/AIMessage';
 

package/src/ChatBlock/tests/BlinkingDot.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import { BlinkingDot } from '../components/BlinkingDot';
 

package/src/ChatBlock/tests/ChatMessage.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import { ChatMessage } from '../chat/ChatMessage';
 

package/src/ChatBlock/tests/Citation.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import { Citation } from '../components/markdown/Citation';
 

package/src/ChatBlock/tests/ClaimModal.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import renderer from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { ClaimModal } from '../components/markdown/ClaimModal';
 
 // Mock semantic-ui-react Modal

package/src/ChatBlock/tests/ClaimSegments.test.jsx

@@ -1,5 +1,5 @@
 import renderer from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { ClaimSegments } from '../components/markdown/ClaimSegments';
 
 // Mock semantic-ui-react

package/src/ChatBlock/tests/CustomToolRenderer.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import renderer, { act } from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { CustomToolRenderer } from '../packets/renderers/CustomToolRenderer';
 import { PacketType } from '../types/streamingModels';
 

package/src/ChatBlock/tests/EmptyState.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import EmptyState from '../components/EmptyState';
 

package/src/ChatBlock/tests/FeedbackModal.test.jsx

@@ -1,5 +1,5 @@
 import { render, screen, fireEvent, act } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import FeedbackModal from '../components/FeedbackModal';
 import * as lib from '../utils';
 

package/src/ChatBlock/tests/FetchToolRenderer.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import renderer, { act } from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { FetchToolRenderer } from '../packets/renderers/FetchToolRenderer';
 import { PacketType } from '../types/streamingModels';
 

package/src/ChatBlock/tests/ImageToolRenderer.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import renderer, { act } from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { ImageToolRenderer } from '../packets/renderers/ImageToolRenderer';
 import { PacketType } from '../types/streamingModels';
 

package/src/ChatBlock/tests/QualityCheckToggle.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import { render, fireEvent } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import QualityCheckToggle from '../components/QualityCheckToggle';
 
 describe('QualityCheckToggle', () => {

package/src/ChatBlock/tests/RelatedQuestions.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import { render, fireEvent } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import RelatedQuestions from '../components/RelatedQuestions';
 
 import { trackEvent } from '@eeacms/volto-matomo/utils';

package/src/ChatBlock/tests/RenderClaimView.test.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import renderer from 'react-test-renderer';
 import { render, screen } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { RenderClaimView } from '../components/markdown/RenderClaimView';
 
 describe('RenderClaimView', () => {

package/src/ChatBlock/tests/SearchToolRenderer.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import renderer, { act } from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { SearchToolRenderer } from '../packets/renderers/SearchToolRenderer';
 import { PacketType } from '../types/streamingModels';
 

package/src/ChatBlock/tests/Source.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import SourceDetails from '../components/Source';
 

package/src/ChatBlock/tests/SourceChip.test.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import renderer, { act } from 'react-test-renderer';
 import { render, fireEvent, screen } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { SourceChip } from '../components/SourceChip';
 
 describe('SourceChip', () => {

package/src/ChatBlock/tests/Spinner.test.jsx

@@ -1,6 +1,6 @@
 import React from 'react';
 import renderer from 'react-test-renderer';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import Spinner from '../components/Spinner';
 
 describe('Spinner', () => {

package/src/ChatBlock/tests/UserActionsToolbar.test.jsx

@@ -3,7 +3,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 import { render, fireEvent, screen } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import UserActionsToolbar from '../components/UserActionsToolbar';
 

package/src/ChatBlock/tests/UserMessage.test.jsx

@@ -2,7 +2,7 @@ import { MemoryRouter } from 'react-router-dom';
 import configureStore from 'redux-mock-store';
 import renderer from 'react-test-renderer';
 
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { Provider } from 'react-intl-redux';
 import { UserMessage } from '../chat/UserMessage';
 

package/src/ChatBlock/tests/WebResultIcon.test.jsx

@@ -1,7 +1,7 @@
 import React from 'react';
 import renderer from 'react-test-renderer';
 import { render, fireEvent, screen } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { WebResultIcon } from '../components/WebResultIcon';
 
 describe('WebResultIcon', () => {

package/src/ChatBlock/tests/index.test.js

@@ -1,4 +1,4 @@
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 
 import installChatBlock from '../index';
 

package/src/ChatBlock/tests/schema.test.js

@@ -1,4 +1,4 @@
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { ChatBlockSchema } from '../schema';
 
 describe('ChatBlockSchema', () => {

package/src/ChatBlock/tests/useDeepCompareMemoize.test.js

@@ -1,5 +1,5 @@
 import { renderHook } from '@testing-library/react-hooks';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import { useDeepCompareMemoize } from '../hooks/useDeepCompareMemoize';
 
 describe('useDeepCompareMemoize', () => {

package/src/ChatBlock/tests/utils.test.jsx

@@ -1,6 +1,6 @@
 import { act } from '@testing-library/react';
 import { renderHook } from '@testing-library/react-hooks';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import {
   EMAIL_REGEX,
   transformEmailsToLinks,

package/src/ChatBlock/tests/withOnyxData.test.jsx

@@ -1,5 +1,5 @@
 import { render, screen, waitFor } from '@testing-library/react';
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 import withOnyxData from '../hocs/withOnyxData';
 
 describe('withOnyxData', () => {

package/src/middleware.js

@@ -240,9 +240,9 @@ export default async function middleware(req, res, next) {
 
   const api_key = process.env.ONYX_API_KEY;
   if (!api_key) {
-    res.send({
-      error: MSG_INVALID_CONFIGURATION,
-    });
+    res.statusCode = 500;
+    res.statusMessage = MSG_INVALID_CONFIGURATION;
+    res.send({ error: MSG_INVALID_CONFIGURATION });
     return;
   }
 
@@ -254,8 +254,10 @@ export default async function middleware(req, res, next) {
     });
   } catch (error) {
     // eslint-disable-next-line
-    console.error(MSG_ERROR_REQUEST, error?.response?.text);
-
-    res.send({ error: `Onyx error: ${error?.response?.text || 'error'}` });
+    const errorMessage = `Onyx error: ${error?.response?.text || 'error'}`;
+    console.error(MSG_ERROR_REQUEST, errorMessage);
+    res.statusCode = 500;
+    res.statusMessage = errorMessage;
+    res.send({ error: errorMessage });
   }
 }