@ouraihub/aether-contracts 0.0.0-stage → 0.1.0

package/src/generated/RunEvent.ts

@@ -0,0 +1,121 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ContextUsage } from "./ContextUsage";
+import type { Cost } from "./Cost";
+import type { EndStatus } from "./EndStatus";
+import type { KitError } from "./KitError";
+import type { SearchHit } from "./SearchHit";
+import type { ToolOutcome } from "./ToolOutcome";
+import type { ToolSourceKind } from "./ToolSourceKind";
+
+/**
+ * Streamed to the UI; every run ends with exactly one `end`.
+ */
+export type RunEvent = { "kind": "search_start" } | { "kind": "search_result", 
+/**
+ * User query sent to the provider.
+ */
+query: string, 
+/**
+ * Provider id.
+ */
+provider: string, 
+/**
+ * Search hits.
+ */
+hits: Array<SearchHit>, } | { "kind": "round_start", 
+/**
+ * 1-based round number.
+ */
+round: number, } | { "kind": "text_delta", 
+/**
+ * Text chunk.
+ */
+text: string, } | { "kind": "tool_call", 
+/**
+ * Call id.
+ */
+callId: string, 
+/**
+ * Tool name.
+ */
+name: string, 
+/**
+ * Tool source.
+ */
+source: ToolSourceKind, 
+/**
+ * MCP server name.
+ */
+server?: string, } | { "kind": "approval_required", 
+/**
+ * Call id.
+ */
+callId: string, 
+/**
+ * Tool name.
+ */
+name: string, 
+/**
+ * Arguments preview, at most 2000 characters.
+ */
+argsPreview: string, } | { "kind": "tool_result", 
+/**
+ * Call id.
+ */
+callId: string, 
+/**
+ * Outcome.
+ */
+outcome: ToolOutcome, 
+/**
+ * One-line summary.
+ */
+summary: string, 
+/**
+ * Structured data for the host UI.
+ */
+payload?: unknown, } | { "kind": "usage", 
+/**
+ * Total input tokens.
+ */
+inputTokens: number | null, 
+/**
+ * Total output tokens.
+ */
+outputTokens: number | null, 
+/**
+ * Input cache reads.
+ */
+cacheReadTokens: number | null, 
+/**
+ * Input cache writes.
+ */
+cacheWriteTokens: number | null, 
+/**
+ * Reasoning output tokens.
+ */
+reasoningTokens: number | null, 
+/**
+ * Turn cost from the model's pricing; `None` = unknown.
+ */
+cost: Cost | null, } | { "kind": "context", 
+/**
+ * Last request context report or estimate.
+ */
+usage: ContextUsage, } | { "kind": "reasoning_delta", 
+/**
+ * Displayable reasoning fragment.
+ */
+text: string, } | { "kind": "end", 
+/**
+ * Terminal status.
+ */
+status: EndStatus, 
+/**
+ * Set when `status` is `failed`.
+ */
+error?: KitError, 
+/**
+ * `true` when the round limit stopped the tool loop.
+ */
+exhausted?: boolean, };

package/src/generated/RunRequest.ts

@@ -0,0 +1,84 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { ContextRef } from "./ContextRef";
+import type { ImagePart } from "./ImagePart";
+import type { ModelRef } from "./ModelRef";
+import type { PermissionMode } from "./PermissionMode";
+import type { ReasoningEffort } from "./ReasoningEffort";
+import type { SkillRef } from "./SkillRef";
+
+/**
+ * Business input of a run, with no transport or owner identity.
+ */
+export type RunRequest = { 
+/**
+ * App-defined purpose.
+ */
+purpose: string, 
+/**
+ * Explicit model selection.
+ */
+model?: ModelRef | null, 
+/**
+ * Pinned skills.
+ */
+skills: Array<SkillRef>, 
+/**
+ * Host context selection.
+ */
+context?: ContextRef | null, 
+/**
+ * Current input, overridden by an authoritative action source.
+ */
+input: string, 
+/**
+ * Current attached images.
+ */
+images?: Array<ImagePart>, 
+/**
+ * Conversation to continue.
+ */
+conversationId?: string | null, 
+/**
+ * Host-defined history scope.
+ */
+scope?: string | null, 
+/**
+ * Explicit pre-search intent.
+ */
+webSearch?: boolean, 
+/**
+ * Retry the selected candidate.
+ */
+regenerate: boolean, 
+/**
+ * Explicit history head.
+ */
+replyToId?: string | null, 
+/**
+ * Source candidate to retry.
+ */
+retryTurnId?: string | null, 
+/**
+ * Source candidate to translate.
+ */
+translateTurnId?: string | null, 
+/**
+ * Translation target language.
+ */
+targetLanguage?: string | null, 
+/**
+ * UI language.
+ */
+language: string, 
+/**
+ * Requested reasoning effort.
+ */
+reasoningEffort?: ReasoningEffort, 
+/**
+ * Offer image generation.
+ */
+generateImage?: boolean, 
+/**
+ * Host-authorized permission mode.
+ */
+permissionMode?: PermissionMode, };

package/src/generated/RunSnapshot.ts

@@ -0,0 +1,36 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { KitError } from "./KitError";
+import type { RunStatus } from "./RunStatus";
+
+/**
+ * Bounded process-local status, never a transcript or credential cache.
+ */
+export type RunSnapshot = { 
+/**
+ * Service-generated identifier.
+ */
+runId: string, 
+/**
+ * Persisted conversation, if any.
+ */
+conversationId: string | null, 
+/**
+ * Persisted candidate, if any.
+ */
+turnId: string | null, 
+/**
+ * Current lifecycle state.
+ */
+status: RunStatus, 
+/**
+ * Cancellation was requested; not a side-effect rollback guarantee.
+ */
+cancelRequested: boolean, 
+/**
+ * Safe terminal error.
+ */
+error?: KitError, 
+/**
+ * Model round limit reached.
+ */
+exhausted?: boolean, };

package/src/generated/RunStatus.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.
+
+/**
+ * Public run lifecycle state.
+ */
+export type RunStatus = "running" | "completed" | "failed" | "cancelled";

package/src/generated/ScopeState.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.
+
+/**
+ * A declared scope and whether the user's master switch has it on (`mcp_server_scopes`).
+ */
+export type ScopeState = { 
+/**
+ * Scope id.
+ */
+id: string, 
+/**
+ * i18n key of the label.
+ */
+labelKey: string, 
+/**
+ * Needs a second confirmation before enabling.
+ */
+destructive: boolean, 
+/**
+ * In `enabled_scopes`.
+ */
+enabled: boolean, };

package/src/generated/SearchHit.ts

@@ -0,0 +1,18 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * A search result source shown in the UI.
+ */
+export type SearchHit = { 
+/**
+ * Result title.
+ */
+title: string, 
+/**
+ * Result URL.
+ */
+url: string, 
+/**
+ * Result summary.
+ */
+snippet: string, };

package/src/generated/ServerDto.ts

@@ -0,0 +1,44 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { McpTransport } from "./McpTransport";
+import type { ToolDto } from "./ToolDto";
+
+/**
+ * A configured server as shown to the UI: credentials only as key names.
+ */
+export type ServerDto = { 
+/**
+ * Server id.
+ */
+id: string, 
+/**
+ * `[a-z0-9_]{1,24}`; tool names become `mcp_<slug>_<tool>`.
+ */
+slug: string, 
+/**
+ * Display name.
+ */
+name: string, 
+/**
+ * Transport; an http URL is masked.
+ */
+transport: McpTransport, 
+/**
+ * Names of stored header/query/env credentials, never values.
+ */
+secretKeys: Array<string>, 
+/**
+ * Enabled by the user.
+ */
+enabled: boolean, 
+/**
+ * Trusted by the user.
+ */
+trusted: boolean, 
+/**
+ * The user explicitly allowed a private-network address (http only; always false for stdio).
+ */
+allowPrivate: boolean, 
+/**
+ * Last successfully discovered tools.
+ */
+tools: Array<ToolDto>, };

package/src/generated/ServerSave.ts

@@ -0,0 +1,40 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { McpTransport } from "./McpTransport";
+import type { ServerSecret } from "./ServerSecret";
+
+/**
+ * Create (no `id`) or update a server.
+ */
+export type ServerSave = { 
+/**
+ * Existing server id when updating.
+ */
+id?: string, 
+/**
+ * Slug.
+ */
+slug: string, 
+/**
+ * Display name.
+ */
+name: string, 
+/**
+ * Transport; an http URL must carry no credentials.
+ */
+transport: McpTransport, 
+/**
+ * Absent = keep; `{}` = clear.
+ */
+secret?: ServerSecret, 
+/**
+ * Enabled.
+ */
+enabled: boolean, 
+/**
+ * Trusted.
+ */
+trusted: boolean, 
+/**
+ * Allow a private-network address; ignored (stored as false) for stdio.
+ */
+allowPrivate: boolean, };

package/src/generated/ServerSecret.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.
+
+/**
+ * Credentials, write-only, so no `Debug`/`Serialize`. `headers`/`query` belong to
+ * http servers, `env` to stdio servers; the other kind is rejected.
+ */
+export type ServerSecret = { 
+/**
+ * Request headers such as `Authorization`.
+ */
+headers?: { [key in string]?: string }, 
+/**
+ * Query parameters such as `ak`; never stored in `url`.
+ */
+query?: { [key in string]?: string }, 
+/**
+ * Environment variables for a stdio server, such as `GITHUB_TOKEN`.
+ */
+env?: { [key in string]?: string }, };

package/src/generated/SkillDto.ts

@@ -0,0 +1,64 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { SkillFileMeta } from "./SkillFileMeta";
+import type { SkillOrigin } from "./SkillOrigin";
+
+/**
+ * A skill with its full text.
+ */
+export type SkillDto = { 
+/**
+ * Body text.
+ */
+body: string, 
+/**
+ * License text, when packaged.
+ */
+license: string | null, 
+/**
+ * Uninterpreted frontmatter keys, shown as-is.
+ */
+extra: { [key in string]?: string }, 
+/**
+ * Packaged files, sorted by path; empty for hand-written and built-in skills.
+ */
+files: Array<SkillFileMeta>, 
+/**
+ * Skill id.
+ */
+id: string, 
+/**
+ * Frontmatter `name` (unique slug).
+ */
+name: string, 
+/**
+ * Frontmatter `description`.
+ */
+description: string, 
+/**
+ * `None` = unversioned; never invented.
+ */
+version: string | null, 
+/**
+ * Origin.
+ */
+origin: SkillOrigin, 
+/**
+ * Incremented on every content change.
+ */
+revision: number, 
+/**
+ * Body length in characters.
+ */
+bodyChars: number, 
+/**
+ * Unix milliseconds.
+ */
+updatedAt: number, 
+/**
+ * At least one `scripts/**` file is packaged.
+ */
+hasScripts: boolean, 
+/**
+ * Number of packaged files (scripts, references, assets).
+ */
+fileCount: number, };

package/src/generated/SkillFileKind.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.
+
+/**
+ * Which package directory a file came from (docs/14 §2).
+ */
+export type SkillFileKind = "script" | "reference" | "asset";

package/src/generated/SkillFileMeta.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 { SkillFileKind } from "./SkillFileKind";
+
+/**
+ * A packaged file without its content; read it with `Store::file`.
+ */
+export type SkillFileMeta = { 
+/**
+ * Package-relative path with `/` separators, e.g. `scripts/run.py`.
+ */
+path: string, 
+/**
+ * Directory kind.
+ */
+kind: SkillFileKind, 
+/**
+ * Size in bytes.
+ */
+size: number, };

package/src/generated/SkillMeta.ts

@@ -0,0 +1,47 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { SkillOrigin } from "./SkillOrigin";
+
+/**
+ * List entry: metadata only, never the body.
+ */
+export type SkillMeta = { 
+/**
+ * Skill id.
+ */
+id: string, 
+/**
+ * Frontmatter `name` (unique slug).
+ */
+name: string, 
+/**
+ * Frontmatter `description`.
+ */
+description: string, 
+/**
+ * `None` = unversioned; never invented.
+ */
+version: string | null, 
+/**
+ * Origin.
+ */
+origin: SkillOrigin, 
+/**
+ * Incremented on every content change.
+ */
+revision: number, 
+/**
+ * Body length in characters.
+ */
+bodyChars: number, 
+/**
+ * Unix milliseconds.
+ */
+updatedAt: number, 
+/**
+ * At least one `scripts/**` file is packaged.
+ */
+hasScripts: boolean, 
+/**
+ * Number of packaged files (scripts, references, assets).
+ */
+fileCount: number, };

package/src/generated/SkillOrigin.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.
+
+/**
+ * Where a skill came from.
+ */
+export type SkillOrigin = "imported" | "manual" | "builtin";

package/src/generated/SkillRef.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.
+
+/**
+ * A skill selected for one run, pinned to the revision the user confirmed.
+ */
+export type SkillRef = { 
+/**
+ * Skill id.
+ */
+id: string, 
+/**
+ * Revision the user saw; a mismatch is `conflict{reason:"skill_changed"}`.
+ */
+revision: number, };

package/src/generated/Source.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.
+
+/**
+ * Where a skill package comes from. JSON: `{ "path": "C:\\…" }` or
+ * `{ "bytes": { "fileName": "x.zip", "bytes": [80, 75, …] } }`.
+ */
+export type Source = { "path": string } | { "bytes": { 
+/**
+ * Original file name.
+ */
+fileName: string, 
+/**
+ * File content.
+ */
+bytes: Array<number>, } };

package/src/generated/Status.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.
+
+/**
+ * Current server state.
+ */
+export type Status = { 
+/**
+ * Listening.
+ */
+running: boolean, 
+/**
+ * Configured port.
+ */
+port: number, 
+/**
+ * `http://127.0.0.1:<port>/mcp` style URL clients connect to.
+ */
+url: string, 
+/**
+ * Number of registered tools.
+ */
+toolCount: number, };

package/src/generated/TokenRecord.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.
+
+/**
+ * A stored token; the secret itself is never kept.
+ */
+export type TokenRecord = { 
+/**
+ * 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/TokenUsage.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.
+
+/**
+ * Known token counts; missing values remain unknown.
+ */
+export type TokenUsage = { 
+/**
+ * Total input tokens including cache.
+ */
+inputTokens: number | null, 
+/**
+ * Total output tokens including reasoning.
+ */
+outputTokens: number | null, 
+/**
+ * Input cache-read detail.
+ */
+cacheReadTokens: number | null, 
+/**
+ * Input cache-write detail.
+ */
+cacheWriteTokens: number | null, 
+/**
+ * Reasoning output detail.
+ */
+reasoningTokens: number | null, };

package/src/generated/ToolDto.ts

@@ -0,0 +1,23 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { Approval } from "./Approval";
+
+/**
+ * A discovered tool and its per-tool approval default.
+ */
+export type ToolDto = { 
+/**
+ * Tool name as reported by the server.
+ */
+name: string, 
+/**
+ * Description, truncated to 1024 characters.
+ */
+description: string, 
+/**
+ * `annotations.readOnlyHint`; a UI suggestion only, never trusted.
+ */
+readOnly: boolean, 
+/**
+ * Default `ask`.
+ */
+approval: Approval, };

package/src/generated/ToolEffect.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.
+
+/**
+ * What a tool does, declared by the host; drives the permission mode matrix (docs/12 §5.1).
+ */
+export type ToolEffect = "read" | "edit" | "exec" | "other";