@artinet/sdk
Version:
A TypeScript SDK for building collaborative AI agents.
48 lines (47 loc) • 1.42 kB
TypeScript
/**
* Copyright 2025 The Artinet Project
* SPDX-License-Identifier: Apache-2.0
*/
import { A2A } from "../types/index.js";
export type AgentCardParams = (Partial<A2A.AgentCard> & Required<Pick<A2A.AgentCard, "name">>) | string;
export declare const isAgentCardParams: (params: any) => params is AgentCardParams;
export declare class AgentCard {
private readonly _agentCard;
constructor(params: Partial<A2A.AgentCard> & Required<Pick<A2A.AgentCard, "name">>);
get agentCard(): A2A.AgentCard;
static create(params: AgentCardParams): A2A.AgentCard;
}
/**
* @deprecated Use {@link card} instead
* @since 0.6.0
*/
export declare const AgentCardBuilder: typeof AgentCard;
/**
* Convenience factory function for creating an {@link A2A.AgentCard} with default parameters.
*
* @returns New {@link A2A.AgentCard} with default parameters
* @defaults {
* description: "An agent that can use the A2A protocol.",
* url: "https://localhost:3000/a2a",
* version: "0.0.0",
* capabilities: {},
* defaultInputModes: [],
* defaultOutputModes: [],
* skills: [],
* preferredTransport: "JSONRPC",
* }
*
* @example
* ```typescript
* const agentCard = card("My Agent");
* ```
*
* @public
* @since 0.6.0
*/
export declare const card: typeof AgentCard.create;
/**
* @deprecated Use {@link card} instead
* @since 0.6.0
*/
export declare const createAgentCard: typeof AgentCard.create;