@plone/volto 17.2.0 → 17.4.0

package/src/helpers/Blocks/Blocks.js

@@ -132,14 +132,14 @@ export function deleteBlock(formData, blockId) {
 }
 
 /**
- * Add block
+ * Adds a block to the blocks form
  * @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) {
+export function addBlock(formData, type, index, blocksConfig) {
   const { settings } = config;
   const id = uuid();
   const idTrailingBlock = uuid();
@@ -148,81 +148,133 @@ export function addBlock(formData, type, index) {
   const totalItems = formData[blocksLayoutFieldname].items.length;
   const insert = index === -1 ? totalItems : index;
 
+  let value = applyBlockDefaults({
+    data: {
+      '@type': type,
+    },
+    intl: _dummyIntl,
+  });
+
   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,
+    _applyBlockInitialValue({
+      id,
+      value,
+      blocksConfig,
+      formData: {
+        ...formData,
+        [blocksLayoutFieldname]: {
+          items: [
+            ...formData[blocksLayoutFieldname].items.slice(0, insert),
+            id,
+            ...(type !== settings.defaultBlockType ? [idTrailingBlock] : []),
+            ...formData[blocksLayoutFieldname].items.slice(insert),
+          ],
+        },
+        [blocksFieldname]: {
+          ...formData[blocksFieldname],
+          [id]: value,
+          ...(type !== settings.defaultBlockType && {
+            [idTrailingBlock]: {
+              '@type': settings.defaultBlockType,
+            },
+          }),
         },
-        ...(type !== settings.defaultBlockType && {
-          [idTrailingBlock]: {
-            '@type': settings.defaultBlockType,
-          },
-        }),
+        selected: id,
       },
-      selected: id,
-    },
+    }),
   ];
 }
 
 /**
- * Mutate block
+ * Gets an initial value for a block, based on configuration
+ *
+ * This allows blocks that need complex initial data structures to avoid having
+ * to call `onChangeBlock` at their creation time, as this is prone to racing
+ * issue on block data storage.
+ */
+const _applyBlockInitialValue = ({ id, value, blocksConfig, formData }) => {
+  const blocksFieldname = getBlocksFieldname(formData);
+  const type = value['@type'];
+  blocksConfig = blocksConfig || config.blocks.blocksConfig;
+
+  if (blocksConfig[type]?.initialValue) {
+    value = blocksConfig[type].initialValue({
+      id,
+      value,
+      formData,
+    });
+    formData[blocksFieldname][id] = value;
+  }
+
+  return formData;
+};
+
+/**
+ * Mutate block, changes the block @type
  * @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) {
+export function mutateBlock(formData, id, value, blocksConfig) {
   const { settings } = config;
   const blocksFieldname = getBlocksFieldname(formData);
   const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
   const index = formData[blocksLayoutFieldname].items.indexOf(id) + 1;
 
+  value = applyBlockDefaults({
+    data: value,
+    intl: _dummyIntl,
+  });
+  let newFormData;
+
   // 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 {
+    newFormData = _applyBlockInitialValue({
+      id,
+      value,
+      blocksConfig,
+      formData: {
         ...formData,
         [blocksFieldname]: {
           ...formData[blocksFieldname],
           [id]: value || null,
         },
-      };
+      },
+    });
+    if (!blockHasValue(block)) {
+      return newFormData;
     }
   }
 
   const idTrailingBlock = uuid();
-  return {
-    ...formData,
-    [blocksFieldname]: {
-      ...formData[blocksFieldname],
-      [id]: value || null,
-      [idTrailingBlock]: {
-        '@type': settings.defaultBlockType,
+  newFormData = _applyBlockInitialValue({
+    id,
+    value,
+    blocksConfig,
+    formData: {
+      ...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),
+        ],
       },
     },
-    [blocksLayoutFieldname]: {
-      items: [
-        ...formData[blocksLayoutFieldname].items.slice(0, index),
-        idTrailingBlock,
-        ...formData[blocksLayoutFieldname].items.slice(index),
-      ],
-    },
-  };
+  });
+  return newFormData;
 }
 
 /**
@@ -233,15 +285,29 @@ export function mutateBlock(formData, id, value) {
  * @param {number} value New block's value
  * @return {Array} New block id, New form data
  */
-export function insertBlock(formData, id, value, current = {}, offset = 0) {
+export function insertBlock(
+  formData,
+  id,
+  value,
+  current = {},
+  offset = 0,
+  blocksConfig,
+) {
   const blocksFieldname = getBlocksFieldname(formData);
   const blocksLayoutFieldname = getBlocksLayoutFieldname(formData);
   const index = formData[blocksLayoutFieldname].items.indexOf(id);
 
+  value = applyBlockDefaults({
+    data: value,
+    intl: _dummyIntl,
+  });
+
   const newBlockId = uuid();
-  return [
-    newBlockId,
-    {
+  const newFormData = _applyBlockInitialValue({
+    id,
+    value,
+    blocksConfig,
+    formData: {
       ...formData,
       [blocksFieldname]: {
         ...formData[blocksFieldname],
@@ -259,7 +325,9 @@ export function insertBlock(formData, id, value, current = {}, offset = 0) {
         ],
       },
     },
-  ];
+  });
+
+  return [newBlockId, newFormData];
 }
 
 /**
@@ -570,3 +638,7 @@ export function findBlocks(blocks, types, result = []) {
 
   return result;
 }
+
+const _dummyIntl = {
+  formatMessage() {},
+};

package/src/helpers/Blocks/Blocks.test.js

@@ -64,6 +64,24 @@ config.blocks.blocksConfig.text = {
   }),
 };
 
+config.blocks.blocksConfig.dummyText = {
+  id: 'dummyText',
+  title: 'Text',
+  group: 'text',
+  restricted: false,
+  mostUsed: false,
+  blockHasOwnFocusManagement: true,
+  blockHasValue: (data) => {
+    const isEmpty =
+      !data.text ||
+      (data.text?.blocks?.length === 1 && data.text.blocks[0].text === '');
+    return !isEmpty;
+  },
+  initialValue: ({ value, id, formData }) => {
+    return { ...value, marker: true };
+  },
+};
+
 config.blocks.blocksConfig.enhancedBlock = {
   id: 'enhancedBlock',
   title: 'Text',
@@ -474,6 +492,63 @@ describe('Blocks', () => {
       );
       expect(form.blocks_layout.items).toStrictEqual(['a', newId, 'b']);
     });
+
+    it('initializes data for new block with initialValue', () => {
+      const [newId, form] = addBlock(
+        {
+          blocks: { a: { value: 1 }, b: { value: 2 } },
+          blocks_layout: { items: ['a', 'b'] },
+        },
+        'dummyText',
+        1,
+      );
+      expect(form.blocks[newId]).toStrictEqual({
+        '@type': 'dummyText',
+        marker: true,
+      });
+    });
+
+    it('initializes data for new block based on schema defaults', () => {
+      const [newId, form] = addBlock(
+        {
+          blocks: { a: { value: 1 }, b: { value: 2 } },
+          blocks_layout: { items: ['a', 'b'] },
+        },
+        'text',
+        1,
+      );
+      expect(form.blocks[newId]).toStrictEqual({
+        '@type': 'text',
+        booleanField: false,
+        description: 'Default description',
+        title: 'Default title',
+      });
+    });
+
+    it('initializes data for new block based on schema defaults and initialValue', () => {
+      config.blocks.blocksConfig.text.initialValue = ({ value }) => ({
+        ...value,
+        marker: true,
+      });
+      const [newId, form] = addBlock(
+        {
+          blocks: { a: { value: 1 }, b: { value: 2 } },
+          blocks_layout: { items: ['a', 'b'] },
+        },
+        'text',
+        1,
+      );
+
+      delete config.blocks.blocksConfig.text.initialValue;
+
+      expect(form.blocks[newId]).toStrictEqual({
+        '@type': 'text',
+        booleanField: false,
+        description: 'Default description',
+        title: 'Default title',
+        marker: true,
+      });
+    });
   });
 
   describe('moveBlock', () => {

package/src/helpers/Html/Html.jsx

@@ -177,7 +177,7 @@ class Html extends Component {
         <body className={bodyClass}>
           <div role="navigation" aria-label="Toolbar" id="toolbar" />
           <div id="main" dangerouslySetInnerHTML={{ __html: markup }} />
-          <div id="sidebar" />
+          <div role="complementary" aria-label="Sidebar" id="sidebar" />
           <script
             dangerouslySetInnerHTML={{
               __html: `window.__data=${serialize(

package/types/actions/actions/actions.d.ts

@@ -0,0 +1,7 @@
+/**
+ * List actions.
+ * @function listActions
+ * @param {string} url Content url.
+ * @returns {Object} List actions action.
+ */
+export function listActions(url: string): any;

package/types/actions/actions/actions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/addons/addons.d.ts

@@ -0,0 +1,27 @@
+/**
+ * List addons function
+ * @function listAddons
+ * @returns {Object} List addons action
+ */
+export function listAddons(): any;
+/**
+ * Install addon function.
+ * @function installAddon
+ * @param {string} id Addon id
+ * @returns {Object} install addon action.
+ */
+export function installAddon(id: string): any;
+/**
+ * Uninstall addon function.
+ * @function uninstallAddon
+ * @param {string} id Addon id
+ * @returns {Object} uninstall addon action.
+ */
+export function uninstallAddon(id: string): any;
+/**
+ * Uninstall addon function.
+ * @function upgradeAddon
+ * @param {string} id Addon id
+ * @returns {Object} id of addon to upgrade.
+ */
+export function upgradeAddon(id: string): any;

package/types/actions/addons/addons.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/aliases/aliases.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Get aliases function.
+ * @function getAliases
+ * @param {string} url Content url.
+ * @param {Object} options Options data.
+ * @returns {Object} Get aliases action.
+ */
+export function getAliases(url: string, options: any): any;
+/**
+ * Add alias function.
+ * @function addAliases
+ * @param {string} url Content url.
+ * @param {Object} data Aliases to add data object.
+ * @returns {Object} Add alias action.
+ */
+export function addAliases(url: string, data: any): any;
+/**
+ * Remove aliases function.
+ * @function removeAliases
+ * @param {string} url Content url.
+ * @param {Object} data Aliases to remove data object.
+ * @returns {Object} Remove alias action.
+ */
+export function removeAliases(url: string, data: any): any;

package/types/actions/aliases/aliases.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/asyncConnect/asyncConnect.d.ts

@@ -0,0 +1,24 @@
+export function clearKey(key: any): {
+    type: string;
+    key: any;
+};
+export function beginGlobalLoad(): {
+    type: string;
+};
+export function endGlobalLoad(): {
+    type: string;
+};
+export function load(key: any): {
+    type: string;
+    key: any;
+};
+export function loadSuccess(key: any, data: any): {
+    type: string;
+    key: any;
+    data: any;
+};
+export function loadFail(key: any, error: any): {
+    type: string;
+    key: any;
+    error: any;
+};

package/types/actions/authRole/authRole.d.ts

@@ -0,0 +1,4 @@
+export function authenticatedRole(role: any): {
+    type: any;
+    result: any;
+};

package/types/actions/authRole/authRole.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/blocksClipboard/blocksClipboard.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copy blocks to clipboard function.
+ * @function copyBlocks
+ * @param {array} blocksData Block data
+ * @returns {Object} Copy action.
+ */
+export function setBlocksClipboard(payload: any): any;
+/**
+ * Reset blocks clipboard function.
+ * @function resetBlocksClipboard
+ * @returns {Object} Reset blocks clipboard
+ */
+export function resetBlocksClipboard(): any;

package/types/actions/breadcrumbs/breadcrumbs.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get breadcrumbs.
+ * @function getBreadcrumbs
+ * @param {string} url Content url.
+ * @returns {Object} Get breadcrumbs action.
+ */
+export function getBreadcrumbs(url: string): any;

package/types/actions/breadcrumbs/breadcrumbs.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/clipboard/clipboard.d.ts

@@ -0,0 +1,30 @@
+/**
+ * Copy content function.
+ * @function copyContent
+ * @param {array} source Source urls.
+ * @param {string} target Target url.
+ * @returns {Object} Copy content action.
+ */
+export function copyContent(source: any[], target: string): any;
+/**
+ * Move content function.
+ * @function moveContent
+ * @param {array} source Source urls.
+ * @param {string} target Target url.
+ * @returns {Object} Move content action.
+ */
+export function moveContent(source: any[], target: string): any;
+/**
+ * Copy function.
+ * @function copy
+ * @param {array} urls Source urls.
+ * @returns {Object} Copy action.
+ */
+export function copy(urls: any[]): any;
+/**
+ * Cut function.
+ * @function cut
+ * @param {array} urls Source urls.
+ * @returns {Object} Cut action.
+ */
+export function cut(urls: any[]): any;

package/types/actions/clipboard/clipboard.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/comments/comments.d.ts

@@ -0,0 +1,37 @@
+/**
+ * Add comment function.
+ * @function addComment
+ * @param {string} url Content url.
+ * @param {string} text Body of the comment.
+ * @returns {Object} Add comment action.
+ */
+export function addComment(url: string, text: string, commentId: any): any;
+/**
+ * List comments function
+ * @function listComments
+ * @param {string} url Content url
+ * @returns {Object} List comment action
+ */
+export function listComments(url: string): any;
+export function listMoreComments(url: any): {
+    type: any;
+    request: {
+        op: string;
+        path: string;
+    };
+};
+/**
+ * Delete comment function.
+ * @function deleteComment
+ * @param {string} url Content url.
+ * @returns {Object} Delete comment action.
+ */
+export function deleteComment(url: string): any;
+/**
+ * Update comment function.
+ * @function updateComment
+ * @param {string} url Content url(s).
+ * @param {string} text Body of the comment.
+ * @returns {Object} Update content action.
+ */
+export function updateComment(url: string, text: string): any;

package/types/actions/comments/comments.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/content/content.d.ts

@@ -0,0 +1,90 @@
+/**
+ * Create content function.
+ * @function createContent
+ * @param {string} url Parent URL.
+ * @param {Object|Array} content Content data.
+ * @param {string} subrequest Optional. Key of the subrequest.
+ * @returns {Object} Create content action.
+ */
+export function createContent(url: string, content: any | any[], subrequest: string): any;
+/**
+ * Delete content function.
+ * @function deleteContent
+ * @param {string|Array} urls Content url(s).
+ * @returns {Object} Delete content action.
+ */
+export function deleteContent(urls: string | any[]): any;
+/**
+ * Update content function.
+ * @function updateContent
+ * @param {string|Array} urls Content url(s).
+ * @param {Object|Array} content Content data.
+ * @param {Object|Array} headers Custom headers.
+ * @returns {Object} Update content action.
+ */
+export function updateContent(urls: string | any[], content: any | any[], headers?: any | any[]): any;
+/**
+ * Order content function
+ * @function orderContent
+ * @param {string} parent Parent url
+ * @param {string} url Content url
+ * @param {string|number} delta Order delta
+ * @param {Array} subset Subset ids
+ * @returns {Object} Order content action
+ */
+export function orderContent(parent: string, url: string, delta: string | number, subset: any[]): any;
+/**
+ * Sort content function
+ * @function sortContent
+ * @param {string} url Content url
+ * @param {string} on Sort on index
+ * @param {string} order Sort order
+ * @returns {Object} Sort content action
+ */
+export function sortContent(url: string, on: string, order: string): any;
+/**
+ * Get content function
+ * @function getContent
+ * @param {string} url Content url
+ * @param {string} version Version id
+ * @param {string} subrequest Key of the subrequest.
+ * @param {boolean} fullobjects If full object information should be retrieved
+ * @returns {Object} Get content action
+ */
+export function getContent(url: string, version?: string, subrequest?: string, page?: any, fullobjects?: boolean): any;
+/**
+ * Reset content function
+ * @function resetContent
+ * @param {string} subrequest Key of the subrequest.
+ * @returns {Object} Get content action
+ */
+export function resetContent(subrequest?: string): any;
+/**
+ * Add, remove or order indexes
+ * @param {string} url Content url
+ * @param {string} index indexes with order
+ * @returns {Object} Index content action
+ */
+export function updateColumnsContent(url: string, index: string): any;
+/**
+ * Lock content function.
+ * @function lockContent
+ * @param {string} urls Content url(s)
+ * @returns {Object} Lock content action.
+ */
+export function lockContent(urls: string): any;
+/**
+ * Unlock content function.
+ * @function unlockContent
+ * @param {string|Array} urls Content url(s).
+ * @returns {Object} Unlock content action.
+ */
+export function unlockContent(urls: string | any[], force?: boolean): any;
+export function linkIntegrityCheck(selection: any): {
+    type: any;
+    mode: string;
+    request: {
+        op: string;
+        path: string;
+    };
+};

package/types/actions/content/content.multilingual.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/content/content.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/actions/contextNavigation/contextNavigation.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Get the context navigation
+ * @function getContextNavigation
+ * @param {string} url Content url.
+ * @param {params} params Options for the navigation component
+ * @returns {Object} Get context navigation action
+ */
+export function getContextNavigation(url: string, params?: any): any;

package/types/actions/contextNavigation/contextNavigation.test.d.ts

@@ -0,0 +1 @@
+export {};