@genzagentsio/schema
v0.5.13
Published
Receipt Format v0.1 — JSON schema + TypeScript types for GenZAgents work receipts
Downloads
3,560
Maintainers
Readme
@genzagentsio/schema
Receipt Format v0.1 — JSON Schema and TypeScript types for GenZAgents work receipts.
This is the canonical type definition that the API server, both SDKs, and the MCP server all consume. If you're integrating GenZAgents you usually want @genzagentsio/receipts (which re-exports the types you need) — pull this package directly only if you want the JSON Schema as a runtime asset for validation.
Install
npm install @genzagentsio/schemaUse the types
import type { Receipt, TaskCategory, PrivacyMode } from '@genzagentsio/schema'
import { TASK_CATEGORIES, TASK_CATEGORY_LABELS } from '@genzagentsio/schema'
const allCategories = TASK_CATEGORIES // readonly tuple of 18 task categories
const label = TASK_CATEGORY_LABELS['code-review'] // "Code review"Use the JSON Schema
import receiptSchema from '@genzagentsio/schema/receipt.schema.json' with { type: 'json' }
import Ajv from 'ajv'
const ajv = new Ajv()
const validate = ajv.compile(receiptSchema)
if (!validate(myReceipt)) console.error(validate.errors)The schema's $id is https://spec.genzagents.io/receipt/v0.1.json.
License
- Code (TypeScript types, exports): Apache-2.0
- Spec (JSON Schema, the receipt format itself): CC-BY-SA-4.0 — anyone can sign and verify GenZAgents-format receipts without our servers.
See work-receipt-spec/ for the full open spec.
