fix(ui-kit): Fix SurfaceRendererPayload (#556)

Author: tassoevan

packages/ui-kit/src/rendering/SurfaceRenderer.ts

@@ -16,7 +16,6 @@ import { SectionBlock } from '../blocks/layout/SectionBlock';
 import { Markdown } from '../blocks/text/Markdown';
 import { PlainText } from '../blocks/text/PlainText';
 import { isNotNull } from '../isNotNull';
-import { Permutation } from '../utils/Permutation';
 import { BlockContext } from './BlockContext';
 import { BlockRenderers } from './BlockRenderers';
 import { Conditions } from './Conditions';
@@ -30,12 +29,14 @@ export abstract class SurfaceRenderer<
   B extends RenderableLayoutBlock = RenderableLayoutBlock
 > implements BlockRenderers<T>
 {
-  public constructor(
-    protected readonly allowedLayoutBlockTypes: Permutation<B['type']>
-  ) {}
+  protected readonly allowedLayoutBlockTypes: Set<B['type']>;
+
+  public constructor(allowedLayoutBlockTypes: B['type'][]) {
+    this.allowedLayoutBlockTypes = new Set(allowedLayoutBlockTypes);
+  }
 
   private isAllowedLayoutBlock = (block: Block): block is B =>
-    (this.allowedLayoutBlockTypes as string[])?.includes(block.type) ?? true;
+    this.allowedLayoutBlockTypes.has(block.type as B['type']);
 
   public render(blocks: readonly Block[], conditions?: Conditions): T[] {
     if (!Array.isArray(blocks)) {
@@ -62,9 +63,7 @@ export abstract class SurfaceRenderer<
     index: number
   ): T | null {
     if (
-      (this.allowedLayoutBlockTypes as string[])?.includes(
-        LayoutBlockType.ACTIONS
-      ) === false &&
+      this.allowedLayoutBlockTypes.has(LayoutBlockType.ACTIONS) === false &&
       !isActionsBlockElement(block)
     ) {
       return null;
@@ -88,9 +87,7 @@ export abstract class SurfaceRenderer<
     index: number
   ): T | null {
     if (
-      (this.allowedLayoutBlockTypes as string[])?.includes(
-        LayoutBlockType.CONTEXT
-      ) === false &&
+      this.allowedLayoutBlockTypes.has(LayoutBlockType.CONTEXT) === false &&
       !isContextBlockElement(block)
     ) {
       return null;
@@ -115,9 +112,7 @@ export abstract class SurfaceRenderer<
 
   public renderInputBlockElement(block: BlockElement, index: number): T | null {
     if (
-      (this.allowedLayoutBlockTypes as string[])?.includes(
-        LayoutBlockType.INPUT
-      ) === false &&
+      this.allowedLayoutBlockTypes.has(LayoutBlockType.INPUT) === false &&
       !isInputBlockElement(block)
     ) {
       return null;
@@ -141,9 +136,7 @@ export abstract class SurfaceRenderer<
     index: number
   ): T | null {
     if (
-      (this.allowedLayoutBlockTypes as string[])?.includes(
-        LayoutBlockType.SECTION
-      ) === false &&
+      this.allowedLayoutBlockTypes.has(LayoutBlockType.SECTION) === false &&
       !isSectionBlockAccessoryElement(block)
     ) {
       return null;
@@ -201,6 +194,3 @@ export abstract class SurfaceRenderer<
     index: number
   ): T | null;
 }
-
-export type SurfaceRendererPayload<S extends BlockRenderers<any>> =
-  S extends SurfaceRenderer<any, infer T> ? T[] : never;

packages/ui-kit/src/rendering/surfaces/UiKitParserAttachment.ts

@@ -3,17 +3,22 @@ import { ContextBlock } from '../../blocks/layout/ContextBlock';
 import { DividerBlock } from '../../blocks/layout/DividerBlock';
 import { ImageBlock } from '../../blocks/layout/ImageBlock';
 import { SectionBlock } from '../../blocks/layout/SectionBlock';
-import { SurfaceRenderer, SurfaceRendererPayload } from '../SurfaceRenderer';
+import { SurfaceRenderer } from '../SurfaceRenderer';
+
+type AttachmentSurfaceLayoutBlock =
+  | ActionsBlock
+  | ContextBlock
+  | DividerBlock
+  | ImageBlock
+  | SectionBlock;
 
 export abstract class UiKitParserAttachment<T> extends SurfaceRenderer<
   T,
-  ActionsBlock | ContextBlock | DividerBlock | ImageBlock | SectionBlock
+  AttachmentSurfaceLayoutBlock
 > {
   public constructor() {
     super(['actions', 'context', 'divider', 'image', 'section']);
   }
 }
 
-export type AttachmentSurfaceLayout = SurfaceRendererPayload<
-  UiKitParserAttachment<any>
->;
+export type AttachmentSurfaceLayout = AttachmentSurfaceLayoutBlock[];

packages/ui-kit/src/rendering/surfaces/UiKitParserBanner.ts

@@ -4,22 +4,23 @@ import { DividerBlock } from '../../blocks/layout/DividerBlock';
 import { ImageBlock } from '../../blocks/layout/ImageBlock';
 import { InputBlock } from '../../blocks/layout/InputBlock';
 import { SectionBlock } from '../../blocks/layout/SectionBlock';
-import { SurfaceRenderer, SurfaceRendererPayload } from '../SurfaceRenderer';
+import { SurfaceRenderer } from '../SurfaceRenderer';
 
-export abstract class UiKitParserBanner<T> extends SurfaceRenderer<
-  T,
+type BannerSurfaceLayoutBlock =
   | ActionsBlock
   | ContextBlock
   | DividerBlock
   | ImageBlock
   | InputBlock
-  | SectionBlock
+  | SectionBlock;
+
+export abstract class UiKitParserBanner<T> extends SurfaceRenderer<
+  T,
+  BannerSurfaceLayoutBlock
 > {
   public constructor() {
     super(['actions', 'context', 'divider', 'image', 'input', 'section']);
   }
 }
 
-export type BannerSurfaceLayout = SurfaceRendererPayload<
-  UiKitParserBanner<any>
->;
+export type BannerSurfaceLayout = BannerSurfaceLayoutBlock[];

packages/ui-kit/src/rendering/surfaces/UiKitParserMessage.ts

@@ -3,17 +3,22 @@ import { ContextBlock } from '../../blocks/layout/ContextBlock';
 import { DividerBlock } from '../../blocks/layout/DividerBlock';
 import { ImageBlock } from '../../blocks/layout/ImageBlock';
 import { SectionBlock } from '../../blocks/layout/SectionBlock';
-import { SurfaceRenderer, SurfaceRendererPayload } from '../SurfaceRenderer';
+import { SurfaceRenderer } from '../SurfaceRenderer';
+
+type MessageSurfaceLayoutBlock =
+  | ActionsBlock
+  | ContextBlock
+  | DividerBlock
+  | ImageBlock
+  | SectionBlock;
 
 export abstract class UiKitParserMessage<OutputElement> extends SurfaceRenderer<
   OutputElement,
-  ActionsBlock | ContextBlock | DividerBlock | ImageBlock | SectionBlock
+  MessageSurfaceLayoutBlock
 > {
   public constructor() {
     super(['actions', 'context', 'divider', 'image', 'section']);
   }
 }
 
-export type MessageSurfaceLayout = SurfaceRendererPayload<
-  UiKitParserMessage<any>
->;
+export type MessageSurfaceLayout = MessageSurfaceLayoutBlock[];

packages/ui-kit/src/rendering/surfaces/UiKitParserModal.ts

@@ -4,20 +4,23 @@ import { DividerBlock } from '../../blocks/layout/DividerBlock';
 import { ImageBlock } from '../../blocks/layout/ImageBlock';
 import { InputBlock } from '../../blocks/layout/InputBlock';
 import { SectionBlock } from '../../blocks/layout/SectionBlock';
-import { SurfaceRenderer, SurfaceRendererPayload } from '../SurfaceRenderer';
+import { SurfaceRenderer } from '../SurfaceRenderer';
 
-export abstract class UiKitParserModal<OutputElement> extends SurfaceRenderer<
-  OutputElement,
+type ModalSurfaceLayoutBlock =
   | ActionsBlock
   | ContextBlock
   | DividerBlock
   | ImageBlock
   | InputBlock
-  | SectionBlock
+  | SectionBlock;
+
+export abstract class UiKitParserModal<OutputElement> extends SurfaceRenderer<
+  OutputElement,
+  ModalSurfaceLayoutBlock
 > {
   public constructor() {
     super(['actions', 'context', 'divider', 'image', 'input', 'section']);
   }
 }
 
-export type ModalSurfaceLayout = SurfaceRendererPayload<UiKitParserModal<any>>;
+export type ModalSurfaceLayout = ModalSurfaceLayoutBlock[];