{"id":47793837,"url":"https://github.com/open-operational-state/status-tooling","last_synced_at":"2026-04-03T16:01:33.093Z","repository":{"id":348864192,"uuid":"1199782034","full_name":"open-operational-state/status-tooling","owner":"open-operational-state","description":"Reference tools, validators, and utilities for working with Open Operational State data and integrations.","archived":false,"fork":false,"pushed_at":"2026-04-03T02:03:21.000Z","size":70,"stargazers_count":0,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-03T13:22:39.187Z","etag":null,"topics":["api-tools","automation","cli","developer-tools","integration","observability","operational-state","sdk","tooling","validation"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/open-operational-state.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-02T17:47:41.000Z","updated_at":"2026-04-02T20:48:40.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/open-operational-state/status-tooling","commit_stats":null,"previous_names":["open-operational-state/status-tooling"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/open-operational-state/status-tooling","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-operational-state%2Fstatus-tooling","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-operational-state%2Fstatus-tooling/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-operational-state%2Fstatus-tooling/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-operational-state%2Fstatus-tooling/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/open-operational-state","download_url":"https://codeload.github.com/open-operational-state/status-tooling/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/open-operational-state%2Fstatus-tooling/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31362680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-03T15:19:21.178Z","status":"ssl_error","status_checked_at":"2026-04-03T15:19:20.670Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-tools","automation","cli","developer-tools","integration","observability","operational-state","sdk","tooling","validation"],"created_at":"2026-04-03T16:01:08.214Z","updated_at":"2026-04-03T16:01:33.065Z","avatar_url":"https://github.com/open-operational-state.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Status Tooling\n\nVendor-neutral reference tooling for the [Open Operational State](https://github.com/open-operational-state) standard.\n\n[![npm](https://img.shields.io/npm/v/@open-operational-state/core)](https://www.npmjs.com/org/open-operational-state)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](LICENSE)\n\n## Install\n\n```bash\nnpm install @open-operational-state/core @open-operational-state/emitter\n```\n\n```js\nimport { normalizeSnapshot } from '@open-operational-state/core';\nimport { emitHealthResponse, suggestHttpStatus } from '@open-operational-state/emitter';\n\napp.get( '/health', ( req, res ) =\u003e {\n    const snapshot = normalizeSnapshot( {\n        condition: 'operational',\n        profiles: [ 'health' ],\n        subject: { id: 'my-api' },\n        timing: { observed: new Date().toISOString() },\n    } );\n\n    res.status( suggestHttpStatus( snapshot ) ).json( emitHealthResponse( snapshot ) );\n} );\n```\n\nOr parse any existing health endpoint into the common model:\n\n```bash\nnpx @open-operational-state/validator probe https://your-api.com/health\n```\n\n## Overview\n\nThis monorepo is the source for the `@open-operational-state` npm packages — a complete toolkit for parsing, emitting, validating, and discovering operational-state resources. All packages are published to npm, written in TypeScript, and use ESM.\n\n## Packages\n\n| Package | Purpose | Version |\n|---|---|---|\n| [`@open-operational-state/types`](packages/types/) | Canonical TypeScript types for the core model | 0.1.1 |\n| [`@open-operational-state/core`](packages/core/) | Core model logic, normalization, validation | 0.1.1 |\n| [`@open-operational-state/parser`](packages/parser/) | Response parsers and format adapters | 0.1.1 |\n| [`@open-operational-state/emitter`](packages/emitter/) | Wire format emitters | 0.1.1 |\n| [`@open-operational-state/validator`](packages/validator/) | Conformance validation and `oos` CLI | 0.1.1 |\n| [`@open-operational-state/discovery`](packages/discovery/) | Discovery client (Link headers, well-known) | 0.1.1 |\n\n## Development\n\n```bash\n# Install dependencies\nbun install\n\n# Build all packages\nbun run build\n\n# Run all tests\nbun run test\n\n# Probe a live endpoint\nnode packages/validator/dist/cli.js probe https://api.example.com/health\n\n# Run conformance fixtures\nnode packages/validator/dist/cli.js fixtures ../status-conformance/fixtures/core --format=table\n```\n\n## CLI\n\nThe `oos` CLI is included in the validator package:\n\n```bash\noos validate \u003cfile\u003e       # Validate a JSON file against conformance levels\noos probe \u003curl\u003e           # Fetch a URL, auto-detect format, parse to core model\noos fixtures \u003cdir\u003e        # Run all conformance fixtures in a directory\noos inspect \u003cfile\u003e        # Parse a JSON file, pretty-print core model\n```\n\nSee the [validator README](packages/validator/README.md) for full CLI documentation.\n\n## Examples\n\nSee [examples/](examples/) for real-world usage patterns — Express, Hono, `safeParse()`, discovery, and component aggregation in ~10 lines each.\n\n## Supported Formats\n\n| Format | Content-Type | Adapter |\n|---|---|---|\n| OOS Native (health) | `application/health+json` | `parseHealthResponse` |\n| OOS Native (status) | `application/status+json` | `parseHealthResponse` |\n| Health Check Draft | `application/json` | `parseHealthCheckDraft` |\n| Spring Boot Actuator | `application/json` | `parseSpringBoot` |\n| Plain HTTP | any | `parsePlainHttp` |\n\nFormat detection is automatic — the `parse()` function inspects content-type and body structure to select the correct adapter.\n\n## Architecture\n\nThis tooling implements the six-layer architecture defined in the [status-spec](https://github.com/open-operational-state/status-spec/blob/main/ARCHITECTURE.md):\n\n- **`types`** — TypeScript interfaces for the core model (Layer 1)\n- **`core`** — normalization and manipulation of core model instances\n- **`parser`** — deserialization from wire formats to core model (Layers 3–4)\n- **`emitter`** — serialization from core model to wire formats (Layer 3)\n- **`validator`** — conformance validation against profiles and serializations (cross-cutting)\n- **`discovery`** — discovery client for locating operational-state resources (Layer 5)\n\n## Dependency Graph\n\n```\ntypes ← core ← parser\n              ← emitter\n              ← validator ← parser\ndiscovery ← types (only)\n```\n\n- `core` depends **only** on `types`\n- `parser` and `emitter` depend on `core` + `types`\n- `validator` depends on `types` + `core` + `parser`\n- `discovery` depends **only** on `types`\n\n## Testing\n\nTests are fixture-driven where applicable. Conformance fixtures are read directly from the sibling `status-conformance` repository:\n\n```bash\n# Run all tests\nbun run test\n\n# Run tests for a specific package\nbun run --filter '@open-operational-state/parser' test\n```\n\n### Round-Trip Invariants\n\nThe emitter package includes golden round-trip tests that enforce:\n\n```\nparse → normalize → emit → parse → normalize\n```\n\nNo semantic drift, no loss of required data, no illegal state introduced.\n\n## Related Repositories\n\n| Repository | Purpose |\n|---|---|\n| [status-spec](https://github.com/open-operational-state/status-spec) | Technical specification (what tooling implements) |\n| [status-conformance](https://github.com/open-operational-state/status-conformance) | Conformance fixtures and test taxonomy |\n| [governance](https://github.com/open-operational-state/governance) | Charter, terminology, roadmap |\n\n## Project Rules\n\nSee [PROJECT_RULES.md](PROJECT_RULES.md) for repo-specific constraints. Key points:\n\n- **ESM only** — no CommonJS\n- **Bun** package manager and test runner\n- **Node.js + TypeScript** — compiled output targets ES2022\n- All behavior must be represented in fixtures or spec\n\n## License\n\nLicensed under [Apache 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-operational-state%2Fstatus-tooling","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopen-operational-state%2Fstatus-tooling","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopen-operational-state%2Fstatus-tooling/lists"}