@eeacms/volto-eea-map 1.0.2 → 2.0.1

package/CHANGELOG.md

@@ -4,7 +4,32 @@ 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.2](https://github.com/eea/volto-eea-map/compare/1.0.1...1.0.2) - 20 July 2023
+### [2.0.1](https://github.com/eea/volto-eea-map/compare/2.0.0...2.0.1) - 8 August 2023
+
+#### :bug: Bug Fixes
+
+- fix: data querys ok on remove too && memos [andreiggr - [`4a27e10`](https://github.com/eea/volto-eea-map/commit/4a27e10b3407734add7db0b09326aa16968b0c2a)]
+- fix: another better way to autoupdate mutliple blocks [andreiggr - [`1b592c5`](https://github.com/eea/volto-eea-map/commit/1b592c58abf34b8c5a0d7c5044c50726f90b4496)]
+
+#### :house: Internal changes
+
+- chore: Move deepUpdateDataQueryParams to Schema -refs #254131 [dana-cfc4 - [`5f683de`](https://github.com/eea/volto-eea-map/commit/5f683deb2e91a721834616592f8bb3b9ee3379e0)]
+
+#### :house: Documentation changes
+
+- docs: Cleanup Makefile, update DEVELOP documentation, i18n - refs #254894 [valentinab25 - [`e3d1060`](https://github.com/eea/volto-eea-map/commit/e3d10606574c006e4ed3e5f2b2134e8f80913ff3)]
+
+## [2.0.0](https://github.com/eea/volto-eea-map/compare/1.0.2...2.0.0) - 25 July 2023
+
+#### :nail_care: Enhancements
+
+- refactor: remove countup - refs #254634 [dobri1408 - [`7763f61`](https://github.com/eea/volto-eea-map/commit/7763f612221210283c9c5dc3e15ede991c78f393)]
+
+#### :hammer_and_wrench: Others
+
+- Release 2.0.0 [Alin Voinea - [`7be280d`](https://github.com/eea/volto-eea-map/commit/7be280d4809186e663f422687aca3c33dd732904)]
+- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`ba6ed22`](https://github.com/eea/volto-eea-map/commit/ba6ed22118406db979457384d4739cced2096137)]
+### [1.0.2](https://github.com/eea/volto-eea-map/compare/1.0.1...1.0.2) - 21 July 2023
 
 #### :hammer_and_wrench: Others
 

package/DEVELOP.md

@@ -2,6 +2,28 @@
 
 ## Develop
 
+1. Make sure you have `docker` and `docker compose` installed and running on your machine:
+
+    ```Bash
+    git clone https://github.com/eea/volto-eea-map.git
+    cd volto-eea-map
+    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.  Happy hacking!
+
+    ```Bash
+    cd src/addons/volto-eea-map/
+    ```
+
+### Or add @eeacms/volto-eea-map 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`
@@ -49,3 +71,37 @@ Before starting make sure your development environment is properly set. See [Vol
 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-eea-map` to `mrs.developer.json`
+
+Go to:
+
+  ```BASH
+  cd src/addons/volto-eea-map/
+  ```
+
+Start:
+
+  ```Bash
+  make
+  make start
+  ```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-eea-map` block installed.
+
+Open Cypress Interface:
+
+  ```Bash
+  make cypress-open
+  ```
+
+Or run it:
+
+  ```Bash
+  make cypress-run
+  ```

package/README.md

@@ -1,4 +1,4 @@
-# volto-addon-template
+# volto-eea-map
 
 [![Releases](https://img.shields.io/github/v/release/eea/volto-eea-map)](https://github.com/eea/volto-eea-map/releases)
 
@@ -17,71 +17,77 @@
 
 [Volto](https://github.com/plone/volto) add-on
 
-# volto-eea-map
-
-Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
+## Features
 
-1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
+Demo GIF
 
-        npm install -g yo @plone/generator-volto mrs-developer
+## Getting started
 
-1.  Create new volto app
+### Try volto-eea-map with Docker
 
-        yo @plone/volto my-volto-project --addon @eeacms/volto-eea-map --skip-install
-        cd my-volto-project
+      git clone https://github.com/eea/volto-eea-map.git
+      cd volto-eea-map
+      make
+      make start
 
-1.  Add the following to `mrs.developer.json`:
+Go to http://localhost:3000
 
-        {
-            "volto-eea-map": {
-                "url": "https://github.com/eea/volto-eea-map.git",
-                "package": "@eeacms/volto-eea-map",
-                "branch": "develop",
-                "path": "src"
-            }
-        }
+### Add volto-eea-map to your Volto project
 
-1.  Install
+1. Make sure you have a [Plone backend](https://plone.org/download) up-and-running at http://localhost:8080/Plone
 
-        yarn develop
-        yarn
+   ```Bash
+   docker compose up backend
+   ```
 
-1.  Start backend
+1. Start Volto frontend
 
-        docker pull plone
-        docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone
+* If you already have a volto project, just update `package.json`:
 
-    ...wait for backend to setup and start - `Ready to handle requests`:
+   ```JSON
+   "addons": [
+       "@eeacms/volto-eea-map"
+   ],
 
-        docker logs -f plone
+   "dependencies": {
+       "@eeacms/volto-eea-map": "*"
+   }
+   ```
 
-    ...you can also check http://localhost:8080/Plone
+* If not, create one:
 
-1.  Start frontend
+   ```
+   npm install -g yo @plone/generator-volto
+   yo @plone/volto my-volto-project --canary --addon @eeacms/volto-eea-map
+   cd my-volto-project
+   ```
 
-        yarn start
+1. Install new add-ons and restart Volto:
 
-1.  Go to http://localhost:3000
+   ```
+   yarn
+   yarn start
+   ```
 
-1.  Happy hacking!
+1. Go to http://localhost:3000
 
-        cd src/addons/volto-eea-map/
+1. Happy editing!
 
-# Configuration
+## Release
 
-This addon contains the EEA Embed Map Block & EEA Map Block. It's configured to work with the map visualization content type and give more access to ArcGIS maps. See available maps here https://discomap.eea.europa.eu/ 
+See [RELEASE.md](https://github.com/eea/volto-eea-map/blob/master/RELEASE.md).
 
-# Enable data queries auto-import 
+## How to contribute
 
-To enable automatic import of queries from the content-type, "Parameters for data connections" should be checked as behavior on the content-type that uses the map. 
+See [DEVELOP.md](https://github.com/eea/volto-eea-map/blob/master/DEVELOP.md).
 
-    controlpanel/dexterity-types/{content-type-id}
-# Enable Sources
+## Copyright and license
 
-Sources (Data provenance) should be set on the visualization. To enable this, "EEA Core Metadata" should be  checked as behavior on the  visualization content-type. 
+The Initial Owner of the Original Code is European Environment Agency (EEA).
+All Rights Reserved.
 
-    controlpanel/dexterity-types/map_visualization
-    
-After this, sources can be added from the visualization edit interface. "Data Provenance" tab => "Add source"
+See [LICENSE.md](https://github.com/eea/volto-eea-map/blob/master/LICENSE.md) for details.
 
+## Funding
 
+[European Environment Agency (EU)](http://eea.europa.eu)

package/docker-compose.yml

@@ -0,0 +1,28 @@
+version: "3"
+services:
+  backend:
+    image: plone/plone-backend:${PLONE_VERSION:-6}
+    ports:
+      - "8080:8080"
+    environment:
+      SITE: "Plone"
+
+  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:
+      RAZZLE_INTERNAL_API_PATH: "http://backend:8080/Plone"
+      RAZZLE_DEV_PROXY_API_PATH: "http://backend:8080/Plone"
+      HOST: "0.0.0.0"

package/locales/de/LC_MESSAGES/volto.po

@@ -0,0 +1,14 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+

package/locales/it/LC_MESSAGES/volto.po

@@ -0,0 +1,14 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+

package/locales/ro/LC_MESSAGES/volto.po

@@ -0,0 +1,14 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: \n"
+"Report-Msgid-Bugs-To: \n"
+"POT-Creation-Date: \n"
+"PO-Revision-Date: \n"
+"Last-Translator: \n"
+"Language: \n"
+"Language-Team: \n"
+"Content-Type: \n"
+"Content-Transfer-Encoding: \n"
+"Plural-Forms: \n"
+
+

package/locales/volto.pot

@@ -0,0 +1,16 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: Plone\n"
+"POT-Creation-Date: 2023-06-28T10:48:22.678Z\n"
+"Last-Translator: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
+"Language-Team: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Language-Code: en\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8\n"
+"Domain: volto\n"
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-map",
-  "version": "1.0.2",
+  "version": "2.0.1",
   "description": "@eeacms/volto-eea-map: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -38,9 +38,6 @@
     "cypress-fail-fast": "^5.0.1",
     "md5": "^2.3.0"
   },
-  "resolutions": {
-    "react-countup/countup.js": "2.5.0"
-  },
   "scripts": {
     "release": "release-it",
     "bootstrap": "npm install -g ejs; npm link ejs; node bootstrap",

package/src/components/Blocks/EmbedEEAMap/Edit.jsx

@@ -9,72 +9,22 @@ import Webmap from '@eeacms/volto-eea-map/components/Webmap';
 import ExtraViews from '@eeacms/volto-eea-map/components/ExtraViews';
 
 import { Schema } from './Schema';
-import {
-  applyQueriesToMapLayers,
-  updateBlockQueryFromPageQuery,
-} from '@eeacms/volto-eea-map/utils';
+import { applyQueriesToMapLayers } from '@eeacms/volto-eea-map/utils';
 
 import { getVisualization } from '@eeacms/volto-eea-map/actions';
 
 const Edit = (props) => {
-  const { block, data, onChangeBlock, selected, data_provenance = {} } = props;
-  const { height = '' } = data;
+  const { block, onChangeBlock, selected, data_provenance = {} } = props;
   const schema = Schema(props);
   const [mapData, setMapData] = React.useState('');
-
-  React.useEffect(() => {
-    if (!Object.hasOwn(data, 'show_legend')) {
-      onChangeBlock(block, {
-        ...data,
-        show_legend: true,
-      });
-    }
-    if (!Object.hasOwn(data, 'show_sources')) {
-      onChangeBlock(block, {
-        ...data,
-        show_sources: true,
-      });
-    }
-    if (!Object.hasOwn(data, 'dataprotection')) {
-      onChangeBlock(block, {
-        ...data,
-        dataprotection: { enabled: true },
-      });
-    }
-    //      eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [data.show_legend, data.show_sources, data.dataprotection]);
+  const data = React.useMemo(() => props.data, [props.data]);
+  const { height = '' } = data;
 
   React.useEffect(() => {
     props.getVisualization(props.data.vis_url);
     // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [props.data.vis_url]);
 
-  React.useEffect(() => {
-    if (props.data_query) {
-      //if block data_query_params do not exist, init them
-      if (!props?.data?.data_query_params) {
-        onChangeBlock(block, {
-          ...props.data,
-          data_query_params: [...props.data_query],
-        });
-      }
-
-      //if block data_query_params exist, deep check them then change them in block data
-      if (props?.data_query && data?.data_query_params) {
-        const newDataQuery = updateBlockQueryFromPageQuery(
-          props?.data_query,
-          data?.data_query_params,
-        );
-
-        onChangeBlock(block, {
-          ...data,
-          data_query_params: [...newDataQuery],
-        });
-      }
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [props.data_query]);
-
   React.useEffect(() => {
     const updatedMapData = applyQueriesToMapLayers(
       props.map_visualization,
@@ -84,11 +34,7 @@ const Edit = (props) => {
     setMapData(updatedMapData);
 
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [
-    props.map_visualization,
-    props.data.data_query_params,
-    props.data.enable_queries,
-  ]);
+  }, [props.map_visualization, props.data]);
 
   return (
     <>

package/src/components/Blocks/EmbedEEAMap/Schema.js

@@ -1,3 +1,6 @@
+import React from 'react';
+import { deepUpdateDataQueryParams } from './helpers';
+
 const ProtectionSchema = () => ({
   title: 'Data Protection',
 
@@ -64,6 +67,12 @@ const ProtectionSchema = () => ({
 });
 
 export const Schema = (props) => {
+  const { block, onChangeBlock } = props;
+
+  const dataQuery = React.useMemo(() => props.data_query, [props.data_query]);
+  const data = React.useMemo(() => props.data, [props.data]);
+
+  deepUpdateDataQueryParams(block, data, dataQuery, onChangeBlock);
   return {
     title: 'Embed EEA Map Block',
     fieldsets: [
@@ -102,10 +111,12 @@ export const Schema = (props) => {
         title: 'Show sources',
         description: 'Will show sources set in this page Data provenance',
         type: 'boolean',
+        defaultValue: true,
       },
       show_legend: {
         title: 'Show legend',
         type: 'boolean',
+        defaultValue: true,
       },
       show_viewer: {
         title: 'Show API link',
@@ -127,6 +138,7 @@ export const Schema = (props) => {
       dataprotection: {
         widget: 'object',
         schema: ProtectionSchema(),
+        default: { enabled: true },
       },
     },
     required: [],

package/src/components/Blocks/EmbedEEAMap/helpers.js

@@ -0,0 +1,30 @@
+import { updateBlockQueryFromPageQuery } from '@eeacms/volto-eea-map/utils';
+
+const deepUpdateDataQueryParams = (block, data, data_query, onChangeBlock) => {
+  // If block data_query_params do not exist, init them
+  if (!data?.data_query_params) {
+    onChangeBlock(block, {
+      ...data,
+      data_query_params: [...data_query],
+    });
+  }
+
+  // If block data_query_params exist, deep check them then change them in block data
+  if (data_query && data?.data_query_params) {
+    const newDataQuery = updateBlockQueryFromPageQuery(
+      data_query,
+      data?.data_query_params,
+    );
+
+    if (
+      JSON.stringify(newDataQuery) !== JSON.stringify(data.data_query_params)
+    ) {
+      onChangeBlock(block, {
+        ...data,
+        data_query_params: [...newDataQuery],
+      });
+    }
+  }
+};
+
+export { deepUpdateDataQueryParams };

package/.i18n.babel.config.js

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