@llamaindex/ui/dist/workflow-event-CFyLs7Zw.d.mts

A comprehensive UI component library built with React, TypeScript, and Tailwind CSS for LlamaIndex applications

import { EventEnvelopeWithMetadata } from '@llamaindex/workflows-client';

type JSONValue = null | string | number | boolean | {
    [key: string]: JSONValue;
} | Array<JSONValue>;
type RunStatus = "running" | "completed" | "failed" | "cancelled" | "not_started";
interface WorkflowProgressState {
    current: number;
    total: number;
    status: RunStatus;
}

declare enum WorkflowEventType {
    StartEvent = "StartEvent",
    StopEvent = "StopEvent",
    InputRequiredEvent = "InputRequiredEvent",
    HumanResponseEvent = "HumanResponseEvent",
    ChatDeltaEvent = "ChatDeltaEvent",
    InternalDispatchEvent = "InternalDispatchEvent",
    StepStateChanged = "StepStateChanged",
    EventsQueueChanged = "EventsQueueChanged",
    ToolCallEvent = "ToolCallEvent"
}
declare const builtInEventTypes: string[];
declare class WorkflowEvent {
    type: string;
    types?: string[] | undefined;
    data?: Record<string, unknown> | undefined;
    timestamp: Date;
    constructor(type: string, data: Record<string, unknown>, types?: string[]);
    static fromRawEvent(event: EventEnvelopeWithMetadata): WorkflowEvent | InputRequiredEvent | HumanResponseEvent | ChatDeltaEvent;
    toRawEvent(): EventEnvelopeWithMetadata;
}
declare class StopEvent extends WorkflowEvent {
    data: Record<string, unknown>;
    constructor(type: string, data: Record<string, unknown>, types?: string[]);
}
declare class InputRequiredEvent extends WorkflowEvent {
    data: {
        prefix: string;
    };
    constructor(type: string, data: {
        prefix: string;
    }, types?: string[]);
}
declare class HumanResponseEvent extends WorkflowEvent {
    data: {
        response: JSONValue;
    };
    constructor(type: string, data: {
        response: JSONValue;
    }, types?: string[]);
}
declare class ChatDeltaEvent extends WorkflowEvent {
    data: {
        delta: string;
    };
    constructor(type: string, data: {
        delta: string;
    }, types?: string[]);
}
declare class StartEvent extends WorkflowEvent {
    constructor(type: string, data: Record<string, unknown>, types?: string[]);
}
declare class InternalDispatchEvent extends WorkflowEvent {
    constructor(type: string, data: Record<string, unknown>, types?: string[]);
}
declare class EventsQueueChanged extends WorkflowEvent {
    constructor(type: string, data: Record<string, unknown>, types?: string[]);
}
declare class StepStateChanged extends WorkflowEvent {
    constructor(type: string, data: Record<string, unknown>, types?: string[]);
}
/**
 * All isXXXEvent functions are used to determine if an event is of a specific type
 * They will take both EventEnvelopeWithMetadata and WorkflowEvent as input for convenience
 * When used with WorkflowEvent, they act as type guards for TypeScript narrowing
 */
declare function isStartEvent(event: WorkflowEvent): event is StartEvent;
declare function isStartEvent(event: EventEnvelopeWithMetadata): boolean;
declare function isStopEvent(event: WorkflowEvent): event is StopEvent;
declare function isStopEvent(event: EventEnvelopeWithMetadata): boolean;
declare function isInputRequiredEvent(event: WorkflowEvent): event is InputRequiredEvent;
declare function isInputRequiredEvent(event: EventEnvelopeWithMetadata): boolean;
declare function isHumanResponseEvent(event: WorkflowEvent): event is HumanResponseEvent;
declare function isHumanResponseEvent(event: EventEnvelopeWithMetadata): boolean;
declare function isChatDeltaEvent(event: WorkflowEvent): event is ChatDeltaEvent;
declare function isChatDeltaEvent(event: EventEnvelopeWithMetadata): boolean;
declare function isInternalDispatchEvent(event: WorkflowEvent): event is InternalDispatchEvent;
declare function isInternalDispatchEvent(event: EventEnvelopeWithMetadata): boolean;
declare function isStepStateChanged(event: WorkflowEvent): event is StepStateChanged;
declare function isStepStateChanged(event: EventEnvelopeWithMetadata): boolean;
declare function isEventsQueueChanged(event: WorkflowEvent): event is EventsQueueChanged;
declare function isEventsQueueChanged(event: EventEnvelopeWithMetadata): boolean;
/**
 * Check if an event is a built-in event
 */
declare function isBuiltInEvent(event: WorkflowEvent): boolean;
/**
 * Check if an event is an overridden built-in event
 * e.g MyStartEvent(StartEvent)
 */
declare function isOverriddenBuiltInEvent(event: WorkflowEvent): boolean;
/**
 * Check if an event is a custom event
 * e.g CustomEvent(Event)
 */
declare function isCustomEvent(event: WorkflowEvent): boolean;

export { ChatDeltaEvent as C, EventsQueueChanged as E, HumanResponseEvent as H, InputRequiredEvent as I, type JSONValue as J, type RunStatus as R, StopEvent as S, type WorkflowProgressState as W, WorkflowEventType as a, builtInEventTypes as b, WorkflowEvent as c, StartEvent as d, InternalDispatchEvent as e, StepStateChanged as f, isStopEvent as g, isInputRequiredEvent as h, isStartEvent as i, isHumanResponseEvent as j, isChatDeltaEvent as k, isInternalDispatchEvent as l, isStepStateChanged as m, isEventsQueueChanged as n, isBuiltInEvent as o, isOverriddenBuiltInEvent as p, isCustomEvent as q };