@agimon-ai/doompi-workflow 0.0.1-alpha.10 → 0.0.1-alpha.100

package/LICENSE

@@ -1,3 +1,11 @@
+Portions of this software are licensed as follows:
+
+* The browser half of this package, meaning every ".web" routed file under
+  "src/extensions" and the "_components" and "_lib" modules colocated with
+  one, is licensed under the DoomPi Web License defined in "LICENSE.web":
+  free to use, not to redistribute.
+* All other content is licensed under the MIT license below.
+
 MIT License
 
 Copyright (c) 2026 Vuong Ngo

package/LICENSE.web

@@ -0,0 +1,29 @@
+The DoomPi Web License
+
+Copyright (c) 2026 Agimon Pty Ltd
+
+With regard to the DoomPi Web Software:
+
+This software and associated documentation files (the "Software") may be
+used, free of charge, by any person or entity, for any purpose, including
+production and commercial use. You may copy the Software as reasonably
+necessary to install, run, develop against, test, and back it up. You are
+free to modify the Software for your own use and to publish patches to the
+Software. You agree that the licensor retains all right, title, and interest
+in and to the Software, and that your modifications and patches may only be
+used, copied, modified, displayed, distributed, or otherwise exploited
+together with the Software. You are not granted any other rights beyond what
+is expressly stated herein. Subject to the foregoing, it is forbidden to
+publish, distribute, sublicense, and/or sell the Software or any copy of it,
+or to offer the Software to third parties as a hosted or managed service.
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+IN THE SOFTWARE.

package/README.md

@@ -1,47 +1,153 @@
 # @agimon-ai/doompi-workflow
 
-Doompi workflow execution and monitoring integration.
+Discover, launch, monitor, control, and recover asynchronous DoomPi workflows.
 
-Long autonomous work in the shape a GitHub Actions user already knows: `on:`, `jobs:`,
-`needs:`, `steps:`, timeouts, and declared artifacts. Every step names the session it wants,
-so one run can hand each job exactly the context that job needs.
+Part of the [DoomPi distribution](https://www.npmjs.com/package/@agimon-ai/doompi).
 
-Part of [Doompi](https://www.npmjs.com/package/@agimon-ai/doompi), a coding agent that loads
-only the skills and tools you name. This package is composed by Doompi and is not usually
-installed on its own.
+The integration embeds `@agimon-ai/workflow-mcp`. Workflow files describe job dependencies and
+host-executed steps, while DoomPi provides session-scoped tools and TUI surfaces.
+
+> **Alpha:** workflow and recovery contracts may change between releases.
+
+## Requirements
+
+- Node.js 22.19.0 or newer
+- Pi 0.85.0 and Pi TUI 0.85.0
 
 ## Install
 
+The seeded `modes.yaml` selects Workflow in `default.packages`. Keep it there or select it through
+a layer; its tools remain inactive until Workflow mode is enabled. For standalone Pi:
+
 ```bash
-npm install @agimon-ai/doompi-workflow
+pi install npm:@agimon-ai/doompi-workflow
 ```
 
-## How it loads
+Enable tools with `SPC w e`, or set `WORKFLOW_MCP_MODE=on` for a non-interactive harness that cannot
+toggle the minor mode.
+
+## Define a workflow
+
+Create a `*.workflow.yml` file:
+
+```yaml
+name: verify
+
+jobs:
+  test:
+    steps:
+      - name: Run tests
+        run: pnpm test
+
+  summarize:
+    needs: test
+    steps:
+      - name: Record result
+        run: node scripts/write-verification-summary.mjs
+```
+
+`run` commands execute on the host with the workflow process's environment and privileges. There is
+no VM, container, or sandbox. Review workflow files as executable code. Runner-specific
+`interactiveRun` mappings are available for commands that require a TTY.
+
+A step can also declare `runConfig` (major mode, minor modes, profile, domains, model, thinking)
+and `customRun` (a prompt). Launched from the DoomPi server, a `customRun` step runs as a child
+session of the launching session with those settings, until the agent has recorded what the step
+needs, and `run` and `interactiveRun` steps each get their own RMUX pane. Each run keeps its engine
+log in `engine.log` in its run directory. See `docs/automation.md` for the full contract and the
+CLI fallback.
+
+## Launch and monitor
 
-Doompi loads this unconditionally. It is core, not a layer, so it does not appear in
-`.doom/modes.yaml`: making it optional would only create broken configurations.
+Core tools are:
 
-Extension entry: `@agimon-ai/doompi-workflow/extensions/pi`
+- `list_workflows`: discover workflows.
+- `launch_workflow`: register and start an asynchronous run.
+- `workflow_run`: inspect or control a run through supported actions.
 
-## Leader
+Launch returns after the run is registered, not after all jobs complete. Use status and follow
+controls for progress, and wait for a terminal notification.
 
-`SPC w w` launches, `SPC w l` manages, `SPC w r` recovers, once the extension is loaded.
-The recovery picker includes terminal failed runs from earlier Pi sessions. `workflow_run` action `recovery-evidence` reads only terminal registry evidence; generic status/tail and all live controls remain session-scoped. Replay claims the failed record atomically, transfers only `PI_SESSION_ID`, and binds controls to the exact run generation the session authorized.
+In the TUI, `SPC w l` lists the repository's workflows and launches the one under the cursor with
+`r`, `SPC w r` inspects this session's runs, `SPC w c` opens recovery, and `SPC w e`
+toggles model-visible tools. The root session can launch; child sessions can inspect the catalog but
+do not receive an unrestricted workflow factory.
 
-## Notes
+## Storage, concurrency, and lifecycle
+
+Registry data defaults to `$HOME/.workflow-mcp`; set `WORKFLOW_MCP_HOME` to relocate it. Persisted
+records contain workflow and run identity, job and step state, ownership, output locations, and
+recovery evidence. The default concurrency ceiling is five runs.
+
+Runs embedded directly in the Pi process end with that process. Runs launched through a terminal
+host such as tmux or cmux can have a different lifetime and remain manageable from the CLI. When
+Team is loaded, Workflow contributes active session runs through Team's `doom/background-work`
+service. That contribution reconnects after Team is replaced and is removed when Workflow unloads.
+Reconciliation distinguishes stale registry records from live processes; do not assume every run
+outlives its parent session.
+
+Each workflow or repair step can launch commands and model-backed agents, consuming provider quota
+and repeating external side effects.
+
+## Recovery
+
+Recovery is available only for records in a terminal failure state. A recovery claim atomically
+adopts the eligible failure, validates the evidence, and transfers ownership to the replay session.
+Live controls remain scoped to the owning session. Recovery does not launch a second copy beside a
+still-running job and does not guarantee that parent-session work survives shutdown.
+
+The package publishes `workflow-recovery` for active Workflow mode. While parent Help mode is
+active, it also contributes `doompi-author-workflow` for writing workflow definitions and
+`doompi-use-workflow` for launching, monitoring, and recovering runs. Deactivating Help hides both
+descriptors; cached files may remain.
+
+Each Pi extension instance uses the runner's shared Doom lifecycle. Reload or shutdown stops retained
+callbacks, interrupts bounded inline work, removes UI and service registrations, and releases
+package resources. Detached children load the same extension entry in their own process.
+
+## Pi extension
+
+The Pi extension is published at `@agimon-ai/doompi-workflow/extensions/pi` and declared in
+`package.json.pi.extensions`. Installing the package loads it automatically; there is no secondary
+registration or dispatcher export.
+
+## Development
+
+```bash
+pnpm build
+pnpm typecheck
+pnpm test
+pnpm lint
+```
 
-The dispatcher exposes `list_workflows` to any session but scopes `launch_workflow` to the
-root session, so a subagent can look but not spawn.
+Maintained by [Agimon](https://agimon.ai/about).
 
-## Entry points
+## Web cockpit plugin
 
-| Import                                                         |
-| -------------------------------------------------------------- |
-| `@agimon-ai/doompi-workflow`                                   |
-| `@agimon-ai/doompi-workflow/extensions/dispatcher`             |
-| `@agimon-ai/doompi-workflow/extensions/pi`                     |
-| `@agimon-ai/doompi-workflow/skills/workflow-recovery/SKILL.md` |
+The `.web` routed files under `src/extensions/workspaces/sessions/(frontend)` are this package's
+DoomPi web cockpit plugin: the workflows panel the dock's workflows group opens in a temporary tab,
+its store, and its `workflow_runs` session channel, compiled into the cockpit bundle by
+`doompi-web`'s build. Each surface keeps its components in a colocated `_components` folder and its
+stores and helpers in `_lib`.
+The hub-side data source ships behind the `./web-hub` subpath and reads the workflow registry
+(run.json plus progress.ndjson) exactly as the engine writes it. Both halves are declared by the
+`doompiWeb` block in package.json.
 
 ## License
 
-MIT
+MIT, except this package's browser half (the `.web` routed files under `src/extensions` and the
+`_components` and `_lib` modules colocated with one), which is source available under the DoomPi
+Web License (see `LICENSE.web`): free to use, including commercially, but not to redistribute.
+
+Workflow's host entries live in `src/extensions/pi.ts`, `server.ts`, and `web.ts`.
+`src/exports` exposes reusable package APIs. Controllers declare server APIs and
+contributions, tools declare native tools, and each service has its own folder.
+Terminal presentation and its session coordinator live in `src/tui`.
+
+The Pi helper owns registrations and service fibers. The Workflow runtime returns
+commands, events, mode ownership, and tool dependencies. Session startup begins
+readiness discovery; dependent calls await that session's readiness. On shutdown,
+`onStop` interrupts inline runs and clears session resources, while `onDispose`
+also handles startup failure. Both use the same idempotent cleanup. A generation
+fence prevents retired callbacks from sending messages or updating the UI; only
+explicit resource teardown may use a retired UI context.

package/dist/apiContracts.cjs

@@ -0,0 +1,335 @@
+Object.defineProperties(exports, {
+	__esModule: { value: true },
+	[Symbol.toStringTag]: { value: "Module" }
+});
+let _agimon_ai_doompi_core_apiContracts = require("@agimon-ai/doompi-core/apiContracts");
+let typebox = require("typebox");
+//#region src/schemas/apiContracts.ts
+const S = typebox.Type.String();
+const N = typebox.Type.Number();
+const B = typebox.Type.Boolean();
+const O = typebox.Type.Optional;
+const values = (items) => typebox.Type.Union(items.map((item) => typebox.Type.Literal(item)));
+const Step = {
+	name: S,
+	status: values([
+		"running",
+		"completed",
+		"skipped",
+		"failed",
+		"pause_requested",
+		"paused",
+		"resumed"
+	]),
+	reason: O(S),
+	group: O(S),
+	startedAt: O(S),
+	endedAt: O(S)
+};
+const Run = typebox.Type.Object({
+	runKey: S,
+	workspace: S,
+	displayName: S,
+	workflowName: O(S),
+	workflowPath: S,
+	stage: values([
+		"running",
+		"completed",
+		"error"
+	]),
+	outcome: O(values([
+		"success",
+		"skipped",
+		"failed",
+		"interrupted"
+	])),
+	executionState: O(values([
+		"running",
+		"pause_requested",
+		"paused",
+		"resume_requested"
+	])),
+	prompt: O(S),
+	startedAt: S,
+	finishedAt: O(S),
+	errorMessage: O(S),
+	failedJob: O(S),
+	stale: O(B),
+	staleReason: O(S),
+	worktreeBranch: O(S),
+	position: O(typebox.Type.Object({
+		job: S,
+		step: O(S),
+		index: O(N),
+		total: O(N)
+	})),
+	jobs: typebox.Type.Array(typebox.Type.Object({
+		...Step,
+		phase: values([
+			"pre",
+			"job",
+			"post"
+		]),
+		index: O(N),
+		total: O(N),
+		steps: typebox.Type.Array(typebox.Type.Object(Step))
+	}))
+});
+const WorkflowRunsSchema = typebox.Type.Object({ runs: typebox.Type.Array(Run) });
+const Artifact = {
+	path: S,
+	kind: values(["file", "directory"]),
+	description: S,
+	producedBy: typebox.Type.Array(S)
+};
+const WorkflowCatalogSchema = typebox.Type.Object({
+	cwd: S,
+	warning: O(S),
+	workflows: typebox.Type.Array(typebox.Type.Object({
+		path: S,
+		relativePath: S,
+		name: S,
+		description: S,
+		tags: typebox.Type.Array(S),
+		triggers: typebox.Type.Array(S),
+		inputs: typebox.Type.Array(typebox.Type.Object({
+			name: S,
+			description: O(S),
+			required: O(B),
+			default: O(S),
+			type: O(S),
+			options: O(typebox.Type.Array(S))
+		})),
+		jobs: typebox.Type.Array(typebox.Type.Object({
+			name: S,
+			steps: typebox.Type.Array(S)
+		})),
+		artifacts: typebox.Type.Array(typebox.Type.Object(Artifact)),
+		runners: O(typebox.Type.Array(S)),
+		commands: O(typebox.Type.Array(S)),
+		choices: O(typebox.Type.Array(S)),
+		error: O(S)
+	}))
+});
+const Screen = typebox.Type.Object({
+	lines: typebox.Type.Array(S),
+	capabilities: typebox.Type.Object({
+		readable: B,
+		writable: B,
+		resizable: B,
+		reason: O(S)
+	}),
+	ended: O(B)
+});
+const Control = typebox.Type.Object({
+	held: B,
+	token: O(S),
+	reason: O(S)
+});
+const root = "/runs/{workspace}/{runKey}";
+const apiContracts = (0, _agimon_ai_doompi_core_apiContracts.defineApiContract)({
+	version: 1,
+	dynamic: [],
+	http: [
+		"global",
+		"workspace",
+		"session"
+	].flatMap((scope) => [
+		{
+			id: "workflow.screen",
+			scope,
+			basePath: "workflow",
+			path: `${root}/screen/stream`,
+			method: "GET",
+			authentication: "owner",
+			description: "Follow the workflow terminal.",
+			responses: {
+				"200": {
+					description: "SSE stream with JSON screen events.",
+					contentType: "text/event-stream",
+					schema: S,
+					events: { screen: Screen }
+				},
+				"404": {
+					description: "Run unavailable.",
+					schema: typebox.Type.Object({ error: S })
+				}
+			}
+		},
+		{
+			id: "workflow.control",
+			scope,
+			basePath: "workflow",
+			path: `${root}/control`,
+			method: "POST",
+			authentication: "owner",
+			description: "Take or release the keyboard.",
+			body: {
+				required: true,
+				contentType: "application/json",
+				schema: typebox.Type.Object({
+					release: O(B),
+					token: O(S)
+				})
+			},
+			responses: {
+				...(0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(Control),
+				"409": {
+					description: "Keyboard unavailable.",
+					schema: Control
+				}
+			}
+		},
+		{
+			id: "workflow.keys",
+			scope,
+			basePath: "workflow",
+			path: `${root}/keys`,
+			method: "POST",
+			authentication: "owner",
+			description: "Write terminal data with the control token.",
+			body: {
+				required: true,
+				contentType: "application/json",
+				schema: typebox.Type.Object({
+					token: S,
+					data: S
+				})
+			},
+			responses: {
+				"204": { description: "Data written." },
+				"400": {
+					description: "Invalid request.",
+					schema: typebox.Type.Object({ error: S })
+				},
+				"409": {
+					description: "Write refused.",
+					schema: typebox.Type.Object({ error: S })
+				}
+			}
+		},
+		{
+			id: "workflow.resize",
+			scope,
+			basePath: "workflow",
+			path: `${root}/resize`,
+			method: "POST",
+			authentication: "owner",
+			description: "Resize the terminal.",
+			body: {
+				required: true,
+				contentType: "application/json",
+				schema: typebox.Type.Object({
+					token: S,
+					columns: N,
+					rows: N
+				})
+			},
+			responses: (0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(typebox.Type.Object({ resized: B }))
+		},
+		{
+			id: "workflow.delete",
+			scope,
+			basePath: "workflow",
+			path: root,
+			method: "DELETE",
+			authentication: "owner",
+			description: "Delete a settled run and its directory.",
+			responses: (0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(typebox.Type.Object({ deleted: typebox.Type.Literal(true) }))
+		},
+		{
+			id: "workflow.artifacts",
+			scope,
+			basePath: "workflow",
+			path: `${root}/artifacts`,
+			method: "GET",
+			authentication: "owner",
+			description: "List declared and discovered artifacts.",
+			responses: (0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(typebox.Type.Object({
+				runDir: S,
+				description: S,
+				artifacts: typebox.Type.Array(typebox.Type.Object({
+					...Artifact,
+					declared: B,
+					state: values([
+						"written",
+						"empty",
+						"pending",
+						"unreadable"
+					]),
+					size: O(N),
+					modifiedAt: O(S)
+				}))
+			}))
+		},
+		{
+			id: "workflow.artifact",
+			scope,
+			basePath: "workflow",
+			path: `${root}/artifacts/{name}`,
+			method: "GET",
+			authentication: "owner",
+			description: "Read artifact metadata and text. name may contain nested path segments. raw=1 streams binary with its media type and supports byte ranges.",
+			parameters: [
+				{
+					name: "raw",
+					in: "query",
+					required: false,
+					schema: values(["0", "1"])
+				},
+				{
+					name: "download",
+					in: "query",
+					required: false,
+					schema: values(["0", "1"])
+				},
+				{
+					name: "range",
+					in: "header",
+					required: false,
+					schema: S
+				}
+			],
+			responses: {
+				...(0, _agimon_ai_doompi_core_apiContracts.jsonApiResponses)(typebox.Type.Union([typebox.Type.Object({
+					path: S,
+					size: N,
+					modifiedAt: S,
+					mimeType: O(S),
+					text: O(S),
+					truncated: B
+				}), S])),
+				"206": {
+					description: "Partial raw bytes.",
+					contentType: "application/octet-stream",
+					schema: S
+				},
+				"416": { description: "Unsatisfiable byte range." }
+			}
+		}
+	]),
+	sockets: ["global", "workspace"].flatMap((scope) => [{
+		id: "workflow.runs",
+		scope,
+		service: "doompi.hub.v1",
+		member: "workflow_runs",
+		kind: "channel",
+		direction: "server-to-client",
+		description: "Workflow runs channel payload.",
+		input: WorkflowRunsSchema
+	}, {
+		id: "workflow.catalog",
+		scope,
+		service: "doompi.hub.v1",
+		member: "workflow_catalog",
+		kind: "channel",
+		direction: "server-to-client",
+		description: "Workflow catalog channel payload.",
+		input: WorkflowCatalogSchema
+	}])
+});
+//#endregion
+exports.apiContracts = apiContracts;
+exports.default = apiContracts;
+
+//# sourceMappingURL=apiContracts.cjs.map

package/dist/apiContracts.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiContracts.cjs","names":["Type","defineApiContract","jsonApiResponses"],"sources":["../src/schemas/apiContracts.ts"],"sourcesContent":["import { defineApiContract, jsonApiResponses, type DoomHttpContract } from '@agimon-ai/doompi-core/apiContracts';\nimport { Type } from 'typebox';\n\nconst S = Type.String();\nconst N = Type.Number();\nconst B = Type.Boolean();\nconst O = Type.Optional;\nconst values = <T extends string>(items: T[]) => Type.Union(items.map((item) => Type.Literal(item)));\nconst Progress = values(['running', 'completed', 'skipped', 'failed', 'pause_requested', 'paused', 'resumed']);\nconst Step = { name: S, status: Progress, reason: O(S), group: O(S), startedAt: O(S), endedAt: O(S) };\nconst Run = Type.Object({\n  runKey: S,\n  workspace: S,\n  displayName: S,\n  workflowName: O(S),\n  workflowPath: S,\n  stage: values(['running', 'completed', 'error']),\n  outcome: O(values(['success', 'skipped', 'failed', 'interrupted'])),\n  executionState: O(values(['running', 'pause_requested', 'paused', 'resume_requested'])),\n  prompt: O(S),\n  startedAt: S,\n  finishedAt: O(S),\n  errorMessage: O(S),\n  failedJob: O(S),\n  stale: O(B),\n  staleReason: O(S),\n  worktreeBranch: O(S),\n  position: O(Type.Object({ job: S, step: O(S), index: O(N), total: O(N) })),\n  jobs: Type.Array(\n    Type.Object({\n      ...Step,\n      phase: values(['pre', 'job', 'post']),\n      index: O(N),\n      total: O(N),\n      steps: Type.Array(Type.Object(Step)),\n    }),\n  ),\n});\nexport const WorkflowRunsSchema = Type.Object({ runs: Type.Array(Run) });\nconst Artifact = { path: S, kind: values(['file', 'directory']), description: S, producedBy: Type.Array(S) };\nexport const WorkflowCatalogSchema = Type.Object({\n  cwd: S,\n  warning: O(S),\n  workflows: Type.Array(\n    Type.Object({\n      path: S,\n      relativePath: S,\n      name: S,\n      description: S,\n      tags: Type.Array(S),\n      triggers: Type.Array(S),\n      inputs: Type.Array(\n        Type.Object({\n          name: S,\n          description: O(S),\n          required: O(B),\n          default: O(S),\n          type: O(S),\n          options: O(Type.Array(S)),\n        }),\n      ),\n      jobs: Type.Array(Type.Object({ name: S, steps: Type.Array(S) })),\n      artifacts: Type.Array(Type.Object(Artifact)),\n      runners: O(Type.Array(S)),\n      commands: O(Type.Array(S)),\n      choices: O(Type.Array(S)),\n      error: O(S),\n    }),\n  ),\n});\nconst Screen = Type.Object({\n  lines: Type.Array(S),\n  capabilities: Type.Object({ readable: B, writable: B, resizable: B, reason: O(S) }),\n  ended: O(B),\n});\nconst Control = Type.Object({ held: B, token: O(S), reason: O(S) });\nconst root = '/runs/{workspace}/{runKey}';\nexport const apiContracts = defineApiContract({\n  version: 1,\n  dynamic: [],\n  http: (['global', 'workspace', 'session'] as const).flatMap((scope): DoomHttpContract[] => [\n    {\n      id: 'workflow.screen',\n      scope,\n      basePath: 'workflow',\n      path: `${root}/screen/stream`,\n      method: 'GET',\n      authentication: 'owner',\n      description: 'Follow the workflow terminal.',\n      responses: {\n        '200': {\n          description: 'SSE stream with JSON screen events.',\n          contentType: 'text/event-stream',\n          schema: S,\n          events: { screen: Screen },\n        },\n        '404': { description: 'Run unavailable.', schema: Type.Object({ error: S }) },\n      },\n    },\n    {\n      id: 'workflow.control',\n      scope,\n      basePath: 'workflow',\n      path: `${root}/control`,\n      method: 'POST',\n      authentication: 'owner',\n      description: 'Take or release the keyboard.',\n      body: { required: true, contentType: 'application/json', schema: Type.Object({ release: O(B), token: O(S) }) },\n      responses: { ...jsonApiResponses(Control), '409': { description: 'Keyboard unavailable.', schema: Control } },\n    },\n    {\n      id: 'workflow.keys',\n      scope,\n      basePath: 'workflow',\n      path: `${root}/keys`,\n      method: 'POST',\n      authentication: 'owner',\n      description: 'Write terminal data with the control token.',\n      body: { required: true, contentType: 'application/json', schema: Type.Object({ token: S, data: S }) },\n      responses: {\n        '204': { description: 'Data written.' },\n        '400': { description: 'Invalid request.', schema: Type.Object({ error: S }) },\n        '409': { description: 'Write refused.', schema: Type.Object({ error: S }) },\n      },\n    },\n    {\n      id: 'workflow.resize',\n      scope,\n      basePath: 'workflow',\n      path: `${root}/resize`,\n      method: 'POST',\n      authentication: 'owner',\n      description: 'Resize the terminal.',\n      body: { required: true, contentType: 'application/json', schema: Type.Object({ token: S, columns: N, rows: N }) },\n      responses: jsonApiResponses(Type.Object({ resized: B })),\n    },\n    {\n      id: 'workflow.delete',\n      scope,\n      basePath: 'workflow',\n      path: root,\n      method: 'DELETE',\n      authentication: 'owner',\n      description: 'Delete a settled run and its directory.',\n      responses: jsonApiResponses(Type.Object({ deleted: Type.Literal(true) })),\n    },\n    {\n      id: 'workflow.artifacts',\n      scope,\n      basePath: 'workflow',\n      path: `${root}/artifacts`,\n      method: 'GET',\n      authentication: 'owner',\n      description: 'List declared and discovered artifacts.',\n      responses: jsonApiResponses(\n        Type.Object({\n          runDir: S,\n          description: S,\n          artifacts: Type.Array(\n            Type.Object({\n              ...Artifact,\n              declared: B,\n              state: values(['written', 'empty', 'pending', 'unreadable']),\n              size: O(N),\n              modifiedAt: O(S),\n            }),\n          ),\n        }),\n      ),\n    },\n    {\n      id: 'workflow.artifact',\n      scope,\n      basePath: 'workflow',\n      path: `${root}/artifacts/{name}`,\n      method: 'GET',\n      authentication: 'owner',\n      description:\n        'Read artifact metadata and text. name may contain nested path segments. raw=1 streams binary with its media type and supports byte ranges.',\n      parameters: [\n        { name: 'raw', in: 'query', required: false, schema: values(['0', '1']) },\n        { name: 'download', in: 'query', required: false, schema: values(['0', '1']) },\n        { name: 'range', in: 'header', required: false, schema: S },\n      ],\n      responses: {\n        ...jsonApiResponses(\n          Type.Union([Type.Object({ path: S, size: N, modifiedAt: S, mimeType: O(S), text: O(S), truncated: B }), S]),\n        ),\n        '206': { description: 'Partial raw bytes.', contentType: 'application/octet-stream', schema: S },\n        '416': { description: 'Unsatisfiable byte range.' },\n      },\n    },\n  ]),\n  sockets: (['global', 'workspace'] as const).flatMap((scope) => [\n    {\n      id: 'workflow.runs',\n      scope,\n      service: 'doompi.hub.v1',\n      member: 'workflow_runs',\n      kind: 'channel',\n      direction: 'server-to-client',\n      description: 'Workflow runs channel payload.',\n      input: WorkflowRunsSchema,\n    },\n    {\n      id: 'workflow.catalog',\n      scope,\n      service: 'doompi.hub.v1',\n      member: 'workflow_catalog',\n      kind: 'channel',\n      direction: 'server-to-client',\n      description: 'Workflow catalog channel payload.',\n      input: WorkflowCatalogSchema,\n    },\n  ]),\n});\nexport default apiContracts;\n"],"mappings":";;;;;;;AAGA,MAAM,IAAIA,QAAAA,KAAK,OAAO;AACtB,MAAM,IAAIA,QAAAA,KAAK,OAAO;AACtB,MAAM,IAAIA,QAAAA,KAAK,QAAQ;AACvB,MAAM,IAAIA,QAAAA,KAAK;AACf,MAAM,UAA4B,UAAeA,QAAAA,KAAK,MAAM,MAAM,KAAK,SAASA,QAAAA,KAAK,QAAQ,IAAI,CAAC,CAAC;AAEnG,MAAM,OAAO;CAAE,MAAM;CAAG,QADP,OAAO;EAAC;EAAW;EAAa;EAAW;EAAU;EAAmB;EAAU;CAAS,CACrE;CAAG,QAAQ,EAAE,CAAC;CAAG,OAAO,EAAE,CAAC;CAAG,WAAW,EAAE,CAAC;CAAG,SAAS,EAAE,CAAC;AAAE;AACpG,MAAM,MAAMA,QAAAA,KAAK,OAAO;CACtB,QAAQ;CACR,WAAW;CACX,aAAa;CACb,cAAc,EAAE,CAAC;CACjB,cAAc;CACd,OAAO,OAAO;EAAC;EAAW;EAAa;CAAO,CAAC;CAC/C,SAAS,EAAE,OAAO;EAAC;EAAW;EAAW;EAAU;CAAa,CAAC,CAAC;CAClE,gBAAgB,EAAE,OAAO;EAAC;EAAW;EAAmB;EAAU;CAAkB,CAAC,CAAC;CACtF,QAAQ,EAAE,CAAC;CACX,WAAW;CACX,YAAY,EAAE,CAAC;CACf,cAAc,EAAE,CAAC;CACjB,WAAW,EAAE,CAAC;CACd,OAAO,EAAE,CAAC;CACV,aAAa,EAAE,CAAC;CAChB,gBAAgB,EAAE,CAAC;CACnB,UAAU,EAAEA,QAAAA,KAAK,OAAO;EAAE,KAAK;EAAG,MAAM,EAAE,CAAC;EAAG,OAAO,EAAE,CAAC;EAAG,OAAO,EAAE,CAAC;CAAE,CAAC,CAAC;CACzE,MAAMA,QAAAA,KAAK,MACTA,QAAAA,KAAK,OAAO;EACV,GAAG;EACH,OAAO,OAAO;GAAC;GAAO;GAAO;EAAM,CAAC;EACpC,OAAO,EAAE,CAAC;EACV,OAAO,EAAE,CAAC;EACV,OAAOA,QAAAA,KAAK,MAAMA,QAAAA,KAAK,OAAO,IAAI,CAAC;CACrC,CAAC,CACH;AACF,CAAC;AACD,MAAa,qBAAqBA,QAAAA,KAAK,OAAO,EAAE,MAAMA,QAAAA,KAAK,MAAM,GAAG,EAAE,CAAC;AACvE,MAAM,WAAW;CAAE,MAAM;CAAG,MAAM,OAAO,CAAC,QAAQ,WAAW,CAAC;CAAG,aAAa;CAAG,YAAYA,QAAAA,KAAK,MAAM,CAAC;AAAE;AAC3G,MAAa,wBAAwBA,QAAAA,KAAK,OAAO;CAC/C,KAAK;CACL,SAAS,EAAE,CAAC;CACZ,WAAWA,QAAAA,KAAK,MACdA,QAAAA,KAAK,OAAO;EACV,MAAM;EACN,cAAc;EACd,MAAM;EACN,aAAa;EACb,MAAMA,QAAAA,KAAK,MAAM,CAAC;EAClB,UAAUA,QAAAA,KAAK,MAAM,CAAC;EACtB,QAAQA,QAAAA,KAAK,MACXA,QAAAA,KAAK,OAAO;GACV,MAAM;GACN,aAAa,EAAE,CAAC;GAChB,UAAU,EAAE,CAAC;GACb,SAAS,EAAE,CAAC;GACZ,MAAM,EAAE,CAAC;GACT,SAAS,EAAEA,QAAAA,KAAK,MAAM,CAAC,CAAC;EAC1B,CAAC,CACH;EACA,MAAMA,QAAAA,KAAK,MAAMA,QAAAA,KAAK,OAAO;GAAE,MAAM;GAAG,OAAOA,QAAAA,KAAK,MAAM,CAAC;EAAE,CAAC,CAAC;EAC/D,WAAWA,QAAAA,KAAK,MAAMA,QAAAA,KAAK,OAAO,QAAQ,CAAC;EAC3C,SAAS,EAAEA,QAAAA,KAAK,MAAM,CAAC,CAAC;EACxB,UAAU,EAAEA,QAAAA,KAAK,MAAM,CAAC,CAAC;EACzB,SAAS,EAAEA,QAAAA,KAAK,MAAM,CAAC,CAAC;EACxB,OAAO,EAAE,CAAC;CACZ,CAAC,CACH;AACF,CAAC;AACD,MAAM,SAASA,QAAAA,KAAK,OAAO;CACzB,OAAOA,QAAAA,KAAK,MAAM,CAAC;CACnB,cAAcA,QAAAA,KAAK,OAAO;EAAE,UAAU;EAAG,UAAU;EAAG,WAAW;EAAG,QAAQ,EAAE,CAAC;CAAE,CAAC;CAClF,OAAO,EAAE,CAAC;AACZ,CAAC;AACD,MAAM,UAAUA,QAAAA,KAAK,OAAO;CAAE,MAAM;CAAG,OAAO,EAAE,CAAC;CAAG,QAAQ,EAAE,CAAC;AAAE,CAAC;AAClE,MAAM,OAAO;AACb,MAAa,gBAAA,GAAeC,oCAAAA,kBAAAA,CAAkB;CAC5C,SAAS;CACT,SAAS,CAAC;CACV,MAAO;EAAC;EAAU;EAAa;CAAS,CAAC,CAAW,SAAS,UAA8B;EACzF;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM,GAAG,KAAK;GACd,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,WAAW;IACT,OAAO;KACL,aAAa;KACb,aAAa;KACb,QAAQ;KACR,QAAQ,EAAE,QAAQ,OAAO;IAC3B;IACA,OAAO;KAAE,aAAa;KAAoB,QAAQD,QAAAA,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;GAC9E;EACF;EACA;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM,GAAG,KAAK;GACd,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,MAAM;IAAE,UAAU;IAAM,aAAa;IAAoB,QAAQA,QAAAA,KAAK,OAAO;KAAE,SAAS,EAAE,CAAC;KAAG,OAAO,EAAE,CAAC;IAAE,CAAC;GAAE;GAC7G,WAAW;IAAE,IAAA,GAAGE,oCAAAA,iBAAAA,CAAiB,OAAO;IAAG,OAAO;KAAE,aAAa;KAAyB,QAAQ;IAAQ;GAAE;EAC9G;EACA;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM,GAAG,KAAK;GACd,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,MAAM;IAAE,UAAU;IAAM,aAAa;IAAoB,QAAQF,QAAAA,KAAK,OAAO;KAAE,OAAO;KAAG,MAAM;IAAE,CAAC;GAAE;GACpG,WAAW;IACT,OAAO,EAAE,aAAa,gBAAgB;IACtC,OAAO;KAAE,aAAa;KAAoB,QAAQA,QAAAA,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;IAC5E,OAAO;KAAE,aAAa;KAAkB,QAAQA,QAAAA,KAAK,OAAO,EAAE,OAAO,EAAE,CAAC;IAAE;GAC5E;EACF;EACA;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM,GAAG,KAAK;GACd,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,MAAM;IAAE,UAAU;IAAM,aAAa;IAAoB,QAAQA,QAAAA,KAAK,OAAO;KAAE,OAAO;KAAG,SAAS;KAAG,MAAM;IAAE,CAAC;GAAE;GAChH,YAAA,GAAWE,oCAAAA,iBAAAA,CAAiBF,QAAAA,KAAK,OAAO,EAAE,SAAS,EAAE,CAAC,CAAC;EACzD;EACA;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM;GACN,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAA,GAAWE,oCAAAA,iBAAAA,CAAiBF,QAAAA,KAAK,OAAO,EAAE,SAASA,QAAAA,KAAK,QAAQ,IAAI,EAAE,CAAC,CAAC;EAC1E;EACA;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM,GAAG,KAAK;GACd,QAAQ;GACR,gBAAgB;GAChB,aAAa;GACb,YAAA,GAAWE,oCAAAA,iBAAAA,CACTF,QAAAA,KAAK,OAAO;IACV,QAAQ;IACR,aAAa;IACb,WAAWA,QAAAA,KAAK,MACdA,QAAAA,KAAK,OAAO;KACV,GAAG;KACH,UAAU;KACV,OAAO,OAAO;MAAC;MAAW;MAAS;MAAW;KAAY,CAAC;KAC3D,MAAM,EAAE,CAAC;KACT,YAAY,EAAE,CAAC;IACjB,CAAC,CACH;GACF,CAAC,CACH;EACF;EACA;GACE,IAAI;GACJ;GACA,UAAU;GACV,MAAM,GAAG,KAAK;GACd,QAAQ;GACR,gBAAgB;GAChB,aACE;GACF,YAAY;IACV;KAAE,MAAM;KAAO,IAAI;KAAS,UAAU;KAAO,QAAQ,OAAO,CAAC,KAAK,GAAG,CAAC;IAAE;IACxE;KAAE,MAAM;KAAY,IAAI;KAAS,UAAU;KAAO,QAAQ,OAAO,CAAC,KAAK,GAAG,CAAC;IAAE;IAC7E;KAAE,MAAM;KAAS,IAAI;KAAU,UAAU;KAAO,QAAQ;IAAE;GAC5D;GACA,WAAW;IACT,IAAA,GAAGE,oCAAAA,iBAAAA,CACDF,QAAAA,KAAK,MAAM,CAACA,QAAAA,KAAK,OAAO;KAAE,MAAM;KAAG,MAAM;KAAG,YAAY;KAAG,UAAU,EAAE,CAAC;KAAG,MAAM,EAAE,CAAC;KAAG,WAAW;IAAE,CAAC,GAAG,CAAC,CAAC,CAC5G;IACA,OAAO;KAAE,aAAa;KAAsB,aAAa;KAA4B,QAAQ;IAAE;IAC/F,OAAO,EAAE,aAAa,4BAA4B;GACpD;EACF;CACF,CAAC;CACD,SAAU,CAAC,UAAU,WAAW,CAAC,CAAW,SAAS,UAAU,CAC7D;EACE,IAAI;EACJ;EACA,SAAS;EACT,QAAQ;EACR,MAAM;EACN,WAAW;EACX,aAAa;EACb,OAAO;CACT,GACA;EACE,IAAI;EACJ;EACA,SAAS;EACT,QAAQ;EACR,MAAM;EACN,WAAW;EACX,aAAa;EACb,OAAO;CACT,CACF,CAAC;AACH,CAAC"}

package/dist/apiContracts.d.mts

@@ -0,0 +1,53 @@
+import { Type } from "typebox";
+//#region src/schemas/apiContracts.d.ts
+export declare const apiContracts: {
+  version: 1;
+  protocols?: Record<string, string> | undefined;
+  schemas?: Record<string, boolean | object> | undefined;
+  http: {
+    id: string;
+    scope: "global" | "session" | "workspace";
+    basePath?: string | undefined;
+    path: string;
+    method: "DELETE" | "GET" | "HEAD" | "OPTIONS" | "PATCH" | "POST" | "PUT";
+    description: string;
+    availability?: string | undefined;
+    authentication: "device" | "none" | "owner";
+    parameters?: {
+      name: string;
+      in: "header" | "path" | "query";
+      required: boolean;
+      schema: boolean | object;
+    }[] | undefined;
+    body?: {
+      contentType: string;
+      contentTypes?: string[] | undefined;
+      required: boolean;
+      schema: boolean | object;
+    } | undefined;
+    responses: Record<string, {
+      description: string;
+      contentType?: string | undefined;
+      schema?: boolean | object | undefined;
+      events?: Record<string, boolean | object> | undefined;
+    }>;
+  }[];
+  sockets: {
+    id: string;
+    scope: "global" | "session" | "workspace";
+    description: string;
+    availability?: string | undefined;
+    service: string;
+    member: string;
+    direction: "client-to-server" | "server-to-client";
+    kind: "channel" | "method" | "state";
+    input: boolean | object;
+    output?: boolean | object | undefined;
+    errors?: boolean | object | undefined;
+  }[];
+  dynamic: string[];
+  gaps?: string[] | undefined;
+};
+//#endregion
+export { apiContracts as default };
+//# sourceMappingURL=apiContracts.d.mts.map

package/dist/apiContracts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"apiContracts.d.mts","names":[],"sources":["../src/schemas/apiContracts.ts"],"mappings":";;qBA6Ea"}