@eeacms/volto-slate-footnote 4.0.5 → 5.0.0

package/CHANGELOG.md

@@ -4,9 +4,15 @@ 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.0](https://github.com/eea/volto-slate-footnote/compare/4.0.5...5.0.0)
+
+- feat(footnotes): Add blocksWithFootnotesSupport config settings [`ed3de55`](https://github.com/eea/volto-slate-footnote/commit/ed3de5546b409c7c9f149a28407110959d198f68)
+
 #### [4.0.5](https://github.com/eea/volto-slate-footnote/compare/4.0.4...4.0.5)
 
-- Allow other block types to define footnotes - refs #148688 [`12f5920`](https://github.com/eea/volto-slate-footnote/commit/12f592019bbc37d71c14a64387ef9fbaf1828adc)
+> 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)
 

package/package.json

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

package/src/editor/FootnoteEditor.jsx

@@ -67,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) => config.settings.blocksWithFootnotes.includes(b['@type']))
-    .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) => config.settings.blocksWithFootnotes.includes(b['@type']))
-    .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

@@ -3,7 +3,7 @@ import codeSVG from '@plone/volto/icons/blog-entry.svg';
 import FootnotesBlockView from './Blocks/Footnote/FootnotesBlockView';
 import FootnotesBlockEdit from './Blocks/Footnote/FootnotesBlockEdit';
 import FootnotesBlockSchema from './Blocks/Footnote/FootnotesBlockSchema';
-import { FOOTNOTE, SLATE } from './constants';
+import { FOOTNOTE } from './constants';
 import installFootnoteEditor from './editor';
 import SearchWidget from '@eeacms/volto-slate-footnote/editor/MultiSelectSearchWidget';
 
@@ -36,10 +36,15 @@ export default function install(config) {
   config.widgets.widget.searchInput = SearchWidget;
   config = installFootnoteEditor(config);
 
-  config.settings.blocksWithFootnotes = [
-    ...(config.settings.blocksWithFootnotes || []),
-    SLATE,
-  ];
+  // 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;
 }