@geenius/ai-workflow 0.1.0 → 0.4.0

package/packages/solidjs/dist/index.d.ts

@@ -0,0 +1,452 @@
+import { WorkflowEngineOptions, WorkflowDefinition, WorkflowRun, WorkflowError, StepResult, WorkflowBuilderState, WorkflowStepDef, StepConnection, RunStatus, StepStatus, WorkflowTemplate, StepType } from '@geenius/ai-workflow-shared';
+export { RunStatus, StepConfig, StepResult, StepStatus, StepType, WORKFLOW_TEMPLATES, WorkflowBuilderState, WorkflowDefinition, WorkflowEngine, WorkflowRun, WorkflowStatus, WorkflowStepDef, validateWorkflow } from '@geenius/ai-workflow-shared';
+import { JSX, JSXElement } from 'solid-js';
+
+/**
+ * @module CreateWorkflow
+ * @package @geenius/ai-workflow-solidjs
+ * @description SolidJS primitive for executing workflow definitions with the
+ * shared workflow engine. This file exposes run state, cancellation, and typed
+ * error handling through Solid signals.
+ */
+
+/**
+ * Runtime integrations accepted by the SolidJS workflow primitive.
+ */
+interface CreateWorkflowOptions extends WorkflowEngineOptions {
+}
+/**
+ * Result returned by `createWorkflow`.
+ *
+ * @property execute Execute a workflow definition against optional input data.
+ * @property cancel Cancel the current in-flight workflow run.
+ * @property run Signal accessor for the latest workflow run snapshot.
+ * @property isRunning Signal accessor for the active-run state.
+ * @property error Signal accessor for the latest typed workflow error.
+ * @property stepResults Signal accessor for emitted step results.
+ * @property reset Clear local run, error, and step-result state.
+ */
+interface CreateWorkflowResult {
+    execute: (definition: WorkflowDefinition, input?: Record<string, unknown>) => Promise<WorkflowRun>;
+    cancel: () => void;
+    run: () => WorkflowRun | null;
+    isRunning: () => boolean;
+    error: () => WorkflowError | null;
+    stepResults: () => StepResult[];
+    reset: () => void;
+}
+/**
+ * Execute shared workflow definitions from SolidJS stateful primitives.
+ *
+ * @param options Runtime integrations and callbacks for the shared engine.
+ * @returns Run state, execution methods, and cancellation controls.
+ */
+declare function createWorkflow(options: CreateWorkflowOptions): CreateWorkflowResult;
+
+/**
+ * @module CreateWorkflowBuilder
+ * @package @geenius/ai-workflow-solidjs
+ * @description Solid primitive for building and editing workflow definitions in
+ * the Tailwind workflow surface, including selection and undo/redo history.
+ */
+
+/**
+ * Create Solid builder state and mutations for the workflow builder UI.
+ *
+ * @param initial Optional partial workflow definition used to seed the builder.
+ * @returns Builder state accessor plus workflow mutation callbacks.
+ */
+declare function createWorkflowBuilder(initial?: Partial<WorkflowDefinition>): {
+    state: () => WorkflowBuilderState;
+    addStep: (step: WorkflowStepDef) => void;
+    removeStep: (stepId: string) => void;
+    updateStep: (stepId: string, updates: Partial<WorkflowStepDef>) => void;
+    addConnection: (connection: StepConnection) => void;
+    removeConnection: (fromStepId: string, toStepId: string) => void;
+    selectStep: (stepId: string | null) => void;
+    undo: () => void;
+    redo: () => void;
+    setDefinition: (definition: WorkflowDefinition) => void;
+};
+
+/**
+ * @module CreateWorkflowRun
+ * @package @geenius/ai-workflow-solidjs
+ * @description Solid primitive for tracking workflow execution progress in the
+ * Tailwind workflow variant.
+ */
+
+/**
+ * Create Solid signals for workflow run progress and step-level execution data.
+ *
+ * @returns Run state, derived flags, and update/reset helpers.
+ */
+declare function createWorkflowRun(): {
+    run: () => WorkflowRun | null;
+    status: () => RunStatus;
+    currentStepIndex: () => number;
+    completedSteps: () => StepResult[];
+    progress: () => number;
+    error: () => string | null;
+    trackRun: (workflowRun: WorkflowRun) => void;
+    updateStep: (result: StepResult) => void;
+    reset: () => void;
+    isRunning: () => boolean;
+    isComplete: () => boolean;
+    isFailed: () => boolean;
+};
+
+/**
+ * @module CreateWorkflowStep
+ * @package @geenius/ai-workflow-solidjs
+ * @description Solid primitive for tracking the state of a single workflow
+ * step in the Tailwind workflow surface.
+ */
+
+/**
+ * Create Solid signals for an individual workflow step state.
+ *
+ * @param stepDef Shared workflow step definition to project into UI state.
+ * @returns Step execution metadata, derived badges, and reset/update actions.
+ */
+declare function createWorkflowStep(stepDef: WorkflowStepDef): {
+    stepDef: WorkflowStepDef;
+    status: () => StepStatus;
+    output: () => unknown;
+    error: () => string | null;
+    durationMs: () => number;
+    icon: () => string;
+    statusColor: () => string;
+    updateFromResult: (result: StepResult) => void;
+    reset: () => void;
+    isComplete: () => boolean;
+    isRunning: () => boolean;
+    isFailed: () => boolean;
+    isWaiting: () => boolean;
+    config: WorkflowStepDef["config"];
+};
+
+/**
+ * @module CreateApprovalGate
+ * @package @geenius/ai-workflow-solidjs
+ * @description Solid primitive for managing human approval requests in the
+ * Tailwind workflow variant.
+ */
+/**
+ * Pending approval request exposed to the UI layer.
+ */
+interface ApprovalRequest {
+    id: string;
+    stepId: string;
+    message: string;
+    requestedAt: number;
+    approvers?: string[];
+}
+interface ApprovalHistoryEntry extends ApprovalRequest {
+    decision: "approved" | "rejected";
+    decidedAt: number;
+}
+/**
+ * Create Solid signals for pending approvals and approval history.
+ *
+ * @returns Approval state plus request, approve, reject, and reset helpers.
+ */
+declare function createApprovalGate(): {
+    pendingApprovals: () => ApprovalRequest[];
+    history: () => ApprovalHistoryEntry[];
+    hasPending: () => boolean;
+    requestApproval: (stepId: string, message: string, approvers?: string[]) => string;
+    approve: (approvalId: string) => void;
+    reject: (approvalId: string) => void;
+    clearHistory: () => void;
+};
+
+/**
+ * @module CreateWorkflowTemplates
+ * @package @geenius/ai-workflow-solidjs
+ * @description Solid primitive for filtering and instantiating shared
+ * workflow templates in the Tailwind workflow surface.
+ */
+
+/**
+ * Create Solid signals for the template browser and instantiation flow.
+ *
+ * @param userId User identifier injected into cloned workflow templates.
+ * @returns Template filters, selections, and creation helpers for the builder UI.
+ */
+declare function createWorkflowTemplates(userId: string): {
+    templates: () => WorkflowTemplate[];
+    allTemplates: WorkflowTemplate[];
+    selectedTemplate: () => WorkflowTemplate | null;
+    selectedTemplateId: () => string | null;
+    categories: () => WorkflowTemplate["category"][];
+    filterCategory: () => WorkflowTemplate["category"] | "all";
+    searchQuery: () => string;
+    setSelectedTemplateId: (templateId: string | null) => void;
+    setFilterCategory: (category: WorkflowTemplate["category"] | "all") => void;
+    setSearchQuery: (query: string) => void;
+    createFromTemplate: (templateId: string) => WorkflowDefinition | null;
+};
+
+/**
+ * Props for the SolidJS workflow builder canvas.
+ *
+ * @property definition Shared workflow definition to render.
+ * @property selectedStepId Currently selected step identifier.
+ * @property onSelectStep Callback used to change the selected step.
+ */
+interface WorkflowCanvasProps {
+    definition: WorkflowDefinition;
+    selectedStepId: string | null;
+    onSelectStep: (id: string | null) => void;
+}
+/**
+ * Render a workflow canvas with connectors, nodes, and an empty state.
+ *
+ * @param props Canvas state and interaction callbacks.
+ * @returns The workflow canvas for the current definition.
+ */
+declare function WorkflowCanvas(props: WorkflowCanvasProps): JSX.Element;
+
+/**
+ * Props for rendering one SolidJS workflow step node.
+ *
+ * @property step Shared workflow step definition to render.
+ * @property isSelected Whether the node is currently selected.
+ * @property status Visual execution status displayed on the node.
+ * @property onClick Optional selection callback invoked from mouse or keyboard.
+ * @property class Optional class name override for outer layout composition.
+ */
+interface StepNodeProps {
+    step: WorkflowStepDef;
+    isSelected?: boolean;
+    status?: "pending" | "running" | "success" | "error" | "skipped" | "default";
+    onClick?: () => void;
+    class?: string;
+}
+/**
+ * Render one selectable workflow step node inside the SolidJS builder canvas.
+ *
+ * @param props Step node rendering props.
+ * @returns A keyboard-accessible workflow step node.
+ */
+declare function StepNode(props: StepNodeProps): JSX.Element;
+
+/**
+ * @module SolidWorkflowStepConnector
+ * @package @geenius/ai-workflow-solidjs
+ * @description SVG connector primitive for drawing directed edges between
+ * positioned workflow steps in the SolidJS builder canvas.
+ */
+
+/**
+ * Props for a workflow step connector path.
+ */
+interface StepConnectorProps {
+    from: {
+        x: number;
+        y: number;
+    };
+    to: {
+        x: number;
+        y: number;
+    };
+    label?: string;
+    isActive?: boolean;
+}
+/**
+ * Render a curved connector between two step positions.
+ *
+ * @param props Connector endpoints and optional label/state metadata.
+ * @returns The SVG group that draws the workflow edge.
+ */
+declare function StepConnector(props: StepConnectorProps): JSX.Element;
+
+/**
+ * @module SolidStepConfigPanel
+ * @package @geenius/ai-workflow-solidjs
+ * @description SolidJS step configuration panel for builder flows. This file
+ * exposes editable step metadata and configuration review for the canvas selection state.
+ */
+
+/**
+ * Props for the SolidJS step configuration panel.
+ *
+ * @property step Shared workflow step being edited.
+ * @property onUpdate Callback for partial step updates.
+ * @property onDelete Callback that removes the current step.
+ * @property onClose Callback that closes the panel.
+ */
+interface StepConfigPanelProps {
+    step: WorkflowStepDef;
+    onUpdate: (id: string, updates: Partial<WorkflowStepDef>) => void;
+    onDelete: (id: string) => void;
+    onClose: () => void;
+}
+/**
+ * Render the SolidJS step configuration panel.
+ *
+ * @param props Step editing callbacks and selected step data.
+ * @returns A complementary panel for reviewing and editing step metadata.
+ */
+declare function StepConfigPanel(props: StepConfigPanelProps): JSX.Element;
+
+/**
+ * Props for the SolidJS workflow run panel.
+ *
+ * @property run Current workflow run snapshot or `null` when idle.
+ * @property isRunning Whether the run is still active.
+ * @property onCancel Optional callback that cancels the active run.
+ */
+interface WorkflowRunPanelProps {
+    run: WorkflowRun | null;
+    isRunning: boolean;
+    onCancel?: () => void;
+}
+/**
+ * Render execution progress and per-step status for a workflow run.
+ *
+ * @param props Run state and optional cancellation callback.
+ * @returns A run summary panel or idle placeholder.
+ */
+declare function WorkflowRunPanel(props: WorkflowRunPanelProps): JSX.Element;
+
+/**
+ * @module SolidApprovalModal
+ * @package @geenius/ai-workflow-solidjs
+ * @description SolidJS approval dialog for human-gated workflow steps. This
+ * component preserves the dialog semantics and request metadata exposed by the React variant.
+ */
+
+/**
+ * Props for the SolidJS approval dialog.
+ */
+interface ApprovalModalProps {
+    request: ApprovalRequest | null;
+    onApprove: (id: string) => void;
+    onReject: (id: string) => void;
+    onDismiss?: (id: string) => void;
+}
+/**
+ * Render the pending approval request as an accessible SolidJS dialog.
+ *
+ * @param props Approval dialog callbacks and the current pending request.
+ * @returns The animated approval dialog when an approval is pending.
+ */
+declare function ApprovalModal(props: ApprovalModalProps): JSX.Element;
+
+/**
+ * @module SolidWorkflowToolbar
+ * @package @geenius/ai-workflow-solidjs
+ * @description SolidJS toolbar for workflow builder actions such as save, run,
+ * cancel, undo, redo, and export. This component owns the top-level command
+ * surface shared across the builder page.
+ */
+
+/**
+ * Props for the workflow toolbar action surface.
+ */
+interface WorkflowToolbarProps {
+    workflowName: string;
+    isDirty: boolean;
+    isRunning: boolean;
+    canUndo: boolean;
+    canRedo: boolean;
+    onSave: () => void;
+    onRun: () => void;
+    onCancel?: () => void;
+    onUndo: () => void;
+    onRedo: () => void;
+    onExport?: () => void;
+    class?: string;
+}
+/**
+ * Render the builder command toolbar with run-state-aware actions.
+ *
+ * @param props Action callbacks and builder status flags for the toolbar.
+ * @returns The animated workflow toolbar.
+ */
+declare function WorkflowToolbar(props: WorkflowToolbarProps): JSX.Element;
+
+/**
+ * Props for the SolidJS workflow step palette.
+ *
+ * @property onAddStep Callback invoked when a step type is selected.
+ */
+interface StepPaletteProps {
+    onAddStep: (type: StepType) => void;
+}
+/**
+ * Render the SolidJS workflow step palette.
+ *
+ * @param props Palette interaction props.
+ * @returns A list of available workflow step types.
+ */
+declare function StepPalette(props: StepPaletteProps): JSX.Element;
+
+/**
+ * @module SolidWorkflowBuilderPage
+ * @package @geenius/ai-workflow-solidjs
+ * @description SolidJS page for composing, editing, and running workflow
+ * definitions. This page coordinates the shared engine with the Solid
+ * primitives and component surface.
+ */
+
+/**
+ * Props for the SolidJS workflow builder page.
+ *
+ * @property engineOptions Shared workflow engine integrations used for execution.
+ * @property onSave Optional callback that persists the edited definition.
+ * @property class Optional class name override for outer layout composition.
+ * @property workflows Optional list of stored workflows shown in the summary strip.
+ * @property workflowRuns Optional list of stored workflow runs shown in the summary strip.
+ */
+interface WorkflowBuilderPageProps {
+    engineOptions: WorkflowEngineOptions;
+    onSave?: (definition: WorkflowDefinition) => void;
+    class?: string;
+    workflows?: Array<{
+        _id: string;
+        name: string;
+    }>;
+    workflowRuns?: Array<{
+        _id: string;
+        workflowId: string;
+    }>;
+}
+/**
+ * Render the full workflow builder page for SolidJS consumers.
+ *
+ * @param props Builder dependencies, persistence callbacks, and optional summaries.
+ * @returns The composed workflow builder page.
+ */
+declare function WorkflowBuilderPage(props: WorkflowBuilderPageProps): JSXElement;
+
+/**
+ * @module SolidWorkflowRunsPage
+ * @package @geenius/ai-workflow-solidjs
+ * @description SolidJS page for browsing stored workflow runs. This file keeps
+ * the run list keyboard-accessible while preserving the builder-facing status summary.
+ */
+
+/**
+ * Props for the SolidJS workflow runs page.
+ *
+ * @property runs Workflow runs to display.
+ * @property onSelectRun Optional callback fired when a run card is selected.
+ * @property class Optional class name override for outer layout composition.
+ */
+interface WorkflowRunsPageProps {
+    runs: WorkflowRun[];
+    onSelectRun?: (id: string) => void;
+    class?: string;
+}
+/**
+ * Render a browsable list of stored workflow runs in the SolidJS surface.
+ *
+ * @param props Run collection and optional selection callback.
+ * @returns The workflow runs page.
+ */
+declare function WorkflowRunsPage(props: WorkflowRunsPageProps): JSX.Element;
+
+export { ApprovalModal, type ApprovalModalProps, type ApprovalRequest, StepConfigPanel, type StepConfigPanelProps, StepConnector, StepNode, type StepNodeProps, StepPalette, type StepPaletteProps, WorkflowBuilderPage, type WorkflowBuilderPageProps, WorkflowCanvas, WorkflowRunPanel, type WorkflowRunPanelProps, WorkflowRunsPage, type WorkflowRunsPageProps, WorkflowToolbar, createApprovalGate, createWorkflow, createWorkflowBuilder, createWorkflowRun, createWorkflowStep, createWorkflowTemplates };