a66f90ebb6
Lexical tests comprise almost half of the collections in the fields suite, and are starting to become complex to manage. They are sometimes related to other auxiliary collections, so refactoring one test sometimes breaks another, seemingly unrelated one. In addition, the fields suite is very large, taking a long time to compile. This will make it faster. Some ideas for future refactorings: - 3 main collections: defaultFeatures, fully featured, and legacy. Legacy is the current one that has multiple editors and could later be migrated to the first two. - Avoid collections with more than 1 editor. - Create reseed buttons to restore the editor to certain states, to avoid a proliferation of collections and documents. - Reduce the complexity of the three auxiliary collections (text, array, upload), which are rarely or never used and have many fields designed for tests in the fields suite.
322 lines
8.7 KiB
TypeScript
322 lines
8.7 KiB
TypeScript
import type {
|
|
SerializedBlockNode,
|
|
SerializedParagraphNode,
|
|
SerializedTextNode,
|
|
SerializedUploadNode,
|
|
TypedEditorState,
|
|
} from '@payloadcms/richtext-lexical'
|
|
|
|
export function generateLexicalRichText(): TypedEditorState<
|
|
SerializedBlockNode | SerializedParagraphNode | SerializedTextNode | SerializedUploadNode
|
|
> {
|
|
return {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Upload Node:',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
textFormat: 0,
|
|
version: 1,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'upload',
|
|
version: 2,
|
|
id: '665d105a91e1c337ba8308dd',
|
|
fields: {
|
|
caption: {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Relationship inside Upload Caption:',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'relationship',
|
|
version: 2,
|
|
relationTo: 'text-fields',
|
|
value: '{{TEXT_DOC_ID}}',
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
},
|
|
},
|
|
},
|
|
relationTo: 'uploads',
|
|
value: '{{UPLOAD_DOC_ID}}',
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b13db4ef8c744a7faaa',
|
|
rel: '{{UPLOAD_DOC_ID}}',
|
|
blockName: 'Block Node, with Relationship Field',
|
|
blockType: 'relationshipBlock',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '6565c8668294bf824c24d4a4',
|
|
blockName: '',
|
|
blockType: 'relationshipHasManyBlock',
|
|
rel: [
|
|
{
|
|
value: '{{TEXT_DOC_ID}}',
|
|
relationTo: 'text-fields',
|
|
},
|
|
{
|
|
value: '{{UPLOAD_DOC_ID}}',
|
|
relationTo: 'uploads',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b1ddb4ef8c744a7faab',
|
|
richTextField: {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
format: '',
|
|
type: 'relationship',
|
|
version: 2,
|
|
relationTo: 'rich-text-fields',
|
|
value: '{{RICH_TEXT_DOC_ID}}',
|
|
},
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Some text below relationship node 1',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: null,
|
|
},
|
|
},
|
|
blockName: 'Block Node, with RichText Field, with Relationship Node',
|
|
blockType: 'richTextBlock',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b2bdb4ef8c744a7faac',
|
|
blockName: 'Block Node, with Blocks Field, With RichText Field, With Relationship Node',
|
|
blockType: 'subBlockLexical',
|
|
subBlocksLexical: [
|
|
{
|
|
id: '65298b2edb4ef8c744a7faad',
|
|
richText: {
|
|
root: {
|
|
type: 'root',
|
|
format: '',
|
|
indent: 0,
|
|
version: 1,
|
|
children: [
|
|
{
|
|
format: '',
|
|
type: 'relationship',
|
|
version: 2,
|
|
relationTo: 'text-fields',
|
|
value: '{{TEXT_DOC_ID}}',
|
|
},
|
|
{
|
|
children: [
|
|
{
|
|
detail: 0,
|
|
format: 0,
|
|
mode: 'normal',
|
|
style: '',
|
|
text: 'Some text below relationship node 2',
|
|
type: 'text',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
},
|
|
],
|
|
direction: null,
|
|
},
|
|
},
|
|
blockType: 'contentBlock',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65298b49db4ef8c744a7faae',
|
|
upload: '{{UPLOAD_DOC_ID}}',
|
|
blockName: 'Block Node, With Upload Field',
|
|
blockType: 'uploadAndRichText',
|
|
},
|
|
},
|
|
{
|
|
children: [],
|
|
direction: null,
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
textFormat: 0,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65532e49fe515eb112e605a3',
|
|
blockName: 'Radio Buttons 1',
|
|
blockType: 'radioButtons',
|
|
radioButtons: 'option1',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65532e50fe515eb112e605a4',
|
|
blockName: 'Radio Buttons 2',
|
|
blockType: 'radioButtons',
|
|
radioButtons: 'option1',
|
|
},
|
|
},
|
|
{
|
|
children: [],
|
|
direction: null,
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
textFormat: 0,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '65588bfa80fb5a147a378e74',
|
|
blockName: '',
|
|
blockType: 'conditionalLayout',
|
|
layout: '1',
|
|
columns: [
|
|
{
|
|
id: '65588bfb80fb5a147a378e75',
|
|
text: 'text in conditionalLayout block',
|
|
},
|
|
],
|
|
},
|
|
}, // Do not remove this blocks node. It ensures that validation passes when it's created
|
|
{
|
|
children: [],
|
|
direction: null,
|
|
format: '',
|
|
indent: 0,
|
|
type: 'paragraph',
|
|
version: 1,
|
|
textFormat: 0,
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '666c9dfd189d72626ea301f9',
|
|
blockName: '',
|
|
tab1: {
|
|
text1: 'Some text1',
|
|
},
|
|
tab2: {
|
|
text2: 'Some text2',
|
|
},
|
|
blockType: 'tabBlock',
|
|
},
|
|
},
|
|
{
|
|
format: '',
|
|
type: 'block',
|
|
version: 2,
|
|
fields: {
|
|
id: '666c9e0b189d72626ea301fa',
|
|
blockName: '',
|
|
blockType: 'code',
|
|
code: 'Some code\nhello\nworld',
|
|
},
|
|
},
|
|
],
|
|
direction: 'ltr',
|
|
},
|
|
}
|
|
}
|