@eeacms/volto-slate-footnote 6.1.3 → 6.1.5

package/.husky/pre-commit

@@ -0,0 +1,2 @@
+[ -n "$CI" ] && exit 0
+yarn lint-staged

package/CHANGELOG.md

@@ -4,6 +4,28 @@ 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).
 
+### [6.1.5](https://github.com/eea/volto-slate-footnote/compare/6.1.4...6.1.5) - 19 September 2023
+
+#### :bug: Bug Fixes
+
+- fix: index not showing on diff - refs #257191 [dobri1408 - [`bd6eb19`](https://github.com/eea/volto-slate-footnote/commit/bd6eb197213e23420fdd2f185447cb92a8156fc9)]
+
+#### :house: Internal changes
+
+- style: lint-staged reorder in package.json [Alin Voinea - [`c618c3c`](https://github.com/eea/volto-slate-footnote/commit/c618c3c12a878cc87fb9c3fd658eeb5d1241e871)]
+
+#### :hammer_and_wrench: Others
+
+- test: EN locales, pre-commit fix, feature PRs checks Refs #257193 [valentinab25 - [`6886cf7`](https://github.com/eea/volto-slate-footnote/commit/6886cf796c58d38fcce7c515bda1d3586420a58a)]
+### [6.1.4](https://github.com/eea/volto-slate-footnote/compare/6.1.3...6.1.4) - 1 September 2023
+
+#### :bug: Bug Fixes
+
+- fix: force footnotes to open in the same tab - refs #257251 [dobri1408 - [`20bb988`](https://github.com/eea/volto-slate-footnote/commit/20bb988534413a837786ab10cc09244498dbcb7e)]
+
+#### :hammer_and_wrench: Others
+
+- increase code coverage [Dobricean Ioan Dorian - [`3ba3ef3`](https://github.com/eea/volto-slate-footnote/commit/3ba3ef3187b1119d7be96ac2f952a36368163b97)]
 ### [6.1.3](https://github.com/eea/volto-slate-footnote/compare/6.1.2...6.1.3) - 30 August 2023
 
 #### :bug: Bug Fixes

package/Jenkinsfile

@@ -62,11 +62,17 @@ pipeline {
 
     stage('Tests') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          anyOf {
-           not { changelog '.*^Automated release [0-9\\.]+$' }
-           branch 'master'
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            anyOf {
+              not { changelog '.*^Automated release [0-9\\.]+$' }
+              branch 'master'
+            }
           }
         }
       }
@@ -110,11 +116,17 @@ pipeline {
 
     stage('Integration tests') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          anyOf {
-           not { changelog '.*^Automated release [0-9\\.]+$' }
-           branch 'master'
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            anyOf {
+              not { changelog '.*^Automated release [0-9\\.]+$' }
+              branch 'master'
+            }
           }
         }
       }
@@ -167,13 +179,19 @@ pipeline {
 
     stage('Report to SonarQube') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          anyOf {
-            branch 'master'
-            allOf {
-              branch 'develop'
-              not { changelog '.*^Automated release [0-9\\.]+$' }
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            anyOf {
+              allOf {
+                branch 'develop'
+                not { changelog '.*^Automated release [0-9\\.]+$' }
+              }
+              branch 'master'
             }
           }
         }
@@ -199,10 +217,16 @@ pipeline {
 
     stage('SonarQube compare to master') {
       when {
-        allOf {
-          environment name: 'CHANGE_ID', value: ''
-          branch 'develop'
-          not { changelog '.*^Automated release [0-9\\.]+$' }
+        anyOf {
+          allOf {
+            not { environment name: 'CHANGE_ID', value: '' }
+            environment name: 'CHANGE_TARGET', value: 'develop'
+          }
+          allOf {
+            environment name: 'CHANGE_ID', value: ''
+            branch 'develop'
+            not { changelog '.*^Automated release [0-9\\.]+$' }
+          }
         }
       }
       steps {

package/cypress/e2e/01-slate-footnote-block.cy.js

@@ -44,6 +44,28 @@ describe('Slate citations', () => {
     cy.get('[aria-label="Back to content"]').first().click();
   });
 
+  it('Test cancel Button', () => {
+    cy.getSlateEditorAndType('Colorless green ideas sleep furiously.')
+      .type('{selectAll}')
+      .dblclick();
+
+    // Footnote
+    cy.setSlateCursor('Colorless').dblclick();
+    cy.setSlateSelection('Colorless', 'green');
+    cy.clickSlateButton('Footnote');
+
+    cy.get('.sidebar-container .field-wrapper-footnote .react-select-container')
+      .click()
+      .type('Citation{enter}');
+
+    //click on the cancel button
+    cy.get('.sidebar-container .form .header button').first().next().click();
+
+    // Save
+    cy.get('#toolbar-save').click();
+    cy.url().should('eq', Cypress.config().baseUrl + '/cypress/my-page');
+  });
+
   it('Add Footnotes block and create multiple citations', () => {
     // Complete chained commands
     cy.getSlateEditorAndType('Colorless green ideas sleep furiously.')

package/cypress.config.js

@@ -2,12 +2,12 @@ const { defineConfig } = require('cypress');
 
 module.exports = defineConfig({
   viewportWidth: 1280,
-  defaultCommandTimeout: 8888,
+  defaultCommandTimeout: 5000,
   chromeWebSecurity: false,
   reporter: 'junit',
   video: true,
   retries: {
-    runMode: 8,
+    runMode: 1,
     openMode: 0,
   },
   reporterOptions: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-slate-footnote",
-  "version": "6.1.3",
+  "version": "6.1.5",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -23,8 +23,31 @@
     "@cypress/code-coverage": "^3.10.0",
     "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "husky": "*",
+    "lint-staged": "*",
     "md5": "^2.3.0"
   },
+  "lint-staged": {
+    "src/**/*.{js,jsx,ts,tsx,json}": [
+      "make lint-fix",
+      "make prettier-fix"
+    ],
+    "src/**/*.{jsx}": [
+      "make i18n"
+    ],
+    "theme/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.{css,less}": [
+      "make stylelint-fix"
+    ],
+    "theme/**/*.overrides": [
+      "make stylelint-fix"
+    ],
+    "src/**/*.overrides": [
+      "make stylelint-fix"
+    ]
+  },
   "scripts": {
     "release": "release-it",
     "release-major-beta": "release-it major --preRelease=beta",
@@ -42,6 +65,7 @@
     "lint:fix": "make lint-fix",
     "i18n": "make i18n",
     "cypress:run": "make cypress-run",
-    "cypress:open": "make cypress-open"
+    "cypress:open": "make cypress-open",
+    "prepare": "husky install"
   }
 }

package/src/Blocks/Footnote/FootnotesBlockView.jsx

@@ -1,4 +1,4 @@
-import React, { useEffect, useState } from 'react';
+import React from 'react';
 import {
   openAccordionIfContainsFootnoteReference,
   getAllBlocksAndSlateFields,
@@ -7,6 +7,8 @@ import {
 } from '@eeacms/volto-slate-footnote/editor/utils';
 import './less/public.less';
 
+import { UniversalLink } from '@plone/volto/components';
+
 const alphabet = 'abcdefghijklmnopqrstuvwxyz';
 
 /**
@@ -20,18 +22,10 @@ const alphabet = 'abcdefghijklmnopqrstuvwxyz';
 const FootnotesBlockView = (props) => {
   const { data, properties } = props;
   const { title, global, placeholder = 'Footnotes' } = data;
-  const [notesObj, setNodesObjs] = useState(null);
   const metadata = props.metadata ? props.metadata : properties;
-
-  useEffect(() => {
-    if (properties) {
-      const globalMetadata = global ? metadata : properties;
-      const blocks = getAllBlocksAndSlateFields(globalMetadata);
-      const notesObjResult = makeFootnoteListOfUniqueItems(blocks);
-
-      setNodesObjs(notesObjResult);
-    }
-  }, [properties]); // eslint-disable-line
+  const globalMetadata = global ? metadata : properties;
+  const blocks = getAllBlocksAndSlateFields(globalMetadata);
+  const notesObj = makeFootnoteListOfUniqueItems(blocks);
 
   return (
     <div className="footnotes-listing-block">
@@ -62,7 +56,7 @@ const FootnotesBlockView = (props) => {
                       id={`cite_ref-${refsList[0]}`}
                       key={`indice-${refsList[0]}`}
                     >
-                      <a
+                      <UniversalLink
                         href={`#ref-${parentUid || uid}`}
                         aria-label="Back to content"
                         onClick={() =>
@@ -72,12 +66,12 @@ const FootnotesBlockView = (props) => {
                         }
                       >
                         {alphabet[0]}
-                      </a>{' '}
+                      </UniversalLink>{' '}
                     </sup>
                     {/** following refs will have the uid of the one that references it*/}
                     {refsList.slice(1).map((ref, index) => (
                       <sup id={`cite_ref-${ref}`} key={`indice-${ref}`}>
-                        <a
+                        <UniversalLink
                           href={`#ref-${ref}`}
                           aria-label="Back to content"
                           onClick={() =>
@@ -87,14 +81,14 @@ const FootnotesBlockView = (props) => {
                           }
                         >
                           {alphabet[index + 1]}
-                        </a>{' '}
+                        </UniversalLink>{' '}
                       </sup>
                     ))}
                   </>
                 ) : (
                   <sup id={`cite_ref-${uid}`}>
                     {/** some footnotes are never parent so we need the parent to reference */}
-                    <a
+                    <UniversalLink
                       href={`#ref-${parentUid || uid}`}
                       aria-label="Back to content"
                       onClick={() =>
@@ -104,7 +98,7 @@ const FootnotesBlockView = (props) => {
                       }
                     >
                       ↵
-                    </a>{' '}
+                    </UniversalLink>{' '}
                   </sup>
                 )}
               </li>

package/src/editor/SearchWidget.test.jsx

@@ -0,0 +1,10 @@
+import React from 'react';
+import renderer from 'react-test-renderer';
+import SearchWidget from './SearchWidget';
+describe('Test SearchWidget', () => {
+  it('check html content', () => {
+    const component = renderer.create(<SearchWidget />);
+    const json = component.toJSON();
+    expect(json).toMatchSnapshot();
+  });
+});

package/src/editor/__snapshots__/SearchWidget.test.jsx.snap

@@ -0,0 +1,72 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Test SearchWidget check html content 1`] = `
+<div
+  id="blockform-fieldset-default"
+>
+  <div
+    className="ui segment attached"
+    fluid={true}
+  >
+    <div
+      className="ui fluid card"
+      onClick={[Function]}
+    >
+      <div
+        className="content"
+        fluid={true}
+      >
+        <div
+          className="header"
+        >
+          Citation
+        </div>
+        <div
+          className="description"
+          fluid={true}
+        >
+          <div
+            className="ui fluid search"
+            onBlur={[Function]}
+            onFocus={[Function]}
+            onMouseDown={[Function]}
+          >
+            <div
+              className="ui fluid right icon input"
+            >
+              <input
+                autoComplete="off"
+                className="prompt"
+                id="field-footnote"
+                onChange={[Function]}
+                onClick={[Function]}
+                tabIndex="0"
+                type="text"
+                value=""
+              />
+              <i
+                aria-hidden="true"
+                className="search icon"
+                onClick={[Function]}
+              />
+            </div>
+            <div
+              className="results transition"
+            >
+              <div
+                className="message empty"
+              >
+                <div
+                  className="header"
+                >
+                  No results found.
+                </div>
+              </div>
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>
+`;

package/src/editor/render.jsx

@@ -1,4 +1,4 @@
-import React, { useEffect, useState } from 'react';
+import React from 'react';
 import { Popup, List } from 'semantic-ui-react';
 import { useEditorContext } from '@plone/volto-slate/hooks';
 import { getAllBlocksAndSlateFields } from '@eeacms/volto-slate-footnote/editor/utils';
@@ -8,6 +8,7 @@ import {
 } from './utils';
 import { isEmpty } from 'lodash';
 import { useSelector } from 'react-redux';
+import { UniversalLink } from '@plone/volto/components';
 
 /**
  * Removes '<?xml version="1.0"?>' from footnote
@@ -23,71 +24,61 @@ export const FootnoteElement = (props) => {
   const { data = {} } = element;
   const { uid, zoteroId } = data;
   const editor = useEditorContext();
-  const [citationIndice, setCitationIndice] = useState(null); // list of indices to reference
-  const [citationRefId, setCitationRefId] = useState(null); // indice of element to be referenced
-  const initialFormData = useSelector((state) => state?.content?.data || {});
-
-  useEffect(() => {
-    const blockProps = editor?.getBlockProps ? editor.getBlockProps() : null;
-    const metadata = blockProps
-      ? blockProps.metadata || blockProps.properties
-      : extras?.metadata || {};
-    const blocks = getAllBlocksAndSlateFields(metadata);
-    const storeBlocks = getAllBlocksAndSlateFields(initialFormData);
 
-    const notesObjResult = isEmpty(metadata)
-      ? makeFootnoteListOfUniqueItems(storeBlocks)
-      : makeFootnoteListOfUniqueItems(blocks);
+  const initialFormData = useSelector((state) => state?.content?.data || {});
+  const blockProps = editor?.getBlockProps ? editor.getBlockProps() : null;
+  const metadata = blockProps
+    ? blockProps.metadata || blockProps.properties
+    : extras?.metadata || {};
+  const blocks = getAllBlocksAndSlateFields(metadata);
+  const storeBlocks = getAllBlocksAndSlateFields(initialFormData);
 
-    // will cosider zotero citations and footnote
-    // notesObjResult contains all zotero/footnote as unique, and contain refs for other zotero/footnote
-    const indiceIfZoteroId = data.extra
-      ? [
-          `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`, // parent footnote
-          ...data.extra.map(
-            // citations from extra
-            (zoteroObj, _index) =>
-              // all zotero citation are indexed by zoteroId in notesObjResult
-              `[${
-                Object.keys(notesObjResult).indexOf(zoteroObj.zoteroId) + 1
-              }]`,
-          ),
-        ].join('')
-      : // no extra citations (no multiples)
-        `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`;
+  const notesObjResult = isEmpty(metadata)
+    ? makeFootnoteListOfUniqueItems(storeBlocks)
+    : makeFootnoteListOfUniqueItems(blocks);
 
-    const indice = zoteroId // ZOTERO
-      ? indiceIfZoteroId
-      : // FOOTNOTES
-        // parent footnote
-        [data, ...(data.extra || [])]
-          .map((footnoteObj, _index) => {
-            return `[${
-              Object.keys(notesObjResult).indexOf(
-                Object.keys(notesObjResult).find(
-                  (key) =>
-                    notesObjResult[key].footnote === footnoteObj.footnote,
-                ),
-              ) + 1
-            }]`;
-          })
-          .join('');
+  // will cosider zotero citations and footnote
+  // notesObjResult contains all zotero/footnote as unique, and contain refs for other zotero/footnote
+  const indiceIfZoteroId = data.extra
+    ? [
+        `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`, // parent footnote
+        ...data.extra.map(
+          // citations from extra
+          (zoteroObj, _index) =>
+            // all zotero citation are indexed by zoteroId in notesObjResult
+            `[${Object.keys(notesObjResult).indexOf(zoteroObj.zoteroId) + 1}]`,
+        ),
+      ].join('')
+    : // no extra citations (no multiples)
+      `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`;
 
-    const findReferenceId =
-      // search within parent citations first, otherwise the uid might be inside a refs obj that comes before
-      Object.keys(notesObjResult).find(
-        (noteKey) => notesObjResult[noteKey].uid === uid,
-      ) ||
-      // if not found in parent, search in refs, it might be a footnote references multiple times
-      Object.keys(notesObjResult).find(
-        (noteKey) =>
-          notesObjResult[noteKey].uid === uid ||
-          (notesObjResult[noteKey].refs && notesObjResult[noteKey].refs[uid]),
-      );
+  const citationIndice = zoteroId // ZOTERO
+    ? indiceIfZoteroId
+    : // FOOTNOTES
+      // parent footnote
+      [data, ...(data.extra || [])]
+        .map((footnoteObj, _index) => {
+          return `[${
+            Object.keys(notesObjResult).indexOf(
+              Object.keys(notesObjResult).find(
+                (key) => notesObjResult[key].footnote === footnoteObj.footnote,
+              ),
+            ) + 1
+          }]`;
+        })
+        .join('');
 
-    setCitationIndice(indice);
-    setCitationRefId(findReferenceId);
-  }, [editor, element, children]); // eslint-disable-line
+  const citationRefId =
+    // search within parent citations first, otherwise the uid might be inside a refs obj that comes before
+    Object.keys(notesObjResult).find(
+      (noteKey) => notesObjResult[noteKey].uid === uid,
+    ) ||
+    // if not found in parent, search in refs, it might be a footnote references multiple times
+    Object.keys(notesObjResult).find(
+      (noteKey) =>
+        notesObjResult[noteKey].uid === uid ||
+        (notesObjResult[noteKey].refs && notesObjResult[noteKey].refs[uid]),
+    );
 
   return (
     <>
@@ -110,7 +101,7 @@ export const FootnoteElement = (props) => {
             <Popup.Content>
               <List divided relaxed selection>
                 <List.Item
-                  as="a"
+                  as={UniversalLink}
                   href={`#footnote-${citationRefId}`}
                   onClick={() =>
                     openAccordionIfContainsFootnoteReference(
@@ -132,7 +123,7 @@ export const FootnoteElement = (props) => {
                 {data.extra &&
                   data.extra.map((item) => (
                     <List.Item
-                      as="a"
+                      as={UniversalLink}
                       href={`#footnote-${item.zoteroId || item.uid}`}
                       onClick={() =>
                         openAccordionIfContainsFootnoteReference(
@@ -174,7 +165,7 @@ export const FootnoteElement = (props) => {
           <Popup.Content>
             <List divided relaxed selection>
               <List.Item
-                as="a"
+                as={UniversalLink}
                 href={`#footnote-${citationRefId}`}
                 onClick={() =>
                   openAccordionIfContainsFootnoteReference(
@@ -196,7 +187,7 @@ export const FootnoteElement = (props) => {
               {data.extra &&
                 data.extra.map((item) => (
                   <List.Item
-                    as="a"
+                    as={UniversalLink}
                     href={`#footnote-${item.zoteroId || item.uid}`}
                     onClick={() =>
                       openAccordionIfContainsFootnoteReference(