@payloadcms/richtext-lexical 3.91.0-internal.6e3dc85 → 4.0.0-beta.0

package/dist/features/blocks/client/component/index.js

@@ -4,17 +4,21 @@ import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "react/jsx-run
 import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext';
 import { useLexicalEditable } from '@lexical/react/useLexicalEditable';
 import { getTranslation } from '@payloadcms/translations';
-import { Button, Collapsible, Drawer, EditDepthProvider, ErrorPill, Form, formatDrawerSlug, FormSubmit, Pill, RenderFields, SectionTitle, useConfig, useDocumentForm, useDocumentInfo, useEditDepth, useFormSubmitted, useServerFunctions, useTranslation } from '@payloadcms/ui';
+import { Button, Collapsible, Drawer, EditDepthProvider, ErrorPill, Form, formatDrawerSlug, MoreIcon, Pill, Popup, PopupList, RenderFields, SectionTitle, useConfig, useDocumentForm, useDocumentInfo, useEditDepth, useFormSubmitted, useServerFunctions, useTranslation, XIcon } from '@payloadcms/ui';
 import { abortAndIgnore } from '@payloadcms/ui/shared';
-import { $getNodeByKey, SKIP_DOM_SELECTION_TAG } from 'lexical';
-import { deepCopyObjectSimpleWithoutReactComponents, reduceFieldsToValues } from 'payload/shared';
+import { $getNodeByKey, $getRoot, SKIP_DOM_SELECTION_TAG } from 'lexical';
+import { deepCopyObjectSimpleWithoutReactComponents } from 'payload/shared';
 import React, { useCallback, useEffect, useMemo, useRef } from 'react';
 import { v4 as uuid } from 'uuid';
+import './index.css';
+import '../../../../utilities/fieldsDrawer/index.css';
 import { useEditorConfigContext } from '../../../../lexical/config/client/EditorConfigProvider.js';
+import { RegisterFormSubmit, useDrawerSubmit } from '../../../../utilities/fieldsDrawer/useDrawerSubmit.js';
 import { useLexicalDrawer } from '../../../../utilities/fieldsDrawer/useLexicalDrawer.js';
+import { getCachedFormStateIfDataMatches, reduceFormStateToBlockData } from '../getCachedFormStateIfDataMatches.js';
 import { $isBlockNode } from '../nodes/BlocksNode.js';
 import { BlockContent, useBlockComponentContext } from './BlockContent.js';
-import { removeEmptyArrayValues } from './removeEmptyArrayValues.js';
+import { BlockReordering } from './BlockReordering/index.js';
 export const BlockComponent = props => {
   const {
     cacheBuster,
@@ -65,31 +69,43 @@ export const BlockComponent = props => {
   const [editor] = useLexicalComposerContext();
   const isEditable = useLexicalEditable();
   const blockType = formData.blockType;
+  const formDataRef = useRef(formData);
+  formDataRef.current = formData;
+  const componentMapRenderedBlockPath = `${schemaPath}.lexical_internal_feature.blocks.lexical_blocks.${blockType}`;
+  const clientSchemaMap = featureClientSchemaMap['blocks'];
+  const blocksField = clientSchemaMap?.[componentMapRenderedBlockPath]?.[0];
+  const blockOrSlug = blocksField?.blocks?.[0];
+  const clientBlock = typeof blockOrSlug === 'string' ? config.blocksMap[blockOrSlug] : blockOrSlug;
   const {
     getFormState
   } = useServerFunctions();
   const schemaFieldsPath = `${schemaPath}.lexical_internal_feature.blocks.lexical_blocks.${blockType}.fields`;
   const [initialState, setInitialState] = React.useState(() => {
     // Initial form state that was calculated server-side. May have stale values
-    const cachedFormState = initialLexicalFormState?.[formData.id]?.formState;
+    const cachedState = initialLexicalFormState?.[formData.id];
+    const cachedFormState = cachedState?.formState;
     if (!cachedFormState) {
       return false;
     }
-    // Merge current formData values into the cached form state
-    // This ensures that when the component remounts (e.g., due to view changes), we don't lose user edits
-    const mergedState = Object.fromEntries(Object.entries(cachedFormState).map(([fieldName, fieldState]) => [fieldName, fieldName in formData ? {
-      ...fieldState,
-      initialValue: formData[fieldName],
-      value: formData[fieldName]
-    } : fieldState]));
+    const matchingCachedState = getCachedFormStateIfDataMatches({
+      cachedFormState,
+      cachedSchemaPath: cachedState.schemaPath,
+      currentSchemaPath: schemaFieldsPath,
+      formData
+    });
+    if (!matchingCachedState) {
+      return false;
+    }
     // Manually add blockName, as it's not part of cachedFormState
-    mergedState.blockName = {
-      initialValue: formData.blockName,
-      passesCondition: true,
-      valid: true,
-      value: formData.blockName
+    return {
+      ...matchingCachedState,
+      blockName: {
+        initialValue: formData.blockName,
+        passesCondition: true,
+        valid: true,
+        value: formData.blockName
+      }
     };
-    return mergedState;
   });
   const hasMounted = useRef(false);
   const prevCacheBuster = useRef(cacheBuster);
@@ -188,9 +204,9 @@ export const BlockComponent = props => {
           valid: true,
           value: formData.blockName
         };
-        const newFormStateData = reduceFieldsToValues(deepCopyObjectSimpleWithoutReactComponents(state, {
+        const newFormStateData = reduceFormStateToBlockData(deepCopyObjectSimpleWithoutReactComponents(state, {
           excludeFiles: true
-        }), true);
+        }));
         // Things like default values may come back from the server => update the node with the new data
         editor.update(() => {
           const node = $getNodeByKey(nodeKey);
@@ -214,18 +230,14 @@ export const BlockComponent = props => {
         }
       }
     };
-    if (formData && !initialState) {
+    if (clientBlock && formData && !initialState) {
       void awaitInitialState();
     }
     return () => {
       abortAndIgnore(abortController);
     };
-  }, [getFormState, schemaFieldsPath, isEditable, id, CustomLabelFromProps, CustomBlockFromProps, formData, editor, nodeKey, initialState, collectionSlug, globalSlug, getDocPreferences, parentDocumentFields, blockType]);
+  }, [getFormState, schemaFieldsPath, isEditable, id, CustomLabelFromProps, CustomBlockFromProps, formData, editor, nodeKey, initialState, collectionSlug, globalSlug, getDocPreferences, parentDocumentFields, blockType, clientBlock]);
   const [isCollapsed, setIsCollapsed] = React.useState(initialLexicalFormState?.[formData.id]?.collapsed ?? false);
-  const componentMapRenderedBlockPath = `${schemaPath}.lexical_internal_feature.blocks.lexical_blocks.${blockType}`;
-  const clientSchemaMap = featureClientSchemaMap['blocks'];
-  const blocksField = clientSchemaMap?.[componentMapRenderedBlockPath]?.[0];
-  const clientBlock = blocksField.blockReferences ? typeof blocksField?.blockReferences?.[0] === 'string' ? config.blocksMap[blocksField?.blockReferences?.[0]] : blocksField?.blockReferences?.[0] : blocksField?.blocks?.[0];
   const {
     i18n,
     t
@@ -237,11 +249,15 @@ export const BlockComponent = props => {
     abortAndIgnore(onChangeAbortControllerRef.current);
     const controller = new AbortController();
     onChangeAbortControllerRef.current = controller;
+    const blockData = reduceFormStateToBlockData(deepCopyObjectSimpleWithoutReactComponents(prevFormState, {
+      excludeFiles: true
+    }), formDataRef.current);
     const {
       state: newFormState
     } = await getFormState({
       id,
       collectionSlug,
+      data: blockData,
       docPermissions: {
         fields: true
       },
@@ -251,7 +267,7 @@ export const BlockComponent = props => {
       }),
       formState: prevFormState,
       globalSlug,
-      initialBlockFormState: prevFormState,
+      initialBlockData: blockData,
       operation: 'update',
       readOnly: !isEditable,
       renderAllFields: submit ? true : false,
@@ -264,11 +280,9 @@ export const BlockComponent = props => {
     if (prevFormState.blockName) {
       newFormState.blockName = prevFormState.blockName;
     }
-    const newFormStateData_0 = reduceFieldsToValues(removeEmptyArrayValues({
-      fields: deepCopyObjectSimpleWithoutReactComponents(newFormState, {
-        excludeFiles: true
-      })
-    }), true);
+    const newFormStateData_0 = reduceFormStateToBlockData(deepCopyObjectSimpleWithoutReactComponents(newFormState, {
+      excludeFiles: true
+    }), blockData);
     setTimeout(() => {
       editor.update(() => {
         const node_0 = $getNodeByKey(nodeKey);
@@ -311,6 +325,29 @@ export const BlockComponent = props => {
       $getNodeByKey(nodeKey)?.remove();
     });
   }, [editor, nodeKey]);
+  const [rowIndex, setRowIndex] = React.useState(0);
+  useEffect(() => {
+    const updateIndex = () => {
+      editor.getEditorState().read(() => {
+        const root = $getRoot();
+        const children = root.getChildren();
+        let blockCount = 0;
+        for (const child of children) {
+          if ($isBlockNode(child)) {
+            if (child.getKey() === nodeKey) {
+              setRowIndex(blockCount);
+              return;
+            }
+            blockCount++;
+          }
+        }
+      });
+    };
+    updateIndex();
+    return editor.registerUpdateListener(() => {
+      updateIndex();
+    });
+  }, [editor, nodeKey]);
   const blockDisplayName = clientBlock?.labels?.singular ? getTranslation(clientBlock.labels.singular, i18n) : clientBlock?.slug;
   const onCollapsedChange = useCallback(changedCollapsed => {
     void getDocPreferences().then(currentDocPreferences => {
@@ -333,7 +370,7 @@ export const BlockComponent = props => {
     });
   }, [getDocPreferences, parentLexicalRichTextField.name, setDocFieldPreferences, formData.id]);
   const EditButton = useMemo(() => () => /*#__PURE__*/_jsx(Button, {
-    buttonStyle: "icon-label",
+    buttonStyle: "ghost",
     className: `${baseClass}__editButton`,
     disabled: !isEditable,
     el: "button",
@@ -350,13 +387,13 @@ export const BlockComponent = props => {
       e_0.preventDefault();
     },
     round: true,
-    size: "small",
+    size: "medium",
     tooltip: t('lexical:blocks:inlineBlocks:edit', {
       label: blockDisplayName
     })
   }), [baseClass, isEditable, t, blockDisplayName, toggleDrawer]);
   const RemoveButton = useMemo(() => () => /*#__PURE__*/_jsx(Button, {
-    buttonStyle: "icon-label",
+    buttonStyle: "ghost",
     className: `${baseClass}__removeButton`,
     disabled: !isEditable,
     icon: "x",
@@ -367,9 +404,9 @@ export const BlockComponent = props => {
     round: true,
     tooltip: "Remove Block"
   }), [baseClass, isEditable, removeBlock]);
-  const BlockCollapsible = useMemo(() => ({
+  const BlockCollapsible = useMemo(() => function BlockCollapsible({
     Actions,
-    children,
+    children: children_0,
     className,
     collapsibleProps,
     disableBlockName,
@@ -378,56 +415,152 @@ export const BlockComponent = props => {
     fieldHasErrors,
     Label,
     Pill: CustomPill,
-    removeButton
-  }) => {
-    return /*#__PURE__*/_jsx("div", {
-      className: `${baseClass}__container ${baseClass}-${blockType}`,
-      children: /*#__PURE__*/_jsx(Collapsible, {
-        className: [`${baseClass}__row`, fieldHasErrors ? `${baseClass}__row--has-errors` : `${baseClass}__row--no-errors`, className].filter(Boolean).join(' '),
-        collapsibleStyle: fieldHasErrors ? 'error' : 'default',
-        header: /*#__PURE__*/_jsxs("div", {
-          className: `${baseClass}__block-header`,
-          children: [typeof Label !== 'undefined' ? Label : typeof resolvedCustomLabel !== 'undefined' ? resolvedCustomLabel : /*#__PURE__*/_jsxs("div", {
-            className: `${baseClass}__block-label`,
-            children: [typeof CustomPill !== 'undefined' ? CustomPill : /*#__PURE__*/_jsx(Pill, {
-              className: `${baseClass}__block-pill ${baseClass}__block-pill-${blockType}`,
-              pillStyle: "white",
-              size: "small",
-              children: blockDisplayName ?? blockType
-            }), !disableBlockName && !clientBlock?.admin?.disableBlockName && /*#__PURE__*/_jsx(SectionTitle, {
-              path: "blockName",
-              readOnly: !isEditable
-            }), fieldHasErrors && /*#__PURE__*/_jsx(ErrorPill, {
-              count: errorCount_0 ?? 0,
-              i18n: i18n,
-              withMessage: true
-            })]
-          }), /*#__PURE__*/_jsx("div", {
-            className: `${baseClass}__block-actions`,
-            children: typeof Actions !== 'undefined' ? Actions : /*#__PURE__*/_jsxs(_Fragment, {
-              children: [resolvedCustomBlock && editButton !== false || !resolvedCustomBlock && editButton ? /*#__PURE__*/_jsx(EditButton, {}) : null, removeButton !== false && isEditable ? /*#__PURE__*/_jsx(RemoveButton, {}) : null]
-            })
-          })]
-        }),
-        isCollapsed: isCollapsed,
-        onToggle: incomingCollapsedState => {
-          onCollapsedChange(incomingCollapsedState);
-          setIsCollapsed(incomingCollapsedState);
+    removeButton,
+    showDragHandle = true,
+    showRowNumber = true
+  }) {
+    return /*#__PURE__*/_jsx(BlockReordering, {
+      editor: editor,
+      nodeKey: nodeKey,
+      children: ({
+        isReordering,
+        move,
+        onBlur,
+        onKeyDown,
+        reorderInstructionsID,
+        targetIndex
+      }) => /*#__PURE__*/_jsx("div", {
+        className: `${baseClass}__container ${baseClass}-${blockType}`,
+        onKeyDownCapture: event => {
+          const target = event.target;
+          if (event.altKey || event.ctrlKey || event.metaKey || target.closest('.collapsible')?.parentElement !== event.currentTarget) {
+            return;
+          }
+          // Handle controls before Lexical consumes keys using its retained text selection.
+          if (target.matches('.collapsible__drag') && (event.key !== 'Escape' || isReordering) && [' ', 'ArrowDown', 'ArrowUp', 'Enter', 'Escape', 'Tab'].includes(event.key)) {
+            onKeyDown(event);
+            event.stopPropagation();
+          } else if (event.key === 'Tab' && target.matches('.collapsible__toggle')) {
+            event.stopPropagation();
+          }
         },
-        ...(collapsibleProps || {}),
-        children: children
-      }, 0)
+        children: /*#__PURE__*/_jsxs(Collapsible, {
+          actions: typeof Actions !== 'undefined' ? Actions : isEditable ? /*#__PURE__*/_jsx(Popup, {
+            button: /*#__PURE__*/_jsx(MoreIcon, {}),
+            buttonAriaLabel: t('general:moreOptions'),
+            buttonClassName: `${baseClass}__actions-button`,
+            caret: false,
+            horizontalAlign: "right",
+            popupType: "menu",
+            render: ({
+              close
+            }) => /*#__PURE__*/_jsxs(PopupList.ButtonGroup, {
+              buttonSize: "medium",
+              children: [/*#__PURE__*/_jsx(PopupList.Button, {
+                onClick: () => {
+                  close();
+                  move({
+                    direction: -1
+                  });
+                },
+                children: t('general:moveUp')
+              }), /*#__PURE__*/_jsx(PopupList.Button, {
+                onClick: () => {
+                  close();
+                  move({
+                    direction: 1
+                  });
+                },
+                children: t('general:moveDown')
+              }), (resolvedCustomBlock && editButton !== false || !resolvedCustomBlock && editButton) && /*#__PURE__*/_jsx(PopupList.Button, {
+                onClick: () => {
+                  toggleDrawer();
+                  close();
+                },
+                children: t('general:edit')
+              }), removeButton !== false && /*#__PURE__*/_jsxs(PopupList.Button, {
+                onClick: () => {
+                  removeBlock();
+                  close();
+                },
+                children: [/*#__PURE__*/_jsx(XIcon, {}), t('general:remove')]
+              })]
+            }),
+            size: "large"
+          }) : null,
+          className: [`${baseClass}__row`, fieldHasErrors ? `${baseClass}__row--has-errors` : `${baseClass}__row--no-errors`, className].filter(Boolean).join(' '),
+          collapsibleStyle: fieldHasErrors ? 'error' : 'default',
+          dragHandleProps: showDragHandle && isEditable ? {
+            id: nodeKey,
+            attributes: {
+              'aria-describedby': reorderInstructionsID,
+              'aria-pressed': isReordering,
+              role: 'button',
+              tabIndex: 0
+            },
+            listeners: {
+              onBlur
+            }
+          } : undefined,
+          header: /*#__PURE__*/_jsx("div", {
+            className: `${baseClass}__block-header`,
+            children: typeof Label !== 'undefined' ? Label : typeof resolvedCustomLabel !== 'undefined' ? resolvedCustomLabel : /*#__PURE__*/_jsxs("div", {
+              className: `${baseClass}__block-label`,
+              children: [showRowNumber && /*#__PURE__*/_jsx("span", {
+                className: `${baseClass}__block-number`,
+                children: String(rowIndex + 1).padStart(2, '0')
+              }), typeof CustomPill !== 'undefined' ? CustomPill : /*#__PURE__*/_jsx(Pill, {
+                className: `${baseClass}__block-pill ${baseClass}__block-pill-${blockType}`,
+                pillStyle: "white",
+                size: "small",
+                children: blockDisplayName ?? blockType
+              }), !disableBlockName && !clientBlock?.admin?.disableBlockName && /*#__PURE__*/_jsx(SectionTitle, {
+                path: "blockName",
+                readOnly: !isEditable
+              }), fieldHasErrors && /*#__PURE__*/_jsx(ErrorPill, {
+                count: errorCount_0 ?? 0,
+                i18n: i18n,
+                withMessage: true
+              })]
+            })
+          }),
+          isCollapsed: isCollapsed,
+          onToggle: incomingCollapsedState => {
+            onCollapsedChange(incomingCollapsedState);
+            setIsCollapsed(incomingCollapsedState);
+          },
+          ...(collapsibleProps || {}),
+          AfterCollapsible: /*#__PURE__*/_jsxs(_Fragment, {
+            children: [collapsibleProps?.AfterCollapsible, /*#__PURE__*/_jsx("span", {
+              className: "sr-only",
+              role: "status",
+              children: isReordering ? `${t('general:order')}: ${(targetIndex ?? 0) + 1}` : ''
+            })]
+          }),
+          children: [/*#__PURE__*/_jsxs("span", {
+            className: "sr-only",
+            id: reorderInstructionsID,
+            children: ["Space / Enter · ", t('general:moveUp'), " ↑ · ", t('general:moveDown'), " ↓ ·", ' ', t('general:cancel'), " Escape"]
+          }), children_0]
+        }, 0)
+      })
     });
-  }, [resolvedCustomBlock, resolvedCustomLabel, EditButton, RemoveButton, blockDisplayName, baseClass, clientBlock?.admin?.disableBlockName, blockType, i18n, isCollapsed, onCollapsedChange, isEditable]);
+  }, [editor, resolvedCustomBlock, resolvedCustomLabel, blockDisplayName, baseClass, clientBlock?.admin?.disableBlockName, blockType, i18n, isCollapsed, onCollapsedChange, isEditable, nodeKey, removeBlock, rowIndex, t, toggleDrawer]);
   const blockID = formData?.id;
+  const {
+    headerActions,
+    submitRef
+  } = useDrawerSubmit();
   const BlockDrawer = useMemo(() => () => /*#__PURE__*/_jsx(EditDepthProvider, {
     children: /*#__PURE__*/_jsx(Drawer, {
       className: '',
+      headerActions: headerActions,
       slug: drawerSlug,
       title: t(`lexical:blocks:inlineBlocks:${blockID ? 'edit' : 'create'}`, {
         label: blockDisplayName ?? t('lexical:blocks:inlineBlocks:label')
       }),
-      children: initialState ? /*#__PURE__*/_jsxs(_Fragment, {
+      children: initialState ? /*#__PURE__*/_jsxs("div", {
+        className: "fields-drawer",
         children: [/*#__PURE__*/_jsx(RenderFields, {
           fields: clientBlock?.fields ?? [],
           forceRender: true,
@@ -436,13 +569,12 @@ export const BlockComponent = props => {
           parentSchemaPath: schemaFieldsPath,
           permissions: true,
           readOnly: !isEditable
-        }), /*#__PURE__*/_jsx(FormSubmit, {
-          programmaticSubmit: true,
-          children: t('fields:saveChanges')
+        }), /*#__PURE__*/_jsx(RegisterFormSubmit, {
+          submitRef: submitRef
         })]
       }) : null
     })
-  }), [initialState, drawerSlug, blockID, blockDisplayName, t, isEditable, clientBlock?.fields, schemaFieldsPath]);
+  }), [initialState, drawerSlug, blockID, blockDisplayName, t, isEditable, clientBlock?.fields, schemaFieldsPath, headerActions, submitRef]);
   // Memoized Form JSX
   const Block = useMemo(() => {
     if (!initialState) {
@@ -467,8 +599,9 @@ export const BlockComponent = props => {
         fields: clientBlock?.fields ?? [],
         initialState: initialState,
         onChange: [onChange],
-        onSubmit: (formState_0, newData_1) => {
+        onSubmit: formState_0 => {
           // This is only called when form is submitted from drawer - usually only the case if the block has a custom Block component
+          const newData_1 = reduceFormStateToBlockData(formState_0, formDataRef.current);
           newData_1.blockType = blockType;
           editor.update(() => {
             const node_1 = $getNodeByKey(nodeKey);