awaitly-visualizer 7.0.1 → 8.0.1

package/dist/index.d.cts

@@ -50,6 +50,140 @@ interface ExportContext {
  */
 declare function toExportUrl(diagram: DiagramSource, format: ExportFormat, options: ExportOptions, ctx?: ExportContext): Result<string, ExportUrlError>;
 
+/**
+ * Interactive Mermaid CDN HTML Generator
+ *
+ * Generates a self-contained HTML file that uses Mermaid CDN to render
+ * workflow diagrams with click-to-inspect interactivity, 6 themes,
+ * and a theme picker.
+ *
+ * Moved from awaitly-analyze so the template is reusable across packages.
+ *
+ * Pipeline:
+ *   mermaidText + WorkflowMetadata → generateInteractiveHTML() → .html file
+ */
+/** Source location for a node in the analyzed source. */
+interface MermaidHTMLSourceLocation {
+    filePath: string;
+    line: number;
+    column: number;
+}
+/** Retry configuration for display in the inspector panel. */
+interface MermaidHTMLRetryConfig {
+    attempts?: number | string;
+    backoff?: string;
+    baseDelay?: number | string;
+    retryOn?: string;
+}
+/** Timeout configuration for display in the inspector panel. */
+interface MermaidHTMLTimeoutConfig {
+    ms?: number | string;
+}
+interface NodeMetadata {
+    /** Mermaid node ID (matches the ID in the rendered diagram) */
+    mermaidId: string;
+    /** Node type from the IR */
+    type: string;
+    /** Human-readable name */
+    name: string;
+    /** Step ID (for step nodes) */
+    stepId?: string;
+    /** Function callee */
+    callee?: string;
+    /** Description */
+    description?: string;
+    /** Source location */
+    location?: MermaidHTMLSourceLocation;
+    /** Retry configuration */
+    retry?: MermaidHTMLRetryConfig;
+    /** Timeout configuration */
+    timeout?: MermaidHTMLTimeoutConfig;
+    /** Condition expression (for decisions/conditionals) */
+    condition?: string;
+    /** Helper used (when/unless) */
+    helper?: string;
+    /** Error tags */
+    errors?: string[];
+    /** Input type */
+    inputType?: string;
+    /** Output type */
+    outputType?: string;
+    /** Output key */
+    out?: string;
+    /** Keys this step reads */
+    reads?: string[];
+    /** Parallel mode */
+    mode?: string;
+    /** Children count */
+    childCount?: number;
+    /** Loop type */
+    loopType?: string;
+    /** Iteration source */
+    iterSource?: string;
+    /** Bound count for loops */
+    boundCount?: number;
+    /** Stream type */
+    streamType?: string;
+    /** Stream namespace */
+    namespace?: string;
+    /** Referenced workflow name */
+    workflowName?: string;
+    /** Whether reference is resolved */
+    resolved?: boolean;
+    /** Has compensation (saga steps) */
+    hasCompensation?: boolean;
+    /** Compensation callee */
+    compensationCallee?: string;
+    /** Switch expression */
+    expression?: string;
+    /** Switch cases */
+    cases?: Array<{
+        value?: string;
+        isDefault: boolean;
+    }>;
+    /** Connected incoming edges */
+    incomingFrom?: string[];
+    /** Connected outgoing edges */
+    outgoingTo?: string[];
+}
+interface WorkflowMetadata {
+    /** Workflow name */
+    workflowName: string;
+    /** Workflow description */
+    description?: string;
+    /** Source file */
+    filePath: string;
+    /** Analysis stats */
+    stats: {
+        totalSteps: number;
+        conditionalCount: number;
+        parallelCount: number;
+        raceCount: number;
+        loopCount: number;
+    };
+    /** Node metadata keyed by Mermaid node ID */
+    nodes: Record<string, NodeMetadata>;
+}
+interface InteractiveHTMLOptions {
+    /** Page title (defaults to workflow name) */
+    title?: string;
+    /** Initial theme name (defaults to system preference auto-detection) */
+    theme?: string;
+    /** Mermaid CDN URL (defaults to latest) */
+    mermaidCdnUrl?: string;
+    /** Diagram direction for display */
+    direction?: "TB" | "LR" | "BT" | "RL";
+}
+/**
+ * Generate a self-contained interactive HTML file.
+ *
+ * @param mermaidText - Mermaid flowchart text from renderStaticMermaid()
+ * @param metadata - Workflow metadata from extractNodeMetadata()
+ * @param options - HTML generation options
+ */
+declare function generateInteractiveHTML(mermaidText: string, metadata: WorkflowMetadata, options?: InteractiveHTMLOptions): string;
+declare function escapeHtml(str: string): string;
+
 /**
  * Workflow Visualization Module
  *
@@ -239,4 +373,4 @@ declare function createEventCollector(options?: VisualizerOptions): {
     visualizeAs: (format: OutputFormat) => string;
 };
 
-export { type CollectableEvent, DecisionBranchEvent, DecisionEndEvent, DecisionStartEvent, DiagramSource, ExportFormat, ExportOptions, OutputFormat, ScopeEndEvent, ScopeStartEvent, VisualizerOptions, WorkflowIR, type WorkflowVisualizer, combineEventHandlers, createEventCollector, createVisualizer, toExportUrl, visualizeEvents };
+export { type CollectableEvent, DecisionBranchEvent, DecisionEndEvent, DecisionStartEvent, DiagramSource, ExportFormat, ExportOptions, type InteractiveHTMLOptions, type MermaidHTMLRetryConfig, type MermaidHTMLSourceLocation, type MermaidHTMLTimeoutConfig, type NodeMetadata, OutputFormat, ScopeEndEvent, ScopeStartEvent, VisualizerOptions, WorkflowIR, type WorkflowMetadata, type WorkflowVisualizer, combineEventHandlers, createEventCollector, createVisualizer, escapeHtml, generateInteractiveHTML, toExportUrl, visualizeEvents };

package/dist/index.d.ts

@@ -50,6 +50,140 @@ interface ExportContext {
  */
 declare function toExportUrl(diagram: DiagramSource, format: ExportFormat, options: ExportOptions, ctx?: ExportContext): Result<string, ExportUrlError>;
 
+/**
+ * Interactive Mermaid CDN HTML Generator
+ *
+ * Generates a self-contained HTML file that uses Mermaid CDN to render
+ * workflow diagrams with click-to-inspect interactivity, 6 themes,
+ * and a theme picker.
+ *
+ * Moved from awaitly-analyze so the template is reusable across packages.
+ *
+ * Pipeline:
+ *   mermaidText + WorkflowMetadata → generateInteractiveHTML() → .html file
+ */
+/** Source location for a node in the analyzed source. */
+interface MermaidHTMLSourceLocation {
+    filePath: string;
+    line: number;
+    column: number;
+}
+/** Retry configuration for display in the inspector panel. */
+interface MermaidHTMLRetryConfig {
+    attempts?: number | string;
+    backoff?: string;
+    baseDelay?: number | string;
+    retryOn?: string;
+}
+/** Timeout configuration for display in the inspector panel. */
+interface MermaidHTMLTimeoutConfig {
+    ms?: number | string;
+}
+interface NodeMetadata {
+    /** Mermaid node ID (matches the ID in the rendered diagram) */
+    mermaidId: string;
+    /** Node type from the IR */
+    type: string;
+    /** Human-readable name */
+    name: string;
+    /** Step ID (for step nodes) */
+    stepId?: string;
+    /** Function callee */
+    callee?: string;
+    /** Description */
+    description?: string;
+    /** Source location */
+    location?: MermaidHTMLSourceLocation;
+    /** Retry configuration */
+    retry?: MermaidHTMLRetryConfig;
+    /** Timeout configuration */
+    timeout?: MermaidHTMLTimeoutConfig;
+    /** Condition expression (for decisions/conditionals) */
+    condition?: string;
+    /** Helper used (when/unless) */
+    helper?: string;
+    /** Error tags */
+    errors?: string[];
+    /** Input type */
+    inputType?: string;
+    /** Output type */
+    outputType?: string;
+    /** Output key */
+    out?: string;
+    /** Keys this step reads */
+    reads?: string[];
+    /** Parallel mode */
+    mode?: string;
+    /** Children count */
+    childCount?: number;
+    /** Loop type */
+    loopType?: string;
+    /** Iteration source */
+    iterSource?: string;
+    /** Bound count for loops */
+    boundCount?: number;
+    /** Stream type */
+    streamType?: string;
+    /** Stream namespace */
+    namespace?: string;
+    /** Referenced workflow name */
+    workflowName?: string;
+    /** Whether reference is resolved */
+    resolved?: boolean;
+    /** Has compensation (saga steps) */
+    hasCompensation?: boolean;
+    /** Compensation callee */
+    compensationCallee?: string;
+    /** Switch expression */
+    expression?: string;
+    /** Switch cases */
+    cases?: Array<{
+        value?: string;
+        isDefault: boolean;
+    }>;
+    /** Connected incoming edges */
+    incomingFrom?: string[];
+    /** Connected outgoing edges */
+    outgoingTo?: string[];
+}
+interface WorkflowMetadata {
+    /** Workflow name */
+    workflowName: string;
+    /** Workflow description */
+    description?: string;
+    /** Source file */
+    filePath: string;
+    /** Analysis stats */
+    stats: {
+        totalSteps: number;
+        conditionalCount: number;
+        parallelCount: number;
+        raceCount: number;
+        loopCount: number;
+    };
+    /** Node metadata keyed by Mermaid node ID */
+    nodes: Record<string, NodeMetadata>;
+}
+interface InteractiveHTMLOptions {
+    /** Page title (defaults to workflow name) */
+    title?: string;
+    /** Initial theme name (defaults to system preference auto-detection) */
+    theme?: string;
+    /** Mermaid CDN URL (defaults to latest) */
+    mermaidCdnUrl?: string;
+    /** Diagram direction for display */
+    direction?: "TB" | "LR" | "BT" | "RL";
+}
+/**
+ * Generate a self-contained interactive HTML file.
+ *
+ * @param mermaidText - Mermaid flowchart text from renderStaticMermaid()
+ * @param metadata - Workflow metadata from extractNodeMetadata()
+ * @param options - HTML generation options
+ */
+declare function generateInteractiveHTML(mermaidText: string, metadata: WorkflowMetadata, options?: InteractiveHTMLOptions): string;
+declare function escapeHtml(str: string): string;
+
 /**
  * Workflow Visualization Module
  *
@@ -239,4 +373,4 @@ declare function createEventCollector(options?: VisualizerOptions): {
     visualizeAs: (format: OutputFormat) => string;
 };
 
-export { type CollectableEvent, DecisionBranchEvent, DecisionEndEvent, DecisionStartEvent, DiagramSource, ExportFormat, ExportOptions, OutputFormat, ScopeEndEvent, ScopeStartEvent, VisualizerOptions, WorkflowIR, type WorkflowVisualizer, combineEventHandlers, createEventCollector, createVisualizer, toExportUrl, visualizeEvents };
+export { type CollectableEvent, DecisionBranchEvent, DecisionEndEvent, DecisionStartEvent, DiagramSource, ExportFormat, ExportOptions, type InteractiveHTMLOptions, type MermaidHTMLRetryConfig, type MermaidHTMLSourceLocation, type MermaidHTMLTimeoutConfig, type NodeMetadata, OutputFormat, ScopeEndEvent, ScopeStartEvent, VisualizerOptions, WorkflowIR, type WorkflowMetadata, type WorkflowVisualizer, combineEventHandlers, createEventCollector, createVisualizer, escapeHtml, generateInteractiveHTML, toExportUrl, visualizeEvents };