@eeacms/volto-slate-footnote 4.0.4 → 5.0.1

package/CHANGELOG.md

@@ -4,8 +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).
 
+#### [5.0.1](https://github.com/eea/volto-slate-footnote/compare/5.0.0...5.0.1)
+
+
+### [5.0.0](https://github.com/eea/volto-slate-footnote/compare/4.0.5...5.0.0)
+
+> 19 May 2022
+
+- feat(footnotes): Add blocksWithFootnotesSupport config settings [`#32`](https://github.com/eea/volto-slate-footnote/pull/32)
+
+#### [4.0.5](https://github.com/eea/volto-slate-footnote/compare/4.0.4...4.0.5)
+
+> 17 May 2022
+
+- Allow other block types to define footnotes - refs #148688 [`#31`](https://github.com/eea/volto-slate-footnote/pull/31)
+
 #### [4.0.4](https://github.com/eea/volto-slate-footnote/compare/4.0.3...4.0.4)
 
+> 3 January 2022
+
 
 #### [4.0.3](https://github.com/eea/volto-slate-footnote/compare/4.0.2...4.0.3)
 

package/Jenkinsfile

@@ -4,8 +4,9 @@ pipeline {
   environment {
         GIT_NAME = "volto-slate-footnote"
         NAMESPACE = "@eeacms"
-        SONARQUBE_TAGS = "volto.eea.europa.eu,biodiversity.europa.eu,www.eea.europa.eu-ims,climate-energy.eea.europa.eu,sustainability.eionet.europa.eu,forest.eea.europa.eu,clms.land.copernicus.eu,industry.eea.europa.eu,water.europa.eu-freshwater"
+        SONARQUBE_TAGS = "volto.eea.europa.eu,biodiversity.europa.eu,www.eea.europa.eu-ims,climate-energy.eea.europa.eu,sustainability.eionet.europa.eu,forest.eea.europa.eu,clms.land.copernicus.eu,industry.eea.europa.eu,water.europa.eu-freshwater,demo-www.eea.europa.eu,clmsdemo.devel6cph.eea.europa.eu,circularity.eea.europa.eu"
         DEPENDENCIES = "volto-slate:asDefault"
+        VOLTO = "alpha"
     }
 
   stages {
@@ -124,8 +125,8 @@ pipeline {
             node(label: 'docker') {
               script {
                 try {
-                  sh '''docker pull plone; docker run -d --rm --name="$BUILD_TAG-plone" -e SITE="Plone" -e PROFILES="profile-plone.restapi:blocks" plone fg'''
-                  sh '''docker pull plone/volto-addon-ci; docker run -i --name="$BUILD_TAG-cypress" --link $BUILD_TAG-plone:plone -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" -e DEPENDENCIES="$DEPENDENCIES" plone/volto-addon-ci cypress'''
+                  sh '''docker pull eeacms/plone-backend; docker run --rm -d --name="$BUILD_TAG-plone" -e SITE="Plone" -e PROFILES="eea.kitkat:testing" eeacms/plone-backend'''
+                  sh '''docker pull plone/volto-addon-ci; docker run -i --name="$BUILD_TAG-cypress" --link $BUILD_TAG-plone:plone -e NAMESPACE="$NAMESPACE" -e GIT_NAME=$GIT_NAME -e GIT_BRANCH="$BRANCH_NAME" -e GIT_CHANGE_ID="$CHANGE_ID" -e DEPENDENCIES="$DEPENDENCIES" -e NODE_ENV=development -e VOLTO="$VOLTO" plone/volto-addon-ci cypress'''
                 } finally {
                   try {
                     sh '''rm -rf cypress-reports cypress-results cypress-coverage'''
@@ -184,10 +185,10 @@ pipeline {
             unstash "xunit-reports"
             unstash "cypress-coverage"
             def scannerHome = tool 'SonarQubeScanner';
-            def nodeJS = tool 'NodeJS11';
+            def nodeJS = tool 'NodeJS';
             withSonarQubeEnv('Sonarqube') {
               sh '''sed -i "s#/opt/frontend/my-volto-project/src/addons/${GIT_NAME}/##g" xunit-reports/coverage/lcov.info'''
-              sh "export PATH=$PATH:${scannerHome}/bin:${nodeJS}/bin; sonar-scanner -Dsonar.javascript.lcov.reportPaths=./xunit-reports/coverage/lcov.info,./cypress-coverage/coverage/lcov.info -Dsonar.sources=./src -Dsonar.projectKey=$GIT_NAME-$BRANCH_NAME -Dsonar.projectVersion=$BRANCH_NAME-$BUILD_NUMBER"
+              sh "export PATH=${scannerHome}/bin:${nodeJS}/bin:$PATH; sonar-scanner -Dsonar.javascript.lcov.reportPaths=./xunit-reports/coverage/lcov.info,./cypress-coverage/coverage/lcov.info -Dsonar.sources=./src -Dsonar.projectKey=$GIT_NAME-$BRANCH_NAME -Dsonar.projectVersion=$BRANCH_NAME-$BUILD_NUMBER"
               sh '''try=2; while [ \$try -gt 0 ]; do curl -s -XPOST -u "${SONAR_AUTH_TOKEN}:" "${SONAR_HOST_URL}api/project_tags/set?project=${GIT_NAME}-${BRANCH_NAME}&tags=${SONARQUBE_TAGS},${BRANCH_NAME}" > set_tags_result; if [ \$(grep -ic error set_tags_result ) -eq 0 ]; then try=0; else cat set_tags_result; echo "... Will retry"; sleep 60; try=\$(( \$try - 1 )); fi; done'''
             }
           }

package/cypress/support/index.js

@@ -26,7 +26,7 @@ coverage-end */
 export const slateBeforeEach = (contentType = 'Document') => {
   cy.autologin();
   cy.createContent({
-    contentType: 'Folder',
+    contentType: 'Document',
     contentId: 'cypress',
     contentTitle: 'Cypress',
   });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-slate-footnote",
-  "version": "4.0.4",
+  "version": "5.0.1",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/constants.js

@@ -1 +1,2 @@
 export const FOOTNOTE = 'footnote';
+export const SLATE = 'slate';

package/src/editor/FootnoteEditor.jsx

@@ -11,6 +11,7 @@ import { Node } from 'slate';
 import { useSelector } from 'react-redux';
 import { isEmpty } from 'lodash';
 import { getAllBlocksAndSlateFields } from '@eeacms/volto-slate-footnote/editor/utils';
+import config from '@plone/volto/registry';
 
 const FootnoteEditor = (props) => {
   const {
@@ -66,18 +67,27 @@ const FootnoteEditor = (props) => {
   // add label and value for the multi search widget
   // flatten blocks to add all extra in the list
   flatAllBlocks
-    .filter((b) => b['@type'] === 'slate')
-    .forEach(({ value }) => {
-      if (!value) return;
+    .filter((b) => b['@type'] in config.settings.blocksWithFootnotesSupport)
+    .forEach((element) => {
+      const mapping = config.settings.blocksWithFootnotesSupport[
+        element['@type']
+      ] || ['value'];
 
-      Array.from(Node.elements(value[0])).forEach(([block]) => {
-        block.children.forEach((node) => {
-          if (node.data && node.type === 'footnote') {
-            manageAddBlockToUniqueBlocks(uniqueFootnoteBlocks, node.data);
-            (node.data.extra || []).forEach((ftitem) => {
-              manageAddBlockToUniqueBlocks(uniqueFootnoteBlocks, ftitem);
+      mapping.forEach((key) => {
+        const value = element[key];
+        if (!value) return;
+
+        value.forEach((item) => {
+          Array.from(Node.elements(item)).forEach(([block]) => {
+            block.children.forEach((node) => {
+              if (node.data && node.type === 'footnote') {
+                manageAddBlockToUniqueBlocks(uniqueFootnoteBlocks, node.data);
+                (node.data.extra || []).forEach((ftitem) => {
+                  manageAddBlockToUniqueBlocks(uniqueFootnoteBlocks, ftitem);
+                });
+              }
             });
-          }
+          });
         });
       });
     });

package/src/editor/utils.js

@@ -118,38 +118,52 @@ export const makeFootnoteListOfUniqueItems = (blocks) => {
   let notesObjResult = {};
 
   blocks
-    .filter((b) => b['@type'] === 'slate')
-    .forEach(({ value }) => {
-      if (!value) return;
-      // Node.elements(value[0]) returns an iterable generator of nodes
-      Array.from(Node.elements(value[0])).forEach(([node]) => {
-        if (footnotes.includes(node.type) && node.data) {
-          // for citations (Zotero items) create refs for same zoteroId
-          if (node.data.zoteroId) {
-            iterateZoteroObj(notesObjResult, node.data);
-            // itereate the extra obj for multiple citations
-            if (node.data.extra) {
-              node.data.extra.forEach((zoteroObjItem) =>
-                // send the uid of the parent
-                // of the word the will have the reference indice
-                iterateZoteroObj(notesObjResult, zoteroObjItem, node.data.uid),
-              );
+    .filter((b) => b['@type'] in config.settings.blocksWithFootnotesSupport)
+    .forEach((element) => {
+      const mapping = config.settings.blocksWithFootnotesSupport[
+        element['@type']
+      ] || ['value'];
+
+      mapping.forEach((key) => {
+        const value = element[key];
+        if (!value) return;
+
+        value.forEach((item) => {
+          // Node.elements(item) returns an iterable generator of nodes
+          Array.from(Node.elements(item)).forEach(([node]) => {
+            if (footnotes.includes(node.type) && node.data) {
+              // for citations (Zotero items) create refs for same zoteroId
+              if (node.data.zoteroId) {
+                iterateZoteroObj(notesObjResult, node.data);
+                // itereate the extra obj for multiple citations
+                if (node.data.extra) {
+                  node.data.extra.forEach((zoteroObjItem) =>
+                    // send the uid of the parent
+                    // of the word the will have the reference indice
+                    iterateZoteroObj(
+                      notesObjResult,
+                      zoteroObjItem,
+                      node.data.uid,
+                    ),
+                  );
+                }
+                // for footnotes - create refs, on identical text
+              } else {
+                iterateFootnoteObj(notesObjResult, node.data);
+                if (node.data.extra) {
+                  node.data.extra.forEach((footnoteObjItem) =>
+                    // since is called in case of extra, the parent is needed
+                    iterateFootnoteObj(
+                      notesObjResult,
+                      footnoteObjItem,
+                      node.data.uid,
+                    ),
+                  );
+                }
+              }
             }
-            // for footnotes - create refs, on identical text
-          } else {
-            iterateFootnoteObj(notesObjResult, node.data);
-            if (node.data.extra) {
-              node.data.extra.forEach((footnoteObjItem) =>
-                // since is called in case of extra, the parent is needed
-                iterateFootnoteObj(
-                  notesObjResult,
-                  footnoteObjItem,
-                  node.data.uid,
-                ),
-              );
-            }
-          }
-        }
+          });
+        });
       });
     });
 

package/src/index.js

@@ -36,5 +36,15 @@ export default function install(config) {
   config.widgets.widget.searchInput = SearchWidget;
   config = installFootnoteEditor(config);
 
+  // Some blocks may have multiple slate fields,
+  // thus provide these fields per block type in order to lookup for footnotes:
+  //
+  //      'my-custom-block-type': ['value', 'field1', 'field2']
+  //
+  config.settings.blocksWithFootnotesSupport = {
+    ...(config.settings.blocksWithFootnotesSupport || {}),
+    slate: ['value'],
+  };
+
   return config;
 }