refactor(richtext-lexical)!: restructure index.ts, rename outputSchema to jsonSchema

docs/migration-guide/v4.mdx

@@ -383,6 +383,36 @@ The deprecated `HTMLConverterFeature`, `lexicalHTML`, and the per-node `converte
 
 Custom nodes that define `converters.html` should export their converters instead.
 
+### RichText adapter `outputSchema` renamed to `jsonSchema`
+
+The optional `outputSchema` function on rich-text editor adapters (`RichTextAdapter`) has been renamed to `jsonSchema` — it returns JSON Schema, not TypeScript, so the old name was misleading. Same arguments, same `JSONSchema4` return value.
+
+```diff
+  myAdapter: RichTextAdapter = {
+-   outputSchema: ({ collectionIDFieldTypes, config, field, i18n, interfaceNameDefinitions, isRequired }) => {
++   jsonSchema: ({ collectionIDFieldTypes, config, field, i18n, interfaceNameDefinitions, isRequired }) => {
+      // return JSONSchema4
+    },
+  }
+```
+
+`@payloadcms/richtext-lexical` is updated. Only custom third-party adapters need attention.
+
+### Lexical: feature `generatedTypes.modifyOutputSchema` renamed to `modifyJSONSchema`
+
+If you authored a custom lexical feature that hooks into type generation, rename `generatedTypes.modifyOutputSchema` to `modifyJSONSchema` (and its sanitized counterpart `modifyOutputSchemas` to `modifyJSONSchemas`) — it operates on JSON Schema, matching the adapter rename above.
+
+```diff
+  createServerFeature({
+    feature: () => ({
+      generatedTypes: {
+-       modifyOutputSchema: ({ currentSchema, interfaceNameDefinitions }) => currentSchema,
++       modifyJSONSchema: ({ currentSchema, interfaceNameDefinitions }) => currentSchema,
+      },
+    }),
+  })
+```
+
 ### Field `typescriptSchema` renamed to `jsonSchema`
 
 `typescriptSchema` accepted JSON Schema, not TypeScript, so the name lied. Renamed to `jsonSchema`. Same shape, same array of `({ jsonSchema }) => JSONSchema4` transforms.

packages/payload/src/admin/RichText.ts

@@ -249,7 +249,7 @@ type RichTextAdapterBase<
    * `json-schema-to-typescript` which is used to generate types for this richtext field
    * payload-types.ts)
    */
-  outputSchema?: (args: {
+  jsonSchema?: (args: {
     collectionIDFieldTypes: { [key: string]: 'number' | 'string' }
     config?: SanitizedConfig
     field: RichTextField<Value, AdapterProps, ExtraFieldProperties>

packages/payload/src/utilities/configToJSONSchema.ts

@@ -734,10 +734,10 @@ export function fieldsToJSONSchema(
             if (typeof field.editor === 'function') {
               throw new Error('Attempted to access unsanitized rich text editor.')
             }
-            if (field.editor.outputSchema) {
+            if (field.editor.jsonSchema) {
               fieldSchema = {
                 ...baseFieldSchema,
-                ...field.editor.outputSchema({
+                ...field.editor.jsonSchema({
                   collectionIDFieldTypes,
                   config,
                   field,

packages/richtext-lexical/src/cell/rscEntry.tsx

@@ -5,7 +5,7 @@ import { Link } from '@payloadcms/ui'
 import { formatAdminURL } from 'payload/shared'
 import React from 'react'
 
-import type { LexicalRichTextCellProps } from '../types.js'
+import type { LexicalRichTextCellProps } from '../types/index.js'
 
 function recurseEditorState(
   editorState: SerializedLexicalNode[],

packages/richtext-lexical/src/exports/react/index.ts

@@ -32,4 +32,4 @@ export type {
   ViewMapBlockComponentProps,
   ViewMapBlockEditorProps,
   ViewMapBlockJSXConverterProps,
-} from '../../types.js'
+} from '../../types/index.js'

packages/richtext-lexical/src/features/blockquote/server/index.ts

@@ -3,7 +3,7 @@ import type { SerializedLexicalNode } from 'lexical'
 
 import { QuoteNode } from '@lexical/rich-text'
 
-import type { StronglyTypedElementNode } from '../../../nodeTypes.js'
+import type { StronglyTypedElementNode } from '../../../types/nodeTypes.js'
 
 import { createServerFeature } from '../../../utilities/createServerFeature.js'
 import { createNode } from '../../typeUtilities.js'

packages/richtext-lexical/src/features/blocks/client/component/index.tsx

@@ -39,7 +39,7 @@ import { deepCopyObjectSimpleWithoutReactComponents, reduceFieldsToValues } from
 import React, { useCallback, useEffect, useMemo, useRef } from 'react'
 import { v4 as uuid } from 'uuid'
 
-import type { ViewMapBlockComponentProps } from '../../../../types.js'
+import type { ViewMapBlockComponentProps } from '../../../../types/index.js'
 import type { BlockFields } from '../../server/nodes/BlocksNode.js'
 
 import './index.css'

packages/richtext-lexical/src/features/blocks/client/componentInline/index.tsx

@@ -30,7 +30,7 @@ import { deepCopyObjectSimpleWithoutReactComponents, reduceFieldsToValues } from
 import React, { createContext, useCallback, useEffect, useMemo, useRef } from 'react'
 import { v4 as uuid } from 'uuid'
 
-import type { ViewMapInlineBlockComponentProps } from '../../../../types.js'
+import type { ViewMapInlineBlockComponentProps } from '../../../../types/index.js'
 import type { InlineBlockFields } from '../../server/nodes/InlineBlocksNode.js'
 import type { BlockComponentProps } from '../component/index.js'
 

packages/richtext-lexical/src/features/blocks/client/nodes/BlocksNode.tsx

@@ -8,7 +8,7 @@ import {
 } from 'lexical'
 import React, { type JSX } from 'react'
 
-import type { ViewMapBlockComponentProps } from '../../../../types.js'
+import type { ViewMapBlockComponentProps } from '../../../../types/index.js'
 import type { BlockFieldsOptionalID, SerializedBlockNode } from '../../server/nodes/BlocksNode.js'
 
 import { ServerBlockNode } from '../../server/nodes/BlocksNode.js'

packages/richtext-lexical/src/features/blocks/client/nodes/InlineBlocksNode.tsx

@@ -8,7 +8,7 @@ import {
 } from 'lexical'
 import React, { type JSX } from 'react'
 
-import type { ViewMapInlineBlockComponentProps } from '../../../../types.js'
+import type { ViewMapInlineBlockComponentProps } from '../../../../types/index.js'
 import type {
   InlineBlockFields,
   SerializedInlineBlockNode,

packages/richtext-lexical/src/features/blocks/server/index.ts

@@ -88,7 +88,7 @@ export const BlocksFeature = createServerFeature<BlocksFeatureProps, BlocksFeatu
     return {
       ClientFeature: '@payloadcms/richtext-lexical/client#BlocksFeatureClient',
       generatedTypes: {
-        modifyOutputSchema: ({
+        modifyJSONSchema: ({
           collectionIDFieldTypes,
           config,
           currentSchema,

packages/richtext-lexical/src/features/blocks/server/nodes/BlocksNode.tsx

@@ -16,7 +16,7 @@ import {
   type NodeKey,
 } from 'lexical'
 
-import type { StronglyTypedLeafNode } from '../../../../nodeTypes.js'
+import type { StronglyTypedLeafNode } from '../../../../types/nodeTypes.js'
 
 type BaseBlockFields<TBlockFields extends JsonObject = JsonObject> = {
   /** Block form data */

packages/richtext-lexical/src/features/blocks/server/nodes/InlineBlocksNode.tsx

@@ -15,7 +15,7 @@ import { addClassNamesToElement } from '@lexical/utils'
 import ObjectID from 'bson-objectid'
 import { $applyNodeReplacement, DecoratorNode } from 'lexical'
 
-import type { StronglyTypedLeafNode } from '../../../../nodeTypes.js'
+import type { StronglyTypedLeafNode } from '../../../../types/nodeTypes.js'
 
 export type InlineBlockFields<TInlineBlockFields extends JsonObject = JsonObject> = {
   blockType: string

packages/richtext-lexical/src/features/converters/htmlToLexical/index.ts

@@ -2,7 +2,7 @@ import { createHeadlessEditor } from '@lexical/headless'
 import { $getRoot, $getSelection, type SerializedLexicalNode } from 'lexical'
 
 import type { SanitizedServerEditorConfig } from '../../../lexical/config/types.js'
-import type { DefaultNodeTypes, TypedEditorState } from '../../../nodeTypes.js'
+import type { DefaultNodeTypes, TypedEditorState } from '../../../types/nodeTypes.js'
 
 import { getEnabledNodes } from '../../../lexical/nodes/index.js'
 import { $generateNodesFromDOM } from '../../../lexical-proxy/@lexical-html.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/blockquote.ts

@@ -1,4 +1,4 @@
-import type { SerializedQuoteNode } from '../../../../../nodeTypes.js'
+import type { SerializedQuoteNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 export const BlockquoteHTMLConverterAsync: HTMLConvertersAsync<SerializedQuoteNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/heading.ts

@@ -1,4 +1,4 @@
-import type { SerializedHeadingNode } from '../../../../../nodeTypes.js'
+import type { SerializedHeadingNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 const ALLOWED_HEADING_TAGS = new Set(['h1', 'h2', 'h3', 'h4', 'h5', 'h6'])

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/horizontalRule.ts

@@ -1,4 +1,4 @@
-import type { SerializedHorizontalRuleNode } from '../../../../../nodeTypes.js'
+import type { SerializedHorizontalRuleNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 export const HorizontalRuleHTMLConverterAsync: HTMLConvertersAsync<SerializedHorizontalRuleNode> = {
   horizontalrule: '<hr />',

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/linebreak.ts

@@ -1,4 +1,4 @@
-import type { SerializedLineBreakNode } from '../../../../../nodeTypes.js'
+import type { SerializedLineBreakNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 export const LinebreakHTMLConverterAsync: HTMLConvertersAsync<SerializedLineBreakNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/link.ts

@@ -1,7 +1,7 @@
 import escapeHTML from 'escape-html'
 import { sanitizeUrl } from 'payload/shared'
 
-import type { SerializedAutoLinkNode, SerializedLinkNode } from '../../../../../nodeTypes.js'
+import type { SerializedAutoLinkNode, SerializedLinkNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync, HTMLPopulateFn } from '../types.js'
 
 export const LinkHTMLConverterAsync: (args: {

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/list.ts

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from 'uuid'
 
-import type { SerializedListItemNode, SerializedListNode } from '../../../../../nodeTypes.js'
+import type { SerializedListItemNode, SerializedListNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 const ALLOWED_LIST_TAGS = new Set(['ol', 'ul'])

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/paragraph.ts

@@ -1,4 +1,4 @@
-import type { SerializedParagraphNode } from '../../../../../nodeTypes.js'
+import type { SerializedParagraphNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 export const ParagraphHTMLConverterAsync: HTMLConvertersAsync<SerializedParagraphNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/tab.ts

@@ -1,4 +1,4 @@
-import type { SerializedTabNode } from '../../../../../nodeTypes.js'
+import type { SerializedTabNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 export const TabHTMLConverterAsync: HTMLConvertersAsync<SerializedTabNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/table.ts

@@ -2,7 +2,7 @@ import type {
   SerializedTableCellNode,
   SerializedTableNode,
   SerializedTableRowNode,
-} from '../../../../../nodeTypes.js'
+} from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 import { isSafeCssColor } from '../../shared/cssColors.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/text.ts

@@ -1,6 +1,6 @@
 import escapeHTML from 'escape-html'
 
-import type { SerializedTextNode } from '../../../../../nodeTypes.js'
+import type { SerializedTextNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from '../types.js'
 
 import { NodeFormat } from '../../../../../lexical/utils/nodeFormat.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/converters/upload.ts

@@ -2,7 +2,7 @@ import type { FileData, FileSize, TypeWithID } from 'payload'
 
 import escapeHTML from 'escape-html'
 
-import type { SerializedUploadNode } from '../../../../../nodeTypes.js'
+import type { SerializedUploadNode } from '../../../../../types/nodeTypes.js'
 import type { UploadDataImproved } from '../../../../upload/server/nodes/UploadNode.js'
 import type { HTMLConvertersAsync } from '../types.js'
 

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/defaultConverters.ts

@@ -1,4 +1,4 @@
-import type { DefaultNodeTypes } from '../../../../nodeTypes.js'
+import type { DefaultNodeTypes } from '../../../../types/nodeTypes.js'
 import type { HTMLConvertersAsync } from './types.js'
 
 import { BlockquoteHTMLConverterAsync } from './converters/blockquote.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/async/types.ts

@@ -5,7 +5,7 @@ import type {
   DefaultNodeTypes,
   SerializedBlockNode,
   SerializedInlineBlockNode,
-} from '../../../../nodeTypes.js'
+} from '../../../../types/nodeTypes.js'
 import type { SerializedLexicalNodeWithParent } from '../shared/types.js'
 export type HTMLPopulateArguments = {
   collectionSlug: string

packages/richtext-lexical/src/features/converters/lexicalToHtml/shared/findConverterForNode.ts

@@ -1,7 +1,7 @@
 /* eslint-disable no-console */
 import type { SerializedLexicalNode } from 'lexical'
 
-import type { SerializedBlockNode, SerializedInlineBlockNode } from '../../../../nodeTypes.js'
+import type { SerializedBlockNode, SerializedInlineBlockNode } from '../../../../types/nodeTypes.js'
 import type { HTMLConverterAsync, HTMLConvertersAsync } from '../async/types.js'
 import type { HTMLConverter, HTMLConverters } from '../sync/types.js'
 import type { ProvidedCSS } from './types.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/blockquote.ts

@@ -1,4 +1,4 @@
-import type { SerializedQuoteNode } from '../../../../../nodeTypes.js'
+import type { SerializedQuoteNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 export const BlockquoteHTMLConverter: HTMLConverters<SerializedQuoteNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/heading.ts

@@ -1,4 +1,4 @@
-import type { SerializedHeadingNode } from '../../../../../nodeTypes.js'
+import type { SerializedHeadingNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 const ALLOWED_HEADING_TAGS = new Set(['h1', 'h2', 'h3', 'h4', 'h5', 'h6'])

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/horizontalRule.ts

@@ -1,4 +1,4 @@
-import type { SerializedHorizontalRuleNode } from '../../../../../nodeTypes.js'
+import type { SerializedHorizontalRuleNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 export const HorizontalRuleHTMLConverter: HTMLConverters<SerializedHorizontalRuleNode> = {
   horizontalrule: '<hr />',

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/linebreak.ts

@@ -1,4 +1,4 @@
-import type { SerializedLineBreakNode } from '../../../../../nodeTypes.js'
+import type { SerializedLineBreakNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 export const LinebreakHTMLConverter: HTMLConverters<SerializedLineBreakNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/link.ts

@@ -1,7 +1,7 @@
 import escapeHTML from 'escape-html'
 import { sanitizeUrl } from 'payload/shared'
 
-import type { SerializedAutoLinkNode, SerializedLinkNode } from '../../../../../nodeTypes.js'
+import type { SerializedAutoLinkNode, SerializedLinkNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 export const LinkHTMLConverter: (args: {

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/list.ts

@@ -1,6 +1,6 @@
 import { v4 as uuidv4 } from 'uuid'
 
-import type { SerializedListItemNode, SerializedListNode } from '../../../../../nodeTypes.js'
+import type { SerializedListItemNode, SerializedListNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 const ALLOWED_LIST_TAGS = new Set(['ol', 'ul'])

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/paragraph.ts

@@ -1,4 +1,4 @@
-import type { SerializedParagraphNode } from '../../../../../nodeTypes.js'
+import type { SerializedParagraphNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 export const ParagraphHTMLConverter: HTMLConverters<SerializedParagraphNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/tab.ts

@@ -1,4 +1,4 @@
-import type { SerializedTabNode } from '../../../../../nodeTypes.js'
+import type { SerializedTabNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 export const TabHTMLConverter: HTMLConverters<SerializedTabNode> = {

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/table.ts

@@ -2,7 +2,7 @@ import type {
   SerializedTableCellNode,
   SerializedTableNode,
   SerializedTableRowNode,
-} from '../../../../../nodeTypes.js'
+} from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 import { isSafeCssColor } from '../../shared/cssColors.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/text.ts

@@ -1,6 +1,6 @@
 import escapeHTML from 'escape-html'
 
-import type { SerializedTextNode } from '../../../../../nodeTypes.js'
+import type { SerializedTextNode } from '../../../../../types/nodeTypes.js'
 import type { HTMLConverters } from '../types.js'
 
 import { NodeFormat } from '../../../../../lexical/utils/nodeFormat.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/converters/upload.ts

@@ -2,7 +2,7 @@ import type { FileData, FileSize, TypeWithID } from 'payload'
 
 import escapeHTML from 'escape-html'
 
-import type { SerializedUploadNode } from '../../../../../nodeTypes.js'
+import type { SerializedUploadNode } from '../../../../../types/nodeTypes.js'
 import type { UploadDataImproved } from '../../../../upload/server/nodes/UploadNode.js'
 import type { HTMLConverters } from '../types.js'
 

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/defaultConverters.ts

@@ -1,4 +1,4 @@
-import type { DefaultNodeTypes } from '../../../../nodeTypes.js'
+import type { DefaultNodeTypes } from '../../../../types/nodeTypes.js'
 import type { HTMLConverters } from './types.js'
 
 import { BlockquoteHTMLConverter } from './converters/blockquote.js'

packages/richtext-lexical/src/features/converters/lexicalToHtml/sync/types.ts

@@ -4,7 +4,7 @@ import type {
   DefaultNodeTypes,
   SerializedBlockNode,
   SerializedInlineBlockNode,
-} from '../../../../nodeTypes.js'
+} from '../../../../types/nodeTypes.js'
 import type { SerializedLexicalNodeWithParent } from '../shared/types.js'
 
 export type HTMLConverter<T extends { [key: string]: any; type?: string } = SerializedLexicalNode> =

packages/richtext-lexical/src/features/converters/lexicalToJSX/Component/index.tsx

@@ -1,11 +1,11 @@
 import React from 'react'
 
+import type { SerializedNodeBase } from '../../../../types/index.js'
 import type {
   DefaultNodeTypes,
   SerializedBlockNode,
   SerializedInlineBlockNode,
-} from '../../../../nodeTypes.js'
-import type { SerializedNodeBase } from '../../../../types.js'
+} from '../../../../types/nodeTypes.js'
 import type { JSXConverters } from '../converter/types.js'
 
 import { defaultJSXConverters } from '../converter/defaultConverters.js'

packages/richtext-lexical/src/features/converters/lexicalToJSX/converter/converters/blockquote.tsx

@@ -1,4 +1,4 @@
-import type { SerializedQuoteNode } from '../../../../../nodeTypes.js'
+import type { SerializedQuoteNode } from '../../../../../types/nodeTypes.js'
 import type { JSXConverters } from '../types.js'
 
 export const BlockquoteJSXConverter: JSXConverters<SerializedQuoteNode> = {

packages/richtext-lexical/src/features/converters/lexicalToJSX/converter/converters/heading.tsx

@@ -1,4 +1,4 @@
-import type { SerializedHeadingNode } from '../../../../../nodeTypes.js'
+import type { SerializedHeadingNode } from '../../../../../types/nodeTypes.js'
 import type { JSXConverters } from '../types.js'
 
 export const HeadingJSXConverter: JSXConverters<SerializedHeadingNode> = {

packages/richtext-lexical/src/features/converters/lexicalToJSX/converter/converters/horizontalRule.tsx

@@ -1,4 +1,4 @@
-import type { SerializedHorizontalRuleNode } from '../../../../../nodeTypes.js'
+import type { SerializedHorizontalRuleNode } from '../../../../../types/nodeTypes.js'
 import type { JSXConverters } from '../types.js'
 export const HorizontalRuleJSXConverter: JSXConverters<SerializedHorizontalRuleNode> = {
   horizontalrule: <hr />,

packages/richtext-lexical/src/features/converters/lexicalToJSX/converter/converters/linebreak.tsx

@@ -1,4 +1,4 @@
-import type { SerializedLineBreakNode } from '../../../../../nodeTypes.js'
+import type { SerializedLineBreakNode } from '../../../../../types/nodeTypes.js'
 import type { JSXConverters } from '../types.js'
 
 export const LinebreakJSXConverter: JSXConverters<SerializedLineBreakNode> = {

packages/richtext-lexical/src/features/converters/lexicalToJSX/converter/converters/link.tsx

@@ -1,4 +1,4 @@
-import type { SerializedAutoLinkNode, SerializedLinkNode } from '../../../../../nodeTypes.js'
+import type { SerializedAutoLinkNode, SerializedLinkNode } from '../../../../../types/nodeTypes.js'
 import type { JSXConverters } from '../types.js'
 
 export const LinkJSXConverter: (args: {