https://github.com/mizcausevic-dev/aeo-sdk-typescript
TypeScript SDK for the AEO Protocol v0.1. Parse, build, validate, and fetch AEO declaration documents. Zod schemas with inferred TypeScript types. ESM-only, Node 18+, zero non-zod runtime deps.
https://github.com/mizcausevic-dev/aeo-sdk-typescript
aeo aeo-protocol ai-governance answer-engine-optimization kinetic-gain-protocol-suite protocol-implementation typescript typescript-sdk well-known zod
Last synced: 12 days ago
JSON representation
TypeScript SDK for the AEO Protocol v0.1. Parse, build, validate, and fetch AEO declaration documents. Zod schemas with inferred TypeScript types. ESM-only, Node 18+, zero non-zod runtime deps.
- Host: GitHub
- URL: https://github.com/mizcausevic-dev/aeo-sdk-typescript
- Owner: mizcausevic-dev
- License: mit
- Created: 2026-05-12T05:08:13.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-05-23T21:40:52.000Z (20 days ago)
- Last Synced: 2026-05-23T23:22:00.862Z (20 days ago)
- Topics: aeo, aeo-protocol, ai-governance, answer-engine-optimization, kinetic-gain-protocol-suite, protocol-implementation, typescript, typescript-sdk, well-known, zod
- Language: TypeScript
- Homepage: https://github.com/mizcausevic-dev/aeo-sdk-typescript
- Size: 43 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# aeo-sdk-typescript
[](https://www.npmjs.com/package/aeo-protocol)
[](https://www.npmjs.com/package/aeo-protocol)
[](https://opensource.org/licenses/MIT)
TypeScript SDK for the [AEO Protocol v0.1](https://github.com/mizcausevic-dev/aeo-protocol-spec) — parse, build, validate, and fetch AEO declaration documents. Zero-runtime-cost types via [zod](https://github.com/colinhacks/zod).
## Install
```bash
npm install aeo-protocol
```
## Quickstart
```typescript
import { 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);
```
## What it does
- **Parse** — `parseDocument(raw)` and `safeParseDocument(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.json` with `Accept: application/aeo+json, application/json`
- **Query** — `claimIds(doc)` and `findClaim(doc, id)` for convenience
## Conformance
Supports the AEO Protocol at **conformance Level 1 (Declare)**. Signature verification (L2) and audit-endpoint posting (L3) deferred to v0.2.
## TypeScript types
Every model has both a zod schema and an inferred type. Import either:
```typescript
import { documentSchema, type AeoDocument } from "aeo-protocol";
const validated: AeoDocument = documentSchema.parse(someUnknown);
```
## Dependencies
- [zod](https://github.com/colinhacks/zod) `^3.23` — runtime validation + type inference
- Native `fetch` (Node 18+, all modern browsers and runtimes)
## Development
```bash
npm install
npm run typecheck
npm test
npm run build
```
## Specification
Full spec at [github.com/mizcausevic-dev/aeo-protocol-spec](https://github.com/mizcausevic-dev/aeo-protocol-spec).
## License
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](https://github.com/mizcausevic-dev/aeo-protocol-spec)).
## Kinetic Gain Protocol Suite
| Spec | Implementation |
|---|---|
| [AEO Protocol](https://github.com/mizcausevic-dev/aeo-protocol-spec) | [aeo-sdk-python](https://github.com/mizcausevic-dev/aeo-sdk-python) · **aeo-sdk-typescript** (this) · [aeo-sdk-rust](https://github.com/mizcausevic-dev/aeo-sdk-rust) · [aeo-sdk-go](https://github.com/mizcausevic-dev/aeo-sdk-go) · [aeo-cli](https://github.com/mizcausevic-dev/aeo-cli) · [aeo-crawler](https://github.com/mizcausevic-dev/aeo-crawler) |
| [Prompt Provenance](https://github.com/mizcausevic-dev/prompt-provenance-spec) | — |
| [Agent Cards](https://github.com/mizcausevic-dev/agent-cards-spec) | — |
| [AI Evidence Format](https://github.com/mizcausevic-dev/ai-evidence-format-spec) | — |
| [MCP Tool Cards](https://github.com/mizcausevic-dev/mcp-tool-card-spec) | — |
---
**Connect:** [LinkedIn](https://www.linkedin.com/in/mirzacausevic/) · [Kinetic Gain](https://kineticgain.com) · [Medium](https://medium.com/@mizcausevic/) · [Skills](https://mizcausevic.com/skills/)