@artinet/sdk 0.5.2 → 0.5.4

package/dist/types/types/schemas/a2a/notification.d.ts

@@ -0,0 +1,87 @@
+import { JSONRPCErrorResponse, JSONRPCRequestWithParams, JSONRPCSuccessResponse } from "./rpc.js";
+import { TaskIdParams } from "./task.js";
+/**
+ * @description Information required for setting up push notifications.
+ * @required schemes
+ * @optional credentials
+ */
+export interface PushNotificationAuthenticationInfo {
+    /**
+     * @required Supported authentication schemes - e.g. Basic, Bearer */
+    schemes: string[];
+    /**
+     * @optional credentials
+     */
+    credentials?: string;
+}
+/**
+ * @description Configuration for setting up push notifications for task updates.
+ * @required url
+ * @optional token
+ * @optional authentication
+ */
+export interface PushNotificationConfig {
+    /**
+     * @optional Push Notification ID - created by server to support multiple callbacks.
+     */
+    id?: string;
+    /**
+     * @required The URL endpoint where the agent should send notifications.
+     */
+    url: string;
+    /**
+     * @optional A token to be included in push notification requests for verification/authentication.
+     */
+    token?: string;
+    /**
+     * @optional authentication details needed by the agent to call the notification URL.
+     */
+    authentication?: PushNotificationAuthenticationInfo;
+}
+/**
+ * @description Represents the push notification information associated with a specific task ID.
+ * Used as parameters for `tasks/pushNotificationConfig/set` and as a result type.
+ * @required taskId
+ * @required pushNotificationConfig
+ */
+export interface TaskPushNotificationConfig {
+    /**
+     * @required The ID of the task the notification config is associated with.
+     */
+    taskId: string;
+    /**
+     * @required The push notification configuration details.
+     */
+    pushNotificationConfig: PushNotificationConfig;
+}
+/**
+ * @description Request to set or update the push notification config for a task.
+ * @required TaskPushNotificationConfig
+ */
+export type SetTaskPushNotificationConfigRequest = JSONRPCRequestWithParams<"tasks/pushNotificationConfig/set", TaskPushNotificationConfig>;
+/**
+ * @description JSON-RPC success response model for the 'tasks/pushNotificationConfig/set' method.
+ * @required TaskPushNotificationConfig
+ */
+export type SetTaskPushNotificationConfigSuccessResponse = JSONRPCSuccessResponse<TaskPushNotificationConfig>;
+/**
+ * @description Response to a `tasks/pushNotificationConfig/set` request. Contains the confirmed TaskPushNotificationConfig or an error.
+ * @oneOf SetTaskPushNotificationConfigSuccessResponse | JSONRPCErrorResponse
+ */
+export type SetTaskPushNotificationConfigResponse = SetTaskPushNotificationConfigSuccessResponse | JSONRPCErrorResponse;
+/**
+ * @description Request to retrieve the currently configured push notification configuration for a task.
+ * @required TaskIdParams
+ */
+export type GetTaskPushNotificationConfigRequest = JSONRPCRequestWithParams<"tasks/pushNotificationConfig/get", TaskIdParams>;
+/**
+ * @description JSON-RPC success response model for the 'tasks/pushNotificationConfig/get' method.
+ * @required TaskPushNotificationConfig
+ */
+export type GetTaskPushNotificationConfigSuccessResponse = JSONRPCSuccessResponse<TaskPushNotificationConfig>;
+/**
+ * @description Response to a `tasks/pushNotificationConfig/get` request. Contains the TaskPushNotificationConfig or an error.
+ * @oneOf GetTaskPushNotificationConfigSuccessResponse | JSONRPCErrorResponse
+ */
+export type GetTaskPushNotificationConfigResponse = GetTaskPushNotificationConfigSuccessResponse | JSONRPCErrorResponse;
+//# sourceMappingURL=notification.d.ts.map

package/dist/types/types/schemas/a2a/notification.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"notification.d.ts","sourceRoot":"","sources":["../../../../../src/types/schemas/a2a/notification.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,oBAAoB,EACpB,wBAAwB,EACxB,sBAAsB,EACvB,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAC;AAEzC;;;;GAIG;AACH,MAAM,WAAW,kCAAkC;IACjD;yEACqE;IACrE,OAAO,EAAE,MAAM,EAAE,CAAC;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;GAKG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,cAAc,CAAC,EAAE,kCAAkC,CAAC;CACrD;AAED;;;;;GAKG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,sBAAsB,EAAE,sBAAsB,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG,wBAAwB,CACzE,kCAAkC,EAClC,0BAA0B,CAC3B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GACtD,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAC7C,4CAA4C,GAC5C,oBAAoB,CAAC;AAEzB;;;GAGG;AACH,MAAM,MAAM,oCAAoC,GAAG,wBAAwB,CACzE,kCAAkC,EAClC,YAAY,CACb,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,4CAA4C,GACtD,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,qCAAqC,GAC7C,4CAA4C,GAC5C,oBAAoB,CAAC"}

package/dist/types/types/schemas/a2a/parameters.d.ts

@@ -0,0 +1,188 @@
+/**
+ * @description Represents the base entity for FileParts
+ * @optional name
+ * @optional mimeType
+ */
+export interface FileBase {
+    /**
+     * @optional name of the file.
+     */
+    name?: string;
+    /**
+     * @optional MIME type of the file content.
+     */
+    mimeType?: string;
+}
+/**
+ * @description Represents a file with its content encoded as a Base64 string.
+ * @required bytes
+ * @optional uri
+ */
+export interface FileWithBytes extends FileBase {
+    /**
+     * @required File content encoded as a Base64 string. Use this OR `uri`.
+     */
+    bytes: string;
+    /**
+     * @optional URI pointing to the file content.
+     */
+    uri?: never;
+}
+/**
+ * @description Represents a file with its content encoded as a Base64 string.
+ * @required uri
+ * @optional bytes
+ */
+export interface FileWithUri extends FileBase {
+    /**
+     * @required URI pointing to the file content.
+     */
+    uri: string;
+    /**
+     * @optional File content encoded as a Base64 string. Use this OR `uri`.
+     */
+    bytes?: never;
+}
+/**
+ * @description Represents the base entity for Parts
+ * @optional metadata
+ */
+export interface PartBase {
+    /**
+     * @optional metadata associated with the part.
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * @description Represents a part of a message containing text content.
+ * @required kind
+ * @required text
+ */
+export interface TextPart extends PartBase {
+    /**
+     * @required Type identifier for this part.
+     */
+    kind: "text";
+    /**
+     * @required The text content.
+     */
+    text: string;
+}
+/**
+ * @description Represents a part of a message containing file content.
+ * @required kind
+ * @required file
+ */
+export interface FilePart extends PartBase {
+    /**
+     * @required Type identifier for this part.
+     */
+    kind: "file";
+    /**
+     * @required The file content, provided either inline or via URI.
+     */
+    file: FileWithBytes | FileWithUri;
+}
+/**
+ * @description Represents a part of a message containing structured data (JSON).
+ * @required kind
+ * @required data
+ */
+export interface DataPart extends PartBase {
+    /**
+     * @required Type identifier for this part.
+     */
+    kind: "data";
+    /**
+     * @required The structured data content as a JSON object.
+     */
+    data: Record<string, unknown>;
+}
+/**
+ * @description Represents a single part of a multi-part message. Can be text, file, or data.
+ */
+export type Part = TextPart | FilePart | DataPart;
+/**
+ * @description Represents an artifact generated or used by a task, potentially composed of multiple parts.
+ * @required artifactId
+ * @optional name
+ * @optional description
+ * @required parts
+ * @optional metadata
+ * @optional extensions
+ */
+export interface Artifact {
+    /**
+     * @required Unique identifier for the artifact.
+     */
+    artifactId: string;
+    /**
+     * @optional name for the artifact.
+     */
+    name?: string;
+    /**
+     * @optional description of the artifact.
+     */
+    description?: string;
+    /**
+     * @required The constituent parts of the artifact.
+     */
+    parts: Part[];
+    /**
+     * @optional metadata associated with the artifact.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * @optional The URIs of extensions that are present or contributed to this Artifact.
+     */
+    extension?: string;
+}
+/**
+ * @description Represents a message exchanged between a user and an agent.
+ * @required role
+ * @required parts
+ * @optional metadata
+ * @optional extensions
+ * @optional referenceTaskIds
+ * @optional messageId
+ * @optional taskId
+ */
+export interface Message {
+    /**
+     * @required The role of the sender (user or agent).
+     */
+    role: "user" | "agent";
+    /**
+     * @required The content of the message, composed of one or more parts.
+     */
+    parts: Part[];
+    /**
+     * @optional metadata associated with the message.
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * @optional The URIs of extensions that are present or contributed to this Message.
+     */
+    extensions?: string[];
+    /**
+     * @optional List of tasks referenced as context by this message.
+     */
+    referenceTaskIds?: string[];
+    /**
+     * @required Identifier created by the message creator
+     */
+    messageId: string;
+    /**
+     * @optional Identifier of task the message is related to
+     */
+    taskId?: string;
+    /**
+     * @optional The context the message is associated with
+     */
+    contextId?: string;
+    /**
+     * @required Event type
+     */
+    kind: "message";
+}
+//# sourceMappingURL=parameters.d.ts.map

package/dist/types/types/schemas/a2a/parameters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parameters.d.ts","sourceRoot":"","sources":["../../../../../src/types/schemas/a2a/parameters.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAc,SAAQ,QAAQ;IAC7C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,GAAG,CAAC,EAAE,KAAK,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,QAAQ;IAC3C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,aAAa,GAAG,WAAW,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,QAAS,SAAQ,QAAQ;IACxC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CAC/B;AAED;;GAEG;AACH,MAAM,MAAM,IAAI,GAAG,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,QAAQ;IACvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,OAAO;IACtB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IAEvB;;OAEG;IACH,KAAK,EAAE,IAAI,EAAE,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAEnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IAEtB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE5B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,SAAS,CAAC;CACjB"}