@inkeep/agents-run-api 0.1.2 → 0.1.6

package/dist/a2a/client.d.ts

@@ -1,182 +0,0 @@
-import type { AgentCard, CancelTaskResponse, GetTaskPushNotificationConfigResponse, GetTaskResponse, Message, MessageSendParams, SendMessageResponse, SetTaskPushNotificationConfigResponse, Task, TaskArtifactUpdateEvent, TaskIdParams, TaskPushNotificationConfig, TaskQueryParams, TaskStatusUpdateEvent } from '@inkeep/agents-core';
-type A2AStreamEventData = Message | Task | TaskStatusUpdateEvent | TaskArtifactUpdateEvent;
-export type BackoffStrategy = {
-    initialInterval: number;
-    maxInterval: number;
-    exponent: number;
-    maxElapsedTime: number;
-};
-export type RetryConfig = {
-    strategy: 'none';
-} | {
-    strategy: 'backoff';
-    backoff?: BackoffStrategy;
-    retryConnectionErrors?: boolean;
-    statusCodes?: string[];
-};
-export interface A2AClientOptions {
-    retryConfig?: RetryConfig;
-    headers?: Record<string, string>;
-}
-/**
- * A2AClient is a TypeScript HTTP client for interacting with A2A-compliant agents.
- *
- * Features:
- * - Configurable retry behavior with exponential backoff
- * - Automatic retry on network errors and configurable HTTP status codes
- * - Support for custom retry strategies and timeouts
- *
- * Default retry behavior:
- * - Retries on: 429, 500, 502, 503, 504 status codes and network errors
- * - Initial delay: 500ms, max delay: 60s, exponential backoff (1.5x)
- * - Max total retry time: 30 seconds
- *
- * @example
- * // Default retry behavior
- * const client = new A2AClient('https://agent.example.com');
- *
- * // Custom retry configuration
- * const client = new A2AClient('https://agent.example.com', {
- *   retryConfig: {
- *     strategy: 'backoff',
- *     retryConnectionErrors: true,
- *     statusCodes: ['429', '502', '503', '504'],
- *     backoff: {
- *       initialInterval: 1000,
- *       maxInterval: 30000,
- *       exponent: 2,
- *       maxElapsedTime: 60000
- *     }
- *   }
- * });
- *
- * // Disable retries
- * const client = new A2AClient('https://agent.example.com', {
- *   retryConfig: { strategy: 'none' }
- * });
- */
-export declare class A2AClient {
-    private agentBaseUrl;
-    private agentCardPromise;
-    private requestIdCounter;
-    private serviceEndpointUrl?;
-    private options;
-    /**
-     * Constructs an A2AClient instance.
-     * It initiates fetching the agent card from the provided agent baseUrl.
-     * The Agent Card is expected at `${agentBaseUrl}/.well-known/agent.json`.
-     * The `url` field from the Agent Card will be used as the RPC service endpoint.
-     * @param agentBaseUrl The base URL of the A2A agent (e.g., https://agent.example.com).
-     * @param options Optional configuration including retry behavior.
-     */
-    constructor(agentBaseUrl: string, options?: A2AClientOptions);
-    /**
-     * Fetches the Agent Card from the agent's well-known URI and caches its service endpoint URL.
-     * This method is called by the constructor.
-     * @returns A Promise that resolves to the AgentCard.
-     */
-    private _fetchAndCacheAgentCard;
-    /**
-     * Retrieves the Agent Card.
-     * If an `agentBaseUrl` is provided, it fetches the card from that specific URL.
-     * Otherwise, it returns the card fetched and cached during client construction.
-     * @param agentBaseUrl Optional. The base URL of the agent to fetch the card from.
-     * If provided, this will fetch a new card, not use the cached one from the constructor's URL.
-     * @returns A Promise that resolves to the AgentCard.
-     */
-    getAgentCard(agentBaseUrl?: string): Promise<AgentCard>;
-    /**
-     * Gets the RPC service endpoint URL. Ensures the agent card has been fetched first.
-     * @returns A Promise that resolves to the service endpoint URL string.
-     */
-    private _getServiceEndpoint;
-    /**
-     * Retry utility functions
-     */
-    private retry;
-    private wrapFetcher;
-    private isRetryableResponse;
-    private isRetryableError;
-    private retryBackoff;
-    private retryIntervalFromResponse;
-    private delay;
-    /**
-     * Helper method to make a generic JSON-RPC POST request.
-     * @param method The RPC method name.
-     * @param params The parameters for the RPC method.
-     * @returns A Promise that resolves to the RPC response.
-     */
-    private _postRpcRequest;
-    /**
-     * Sends a message to the agent.
-     * The behavior (blocking/non-blocking) and push notification configuration
-     * are specified within the `params.configuration` object.
-     * Optionally, `params.message.contextId` or `params.message.taskId` can be provided.
-     * @param params The parameters for sending the message, including the message content and configuration.
-     * @returns A Promise resolving to SendMessageResponse, which can be a Message, Task, or an error.
-     */
-    sendMessage(params: MessageSendParams): Promise<SendMessageResponse>;
-    /**
-     * Sends a message to the agent and streams back responses using Server-Sent Events (SSE).
-     * Push notification configuration can be specified in `params.configuration`.
-     * Optionally, `params.message.contextId` or `params.message.taskId` can be provided.
-     * Requires the agent to support streaming (`capabilities.streaming: true` in AgentCard).
-     * @param params The parameters for sending the message.
-     * @returns An AsyncGenerator yielding A2AStreamEventData (Message, Task, TaskStatusUpdateEvent, or TaskArtifactUpdateEvent).
-     * The generator throws an error if streaming is not supported or if an HTTP/SSE error occurs.
-     */
-    sendMessageStream(params: MessageSendParams): AsyncGenerator<A2AStreamEventData, void, undefined>;
-    /**
-     * Sets or updates the push notification configuration for a given task.
-     * Requires the agent to support push notifications (`capabilities.pushNotifications: true` in AgentCard).
-     * @param params Parameters containing the taskId and the TaskPushNotificationConfig.
-     * @returns A Promise resolving to SetTaskPushNotificationConfigResponse.
-     */
-    setTaskPushNotificationConfig(params: TaskPushNotificationConfig): Promise<SetTaskPushNotificationConfigResponse>;
-    /**
-     * Gets the push notification configuration for a given task.
-     * @param params Parameters containing the taskId.
-     * @returns A Promise resolving to GetTaskPushNotificationConfigResponse.
-     */
-    getTaskPushNotificationConfig(params: TaskIdParams): Promise<GetTaskPushNotificationConfigResponse>;
-    /**
-     * Retrieves a task by its ID.
-     * @param params Parameters containing the taskId and optional historyLength.
-     * @returns A Promise resolving to GetTaskResponse, which contains the Task object or an error.
-     */
-    getTask(params: TaskQueryParams): Promise<GetTaskResponse>;
-    /**
-     * Cancels a task by its ID.
-     * @param params Parameters containing the taskId.
-     * @returns A Promise resolving to CancelTaskResponse, which contains the updated Task object or an error.
-     */
-    cancelTask(params: TaskIdParams): Promise<CancelTaskResponse>;
-    /**
-     * Resubscribes to a task's event stream using Server-Sent Events (SSE).
-     * This is used if a previous SSE connection for an active task was broken.
-     * Requires the agent to support streaming (`capabilities.streaming: true` in AgentCard).
-     * @param params Parameters containing the taskId.
-     * @returns An AsyncGenerator yielding A2AStreamEventData (Message, Task, TaskStatusUpdateEvent, or TaskArtifactUpdateEvent).
-     */
-    resubscribeTask(params: TaskIdParams): AsyncGenerator<A2AStreamEventData, void, undefined>;
-    /**
-     * Parses an HTTP response body as an A2A Server-Sent Event stream.
-     * Each 'data' field of an SSE event is expected to be a JSON-RPC 2.0 Response object,
-     * specifically a SendStreamingMessageResponse (or similar structure for resubscribe).
-     * @param response The HTTP Response object whose body is the SSE stream.
-     * @param originalRequestId The ID of the client's JSON-RPC request that initiated this stream.
-     * Used to validate the `id` in the streamed JSON-RPC responses.
-     * @returns An AsyncGenerator yielding the `result` field of each valid JSON-RPC success response from the stream.
-     */
-    private _parseA2ASseStream;
-    /**
-     * Processes a single SSE event's data string, expecting it to be a JSON-RPC response.
-     * @param jsonData The string content from one or more 'data:' lines of an SSE event.
-     * @param originalRequestId The ID of the client's request that initiated the stream.
-     * @returns The `result` field of the parsed JSON-RPC success response.
-     * @throws Error if data is not valid JSON, not a valid JSON-RPC response, an error response, or ID mismatch.
-     */
-    private _processSseEventData;
-}
-export {};
-//# sourceMappingURL=client.d.ts.map

package/dist/a2a/client.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/a2a/client.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,SAAS,EACT,kBAAkB,EAClB,qCAAqC,EACrC,eAAe,EAKf,OAAO,EACP,iBAAiB,EACjB,mBAAmB,EAGnB,qCAAqC,EACrC,IAAI,EACJ,uBAAuB,EACvB,YAAY,EACZ,0BAA0B,EAC1B,eAAe,EACf,qBAAqB,EACtB,MAAM,qBAAqB,CAAC;AAK7B,KAAK,kBAAkB,GAAG,OAAO,GAAG,IAAI,GAAG,qBAAqB,GAAG,uBAAuB,CAAC;AAG3F,MAAM,MAAM,eAAe,GAAG;IAC5B,eAAe,EAAE,MAAM,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB;IAAE,QAAQ,EAAE,MAAM,CAAA;CAAE,GACpB;IACE,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,CAAC,EAAE,eAAe,CAAC;IAC1B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB,CAAC;AAEN,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AA0CD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoCG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,YAAY,CAAS;IAC7B,OAAO,CAAC,gBAAgB,CAAqB;IAC7C,OAAO,CAAC,gBAAgB,CAAK;IAC7B,OAAO,CAAC,kBAAkB,CAAC,CAAS;IACpC,OAAO,CAAC,OAAO,CAAmB;IAElC;;;;;;;OAOG;gBACS,YAAY,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAc5D;;;;OAIG;YACW,uBAAuB;IA+BrC;;;;;;;OAOG;IACU,YAAY,CAAC,YAAY,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,CAAC;IAqBpE;;;OAGG;YACW,mBAAmB;IAgBjC;;OAEG;YACW,KAAK;IAgBnB,OAAO,CAAC,WAAW;IA4BnB,OAAO,CAAC,mBAAmB;IAuB3B,OAAO,CAAC,gBAAgB;YAiBV,YAAY;IAqE1B,OAAO,CAAC,yBAAyB;YAoBnB,KAAK;IAInB;;;;;OAKG;YACW,eAAe;IAyE7B;;;;;;;OAOG;IACU,WAAW,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAIjF;;;;;;;;OAQG;IACW,iBAAiB,CAC7B,MAAM,EAAE,iBAAiB,GACxB,cAAc,CAAC,kBAAkB,EAAE,IAAI,EAAE,SAAS,CAAC;IA4DtD;;;;;OAKG;IACU,6BAA6B,CACxC,MAAM,EAAE,0BAA0B,GACjC,OAAO,CAAC,qCAAqC,CAAC;IAcjD;;;;OAIG;IACU,6BAA6B,CACxC,MAAM,EAAE,YAAY,GACnB,OAAO,CAAC,qCAAqC,CAAC;IAQjD;;;;OAIG;IACU,OAAO,CAAC,MAAM,EAAE,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;IAIvE;;;;OAIG;IACU,UAAU,CAAC,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI1E;;;;;;OAMG;IACW,eAAe,CAC3B,MAAM,EAAE,YAAY,GACnB,cAAc,CAAC,kBAAkB,EAAE,IAAI,EAAE,SAAS,CAAC;IAyDtD;;;;;;;;OAQG;YACY,kBAAkB;IAoEjC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;CA2D7B"}