refactor

Signed-off-by: Teo Koon Peng <[email protected]>

Author: koonpeng

diagram-editor/frontend/edges/buffer-edge.tsx

@@ -1,23 +1,17 @@
 import { type EdgeProps, StepEdge } from '@xyflow/react';
 import { memo } from 'react';
 import type { Edge } from '../types/react-flow';
-import type { SectionBufferSlotData } from './section-edge';
-
-export type BufferKeySlotData = {
-  type: 'bufferKey';
-  key: string;
-};
-
-export type BufferSeqSlotData = {
-  type: 'bufferSeq';
-  seq: number;
-};
+import type {
+  BufferKeyInputSlotData,
+  BufferSeqInputSlotData,
+  SectionBufferInputSlotData,
+} from './input-slots';
 
 export type BufferOutputData = Record<string, never>;
 
 export type BufferEdge = Edge<
   BufferOutputData,
-  BufferKeySlotData | BufferSeqSlotData | SectionBufferSlotData,
+  BufferKeyInputSlotData | BufferSeqInputSlotData | SectionBufferInputSlotData,
   'buffer'
 >;
 

diagram-editor/frontend/edges/create-edge.ts

@@ -1,9 +1,12 @@
 import { MarkerType } from '@xyflow/react';
 import { v4 as uuidv4 } from 'uuid';
 import type { DiagramEditorEdge, EdgeOutputData } from '.';
-import type { BufferKeySlotData, BufferSeqSlotData } from './buffer-edge';
 import type { DefaultEdge } from './default-edge';
-import type { SectionBufferSlotData } from './section-edge';
+import type {
+  BufferKeyInputSlotData,
+  BufferSeqInputSlotData,
+  SectionBufferInputSlotData,
+} from './input-slots';
 
 export function createBaseEdge(
   source: string,
@@ -109,7 +112,10 @@ export function createSplitRemainingEdge(
 export function createBufferEdge(
   source: string,
   target: string,
-  data: BufferKeySlotData | BufferSeqSlotData | SectionBufferSlotData,
+  data:
+    | BufferKeyInputSlotData
+    | BufferSeqInputSlotData
+    | SectionBufferInputSlotData,
 ): DiagramEditorEdge<'buffer'> {
   return {
     ...createBaseEdge(source, target),

diagram-editor/frontend/edges/data-edge.ts

@@ -0,0 +1,10 @@
+import type { Edge } from '../types/react-flow';
+import type { DefaultInputSlotData, SectionInputSlotData } from './input-slots';
+
+/**
+ * A specialization of `Edge` that enforces the edge input slot data is valid for data edges.
+ */
+export type DataEdge<
+  O extends Record<string, unknown>,
+  S extends string,
+> = Edge<O, DefaultInputSlotData | SectionInputSlotData, S>;

diagram-editor/frontend/edges/default-edge.tsx

@@ -1,6 +1,6 @@
 import { type EdgeProps, StepEdge } from '@xyflow/react';
 import { memo } from 'react';
-import type { DataEdge } from '.';
+import type { DataEdge } from './data-edge';
 
 export type DefaultEdgeOutputData = Record<string, never>;
 

diagram-editor/frontend/edges/fork-result-err-edge.tsx

@@ -1,6 +1,6 @@
 import { type EdgeProps, StepEdge } from '@xyflow/react';
 import { memo } from 'react';
-import type { DataEdge } from '.';
+import type { DataEdge } from './data-edge';
 
 export type ForkResultErrOutputData = Record<string, never>;
 export type ForkResultErrEdge = DataEdge<

diagram-editor/frontend/edges/fork-result-ok-edge.tsx

@@ -1,6 +1,6 @@
 import { type EdgeProps, StepEdge } from '@xyflow/react';
 import { memo } from 'react';
-import type { DataEdge } from '.';
+import type { DataEdge } from './data-edge';
 
 export type ForkResultOkOutputData = Record<string, never>;
 export type ForkResultOkEdge = DataEdge<ForkResultOkOutputData, 'forkResultOk'>;

diagram-editor/frontend/edges/index.ts

@@ -1,17 +1,13 @@
-import type { Edge } from '../types/react-flow';
 import { type BufferEdge, BufferEdgeComp } from './buffer-edge';
+import type { DataEdge } from './data-edge';
 import { type DefaultEdge, DefaultEdgeComp } from './default-edge';
 import ForkResultErrEdgeComp, {
   type ForkResultErrEdge,
 } from './fork-result-err-edge';
 import ForkResultOkEdgeComp, {
   type ForkResultOkEdge,
 } from './fork-result-ok-edge';
-import {
-  type SectionEdge,
-  type SectionInputSlotData,
-  SectionOutputEdgeComp,
-} from './section-edge';
+import { type SectionEdge, SectionOutputEdgeComp } from './section-edge';
 import SplitKeyEdgeComp, { type SplitKeyEdge } from './split-key-edge';
 import SplitRemainingEdgeComp, {
   type SplitRemainingEdge,
@@ -22,21 +18,15 @@ import UnzipEdgeComp, { type UnzipEdge } from './unzip-edge';
 
 export type { BufferEdge } from './buffer-edge';
 export * from './create-edge';
+export type * from './input-slots';
 export type { SectionEdge } from './section-edge';
 export type { SplitKeyEdge } from './split-key-edge';
 export type { SplitRemainingEdge } from './split-remaining-edge';
 export type { SplitSeqEdge } from './split-seq-edge';
 export type { StreamOutEdge } from './stream-out-edge';
 export type { UnzipEdge } from './unzip-edge';
 
-export type DefaultInputSlotData = { type: 'default' };
-
-export type DataEdge<
-  O extends Record<string, unknown>,
-  S extends string,
-> = Edge<O, DefaultInputSlotData | SectionInputSlotData, S>;
-
-export type EdgeMapping = {
+type EdgeMapping = {
   default: DefaultEdge;
   unzip: UnzipEdge;
   forkResultOk: ForkResultOkEdge;
@@ -56,6 +46,9 @@ export type EdgeData<K extends EdgeTypes = EdgeTypes> = EdgeMapping[K]['data'];
 export type EdgeOutputData<K extends EdgeTypes = EdgeTypes> =
   EdgeData<K>['output'];
 
+export type EdgeInputData<K extends EdgeTypes = EdgeTypes> =
+  EdgeData<K>['input'];
+
 export const EDGE_TYPES = {
   default: DefaultEdgeComp,
   unzip: UnzipEdgeComp,
@@ -77,7 +70,7 @@ export enum EdgeCategory {
   Stream,
 }
 
-export const EDGE_CATEGORIES: Record<EdgeTypes, EdgeCategory> = {
+export const EDGE_CATEGORIES = {
   buffer: EdgeCategory.Buffer,
   forkResultOk: EdgeCategory.Data,
   forkResultErr: EdgeCategory.Data,
@@ -88,7 +81,13 @@ export const EDGE_CATEGORIES: Record<EdgeTypes, EdgeCategory> = {
   streamOut: EdgeCategory.Stream,
   unzip: EdgeCategory.Data,
   section: EdgeCategory.Data,
-};
+} satisfies Record<EdgeTypes, EdgeCategory>;
+
+export type DataEdgeTypes = {
+  [K in EdgeTypes]: (typeof EDGE_CATEGORIES)[K] extends EdgeCategory.Data
+    ? K
+    : never;
+}[EdgeTypes];
 
 export function isDataEdge<T extends EdgeTypes>(
   edge: DiagramEditorEdge<T>,

diagram-editor/frontend/edges/input-slots.ts

@@ -0,0 +1,21 @@
+export type DefaultInputSlotData = { type: 'default' };
+
+export type SectionInputSlotData = {
+  type: 'sectionInput';
+  inputId: string;
+};
+
+export type BufferKeyInputSlotData = {
+  type: 'bufferKey';
+  key: string;
+};
+
+export type BufferSeqInputSlotData = {
+  type: 'bufferSeq';
+  seq: number;
+};
+
+export type SectionBufferInputSlotData = {
+  type: 'sectionBuffer';
+  inputId: string;
+};

diagram-editor/frontend/edges/section-edge.tsx

@@ -1,6 +1,6 @@
 import { type EdgeProps, StepEdge } from '@xyflow/react';
 import { memo } from 'react';
-import type { DataEdge } from '.';
+import type { DataEdge } from './data-edge';
 
 export type SectionOutputData = {
   output: string;
@@ -13,13 +13,3 @@ export type SectionOutputEdgeProps = Exclude<EdgeProps<SectionEdge>, 'label'>;
 export const SectionOutputEdgeComp = memo((props: SectionOutputEdgeProps) => {
   return <StepEdge {...props} label={props.data.output.output} />;
 });
-
-export type SectionInputSlotData = {
-  type: 'sectionInput';
-  inputId: string;
-};
-
-export type SectionBufferSlotData = {
-  type: 'sectionBuffer';
-  inputId: string;
-};

diagram-editor/frontend/edges/split-key-edge.tsx

@@ -1,6 +1,6 @@
 import { type EdgeProps, StepEdge } from '@xyflow/react';
 import { memo } from 'react';
-import type { DataEdge } from '.';
+import type { DataEdge } from './data-edge';
 
 export type SplitKeyOutputData = {
   key: string;