@qontinui/shared-types 0.12.0 → 0.12.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (123) hide show
  1. package/dist/accessibility.d.cts +9 -0
  2. package/dist/accessibility.d.ts +9 -0
  3. package/dist/constraints.d.cts +15 -0
  4. package/dist/constraints.d.ts +15 -0
  5. package/dist/execution.d.cts +39 -0
  6. package/dist/execution.d.ts +39 -0
  7. package/dist/geometry.d.cts +3 -0
  8. package/dist/geometry.d.ts +3 -0
  9. package/dist/index.d.cts +24 -0
  10. package/dist/index.d.ts +24 -0
  11. package/dist/runner.d.cts +4 -0
  12. package/dist/runner.d.ts +4 -0
  13. package/dist/scheduler.d.cts +15 -0
  14. package/dist/scheduler.d.ts +15 -0
  15. package/dist/state-machine.d.cts +9 -0
  16. package/dist/state-machine.d.ts +9 -0
  17. package/dist/task-run.d.cts +45 -0
  18. package/dist/task-run.d.ts +45 -0
  19. package/dist/tree-events.d.cts +12 -0
  20. package/dist/tree-events.d.ts +12 -0
  21. package/dist/workflow.d.cts +26 -0
  22. package/dist/workflow.d.ts +26 -0
  23. package/package.json +3 -3
  24. package/src/generated/AccessibilityNode.d.ts +3 -0
  25. package/src/generated/AccessibilitySnapshot.d.ts +6 -0
  26. package/src/generated/ActionExecutionCreate.d.ts +6 -0
  27. package/src/generated/ActionExecutionListResponse.d.ts +3 -0
  28. package/src/generated/ActionReliabilityStats.d.ts +3 -0
  29. package/src/generated/AgenticPhaseOutput.d.ts +3 -0
  30. package/src/generated/ApiAssertion.d.ts +3 -0
  31. package/src/generated/AssertionMiss.d.ts +3 -0
  32. package/src/generated/AssertionOutcome.d.ts +6 -0
  33. package/src/generated/AssertionResult.d.ts +3 -0
  34. package/src/generated/BackendProfile.d.ts +3 -0
  35. package/src/generated/CommandStep.d.ts +3 -0
  36. package/src/generated/CompletenessVerdict.d.ts +3 -0
  37. package/src/generated/ConjunctEvaluation.d.ts +3 -0
  38. package/src/generated/ConjunctRule.d.ts +3 -0
  39. package/src/generated/Constraint.d.ts +6 -0
  40. package/src/generated/ConstraintProposal.d.ts +3 -0
  41. package/src/generated/ConstraintResult.d.ts +3 -0
  42. package/src/generated/CoverageGap.d.ts +9 -0
  43. package/src/generated/CreateMcpServerInput.d.ts +3 -0
  44. package/src/generated/CreateScheduledTaskRequest.d.ts +6 -0
  45. package/src/generated/DiscoveredElement.d.ts +3 -0
  46. package/src/generated/DiscoveredStateImage.d.ts +3 -0
  47. package/src/generated/ElementState.d.ts +3 -0
  48. package/src/generated/EmbeddedElement.d.ts +3 -0
  49. package/src/generated/Entity.d.ts +3 -0
  50. package/src/generated/ExecutionIssueCreate.d.ts +3 -0
  51. package/src/generated/ExecutionIssueDetail.d.ts +12 -0
  52. package/src/generated/ExecutionIssueListResponse.d.ts +3 -0
  53. package/src/generated/ExecutionRunComplete.d.ts +6 -0
  54. package/src/generated/ExecutionRunCompleteResponse.d.ts +6 -0
  55. package/src/generated/ExecutionRunCreate.d.ts +6 -0
  56. package/src/generated/ExecutionRunDetail.d.ts +12 -0
  57. package/src/generated/ExecutionRunListResponse.d.ts +3 -0
  58. package/src/generated/ExecutionRunResponse.d.ts +6 -0
  59. package/src/generated/ExecutionScreenshotCreate.d.ts +3 -0
  60. package/src/generated/Finding.d.ts +3 -0
  61. package/src/generated/FindingCreate.d.ts +9 -0
  62. package/src/generated/FindingDetail.d.ts +12 -0
  63. package/src/generated/FunctionalSpec.d.ts +3 -0
  64. package/src/generated/HelperAnswer.d.ts +3 -0
  65. package/src/generated/HelperTask.d.ts +16 -0
  66. package/src/generated/HistoricalActionResult.d.ts +6 -0
  67. package/src/generated/IrPageSpec.d.ts +62 -0
  68. package/src/generated/IterationResult.d.ts +3 -0
  69. package/src/generated/LoopInstanceStatus.d.ts +3 -0
  70. package/src/generated/McpServerConfig.d.ts +3 -0
  71. package/src/generated/McpToolInfo.d.ts +3 -0
  72. package/src/generated/Monitor.d.ts +3 -0
  73. package/src/generated/MultiLoopEntry.d.ts +3 -0
  74. package/src/generated/NewConstraintProposal.d.ts +3 -0
  75. package/src/generated/OrchestrationLoopStatus.d.ts +3 -0
  76. package/src/generated/OutputLine.d.ts +3 -0
  77. package/src/generated/PolicyConjunct.d.ts +7 -0
  78. package/src/generated/PolicyEvaluation.d.ts +5 -1
  79. package/src/generated/ProcessStatusLite.d.ts +3 -0
  80. package/src/generated/Profile.d.ts +6 -0
  81. package/src/generated/ProjectSnapshot.d.ts +3 -0
  82. package/src/generated/PromptStep.d.ts +3 -0
  83. package/src/generated/RecommendedState.d.ts +3 -0
  84. package/src/generated/ResolvedInitialStates.d.ts +3 -0
  85. package/src/generated/ResolvedInitialStatesResult.d.ts +3 -0
  86. package/src/generated/Runner.d.ts +4 -0
  87. package/src/generated/ScheduledTask.d.ts +6 -0
  88. package/src/generated/ScreenshotAnnotation.d.ts +3 -0
  89. package/src/generated/SessionLite.d.ts +3 -0
  90. package/src/generated/SpecApiEvent.d.ts +26 -0
  91. package/src/generated/SpecCheckResult.d.ts +22 -0
  92. package/src/generated/SpecCheckStepConfig.d.ts +3 -0
  93. package/src/generated/SpecCheckSummary.d.ts +6 -0
  94. package/src/generated/StateDiscoveryResult.d.ts +3 -0
  95. package/src/generated/StateDiscoveryResultCreate.d.ts +3 -0
  96. package/src/generated/StateDiscoveryResultSummary.d.ts +3 -0
  97. package/src/generated/StateMachineImport.d.ts +3 -0
  98. package/src/generated/SuccessCriterion.d.ts +3 -0
  99. package/src/generated/TaskCompletionResult.d.ts +5 -2
  100. package/src/generated/TaskExecutionRecord.d.ts +3 -0
  101. package/src/generated/TaskRun.d.ts +6 -0
  102. package/src/generated/TaskRunBackend.d.ts +3 -0
  103. package/src/generated/TaskRunBackendDetail.d.ts +6 -0
  104. package/src/generated/TaskRunFinding.d.ts +12 -0
  105. package/src/generated/TaskRunFindingCreate.d.ts +6 -0
  106. package/src/generated/TaskRunFindingsListResponse.d.ts +3 -0
  107. package/src/generated/TaskRunListResponse.d.ts +3 -0
  108. package/src/generated/Ticket.d.ts +6 -0
  109. package/src/generated/TicketProviderConfig.d.ts +3 -0
  110. package/src/generated/TransitionAction.d.ts +3 -0
  111. package/src/generated/TreeEvent.d.ts +6 -0
  112. package/src/generated/TreeNode.d.ts +6 -0
  113. package/src/generated/UIBridgeElement.d.ts +6 -0
  114. package/src/generated/UiBridgeHttpHealthEnvelope.d.ts +3 -0
  115. package/src/generated/UiBridgeStep.d.ts +6 -0
  116. package/src/generated/UnifiedWorkflow.d.ts +8 -0
  117. package/src/generated/VectorSearchResult.d.ts +3 -0
  118. package/src/generated/VerificationResult.d.ts +3 -0
  119. package/src/generated/VerificationResultResponse.d.ts +3 -0
  120. package/src/generated/VerificationStepResult.d.ts +3 -0
  121. package/src/generated/WorkerCoordinationMessage.d.ts +3 -0
  122. package/src/generated/WorkerInstance.d.ts +3 -0
  123. package/src/generated/WorkflowStep.d.ts +3 -0
@@ -61,6 +61,9 @@ export interface CompletenessVerdict {
61
61
  * re-dispatches generation for.
62
62
  */
63
63
  gaps?: CoverageGap[];
64
+ /**
65
+ * Overall node counts by provenance.
66
+ */
64
67
  provenanceMix: ProvenanceMix;
65
68
  /**
66
69
  * Per-section breakdown.
@@ -20,5 +20,8 @@ export interface ConjunctEvaluation {
20
20
  * Snapshot of `PolicyConjunct.name`.
21
21
  */
22
22
  name: string;
23
+ /**
24
+ * Pass / fail / indeterminate.
25
+ */
23
26
  status: PolicyStatus;
24
27
  }
@@ -50,6 +50,9 @@ export type ConjunctRule =
50
50
  }
51
51
  | {
52
52
  kind: "match_outcome_at_least";
53
+ /**
54
+ * Minimum acceptable outcome.
55
+ */
53
56
  outcome: MatchOutcome;
54
57
  [k: string]: unknown;
55
58
  };
@@ -12,6 +12,9 @@ import type { ConstraintSeverity } from "./ConstraintSeverity";
12
12
  * A constraint definition.
13
13
  */
14
14
  export interface Constraint {
15
+ /**
16
+ * What to check.
17
+ */
15
18
  check: ConstraintCheck;
16
19
  /**
17
20
  * Why this constraint exists (shown to the AI on violation).
@@ -29,5 +32,8 @@ export interface Constraint {
29
32
  * Human-readable name.
30
33
  */
31
34
  name: string;
35
+ /**
36
+ * How severe a violation is.
37
+ */
32
38
  severity: ConstraintSeverity;
33
39
  }
@@ -17,6 +17,9 @@ import type { ConstraintSeverity } from "./ConstraintSeverity";
17
17
  */
18
18
  export type ConstraintProposal =
19
19
  | {
20
+ /**
21
+ * The proposed constraint definition.
22
+ */
20
23
  constraint: Constraint;
21
24
  type: "new_constraint";
22
25
  }
@@ -24,6 +24,9 @@ export interface ConstraintResult {
24
24
  * Whether the constraint passed.
25
25
  */
26
26
  passed: boolean;
27
+ /**
28
+ * Severity of the constraint (for quick filtering).
29
+ */
27
30
  severity: ConstraintSeverity;
28
31
  /**
29
32
  * Details about the violation (empty if passed).
@@ -18,13 +18,22 @@ export interface CoverageGap {
18
18
  * Free-form diagnostic detail (e.g. the verifier's near-miss explanation).
19
19
  */
20
20
  detail?: string | null;
21
+ /**
22
+ * Provenance of the gapped node — always `Observed` or `Inferred`.
23
+ */
21
24
  nodeProvenance: SpecProvenance;
25
+ /**
26
+ * Why it is uncovered.
27
+ */
22
28
  reason: GapReason;
23
29
  /**
24
30
  * Dotted ref into the spec, e.g. `"entities.Invoice.fields.amount"` or
25
31
  * `"operations.createInvoice"`.
26
32
  */
27
33
  ref: string;
34
+ /**
35
+ * Which section the gapped node belongs to.
36
+ */
28
37
  section: SpecSection;
29
38
  [k: string]: unknown;
30
39
  }
@@ -44,5 +44,8 @@ export interface CreateMcpServerInput {
44
44
  * Override for the default `timeout_seconds = 30`.
45
45
  */
46
46
  timeoutSeconds?: number | null;
47
+ /**
48
+ * Transport selector.
49
+ */
47
50
  transport: McpTransport;
48
51
  }
@@ -50,6 +50,9 @@ export interface CreateScheduledTaskRequest {
50
50
  * Display name.
51
51
  */
52
52
  name: string;
53
+ /**
54
+ * Schedule configuration.
55
+ */
53
56
  schedule: ScheduleExpression;
54
57
  /**
55
58
  * Skip future runs once the task has succeeded.
@@ -59,5 +62,8 @@ export interface CreateScheduledTaskRequest {
59
62
  * Free-form success criteria description.
60
63
  */
61
64
  successCriteria?: string | null;
65
+ /**
66
+ * Task type and its per-type configuration.
67
+ */
62
68
  task: ScheduledTaskType;
63
69
  }
@@ -36,6 +36,9 @@ export interface DiscoveredElement {
36
36
  * ARIA role attribute.
37
37
  */
38
38
  role?: string | null;
39
+ /**
40
+ * Current observable state.
41
+ */
39
42
  state: ElementState;
40
43
  /**
41
44
  * HTML tag name (e.g. `"BUTTON"`, `"INPUT"`).
@@ -14,6 +14,9 @@ import type { DiscoveryBoundingBox } from "./DiscoveryBoundingBox";
14
14
  * optional pixel-level identification.
15
15
  */
16
16
  export interface DiscoveredStateImage {
17
+ /**
18
+ * Bounding box within the screenshot.
19
+ */
17
20
  bbox: DiscoveryBoundingBox;
18
21
  /**
19
22
  * Confidence score for this image (0.0–1.0). Defaults to `1.0`.
@@ -53,6 +53,9 @@ export interface ElementState {
53
53
  * Whether the element currently has keyboard focus.
54
54
  */
55
55
  focused: boolean;
56
+ /**
57
+ * Bounding rectangle of the element.
58
+ */
56
59
  rect: ElementRect;
57
60
  /**
58
61
  * Currently selected options for `<select>` elements.
@@ -16,6 +16,9 @@ import type { GUIElementChunk } from "./GUIElementChunk";
16
16
  * Mirrors `rag.models.EmbeddedElement`.
17
17
  */
18
18
  export interface EmbeddedElement {
19
+ /**
20
+ * The GUI element that was embedded.
21
+ */
19
22
  element: GUIElementChunk;
20
23
  /**
21
24
  * Model used for embedding.
@@ -13,6 +13,9 @@ import type { SpecProvenance } from "./SpecProvenance";
13
13
  * A domain entity inferred from rendered data shapes.
14
14
  */
15
15
  export interface Entity {
16
+ /**
17
+ * How this entity's existence was established.
18
+ */
16
19
  confidence: SpecProvenance;
17
20
  /**
18
21
  * Optional deduction strength ∈ [0,1]. Present only on `Inferred` nodes;
@@ -45,6 +45,9 @@ export interface ExecutionIssueCreate {
45
45
  * IDs of screenshots illustrating the issue.
46
46
  */
47
47
  screenshotIds?: string[] | null;
48
+ /**
49
+ * Severity.
50
+ */
48
51
  severity: IssueSeverity;
49
52
  /**
50
53
  * State ID active when the issue was observed.
@@ -44,6 +44,9 @@ export interface ExecutionIssueDetail {
44
44
  * Issue ID.
45
45
  */
46
46
  id: string;
47
+ /**
48
+ * Category label for the issue.
49
+ */
47
50
  issueType: IssueType;
48
51
  /**
49
52
  * Opaque additional metadata.
@@ -71,12 +74,21 @@ export interface ExecutionIssueDetail {
71
74
  * Full screenshot records associated with the issue.
72
75
  */
73
76
  screenshots?: ExecutionScreenshotResponse[];
77
+ /**
78
+ * Severity.
79
+ */
74
80
  severity: IssueSeverity;
81
+ /**
82
+ * Source that detected the issue.
83
+ */
75
84
  source: IssueSource;
76
85
  /**
77
86
  * State ID where the issue was observed, if any.
78
87
  */
79
88
  stateName?: string | null;
89
+ /**
90
+ * Current lifecycle status.
91
+ */
80
92
  status: IssueStatus;
81
93
  /**
82
94
  * Short title.
@@ -16,6 +16,9 @@ export interface ExecutionIssueListResponse {
16
16
  * Page of matching issues.
17
17
  */
18
18
  issues: ExecutionIssueResponse[];
19
+ /**
20
+ * Pagination envelope.
21
+ */
19
22
  pagination: Pagination;
20
23
  /**
21
24
  * Summary keyed by severity or status. Shape is intentionally opaque.
@@ -25,7 +25,13 @@ export interface ExecutionRunComplete {
25
25
  * Error message if the run failed.
26
26
  */
27
27
  errorMessage?: string | null;
28
+ /**
29
+ * Aggregate execution statistics.
30
+ */
28
31
  stats: ExecutionStats;
32
+ /**
33
+ * Final lifecycle status.
34
+ */
29
35
  status: RunStatus;
30
36
  /**
31
37
  * Free-form run summary.
@@ -33,6 +33,12 @@ export interface ExecutionRunCompleteResponse {
33
33
  * ISO 8601 timestamp when the run started.
34
34
  */
35
35
  startedAt: string;
36
+ /**
37
+ * Aggregate execution statistics.
38
+ */
36
39
  stats: ExecutionStats;
40
+ /**
41
+ * Final lifecycle status.
42
+ */
37
43
  status: RunStatus;
38
44
  }
@@ -31,7 +31,13 @@ export interface ExecutionRunCreate {
31
31
  * Human-readable run name.
32
32
  */
33
33
  runName: string;
34
+ /**
35
+ * Kind of run being created.
36
+ */
34
37
  runType: RunType;
38
+ /**
39
+ * Runner environment metadata.
40
+ */
35
41
  runnerMetadata: RunnerMetadata;
36
42
  /**
37
43
  * Workflow metadata, if the run executes a workflow.
@@ -57,13 +57,25 @@ export interface ExecutionRunDetail {
57
57
  * Human-readable run name.
58
58
  */
59
59
  runName: string;
60
+ /**
61
+ * Kind of run.
62
+ */
60
63
  runType: RunType;
64
+ /**
65
+ * Runner environment metadata.
66
+ */
61
67
  runnerMetadata: RunnerMetadata;
62
68
  /**
63
69
  * ISO 8601 timestamp when the run started.
64
70
  */
65
71
  startedAt: string;
72
+ /**
73
+ * Aggregate execution statistics.
74
+ */
66
75
  stats: ExecutionStats;
76
+ /**
77
+ * Current lifecycle status.
78
+ */
67
79
  status: RunStatus;
68
80
  /**
69
81
  * ISO 8601 timestamp when the record was last updated.
@@ -14,6 +14,9 @@ import type { RunType } from "./RunType";
14
14
  * Paginated list of execution runs.
15
15
  */
16
16
  export interface ExecutionRunListResponse {
17
+ /**
18
+ * Pagination envelope.
19
+ */
17
20
  pagination: Pagination;
18
21
  /**
19
22
  * Page of matching runs.
@@ -32,10 +32,16 @@ export interface ExecutionRunResponse {
32
32
  * Human-readable run name.
33
33
  */
34
34
  runName: string;
35
+ /**
36
+ * Kind of run.
37
+ */
35
38
  runType: RunType;
36
39
  /**
37
40
  * ISO 8601 timestamp when the run started.
38
41
  */
39
42
  startedAt: string;
43
+ /**
44
+ * Current lifecycle status.
45
+ */
40
46
  status: RunStatus;
41
47
  }
@@ -39,6 +39,9 @@ export interface ExecutionScreenshotCreate {
39
39
  * Client-generated screenshot identifier.
40
40
  */
41
41
  screenshotId: string;
42
+ /**
43
+ * Kind of screenshot.
44
+ */
42
45
  screenshotType: ScreenshotType;
43
46
  /**
44
47
  * Sequence number of the screenshot within the run.
@@ -11,6 +11,9 @@ import type { Confidence } from "./Confidence";
11
11
  * A finding recorded by a worker agent.
12
12
  */
13
13
  export interface Finding {
14
+ /**
15
+ * Confidence level.
16
+ */
14
17
  confidence: Confidence;
15
18
  /**
16
19
  * Description of the finding.
@@ -18,7 +18,13 @@ import type { FindingUserInput } from "./FindingUserInput";
18
18
  * observation.
19
19
  */
20
20
  export interface FindingCreate {
21
+ /**
22
+ * Type of action for this finding.
23
+ */
21
24
  actionType: FindingActionType;
25
+ /**
26
+ * Category of the finding.
27
+ */
22
28
  category: FindingCategory;
23
29
  /**
24
30
  * Code context, if the finding relates to specific code.
@@ -32,6 +38,9 @@ export interface FindingCreate {
32
38
  * Session number where the finding was detected.
33
39
  */
34
40
  sessionNum: number;
41
+ /**
42
+ * Severity level of the finding.
43
+ */
35
44
  severity: FindingSeverity;
36
45
  /**
37
46
  * Hash used to deduplicate findings across sessions.
@@ -19,7 +19,13 @@ import type { FindingUserInput } from "./FindingUserInput";
19
19
  * string (see crate-level wire-format note).
20
20
  */
21
21
  export interface FindingDetail {
22
+ /**
23
+ * Type of action for this finding.
24
+ */
22
25
  actionType: FindingActionType;
26
+ /**
27
+ * Category of the finding.
28
+ */
23
29
  category: FindingCategory;
24
30
  /**
25
31
  * Code context, if the finding relates to specific code.
@@ -53,11 +59,17 @@ export interface FindingDetail {
53
59
  * Session number where the finding was detected.
54
60
  */
55
61
  sessionNum: number;
62
+ /**
63
+ * Severity level of the finding.
64
+ */
56
65
  severity: FindingSeverity;
57
66
  /**
58
67
  * Hash used to deduplicate findings across sessions.
59
68
  */
60
69
  signatureHash?: string | null;
70
+ /**
71
+ * Current status of the finding.
72
+ */
61
73
  status: FindingStatus;
62
74
  /**
63
75
  * Parent task run ID.
@@ -66,6 +66,9 @@ export interface FunctionalSpec {
66
66
  * Schema version. Currently always `"0"`. Additive-only until `"1"`.
67
67
  */
68
68
  specVersion: string;
69
+ /**
70
+ * What was observed and when.
71
+ */
69
72
  target: SpecTarget;
70
73
  /**
71
74
  * Section (3a) UI STATES — a literal superset of the UI Bridge IR. These are the
@@ -42,6 +42,9 @@ export interface HelperAnswer {
42
42
  * The [`HelperTask`] this answers.
43
43
  */
44
44
  taskId: string;
45
+ /**
46
+ * The verdict the helper gave.
47
+ */
45
48
  verdict: HelperVerdict;
46
49
  [k: string]: unknown;
47
50
  }
@@ -20,6 +20,9 @@ import type { HelperVerdict } from "./HelperVerdict";
20
20
  * verdict and routes it back through [`source`](HelperTask::source).
21
21
  */
22
22
  export interface HelperTask {
23
+ /**
24
+ * The set of allowed answers and preset reason codes offered to the helper.
25
+ */
23
26
  answerSchema: HelperAnswerSchema;
24
27
  /**
25
28
  * Application the task pertains to.
@@ -38,7 +41,13 @@ export interface HelperTask {
38
41
  * Task ID (UUID v4 string).
39
42
  */
40
43
  id: string;
44
+ /**
45
+ * Which kind of judgment is being asked for.
46
+ */
41
47
  kind: HelperTaskKind;
48
+ /**
49
+ * Kind-specific content (screenshot URL, compare URLs, steps, …).
50
+ */
42
51
  payload: HelperTaskPayload;
43
52
  /**
44
53
  * Human-readable question shown to the helper (e.g. "Does this login
@@ -49,7 +58,14 @@ export interface HelperTask {
49
58
  * Number of helper answers required before the task is `Answered`.
50
59
  */
51
60
  requiredVotes: number;
61
+ /**
62
+ * Provenance linking the task back to its originating finding / page /
63
+ * spec-check.
64
+ */
52
65
  source: HelperTaskSource;
66
+ /**
67
+ * Current lifecycle status.
68
+ */
53
69
  status: HelperTaskStatus;
54
70
  /**
55
71
  * Tenant that owns the task (coord tenant id).
@@ -16,6 +16,9 @@ export interface HistoricalActionResult {
16
16
  * Human-readable action name.
17
17
  */
18
18
  actionName: string;
19
+ /**
20
+ * Kind of action.
21
+ */
19
22
  actionType: ExecutionActionType;
20
23
  /**
21
24
  * Duration in milliseconds.
@@ -49,6 +52,9 @@ export interface HistoricalActionResult {
49
52
  * URL to an associated screenshot, if any.
50
53
  */
51
54
  screenshotUrl?: string | null;
55
+ /**
56
+ * Outcome.
57
+ */
52
58
  status: ActionStatus;
53
59
  /**
54
60
  * Target state.
@@ -19,6 +19,48 @@ import type { IrTransitionAction } from "./IrTransitionAction";
19
19
  import type { IrWaitSpec } from "./IrWaitSpec";
20
20
  import type { ProposalStatus } from "./ProposalStatus";
21
21
 
22
+ /**
23
+ * API assertion: either a value-level assertion (status_code, json_path, etc.)
24
+ * or a schema-conformance assertion (conforms_to — Phase 2 placeholder).
25
+ */
26
+ export type IrApiAssertion =
27
+ | {
28
+ expected: unknown;
29
+ operator?: string | null;
30
+ type: "status_code";
31
+ [k: string]: unknown;
32
+ }
33
+ | {
34
+ expected: unknown;
35
+ json_path: string;
36
+ operator?: string | null;
37
+ type: "json_path";
38
+ [k: string]: unknown;
39
+ }
40
+ | {
41
+ expected: unknown;
42
+ header_name: string;
43
+ operator?: string | null;
44
+ type: "header";
45
+ [k: string]: unknown;
46
+ }
47
+ | {
48
+ expected: unknown;
49
+ type: "body_contains";
50
+ [k: string]: unknown;
51
+ }
52
+ | {
53
+ expected: unknown;
54
+ operator?: string | null;
55
+ type: "response_time";
56
+ [k: string]: unknown;
57
+ }
58
+ | {
59
+ schema: string;
60
+ type: "conforms_to";
61
+ [k: string]: unknown;
62
+ };
63
+
22
64
  /**
23
65
  * Top-level IR page specification (formerly `IrDocument`).
24
66
  *
@@ -55,3 +97,23 @@ export interface IrPageSpec {
55
97
  version: string;
56
98
  [k: string]: unknown;
57
99
  }
100
+ /**
101
+ * A single API-contract check: issue a request, validate the response.
102
+ */
103
+ export interface IrApiCheck {
104
+ assertions: IrApiAssertion[];
105
+ description?: string | null;
106
+ effect: string;
107
+ id: string;
108
+ request: IrApiRequest;
109
+ [k: string]: unknown;
110
+ }
111
+ export interface IrApiRequest {
112
+ body?: unknown;
113
+ headers?: {
114
+ [k: string]: string;
115
+ } | null;
116
+ method: string;
117
+ path: string;
118
+ [k: string]: unknown;
119
+ }
@@ -25,6 +25,9 @@ export interface IterationResult {
25
25
  * Diagnostic-phase result (if the diagnose phase is configured).
26
26
  */
27
27
  diagnosticResult?: DiagnosticResult | null;
28
+ /**
29
+ * Exit-check outcome for this iteration.
30
+ */
28
31
  exitCheck: ExitCheckResult;
29
32
  /**
30
33
  * Number of fixes proposed during reflection.
@@ -24,5 +24,8 @@ export interface LoopInstanceStatus {
24
24
  * Unique identifier for this loop.
25
25
  */
26
26
  loopId: string;
27
+ /**
28
+ * The per-loop status snapshot.
29
+ */
27
30
  status: OrchestrationLoopStatus;
28
31
  }
@@ -69,6 +69,9 @@ export interface McpServerConfig {
69
69
  * ISO 8601 timestamp of when `cached_tools` was populated.
70
70
  */
71
71
  toolsCachedAt?: string | null;
72
+ /**
73
+ * Which transport this server uses.
74
+ */
72
75
  transport: McpTransport;
73
76
  /**
74
77
  * ISO 8601 last-update timestamp.
@@ -15,6 +15,9 @@ export interface McpToolInfo {
15
15
  * Tool description shown to users.
16
16
  */
17
17
  description?: string | null;
18
+ /**
19
+ * Input-argument schema. Wire field is `"inputSchema"` per MCP spec.
20
+ */
18
21
  inputSchema: McpToolInputSchema;
19
22
  /**
20
23
  * Tool name (the argument passed back on `tools/call`).
@@ -28,6 +28,9 @@ export interface Monitor {
28
28
  * Display name (e.g., "DELL U2720Q").
29
29
  */
30
30
  name?: string | null;
31
+ /**
32
+ * Spatial position based on X coordinate (for UI display).
33
+ */
31
34
  position: MonitorPosition;
32
35
  /**
33
36
  * DPI scale factor (1.0 = 100%, 1.5 = 150%, 2.0 = 200%).
@@ -20,6 +20,9 @@ import type { SummarizationConfig } from "./SummarizationConfig";
20
20
  * A single entry in a multi-loop configuration.
21
21
  */
22
22
  export interface MultiLoopEntry {
23
+ /**
24
+ * The loop configuration.
25
+ */
23
26
  config: OrchestrationLoopConfig;
24
27
  /**
25
28
  * Human label (e.g., `"Pages 1–10"` or an app section name).
@@ -16,5 +16,8 @@ import type { ConstraintSeverity } from "./ConstraintSeverity";
16
16
  * enum's internal tag.
17
17
  */
18
18
  export interface NewConstraintProposal {
19
+ /**
20
+ * The proposed constraint definition.
21
+ */
19
22
  constraint: Constraint;
20
23
  }
@@ -35,6 +35,9 @@ export interface OrchestrationLoopStatus {
35
35
  * Iteration cap for this run. `None` renders as `"∞"`/unlimited in the UI.
36
36
  */
37
37
  maxIterations?: number | null;
38
+ /**
39
+ * Current phase.
40
+ */
38
41
  phase: LoopPhase;
39
42
  /**
40
43
  * Whether the loop is currently running.
@@ -15,6 +15,9 @@ export interface OutputLine {
15
15
  * The line content
16
16
  */
17
17
  line: string;
18
+ /**
19
+ * Which stream this came from
20
+ */
18
21
  stream: OutputStream;
19
22
  /**
20
23
  * ISO 8601 timestamp