@eeacms/volto-slate-footnote 7.0.0 → 7.1.0

package/CHANGELOG.md

@@ -4,7 +4,22 @@ 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).
 
-### [7.0.0](https://github.com/eea/volto-slate-footnote/compare/6.3.0...7.0.0) - 22 April 2024
+### [7.1.0](https://github.com/eea/volto-slate-footnote/compare/7.0.1...7.1.0) - 13 September 2024
+
+#### :rocket: New Features
+
+- feat: autodetect links and use universal link - refs #274052 [dobri1408 - [`9c13101`](https://github.com/eea/volto-slate-footnote/commit/9c13101b62b1df150e1b3dbb93807df60a074ad5)]
+
+#### :hammer_and_wrench: Others
+
+- Release 7.1.0 [alin - [`c15afb0`](https://github.com/eea/volto-slate-footnote/commit/c15afb0be79ba9c4e3a46e3c190a41db468e88cd)]
+### [7.0.1](https://github.com/eea/volto-slate-footnote/compare/7.0.0...7.0.1) - 23 August 2024
+
+#### :hammer_and_wrench: Others
+
+- test: Fix tests on Volto 16 [Alin Voinea - [`1de9cc0`](https://github.com/eea/volto-slate-footnote/commit/1de9cc0dc69f1e6316654c149e7e9c0912f27749)]
+- Squashed commit of the following: [Alin Voinea - [`207a2d3`](https://github.com/eea/volto-slate-footnote/commit/207a2d3be243d8ff60e64dfe627c7b32443ea222)]
+## [7.0.0](https://github.com/eea/volto-slate-footnote/compare/6.3.0...7.0.0) - 22 April 2024
 
 #### :rocket: New Features
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-slate-footnote",
-  "version": "7.0.0",
+  "version": "7.1.0",
   "description": "volto-slate-footnote: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -23,6 +23,7 @@
     "@cypress/code-coverage": "^3.10.0",
     "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
+    "cypress": "13.1.0",
     "dotenv": "^16.3.2",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",

package/src/Blocks/Footnote/FootnotesBlockView.jsx

@@ -3,13 +3,13 @@ import {
   openAccordionOrTabIfContainsFootnoteReference,
   getAllBlocksAndSlateFields,
   makeFootnoteListOfUniqueItems,
-  makeFootnote,
 } from '@eeacms/volto-slate-footnote/editor/utils';
 import './less/public.less';
 
 import { UniversalLink } from '@plone/volto/components';
 
 const alphabet = 'abcdefghijklmnopqrstuvwxyz';
+const urlRegex = /https?:\/\/[^\s]+/g;
 
 /**
  * @summary The React component that displays the list of footnotes inserted
@@ -19,6 +19,7 @@ const alphabet = 'abcdefghijklmnopqrstuvwxyz';
  * @param {Object} props Contains the properties `data` and `properties` as
  * received from the Volto form.
  */
+
 const FootnotesBlockView = (props) => {
   const { data, properties, tabData, content } = props;
   const { title, global, placeholder = 'Footnotes' } = data;
@@ -75,6 +76,30 @@ const FootnotesBlockView = (props) => {
     startList = citationIndice;
   }
 
+  const renderTextWithLinks = (text) => {
+    if (!text) return null;
+    const parts = text.split(urlRegex);
+    const links = text.match(urlRegex);
+    let result = [];
+
+    parts.forEach((part, index) => {
+      result.push(<span key={`text-${index}`}>{part}</span>);
+
+      if (links && links[index]) {
+        result.push(
+          <UniversalLink
+            key={`link-${index}`}
+            href={links[index]}
+            openLinkInNewTab={false}
+          >
+            {links[index]}
+          </UniversalLink>,
+        );
+      }
+    });
+
+    return result;
+  };
   return (
     <div className="footnotes-listing-block">
       <h3 title={placeholder}>{title}</h3>
@@ -85,16 +110,19 @@ const FootnotesBlockView = (props) => {
             const { uid, footnote, zoteroId, parentUid } = note;
             const { refs } = note;
             const refsList = refs ? Object.keys(refs) : null;
+
+            // const history = createBrowserHistory();
+            // const api = new Api();
+            // const store = configureStore(window.__data, history, api);
+            const footnoteText = !footnote
+              ? ''
+              : footnote.replace('<?xml version="1.0"?>', '');
             return (
               <li
                 key={`footnote-${zoteroId || uid}`}
                 id={`footnote-${zoteroId || uid}`}
               >
-                <div
-                  dangerouslySetInnerHTML={{
-                    __html: makeFootnote(footnote),
-                  }}
-                />
+                <div>{renderTextWithLinks(footnoteText)}</div>
                 {refsList ? (
                   <>
                     {/** some footnotes are never parent so we need the parent to reference */}

package/src/editor/render.jsx

@@ -15,9 +15,8 @@ import { UniversalLink } from '@plone/volto/components';
  * @param {string} footnote
  * @returns {string} formatted footnote
  */
-const makeFootnote = (footnote) => {
-  return footnote ? footnote.replace('<?xml version="1.0"?>', '') : '';
-};
+
+const urlRegex = /https?:\/\/[^\s]+/g;
 
 export const FootnoteElement = (props) => {
   const { attributes, children, element, mode, extras } = props;
@@ -37,7 +36,7 @@ export const FootnoteElement = (props) => {
   const notesObjResult = isEmpty(metadata)
     ? makeFootnoteListOfUniqueItems(storeBlocks)
     : makeFootnoteListOfUniqueItems(blocks);
-  // will cosider zotero citations and footnote
+  // will consider zotero citations and footnote
   // notesObjResult contains all zotero/footnote as unique, and contain refs for other zotero/footnote
   const indiceIfZoteroId = data.extra
     ? [
@@ -52,6 +51,29 @@ export const FootnoteElement = (props) => {
     : // no extra citations (no multiples)
       `[${Object.keys(notesObjResult).indexOf(zoteroId) + 1}]`;
 
+  const renderTextWithLinks = (text) => {
+    if (!text) return null;
+    const parts = text.split(urlRegex);
+    const links = text.match(urlRegex);
+    let result = [];
+
+    parts.forEach((part, index) => {
+      result.push(<span key={`text-${index}`}>{part}</span>);
+      if (links && links[index]) {
+        result.push(
+          <UniversalLink
+            key={`link-${index}`}
+            href={links[index]}
+            openLinkInNewTab={false}
+          >
+            {links[index]}
+          </UniversalLink>,
+        );
+      }
+    });
+
+    return result;
+  };
   const citationIndice = zoteroId // ZOTERO
     ? indiceIfZoteroId
     : // FOOTNOTES
@@ -76,13 +98,17 @@ export const FootnoteElement = (props) => {
     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
+    // if not found in parent, search in refs, it might be a footnote referenced multiple times
     Object.keys(notesObjResult).find(
       (noteKey) =>
         notesObjResult[noteKey].uid === uid ||
         (notesObjResult[noteKey].refs && notesObjResult[noteKey].refs[uid]),
     );
 
+  const footnoteText = !data.footnote
+    ? ''
+    : data.footnote.replace('<?xml version="1.0"?>', '');
+
   return (
     <>
       {mode === 'view' ? (
@@ -109,7 +135,6 @@ export const FootnoteElement = (props) => {
             <Popup.Content>
               <List divided relaxed selection>
                 <List.Item
-                  as={UniversalLink}
                   href={`#footnote-${citationRefId}`}
                   onClick={() =>
                     openAccordionOrTabIfContainsFootnoteReference(
@@ -120,37 +145,34 @@ export const FootnoteElement = (props) => {
                 >
                   <List.Content>
                     <List.Description>
-                      <div
-                        dangerouslySetInnerHTML={{
-                          __html: makeFootnote(data.footnote),
-                        }}
-                      />{' '}
+                      {renderTextWithLinks(footnoteText)}
                     </List.Description>
                   </List.Content>
                 </List.Item>
                 {data.extra &&
-                  data.extra.map((item) => (
-                    <List.Item
-                      as={UniversalLink}
-                      href={`#footnote-${item.zoteroId || item.uid}`}
-                      onClick={() =>
-                        openAccordionOrTabIfContainsFootnoteReference(
-                          `#footnote-${item.zoteroId || item.uid}`,
-                        )
-                      }
-                      key={`#footnote-${item.zoteroId || item.uid}`}
-                    >
-                      <List.Content>
-                        <List.Description>
-                          <div
-                            dangerouslySetInnerHTML={{
-                              __html: makeFootnote(item.footnote),
-                            }}
-                          />{' '}
-                        </List.Description>
-                      </List.Content>
-                    </List.Item>
-                  ))}
+                  data.extra.map((item) => {
+                    const footnoteText = !item.footnote
+                      ? ''
+                      : item.footnote.replace('<?xml version="1.0"?>', '');
+
+                    return (
+                      <List.Item
+                        href={`#footnote-${item.zoteroId || item.uid}`}
+                        onClick={() =>
+                          openAccordionOrTabIfContainsFootnoteReference(
+                            `#footnote-${item.zoteroId || item.uid}`,
+                          )
+                        }
+                        key={`#footnote-${item.zoteroId || item.uid}`}
+                      >
+                        <List.Content>
+                          <List.Description>
+                            {renderTextWithLinks(footnoteText)}
+                          </List.Description>
+                        </List.Content>
+                      </List.Item>
+                    );
+                  })}
               </List>
             </Popup.Content>
           </Popup>
@@ -173,7 +195,6 @@ export const FootnoteElement = (props) => {
           <Popup.Content>
             <List divided relaxed selection>
               <List.Item
-                as={UniversalLink}
                 href={`#footnote-${citationRefId}`}
                 onClick={() =>
                   openAccordionOrTabIfContainsFootnoteReference(
@@ -184,18 +205,13 @@ export const FootnoteElement = (props) => {
               >
                 <List.Content>
                   <List.Description>
-                    <div
-                      dangerouslySetInnerHTML={{
-                        __html: makeFootnote(data.footnote),
-                      }}
-                    />{' '}
+                    {renderTextWithLinks(footnoteText)}
                   </List.Description>
                 </List.Content>
               </List.Item>
               {data.extra &&
                 data.extra.map((item) => (
                   <List.Item
-                    as={UniversalLink}
                     href={`#footnote-${item.zoteroId || item.uid}`}
                     onClick={() =>
                       openAccordionOrTabIfContainsFootnoteReference(
@@ -206,11 +222,7 @@ export const FootnoteElement = (props) => {
                   >
                     <List.Content>
                       <List.Description>
-                        <div
-                          dangerouslySetInnerHTML={{
-                            __html: makeFootnote(item.footnote),
-                          }}
-                        />{' '}
+                        {renderTextWithLinks(item.footnote)}
                       </List.Description>
                     </List.Content>
                   </List.Item>

package/src/editor/utils.js

@@ -1,15 +1,6 @@
 import config from '@plone/volto/registry';
 import { Node } from 'slate';
 import { getAllBlocks } from '@plone/volto-slate/utils';
-
-/**
- * remove <?xml version="1.0"?> from the string
- * @param {*} footnote - xml format
- * @returns string
- */
-export const makeFootnote = (footnote) => {
-  return footnote ? footnote.replace('<?xml version="1.0"?>', '') : '';
-};
 /**
  * retrive all slate children of nested objects
  * @param {object} path - the keys that we want to extract the slate children from
@@ -79,6 +70,14 @@ export const openAccordionOrTabIfContainsFootnoteReference = (footnoteId) => {
   return true;
 };
 
+/**
+ * Will open accordion if contains footnote reference
+ * @param {string} footnoteId
+ * @deprecated This function got renamed to {@link openAccordionOrTabIfContainsFootnoteReference}
+ */
+export const openAccordionIfContainsFootnoteReference =
+  openAccordionOrTabIfContainsFootnoteReference;
+
 const blockTypesOperations = {
   metadataSection: (block, properties) => {
     const fields = block?.fields || [];

package/src/editor/utils.test.js

@@ -1,5 +1,4 @@
 import {
-  makeFootnote,
   openAccordionOrTabIfContainsFootnoteReference,
   getAllBlocksAndSlateFields,
 } from './utils';
@@ -9,19 +8,6 @@ jest.mock('@plone/volto-slate/utils', () => ({
   getAllBlocks: jest.fn(),
 }));
 
-describe('makeFootnote', () => {
-  it('should remove xml version string from footnote', () => {
-    const xmlString = '<?xml version="1.0"?>Test text';
-    const expectedResult = 'Test text';
-    expect(makeFootnote(xmlString)).toEqual(expectedResult);
-  });
-
-  it('should return empty string when footnote is null or undefined', () => {
-    expect(makeFootnote(null)).toEqual('');
-    expect(makeFootnote(undefined)).toEqual('');
-  });
-});
-
 describe('openAccordionOrTabIfContainsFootnoteReference', () => {
   it('should open accordion if it contains footnote reference', () => {
     document.body.innerHTML = `