@eeacms/volto-cca-policy 0.1.13 → 0.1.15

package/CHANGELOG.md

@@ -4,6 +4,19 @@ 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).
 
+### [0.1.15](https://github.com/eea/volto-cca-policy/compare/0.1.14...0.1.15) - 27 March 2023
+
+#### :hammer_and_wrench: Others
+
+- Retry build [Ghiță Bizău - [`d878ed0`](https://github.com/eea/volto-cca-policy/commit/d878ed0c91c7441f0f65a1caf6336de5272c9907)]
+### [0.1.14](https://github.com/eea/volto-cca-policy/compare/0.1.13...0.1.14) - 24 March 2023
+
+#### :hammer_and_wrench: Others
+
+- Update url for privacy in footer [Ghiță Bizău - [`18f2c9b`](https://github.com/eea/volto-cca-policy/commit/18f2c9b9e0f912d4851c5fcc9fbaf89a07476ce9)]
+- Update links [kreafox - [`1cc68f2`](https://github.com/eea/volto-cca-policy/commit/1cc68f2093e0c8308afd8461f3fa6cbfe9e0aa36)]
+- Refs #250307 - Add Privacy link in footer. [GhitaB - [`e2338c9`](https://github.com/eea/volto-cca-policy/commit/e2338c9289a9205f50fbfc626f2ccad79180d11b)]
+- Add volto-slate customization [kreafox - [`d267f35`](https://github.com/eea/volto-cca-policy/commit/d267f351b8d76dca09748851ba9eb22d882efb69)]
 ### [0.1.13](https://github.com/eea/volto-cca-policy/compare/0.1.12...0.1.13) - 23 March 2023
 
 #### :hammer_and_wrench: Others

package/README.md

@@ -83,3 +83,4 @@ don-template/blob/master/LICENSE.md) for details.
 ## Funding
 
 [European Environment Agency (EU)](http://eea.europa.eu)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-cca-policy",
-  "version": "0.1.13",
+  "version": "0.1.15",
   "description": "@eeacms/volto-cca-policy: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",

package/src/customizations/@plone/volto-slate/README.md

@@ -0,0 +1 @@
+Customizations from this PR: https://github.com/plone/volto/pull/4583

package/src/customizations/@plone/volto-slate/blocks/Table/deconstruct.js

@@ -0,0 +1,115 @@
+import { v4 as uuid } from 'uuid';
+import { Editor, Transforms } from 'slate';
+import {
+  TABLE,
+  THEAD,
+  TBODY,
+  TFOOT,
+  TD,
+  TH,
+  TR,
+} from '@plone/volto-slate/constants';
+
+/**
+ * @param {Array} rows The array of rows that almost completely defines a
+ * `table`-typed block.
+ * @returns {Array} A tuple `[id, block]` where `id` is the new block's ID and
+ * the `block` is all the block's data.
+ */
+export function syncCreateTableBlock(rows) {
+  const id = uuid();
+  const block = {
+    '@type': 'slateTable',
+    table: {
+      rows,
+    },
+  };
+  return [id, block];
+}
+
+/**
+ * @param {Editor} editor The Slate Editor from which to extract tables.
+ * @param {PathRef} pathRef Has the current value a `Path` so that the search is
+ * done just inside nodes in that `Path`.
+ * @returns Extracts tables from a Slate `Editor` into an array of detached
+ * `table` blocks.
+ */
+export const extractTables = (editor, pathRef) => {
+  const tableNodes = Array.from(
+    Editor.nodes(editor, {
+      at: pathRef.current,
+      match: (node) => node.type === TABLE,
+    }),
+  );
+  const tables = tableNodes.map(([node]) => extractVoltoTable(node));
+
+  Transforms.removeNodes(editor, {
+    at: pathRef.current,
+    match: (node) => node.type === TABLE,
+  });
+
+  return tables.map((el) => syncCreateTableBlock(el));
+};
+
+extractTables.id = 'extractTables';
+
+/**
+ * @param {Node[]} fragment A Slate document fragment.
+ * @returns {Array} An array of rows in the format requested by `table`
+ * blocks.
+ */
+function collectRowsFrom(fragment) {
+  let rows = [];
+  fragment.children.forEach((y) => {
+    if (y.type === TR) {
+      let row = { key: uuid(), cells: [] };
+
+      y.children.forEach((z) => {
+        let val = JSON.parse(JSON.stringify(z.children));
+        if (z.type === TD) {
+          row.cells.push({
+            key: uuid(),
+            type: 'data',
+            value: val,
+          });
+        } else if (z.type === TH) {
+          row.cells.push({
+            key: uuid(),
+            type: 'header',
+            value: val,
+          });
+        }
+      });
+
+      rows.push(row);
+    }
+  });
+  return rows;
+}
+
+/**
+ * @param {HTMLElement} el The <table> element from which to extract rows.
+ * @returns {Array} A rows array that contains rows in the format required by
+ * `table` blocks.
+ */
+function extractVoltoTable(el) {
+  let thead = [],
+    tfoot = [],
+    tbody = [];
+
+  el.children.forEach((fragment) => {
+    if (fragment.type === THEAD) {
+      // not supported by View fully, so prepend this to tbody below
+      thead = collectRowsFrom(fragment);
+    } else if (fragment.type === TBODY) {
+      tbody = collectRowsFrom(fragment);
+    } else if (fragment.type === TFOOT) {
+      // not supported by View fully, so append this to tbody below
+      tfoot = collectRowsFrom(fragment);
+    }
+  });
+
+  const rows = [...thead, ...tbody, ...tfoot];
+
+  return rows;
+}

package/src/customizations/@plone/volto-slate/blocks/Table/index.js

@@ -0,0 +1,69 @@
+import TableBlockEdit from '@plone/volto-slate/blocks/Table/TableBlockEdit';
+import TableBlockView from '@plone/volto-slate/blocks/Table/TableBlockView';
+import { extractTables } from './deconstruct';
+import { normalizeTable } from '@plone/volto-slate/blocks/Table/extensions/normalizeTable';
+import { normalizeExternalData } from '@plone/volto-slate/blocks/Text/extensions';
+
+import tableSVG from '@plone/volto/icons/table.svg';
+
+/**
+ * @summary Called from Volto to configure new or existing Volto block types.
+ * @param {object} config The object received from Volto containing the
+ * configuration for all the blocks.
+ */
+export default function install(config) {
+  config.settings.slate = {
+    ...config.settings.slate,
+    tableblockExtensions: [
+      // First here gets executed last
+      // withLists,
+      // withSplitBlocksOnBreak,
+      // withDeleteSelectionOnEnter,
+      // withDeserializers,
+      // breakList,
+      normalizeTable,
+      normalizeExternalData,
+    ],
+  };
+
+  const tableBlockConfig = {
+    id: 'table',
+    title: 'Table',
+    icon: tableSVG,
+    group: 'common',
+    view: TableBlockView,
+    edit: TableBlockEdit,
+    restricted: false,
+    mostUsed: false,
+    blockHasOwnFocusManagement: true,
+    sidebarTab: 1,
+    security: {
+      addPermission: [],
+      view: [],
+    },
+    // blockHasValue: (data) => {
+    //   return true;
+    // },
+  };
+
+  config.blocks.blocksConfig.table.restricted = true;
+  config.blocks.blocksConfig.slateTable = {
+    ...tableBlockConfig,
+    id: 'slateTable',
+  };
+
+  const { voltoBlockEmiters = [] } = config.settings.slate;
+  const imageExtractor = voltoBlockEmiters.find(
+    (e) => e.id === 'extractImages',
+  );
+
+  // we want to extract the tables before the images, so that the images that
+  // that are inserted in the tables are not extracted as Volto image blocks
+  config.settings.slate.voltoBlockEmiters = [
+    ...voltoBlockEmiters.filter((e) => e.id !== 'extractImages'),
+    extractTables,
+    ...(imageExtractor ? [imageExtractor] : []),
+  ];
+
+  return config;
+}

package/src/customizations/@plone/volto-slate/blocks/Text/index.js

@@ -0,0 +1,164 @@
+import React from 'react';
+import redraft from 'redraft';
+import TextBlockView from '@plone/volto-slate/blocks/Text/TextBlockView';
+import TextBlockEdit from '@plone/volto-slate/blocks/Text/TextBlockEdit';
+import TextBlockSchema from '@plone/volto-slate/blocks/Text/TextBlockSchema';
+
+import {
+  goDown,
+  goUp,
+  backspaceInList,
+  indentListItems,
+  joinWithNextBlock,
+  joinWithPreviousBlock,
+  softBreak,
+  moveListItemDown,
+  moveListItemUp,
+  traverseBlocks,
+  unwrapEmptyString,
+  slashMenu,
+  cancelEsc,
+} from '@plone/volto-slate/blocks/Text/keyboard';
+import { withDeleteSelectionOnEnter } from '@plone/volto-slate/editor/extensions';
+import {
+  breakList,
+  withDeserializers,
+  withLists,
+  withSplitBlocksOnBreak,
+  withIsSelected,
+  normalizeExternalData,
+} from '@plone/volto-slate/blocks/Text/extensions';
+
+import textSVG from '@plone/volto/icons/subtext.svg';
+
+export { TextBlockView, TextBlockEdit, TextBlockSchema };
+
+export default function installTextBlock(config) {
+  config.settings.slate = {
+    // TODO: should we inverse order? First here gets executed last
+    textblockExtensions: [
+      withLists,
+      withSplitBlocksOnBreak, // TODO: do we still need this one?
+      withDeleteSelectionOnEnter,
+      withDeserializers,
+      withIsSelected,
+      breakList,
+      normalizeExternalData,
+    ],
+
+    // Pluggable handlers for the onKeyDown event of <Editable />
+    // Order matters here. A handler can return `true` to stop executing any
+    // following handler
+    textblockKeyboardHandlers: {
+      Backspace: [
+        unwrapEmptyString,
+        backspaceInList, // Backspace in list item lifts node and breaks Volto blocks
+        joinWithPreviousBlock, // Backspace at beginning of block joins with previous block
+      ],
+      Delete: [
+        unwrapEmptyString,
+        joinWithNextBlock, // Delete at end of block joins with next block
+      ],
+      Enter: [
+        slashMenu,
+        unwrapEmptyString,
+        softBreak, // Handles shift+Enter as a newline (<br/>)
+      ],
+      ArrowUp: [
+        slashMenu,
+        moveListItemUp, // Move up a list with with Ctrl+up
+        goUp, // Select previous block
+      ],
+      ArrowDown: [
+        slashMenu,
+        moveListItemDown, // Move down a list item with Ctrl+down
+        goDown, // Select next block
+      ],
+      Tab: [
+        indentListItems, // <tab> and <c-tab> behaviour for list items
+        traverseBlocks,
+      ],
+      Escape: [cancelEsc],
+    },
+    textblockDetachedKeyboardHandlers: {
+      Enter: [
+        softBreak, // Handles shift+Enter as a newline (<br/>)
+      ],
+    },
+    // Used by deconstructToVoltoBlocks to transform tags such as <img> to a Volto image block
+    // These emiters receive (editor, pathRef), emit [blockid, blockoptions] and
+    // are allowed to change the editor contents (for the given path)
+    // voltoBlockEmiters: [
+    //   ...(config.settings.slate.voltoBlockEmiters || []),
+    // ],
+
+    // These elements will get an id, to make them targets in TOC
+    topLevelTargetElements: ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'],
+
+    ...config.settings.slate, // TODO: is this correct for volto-slate addons?
+  };
+
+  config.settings.integratesBlockStyles = [
+    ...(config.settings.integratesBlockStyles || []),
+    'slate',
+  ];
+
+  const slateBlockConfig = {
+    id: 'slate',
+    title: 'Text',
+    icon: textSVG,
+    group: 'text',
+    view: TextBlockView,
+    edit: TextBlockEdit,
+    schema: TextBlockSchema,
+    restricted: false,
+    mostUsed: false,
+    blockHasOwnFocusManagement: true,
+    sidebarTab: 0,
+    security: {
+      addPermission: [],
+      view: [],
+    },
+    blockHasValue: (data) => {
+      // TODO: this should be handled better
+      return data && !!data.plaintext?.trim();
+    },
+    tocEntry: (block = {}) => {
+      const { value, override_toc, entry_text, level, plaintext } = block;
+      const type = value?.[0]?.type;
+      return override_toc && level
+        ? [parseInt(level.slice(1)), entry_text]
+        : config.settings.slate.topLevelTargetElements.includes(type)
+        ? [parseInt(type.slice(1)), plaintext]
+        : null;
+    },
+  };
+
+  // Make draft js compatible with ToC
+  config.blocks.blocksConfig.text = {
+    ...config.blocks.blocksConfig.text,
+    restricted: true,
+    tocEntry: (block = {}) => {
+      const draft = redraft(
+        block.text,
+        config.settings.richtextViewSettings.ToHTMLRenderers,
+        config.settings.richtextViewSettings.ToHTMLOptions,
+      );
+      const type = draft?.[0]?.[0]?.type;
+
+      return config.settings.slate.topLevelTargetElements.includes(type)
+        ? [parseInt(type.slice(1)), block.text.blocks[0].text]
+        : null;
+    },
+  };
+
+  config.blocks.blocksConfig.slate = slateBlockConfig;
+  config.blocks.blocksConfig.detachedSlate = {
+    ...config.blocks.blocksConfig.slate,
+    id: 'detachedSlate',
+    title: 'Detached Slate',
+    edit: (props) => <TextBlockEdit {...props} detached />,
+    restricted: true,
+  };
+  return config;
+}