@farming-labs/docs 0.2.62 → 0.2.64

package/dist/standards-discovery-C4HUqMd2.d.mts

@@ -0,0 +1,227 @@
+//#region src/standards-discovery.d.ts
+declare const DEFAULT_API_CATALOG_ROUTE = "/.well-known/api-catalog";
+declare const DEFAULT_API_CATALOG_FORMAT = "api-catalog";
+declare const API_CATALOG_PROFILE_URI = "https://www.rfc-editor.org/info/rfc9727";
+declare const API_CATALOG_MEDIA_TYPE = "application/linkset+json";
+declare const DEFAULT_AGENT_SKILLS_INDEX_ROUTE = "/.well-known/agent-skills/index.json";
+declare const DEFAULT_AGENT_SKILLS_ROUTE_PREFIX = "/.well-known/agent-skills";
+declare const DEFAULT_AGENT_SKILLS_ROUTE_PATTERN = "/.well-known/agent-skills/{name}/SKILL.md";
+declare const DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN = "/.well-known/agent-skills/{name}.tar.gz";
+declare const DEFAULT_AGENT_SKILLS_INDEX_FORMAT = "agent-skills";
+declare const DEFAULT_AGENT_SKILL_FORMAT = "agent-skill";
+declare const DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT = "agent-skill-archive";
+declare const DEFAULT_AGENT_SKILL_FILE_FORMAT = "agent-skill-file";
+declare const DEFAULT_AGENT_SKILL_RESOURCE_FORMAT = "agent-skill-resource";
+declare const DEFAULT_LEGACY_SKILLS_INDEX_ROUTE = "/.well-known/skills/index.json";
+declare const DEFAULT_LEGACY_SKILLS_INDEX_FORMAT = "legacy-skills";
+declare const DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX = "/.well-known/skills";
+declare const DEFAULT_A2A_AGENT_CARD_ROUTE = "/.well-known/agent-card.json";
+declare const DEFAULT_A2A_AGENT_CARD_FORMAT = "agent-card";
+declare const AGENT_SKILLS_DISCOVERY_SCHEMA_URI = "https://schemas.agentskills.io/discovery/0.2.0/schema.json";
+interface DocsAgentSkillIndexEntry {
+  name: string;
+  type: "skill-md" | "archive";
+  description: string;
+  url: string;
+  digest: `sha256:${string}`;
+}
+interface DocsAgentSkillsIndex {
+  $schema: typeof AGENT_SKILLS_DISCOVERY_SCHEMA_URI;
+  skills: DocsAgentSkillIndexEntry[];
+}
+interface DocsPublishedAgentSkill extends DocsAgentSkillIndexEntry {
+  /** Exact bytes served from the indexed artifact URL. */
+  content: string | Uint8Array;
+  sha256: string;
+  /** Parsed SKILL.md text, including when `content` is an archive. */
+  skillDocument: string;
+  /** Safe files available for progressive disclosure and MCP resources. */
+  files: DocsPublishedAgentSkillFile[];
+}
+interface DocsPublishedAgentSkillFile {
+  path: string;
+  url: string;
+  mediaType: string;
+  content: string | Uint8Array;
+  sha256: string;
+  digest: `sha256:${string}`;
+  /** Preserve source executability in portable archives without granting it to every script. */
+  executable?: boolean;
+}
+interface DocsLegacySkillsIndex {
+  skills: Array<{
+    name: string;
+    description: string;
+    files: string[];
+  }>;
+}
+interface DocsA2AAgentCardOptions {
+  /** URL of a real A2A interface. Merely exposing docs or MCP is not sufficient. */
+  interfaceUrl: string;
+  name: string;
+  description: string;
+  documentationUrl: string;
+  provider: {
+    organization: string;
+    url: string;
+  };
+  version?: string;
+  protocolVersion?: string;
+  protocolBinding?: string;
+}
+interface DocsA2AAgentCard {
+  protocolVersion: string;
+  preferredTransport: string;
+  supportedInterfaces: Array<{
+    url: string;
+    protocolBinding: string;
+    protocolVersion: string;
+  }>;
+  name: string;
+  description: string;
+  url: string;
+  provider: {
+    organization: string;
+    url: string;
+  };
+  version: string;
+  documentationUrl: string;
+  capabilities: {
+    streaming: false;
+    pushNotifications: false;
+  };
+  defaultInputModes: ["text/plain"];
+  defaultOutputModes: ["text/plain"];
+  skills: Array<{
+    id: string;
+    name: string;
+    description: string;
+    tags: string[];
+    examples: string[];
+    url: string;
+  }>;
+}
+interface DocsPublishedAgentSkillOptions {
+  preferredDocument?: string | null;
+  fallbackDocument: string;
+}
+interface DocsApiCatalogLinkTarget {
+  href: string;
+  type?: string;
+  title?: string;
+}
+interface DocsApiCatalogLinkContext {
+  anchor: string;
+  item?: DocsApiCatalogLinkTarget[];
+  "api-catalog"?: DocsApiCatalogLinkTarget[];
+  "service-desc"?: DocsApiCatalogLinkTarget[];
+  "service-doc"?: DocsApiCatalogLinkTarget[];
+  "service-meta"?: DocsApiCatalogLinkTarget[];
+}
+interface DocsApiCatalog {
+  linkset: DocsApiCatalogLinkContext[];
+}
+interface DocsApiCatalogOptions {
+  origin: string;
+  docsRoute?: string;
+  apiRoute?: string | null;
+  /** Additional HTTP API endpoints to list as RFC 9727 `item` links. */
+  apiRoutes?: readonly {
+    route: string;
+    type?: string;
+    title?: string;
+  }[];
+  configRoute?: string | null;
+  diagnosticsRoute?: string | null;
+  agentManifestRoute?: string | null;
+  agentSkillsIndexRoute?: string | null;
+  legacySkillsIndexRoute?: string | null;
+  agentCardRoute?: string | null;
+  agentsRoute?: string | null;
+  skillRoute?: string | null;
+  markdownRootRoute?: string | null;
+  llmsRoutes?: readonly string[];
+  sitemapRoutes?: readonly string[];
+  robotsRoute?: string | null;
+  mcpRoute?: string | null;
+  protectedResourceMetadataRoutes?: readonly string[];
+  feedbackRoutes?: readonly string[];
+  openapiRoute?: string | null;
+  apiReferenceRoute?: string | null;
+}
+type DocsStandardsDiscoveryRequest = {
+  kind: "api-catalog";
+} | {
+  kind: "agent-skills-index";
+} | {
+  kind: "legacy-skills-index";
+} | {
+  kind: "agent-card";
+} | {
+  kind: "agent-skill";
+  name: string;
+} | {
+  kind: "agent-skill-archive";
+  name: string;
+} | {
+  kind: "agent-skill-file";
+  name: string;
+  path: string;
+};
+interface DocsDiscoveryApiRouteOptions {
+  /** Same-origin Docs API pathname used by query-form discovery. @default "/api/docs" */
+  apiRoute?: string;
+}
+interface DocsStandardsDiscoveryRouteOptions extends DocsDiscoveryApiRouteOptions {}
+interface CreateDocsStandardsResponseOptions {
+  request: Request;
+  apiCatalog?: DocsApiCatalog;
+  /** Whether the RFC 9727 catalog is exposed. Defaults to true. */
+  apiCatalogEnabled?: boolean;
+  /** Internal docs API route used for query-form forwarding. */
+  apiRoute?: string;
+  preferredSkillDocument?: string | null;
+  fallbackSkillDocument: string;
+  /** Additional validated project skills. The legacy root/fallback skill remains first. */
+  publishedSkills?: readonly DocsPublishedAgentSkill[];
+  /** Identity used to publish the optional A2A Agent Card. */
+  agentCard?: DocsA2AAgentCardOptions;
+}
+/** Resolve the same-origin Docs API pathname used by query-form discovery routes. */
+declare function resolveDocsDiscoveryApiRoute(apiRoute?: string): string;
+/** Build an RFC 9727 API Catalog using the RFC 9264 JSON Linkset representation. */
+declare function buildDocsApiCatalog(options: DocsApiCatalogOptions): DocsApiCatalog;
+declare function sha256DocsDiscoveryContent(content: string | Uint8Array): Promise<string>;
+/** Select a valid public skill and hash the exact bytes returned by its standards route. */
+declare function resolveDocsPublishedAgentSkill({
+  preferredDocument,
+  fallbackDocument
+}: DocsPublishedAgentSkillOptions): Promise<DocsPublishedAgentSkill>;
+declare function buildDocsAgentSkillsIndex(skills: DocsPublishedAgentSkill | readonly DocsPublishedAgentSkill[]): DocsAgentSkillsIndex;
+/** Build the compatibility index used by older Agent Skills clients. */
+declare function buildDocsLegacySkillsIndex(skills: DocsPublishedAgentSkill | readonly DocsPublishedAgentSkill[]): DocsLegacySkillsIndex;
+/** Build an A2A Agent Card only when a real A2A interface is explicitly configured. */
+declare function buildDocsA2AAgentCard(options: DocsA2AAgentCardOptions, skills: DocsPublishedAgentSkill | readonly DocsPublishedAgentSkill[]): DocsA2AAgentCard;
+declare function resolveDocsStandardsDiscoveryRequest(url: URL, options?: DocsStandardsDiscoveryRouteOptions): DocsStandardsDiscoveryRequest | null;
+declare function isDocsStandardsDiscoveryRequest(url: URL, options?: DocsStandardsDiscoveryRouteOptions): boolean;
+/** Cross-link the standards endpoints without replacing an existing canonical Link value. */
+declare function getDocsDiscoveryLinkHeader(options?: {
+  includeApiCatalog?: boolean;
+  includeManifest?: boolean;
+  includeSkills?: boolean;
+  includeAgentCard?: boolean;
+}): string;
+declare function appendDocsDiscoveryLinkHeader(headers: Headers, value?: string): Headers;
+/** Return one RFC 9727 or Agent Skills discovery response, or null for unrelated requests. */
+declare function createDocsStandardsResponse({
+  request,
+  apiCatalog,
+  apiCatalogEnabled,
+  apiRoute,
+  preferredSkillDocument,
+  fallbackSkillDocument,
+  publishedSkills,
+  agentCard
+}: CreateDocsStandardsResponseOptions): Promise<Response | null>;
+//#endregion
+export { DocsPublishedAgentSkill as A, createDocsStandardsResponse as B, DocsAgentSkillIndexEntry as C, DocsApiCatalogLinkTarget as D, DocsApiCatalogLinkContext as E, appendDocsDiscoveryLinkHeader as F, resolveDocsStandardsDiscoveryRequest as G, isDocsStandardsDiscoveryRequest as H, buildDocsA2AAgentCard as I, sha256DocsDiscoveryContent as K, buildDocsAgentSkillsIndex as L, DocsPublishedAgentSkillOptions as M, DocsStandardsDiscoveryRequest as N, DocsApiCatalogOptions as O, DocsStandardsDiscoveryRouteOptions as P, buildDocsApiCatalog as R, DocsA2AAgentCardOptions as S, DocsApiCatalog as T, resolveDocsDiscoveryApiRoute as U, getDocsDiscoveryLinkHeader as V, resolveDocsPublishedAgentSkill as W, DEFAULT_API_CATALOG_ROUTE as _, DEFAULT_A2A_AGENT_CARD_FORMAT as a, DEFAULT_LEGACY_SKILLS_ROUTE_PREFIX as b, DEFAULT_AGENT_SKILLS_INDEX_FORMAT as c, DEFAULT_AGENT_SKILLS_ROUTE_PREFIX as d, DEFAULT_AGENT_SKILL_ARCHIVE_FORMAT as f, DEFAULT_API_CATALOG_FORMAT as g, DEFAULT_AGENT_SKILL_RESOURCE_FORMAT as h, CreateDocsStandardsResponseOptions as i, DocsPublishedAgentSkillFile as j, DocsDiscoveryApiRouteOptions as k, DEFAULT_AGENT_SKILLS_INDEX_ROUTE as l, DEFAULT_AGENT_SKILL_FORMAT as m, API_CATALOG_MEDIA_TYPE as n, DEFAULT_A2A_AGENT_CARD_ROUTE as o, DEFAULT_AGENT_SKILL_FILE_FORMAT as p, API_CATALOG_PROFILE_URI as r, DEFAULT_AGENT_SKILLS_ARCHIVE_ROUTE_PATTERN as s, AGENT_SKILLS_DISCOVERY_SCHEMA_URI as t, DEFAULT_AGENT_SKILLS_ROUTE_PATTERN as u, DEFAULT_LEGACY_SKILLS_INDEX_FORMAT as v, DocsAgentSkillsIndex as w, DocsA2AAgentCard as x, DEFAULT_LEGACY_SKILLS_INDEX_ROUTE as y, buildDocsLegacySkillsIndex as z };