@capabilityhostprotocol/types 0.1.0

package/README.md

@@ -0,0 +1,123 @@
+# @chp/types
+
+TypeScript protocol types for CHP v0.1.
+
+## Overview
+
+CHP v0.1 makes capability execution visible, replayable, and ready for governance. The package root exports only the schema-aligned v0.1 protocol types and mirrors the JSON Schemas in `schemas/`.
+
+The root export is the public v0.1 protocol surface. It does not expose the
+older internal mesh/governance model.
+
+## Installation
+
+```bash
+npm install @chp/types
+# or
+pnpm add @chp/types
+```
+
+## Usage
+
+```typescript
+import type {
+  CapabilityDescriptor,
+  CorrelationContext,
+  ExecutionEvidence,
+  HostDescriptor,
+  InvocationEnvelope,
+  InvocationResult,
+  ReplayResult,
+} from '@chp/types';
+```
+
+```typescript
+const correlation: CorrelationContext = {
+  correlation_id: 'corr_123',
+};
+
+const descriptor: CapabilityDescriptor = {
+  id: 'example.search_information',
+  version: '0.1.0',
+  description: 'Search for information.',
+  modes: ['sync'],
+  emits: ['execution_started', 'execution_completed', 'execution_failed'],
+};
+```
+
+Use the schema names for v0.1 integrations:
+
+- `CapabilityDescriptor`
+- `HostDescriptor`
+- `InvocationEnvelope`
+- `InvocationResult`
+- `ExecutionEvidence`
+- `CorrelationContext`
+- `ReplayQuery`
+- `ReplayResult`
+
+## Legacy Usage
+
+Older internal mesh/governance helper types are available from the explicit
+legacy subpath while internal systems migrate:
+
+```typescript
+import {
+  createEvidence,
+  createGovernedContext,
+  createSubjectContext,
+  type Evidence,
+  type RiskClass,
+  type AssuranceTier,
+} from '@chp/types/legacy';
+
+// Create a subject
+const subject = createSubjectContext({
+  subject_id: 'user-123',
+  subject_type: 'user',
+  entitlements: ['payment.process', 'user.read'],
+});
+
+// Create governed context
+const ctx = createGovernedContext({
+  capability_id: 'payment.process:1.0.0',
+  subject,
+  governance_mode: 'enforce',
+  risk_class: 'high',
+  minimum_tier: 'S2',
+});
+
+// Emit evidence
+const evidence = createEvidence({
+  evidence_type: 'execution_completed',
+  capability_id: ctx.capability_id,
+  subject_id: subject.subject_id,
+  correlation_id: ctx.correlation_id,
+  assurance_tier: 'S2',
+  payload: { amount: 100.00, currency: 'USD' },
+});
+```
+
+## Type Correspondence
+
+| CHP v0.1 Concept | Python `chp_core` | TypeScript `@chp/types` |
+|---|---|---|
+| Capability descriptor | `CapabilityDescriptor` | `CapabilityDescriptor` |
+| Host descriptor | `HostDescriptor` | `HostDescriptor` |
+| Invocation envelope | `InvocationEnvelope` | `InvocationEnvelope` |
+| Invocation result | `InvocationResult` | `InvocationResult` |
+| Execution evidence | `ExecutionEvidence` | `ExecutionEvidence` |
+| Correlation context | `CorrelationContext` | `CorrelationContext` |
+| Replay query | `ReplayQuery` | `ReplayQuery` |
+| Replay result | `ReplayResult` | `ReplayResult` |
+
+## Verification
+
+```bash
+npm run typecheck --workspace @chp/types
+npm run build --workspace @chp/types
+```
+
+## License
+
+Apache-2.0. See [LICENSE](../../LICENSE).

package/dist/index.d.mts

@@ -0,0 +1,150 @@
+/**
+ * CHP v0.1 protocol types.
+ *
+ * These interfaces mirror the JSON Schemas in the repository root `schemas/`
+ * directory. They are intentionally transport-neutral and do not depend on the
+ * older mesh/governance TypeScript model in this package.
+ */
+declare const CHP_V0_1_VERSION: "0.1";
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
+interface JsonObject {
+    [key: string]: JsonValue;
+}
+type CapabilityRisk = "low" | "medium" | "high" | "critical";
+type ChpV01InvocationMode = "sync" | "async" | "stream" | "fire_and_forget";
+type ChpV01ExecutionOutcome = "success" | "failure" | "denied" | "skipped";
+type AssuranceLevel = "S1" | "S2" | "S3";
+type InvariantEnforcement = "declarative" | "host" | "runtime";
+type InvariantFailureBehavior = "deny" | "warn" | "degrade";
+declare const CHP_V0_1_OUTCOMES: readonly ["success", "failure", "denied", "skipped"];
+declare const CHP_V0_1_CORE_EVIDENCE_TYPES: readonly ["execution_started", "execution_completed", "execution_failed", "execution_denied", "execution_skipped"];
+interface AssuranceMetadata {
+    level: AssuranceLevel;
+    evidence_policy?: string;
+    notes?: string[];
+}
+interface InvariantDescriptor {
+    id: string;
+    kind: string;
+    description?: string;
+    enforcement?: InvariantEnforcement;
+    failure_behavior?: InvariantFailureBehavior;
+    parameters?: JsonObject;
+}
+interface CapabilityDescriptor {
+    id: string;
+    version: string;
+    capability_uri?: string;
+    description: string;
+    modes: ChpV01InvocationMode[];
+    input_schema?: JsonObject;
+    output_schema?: JsonObject;
+    invariants?: InvariantDescriptor[];
+    emits: string[];
+    owner?: string | null;
+    tags?: string[];
+    risk?: CapabilityRisk;
+    assurance?: AssuranceMetadata;
+    metadata?: JsonObject;
+}
+interface HostDescriptor {
+    id: string;
+    version: string;
+    protocol_version: typeof CHP_V0_1_VERSION;
+    kind: string;
+    capabilities: CapabilityDescriptor[];
+    evidence: {
+        store: string;
+        append_only: boolean;
+        [key: string]: JsonValue;
+    };
+    metadata?: JsonObject;
+}
+interface CorrelationContext {
+    correlation_id: string;
+    causation_id?: string | null;
+    parent_correlation_id?: string | null;
+    trace_id?: string | null;
+    baggage?: Record<string, JsonPrimitive>;
+}
+interface InvocationEnvelope {
+    invocation_id: string;
+    capability_id: string;
+    version?: string | null;
+    mode: ChpV01InvocationMode;
+    correlation: CorrelationContext;
+    subject: JsonObject;
+    payload: JsonObject;
+    requested_at: string;
+    metadata?: JsonObject;
+}
+interface DenialReason {
+    code: string;
+    message: string;
+    invariant_id?: string | null;
+    retryable: boolean;
+    details?: JsonObject;
+}
+interface InvocationResult {
+    invocation_id: string;
+    capability_id: string;
+    capability_version?: string | null;
+    correlation: CorrelationContext;
+    outcome: ChpV01ExecutionOutcome;
+    success: boolean;
+    data?: JsonValue;
+    error?: JsonObject | null;
+    denial?: DenialReason | null;
+    evidence_ids: string[];
+    started_at?: string | null;
+    completed_at: string;
+}
+interface ExecutionEvidence {
+    event_id: string;
+    event_type: string;
+    invocation_id: string;
+    capability_id: string;
+    capability_version?: string | null;
+    host_id: string;
+    correlation: CorrelationContext;
+    timestamp: string;
+    sequence: number;
+    outcome?: ChpV01ExecutionOutcome | null;
+    payload: JsonObject;
+    redacted: boolean;
+    error?: JsonObject | null;
+    denial?: DenialReason | null;
+    assurance: AssuranceMetadata;
+}
+interface ReplayQuery {
+    correlation_id: string;
+    limit?: number | null;
+    since_sequence?: number | null;
+    include_payloads?: boolean;
+}
+interface ReplayResult {
+    correlation_id: string;
+    events: ExecutionEvidence[];
+    event_count: number;
+    replayed_at: string;
+}
+declare function capabilityUri(descriptor: Pick<CapabilityDescriptor, "id" | "version">): string;
+declare function isChpV01Outcome(value: string): value is ChpV01ExecutionOutcome;
+
+/**
+ * Public TypeScript types for CHP v0.1.
+ *
+ * The root export is intentionally limited to the open-source protocol surface
+ * described by `spec/chp-v0.1.md` and the JSON Schemas in `schemas/`.
+ *
+ * Internal legacy mesh/governance helpers are available from
+ * `@auxo/ts-types/legacy`.
+ *
+ * @packageDocumentation
+ */
+
+declare const CHP_VERSION = "0.1";
+declare const VERSION = "0.1.0";
+
+export { type AssuranceLevel, type AssuranceMetadata, CHP_V0_1_CORE_EVIDENCE_TYPES, CHP_V0_1_OUTCOMES, CHP_V0_1_VERSION, CHP_VERSION, type CapabilityDescriptor, type CapabilityRisk, type ChpV01ExecutionOutcome, type ChpV01InvocationMode, type CorrelationContext, type DenialReason, type ExecutionEvidence, type HostDescriptor, type InvariantDescriptor, type InvariantEnforcement, type InvariantFailureBehavior, type InvocationEnvelope, type InvocationResult, type JsonObject, type JsonPrimitive, type JsonValue, type ReplayQuery, type ReplayResult, VERSION, capabilityUri, isChpV01Outcome };

package/dist/index.d.ts

@@ -0,0 +1,150 @@
+/**
+ * CHP v0.1 protocol types.
+ *
+ * These interfaces mirror the JSON Schemas in the repository root `schemas/`
+ * directory. They are intentionally transport-neutral and do not depend on the
+ * older mesh/governance TypeScript model in this package.
+ */
+declare const CHP_V0_1_VERSION: "0.1";
+type JsonPrimitive = string | number | boolean | null;
+type JsonValue = JsonPrimitive | JsonValue[] | JsonObject;
+interface JsonObject {
+    [key: string]: JsonValue;
+}
+type CapabilityRisk = "low" | "medium" | "high" | "critical";
+type ChpV01InvocationMode = "sync" | "async" | "stream" | "fire_and_forget";
+type ChpV01ExecutionOutcome = "success" | "failure" | "denied" | "skipped";
+type AssuranceLevel = "S1" | "S2" | "S3";
+type InvariantEnforcement = "declarative" | "host" | "runtime";
+type InvariantFailureBehavior = "deny" | "warn" | "degrade";
+declare const CHP_V0_1_OUTCOMES: readonly ["success", "failure", "denied", "skipped"];
+declare const CHP_V0_1_CORE_EVIDENCE_TYPES: readonly ["execution_started", "execution_completed", "execution_failed", "execution_denied", "execution_skipped"];
+interface AssuranceMetadata {
+    level: AssuranceLevel;
+    evidence_policy?: string;
+    notes?: string[];
+}
+interface InvariantDescriptor {
+    id: string;
+    kind: string;
+    description?: string;
+    enforcement?: InvariantEnforcement;
+    failure_behavior?: InvariantFailureBehavior;
+    parameters?: JsonObject;
+}
+interface CapabilityDescriptor {
+    id: string;
+    version: string;
+    capability_uri?: string;
+    description: string;
+    modes: ChpV01InvocationMode[];
+    input_schema?: JsonObject;
+    output_schema?: JsonObject;
+    invariants?: InvariantDescriptor[];
+    emits: string[];
+    owner?: string | null;
+    tags?: string[];
+    risk?: CapabilityRisk;
+    assurance?: AssuranceMetadata;
+    metadata?: JsonObject;
+}
+interface HostDescriptor {
+    id: string;
+    version: string;
+    protocol_version: typeof CHP_V0_1_VERSION;
+    kind: string;
+    capabilities: CapabilityDescriptor[];
+    evidence: {
+        store: string;
+        append_only: boolean;
+        [key: string]: JsonValue;
+    };
+    metadata?: JsonObject;
+}
+interface CorrelationContext {
+    correlation_id: string;
+    causation_id?: string | null;
+    parent_correlation_id?: string | null;
+    trace_id?: string | null;
+    baggage?: Record<string, JsonPrimitive>;
+}
+interface InvocationEnvelope {
+    invocation_id: string;
+    capability_id: string;
+    version?: string | null;
+    mode: ChpV01InvocationMode;
+    correlation: CorrelationContext;
+    subject: JsonObject;
+    payload: JsonObject;
+    requested_at: string;
+    metadata?: JsonObject;
+}
+interface DenialReason {
+    code: string;
+    message: string;
+    invariant_id?: string | null;
+    retryable: boolean;
+    details?: JsonObject;
+}
+interface InvocationResult {
+    invocation_id: string;
+    capability_id: string;
+    capability_version?: string | null;
+    correlation: CorrelationContext;
+    outcome: ChpV01ExecutionOutcome;
+    success: boolean;
+    data?: JsonValue;
+    error?: JsonObject | null;
+    denial?: DenialReason | null;
+    evidence_ids: string[];
+    started_at?: string | null;
+    completed_at: string;
+}
+interface ExecutionEvidence {
+    event_id: string;
+    event_type: string;
+    invocation_id: string;
+    capability_id: string;
+    capability_version?: string | null;
+    host_id: string;
+    correlation: CorrelationContext;
+    timestamp: string;
+    sequence: number;
+    outcome?: ChpV01ExecutionOutcome | null;
+    payload: JsonObject;
+    redacted: boolean;
+    error?: JsonObject | null;
+    denial?: DenialReason | null;
+    assurance: AssuranceMetadata;
+}
+interface ReplayQuery {
+    correlation_id: string;
+    limit?: number | null;
+    since_sequence?: number | null;
+    include_payloads?: boolean;
+}
+interface ReplayResult {
+    correlation_id: string;
+    events: ExecutionEvidence[];
+    event_count: number;
+    replayed_at: string;
+}
+declare function capabilityUri(descriptor: Pick<CapabilityDescriptor, "id" | "version">): string;
+declare function isChpV01Outcome(value: string): value is ChpV01ExecutionOutcome;
+
+/**
+ * Public TypeScript types for CHP v0.1.
+ *
+ * The root export is intentionally limited to the open-source protocol surface
+ * described by `spec/chp-v0.1.md` and the JSON Schemas in `schemas/`.
+ *
+ * Internal legacy mesh/governance helpers are available from
+ * `@auxo/ts-types/legacy`.
+ *
+ * @packageDocumentation
+ */
+
+declare const CHP_VERSION = "0.1";
+declare const VERSION = "0.1.0";
+
+export { type AssuranceLevel, type AssuranceMetadata, CHP_V0_1_CORE_EVIDENCE_TYPES, CHP_V0_1_OUTCOMES, CHP_V0_1_VERSION, CHP_VERSION, type CapabilityDescriptor, type CapabilityRisk, type ChpV01ExecutionOutcome, type ChpV01InvocationMode, type CorrelationContext, type DenialReason, type ExecutionEvidence, type HostDescriptor, type InvariantDescriptor, type InvariantEnforcement, type InvariantFailureBehavior, type InvocationEnvelope, type InvocationResult, type JsonObject, type JsonPrimitive, type JsonValue, type ReplayQuery, type ReplayResult, VERSION, capabilityUri, isChpV01Outcome };

package/dist/index.js

@@ -0,0 +1,66 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  CHP_V0_1_CORE_EVIDENCE_TYPES: () => CHP_V0_1_CORE_EVIDENCE_TYPES,
+  CHP_V0_1_OUTCOMES: () => CHP_V0_1_OUTCOMES,
+  CHP_V0_1_VERSION: () => CHP_V0_1_VERSION,
+  CHP_VERSION: () => CHP_VERSION,
+  VERSION: () => VERSION,
+  capabilityUri: () => capabilityUri,
+  isChpV01Outcome: () => isChpV01Outcome
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/v0_1.ts
+var CHP_V0_1_VERSION = "0.1";
+var CHP_V0_1_OUTCOMES = [
+  "success",
+  "failure",
+  "denied",
+  "skipped"
+];
+var CHP_V0_1_CORE_EVIDENCE_TYPES = [
+  "execution_started",
+  "execution_completed",
+  "execution_failed",
+  "execution_denied",
+  "execution_skipped"
+];
+function capabilityUri(descriptor) {
+  return `${descriptor.id}:${descriptor.version}`;
+}
+function isChpV01Outcome(value) {
+  return CHP_V0_1_OUTCOMES.includes(value);
+}
+
+// src/index.ts
+var CHP_VERSION = "0.1";
+var VERSION = "0.1.0";
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  CHP_V0_1_CORE_EVIDENCE_TYPES,
+  CHP_V0_1_OUTCOMES,
+  CHP_V0_1_VERSION,
+  CHP_VERSION,
+  VERSION,
+  capabilityUri,
+  isChpV01Outcome
+});

package/dist/index.mjs

@@ -0,0 +1,34 @@
+// src/v0_1.ts
+var CHP_V0_1_VERSION = "0.1";
+var CHP_V0_1_OUTCOMES = [
+  "success",
+  "failure",
+  "denied",
+  "skipped"
+];
+var CHP_V0_1_CORE_EVIDENCE_TYPES = [
+  "execution_started",
+  "execution_completed",
+  "execution_failed",
+  "execution_denied",
+  "execution_skipped"
+];
+function capabilityUri(descriptor) {
+  return `${descriptor.id}:${descriptor.version}`;
+}
+function isChpV01Outcome(value) {
+  return CHP_V0_1_OUTCOMES.includes(value);
+}
+
+// src/index.ts
+var CHP_VERSION = "0.1";
+var VERSION = "0.1.0";
+export {
+  CHP_V0_1_CORE_EVIDENCE_TYPES,
+  CHP_V0_1_OUTCOMES,
+  CHP_V0_1_VERSION,
+  CHP_VERSION,
+  VERSION,
+  capabilityUri,
+  isChpV01Outcome
+};