@magnaboy/robot-contracts
v0.0.1
Published
Canonical Zod schemas and inferred TypeScript types for the robot protocol.
Readme
@magnaboy/robot-contracts
Canonical Zod 4 schemas and inferred TypeScript types for the robot protocol.
- The root export owns wire telemetry, commands, animation runtime, HTTP requests, and validation limits.
ROBOT_REQUEST_SCHEMASmaps the daemon's endpoint schema names to those same validators. Generate JSON Schema withz.toJSONSchema; do not maintain a separate TypeScript or JSON definition./compatderives CX's readers from the wire schemas. It preserves optional/null telemetry, extra fields, and future acknowledgment verbs. Outbound stream configuration uses the canonical validator, including360framing and view controls.
import { z } from 'zod';
import { ROBOT_REQUEST_SCHEMAS, ZRobotControlCommand } from '@magnaboy/robot-contracts';
const command = ZRobotControlCommand.parse(input);
const jsonSchema = z.toJSONSchema(ROBOT_REQUEST_SCHEMAS.ControlCommand);CX derives its robot_* browser messages from ZRobotControlSchemas, excluding relay-only admin, sequence, and playback limits as appropriate. The relay still owns authentication and authorization. Schemas alone do not grant permission to drive the robot.
cx-robot/apps/schemas re-exports the canonical package and generates the daemon's JSON artifacts. Its voice catalog stays in that application; the catalog's shape is shared. CX retains stored animation documents, UI joint metadata, and animation compilation locally.
The extraction preserves all 32 generated request schemas and all 28 voice entries. The acknowledgment command enumeration is derived from the command registry; its order is not part of the protocol. Types come from z.infer, including compatibility types.
For sibling checkouts, build this package before installing the consumers' file: dependencies. Rebuild and refresh consumer installs after changes. Publishing and version selection are separate steps.
Run pnpm build, pnpm test:types, and pnpm test:unit from this directory.
