TypeScript SDK for the AEO Protocol v0.1 — parse, build, validate, and fetch AEO declaration documents. Zero-runtime-cost types via zod.
npm install aeo-protocolimport { fetchWellKnown, parseDocument, claimIds, findClaim } from "aeo-protocol";
// Fetch and parse from a live well-known URL
const doc = await fetchWellKnown("https://mizcausevic-dev.github.io");
console.log(doc.entity.name); // "Miz Causevic"
console.log(claimIds(doc)); // ['current-role', ...]
console.log(findClaim(doc, "years-experience")?.value); // 30
// Parse from a string
const docFromString = parseDocument('{"aeo_version":"0.1",...}');
// Validate safely
import { safeParseDocument } from "aeo-protocol";
const result = safeParseDocument(maybeMalformed);
if (!result.success) console.error(result.error);- Parse —
parseDocument(raw)andsafeParseDocument(value)for strict and recoverable parsing - Build — full zod schemas (
documentSchema,entitySchema, etc.) and inferred TypeScript types (AeoDocument,Entity,Claim, ...) - Serialize —
serializeDocument(doc, indent)returns canonical JSON - Fetch —
fetchWellKnown(origin, { timeoutMs })discovers and parses against/.well-known/aeo.jsonwithAccept: application/aeo+json, application/json - Query —
claimIds(doc)andfindClaim(doc, id)for convenience
Supports the AEO Protocol at conformance Level 1 (Declare). Signature verification (L2) and audit-endpoint posting (L3) deferred to v0.2.
Every model has both a zod schema and an inferred type. Import either:
import { documentSchema, type AeoDocument } from "aeo-protocol";
const validated: AeoDocument = documentSchema.parse(someUnknown);- zod
^3.23— runtime validation + type inference - Native
fetch(Node 18+, all modern browsers and runtimes)
npm install
npm run typecheck
npm test
npm run buildFull spec at github.com/mizcausevic-dev/aeo-protocol-spec.
MIT-licensed. Free for commercial and non-commercial use with attribution. The AEO Protocol specification this SDK implements is also MIT (see aeo-protocol-spec).
| Spec | Implementation |
|---|---|
| AEO Protocol | aeo-sdk-python · aeo-sdk-typescript (this) · aeo-sdk-rust · aeo-sdk-go · aeo-cli · aeo-crawler |
| Prompt Provenance | — |
| Agent Cards | — |
| AI Evidence Format | — |
| MCP Tool Cards | — |
Connect: LinkedIn · Kinetic Gain · Medium · Skills