@arbor-education/agent-view-frontend 0.2.1

package/dist/index.d.ts

@@ -0,0 +1,429 @@
+import { JSX as JSX_2 } from 'react';
+
+export declare type Agent = {
+    id: string;
+    invocation_id: string;
+    agent_definition_ref: string;
+    agent_intent?: string | null;
+    invocation_name: string;
+    application_id: string;
+    application_name?: string;
+    created_by: string;
+    status: AgentStatus;
+    context_ref: string | null;
+    checklist_ref: string | null;
+};
+
+export declare type AgentBrief = {
+    tripId: string | null;
+    isNewTrip: boolean;
+    tripName: string;
+    destination: string;
+    website: string;
+    hasRunBefore: boolean;
+};
+
+export declare type AgentChecklistItem = {
+    task: string;
+    status: AgentChecklistItemStatus;
+    description: string;
+    prompt?: string;
+    clarificationPrompts?: string[];
+    children?: AgentChecklistItem[];
+};
+
+export declare type AgentChecklistItemStatus = 'generating-a-response' | 'hitl' | 'complete' | 'failed';
+
+export declare type AgentChecklistResponse = {
+    invocation_id: string;
+    checklist: AgentChecklistItem[];
+    openingMessage?: ChatMessage;
+};
+
+export declare type AgentDefinition = {
+    ref: string;
+    display_name: string;
+    agent_intent: string;
+    description: string;
+};
+
+export declare const AgentMonitorKanban: ({ jwt, headers, baseUrl, agentDefinitionsUrl, agentsUrl, agentUrl, agentChecklistUrl, agentResourcesUrl, agentChatUrl, institutions, }: AgentMonitorKanbanProps) => JSX_2.Element;
+
+export declare type AgentMonitorKanbanProps = {
+    jwt?: string;
+    headers?: Record<string, string>;
+    baseUrl: string;
+    agentDefinitionsUrl?: string;
+    agentsUrl?: string;
+    agentUrl?: string;
+    agentChecklistUrl?: string;
+    agentResourcesUrl?: string;
+    agentChatUrl?: string;
+    institutions?: InstitutionConfig[];
+};
+
+export declare type AgentResource = {
+    uri: string;
+    type: AgentResourceType;
+    name: string;
+    description: string;
+};
+
+export declare type AgentResourceType = 'MIS_RECORD' | 'FILE' | 'WORKFLOW' | 'LINK';
+
+export declare class AgentServiceClient {
+    private readonly baseUrl;
+    private readonly token?;
+    private customHeaders?;
+    private readonly urls;
+    private readonly fetchImpl;
+    constructor(options: AgentServiceClientOptions);
+    setHeaders(headers?: Record<string, string>): void;
+    listAgentDefinitions(): Promise<ApiAgentDefinition[]>;
+    getAgentDefinition(agentDefinitionRef: string): Promise<ApiAgentDefinition>;
+    listTripOptions(): Promise<ApiTripOption[]>;
+    getDataset(): Promise<{
+        dataset: ApiDemoDataset;
+    }>;
+    setDataset(dataset: ApiDemoDataset): Promise<{
+        dataset: ApiDemoDataset;
+    }>;
+    listAgents(params?: ListAgentsParams): Promise<ApiAgentInvocation[]>;
+    createAgent(agentDefinitionRef: string, options?: {
+        invocationName?: string;
+        agentIntent?: string;
+    }): Promise<ApiCreateAgentResponse>;
+    getAgent(agentId: string): Promise<ApiAgentInvocationDetail>;
+    getAgentChecklist(agentId: string): Promise<ApiChecklistEndpointResponse>;
+    getAgentResources(agentId: string): Promise<ApiResourcesEndpointResponse>;
+    getAgentContext(agentId: string): Promise<unknown>;
+    cancelAgent(agentId: string): Promise<ApiAgentInvocation>;
+    archiveAgent(agentId: string): Promise<ApiAgentInvocation>;
+    chat(agentId: string, request: ApiChatRequest, options?: ChatOptions): Promise<ApiChatStreamEvent>;
+    private authHeaders;
+    private apiUrl;
+    private resolveUrl;
+    private request;
+    private toError;
+    private consumeSse;
+}
+
+export declare type AgentServiceClientOptions = {
+    baseUrl: string;
+    token?: string;
+    headers?: Record<string, string>;
+    urls?: AgentServiceUrlOverrides;
+    fetch?: FetchLike;
+};
+
+export declare type AgentServiceConfig = {
+    jwt?: string;
+    headers?: Record<string, string>;
+    urls: AgentServiceUrls;
+};
+
+export declare class AgentServiceError extends Error {
+    readonly status: number;
+    readonly detail: unknown;
+    constructor(status: number, detail: unknown, message?: string);
+}
+
+export declare type AgentServiceLoadState = 'idle' | 'loading' | 'error';
+
+export declare type AgentServiceUrlOverrides = {
+    agentDefinitions?: string;
+    agents?: string;
+    agent?: string;
+    agentChecklist?: string;
+    agentResources?: string;
+    agentChat?: string;
+};
+
+export declare type AgentServiceUrls = AgentServiceUrlOverrides & {
+    baseUrl: string;
+};
+
+export declare type AgentStatus = 'generating-a-response' | 'hitl' | 'complete' | 'failed';
+
+export declare const AgentView: ({ agent, open, onClose, initialBrief, initialPhase, initialChecklist, fetchAgentChecklist, fetchAgentResources, connector, }: AgentViewProps) => JSX_2.Element;
+
+export declare type AgentViewProps = {
+    agent: Agent;
+    open: boolean;
+    onClose: () => void;
+    initialBrief?: AgentBrief;
+    initialPhase?: WorkspacePhase;
+    initialChecklist?: AgentChecklistItem[] | null;
+    fetchAgentChecklist?: (invocationId: string) => Promise<AgentChecklistResponse>;
+    fetchAgentResources?: (invocationId: string) => Promise<AgentResource[]>;
+    connector: ChatConnector;
+};
+
+export declare type ApiAgentDefinition = {
+    schema_version?: number;
+    name: string;
+    agent_intent?: string;
+    display_name: string;
+    description: string;
+    enabled?: boolean;
+    default_model?: {
+        name: string;
+        parameters: Record<string, unknown>;
+    };
+    skill_refs?: string[];
+    mcps?: Array<{
+        server: string;
+        tools: string[];
+    }>;
+    workflow_refs?: string[];
+    tags?: string[];
+};
+
+export declare type ApiAgentInvocation = {
+    id: string;
+    invocation_id?: string | null;
+    agent_definition_ref: string;
+    agent_intent?: string | null;
+    invocation_name?: string | null;
+    application_id: string;
+    application_name?: string;
+    created_by: string;
+    status: ApiAgentInvocationStatus;
+    context_ref?: string | null;
+    checklist_ref?: string | null;
+    opening_message?: string;
+    opening_follow_up_prompts?: string[];
+};
+
+export declare type ApiAgentInvocationDetail = ApiAgentInvocation & {
+    checklist_items?: ApiChecklistItem[] | null;
+};
+
+export declare type ApiAgentInvocationStatus = 'active' | 'cancelled' | 'archived';
+
+export declare type ApiAgentResource = {
+    uri: string;
+    type?: string;
+    name?: string;
+    description?: string;
+};
+
+export declare type ApiChatMessage = {
+    role: ApiChatRole;
+    content: string;
+};
+
+export declare type ApiChatRequest = {
+    messages: ApiChatMessage[];
+    model?: string;
+    model_kwargs?: Record<string, unknown>;
+    chat_id?: string;
+    client_message_id?: string;
+    meta?: Record<string, unknown>;
+    moderation_enabled?: boolean;
+    auto_title?: boolean;
+};
+
+export declare type ApiChatRole = 'system' | 'user' | 'assistant';
+
+export declare type ApiChatStreamError = {
+    error: true;
+    chat_id?: string;
+    message: string;
+    is_final: boolean;
+    meta?: Record<string, unknown>;
+};
+
+export declare type ApiChatStreamEvent = {
+    chat_id: string;
+    event_id: string;
+    client_message_id: string;
+    message: ApiChatMessage;
+    timestamp: string;
+    is_final: boolean;
+    moderation_status: string | null;
+    follow_up_prompts?: string[];
+    meta: Record<string, unknown>;
+};
+
+declare type ApiChecklistEndpointResponse = ApiChecklistItem[] | {
+    checklist_items?: ApiChecklistItem[] | null;
+    checklist?: ApiChecklistItem[] | null;
+    items?: ApiChecklistItem[] | null;
+    opening_message?: string;
+    opening_follow_up_prompts?: string[];
+};
+
+export declare type ApiChecklistItem = {
+    id?: string;
+    task?: string;
+    name?: string;
+    label?: string;
+    description?: string;
+    status?: ApiChecklistItemStatus;
+    prompt?: string;
+    follow_up_prompts?: string[];
+};
+
+export declare type ApiChecklistItemStatus = 'in_progress' | 'requires_attention' | 'failed' | 'complete' | 'available' | 'generating-a-response' | 'hitl';
+
+export declare type ApiCreateAgentResponse = {
+    id: string;
+    status: ApiAgentInvocationStatus;
+    self_link: string;
+};
+
+export declare type ApiDemoDataset = 'full' | 'sparse' | 'empty';
+
+export declare type ApiResourcesEndpointResponse = ApiAgentResource[] | {
+    resources?: ApiAgentResource[] | null;
+};
+
+export declare type ApiTripOption = {
+    id: string;
+    name: string;
+    has_run_before?: boolean;
+};
+
+export declare const buildAgentFromDefinition: (definition: AgentDefinition, invocationName: string) => Agent;
+
+export declare interface ChatConnector {
+    openingMessage(): ChatMessage;
+    start(brief: AgentBrief): Promise<ChatTurn>;
+    sendMessage(text: string): Promise<ChatTurn>;
+    stop(): Promise<void>;
+    seedChecklist?(checklist: AgentChecklistItem[]): void;
+    bootstrapConversation?(prompt?: string): Promise<ChatMessage[]>;
+}
+
+export declare type ChatMessage = {
+    id: string;
+    author: ChatMessageAuthor;
+    text: string;
+    followUpPrompts?: string[];
+    pending?: boolean;
+};
+
+export declare type ChatMessageAuthor = 'agent' | 'user' | 'system';
+
+export declare type ChatOptions = {
+    onEvent?: (event: ApiChatStreamEvent) => void;
+    signal?: AbortSignal;
+};
+
+export declare type ChatTurn = {
+    message: ChatMessage;
+    checklist?: AgentChecklistItem[];
+    phase?: WorkspacePhase;
+};
+
+export declare const createHttpChatConnectorFactory: (client: AgentServiceClient, options?: HttpChatConnectorOptions & {
+    resolveOpeningMessage?: (agent: {
+        id: string;
+        invocation_id: string;
+    }) => ChatMessage | undefined;
+}) => (agent: {
+    id: string;
+    invocation_id: string;
+}) => HttpChatConnector;
+
+declare type FetchLike = typeof fetch;
+
+export declare class HttpChatConnector implements ChatConnector {
+    private readonly client;
+    private readonly agentId;
+    private readonly opening;
+    private readonly model?;
+    private readonly bootstrapPrompt;
+    private chatId?;
+    private seededChecklist;
+    constructor(client: AgentServiceClient, agentId: string, options?: HttpChatConnectorOptions);
+    openingMessage(): ChatMessage;
+    bootstrapConversation(prompt?: string): Promise<ChatMessage[]>;
+    start(brief: AgentBrief): Promise<ChatTurn>;
+    sendMessage(text: string): Promise<ChatTurn>;
+    stop(): Promise<void>;
+    seedChecklist(checklist: AgentChecklistItem[]): void;
+    private exchange;
+}
+
+export declare type HttpChatConnectorOptions = {
+    openingMessage?: ChatMessage;
+    model?: string;
+    bootstrapPrompt?: string;
+};
+
+export declare type InstitutionConfig = {
+    name: string;
+    applicationId: string;
+    applicationUrl: string;
+};
+
+export declare type ListAgentsParams = {
+    status?: ApiAgentInvocationStatus;
+    agentDefinitionRef?: string;
+};
+
+export declare const mapApiAgent: (record: ApiAgentInvocation) => Agent;
+
+export declare const mapApiAgentDefinition: (record: ApiAgentDefinition) => AgentDefinition;
+
+export declare const mapApiAgentStatus: (status: string) => AgentStatus;
+
+export declare const mapApiChecklistEndpointResponse: (invocationId: string, payload: ApiChecklistEndpointResponse, agent?: Pick<ApiAgentInvocation, "opening_message" | "opening_follow_up_prompts">) => AgentChecklistResponse;
+
+export declare const mapApiChecklistItem: (item: ApiChecklistItem) => AgentChecklistItem;
+
+export declare const mapApiChecklistResponse: (invocationId: string, detail: ApiAgentInvocationDetail) => AgentChecklistResponse;
+
+export declare const mapApiChecklistStatus: (status: ApiChecklistItemStatus | string | undefined) => AgentChecklistItemStatus;
+
+export declare const mapApiOpeningMessage: (record: Pick<ApiAgentInvocation, "opening_message" | "opening_follow_up_prompts">) => ChatMessage | undefined;
+
+export declare const mapApiResource: (record: ApiAgentResource) => AgentResource;
+
+export declare const mapApiResourcesEndpointResponse: (payload: ApiResourcesEndpointResponse) => AgentResource[];
+
+export declare const mapApiTripOption: (record: ApiTripOption) => {
+    hasRunBefore?: true | undefined;
+    id: string;
+    name: string;
+};
+
+export declare const NewAgentModal: ({ open, onClose, onStart, agentDefinitions, }: NewAgentModalProps) => JSX_2.Element | null;
+
+export declare type NewAgentModalProps = {
+    open: boolean;
+    onClose: () => void;
+    onStart: (payload: NewAgentStartPayload) => void | Promise<void>;
+    agentDefinitions: AgentDefinition[];
+};
+
+export declare type NewAgentStartPayload = {
+    definition: AgentDefinition;
+    invocationName: string;
+};
+
+export declare type TripOption = {
+    id: string;
+    name: string;
+    hasRunBefore?: boolean;
+};
+
+export declare const useAgentService: (config: AgentServiceConfig) => UseAgentServiceResult;
+
+export declare type UseAgentServiceResult = {
+    agents: Agent[];
+    agentDefinitions: AgentDefinition[];
+    loadState: AgentServiceLoadState;
+    loadError: string | null;
+    reload: () => void;
+    fetchAgentChecklist: (invocationId: string) => Promise<AgentChecklistResponse>;
+    fetchAgentResources: (invocationId: string) => Promise<AgentResource[]>;
+    createAgent: (payload: NewAgentStartPayload) => Promise<Agent>;
+    chatConnector: (agent: Agent) => ChatConnector;
+};
+
+export declare type WorkspacePhase = 'briefing' | 'running' | 'stopped' | 'complete';
+
+export { }