@open-operational-state/oos 0.2.0

package/README.md

@@ -0,0 +1,77 @@
+# @open-operational-state/oos
+
+The developer-facing package for [Open Operational State](https://github.com/open-operational-state). Install this one package to get the CLI and the programmatic API.
+
+[![npm](https://img.shields.io/npm/v/@open-operational-state/oos)](https://www.npmjs.com/package/@open-operational-state/oos)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue)](../../LICENSE)
+
+## Install
+
+```bash
+npm install @open-operational-state/oos
+```
+
+## CLI
+
+After local install, the `oos` binary is available:
+
+```bash
+npx oos probe https://api.example.com/health
+npx oos validate snapshot.json
+npx oos fixtures ./conformance-fixtures --format=table
+npx oos inspect snapshot.json
+```
+
+Or run without installing:
+
+```bash
+npx @open-operational-state/oos probe https://api.example.com/health
+```
+
+Or install globally:
+
+```bash
+npm i -g @open-operational-state/oos
+oos probe https://api.example.com/health
+```
+
+### Commands
+
+| Command | Description |
+|---|---|
+| `probe <url>` | Fetch a URL, auto-detect format, parse to core model |
+| `validate <file>` | Validate a JSON file against conformance levels |
+| `fixtures <dir>` | Run all conformance fixtures in a directory |
+| `inspect <file>` | Parse a JSON file, pretty-print core model |
+
+### Options
+
+| Option | Description |
+|---|---|
+| `--format=json\|table` | Output format (default: json) |
+| `--help` | Show help |
+
+## Programmatic API
+
+```js
+import { probe } from '@open-operational-state/oos';
+
+const result = await probe( 'https://api.example.com/health' );
+
+console.log( result.snapshot.condition );  // 'operational'
+console.log( result.httpStatus );          // 200
+console.log( result.validation.valid );    // true
+```
+
+## What this package includes
+
+`@open-operational-state/oos` is an umbrella package that bundles:
+
+- **`probe`** — programmatic endpoint probing
+- **`validator`** — conformance validation, fixture runner, CLI implementation
+
+You don't need to install the lower-level packages separately.
+
+## License
+
+Licensed under [Apache 2.0](../../LICENSE).

package/dist/cli.d.ts

@@ -0,0 +1,10 @@
+#!/usr/bin/env node
+/**
+ * OOS CLI entrypoint.
+ *
+ * This is the executable that `npx @open-operational-state/oos` resolves to.
+ * All CLI implementation logic lives in @open-operational-state/validator —
+ * this file is a thin delegation layer.
+ */
+export {};
+//# sourceMappingURL=cli.d.ts.map

package/dist/cli.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA;;;;;;GAMG"}

package/dist/cli.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+/**
+ * OOS CLI entrypoint.
+ *
+ * This is the executable that `npx @open-operational-state/oos` resolves to.
+ * All CLI implementation logic lives in @open-operational-state/validator —
+ * this file is a thin delegation layer.
+ */
+import { runCli } from '@open-operational-state/validator';
+runCli().catch((err) => {
+    console.error(err);
+    process.exit(1);
+});
+//# sourceMappingURL=cli.js.map

package/dist/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sourceRoot":"","sources":["../src/cli.ts"],"names":[],"mappings":";AAEA;;;;;;GAMG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,mCAAmC,CAAC;AAE3D,MAAM,EAAE,CAAC,KAAK,CAAE,CAAE,GAAY,EAAG,EAAE;IAC/B,OAAO,CAAC,KAAK,CAAE,GAAG,CAAE,CAAC;IACrB,OAAO,CAAC,IAAI,CAAE,CAAC,CAAE,CAAC;AACtB,CAAC,CAAE,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @open-operational-state/oos
+ *
+ * The developer-facing package for Open Operational State.
+ *
+ * Curated re-exports — small, opinionated, stable.
+ */
+export { probe } from '@open-operational-state/probe';
+export type { ProbeResult, ProbeOptions } from '@open-operational-state/probe';
+export type { Snapshot, Subject, Evidence, Timing, CheckEntry, ValidationResult, ValidationError, ValidationWarning, DiscoveryDocument, } from '@open-operational-state/types';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAGH,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC;AACtD,YAAY,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAG/E,YAAY,EACR,QAAQ,EACR,OAAO,EACP,QAAQ,EACR,MAAM,EACN,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,iBAAiB,GACpB,MAAM,+BAA+B,CAAC"}

package/dist/index.js

@@ -0,0 +1,10 @@
+/**
+ * @open-operational-state/oos
+ *
+ * The developer-facing package for Open Operational State.
+ *
+ * Curated re-exports — small, opinionated, stable.
+ */
+// ── Probe (primary API) ───────────────────────────────────────────────
+export { probe } from '@open-operational-state/probe';
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,yEAAyE;AACzE,OAAO,EAAE,KAAK,EAAE,MAAM,+BAA+B,CAAC"}

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@open-operational-state/oos",
+  "version": "0.2.0",
+  "description": "Open Operational State — developer-facing package and CLI",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "bin": {
+    "oos": "./dist/cli.js"
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/open-operational-state/status-tooling-js.git",
+    "directory": "packages/oos"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "echo 'No tests — thin entrypoint'"
+  },
+  "dependencies": {
+    "@open-operational-state/probe": "^0.2.0",
+    "@open-operational-state/types": "^0.2.0",
+    "@open-operational-state/validator": "^0.2.0"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.0"
+  }
+}