@artinet/sdk 0.5.17 → 0.5.18

package/dist/browser/types/schemas/a2a/protocol.js

@@ -0,0 +1,59 @@
+/**
+ * Copyright 2025 The Artinet Project
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { z } from "zod";
+import { SendMessageRequestSchema, SendMessageResponseSchema, SendStreamingMessageRequestSchema, SendStreamingMessageResponseSchema, } from "./message.js";
+import { GetTaskRequestSchema, GetTaskResponseSchema, CancelTaskRequestSchema, CancelTaskResponseSchema, TaskResubscriptionRequestSchema, } from "./task.js";
+import { SetTaskPushNotificationConfigRequestSchema, SetTaskPushNotificationConfigResponseSchema, GetTaskPushNotificationConfigRequestSchema, GetTaskPushNotificationConfigResponseSchema, DeleteTaskPushNotificationConfigRequestSchema, ListTaskPushNotificationConfigRequestSchema, DeleteTaskPushNotificationConfigResponseSchema, ListTaskPushNotificationConfigResponseSchema, } from "./notification.js";
+import { GetAuthenticatedExtendedCardRequestSchema, GetAuthenticatedExtendedCardResponseSchema, } from "./agent.js";
+import { JSONRPCSuccessResponseSchema, JSONRPCErrorResponseSchema, } from "./rpc.js";
+/**
+ * @description Union of all valid A2A request types defined in the protocol.
+ * @description Represents any valid JSON-RPC request defined in the A2A protocol.
+ */
+export const A2ARequestSchema = z.union([
+    SendMessageRequestSchema,
+    SendStreamingMessageRequestSchema,
+    TaskResubscriptionRequestSchema,
+    GetTaskRequestSchema,
+    CancelTaskRequestSchema,
+    SetTaskPushNotificationConfigRequestSchema,
+    GetTaskPushNotificationConfigRequestSchema,
+    ListTaskPushNotificationConfigRequestSchema,
+    DeleteTaskPushNotificationConfigRequestSchema,
+    GetAuthenticatedExtendedCardRequestSchema,
+]);
+/**
+ * @description Union of all valid A2A response types defined in the protocol.
+ * @description Represents any valid JSON-RPC response defined in the A2A protocol.
+ * (This is a helper type, not explicitly defined with `oneOf` in the spec like A2ARequest, but useful).
+ */
+export const A2AResponseSchema = z.union([
+    SendMessageResponseSchema,
+    SendStreamingMessageResponseSchema,
+    GetTaskResponseSchema,
+    CancelTaskResponseSchema,
+    SetTaskPushNotificationConfigResponseSchema,
+    GetTaskPushNotificationConfigResponseSchema,
+    ListTaskPushNotificationConfigResponseSchema,
+    DeleteTaskPushNotificationConfigResponseSchema,
+    GetAuthenticatedExtendedCardResponseSchema,
+]);
+/**
+ * @description Represents a JSON-RPC response object.
+ */
+export const JSONRPCResponseSchema = z
+    .union([
+    A2AResponseSchema,
+    JSONRPCSuccessResponseSchema.extend({
+        result: z.any(),
+    }),
+    JSONRPCErrorResponseSchema.extend({
+        error: z.any(),
+    }),
+])
+    .describe("Represents a JSON-RPC response object.");
+// // Re-export A2AError from error.js for convenience
+// export { A2AErrorSchema } from "./error.js";
+// export type { A2AError } from "./error.js";

package/dist/browser/types/schemas/a2a/rpc.d.ts

@@ -0,0 +1,182 @@
+/**
+ * Copyright 2025 The Artinet Project
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { z } from "zod";
+/**
+ * @description Base interface for all JSON-RPC messages (Requests and Responses).
+ */
+export declare const JSONRPCMessageSchema: z.ZodObject<{
+    /**
+     * @required Specifies the JSON-RPC version. Must be "2.0".
+     * @default "2.0"
+     * @const "2.0"
+     */
+    jsonrpc: z.ZodLiteral<"2.0">;
+    /**
+     * @optional An identifier established by the Client that MUST contain a String, Number.
+     * @description Can be a string, number. Responses must have the same ID as the request they relate to.
+     * Notifications (requests without an expected response) should omit the ID.
+     */
+    id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+}, "strip", z.ZodTypeAny, {
+    jsonrpc: "2.0";
+    id?: string | number | undefined;
+}, {
+    jsonrpc: "2.0";
+    id?: string | number | undefined;
+}>;
+export type JSONRPCMessage = z.infer<typeof JSONRPCMessageSchema>;
+/**
+ * @description Represents a JSON-RPC request object base structure.
+ */
+export declare const JSONRPCRequestSchema: z.ZodObject<{
+    jsonrpc: z.ZodLiteral<"2.0">;
+} & {
+    id: z.ZodUnion<[z.ZodString, z.ZodNumber]>;
+    method: z.ZodString;
+    params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+}, "strip", z.ZodTypeAny, {
+    jsonrpc: "2.0";
+    id: string | number;
+    method: string;
+    params?: Record<string, unknown> | undefined;
+}, {
+    jsonrpc: "2.0";
+    id: string | number;
+    method: string;
+    params?: Record<string, unknown> | undefined;
+}>;
+export type JSONRPCRequest = z.infer<typeof JSONRPCRequestSchema>;
+/**
+ * @description Represents a JSON-RPC 2.0 Error object, included in an error response.
+ */
+export declare const JSONRPCErrorSchema: z.ZodObject<{
+    /**
+     * @required A number indicating the error type that occurred.
+     */
+    code: z.ZodNumber;
+    /**
+     * @required A string providing a short description of the error.
+     */
+    message: z.ZodString;
+    /**
+     * @optional A Primitive or Structured value that contains additional information about the error.
+     */
+    data: z.ZodOptional<z.ZodUnknown>;
+}, "strip", z.ZodTypeAny, {
+    message: string;
+    code: number;
+    data?: unknown;
+}, {
+    message: string;
+    code: number;
+    data?: unknown;
+}>;
+export type JSONRPCError = z.infer<typeof JSONRPCErrorSchema>;
+/**
+ * @description Represents a JSON-RPC 2.0 Success Response object.
+ */
+export declare const JSONRPCSuccessResponseSchema: z.ZodObject<{
+    /**
+     * @required Specifies the JSON-RPC version. Must be "2.0".
+     * @default "2.0"
+     * @const "2.0"
+     */
+    jsonrpc: z.ZodLiteral<"2.0">;
+    /**
+     * @optional An identifier established by the Client that MUST contain a String, Number.
+     * @description Can be a string, number. Responses must have the same ID as the request they relate to.
+     * Notifications (requests without an expected response) should omit the ID.
+     */
+    id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+} & {
+    /**
+     * @required The result object on success
+     * @description The value of this member is determined by the method invoked on the Server.
+     */
+    result: z.ZodUnknown;
+    /**
+     * @optional The error object on failure
+     * @description Optional 'never' helps enforce exclusivity
+     */
+    error: z.ZodOptional<z.ZodNever>;
+}, "strip", z.ZodTypeAny, {
+    jsonrpc: "2.0";
+    id?: string | number | undefined;
+    result?: unknown;
+    error?: undefined;
+}, {
+    jsonrpc: "2.0";
+    id?: string | number | undefined;
+    result?: unknown;
+    error?: undefined;
+}>;
+export type JSONRPCSuccessResponse = z.infer<typeof JSONRPCSuccessResponseSchema>;
+/**
+ * @description Represents a JSON-RPC 2.0 Error Response object.
+ */
+export declare const JSONRPCErrorResponseSchema: z.ZodObject<{
+    /**
+     * @required Specifies the JSON-RPC version. Must be "2.0".
+     * @default "2.0"
+     * @const "2.0"
+     */
+    jsonrpc: z.ZodLiteral<"2.0">;
+    /**
+     * @optional An identifier established by the Client that MUST contain a String, Number.
+     * @description Can be a string, number. Responses must have the same ID as the request they relate to.
+     * Notifications (requests without an expected response) should omit the ID.
+     */
+    id: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
+} & {
+    /**
+     * @optional The result object on success
+     * @description Optional 'never' helps enforce exclusivity
+     */
+    result: z.ZodOptional<z.ZodNever>;
+    /**
+     * @required The result object on failure
+     */
+    error: z.ZodObject<{
+        /**
+         * @required A number indicating the error type that occurred.
+         */
+        code: z.ZodNumber;
+        /**
+         * @required A string providing a short description of the error.
+         */
+        message: z.ZodString;
+        /**
+         * @optional A Primitive or Structured value that contains additional information about the error.
+         */
+        data: z.ZodOptional<z.ZodUnknown>;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        code: number;
+        data?: unknown;
+    }, {
+        message: string;
+        code: number;
+        data?: unknown;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    jsonrpc: "2.0";
+    error: {
+        message: string;
+        code: number;
+        data?: unknown;
+    };
+    id?: string | number | undefined;
+    result?: undefined;
+}, {
+    jsonrpc: "2.0";
+    error: {
+        message: string;
+        code: number;
+        data?: unknown;
+    };
+    id?: string | number | undefined;
+    result?: undefined;
+}>;
+export type JSONRPCErrorResponse = z.infer<typeof JSONRPCErrorResponseSchema>;

package/dist/browser/types/schemas/a2a/rpc.js

@@ -0,0 +1,126 @@
+/**
+ * Copyright 2025 The Artinet Project
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import { z } from "zod";
+/**
+ * @description Base interface for all JSON-RPC messages (Requests and Responses).
+ */
+export const JSONRPCMessageSchema = z
+    .object({
+    /**
+     * @required Specifies the JSON-RPC version. Must be "2.0".
+     * @default "2.0"
+     * @const "2.0"
+     */
+    jsonrpc: z
+        .literal("2.0")
+        .describe("Specifies the JSON-RPC version. Must be '2.0'."),
+    /**
+     * @optional An identifier established by the Client that MUST contain a String, Number.
+     * @description Can be a string, number. Responses must have the same ID as the request they relate to.
+     * Notifications (requests without an expected response) should omit the ID.
+     */
+    id: z
+        .union([z.string(), z.number()])
+        .optional()
+        .describe("An identifier established by the Client that MUST contain a String, Number. Responses must have the same ID as the request they relate to. Notifications (requests without an expected response) should omit the ID."),
+})
+    .describe("Base interface for all JSON-RPC messages (Requests and Responses).");
+/**
+ * @description Represents a JSON-RPC request object base structure.
+ */
+export const JSONRPCRequestSchema = JSONRPCMessageSchema.extend({
+    /**
+     * @required Request identifier.
+     */
+    id: z
+        .union([z.string(), z.number()])
+        .describe("Request identifier. Must be a String, Number, or NULL. The value MUST remain the same throughout the request."),
+    /**
+     * @required A string containing the name of the method to be invoked.
+     */
+    method: z
+        .string()
+        .describe("A String containing the name of the method to be invoked. Method names that begin with the word rpc are reserved and MUST NOT be used."),
+    /**
+     * @optional Parameters for the method. Can be a structured object, an array, or omitted.
+     * @description A Structured value that holds the parameter values to be used during the invocation of the method.
+     */
+    params: z
+        .record(z.string(), z.unknown())
+        .optional()
+        .describe("A Structured value that holds the parameter values to be used during the invocation of the method."),
+}).describe("Represents a JSON-RPC request object base structure.");
+// /**
+//  * @description Represents a JSON-RPC request object with parameters.
+//  */
+// export const JSONRPCRequestWithParamsSchema = JSONRPCRequestSchema.extend({
+//   params: z.unknown(),
+// });
+// export type JSONRPCRequestWithParams = z.infer<
+//   typeof JSONRPCRequestWithParamsSchema
+// >;
+/**
+ * @description Represents a JSON-RPC 2.0 Error object, included in an error response.
+ */
+export const JSONRPCErrorSchema = z
+    .object({
+    /**
+     * @required A number indicating the error type that occurred.
+     */
+    code: z
+        .number()
+        .describe("A Number indicating the error type that occurred. This MUST be an integer."),
+    /**
+     * @required A string providing a short description of the error.
+     */
+    message: z
+        .string()
+        .describe("A String providing a short description of the error. The message SHOULD be limited to a concise single sentence."),
+    /**
+     * @optional A Primitive or Structured value that contains additional information about the error.
+     */
+    data: z
+        .unknown()
+        .optional()
+        .describe("A Primitive or Structured value that contains additional information about the error."),
+})
+    .describe("Represents a JSON-RPC 2.0 Error object, included in an error response.");
+/**
+ * @description Represents a JSON-RPC 2.0 Success Response object.
+ */
+export const JSONRPCSuccessResponseSchema = JSONRPCMessageSchema.extend({
+    /**
+     * @required The result object on success
+     * @description The value of this member is determined by the method invoked on the Server.
+     */
+    result: z
+        .unknown()
+        .describe("The value of this member is determined by the method invoked on the Server."),
+    /**
+     * @optional The error object on failure
+     * @description Optional 'never' helps enforce exclusivity
+     */
+    error: z
+        .never()
+        .optional()
+        .describe("Optional 'never' helps enforce exclusivity"),
+}).describe("Represents a JSON-RPC 2.0 Success Response object.");
+/**
+ * @description Represents a JSON-RPC 2.0 Error Response object.
+ */
+export const JSONRPCErrorResponseSchema = JSONRPCMessageSchema.extend({
+    /**
+     * @optional The result object on success
+     * @description Optional 'never' helps enforce exclusivity
+     */
+    result: z
+        .never()
+        .optional()
+        .describe("Optional 'never' helps enforce exclusivity"),
+    /**
+     * @required The result object on failure
+     */
+    error: JSONRPCErrorSchema.extend({}).describe("Represents a JSON-RPC 2.0 Error Response object."),
+}).describe("Represents a JSON-RPC 2.0 Error Response object.");