@alquimia-ai/tools 2.3.0 → 2.5.0

package/dist/type-xksRnBUW.d.ts

@@ -0,0 +1,312 @@
+import { Span } from '@elastic/apm-rum';
+import { Message } from 'ai';
+import { A as A2uiSurface } from './types-CMVbyEv8.js';
+
+interface ITooler {
+    tooler: Array<{
+        name: string;
+        parameters: Record<string, any>;
+    }>;
+}
+interface IToolSpec {
+    name: string;
+    parameters: Record<string, any>;
+}
+declare abstract class ToolFactory {
+    protected toolSpec: IToolSpec | null;
+    constructor(toolSpec: IToolSpec);
+    static createTool(toolSpec: IToolSpec): IToolSpec;
+    abstract execute(): Promise<any>;
+}
+interface AIMessageChunk {
+    type: string;
+    data?: AIMessageChunkData;
+    answer?: string;
+    tooler?: ToolEvent[];
+    error_code?: string;
+    error_detail?: string;
+    taskid?: string;
+    loading?: boolean;
+    thinkings?: ThinkingsInferenceResponse[];
+}
+interface AIMessageChunkData {
+    content: string;
+    additional_kwargs?: Record<string, unknown>;
+    response_metadata?: Record<string, unknown>;
+    type: string;
+    name?: string | null;
+    id?: string | null;
+    example?: boolean;
+    tool_calls?: ToolCall[];
+    invalid_tool_calls?: InvalidToolCall[];
+    usage_metadata?: any;
+    tool_call_chunks?: unknown[];
+    error_code?: string;
+    error_detail?: string;
+}
+type ToolCall = {
+    name: string;
+    args: Record<string, any>;
+    id?: string | null;
+};
+type InvalidToolCall = {
+    name: string | null;
+    args: string | null;
+    id: string | null;
+    error: string | null;
+};
+interface BaseAPIConfig {
+    baseUrl: string;
+    route: string;
+    token?: string;
+    headers?: Record<string, string>;
+}
+interface RatingData {
+    assistantId: string;
+    sessionId: string;
+    topicId: number;
+    score?: number;
+    description?: string;
+}
+interface AttachmentPayload {
+    filename: string;
+    content_type: string;
+    content_size: number;
+}
+type AlquimiaMessage = Message & {
+    error_code?: string;
+    error_detail?: string;
+    taskid?: string;
+    loading?: boolean;
+    created_at?: string;
+    additionalInfo?: string;
+    tooler?: Tooler[];
+    thinkings?: ThinkingsInferenceResponse[];
+    attachments?: AttachmentPayload[];
+};
+interface ActionResponse<T = void> {
+    success: boolean;
+    data?: T;
+    error?: {
+        message: string;
+        code?: string;
+        details?: any;
+        name?: string;
+        cause?: string;
+        status?: string;
+    };
+}
+type ApmSpan = Span & {
+    id?: string;
+    traceId?: string;
+} | undefined;
+type ApiError = Error & {
+    message: string;
+    name: string;
+    cause: string;
+    code?: string | number;
+    status?: string | number;
+};
+type Tooler = {
+    control_id: string;
+    tool_summary?: ToolSummary;
+    tool_output?: ToolOutput;
+};
+type ToolSummary = {
+    name: string;
+    parameters: Record<string, any>;
+};
+type ToolOutput = {
+    result: any;
+    status: string;
+};
+type ToolEvent = {
+    event_class: string;
+    control_id: string;
+    data: any;
+    status: string;
+};
+interface ConversationsMap {
+    [topicId: string]: string;
+}
+interface DocumentSearchResult {
+    pageContent: string;
+    metadata: {
+        source: string;
+        _id: string;
+        _collection_name: string;
+    };
+    score: number;
+}
+type ElevenLabsVoiceSettings = {
+    stability: number;
+    similarity_boost: number;
+    style: number;
+};
+type ElevenLabsRequestSpecs = {
+    optimize_streaming_latency: string;
+    output_format: string;
+    model_id: string;
+    language: string;
+    voice_settings: ElevenLabsVoiceSettings;
+};
+type TTSResult = {
+    type: 'blob';
+    data: Blob;
+} | {
+    type: 'url';
+    data: string;
+} | {
+    type: 'error';
+    message: string;
+};
+/** One SSE `data:` JSON frame (`event_class` at top level). */
+interface AlquimiaEventData {
+    taskid?: string;
+    event_class?: string;
+    control_id?: string;
+    date_submitted?: string;
+    status?: string | null;
+    data?: unknown;
+    experts?: ExpertInferenceResponse[];
+    thinkings?: ThinkingsInferenceResponse[];
+    tools_output?: ToolEvent[];
+    agents_output?: any[];
+    tools_pending_approval?: any[];
+    tools_pending_execution?: any[];
+    errors?: any[];
+}
+interface AssistantInferenceResponse {
+    event_class: string;
+    control_id: string;
+    data: string;
+    status: string;
+    date_submitted: string;
+    message?: string | null;
+    extras?: Record<string, unknown> | null;
+    extra_data?: ExtraDataContext | null;
+    channel?: unknown | null;
+    depth?: number;
+    taskid?: string;
+}
+/**
+ * Channel-scoped context returned alongside an inference response (was
+ * `ExtraDataConfig` in v0.2.0). Carries message metadata from the channel
+ * the inference was triggered from.
+ */
+interface ExtraDataContext {
+    whatsapp_message_id?: string;
+    whatsapp_message_from?: string;
+    email_message_recipient?: string;
+    email_message_subject?: string;
+    email_message_id?: string;
+    email_message_body?: string;
+    slack_team_id?: string;
+    slack_user_id?: string;
+    slack_channel_id?: string;
+    slack_response_url?: string;
+}
+/**
+ * JSON body returned by `POST /event/infer/{assistantId}` (and channel
+ * variants). Keys match the runtime wire format (lowercase, no underscores).
+ * `taskid` is the id used for the SSE stream.
+ */
+interface CommonAttributes {
+    taskid?: string | null;
+    parenttaskid?: string | null;
+    sessionid?: string | null;
+    userid?: string | null;
+    assistantid?: string | null;
+    agentspaceid?: string | null;
+    channelid?: string | null;
+    depth?: string;
+    attachments?: string[];
+}
+type InferInitResponse = CommonAttributes;
+/**
+ * Native-tools evaluation strategy. Wraps the client-side tool schemas
+ * the SDK previously sent at the top level of the infer payload.
+ */
+interface NativeToolsEvaluationStrategy {
+    evaluation_strategy_id: 'native';
+    tool_schemas?: unknown[];
+    max_steps?: number;
+    current_step?: number;
+    max_concurrent_tools?: number;
+    decorators?: unknown[];
+    tool_choice?: unknown;
+    structured_output?: unknown;
+}
+interface RawToolsEvaluationStrategy {
+    evaluation_strategy_id: 'raw';
+    tool_schemas?: unknown[];
+}
+interface OneShootEvaluationStrategy {
+    evaluation_strategy_id: 'one-shoot';
+}
+type EvaluationStrategy = NativeToolsEvaluationStrategy | RawToolsEvaluationStrategy | OneShootEvaluationStrategy;
+interface AssistantResponseData {
+    content: string;
+    additional_kwargs: Record<string, any>;
+    response_metadata: ResponseMetadata;
+    type: string;
+    id: string;
+    example: boolean;
+    tool_calls: any[];
+    invalid_tool_calls: any[];
+    usage_metadata: UsageMetadata;
+}
+interface ResponseMetadata {
+    token_usage: TokenUsage;
+    model_name: string;
+    system_fingerprint: string;
+    finish_reason: string;
+    logprobs: any | null;
+}
+interface TokenUsage {
+    completion_tokens: number;
+    prompt_tokens: number;
+    total_tokens: number;
+    completion_time: number;
+    prompt_time: number;
+    queue_time: number;
+    total_time: number;
+}
+interface UsageMetadata {
+    input_tokens: number;
+    output_tokens: number;
+    total_tokens: number;
+}
+interface ExpertInferenceResponse {
+    event_class: string;
+    control_id: string;
+    data: {
+        label: string;
+        score: number;
+    };
+    status: string;
+    date_submitted: string;
+}
+interface ThinkingsInferenceResponse {
+    event_class: string;
+    control_id: string;
+    status: string;
+    date_submitted: string;
+    data: {
+        content: AssistantResponseData;
+        is_complete: boolean;
+        is_partial: boolean;
+    };
+}
+interface GenuiSurfaceItem {
+    controlId: string;
+    surface: A2uiSurface;
+    /** Message-count anchor: the surface renders after this many messages (chronological ordering). */
+    afterCount: number;
+    /** True once the user has submitted an interactive surface (disables it + shows a submitted state). */
+    submitted?: boolean;
+    /** Set when the user declined the surface and typed a reply */
+    dismissedWith?: string;
+}
+
+export { type ApmSpan as A, type BaseAPIConfig as B, type CommonAttributes as C, type DocumentSearchResult as D, type ElevenLabsRequestSpecs as E, type GenuiSurfaceItem as G, type IToolSpec as I, type NativeToolsEvaluationStrategy as N, type OneShootEvaluationStrategy as O, type RatingData as R, type TTSResult as T, type UsageMetadata as U, type AIMessageChunk as a, type AIMessageChunkData as b, type ActionResponse as c, type AlquimiaEventData as d, type AlquimiaMessage as e, type ApiError as f, type AssistantInferenceResponse as g, type AssistantResponseData as h, type AttachmentPayload as i, type ConversationsMap as j, type ElevenLabsVoiceSettings as k, type EvaluationStrategy as l, type ExpertInferenceResponse as m, type ExtraDataContext as n, type ITooler as o, type InferInitResponse as p, type RawToolsEvaluationStrategy as q, type ResponseMetadata as r, type ThinkingsInferenceResponse as s, type TokenUsage as t, type ToolEvent as u, ToolFactory as v, type ToolOutput as w, type ToolSummary as x, type Tooler as y };

package/dist/types/index.d.mts

@@ -1,310 +1,86 @@
-import { Span } from '@elastic/apm-rum';
-import { Message } from 'ai';
-import { a as A2uiSurface } from '../types-DnfWUE9V.mjs';
+export { a as AIMessageChunk, b as AIMessageChunkData, c as ActionResponse, d as AlquimiaEventData, e as AlquimiaMessage, f as ApiError, A as ApmSpan, g as AssistantInferenceResponse, h as AssistantResponseData, i as AttachmentPayload, B as BaseAPIConfig, C as CommonAttributes, j as ConversationsMap, D as DocumentSearchResult, E as ElevenLabsRequestSpecs, k as ElevenLabsVoiceSettings, l as EvaluationStrategy, m as ExpertInferenceResponse, n as ExtraDataContext, G as GenuiSurfaceItem, I as IToolSpec, o as ITooler, p as InferInitResponse, N as NativeToolsEvaluationStrategy, O as OneShootEvaluationStrategy, R as RatingData, q as RawToolsEvaluationStrategy, r as ResponseMetadata, T as TTSResult, s as ThinkingsInferenceResponse, t as TokenUsage, u as ToolEvent, v as ToolFactory, w as ToolOutput, x as ToolSummary, y as Tooler, U as UsageMetadata } from '../type-DqX3-9QS.mjs';
+import { T as ToolExecutionResponse } from '../types-CMVbyEv8.mjs';
+import { W as WorklogRecord } from '../types-C-6fgK1_.mjs';
+import '@elastic/apm-rum';
+import 'ai';
 
-interface ITooler {
-    tooler: Array<{
-        name: string;
-        parameters: Record<string, any>;
-    }>;
-}
-interface IToolSpec {
-    name: string;
-    parameters: Record<string, any>;
-}
-declare abstract class ToolFactory {
-    protected toolSpec: IToolSpec | null;
-    constructor(toolSpec: IToolSpec);
-    static createTool(toolSpec: IToolSpec): IToolSpec;
-    abstract execute(): Promise<any>;
-}
-interface AIMessageChunk {
-    type: string;
-    data?: AIMessageChunkData;
-    answer?: string;
-    tooler?: ToolEvent[];
-    error_code?: string;
-    error_detail?: string;
-    taskid?: string;
-    loading?: boolean;
-    thinkings?: ThinkingsInferenceResponse[];
-}
-interface AIMessageChunkData {
-    content: string;
-    additional_kwargs?: Record<string, unknown>;
-    response_metadata?: Record<string, unknown>;
-    type: string;
-    name?: string | null;
-    id?: string | null;
-    example?: boolean;
-    tool_calls?: ToolCall[];
-    invalid_tool_calls?: InvalidToolCall[];
-    usage_metadata?: any;
-    tool_call_chunks?: unknown[];
-    error_code?: string;
-    error_detail?: string;
-}
-type ToolCall = {
-    name: string;
-    args: Record<string, any>;
-    id?: string | null;
-};
-type InvalidToolCall = {
-    name: string | null;
-    args: string | null;
-    id: string | null;
-    error: string | null;
-};
-interface BaseAPIConfig {
-    baseUrl: string;
-    route: string;
-    token?: string;
-    headers?: Record<string, string>;
-}
-interface RatingData {
-    assistantId: string;
-    sessionId: string;
-    topicId: number;
-    score?: number;
-    description?: string;
-}
-interface AttachmentPayload {
-    filename: string;
-    content_type: string;
-    content_size: number;
-}
-type AlquimiaMessage = Message & {
-    error_code?: string;
-    error_detail?: string;
-    taskid?: string;
-    loading?: boolean;
-    created_at?: string;
-    additionalInfo?: string;
-    tooler?: Tooler[];
-    thinkings?: ThinkingsInferenceResponse[];
-    attachments?: AttachmentPayload[];
-};
-interface ActionResponse<T = void> {
-    success: boolean;
-    data?: T;
-    error?: {
-        message: string;
-        code?: string;
-        details?: any;
-        name?: string;
-        cause?: string;
-        status?: string;
-    };
-}
-type ApmSpan = Span & {
-    id?: string;
-    traceId?: string;
-} | undefined;
-type ApiError = Error & {
-    message: string;
-    name: string;
-    cause: string;
-    code?: string | number;
-    status?: string | number;
-};
-type Tooler = {
-    control_id: string;
-    tool_summary?: ToolSummary;
-    tool_output?: ToolOutput;
-};
-type ToolSummary = {
-    name: string;
-    parameters: Record<string, any>;
-};
-type ToolOutput = {
-    result: any;
-    status: string;
-};
-type ToolEvent = {
-    event_class: string;
-    control_id: string;
-    data: any;
-    status: string;
-};
-interface ConversationsMap {
-    [topicId: string]: string;
-}
-interface DocumentSearchResult {
-    pageContent: string;
-    metadata: {
-        source: string;
-        _id: string;
-        _collection_name: string;
-    };
-    score: number;
-}
-type ElevenLabsVoiceSettings = {
-    stability: number;
-    similarity_boost: number;
-    style: number;
-};
-type ElevenLabsRequestSpecs = {
-    optimize_streaming_latency: string;
-    output_format: string;
-    model_id: string;
-    language: string;
-    voice_settings: ElevenLabsVoiceSettings;
-};
-type TTSResult = {
-    type: 'blob';
-    data: Blob;
-} | {
-    type: 'url';
-    data: string;
-} | {
-    type: 'error';
-    message: string;
-};
-/** One SSE `data:` JSON frame (`event_class` at top level). */
-interface AlquimiaEventData {
-    taskid?: string;
-    event_class?: string;
-    control_id?: string;
-    date_submitted?: string;
-    status?: string | null;
-    data?: unknown;
-    experts?: ExpertInferenceResponse[];
-    thinkings?: ThinkingsInferenceResponse[];
-    tools_output?: ToolEvent[];
-    agents_output?: any[];
-    tools_pending_approval?: any[];
-    tools_pending_execution?: any[];
-    errors?: any[];
-}
-interface AssistantInferenceResponse {
-    event_class: string;
-    control_id: string;
-    data: string;
-    status: string;
-    date_submitted: string;
-    message?: string | null;
-    extras?: Record<string, unknown> | null;
-    extra_data?: ExtraDataContext | null;
-    channel?: unknown | null;
-    depth?: number;
-    taskid?: string;
-}
-/**
- * Channel-scoped context returned alongside an inference response (was
- * `ExtraDataConfig` in v0.2.0). Carries message metadata from the channel
- * the inference was triggered from.
- */
-interface ExtraDataContext {
-    whatsapp_message_id?: string;
-    whatsapp_message_from?: string;
-    email_message_recipient?: string;
-    email_message_subject?: string;
-    email_message_id?: string;
-    email_message_body?: string;
-    slack_team_id?: string;
-    slack_user_id?: string;
-    slack_channel_id?: string;
-    slack_response_url?: string;
-}
 /**
- * JSON body returned by `POST /event/infer/{assistantId}` (and channel
- * variants). Keys match the runtime wire format (lowercase, no underscores).
- * `taskid` is the id used for the SSE stream.
+ * Runtime v0.5.0 event payloads.
+ *
+ * These types mirror the request/response schemas exposed by the
+ * `/event/*` endpoints. Many fields are optional because the runtime accepts
+ * sparse payloads and fills in defaults from the controller context.
  */
-interface CommonAttributes {
-    taskid?: string | null;
-    parenttaskid?: string | null;
-    sessionid?: string | null;
-    userid?: string | null;
-    assistantid?: string | null;
-    agentspaceid?: string | null;
-    channelid?: string | null;
-    depth?: string;
-    attachments?: string[];
-}
-type InferInitResponse = CommonAttributes;
-/**
- * Native-tools evaluation strategy. Wraps the client-side tool schemas
- * the SDK previously sent at the top level of the infer payload.
- */
-interface NativeToolsEvaluationStrategy {
-    evaluation_strategy_id: 'native';
-    tool_schemas?: unknown[];
-    max_steps?: number;
-    current_step?: number;
-    max_concurrent_tools?: number;
-    decorators?: unknown[];
-    tool_choice?: unknown;
-    structured_output?: unknown;
-}
-interface RawToolsEvaluationStrategy {
-    evaluation_strategy_id: 'raw';
-    tool_schemas?: unknown[];
-}
-interface OneShootEvaluationStrategy {
-    evaluation_strategy_id: 'one-shoot';
-}
-type EvaluationStrategy = NativeToolsEvaluationStrategy | RawToolsEvaluationStrategy | OneShootEvaluationStrategy;
-interface AssistantResponseData {
-    content: string;
-    additional_kwargs: Record<string, any>;
-    response_metadata: ResponseMetadata;
-    type: string;
-    id: string;
-    example: boolean;
-    tool_calls: any[];
-    invalid_tool_calls: any[];
-    usage_metadata: UsageMetadata;
-}
-interface ResponseMetadata {
-    token_usage: TokenUsage;
-    model_name: string;
-    system_fingerprint: string;
-    finish_reason: string;
-    logprobs: any | null;
-}
-interface TokenUsage {
-    completion_tokens: number;
-    prompt_tokens: number;
-    total_tokens: number;
-    completion_time: number;
-    prompt_time: number;
-    queue_time: number;
-    total_time: number;
-}
-interface UsageMetadata {
-    input_tokens: number;
-    output_tokens: number;
-    total_tokens: number;
-}
-interface ExpertInferenceResponse {
-    event_class: string;
+/** Base fields shared by most runtime events. */
+interface RuntimeEventBase {
+    task_id?: string;
+    session_id?: string;
+    user_id?: string;
+    assistant_id?: string;
+    agentspace_id?: string;
+    channel_id?: string;
+    control_id?: string | null;
+    timestamp?: string;
+}
+/** POST /event/session-start */
+interface SessionStartEvent extends RuntimeEventBase {
+    event_class: "SessionStartEvent";
+    session_id: string;
+    assistant_id?: string;
+    user_id?: string;
+    agentspace_id?: string;
+    channel_id?: string;
+}
+/** POST /event/session-end */
+interface SessionEndEvent extends RuntimeEventBase {
+    event_class: "SessionEndEvent";
+    session_id?: string;
+    reason?: string;
+}
+/** POST /event/user-message */
+interface UserMessageEvent extends RuntimeEventBase {
+    event_class: "UserMessageEvent";
+    message: unknown;
+    session_id?: string;
+    user_id?: string;
+}
+/** POST /event/agent-message */
+interface AgentMessageEvent extends RuntimeEventBase {
+    event_class: "AgentMessageEvent";
+    content: unknown;
+    session_id?: string;
+    assistant_id?: string;
+}
+/** POST /event/tool-approval (approval/rejection of a pending human-approval gate). */
+interface ToolApprovalEvent extends RuntimeEventBase {
+    event_class: "ToolApprovalEvent";
     control_id: string;
-    data: {
-        label: string;
-        score: number;
-    };
-    status: string;
-    date_submitted: string;
+    /** `true` for approval, `false` for rejection. */
+    result: boolean;
+    /** Optional reason or note attached to the decision. */
+    message?: string;
+}
+/** POST /event/tool-completion (client-side tool execution result). */
+interface ToolCompletionEvent extends ToolExecutionResponse {
+    event_class: "ToolCompletionEvent";
+}
+/** POST /event/error */
+interface RuntimeErrorEvent extends RuntimeEventBase {
+    event_class: "ErrorEvent";
+    error_code?: string;
+    message: string;
+    details?: unknown;
 }
-interface ThinkingsInferenceResponse {
-    event_class: string;
-    control_id: string;
-    status: string;
-    date_submitted: string;
-    data: {
-        content: AssistantResponseData;
-        is_complete: boolean;
-        is_partial: boolean;
-    };
+/** POST /event/bus-mode (batch of worklog records emitted when streaming in bus mode). */
+interface BusModeEvent extends RuntimeEventBase {
+    event_class: "BusModeEvent";
+    records?: WorklogRecord[];
 }
-interface GenuiSurfaceItem {
-    controlId: string;
-    surface: A2uiSurface;
-    /** Message-count anchor: the surface renders after this many messages (chronological ordering). */
-    afterCount: number;
-    /** True once the user has submitted an interactive surface (disables it + shows a submitted state). */
-    submitted?: boolean;
+/** POST /event/heartbeat */
+interface HeartbeatEvent extends RuntimeEventBase {
+    event_class: "HeartbeatEvent";
 }
+/** Discriminated union of all runtime v0.5.0 event payloads. */
+type RuntimeEvent = SessionStartEvent | SessionEndEvent | UserMessageEvent | AgentMessageEvent | ToolApprovalEvent | ToolCompletionEvent | RuntimeErrorEvent | BusModeEvent | HeartbeatEvent;
 
-export { type AIMessageChunk, type AIMessageChunkData, type ActionResponse, type AlquimiaEventData, type AlquimiaMessage, type ApiError, type ApmSpan, type AssistantInferenceResponse, type AssistantResponseData, type AttachmentPayload, type BaseAPIConfig, type CommonAttributes, type ConversationsMap, type DocumentSearchResult, type ElevenLabsRequestSpecs, type ElevenLabsVoiceSettings, type EvaluationStrategy, type ExpertInferenceResponse, type ExtraDataContext, type GenuiSurfaceItem, type IToolSpec, type ITooler, type InferInitResponse, type NativeToolsEvaluationStrategy, type OneShootEvaluationStrategy, type RatingData, type RawToolsEvaluationStrategy, type ResponseMetadata, type TTSResult, type ThinkingsInferenceResponse, type TokenUsage, type ToolEvent, ToolFactory, type ToolOutput, type ToolSummary, type Tooler, type UsageMetadata };
+export type { AgentMessageEvent, BusModeEvent, HeartbeatEvent, RuntimeErrorEvent, RuntimeEvent, RuntimeEventBase, SessionEndEvent, SessionStartEvent, ToolApprovalEvent, ToolCompletionEvent, UserMessageEvent };