@payloadcms/richtext-lexical 3.0.0-beta.13 → 3.0.0-beta.130

package/dist/features/converters/html/field/index.js

@@ -0,0 +1,158 @@
+import { defaultHTMLConverters } from '../converter/defaultConverters.js';
+import { convertLexicalToHTML } from '../converter/index.js';
+/**
+ * Combines the default HTML converters with HTML converters found in the features, and with HTML converters configured in the htmlConverter feature.
+ *
+ * @param editorConfig
+ */
+export const consolidateHTMLConverters = ({
+  editorConfig
+}) => {
+  const htmlConverterFeature = editorConfig.resolvedFeatureMap.get('htmlConverter');
+  const htmlConverterFeatureProps = htmlConverterFeature?.sanitizedServerFeatureProps;
+  const defaultConvertersWithConvertersFromFeatures = [...defaultHTMLConverters];
+  for (const converter of editorConfig.features.converters.html) {
+    defaultConvertersWithConvertersFromFeatures.push(converter);
+  }
+  const finalConverters = htmlConverterFeatureProps?.converters && typeof htmlConverterFeatureProps?.converters === 'function' ? htmlConverterFeatureProps.converters({
+    defaultConverters: defaultConvertersWithConvertersFromFeatures
+  }) : htmlConverterFeatureProps?.converters || defaultConvertersWithConvertersFromFeatures;
+  // filter converters by nodeTypes. The last converter in the list wins. If there are multiple converters for the same nodeType, the last one will be used and the node types will be removed from
+  // previous converters. If previous converters do not have any nodeTypes left, they will be removed from the list.
+  // This guarantees that user-added converters which are added after the default ones will always have precedence
+  const foundNodeTypes = [];
+  const filteredConverters = [];
+  for (const converter of finalConverters.reverse()) {
+    if (!converter.nodeTypes?.length) {
+      continue;
+    }
+    const newConverter = {
+      converter: converter.converter,
+      nodeTypes: [...converter.nodeTypes]
+    };
+    newConverter.nodeTypes = newConverter.nodeTypes.filter(nodeType => {
+      if (foundNodeTypes.includes(nodeType)) {
+        return false;
+      }
+      foundNodeTypes.push(nodeType);
+      return true;
+    });
+    if (newConverter.nodeTypes.length) {
+      filteredConverters.push(newConverter);
+    }
+  }
+  return filteredConverters;
+};
+// find the path of this field, as well as its sibling fields, by looking for this `field` in fields and traversing it recursively
+function findFieldPathAndSiblingFields(fields, path, field) {
+  for (const curField of fields) {
+    if (curField === field) {
+      return {
+        path: [...path, curField.name],
+        siblingFields: fields
+      };
+    }
+    if ('fields' in curField) {
+      const result = findFieldPathAndSiblingFields(curField.fields, 'name' in curField ? [...path, curField.name] : [...path], field);
+      if (result) {
+        return result;
+      }
+    } else if ('tabs' in curField) {
+      for (const tab of curField.tabs) {
+        const result = findFieldPathAndSiblingFields(tab.fields, 'name' in tab ? [...path, tab.name] : [...path], field);
+        if (result) {
+          return result;
+        }
+      }
+    } else if ('blocks' in curField) {
+      for (const block of curField.blocks) {
+        if (block?.fields?.length) {
+          const result = findFieldPathAndSiblingFields(block.fields, [...path, curField.name, block.slug], field);
+          if (result) {
+            return result;
+          }
+        }
+      }
+    }
+  }
+  return null;
+}
+export const lexicalHTML = (lexicalFieldName, props) => {
+  const {
+    name = 'lexicalHTML',
+    hidden = true,
+    storeInDB = false
+  } = props;
+  return {
+    name,
+    type: 'code',
+    admin: {
+      editorOptions: {
+        language: 'html'
+      },
+      hidden
+    },
+    hooks: {
+      afterRead: [async ({
+        collection,
+        currentDepth,
+        depth,
+        draft,
+        field,
+        global,
+        overrideAccess,
+        req,
+        showHiddenFields,
+        siblingData
+      }) => {
+        const fields = collection ? collection.fields : global.fields;
+        const foundSiblingFields = findFieldPathAndSiblingFields(fields, [], field);
+        if (!foundSiblingFields) {
+          throw new Error(`Could not find sibling fields of current lexicalHTML field with name ${field?.name}`);
+        }
+        const {
+          siblingFields
+        } = foundSiblingFields;
+        const lexicalField = siblingFields.find(field => 'name' in field && field.name === lexicalFieldName);
+        const lexicalFieldData = siblingData[lexicalFieldName];
+        if (!lexicalFieldData) {
+          return '';
+        }
+        if (!lexicalField) {
+          throw new Error('You cannot use the lexicalHTML field because the referenced lexical field was not found');
+        }
+        const config = lexicalField?.editor?.editorConfig;
+        if (!config) {
+          throw new Error('The linked lexical field does not have an editorConfig. This is needed for the lexicalHTML field.');
+        }
+        if (!config?.resolvedFeatureMap?.has('htmlConverter')) {
+          throw new Error('You cannot use the lexicalHTML field because the linked lexical field does not have a HTMLConverterFeature');
+        }
+        const finalConverters = consolidateHTMLConverters({
+          editorConfig: config
+        });
+        return await convertLexicalToHTML({
+          converters: finalConverters,
+          currentDepth,
+          data: lexicalFieldData,
+          depth,
+          draft,
+          overrideAccess,
+          req,
+          showHiddenFields
+        });
+      }],
+      beforeChange: [({
+        siblingData,
+        value
+      }) => {
+        if (storeInDB) {
+          return value;
+        }
+        delete siblingData[name];
+        return null;
+      }]
+    }
+  };
+};
+//# sourceMappingURL=index.js.map

package/dist/features/converters/html/field/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["defaultHTMLConverters","convertLexicalToHTML","consolidateHTMLConverters","editorConfig","htmlConverterFeature","resolvedFeatureMap","get","htmlConverterFeatureProps","sanitizedServerFeatureProps","defaultConvertersWithConvertersFromFeatures","converter","features","converters","html","push","finalConverters","defaultConverters","foundNodeTypes","filteredConverters","reverse","nodeTypes","length","newConverter","filter","nodeType","includes","findFieldPathAndSiblingFields","fields","path","field","curField","name","siblingFields","result","tab","tabs","block","blocks","slug","lexicalHTML","lexicalFieldName","props","hidden","storeInDB","type","admin","editorOptions","language","hooks","afterRead","collection","currentDepth","depth","draft","global","overrideAccess","req","showHiddenFields","siblingData","foundSiblingFields","Error","lexicalField","find","lexicalFieldData","config","editor","has","data","beforeChange","value"],"sources":["../../../../../src/features/converters/html/field/index.ts"],"sourcesContent":["import type { SerializedEditorState } from 'lexical'\nimport type { Field, FieldAffectingData, RichTextField } from 'payload'\n\nimport type { SanitizedServerEditorConfig } from '../../../../lexical/config/types.js'\nimport type { AdapterProps, LexicalRichTextAdapter } from '../../../../types.js'\nimport type { HTMLConverter } from '../converter/types.js'\nimport type { HTMLConverterFeatureProps } from '../index.js'\n\nimport { defaultHTMLConverters } from '../converter/defaultConverters.js'\nimport { convertLexicalToHTML } from '../converter/index.js'\n\ntype Props = {\n  /**\n   * Whether the lexicalHTML field should be hidden in the admin panel\n   *\n   * @default true\n   */\n  hidden?: boolean\n  name: string\n  /**\n   * Whether the HTML should be stored in the database\n   *\n   * @default false\n   */\n  storeInDB?: boolean\n}\n\n/**\n * Combines the default HTML converters with HTML converters found in the features, and with HTML converters configured in the htmlConverter feature.\n *\n * @param editorConfig\n */\nexport const consolidateHTMLConverters = ({\n  editorConfig,\n}: {\n  editorConfig: SanitizedServerEditorConfig\n}): HTMLConverter[] => {\n  const htmlConverterFeature = editorConfig.resolvedFeatureMap.get('htmlConverter')\n  const htmlConverterFeatureProps: HTMLConverterFeatureProps =\n    htmlConverterFeature?.sanitizedServerFeatureProps\n\n  const defaultConvertersWithConvertersFromFeatures = [...defaultHTMLConverters]\n\n  for (const converter of editorConfig.features.converters.html) {\n    defaultConvertersWithConvertersFromFeatures.push(converter)\n  }\n\n  const finalConverters =\n    htmlConverterFeatureProps?.converters &&\n    typeof htmlConverterFeatureProps?.converters === 'function'\n      ? htmlConverterFeatureProps.converters({\n          defaultConverters: defaultConvertersWithConvertersFromFeatures,\n        })\n      : (htmlConverterFeatureProps?.converters as HTMLConverter[]) ||\n        defaultConvertersWithConvertersFromFeatures\n\n  // filter converters by nodeTypes. The last converter in the list wins. If there are multiple converters for the same nodeType, the last one will be used and the node types will be removed from\n  // previous converters. If previous converters do not have any nodeTypes left, they will be removed from the list.\n  // This guarantees that user-added converters which are added after the default ones will always have precedence\n  const foundNodeTypes: string[] = []\n  const filteredConverters: HTMLConverter[] = []\n  for (const converter of finalConverters.reverse()) {\n    if (!converter.nodeTypes?.length) {\n      continue\n    }\n    const newConverter: HTMLConverter = {\n      converter: converter.converter,\n      nodeTypes: [...converter.nodeTypes],\n    }\n    newConverter.nodeTypes = newConverter.nodeTypes.filter((nodeType) => {\n      if (foundNodeTypes.includes(nodeType)) {\n        return false\n      }\n      foundNodeTypes.push(nodeType)\n      return true\n    })\n\n    if (newConverter.nodeTypes.length) {\n      filteredConverters.push(newConverter)\n    }\n  }\n\n  return filteredConverters\n}\n\n// find the path of this field, as well as its sibling fields, by looking for this `field` in fields and traversing it recursively\nfunction findFieldPathAndSiblingFields(\n  fields: Field[],\n  path: string[],\n  field: FieldAffectingData,\n): {\n  path: string[]\n  siblingFields: Field[]\n} | null {\n  for (const curField of fields) {\n    if (curField === field) {\n      return {\n        path: [...path, curField.name],\n        siblingFields: fields,\n      }\n    }\n\n    if ('fields' in curField) {\n      const result = findFieldPathAndSiblingFields(\n        curField.fields,\n        'name' in curField ? [...path, curField.name] : [...path],\n        field,\n      )\n      if (result) {\n        return result\n      }\n    } else if ('tabs' in curField) {\n      for (const tab of curField.tabs) {\n        const result = findFieldPathAndSiblingFields(\n          tab.fields,\n          'name' in tab ? [...path, tab.name] : [...path],\n          field,\n        )\n        if (result) {\n          return result\n        }\n      }\n    } else if ('blocks' in curField) {\n      for (const block of curField.blocks) {\n        if (block?.fields?.length) {\n          const result = findFieldPathAndSiblingFields(\n            block.fields,\n            [...path, curField.name, block.slug],\n            field,\n          )\n          if (result) {\n            return result\n          }\n        }\n      }\n    }\n  }\n\n  return null\n}\n\nexport const lexicalHTML: (\n  /**\n   * A string which matches the lexical field name you want to convert to HTML.\n   *\n   * This has to be a SIBLING field of this lexicalHTML field - otherwise, it won't be able to find the lexical field.\n   **/\n  lexicalFieldName: string,\n  props: Props,\n) => Field = (lexicalFieldName, props) => {\n  const { name = 'lexicalHTML', hidden = true, storeInDB = false } = props\n  return {\n    name,\n    type: 'code',\n    admin: {\n      editorOptions: {\n        language: 'html',\n      },\n      hidden,\n    },\n    hooks: {\n      afterRead: [\n        async ({\n          collection,\n          currentDepth,\n          depth,\n          draft,\n          field,\n          global,\n          overrideAccess,\n          req,\n          showHiddenFields,\n          siblingData,\n        }) => {\n          const fields = collection ? collection.fields : global!.fields\n\n          const foundSiblingFields = findFieldPathAndSiblingFields(fields, [], field)\n\n          if (!foundSiblingFields) {\n            throw new Error(\n              `Could not find sibling fields of current lexicalHTML field with name ${field?.name}`,\n            )\n          }\n\n          const { siblingFields } = foundSiblingFields\n          const lexicalField: RichTextField<SerializedEditorState, AdapterProps> =\n            siblingFields.find(\n              (field) => 'name' in field && field.name === lexicalFieldName,\n            ) as RichTextField<SerializedEditorState, AdapterProps>\n\n          const lexicalFieldData: SerializedEditorState = siblingData[lexicalFieldName]\n\n          if (!lexicalFieldData) {\n            return ''\n          }\n\n          if (!lexicalField) {\n            throw new Error(\n              'You cannot use the lexicalHTML field because the referenced lexical field was not found',\n            )\n          }\n\n          const config = (lexicalField?.editor as LexicalRichTextAdapter)?.editorConfig\n\n          if (!config) {\n            throw new Error(\n              'The linked lexical field does not have an editorConfig. This is needed for the lexicalHTML field.',\n            )\n          }\n\n          if (!config?.resolvedFeatureMap?.has('htmlConverter')) {\n            throw new Error(\n              'You cannot use the lexicalHTML field because the linked lexical field does not have a HTMLConverterFeature',\n            )\n          }\n\n          const finalConverters = consolidateHTMLConverters({\n            editorConfig: config,\n          })\n\n          return await convertLexicalToHTML({\n            converters: finalConverters,\n            currentDepth,\n            data: lexicalFieldData,\n            depth,\n            draft,\n            overrideAccess,\n            req,\n            showHiddenFields,\n          })\n        },\n      ],\n      beforeChange: [\n        ({ siblingData, value }) => {\n          if (storeInDB) {\n            return value\n          }\n          delete siblingData[name]\n          return null\n        },\n      ],\n    },\n  }\n}\n"],"mappings":"AAQA,SAASA,qBAAqB,QAAQ;AACtC,SAASC,oBAAoB,QAAQ;AAkBrC;;;;;AAKA,OAAO,MAAMC,yBAAA,GAA4BA,CAAC;EACxCC;AAAY,CAGb;EACC,MAAMC,oBAAA,GAAuBD,YAAA,CAAaE,kBAAkB,CAACC,GAAG,CAAC;EACjE,MAAMC,yBAAA,GACJH,oBAAA,EAAsBI,2BAAA;EAExB,MAAMC,2CAAA,GAA8C,C,GAAIT,qBAAA,CAAsB;EAE9E,KAAK,MAAMU,SAAA,IAAaP,YAAA,CAAaQ,QAAQ,CAACC,UAAU,CAACC,IAAI,EAAE;IAC7DJ,2CAAA,CAA4CK,IAAI,CAACJ,SAAA;EACnD;EAEA,MAAMK,eAAA,GACJR,yBAAA,EAA2BK,UAAA,IAC3B,OAAOL,yBAAA,EAA2BK,UAAA,KAAe,aAC7CL,yBAAA,CAA0BK,UAAU,CAAC;IACnCI,iBAAA,EAAmBP;EACrB,KACAF,yBAAC,EAA2BK,UAAA,IAC5BH,2CAAA;EAEN;EACA;EACA;EACA,MAAMQ,cAAA,GAA2B,EAAE;EACnC,MAAMC,kBAAA,GAAsC,EAAE;EAC9C,KAAK,MAAMR,SAAA,IAAaK,eAAA,CAAgBI,OAAO,IAAI;IACjD,IAAI,CAACT,SAAA,CAAUU,SAAS,EAAEC,MAAA,EAAQ;MAChC;IACF;IACA,MAAMC,YAAA,GAA8B;MAClCZ,SAAA,EAAWA,SAAA,CAAUA,SAAS;MAC9BU,SAAA,EAAW,C,GAAIV,SAAA,CAAUU,SAAS;IACpC;IACAE,YAAA,CAAaF,SAAS,GAAGE,YAAA,CAAaF,SAAS,CAACG,MAAM,CAAEC,QAAA;MACtD,IAAIP,cAAA,CAAeQ,QAAQ,CAACD,QAAA,GAAW;QACrC,OAAO;MACT;MACAP,cAAA,CAAeH,IAAI,CAACU,QAAA;MACpB,OAAO;IACT;IAEA,IAAIF,YAAA,CAAaF,SAAS,CAACC,MAAM,EAAE;MACjCH,kBAAA,CAAmBJ,IAAI,CAACQ,YAAA;IAC1B;EACF;EAEA,OAAOJ,kBAAA;AACT;AAEA;AACA,SAASQ,8BACPC,MAAe,EACfC,IAAc,EACdC,KAAyB;EAKzB,KAAK,MAAMC,QAAA,IAAYH,MAAA,EAAQ;IAC7B,IAAIG,QAAA,KAAaD,KAAA,EAAO;MACtB,OAAO;QACLD,IAAA,EAAM,C,GAAIA,IAAA,EAAME,QAAA,CAASC,IAAI,CAAC;QAC9BC,aAAA,EAAeL;MACjB;IACF;IAEA,IAAI,YAAYG,QAAA,EAAU;MACxB,MAAMG,MAAA,GAASP,6BAAA,CACbI,QAAA,CAASH,MAAM,EACf,UAAUG,QAAA,GAAW,C,GAAIF,IAAA,EAAME,QAAA,CAASC,IAAI,CAAC,GAAG,C,GAAIH,IAAA,CAAK,EACzDC,KAAA;MAEF,IAAII,MAAA,EAAQ;QACV,OAAOA,MAAA;MACT;IACF,OAAO,IAAI,UAAUH,QAAA,EAAU;MAC7B,KAAK,MAAMI,GAAA,IAAOJ,QAAA,CAASK,IAAI,EAAE;QAC/B,MAAMF,MAAA,GAASP,6BAAA,CACbQ,GAAA,CAAIP,MAAM,EACV,UAAUO,GAAA,GAAM,C,GAAIN,IAAA,EAAMM,GAAA,CAAIH,IAAI,CAAC,GAAG,C,GAAIH,IAAA,CAAK,EAC/CC,KAAA;QAEF,IAAII,MAAA,EAAQ;UACV,OAAOA,MAAA;QACT;MACF;IACF,OAAO,IAAI,YAAYH,QAAA,EAAU;MAC/B,KAAK,MAAMM,KAAA,IAASN,QAAA,CAASO,MAAM,EAAE;QACnC,IAAID,KAAA,EAAOT,MAAA,EAAQN,MAAA,EAAQ;UACzB,MAAMY,MAAA,GAASP,6BAAA,CACbU,KAAA,CAAMT,MAAM,EACZ,C,GAAIC,IAAA,EAAME,QAAA,CAASC,IAAI,EAAEK,KAAA,CAAME,IAAI,CAAC,EACpCT,KAAA;UAEF,IAAII,MAAA,EAAQ;YACV,OAAOA,MAAA;UACT;QACF;MACF;IACF;EACF;EAEA,OAAO;AACT;AAEA,OAAO,MAAMM,WAAA,GAQAA,CAACC,gBAAA,EAAkBC,KAAA;EAC9B,MAAM;IAAEV,IAAA,GAAO,aAAa;IAAEW,MAAA,GAAS,IAAI;IAAEC,SAAA,GAAY;EAAK,CAAE,GAAGF,KAAA;EACnE,OAAO;IACLV,IAAA;IACAa,IAAA,EAAM;IACNC,KAAA,EAAO;MACLC,aAAA,EAAe;QACbC,QAAA,EAAU;MACZ;MACAL;IACF;IACAM,KAAA,EAAO;MACLC,SAAA,EAAW,CACT,OAAO;QACLC,UAAU;QACVC,YAAY;QACZC,KAAK;QACLC,KAAK;QACLxB,KAAK;QACLyB,MAAM;QACNC,cAAc;QACdC,GAAG;QACHC,gBAAgB;QAChBC;MAAW,CACZ;QACC,MAAM/B,MAAA,GAASuB,UAAA,GAAaA,UAAA,CAAWvB,MAAM,GAAG2B,MAAA,CAAQ3B,MAAM;QAE9D,MAAMgC,kBAAA,GAAqBjC,6BAAA,CAA8BC,MAAA,EAAQ,EAAE,EAAEE,KAAA;QAErE,IAAI,CAAC8B,kBAAA,EAAoB;UACvB,MAAM,IAAIC,KAAA,CACR,wEAAwE/B,KAAA,EAAOE,IAAA,EAAM;QAEzF;QAEA,MAAM;UAAEC;QAAa,CAAE,GAAG2B,kBAAA;QAC1B,MAAME,YAAA,GACJ7B,aAAA,CAAc8B,IAAI,CACfjC,KAAA,IAAU,UAAUA,KAAA,IAASA,KAAA,CAAME,IAAI,KAAKS,gBAAA;QAGjD,MAAMuB,gBAAA,GAA0CL,WAAW,CAAClB,gBAAA,CAAiB;QAE7E,IAAI,CAACuB,gBAAA,EAAkB;UACrB,OAAO;QACT;QAEA,IAAI,CAACF,YAAA,EAAc;UACjB,MAAM,IAAID,KAAA,CACR;QAEJ;QAEA,MAAMI,MAAA,GAAUH,YAAA,EAAcI,MAAA,EAAmC9D,YAAA;QAEjE,IAAI,CAAC6D,MAAA,EAAQ;UACX,MAAM,IAAIJ,KAAA,CACR;QAEJ;QAEA,IAAI,CAACI,MAAA,EAAQ3D,kBAAA,EAAoB6D,GAAA,CAAI,kBAAkB;UACrD,MAAM,IAAIN,KAAA,CACR;QAEJ;QAEA,MAAM7C,eAAA,GAAkBb,yBAAA,CAA0B;UAChDC,YAAA,EAAc6D;QAChB;QAEA,OAAO,MAAM/D,oBAAA,CAAqB;UAChCW,UAAA,EAAYG,eAAA;UACZoC,YAAA;UACAgB,IAAA,EAAMJ,gBAAA;UACNX,KAAA;UACAC,KAAA;UACAE,cAAA;UACAC,GAAA;UACAC;QACF;MACF,EACD;MACDW,YAAA,EAAc,CACZ,CAAC;QAAEV,WAAW;QAAEW;MAAK,CAAE;QACrB,IAAI1B,SAAA,EAAW;UACb,OAAO0B,KAAA;QACT;QACA,OAAOX,WAAW,CAAC3B,IAAA,CAAK;QACxB,OAAO;MACT;IAEJ;EACF;AACF","ignoreList":[]}

package/dist/features/converters/html/index.d.ts

@@ -0,0 +1,8 @@
+import type { HTMLConverter } from './converter/types.js';
+export type HTMLConverterFeatureProps = {
+    converters?: (({ defaultConverters }: {
+        defaultConverters: HTMLConverter<any>[];
+    }) => HTMLConverter<any>[]) | HTMLConverter<any>[];
+};
+export declare const HTMLConverterFeature: import("../../typesServer.js").FeatureProviderProviderServer<HTMLConverterFeatureProps, HTMLConverterFeatureProps, undefined>;
+//# sourceMappingURL=index.d.ts.map

package/dist/features/converters/html/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/features/converters/html/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAA;AAIzD,MAAM,MAAM,yBAAyB,GAAG;IACtC,UAAU,CAAC,EACP,CAAC,CAAC,EAAE,iBAAiB,EAAE,EAAE;QAAE,iBAAiB,EAAE,aAAa,CAAC,GAAG,CAAC,EAAE,CAAA;KAAE,KAAK,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,GAC9F,aAAa,CAAC,GAAG,CAAC,EAAE,CAAA;CACzB,CAAA;AAGD,eAAO,MAAM,oBAAoB,+HAG/B,CAAA"}

package/dist/features/converters/html/index.js

@@ -0,0 +1,7 @@
+import { createServerFeature } from '../../../utilities/createServerFeature.js';
+// This is just used to save the props on the richText field
+export const HTMLConverterFeature = createServerFeature({
+  feature: {},
+  key: 'htmlConverter'
+});
+//# sourceMappingURL=index.js.map

package/dist/features/converters/html/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["createServerFeature","HTMLConverterFeature","feature","key"],"sources":["../../../../src/features/converters/html/index.ts"],"sourcesContent":["import type { HTMLConverter } from './converter/types.js'\n\nimport { createServerFeature } from '../../../utilities/createServerFeature.js'\n\nexport type HTMLConverterFeatureProps = {\n  converters?:\n    | (({ defaultConverters }: { defaultConverters: HTMLConverter<any>[] }) => HTMLConverter<any>[])\n    | HTMLConverter<any>[]\n}\n\n// This is just used to save the props on the richText field\nexport const HTMLConverterFeature = createServerFeature<HTMLConverterFeatureProps>({\n  feature: {},\n  key: 'htmlConverter',\n})\n"],"mappings":"AAEA,SAASA,mBAAmB,QAAQ;AAQpC;AACA,OAAO,MAAMC,oBAAA,GAAuBD,mBAAA,CAA+C;EACjFE,OAAA,EAAS,CAAC;EACVC,GAAA,EAAK;AACP","ignoreList":[]}

package/dist/features/debug/testRecorder/client/index.d.ts

@@ -0,0 +1,2 @@
+export declare const TestRecorderFeatureClient: import("../../../typesClient.js").FeatureProviderProviderClient<undefined, undefined>;
+//# sourceMappingURL=index.d.ts.map

package/dist/features/debug/testRecorder/client/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/features/debug/testRecorder/client/index.tsx"],"names":[],"mappings":"AAKA,eAAO,MAAM,yBAAyB,uFAOpC,CAAA"}

package/dist/features/debug/testRecorder/client/index.js

@@ -0,0 +1,11 @@
+'use client';
+
+import { createClientFeature } from '../../../../utilities/createClientFeature.js';
+import { TestRecorderPlugin } from './plugin/index.js';
+export const TestRecorderFeatureClient = createClientFeature({
+  plugins: [{
+    Component: TestRecorderPlugin,
+    position: 'bottom'
+  }]
+});
+//# sourceMappingURL=index.js.map

package/dist/features/debug/testRecorder/client/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["createClientFeature","TestRecorderPlugin","TestRecorderFeatureClient","plugins","Component","position"],"sources":["../../../../../src/features/debug/testRecorder/client/index.tsx"],"sourcesContent":["'use client'\n\nimport { createClientFeature } from '../../../../utilities/createClientFeature.js'\nimport { TestRecorderPlugin } from './plugin/index.js'\n\nexport const TestRecorderFeatureClient = createClientFeature({\n  plugins: [\n    {\n      Component: TestRecorderPlugin,\n      position: 'bottom',\n    },\n  ],\n})\n"],"mappings":"AAAA;;AAEA,SAASA,mBAAmB,QAAQ;AACpC,SAASC,kBAAkB,QAAQ;AAEnC,OAAO,MAAMC,yBAAA,GAA4BF,mBAAA,CAAoB;EAC3DG,OAAA,EAAS,CACP;IACEC,SAAA,EAAWH,kBAAA;IACXI,QAAA,EAAU;EACZ;AAEJ","ignoreList":[]}

package/dist/features/debug/testRecorder/client/plugin/index.d.ts

@@ -0,0 +1,5 @@
+import type { PluginComponent } from '../../../../typesClient.js';
+import './index.scss';
+export declare function isSelectAll(event: KeyboardEvent): boolean;
+export declare const TestRecorderPlugin: PluginComponent<undefined>;
+//# sourceMappingURL=index.d.ts.map

package/dist/features/debug/testRecorder/client/plugin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/features/debug/testRecorder/client/plugin/index.tsx"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,4BAA4B,CAAA;AAGjE,OAAO,cAAc,CAAA;AA8ErB,wBAAgB,WAAW,CAAC,KAAK,EAAE,aAAa,GAAG,OAAO,CAEzD;AAmWD,eAAO,MAAM,kBAAkB,EAAE,eAAe,CAAC,SAAS,CAYzD,CAAA"}

package/dist/features/debug/testRecorder/client/plugin/index.js

@@ -0,0 +1,422 @@
+'use client';
+
+import { c as _c } from "react/compiler-runtime";
+import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
+import { useLexicalComposerContext } from '@lexical/react/LexicalComposerContext.js';
+import { $createParagraphNode, $createTextNode, $getRoot } from 'lexical';
+import * as React from 'react';
+import { useCallback, useEffect, useLayoutEffect, useRef, useState } from 'react';
+import { IS_APPLE } from '../../../../../lexical/utils/environment.js';
+const copy = text => {
+  const textArea = document.createElement('textarea');
+  textArea.value = text || '';
+  textArea.style.position = 'absolute';
+  textArea.style.opacity = '0';
+  document.body?.appendChild(textArea);
+  textArea.focus();
+  textArea.select();
+  try {
+    const result = document.execCommand('copy');
+    // eslint-disable-next-line no-console
+    console.log(result);
+  } catch (error) {
+    console.error(error);
+  }
+  document.body?.removeChild(textArea);
+};
+const download = (filename, text) => {
+  const a = document.createElement('a');
+  a.setAttribute('href', 'data:text/plain;charset=utf-8,' + encodeURIComponent(text || ''));
+  a.setAttribute('download', filename);
+  a.style.display = 'none';
+  document.body?.appendChild(a);
+  a.click();
+  document.body?.removeChild(a);
+};
+const formatStep = step => {
+  const formatOneStep = (name, value) => {
+    switch (name) {
+      case 'click':
+        {
+          return `      await page.mouse.click(${value.x}, ${value.y});`;
+        }
+      case 'keydown':
+        {
+          return `      await page.keyboard.keydown('${value}');`;
+        }
+      case 'keyup':
+        {
+          return `      await page.keyboard.keyup('${value}');`;
+        }
+      case 'press':
+        {
+          return `      await page.keyboard.press('${value}');`;
+        }
+      case 'selectAll':
+        {
+          return `      await selectAll(page);`;
+        }
+      case 'snapshot':
+        {
+          return `      await assertHTMLSnapshot(page);
+      await assertSelection(page, {
+        anchorPath: [${value.anchorPath.toString()}],
+        anchorOffset: ${value.anchorOffset},
+        focusPath: [${value.focusPath.toString()}],
+        focusOffset: ${value.focusOffset},
+      });
+`;
+        }
+      case 'type':
+        {
+          return `      await page.keyboard.type('${value}');`;
+        }
+      default:
+        return ``;
+    }
+  };
+  const formattedStep = formatOneStep(step.name, step.value);
+  switch (step.count) {
+    case 1:
+      return formattedStep;
+    case 2:
+      return [formattedStep, formattedStep].join(`\n`);
+    default:
+      return `      await repeat(${step.count}, async () => {
+  ${formattedStep}
+      );`;
+  }
+};
+export function isSelectAll(event) {
+  return event.key.toLowerCase() === 'a' && (IS_APPLE ? event.metaKey : event.ctrlKey);
+}
+// stolen from LexicalSelection-test
+function sanitizeSelection(selection) {
+  const {
+    anchorNode,
+    focusNode
+  } = selection;
+  let {
+    anchorOffset,
+    focusOffset
+  } = selection;
+  if (anchorOffset !== 0) {
+    anchorOffset--;
+  }
+  if (focusOffset !== 0) {
+    focusOffset--;
+  }
+  return {
+    anchorNode,
+    anchorOffset,
+    focusNode,
+    focusOffset
+  };
+}
+function getPathFromNodeToEditor(node, rootElement) {
+  let currentNode = node;
+  const path = [];
+  while (currentNode !== rootElement) {
+    if (currentNode !== null && currentNode !== undefined) {
+      path.unshift(Array.from(currentNode?.parentNode?.childNodes ?? []).indexOf(currentNode));
+    }
+    currentNode = currentNode?.parentNode;
+  }
+  return path;
+}
+const keyPresses = new Set(['ArrowDown', 'ArrowLeft', 'ArrowRight', 'ArrowUp', 'Backspace', 'Delete', 'Enter', 'Escape']);
+function useTestRecorder(editor) {
+  const [steps, setSteps] = useState([]);
+  const [isRecording, setIsRecording] = useState(false);
+  const [, setCurrentInnerHTML] = useState('');
+  const [templatedTest, setTemplatedTest] = useState('');
+  const previousSelectionRef = useRef(null);
+  const skipNextSelectionChangeRef = useRef(false);
+  const preRef = useRef(null);
+  const getCurrentEditor = useCallback(() => {
+    return editor;
+  }, [editor]);
+  const generateTestContent = useCallback(() => {
+    const rootElement = editor.getRootElement();
+    const browserSelection = window.getSelection();
+    if (rootElement == null || browserSelection == null || browserSelection.anchorNode == null || browserSelection.focusNode == null || !rootElement.contains(browserSelection.anchorNode) || !rootElement.contains(browserSelection.focusNode)) {
+      return null;
+    }
+    return `
+import {
+  initializeE2E,
+  assertHTMLSnapshot,
+  assertSelection,
+  repeat,
+} from '../utils';
+import {selectAll} from '../keyboardShortcuts';
+import { RangeSelection } from 'lexical';
+import { NodeSelection } from 'lexical';
+
+describe('Test case', () => {
+  initializeE2E((e2e) => {
+    it('Should pass this test', async () => {
+      const {page} = e2e;
+
+      await page.focus('div[contenteditable="true"]');
+${steps.map(formatStep).join(`\n`)}
+    });
+});
+    `;
+  }, [editor, steps]);
+  // just a wrapper around inserting new actions so that we can
+  // coalesce some actions like insertText/moveNativeSelection
+  const pushStep = useCallback((name, value) => {
+    setSteps(currentSteps => {
+      // trying to group steps
+      const currentIndex = steps.length - 1;
+      const lastStep = steps[currentIndex];
+      if (lastStep) {
+        if (lastStep.name === name) {
+          if (name === 'type') {
+            // for typing events we just append the text
+            return [...steps.slice(0, currentIndex), {
+              ...lastStep,
+              value: lastStep.value + value
+            }];
+          } else {
+            // for other events we bump the counter if their values are the same
+            if (lastStep.value === value) {
+              return [...steps.slice(0, currentIndex), {
+                ...lastStep,
+                count: lastStep.count + 1
+              }];
+            }
+          }
+        }
+      }
+      // could not group, just append a new one
+      return [...currentSteps, {
+        name,
+        count: 1,
+        value
+      }];
+    });
+  }, [steps, setSteps]);
+  useLayoutEffect(() => {
+    const onKeyDown = event => {
+      if (!isRecording) {
+        return;
+      }
+      const key = event.key;
+      if (isSelectAll(event)) {
+        pushStep('selectAll', '');
+      } else if (keyPresses.has(key)) {
+        pushStep('press', event.key);
+      } else if ([...key].length > 1) {
+        pushStep('keydown', event.key);
+      } else {
+        pushStep('type', event.key);
+      }
+    };
+    const onKeyUp = event_0 => {
+      if (!isRecording) {
+        return;
+      }
+      const key_0 = event_0.key;
+      if (!keyPresses.has(key_0) && [...key_0].length > 1) {
+        pushStep('keyup', event_0.key);
+      }
+    };
+    return editor.registerRootListener((rootElement_0, prevRootElement) => {
+      if (prevRootElement !== null) {
+        prevRootElement.removeEventListener('keydown', onKeyDown);
+        prevRootElement.removeEventListener('keyup', onKeyUp);
+      }
+      if (rootElement_0 !== null) {
+        rootElement_0.addEventListener('keydown', onKeyDown);
+        rootElement_0.addEventListener('keyup', onKeyUp);
+      }
+    });
+  }, [editor, isRecording, pushStep]);
+  useLayoutEffect(() => {
+    if (preRef.current) {
+      preRef.current.scrollTo(0, preRef.current.scrollHeight);
+    }
+  }, [generateTestContent]);
+  useEffect(() => {
+    if (steps) {
+      const testContent = generateTestContent();
+      if (testContent !== null) {
+        setTemplatedTest(testContent);
+      }
+      if (preRef.current) {
+        preRef.current.scrollTo(0, preRef.current.scrollHeight);
+      }
+    }
+  }, [generateTestContent, steps]);
+  useEffect(() => {
+    const removeUpdateListener = editor.registerUpdateListener(({
+      dirtyElements,
+      dirtyLeaves,
+      editorState
+    }) => {
+      if (!isRecording) {
+        return;
+      }
+      const currentSelection = editorState._selection;
+      const previousSelection = previousSelectionRef.current;
+      const skipNextSelectionChange = skipNextSelectionChangeRef.current;
+      if (previousSelection !== currentSelection) {
+        if (dirtyLeaves.size === 0 && dirtyElements.size === 0 && !skipNextSelectionChange) {
+          const browserSelection_0 = window.getSelection();
+          if (browserSelection_0 && (browserSelection_0.anchorNode == null || browserSelection_0.focusNode == null)) {
+            return;
+          }
+        }
+        previousSelectionRef.current = currentSelection;
+      }
+      skipNextSelectionChangeRef.current = false;
+      const testContent_0 = generateTestContent();
+      if (testContent_0 !== null) {
+        setTemplatedTest(testContent_0);
+      }
+    });
+    return removeUpdateListener;
+  }, [editor, generateTestContent, isRecording, pushStep]);
+  // save innerHTML
+  useEffect(() => {
+    if (!isRecording) {
+      return;
+    }
+    const removeUpdateListener_0 = editor.registerUpdateListener(() => {
+      const rootElement_1 = editor.getRootElement();
+      if (rootElement_1 !== null) {
+        setCurrentInnerHTML(rootElement_1?.innerHTML);
+      }
+    });
+    return removeUpdateListener_0;
+  }, [editor, isRecording]);
+  // clear editor and start recording
+  const toggleEditorSelection = useCallback(currentEditor => {
+    if (!isRecording) {
+      currentEditor.update(() => {
+        const root = $getRoot();
+        root.clear();
+        const text = $createTextNode();
+        root.append($createParagraphNode().append(text));
+        text.select();
+      });
+      setSteps([]);
+    }
+    setIsRecording(currentIsRecording => !currentIsRecording);
+  }, [isRecording]);
+  const onSnapshotClick = useCallback(() => {
+    if (!isRecording) {
+      return;
+    }
+    const browserSelection_1 = window.getSelection();
+    if (browserSelection_1 === null || browserSelection_1.anchorNode == null || browserSelection_1.focusNode == null) {
+      return;
+    }
+    const {
+      anchorNode,
+      anchorOffset,
+      focusNode,
+      focusOffset
+    } = sanitizeSelection(browserSelection_1);
+    const rootElement_2 = getCurrentEditor().getRootElement();
+    let anchorPath;
+    if (anchorNode !== null) {
+      anchorPath = getPathFromNodeToEditor(anchorNode, rootElement_2);
+    }
+    let focusPath;
+    if (focusNode !== null) {
+      focusPath = getPathFromNodeToEditor(focusNode, rootElement_2);
+    }
+    pushStep('snapshot', {
+      anchorNode,
+      anchorOffset,
+      anchorPath,
+      focusNode,
+      focusOffset,
+      focusPath
+    });
+  }, [pushStep, isRecording, getCurrentEditor]);
+  const onCopyClick = useCallback(() => {
+    copy(generateTestContent());
+  }, [generateTestContent]);
+  const onDownloadClick = useCallback(() => {
+    download('test.js', generateTestContent());
+  }, [generateTestContent]);
+  const button = /*#__PURE__*/_jsx("button", {
+    className: `editor-dev-button ${isRecording ? 'active' : ''}`,
+    id: "test-recorder-button",
+    onClick: e => {
+      toggleEditorSelection(getCurrentEditor());
+      e.preventDefault();
+    },
+    title: isRecording ? 'Disable test recorder' : 'Enable test recorder',
+    type: "button",
+    children: isRecording ? 'Disable test recorder' : 'Enable test recorder'
+  });
+  const output = isRecording ? /*#__PURE__*/_jsxs("div", {
+    className: "test-recorder-output",
+    children: [/*#__PURE__*/_jsxs("div", {
+      className: "test-recorder-toolbar",
+      children: [/*#__PURE__*/_jsx("button", {
+        className: "test-recorder-button",
+        id: "test-recorder-button-snapshot",
+        onClick: e_0 => {
+          onSnapshotClick();
+          e_0.preventDefault();
+        },
+        title: "Insert snapshot",
+        type: "button",
+        children: "Insert Snapshot"
+      }), /*#__PURE__*/_jsx("button", {
+        className: "test-recorder-button",
+        id: "test-recorder-button-copy",
+        onClick: e_1 => {
+          onCopyClick();
+          e_1.preventDefault();
+        },
+        title: "Copy to clipboard",
+        type: "button",
+        children: "Copy"
+      }), /*#__PURE__*/_jsx("button", {
+        className: "test-recorder-button",
+        id: "test-recorder-button-download",
+        onClick: e_2 => {
+          onDownloadClick();
+          e_2.preventDefault();
+        },
+        title: "Download as a file",
+        type: "button",
+        children: "Download"
+      })]
+    }), /*#__PURE__*/_jsx("pre", {
+      id: "test-recorder",
+      ref: preRef,
+      children: templatedTest
+    })]
+  }) : null;
+  return [button, output];
+}
+export const TestRecorderPlugin = () => {
+  const $ = _c(3);
+  const [editor] = useLexicalComposerContext();
+  const [testRecorderButton, testRecorderOutput] = useTestRecorder(editor);
+  let t0;
+  if ($[0] !== testRecorderButton || $[1] !== testRecorderOutput) {
+    t0 = _jsxs(React.Fragment, {
+      children: [_jsx("p", {
+        children: "HI"
+      }), testRecorderButton, testRecorderOutput, _jsx("p", {
+        children: "DONE"
+      })]
+    });
+    $[0] = testRecorderButton;
+    $[1] = testRecorderOutput;
+    $[2] = t0;
+  } else {
+    t0 = $[2];
+  }
+  return t0;
+};
+//# sourceMappingURL=index.js.map