@eeacms/volto-embed 9.0.5 → 9.0.6

package/CHANGELOG.md

@@ -4,7 +4,25 @@ 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).
 
-### [9.0.5](https://github.com/eea/volto-embed/compare/9.0.4...9.0.5) - 13 December 2023
+### [9.0.6](https://github.com/eea/volto-embed/compare/9.0.5...9.0.6) - 10 January 2024
+
+#### :rocket: New Features
+
+- feat: filter embed map by data query + add option to give extra parameters [kreafox - [`c2331fb`](https://github.com/eea/volto-embed/commit/c2331fb1f3413c54d365cdbc701b37991e98dfda)]
+
+#### :bug: Bug Fixes
+
+- fix: handle case with multiple values [kreafox - [`ab3bfc4`](https://github.com/eea/volto-embed/commit/ab3bfc4b645671550fec3534ae7e25a6d7274ee5)]
+- fix: missing map on view [kreafox - [`7481650`](https://github.com/eea/volto-embed/commit/748165070f109f2b09039882bb22451c520cbbba)]
+
+#### :hammer_and_wrench: Others
+
+- test: increase coverage [kreafox - [`2d8e43c`](https://github.com/eea/volto-embed/commit/2d8e43cf3988564306b6aa7b885b0ff398043ce0)]
+- test: increase coverage [kreafox - [`1fa9052`](https://github.com/eea/volto-embed/commit/1fa9052a3c015361e3a7eae043c418b696262fbe)]
+- test: increase cypress timeout [kreafox - [`9bb40a5`](https://github.com/eea/volto-embed/commit/9bb40a5df2b29a55edec24a57fcd6e65f270f13c)]
+- test: updates [kreafox - [`5b54d02`](https://github.com/eea/volto-embed/commit/5b54d02c6b6392e25f07ef1e286bdbced999592e)]
+- test: update snapshot [kreafox - [`338f23e`](https://github.com/eea/volto-embed/commit/338f23ee5c6c75ccb6ee2d8d474298553fe3bd53)]
+### [9.0.5](https://github.com/eea/volto-embed/compare/9.0.4...9.0.5) - 14 December 2023
 
 #### :bug: Bug Fixes
 
@@ -57,13 +75,11 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - update [Miu Razvan - [`926beb8`](https://github.com/eea/volto-embed/commit/926beb87d2c44907aebe57369312eea7bf22d656)]
 - update [Miu Razvan - [`da351ae`](https://github.com/eea/volto-embed/commit/da351ae9ffaaef756f7a665618a03fd04cb9b01d)]
 - use volto-datablocks@develop dependency [Miu Razvan - [`b379d84`](https://github.com/eea/volto-embed/commit/b379d8478657dd39dad066181b349cee7ac2531d)]
-- test: [JENKINS] Use java17 for sonarqube scanner [valentinab25 - [`ddf685a`](https://github.com/eea/volto-embed/commit/ddf685a9481d780a1df2e4f991f93676478c3e05)]
 ## [8.0.0](https://github.com/eea/volto-embed/compare/7.0.2...8.0.0) - 17 November 2023
 
 #### :hammer_and_wrench: Others
 
 - tests: add cypress tests [nileshgulia1 - [`e4b2803`](https://github.com/eea/volto-embed/commit/e4b28033114170639787d77976dc13b7f697f704)]
-- test: [JENKINS] Run cypress in started frontend container [valentinab25 - [`83d91d5`](https://github.com/eea/volto-embed/commit/83d91d5716a9ce8ebbbff01a7838711298684be4)]
 - fix error [Claudia Ifrim - [`553f3af`](https://github.com/eea/volto-embed/commit/553f3af004af034c721dcd6b01de55c258a88c49)]
 - bump version [Miu Razvan - [`363694a`](https://github.com/eea/volto-embed/commit/363694ae50cdec941fb53b396b75e9a4554d44fb)]
 ### [7.0.2](https://github.com/eea/volto-embed/compare/7.0.1...7.0.2) - 10 November 2023
@@ -73,7 +89,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :hammer_and_wrench: Others
 
 - add missing less variable [Miu Razvan - [`47683a7`](https://github.com/eea/volto-embed/commit/47683a7816581d117bb88f16e3087864aaa52f5e)]
-- test: [JENKINS] Add cpu limit on cypress docker [valentinab25 - [`ba168e4`](https://github.com/eea/volto-embed/commit/ba168e49554a51a6015a98a77dc0ceab76320218)]
 ## [7.0.0](https://github.com/eea/volto-embed/compare/6.0.1...7.0.0) - 6 November 2023
 
 #### :rocket: New Features
@@ -83,15 +98,12 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 #### :house: Internal changes
 
 - style: Automated code fix [eea-jenkins - [`c34d6f4`](https://github.com/eea/volto-embed/commit/c34d6f47fd33f728d40254a12c05fe385b27f2e9)]
-- chore: [JENKINS] Refactor automated testing [valentinab25 - [`673f3ff`](https://github.com/eea/volto-embed/commit/673f3ff355baa8d3646e4558ff2be00f36b5a45a)]
 - chore: husky, lint-staged use fixed versions [valentinab25 - [`31169f7`](https://github.com/eea/volto-embed/commit/31169f73887837463daee76d63b6516046ad49aa)]
 
 #### :hammer_and_wrench: Others
 
 - update tests [Miu Razvan - [`c906b79`](https://github.com/eea/volto-embed/commit/c906b79149e853f718d924871ce2e633e5e427c8)]
 - update tests [Miu Razvan - [`11625b6`](https://github.com/eea/volto-embed/commit/11625b65846388a846d1bdf7ebb2e1f8bd103c91)]
-- test: [JENKINS] Increase shm-size to cypress docker [valentinab25 - [`5e7a155`](https://github.com/eea/volto-embed/commit/5e7a15505334c9b81f07172116b49eaefc692ebf)]
-- test: [JENKINS] Improve cypress time [valentinab25 - [`eeb6dcb`](https://github.com/eea/volto-embed/commit/eeb6dcb4b0f8af07496450e6e7783932ebe88bf7)]
 - Release 7.0.0 [Alin Voinea - [`cbc5c79`](https://github.com/eea/volto-embed/commit/cbc5c79f1b66daf0d599d9de5a1bc7d137bafed8)]
 - add act in unit tests [Miu Razvan - [`ecf5b2f`](https://github.com/eea/volto-embed/commit/ecf5b2fe553d99ad6a11570d3d34852d557fbe85)]
 - update [Miu Razvan - [`049cc14`](https://github.com/eea/volto-embed/commit/049cc140bb6ffea4eb3f1555e693e9973ef63d0e)]
@@ -114,7 +126,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - test: EN locales, pre-commit fix, feature PRs checks Refs #257193 [valentinab25 - [`dc2de20`](https://github.com/eea/volto-embed/commit/dc2de2084b53043f240ee1efa2588b5037326ed7)]
 - test: Fix package.json scripts to use makefile [Alin Voinea - [`b4ffca2`](https://github.com/eea/volto-embed/commit/b4ffca24bb8cc4ba2007cc1040cc7b55dc7cc779)]
-- test: Fix eslint and yarn i18n [Alin Voinea - [`1563d0a`](https://github.com/eea/volto-embed/commit/1563d0ab1f54e775a16705bfd3d267303eb2a526)]
 - i18n: Add en [Alin Voinea - [`b4e0694`](https://github.com/eea/volto-embed/commit/b4e0694ee40ecc195536fd1826adfab8876c5061)]
 - test: Update Makefile and docker-compose to align it with Jenkinsfile [valentinab25 - [`8f228ca`](https://github.com/eea/volto-embed/commit/8f228ca0644cee0f777a01114895583f387a395c)]
 - test: increase test coverage - refs #254313 [ana-oprea - [`30354d8`](https://github.com/eea/volto-embed/commit/30354d8a10a78e4fc322e37f4be20ff85cd00bbc)]
@@ -143,9 +154,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - Add react-countup to resolutions [kreafox - [`36eb637`](https://github.com/eea/volto-embed/commit/36eb637c0cb9413b0b0e0ce53e621b2289929d65)]
 - Move generic classes to privacy-protection [kreafox - [`715d559`](https://github.com/eea/volto-embed/commit/715d559e370bf7a3489b64d357b0a6cd7b1a3af2)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`5715b4d`](https://github.com/eea/volto-embed/commit/5715b4d3fcc14a34e031c383275c685d88f4db44)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`ef24ac0`](https://github.com/eea/volto-embed/commit/ef24ac05b17f4f4dbf05ceafbee677012a7f28f5)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`81f957b`](https://github.com/eea/volto-embed/commit/81f957b51aef7be59214530b774de8547bee3f5f)]
 ### [5.0.2](https://github.com/eea/volto-embed/compare/5.0.1...5.0.2) - 20 March 2023
 
 #### :hammer_and_wrench: Others
@@ -160,7 +168,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - update .project.eslintrc.js [Miu Razvan - [`628fd40`](https://github.com/eea/volto-embed/commit/628fd402b00d075ce319b9be92ff5f0e4d0ca2c4)]
 - rename schema.jsx [Miu Razvan - [`62794e3`](https://github.com/eea/volto-embed/commit/62794e398eab5117132e5622cab735f6cf4f79fd)]
 - improving code quality as per sonarqube reported issues [tedw87 - [`c7842f7`](https://github.com/eea/volto-embed/commit/c7842f7795f344e9d30538ddf2da04e97e319ebe)]
-- Add Sonarqube tag using cca-frontend addons list [EEA Jenkins - [`fe3a2de`](https://github.com/eea/volto-embed/commit/fe3a2de6180796c3d6b569733d2b9365a669c23e)]
 ## [5.0.0](https://github.com/eea/volto-embed/compare/4.0.4...5.0.0) - 31 October 2022
 
 #### :hammer_and_wrench: Others
@@ -180,8 +187,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - use specific alpha for addon test [andreiggr - [`e6df633`](https://github.com/eea/volto-embed/commit/e6df633aa4d2b0ee7eeb6b5aafa21528f14cd1df)]
 - add optional height to privacy container [andreiggr - [`e2ac711`](https://github.com/eea/volto-embed/commit/e2ac711db4e461b474cade42109346a73bb8ecbd)]
-- Add Sonarqube tag using marine-frontend addons list [EEA Jenkins - [`9f3f358`](https://github.com/eea/volto-embed/commit/9f3f35882fb367d72c7916abe7cbf366dbd8d5b6)]
-- Add Sonarqube tag using bise-frontend addons list [EEA Jenkins - [`7677140`](https://github.com/eea/volto-embed/commit/767714006abf7cbe336c5ab00d76c7232d5bc798)]
 ### [4.0.2](https://github.com/eea/volto-embed/compare/4.0.1...4.0.2) - 15 July 2022
 
 #### :hammer_and_wrench: Others
@@ -221,7 +226,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 - Update package.json [Nilesh - [`0ec673a`](https://github.com/eea/volto-embed/commit/0ec673a8178731b8c1e010101caee2a3c9fafaca)]
 - Update package.json [Nilesh - [`b8b94ec`](https://github.com/eea/volto-embed/commit/b8b94ec64672229f464b9108b4ac01a848827c00)]
-- Add Sonarqube tag using freshwater-frontend addons list [EEA Jenkins - [`cfe04d8`](https://github.com/eea/volto-embed/commit/cfe04d885255bb8e472a3b268b98e3d7b9022437)]
 - Refs #142010 - Optimize Volto-addons gitflow pipelines [valentinab25 - [`bf197dd`](https://github.com/eea/volto-embed/commit/bf197dd6516f9c18994add19b1141e061a96e2b6)]
 - no hardcoded text [Daniela Mormocea - [`4001bb4`](https://github.com/eea/volto-embed/commit/4001bb414df05c1516f95e4dcec4a328406dc63f)]
 - fix [Daniela Mormocea - [`a41ca9a`](https://github.com/eea/volto-embed/commit/a41ca9a2795a59f2633fb97938244e335dca8c43)]
@@ -295,8 +299,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - revert use of custom bg image [nileshgulia1 - [`63a74b7`](https://github.com/eea/volto-embed/commit/63a74b7e671d85b602b0190c7a18e6d6ad71341b)]
 - PrivacyProtection update & accept bg image [Andrei Grigore - [`f3f05d1`](https://github.com/eea/volto-embed/commit/f3f05d1d21fc88b90de3f68a995242b6c359e03a)]
 - fix loading of cookies [nileshgulia1 - [`46348d8`](https://github.com/eea/volto-embed/commit/46348d8321b4633a3d5fdcbfb2c4f01912d7ed2a)]
-- Add Sonarqube tag using frontend addons list [EEA Jenkins - [`a1e1f50`](https://github.com/eea/volto-embed/commit/a1e1f50db8a1ebc11261c3a24c39687c00ca7eea)]
-- Add Sonarqube tag using frontend addons list [EEA Jenkins - [`1e1471e`](https://github.com/eea/volto-embed/commit/1e1471ebab5ba6e5bf0c231ddd0de94d8fe6c846)]
 ### [2.0.1](https://github.com/eea/volto-embed/compare/2.0.0...2.0.1) - 28 May 2021
 
 #### :hammer_and_wrench: Others

package/cypress.config.js

@@ -2,7 +2,7 @@ const { defineConfig } = require('cypress');
 
 module.exports = defineConfig({
   viewportWidth: 1280,
-  defaultCommandTimeout: 8888,
+  defaultCommandTimeout: 15000,
   chromeWebSecurity: false,
   reporter: 'junit',
   video: false,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-embed",
-  "version": "9.0.5",
+  "version": "9.0.6",
   "description": "Embed external content",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/Blocks/EmbedMaps/View.jsx

@@ -1,4 +1,5 @@
-import React, { useEffect, useMemo } from 'react';
+import React, { useEffect, useMemo, useState } from 'react';
+import { reduce, isArray, isString } from 'lodash';
 import { connect } from 'react-redux';
 import { Message } from 'semantic-ui-react';
 import { getContent } from '@plone/volto/actions';
@@ -6,6 +7,13 @@ import { flattenToAppURL } from '@plone/volto/helpers';
 import EmbedMap from '@eeacms/volto-embed/EmbedMap/EmbedMap';
 import { pickMetadata } from '@eeacms/volto-embed/helpers';
 
+let timer;
+
+const debounce = (func, ...args) => {
+  if (timer) clearTimeout(timer);
+  timer = setTimeout(func, 800, ...args);
+};
+
 function getMaps(props) {
   const content = props.mapsContent || {};
   const maps = content.maps || props.data?.maps || {};
@@ -15,9 +23,46 @@ function getMaps(props) {
   };
 }
 
+function getParameters({ parameters, data_query }) {
+  return {
+    ...reduce(
+      data_query,
+      (acc, { i, v }) => {
+        if (i && v) {
+          let value = isString(v) ? v : '';
+          if (isArray(v)) {
+            value = v.join(',');
+          }
+          return {
+            ...acc,
+            [i]: value,
+          };
+        }
+        return acc;
+      },
+      {},
+    ),
+    ...reduce(
+      parameters,
+      (acc, { field, value }) => {
+        if (field && value) {
+          return {
+            ...acc,
+            [field]: value,
+          };
+        }
+        return acc;
+      },
+      {},
+    ),
+  };
+}
+
 function View(props) {
-  const { id, getContent, mode } = props;
+  const { id, getContent, mode, data_query } = props;
   const {
+    height,
+    parameters,
     useVisibilitySensor = true,
     with_notes = true,
     with_sources = true,
@@ -30,14 +75,29 @@ function View(props) {
 
   const maps = useMemo(() => getMaps(props), [props]);
 
+  const [queryParams, setQueryParams] = useState(() =>
+    getParameters({ parameters, data_query }),
+  );
+
+  useEffect(() => {
+    debounce(() => {
+      setQueryParams(
+        getParameters({
+          parameters,
+          data_query,
+        }),
+      );
+    });
+  }, [data_query, parameters]);
+
   useEffect(() => {
     const mapsId = maps['@id'] ? flattenToAppURL(maps['@id']) : undefined;
-    if (mode === 'edit' && url && url !== mapsId) {
+    if (url && url !== mapsId) {
       getContent(url, null, id);
     }
   }, [id, getContent, mode, url, maps]);
 
-  if (props.mode === 'edit' && !url) {
+  if (mode === 'edit' && !url) {
     return <Message>Please select a map from block editor.</Message>;
   }
 
@@ -51,7 +111,8 @@ function View(props) {
         data={{
           ...maps,
           useVisibilitySensor,
-          height: props.data.height || maps.height,
+          parameters: queryParams,
+          height: height || maps.height,
           with_notes,
           with_sources,
           with_more_info,
@@ -67,6 +128,7 @@ function View(props) {
 export default connect(
   (state, props) => ({
     mapsContent: state.content.subrequests?.[props.id]?.data,
+    data_query: state.content?.data?.data_query,
   }),
   { getContent },
 )(View);

package/src/Blocks/EmbedMaps/View.test.js

@@ -31,6 +31,37 @@ test('renders a view embed map block component', () => {
             enabled: false,
           },
           useVisibilitySensor: false,
+          parameters: {
+            '@id': '647e4a0f-d4a0-4b8a-9965-0a016f017ebd',
+            field: 'zoomtocountry',
+            value: 'RO',
+          },
+          height: '800',
+        }}
+        data_query={[
+          {
+            i: 'Country',
+            o: 'plone.app.querystring.operation.selection.is',
+            v: ['RO'],
+          },
+        ]}
+      />
+    </Provider>,
+  );
+  const json = component.toJSON();
+  expect(json).toMatchSnapshot();
+});
+
+test('renders an edit view embed map block component', () => {
+  const component = renderer.create(
+    <Provider store={global.store}>
+      <View
+        id="my-map"
+        mode="edit"
+        data={{
+          '@type': 'embed_maps',
+          url: '',
+          maps: {},
         }}
       />
     </Provider>,

package/src/Blocks/EmbedMaps/schema.js

@@ -11,6 +11,22 @@ const messages = defineMessages({
   },
 });
 
+const parameters = {
+  title: 'Parameter',
+  fieldsets: [{ id: 'default', title: 'Default', fields: ['field', 'value'] }],
+  properties: {
+    field: {
+      title: 'Name',
+      type: 'text',
+    },
+    value: {
+      title: 'Value',
+      type: 'text',
+    },
+  },
+  required: [],
+};
+
 export default (props) => {
   return {
     title: 'Embed interactive Map',
@@ -31,6 +47,11 @@ export default (props) => {
           'with_enlarge',
         ],
       },
+      {
+        id: 'parameters',
+        title: 'Parameters',
+        fields: ['parameters'],
+      },
     ],
     properties: {
       url: {
@@ -75,6 +96,12 @@ export default (props) => {
         type: 'boolean',
         defaultValue: true,
       },
+      parameters: {
+        title: 'Parameters',
+        widget: 'object_list',
+        schema: parameters,
+        description: 'Set a list of parameters.',
+      },
     },
 
     required: [],

package/src/Blocks/Maps/Edit.test.js

@@ -80,4 +80,30 @@ describe('Test Maps Block editing', () => {
     const json = component.toJSON();
     expect(json).toMatchSnapshot();
   });
+
+  test('test-3', () => {
+    const component = renderer.create(
+      <Provider store={global.store}>
+        <Edit
+          data={{
+            '@type': 'maps',
+            url: '',
+          }}
+          pathname="/news"
+          selected={true}
+          block="1234"
+          index={1}
+          onChangeBlock={() => {}}
+          onSelectBlock={() => {}}
+          onDeleteBlock={() => {}}
+          onFocusPreviousBlock={() => {}}
+          onFocusNextBlock={() => {}}
+          handleKeyDown={() => {}}
+          content={{}}
+        />
+      </Provider>,
+    );
+    const json = component.toJSON();
+    expect(json).toMatchSnapshot();
+  });
 });

package/src/EmbedMap/EmbedMap.jsx

@@ -1,5 +1,5 @@
 import React, { useEffect, useState, useRef } from 'react';
-import { isNaN, isNumber } from 'lodash';
+import { isNaN, isNumber, isEmpty } from 'lodash';
 import { compose } from 'redux';
 import { connect } from 'react-redux';
 import { defineMessages, injectIntl } from 'react-intl';
@@ -31,8 +31,19 @@ function getHeight(height) {
 }
 
 function EmbedMap({ data, intl, id, screen }) {
+  const { parameters, url } = data;
   const el = useRef();
   const [mobile, setMobile] = useState(false);
+  const [iframeSrc, setIframeSrc] = useState(url);
+
+  useEffect(() => {
+    const query_params = new URLSearchParams(parameters).toString();
+    if (isEmpty(parameters)) {
+      setIframeSrc(url);
+    } else {
+      setIframeSrc(url + '&' + query_params);
+    }
+  }, [url, parameters]);
 
   useEffect(() => {
     if (el.current) {
@@ -46,7 +57,7 @@ function EmbedMap({ data, intl, id, screen }) {
     }
   }, [screen, mobile]);
 
-  if (!data.url) return null;
+  if (!url) return null;
 
   return (
     <div
@@ -72,7 +83,7 @@ function EmbedMap({ data, intl, id, screen }) {
         >
           <iframe
             title={intl.formatMessage(messages.EmbededESRIMaps)}
-            src={data.url}
+            src={iframeSrc}
             className="google-map"
             frameBorder="0"
             allowFullScreen
@@ -115,5 +126,7 @@ function EmbedMap({ data, intl, id, screen }) {
 
 export default compose(
   injectIntl,
-  connect((state) => ({ screen: state.screen })),
+  connect((state) => ({
+    screen: state.screen,
+  })),
 )(EmbedMap);

package/src/EmbedMap/EmbedMap.test.js

@@ -37,6 +37,10 @@ test('renders map component', () => {
           url:
             'https://www.google.com/maps/embed?pb=!1m18!1m12!1m3!1d3027.7835278268726!2d14.38842915203974!3d40.634655679238854!2m3!1f0!2f0!3f0!3m2!1i1024!2i768!4f13.1!3m3!1m2!1s0x133b994881d943cb%3A0x6ab93db57d3272f0!2sHotel+Mediterraneo+Sorrento!5e0!3m2!1sen!2ses!4v1550168740166',
           useVisibilitySensor: false,
+          parameters: {
+            Country: 'RO',
+            zoomtocountry: 'RO',
+          },
         }}
       />
     </Provider>,