Is it possible to generate more accurate types in the richText.content?

[Stupidism]

For example:

Current generated code:

export interface Article {
  id: string;
  content?: (
    | {
-        richText?: {
-         [k: string]: unknown;
-        }[];
        id?: string;
        blockName?: string;
        blockType: 'content';
      }
    | {
        mediaType?: 'image' | 'video';
        media: string | Media;
        link?: string;
        newTab?: boolean;
-        caption?: {
-          [k: string]: unknown;
-        }[];
        videoName: string;
        videoUrl: string;
        id?: string;
        blockName?: string;
        blockType: 'media';
      }

Expected generated code:

export interface Article {
  id: string;
  content?: (
    | {
+        richText?: RichText[];
        id?: string;
        blockName?: string;
        blockType: 'content';
      }
    | {
        mediaType?: 'image' | 'video';
        media: string | Media;
        link?: string;
        newTab?: boolean;
+        caption?: RichText[];
        videoName: string;
        videoUrl: string;
        id?: string;
        blockName?: string;
        blockType: 'media';
      }



export interface TextWithMark {
  text: string;
  bold?: boolean;
  italic?: boolean;
  underline?: boolean;
  strikethrough?: boolean;
  code?: boolean;
}

export interface Link {
  type: 'link';
  url: string;
  children: TextWithMark[];
  newTab?: boolean;
}

export type Inline = Link;

export type Fragment = TextWithMark | Link;

export interface Paragraph {
  type?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'hr';
  children: Fragment[];
}

export type Block = Paragraph;// || other blocks;

export interface Indent {
  type: 'indent';
  children: [Indent] | Block[];
}

export type Node = Indent | Block;

export type RichText =
  | Node
  | Inline
  | TextWithMark;

[jmikrut]

Hey @Stupidism — this should be completely possible and would be a great feature to add. Could be fairly complex to implement, because Payload doesn't necessarily know the shape of custom elements / leaves, but we could certainly extend custom elements / leaves to allow a developer to define the shape of data that is stored within them. Then, we could use that data shape in our type generation.

If this is something you are interested in taking on in a PR, we would happily accept it and we can point you in the right direction! Otherwise, not sure when we would be able to get to it.

Good question!

[Stupidism]

Got it. Added into my TODO list.

[Stupidism]

My temporary solution is to import a customized PayloadRichText definition and replace all the object code to PayloadRichText:

"commands": [
          "PAYLOAD_CONFIG_PATH=apps/seo-payload/src/payload.config.ts payload generate:types",
          "regex-replace 'tslint:disable' 'eslint-disable' apps/seo-payload/src/generated/payload-types.ts",
          "regex-replace 'payload generate:types' 'nx run seo-payload:ts-codegen' apps/seo-payload/src/generated/payload-types.ts",
          "regex-replace 'export interface Config' 'import { PayloadRichText } from \"./PayloadRichText\"; export interface Config' apps/seo-payload/src/generated/payload-types.ts",
          "regex-replace '\\{\n *\\[k: string\\]: unknown;\n *\\}\\[\\]' 'PayloadRichText' apps/seo-payload/src/generated/payload-types.ts"
        ],