@karmaniverous/jeeves-watcher-core

Shared Zod schemas, derived TypeScript types, defaults and constants for the jeeves-watcher ecosystem.

This package is the single source of truth for the watcher's contracts. The service validates with these schemas, and the SDK and the OpenClaw plugin type against them, so clients cannot drift from the server.

• Config: jeevesWatcherConfigSchema and its section schemas (watch, embedding, vector store, inference rules, API key, payload indexes, sources), plus defaults such as EMBEDDING_DEFAULTS and API_DEFAULTS.
• API: request and response schemas for the HTTP endpoints (including the admin routes: points delete, rules register/unregister/reapply), the endpoint catalogue (WATCHER_ENDPOINTS, getEndpoint), the error body with its machine-readable code (API_ERROR_CODES) and the HTTP status each code is sent with (API_ERROR_STATUS).
• HTTP client contract: shared by the SDK, the CLI and the plugin: the API key environment variable (API_KEY_ENV_VAR, JEEVES_WATCHER_API_KEY), bearer headers (bearerHeaders) and the mapping of a non-2xx response to { status, code, message, details } (httpError, formatHttpError).
• Source documents: the <name>://<id> reference schema (sourceReferenceSchema) and the callback record contract (sourceDocumentSchema).
• Payload: reserved system payload fields (RESERVED_PAYLOAD_FIELDS, isReservedPayloadField).

ESM only, Node.js >= 22.13. Most applications should use the SDK rather than depend on this package directly.

Install

npm install @karmaniverous/jeeves-watcher-core
Copy

Documentation

API reference: docs.karmanivero.us/jeeves-watcher. Source and guides: github.com/karmaniverous/jeeves-watcher.

License

BSD-3-Clause