@ouraihub/aether-contracts 0.0.0-stage → 0.1.1

package/package.json

@@ -1,6 +1,35 @@
 {
   "name": "@ouraihub/aether-contracts",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "license": "LGPL-3.0-only",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ouraihub/Aether.git",
+    "directory": "packages/contracts"
+  },
+  "type": "module",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "ajv": "8.20.0"
+  },
+  "devDependencies": {
+    "typescript": "5.9.3"
+  },
+  "files": [
+    "src",
+    "!src/**/*.test.ts",
+    "!src/**/*.test.svelte",
+    "!src/**/__tests__"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "generate": "node scripts/generate.mjs",
+    "check-generated": "node scripts/generate.mjs --check",
+    "typecheck": "tsc --noEmit",
+    "test": "node --test test/contracts.test.mjs"
+  }
 }

package/src/generated/Ack.ts

@@ -0,0 +1,10 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Successful acknowledgement.
+ */
+export type Ack = { 
+/**
+ * Always true.
+ */
+ok: true, };

package/src/generated/Approval.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Default approval of a tool in the run catalogue; the host has the final say.
+ */
+export type Approval = "auto" | "ask" | "deny";

package/src/generated/ContextRef.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * App-defined context reference, not an authorization credential.
+ */
+export type ContextRef = { 
+/**
+ * App-defined kind.
+ */
+kind: string, 
+/**
+ * App-defined identifier.
+ */
+id: string, };

package/src/generated/ContextSource.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Provenance of the current request context count.
+ */
+export type ContextSource = "reported" | "estimated" | "unknown";

package/src/generated/ContextUsage.ts

@@ -0,0 +1,27 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ContextSource } from "./ContextSource.js";
+
+/**
+ * Context count and identity of the most recent model request.
+ */
+export type ContextUsage = { 
+/**
+ * Input plus output count.
+ */
+tokens: number | null, 
+/**
+ * Configured real model window, not a fallback safety budget.
+ */
+contextWindow: number | null, 
+/**
+ * Count provenance.
+ */
+source: ContextSource, 
+/**
+ * Endpoint used for the count.
+ */
+endpointId: string | null, 
+/**
+ * Model used for the count.
+ */
+modelId: string | null, };

package/src/generated/Conversation.ts

@@ -0,0 +1,16 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ConversationSummary } from "./ConversationSummary.js";
+import type { Turn } from "./Turn.js";
+
+/**
+ * A display-only conversation, without native messages or database state.
+ */
+export type Conversation = { 
+/**
+ * Conversation metadata.
+ */
+summary: ConversationSummary, 
+/**
+ * All display candidates in sequence order.
+ */
+turns: Array<Turn>, };

package/src/generated/ConversationSummary.ts

@@ -0,0 +1,30 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Metadata projected for the public history list.
+ */
+export type ConversationSummary = { 
+/**
+ * Conversation identity.
+ */
+id: string, 
+/**
+ * Display title.
+ */
+title: string, 
+/**
+ * Optional host-defined scope, not an authorization claim.
+ */
+scope: string | null, 
+/**
+ * Persisted completed context head.
+ */
+selectedTurnId: string | null, 
+/**
+ * Creation time in Unix milliseconds.
+ */
+createdAt: number, 
+/**
+ * Last history update in Unix milliseconds.
+ */
+updatedAt: number, };

package/src/generated/Cost.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Currency } from "./Currency.js";
+
+/**
+ * Cost of one turn, fixed when the turn finishes.
+ */
+export type Cost = { 
+/**
+ * Amount in `currency`.
+ */
+amount: number, 
+/**
+ * Currency of the pricing used.
+ */
+currency: Currency, };

package/src/generated/Currency.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Price currency.
+ */
+export type Currency = "USD" | "CNY";

package/src/generated/Details.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Whitelisted context sent to the UI. Anything else stays in the diagnostic log.
+ */
+export type Details = { field?: string, reason?: string, status?: number, limit?: number, entity?: string, port?: number, errorId?: string, };

package/src/generated/EndStatus.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Terminal status of a run.
+ */
+export type EndStatus = "completed" | "failed" | "cancelled";

package/src/generated/Endpoint.ts

@@ -0,0 +1,54 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { EndpointKey } from "./EndpointKey.js";
+import type { KeyStrategy } from "./KeyStrategy.js";
+import type { Model } from "./Model.js";
+import type { Protocol } from "./Protocol.js";
+
+/**
+ * A stored endpoint as shown to the UI: keys only as masked entries.
+ */
+export type Endpoint = { 
+/**
+ * Endpoint id.
+ */
+id: string, 
+/**
+ * Short name, unique within the provider.
+ */
+slug: string, 
+/**
+ * Base URL as entered; may be empty.
+ */
+baseUrl: string, 
+/**
+ * Wire protocol.
+ */
+protocol: Protocol, 
+/**
+ * API keys ordered by position.
+ */
+keys: Array<EndpointKey>, 
+/**
+ * How a request picks among `keys`.
+ */
+keyStrategy: KeyStrategy, 
+/**
+ * Where model listing is fetched from.
+ */
+probeUrl: string, 
+/**
+ * Selected models in display order.
+ */
+models: Array<Model>, 
+/**
+ * Image generation base URL; `None` = use `base_url`.
+ */
+imageBaseUrl: string | null, 
+/**
+ * Image edit (`/images/edits`) base URL; `None` = use `base_url`.
+ */
+imageEditBaseUrl: string | null, 
+/**
+ * Custom request headers, applied before system headers.
+ */
+headers: { [key in string]?: string }, };

package/src/generated/EndpointKey.ts

@@ -0,0 +1,34 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * One API key of an endpoint as shown to the UI: never the plaintext.
+ */
+export type EndpointKey = { 
+/**
+ * Key id.
+ */
+id: string, 
+/**
+ * Optional user label, at most 40 characters.
+ */
+label: string, 
+/**
+ * Disabled keys are skipped by rotation.
+ */
+enabled: boolean, 
+/**
+ * First 4 and last 4 characters; `None` when the ciphertext cannot be decrypted.
+ */
+masked: string | null, 
+/**
+ * `false` when the ciphertext cannot be decrypted (e.g. another Windows user).
+ */
+readable: boolean, 
+/**
+ * Unix milliseconds until which `FillFirst` skips this key; `None` = usable.
+ */
+exhaustedUntil: number | null, 
+/**
+ * Why the key was set aside, e.g. `HTTP 429`; `None` when usable.
+ */
+exhaustedReason: string | null, };

package/src/generated/EndpointKeySave.ts

@@ -0,0 +1,30 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Adds (no `id`) or patches (with `id`) one key of an endpoint; omitted fields keep.
+ */
+export type EndpointKeySave = { 
+/**
+ * Endpoint the key belongs to.
+ */
+endpointId: string, 
+/**
+ * Existing key id; absent = new key.
+ */
+id?: string, 
+/**
+ * Plaintext key, at most 4096 bytes; required for a new key.
+ */
+key?: string, 
+/**
+ * Label, at most 40 characters; new keys default to `""`.
+ */
+label?: string, 
+/**
+ * New keys default to enabled.
+ */
+enabled?: boolean, 
+/**
+ * `true` clears a set-aside state so the key is tried again.
+ */
+restore?: boolean, };

package/src/generated/EndpointSave.ts

@@ -0,0 +1,45 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { KeyStrategy } from "./KeyStrategy.js";
+import type { ModelSave } from "./ModelSave.js";
+import type { Protocol } from "./Protocol.js";
+
+/**
+ * One endpoint of a save request. Existing endpoints must carry their `id`.
+ */
+export type EndpointSave = { 
+/**
+ * Existing endpoint id; absent = new endpoint.
+ */
+id?: string, 
+/**
+ * Short name, 1–40 of `[a-z0-9-]`.
+ */
+slug: string, 
+/**
+ * Base URL: empty, or `http(s)://` of at most 2048 bytes.
+ */
+baseUrl: string, 
+/**
+ * Wire protocol.
+ */
+protocol: Protocol, 
+/**
+ * Key selection; absent = keep (new endpoints: `RoundRobin`).
+ */
+keyStrategy?: KeyStrategy, 
+/**
+ * Selected models in display order.
+ */
+models: Array<ModelSave>, 
+/**
+ * Image generation base URL: empty/null = use `baseUrl`; absent = keep.
+ */
+imageBaseUrl?: string | null, 
+/**
+ * Image edit (`/images/edits`) base URL: empty/null = use `base_url`; absent = keep.
+ */
+imageEditBaseUrl?: string | null, 
+/**
+ * Custom request headers; absent = keep.
+ */
+headers?: { [key in string]?: string }, };

package/src/generated/ImagePart.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Standard base64 image bytes without a data URL prefix.
+ */
+export type ImagePart = { 
+/**
+ * Supported MIME type.
+ */
+mime: string, 
+/**
+ * Standard base64 bytes.
+ */
+data: string, };

package/src/generated/ImageRef.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Host-controlled display reference; expired images retain their MIME.
+ */
+export type ImageRef = { 
+/**
+ * Supported MIME type.
+ */
+mime: string, 
+/**
+ * Controlled display URL, absent after expiry.
+ */
+url: string | null, };

package/src/generated/IngestBatch.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { IngestEntry } from "./IngestEntry.js";
+
+/**
+ * A batch of frontend log entries.
+ */
+export type IngestBatch = { 
+/**
+ * Entries, at most 50 are accepted per batch.
+ */
+entries: Array<IngestEntry>, 
+/**
+ * Entries the frontend dropped before sending (buffer overflow).
+ */
+droppedCount: number, };

package/src/generated/IngestEntry.ts

@@ -0,0 +1,19 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { IngestLevel } from "./IngestLevel.js";
+
+/**
+ * One frontend log entry.
+ */
+export type IngestEntry = { 
+/**
+ * Severity.
+ */
+level: IngestLevel, 
+/**
+ * Dotted lower-case event name, e.g. `ui.dialog.opened`.
+ */
+event: string, 
+/**
+ * Flat fields: bool, number or short non-secret string.
+ */
+fields?: Record<string, unknown>, };

package/src/generated/IngestLevel.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Frontend log levels.
+ */
+export type IngestLevel = "debug" | "info" | "warn" | "error";

package/src/generated/IngestReceipt.ts

@@ -0,0 +1,14 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * How many entries of a batch were written or refused.
+ */
+export type IngestReceipt = { 
+/**
+ * Entries written to the log.
+ */
+accepted: number, 
+/**
+ * Entries refused (over the batch limit or failing validation).
+ */
+rejected: number, };

package/src/generated/IssuedToken.ts

@@ -0,0 +1,34 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * A freshly issued token: the only response that ever carries the secret, so no `Debug`.
+ */
+export type IssuedToken = { 
+/**
+ * `<prefix>_<base64url>`; shown once.
+ */
+token: string, 
+/**
+ * Token id.
+ */
+id: string, 
+/**
+ * User-given name.
+ */
+name: string, 
+/**
+ * Granted scope ids.
+ */
+scopes: Array<string>, 
+/**
+ * Unix milliseconds.
+ */
+createdAt: number, 
+/**
+ * Unix milliseconds, updated at most once a minute.
+ */
+lastUsedAt: number | null, 
+/**
+ * Unix milliseconds once revoked.
+ */
+revokedAt: number | null, };

package/src/generated/KeyStrategy.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * How an endpoint picks among its enabled keys (docs/43 §3 of the host).
+ */
+export type KeyStrategy = "round_robin" | "fill_first";

package/src/generated/KitError.ts

@@ -0,0 +1,21 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Details } from "./Details.js";
+import type { KitErrorCode } from "./KitErrorCode.js";
+
+/**
+ * A failure crossing a aether boundary. Serializes to `{ code, message, details? }`;
+ * the cause chain is logged by whoever handles the error and never serialized.
+ */
+export type KitError = { 
+/**
+ * Error code.
+ */
+code: KitErrorCode, 
+/**
+ * Safe English fallback text.
+ */
+message: string, 
+/**
+ * Omitted when empty.
+ */
+details?: Details, };

package/src/generated/KitErrorCode.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Stable error codes. The UI translates by code, never by message (docs/00 §7.2).
+ */
+export type KitErrorCode = "bad_request" | "not_found" | "conflict" | "unsupported" | "cancelled" | "unauthorized" | "forbidden" | "rate_limited" | "upstream" | "timeout" | "network" | "needs_config" | "budget_exceeded" | "incompatible_db" | "internal";

package/src/generated/LogEntry.ts

@@ -0,0 +1,26 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * One parsed log line.
+ */
+export type LogEntry = { 
+/**
+ * Position in the returned list, oldest first.
+ */
+seq: number, 
+/**
+ * RFC 3339 UTC timestamp as written; empty for unparsable lines.
+ */
+time: string, 
+/**
+ * `ERROR` | `WARN` | `INFO` | `DEBUG` | `TRACE`.
+ */
+level: 'ERROR' | 'WARN' | 'INFO' | 'DEBUG' | 'TRACE', 
+/**
+ * Event target (module path, or `frontend` for ingested entries).
+ */
+target: string, 
+/**
+ * Message followed by `k=v` fields.
+ */
+message: string, };

package/src/generated/LogLevel.ts

@@ -0,0 +1,6 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Serialized diagnostic level. Native logging configuration uses `tracing::Level`.
+ */
+export type LogLevel = "ERROR" | "WARN" | "INFO" | "DEBUG" | "TRACE";

package/src/generated/LogStatus.ts

@@ -0,0 +1,15 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { LogLevel } from "./LogLevel.js";
+
+/**
+ * Current diagnostic level and availability of the configured log sink.
+ */
+export type LogStatus = { 
+/**
+ * Effective level.
+ */
+level: LogLevel, 
+/**
+ * Whether the most recent write, flush or rotation succeeded.
+ */
+available: boolean, };

package/src/generated/ManualSave.ts

@@ -0,0 +1,30 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Create (no `id`) or edit a hand-written skill.
+ */
+export type ManualSave = { 
+/**
+ * Existing skill id when editing.
+ */
+id?: string, 
+/**
+ * Must equal the current revision when editing (two-window guard).
+ */
+expectedRevision?: number, 
+/**
+ * Slug name.
+ */
+name: string, 
+/**
+ * Description.
+ */
+description: string, 
+/**
+ * Version; absent or `null` = unversioned.
+ */
+version?: string | null, 
+/**
+ * Body.
+ */
+body: string, };

package/src/generated/McpTransport.ts

@@ -0,0 +1,22 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * How the server is reached (docs/27 §2). Requests reject unknown fields.
+ */
+export type McpTransport = { "kind": "http", 
+/**
+ * URL without credentials; masked when listed.
+ */
+url: string, } | { "kind": "stdio", 
+/**
+ * Program to start (a path or a name looked up in `PATH`).
+ */
+command: string, 
+/**
+ * Arguments, passed as is (no shell).
+ */
+args: Array<string>, 
+/**
+ * Absolute working directory; absent = inherited.
+ */
+cwd?: string, };