logicsrc/packages/schemas/README.md

41 lines
1.6 KiB
Markdown

# @logicsrc/schemas
Canonical JSON Schemas (draft 2020-12) for the LogicSRC open coordination
standards, maintained by Profullstack, Inc.
Schema families include:
- **LogicSRC core** — `logicsrc-*.schema.json`: tasks, agents, runs, events,
plugins, connected accounts, email messages, social posts.
- **AgentAd** — `agentad-*.schema.json`: a disclosed, agent-readable advertising
contract for CLI tools and AI agents (ads, placements, requests, responses,
impressions, clicks, campaigns). See `docs/agentad.md` in the repo;
[cl1s.tech](https://github.com/profullstack/cl1s.tech) is the reference network.
- **OpenWall draft** — `openwall-message` and `openwall-receipt` exports define
sender-side audience jobs and private delivery events. Fixtures are in
`fixtures/openwall`. See `docs/openwall.md` for consent, routing, and runtime
requirements beyond structural validation; no OpenWall delivery runtime ships.
- **OpenFleet draft** — the `openfleet` export describes fleets of OpenAgent
profiles and OpenSwarm file-key references, with metadata and CoinPay rental
offers. `@logicsrc/validators` also checks membership and rental references.
## Install
```bash
npm install @logicsrc/schemas
```
## Use
```js
import adSchema from "@logicsrc/schemas/agentad-ad" with { type: "json" };
import taskSchema from "@logicsrc/schemas/task" with { type: "json" };
```
Schema `$id`s resolve under `https://schemas.logicsrc.com/`. Validate with any
draft 2020-12 validator (e.g. `ajv/dist/2020.js`), or use `@logicsrc/validators`
from the monorepo.
## License
MIT © Profullstack, Inc.