@eeacms/volto-n2k 1.0.33 → 1.0.34

package/.husky/pre-commit

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

package/CHANGELOG.md

@@ -4,11 +4,33 @@ 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).
 
-### [1.0.33](https://github.com/eea/volto-n2k/compare/1.0.32...1.0.33) - 3 July 2023
+### [1.0.34](https://github.com/eea/volto-n2k/compare/1.0.33...1.0.34) - 13 May 2024
+
+#### :bug: Bug Fixes
+
+- fix: fix issue where schemeSpectral was never used due to the always truthy color array [ana-oprea - [`ea4cd65`](https://github.com/eea/volto-n2k/commit/ea4cd65a14719c5c60b899332d7ed289c1a50e5c)]
+- fix(tests): add cypress 13 to devdependencies [ana-oprea - [`a218b28`](https://github.com/eea/volto-n2k/commit/a218b289fdbd0825540527cab4567ee3880a8e44)]
+
+#### :house: Internal changes
+
+- chore: husky, lint-staged use fixed versions [valentinab25 - [`647d621`](https://github.com/eea/volto-n2k/commit/647d621d52400c50f5bc629b3ddc4f2121f14ffa)]
+- chore:volto 16 in tests, update docs, fix stylelint overrides [valentinab25 - [`60d94b6`](https://github.com/eea/volto-n2k/commit/60d94b61ff8826abc57af9616793a1a247f585b5)]
+
+#### :house: Documentation changes
+
+- docs: Cleanup Makefile, update DEVELOP documentation, i18n - refs #254894 [valentinab25 - [`d6d017d`](https://github.com/eea/volto-n2k/commit/d6d017de1409f7319684f1c98d2c017d35631e83)]
 
 #### :hammer_and_wrench: Others
 
-- hide arrows if pictures length <= 1 [Miu Razvan - [`5dfee21`](https://github.com/eea/volto-n2k/commit/5dfee212b039d92c325665eed203c99280fd8155)]
+- use volto-spotlight theme in jenkins [ana-oprea - [`f7ffa9a`](https://github.com/eea/volto-n2k/commit/f7ffa9a8d4621fe4d0e46fd6450791a9f6d5c7e7)]
+- fix sonarqube errors [ana-oprea - [`50a4ff2`](https://github.com/eea/volto-n2k/commit/50a4ff2a03ca964b93443ef98f79684d40e0b768)]
+- try to use volto-spotlight theme in jenkins [Miu Razvan - [`ec0b952`](https://github.com/eea/volto-n2k/commit/ec0b9525b967f907922ae660bd9f520119cd80c1)]
+- remove waitForResourceToLoad [ana-oprea - [`eaded9b`](https://github.com/eea/volto-n2k/commit/eaded9b9ecd1ca2eb78aa8dd65838c063d95db85)]
+- update image size from 300 to 800 px [Claudia Ifrim - [`8d9270a`](https://github.com/eea/volto-n2k/commit/8d9270a09506278ceaea25e8a72abdf5b22fcc78)]
+- test: EN locales, pre-commit fix, feature PRs checks Refs #257193 [valentinab25 - [`4850d6a`](https://github.com/eea/volto-n2k/commit/4850d6a65349fe49dbe9244c30592ae38c9aeaba)]
+- test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`2c91856`](https://github.com/eea/volto-n2k/commit/2c9185688a2fe6b36e5eeb2963f6c8676e3c5628)]
+### [1.0.33](https://github.com/eea/volto-n2k/compare/1.0.32...1.0.33) - 3 July 2023
+
 ### [1.0.32](https://github.com/eea/volto-n2k/compare/1.0.31...1.0.32) - 26 June 2023
 
 #### :hammer_and_wrench: Others
@@ -261,7 +283,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Update [razvanMiu - [`42ab50e`](https://github.com/eea/volto-n2k/commit/42ab50e6681a47251d15ac06b836c6f8c27157fa)]
 - Added bubble chart [razvanMiu - [`89fba5e`](https://github.com/eea/volto-n2k/commit/89fba5e5db41aa955ba2d0ed58c9f0042c461504)]
 - Group species by id_eunis in species list [razvanMiu - [`543c957`](https://github.com/eea/volto-n2k/commit/543c9573b53acd8eecc9afbb6ae7beeddba53966)]
-- Add Sonarqube tag using frontend addons list [EEA Jenkins - [`2ca3e4c`](https://github.com/eea/volto-n2k/commit/2ca3e4c092211f92339791d71db81f5b4ca2d562)]
 - update maps - species and habitats distribution maps [Claudia Ifrim - [`ad12eb1`](https://github.com/eea/volto-n2k/commit/ad12eb141907d6f28444f1eafc3f687735d2a68d)]
 - update format for common name and author [Claudia Ifrim - [`26b7a2f`](https://github.com/eea/volto-n2k/commit/26b7a2f3d20c7701b57fb24f39fc7dfeceec3ce8)]
 - update format for species name (common / scientific) [Claudia Ifrim - [`abdedcf`](https://github.com/eea/volto-n2k/commit/abdedcfe645665031dedf050fd2c5cdde8c14a50)]

package/DEVELOP.md

@@ -2,6 +2,30 @@
 
 ## Develop
 
+1. Make sure you have `docker` and `docker compose` installed and running on your machine:
+
+    ```Bash
+    git clone https://github.com/eea/volto-n2k.git
+    cd volto-n2k
+    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-n2k 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`
@@ -28,18 +52,15 @@ Before starting make sure your development environment is properly set. See [Vol
 
 1.  Install
 
-        $ yarn develop
+        $ make develop
         $ yarn
 
 1.  Start backend
 
-        $ docker pull plone
-        $ docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+        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`:
 
-        $ docker logs -f plone
-
     ...you can also check http://localhost:8080/Plone
 
 1.  Start frontend
@@ -51,3 +72,37 @@ Before starting make sure your development environment is properly set. See [Vol
 1.  Happy hacking!
 
         $ cd src/addons/volto-n2k/
+
+## 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-n2k` to `mrs.developer.json`
+
+Go to:
+
+  ```BASH
+  cd src/addons/volto-n2k/
+  ```
+
+Start:
+
+  ```Bash
+  make
+  make start
+  ```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-n2k` block installed.
+
+Open Cypress Interface:
+
+  ```Bash
+  make cypress-open
+  ```
+
+Or run it:
+
+  ```Bash
+  make cypress-run
+  ```

package/README.md

@@ -14,27 +14,35 @@
 [![Bugs](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-n2k-develop&metric=bugs)](https://sonarqube.eea.europa.eu/dashboard?id=volto-n2k-develop)
 [![Duplicated Lines (%)](https://sonarqube.eea.europa.eu/api/project_badges/measure?project=volto-n2k-develop&metric=duplicated_lines_density)](https://sonarqube.eea.europa.eu/dashboard?id=volto-n2k-develop)
 
+
 [Volto](https://github.com/plone/volto) add-on
 
 ## Features
 
-###
-
 Demo GIF
 
 ## Getting started
 
-1. Create new volto project if you don't already have one:
+### Try volto-n2k with Docker
 
-   ```
-   $ npm install -g yo @plone/generator-volto
-   $ yo @plone/volto my-volto-project --addon @eeacms/volto-n2k
+      git clone https://github.com/eea/volto-n2k.git
+      cd volto-n2k
+      make
+      make start
+
+Go to http://localhost:3000
+
+### Add volto-n2k to your Volto project
+
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
 
-   $ cd my-volto-project
-   $ yarn add -W @eeacms/volto-n2k
+   ```Bash
+   docker compose up backend
    ```
 
-1. If you already have a volto project, just update `package.json`:
+1. Start Volto frontend
+
+* If you already have a volto project, just update `package.json`:
 
    ```JSON
    "addons": [
@@ -42,15 +50,23 @@ Demo GIF
    ],
 
    "dependencies": {
-       "@eeacms/volto-n2k": "^1.0.0"
+       "@eeacms/volto-n2k": "*"
    }
    ```
 
+* If not, create one:
+
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-n2k
+   cd my-volto-project
+   ```
+
 1. Install new add-ons and restart Volto:
 
    ```
-   $ yarn
-   $ yarn start
+   yarn
+   yarn start
    ```
 
 1. Go to http://localhost:3000

package/RELEASE.md

@@ -20,9 +20,9 @@ You need to first install the [release-it](https://github.com/release-it/release
    ```
    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`)
@@ -30,45 +30,45 @@ Release-it is a tool that automates 4 important steps in the release process:
 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) 
+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). 
+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... 
+? 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 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/cypress.config.js

@@ -5,9 +5,9 @@ module.exports = defineConfig({
   defaultCommandTimeout: 8888,
   chromeWebSecurity: false,
   reporter: 'junit',
-  video: true,
+  video: false,
   retries: {
-    runMode: 8,
+    runMode: 2,
     openMode: 0,
   },
   reporterOptions: {

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"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-n2k",
-  "version": "1.0.33",
+  "version": "1.0.34",
   "description": "volto-n2k: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -13,6 +13,7 @@
     "react"
   ],
   "addons": [
+    "@eeacms/volto-spotlight",
     "@eeacms/volto-datablocks",
     "@eeacms/volto-openlayers-map",
     "@eeacms/volto-resize-helper",
@@ -23,6 +24,7 @@
     "url": "git@github.com:eea/volto-n2k.git"
   },
   "dependencies": {
+    "@eeacms/volto-spotlight": "*",
     "@eeacms/volto-datablocks": "*",
     "@eeacms/volto-openlayers-map": "*",
     "@eeacms/volto-resize-helper": "*",
@@ -37,11 +39,35 @@
     "swiper": "9.1.1"
   },
   "devDependencies": {
+    "cypress": "13.1.0",
     "@cypress/code-coverage": "^3.10.0",
     "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "husky": "^8.0.3",
+    "lint-staged": "^14.0.1",
     "md5": "^2.3.0"
   },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx,json}": [
+      "make lint-fix",
+      "make prettier-fix"
+    ],
+    "src/**/*.{jsx}": [
+      "make i18n"
+    ],
+    "theme/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "theme/**/*.overrides": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.overrides": [
+      "make stylelint-fix"
+    ]
+  },
   "scripts": {
     "release": "release-it",
     "release-major-beta": "release-it major --preRelease=beta",
@@ -59,6 +85,7 @@
     "lint:fix": "make lint-fix",
     "i18n": "make i18n",
     "cypress:run": "make cypress-run",
-    "cypress:open": "make cypress-open"
+    "cypress:open": "make cypress-open",
+    "prepare": "husky install"
   }
 }

package/src/components/manage/Blocks/HabitatsBanner/View.jsx

@@ -15,8 +15,8 @@ const SwiperLoader = loadable.lib(() => import('swiper'));
 const SwiperReactLoader = loadable.lib(() => import('swiper/react'));
 
 const getSource = (source) => {
-  let parsedSource = replaceQueryParam(source, 'x', 300);
-  parsedSource = replaceQueryParam(parsedSource, 'y', 300);
+  let parsedSource = replaceQueryParam(source, 'x', 800);
+  parsedSource = replaceQueryParam(parsedSource, 'y', 800);
 
   return parsedSource;
 };

package/src/components/manage/Blocks/SiteHabitatsList/View.jsx

@@ -31,7 +31,7 @@ const View = (props) => {
     <div className="site-habitats-list">
       {Object.keys(habitats)?.length ? (
         Object.keys(habitats)
-          .sort()
+          .sort((a, b) => a.localeCompare(b))
           .map((habitat) => {
             const expanded = expandedHabitats.includes(habitat);
             return (

package/src/components/manage/Blocks/SpeciesBanner/View.jsx

@@ -16,8 +16,8 @@ const SwiperLoader = loadable.lib(() => import('swiper'));
 const SwiperReactLoader = loadable.lib(() => import('swiper/react'));
 
 const getSource = (source) => {
-  let parsedSource = replaceQueryParam(source, 'x', 300);
-  parsedSource = replaceQueryParam(parsedSource, 'y', 300);
+  let parsedSource = replaceQueryParam(source, 'x', 800);
+  parsedSource = replaceQueryParam(parsedSource, 'y', 800);
 
   return parsedSource;
 };

package/src/components/manage/Blocks/StackedBarChart/StackedBars.jsx

@@ -12,7 +12,7 @@ const getSerieData = (serie) => {
 
 function StackedBars(props) {
   const { d3 } = props;
-  const { scaleOrdinal, schemeSpectral, stack } = d3;
+  const { scaleOrdinal, stack } = d3;
   const {
     element,
     height,
@@ -34,12 +34,10 @@ function StackedBars(props) {
       d.forEach((v) => (v.key = d.key));
       return d;
     });
+
   const color = scaleOrdinal()
     .domain(series.map((d) => d.key))
-    .range(
-      ['#70AD47', '#ED7D31', '#FF3F3F', '#AFABAB'] ||
-        schemeSpectral[series.length],
-    )
+    .range(['#70AD47', '#ED7D31', '#FF3F3F', '#AFABAB'])
     .unknown('#ccc');
 
   return (

package/.i18n.babel.config.js

@@ -1 +0,0 @@
-module.exports = require('@plone/volto/babel');