@accidentally-awesome-labs/spatula-api
v0.1.1
Published
Internal Spatula Hono REST API server — NO TS-API compat guarantee. Public SDK is @accidentally-awesome-labs/spatula-client. See docs/compat-policy.md.
Downloads
269
Readme
@accidentally-awesome-labs/spatula-api
NO COMPAT GUARANTEE AT TS-API LEVEL. This is an internal Spatula implementation package. Breaking changes to its TypeScript surface may land in any MINOR release. External consumers should not import it directly. The public packages with semver-stable TypeScript surfaces are:
@accidentally-awesome-labs/spatula-client,@accidentally-awesome-labs/spatula-core-types, and@accidentally-awesome-labs/spatula. Seedocs/compat-policy.mdfor the full matrix.
Purpose
Hono-based REST API server for Spatula. Tenant-scoped middleware, OpenAPI runtime (GET /api/v1/openapi.json), well-known version probe (GET /.well-known/spatula-version), Bull Board admin UI, WebSocket + SSE adapters.
Note: The TS-API surface is internal. The HTTP API contract is the public surface; it is governed by docs/api-errors.md, docs/api-idempotency.md, docs/api-auth.md, and the OpenAPI document served at runtime, all of which are stable per the compat policy. Self-hosters should consume the HTTP API via @accidentally-awesome-labs/spatula-client, not by importing this package directly.
Stability
No stable TS-API. Use @accidentally-awesome-labs/spatula-client for programmatic API access.
Compatibility
The TypeScript API is internal and may change between minor versions. The stable public API is the REST contract documented by OpenAPI and docs/compat-policy.md.
