Use only one value for the enum type of a component (dynamic zone)

[baptadn]

What does it do?

Use only the current component name in the enum instead of all component names. Enum with one value describe a constant parameter (see https://swagger.io/docs/specification/describing-parameters/)

You can define a constant parameter as a required parameter with only one possible value

Blocks config example:

Example of generated code in the documentation, before/after:

{
  "cmsBlocks": {
    "type": "array",
    "items": {
      "oneOf": [
        {
          "properties": {
            "__component": {
              "type": "string",
              "enum": [
                "pages.hero-block"
-               "pages.title-block",
-               "pages.social-block"
              ]
            },
            "id": {
              "type": "string"
            },
            "title": {
              "type": "string"
            }
          },
          "required": [
            "id"
          ]
        },
        {
          "properties": {
            "__component": {
              "type": "string",
              "enum": [
-               "pages.hero-block",
                "pages.title-block",
-               "pages.social-block"
              ]
            },
            "id": {
              "type": "string"
            },
            "title": {
              "type": "string"
            }
          },
          "required": [
            "id"
          ]
        },
        {
          "properties": {
            "__component": {
              "type": "string",
              "enum": [
-              "pages.hero-block",
-              "pages.title-block",
                "pages.social-block"
              ]
            },
            "id": {
              "type": "string"
            },
            "facebookLink": {
              "type": "string"
            },
            "twitterLink": {
              "type": "string"
            }
          },
          "required": [
            "id"
          ]
        }
      ]
    }
  }
}

Why is it needed?

That allows us to get the right TypeScript types when using librairies like swagger-typescript-api:

const BlockRenderer = ({ page }: Props) => {
  return (
    <>
      {page.cmsBlocks.map((block, index) => {
        if (block.__component === 'pages.hero-block') {
          return (
            <HeroBlock
              key={index}
              title={block.title}             
            />
          )
        }
        if (block.__component === 'pages.social-block') {
          return (
            <SocialBlock
              key={index}
              facebookLink={block.facebookLink}
              twitterLink={block.twitterLink}           
            />
          )
        }
    </>
  )
}

Generated types before / after:

 cmsBlocks?: (
    | { __component?: "pages.hero-block" | "pages.title-block" | "pages.social-block"; id: string; title?: string }
    | { __component?: "pages.hero-block" | "pages.title-block" | "pages.social-block"; id: string; title?: string }
    | {
        __component?: "pages.hero-block" | "pages.title-block" | "pages.social-block";
        id: string;
        facebookLink?: string;
        twitterLink?: string;
      }
  )[];

 cmsBlocks?: (
    | { __component?: "pages.hero-block"; id: string; title?: string }
    | { __component?: "pages.title-block"; id: string; title?: string }
    | { __component?: "pages.social-block"; id: string; facebookLink?: string; twitterLink?: string }
  )[];

[strapi-cla]

All committers have signed the CLA.

[derrickmehaffy]

Hi 👋
We now have released the v4. As of now, the v3 is in maintenance mode for 6 months. We will only be fixing critical and security issues on v3 from now on.
I will go ahead and close this PR. Thank you for contributing to Strapi 🔥