@eeacms/volto-eea-chatbot 1.0.9

package/.coverage.babel.config.js

@@ -0,0 +1,9 @@
+const defaultBabel = require('@plone/volto/babel');
+
+function applyDefault(api) {
+  const voltoBabel = defaultBabel(api);
+  voltoBabel.plugins.push('istanbul');
+  return voltoBabel;
+}
+
+module.exports = applyDefault;

package/.eslintrc.js

@@ -0,0 +1,68 @@
+const fs = require('fs');
+const path = require('path');
+const projectRootPath = fs.realpathSync(__dirname + '/../../../');
+
+let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
+let configFile;
+if (fs.existsSync(`${projectRootPath}/tsconfig.json`))
+  configFile = `${projectRootPath}/tsconfig.json`;
+else if (fs.existsSync(`${projectRootPath}/jsconfig.json`))
+  configFile = `${projectRootPath}/jsconfig.json`;
+
+if (configFile) {
+  const jsConfig = require(configFile).compilerOptions;
+  const pathsConfig = jsConfig.paths;
+  if (pathsConfig['@plone/volto'])
+    voltoPath = `./${jsConfig.baseUrl}/${pathsConfig['@plone/volto'][0]}`;
+}
+
+const AddonConfigurationRegistry = require(`${voltoPath}/addon-registry.js`);
+const reg = new AddonConfigurationRegistry(projectRootPath);
+
+// Extends ESlint configuration for adding aliases to `src` directories in Volto addons
+const addonAliases = Object.keys(reg.packages).map((o) => [
+  o,
+  reg.packages[o].modulePath,
+]);
+
+const addonExtenders = reg.getEslintExtenders().map((m) => require(m));
+
+const defaultConfig = {
+  extends: `${voltoPath}/.eslintrc`,
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['@plone/volto', '@plone/volto/src'],
+          ['@plone/volto-slate', '@plone/volto/packages/volto-slate/src'],
+          ...addonAliases,
+          ['@package', `${__dirname}/src`],
+          ['@root', `${__dirname}/src`],
+          ['~', `${__dirname}/src`],
+        ],
+        extensions: ['.js', '.jsx', '.ts', '.tsx', '.json'],
+      },
+      'babel-plugin-root-import': {
+        rootPathSuffix: 'src',
+      },
+    },
+  },
+  rules: {
+    'react/jsx-no-target-blank': [
+      'error',
+      {
+        allowReferrer: true,
+      },
+    ],
+    // 'import/no-unresolved': 'off',
+    'no-console': 'off',
+    // 'react-hooks/exhaustive-deps': 'warn',
+  },
+};
+
+const config = addonExtenders.reduce(
+  (acc, extender) => extender.modify(acc),
+  defaultConfig,
+);
+
+module.exports = config;

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+[ -n "$CI" ] && exit 0
+yarn lint-staged

package/.release-it.json

@@ -0,0 +1,17 @@
+{
+  "npm": {
+    "publish": false
+  },
+  "git": {
+    "changelog": "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs",
+    "tagName": "${version}"
+  },
+  "github": {
+    "release": true,
+    "releaseName": "${version}",
+    "releaseNotes": "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs"
+  },
+  "hooks": {
+    "after:bump": "npx auto-changelog --commit-limit false -p"
+  }
+}

package/AGENTS.md

@@ -0,0 +1,89 @@
+# Project Overview: Volto Chatbot
+
+This project is a Volto add-on designed to integrate an AI-powered chatbot
+into a Volto
+(React-based frontend for Plone) project. It provides a customizable
+interface and advanced
+settings to tailor the chatbot's behavior and enhance user interactions. The chatbot
+integrates with the Onyx service for its AI capabilities.
+
+**Key Technologies:**
+
+- **Frontend:** React, Volto (Plone frontend framework)
+- **Backend Integration:** Onyx service
+- **Development Tools:** Node.js, Cypress (E2E testing), Jest (unit testing),
+  ESLint (linting), Prettier (code formatting), Stylelint (CSS linting).
+
+### Integrating into an Existing Volto Project
+
+1.  **Ensure Plone Backend is Running:** Make sure you have a Plone backend up
+    and running, typically at `http://localhost:8080/Plone`. You can start it
+    with Docker:
+
+    ```bash
+    docker compose up backend
+    ```
+
+2.  **Update `package.json`:** In your Volto project's `package.json`,
+    add `@eeacms/volto-eea-chatbot` to the `addons` array
+    and `dependencies`:
+
+    ```json
+    "addons": [
+        "@eeacms/volto-eea-chatbot"
+    ],
+    "dependencies": {
+        "@eeacms/volto-eea-chatbot": "*"
+    }
+    ```
+
+3.  **Install and Start:**
+
+    ```bash
+    yarn install
+    yarn start
+    ```
+
+### Environment Configuration
+
+The project requires specific environment variables for Onyx service
+authentication. Create a `.env` file in your project root with the following content:
+
+```env
+ONYX_URL=https://api.onyx.com
+```
+
+- `ONYX_URL`: The base URL of the Onyx service.
+
+## Development Conventions
+
+The project adheres to several development conventions to maintain code quality
+and consistency.
+
+- **Linting:**
+  - Run ESLint checks: `make lint`
+- Fix ESLint issues automatically: `make lint-fix`
+- **Code Formatting:**
+  - Check code formatting with Prettier: `make prettier`
+  - Fix formatting issues automatically: `make prettier-fix`
+- **Styling (CSS/LESS):**
+  - Run Stylelint checks: `make stylelint`
+  - Fix Stylelint issues automatically: `make stylelint-fix`
+- **Testing:**
+  - Run unit tests (likely Jest): `make test`
+  - Update snapshots for tests: `make test-update`
+  - Run Cypress end-to-end tests in headless mode: `make cypress-run`
+  - Open Cypress test runner: `make cypress-open`
+  - **Specific test file:** To test the addon, run
+    `make addon-test TEST_FILE=src/addons/volto-eea-chatbot/src`. To test a specific file,
+    for example `preprocessing.test.js`, run
+    `make addon-test TEST_FILE=src/addons/volto-eea-chatbot/src/halloumi/preprocessing.test.js`
+- **Pre-commit Hook:** A `pre-commit` hook is configured to automatically run
+  `stylelint:fix`, `prettier:fix`, and `lint:fix` before each commit.
+- **Internationalization:** Generate translation files: `make i18n`
+- **Git Workflow:** When committing changes, always use `git status` to review
+  changes and then `git add <relevant files changed>` to stage specific files,
+  instead of `git add .`.
+
+For more detailed contribution guidelines, refer to `DEVELOP.md`.
+For release procedures, refer to `RELEASE.md`.