naylence-agent-sdk-ts
naylence-agent-sdk-ts
Public API entrypoint for documentation generation.
This file exports only the curated public surface of the Naylence Agent SDK. It is used by TypeDoc to generate API reference documentation.
Enumerations
| Enumeration | Description |
|---|---|
| TaskState | - |
Classes
| Class | Description |
|---|---|
| A2AClientError | - |
| A2AClientHTTPError | - |
| A2AClientJSONError | - |
| Agent | Abstract base class for all agents. |
| AgentException | - |
| AgentProxy | Client-side proxy for communicating with remote agents. |
| AuthorizationException | - |
| BackgroundTaskAgent | Base class for agents that execute long-running background tasks. |
| BaseAgent | Standard implementation of the Agent protocol. |
| BaseAgentState | Base class for agent state with Pydantic-like serialization and validation. |
| ConflictException | - |
| ContentTypeNotSupportedError | - |
| DuplicateTaskException | - |
| InternalError | - |
| InvalidDataException | - |
| InvalidParamsError | - |
| InvalidRequestError | - |
| InvalidTaskException | - |
| JSONParseError | - |
| MethodNotFoundError | - |
| MissingAPIKeyError | - |
| NoDataFoundException | - |
| PushNotificationNotSupportedError | - |
| PushNotificationNotSupportedException | - |
| RateLimitExceededException | - |
| TaskNotCancelableError | - |
| TaskNotCancelableException | - |
| TaskNotFoundError | - |
| UnsupportedOperationError | - |
| UnsupportedOperationException | - |
Interfaces
| Interface | Description |
|---|---|
| AgentProxyConstructor | - |
| AgentRemoteOptions | Options for creating a remote agent proxy. |
| AgentRunManyOptions | Options for running tasks on multiple agents. |
| AgentServeOptions | Options for serving an agent at a given address. |
| BackgroundTaskAgentOptions | Configuration options for BackgroundTaskAgent. |
| BaseAgentOptions | Configuration options for BaseAgent. |
| TaskJSON | - |
| TaskStatusJSON | - |
Type Aliases
| Type Alias | Description |
|---|---|
| A2ARequest | - |
| AgentAuthentication | - |
| AgentCapabilities | - |
| AgentCard | - |
| AgentProvider | - |
| AgentSkill | - |
| Artifact | - |
| AuthenticationInfo | - |
| CancelTaskRequest | - |
| CancelTaskResponse | - |
| DataPart | - |
| FileContent | - |
| FilePart | - |
| GetAgentCardRequest | - |
| GetTaskPushNotificationRequest | - |
| GetTaskPushNotificationResponse | - |
| GetTaskRequest | - |
| GetTaskResponse | - |
| Message | - |
| Part | - |
| Payload | Payload type for agent task messages. |
| PushNotificationConfig | - |
| SendTaskRequest | - |
| SendTaskResponse | - |
| SendTaskStreamingRequest | - |
| SendTaskStreamingResponse | - |
| SetTaskPushNotificationRequest | - |
| SetTaskPushNotificationResponse | - |
| StopTaskStreamingRequest | - |
| Targets | Collection of address-payload pairs for broadcasting tasks to multiple agents. |
| Task | - |
| TaskArtifactUpdateEvent | - |
| TaskIdParams | - |
| TaskPushNotificationConfig | - |
| TaskQueryParams | - |
| TaskResubscriptionRequest | - |
| TaskSendParams | - |
| TaskStatus | - |
| TaskStatusUpdateEvent | - |
| TextPart | - |
Variables
A2ARequestSchema
const A2ARequestSchema: ZodDiscriminatedUnion<[ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/send">;
params: ZodType<{
acceptedOutputModes?: string[] | null;
historyLength?: number | null;
id: string;
message: {
metadata?: Metadata | null;
parts: (
| {
metadata?: ... | ... | ...;
text: string;
type: "text";
}
| {
file: {
bytes?: ...;
mimeType?: ...;
name?: ...;
uri?: ...;
};
metadata?: ... | ... | ...;
type: "file";
}
| {
data: Metadata;
metadata?: ... | ... | ...;
type: "data";
})[];
role: "user" | "agent";
};
metadata?: Metadata | null;
pushNotification?: | {
authentication?: | {
[key: string]: unknown;
credentials?: ... | ... | ...;
schemes: ...[];
}
| null;
token?: string | null;
url: string;
}
| null;
sessionId: string;
}, unknown, $ZodTypeInternals<{
acceptedOutputModes?: string[] | null;
historyLength?: number | null;
id: string;
message: {
metadata?: Metadata | null;
parts: (
| {
metadata?: ...;
text: ...;
type: ...;
}
| {
file: ...;
metadata?: ...;
type: ...;
}
| {
data: ...;
metadata?: ...;
type: ...;
})[];
role: "user" | "agent";
};
metadata?: Metadata | null;
pushNotification?: | {
authentication?: | {
[key: ...]: ...;
credentials?: ...;
schemes: ...;
}
| null;
token?: string | null;
url: string;
}
| null;
sessionId: string;
}, unknown>>;
}, $strip>, ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/get">;
params: ZodType<{
historyLength?: number | null;
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
historyLength?: number | null;
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>, ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/cancel">;
params: ZodType<{
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>], "method">;Defined in: src/naylence/agent/a2a-types.ts:355
AgentAuthenticationSchema
const AgentAuthenticationSchema: ZodObject<{
credentials: ZodOptional<ZodNullable<ZodString>>;
schemes: ZodArray<ZodString>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:506
AgentCapabilitiesSchema
const AgentCapabilitiesSchema: ZodObject<{
pushNotifications: ZodDefault<ZodBoolean>;
stateTransitionHistory: ZodDefault<ZodBoolean>;
streaming: ZodDefault<ZodBoolean>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:498
AgentCardSchema
const AgentCardSchema: ZodObject<{
authentication: ZodOptional<ZodNullable<ZodObject<{
credentials: ZodOptional<ZodNullable<ZodString>>;
schemes: ZodArray<ZodString>;
}, $strip>>>;
capabilities: ZodObject<{
pushNotifications: ZodDefault<ZodBoolean>;
stateTransitionHistory: ZodDefault<ZodBoolean>;
streaming: ZodDefault<ZodBoolean>;
}, $strip>;
defaultInputModes: ZodDefault<ZodArray<ZodString>>;
defaultOutputModes: ZodDefault<ZodArray<ZodString>>;
description: ZodOptional<ZodNullable<ZodString>>;
documentationUrl: ZodOptional<ZodNullable<ZodString>>;
name: ZodString;
provider: ZodOptional<ZodNullable<ZodObject<{
organization: ZodString;
url: ZodOptional<ZodNullable<ZodString>>;
}, $strip>>>;
skills: ZodArray<ZodObject<{
description: ZodOptional<ZodNullable<ZodString>>;
examples: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
id: ZodString;
inputModes: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
name: ZodString;
outputModes: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
tags: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
}, $strip>>;
url: ZodString;
version: ZodString;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:525
AgentProviderSchema
const AgentProviderSchema: ZodObject<{
organization: ZodString;
url: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:491
AgentSkillSchema
const AgentSkillSchema: ZodObject<{
description: ZodOptional<ZodNullable<ZodString>>;
examples: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
id: ZodString;
inputModes: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
name: ZodString;
outputModes: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
tags: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:513
ArtifactSchema
const ArtifactSchema: ZodObject<{
append: ZodOptional<ZodNullable<ZodBoolean>>;
description: ZodOptional<ZodNullable<ZodString>>;
index: ZodDefault<ZodNumber>;
lastChunk: ZodOptional<ZodNullable<ZodBoolean>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
name: ZodOptional<ZodNullable<ZodString>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
text: ZodString;
type: ZodLiteral<"text">;
}, $strip>, ZodObject<{
file: ZodObject<{
bytes: ZodOptional<ZodNullable<...>>;
mimeType: ZodOptional<ZodNullable<...>>;
name: ZodOptional<ZodNullable<...>>;
uri: ZodOptional<ZodNullable<...>>;
}, $strip>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
type: ZodLiteral<"file">;
}, $strip>, ZodObject<{
data: ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
type: ZodLiteral<"data">;
}, $strip>], "type">>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:133
AuthenticationInfoSchema
const AuthenticationInfoSchema: ZodObject<{
credentials: ZodOptional<ZodNullable<ZodString>>;
schemes: ZodArray<ZodString>;
}, $loose>;Defined in: src/naylence/agent/a2a-types.ts:173
CancelTaskRequestSchema
const CancelTaskRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/cancel">;
params: ZodType<{
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:238
CancelTaskResponseSchema
const CancelTaskResponseSchema: ZodObject<{
error: ZodOptional<ZodObject<{
code: ZodNumber;
data: ZodOptional<ZodAny>;
message: ZodString;
}, $strip>>;
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
result: ZodOptional<ZodNullable<ZodObject<{
artifacts: ZodOptional<ZodNullable<ZodArray<ZodObject<{
append: ...;
description: ...;
index: ...;
lastChunk: ...;
metadata: ...;
name: ...;
parts: ...;
}, $strip>>>>;
history: ZodOptional<ZodNullable<ZodArray<ZodObject<{
metadata: ...;
parts: ...;
role: ...;
}, $strip>>>>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
sessionId: ZodOptional<ZodNullable<ZodString>>;
status: ZodObject<{
message: ZodOptional<ZodNullable<ZodObject<..., ...>>>;
state: ZodEnum<typeof TaskState>;
timestamp: ZodDefault<ZodPipe<ZodTransform<..., ...>, ZodDate>>;
}, $strip>;
}, $strip>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:308
CLIENT_CONFIG
const CLIENT_CONFIG: {
node: {
admission: {
profile: "${env:FAME_ADMISSION_PROFILE:open}";
type: "AdmissionProfile";
};
delivery: {
profile: "${env:FAME_DELIVERY_PROFILE:at-most-once}";
type: "DeliveryProfile";
};
identity_policy: {
profile: "${env:FAME_NODE_IDENTITY_PROFILE:default}";
type: "NodeIdentityPolicyProfile";
};
security: {
profile: "${env:FAME_SECURITY_PROFILE:open}";
type: "SecurityProfile";
};
storage: {
profile: "${env:FAME_STORAGE_PROFILE:memory}";
type: "StorageProfile";
};
};
plugins: string[];
};Defined in: src/naylence/agent/configs.ts:54
Type Declaration
DataPartSchema
const DataPartSchema: ZodObject<{
data: ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
type: ZodLiteral<"data">;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:82
FileContentSchema
const FileContentSchema: ZodObject<{
bytes: ZodOptional<ZodNullable<ZodString>>;
mimeType: ZodOptional<ZodNullable<ZodString>>;
name: ZodOptional<ZodNullable<ZodString>>;
uri: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:34
FilePartSchema
const FilePartSchema: ZodObject<{
file: ZodObject<{
bytes: ZodOptional<ZodNullable<ZodString>>;
mimeType: ZodOptional<ZodNullable<ZodString>>;
name: ZodOptional<ZodNullable<ZodString>>;
uri: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
type: ZodLiteral<"file">;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:74
GetAgentCardRequestSchema
const GetAgentCardRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"agent.get_card">;
params: ZodDefault<ZodObject<{
}, $strip>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:283
GetTaskPushNotificationRequestSchema
const GetTaskPushNotificationRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/pushNotification/get">;
params: ZodType<{
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:251
GetTaskPushNotificationResponseSchema
const GetTaskPushNotificationResponseSchema: ZodObject<{
error: ZodOptional<ZodObject<{
code: ZodNumber;
data: ZodOptional<ZodAny>;
message: ZodString;
}, $strip>>;
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
result: ZodOptional<ZodNullable<ZodObject<{
id: ZodString;
pushNotificationConfig: ZodObject<{
authentication: ZodOptional<ZodNullable<ZodObject<..., ...>>>;
token: ZodOptional<ZodNullable<ZodString>>;
url: ZodString;
}, $strip>;
}, $strip>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:324
GetTaskRequestSchema
const GetTaskRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/get">;
params: ZodType<{
historyLength?: number | null;
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
historyLength?: number | null;
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:233
GetTaskResponseSchema
const GetTaskResponseSchema: ZodObject<{
error: ZodOptional<ZodObject<{
code: ZodNumber;
data: ZodOptional<ZodAny>;
message: ZodString;
}, $strip>>;
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
result: ZodOptional<ZodNullable<ZodObject<{
artifacts: ZodOptional<ZodNullable<ZodArray<ZodObject<{
append: ...;
description: ...;
index: ...;
lastChunk: ...;
metadata: ...;
name: ...;
parts: ...;
}, $strip>>>>;
history: ZodOptional<ZodNullable<ZodArray<ZodObject<{
metadata: ...;
parts: ...;
role: ...;
}, $strip>>>>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
sessionId: ZodOptional<ZodNullable<ZodString>>;
status: ZodObject<{
message: ZodOptional<ZodNullable<ZodObject<..., ...>>>;
state: ZodEnum<typeof TaskState>;
timestamp: ZodDefault<ZodPipe<ZodTransform<..., ...>, ZodDate>>;
}, $strip>;
}, $strip>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:301
MessageSchema
const MessageSchema: ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
text: ZodString;
type: ZodLiteral<"text">;
}, $strip>, ZodObject<{
file: ZodObject<{
bytes: ZodOptional<ZodNullable<...>>;
mimeType: ZodOptional<ZodNullable<...>>;
name: ZodOptional<ZodNullable<...>>;
uri: ZodOptional<ZodNullable<...>>;
}, $strip>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
type: ZodLiteral<"file">;
}, $strip>, ZodObject<{
data: ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
type: ZodLiteral<"data">;
}, $strip>], "type">>;
role: ZodUnion<readonly [ZodLiteral<"user">, ZodLiteral<"agent">]>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:98
NODE_CONFIG
const NODE_CONFIG: {
node: {
admission: {
profile: "${env:FAME_ADMISSION_PROFILE:open}";
type: "AdmissionProfile";
};
delivery: {
profile: "${env:FAME_DELIVERY_PROFILE:at-most-once}";
type: "DeliveryProfile";
};
id: "${env:FAME_NODE_ID:}";
identity_policy: {
profile: "${env:FAME_NODE_IDENTITY_PROFILE:default}";
type: "NodeIdentityPolicyProfile";
};
public_url: "${env:FAME_PUBLIC_URL:}";
requested_logicals: readonly ["fame.fabric"];
security: {
profile: "${env:FAME_SECURITY_PROFILE:open}";
type: "SecurityProfile";
};
storage: {
profile: "${env:FAME_STORAGE_PROFILE:memory}";
type: "StorageProfile";
};
type: "Node";
};
plugins: string[];
};Defined in: src/naylence/agent/configs.ts:80
Type Declaration
PartSchema
const PartSchema: ZodDiscriminatedUnion<[ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
text: ZodString;
type: ZodLiteral<"text">;
}, $strip>, ZodObject<{
file: ZodObject<{
bytes: ZodOptional<ZodNullable<ZodString>>;
mimeType: ZodOptional<ZodNullable<ZodString>>;
name: ZodOptional<ZodNullable<ZodString>>;
uri: ZodOptional<ZodNullable<ZodString>>;
}, $strip>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
type: ZodLiteral<"file">;
}, $strip>, ZodObject<{
data: ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
type: ZodLiteral<"data">;
}, $strip>], "type">;Defined in: src/naylence/agent/a2a-types.ts:90
PushNotificationConfigSchema
const PushNotificationConfigSchema: ZodObject<{
authentication: ZodOptional<ZodNullable<ZodObject<{
credentials: ZodOptional<ZodNullable<ZodString>>;
schemes: ZodArray<ZodString>;
}, $loose>>>;
token: ZodOptional<ZodNullable<ZodString>>;
url: ZodString;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:182
SendTaskRequestSchema
const SendTaskRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/send">;
params: ZodType<{
acceptedOutputModes?: string[] | null;
historyLength?: number | null;
id: string;
message: {
metadata?: Metadata | null;
parts: (
| {
metadata?: Metadata | null;
text: string;
type: "text";
}
| {
file: {
bytes?: string | null;
mimeType?: string | null;
name?: string | null;
uri?: string | null;
};
metadata?: Metadata | null;
type: "file";
}
| {
data: Metadata;
metadata?: Metadata | null;
type: "data";
})[];
role: "user" | "agent";
};
metadata?: Metadata | null;
pushNotification?: | {
authentication?: | {
[key: string]: unknown;
credentials?: string | null;
schemes: string[];
}
| null;
token?: string | null;
url: string;
}
| null;
sessionId: string;
}, unknown, $ZodTypeInternals<{
acceptedOutputModes?: string[] | null;
historyLength?: number | null;
id: string;
message: {
metadata?: Metadata | null;
parts: (
| {
metadata?: Metadata | null;
text: string;
type: "text";
}
| {
file: {
bytes?: ... | ... | ...;
mimeType?: ... | ... | ...;
name?: ... | ... | ...;
uri?: ... | ... | ...;
};
metadata?: Metadata | null;
type: "file";
}
| {
data: Metadata;
metadata?: Metadata | null;
type: "data";
})[];
role: "user" | "agent";
};
metadata?: Metadata | null;
pushNotification?: | {
authentication?: | {
[key: string]: unknown;
credentials?: string | null;
schemes: string[];
}
| null;
token?: string | null;
url: string;
}
| null;
sessionId: string;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:228
SendTaskResponseSchema
const SendTaskResponseSchema: ZodObject<{
error: ZodOptional<ZodObject<{
code: ZodNumber;
data: ZodOptional<ZodAny>;
message: ZodString;
}, $strip>>;
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
result: ZodOptional<ZodNullable<ZodObject<{
artifacts: ZodOptional<ZodNullable<ZodArray<ZodObject<{
append: ...;
description: ...;
index: ...;
lastChunk: ...;
metadata: ...;
name: ...;
parts: ...;
}, $strip>>>>;
history: ZodOptional<ZodNullable<ZodArray<ZodObject<{
metadata: ...;
parts: ...;
role: ...;
}, $strip>>>>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
sessionId: ZodOptional<ZodNullable<ZodString>>;
status: ZodObject<{
message: ZodOptional<ZodNullable<ZodObject<..., ...>>>;
state: ZodEnum<typeof TaskState>;
timestamp: ZodDefault<ZodPipe<ZodTransform<..., ...>, ZodDate>>;
}, $strip>;
}, $strip>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:294
SendTaskStreamingRequestSchema
const SendTaskStreamingRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/sendSubscribe">;
params: ZodType<{
acceptedOutputModes?: string[] | null;
historyLength?: number | null;
id: string;
message: {
metadata?: Metadata | null;
parts: (
| {
metadata?: Metadata | null;
text: string;
type: "text";
}
| {
file: {
bytes?: string | null;
mimeType?: string | null;
name?: string | null;
uri?: string | null;
};
metadata?: Metadata | null;
type: "file";
}
| {
data: Metadata;
metadata?: Metadata | null;
type: "data";
})[];
role: "user" | "agent";
};
metadata?: Metadata | null;
pushNotification?: | {
authentication?: | {
[key: string]: unknown;
credentials?: string | null;
schemes: string[];
}
| null;
token?: string | null;
url: string;
}
| null;
sessionId: string;
}, unknown, $ZodTypeInternals<{
acceptedOutputModes?: string[] | null;
historyLength?: number | null;
id: string;
message: {
metadata?: Metadata | null;
parts: (
| {
metadata?: Metadata | null;
text: string;
type: "text";
}
| {
file: {
bytes?: ... | ... | ...;
mimeType?: ... | ... | ...;
name?: ... | ... | ...;
uri?: ... | ... | ...;
};
metadata?: Metadata | null;
type: "file";
}
| {
data: Metadata;
metadata?: Metadata | null;
type: "data";
})[];
role: "user" | "agent";
};
metadata?: Metadata | null;
pushNotification?: | {
authentication?: | {
[key: string]: unknown;
credentials?: string | null;
schemes: string[];
}
| null;
token?: string | null;
url: string;
}
| null;
sessionId: string;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:267
SendTaskStreamingResponseSchema
const SendTaskStreamingResponseSchema: ZodObject<{
error: ZodOptional<ZodObject<{
code: ZodNumber;
data: ZodOptional<ZodAny>;
message: ZodString;
}, $strip>>;
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
result: ZodOptional<ZodNullable<ZodUnion<readonly [ZodObject<{
final: ZodDefault<ZodBoolean>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<..., ..., ...>>>;
status: ZodObject<{
message: ZodOptional<...>;
state: ZodEnum<...>;
timestamp: ZodDefault<...>;
}, $strip>;
}, $strip>, ZodObject<{
artifact: ZodObject<{
append: ZodOptional<...>;
description: ZodOptional<...>;
index: ZodDefault<...>;
lastChunk: ZodOptional<...>;
metadata: ZodOptional<...>;
name: ZodOptional<...>;
parts: ZodArray<...>;
}, $strip>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<..., ..., ...>>>;
}, $strip>]>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:336
SENTINEL_CONFIG
const SENTINEL_CONFIG: {
node: {
admission: {
profile: "${env:FAME_ADMISSION_PROFILE:none}";
type: "AdmissionProfile";
};
delivery: {
profile: "${env:FAME_DELIVERY_PROFILE:at-most-once}";
type: "DeliveryProfile";
};
id: "${env:FAME_NODE_ID:}";
identity_policy: {
profile: "${env:FAME_NODE_IDENTITY_PROFILE:default}";
type: "NodeIdentityPolicyProfile";
};
listeners: readonly [{
port: 8000;
type: "HttpListener";
}, {
port: 8000;
type: "WebSocketListener";
}];
public_url: "${env:FAME_PUBLIC_URL:}";
requested_logicals: readonly ["fame.fabric"];
security: {
profile: "${env:FAME_SECURITY_PROFILE:open}";
type: "SecurityProfile";
};
storage: {
profile: "${env:FAME_STORAGE_PROFILE:memory}";
type: "StorageProfile";
};
type: "Sentinel";
};
plugins: string[];
};Defined in: src/naylence/agent/configs.ts:110
Type Declaration
SENTINEL_PORT
const SENTINEL_PORT: 8000 = 8000;Defined in: src/naylence/agent/configs.ts:1
SetTaskPushNotificationRequestSchema
const SetTaskPushNotificationRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/pushNotification/set">;
params: ZodType<{
id: string;
pushNotificationConfig: {
authentication?: | {
[key: string]: unknown;
credentials?: string | null;
schemes: string[];
}
| null;
token?: string | null;
url: string;
};
}, unknown, $ZodTypeInternals<{
id: string;
pushNotificationConfig: {
authentication?: | {
[key: string]: unknown;
credentials?: string | null;
schemes: string[];
}
| null;
token?: string | null;
url: string;
};
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:243
SetTaskPushNotificationResponseSchema
const SetTaskPushNotificationResponseSchema: ZodObject<{
error: ZodOptional<ZodObject<{
code: ZodNumber;
data: ZodOptional<ZodAny>;
message: ZodString;
}, $strip>>;
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
result: ZodOptional<ZodNullable<ZodObject<{
id: ZodString;
pushNotificationConfig: ZodObject<{
authentication: ZodOptional<ZodNullable<ZodObject<..., ...>>>;
token: ZodOptional<ZodNullable<ZodString>>;
url: ZodString;
}, $strip>;
}, $strip>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:317
StopTaskStreamingRequestSchema
const StopTaskStreamingRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/sendUnsubscribe">;
params: ZodType<{
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:275
TaskArtifactUpdateEventSchema
const TaskArtifactUpdateEventSchema: ZodObject<{
artifact: ZodObject<{
append: ZodOptional<ZodNullable<ZodBoolean>>;
description: ZodOptional<ZodNullable<ZodString>>;
index: ZodDefault<ZodNumber>;
lastChunk: ZodOptional<ZodNullable<ZodBoolean>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
name: ZodOptional<ZodNullable<ZodString>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<{
metadata: ZodOptional<ZodNullable<...>>;
text: ZodString;
type: ZodLiteral<"text">;
}, $strip>, ZodObject<{
file: ZodObject<{
bytes: ...;
mimeType: ...;
name: ...;
uri: ...;
}, $strip>;
metadata: ZodOptional<ZodNullable<...>>;
type: ZodLiteral<"file">;
}, $strip>, ZodObject<{
data: ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>;
metadata: ZodOptional<ZodNullable<...>>;
type: ZodLiteral<"data">;
}, $strip>], "type">>;
}, $strip>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:165
TaskIdParamsSchema
const TaskIdParamsSchema: ZodObject<{
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:190
TaskPushNotificationConfigSchema
const TaskPushNotificationConfigSchema: ZodObject<{
id: ZodString;
pushNotificationConfig: ZodObject<{
authentication: ZodOptional<ZodNullable<ZodObject<{
credentials: ZodOptional<ZodNullable<ZodString>>;
schemes: ZodArray<ZodString>;
}, $loose>>>;
token: ZodOptional<ZodNullable<ZodString>>;
url: ZodString;
}, $strip>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:215
TaskQueryParamsSchema
const TaskQueryParamsSchema: ZodObject<{
historyLength: ZodNullable<ZodOptional<ZodNumber>>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:197
TaskResubscriptionRequestSchema
const TaskResubscriptionRequestSchema: ZodObject<{
id: ZodDefault<ZodUnion<readonly [ZodNumber, ZodString, ZodNull]>>;
jsonrpc: ZodDefault<ZodLiteral<"2.0">>;
method: ZodLiteral<"tasks/resubscribe">;
params: ZodType<{
id: string;
metadata?: Metadata | null;
}, unknown, $ZodTypeInternals<{
id: string;
metadata?: Metadata | null;
}, unknown>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:259
TaskSchema
const TaskSchema: ZodObject<{
artifacts: ZodOptional<ZodNullable<ZodArray<ZodObject<{
append: ZodOptional<ZodNullable<ZodBoolean>>;
description: ZodOptional<ZodNullable<ZodString>>;
index: ZodDefault<ZodNumber>;
lastChunk: ZodOptional<ZodNullable<ZodBoolean>>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
name: ZodOptional<ZodNullable<ZodString>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<..., ...>, ZodObject<..., ...>, ZodObject<..., ...>], "type">>;
}, $strip>>>>;
history: ZodOptional<ZodNullable<ZodArray<ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<..., ...>, ZodObject<..., ...>, ZodObject<..., ...>], "type">>;
role: ZodUnion<readonly [ZodLiteral<"user">, ZodLiteral<"agent">]>;
}, $strip>>>>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
sessionId: ZodOptional<ZodNullable<ZodString>>;
status: ZodObject<{
message: ZodOptional<ZodNullable<ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<..., ..., ...>>>;
parts: ZodArray<ZodDiscriminatedUnion<[..., ..., ...], "type">>;
role: ZodUnion<readonly [ZodLiteral<...>, ZodLiteral<...>]>;
}, $strip>>>;
state: ZodEnum<typeof TaskState>;
timestamp: ZodDefault<ZodPipe<ZodTransform<{
}, unknown>, ZodDate>>;
}, $strip>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:145
TaskSendParamsSchema
const TaskSendParamsSchema: ZodObject<{
acceptedOutputModes: ZodOptional<ZodNullable<ZodArray<ZodString>>>;
historyLength: ZodNullable<ZodOptional<ZodNumber>>;
id: ZodString;
message: ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<{
metadata: ZodOptional<ZodNullable<...>>;
text: ZodString;
type: ZodLiteral<"text">;
}, $strip>, ZodObject<{
file: ZodObject<{
bytes: ...;
mimeType: ...;
name: ...;
uri: ...;
}, $strip>;
metadata: ZodOptional<ZodNullable<...>>;
type: ZodLiteral<"file">;
}, $strip>, ZodObject<{
data: ZodType<Metadata, unknown, $ZodTypeInternals<..., ...>>;
metadata: ZodOptional<ZodNullable<...>>;
type: ZodLiteral<"data">;
}, $strip>], "type">>;
role: ZodUnion<readonly [ZodLiteral<"user">, ZodLiteral<"agent">]>;
}, $strip>;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
pushNotification: ZodOptional<ZodNullable<ZodObject<{
authentication: ZodOptional<ZodNullable<ZodObject<{
credentials: ZodOptional<...>;
schemes: ZodArray<...>;
}, $loose>>>;
token: ZodOptional<ZodNullable<ZodString>>;
url: ZodString;
}, $strip>>>;
sessionId: ZodDefault<ZodString>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:203
TaskStatusSchema
const TaskStatusSchema: ZodObject<{
message: ZodOptional<ZodNullable<ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
parts: ZodArray<ZodDiscriminatedUnion<[ZodObject<{
metadata: ...;
text: ...;
type: ...;
}, $strip>, ZodObject<{
file: ...;
metadata: ...;
type: ...;
}, $strip>, ZodObject<{
data: ...;
metadata: ...;
type: ...;
}, $strip>], "type">>;
role: ZodUnion<readonly [ZodLiteral<"user">, ZodLiteral<"agent">]>;
}, $strip>>>;
state: ZodEnum<typeof TaskState>;
timestamp: ZodDefault<ZodPipe<ZodTransform<{
}, unknown>, ZodDate>>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:125
TaskStatusUpdateEventSchema
const TaskStatusUpdateEventSchema: ZodObject<{
final: ZodDefault<ZodBoolean>;
id: ZodString;
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
status: ZodObject<{
message: ZodOptional<ZodNullable<ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<..., ..., ...>>>;
parts: ZodArray<ZodDiscriminatedUnion<[..., ..., ...], "type">>;
role: ZodUnion<readonly [ZodLiteral<...>, ZodLiteral<...>]>;
}, $strip>>>;
state: ZodEnum<typeof TaskState>;
timestamp: ZodDefault<ZodPipe<ZodTransform<{
}, unknown>, ZodDate>>;
}, $strip>;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:156
TERMINAL_TASK_STATES
const TERMINAL_TASK_STATES: Set<TaskState>;Defined in: src/naylence/agent/task-states.ts:3
TextPartSchema
const TextPartSchema: ZodObject<{
metadata: ZodOptional<ZodNullable<ZodType<Metadata, unknown, $ZodTypeInternals<Metadata, unknown>>>>;
text: ZodString;
type: ZodLiteral<"text">;
}, $strip>;Defined in: src/naylence/agent/a2a-types.ts:26
Functions
| Function | Description |
|---|---|
| parseA2ARequest | - |
| registerAgentProxyFactory | - |
| safeParseA2ARequest | - |
| serializeTask | - |
| serializeTaskStatus | - |