@celestia-island/plana-types 0.1.0 → 0.1.2

package/bindings/ws/realtime.ts

@@ -0,0 +1,122 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * One PCM audio block (base64-encoded in JSON payloads).
+ */
+export type RealtimeAudioChunk = { 
+/**
+ * MIME type of the payload (e.g. `"audio/pcm"`).
+ */
+mime: string, 
+/**
+ * Sample rate in Hz (16 kHz client→model, 24 kHz model→client).
+ */
+sample_rate: number, 
+/**
+ * Base64-encoded PCM16 LE audio bytes.
+ */
+data_base64: string, };
+
+/**
+ * Client → gateway realtime events (client-sent).
+ *
+ * Canonical vendor-neutral tags (see `docs/en/designs/realtime-media.md`);
+ * wired as JSON-RPC notifications on the session channel. Binary audio
+ * (16 kHz PCM16) travels base64-encoded in `data_base64` (v1) or as WS
+ * binary frames announced via the CEP binary-transfer triple (v2).
+ */
+export type RealtimeClientEvent = { "type": "session.configure", session: RealtimeSessionConfig, } | { "type": "audio.input.append", audio: RealtimeAudioChunk, } | { "type": "audio.input.commit" } | { "type": "audio.input.clear" } | { "type": "video.input.frame", frame: RealtimeVideoFrame, } | { "type": "response.request" } | { "type": "response.cancel" } | { "type": "session.close" };
+
+/**
+ * Gateway → client realtime events (server-sent).
+ *
+ * Canonical vendor-neutral tags (see `docs/en/designs/realtime-media.md`);
+ * wired as JSON-RPC notifications on the session channel. Binary audio
+ * (24 kHz PCM16) travels base64-encoded in `delta.data_base64` (v1) or as
+ * WS binary frames (v2). Clients stop playback on `turn.speech_started`
+ * (barge-in) and treat `response.done` as the terminal billing event for
+ * one response.
+ */
+export type RealtimeServerEvent = { "type": "session.created", session: RealtimeSessionConfig, } | { "type": "session.configured", session: RealtimeSessionConfig, } | { "type": "turn.speech_started", audio_start_ms: bigint, } | { "type": "turn.speech_stopped", audio_end_ms: bigint, } | { "type": "response.started", response_id: string, } | { "type": "response.audio.delta", response_id: string, delta: RealtimeAudioChunk, } | { "type": "response.audio.end", response_id: string, } | { "type": "response.transcript.delta", response_id: string, delta: string, } | { "type": "response.text.delta", response_id: string, delta: string, } | { "type": "response.done", response_id: string, usage: RealtimeUsage, } | { "type": "response.video.frame", response_id: string, frame: RealtimeVideoFrame, } | { "type": "error", code: string, message: string, };
+
+/**
+ * `session.update` payload — the full realtime session configuration.
+ */
+export type RealtimeSessionConfig = { model: string, 
+/**
+ * Output modalities: `["text", "audio"]` or `["text"]`.
+ */
+modalities: Array<string>, 
+/**
+ * Voice id for speech output (vendor-specific).
+ */
+voice?: string, 
+/**
+ * `"pcm16"` — input audio encoding (16 kHz).
+ */
+input_audio_format: string, 
+/**
+ * `"pcm16"` — output audio encoding (24 kHz).
+ */
+output_audio_format: string, 
+/**
+ * System prompt for the session.
+ */
+instructions?: string, turn_detection?: RealtimeTurnDetection, temperature?: number, };
+
+/**
+ * Server-side VAD (voice activity detection) configuration for a realtime
+ * session. Mirrors the upstream `turn_detection` payload.
+ */
+export type RealtimeTurnDetection = { 
+/**
+ * `"server_vad"` | `"semantic_vad"` | `null` (manual commit).
+ */
+type?: string, 
+/**
+ * VAD activation threshold in [-1, 1] (server_vad).
+ */
+threshold?: number, 
+/**
+ * Padding to keep before speech onset, ms.
+ */
+prefix_padding_ms?: number, 
+/**
+ * Silence duration that ends a user turn, ms (default 800).
+ */
+silence_duration_ms?: number, 
+/**
+ * Idle timeout that force-commits the buffer, ms.
+ */
+idle_timeout_ms?: number, 
+/**
+ * Semantic VAD: auto-create a response at end of user turn.
+ */
+create_response?: boolean, 
+/**
+ * Semantic VAD: interrupt the current response when user speech begins.
+ */
+interrupt_response?: boolean, };
+
+/**
+ * Token usage reported in `response.done` — surface for billing.
+ */
+export type RealtimeUsage = { input_tokens: bigint, output_tokens: bigint, total_tokens: bigint, };
+
+/**
+ * One video frame (image) in a realtime session — e.g. a JPEG frame
+ * streamed to the model at ~1 fps, or a generated frame streamed back.
+ */
+export type RealtimeVideoFrame = { 
+/**
+ * MIME type (e.g. `"image/jpeg"`).
+ */
+mime: string, 
+/**
+ * Monotonic frame sequence number for ordering / dedup.
+ */
+frame_seq: number, 
+/**
+ * Base64-encoded image bytes.
+ */
+data_base64: string, };

package/bindings/ws/tasks.ts

@@ -1,6 +1,11 @@
 // This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
 import type { Agent, TaskStatus } from "./core";
 
-export type TaskCreatedParams = { task_id: string, issue_id: string, title: string, description?: string, assigned_agent?: Agent, parent_task_id?: string, badge?: string, tags?: Array<string>, };
+export type TaskCreatedParams = { task_id: string, issue_id: string, title: string, description?: string, assigned_agent?: Agent, parent_task_id?: string, badge?: string, tags?: Array<string>, 
+/**
+ * Topic correlation: the conversation this task was spawned for,
+ * when the spawning chain knows one.
+ */
+conversation_id?: string, };
 
 export type TaskStatusUpdateParams = { task_id: string, status: TaskStatus, progress: number, };

package/index.ts

@@ -0,0 +1,74 @@
+// Every export line references a concrete generated file; the bindings
+// folders carry no per-directory index.ts, so directory-star exports would
+// dangle. A handful of distinct generated types share names across files;
+// the flat-surface winner is resolved by named-export EXCLUSION LISTS, NOT
+// by TypeScript star-export precedence:
+//
+//   - The tools namespace files below that collide with earlier star-exported
+//     files (aporia, kalos, neikos, orexis) are re-exported via an explicit
+//     `export { ... } from` list instead of `export *`. The list is a FULL
+//     enumeration of what that file contributes to the flat surface — a
+//     name in the generated file but not in the list is excluded.
+//   - Each list therefore shadows its file's colliding duplicates on
+//     purpose: the name the flat surface resolves to comes from whichever
+//     OTHER (star-exported) source the earlier line exports, so "first
+//     listed source wins" is the deliberate outcome, not an artifact.
+//   - Shadowed duplicates stay importable via deep imports
+//     (`import type { FileEntry } from "@celestia-island/plana-celestia-types/bindings/tools/kalos"`).
+//
+// The 6 current collisions (flat winner -> shadowed source):
+//
+//   WorkspaceStatusParams    ws/workspace        wins vs tools/aporia
+//   FileEntry                httpTypes           wins vs tools/kalos
+//   FileReadParams           ws/fileBrowsing     wins vs tools/kalos
+//   FileTreeEntry            ws/fileBrowsing     wins vs tools/kalos
+//   ContainerSnapshotParams  ws/stateSync        wins vs tools/neikos
+//   ReportHumanParams        tools/hubris          wins vs tools/orexis
+//
+// MAINTENANCE WARNING: the four exclusion lists are hand-maintained here —
+// there is no generator script that rewrites this file. New types added to
+// the generated aporia/kalos/neikos/orexis files do NOT appear in the flat
+// surface unless their name is appended to the matching `export { ... }`
+// line below (keep the list alphabetically sorted). A type added with a
+// name that already exists on the flat surface is silently shadowed: it
+// must either stay deep-import-only (deliberate shadow) or the existing
+// name must be dropped from the earlier star-exported source.
+export * from "./bindings/engine";
+export * from "./bindings/enums";
+export * from "./bindings/httpTypes";
+export * from "./bindings/mdd";
+export * from "./bindings/model";
+export * from "./bindings/ws/agentLifecycle";
+export * from "./bindings/ws/auth";
+export * from "./bindings/ws/bridgeNetwork";
+export * from "./bindings/ws/core";
+export * from "./bindings/ws/fileBrowsing";
+export * from "./bindings/ws/handshake";
+export * from "./bindings/ws/industrial";
+export * from "./bindings/ws/knowledgeBase";
+export * from "./bindings/ws/layer2";
+export * from "./bindings/ws/llmProvider";
+export * from "./bindings/ws/logs";
+export * from "./bindings/ws/malkuth";
+export * from "./bindings/ws/noa";
+export * from "./bindings/ws/stateSync";
+export * from "./bindings/ws/systemUi";
+export * from "./bindings/ws/tasks";
+export * from "./bindings/ws/views";
+export * from "./bindings/ws/workspace";
+export * from "./bindings/ws/yolo";
+export type { AnomalyDetectParams, AnomalyInfo, AnomalyResult, CausalReasonParams, CausalReasonResult, CorrelationInfo, Hypothesis, LlmChatParams, LlmChatResult, MediaAssetItem, MediaAssetRegisterResult, MediaAssetRetrieveResult, RagDbDeleteParams, RagDbDeleteResult, RagDbReadParams, RagDbReadResult, RagDbStatsParams, RagDbStatsResult, RagDbWriteParams, RagDbWriteResult, RagDocResult, TranslateReportParams, TranslateReportResult, WorkspaceIndexParams, WorkspaceIndexResult, WorkspaceSearchDoc, WorkspaceSearchParams, WorkspaceSearchResult, WorkspaceStatusResult } from "./bindings/tools/aporia";
+export * from "./bindings/tools/eleos";
+export * from "./bindings/tools/epieikeia";
+export * from "./bindings/tools/haplotes";
+export * from "./bindings/tools/hubris";
+export type { Annotation, FileCreateDirParams, FileDeleteParams, FileDeleteResult, FileEditParams, FileEditResult, FileExistsParams, FileExistsResult, FileGetInfoParams, FileInfoResult, FileListParams, FileListResult, FileReadResult, FileTreeListResult, FileWriteParams, FileWriteResult, ListAnnotationsResult, MkDirResult, ResolveAnnotationResult } from "./bindings/tools/kalos";
+export type { CheckWaitParams, ContainerCreateResult, ContainerFilterCriteria, ContainerForkParams, ContainerForkResult, ContainerInfoParams, ContainerInfoResult, ContainerListItem, ContainerListParams, ContainerListResult, ContainerRemoveParams, ContainerRemoveResult, ContainerSnapshotResult, ContainerStartParams, ContainerStartResult, ContainerStopParams, ContainerStopResult, ExecOnContainerParams, ExecResult, GitPushBranchParams, GitPushResult, NewContainerToolParams, NewContainerVolumeMount, SidecarDeliverResult, SidecarKillParams, SidecarSendParams, SidecarSendResult, SidecarSpawnParams, ToolchainEnsureParams, ToolchainEnsureResult, ToolchainListParams, ToolchainListResult, ToolchainProfileInfo, ToolchainVolumeSpec, VolumeInfo, WaitParams } from "./bindings/tools/neikos";
+export type { AgentIntegrityParams, AskResult, AuditAlignmentParams, AuditAlignmentResult, AuditFinding, AuditLegalityParams, AuditLegalityResult, BlockToolParams, CheckResultItem, ComplianceReportParams, ComplianceReportToolResult, ComplianceRule, ComplianceSummary, InspectToolCallParams, ManageSensitivityRulesParams, ReplyResult, ReportDetail, ReportHumanResult, RuleCheckResult, SecurityAuditParams, SecurityStatusParams, SecuritySuggestionsParams, SensitivityRule, SetNetworkPolicyParams, SetRiskThresholdParams, SetSecurityPolicyParams, StandardCheckParams, StandardCheckResult, StandardRegisterResult, UnblockToolParams } from "./bindings/tools/orexis";
+export type { GrantItem, GrantListResponse, MyPermissions, OAuthProvider, RbacUser, RbacUsersResponse } from "./bindings/httpTypes";
+export * from "./bindings/tools/philia";
+export * from "./bindings/tools/polemos";
+export * from "./bindings/tools/skemma";
+export * from "./bindings/tools/skopeo";
+export * from "./bindings/tools/web_automation";
+export * from "./bindings/serde_json/JsonValue";

package/package.json

@@ -1,6 +1,16 @@
 {
   "name": "@celestia-island/plana-types",
-  "version": "0.1.0",
-  "description": "Shared protocol types, TypeScript bindings, and build scripts for the entelecheia multi-agent platform",
-  "packageManager": "pnpm@9.15.0"
+  "version": "0.1.2",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/celestia-island/plana"
+  },
+  "description": "TypeScript bindings for the celestia platform domain profile of the PLANA protocol.",
+  "main": "index.ts",
+  "types": "index.ts",
+  "files": [
+    "index.ts",
+    "bindings"
+  ],
+  "packageManager": "pnpm@11.18.0"
 }

package/Cargo.toml

@@ -1,38 +0,0 @@
-[package]
-name = "plana-types"
-version.workspace = true
-edition.workspace = true
-rust-version.workspace = true
-authors.workspace = true
-license.workspace = true
-description = "Shared protocol types for celestia-island"
-repository = "https://github.com/celestia-island/plana"
-keywords = ["json-rpc", "protocol", "mcp", "typescript", "schema"]
-categories = ["api-bindings", "data-structures", "web-programming::websocket", "network-programming"]
-# Keep generated TS bindings, Python build scripts, and docs out of the published crate.
-exclude = ["bindings", "scripts", ".cargo", "justfile", "package.json", "pnpm-workspace.yaml", "PLAN.md", "res", "examples"]
-
-[features]
-default = []
-tracing-helpers = ["chrono", "tracing-subscriber"]
-
-[dependencies]
-
-kirino = { workspace = true }
-
-chrono = { workspace = true, optional = true }
-hex.workspace = true
-schemars = { workspace = true }
-serde = { workspace = true, features = ["derive"] }
-serde_json.workspace = true
-sha2.workspace = true
-thiserror.workspace = true
-tracing-subscriber = { workspace = true, optional = true }
-ts-rs = { workspace = true }
-uuid = { workspace = true }
-[dev-dependencies]
-
-anyhow.workspace = true
-toml.workspace = true
-[package.metadata.docs.rs]
-all-features = true

package/bindings/FileAnchor.ts

@@ -1,3 +0,0 @@
-// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
-
-export type FileAnchor = { file_path: string, line_start?: number | null, line_end?: number | null, snapshot_hash?: string | null, };

package/bindings/index.ts

@@ -1,47 +0,0 @@
-// WS protocol — foundational shared enums (Agent, AgentStatus, TaskStatus, …).
-export * from "./ws/core";
-// WS protocol — per-domain message param structs.
-export * from "./ws/handshake";
-export * from "./ws/noa";
-export * from "./ws/logs";
-export * from "./ws/agentLifecycle";
-export * from "./ws/tasks";
-export * from "./ws/llmProvider";
-export * from "./ws/stateSync";
-export * from "./ws/knowledgeBase";
-export * from "./ws/layer2";
-export * from "./ws/workspace";
-export * from "./ws/systemUi";
-export * from "./ws/auth";
-export * from "./ws/yolo";
-export * from "./ws/baseMessages";
-export * from "./ws/industrial";
-export * from "./ws/views";
-export * from "./ws/fileBrowsing";
-export * from "./ws/bridgeNetwork";
-// Malkuth supervision protocol types (restart authorization gate).
-// HealthResponse is re-exported under a distinct name because the HTTP REST
-// types below export a same-named type; TS forbids two `export *` collisions.
-export {
-  type GateDecision,
-  type RestartRisk,
-  type RestartGateDecision,
-  type RestartProposal,
-  type ConnectionProtocol,
-  type WorkerState,
-  type ConnectionEndpoint,
-  type DrainRequest,
-  type HealthResponse as MalkuthHealthResponse,
-  type WorkerRegistration,
-  type WorkerStatus,
-} from "./ws/malkuth";
-// HTTP REST API types.
-export * from "./httpTypes";
-// Unified model management types.
-export * from "./model";
-// Shared domain vocabulary enums.
-export * from "./enums";
-// Celestia Engine Protocol (CEP) — model-runtime interchange types.
-export * from "./engine";
-// Per-agent MCP tool request/result types (namespaced).
-export * as mcp from "./mcp";

package/bindings/mcp/index.ts

@@ -1,13 +0,0 @@
-export * as aporia from "./aporia";
-export * as eleos from "./eleos";
-export * as epieikeia from "./epieikeia";
-export * as haplotes from "./haplotes";
-export * as hubris from "./hubris";
-export * as kalos from "./kalos";
-export * as neikos from "./neikos";
-export * as orexis from "./orexis";
-export * as philia from "./philia";
-export * as polemos from "./polemos";
-export * as skemma from "./skemma";
-export * as skopeo from "./skopeo";
-export * as webAutomation from "./webAutomation";

package/bindings/package.json

@@ -1,16 +0,0 @@
-{
-  "name": "@celestia-island/plana-types",
-  "version": "0.1.0",
-  "private": true,
-  "description": "TypeScript type bindings for the plana protocol crate (auto-generated by ts-rs)",
-  "main": "index.ts",
-  "types": "index.ts",
-  "files": [
-    "index.ts",
-    "ws/",
-    "httpTypes.ts",
-    "model.ts",
-    "enums.ts",
-    "mcp/"
-  ]
-}

package/bindings/region.ts

@@ -1,3 +0,0 @@
-// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
-
-export type RegionPolicy = { "china": { icp_number: string | null, data_residency_required: boolean, payment_domestic_only: boolean, pipi_consent_required: boolean, } } | { "european_union": { gdpr_consent_required: boolean, right_to_deletion: boolean, right_to_export: boolean, dpo_contact: string | null, cookie_consent_required: boolean, } } | { "russia": { data_localization_required: boolean, payment_mir_supported: boolean, } } | "free_market";

package/bindings/ws/baseMessages.ts

@@ -1,7 +0,0 @@
-// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
-
-export type BaseAckParams = { message_id: string, };
-
-export type BaseErrorParams = { code: string, message: string, };
-
-export type BaseHeartbeatParams = { timestamp: bigint, };

package/examples/schema_dump.rs

@@ -1,51 +0,0 @@
-/// Schema dump tool — exports JsonSchema from plana types as JSON.
-/// Run: cargo run --example schema_dump > plana_schema.json
-use schemars::schema_for;
-
-fn main() -> Result<(), Box<dyn std::error::Error>> {
-    let schemas = serde_json::json!({
-        "$schema": "http://json-schema.org/draft-07/schema#",
-        "definitions": {
-            "Agent": schema_for!(plana_types::Agent),
-            "AgentBadge": schema_for!(plana_types::AgentBadge),
-            "AgentErrorCode": schema_for!(plana_types::AgentErrorCode),
-            "AgentStatus": schema_for!(plana_types::AgentStatus),
-            "CompletionOutcome": schema_for!(plana_types::CompletionOutcome),
-            "ContainerStatus": schema_for!(plana_types::ContainerStatus),
-            "EmbeddingModel": schema_for!(plana_types::EmbeddingModel),
-            "KnowledgeBaseStatus": schema_for!(plana_types::KnowledgeBaseStatus),
-            "LlmStream": schema_for!(plana_types::LlmStream),
-            "ModelTier": schema_for!(plana_types::ModelTier),
-            "PeriodType": schema_for!(plana_types::PeriodType),
-            "ReportSelection": schema_for!(plana_types::ReportSelection),
-            "ReportType": schema_for!(plana_types::ReportType),
-            "RequestState": schema_for!(plana_types::RequestState),
-            "RetryReason": schema_for!(plana_types::RetryReason),
-            "RouteInfo": schema_for!(plana_types::RouteInfo),
-            "SkillStage": schema_for!(plana_types::SkillStage),
-            "StreamChunkKind": schema_for!(plana_types::StreamChunkKind),
-            "StreamSegment": schema_for!(plana_types::StreamSegment),
-            "StructuredAgentError": schema_for!(plana_types::StructuredAgentError),
-            "TaskStatus": schema_for!(plana_types::TaskStatus),
-            "WorkStatus": schema_for!(plana_types::WorkStatus),
-            "YoloTaskTier": schema_for!(plana_types::YoloTaskTier),
-            "ModelCategory": schema_for!(plana_types::model::ModelCategory),
-            "ModelBackend": schema_for!(plana_types::model::ModelBackend),
-            "ModelDescriptor": schema_for!(plana_types::model::ModelDescriptor),
-            "ModelServerStatus": schema_for!(plana_types::model::ModelServerStatus),
-            "ModelServerInfo": schema_for!(plana_types::model::ModelServerInfo),
-            "ModelServerKind": schema_for!(plana_types::model::ModelServerKind),
-            "ModelServerAction": schema_for!(plana_types::model::ModelServerAction),
-            "ModelInferenceRequest": schema_for!(plana_types::model::ModelInferenceRequest),
-            "ModelInferenceResult": schema_for!(plana_types::model::ModelInferenceResult),
-            "AgentStreamingChunkParams": schema_for!(plana_types::AgentStreamingChunkParams),
-            "McpToolResultParams": schema_for!(plana_types::McpToolResultParams),
-            "TaskCreatedParams": schema_for!(plana_types::TaskCreatedParams),
-            "TaskStatusUpdateParams": schema_for!(plana_types::TaskStatusUpdateParams),
-            "TuiAgentInfo": schema_for!(plana_types::TuiAgentInfo),
-        },
-    });
-    let json = serde_json::to_string_pretty(&schemas)?;
-    println!("{json}");
-    Ok(())
-}

package/pnpm-workspace.yaml

@@ -1,2 +0,0 @@
-packages:
-  - "bindings"