@squeed/flow-sdk 2.0.16 → 2.0.18

package/dist/index.d.cts

@@ -125,6 +125,8 @@ export declare interface ConnectionsOnlyToggleProps {
     label?: string;
 }
 
+export declare type ContentFormat = "markdown" | "html" | "jsx";
+
 export declare const contentObjTheme: (color: any) => {
     background: any;
     highlight: string;
@@ -203,6 +205,13 @@ export declare function createJsonStream<Document>(options: JsonStreamOptions<Do
     cancel(): void;
 };
 
+export declare function createWorkflowExecution<Input>(adapter: WorkflowExecutionAdapter<Input>, onChange: (state: WorkflowExecutionState) => void): {
+    getState: () => WorkflowExecutionState;
+    run(input: Input, executionId?: string): Promise<WorkflowExecutionState>;
+    cancel(): Promise<void>;
+    dispose(): void;
+};
+
 export declare interface CustomEdgeContext {
     edge: FlowDiagramEdge["data"];
     source: Box;
@@ -355,6 +364,7 @@ export declare interface FlowDiagramCallbacks {
     onDirectionChange?: (direction: FlowDirection) => void;
     onThemeColorChange?: (color: string) => void;
     onEdgeModeChange?: (mode: EdgeMode) => void;
+    onWorkflowConfigurationOpen?: () => void;
     onWorkflowContractChange?: (contract: WorkflowContract | undefined) => void;
     /** Fires when array/set mode toggles in bottom bar */
     onArrayModeChange?: (isArrayMode: boolean) => void;
@@ -613,11 +623,11 @@ export declare interface FlowEngine {
     centerAndFit(padding?: number, animate?: boolean): void;
     /** Centre all elements at the current zoom */
     center(animate?: boolean): void;
-    /** Fit one currently laid-out node; padding is in screen pixels (default 50). */
-    focusNode(id: string, padding?: number, animate?: boolean): void;
+    /** Fit one node; afterViewChange waits for opening geometry. Padding is in screen pixels (default 50). */
+    focusNode(id: string, padding?: number, animate?: boolean, afterViewChange?: boolean): void;
     /** Fit laid-out hierarchy descendants and outgoing reachable nodes. Does not expand collapsed nodes. Animate overrides config.animateViewport. */
     focusBranch(id: string, padding?: number, animate?: boolean): void;
-    focusConnections(id: string, padding?: number, animate?: boolean): void;
+    focusConnections(id: string, padding?: number, animate?: boolean, afterViewChange?: boolean): void;
     isolateConnections(id: string, padding?: number, animate?: boolean): void;
     /** Temporarily show only this branch and fit it, preserving graph data. */
     isolateBranch(id: string, padding?: number, animate?: boolean): void;
@@ -836,7 +846,7 @@ export declare function NodeForm({ nodeAddress, structured, }: {
     structured?: boolean;
 }): JSX_2.Element;
 
-export declare function NodeFormPopover({ nodeAddress, active, label, open, onClose, children, filter, height, }: {
+export declare function NodeFormPopover({ nodeAddress, active, label, open, onClose, children, filter, height, width, }: {
     nodeAddress: string;
     active: boolean;
     label: string;
@@ -845,6 +855,7 @@ export declare function NodeFormPopover({ nodeAddress, active, label, open, onCl
     children?: ReactNode;
     filter?: ReactNode;
     height?: number;
+    width?: number;
 }): JSX_2.Element;
 
 export declare function NodeIconPicker({ nodeId, edgeId, value, open: requestedOpen, onOpenChange, }: {
@@ -1082,7 +1093,7 @@ export declare type SqueedEdgeKey = "$edgeIcon" | "$edgeType" | "$sourceLabel" |
 export declare type SqueedJson = Record<string, any> | any[];
 
 /** Schema keys that live on a node */
-export declare type SqueedNodeKey = "$view" | "$label" | "$subtitle" | "$form" | "$bgColor" | "$textColor" | "$borderColor" | "$borderStyle" | "$borderWidth" | "$borderRadius" | "$fontSize" | "$icon" | "$content" | "$media" | "$collapsed" | "$parent" | "$outline" | "$isNodeAnimated" | "$nodeAnimationVariant" | "$connections" | "$ports";
+export declare type SqueedNodeKey = "$view" | "$label" | "$subtitle" | "$form" | "$bgColor" | "$textColor" | "$borderColor" | "$borderStyle" | "$borderWidth" | "$borderRadius" | "$fontSize" | "$icon" | "$content" | "$contentFormat" | "$media" | "$collapsed" | "$parent" | "$outline" | "$isNodeAnimated" | "$nodeAnimationVariant" | "$connections" | "$ports";
 
 export declare interface StateFormBinding {
     address: string;
@@ -1163,6 +1174,7 @@ export declare function ToolbarDivider(): JSX_2.Element;
 
 export declare const ToolbarIconButton: ForwardRefExoticComponent<Omit<IconButtonProps & RefAttributes<HTMLButtonElement> & {
 icon: React.ReactElement;
+rememberAction?: boolean;
 }, "ref"> & RefAttributes<HTMLButtonElement>>;
 
 export declare const ToolbarRangeInput: ForwardRefExoticComponent<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & RefAttributes<HTMLInputElement>>;
@@ -1174,7 +1186,7 @@ export declare function ToolbarScrollContainer({ children, background, border, e
     endElement?: ReactNode;
 }): JSX_2.Element;
 
-export declare function ToolbarSelect({ children, value, onValueChange, disabled, style, title, icon, popupContent, labelCase, "aria-label": label, ...triggerProps }: {
+export declare function ToolbarSelect({ children, value, onValueChange, disabled, style, title, icon, popupContent, footer, labelCase, "aria-label": label, ...triggerProps }: {
     children: ReactNode;
     value: string;
     onValueChange: (value: string) => void;
@@ -1183,6 +1195,7 @@ export declare function ToolbarSelect({ children, value, onValueChange, disabled
     title?: string;
     icon?: ReactNode;
     popupContent?: ReactNode;
+    footer?: ReactNode;
     labelCase?: "title" | "preserve";
     "aria-label": string;
 } & Pick<React.ComponentProps<"button">, "id" | "aria-required" | "aria-invalid" | "aria-describedby">): JSX_2.Element;
@@ -1295,4 +1308,41 @@ export declare function WorkflowControls({ showDivider, compact, }?: {
     compact?: boolean;
 }): JSX_2.Element;
 
+export declare interface WorkflowExecutionAdapter<Input> {
+    execute: (request: WorkflowExecutionRequest<Input>) => Promise<WorkflowExecutionUpdate | void>;
+    subscribe: (request: WorkflowExecutionRequest<Input>, receive: (update: WorkflowExecutionUpdate) => void) => (() => void) | Promise<() => void>;
+    cancel?: (request: WorkflowExecutionRequest<Input>) => Promise<void>;
+}
+
+export declare interface WorkflowExecutionRequest<Input> {
+    executionId: string;
+    input: Input;
+    signal: AbortSignal;
+}
+
+export declare interface WorkflowExecutionState {
+    executionId: string;
+    status: WorkflowRunStatus;
+    output?: unknown;
+    error?: string;
+    steps: Record<string, NonNullable<WorkflowExecutionUpdate["step"]>>;
+}
+
+export declare interface WorkflowExecutionUpdate {
+    executionId: string;
+    status?: WorkflowRunStatus;
+    output?: unknown;
+    error?: string;
+    step?: {
+        id: string;
+        status: WorkflowStepStatus;
+        output?: unknown;
+        error?: string;
+    };
+}
+
+export declare type WorkflowRunStatus = "subscribing" | "running" | "paused" | "completed" | "failed" | "cancelled";
+
+export declare type WorkflowStepStatus = "pending" | "running" | "completed" | "failed" | "skipped";
+
 export { }

package/dist/index.d.ts

@@ -125,6 +125,8 @@ export declare interface ConnectionsOnlyToggleProps {
     label?: string;
 }
 
+export declare type ContentFormat = "markdown" | "html" | "jsx";
+
 export declare const contentObjTheme: (color: any) => {
     background: any;
     highlight: string;
@@ -203,6 +205,13 @@ export declare function createJsonStream<Document>(options: JsonStreamOptions<Do
     cancel(): void;
 };
 
+export declare function createWorkflowExecution<Input>(adapter: WorkflowExecutionAdapter<Input>, onChange: (state: WorkflowExecutionState) => void): {
+    getState: () => WorkflowExecutionState;
+    run(input: Input, executionId?: string): Promise<WorkflowExecutionState>;
+    cancel(): Promise<void>;
+    dispose(): void;
+};
+
 export declare interface CustomEdgeContext {
     edge: FlowDiagramEdge["data"];
     source: Box;
@@ -355,6 +364,7 @@ export declare interface FlowDiagramCallbacks {
     onDirectionChange?: (direction: FlowDirection) => void;
     onThemeColorChange?: (color: string) => void;
     onEdgeModeChange?: (mode: EdgeMode) => void;
+    onWorkflowConfigurationOpen?: () => void;
     onWorkflowContractChange?: (contract: WorkflowContract | undefined) => void;
     /** Fires when array/set mode toggles in bottom bar */
     onArrayModeChange?: (isArrayMode: boolean) => void;
@@ -613,11 +623,11 @@ export declare interface FlowEngine {
     centerAndFit(padding?: number, animate?: boolean): void;
     /** Centre all elements at the current zoom */
     center(animate?: boolean): void;
-    /** Fit one currently laid-out node; padding is in screen pixels (default 50). */
-    focusNode(id: string, padding?: number, animate?: boolean): void;
+    /** Fit one node; afterViewChange waits for opening geometry. Padding is in screen pixels (default 50). */
+    focusNode(id: string, padding?: number, animate?: boolean, afterViewChange?: boolean): void;
     /** Fit laid-out hierarchy descendants and outgoing reachable nodes. Does not expand collapsed nodes. Animate overrides config.animateViewport. */
     focusBranch(id: string, padding?: number, animate?: boolean): void;
-    focusConnections(id: string, padding?: number, animate?: boolean): void;
+    focusConnections(id: string, padding?: number, animate?: boolean, afterViewChange?: boolean): void;
     isolateConnections(id: string, padding?: number, animate?: boolean): void;
     /** Temporarily show only this branch and fit it, preserving graph data. */
     isolateBranch(id: string, padding?: number, animate?: boolean): void;
@@ -836,7 +846,7 @@ export declare function NodeForm({ nodeAddress, structured, }: {
     structured?: boolean;
 }): JSX_2.Element;
 
-export declare function NodeFormPopover({ nodeAddress, active, label, open, onClose, children, filter, height, }: {
+export declare function NodeFormPopover({ nodeAddress, active, label, open, onClose, children, filter, height, width, }: {
     nodeAddress: string;
     active: boolean;
     label: string;
@@ -845,6 +855,7 @@ export declare function NodeFormPopover({ nodeAddress, active, label, open, onCl
     children?: ReactNode;
     filter?: ReactNode;
     height?: number;
+    width?: number;
 }): JSX_2.Element;
 
 export declare function NodeIconPicker({ nodeId, edgeId, value, open: requestedOpen, onOpenChange, }: {
@@ -1082,7 +1093,7 @@ export declare type SqueedEdgeKey = "$edgeIcon" | "$edgeType" | "$sourceLabel" |
 export declare type SqueedJson = Record<string, any> | any[];
 
 /** Schema keys that live on a node */
-export declare type SqueedNodeKey = "$view" | "$label" | "$subtitle" | "$form" | "$bgColor" | "$textColor" | "$borderColor" | "$borderStyle" | "$borderWidth" | "$borderRadius" | "$fontSize" | "$icon" | "$content" | "$media" | "$collapsed" | "$parent" | "$outline" | "$isNodeAnimated" | "$nodeAnimationVariant" | "$connections" | "$ports";
+export declare type SqueedNodeKey = "$view" | "$label" | "$subtitle" | "$form" | "$bgColor" | "$textColor" | "$borderColor" | "$borderStyle" | "$borderWidth" | "$borderRadius" | "$fontSize" | "$icon" | "$content" | "$contentFormat" | "$media" | "$collapsed" | "$parent" | "$outline" | "$isNodeAnimated" | "$nodeAnimationVariant" | "$connections" | "$ports";
 
 export declare interface StateFormBinding {
     address: string;
@@ -1163,6 +1174,7 @@ export declare function ToolbarDivider(): JSX_2.Element;
 
 export declare const ToolbarIconButton: ForwardRefExoticComponent<Omit<IconButtonProps & RefAttributes<HTMLButtonElement> & {
 icon: React.ReactElement;
+rememberAction?: boolean;
 }, "ref"> & RefAttributes<HTMLButtonElement>>;
 
 export declare const ToolbarRangeInput: ForwardRefExoticComponent<Omit<DetailedHTMLProps<InputHTMLAttributes<HTMLInputElement>, HTMLInputElement>, "ref"> & RefAttributes<HTMLInputElement>>;
@@ -1174,7 +1186,7 @@ export declare function ToolbarScrollContainer({ children, background, border, e
     endElement?: ReactNode;
 }): JSX_2.Element;
 
-export declare function ToolbarSelect({ children, value, onValueChange, disabled, style, title, icon, popupContent, labelCase, "aria-label": label, ...triggerProps }: {
+export declare function ToolbarSelect({ children, value, onValueChange, disabled, style, title, icon, popupContent, footer, labelCase, "aria-label": label, ...triggerProps }: {
     children: ReactNode;
     value: string;
     onValueChange: (value: string) => void;
@@ -1183,6 +1195,7 @@ export declare function ToolbarSelect({ children, value, onValueChange, disabled
     title?: string;
     icon?: ReactNode;
     popupContent?: ReactNode;
+    footer?: ReactNode;
     labelCase?: "title" | "preserve";
     "aria-label": string;
 } & Pick<React.ComponentProps<"button">, "id" | "aria-required" | "aria-invalid" | "aria-describedby">): JSX_2.Element;
@@ -1295,4 +1308,41 @@ export declare function WorkflowControls({ showDivider, compact, }?: {
     compact?: boolean;
 }): JSX_2.Element;
 
+export declare interface WorkflowExecutionAdapter<Input> {
+    execute: (request: WorkflowExecutionRequest<Input>) => Promise<WorkflowExecutionUpdate | void>;
+    subscribe: (request: WorkflowExecutionRequest<Input>, receive: (update: WorkflowExecutionUpdate) => void) => (() => void) | Promise<() => void>;
+    cancel?: (request: WorkflowExecutionRequest<Input>) => Promise<void>;
+}
+
+export declare interface WorkflowExecutionRequest<Input> {
+    executionId: string;
+    input: Input;
+    signal: AbortSignal;
+}
+
+export declare interface WorkflowExecutionState {
+    executionId: string;
+    status: WorkflowRunStatus;
+    output?: unknown;
+    error?: string;
+    steps: Record<string, NonNullable<WorkflowExecutionUpdate["step"]>>;
+}
+
+export declare interface WorkflowExecutionUpdate {
+    executionId: string;
+    status?: WorkflowRunStatus;
+    output?: unknown;
+    error?: string;
+    step?: {
+        id: string;
+        status: WorkflowStepStatus;
+        output?: unknown;
+        error?: string;
+    };
+}
+
+export declare type WorkflowRunStatus = "subscribing" | "running" | "paused" | "completed" | "failed" | "cancelled";
+
+export declare type WorkflowStepStatus = "pending" | "running" | "completed" | "failed" | "skipped";
+
 export { }