@qontinui/shared-types 0.12.0 → 0.13.0

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 (128) 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/AgentTextUnit.d.ts +152 -0
  30. package/src/generated/AgentTextUnitError.d.ts +82 -0
  31. package/src/generated/AgentTextUnitFile.d.ts +33 -0
  32. package/src/generated/AgentTextUnitVersion.d.ts +72 -0
  33. package/src/generated/AgenticPhaseOutput.d.ts +3 -0
  34. package/src/generated/ApiAssertion.d.ts +3 -0
  35. package/src/generated/AssertionMiss.d.ts +3 -0
  36. package/src/generated/AssertionOutcome.d.ts +6 -0
  37. package/src/generated/AssertionResult.d.ts +3 -0
  38. package/src/generated/BackendProfile.d.ts +3 -0
  39. package/src/generated/CommandStep.d.ts +3 -0
  40. package/src/generated/CompletenessVerdict.d.ts +3 -0
  41. package/src/generated/ConjunctEvaluation.d.ts +3 -0
  42. package/src/generated/ConjunctRule.d.ts +3 -0
  43. package/src/generated/Constraint.d.ts +6 -0
  44. package/src/generated/ConstraintProposal.d.ts +3 -0
  45. package/src/generated/ConstraintResult.d.ts +3 -0
  46. package/src/generated/CoverageGap.d.ts +9 -0
  47. package/src/generated/CreateMcpServerInput.d.ts +3 -0
  48. package/src/generated/CreateScheduledTaskRequest.d.ts +6 -0
  49. package/src/generated/DiscoveredElement.d.ts +3 -0
  50. package/src/generated/DiscoveredStateImage.d.ts +3 -0
  51. package/src/generated/ElementState.d.ts +3 -0
  52. package/src/generated/EmbeddedElement.d.ts +3 -0
  53. package/src/generated/Entity.d.ts +3 -0
  54. package/src/generated/ExecutionIssueCreate.d.ts +3 -0
  55. package/src/generated/ExecutionIssueDetail.d.ts +12 -0
  56. package/src/generated/ExecutionIssueListResponse.d.ts +3 -0
  57. package/src/generated/ExecutionRunComplete.d.ts +6 -0
  58. package/src/generated/ExecutionRunCompleteResponse.d.ts +6 -0
  59. package/src/generated/ExecutionRunCreate.d.ts +6 -0
  60. package/src/generated/ExecutionRunDetail.d.ts +12 -0
  61. package/src/generated/ExecutionRunListResponse.d.ts +3 -0
  62. package/src/generated/ExecutionRunResponse.d.ts +6 -0
  63. package/src/generated/ExecutionScreenshotCreate.d.ts +3 -0
  64. package/src/generated/Finding.d.ts +3 -0
  65. package/src/generated/FindingCreate.d.ts +9 -0
  66. package/src/generated/FindingDetail.d.ts +12 -0
  67. package/src/generated/FunctionalSpec.d.ts +3 -0
  68. package/src/generated/HelperAnswer.d.ts +3 -0
  69. package/src/generated/HelperTask.d.ts +16 -0
  70. package/src/generated/HistoricalActionResult.d.ts +6 -0
  71. package/src/generated/IrPageSpec.d.ts +62 -0
  72. package/src/generated/IterationResult.d.ts +3 -0
  73. package/src/generated/LoopInstanceStatus.d.ts +3 -0
  74. package/src/generated/McpServerConfig.d.ts +3 -0
  75. package/src/generated/McpToolInfo.d.ts +3 -0
  76. package/src/generated/Monitor.d.ts +3 -0
  77. package/src/generated/MultiLoopEntry.d.ts +3 -0
  78. package/src/generated/NewConstraintProposal.d.ts +3 -0
  79. package/src/generated/OrchestrationLoopStatus.d.ts +3 -0
  80. package/src/generated/OutputLine.d.ts +3 -0
  81. package/src/generated/PolicyConjunct.d.ts +7 -0
  82. package/src/generated/PolicyEvaluation.d.ts +5 -1
  83. package/src/generated/ProcessStatusLite.d.ts +3 -0
  84. package/src/generated/Profile.d.ts +6 -0
  85. package/src/generated/ProjectSnapshot.d.ts +3 -0
  86. package/src/generated/PromptStep.d.ts +3 -0
  87. package/src/generated/RecommendedState.d.ts +3 -0
  88. package/src/generated/ResolvedInitialStates.d.ts +3 -0
  89. package/src/generated/ResolvedInitialStatesResult.d.ts +3 -0
  90. package/src/generated/Runner.d.ts +4 -0
  91. package/src/generated/ScheduledTask.d.ts +6 -0
  92. package/src/generated/ScreenshotAnnotation.d.ts +3 -0
  93. package/src/generated/SessionLite.d.ts +3 -0
  94. package/src/generated/SpecApiEvent.d.ts +26 -0
  95. package/src/generated/SpecCheckResult.d.ts +22 -0
  96. package/src/generated/SpecCheckStepConfig.d.ts +3 -0
  97. package/src/generated/SpecCheckSummary.d.ts +6 -0
  98. package/src/generated/StateDiscoveryResult.d.ts +3 -0
  99. package/src/generated/StateDiscoveryResultCreate.d.ts +3 -0
  100. package/src/generated/StateDiscoveryResultSummary.d.ts +3 -0
  101. package/src/generated/StateMachineImport.d.ts +3 -0
  102. package/src/generated/SuccessCriterion.d.ts +3 -0
  103. package/src/generated/TaskCompletionResult.d.ts +5 -2
  104. package/src/generated/TaskExecutionRecord.d.ts +3 -0
  105. package/src/generated/TaskRun.d.ts +6 -0
  106. package/src/generated/TaskRunBackend.d.ts +3 -0
  107. package/src/generated/TaskRunBackendDetail.d.ts +6 -0
  108. package/src/generated/TaskRunFinding.d.ts +12 -0
  109. package/src/generated/TaskRunFindingCreate.d.ts +6 -0
  110. package/src/generated/TaskRunFindingsListResponse.d.ts +3 -0
  111. package/src/generated/TaskRunListResponse.d.ts +3 -0
  112. package/src/generated/Ticket.d.ts +6 -0
  113. package/src/generated/TicketProviderConfig.d.ts +3 -0
  114. package/src/generated/TransitionAction.d.ts +3 -0
  115. package/src/generated/TreeEvent.d.ts +6 -0
  116. package/src/generated/TreeNode.d.ts +6 -0
  117. package/src/generated/UIBridgeElement.d.ts +6 -0
  118. package/src/generated/UiBridgeHttpHealthEnvelope.d.ts +3 -0
  119. package/src/generated/UiBridgeStep.d.ts +6 -0
  120. package/src/generated/UnifiedWorkflow.d.ts +8 -0
  121. package/src/generated/VectorSearchResult.d.ts +3 -0
  122. package/src/generated/VerificationResult.d.ts +3 -0
  123. package/src/generated/VerificationResultResponse.d.ts +3 -0
  124. package/src/generated/VerificationStepResult.d.ts +3 -0
  125. package/src/generated/WorkerCoordinationMessage.d.ts +3 -0
  126. package/src/generated/WorkerInstance.d.ts +3 -0
  127. package/src/generated/WorkflowStep.d.ts +3 -0
  128. package/src/generated/index.ts +4 -0
@@ -0,0 +1,152 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * This file was automatically generated.
4
+ * DO NOT MODIFY IT BY HAND. Regenerate with `just generate-types` or
5
+ * `qontinui-runner/src-tauri/scripts/generate_types.sh`.
6
+ */
7
+
8
+ /**
9
+ * One unit of the agent text corpus: a `(kind, name)` addressed bundle of
10
+ * text files, owned either by an organization or by the fleet-default layer.
11
+ *
12
+ * The content is **untrusted remote content** from the runner's point of
13
+ * view — it is markdown and shell text rather than compiled code, but it is
14
+ * instructions to an agent and it becomes files on a fleet device. Consumers
15
+ * fail soft (a malformed unit falls back to the next rung of the resolution
16
+ * chain and warns) and never fetch cross-org.
17
+ *
18
+ * This mirrors qontinui-web's `AgentTextUnitResponse` field for field, plus
19
+ * the two forward provenance fields Phase 5 fills in.
20
+ */
21
+ export interface AgentTextUnit {
22
+ /**
23
+ * Canonical digest over the whole [`files`](Self::files) map, from
24
+ * [`agent_text_unit_files_checksum`]. `None` on a row written before a
25
+ * checksum was computed.
26
+ *
27
+ * This is **not** [`crate::agent_commands::agent_command_checksum`]: that
28
+ * one digests a single body and is what the legacy `/agent-commands` wire
29
+ * still carries. The two deliberately disagree even for a one-entry map.
30
+ */
31
+ checksum?: string | null;
32
+ /**
33
+ * ISO 8601 (RFC 3339) creation timestamp.
34
+ */
35
+ created_at: string;
36
+ /**
37
+ * User who last authored this unit. **Attribution only** — it does not
38
+ * scope visibility; [`organization_id`](Self::organization_id) does.
39
+ */
40
+ created_by_user_id?: string | null;
41
+ /**
42
+ * Head of the version chain — the `version_number` of the
43
+ * [`AgentTextUnitVersion`] whose content this unit currently serves.
44
+ * Starts at 1 and only ever increases (a revert bumps it).
45
+ */
46
+ current_version: number;
47
+ /**
48
+ * The key of [`files`](Self::files) holding this unit's primary text,
49
+ * derived server-side from `(kind, name)` — see
50
+ * [`agent_text_unit_entrypoint`]. Read-only: it is recomputed on every
51
+ * response and ignored on write.
52
+ */
53
+ entrypoint: string;
54
+ /**
55
+ * The unit's current content: **relative path → text**. A command carries
56
+ * one entry; a skill carries `SKILL.md` plus siblings.
57
+ *
58
+ * Carried inline on the unit, matching the landed
59
+ * `AgentTextUnitResponse`. Note the cost that buys the convenience: a
60
+ * whole-corpus list is ~88 units / ~1.8 MB, and the runner fetches it on
61
+ * the spawn critical path under a 4 s budget, so a caller that only needs
62
+ * to know whether its cache is current should compare
63
+ * [`checksum`](Self::checksum) rather than re-reading these bytes.
64
+ */
65
+ files: {
66
+ [k: string]: string;
67
+ };
68
+ /**
69
+ * Unit id (UUID v4 string).
70
+ */
71
+ id: string;
72
+ /**
73
+ * Whether the harness may offer this unit as an invocable slash command.
74
+ *
75
+ * `false` means "carried by the corpus, never invocable": the
76
+ * underscore-prefixed units (`_gate-registration`, `_loop-control`) are
77
+ * copy-source specs that other units paste from, and `.claude/commands/`
78
+ * has no include mechanism, so they must be *present on disk* without
79
+ * appearing as `/_gate-registration`. Absent means `true`.
80
+ *
81
+ * Storage enforces the pairing with a CHECK (`left(name,1) <> '_' OR
82
+ * is_invocable = false`); [`validate_agent_text_unit_invocability`] is the
83
+ * same rule at this boundary.
84
+ * Always written on the wire, matching the landed `AgentTextUnitResponse`
85
+ * (which emits it unconditionally). `#[serde(default)]` covers reading an
86
+ * older payload that predates the field; the `#[schemars(default)]` twin
87
+ * is what puts `true` — rather than `null` — into the generated Python and
88
+ * TypeScript bindings, so a consumer that sees the field absent defaults
89
+ * it the same way Rust does.
90
+ */
91
+ is_invocable: boolean;
92
+ /**
93
+ * Whether this unit is visible to the whole organization rather than only
94
+ * its author. Absent means `false`.
95
+ */
96
+ is_shared: boolean;
97
+ /**
98
+ * What sort of unit this is. Open discriminator — see
99
+ * [`AgentTextUnitKind`].
100
+ */
101
+ kind: string;
102
+ /**
103
+ * The unit slug, e.g. `vet-plan` or `coord-revive`. It is the filename
104
+ * stem (single-file kinds) or the directory name (directory kinds) under
105
+ * `.claude/<subdir>/`, so it is a write-boundary value — validate it with
106
+ * [`validate_agent_text_unit_name`] before persisting.
107
+ */
108
+ name: string;
109
+ /**
110
+ * Owning organization (`auth.organizations.id`).
111
+ *
112
+ * **`None` is meaningful**: it is the *fleet-default* layer, resolved
113
+ * after an account override and before the runner's embedded default. It
114
+ * is also what an organization deletion leaves behind (`ondelete SET
115
+ * NULL`), which is why storage keys the NULL bucket with its own partial
116
+ * unique index — see the module docs.
117
+ */
118
+ organization_id?: string | null;
119
+ /**
120
+ * Which resolution layer this row was served from —
121
+ * [`AGENT_TEXT_UNIT_SOURCE_USER`] or [`AGENT_TEXT_UNIT_SOURCE_FLEET`].
122
+ * Server-derived, defaults to `user`.
123
+ *
124
+ * ⚠️ **Unrelated to [`source_path`](Self::source_path) /
125
+ * [`source_commit`](Self::source_commit) despite the shared prefix.** This
126
+ * field names the *layer the row came from*; those two name the *config
127
+ * repo the text was imported from*. Adjacent names, different concepts.
128
+ */
129
+ source: string;
130
+ /**
131
+ * Import provenance: the commit of the source repo (full 40-char SHA).
132
+ * `None` for a console-authored unit, or for an import from a dirty tree
133
+ * where no commit honestly describes the bytes.
134
+ */
135
+ source_commit?: string | null;
136
+ /**
137
+ * Import provenance: the repo-relative path this unit's text came from,
138
+ * e.g. `.claude/skills/coord-revive/`. `None` for a unit authored directly
139
+ * in the console.
140
+ *
141
+ * Recorded per unit at import so the console can show an operator whether
142
+ * a unit still matches its source. The path is **repo-relative on
143
+ * purpose** — an absolute one would pin a build machine's layout into
144
+ * account data.
145
+ */
146
+ source_path?: string | null;
147
+ /**
148
+ * ISO 8601 (RFC 3339) last-modification timestamp.
149
+ */
150
+ updated_at: string;
151
+ [k: string]: unknown;
152
+ }
@@ -0,0 +1,82 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * This file was automatically generated.
4
+ * DO NOT MODIFY IT BY HAND. Regenerate with `just generate-types` or
5
+ * `qontinui-runner/src-tauri/scripts/generate_types.sh`.
6
+ */
7
+
8
+ /**
9
+ * Failure modes for agent text units. Mirrors the tagged-enum shape of
10
+ * [`crate::apps::AppError`] and [`crate::agent_commands::AgentCommandError`],
11
+ * so the qontinui-web layer surfaces a rejected unit the same way it surfaces
12
+ * a rejected app registration.
13
+ *
14
+ * One variant per raise site in qontinui-web's `AgentTextUnitValidationError`,
15
+ * so a Rust caller can render exactly the refusal the store would give.
16
+ */
17
+ export type AgentTextUnitError =
18
+ | {
19
+ name: string;
20
+ reason: "invalid-name";
21
+ [k: string]: unknown;
22
+ }
23
+ | {
24
+ name: string;
25
+ reason: "reserved-name";
26
+ [k: string]: unknown;
27
+ }
28
+ | {
29
+ kind: string;
30
+ reason: "invalid-kind";
31
+ [k: string]: unknown;
32
+ }
33
+ | {
34
+ path: string;
35
+ reason: "invalid-file-path";
36
+ [k: string]: unknown;
37
+ }
38
+ | {
39
+ path: string;
40
+ reason: "reserved-file-path";
41
+ [k: string]: unknown;
42
+ }
43
+ | {
44
+ reason: "empty-file-set";
45
+ [k: string]: unknown;
46
+ }
47
+ | {
48
+ count: number;
49
+ max: number;
50
+ reason: "too-many-files";
51
+ [k: string]: unknown;
52
+ }
53
+ | {
54
+ path: string;
55
+ reason: "blank-file";
56
+ [k: string]: unknown;
57
+ }
58
+ | {
59
+ bytes: number;
60
+ max: number;
61
+ path: string;
62
+ reason: "file-too-large";
63
+ [k: string]: unknown;
64
+ }
65
+ | {
66
+ bytes: number;
67
+ max: number;
68
+ reason: "unit-too-large";
69
+ [k: string]: unknown;
70
+ }
71
+ | {
72
+ entrypoint: string;
73
+ kind: string;
74
+ name: string;
75
+ reason: "missing-entrypoint";
76
+ [k: string]: unknown;
77
+ }
78
+ | {
79
+ name: string;
80
+ reason: "underscore-not-invocable";
81
+ [k: string]: unknown;
82
+ };
@@ -0,0 +1,33 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * This file was automatically generated.
4
+ * DO NOT MODIFY IT BY HAND. Regenerate with `just generate-types` or
5
+ * `qontinui-runner/src-tauri/scripts/generate_types.sh`.
6
+ */
7
+
8
+ /**
9
+ * One `relative path → text` entry of a `files` map, as a standalone record.
10
+ *
11
+ * The map is the storage and wire form (it is one JSONB column, and it makes
12
+ * "no duplicate paths" structural rather than validated). This type is the
13
+ * **entry** form: what a per-file API operation addresses, what a per-file
14
+ * validation failure names, and what a provisioner iterates. Convert with
15
+ * [`from_map`](Self::from_map) / [`into_map`](Self::into_map).
16
+ */
17
+ export interface AgentTextUnitFile {
18
+ /**
19
+ * Path relative to the unit's own directory, `/`-separated, e.g.
20
+ * `SKILL.md` or `coord-revive.sh`. Validated by
21
+ * [`validate_agent_text_unit_file_path`].
22
+ */
23
+ path: string;
24
+ /**
25
+ * The file's full text. Written verbatim (modulo the provisioner's own
26
+ * line-ending handling); never given an executable bit, because scripts
27
+ * in this corpus are invoked as `bash <path>` and Windows has no exec bit
28
+ * anyway. "Account-supplied text written to disk" must not become
29
+ * "account-supplied program registered with the OS".
30
+ */
31
+ text: string;
32
+ [k: string]: unknown;
33
+ }
@@ -0,0 +1,72 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * This file was automatically generated.
4
+ * DO NOT MODIFY IT BY HAND. Regenerate with `just generate-types` or
5
+ * `qontinui-runner/src-tauri/scripts/generate_types.sh`.
6
+ */
7
+
8
+ /**
9
+ * One immutable entry in an [`AgentTextUnit`]'s append-only version chain.
10
+ *
11
+ * Rows are **only ever inserted**. An edit appends the next `version_number`;
12
+ * a revert appends a new version whose `files` are copied from an older one
13
+ * and whose [`restored_from`](Self::restored_from) names that older version.
14
+ * Nothing in the chain is updated or deleted, so the chain is the complete
15
+ * edit history and "revert" is itself a recorded edit.
16
+ */
17
+ export interface AgentTextUnitVersion {
18
+ /**
19
+ * The [`AgentTextUnit`] this version belongs to. Deleting the unit
20
+ * cascades to its versions.
21
+ */
22
+ agent_text_unit_id: string;
23
+ /**
24
+ * Free-text note describing what changed, supplied by the editor. A
25
+ * revert writes a generated one (e.g. `"Restored from version 2"`).
26
+ */
27
+ change_description?: string | null;
28
+ /**
29
+ * Content hash of [`files`](Self::files), from
30
+ * [`agent_text_unit_files_checksum`]. Equal checksums on two versions mean
31
+ * the content is identical, which is what makes the Phase 5 re-import
32
+ * idempotent — it is the field "did the text actually change?" is read
33
+ * off. `None` on a row written before a checksum was computed.
34
+ */
35
+ checksum?: string | null;
36
+ /**
37
+ * ISO 8601 (RFC 3339) creation timestamp. Versions are immutable, so
38
+ * there is deliberately no `updated_at`.
39
+ */
40
+ created_at: string;
41
+ /**
42
+ * User who authored this version. Attribution only.
43
+ */
44
+ created_by_user_id?: string | null;
45
+ /**
46
+ * The unit's whole content as of this version: **relative path → text**.
47
+ *
48
+ * Every key must satisfy [`validate_agent_text_unit_file_path`]; the map
49
+ * must be non-empty and must contain the unit's
50
+ * [`agent_text_unit_entrypoint`].
51
+ */
52
+ files: {
53
+ [k: string]: string;
54
+ };
55
+ /**
56
+ * Version-row id (UUID v4 string).
57
+ */
58
+ id: string;
59
+ /**
60
+ * Provenance for a revert: the `version_number` this version's content
61
+ * was copied from. `None` for an ordinary edit.
62
+ */
63
+ restored_from?: number | null;
64
+ /**
65
+ * Monotonic version number within this unit, starting at 1. Unique per
66
+ * `(agent_text_unit_id, version_number)`; the DB constraint — not
67
+ * application code — is what rejects a duplicate under concurrent
68
+ * appends.
69
+ */
70
+ version_number: number;
71
+ [k: string]: unknown;
72
+ }
@@ -34,6 +34,9 @@ export interface AgenticPhaseOutput {
34
34
  * Reflection fixes (when reflection_mode is enabled).
35
35
  */
36
36
  reflectionFixes: ReflectionFixOutput[];
37
+ /**
38
+ * Overall status of the agentic phase.
39
+ */
37
40
  status: AgenticStatus;
38
41
  /**
39
42
  * Human-readable summary of what was done.
@@ -31,5 +31,8 @@ export interface ApiAssertion {
31
31
  * Comparison operator; defaults to `equals` on the consumer side.
32
32
  */
33
33
  operator?: ApiAssertionOperator | null;
34
+ /**
35
+ * Kind of assertion.
36
+ */
34
37
  type: ApiAssertionType;
35
38
  }
@@ -18,5 +18,8 @@ export interface AssertionMiss {
18
18
  * descending.
19
19
  */
20
20
  candidates?: CandidateMiss[];
21
+ /**
22
+ * Coarse-grained classification of why the match failed.
23
+ */
21
24
  reason: MissReason;
22
25
  }
@@ -19,11 +19,17 @@ import type { MissReason } from "./MissReason";
19
19
  */
20
20
  export type AssertionOutcome =
21
21
  | {
22
+ /**
23
+ * The element that satisfied the assertion.
24
+ */
22
25
  matched: MatchedElement;
23
26
  status: "pass";
24
27
  [k: string]: unknown;
25
28
  }
26
29
  | {
30
+ /**
31
+ * Diagnostic detail.
32
+ */
27
33
  miss: AssertionMiss;
28
34
  status: "fail";
29
35
  [k: string]: unknown;
@@ -28,6 +28,9 @@ export interface AssertionResult {
28
28
  * Snapshot of `IrAssertion.description`.
29
29
  */
30
30
  description: string;
31
+ /**
32
+ * Pass / fail discriminator + payload.
33
+ */
31
34
  outcome: AssertionOutcome;
32
35
  /**
33
36
  * Free-form severity string — `"critical"` / `"error"` / `"warning"`
@@ -11,6 +11,9 @@ import type { ApiStyle } from "./ApiStyle";
11
11
  * Target backend stack.
12
12
  */
13
13
  export interface BackendProfile {
14
+ /**
15
+ * REST vs GraphQL.
16
+ */
14
17
  apiStyle: ApiStyle;
15
18
  /**
16
19
  * Backend auth strategy (e.g. `"jwt"`, `"session"`). Free-form; `None` lets
@@ -104,6 +104,9 @@ export interface CommandStep {
104
104
  * Display name for the step.
105
105
  */
106
106
  name: string;
107
+ /**
108
+ * Phase in which the step appears.
109
+ */
107
110
  phase: CommandStepPhase;
108
111
  /**
109
112
  * Repository selector for repository-targeted steps.
@@ -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.