Add override parameter to all block factories in @comet/cms-admin (…

…#3280) Co-authored-by: Johannes Obermair <48853629+johnnyomair@users.noreply.github.com>
vivid-planet · Feb 5, 2025 · c71604e · c71604e
1 parent 711958c
commit c71604e
Show file tree

Hide file tree

Showing 7 changed files with 81 additions and 39 deletions.
diff --git a/.changeset/strong-bees-breathe.md b/.changeset/strong-bees-breathe.md
@@ -0,0 +1,5 @@
+---
+"@comet/cms-admin": minor
+---
+
+Add an `override` argument to all block factories to follow `createCompositeBlock`'s pattern
diff --git a/packages/admin/cms-admin/src/blocks/createImageLinkBlock.tsx b/packages/admin/cms-admin/src/blocks/createImageLinkBlock.tsx
@@ -9,21 +9,27 @@ interface CreateImageLinkBlockOptions {
     name?: string;
 }
 
-export function createImageLinkBlock({ link: LinkBlock, image = PixelImageBlock, name = "ImageLink" }: CreateImageLinkBlockOptions): BlockInterface {
-    return createCompositeBlock({
-        name,
-        displayName: <FormattedMessage id="comet.blocks.imageLink" defaultMessage="Image/Link" />,
-        blocks: {
-            link: {
-                block: LinkBlock,
-                title: <FormattedMessage id="comet.blocks.imageLink.link" defaultMessage="Link" />,
-                paper: true,
-            },
-            image: {
-                block: image,
-                title: <FormattedMessage id="comet.blocks.imageLink.image" defaultMessage="Image" />,
-                paper: true,
+export function createImageLinkBlock(
+    { link: LinkBlock, image = PixelImageBlock, name = "ImageLink" }: CreateImageLinkBlockOptions,
+    override?: (block: BlockInterface) => BlockInterface,
+): BlockInterface {
+    return createCompositeBlock(
+        {
+            name,
+            displayName: <FormattedMessage id="comet.blocks.imageLink" defaultMessage="Image/Link" />,
+            blocks: {
+                link: {
+                    block: LinkBlock,
+                    title: <FormattedMessage id="comet.blocks.imageLink.link" defaultMessage="Link" />,
+                    paper: true,
+                },
+                image: {
+                    block: image,
+                    title: <FormattedMessage id="comet.blocks.imageLink.image" defaultMessage="Image" />,
+                    paper: true,
+                },
             },
         },
-    });
+        override,
+    );
 }
diff --git a/packages/admin/cms-admin/src/blocks/createLinkBlock.tsx b/packages/admin/cms-admin/src/blocks/createLinkBlock.tsx
@@ -20,20 +20,26 @@ interface CreateLinkBlockOptions extends Omit<CreateOneOfBlockOptions<boolean>,
     supportedBlocks?: Record<string, BlockInterface & LinkBlockInterface>;
 }
 
-function createLinkBlock({
-    name = "Link",
-    displayName = <FormattedMessage id="comet.blocks.link" defaultMessage="Link" />,
-    supportedBlocks = { internal: InternalLinkBlock, external: ExternalLinkBlock },
-    allowEmpty = false,
-    ...oneOfBlockOptions
-}: CreateLinkBlockOptions): BlockInterface & LinkBlockInterface {
-    const OneOfBlock = createOneOfBlock({
-        name,
-        displayName,
-        supportedBlocks,
-        allowEmpty,
-        ...oneOfBlockOptions,
-    });
+function createLinkBlock(
+    {
+        name = "Link",
+        displayName = <FormattedMessage id="comet.blocks.link" defaultMessage="Link" />,
+        supportedBlocks = { internal: InternalLinkBlock, external: ExternalLinkBlock },
+        allowEmpty = false,
+        ...oneOfBlockOptions
+    }: CreateLinkBlockOptions,
+    override?: (block: BlockInterface & LinkBlockInterface) => BlockInterface & LinkBlockInterface,
+): BlockInterface & LinkBlockInterface {
+    const OneOfBlock = createOneOfBlock(
+        {
+            name,
+            displayName,
+            supportedBlocks,
+            allowEmpty,
+            ...oneOfBlockOptions,
+        },
+        override,
+    );
 
     return {
         ...OneOfBlock,

diff --git a/packages/admin/cms-admin/src/blocks/createRichTextBlock.tsx b/packages/admin/cms-admin/src/blocks/createRichTextBlock.tsx
@@ -96,6 +96,9 @@ export type RichTextBlock = BlockInterface<RichTextBlockData, RichTextBlockState
 
 export const createRichTextBlock = (
     options: RichTextBlockFactoryOptions,
+    override?: (
+        block: BlockInterface<RichTextBlockData, RichTextBlockState, RichTextBlockInput>,
+    ) => BlockInterface<RichTextBlockData, RichTextBlockState, RichTextBlockInput>,
 ): BlockInterface<RichTextBlockData, RichTextBlockState, RichTextBlockInput> => {
     const CmsLinkToolbarButton = createCmsLinkToolbarButton({ link: options.link });
     const defaultRteOptions: IRteOptions = {
@@ -254,5 +257,10 @@ export const createRichTextBlock = (
             return content.hasText() ? [{ type: "text", content: content.getPlainText().slice(0, MAX_CHARS) }] : [];
         },
     };
+
+    if (override) {
+        return override(RichTextBlock);
+    }
+
     return RichTextBlock;
 };
diff --git a/packages/admin/cms-admin/src/blocks/createSeoBlock.tsx b/packages/admin/cms-admin/src/blocks/createSeoBlock.tsx
@@ -32,7 +32,10 @@ interface CreateSeoBlockOptions {
     image?: BlockInterface;
 }
 
-export function createSeoBlock({ image = PixelImageBlock }: CreateSeoBlockOptions = {}): BlockInterface {
+export function createSeoBlock(
+    { image = PixelImageBlock }: CreateSeoBlockOptions = {},
+    override?: (block: BlockInterface) => BlockInterface,
+): BlockInterface {
     const OptionalImageBlock = createOptionalBlock(image, {
         title: <FormattedMessage id="comet.sitemap.openGraphImage" defaultMessage="Open Graph Image" />,
     });
@@ -328,6 +331,10 @@ export function createSeoBlock({ image = PixelImageBlock }: CreateSeoBlockOption
         },
     };
 
+    if (override) {
+        return override(SeoBlock);
+    }
+
     return SeoBlock;
 }
 

diff --git a/packages/admin/cms-admin/src/blocks/createTextImageBlock.tsx b/packages/admin/cms-admin/src/blocks/createTextImageBlock.tsx
@@ -29,10 +29,12 @@ export interface TextImageBlockFactoryOptions {
     image?: BlockInterface;
 }
 
-const createTextImageBlock = ({
-    text,
-    image = PixelImageBlock,
-}: TextImageBlockFactoryOptions): BlockInterface<TextImageBlockData, State, TextImageBlockInput> => {
+const createTextImageBlock = (
+    { text, image = PixelImageBlock }: TextImageBlockFactoryOptions,
+    override?: (
+        block: BlockInterface<TextImageBlockData, State, TextImageBlockInput>,
+    ) => BlockInterface<TextImageBlockData, State, TextImageBlockInput>,
+): BlockInterface<TextImageBlockData, State, TextImageBlockInput> => {
     const composed = composeBlocks({ text, image });
 
     const { api: composedApi, block: composedBlock } = composed;
@@ -106,6 +108,11 @@ const createTextImageBlock = ({
             );
         },
     };
+
+    if (override) {
+        return override(TextImageBlock);
+    }
+
     return TextImageBlock;
 };
 

diff --git a/packages/admin/cms-admin/src/blocks/createTextLinkBlock.tsx b/packages/admin/cms-admin/src/blocks/createTextLinkBlock.tsx
@@ -22,11 +22,10 @@ interface CreateTextLinkBlockOptions {
     link: BlockInterface;
 }
 
-export function createTextLinkBlock({
-    link: LinkBlock,
-    name = "TextLink",
-    displayName = <FormattedMessage {...messages.link} />,
-}: CreateTextLinkBlockOptions): BlockInterface {
+export function createTextLinkBlock(
+    { link: LinkBlock, name = "TextLink", displayName = <FormattedMessage {...messages.link} /> }: CreateTextLinkBlockOptions,
+    override?: (block: BlockInterface) => BlockInterface,
+): BlockInterface {
     const { api: composedApi, block: composedBlock } = composeBlocks({ link: LinkBlock });
 
     const block = withAdditionalBlockAttributes<Pick<TextLinkBlockData, "text">>({
@@ -70,5 +69,9 @@ export function createTextLinkBlock({
         dynamicDisplayName: (state) => LinkBlock.dynamicDisplayName?.(state.link),
     };
 
+    if (override) {
+        return override(TextLinkBlock);
+    }
+
     return TextLinkBlock;
 }