@jentic/arazzo-ui 1.0.0-alpha.13

package/types/arazzo-ui.d.ts

@@ -0,0 +1,335 @@
+import { Edge } from 'reactflow';
+import { Node as Node_2 } from 'reactflow';
+import { default as React_2 } from 'react';
+
+/**
+ * Arazzo Specification v1.0.1 Type Definitions
+ * Based on: https://spec.openapis.org/arazzo/latest.html
+ */
+/** @public */
+export declare interface ArazzoDocument {
+    arazzo: string;
+    info: InfoObject;
+    sourceDescriptions: SourceDescription[];
+    workflows: Workflow[];
+    components?: ComponentsObject;
+}
+
+/** @public */
+export declare type ArazzoEdge = Edge<ArazzoEdgeData>;
+
+/** @public */
+export declare type ArazzoEdgeData = SequentialEdgeData | SuccessEdgeData | FailureEdgeData | RetryEdgeData | BundledSuccessEdgeData | BundledFailureEdgeData | BundledRetryEdgeData;
+
+/** @public */
+export declare type ArazzoNode = Node_2<ArazzoNodeData>;
+
+/** @public */
+export declare type ArazzoNodeData = StepNodeData | WorkflowRefNodeData | StartNodeData | EndNodeData | WorkflowNodeData | ExternalWorkflowNodeData;
+
+/**
+ * ArazzoUI - Interactive viewer for Arazzo workflow specifications
+ *
+ * Renders diagram and documentation views of an Arazzo document.
+ * Supports click-to-select, workflow switching, zoom/pan.
+ * No document mutation capability.
+ *
+ * The `document` prop accepts:
+ * - An `ArazzoDocument` object (rendered immediately)
+ * - A JSON or YAML string (parsed via \@jentic/arazzo-parser)
+ * - A file path or HTTP(S) URL (fetched and parsed via \@jentic/arazzo-parser)
+ *
+ * @public
+ */
+export declare const ArazzoUI: React_2.ForwardRefExoticComponent<ArazzoUIProps & React_2.RefAttributes<ArazzoUIRef>>;
+
+/** @public */
+export declare interface ArazzoUIProps {
+    document: ArazzoDocument | string;
+    view?: ViewerMode;
+    activeWorkflowId?: string | null;
+    selectedNodeId?: string | null;
+    diagramType?: DiagramType | 'none';
+    className?: string;
+    style?: React.CSSProperties;
+    onNodeSelect?: (nodeId: string, node: ArazzoNode) => void;
+    onEdgeSelect?: (edgeId: string, edge: ArazzoEdge) => void;
+    onWorkflowSelect?: (workflowId: string) => void;
+    onViewChange?: (view: ViewerMode) => void;
+}
+
+/** @public */
+export declare interface ArazzoUIRef {
+    fitView(): void;
+    setZoom(level: number): void;
+    getDocument(): ArazzoDocument;
+    setActiveWorkflow(workflowId: string | null): void;
+    selectStep(stepId: string): void;
+    clearSelection(): void;
+    getActiveWorkflowId(): string | null;
+    getSelectedStepId(): string | null;
+}
+
+/** @public */
+export declare interface BundledFailureEdgeData {
+    type: 'bundled-failure';
+    action: FailureAction;
+    criteria?: Criterion[];
+    sources: Array<{
+        nodeId: string;
+        handleId: string;
+    }>;
+    actionIdx: number;
+}
+
+/** @public */
+export declare interface BundledRetryEdgeData {
+    type: 'bundled-retry';
+    action: FailureAction;
+    retryAfter?: number;
+    retryLimit?: number;
+    criteria?: Criterion[];
+    sources: Array<{
+        nodeId: string;
+        handleId: string;
+    }>;
+    actionIdx: number;
+}
+
+/** @public */
+export declare interface BundledSuccessEdgeData {
+    type: 'bundled-success';
+    action: SuccessAction;
+    criteria?: Criterion[];
+    sources: Array<{
+        nodeId: string;
+        handleId: string;
+    }>;
+    actionIdx: number;
+}
+
+/** @public */
+export declare interface ComponentsObject {
+    inputs?: Record<string, JSONSchema>;
+    parameters?: Record<string, Parameter>;
+    successActions?: Record<string, SuccessAction>;
+    failureActions?: Record<string, FailureAction>;
+}
+
+/** @public */
+export declare interface Criterion {
+    context?: string;
+    condition: string;
+    type?: 'simple' | 'regex' | 'jsonpath' | 'xpath' | CriterionExpressionType;
+}
+
+/** @public */
+export declare interface CriterionExpressionType {
+    type: 'jsonpath' | 'xpath';
+    version: string;
+}
+
+/** @public */
+export declare type DiagramType = 'sequence' | 'flowchart';
+
+/** @public */
+export declare interface EndNodeData {
+    type: 'end';
+    workflowId: string;
+    outputs?: Record<string, string>;
+}
+
+/** @public */
+export declare interface ExternalWorkflowNodeData {
+    type: 'externalWorkflow';
+    workflowId: string;
+    workflow?: Workflow;
+    onClick?: (workflowId: string) => void;
+}
+
+/** @public */
+export declare interface FailureAction {
+    name: string;
+    type: 'end' | 'retry' | 'goto';
+    workflowId?: string;
+    stepId?: string;
+    retryAfter?: number;
+    retryLimit?: number;
+    criteria?: Criterion[];
+}
+
+/** @public */
+export declare interface FailureEdgeData {
+    type: 'failure';
+    action: FailureAction;
+    criteria?: Criterion[];
+    isInherited?: boolean;
+}
+
+/** @public */
+export declare interface InfoObject {
+    title: string;
+    version: string;
+    summary?: string;
+    description?: string;
+}
+
+/** @public */
+export declare type JSONSchema = Record<string, any>;
+
+/** @public */
+export declare interface Parameter {
+    name: string;
+    in?: 'path' | 'query' | 'header' | 'cookie';
+    value: any;
+}
+
+/** @public */
+export declare interface PayloadReplacement {
+    target: string;
+    value: any;
+}
+
+/** @public */
+export declare interface RequestBody {
+    contentType?: string;
+    payload?: any;
+    replacements?: PayloadReplacement[];
+}
+
+/** @public */
+export declare interface RetryEdgeData {
+    type: 'retry';
+    action: FailureAction;
+    retryAfter?: number;
+    retryLimit?: number;
+    criteria?: Criterion[];
+    isInherited?: boolean;
+}
+
+/** @public */
+export declare interface ReusableObject {
+    reference: string;
+    value?: string;
+}
+
+/** @public */
+export declare interface SequentialEdgeData {
+    type: 'sequential';
+}
+
+/** @public */
+export declare interface SourceDescription {
+    name: string;
+    url: string;
+    type?: 'openapi' | 'arazzo';
+    /** Internal tracking ID - not part of Arazzo spec, stripped on export */
+    _internalId?: string;
+}
+
+/** @public */
+export declare interface StartNodeData {
+    type: 'start';
+    workflowId: string;
+    inputs?: JSONSchema;
+    description?: string;
+}
+
+/** @public */
+export declare interface Step {
+    stepId: string;
+    description?: string;
+    operationId?: string;
+    operationPath?: string;
+    workflowId?: string;
+    parameters?: (Parameter | ReusableObject)[];
+    requestBody?: RequestBody;
+    successCriteria?: Criterion[];
+    onSuccess?: (SuccessAction | ReusableObject)[];
+    onFailure?: (FailureAction | ReusableObject)[];
+    outputs?: Record<string, string>;
+    /** Internal tracking ID - not part of Arazzo spec, stripped on export */
+    _internalId?: string;
+}
+
+/** @public */
+export declare interface StepNodeData {
+    type: 'step';
+    step: Step;
+    workflowId: string;
+    workflowSuccessActions?: (SuccessAction | {
+        $ref: string;
+    })[];
+    workflowFailureActions?: (FailureAction | {
+        $ref: string;
+    })[];
+    isValid: boolean;
+    errors?: ValidationError[];
+    isSelected?: boolean;
+    isHighlighted?: boolean;
+}
+
+/** @public */
+export declare interface SuccessAction {
+    name: string;
+    type: 'end' | 'goto';
+    workflowId?: string;
+    stepId?: string;
+    criteria?: Criterion[];
+}
+
+/** @public */
+export declare interface SuccessEdgeData {
+    type: 'success';
+    action: SuccessAction;
+    criteria?: Criterion[];
+    isInherited?: boolean;
+}
+
+/** @public */
+export declare interface ValidationError {
+    path: string;
+    message: string;
+    severity: 'error' | 'warning';
+    nodeId?: string;
+    edgeId?: string;
+    specRef?: string;
+}
+
+/** @public */
+export declare type ViewerMode = 'diagram' | 'docs' | 'split';
+
+/** @public */
+export declare interface Workflow {
+    workflowId: string;
+    summary?: string;
+    description?: string;
+    inputs?: JSONSchema;
+    dependsOn?: string[];
+    steps: Step[];
+    successActions?: (SuccessAction | ReusableObject)[];
+    failureActions?: (FailureAction | ReusableObject)[];
+    outputs?: Record<string, string>;
+    parameters?: (Parameter | ReusableObject)[];
+    /** Internal tracking ID - not part of Arazzo spec, stripped on export */
+    _internalId?: string;
+}
+
+/** @public */
+export declare interface WorkflowNodeData {
+    type: 'workflow';
+    workflow: Workflow;
+    onClick?: (workflowId: string) => void;
+}
+
+/** @public */
+export declare interface WorkflowRefNodeData {
+    type: 'workflowRef';
+    step: Step;
+    targetWorkflowId: string;
+    workflowSuccessActions?: (SuccessAction | ReusableObject)[];
+    workflowFailureActions?: (FailureAction | ReusableObject)[];
+    isValid: boolean;
+}
+
+export { }