@eeacms/volto-eea-website-policy 1.0.4 → 1.1.0

package/CHANGELOG.md

@@ -4,6 +4,12 @@ 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).
 
+### [1.1.0](https://github.com/eea/volto-eea-website-policy/compare/1.0.4...1.1.0) - 29 November 2022
+
+#### :hammer_and_wrench: Others
+
+- Release 1.1.0 [Alin Voinea - [`0291b3b`](https://github.com/eea/volto-eea-website-policy/commit/0291b3bb7b4c6ab09ca98728885cea4051eac8e3)]
+- Remove Blocks customization, it's outdated [Tiberiu Ichim - [`97306cb`](https://github.com/eea/volto-eea-website-policy/commit/97306cb6a9ac53f00576559dd919197cef7439b8)]
 ### [1.0.4](https://github.com/eea/volto-eea-website-policy/compare/1.0.3...1.0.4) - 22 November 2022
 
 #### :nail_care: Enhancements
@@ -49,7 +55,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`d153f54`](https://github.com/eea/volto-eea-website-policy/commit/d153f54e55e918fa4746e05488c734624eaf14a9)]
 ### [0.4.0](https://github.com/eea/volto-eea-website-policy/compare/0.3.3...0.4.0) - 19 September 2022
 
 #### :hammer_and_wrench: Others
@@ -125,7 +130,6 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - format index.js [Andrei Grigore - [`db4481a`](https://github.com/eea/volto-eea-website-policy/commit/db4481aeeba59a769272659f33278c902fc69bec)]
 - Update index.js [Alexandru Ghica - [`dc09886`](https://github.com/eea/volto-eea-website-policy/commit/dc0988640a76a9914381b120f58bb61a9ab1eb39)]
 - Added externalRoutes [Alexandru Ghica - [`b68135b`](https://github.com/eea/volto-eea-website-policy/commit/b68135b013fafa93a41ea602ea2fad30879abe0f)]
-- Add Sonarqube tag using eea-website-frontend addons list [EEA Jenkins - [`575cca6`](https://github.com/eea/volto-eea-website-policy/commit/575cca674602ca2e1c2a41300c47ba594ff49aa0)]
 ### [0.1.1](https://github.com/eea/volto-eea-website-policy/compare/0.1.0...0.1.1) - 4 March 2022
 
 #### :hammer_and_wrench: Others
@@ -138,5 +142,4 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 
 #### :hammer_and_wrench: Others
 
-- yarn bootstrap [Alin Voinea - [`9b4d197`](https://github.com/eea/volto-eea-website-policy/commit/9b4d197cbc7992566cb36524d190078d5ad21a44)]
 - Initial commit [Alin Voinea - [`3800692`](https://github.com/eea/volto-eea-website-policy/commit/3800692f7a4de6460815bd6061facacb986cbef0)]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@eeacms/volto-eea-website-policy",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "description": "@eeacms/volto-eea-website-policy: Volto add-on",
   "main": "src/index.js",
   "author": "European Environment Agency: IDM2 A-Team",
@@ -17,10 +17,9 @@
     "url": "git@github.com:eea/volto-eea-website-policy.git"
   },
   "addons": [],
-  "dependencies": {},
   "devDependencies": {
-    "@plone/scripts": "*",
     "@cypress/code-coverage": "^3.10.0",
+    "@plone/scripts": "*",
     "babel-plugin-transform-class-properties": "^6.24.1",
     "md5": "^2.3.0"
   },

package/src/customizations/volto/helpers/Blocks/Blocks.js

@@ -1,440 +0,0 @@
-/**
- * Blocks helper.
- * @module helpers/Blocks
- */
-
-import { omit, without, endsWith, find, isObject, keys, toPairs } from 'lodash';
-import move from 'lodash-move';
-import { v4 as uuid } from 'uuid';
-import config from '@plone/volto/registry';
-import { applySchemaEnhancer } from '@plone/volto/helpers';
-
-/**
- * Get blocks field.
- * @function getBlocksFieldname
- * @param {Object} props Properties.
- * @return {string} Field name of the blocks
- */
-export function getBlocksFieldname(props) {
-  return (
-    find(
-      keys(props),
-      (key) => key !== 'volto.blocks' && endsWith(key, 'blocks'),
-    ) || null
-  );
-}
-
-/**
- * Get blocks layout field.
- * @function getBlocksLayoutFieldname
- * @param {Object} props Properties.
- * @return {string} Field name of the blocks layout
- */
-export function getBlocksLayoutFieldname(props) {
-  return (
-    find(
-      keys(props),
-      (key) => key !== 'volto.blocks' && endsWith(key, 'blocks_layout'),
-    ) || null
-  );
-}
-
-/**
- * Has blocks data.
- * @function hasBlocksData
- * @param {Object} props Properties.
- * @return {boolean} True if it has blocks data.
- */
-export function hasBlocksData(props) {
-  return (
-    find(
-      keys(props),
-      (key) => key !== 'volto.blocks' && endsWith(key, 'blocks'),
-    ) !== undefined
-  );
-}
-
-/**
- * Pluggable method to test if a block has a set value (any non-empty value)
- * @function blockHasValue
- * @param {Object} data Block data
- * @return {boolean} True if block has a non-empty value
- */
-export function blockHasValue(data) {
-  const { blocks } = config;
-  const blockType = data['@type'];
-  const check = blocks.blocksConfig[blockType]?.blockHasValue;
-  if (!check) {
-    return true;
-  }
-  return check(data);
-}
-
-/**
- * Get block pairs of [id, block] from content properties
- * @function getBlocks
- * @param {Object} properties
- * @return {Array} a list of block [id, value] pairs, in order from layout
- */
-export const getBlocks = (properties) => {
-  const blocksFieldName = getBlocksFieldname(properties);
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(properties);
-  return (
-    properties[blocksLayoutFieldname]?.items?.map((n) => [
-      n,
-      properties[blocksFieldName][n],
-    ]) || []
-  );
-};
-
-/**
- * Move block to different location index within blocks_layout
- * @function moveBlock
- * @param {Object} formData Form data
- * @param {number} source index within form blocks_layout items
- * @param {number} destination index within form blocks_layout items
- * @return {Object} New form data
- */
-export function moveBlock(formData, source, destination) {
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-  return {
-    ...formData,
-    [blocksLayoutFieldname]: {
-      items: move(formData[blocksLayoutFieldname].items, source, destination),
-    },
-  };
-}
-
-/**
- * Delete block by id
- * @function deleteBlock
- * @param {Object} formData Form data
- * @param {string} blockId Block uid
- * @return {Object} New form data
- */
-export function deleteBlock(formData, blockId) {
-  const blocksFieldname = getBlocksFieldname(formData);
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-
-  let newFormData = {
-    ...formData,
-    [blocksLayoutFieldname]: {
-      items: without(formData[blocksLayoutFieldname].items, blockId),
-    },
-    [blocksFieldname]: omit(formData[blocksFieldname], [blockId]),
-  };
-
-  if (newFormData[blocksLayoutFieldname].items.length === 0) {
-    newFormData = addBlock(newFormData, config.settings.defaultBlockType, 0);
-  }
-
-  return newFormData;
-}
-
-/**
- * Add block
- * @function addBlock
- * @param {Object} formData Form data
- * @param {string} type Block type
- * @param {number} index Destination index
- * @return {Array} New block id, New form data
- */
-export function addBlock(formData, type, index) {
-  const { settings } = config;
-  const id = uuid();
-  const idTrailingBlock = uuid();
-  const blocksFieldname = getBlocksFieldname(formData);
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-  const totalItems = formData[blocksLayoutFieldname].items.length;
-  const insert = index === -1 ? totalItems : index;
-
-  return [
-    id,
-    {
-      ...formData,
-      [blocksLayoutFieldname]: {
-        items: [
-          ...formData[blocksLayoutFieldname].items.slice(0, insert),
-          id,
-          ...(type !== settings.defaultBlockType ? [idTrailingBlock] : []),
-          ...formData[blocksLayoutFieldname].items.slice(insert),
-        ],
-      },
-      [blocksFieldname]: {
-        ...formData[blocksFieldname],
-        [id]: {
-          '@type': type,
-        },
-        ...(type !== settings.defaultBlockType && {
-          [idTrailingBlock]: {
-            '@type': settings.defaultBlockType,
-          },
-        }),
-      },
-      selected: id,
-    },
-  ];
-}
-
-/**
- * Mutate block
- * @function mutateBlock
- * @param {Object} formData Form data
- * @param {string} id Block uid to mutate
- * @param {number} value Block's new value
- * @return {Object} New form data
- */
-export function mutateBlock(formData, id, value) {
-  const { settings } = config;
-  const blocksFieldname = getBlocksFieldname(formData);
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-  const index = formData[blocksLayoutFieldname].items.indexOf(id) + 1;
-
-  // Test if block at index is already a placeholder (trailing) block
-  const trailId = formData[blocksLayoutFieldname].items[index];
-  if (trailId) {
-    const block = formData[blocksFieldname][trailId];
-    if (!blockHasValue(block)) {
-      return {
-        ...formData,
-        [blocksFieldname]: {
-          ...formData[blocksFieldname],
-          [id]: value || null,
-        },
-      };
-    }
-  }
-
-  const idTrailingBlock = uuid();
-  return {
-    ...formData,
-    [blocksFieldname]: {
-      ...formData[blocksFieldname],
-      [id]: value || null,
-      [idTrailingBlock]: {
-        '@type': settings.defaultBlockType,
-      },
-    },
-    [blocksLayoutFieldname]: {
-      items: [
-        ...formData[blocksLayoutFieldname].items.slice(0, index),
-        idTrailingBlock,
-        ...formData[blocksLayoutFieldname].items.slice(index),
-      ],
-    },
-  };
-}
-
-/**
- * Insert new block before another block
- * @function insertBlock
- * @param {Object} formData Form data
- * @param {string} id Insert new block before the block with this id
- * @param {number} value New block's value
- * @return {Array} New block id, New form data
- */
-export function insertBlock(formData, id, value, current = {}) {
-  const blocksFieldname = getBlocksFieldname(formData);
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-  const index = formData[blocksLayoutFieldname].items.indexOf(id);
-
-  const newBlockId = uuid();
-  return [
-    newBlockId,
-    {
-      ...formData,
-      [blocksFieldname]: {
-        ...formData[blocksFieldname],
-        [newBlockId]: value || null,
-        [id]: {
-          ...formData[blocksFieldname][id],
-          ...current,
-        },
-      },
-      [blocksLayoutFieldname]: {
-        items: [
-          ...formData[blocksLayoutFieldname].items.slice(0, index),
-          newBlockId,
-          ...formData[blocksLayoutFieldname].items.slice(index),
-        ],
-      },
-    },
-  ];
-}
-
-/**
- * Change block
- * @function changeBlock
- * @param {Object} formData Form data
- * @param {string} id Block uid to change
- * @param {number} value Block's new value
- * @return {Object} New form data
- */
-export function changeBlock(formData, id, value) {
-  const blocksFieldname = getBlocksFieldname(formData);
-  return {
-    ...formData,
-    [blocksFieldname]: {
-      ...formData[blocksFieldname],
-      [id]: value || null,
-    },
-  };
-}
-
-/**
- * Get the next block UID within form
- * @function nextBlockId
- * @param {Object} formData Form data
- * @param {string} currentBlock Block uid
- * @return {string} Next block uid
- */
-export function nextBlockId(formData, currentBlock) {
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-  const currentIndex = formData[blocksLayoutFieldname].items.indexOf(
-    currentBlock,
-  );
-
-  if (currentIndex === formData[blocksLayoutFieldname].items.length - 1) {
-    // We are already at the bottom block don't do anything
-    return null;
-  }
-
-  const newIndex = currentIndex + 1;
-  return formData[blocksLayoutFieldname].items[newIndex];
-}
-
-/**
- * Get the previous block UID within form
- * @function previousBlockId
- * @param {Object} formData Form data
- * @param {string} currentBlock Block uid
- * @return {string} Previous block uid
- */
-export function previousBlockId(formData, currentBlock) {
-  const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
-  const currentIndex = formData[blocksLayoutFieldname].items.indexOf(
-    currentBlock,
-  );
-
-  if (currentIndex === 0) {
-    // We are already at the top block don't do anything
-    return null;
-  }
-  const newindex = currentIndex - 1;
-  return formData[blocksLayoutFieldname].items[newindex];
-}
-
-/**
- * Generate empty block form
- * @function emptyBlocksForm
- * @param {Object} formData Form data
- * @return {Object} Empty blocks form with one defaultBlockType block
- */
-export function emptyBlocksForm() {
-  const { settings } = config;
-  const id = uuid();
-  return {
-    blocks: {
-      [id]: {
-        '@type': settings.defaultBlockType,
-      },
-    },
-    blocks_layout: { items: [id] },
-  };
-}
-
-/**
- * Recursively discover blocks in data and call the provided callback
- * @function visitBlocks
- * @param {Object} content A content data structure (an object with blocks and blocks_layout)
- * @param {Function} callback A function to call on each discovered block
- */
-export function visitBlocks(content, callback) {
-  const queue = getBlocks(content);
-  while (queue.length > 0) {
-    const [id, blockdata] = queue.shift();
-    callback([id, blockdata]);
-
-    // assumes that a block value is like: {blocks, blocks_layout} or
-    // { data: {blocks, blocks_layout}}
-    if (Object.keys(blockdata || {}).indexOf('blocks') > -1) {
-      queue.push(...getBlocks(blockdata));
-    }
-    if (Object.keys(blockdata?.data || {}).indexOf('blocks') > -1) {
-      queue.push(...getBlocks(blockdata.data));
-    }
-  }
-}
-
-/**
- * Initializes data with the default values coming from schema
- */
-export function applySchemaDefaults({ data = {}, schema }) {
-  const derivedData = {
-    ...Object.keys(schema.properties).reduce((accumulator, currentField) => {
-      return schema.properties[currentField].default
-        ? {
-            ...accumulator,
-            [currentField]: schema.properties[currentField].default,
-          }
-        : accumulator;
-    }, {}),
-    ...data,
-  };
-  return derivedData;
-}
-
-/**
- * Apply the block's default (as defined in schema) to the block data.
- *
- * @function applyBlockDefaults
- * @param {Object} params An object with data, intl and anything else
- * @return {Object} Derived data, with the defaults extracted from the schema
- */
-export function applyBlockDefaults({ data = {}, intl, ...rest }, blocksConfig) {
-  const block_type = data['@type'];
-  const { blockSchema } =
-    (blocksConfig || config.blocks.blocksConfig)[block_type] || {};
-  if (!blockSchema) return data;
-
-  let schema =
-    typeof blockSchema === 'function'
-      ? blockSchema({ data, intl, ...rest })
-      : blockSchema;
-  schema = applySchemaEnhancer({ schema, formData: data, intl });
-
-  return applySchemaDefaults({ data, schema });
-}
-
-export const buildStyleClassNamesFromData = (styles) => {
-  // styles has the form
-  // const styles = {
-  // color: 'red',
-  // backgroundColor: '#AABBCC',
-  // }
-  // Returns: ['has--color--red', 'has--backgroundColor--AABBCC']
-  let styleArray = [];
-  const pairedStyles = toPairs(styles);
-  pairedStyles.forEach((item) => {
-    if (isObject(item[1])) {
-      const flattenedNestedStyles = toPairs(item[1]).map((nested) => [
-        item[0],
-        ...nested,
-      ]);
-      flattenedNestedStyles.forEach((sub) => styleArray.push(sub));
-    } else {
-      styleArray.push(item);
-    }
-  });
-  return styleArray.map((item) => {
-    const classname = item.map((item) => {
-      const str_item = item ? item.toString() : '';
-      return str_item && str_item.startsWith('#')
-        ? str_item.replace('#', '')
-        : str_item;
-    });
-    return `has--${classname[0]}--${classname[1]}${
-      classname[2] ? `--${classname[2]}` : ''
-    }`;
-  });
-};