@eeacms/volto-eea-chatbot 1.0.9

package/DEVELOP.md

@@ -0,0 +1,124 @@
+# volto-addon-template
+
+## 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 checkout -b bugfix-123456 develop
+   make
+   make start
+   ```
+
+1. Wait for `Volto started at 0.0.0.0:3000` meesage
+
+1. Go to http://localhost:3000
+
+1. Initialize git hooks
+
+   ```Bash
+   yarn prepare
+   ```
+
+1. Happy hacking!
+
+### Or add @eeacms/volto-addon-template 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/)
+
+1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
+
+        npm install -g yo @plone/generator-volto mrs-developer
+
+1.  Create new volto app
+
+        yo @plone/volto my-volto-project --addon @eeacms/volto-addon-template --skip-install
+        cd my-volto-project
+
+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",
+                "branch": "develop",
+                "path": "src"
+            }
+        }
+
+1.  Install
+
+        make develop
+        yarn
+
+1.  Start backend
+
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
+
+    ...wait for backend to setup and start - `Ready to handle requests`:
+
+    ...you can also check http://localhost:8080/Plone
+
+1.  Start frontend
+
+        yarn start
+
+1.  Go to http://localhost:3000
+
+1.  Happy hacking!
+
+        cd src/addons/volto-addon-template/
+
+## 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`
+
+Go to:
+
+```BASH
+cd src/addons/volto-addon-template/
+```
+
+Start:
+
+```Bash
+make
+make start
+```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-addon-template` block installed.
+
+Open Cypress Interface:
+
+```Bash
+make cypress-open
+```
+
+Or run it:
+
+```Bash
+make cypress-run
+```
+
+## Mock develop environment
+
+The following environment variables are used in the develop environment:
+
+```Bash
+MOCK_INDEX=1
+MOCK_LLM_CALL=true
+MOCK_STREAM_DELAY=1
+```
+
+You can also dump the Halloumi response by setting:
+
+```Bash
+DUMP_HALLOUMI_RESPONSE=1
+```
+
+This is kind of exclusive, you don't want to dump if you're mocking the LLM call.

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2020 European Environment Agency
+
+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

@@ -0,0 +1,170 @@
+# Volto Chatbot
+
+[![Releases](https://img.shields.io/github/v/release/eea/volto-eea-chatbot)](https://github.com/eea/volto-eea-chatbot/releases)
+
+[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-eea-chatbot%2Fmaster&subject=master)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-eea-chatbot/job/master/display/redirect)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-master&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-master)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-master&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-master)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-master&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-master)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-master&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-master)
+
+[![Pipeline](https://ci.eionet.europa.eu/buildStatus/icon?job=volto-addons%2Fvolto-eea-chatbot%2Fdevelop&subject=develop)](https://ci.eionet.europa.eu/view/Github/job/volto-addons/job/volto-eea-chatbot/job/develop/display/redirect)
+[![Lines of Code](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-develop&metric=ncloc)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-develop)
+[![Coverage](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-develop&metric=coverage)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-develop)
+[![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-develop)
+[![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-eea-chatbot-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-eea-chatbot-develop)
+
+[Volto](https://github.com/plone/volto) add-on that integrates an AI-powered chatbot with a customizable interface and advanced settings to tailor its behavior and enhance user interactions.
+
+## Upgrade
+
+**1.0.0 (Breaking)** - This release introduces breaking changes to the chatbot configuration and API endpoints, making it compatible with Onyx v2.
+
+## Features
+
+https://github.com/user-attachments/assets/f9b5f813-672f-4e4d-81d0-bf2aec35b587
+
+The **Volto Chatbot** block allows the integration of an AI-powered chatbot into your Volto project. It offers a customizable interface and advanced settings to tailor the chatbot's behavior to your needs. Below is an overview of its features and configuration options.
+
+---
+
+## Functionalities
+
+| **Property**                 | **Description**                                                                 | **Type** | **Default**                      |
+| ---------------------------- | ------------------------------------------------------------------------------- | -------- | -------------------------------- |
+| `assistant`                  | Choose from the list of available assistants configured in the application.     | Dropdown | -                                |
+| `qgenAsistantId`             | Select an assistant for generating related questions.                           | Dropdown | -                                |
+| `enableQgen`                 | Toggle the generation of related questions.                                     | Boolean  | `false`                          |
+| `enableFeedback`             | Enable or disable thumbs up/down feedback for assistant responses.              | Boolean  | `true`                           |
+| `enableMatomoTracking`       | Enable tracking of user interactions via Matomo Analytics.                      | Boolean  | `true`                           |
+| `enableShowTotalFailMessage` | Show total failure message.                                                     | Boolean  | `false`                          |
+| `showAssistantTitle`         | Display or hide the assistant's title in the chat interface.                    | Boolean  | `true`                           |
+| `showAssistantDescription`   | Display or hide the assistant's description in the chat interface.              | Boolean  | `true`                           |
+| `qualityCheck`               | Show Halloumi-based automated quality check.                                    | Dropdown | `Disabled`                       |
+| `onDemandInputToggle`        | Sets the default state of the fact-check AI toggle.                             | Boolean  | `true`                           |
+| `showTools`                  | Show or hide tools in the chat interface.                                       | Array    | `["internal_search_tool_start"]` |
+| `scrollToInput`              | Automatically scroll the page to focus on the chat input when interacting.      | Boolean  | `false`                          |
+| `showAssistantPrompts`       | Show or hide predefined prompts provided by the assistant.                      | Boolean  | `true`                           |
+| `enableStarterPrompts`       | Define custom prompts to initiate a chat with the assistant.                    | Boolean  | `false`                          |
+| `starterPromptsHeading`      | Heading shown above the prompts.                                                | String   | -                                |
+| `starterPromptsPosition`     | Prompts position.                                                               | Dropdown | `Top`                            |
+| `placeholderPrompt`          | Set placeholder text for the chat input field.                                  | String   | `Ask a question`                 |
+| `chatTitle`                  | Title assigned to saved chats, visible only in Onyx or analytics.               | String   | `Online public chat`             |
+| `height`                     | Set the height of the chat window using CSS dimensions (e.g., `500px`, `70vh`). | String   | -                                |
+
+---
+
+## Getting started
+
+### Try volto-eea-chatbot with Docker
+
+```
+git clone https://github.com/eea/volto-eea-chatbot.git
+cd volto-eea-chatbot
+make
+make start
+```
+
+Go to http://localhost:3000
+
+### 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
+
+   ```Bash
+   docker compose up backend
+   ```
+
+1. Start Volto frontend
+
+- If you already have a volto project, just update `package.json`:
+
+  ```JSON
+  "addons": [
+      "@eeacms/volto-eea-chatbot"
+  ],
+
+  "dependencies": {
+      "@eeacms/volto-eea-chatbot": "*"
+  }
+  ```
+
+- If not, create one:
+
+  ```
+  npm install -g yo @plone/generator-volto
+  yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-chatbot
+  cd my-volto-project
+  ```
+
+1. Install new add-ons and restart Volto:
+
+   ```
+   yarn
+   yarn start
+   ```
+
+## Environment Configuration
+
+To properly configure the middleware and authenticate with the Onyx service, ensure that the following environment variables are set:
+
+This document lists the environment variables used in the Volto Chatbot project.
+
+- `ONYX_URL`
+  The base URL for the Onyx service. Used for API calls to Onyx.
+
+- `ONYX_API_KEY`
+  The API key for authenticating with the Onyx service. This is the recommended authentication method.
+
+- `JEST_USE_SETUP`
+  Used in Jest configuration. When set to 'ON', it enables a specific Jest setup.
+
+- `LLMGW_URL`
+  The URL for the LLM Gateway service.
+
+- `LLMGW_TOKEN`
+  The token for authenticating with the LLM Gateway service.
+
+### Development-specific environment variables
+
+- `MOCK_HALLOUMI_FILE_PATH`
+  When set, this specifies the absolute path to the JSON file containing the mocked Halloumi response. Setting this variable enables mocking of Halloumi API calls.
+
+- `DUMP_HALLOUMI_FILE_PATH`
+  When set, the Halloumi response will be dumped to the specified absolute file path for debugging or to create new mock files.
+
+- `MOCK_LLM_FILE_PATH`
+  When set, this specifies the absolute path to the JSONL file containing the mocked Onyx stream response. Setting this variable enables mocking of Onyx LLM calls.
+
+- `DUMP_LLM_FILE_PATH`
+  When set, the LLM response will be dumped to the specified absolute file path for debugging or to create new mock files.
+
+- `MOCK_STREAM_DELAY`
+  Specifies a delay for mock streaming, used in testing or development.
+
+## Release
+
+See [RELEASE.md](https://github.com/eea/volto-eea-chatbot/blob/master/RELEASE.md).
+
+## How to contribute
+
+See [DEVELOP.md](https://github.com/eea/volto-eea-chatbot/blob/master/DEVELOP.md).
+
+## Copyright and license
+
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+All Rights Reserved.
+
+See [LICENSE.md](https://github.com/eea/volto-eea-chatbot/blob/master/LICENSE.md) for details.
+
+## Funding
+
+[European Environment Agency (EU)](http://eea.europa.eu)
+de is European Environment Agency (EEA).
+All Rights Reserved.
+
+See [LICENSE.md](https://github.com/eea/volto-addon-template/blob/master/LICENSE.md) for details.
+
+## Funding
+
+[European Environment Agency (EU)](http://eea.europa.eu)

package/RELEASE.md

@@ -0,0 +1,74 @@
+## Release
+
+### Automatic release using Jenkins
+
+*  The automatic release is started by creating a [Pull Request](../../compare/master...develop) from `develop` to `master`. The pull request status checks correlated to the branch and PR Jenkins jobs need to be processed successfully. 1 review from a github user with rights is mandatory.
+* It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits.
+* The automatic release is done by [Jenkins](https://ci.eionet.europa.eu). The status of the release job can be seen both in the Readme.md badges and the green check/red cross/yellow circle near the last commit information. If you click on the icon, you will have the list of checks that were run. The `continuous-integration/jenkins/branch` link goes to the Jenkins job execution webpage.
+* Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [js-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/js-release.sh) script. It  uses the `release-it` tool.
+* As long as a PR request is open from develop to master, the PR Jenkins job will automatically re-create the CHANGELOG.md and package.json files to be production-ready.
+* The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0).
+* You can manually change the version in `package.json`.  The new version must not be already present in the tags/releases of the repository, otherwise it will be automatically increased by the script. Any changes to the version will trigger a `CHANGELOG.md` re-generation.
+* Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file.
+
+### Manual release from the develop branch ( beta release )
+
+#### Installation and configuration of release-it
+
+You need to first install the [release-it](https://github.com/release-it/release-it)  client.
+
+   ```
+   npm install -g release-it
+   ```
+
+Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository.
+
+Release-it is a tool that automates 4 important steps in the release process:
+
+1. Version increase in `package.json` ( increased from the current version in `package.json`)
+2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases )
+3. GitHub release on the commit with the changelog and package.json modification on the develop branch
+4. NPM release ( by default it's disabled, but can be enabled in the configuration file )
+
+To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens)
+
+   ```
+   export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX
+   ```
+
+ To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN :
+
+   ```
+   echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc
+   ```
+
+#### Using release-it tool
+
+There are 3 yarn scripts that can be run to do the release
+
+##### yarn release-beta
+
+Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input).
+
+```
+? Select increment (next version):
+❯ prepatch (0.1.1-beta.0)
+  preminor (0.2.0-beta.0)
+  premajor (1.0.0-beta.0)
+  Other, please specify...
+```
+
+##### yarn release-major-beta
+
+Same as `yarn release-beta`, but with premajor version pre-selected.
+
+##### yarn release
+
+Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other.
+
+#### Important notes
+
+> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST.
+
+> Do not keep Pull Requests from develop to master branches open when you are doing beta releases from the develop branch. As long as a PR to master is open, an automatic script will run on every commit and will update both the version and the changelog to a production-ready state - ( MAJOR.MINOR.PATCH mandatory format for version).
+

package/TESTING.md

@@ -0,0 +1,5 @@
+To run tests:
+
+```
+env RAZZLE_JEST_CONFIG=src/addons/volto-eea-chatbot/jest-addon.config.js yarn test src/addons/volto-eea-chatbot/src/
+```

package/babel.config.js

@@ -0,0 +1,17 @@
+module.exports = function (api) {
+  api.cache(true);
+  const presets = ['razzle'];
+  const plugins = [
+    [
+      'react-intl', // React Intl extractor, required for the whole i18n infrastructure to work
+      {
+        messagesDir: './build/messages/',
+      },
+    ],
+  ];
+
+  return {
+    plugins,
+    presets,
+  };
+};

package/bootstrap

@@ -0,0 +1,41 @@
+const path = require('path');
+const fs = require('fs');
+const ejs = require('ejs');
+
+const currentDir = path.basename(process.cwd());
+
+const bootstrap = function (ofile) {
+    fs.readFile(ofile, 'utf8', function (err, data) {
+        if (err) {
+            return console.log(err);
+        }
+        const result = ejs.render(data, {
+            addonName: `@eeacms/${currentDir}`,
+            name: currentDir
+        });
+        const output = ofile.replace('.tpl', '');
+        fs.writeFile(output, result, 'utf8', function (err) {
+            if (err) {
+                return console.log(err);
+            }
+        });
+        if (ofile.includes('.tpl')) {
+            fs.unlink(ofile, (err) => {
+                if (err) {
+                    return console.error(err);
+                }
+            });
+        }
+    });
+}
+
+fs.readdir(".", { withFileTypes: true }, (err, dirents) => {
+    const files = dirents
+        .filter(dirent => dirent.isFile())
+        .map(dirent => dirent.name);
+    files.forEach(function (file) {
+        if (file != 'bootstrap') {
+            bootstrap(file);
+        }
+    });
+});

package/cypress.config.js

@@ -0,0 +1,27 @@
+const { defineConfig } = require('cypress');
+
+module.exports = defineConfig({
+  viewportWidth: 1280,
+  defaultCommandTimeout: 8888,
+  chromeWebSecurity: false,
+  reporter: 'junit',
+  video: false,
+  retries: {
+    runMode: 2,
+    openMode: 0,
+  },
+  reporterOptions: {
+    mochaFile: 'cypress/reports/cypress-[hash].xml',
+    jenkinsMode: true,
+    toConsole: true,
+  },
+  e2e: {
+    setupNodeEvents(on, config) {
+      // e2e testing node events setup code
+      require('@cypress/code-coverage/task')(on, config);
+      require('cypress-fail-fast/plugin')(on, config);
+      return config;
+    },
+    baseUrl: 'http://localhost:3000',
+  },
+});

package/docker-compose.yml

@@ -0,0 +1,32 @@
+version: "3"
+services:
+  backend:
+    image: eeacms/plone-backend
+    ports:
+      - "8080:8080"
+    environment:
+      SITE: "Plone"
+      PROFILES: "eea.kitkat:testing"
+
+  frontend: 
+    build:
+      context: ./
+      dockerfile: ./Dockerfile
+      args:
+        ADDON_NAME: "${ADDON_NAME}"
+        ADDON_PATH: "${ADDON_PATH}"
+        VOLTO_VERSION: ${VOLTO_VERSION:-16}
+    ports:
+    - "3000:3000"
+    - "3001:3001"
+    depends_on:
+      - backend
+    volumes:
+      - ./:/app/src/addons/${ADDON_PATH}
+    environment:
+      CI: "true"
+      NODE_ENV: "development"
+      RAZZLE_JEST_CONFIG: "src/addons/${ADDON_PATH}/jest-addon.config.js"
+      RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
+      RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
+      HOST: "0.0.0.0"