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

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

@@ -0,0 +1,168 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Promoted KnowledgeEntry or wire error. Use knowledge_entry OR error — not both.
+ */
+export type PromoteResponse =
+  | {
+      knowledge_entry: KnowledgeEntry;
+      /**
+       * Optional id of KnowledgeEntry superseded during merge.
+       */
+      superseded_id?: string;
+      extensions?: ExtensionMap1;
+    }
+  | {
+      error: ErrorEnvelope;
+      extensions?: ExtensionMap2;
+    };
+
+/**
+ * Success: promoted KnowledgeEntry.
+ */
+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;
+}
+/**
+ * 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/relate-request.ts

@@ -0,0 +1,77 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Create or update a Relation.
+ */
+export interface RelateRequest {
+  relation: Relation;
+  extensions?: ExtensionMap1;
+}
+/**
+ * Relation to create or update.
+ */
+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;
+}
+/**
+ * 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;
+}

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

@@ -0,0 +1,113 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Persisted Relation or wire error. Use relation OR error — not both.
+ */
+export type RelateResponse =
+  | {
+      relation: Relation;
+      extensions?: ExtensionMap1;
+    }
+  | {
+      error: ErrorEnvelope;
+      extensions?: ExtensionMap2;
+    };
+
+/**
+ * Success: persisted Relation.
+ */
+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;
+}
+/**
+ * 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/upsert-request.ts

@@ -0,0 +1,137 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Create or update one or more KnowledgeEntries by stable id.
+ */
+export interface UpsertRequest {
+  /**
+   * KnowledgeEntries to create or update.
+   *
+   * @minItems 1
+   */
+  knowledge_entries: [KnowledgeEntry, ...KnowledgeEntry[]];
+  /**
+   * Opaque idempotency hint (no server semantics in v0.1).
+   */
+  idempotency_key?: string;
+  extensions?: ExtensionMap1;
+}
+/**
+ * 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;
+}
+/**
+ * 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;
+}

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

@@ -0,0 +1,185 @@
+/**
+ * AUTO-GENERATED FROM JSON SCHEMA - DO NOT MODIFY
+ * Source: schemas/
+ * Generated by: pnpm run codegen
+ */
+
+/**
+ * Persisted KnowledgeEntry view or wire error. Use knowledge_entries OR error — not both.
+ */
+export type UpsertResponse =
+  | {
+      /**
+       * Success: persisted KnowledgeEntries.
+       */
+      knowledge_entries: KnowledgeEntry[];
+      /**
+       * Optional per-KnowledgeEntry rejections (success branch only).
+       */
+      rejected?: UpsertRejected[];
+      extensions?: ExtensionMap1;
+    }
+  | {
+      error: ErrorEnvelope;
+      extensions?: ExtensionMap2;
+    };
+
+/**
+ * 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;
+}
+export interface UpsertRejected {
+  /**
+   * Rejected KnowledgeEntry id.
+   */
+  entry_id: string;
+  /**
+   * Machine-readable rejection code.
+   */
+  code: string;
+  /**
+   * Human-readable rejection message.
+   */
+  message: 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 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/index.ts

@@ -0,0 +1,4 @@
+/**
+ * @42ch/spoke-schemas — SPOKE wire types (generated from JSON Schema).
+ */
+export * from "./generated";