@payloadcms/richtext-lexical 3.0.0-beta.45 → 3.0.0-beta.47

package/dist/index.js

@@ -1,5 +1,5 @@
 import { withMergedProps } from '@payloadcms/ui/elements/withMergedProps';
-import { withNullableJSONSchemaType } from 'payload/utilities';
+import { afterChangeTraverseFields, afterReadTraverseFields, beforeChangeTraverseFields, beforeValidateTraverseFields, withNullableJSONSchemaType } from 'payload/utilities';
 import { RichTextCell } from './cell/index.js';
 import { RichTextField } from './field/index.js';
 import { defaultEditorConfig, defaultEditorFeatures } from './field/lexical/config/server/default.js';
@@ -9,7 +9,8 @@ import { cloneDeep } from './field/lexical/utils/cloneDeep.js';
 import { getGenerateComponentMap } from './generateComponentMap.js';
 import { getGenerateSchemaMap } from './generateSchemaMap.js';
 import { i18n } from './i18n.js';
-import { populateLexicalPopulationPromises } from './populate/populateLexicalPopulationPromises.js';
+import { populateLexicalPopulationPromises } from './populateGraphQL/populateLexicalPopulationPromises.js';
+import { recurseNodeTree } from './recurseNodeTree.js';
 import { richTextValidateHOC } from './validate/index.js';
 let defaultSanitizedServerEditorConfig = null;
 export function lexicalEditor(props) {
@@ -85,104 +86,421 @@ export function lexicalEditor(props) {
             generateSchemaMap: getGenerateSchemaMap({
                 resolvedFeatureMap
             }),
-            i18n: featureI18n,
-            /* hooks: {
-        afterChange: finalSanitizedEditorConfig.features.hooks.afterChange,
-        afterRead: finalSanitizedEditorConfig.features.hooks.afterRead,
-        beforeChange: finalSanitizedEditorConfig.features.hooks.beforeChange,
-        beforeDuplicate: finalSanitizedEditorConfig.features.hooks.beforeDuplicate,
-        beforeValidate: finalSanitizedEditorConfig.features.hooks.beforeValidate,
-      },*/ /* // TODO: Figure out docWithLocales / originalSiblingDoc => node matching. Can't use indexes, as the order of nodes could technically change between hooks.
-      hooks: {
-        afterChange: [
-          async ({ context, findMany, operation, overrideAccess, req, value }) => {
-            await recurseNodesAsync({
-              callback: async (node) => {
-                const afterChangeHooks = finalSanitizedEditorConfig.features.hooks.afterChange
-                if (afterChangeHooks?.has(node.type)) {
-                  for (const hook of afterChangeHooks.get(node.type)) {
-                    node = await hook({ context, findMany, node, operation, overrideAccess, req })
-                  }
-                }
-              },
-              nodes: (value as SerializedEditorState)?.root?.children ?? [],
-            })
-
-            return value
-          },
-        ],
-        afterRead: [
-          async ({ context, findMany, operation, overrideAccess, req, value }) => {
-            await recurseNodesAsync({
-              callback: async (node) => {
-                const afterReadHooks = finalSanitizedEditorConfig.features.hooks.afterRead
-                if (afterReadHooks?.has(node.type)) {
-                  for (const hook of afterReadHooks.get(node.type)) {
-                    node = await hook({ context, findMany, node, operation, overrideAccess, req })
-                  }
-                }
-              },
-              nodes: (value as SerializedEditorState)?.root?.children ?? [],
-            })
-
-            return value
-          },
-        ],
-        beforeChange: [
-          async ({ context, findMany, operation, overrideAccess, req, value }) => {
-            await recurseNodesAsync({
-              callback: async (node) => {
-                const beforeChangeHooks = finalSanitizedEditorConfig.features.hooks.beforeChange
-                if (beforeChangeHooks?.has(node.type)) {
-                  for (const hook of beforeChangeHooks.get(node.type)) {
-                    node = await hook({ context, findMany, node, operation, overrideAccess, req })
-                  }
-                }
-              },
-              nodes: (value as SerializedEditorState)?.root?.children ?? [],
-            })
-
-            return value
-          },
-        ],
-        beforeDuplicate: [
-          async ({ context, findMany, operation, overrideAccess, req, value }) => {
-            await recurseNodesAsync({
-              callback: async (node) => {
-                const beforeDuplicateHooks = finalSanitizedEditorConfig.features.hooks.beforeDuplicate
-                if (beforeDuplicateHooks?.has(node.type)) {
-                  for (const hook of beforeDuplicateHooks.get(node.type)) {
-                    node = await hook({ context, findMany, node, operation, overrideAccess, req })
-                  }
+            graphQLPopulationPromises ({ context, currentDepth, depth, draft, field, fieldPromises, findMany, flattenLocales, overrideAccess, populationPromises, req, showHiddenFields, siblingDoc }) {
+                // check if there are any features with nodes which have populationPromises for this field
+                if (finalSanitizedEditorConfig?.features?.graphQLPopulationPromises?.size) {
+                    populateLexicalPopulationPromises({
+                        context,
+                        currentDepth: currentDepth ?? 0,
+                        depth,
+                        draft,
+                        editorPopulationPromises: finalSanitizedEditorConfig.features.graphQLPopulationPromises,
+                        field,
+                        fieldPromises,
+                        findMany,
+                        flattenLocales,
+                        overrideAccess,
+                        populationPromises,
+                        req,
+                        showHiddenFields,
+                        siblingDoc
+                    });
                 }
-              },
-              nodes: (value as SerializedEditorState)?.root?.children ?? [],
-            })
-
-            return value
-          },
-        ],
-        beforeValidate: [
-          async ({ context, findMany, operation, overrideAccess, req, value }) => {
-            await recurseNodesAsync({
-              callback: async (node) => {
-                const beforeValidateHooks = finalSanitizedEditorConfig.features.hooks.beforeValidate
-                if (beforeValidateHooks?.has(node.type)) {
-                  for (const hook of beforeValidateHooks.get(node.type)) {
+            },
+            hooks: {
+                afterChange: [
+                    async ({ collection, context: _context, global, operation, path, req, schemaPath, value })=>{
+                        if (!finalSanitizedEditorConfig.features.hooks.afterChange.size && !finalSanitizedEditorConfig.features.getSubFields.size) {
+                            return value;
+                        }
+                        const context = _context;
+                        const nodeIDMap = {};
+                        /**
+             * Get the originalNodeIDMap from the beforeValidate hook, which is always run before this hook.
+             */ const originalNodeIDMap = context?.internal?.richText?.[path.join('.')]?.originalNodeIDMap;
+                        if (!originalNodeIDMap || !Object.keys(originalNodeIDMap).length || !value) {
+                            return value;
+                        }
+                        recurseNodeTree({
+                            nodeIDMap,
+                            nodes: value?.root?.children ?? []
+                        });
+                        // eslint-disable-next-line prefer-const
+                        for (let [id, node] of Object.entries(nodeIDMap)){
+                            const afterChangeHooks = finalSanitizedEditorConfig.features.hooks.afterChange;
+                            if (afterChangeHooks?.has(node.type)) {
+                                for (const hook of afterChangeHooks.get(node.type)){
+                                    if (!originalNodeIDMap[id]) {
+                                        console.warn('(afterChange) No original node found for node with id', id, 'node:', node, 'path', path.join('.'));
+                                        continue;
+                                    }
+                                    node = await hook({
+                                        context,
+                                        node,
+                                        operation,
+                                        originalNode: originalNodeIDMap[id],
+                                        parentRichTextFieldPath: path,
+                                        parentRichTextFieldSchemaPath: schemaPath,
+                                        req
+                                    });
+                                }
+                            }
+                            const subFieldFn = finalSanitizedEditorConfig.features.getSubFields.get(node.type);
+                            const subFieldDataFn = finalSanitizedEditorConfig.features.getSubFieldsData.get(node.type);
+                            if (subFieldFn) {
+                                const subFields = subFieldFn({
+                                    node,
+                                    req
+                                });
+                                const data = subFieldDataFn({
+                                    node,
+                                    req
+                                });
+                                const originalData = subFieldDataFn({
+                                    node: originalNodeIDMap[id],
+                                    req
+                                });
+                                if (subFields?.length) {
+                                    await afterChangeTraverseFields({
+                                        collection,
+                                        context,
+                                        data: originalData,
+                                        doc: data,
+                                        fields: subFields,
+                                        global,
+                                        operation,
+                                        path,
+                                        previousDoc: data,
+                                        previousSiblingDoc: {
+                                            ...data
+                                        },
+                                        req,
+                                        schemaPath,
+                                        siblingData: originalData || {},
+                                        siblingDoc: {
+                                            ...data
+                                        }
+                                    });
+                                }
+                            }
+                        }
+                        return value;
+                    }
+                ],
+                afterRead: [
                     /**
-                     * We cannot pass the originalNode here, as there is no way to map one node to a previous one, as a previous originalNode might be in a different position
-                     */ /*
-                  node = await hook({ context, findMany, node, operation, overrideAccess, req })
-                }
-              }
+           * afterRead hooks do not receive the originalNode. Thus, they can run on all nodes, not just nodes with an ID.
+           */ async ({ collection, context: context, currentDepth, depth, draft, fallbackLocale, fieldPromises, findMany, flattenLocales, global, locale, overrideAccess, path, populationPromises, req, schemaPath, showHiddenFields, triggerAccessControl, triggerHooks, value })=>{
+                        if (!finalSanitizedEditorConfig.features.hooks.afterRead.size && !finalSanitizedEditorConfig.features.getSubFields.size) {
+                            return value;
+                        }
+                        const flattenedNodes = [];
+                        recurseNodeTree({
+                            flattenedNodes,
+                            nodes: value?.root?.children ?? []
+                        });
+                        for (let node of flattenedNodes){
+                            const afterReadHooks = finalSanitizedEditorConfig.features.hooks.afterRead;
+                            if (afterReadHooks?.has(node.type)) {
+                                for (const hook of afterReadHooks.get(node.type)){
+                                    node = await hook({
+                                        context,
+                                        currentDepth,
+                                        depth,
+                                        draft,
+                                        fallbackLocale,
+                                        fieldPromises,
+                                        findMany,
+                                        flattenLocales,
+                                        locale,
+                                        node,
+                                        overrideAccess,
+                                        parentRichTextFieldPath: path,
+                                        parentRichTextFieldSchemaPath: schemaPath,
+                                        populationPromises,
+                                        req,
+                                        showHiddenFields,
+                                        triggerAccessControl,
+                                        triggerHooks
+                                    });
+                                }
+                            }
+                            const subFieldFn = finalSanitizedEditorConfig.features.getSubFields.get(node.type);
+                            const subFieldDataFn = finalSanitizedEditorConfig.features.getSubFieldsData.get(node.type);
+                            if (subFieldFn) {
+                                const subFields = subFieldFn({
+                                    node,
+                                    req
+                                });
+                                const data = subFieldDataFn({
+                                    node,
+                                    req
+                                });
+                                if (subFields?.length) {
+                                    afterReadTraverseFields({
+                                        collection,
+                                        context,
+                                        currentDepth,
+                                        depth,
+                                        doc: data,
+                                        draft,
+                                        fallbackLocale,
+                                        fieldPromises,
+                                        fields: subFields,
+                                        findMany,
+                                        flattenLocales,
+                                        global,
+                                        locale,
+                                        overrideAccess,
+                                        path,
+                                        populationPromises,
+                                        req,
+                                        schemaPath,
+                                        showHiddenFields,
+                                        siblingDoc: data,
+                                        triggerAccessControl,
+                                        triggerHooks
+                                    });
+                                }
+                            }
+                        }
+                        return value;
+                    }
+                ],
+                beforeChange: [
+                    async ({ collection, context: _context, duplicate, errors, field, global, mergeLocaleActions, operation, path, req, schemaPath, siblingData, siblingDocWithLocales, skipValidation, value })=>{
+                        if (!finalSanitizedEditorConfig.features.hooks.beforeChange.size && !finalSanitizedEditorConfig.features.getSubFields.size) {
+                            return value;
+                        }
+                        const context = _context;
+                        const nodeIDMap = {};
+                        /**
+             * Get the originalNodeIDMap from the beforeValidate hook, which is always run before this hook.
+             */ const originalNodeIDMap = context?.internal?.richText?.[path.join('.')]?.originalNodeIDMap;
+                        if (!originalNodeIDMap || !Object.keys(originalNodeIDMap).length || !value) {
+                            return value;
+                        }
+                        const originalNodeWithLocalesIDMap = {};
+                        recurseNodeTree({
+                            nodeIDMap,
+                            nodes: value?.root?.children ?? []
+                        });
+                        if (siblingDocWithLocales?.[field.name]) {
+                            recurseNodeTree({
+                                nodeIDMap: originalNodeWithLocalesIDMap,
+                                nodes: siblingDocWithLocales[field.name]?.root?.children ?? []
+                            });
+                        }
+                        // eslint-disable-next-line prefer-const
+                        for (let [id, node] of Object.entries(nodeIDMap)){
+                            const beforeChangeHooks = finalSanitizedEditorConfig.features.hooks.beforeChange;
+                            if (beforeChangeHooks?.has(node.type)) {
+                                for (const hook of beforeChangeHooks.get(node.type)){
+                                    if (!originalNodeIDMap[id]) {
+                                        console.warn('(beforeChange) No original node found for node with id', id, 'node:', node, 'path', path.join('.'));
+                                        continue;
+                                    }
+                                    node = await hook({
+                                        context,
+                                        duplicate,
+                                        errors,
+                                        mergeLocaleActions,
+                                        node,
+                                        operation,
+                                        originalNode: originalNodeIDMap[id],
+                                        originalNodeWithLocales: originalNodeWithLocalesIDMap[id],
+                                        parentRichTextFieldPath: path,
+                                        parentRichTextFieldSchemaPath: schemaPath,
+                                        req,
+                                        skipValidation
+                                    });
+                                }
+                            }
+                            const subFieldFn = finalSanitizedEditorConfig.features.getSubFields.get(node.type);
+                            const subFieldDataFn = finalSanitizedEditorConfig.features.getSubFieldsData.get(node.type);
+                            if (subFieldFn) {
+                                const subFields = subFieldFn({
+                                    node,
+                                    req
+                                });
+                                const data = subFieldDataFn({
+                                    node,
+                                    req
+                                });
+                                const originalData = subFieldDataFn({
+                                    node: originalNodeIDMap[id],
+                                    req
+                                });
+                                const originalDataWithLocales = subFieldDataFn({
+                                    node: originalNodeWithLocalesIDMap[id],
+                                    req
+                                });
+                                if (subFields?.length) {
+                                    await beforeChangeTraverseFields({
+                                        id,
+                                        collection,
+                                        context,
+                                        data,
+                                        doc: originalData,
+                                        docWithLocales: originalDataWithLocales ?? {},
+                                        duplicate,
+                                        errors,
+                                        fields: subFields,
+                                        global,
+                                        mergeLocaleActions,
+                                        operation,
+                                        path,
+                                        req,
+                                        schemaPath,
+                                        siblingData: data,
+                                        siblingDoc: originalData,
+                                        siblingDocWithLocales: originalDataWithLocales ?? {},
+                                        skipValidation
+                                    });
+                                }
+                            }
+                        }
+                        /**
+             * within the beforeChange hook, id's may be re-generated.
+             * Example:
+             * 1. Seed data contains IDs for block feature blocks.
+             * 2. Those are used in beforeValidate
+             * 3. in beforeChange, those IDs are regenerated, because you cannot provide IDs during document creation. See baseIDField beforeChange hook for reasoning
+             * 4. Thus, in order for all post-beforeChange hooks to receive the correct ID, we need to update the originalNodeIDMap with the new ID's, by regenerating the nodeIDMap.
+             * The reason this is not generated for every hook, is to save on performance. We know we only really have to generate it in beforeValidate, which is the first hook,
+             * and in beforeChange, which is where modifications to the provided IDs can occur.
+             */ const newOriginalNodeIDMap = {};
+                        const previousValue = siblingData[field.name];
+                        recurseNodeTree({
+                            nodeIDMap: newOriginalNodeIDMap,
+                            nodes: previousValue?.root?.children ?? []
+                        });
+                        if (!context.internal) {
+                            // Add to context, for other hooks to use
+                            context.internal = {};
+                        }
+                        if (!context.internal.richText) {
+                            context.internal.richText = {};
+                        }
+                        context.internal.richText[path.join('.')] = {
+                            originalNodeIDMap: newOriginalNodeIDMap
+                        };
+                        return value;
+                    }
+                ],
+                beforeValidate: [
+                    async ({ collection, context, global, operation, overrideAccess, path, previousValue, req, schemaPath, value })=>{
+                        // return value if there are NO hooks
+                        if (!finalSanitizedEditorConfig.features.hooks.beforeValidate.size && !finalSanitizedEditorConfig.features.hooks.afterChange.size && !finalSanitizedEditorConfig.features.hooks.beforeChange.size && !finalSanitizedEditorConfig.features.getSubFields.size) {
+                            return value;
+                        }
+                        /**
+             * beforeValidate is the first field hook which runs. This is where we can create the node map, which can then be used in the other hooks.
+             *
+             */ /**
+             * flattenedNodes contains all nodes in the editor, in the order they appear in the editor. They will be used for the following hooks:
+             * - afterRead
+             *
+             * The other hooks require nodes to have IDs, which is why those are ran only from the nodeIDMap. They require IDs because they have both doc/siblingDoc and data/siblingData, and
+             * thus require a reliable way to match new node data to old node data. Given that node positions can change in between hooks, this is only reliably possible for nodes which are saved with
+             * an ID.
+             */ //const flattenedNodes: SerializedLexicalNode[] = []
+                        /**
+             * Only nodes with id's (so, nodes with hooks added to them) will be added to the nodeIDMap. They will be used for the following hooks:
+             * - afterChange
+             * - beforeChange
+             * - beforeValidate
+             * - beforeDuplicate
+             *
+             * Other hooks are handled by the flattenedNodes. All nodes in the nodeIDMap are part of flattenedNodes.
+             */ const originalNodeIDMap = {};
+                        recurseNodeTree({
+                            nodeIDMap: originalNodeIDMap,
+                            nodes: previousValue?.root?.children ?? []
+                        });
+                        if (!context.internal) {
+                            // Add to context, for other hooks to use
+                            context.internal = {};
+                        }
+                        if (!context.internal.richText) {
+                            context.internal.richText = {};
+                        }
+                        context.internal.richText[path.join('.')] = {
+                            originalNodeIDMap
+                        };
+                        /**
+             * Now that the maps for all hooks are set up, we can run the validate hook
+             */ if (!finalSanitizedEditorConfig.features.hooks.beforeValidate.size) {
+                            return value;
+                        }
+                        const nodeIDMap = {};
+                        recurseNodeTree({
+                            //flattenedNodes,
+                            nodeIDMap,
+                            nodes: value?.root?.children ?? []
+                        });
+                        // eslint-disable-next-line prefer-const
+                        for (let [id, node] of Object.entries(nodeIDMap)){
+                            const beforeValidateHooks = finalSanitizedEditorConfig.features.hooks.beforeValidate;
+                            if (beforeValidateHooks?.has(node.type)) {
+                                for (const hook of beforeValidateHooks.get(node.type)){
+                                    if (!originalNodeIDMap[id]) {
+                                        console.warn('(beforeValidate) No original node found for node with id', id, 'node:', node, 'path', path.join('.'));
+                                        continue;
+                                    }
+                                    node = await hook({
+                                        context,
+                                        node,
+                                        operation,
+                                        originalNode: originalNodeIDMap[id],
+                                        overrideAccess,
+                                        parentRichTextFieldPath: path,
+                                        parentRichTextFieldSchemaPath: schemaPath,
+                                        req
+                                    });
+                                }
+                            }
+                            const subFieldFn = finalSanitizedEditorConfig.features.getSubFields.get(node.type);
+                            const subFieldDataFn = finalSanitizedEditorConfig.features.getSubFieldsData.get(node.type);
+                            if (subFieldFn) {
+                                const subFields = subFieldFn({
+                                    node,
+                                    req
+                                });
+                                const data = subFieldDataFn({
+                                    node,
+                                    req
+                                });
+                                const originalData = subFieldDataFn({
+                                    node: originalNodeIDMap[id],
+                                    req
+                                });
+                                if (subFields?.length) {
+                                    await beforeValidateTraverseFields({
+                                        id,
+                                        collection,
+                                        context,
+                                        data,
+                                        doc: originalData,
+                                        fields: subFields,
+                                        global,
+                                        operation,
+                                        overrideAccess,
+                                        path,
+                                        req,
+                                        schemaPath,
+                                        siblingData: data,
+                                        siblingDoc: originalData
+                                    });
+                                }
+                            }
+                        }
+                        return value;
+                    }
+                ]
             },
-            nodes: (value as SerializedEditorState)?.root?.children ?? [],
-          })
-
-          return value
-        },
-      ],
-    },*/ outputSchema: ({ collectionIDFieldTypes, config, field, interfaceNameDefinitions, isRequired })=>{
+            i18n: featureI18n,
+            outputSchema: ({ collectionIDFieldTypes, config, field, interfaceNameDefinitions, isRequired })=>{
                 let outputSchema = {
                     // This schema matches the SerializedEditorState type so far, that it's possible to cast SerializedEditorState to this schema without any errors.
                     // In the future, we should
@@ -274,27 +592,6 @@ export function lexicalEditor(props) {
                 }
                 return outputSchema;
             },
-            populationPromises ({ context, currentDepth, depth, draft, field, fieldPromises, findMany, flattenLocales, overrideAccess, populationPromises, req, showHiddenFields, siblingDoc }) {
-                // check if there are any features with nodes which have populationPromises for this field
-                if (finalSanitizedEditorConfig?.features?.populationPromises?.size) {
-                    populateLexicalPopulationPromises({
-                        context,
-                        currentDepth,
-                        depth,
-                        draft,
-                        editorPopulationPromises: finalSanitizedEditorConfig.features.populationPromises,
-                        field,
-                        fieldPromises,
-                        findMany,
-                        flattenLocales,
-                        overrideAccess,
-                        populationPromises,
-                        req,
-                        showHiddenFields,
-                        siblingDoc
-                    });
-                }
-            },
             validate: richTextValidateHOC({
                 editorConfig: finalSanitizedEditorConfig
             })
@@ -378,6 +675,6 @@ export { setFloatingElemPosition } from './field/lexical/utils/setFloatingElemPo
 export { setFloatingElemPositionForLinkEditor } from './field/lexical/utils/setFloatingElemPositionForLinkEditor.js';
 export { addSwipeDownListener, addSwipeLeftListener, addSwipeRightListener, addSwipeUpListener } from './field/lexical/utils/swipe.js';
 export { sanitizeUrl, validateUrl } from './field/lexical/utils/url.js';
-export { defaultRichTextValue } from './populate/defaultValue.js';
+export { defaultRichTextValue } from './populateGraphQL/defaultValue.js';
 
 //# sourceMappingURL=index.js.map