@42ch/spoke-schemas 0.1.0-alpha.1

package/src/generated/ops/check-response.ts

@@ -0,0 +1,165 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Checker findings or wire error. Use findings OR error — not both.
+ */
+export type CheckResponse =
+  | {
+      /**
+       * Success: checker output findings.
+       */
+      findings: Finding[];
+      extensions?: ExtensionMap1;
+    }
+  | {
+      error: ErrorEnvelope;
+      extensions?: ExtensionMap2;
+    };
+
+/**
+ * Checker output — not a KnowledgeEntry body.
+ */
+export interface Finding {
+  /**
+   * Wire schema version (integer >= 1).
+   */
+  schema_version: number;
+  /**
+   * Stable finding id.
+   */
+  finding_id: string;
+  /**
+   * Open string. Core vocabulary (documented, not enforced): info, warning, error.
+   */
+  severity: string;
+  /**
+   * Open string. Core vocabulary (documented, not enforced): open, resolved, dismissed.
+   */
+  status: string;
+  /**
+   * Short finding title.
+   */
+  title: string;
+  /**
+   * Finding detail text.
+   */
+  description: string;
+  /**
+   * Optional checker kind or category.
+   */
+  kind?: string;
+  /**
+   * Optional KnowledgeEntry the finding targets.
+   */
+  target_entry_id?: string;
+  source_anchor?: SourceAnchor;
+  /**
+   * Optional suggested remediation text.
+   */
+  suggested_fix?: string;
+  /**
+   * Optional position hint within source text.
+   */
+  text_position?: {
+    [k: string]: unknown | undefined;
+  };
+  /**
+   * RFC 3339 UTC datetime string.
+   */
+  created_at?: string;
+  /**
+   * RFC 3339 UTC datetime string.
+   */
+  updated_at?: string;
+  extensions: ExtensionMap;
+}
+/**
+ * Optional provenance pointer.
+ */
+export interface SourceAnchor {
+  /**
+   * Wire schema version (integer >= 1).
+   */
+  schema_version: number;
+  /**
+   * Opaque source locator; products define grammar.
+   */
+  source_id: string;
+  span?: SourceSpan;
+  /**
+   * Optional human label for the anchor.
+   */
+  label?: string;
+  /**
+   * Optional MIME type of the referenced source.
+   */
+  mime_type?: string;
+  extensions: ExtensionMap;
+}
+/**
+ * Optional byte or character span within the source.
+ */
+export interface SourceSpan {
+  /**
+   * Start offset (inclusive).
+   */
+  start: number;
+  /**
+   * End offset (exclusive).
+   */
+  end: number;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap1 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Failure: shared error envelope.
+ */
+export interface ErrorEnvelope {
+  /**
+   * Machine-readable error code.
+   */
+  code: string;
+  /**
+   * Human-readable error message.
+   */
+  message: string;
+  /**
+   * Optional structured error context.
+   */
+  details?: {
+    [k: string]: unknown | undefined;
+  };
+  extensions: ExtensionMap;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap2 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}

package/src/generated/ops/compute-request.ts

@@ -0,0 +1,41 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Apply / settle I/O — carry computable updates; merge to static state when settle is true.
+ */
+export interface ComputeRequest {
+  /**
+   * Opaque Session correlation id. Products own Session stores.
+   */
+  session_id: string;
+  /**
+   * Target KnowledgeEntry id.
+   */
+  entry_id: string;
+  computable: ComputableFieldMap;
+  /**
+   * When true, product merges computable into static state at Session end. Defaults to false when omitted.
+   */
+  settle?: boolean;
+  extensions?: ExtensionMap;
+}
+/**
+ * Session-scoped dynamic computable payload (body.computable).
+ */
+export interface ComputableFieldMap {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Optional transport metadata.
+ */
+export interface ExtensionMap {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}

package/src/generated/ops/compute-response.ts

@@ -0,0 +1,90 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Updated computable view (and merged static state when settle was true) or wire error. Use session_id, entry_id, and computable OR error — not both.
+ */
+export type ComputeResponse =
+  | {
+      /**
+       * Echo of request Session correlation id.
+       */
+      session_id: string;
+      /**
+       * Target KnowledgeEntry id.
+       */
+      entry_id: string;
+      computable: ComputableFieldMap;
+      state?: ComputableFieldMap1;
+      extensions?: ExtensionMap;
+    }
+  | {
+      error: ErrorEnvelope;
+      extensions?: ExtensionMap2;
+    };
+
+/**
+ * Success: updated dynamic computable view.
+ */
+export interface ComputableFieldMap {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Merged static state after settle. Products MUST include when request settle was true.
+ */
+export interface ComputableFieldMap1 {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Optional transport metadata.
+ */
+export interface ExtensionMap {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Failure: shared error envelope.
+ */
+export interface ErrorEnvelope {
+  /**
+   * Machine-readable error code.
+   */
+  code: string;
+  /**
+   * Human-readable error message.
+   */
+  message: string;
+  /**
+   * Optional structured error context.
+   */
+  details?: {
+    [k: string]: unknown | undefined;
+  };
+  extensions: ExtensionMap1;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap1 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap2 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}

package/src/generated/ops/index.ts

@@ -0,0 +1,20 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+export type { AssembleRequest } from './assemble-request';
+export type { AssembleResponse } from './assemble-response';
+export type { CheckRequest } from './check-request';
+export type { CheckResponse } from './check-response';
+export type { ComputeRequest } from './compute-request';
+export type { ComputeResponse } from './compute-response';
+export type { ProjectRequest } from './project-request';
+export type { ProjectResponse } from './project-response';
+export type { PromoteRequest } from './promote-request';
+export type { PromoteResponse } from './promote-response';
+export type { RelateRequest } from './relate-request';
+export type { RelateResponse } from './relate-response';
+export type { UpsertRequest } from './upsert-request';
+export type { UpsertResponse } from './upsert-response';

package/src/generated/ops/project-request.ts

@@ -0,0 +1,37 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Init / projection — materialize Session dynamic computable view from static state.
+ */
+export interface ProjectRequest {
+  /**
+   * Opaque Session correlation id. Products own Session stores.
+   */
+  session_id: string;
+  /**
+   * Target KnowledgeEntry id.
+   */
+  entry_id: string;
+  state: ComputableFieldMap;
+  extensions?: ExtensionMap;
+}
+/**
+ * Static computable source (body.state).
+ */
+export interface ComputableFieldMap {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Optional transport metadata.
+ */
+export interface ExtensionMap {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}

package/src/generated/ops/project-response.ts

@@ -0,0 +1,83 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Projected computable view or wire error. Use session_id, entry_id, and computable OR error — not both.
+ */
+export type ProjectResponse =
+  | {
+      /**
+       * Echo of request Session correlation id.
+       */
+      session_id: string;
+      /**
+       * Target KnowledgeEntry id.
+       */
+      entry_id: string;
+      computable: ComputableFieldMap;
+      extensions?: ExtensionMap;
+    }
+  | {
+      error: ErrorEnvelope;
+      extensions?: ExtensionMap2;
+    };
+
+/**
+ * Success: materialized dynamic computable view (body.computable).
+ */
+export interface ComputableFieldMap {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Optional transport metadata.
+ */
+export interface ExtensionMap {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Failure: shared error envelope.
+ */
+export interface ErrorEnvelope {
+  /**
+   * Machine-readable error code.
+   */
+  code: string;
+  /**
+   * Human-readable error message.
+   */
+  message: string;
+  /**
+   * Optional structured error context.
+   */
+  details?: {
+    [k: string]: unknown | undefined;
+  };
+  extensions: ExtensionMap1;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap1 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap2 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}

package/src/generated/ops/promote-request.ts

@@ -0,0 +1,132 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Extract-to-promote: promote a candidate KnowledgeEntry to durable storage.
+ */
+export interface PromoteRequest {
+  candidate: KnowledgeEntry;
+  /**
+   * Optional merge target KnowledgeEntry id.
+   */
+  target_entry_id?: string;
+  extensions?: ExtensionMap1;
+}
+/**
+ * Candidate KnowledgeEntry (typically status provisional).
+ */
+export interface KnowledgeEntry {
+  /**
+   * Wire schema version (integer >= 1).
+   */
+  schema_version: number;
+  /**
+   * Stable KnowledgeEntry id (opaque to protocol).
+   */
+  entry_id: string;
+  /**
+   * Open string. Core vocabulary (documented, not enforced): character, location, event (ontology label; ≠ TimelineEvent wire object), scene, act, organization, item, conflict, info_point, era, worldbuilding, note, research, ability, rule (ontology label; ≠ L6 Rule wire object). Products MAY emit values outside this list.
+   */
+  entry_type: string;
+  /**
+   * Human-stable name.
+   */
+  canonical_name: string;
+  /**
+   * Open string. Core vocabulary (documented, not enforced): provisional, confirmed, deprecated, merged, deleted.
+   */
+  status: string;
+  /**
+   * Structured payload. Typed attributes (summary, tags, attributes) live here — not as protocol siblings. Under l2-computable: optional state (static durable computable) and computable (dynamic Session-scoped projection).
+   */
+  body: {
+    state?: ComputableFieldMap;
+    computable?: ComputableFieldMap1;
+    [k: string]: unknown | undefined;
+  };
+  source_anchor?: SourceAnchor;
+  /**
+   * Optimistic concurrency revision.
+   */
+  revision?: number;
+  /**
+   * RFC 3339 UTC datetime string.
+   */
+  created_at?: string;
+  /**
+   * RFC 3339 UTC datetime string.
+   */
+  updated_at?: string;
+  extensions: ExtensionMap;
+}
+/**
+ * Static durable computable state (l2-computable optional). Authoritative pre-Session and after settle.
+ */
+export interface ComputableFieldMap {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Dynamic Session-scoped computable projection (l2-computable optional). Absent or inert pre-Session; mutates mid-Session only.
+ */
+export interface ComputableFieldMap1 {
+  [k: string]: unknown | undefined;
+}
+/**
+ * Optional provenance pointer.
+ */
+export interface SourceAnchor {
+  /**
+   * Wire schema version (integer >= 1).
+   */
+  schema_version: number;
+  /**
+   * Opaque source locator; products define grammar.
+   */
+  source_id: string;
+  span?: SourceSpan;
+  /**
+   * Optional human label for the anchor.
+   */
+  label?: string;
+  /**
+   * Optional MIME type of the referenced source.
+   */
+  mime_type?: string;
+  extensions: ExtensionMap;
+}
+/**
+ * Optional byte or character span within the source.
+ */
+export interface SourceSpan {
+  /**
+   * Start offset (inclusive).
+   */
+  start: number;
+  /**
+   * End offset (exclusive).
+   */
+  end: number;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}
+/**
+ * Product namespace bag keyed by product-chosen ids matching ^[a-z][a-z0-9_-]*$. Values are opaque JSON objects. Adapters MUST preserve unknown namespaces and keys on round-trip.
+ */
+export interface ExtensionMap1 {
+  [k: string]:
+    | {
+        [k: string]: unknown | undefined;
+      }
+    | undefined;
+}