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

package/README.md

@@ -0,0 +1,19 @@
+# @42ch/spoke-schemas
+
+Generated TypeScript wire types for [SPOKE](https://github.com/42ch-dev/spoke) — the Standardized Programmable Ontology Knowledge Engine.
+
+Types are produced from the repository JSON Schema SSOT (`schemas/`). Pair with [`@42ch/spoke-operations`](https://www.npmjs.com/package/@42ch/spoke-operations) for pure lifecycle helpers.
+
+## Install
+
+```bash
+pnpm add @42ch/spoke-schemas
+```
+
+## Usage
+
+```ts
+import type { KnowledgeEntry, TimelineEvent } from "@42ch/spoke-schemas";
+```
+
+Protocol docs, concepts, and the lockstep SemVer release policy live in the [SPOKE repository](https://github.com/42ch-dev/spoke).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@42ch/spoke-schemas",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.2",
   "description": "SPOKE wire types — TypeScript generated from JSON Schema",
   "license": "Apache-2.0",
   "repository": {
@@ -27,8 +27,7 @@
     }
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "devDependencies": {
     "tsup": "^8.0.0",

package/src/generated/common/common.ts

@@ -1,159 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * Wire schema version (integer >= 1).
- *
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "SchemaVersion".
- */
-export type SchemaVersion = number;
-/**
- * RFC 3339 UTC datetime string.
- *
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "Timestamp".
- */
-export type Timestamp = string;
-/**
- * L5 Timeline projection tier (open string). Core vocabulary (documented, not enforced): brief, narrative, moment. Wire field name timeline_scale — not tier or projection.
- *
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "TimelineScale".
- */
-export type TimelineScale = string;
-/**
- * Opaque world-history branch identity (l5-fork).
- *
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "ForkId".
- */
-export type ForkId = string;
-
-/**
- * Shared type definitions for SPOKE wire schemas.
- */
-export interface SPOKECommonTypes {
-  [k: string]: unknown | 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.
- *
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "ExtensionMap".
- */
-export interface ExtensionMap {
-  [k: string]:
-    | {
-        [k: string]: unknown | undefined;
-      }
-    | undefined;
-}
-/**
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "SourceSpan".
- */
-export interface SourceSpan {
-  /**
-   * Start offset (inclusive).
-   */
-  start: number;
-  /**
-   * End offset (exclusive).
-   */
-  end: number;
-}
-/**
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "Scope".
- */
-export interface Scope {
-  /**
-   * Protocol-neutral opaque selector. Products map World/Book/chapter/manuscript ids via adapters or op extensions.
-   */
-  scope_id: string;
-  /**
-   * Optional narrow scope to explicit KnowledgeEntries.
-   */
-  entry_ids?: string[];
-  /**
-   * Optional filter by open entry_type vocabulary.
-   */
-  entry_types?: string[];
-  /**
-   * Optional narrow scope to explicit L5 TimelineEvent ids.
-   */
-  timeline_event_ids?: string[];
-  /**
-   * Optional provenance or manuscript locator scope.
-   */
-  source_id?: string;
-  /**
-   * Optional L5 tier filter (brief, narrative, moment).
-   */
-  timeline_scale?: string;
-  /**
-   * Optional L5 branch filter — strict equality on TimelineEvent.fork_id (l5-fork).
-   */
-  fork_id?: string;
-}
-/**
- * Open map of product-owned computable field names to domain values. Shared by KnowledgeEntry body.state and body.computable under l2-computable. Protocol does not require WASM bytecode or executable artifacts.
- *
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "ComputableFieldMap".
- */
-export interface ComputableFieldMap {
-  [k: string]: unknown | undefined;
-}
-/**
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "ComputableLogChange".
- */
-export interface ComputableLogChange {
-  /**
-   * Dot-path or JSON Pointer to changed field within body.computable.
-   */
-  path: string;
-  /**
-   * Opaque JSON — value before change.
-   */
-  previous?: {
-    [k: string]: unknown | undefined;
-  };
-  /**
-   * Opaque JSON — value after change.
-   */
-  next?: {
-    [k: string]: unknown | undefined;
-  };
-}
-/**
- * This interface was referenced by `SPOKECommonTypes`'s JSON-Schema
- * via the `definition` "ComputableLogEntry".
- */
-export interface ComputableLogEntry {
-  /**
-   * When the computable field change was recorded (RFC 3339).
-   */
-  logged_at: string;
-  /**
-   * KnowledgeEntry id whose computable fields changed.
-   */
-  entry_id: string;
-  /**
-   * Field-level change records within body.computable.
-   */
-  changes: ComputableLogChange[];
-  /**
-   * Opaque Session correlation (matches op session_id when omitted on parent context).
-   */
-  session_id?: string;
-  /**
-   * Human-readable presentation note (presentation only).
-   */
-  message?: string;
-}

package/src/generated/common/error-envelope.ts

@@ -1,36 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * Shared ops error shape. Ops responses use either a success payload or a top-level error field — not both.
- */
-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 ExtensionMap {
-  [k: string]:
-    | {
-        [k: string]: unknown | undefined;
-      }
-    | undefined;
-}

package/src/generated/common/index.ts

@@ -1,8 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-export * from './common';
-export type { ErrorEnvelope } from './error-envelope';

package/src/generated/data/assemble-packet.ts

@@ -1,56 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * Wire-only context-assembly payload. No ranking, retrieval, or token-budget fields in v0.1.
- */
-export interface AssemblePacket {
-  /**
-   * Wire schema version (integer >= 1).
-   */
-  schema_version: number;
-  /**
-   * Stable packet id.
-   */
-  packet_id: string;
-  /**
-   * Slim context entries (default). Full KnowledgeEntry embedding is op-specific.
-   */
-  entries: AssembleEntry[];
-  extensions: ExtensionMap;
-}
-/**
- * This interface was referenced by `AssemblePacket`'s JSON-Schema
- * via the `definition` "AssembleEntry".
- */
-export interface AssembleEntry {
-  /**
-   * Referenced KnowledgeEntry id.
-   */
-  entry_id: string;
-  /**
-   * Open string. Same core vocabulary as KnowledgeEntry.entry_type.
-   */
-  entry_type: string;
-  /**
-   * Display name for context window.
-   */
-  canonical_name: string;
-  /**
-   * Optional trimmed text for context window.
-   */
-  snippet?: string;
-}
-/**
- * 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;
-}

package/src/generated/data/finding.ts

@@ -1,109 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * 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;
-}

package/src/generated/data/index.ts

@@ -1,13 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-export type { AssemblePacket } from './assemble-packet';
-export type { Finding } from './finding';
-export type { KnowledgeEntry } from './knowledge-entry';
-export type { Relation } from './relation';
-export type { Rule } from './rule';
-export type { SourceAnchor } from './source-anchor';
-export type { TimelineEvent } from './timeline-event';

package/src/generated/data/knowledge-entry.ts

@@ -1,111 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * Atomic narrative knowledge unit: identity, typed body, provenance envelope.
- */
-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;
-}

package/src/generated/data/relation.ts

@@ -1,60 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * Directed edge between two KnowledgeEntries (or KnowledgeEntry and source anchor).
- */
-export interface Relation {
-  /**
-   * Wire schema version (integer >= 1).
-   */
-  schema_version: number;
-  /**
-   * Stable relation id.
-   */
-  relation_id: string;
-  /**
-   * Open string. Core vocabulary (documented, not enforced): related_to, parent_of, member_of, located_in, participates_in, causes, foreshadows.
-   */
-  relation_type: string;
-  /**
-   * Source endpoint id (KnowledgeEntry or anchor id).
-   */
-  from_id: string;
-  /**
-   * Target endpoint id (KnowledgeEntry or anchor id).
-   */
-  to_id: string;
-  /**
-   * Optional human label.
-   */
-  label?: string;
-  /**
-   * Optional open metadata bag.
-   */
-  metadata?: {
-    [k: string]: unknown | undefined;
-  };
-  /**
-   * RFC 3339 UTC datetime string.
-   */
-  created_at?: string;
-  /**
-   * RFC 3339 UTC datetime string.
-   */
-  updated_at?: string;
-  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 ExtensionMap {
-  [k: string]:
-    | {
-        [k: string]: unknown | undefined;
-      }
-    | undefined;
-}

package/src/generated/data/rule.ts

@@ -1,103 +0,0 @@
-/**
- * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
- * Source: schemas/
- * Generated by: pnpm run codegen
- */
-
-/**
- * Declarative constraint input to check — never checker output.
- */
-export interface Rule {
-  /**
-   * Wire schema version (integer >= 1).
-   */
-  schema_version: number;
-  /**
-   * Stable rule id (opaque to protocol).
-   */
-  rule_id: string;
-  /**
-   * Human-stable name.
-   */
-  canonical_name: string;
-  /**
-   * Open string. Core vocabulary (documented, not enforced): rule, prohibition, style.
-   */
-  kind: string;
-  /**
-   * Declarative constraint text (human- or machine-readable; products choose grammar).
-   */
-  statement?: string;
-  /**
-   * Longer explanation for integrators or authors.
-   */
-  description?: string;
-  /**
-   * Optional ontology filter — open strings matching KnowledgeEntry entry_type vocabulary.
-   */
-  target_entry_types?: string[];
-  /**
-   * Optional checker hint. Core vocabulary (documented, not enforced): info, warning, error.
-   */
-  severity_hint?: string;
-  source_anchor?: SourceAnchor;
-  /**
-   * Open string. Core vocabulary (documented, not enforced): draft, active, deprecated.
-   */
-  status?: string;
-  /**
-   * RFC 3339 UTC datetime string.
-   */
-  created_at?: string;
-  /**
-   * RFC 3339 UTC datetime string.
-   */
-  updated_at?: string;
-  extensions: ExtensionMap;
-}
-/**
- * Optional provenance pointer when rule is anchored to manuscript.
- */
-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;
-}