@open-operational-state/types 0.1.0

package/README.md

@@ -0,0 +1,58 @@
+# @open-operational-state/types
+
+Canonical TypeScript interfaces for the [Open Operational State](https://github.com/open-operational-state) core model.
+
+This package is the shared contract surface for all tooling packages. It contains zero runtime logic — only type declarations, constants, and type guards.
+
+## Installation
+
+```bash
+bun add @open-operational-state/types
+```
+
+## API
+
+### Core Interfaces
+
+| Interface | Description |
+|---|---|
+| `Snapshot` | Root operational-state document |
+| `Subject` | Identity and metadata for the observed service |
+| `Timing` | Observation, reporting, and state-change timestamps |
+| `Evidence` | Supporting data for a condition assessment |
+| `Scope` | Geographic or environmental scope |
+| `CheckEntry` | Flat check (used in `health-response` format) |
+| `ComponentEntry` | Nested component (used in `service-status` format) |
+| `DependencyEntry` | Nested dependency (used in `service-status` format) |
+| `DiscoveryDocument` | `/.well-known/operational-state` document |
+| `ResourceEntry` | Single resource in a discovery document |
+| `ValidationResult` | Validation output with errors and warnings |
+| `ConformanceResult` | Conformance level assessment |
+
+### Condition Vocabulary
+
+```js
+import { LIVENESS_CONDITIONS, READINESS_CONDITIONS, HEALTH_CONDITIONS } from '@open-operational-state/types';
+import { isHealthCondition, isExtensionCondition, conditionSeverity } from '@open-operational-state/types';
+
+isHealthCondition( 'operational' );       // true
+isExtensionCondition( 'x-acme-drain' );   // true
+
+conditionSeverity( 'operational' );  // 1 (lowest orderable)
+conditionSeverity( 'down' );         // 5 (highest orderable)
+```
+
+### Profile Helpers
+
+```js
+import { PROFILE_REQUIREMENTS, isProfileId, satisfiedProfiles } from '@open-operational-state/types';
+
+isProfileId( 'health' );  // true
+isProfileId( 'custom' );  // false
+
+satisfiedProfiles( 'status' );  // ['liveness', 'readiness', 'health', 'status']
+```
+
+## Dependencies
+
+None. This package has zero external dependencies.

package/dist/conditions.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Condition Vocabularies
+ *
+ * Normative condition values per profile, derived from
+ * status-spec/spec/condition-vocabularies.md.
+ */
+export declare const LIVENESS_CONDITIONS: readonly ["alive", "unreachable"];
+export type LivenessCondition = typeof LIVENESS_CONDITIONS[number];
+export declare const READINESS_CONDITIONS: readonly ["ready", "initializing", "not-ready"];
+export type ReadinessCondition = typeof READINESS_CONDITIONS[number];
+export declare const HEALTH_ORDERABLE_CONDITIONS: readonly ["operational", "degraded", "partial-outage", "major-outage", "down"];
+export type HealthOrderableCondition = typeof HEALTH_ORDERABLE_CONDITIONS[number];
+export declare const HEALTH_CATEGORICAL_CONDITIONS: readonly ["maintenance", "unknown"];
+export type HealthCategoricalCondition = typeof HEALTH_CATEGORICAL_CONDITIONS[number];
+export declare const HEALTH_CONDITIONS: readonly ["operational", "degraded", "partial-outage", "major-outage", "down", "maintenance", "unknown"];
+export type HealthCondition = HealthOrderableCondition | HealthCategoricalCondition;
+export type StatusCondition = HealthCondition;
+export declare function isExtensionCondition(value: string): boolean;
+export type Condition = LivenessCondition | ReadinessCondition | HealthCondition | string;
+export declare function isLivenessCondition(value: string): value is LivenessCondition;
+export declare function isReadinessCondition(value: string): value is ReadinessCondition;
+export declare function isHealthOrderableCondition(value: string): value is HealthOrderableCondition;
+export declare function isHealthCategoricalCondition(value: string): value is HealthCategoricalCondition;
+export declare function isHealthCondition(value: string): value is HealthCondition;
+/**
+ * Returns the numeric severity of an orderable condition value.
+ * Lower numbers indicate better operational state.
+ *
+ * Returns `undefined` for categorical or extension values.
+ */
+export declare function conditionSeverity(value: string): number | undefined;
+/**
+ * Returns true if the condition value is orderable (has defined severity).
+ */
+export declare function isOrderableCondition(value: string): boolean;
+//# sourceMappingURL=conditions.d.ts.map

package/dist/conditions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditions.d.ts","sourceRoot":"","sources":["../src/conditions.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,eAAO,MAAM,mBAAmB,mCAAsC,CAAC;AACvE,MAAM,MAAM,iBAAiB,GAAG,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;AAMnE,eAAO,MAAM,oBAAoB,iDAAoD,CAAC;AACtF,MAAM,MAAM,kBAAkB,GAAG,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAC;AAMrE,eAAO,MAAM,2BAA2B,gFAM9B,CAAC;AACX,MAAM,MAAM,wBAAwB,GAAG,OAAO,2BAA2B,CAAC,MAAM,CAAC,CAAC;AAElF,eAAO,MAAM,6BAA6B,qCAAwC,CAAC;AACnF,MAAM,MAAM,0BAA0B,GAAG,OAAO,6BAA6B,CAAC,MAAM,CAAC,CAAC;AAEtF,eAAO,MAAM,iBAAiB,0GAGpB,CAAC;AACX,MAAM,MAAM,eAAe,GAAG,wBAAwB,GAAG,0BAA0B,CAAC;AAMpF,MAAM,MAAM,eAAe,GAAG,eAAe,CAAC;AAQ9C,wBAAgB,oBAAoB,CAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAE7D;AAMD,MAAM,MAAM,SAAS,GAAG,iBAAiB,GAAG,kBAAkB,GAAG,eAAe,GAAG,MAAM,CAAC;AAM1F,wBAAgB,mBAAmB,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,iBAAiB,CAE/E;AAED,wBAAgB,oBAAoB,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,kBAAkB,CAEjF;AAED,wBAAgB,0BAA0B,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,wBAAwB,CAE7F;AAED,wBAAgB,4BAA4B,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,0BAA0B,CAEjG;AAED,wBAAgB,iBAAiB,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,eAAe,CAE3E;AAyBD;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAE,KAAK,EAAE,MAAM,GAAI,MAAM,GAAG,SAAS,CAErE;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAE,KAAK,EAAE,MAAM,GAAI,OAAO,CAE7D"}

package/dist/conditions.js

@@ -0,0 +1,91 @@
+/**
+ * Condition Vocabularies
+ *
+ * Normative condition values per profile, derived from
+ * status-spec/spec/condition-vocabularies.md.
+ */
+// ---------------------------------------------------------------------------
+// Liveness vocabulary (orderable)
+// ---------------------------------------------------------------------------
+export const LIVENESS_CONDITIONS = ['alive', 'unreachable'];
+// ---------------------------------------------------------------------------
+// Readiness vocabulary (orderable)
+// ---------------------------------------------------------------------------
+export const READINESS_CONDITIONS = ['ready', 'initializing', 'not-ready'];
+// ---------------------------------------------------------------------------
+// Health vocabulary — orderable core + categorical extensions
+// ---------------------------------------------------------------------------
+export const HEALTH_ORDERABLE_CONDITIONS = [
+    'operational',
+    'degraded',
+    'partial-outage',
+    'major-outage',
+    'down',
+];
+export const HEALTH_CATEGORICAL_CONDITIONS = ['maintenance', 'unknown'];
+export const HEALTH_CONDITIONS = [
+    ...HEALTH_ORDERABLE_CONDITIONS,
+    ...HEALTH_CATEGORICAL_CONDITIONS,
+];
+// ---------------------------------------------------------------------------
+// Extension value pattern
+// ---------------------------------------------------------------------------
+const EXTENSION_PATTERN = /^x-[a-z][a-z0-9]*-[a-z][a-z0-9-]*$/;
+export function isExtensionCondition(value) {
+    return EXTENSION_PATTERN.test(value);
+}
+// ---------------------------------------------------------------------------
+// Type guards
+// ---------------------------------------------------------------------------
+export function isLivenessCondition(value) {
+    return LIVENESS_CONDITIONS.includes(value);
+}
+export function isReadinessCondition(value) {
+    return READINESS_CONDITIONS.includes(value);
+}
+export function isHealthOrderableCondition(value) {
+    return HEALTH_ORDERABLE_CONDITIONS.includes(value);
+}
+export function isHealthCategoricalCondition(value) {
+    return HEALTH_CATEGORICAL_CONDITIONS.includes(value);
+}
+export function isHealthCondition(value) {
+    return isHealthOrderableCondition(value) || isHealthCategoricalCondition(value);
+}
+// ---------------------------------------------------------------------------
+// Severity ordering (lower = better)
+//
+// Only orderable values have a defined severity.  Categorical and extension
+// values return `undefined`.
+// ---------------------------------------------------------------------------
+const ORDERABLE_SEVERITY = {
+    // Liveness (1–2)
+    alive: 1,
+    unreachable: 2,
+    // Readiness (1–3)
+    ready: 1,
+    initializing: 2,
+    'not-ready': 3,
+    // Health orderable (1–5)
+    operational: 1,
+    degraded: 2,
+    'partial-outage': 3,
+    'major-outage': 4,
+    down: 5,
+};
+/**
+ * Returns the numeric severity of an orderable condition value.
+ * Lower numbers indicate better operational state.
+ *
+ * Returns `undefined` for categorical or extension values.
+ */
+export function conditionSeverity(value) {
+    return ORDERABLE_SEVERITY[value];
+}
+/**
+ * Returns true if the condition value is orderable (has defined severity).
+ */
+export function isOrderableCondition(value) {
+    return ORDERABLE_SEVERITY[value] !== undefined;
+}
+//# sourceMappingURL=conditions.js.map

package/dist/conditions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"conditions.js","sourceRoot":"","sources":["../src/conditions.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,8EAA8E;AAC9E,kCAAkC;AAClC,8EAA8E;AAE9E,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAE,OAAO,EAAE,aAAa,CAAW,CAAC;AAGvE,8EAA8E;AAC9E,mCAAmC;AACnC,8EAA8E;AAE9E,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAE,OAAO,EAAE,cAAc,EAAE,WAAW,CAAW,CAAC;AAGtF,8EAA8E;AAC9E,8DAA8D;AAC9D,8EAA8E;AAE9E,MAAM,CAAC,MAAM,2BAA2B,GAAG;IACvC,aAAa;IACb,UAAU;IACV,gBAAgB;IAChB,cAAc;IACd,MAAM;CACA,CAAC;AAGX,MAAM,CAAC,MAAM,6BAA6B,GAAG,CAAE,aAAa,EAAE,SAAS,CAAW,CAAC;AAGnF,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC7B,GAAG,2BAA2B;IAC9B,GAAG,6BAA6B;CAC1B,CAAC;AASX,8EAA8E;AAC9E,0BAA0B;AAC1B,8EAA8E;AAE9E,MAAM,iBAAiB,GAAG,oCAAoC,CAAC;AAE/D,MAAM,UAAU,oBAAoB,CAAE,KAAa;IAC/C,OAAO,iBAAiB,CAAC,IAAI,CAAE,KAAK,CAAE,CAAC;AAC3C,CAAC;AAQD,8EAA8E;AAC9E,cAAc;AACd,8EAA8E;AAE9E,MAAM,UAAU,mBAAmB,CAAE,KAAa;IAC9C,OAAS,mBAA0C,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAC;AAC1E,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAE,KAAa;IAC/C,OAAS,oBAA2C,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAC;AAC3E,CAAC;AAED,MAAM,UAAU,0BAA0B,CAAE,KAAa;IACrD,OAAS,2BAAkD,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAC;AAClF,CAAC;AAED,MAAM,UAAU,4BAA4B,CAAE,KAAa;IACvD,OAAS,6BAAoD,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAC;AACpF,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAE,KAAa;IAC5C,OAAO,0BAA0B,CAAE,KAAK,CAAE,IAAI,4BAA4B,CAAE,KAAK,CAAE,CAAC;AACxF,CAAC;AAED,8EAA8E;AAC9E,qCAAqC;AACrC,EAAE;AACF,4EAA4E;AAC5E,6BAA6B;AAC7B,8EAA8E;AAE9E,MAAM,kBAAkB,GAA2B;IAC/C,iBAAiB;IACjB,KAAK,EAAE,CAAC;IACR,WAAW,EAAE,CAAC;IACd,kBAAkB;IAClB,KAAK,EAAE,CAAC;IACR,YAAY,EAAE,CAAC;IACf,WAAW,EAAE,CAAC;IACd,yBAAyB;IACzB,WAAW,EAAE,CAAC;IACd,QAAQ,EAAE,CAAC;IACX,gBAAgB,EAAE,CAAC;IACnB,cAAc,EAAE,CAAC;IACjB,IAAI,EAAE,CAAC;CACV,CAAC;AAEF;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAE,KAAa;IAC5C,OAAO,kBAAkB,CAAC,KAAK,CAAC,CAAC;AACrC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAE,KAAa;IAC/C,OAAO,kBAAkB,CAAC,KAAK,CAAC,KAAK,SAAS,CAAC;AACnD,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,156 @@
+/**
+ * @open-operational-state/types
+ *
+ * Canonical TypeScript types for the Open Operational State core model.
+ *
+ * This package is the shared contract surface.  It contains only interfaces,
+ * type aliases, constants, and type guards — no runtime logic beyond
+ * trivial constant lookups.  Zero external dependencies.
+ */
+export { type Condition, type LivenessCondition, type ReadinessCondition, type HealthOrderableCondition, type HealthCategoricalCondition, type HealthCondition, type StatusCondition, LIVENESS_CONDITIONS, READINESS_CONDITIONS, HEALTH_ORDERABLE_CONDITIONS, HEALTH_CATEGORICAL_CONDITIONS, HEALTH_CONDITIONS, isExtensionCondition, isLivenessCondition, isReadinessCondition, isHealthOrderableCondition, isHealthCategoricalCondition, isHealthCondition, isOrderableCondition, conditionSeverity, } from './conditions.js';
+export { type ProfileId, type RequirementLevel, type ProfileRequirements, PROFILE_IDS, isProfileId, PROFILE_REQUIREMENTS, satisfiedProfiles, } from './profiles.js';
+export declare const PROVENANCE_TYPES: readonly ["self-reported", "externally-observed", "derived", "manually-declared"];
+export type Provenance = typeof PROVENANCE_TYPES[number];
+export declare function isProvenance(value: string): value is Provenance;
+export interface Subject {
+    id: string;
+    description?: string;
+    /** Service version — used in service-status serialization */
+    version?: string;
+    /** Contact URI — used in service-status serialization */
+    contact?: string;
+}
+export interface Timing {
+    /** RFC 3339 — when the condition was observed */
+    observed?: string;
+    /** RFC 3339 — when the condition was communicated */
+    reported?: string;
+    /** RFC 3339 — when the condition last transitioned */
+    stateChanged?: string;
+}
+export interface Evidence {
+    /** Kind of check or observation */
+    type: string;
+    /** Supplementary information */
+    detail?: string;
+    /** Measured value */
+    observedValue?: unknown;
+    /** Unit of measurement */
+    observedUnit?: string;
+}
+export interface Scope {
+    type: string;
+    identifier?: string;
+}
+export interface CheckEntry {
+    condition: string;
+    role?: 'component' | 'dependency';
+    timing?: Timing;
+    provenance?: Provenance | string;
+    evidence?: Evidence;
+}
+export interface ComponentEntry {
+    id: string;
+    description?: string;
+    condition: string;
+    criticality?: 'critical' | 'important' | 'informational';
+    timing?: Timing;
+    provenance?: Provenance | string;
+    evidence?: Evidence;
+    /** Nested sub-components (multi-level hierarchy) */
+    components?: ComponentEntry[];
+}
+export interface DependencyEntry {
+    id: string;
+    description?: string;
+    condition: string;
+    criticality?: 'critical' | 'important' | 'informational';
+    timing?: Timing;
+    provenance?: Provenance | string;
+    evidence?: Evidence;
+}
+export interface IncidentUpdate {
+    timestamp: string;
+    message: string;
+}
+export interface Incident {
+    id: string;
+    title: string;
+    condition: string;
+    started: string;
+    resolved?: string;
+    affectedComponents?: string[];
+    updates?: IncidentUpdate[];
+}
+export interface Snapshot {
+    condition: string;
+    profiles: string[];
+    subject: Subject;
+    timing?: Timing;
+    provenance?: Provenance | string;
+    evidence?: Evidence;
+    scope?: Scope;
+    /** health-response flat checks */
+    checks?: Record<string, CheckEntry>;
+    /** service-status nested components */
+    components?: ComponentEntry[];
+    /** service-status nested dependencies */
+    dependencies?: DependencyEntry[];
+    /** service-status incidents (informational extension) */
+    incidents?: Incident[];
+    /** Link relations */
+    links?: Record<string, string>;
+}
+export interface ValidationError {
+    path: string;
+    message: string;
+    code: string;
+}
+export interface ValidationWarning {
+    path: string;
+    message: string;
+    code: string;
+}
+export interface ValidationResult {
+    valid: boolean;
+    errors: ValidationError[];
+    warnings: ValidationWarning[];
+}
+export interface ParseError {
+    message: string;
+    code: string;
+}
+export interface ParseWarning {
+    message: string;
+    code: string;
+}
+export interface ParseResult {
+    /** The parsed snapshot, or null if parsing failed completely */
+    snapshot: Snapshot | null;
+    /** Non-fatal errors encountered during parsing */
+    errors: ParseError[];
+    /** Warnings about ambiguous or lossy interpretation */
+    warnings: ParseWarning[];
+}
+export interface ResourceEntry {
+    href: string;
+    profiles: string[];
+    serialization: string;
+    auth?: 'none' | 'required';
+    description?: string;
+}
+export interface DiscoveryDocument {
+    version: string;
+    subject: Subject;
+    resources: ResourceEntry[];
+}
+export type ConformanceLevel = 'basic' | 'standard' | 'extended';
+export interface ConformanceResult {
+    level: ConformanceLevel | null;
+    basic: boolean;
+    standard: boolean;
+    extended: boolean;
+    errors: ValidationError[];
+    warnings: ValidationWarning[];
+}
+//# 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;;;;;;;;GAQG;AAMH,OAAO,EACH,KAAK,SAAS,EACd,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EACvB,KAAK,wBAAwB,EAC7B,KAAK,0BAA0B,EAC/B,KAAK,eAAe,EACpB,KAAK,eAAe,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,4BAA4B,EAC5B,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,GACpB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EACH,KAAK,SAAS,EACd,KAAK,gBAAgB,EACrB,KAAK,mBAAmB,EACxB,WAAW,EACX,WAAW,EACX,oBAAoB,EACpB,iBAAiB,GACpB,MAAM,eAAe,CAAC;AAMvB,eAAO,MAAM,gBAAgB,mFAKnB,CAAC;AAEX,MAAM,MAAM,UAAU,GAAG,OAAO,gBAAgB,CAAC,MAAM,CAAC,CAAC;AAEzD,wBAAgB,YAAY,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,UAAU,CAEjE;AAMD,MAAM,WAAW,OAAO;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6DAA6D;IAC7D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,yDAAyD;IACzD,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAMD,MAAM,WAAW,MAAM;IACnB,iDAAiD;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qDAAqD;IACrD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,sDAAsD;IACtD,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,WAAW,QAAQ;IACrB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,gCAAgC;IAChC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,qBAAqB;IACrB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,0BAA0B;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAMD,MAAM,WAAW,KAAK;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACvB;AAMD,MAAM,WAAW,UAAU;IACvB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,WAAW,GAAG,YAAY,CAAC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACvB;AAMD,MAAM,WAAW,cAAc;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,eAAe,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,oDAAoD;IACpD,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;CACjC;AAED,MAAM,WAAW,eAAe;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,eAAe,CAAC;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACvB;AAMD,MAAM,WAAW,cAAc;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,QAAQ;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,cAAc,EAAE,CAAC;CAC9B;AAMD,MAAM,WAAW,QAAQ;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC;IACjC,QAAQ,CAAC,EAAE,QAAQ,CAAC;IACpB,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd,kCAAkC;IAClC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;IAEpC,uCAAuC;IACvC,UAAU,CAAC,EAAE,cAAc,EAAE,CAAC;IAC9B,yCAAyC;IACzC,YAAY,CAAC,EAAE,eAAe,EAAE,CAAC;IAEjC,yDAAyD;IACzD,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;IAEvB,qBAAqB;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAClC;AAMD,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,gBAAgB;IAC7B,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC;AAMD,MAAM,WAAW,UAAU;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IACzB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,WAAW;IACxB,gEAAgE;IAChE,QAAQ,EAAE,QAAQ,GAAG,IAAI,CAAC;IAC1B,kDAAkD;IAClD,MAAM,EAAE,UAAU,EAAE,CAAC;IACrB,uDAAuD;IACvD,QAAQ,EAAE,YAAY,EAAE,CAAC;CAC5B;AAMD,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,GAAG,UAAU,CAAC;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,iBAAiB;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,aAAa,EAAE,CAAC;CAC9B;AAMD,MAAM,MAAM,gBAAgB,GAAG,OAAO,GAAG,UAAU,GAAG,UAAU,CAAC;AAEjE,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,gBAAgB,GAAG,IAAI,CAAC;IAC/B,KAAK,EAAE,OAAO,CAAC;IACf,QAAQ,EAAE,OAAO,CAAC;IAClB,QAAQ,EAAE,OAAO,CAAC;IAClB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CACjC"}

package/dist/index.js

@@ -0,0 +1,27 @@
+/**
+ * @open-operational-state/types
+ *
+ * Canonical TypeScript types for the Open Operational State core model.
+ *
+ * This package is the shared contract surface.  It contains only interfaces,
+ * type aliases, constants, and type guards — no runtime logic beyond
+ * trivial constant lookups.  Zero external dependencies.
+ */
+// ---------------------------------------------------------------------------
+// Re-exports
+// ---------------------------------------------------------------------------
+export { LIVENESS_CONDITIONS, READINESS_CONDITIONS, HEALTH_ORDERABLE_CONDITIONS, HEALTH_CATEGORICAL_CONDITIONS, HEALTH_CONDITIONS, isExtensionCondition, isLivenessCondition, isReadinessCondition, isHealthOrderableCondition, isHealthCategoricalCondition, isHealthCondition, isOrderableCondition, conditionSeverity, } from './conditions.js';
+export { PROFILE_IDS, isProfileId, PROFILE_REQUIREMENTS, satisfiedProfiles, } from './profiles.js';
+// ---------------------------------------------------------------------------
+// Provenance
+// ---------------------------------------------------------------------------
+export const PROVENANCE_TYPES = [
+    'self-reported',
+    'externally-observed',
+    'derived',
+    'manually-declared',
+];
+export function isProvenance(value) {
+    return PROVENANCE_TYPES.includes(value);
+}
+//# 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;;;;;;;;GAQG;AAEH,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E,OAAO,EAQH,mBAAmB,EACnB,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,iBAAiB,EACjB,oBAAoB,EACpB,mBAAmB,EACnB,oBAAoB,EACpB,0BAA0B,EAC1B,4BAA4B,EAC5B,iBAAiB,EACjB,oBAAoB,EACpB,iBAAiB,GACpB,MAAM,iBAAiB,CAAC;AAEzB,OAAO,EAIH,WAAW,EACX,WAAW,EACX,oBAAoB,EACpB,iBAAiB,GACpB,MAAM,eAAe,CAAC;AAEvB,8EAA8E;AAC9E,aAAa;AACb,8EAA8E;AAE9E,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC5B,eAAe;IACf,qBAAqB;IACrB,SAAS;IACT,mBAAmB;CACb,CAAC;AAIX,MAAM,UAAU,YAAY,CAAE,KAAa;IACvC,OAAS,gBAAuC,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAC;AACvE,CAAC"}

package/dist/profiles.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Profile Definitions
+ *
+ * Profile identifiers, requirement matrices, and hierarchy,
+ * derived from status-spec/spec/profiles.md.
+ */
+export declare const PROFILE_IDS: readonly ["liveness", "readiness", "health", "status"];
+export type ProfileId = typeof PROFILE_IDS[number];
+export declare function isProfileId(value: string): value is ProfileId;
+export type RequirementLevel = 'MUST' | 'SHOULD' | 'MAY' | 'NONE';
+export interface ProfileRequirements {
+    subject: RequirementLevel;
+    condition: RequirementLevel;
+    timing: RequirementLevel;
+    evidence: RequirementLevel;
+    components: RequirementLevel;
+    dependencies: RequirementLevel;
+    provenance: RequirementLevel;
+    scope: RequirementLevel;
+}
+/**
+ * Normative requirement matrix per profile.
+ *
+ * Maps directly to the table in profiles.md §Required and Optional Concepts.
+ * "—" in the spec table is represented as 'NONE'.
+ */
+export declare const PROFILE_REQUIREMENTS: Record<ProfileId, ProfileRequirements>;
+/**
+ * Returns the profiles that this profile automatically satisfies,
+ * based on the conceptual hierarchy.
+ *
+ * Example: 'health' → ['health', 'readiness', 'liveness']
+ */
+export declare function satisfiedProfiles(profile: ProfileId): ProfileId[];
+//# sourceMappingURL=profiles.d.ts.map

package/dist/profiles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.d.ts","sourceRoot":"","sources":["../src/profiles.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAMH,eAAO,MAAM,WAAW,wDAA2D,CAAC;AACpF,MAAM,MAAM,SAAS,GAAG,OAAO,WAAW,CAAC,MAAM,CAAC,CAAC;AAEnD,wBAAgB,WAAW,CAAE,KAAK,EAAE,MAAM,GAAI,KAAK,IAAI,SAAS,CAE/D;AAMD,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;AAElE,MAAM,WAAW,mBAAmB;IAChC,OAAO,EAAE,gBAAgB,CAAC;IAC1B,SAAS,EAAE,gBAAgB,CAAC;IAC5B,MAAM,EAAE,gBAAgB,CAAC;IACzB,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,YAAY,EAAE,gBAAgB,CAAC;IAC/B,UAAU,EAAE,gBAAgB,CAAC;IAC7B,KAAK,EAAE,gBAAgB,CAAC;CAC3B;AAED;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,EAAE,MAAM,CAAC,SAAS,EAAE,mBAAmB,CAyCvE,CAAC;AASF;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAE,OAAO,EAAE,SAAS,GAAI,SAAS,EAAE,CAInE"}

package/dist/profiles.js

@@ -0,0 +1,79 @@
+/**
+ * Profile Definitions
+ *
+ * Profile identifiers, requirement matrices, and hierarchy,
+ * derived from status-spec/spec/profiles.md.
+ */
+// ---------------------------------------------------------------------------
+// Profile identifiers
+// ---------------------------------------------------------------------------
+export const PROFILE_IDS = ['liveness', 'readiness', 'health', 'status'];
+export function isProfileId(value) {
+    return PROFILE_IDS.includes(value);
+}
+/**
+ * Normative requirement matrix per profile.
+ *
+ * Maps directly to the table in profiles.md §Required and Optional Concepts.
+ * "—" in the spec table is represented as 'NONE'.
+ */
+export const PROFILE_REQUIREMENTS = {
+    liveness: {
+        subject: 'MUST',
+        condition: 'MUST',
+        timing: 'MAY',
+        evidence: 'NONE',
+        components: 'NONE',
+        dependencies: 'NONE',
+        provenance: 'NONE',
+        scope: 'NONE',
+    },
+    readiness: {
+        subject: 'MUST',
+        condition: 'MUST',
+        timing: 'MAY',
+        evidence: 'NONE',
+        components: 'NONE',
+        dependencies: 'MAY',
+        provenance: 'NONE',
+        scope: 'NONE',
+    },
+    health: {
+        subject: 'MUST',
+        condition: 'MUST',
+        timing: 'MUST',
+        evidence: 'SHOULD',
+        components: 'MAY',
+        dependencies: 'MAY',
+        provenance: 'SHOULD',
+        scope: 'MAY',
+    },
+    status: {
+        subject: 'MUST',
+        condition: 'MUST',
+        timing: 'MUST',
+        evidence: 'MUST',
+        components: 'MUST',
+        dependencies: 'MUST',
+        provenance: 'MUST',
+        scope: 'MAY',
+    },
+};
+// ---------------------------------------------------------------------------
+// Profile hierarchy
+//
+// Status ⊃ Health ⊃ Readiness ⊃ Liveness
+// Each profile's index in PROFILE_IDS is coincidentally its hierarchy level.
+// ---------------------------------------------------------------------------
+/**
+ * Returns the profiles that this profile automatically satisfies,
+ * based on the conceptual hierarchy.
+ *
+ * Example: 'health' → ['health', 'readiness', 'liveness']
+ */
+export function satisfiedProfiles(profile) {
+    const idx = PROFILE_IDS.indexOf(profile);
+    // Include the profile itself and all profiles below it in the hierarchy
+    return PROFILE_IDS.slice(0, idx + 1).reverse();
+}
+//# sourceMappingURL=profiles.js.map

package/dist/profiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profiles.js","sourceRoot":"","sources":["../src/profiles.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,8EAA8E;AAC9E,sBAAsB;AACtB,8EAA8E;AAE9E,MAAM,CAAC,MAAM,WAAW,GAAG,CAAE,UAAU,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAW,CAAC;AAGpF,MAAM,UAAU,WAAW,CAAE,KAAa;IACtC,OAAS,WAAkC,CAAC,QAAQ,CAAE,KAAK,CAAE,CAAC;AAClE,CAAC;AAmBD;;;;;GAKG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAA2C;IACxE,QAAQ,EAAE;QACN,OAAO,EAAE,MAAM;QACf,SAAS,EAAE,MAAM;QACjB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE,MAAM;QAClB,YAAY,EAAE,MAAM;QACpB,UAAU,EAAE,MAAM;QAClB,KAAK,EAAE,MAAM;KAChB;IACD,SAAS,EAAE;QACP,OAAO,EAAE,MAAM;QACf,SAAS,EAAE,MAAM;QACjB,MAAM,EAAE,KAAK;QACb,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE,MAAM;QAClB,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,MAAM;QAClB,KAAK,EAAE,MAAM;KAChB;IACD,MAAM,EAAE;QACJ,OAAO,EAAE,MAAM;QACf,SAAS,EAAE,MAAM;QACjB,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,QAAQ;QAClB,UAAU,EAAE,KAAK;QACjB,YAAY,EAAE,KAAK;QACnB,UAAU,EAAE,QAAQ;QACpB,KAAK,EAAE,KAAK;KACf;IACD,MAAM,EAAE;QACJ,OAAO,EAAE,MAAM;QACf,SAAS,EAAE,MAAM;QACjB,MAAM,EAAE,MAAM;QACd,QAAQ,EAAE,MAAM;QAChB,UAAU,EAAE,MAAM;QAClB,YAAY,EAAE,MAAM;QACpB,UAAU,EAAE,MAAM;QAClB,KAAK,EAAE,KAAK;KACf;CACJ,CAAC;AAEF,8EAA8E;AAC9E,oBAAoB;AACpB,EAAE;AACF,yCAAyC;AACzC,6EAA6E;AAC7E,8EAA8E;AAE9E;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAE,OAAkB;IACjD,MAAM,GAAG,GAAG,WAAW,CAAC,OAAO,CAAE,OAAO,CAAE,CAAC;IAC3C,wEAAwE;IACxE,OAAO,WAAW,CAAC,KAAK,CAAE,CAAC,EAAE,GAAG,GAAG,CAAC,CAAE,CAAC,OAAO,EAA4B,CAAC;AAC/E,CAAC"}

package/package.json

@@ -0,0 +1,35 @@
+{
+  "name": "@open-operational-state/types",
+  "version": "0.1.0",
+  "description": "Canonical TypeScript interfaces for the Open Operational State core model",
+  "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"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/open-operational-state/status-tooling.git",
+    "directory": "packages/types"
+  },
+  "scripts": {
+    "build": "tsc",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "echo 'No tests yet'"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.0"
+  }
+}