@qontinui/shared-types 0.11.0 → 0.12.1

package/dist/accessibility.d.cts

@@ -249,6 +249,9 @@ interface AccessibilityNode {
    * Reference ID like `@e1`, `@e2` for AI interaction.
    */
   ref: string;
+  /**
+   * Accessibility role (button, textbox, etc.).
+   */
   role: AccessibilityRole;
   /**
    * Current state flags.
@@ -280,11 +283,17 @@ interface AccessibilityNode {
  * capture source and summary statistics.
  */
 interface AccessibilitySnapshot {
+  /**
+   * Backend used for capture.
+   */
   backend: AccessibilityBackend;
   /**
    * Number of interactive nodes.
    */
   interactiveNodes: number;
+  /**
+   * Root node of the accessibility tree.
+   */
   root: AccessibilityNode;
   /**
    * Unix timestamp of capture.

package/dist/accessibility.d.ts

@@ -249,6 +249,9 @@ interface AccessibilityNode {
    * Reference ID like `@e1`, `@e2` for AI interaction.
    */
   ref: string;
+  /**
+   * Accessibility role (button, textbox, etc.).
+   */
   role: AccessibilityRole;
   /**
    * Current state flags.
@@ -280,11 +283,17 @@ interface AccessibilityNode {
  * capture source and summary statistics.
  */
 interface AccessibilitySnapshot {
+  /**
+   * Backend used for capture.
+   */
   backend: AccessibilityBackend;
   /**
    * Number of interactive nodes.
    */
   interactiveNodes: number;
+  /**
+   * Root node of the accessibility tree.
+   */
   root: AccessibilityNode;
   /**
    * Unix timestamp of capture.

package/dist/constraints.d.cts

@@ -93,6 +93,9 @@ type ConstraintSeverity = "block" | "warn" | "log";
  * A constraint definition.
  */
 interface Constraint {
+  /**
+   * What to check.
+   */
   check: ConstraintCheck;
   /**
    * Why this constraint exists (shown to the AI on violation).
@@ -110,6 +113,9 @@ interface Constraint {
    * Human-readable name.
    */
   name: string;
+  /**
+   * How severe a violation is.
+   */
   severity: ConstraintSeverity;
 }
 
@@ -163,6 +169,9 @@ interface ConstraintResult {
    * Whether the constraint passed.
    */
   passed: boolean;
+  /**
+   * Severity of the constraint (for quick filtering).
+   */
   severity: ConstraintSeverity;
   /**
    * Details about the violation (empty if passed).
@@ -221,6 +230,9 @@ interface ResourceLimits {
  */
 type ConstraintProposal =
   | {
+      /**
+       * The proposed constraint definition.
+       */
       constraint: Constraint;
       type: "new_constraint";
     }
@@ -256,6 +268,9 @@ type ConstraintProposal =
  * enum's internal tag.
  */
 interface NewConstraintProposal {
+  /**
+   * The proposed constraint definition.
+   */
   constraint: Constraint;
 }
 

package/dist/constraints.d.ts

@@ -93,6 +93,9 @@ type ConstraintSeverity = "block" | "warn" | "log";
  * A constraint definition.
  */
 interface Constraint {
+  /**
+   * What to check.
+   */
   check: ConstraintCheck;
   /**
    * Why this constraint exists (shown to the AI on violation).
@@ -110,6 +113,9 @@ interface Constraint {
    * Human-readable name.
    */
   name: string;
+  /**
+   * How severe a violation is.
+   */
   severity: ConstraintSeverity;
 }
 
@@ -163,6 +169,9 @@ interface ConstraintResult {
    * Whether the constraint passed.
    */
   passed: boolean;
+  /**
+   * Severity of the constraint (for quick filtering).
+   */
   severity: ConstraintSeverity;
   /**
    * Details about the violation (empty if passed).
@@ -221,6 +230,9 @@ interface ResourceLimits {
  */
 type ConstraintProposal =
   | {
+      /**
+       * The proposed constraint definition.
+       */
       constraint: Constraint;
       type: "new_constraint";
     }
@@ -256,6 +268,9 @@ type ConstraintProposal =
  * enum's internal tag.
  */
 interface NewConstraintProposal {
+  /**
+   * The proposed constraint definition.
+   */
   constraint: Constraint;
 }
 

package/dist/execution.d.cts

@@ -418,7 +418,13 @@ interface ExecutionRunCreate {
    * Human-readable run name.
    */
   runName: string;
+  /**
+   * Kind of run being created.
+   */
   runType: RunType$1;
+  /**
+   * Runner environment metadata.
+   */
   runnerMetadata: RunnerMetadata;
   /**
    * Workflow metadata, if the run executes a workflow.
@@ -459,11 +465,17 @@ interface ExecutionRunResponse {
    * Human-readable run name.
    */
   runName: string;
+  /**
+   * Kind of run.
+   */
   runType: RunType$1;
   /**
    * ISO 8601 timestamp when the run started.
    */
   startedAt: string;
+  /**
+   * Current lifecycle status.
+   */
   status: RunStatus$1;
 }
 
@@ -518,6 +530,9 @@ interface ActionExecutionCreate {
    * Human-readable action name.
    */
   actionName: string;
+  /**
+   * Kind of action.
+   */
   actionType: ExecutionActionType;
   /**
    * IDs of states active when the action ran.
@@ -609,6 +624,9 @@ interface ActionExecutionCreate {
    * ISO 8601 timestamp when the action started.
    */
   startedAt: string;
+  /**
+   * Outcome of the action.
+   */
   status: ActionStatus$1;
   /**
    * Destination state ID for state-machine actions.
@@ -670,6 +688,9 @@ interface ScreenshotAnnotation {
    * Free-form label for the annotation.
    */
   label?: string | null;
+  /**
+   * Shape of the annotation.
+   */
   type: ScreenshotAnnotationShape;
   /**
    * Annotation width in pixels.
@@ -724,6 +745,9 @@ interface ExecutionScreenshotCreate {
    * Client-generated screenshot identifier.
    */
   screenshotId: string;
+  /**
+   * Kind of screenshot.
+   */
   screenshotType: ScreenshotType$1;
   /**
    * Sequence number of the screenshot within the run.
@@ -827,6 +851,9 @@ interface ExecutionIssueCreate {
    * IDs of screenshots illustrating the issue.
    */
   screenshotIds?: string[] | null;
+  /**
+   * Severity.
+   */
   severity: IssueSeverity$1;
   /**
    * State ID active when the issue was observed.
@@ -888,7 +915,13 @@ interface ExecutionRunComplete {
    * Error message if the run failed.
    */
   errorMessage?: string | null;
+  /**
+   * Aggregate execution statistics.
+   */
   stats: ExecutionStats;
+  /**
+   * Final lifecycle status.
+   */
   status: RunStatus$1;
   /**
    * Free-form run summary.
@@ -929,7 +962,13 @@ interface ExecutionRunCompleteResponse {
    * ISO 8601 timestamp when the run started.
    */
   startedAt: string;
+  /**
+   * Aggregate execution statistics.
+   */
   stats: ExecutionStats;
+  /**
+   * Final lifecycle status.
+   */
   status: RunStatus$1;
 }
 

package/dist/execution.d.ts

@@ -418,7 +418,13 @@ interface ExecutionRunCreate {
    * Human-readable run name.
    */
   runName: string;
+  /**
+   * Kind of run being created.
+   */
   runType: RunType$1;
+  /**
+   * Runner environment metadata.
+   */
   runnerMetadata: RunnerMetadata;
   /**
    * Workflow metadata, if the run executes a workflow.
@@ -459,11 +465,17 @@ interface ExecutionRunResponse {
    * Human-readable run name.
    */
   runName: string;
+  /**
+   * Kind of run.
+   */
   runType: RunType$1;
   /**
    * ISO 8601 timestamp when the run started.
    */
   startedAt: string;
+  /**
+   * Current lifecycle status.
+   */
   status: RunStatus$1;
 }
 
@@ -518,6 +530,9 @@ interface ActionExecutionCreate {
    * Human-readable action name.
    */
   actionName: string;
+  /**
+   * Kind of action.
+   */
   actionType: ExecutionActionType;
   /**
    * IDs of states active when the action ran.
@@ -609,6 +624,9 @@ interface ActionExecutionCreate {
    * ISO 8601 timestamp when the action started.
    */
   startedAt: string;
+  /**
+   * Outcome of the action.
+   */
   status: ActionStatus$1;
   /**
    * Destination state ID for state-machine actions.
@@ -670,6 +688,9 @@ interface ScreenshotAnnotation {
    * Free-form label for the annotation.
    */
   label?: string | null;
+  /**
+   * Shape of the annotation.
+   */
   type: ScreenshotAnnotationShape;
   /**
    * Annotation width in pixels.
@@ -724,6 +745,9 @@ interface ExecutionScreenshotCreate {
    * Client-generated screenshot identifier.
    */
   screenshotId: string;
+  /**
+   * Kind of screenshot.
+   */
   screenshotType: ScreenshotType$1;
   /**
    * Sequence number of the screenshot within the run.
@@ -827,6 +851,9 @@ interface ExecutionIssueCreate {
    * IDs of screenshots illustrating the issue.
    */
   screenshotIds?: string[] | null;
+  /**
+   * Severity.
+   */
   severity: IssueSeverity$1;
   /**
    * State ID active when the issue was observed.
@@ -888,7 +915,13 @@ interface ExecutionRunComplete {
    * Error message if the run failed.
    */
   errorMessage?: string | null;
+  /**
+   * Aggregate execution statistics.
+   */
   stats: ExecutionStats;
+  /**
+   * Final lifecycle status.
+   */
   status: RunStatus$1;
   /**
    * Free-form run summary.
@@ -929,7 +962,13 @@ interface ExecutionRunCompleteResponse {
    * ISO 8601 timestamp when the run started.
    */
   startedAt: string;
+  /**
+   * Aggregate execution statistics.
+   */
   stats: ExecutionStats;
+  /**
+   * Final lifecycle status.
+   */
   status: RunStatus$1;
 }
 

package/dist/geometry.d.cts

@@ -44,6 +44,9 @@ interface Monitor {
    * Display name (e.g., "DELL U2720Q").
    */
   name?: string | null;
+  /**
+   * Spatial position based on X coordinate (for UI display).
+   */
   position: MonitorPosition;
   /**
    * DPI scale factor (1.0 = 100%, 1.5 = 150%, 2.0 = 200%).

package/dist/geometry.d.ts

@@ -44,6 +44,9 @@ interface Monitor {
    * Display name (e.g., "DELL U2720Q").
    */
   name?: string | null;
+  /**
+   * Spatial position based on X coordinate (for UI display).
+   */
   position: MonitorPosition;
   /**
    * DPI scale factor (1.0 = 100%, 1.5 = 150%, 2.0 = 200%).

package/dist/index.d.cts

@@ -623,6 +623,9 @@ interface ProcessStatusLite {
    * process declares no health port.
    */
   portHealthy?: boolean | null;
+  /**
+   * Lifecycle state as reported by the process manager.
+   */
   state: ProcessState;
 }
 
@@ -671,6 +674,9 @@ interface SessionLite {
    * Session name — `task_runs.task_name` or the terminal's title.
    */
   name?: string | null;
+  /**
+   * Where this row came from.
+   */
   source: SessionSource;
   /**
    * `task_runs.status` ("running", "completed", …) for AI sessions;
@@ -720,6 +726,9 @@ interface ProjectSnapshot {
    * Managed processes whose `cwd` is under the project root.
    */
   processes: ProcessStatusLite[];
+  /**
+   * The registry entry this snapshot describes.
+   */
   project: SavedProject;
   /**
    * Questions waiting on the user, from `deferred_questions`.
@@ -857,6 +866,9 @@ interface DiscoveryTransitionTrigger {
  * optional pixel-level identification.
  */
 interface DiscoveredStateImage {
+  /**
+   * Bounding box within the screenshot.
+   */
   bbox: DiscoveryBoundingBox;
   /**
    * Confidence score for this image (0.0–1.0). Defaults to `1.0`.
@@ -1064,6 +1076,9 @@ interface StateDiscoveryResult {
    * ID of the source session (extraction, recording, …).
    */
   sourceSessionId?: string | null;
+  /**
+   * How this state machine was discovered.
+   */
   sourceType: DiscoverySourceType;
   /**
    * Number of states (statistic).
@@ -1138,6 +1153,9 @@ interface StateDiscoveryResultSummary {
    * ID of the project.
    */
   projectId: string;
+  /**
+   * Discovery source.
+   */
   sourceType: DiscoverySourceType;
   /**
    * Number of states.
@@ -1221,6 +1239,9 @@ interface StateDiscoveryResultCreate {
    * ID of the source session.
    */
   sourceSessionId?: string | null;
+  /**
+   * Discovery source.
+   */
   sourceType: DiscoverySourceType;
   /**
    * Discovered states.
@@ -1352,6 +1373,9 @@ interface StateMachineImport {
    * Override name (uses export name when omitted).
    */
   name?: string | null;
+  /**
+   * The state machine to import.
+   */
   stateMachine: StateMachineExport;
 }
 

package/dist/index.d.ts

@@ -623,6 +623,9 @@ interface ProcessStatusLite {
    * process declares no health port.
    */
   portHealthy?: boolean | null;
+  /**
+   * Lifecycle state as reported by the process manager.
+   */
   state: ProcessState;
 }
 
@@ -671,6 +674,9 @@ interface SessionLite {
    * Session name — `task_runs.task_name` or the terminal's title.
    */
   name?: string | null;
+  /**
+   * Where this row came from.
+   */
   source: SessionSource;
   /**
    * `task_runs.status` ("running", "completed", …) for AI sessions;
@@ -720,6 +726,9 @@ interface ProjectSnapshot {
    * Managed processes whose `cwd` is under the project root.
    */
   processes: ProcessStatusLite[];
+  /**
+   * The registry entry this snapshot describes.
+   */
   project: SavedProject;
   /**
    * Questions waiting on the user, from `deferred_questions`.
@@ -857,6 +866,9 @@ interface DiscoveryTransitionTrigger {
  * optional pixel-level identification.
  */
 interface DiscoveredStateImage {
+  /**
+   * Bounding box within the screenshot.
+   */
   bbox: DiscoveryBoundingBox;
   /**
    * Confidence score for this image (0.0–1.0). Defaults to `1.0`.
@@ -1064,6 +1076,9 @@ interface StateDiscoveryResult {
    * ID of the source session (extraction, recording, …).
    */
   sourceSessionId?: string | null;
+  /**
+   * How this state machine was discovered.
+   */
   sourceType: DiscoverySourceType;
   /**
    * Number of states (statistic).
@@ -1138,6 +1153,9 @@ interface StateDiscoveryResultSummary {
    * ID of the project.
    */
   projectId: string;
+  /**
+   * Discovery source.
+   */
   sourceType: DiscoverySourceType;
   /**
    * Number of states.
@@ -1221,6 +1239,9 @@ interface StateDiscoveryResultCreate {
    * ID of the source session.
    */
   sourceSessionId?: string | null;
+  /**
+   * Discovery source.
+   */
   sourceType: DiscoverySourceType;
   /**
    * Discovered states.
@@ -1352,6 +1373,9 @@ interface StateMachineImport {
    * Override name (uses export name when omitted).
    */
   name?: string | null;
+  /**
+   * The state machine to import.
+   */
   stateMachine: StateMachineExport;
 }
 

package/dist/runner.d.cts

@@ -102,6 +102,10 @@ interface Runner {
    * ISO 8601 timestamp when the runner was first registered.
    */
   createdAt: string;
+  /**
+   * Computed health state derived from `ws_connected` and
+   * `last_heartbeat`. Authoritative for UI display.
+   */
   derivedStatus: RunnerStatus;
   /**
    * Reported hostname of the machine the runner is running on.

package/dist/runner.d.ts

@@ -102,6 +102,10 @@ interface Runner {
    * ISO 8601 timestamp when the runner was first registered.
    */
   createdAt: string;
+  /**
+   * Computed health state derived from `ws_connected` and
+   * `last_heartbeat`. Authoritative for UI display.
+   */
   derivedStatus: RunnerStatus;
   /**
    * Reported hostname of the machine the runner is running on.

package/dist/scheduler.d.cts

@@ -415,6 +415,9 @@ interface TaskExecutionRecord {
    * ISO 8601 timestamp when execution started.
    */
   startedAt: string;
+  /**
+   * Current status of this execution.
+   */
   status: ScheduledTaskStatus;
   /**
    * Whether the task succeeded, read from the session checkpoint.
@@ -508,6 +511,9 @@ interface ScheduledTask {
    * Next scheduled run time (ISO 8601), computed by the runner.
    */
   nextRun?: string | null;
+  /**
+   * Schedule configuration.
+   */
   schedule: ScheduleExpression;
   /**
    * Skip future runs once the task has succeeded at least once.
@@ -517,6 +523,9 @@ interface ScheduledTask {
    * Free-form description of success criteria, for human reference.
    */
   successCriteria?: string | null;
+  /**
+   * Task type and its per-type configuration.
+   */
   task: ScheduledTaskType;
 }
 
@@ -650,6 +659,9 @@ interface CreateScheduledTaskRequest {
    * Display name.
    */
   name: string;
+  /**
+   * Schedule configuration.
+   */
   schedule: ScheduleExpression;
   /**
    * Skip future runs once the task has succeeded.
@@ -659,6 +671,9 @@ interface CreateScheduledTaskRequest {
    * Free-form success criteria description.
    */
   successCriteria?: string | null;
+  /**
+   * Task type and its per-type configuration.
+   */
   task: ScheduledTaskType;
 }
 

package/dist/scheduler.d.ts

@@ -415,6 +415,9 @@ interface TaskExecutionRecord {
    * ISO 8601 timestamp when execution started.
    */
   startedAt: string;
+  /**
+   * Current status of this execution.
+   */
   status: ScheduledTaskStatus;
   /**
    * Whether the task succeeded, read from the session checkpoint.
@@ -508,6 +511,9 @@ interface ScheduledTask {
    * Next scheduled run time (ISO 8601), computed by the runner.
    */
   nextRun?: string | null;
+  /**
+   * Schedule configuration.
+   */
   schedule: ScheduleExpression;
   /**
    * Skip future runs once the task has succeeded at least once.
@@ -517,6 +523,9 @@ interface ScheduledTask {
    * Free-form description of success criteria, for human reference.
    */
   successCriteria?: string | null;
+  /**
+   * Task type and its per-type configuration.
+   */
   task: ScheduledTaskType;
 }
 
@@ -650,6 +659,9 @@ interface CreateScheduledTaskRequest {
    * Display name.
    */
   name: string;
+  /**
+   * Schedule configuration.
+   */
   schedule: ScheduleExpression;
   /**
    * Skip future runs once the task has succeeded.
@@ -659,6 +671,9 @@ interface CreateScheduledTaskRequest {
    * Free-form success criteria description.
    */
   successCriteria?: string | null;
+  /**
+   * Task type and its per-type configuration.
+   */
   task: ScheduledTaskType;
 }
 

package/dist/state-machine.d.cts

@@ -178,6 +178,9 @@ interface TransitionAction {
    * Text to type (`type` action).
    */
   text?: string | null;
+  /**
+   * The kind of action to perform.
+   */
   type: StandardActionType;
   /**
    * Keystroke delay in milliseconds (`type` action).
@@ -1034,6 +1037,9 @@ interface InitialStateRef {
  * resolution came from.
  */
 interface ResolvedInitialStates {
+  /**
+   * Where the resolution came from.
+   */
   source: InitialStatesSource;
   /**
    * Resolved initial state IDs.
@@ -1070,6 +1076,9 @@ interface ResolvedInitialStatesResult {
    * Error message when resolution failed.
    */
   error?: string | null;
+  /**
+   * Where the resolution came from.
+   */
   source: InitialStatesSource;
   /**
    * Resolved initial state IDs.