@celestia-island/plana-types 0.1.0

package/bindings/ws/llmProvider.ts

@@ -0,0 +1,74 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { GenerationTier, HardwareRequirements, ModelCapability } from "../model";
+import type { PeriodType } from "./core";
+
+export type ApiKeyInfoResponseParams = { info: KeyInfo, };
+
+export type ConfiguredProviderInfo = { provider_name: string, display_name: string, api_endpoint?: string, default_model: string, is_enabled: boolean, };
+
+export type ConfiguredProvidersListParams = { providers: Array<ConfiguredProviderInfo>, };
+
+export type EndpointValidatedParams = { provider_name: string, is_reachable: boolean, latency_ms?: bigint, error?: string, };
+
+export type EntrypointApiConfigInfo = { protocol: string, base_url: string, chat_endpoint: string, models_endpoint?: string, auth_type: string, auth_header?: string, env_var: string, };
+
+export type EntrypointConfigInfo = { id: string, name: { [key in string]: string }, type: string, billing_type: string, plan_tier: string, api: EntrypointApiConfigInfo, defaults: EntrypointDefaultsInfo, quotas: Array<QuotaInfo>, models: Array<string>, };
+
+export type EntrypointDefaultsInfo = { deep: Array<string>, normal: Array<string>, basic: Array<string>, max_concurrent: MaxConcurrentInfo, };
+
+export type KeyInfo = { provider: string, display_name: string, has_key: boolean, created_at: string, updated_at: string, source: string, };
+
+export type KeysListResponseParams = { keys: Array<KeyInfo>, };
+
+export type LlmProviderConfiguredParams = { provider_name: string, success: boolean, error?: string, };
+
+export type MaxConcurrentInfo = { deep: number, normal: number, basic: number, };
+
+export type ModelFsInfo = { id: string, name: string, provider_id: string, context_window: bigint, max_output_tokens: bigint, supports_vision: boolean, supports_function_calling: boolean, supports_streaming: boolean, supports_reasoning: boolean, tags: Array<string>, 
+/**
+ * Fine-grained capability flags. When non-empty, supersedes the boolean
+ * flags above for skill→model routing. See [`crate::ModelCapability`].
+ */
+capabilities: Array<ModelCapability>, 
+/**
+ * Generation quality tier (image / 3D generation models only).
+ * See [`crate::GenerationTier`].
+ */
+generation_tier?: GenerationTier, 
+/**
+ * Hardware requirements (local generative models only).
+ * See [`crate::HardwareRequirements`].
+ */
+hardware_requirements?: HardwareRequirements, pricing?: ModelFsPricing, rate_multiplier?: number, rate_rules: Array<RateRuleInfo>, };
+
+export type ModelFsInfoParams = { models: Array<ModelFsInfo>, };
+
+export type ModelFsPricing = { input_per_million?: number, output_per_million?: number, cached_per_million?: number, };
+
+export type ModelProviderConfigUpdatedParams = { provider_name: string, success: boolean, error?: string, };
+
+export type ProviderCapabilitiesInfo = { streaming: boolean, function_calling: boolean, vision: boolean, reasoning: boolean, };
+
+export type ProviderDeletedParams = { provider_name: string, success: boolean, error?: string, };
+
+export type ProviderEditedParams = { provider_name: string, success: boolean, error?: string, };
+
+export type ProviderFsInfo = { id: string, name: { [key in string]: string }, protocol: string, category: string, base_url?: string, entry_points: Array<EntrypointConfigInfo>, models: Array<ModelFsInfo>, capabilities: ProviderCapabilitiesInfo, limits: ProviderLimitsInfo, pricing_model: string, };
+
+export type ProviderFsInfoParams = { providers: Array<ProviderFsInfo>, };
+
+export type ProviderLimitsInfo = { max_concurrent: number, rate_limit_per_minute?: number, timeout_seconds: bigint, };
+
+export type ProviderRenamedParams = { provider_name: string, new_display_name: string, success: boolean, error?: string, };
+
+export type QuotaInfo = { data_limit: bigint, period_hours?: number, period_days?: number, billing_metric: string, };
+
+export type RateRuleInfo = { timezone_offset: number, peak_start: number, peak_end: number, peak_multiplier: number, off_peak_multiplier: number, };
+
+export type UsagePeriodData = { user_id: string, period_type: PeriodType, used_tokens: bigint, cost: number, start_time: string, remaining_tokens?: bigint, remaining_cost?: number, };
+
+export type UsagePeriodResponseParams = { data: Array<UsagePeriodData>, };
+
+export type UserConfigResponseParams = { config: UserInfoConfig, };
+
+export type UserInfoConfig = { preferred_language: string, default_models: { [key in string]: string }, enabled_providers: Array<string>, enabled_models: Array<string>, model_priorities: { [key in string]: number }, auto_import_from_env: Array<string>, };

package/bindings/ws/logs.ts

@@ -0,0 +1,11 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type ContainerLogEntryParams = { instance_uuid: string, entry: LogEntryData, };
+
+export type LogEntryData = { source: string, instance_uuid?: string, level: string, target?: string, message: string, fields: Record<string, unknown>, created_at: string, };
+
+export type ServerLogEntryParams = { entry: LogEntryData, };
+
+export type SubscribeLogsResponseParams = { ok: boolean, error?: string, entries: Array<LogEntryData>, };
+
+export type UnsubscribeLogsResponseParams = { ok: boolean, error?: string, };

package/bindings/ws/malkuth.ts

@@ -0,0 +1,62 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Describes how clients connect to a supervised worker.
+ */
+export type ConnectionEndpoint = { protocol: ConnectionProtocol, address: string, port: number, };
+
+export type ConnectionProtocol = "http" | "ws" | "ipc" | "tcp";
+
+/**
+ * External request to drain (gracefully shut down) a supervised worker.
+ * Sent to malkuth daemon after a restart proposal has been approved.
+ */
+export type DrainRequest = { 
+/**
+ * Which worker to drain.
+ */
+worker_id: string, 
+/**
+ * Authorization: must match a previously approved GateDecision.proposal_id.
+ */
+proposal_id: string, 
+/**
+ * Optional drain budget in seconds (default derived from worker config).
+ */
+drain_budget_secs: bigint | null, };
+
+export type GateDecision = "allow" | "review" | "block";
+
+/**
+ * Health probe response returned by each worker at `/healthz` or `/readyz`.
+ */
+export type HealthResponse = { worker_id: string, healthy: boolean, ready: boolean, 
+/**
+ * If not ready, the reason (e.g. "draining", "starting").
+ */
+not_ready_reason: string | null, uptime_secs: bigint, version: string, };
+
+/**
+ * OreXis LAYER3_PREFLIGHT_GUARD gate decision for a restart proposal.
+ */
+export type RestartGateDecision = { proposal_id: string, decision: GateDecision, findings: Array<string>, reason: string, };
+
+/**
+ * A rebuild has completed and restart is proposed for a supervised worker.
+ */
+export type RestartProposal = { proposal_id: string, worker_id: string, repo_path: string, git_diff_summary: string, affected_services: Array<string>, risk_estimate: RestartRisk, };
+
+export type RestartRisk = "low" | "medium" | "high" | "critical";
+
+/**
+ * Registers a new worker with the malkuth supervisor.
+ * Sent by a worker at startup to announce its presence and capabilities.
+ */
+export type WorkerRegistration = { worker_id: string, worker_kind: string, repo_path: string, connections: Array<ConnectionEndpoint>, health_check_path: string | null, drain_budget_secs: bigint, };
+
+export type WorkerState = "running" | "draining" | "stopped" | "crashed";
+
+/**
+ * Current status of a supervised worker returned by malkuth when queried.
+ */
+export type WorkerStatus = { worker_id: string, state: WorkerState, pid: number | null, restart_count: number, last_restart_at: string | null, connections: Array<ConnectionEndpoint>, };

package/bindings/ws/noa.ts

@@ -0,0 +1,17 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type NoaAuthRequestParams = { workspace_id: string, branches: Array<string>, suggested_branch: string, reason: string, };
+
+export type NoaAuthResponseParams = { workspace_id: string, selected_branch: string, branch_base?: string, approved: boolean, };
+
+export type NoaEvent = { event_id: string, event_type: string, timestamp: string, file_path?: string, content_hash?: string, metadata?: Record<string, unknown>, };
+
+export type NoaEventSyncAckParams = { workspace_id: string, last_event_id: string, };
+
+export type NoaEventSyncParams = { workspace_id: string, events: Array<NoaEvent>, direction?: string, };
+
+export type NoaHandshakeResponseParams = { workspace_id: string, repo_id: string, current_branch: string, noa_initialized: boolean, gitignore_updated: boolean, };
+
+export type NoaReadyParams = { workspace_id: string, branch: string, snapshot_id: string, };
+
+export type RequestNoaHandshakeParams = { workspace_id: string, remote_name: string, remote_path: string, };

package/bindings/ws/stateSync.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 { TuiAgentInfo } from "./agentLifecycle";
+import type { ContainerStatus, TaskStatus } from "./core";
+
+export type ContainerInfo = { id: string, name: string, status: ContainerStatus, cpu_usage: number, memory_mb: bigint, image: string, agent_type?: string, parent_id?: string, branch_level: number, is_cosmos: boolean, branch?: string, is_read_only: boolean, badge?: string, current_skill?: string, workspace_id?: string, workspace_path?: string, git_remote_url?: string, git_branch?: string, };
+
+export type ContainerSnapshotData = { version: bigint, timestamp: bigint, containers: Array<ContainerInfo>, };
+
+export type ContainerSnapshotParams = { snapshot: ContainerSnapshotData, };
+
+export type GlobalSnapshotData = { version: bigint, timestamp: bigint, agents: Array<TuiAgentInfo>, containers: Array<ContainerInfo>, active_tasks: Array<TaskInfo>, };
+
+export type GlobalSnapshotParams = { snapshot: GlobalSnapshotData, };
+
+export type TaskInfo = { id: string, issue_id: string, title: string, status: TaskStatus, progress: number, assigned_agent?: string, };
+
+export type TasksSnapshotData = { version: bigint, timestamp: bigint, tasks: Array<TaskInfo>, };
+
+export type TasksSnapshotParams = { snapshot: TasksSnapshotData, };

package/bindings/ws/systemUi.ts

@@ -0,0 +1,5 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type WebUiControlResponseParams = { command: string, success: boolean, message: string, url?: string, };
+
+export type WebUiStatusParams = { running: boolean, url?: string, container_id?: string, };

package/bindings/ws/tasks.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.
+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 TaskStatusUpdateParams = { task_id: string, status: TaskStatus, progress: number, };

package/bindings/ws/views.ts

@@ -0,0 +1,163 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+/**
+ * Dashboard layout — a collection of views arranged in a grid.
+ */
+export type DashboardLayout = { 
+/**
+ * Workspace ID this dashboard belongs to.
+ */
+workspace_id: string, 
+/**
+ * Dashboard name.
+ */
+name: string, 
+/**
+ * All view instances in this dashboard.
+ */
+views: Array<ViewInstance>, 
+/**
+ * Grid columns count (0 = auto).
+ */
+grid_columns: number, };
+
+/**
+ * Push a dashboard layout update to connected clients.
+ */
+export type DashboardLayoutPushParams = { layout: DashboardLayout, };
+
+/**
+ * A widget inside a webui dashboard descriptor (P3#A4).
+ *
+ * Mirrors the shittim-chest `WidgetDescriptor` (dashboard.ts) so the
+ * agent-side push tool can construct widgets the webui understands
+ * without knowing its internals.
+ */
+export type DashboardWidget = { 
+/**
+ * Unique widget id within the layout.
+ */
+id: string, 
+/**
+ * Renderer discriminator ("gauge-row", "node-graph", "data-table", …).
+ */
+type: string, 
+/**
+ * Optional display title.
+ */
+title?: string, 
+/**
+ * Data-source label (free-form).
+ */
+source: string, 
+/**
+ * Grid span hint ("full" | "half").
+ */
+span?: string, 
+/**
+ * Widget-specific configuration.
+ */
+config?: Record<string, unknown>, 
+/**
+ * Initial data payload (shape depends on widget type).
+ */
+data?: Record<string, unknown>, };
+
+/**
+ * View data update — incremental data push for a specific view.
+ */
+export type ViewDataPushParams = { 
+/**
+ * Target view ID.
+ */
+view_id: string, 
+/**
+ * Data payload (format depends on ViewKind).
+ */
+data: Record<string, unknown>, 
+/**
+ * Whether this is a full replacement or incremental update.
+ */
+full_replace: boolean, };
+
+/**
+ * A view instance — one panel in the dashboard.
+ */
+export type ViewInstance = { 
+/**
+ * Unique view ID within the workspace.
+ */
+view_id: string, 
+/**
+ * What kind of renderer to use.
+ */
+kind: ViewKind, 
+/**
+ * Display title.
+ */
+title: string, 
+/**
+ * Data source identifier — what the view is bound to.
+ * Examples: "industrial:station:19", "chat:conversation:abc",
+ * "kanban:project:xyz", "media:flow:comfyui"
+ */
+data_source: string, 
+/**
+ * View-specific configuration (JSON, interpreted by the renderer).
+ */
+config: Record<string, unknown>, 
+/**
+ * Layout position (grid area, tab order, etc.).
+ */
+layout?: ViewLayout, };
+
+/**
+ * Widget create/update/delete on an existing layout (P3#A4).
+ */
+export type ViewInstancePushParams = { 
+/**
+ * Target layout (panel instance) id.
+ */
+layout_id: string, 
+/**
+ * Mutation: "create" | "update" | "delete".
+ */
+op: string, 
+/**
+ * Widget descriptor to create/update (ignored for delete).
+ */
+widget: DashboardWidget, };
+
+/**
+ * View type identifier — determines which frontend renderer handles the view.
+ */
+export type ViewKind = "industrial_scada" | "chat" | "kanban" | "gantt" | "data_table" | "media_flow" | "file_explorer" | "custom";
+
+/**
+ * Layout descriptor for a view within the dashboard grid.
+ */
+export type ViewLayout = { 
+/**
+ * Grid column start (1-based).
+ */
+col: number, 
+/**
+ * Grid row start (1-based).
+ */
+row: number, 
+/**
+ * Column span.
+ */
+col_span: number, 
+/**
+ * Row span.
+ */
+row_span: number, 
+/**
+ * Minimum width in pixels.
+ */
+min_width?: number, 
+/**
+ * Minimum height in pixels.
+ */
+min_height?: number, };

package/bindings/ws/workspace.ts

@@ -0,0 +1,11 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+
+export type PolemosDeviceInfo = { node_id: string, name: string, address: string, status: string, workspace_path?: string, ide_id?: string, };
+
+export type PolemosDeviceListParams = { devices: Array<PolemosDeviceInfo>, };
+
+export type RegisterPolemosDeviceResponseParams = { success: boolean, error?: string, device?: PolemosDeviceInfo, };
+
+export type SwitchWorkspaceResponseParams = { success: boolean, workspace_id: string, error?: string, };
+
+export type WorkspaceStatusParams = { workspace_id: string, display_name?: string, connection_kind: string, resolved_path?: string, remote_url?: string, branch?: string, host_id?: string, };

package/bindings/ws/yolo.ts

@@ -0,0 +1,32 @@
+// This file was generated by [ts-rs](https://github.com/Aleph-Alpha/ts-rs). Do not edit this file manually.
+import type { YoloTaskTier } from "./core";
+
+export type YoloConfigResponseParams = { tiers: Array<YoloTierConfig>, };
+
+export type YoloCycleCompleteParams = { loop_count: bigint, duration_ms: bigint, };
+
+export type YoloCycleStepParams = { skill: string, loop_count: bigint, status: string, token_usage?: [number, number], model_name?: string, };
+
+export type YoloRunTierNowResponseParams = { ok: boolean, error?: string, };
+
+export type YoloSetTierIntervalResponseParams = { ok: boolean, error?: string, };
+
+export type YoloStartResponseParams = { ok: boolean, error?: string, };
+
+export type YoloStatusResponseParams = { active: boolean, loop_count: bigint, started_at?: string, current_cycle?: string, tiers: Array<YoloTierStatus>, };
+
+export type YoloStopResponseParams = { ok: boolean, error?: string, };
+
+export type YoloTaskResult = { success: boolean, duration_ms: bigint, completed_at: string, error?: string, };
+
+export type YoloTaskStatus = { agent: string, skill: string, enabled: boolean, last_result?: YoloTaskResult, };
+
+export type YoloTerminateResponseParams = { ok: boolean, error?: string, };
+
+export type YoloTierConfig = { tier: YoloTaskTier, enabled: boolean, interval_secs: bigint, tasks: Array<YoloTierTaskConfig>, };
+
+export type YoloTierStatus = { tier: YoloTaskTier, enabled: boolean, interval_secs: bigint, last_run_at?: string, next_run_at?: string, tasks: Array<YoloTaskStatus>, };
+
+export type YoloTierTaskConfig = { agent: string, skill: string, enabled: boolean, };
+
+export type YoloUpdateTaskResponseParams = { ok: boolean, error?: string, };

package/examples/schema_dump.rs

@@ -0,0 +1,51 @@
+/// 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/package.json

@@ -0,0 +1,6 @@
+{
+  "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"
+}

package/pnpm-workspace.yaml

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