@eeacms/volto-slate-footnote 3.0.0 → 4.0.0

package/src/editor/utils.js

@@ -1,5 +1,6 @@
 import config from '@plone/volto/registry';
 import { Node } from 'slate';
+import { getAllBlocks } from 'volto-slate/utils';
 
 /**
  * remove <?xml version="1.0"?> from the string
@@ -12,6 +13,46 @@ export const makeFootnote = (footnote) => {
   return free;
 };
 
+/**
+ * Extends volto-slate getAllBlocks functionality also to SlateJSONFields
+ * inserted within blocks via Metadata / Metadata section block
+ * @param {Object} properties metadata properties received by the View component
+ * @returns {Array} Returns a flat array of blocks and slate fields
+ */
+export const getAllBlocksAndSlateFields = (properties) => {
+  const blocks = getAllBlocks(properties, []);
+  const flat_blocks = [];
+  for (const b_idx in blocks) {
+    const block = blocks[b_idx];
+    if (block['@type'] === 'metadataSection') {
+      const fields = block.fields;
+      for (const f_idx in fields) {
+        const field = fields[f_idx];
+        if (field?.field?.widget === 'slate') {
+          const field_id = field.field.id;
+          flat_blocks.push({
+            '@type': 'slate',
+            id: field_id,
+            value: properties[field_id]?.length ? properties[field_id] : null,
+          });
+        }
+      }
+    } else if (block['@type'] === 'metadata') {
+      if (block?.data?.widget === 'slate') {
+        const f_id = block.data.id;
+        flat_blocks.push({
+          '@type': 'slate',
+          id: f_id,
+          value: properties[f_id]?.length ? properties[f_id] : null,
+        });
+      }
+    } else {
+      flat_blocks.push(block);
+    }
+  }
+  return flat_blocks;
+};
+
 /**
  * Will make an object with keys for every zoteroId and some uid that are unique
  * or referenced multiple times
@@ -34,37 +75,28 @@ export const makeFootnoteListOfUniqueItems = (blocks) => {
         if (footnotes.includes(node.type) && node.data) {
           // for citations (Zotero items) create refs for same zoteroId
           if (node.data.zoteroId) {
-            if (!notesObjResult[node.data.zoteroId]) {
-              notesObjResult[node.data.zoteroId] = {
-                ...node.data,
-              };
-            } else if (notesObjResult[node.data.zoteroId].refs) {
-              notesObjResult[node.data.zoteroId].refs[node.data.uid] = true;
-            } else {
-              // add its own uid in refs for easier parsing in html
-              notesObjResult[node.data.zoteroId].refs = {
-                [notesObjResult[node.data.zoteroId].uid]: true,
-                [node.data.uid]: true,
-              };
+            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 {
-            const found = Object.keys(notesObjResult).find(
-              (noteId) =>
-                notesObjResult[noteId].footnote === node.data.footnote,
+          } else if (node.data.extra) {
+            iterateFootnoteObj(notesObjResult, node.data);
+            node.data.extra.forEach((footnoteObjItem) =>
+              // since is called in case of extra, the parent is needed
+              iterateFootnoteObj(
+                notesObjResult,
+                footnoteObjItem,
+                node.data.uid,
+              ),
             );
-
-            if (!found) {
-              notesObjResult[node.data.uid] = { ...node.data };
-            } else if (notesObjResult[found].refs) {
-              notesObjResult[found].refs[node.data.uid] = true;
-            } else {
-              // add its own uid in refs for easier parsing in html
-              notesObjResult[found].refs = {
-                [notesObjResult[found].uid]: true,
-                [node.data.uid]: true,
-              };
-            }
+          } else {
+            iterateFootnoteObj(notesObjResult, node.data);
           }
         }
       });
@@ -72,3 +104,69 @@ export const makeFootnoteListOfUniqueItems = (blocks) => {
 
   return notesObjResult;
 };
+
+/**
+ * Will change the notesObjResultTemp to add new property if the zoteroId is new or add to the existing ones refs
+ * @param {Object} notesObjResultTemp - the object that will configure the zotero items
+ * @param {Object} zoteroObj - the footnote object
+ * @param {string} zoteroObj.zoteroId - id of the zotero citation
+ * @param {string} zoteroObj.uid - id of the slate item
+ * @param {string} zoteroObj.footnote - xml citation from zotero
+ * @param {string} parentUid - will be needed because html element (the word) that references multiple citations
+ * will have the id as the main uid, the ids from the extra will not matter in this case
+ */
+const iterateZoteroObj = (notesObjResultTemp, zoteroObj, parentUid) => {
+  const uid = parentUid || zoteroObj.uid;
+  // add new zoteroId
+  if (!notesObjResultTemp[zoteroObj.zoteroId]) {
+    notesObjResultTemp[zoteroObj.zoteroId] = {
+      ...zoteroObj,
+      uid,
+    };
+    // if zoteroId and refs exist then add the uid to the refs
+  } else if (notesObjResultTemp[zoteroObj.zoteroId].refs) {
+    notesObjResultTemp[zoteroObj.zoteroId].refs[uid] = true;
+  } else {
+    // if zoteroId exists but not refs, add its own uid also in refs for easier parsing in html
+    notesObjResultTemp[zoteroObj.zoteroId].refs = {
+      [notesObjResultTemp[zoteroObj.zoteroId].uid]: true,
+      [uid]: true,
+    };
+  }
+};
+
+/**
+ * Will change the notesObjResultTemp to add new property if the footnote uid is new or add to the refs of the existing ones
+ * Some footnotes will always be in extra, so we need parentId to know where to find it in render
+ * @param {Object} notesObjResultTemp - the object that will configure the zotero items
+ * @param {Object} node - the footnote object
+ * @param {string} node.zoteroId - id of the zotero citation
+ * @param {string} node.parentUid - id of the parent footnote
+ * @param {string} node.uid - id of the slate item
+ * @param {string} node.footnote - xml citation from zotero
+ * @param {string} parentUid - will be needed because html element (the word) that references multiple citations
+ * will have the id as the main uid, the ids from the extra will not matter in this case
+ */
+const iterateFootnoteObj = (notesObjResultTemp, node, parentUid) => {
+  const uid = parentUid || node.uid;
+  const found = Object.keys(notesObjResultTemp).find((noteId) => {
+    return notesObjResultTemp[noteId].footnote === node.footnote;
+  });
+  // has not yet been added
+  if (!found) {
+    // will use the parentUid instead of own uid for render to be able to reference to the correct element
+    //(word containing the footnotes)
+    notesObjResultTemp[node.uid] = parentUid
+      ? { ...node, parentUid }
+      : { ...node };
+    // the element is found, just add it's own uid to the list of refs, the parent is already known
+  } else if (notesObjResultTemp[found].refs) {
+    notesObjResultTemp[found].refs[node.uid] = true;
+  } else {
+    // element found but doesn't have refs yet, this means that it is a parent, so add it's existing uid and the current one
+    notesObjResultTemp[found].refs = {
+      [notesObjResultTemp[found].uid]: true,
+      [uid]: true,
+    };
+  }
+};

package/src/index.js

@@ -5,7 +5,7 @@ import FootnotesBlockEdit from './Blocks/Footnote/FootnotesBlockEdit';
 import FootnotesBlockSchema from './Blocks/Footnote/FootnotesBlockSchema';
 import { FOOTNOTE } from './constants';
 import installFootnoteEditor from './editor';
-import SearchWidget from '@eeacms/volto-slate-footnote/editor/SearchWidget';
+import SearchWidget from '@eeacms/volto-slate-footnote/editor/MultiSelectSearchWidget';
 
 /**
  * @summary Called from Volto to configure new or existing Volto block types.

package/cypress/integration/01-block-basics.js

@@ -1,36 +0,0 @@
-import { setupBeforeEach, tearDownAfterEach } from '../support';
-
-describe('Blocks Tests', () => {
-  beforeEach(setupBeforeEach);
-  afterEach(tearDownAfterEach);
-
-  it('Add Block: Empty', () => {
-    // Change page title
-    cy.get('.documentFirstHeading > .public-DraftStyleDefault-block')
-      .clear()
-      .type('My Add-on Page')
-      .get('.documentFirstHeading span[data-text]')
-      .contains('My Add-on Page');
-
-    cy.get('.documentFirstHeading > .public-DraftStyleDefault-block').type(
-      '{enter}',
-    );
-
-    // Add block
-    cy.get('.ui.basic.icon.button.block-add-button').first().click();
-    cy.get('.blocks-chooser .title').contains('Text').click();
-    cy.get('.content.active.text .button.slateFootnotes').contains('Footnotes').click();
-
-    // Configure block
-    cy.get('[id=sidebar-properties] [name=title]').click().type('Footnotes');
-    cy.get('[id=sidebar-properties] label[for=field-global]').click();
-
-    // Save
-    cy.get('#toolbar-save').click();
-    cy.url().should('eq', Cypress.config().baseUrl + '/cypress/my-page');
-
-    // then the page view should contain our changes
-    cy.contains('My Add-on Page');
-    cy.contains('Footnotes');
-  });
-});

package/cypress/integration/02-block-slate.js

@@ -1,63 +0,0 @@
-import { setupBeforeEach, tearDownAfterEach } from '../support';
-
-describe('Blocks Tests', () => {
-  beforeEach(setupBeforeEach);
-  afterEach(tearDownAfterEach);
-
-  it('Add Block and create footnote', () => {
-    // Change page title
-    cy.get('.documentFirstHeading > .public-DraftStyleDefault-block')
-      .clear()
-      .type('My Add-on Page')
-      .get('.documentFirstHeading span[data-text]')
-      .contains('My Add-on Page');
-
-    cy.get('.documentFirstHeading > .public-DraftStyleDefault-block').type(
-      '{enter}',
-    );
-
-    // Add some text with footnotes
-    cy.get('.slate-editor [contenteditable=true]')
-      .focus()
-      .click()
-      .wait(1000)
-      .type('Colorless green ideas sleep furiously.');
-
-    cy.get('.slate-editor.selected [contenteditable=true]').setSelection(
-      'furiously',
-    );
-
-    cy.wait(1000);
-
-    cy.get('.slate-inline-toolbar .button-wrapper a[title="Footnote"]').click();
-    cy.get('.sidebar-container [id=field-footnote]').click().type('Citation');
-    cy.get('.sidebar-container .form .header button:first-of-type').click();
-
-    // Add block
-    cy.get('.slate-editor [contenteditable=true]')
-      .focus()
-      .click()
-      .wait(1000)
-      .type('{enter}');
-
-    cy.get('.ui.basic.icon.button.block-add-button').first().click();
-    cy.get('.blocks-chooser .title').contains('Text').click();
-    cy.get('.content.active.text .button.slateFootnotes')
-      .contains('Footnotes')
-      .click();
-
-    // Configure block
-    cy.get('[id=sidebar-properties] [name=title]').click().type('Footnotes');
-    cy.get('[id=sidebar-properties] label[for=field-global]').click();
-
-    // Save
-    cy.get('#toolbar-save').click();
-    cy.url().should('eq', Cypress.config().baseUrl + '/cypress/my-page');
-
-    // then the page view should contain our changes
-    cy.contains('My Add-on Page');
-    cy.get('span.citation-item').contains('furiously');
-    cy.contains('Footnotes');
-    cy.contains('Citation');
-  });
-});