@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
@@ -76,6 +76,9 @@ export interface StateDiscoveryResult {
76
76
  * ID of the source session (extraction, recording, …).
77
77
  */
78
78
  sourceSessionId?: string | null;
79
+ /**
80
+ * How this state machine was discovered.
81
+ */
79
82
  sourceType: DiscoverySourceType;
80
83
  /**
81
84
  * Number of states (statistic).
@@ -53,6 +53,9 @@ export interface StateDiscoveryResultCreate {
53
53
  * ID of the source session.
54
54
  */
55
55
  sourceSessionId?: string | null;
56
+ /**
57
+ * Discovery source.
58
+ */
56
59
  sourceType: DiscoverySourceType;
57
60
  /**
58
61
  * Discovered states.
@@ -45,6 +45,9 @@ export interface StateDiscoveryResultSummary {
45
45
  * ID of the project.
46
46
  */
47
47
  projectId: string;
48
+ /**
49
+ * Discovery source.
50
+ */
48
51
  sourceType: DiscoverySourceType;
49
52
  /**
50
53
  * Number of states.
@@ -21,5 +21,8 @@ export interface StateMachineImport {
21
21
  * Override name (uses export name when omitted).
22
22
  */
23
23
  name?: string | null;
24
+ /**
25
+ * The state machine to import.
26
+ */
24
27
  stateMachine: StateMachineExport;
25
28
  }
@@ -38,6 +38,9 @@ export interface SuccessCriterion {
38
38
  * Whether this criterion must pass for task completion.
39
39
  */
40
40
  required: boolean;
41
+ /**
42
+ * Type of verification required. Serialized as `"type"` on the wire.
43
+ */
41
44
  type: CriterionType;
42
45
  /**
43
46
  * Configuration blob for the verification method (command args, log
@@ -29,6 +29,9 @@ export type TaskCompletionResult =
29
29
  */
30
30
  iterations: number;
31
31
  status: "success";
32
+ /**
33
+ * Final verification results.
34
+ */
32
35
  verification_results: IterationVerificationResults;
33
36
  [k: string]: unknown;
34
37
  }
@@ -44,7 +47,7 @@ export type TaskCompletionResult =
44
47
  /**
45
48
  * Last verification results (if any).
46
49
  */
47
- last_results?: IterationVerificationResults1 | null;
50
+ last_results?: IterationVerificationResults | null;
48
51
  /**
49
52
  * Human-readable reason for the failure.
50
53
  */
@@ -80,7 +83,7 @@ export type TaskCompletionResult =
80
83
  /**
81
84
  * Last verification results (if any).
82
85
  */
83
- last_results?: IterationVerificationResults1 | null;
86
+ last_results?: IterationVerificationResults | null;
84
87
  /**
85
88
  * The max-iteration limit that triggered the pause.
86
89
  */
@@ -49,6 +49,9 @@ export interface TaskExecutionRecord {
49
49
  * ISO 8601 timestamp when execution started.
50
50
  */
51
51
  startedAt: string;
52
+ /**
53
+ * Current status of this execution.
54
+ */
52
55
  status: ScheduledTaskStatus;
53
56
  /**
54
57
  * Whether the task succeeded, read from the session checkpoint.
@@ -63,6 +63,9 @@ export interface TaskRun {
63
63
  * Number of AI sessions that have been run.
64
64
  */
65
65
  sessionsCount: number;
66
+ /**
67
+ * Current lifecycle status.
68
+ */
66
69
  status: TaskRunStatus;
67
70
  /**
68
71
  * AI-generated summary of the task run.
@@ -76,6 +79,9 @@ export interface TaskRun {
76
79
  * Display name of the task.
77
80
  */
78
81
  taskName: string;
82
+ /**
83
+ * Kind of task (one-off, automation, or scheduled).
84
+ */
79
85
  taskType: TaskType;
80
86
  /**
81
87
  * ISO 8601 timestamp when the task record was last updated.
@@ -74,6 +74,9 @@ export interface TaskRunBackend {
74
74
  * Number of AI sessions that have been run.
75
75
  */
76
76
  sessionsCount: number;
77
+ /**
78
+ * Current lifecycle status.
79
+ */
77
80
  status: TaskRunStatus;
78
81
  /**
79
82
  * Display name.
@@ -45,6 +45,9 @@ export interface TaskRunBackendDetail {
45
45
  * Error message if the task failed.
46
46
  */
47
47
  errorMessage: string | null;
48
+ /**
49
+ * Aggregated counts of findings.
50
+ */
48
51
  findingSummary: TaskRunFindingSummary;
49
52
  /**
50
53
  * Findings surfaced during this task run.
@@ -86,6 +89,9 @@ export interface TaskRunBackendDetail {
86
89
  * Number of AI sessions that have been run.
87
90
  */
88
91
  sessionsCount: number;
92
+ /**
93
+ * Current lifecycle status.
94
+ */
89
95
  status: TaskRunStatus;
90
96
  /**
91
97
  * Display name.
@@ -17,7 +17,13 @@ import type { TaskRunFindingStatus } from "./TaskRunFindingStatus";
17
17
  * possibly `null`), so they use `serde(default)` without `skip_serializing_if`.
18
18
  */
19
19
  export interface TaskRunFinding {
20
+ /**
21
+ * How the finding should be acted upon.
22
+ */
20
23
  actionType: TaskRunFindingActionType;
24
+ /**
25
+ * Category (bug, security, performance, etc.).
26
+ */
21
27
  category: TaskRunFindingCategory;
22
28
  /**
23
29
  * Snippet of code illustrating the issue.
@@ -75,11 +81,17 @@ export interface TaskRunFinding {
75
81
  * Session number in which the finding was resolved.
76
82
  */
77
83
  resolvedInSession: number | null;
84
+ /**
85
+ * Severity of the finding.
86
+ */
78
87
  severity: TaskRunFindingSeverity;
79
88
  /**
80
89
  * Hash used to deduplicate findings across runs.
81
90
  */
82
91
  signatureHash: string | null;
92
+ /**
93
+ * Current lifecycle status.
94
+ */
83
95
  status: TaskRunFindingStatus;
84
96
  /**
85
97
  * Parent task run ID.
@@ -18,6 +18,9 @@ export interface TaskRunFindingCreate {
18
18
  * Action type (defaults server-side if omitted).
19
19
  */
20
20
  actionType?: TaskRunFindingActionType | null;
21
+ /**
22
+ * Category.
23
+ */
21
24
  category: TaskRunFindingCategory;
22
25
  /**
23
26
  * Snippet of code illustrating the issue.
@@ -63,6 +66,9 @@ export interface TaskRunFindingCreate {
63
66
  * Resolution text, if already resolved.
64
67
  */
65
68
  resolution?: string | null;
69
+ /**
70
+ * Severity.
71
+ */
66
72
  severity: TaskRunFindingSeverity;
67
73
  /**
68
74
  * Deduplication hash.
@@ -20,5 +20,8 @@ export interface TaskRunFindingsListResponse {
20
20
  * Findings for the task run.
21
21
  */
22
22
  findings: TaskRunFinding[];
23
+ /**
24
+ * Aggregated counts of findings.
25
+ */
23
26
  summary: TaskRunFindingSummary;
24
27
  }
@@ -13,6 +13,9 @@ import type { TaskRunStatus } from "./TaskRunStatus";
13
13
  * Response for `GET /task-runs`.
14
14
  */
15
15
  export interface TaskRunListResponse {
16
+ /**
17
+ * Pagination envelope.
18
+ */
16
19
  pagination: Pagination;
17
20
  /**
18
21
  * Page of matching task runs.
@@ -36,7 +36,13 @@ export interface Ticket {
36
36
  * Labels applied to the ticket by the provider.
37
37
  */
38
38
  labels?: string[];
39
+ /**
40
+ * Which provider this ticket came from.
41
+ */
39
42
  source: TicketSource;
43
+ /**
44
+ * Abstract lifecycle state.
45
+ */
40
46
  state: TicketState;
41
47
  /**
42
48
  * Ticket title / summary.
@@ -35,6 +35,9 @@ export interface TicketProviderConfig {
35
35
  * Poll interval in seconds. Default: 60.
36
36
  */
37
37
  pollIntervalSeconds: number;
38
+ /**
39
+ * Which provider this config targets.
40
+ */
38
41
  source: TicketSource;
39
42
  /**
40
43
  * Provider-specific target:
@@ -77,6 +77,9 @@ export interface TransitionAction {
77
77
  * Text to type (`type` action).
78
78
  */
79
79
  text?: string | null;
80
+ /**
81
+ * The kind of action to perform.
82
+ */
80
83
  type: StandardActionType;
81
84
  /**
82
85
  * Keystroke delay in milliseconds (`type` action).
@@ -26,7 +26,13 @@ import type { TreeNode } from "./TreeNode";
26
26
  * a sequence number for ordering.
27
27
  */
28
28
  export interface TreeEvent {
29
+ /**
30
+ * Specific tree-event variant.
31
+ */
29
32
  eventType: TreeEventType;
33
+ /**
34
+ * The node this event is about.
35
+ */
30
36
  node: TreeNode;
31
37
  /**
32
38
  * Path from root to this node (breadcrumb).
@@ -41,11 +41,17 @@ export interface TreeNode {
41
41
  * Display name for this node.
42
42
  */
43
43
  name: string;
44
+ /**
45
+ * Type of node (workflow / action / transition).
46
+ */
44
47
  nodeType: NodeType;
45
48
  /**
46
49
  * ID of parent node, `None` for root.
47
50
  */
48
51
  parentId?: string | null;
52
+ /**
53
+ * Current execution status.
54
+ */
49
55
  status: NodeStatus;
50
56
  /**
51
57
  * When this node was created (Unix epoch seconds).
@@ -47,6 +47,9 @@ export interface UIBridgeElement {
47
47
  * Unique element ID within the registry.
48
48
  */
49
49
  id: string;
50
+ /**
51
+ * Identifier bundle for locating the element.
52
+ */
50
53
  identifier: ElementIdentifier;
51
54
  /**
52
55
  * Human-readable label for the element.
@@ -65,6 +68,9 @@ export interface UIBridgeElement {
65
68
  * Populated by the SDK's element walker. Source of truth for IrElementCriteria.role.
66
69
  */
67
70
  role?: string | null;
71
+ /**
72
+ * Current observable state.
73
+ */
68
74
  state: ElementState;
69
75
  /**
70
76
  * HTML tag name in lowercase. Source of truth for IrElementCriteria.tag_name.
@@ -26,6 +26,9 @@ import type { UiBridgeHttpHealthData } from "./UiBridgeHttpHealthData";
26
26
  * other three fields are always present.
27
27
  */
28
28
  export interface UiBridgeHttpHealthEnvelope {
29
+ /**
30
+ * Transport-diagnostics payload (typed signals + open diagnostics spread).
31
+ */
29
32
  data: UiBridgeHttpHealthData;
30
33
  /**
31
34
  * Always `true` on the health path.
@@ -17,6 +17,9 @@ import type { VerificationCategoryKind } from "./VerificationCategoryKind";
17
17
  * UI Bridge SDK interaction — navigate, execute, assert, snapshot, compare.
18
18
  */
19
19
  export interface UiBridgeStep {
20
+ /**
21
+ * Action kind.
22
+ */
20
23
  action: UiBridgeAction;
21
24
  /**
22
25
  * Structured action plan (for `action_plan`).
@@ -76,6 +79,9 @@ export interface UiBridgeStep {
76
79
  * Display name for the step.
77
80
  */
78
81
  name: string;
82
+ /**
83
+ * Phase in which the step appears.
84
+ */
79
85
  phase: UiBridgeStepPhase;
80
86
  /**
81
87
  * Reference snapshot ID (for `compare` / `snapshot_assert`).
@@ -215,6 +215,14 @@ export interface UnifiedWorkflow {
215
215
  * Whether this workflow is marked as a favorite for quick access.
216
216
  */
217
217
  isFavorite: boolean;
218
+ /**
219
+ * Log source selection for this workflow.
220
+ *
221
+ * - `"default"`: use the global default profile (from Settings → Log Sources)
222
+ * - `"ai"`: let AI automatically select relevant sources based on context
223
+ * - `"all"`: use all enabled log sources
224
+ * - `{ "profile_id": "..." }`: use a specific profile
225
+ */
218
226
  logSourceSelection?: LogSourceSelection;
219
227
  /**
220
228
  * Whether to automatically include a `log_watch` step before verification.
@@ -20,6 +20,9 @@ export interface VectorSearchResult {
20
20
  * Distance metric from query.
21
21
  */
22
22
  distance: number;
23
+ /**
24
+ * The matched GUI element.
25
+ */
23
26
  element: GUIElementChunk;
24
27
  /**
25
28
  * Which embedding was matched: `"text"`, `"image"`, or `"hybrid"`.
@@ -20,6 +20,9 @@ export interface VerificationResult {
20
20
  * The criterion that was checked.
21
21
  */
22
22
  criterionId: string;
23
+ /**
24
+ * Type of verification performed.
25
+ */
23
26
  criterionType: CriterionType;
24
27
  /**
25
28
  * Issues found (if failed).
@@ -45,6 +45,9 @@ export interface VerificationResultResponse {
45
45
  * Number of steps that passed.
46
46
  */
47
47
  passedSteps: number;
48
+ /**
49
+ * Full typed verification result payload.
50
+ */
48
51
  resultJson: VerificationPhaseResult;
49
52
  /**
50
53
  * Number of steps that were skipped.
@@ -14,6 +14,9 @@ import type { VerificationStepDetails } from "./VerificationStepDetails";
14
14
  * Result of a single step within a verification phase.
15
15
  */
16
16
  export interface VerificationStepResult {
17
+ /**
18
+ * Execution config for the step.
19
+ */
17
20
  config: StepExecutionConfig;
18
21
  /**
19
22
  * Step duration in milliseconds.
@@ -32,6 +32,9 @@ export type WorkerCoordinationMessage =
32
32
  }
33
33
  | {
34
34
  data: {
35
+ /**
36
+ * The finding payload.
37
+ */
35
38
  finding: Finding;
36
39
  /**
37
40
  * ID of the worker that made the finding.
@@ -50,6 +50,9 @@ export interface WorkerInstance {
50
50
  * ISO 8601 timestamp when the worker started.
51
51
  */
52
52
  startedAt?: string | null;
53
+ /**
54
+ * Current status.
55
+ */
53
56
  status: WorkerStatus;
54
57
  /**
55
58
  * Files this worker has touched.
@@ -45,6 +45,9 @@ export interface WorkflowStep {
45
45
  * Display name for the step.
46
46
  */
47
47
  name: string;
48
+ /**
49
+ * Phase in which the step appears.
50
+ */
48
51
  phase: WorkflowStepPhase;
49
52
  /**
50
53
  * Whether this step is required (default: `true` on consumer side).
@@ -21,6 +21,10 @@ export type { ActiveStatesResult } from './ActiveStatesResult';
21
21
  export type { AgentCommand } from './AgentCommand';
22
22
  export type { AgentCommandError } from './AgentCommandError';
23
23
  export type { AgentCommandVersion } from './AgentCommandVersion';
24
+ export type { AgentTextUnit } from './AgentTextUnit';
25
+ export type { AgentTextUnitError } from './AgentTextUnitError';
26
+ export type { AgentTextUnitFile } from './AgentTextUnitFile';
27
+ export type { AgentTextUnitVersion } from './AgentTextUnitVersion';
24
28
  export type { AgenticPhaseOutput } from './AgenticPhaseOutput';
25
29
  export type { AgenticStatus } from './AgenticStatus';
26
30
  export type { AiWorkflow } from './AiWorkflow';