@a2a-js/sdk 0.2.1

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,422 @@
+# A2A JavaScript SDK
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+
+<!-- markdownlint-disable no-inline-html -->
+
+<html>
+   <h2 align="center">
+   <img src="https://raw.githubusercontent.com/google-a2a/A2A/refs/heads/main/docs/assets/a2a-logo-black.svg" width="256" alt="A2A Logo"/>
+   </h2>
+   <h3 align="center">A JavaScript library that helps run agentic applications as A2AServers following the <a href="https://google-a2a.github.io/A2A">Agent2Agent (A2A) Protocol</a>.</h3>
+</html>
+
+<!-- markdownlint-enable no-inline-html -->
+
+## Installation
+
+You can install the A2A SDK using either `npm`.
+
+```bash
+npm install @a2a-js/sdk
+```
+
+You can also find JavaScript samples [here](https://github.com/google-a2a/a2a-samples/tree/main/samples/js).
+
+## A2A Server
+
+This directory contains a TypeScript server implementation for the Agent-to-Agent (A2A) communication protocol, built using Express.js.
+
+### 1. Define Agent Card
+```typescript
+import { AgentCard } from "@a2a-js/sdk";
+
+const movieAgentCard: AgentCard = {
+  name: 'Movie Agent',
+  description: 'An agent that can answer questions about movies and actors using TMDB.',
+  // Adjust the base URL and port as needed.
+  url: 'http://localhost:41241/',
+  provider: {
+    organization: 'A2A Agents',
+    url: 'https://example.com/a2a-agents' // Added provider URL
+  },
+  version: '0.0.2', // Incremented version
+  capabilities: {
+    streaming: true, // Supports streaming
+    pushNotifications: false, // Assuming not implemented for this agent yet
+    stateTransitionHistory: true, // Agent uses history
+  },
+  securitySchemes: undefined, // Or define actual security schemes if any
+  security: undefined,
+  defaultInputModes: ['text/plain'],
+  defaultOutputModes: ['text/plain'],
+  skills: [
+    {
+      id: 'general_movie_chat',
+      name: 'General Movie Chat',
+      description: 'Answer general questions or chat about movies, actors, directors.',
+      tags: ['movies', 'actors', 'directors'],
+      examples: [
+        'Tell me about the plot of Inception.',
+        'Recommend a good sci-fi movie.',
+        'Who directed The Matrix?',
+        'What other movies has Scarlett Johansson been in?',
+        'Find action movies starring Keanu Reeves',
+        'Which came out first, Jurassic Park or Terminator 2?',
+      ],
+      inputModes: ['text/plain'], // Explicitly defining for skill
+      outputModes: ['text/plain'] // Explicitly defining for skill
+    },
+  ],
+  supportsAuthenticatedExtendedCard: false,
+};
+```
+
+### 2. Define Agent Executor
+```typescript
+import {
+  InMemoryTaskStore,
+  TaskStore,
+  A2AExpressApp,
+  AgentExecutor,
+  RequestContext,
+  ExecutionEventBus,
+  DefaultRequestHandler,
+} from "@a2a-js/sdk";
+
+// 1. Define your agent's logic as a AgentExecutor
+class MyAgentExecutor implements AgentExecutor {
+  private cancelledTasks = new Set<string>();
+
+  public cancelTask = async (
+        taskId: string,
+        eventBus: ExecutionEventBus,
+    ): Promise<void> => {
+        this.cancelledTasks.add(taskId);
+        // The execute loop is responsible for publishing the final state
+    };
+
+  async execute(
+    requestContext: RequestContext,
+    eventBus: ExecutionEventBus
+  ): Promise<void> {
+    const userMessage = requestContext.userMessage;
+    const existingTask = requestContext.task;
+
+    // Determine IDs for the task and context, from requestContext.
+    const taskId = requestContext.taskId;
+    const contextId = requestContext.contextId;
+
+    console.log(
+      `[MyAgentExecutor] Processing message ${userMessage.messageId} for task ${taskId} (context: ${contextId})`
+    );
+
+    // 1. Publish initial Task event if it's a new task
+    if (!existingTask) {
+      const initialTask: Task = {
+        kind: 'task',
+        id: taskId,
+        contextId: contextId,
+        status: {
+          state: 'submitted',
+          timestamp: new Date().toISOString(),
+        },
+        history: [userMessage],
+        metadata: userMessage.metadata,
+        artifacts: [], // Initialize artifacts array
+      };
+      eventBus.publish(initialTask);
+    }
+
+    // 2. Publish "working" status update
+    const workingStatusUpdate: TaskStatusUpdateEvent = {
+      kind: 'status-update',
+      taskId: taskId,
+      contextId: contextId,
+      status: {
+        state: 'working',
+        message: {
+          kind: 'message',
+          role: 'agent',
+          messageId: uuidv4(),
+          parts: [{ kind: 'text', text: 'Generating code...' }],
+          taskId: taskId,
+          contextId: contextId,
+        },
+        timestamp: new Date().toISOString(),
+      },
+      final: false,
+    };
+    eventBus.publish(workingStatusUpdate);
+
+    // Simulate work...
+    await new Promise((resolve) => setTimeout(resolve, 1000));
+
+    // Check for request cancellation
+    if (this.cancelledTasks.has(taskId)) {
+      console.log(`[MyAgentExecutor] Request cancelled for task: ${taskId}`);
+      const cancelledUpdate: TaskStatusUpdateEvent = {
+        kind: 'status-update',
+        taskId: taskId,
+        contextId: contextId,
+        status: {
+          state: 'canceled',
+          timestamp: new Date().toISOString(),
+        },
+        final: true,
+      };
+      eventBus.publish(cancelledUpdate);
+      eventBus.finished();
+      return;
+    }
+
+    // 3. Publish artifact update
+    const artifactUpdate: TaskArtifactUpdateEvent = {
+      kind: 'artifact-update',
+      taskId: taskId,
+      contextId: contextId,
+      artifact: {
+        artifactId: "artifact-1",
+        name: "artifact-1",
+        parts: [{ text: `Task ${context.task.id} completed.` }],
+      },
+      append: false, // Each emission is a complete file snapshot
+      lastChunk: true, // True for this file artifact
+    };
+    eventBus.publish(artifactUpdate);
+
+    // 4. Publish final status update
+    const finalUpdate: TaskStatusUpdateEvent = {
+      kind: 'status-update',
+      taskId: taskId,
+      contextId: contextId,
+      status: {
+        state: 'completed',
+        message: {
+          kind: 'message',
+          role: 'agent',
+          messageId: uuidv4(),
+          taskId: taskId,
+          contextId: contextId,
+        },
+        timestamp: new Date().toISOString(),
+      },
+      final: true,
+    };
+    eventBus.publish(finalUpdate);
+    eventBus.finished();
+  }
+}
+```
+
+### 3. Start the server
+```typescript
+const taskStore: TaskStore = new InMemoryTaskStore();
+const agentExecutor: AgentExecutor = new MyAgentExecutor();
+
+const requestHandler = new DefaultRequestHandler(
+  coderAgentCard,
+  taskStore,
+  agentExecutor
+);
+
+const appBuilder = new A2AExpressApp(requestHandler);
+const expressApp = appBuilder.setupRoutes(express(), '');
+
+const PORT = process.env.CODER_AGENT_PORT || 41242; // Different port for coder agent
+expressApp.listen(PORT, () => {
+  console.log(`[MyAgent] Server using new framework started on http://localhost:${PORT}`);
+  console.log(`[MyAgent] Agent Card: http://localhost:${PORT}/.well-known/agent.json`);
+  console.log('[MyAgent] Press Ctrl+C to stop the server');
+});
+```
+### Agent Executor
+Developers are expected to implement this interface and provide two methods: `execute` and `cancelTask`.
+
+#### `execute`
+- This method is provided with a `RequestContext` and an `EventBus` to publish execution events.
+- Executor can either respond by publishing a Message or Task.
+- For a task, check if there's an existing task in `RequestContext`. If not, publish an initial Task event using `taskId` & `contextId` from `RequestContext`.
+- Executor can subsequently publish `TaskStatusUpdateEvent` or `TaskArtifactUpdateEvent`.
+- Executor should indicate which is the `final` event and also call `finished()` method of event bus.
+- Executor should also check if an ongoing task has been cancelled. If yes, cancel the execution and emit an `TaskStatusUpdateEvent` with cancelled state.
+
+#### `cancelTask`
+Executors should implement cancellation mechanism for an ongoing task.
+
+## A2A Client 
+
+There's a `A2AClient` class, which provides methods for interacting with an A2A server over HTTP using JSON-RPC.
+
+### Key Features:
+
+- **JSON-RPC Communication:** Handles sending requests and receiving responses (both standard and streaming via Server-Sent Events) according to the JSON-RPC 2.0 specification.
+- **A2A Methods:** Implements standard A2A methods like `sendMessage`, `sendMessageStream`, `getTask`, `cancelTask`, `setTaskPushNotificationConfig`, `getTaskPushNotificationConfig`, and `resubscribeTask`.
+- **Error Handling:** Provides basic error handling for network issues and JSON-RPC errors.
+- **Streaming Support:** Manages Server-Sent Events (SSE) for real-time task updates (`sendMessageStream`, `resubscribeTask`).
+- **Extensibility:** Allows providing a custom `fetch` implementation for different environments (e.g., Node.js).
+
+### Basic Usage
+
+```typescript
+import {
+  A2AClient,
+  Message,
+  MessageSendParams,
+  Task,
+  TaskQueryParams,
+  SendMessageResponse,
+  GetTaskResponse,
+  SendMessageSuccessResponse,
+  GetTaskSuccessResponse
+} from "@a2a-js/sdk";
+import { v4 as uuidv4 } from "uuid";
+
+const client = new A2AClient("http://localhost:41241"); // Replace with your server URL
+
+async function run() {
+  const messageId = uuidv4();
+  let taskId: string | undefined;
+
+  try {
+    // 1. Send a message to the agent.
+    const sendParams: MessageSendParams = {
+      message: {
+        messageId: messageId,
+        role: "user",
+        parts: [{ kind: "text", text: "Hello, agent!" }],
+        kind: "message"
+      },
+      configuration: {
+        blocking: true,
+        acceptedOutputModes: ['text/plain']
+      }
+    };
+    
+    const sendResponse: SendMessageResponse = await client.sendMessage(sendParams);
+
+    if (sendResponse.error) {
+        console.error("Error sending message:", sendResponse.error);
+        return;
+    }
+
+    // On success, the result can be a Task or a Message. Check which one it is.
+    const result = (sendResponse as SendMessageSuccessResponse).result;
+
+    if (result.kind === 'task') {
+        // The agent created a task.
+        const taskResult = result as Task;
+        console.log("Send Message Result (Task):", taskResult);
+        taskId = taskResult.id; // Save the task ID for the next call
+    } else if (result.kind === 'message') {
+        // The agent responded with a direct message.
+        const messageResult = result as Message;
+        console.log("Send Message Result (Direct Message):", messageResult);
+        // No task was created, so we can't get task status.
+    }
+
+    // 2. If a task was created, get its status.
+    if (taskId) {
+        const getParams: TaskQueryParams = { id: taskId };
+        const getResponse: GetTaskResponse = await client.getTask(getParams);
+
+        if (getResponse.error) {
+            console.error(`Error getting task ${taskId}:`, getResponse.error);
+            return;
+        }
+        
+        const getTaskResult = (getResponse as GetTaskSuccessResponse).result;
+        console.log("Get Task Result:", getTaskResult);
+    }
+
+  } catch (error) {
+    console.error("A2A Client Communication Error:", error);
+  }
+}
+
+run();
+```
+
+### Streaming Usage
+
+```typescript
+import {
+  A2AClient,
+  TaskStatusUpdateEvent,
+  TaskArtifactUpdateEvent,
+  MessageSendParams,
+  Task,
+  Message,
+} from "@a2a-js/sdk";
+import { v4 as uuidv4 } from "uuid";
+
+const client = new A2AClient("http://localhost:41241");
+
+async function streamTask() {
+  const messageId = uuidv4();
+  try {
+    console.log(`\n--- Starting streaming task for message ${messageId} ---`);
+    
+    // Construct the `MessageSendParams` object.
+    const streamParams: MessageSendParams = {
+      message: {
+        messageId: messageId,
+        role: "user",
+        parts: [{ kind: "text", text: "Stream me some updates!" }],
+        kind: "message"
+      },
+    };
+    
+    // Use the `sendMessageStream` method.
+    const stream = client.sendMessageStream(streamParams);
+    let currentTaskId: string | undefined;
+
+    for await (const event of stream) {
+      // The first event is often the Task object itself, establishing the ID.
+      if ((event as Task).kind === 'task') {
+          currentTaskId = (event as Task).id;
+          console.log(`[${currentTaskId}] Task created. Status: ${(event as Task).status.state}`);
+          continue;
+      }
+      
+      // Differentiate subsequent stream events.
+      if ((event as TaskStatusUpdateEvent).kind === 'status-update') {
+        const statusEvent = event as TaskStatusUpdateEvent;
+        console.log(
+          `[${statusEvent.taskId}] Status Update: ${statusEvent.status.state} - ${
+            statusEvent.status.message?.parts[0]?.text ?? ""
+          }`
+        );
+        if (statusEvent.final) {
+          console.log(`[${statusEvent.taskId}] Stream marked as final.`);
+          break; // Exit loop when server signals completion
+        }
+      } else if ((event as TaskArtifactUpdateEvent).kind === 'artifact-update') {
+        const artifactEvent = event as TaskArtifactUpdateEvent;
+        // Use artifact.name or artifact.artifactId for identification
+        console.log(
+          `[${artifactEvent.taskId}] Artifact Update: ${
+            artifactEvent.artifact.name ?? artifactEvent.artifact.artifactId
+          } - Part Count: ${artifactEvent.artifact.parts.length}`
+        );
+      } else {
+        // This could be a direct Message response if the agent doesn't create a task.
+        console.log("Received direct message response in stream:", event);
+      }
+    }
+    console.log(`--- Streaming for message ${messageId} finished ---`);
+  } catch (error) {
+    console.error(`Error during streaming for message ${messageId}:`, error);
+  }
+}
+
+streamTask();
+```
+
+## License
+
+This project is licensed under the terms of the [Apache 2.0 License](https://raw.githubusercontent.com/google-a2a/a2a-python/refs/heads/main/LICENSE).
+
+## Contributing
+
+See [CONTRIBUTING.md](https://github.com/google-a2a/a2a-js/blob/main/CONTRIBUTING.md) for contribution guidelines.

package/build/src/a2a_response.d.ts

@@ -0,0 +1,5 @@
+import { SendMessageResponse, SendStreamingMessageResponse, GetTaskResponse, CancelTaskResponse, SetTaskPushNotificationConfigResponse, GetTaskPushNotificationConfigResponse, JSONRPCErrorResponse } from "./types.js";
+/**
+ * Represents any valid JSON-RPC response defined in the A2A protocol.
+ */
+export type A2AResponse = SendMessageResponse | SendStreamingMessageResponse | GetTaskResponse | CancelTaskResponse | SetTaskPushNotificationConfigResponse | GetTaskPushNotificationConfigResponse | JSONRPCErrorResponse;

package/build/src/a2a_response.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=a2a_response.js.map