@contractspec/example.agent-console 3.7.5 → 3.7.7

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 (176) hide show
  1. package/.turbo/turbo-build.log +18 -18
  2. package/AGENTS.md +50 -31
  3. package/CHANGELOG.md +12 -0
  4. package/README.md +69 -77
  5. package/dist/agent/agent.event.js +1 -1
  6. package/dist/agent/agent.operation.js +1 -1
  7. package/dist/agent/index.d.ts +5 -5
  8. package/dist/agent/index.js +1 -1
  9. package/dist/browser/agent/agent.event.js +1 -1
  10. package/dist/browser/agent/agent.operation.js +1 -1
  11. package/dist/browser/agent/index.js +1 -1
  12. package/dist/browser/index.js +2145 -2145
  13. package/dist/browser/presentations/index.js +4 -4
  14. package/dist/browser/run/index.js +536 -536
  15. package/dist/browser/run/run.event.js +2 -2
  16. package/dist/browser/run/run.presentation.js +2 -2
  17. package/dist/browser/tool/index.js +260 -260
  18. package/dist/browser/tool/tool.event.js +1 -1
  19. package/dist/browser/tool/tool.presentation.js +2 -2
  20. package/dist/browser/ui/AgentDashboard.js +956 -956
  21. package/dist/browser/ui/AgentRunList.js +16 -16
  22. package/dist/browser/ui/AgentToolRegistry.js +9 -9
  23. package/dist/browser/ui/hooks/index.js +153 -153
  24. package/dist/browser/ui/hooks/useAgentList.js +1 -1
  25. package/dist/browser/ui/hooks/useAgentMutations.js +1 -1
  26. package/dist/browser/ui/hooks/useRunList.js +1 -1
  27. package/dist/browser/ui/hooks/useToolList.js +1 -1
  28. package/dist/browser/ui/index.js +1222 -1222
  29. package/dist/browser/ui/modals/AgentActionsModal.js +13 -13
  30. package/dist/browser/ui/modals/CreateAgentModal.js +15 -15
  31. package/dist/browser/ui/modals/index.js +297 -297
  32. package/dist/browser/ui/renderers/agent-list.renderer.js +7 -7
  33. package/dist/browser/ui/renderers/index.js +157 -157
  34. package/dist/browser/ui/views/AgentListView.js +7 -7
  35. package/dist/browser/ui/views/RunListView.js +16 -16
  36. package/dist/browser/ui/views/ToolRegistryView.js +9 -9
  37. package/dist/browser/ui/views/index.js +97 -97
  38. package/dist/handlers/index.d.ts +1 -1
  39. package/dist/index.d.ts +4 -4
  40. package/dist/index.js +2145 -2145
  41. package/dist/node/agent/agent.event.js +1 -1
  42. package/dist/node/agent/agent.operation.js +1 -1
  43. package/dist/node/agent/index.js +1 -1
  44. package/dist/node/index.js +2145 -2145
  45. package/dist/node/presentations/index.js +4 -4
  46. package/dist/node/run/index.js +536 -536
  47. package/dist/node/run/run.event.js +2 -2
  48. package/dist/node/run/run.presentation.js +2 -2
  49. package/dist/node/tool/index.js +260 -260
  50. package/dist/node/tool/tool.event.js +1 -1
  51. package/dist/node/tool/tool.presentation.js +2 -2
  52. package/dist/node/ui/AgentDashboard.js +956 -956
  53. package/dist/node/ui/AgentRunList.js +16 -16
  54. package/dist/node/ui/AgentToolRegistry.js +9 -9
  55. package/dist/node/ui/hooks/index.js +153 -153
  56. package/dist/node/ui/hooks/useAgentList.js +1 -1
  57. package/dist/node/ui/hooks/useAgentMutations.js +1 -1
  58. package/dist/node/ui/hooks/useRunList.js +1 -1
  59. package/dist/node/ui/hooks/useToolList.js +1 -1
  60. package/dist/node/ui/index.js +1222 -1222
  61. package/dist/node/ui/modals/AgentActionsModal.js +13 -13
  62. package/dist/node/ui/modals/CreateAgentModal.js +15 -15
  63. package/dist/node/ui/modals/index.js +297 -297
  64. package/dist/node/ui/renderers/agent-list.renderer.js +7 -7
  65. package/dist/node/ui/renderers/index.js +157 -157
  66. package/dist/node/ui/views/AgentListView.js +7 -7
  67. package/dist/node/ui/views/RunListView.js +16 -16
  68. package/dist/node/ui/views/ToolRegistryView.js +9 -9
  69. package/dist/node/ui/views/index.js +97 -97
  70. package/dist/presentations/index.d.ts +3 -5
  71. package/dist/presentations/index.js +4 -4
  72. package/dist/run/index.d.ts +7 -7
  73. package/dist/run/index.js +536 -536
  74. package/dist/run/run.event.js +2 -2
  75. package/dist/run/run.handler.d.ts +3 -0
  76. package/dist/run/run.presentation.js +2 -2
  77. package/dist/shared/index.d.ts +1 -1
  78. package/dist/tool/index.d.ts +7 -7
  79. package/dist/tool/index.js +260 -260
  80. package/dist/tool/tool.event.js +1 -1
  81. package/dist/tool/tool.handler.d.ts +1 -1
  82. package/dist/tool/tool.presentation.js +2 -2
  83. package/dist/ui/AgentDashboard.js +956 -956
  84. package/dist/ui/AgentRunList.js +16 -16
  85. package/dist/ui/AgentToolRegistry.js +9 -9
  86. package/dist/ui/hooks/index.d.ts +4 -4
  87. package/dist/ui/hooks/index.js +153 -153
  88. package/dist/ui/hooks/useAgentList.d.ts +5 -0
  89. package/dist/ui/hooks/useAgentList.js +1 -1
  90. package/dist/ui/hooks/useAgentMutations.d.ts +9 -2
  91. package/dist/ui/hooks/useAgentMutations.js +1 -1
  92. package/dist/ui/hooks/useRunList.d.ts +5 -0
  93. package/dist/ui/hooks/useRunList.js +1 -1
  94. package/dist/ui/hooks/useToolList.d.ts +5 -0
  95. package/dist/ui/hooks/useToolList.js +1 -1
  96. package/dist/ui/index.d.ts +3 -3
  97. package/dist/ui/index.js +1222 -1222
  98. package/dist/ui/modals/AgentActionsModal.js +13 -13
  99. package/dist/ui/modals/CreateAgentModal.js +15 -15
  100. package/dist/ui/modals/index.d.ts +1 -1
  101. package/dist/ui/modals/index.js +297 -297
  102. package/dist/ui/renderers/agent-list.markdown.d.ts +5 -0
  103. package/dist/ui/renderers/agent-list.renderer.js +7 -7
  104. package/dist/ui/renderers/dashboard.markdown.d.ts +5 -0
  105. package/dist/ui/renderers/index.d.ts +2 -2
  106. package/dist/ui/renderers/index.js +157 -157
  107. package/dist/ui/renderers/run-list.markdown.d.ts +5 -0
  108. package/dist/ui/renderers/tool-registry.markdown.d.ts +5 -0
  109. package/dist/ui/views/AgentListView.js +7 -7
  110. package/dist/ui/views/RunListView.js +16 -16
  111. package/dist/ui/views/ToolRegistryView.js +9 -9
  112. package/dist/ui/views/index.js +97 -97
  113. package/package.json +10 -10
  114. package/src/agent/agent.entity.ts +111 -111
  115. package/src/agent/agent.enum.ts +12 -12
  116. package/src/agent/agent.event.ts +91 -91
  117. package/src/agent/agent.handler.ts +123 -123
  118. package/src/agent/agent.operation.ts +400 -400
  119. package/src/agent/agent.presentation.ts +62 -62
  120. package/src/agent/agent.schema.ts +175 -175
  121. package/src/agent/agent.test-spec.ts +48 -48
  122. package/src/agent/index.ts +46 -51
  123. package/src/agent.capability.ts +11 -11
  124. package/src/agent.feature.ts +131 -131
  125. package/src/docs/agent-console.docblock.ts +42 -42
  126. package/src/example.ts +35 -35
  127. package/src/handlers/agent.handlers.ts +522 -521
  128. package/src/handlers/index.ts +12 -12
  129. package/src/index.ts +8 -9
  130. package/src/presentations/index.ts +11 -13
  131. package/src/run/index.ts +49 -54
  132. package/src/run/run.entity.ts +137 -137
  133. package/src/run/run.enum.ts +18 -18
  134. package/src/run/run.event.ts +174 -174
  135. package/src/run/run.handler.ts +92 -91
  136. package/src/run/run.operation.ts +474 -474
  137. package/src/run/run.presentation.ts +42 -42
  138. package/src/run/run.schema.ts +126 -126
  139. package/src/run/run.test-spec.ts +48 -48
  140. package/src/seeders/index.ts +21 -21
  141. package/src/shared/index.ts +1 -1
  142. package/src/shared/mock-agents.ts +76 -76
  143. package/src/shared/mock-runs.ts +102 -102
  144. package/src/shared/mock-tools.ts +140 -140
  145. package/src/shared/overlay-types.ts +23 -23
  146. package/src/tool/index.ts +39 -44
  147. package/src/tool/tool.entity.ts +73 -73
  148. package/src/tool/tool.enum.ts +13 -13
  149. package/src/tool/tool.event.ts +80 -80
  150. package/src/tool/tool.handler.ts +102 -102
  151. package/src/tool/tool.operation.ts +328 -328
  152. package/src/tool/tool.presentation.ts +43 -43
  153. package/src/tool/tool.schema.ts +106 -106
  154. package/src/tool/tool.test-spec.ts +48 -48
  155. package/src/ui/AgentDashboard.tsx +348 -348
  156. package/src/ui/hooks/index.ts +7 -7
  157. package/src/ui/hooks/useAgentList.ts +57 -56
  158. package/src/ui/hooks/useAgentMutations.ts +160 -159
  159. package/src/ui/hooks/useRunList.ts +58 -57
  160. package/src/ui/hooks/useToolList.ts +102 -101
  161. package/src/ui/index.ts +6 -9
  162. package/src/ui/modals/AgentActionsModal.tsx +262 -262
  163. package/src/ui/modals/CreateAgentModal.tsx +232 -232
  164. package/src/ui/modals/index.ts +1 -1
  165. package/src/ui/overlays/demo-overlays.ts +52 -52
  166. package/src/ui/renderers/agent-list.markdown.ts +61 -60
  167. package/src/ui/renderers/agent-list.renderer.tsx +14 -14
  168. package/src/ui/renderers/dashboard.markdown.ts +140 -139
  169. package/src/ui/renderers/index.ts +3 -4
  170. package/src/ui/renderers/run-list.markdown.ts +48 -47
  171. package/src/ui/renderers/tool-registry.markdown.ts +66 -65
  172. package/src/ui/views/AgentListView.tsx +90 -90
  173. package/src/ui/views/RunListView.tsx +141 -141
  174. package/src/ui/views/ToolRegistryView.tsx +113 -113
  175. package/tsconfig.json +7 -8
  176. package/tsdown.config.js +7 -3
@@ -1,16 +1,16 @@
1
1
  import {
2
- defineCommand,
3
- defineQuery,
2
+ defineCommand,
3
+ defineQuery,
4
4
  } from '@contractspec/lib.contracts-spec/operations';
5
5
  import { defineSchemaModel, ScalarTypeEnum } from '@contractspec/lib.schema';
6
6
  import { GranularityEnum, LogLevelEnum, RunStatusEnum } from './run.enum';
7
7
  import {
8
- RunInputModel,
9
- RunLogModel,
10
- RunModel,
11
- RunStepModel,
12
- RunSummaryModel,
13
- TimelineDataPointModel,
8
+ RunInputModel,
9
+ RunLogModel,
10
+ RunModel,
11
+ RunStepModel,
12
+ RunSummaryModel,
13
+ TimelineDataPointModel,
14
14
  } from './run.schema';
15
15
 
16
16
  const OWNERS = ['@agent-console-team'] as const;
@@ -19,506 +19,506 @@ const OWNERS = ['@agent-console-team'] as const;
19
19
  * ExecuteAgentCommand - Starts a new agent run.
20
20
  */
21
21
  export const ExecuteAgentCommand = defineCommand({
22
- meta: {
23
- key: 'agent.run.execute',
24
- version: '1.0.0',
25
- stability: 'stable',
26
- owners: [...OWNERS],
27
- tags: ['run', 'execute'],
28
- description: 'Starts a new agent run with the given input.',
29
- goal: 'Execute an AI agent with user input.',
30
- context: 'Called from chat interface or API.',
31
- },
32
- io: {
33
- input: defineSchemaModel({
34
- name: 'ExecuteAgentInput',
35
- fields: {
36
- agentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
37
- input: { type: RunInputModel, isOptional: false },
38
- sessionId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
39
- metadata: { type: ScalarTypeEnum.JSONObject(), isOptional: true },
40
- stream: { type: ScalarTypeEnum.Boolean(), isOptional: true },
41
- maxIterations: {
42
- type: ScalarTypeEnum.Int_unsecure(),
43
- isOptional: true,
44
- },
45
- timeoutMs: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
46
- },
47
- }),
48
- output: defineSchemaModel({
49
- name: 'ExecuteAgentOutput',
50
- fields: {
51
- runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
52
- status: { type: RunStatusEnum, isOptional: false },
53
- estimatedWaitMs: {
54
- type: ScalarTypeEnum.Int_unsecure(),
55
- isOptional: true,
56
- },
57
- },
58
- }),
59
- errors: {
60
- AGENT_NOT_FOUND: {
61
- description: 'The specified agent does not exist',
62
- http: 404,
63
- gqlCode: 'AGENT_NOT_FOUND',
64
- when: 'Agent ID is invalid',
65
- },
66
- AGENT_NOT_ACTIVE: {
67
- description: 'The specified agent is not active',
68
- http: 400,
69
- gqlCode: 'AGENT_NOT_ACTIVE',
70
- when: 'Agent is in draft/paused/archived state',
71
- },
72
- },
73
- },
74
- policy: { auth: 'user' },
75
- sideEffects: {
76
- emits: [
77
- {
78
- key: 'run.started',
79
- version: '1.0.0',
80
- stability: 'stable',
81
- owners: [...OWNERS],
82
- tags: ['run', 'started'],
83
- when: 'Run is queued',
84
- payload: RunSummaryModel,
85
- },
86
- ],
87
- audit: ['run.started'],
88
- },
89
- acceptance: {
90
- scenarios: [
91
- {
92
- key: 'execute-agent-happy-path',
93
- given: ['Agent exists', 'Agent is active'],
94
- when: ['User submits execution request'],
95
- then: ['Run is created', 'RunStarted event is emitted'],
96
- },
97
- {
98
- key: 'execute-agent-not-active',
99
- given: ['Agent exists but is not active'],
100
- when: ['User attempts to execute'],
101
- then: ['AGENT_NOT_ACTIVE error is returned'],
102
- },
103
- ],
104
- examples: [
105
- {
106
- key: 'basic-execute',
107
- input: { agentId: 'agent-123', input: { message: 'Hello' } },
108
- output: { runId: 'run-456', status: 'pending', estimatedWaitMs: 5000 },
109
- },
110
- ],
111
- },
22
+ meta: {
23
+ key: 'agent.run.execute',
24
+ version: '1.0.0',
25
+ stability: 'stable',
26
+ owners: [...OWNERS],
27
+ tags: ['run', 'execute'],
28
+ description: 'Starts a new agent run with the given input.',
29
+ goal: 'Execute an AI agent with user input.',
30
+ context: 'Called from chat interface or API.',
31
+ },
32
+ io: {
33
+ input: defineSchemaModel({
34
+ name: 'ExecuteAgentInput',
35
+ fields: {
36
+ agentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
37
+ input: { type: RunInputModel, isOptional: false },
38
+ sessionId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
39
+ metadata: { type: ScalarTypeEnum.JSONObject(), isOptional: true },
40
+ stream: { type: ScalarTypeEnum.Boolean(), isOptional: true },
41
+ maxIterations: {
42
+ type: ScalarTypeEnum.Int_unsecure(),
43
+ isOptional: true,
44
+ },
45
+ timeoutMs: { type: ScalarTypeEnum.Int_unsecure(), isOptional: true },
46
+ },
47
+ }),
48
+ output: defineSchemaModel({
49
+ name: 'ExecuteAgentOutput',
50
+ fields: {
51
+ runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
52
+ status: { type: RunStatusEnum, isOptional: false },
53
+ estimatedWaitMs: {
54
+ type: ScalarTypeEnum.Int_unsecure(),
55
+ isOptional: true,
56
+ },
57
+ },
58
+ }),
59
+ errors: {
60
+ AGENT_NOT_FOUND: {
61
+ description: 'The specified agent does not exist',
62
+ http: 404,
63
+ gqlCode: 'AGENT_NOT_FOUND',
64
+ when: 'Agent ID is invalid',
65
+ },
66
+ AGENT_NOT_ACTIVE: {
67
+ description: 'The specified agent is not active',
68
+ http: 400,
69
+ gqlCode: 'AGENT_NOT_ACTIVE',
70
+ when: 'Agent is in draft/paused/archived state',
71
+ },
72
+ },
73
+ },
74
+ policy: { auth: 'user' },
75
+ sideEffects: {
76
+ emits: [
77
+ {
78
+ key: 'run.started',
79
+ version: '1.0.0',
80
+ stability: 'stable',
81
+ owners: [...OWNERS],
82
+ tags: ['run', 'started'],
83
+ when: 'Run is queued',
84
+ payload: RunSummaryModel,
85
+ },
86
+ ],
87
+ audit: ['run.started'],
88
+ },
89
+ acceptance: {
90
+ scenarios: [
91
+ {
92
+ key: 'execute-agent-happy-path',
93
+ given: ['Agent exists', 'Agent is active'],
94
+ when: ['User submits execution request'],
95
+ then: ['Run is created', 'RunStarted event is emitted'],
96
+ },
97
+ {
98
+ key: 'execute-agent-not-active',
99
+ given: ['Agent exists but is not active'],
100
+ when: ['User attempts to execute'],
101
+ then: ['AGENT_NOT_ACTIVE error is returned'],
102
+ },
103
+ ],
104
+ examples: [
105
+ {
106
+ key: 'basic-execute',
107
+ input: { agentId: 'agent-123', input: { message: 'Hello' } },
108
+ output: { runId: 'run-456', status: 'pending', estimatedWaitMs: 5000 },
109
+ },
110
+ ],
111
+ },
112
112
  });
113
113
 
114
114
  /**
115
115
  * CancelRunCommand - Cancels an in-progress run.
116
116
  */
117
117
  export const CancelRunCommand = defineCommand({
118
- meta: {
119
- key: 'agent.run.cancel',
120
- version: '1.0.0',
121
- stability: 'stable',
122
- owners: [...OWNERS],
123
- tags: ['run', 'cancel'],
124
- description: 'Cancels an in-progress agent run.',
125
- goal: 'Stop a running agent execution.',
126
- context: 'Called when user wants to abort a long-running task.',
127
- },
128
- io: {
129
- input: defineSchemaModel({
130
- name: 'CancelRunInput',
131
- fields: {
132
- runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
133
- reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
134
- },
135
- }),
136
- output: defineSchemaModel({
137
- name: 'CancelRunOutput',
138
- fields: {
139
- success: { type: ScalarTypeEnum.Boolean(), isOptional: false },
140
- status: { type: RunStatusEnum, isOptional: false },
141
- },
142
- }),
143
- errors: {
144
- RUN_NOT_FOUND: {
145
- description: 'The specified run does not exist',
146
- http: 404,
147
- gqlCode: 'RUN_NOT_FOUND',
148
- when: 'Run ID is invalid',
149
- },
150
- RUN_NOT_CANCELLABLE: {
151
- description: 'The run cannot be cancelled',
152
- http: 400,
153
- gqlCode: 'RUN_NOT_CANCELLABLE',
154
- when: 'Run is already completed/failed/cancelled',
155
- },
156
- },
157
- },
158
- policy: { auth: 'user' },
159
- sideEffects: {
160
- emits: [
161
- {
162
- key: 'run.cancelled',
163
- version: '1.0.0',
164
- stability: 'stable',
165
- owners: [...OWNERS],
166
- tags: ['run', 'cancelled'],
167
- when: 'Run is cancelled',
168
- payload: RunSummaryModel,
169
- },
170
- ],
171
- audit: ['run.cancelled'],
172
- },
173
- acceptance: {
174
- scenarios: [
175
- {
176
- key: 'cancel-run-happy-path',
177
- given: ['Run exists', 'Run is in progress'],
178
- when: ['User cancels run'],
179
- then: ['Run is cancelled', 'RunCancelled event is emitted'],
180
- },
181
- {
182
- key: 'cancel-run-already-completed',
183
- given: ['Run exists but is already completed'],
184
- when: ['User attempts to cancel'],
185
- then: ['RUN_NOT_CANCELLABLE error is returned'],
186
- },
187
- ],
188
- examples: [
189
- {
190
- key: 'cancel-basic',
191
- input: { runId: 'run-456', reason: 'User requested' },
192
- output: { success: true, status: 'cancelled' },
193
- },
194
- ],
195
- },
118
+ meta: {
119
+ key: 'agent.run.cancel',
120
+ version: '1.0.0',
121
+ stability: 'stable',
122
+ owners: [...OWNERS],
123
+ tags: ['run', 'cancel'],
124
+ description: 'Cancels an in-progress agent run.',
125
+ goal: 'Stop a running agent execution.',
126
+ context: 'Called when user wants to abort a long-running task.',
127
+ },
128
+ io: {
129
+ input: defineSchemaModel({
130
+ name: 'CancelRunInput',
131
+ fields: {
132
+ runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
133
+ reason: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
134
+ },
135
+ }),
136
+ output: defineSchemaModel({
137
+ name: 'CancelRunOutput',
138
+ fields: {
139
+ success: { type: ScalarTypeEnum.Boolean(), isOptional: false },
140
+ status: { type: RunStatusEnum, isOptional: false },
141
+ },
142
+ }),
143
+ errors: {
144
+ RUN_NOT_FOUND: {
145
+ description: 'The specified run does not exist',
146
+ http: 404,
147
+ gqlCode: 'RUN_NOT_FOUND',
148
+ when: 'Run ID is invalid',
149
+ },
150
+ RUN_NOT_CANCELLABLE: {
151
+ description: 'The run cannot be cancelled',
152
+ http: 400,
153
+ gqlCode: 'RUN_NOT_CANCELLABLE',
154
+ when: 'Run is already completed/failed/cancelled',
155
+ },
156
+ },
157
+ },
158
+ policy: { auth: 'user' },
159
+ sideEffects: {
160
+ emits: [
161
+ {
162
+ key: 'run.cancelled',
163
+ version: '1.0.0',
164
+ stability: 'stable',
165
+ owners: [...OWNERS],
166
+ tags: ['run', 'cancelled'],
167
+ when: 'Run is cancelled',
168
+ payload: RunSummaryModel,
169
+ },
170
+ ],
171
+ audit: ['run.cancelled'],
172
+ },
173
+ acceptance: {
174
+ scenarios: [
175
+ {
176
+ key: 'cancel-run-happy-path',
177
+ given: ['Run exists', 'Run is in progress'],
178
+ when: ['User cancels run'],
179
+ then: ['Run is cancelled', 'RunCancelled event is emitted'],
180
+ },
181
+ {
182
+ key: 'cancel-run-already-completed',
183
+ given: ['Run exists but is already completed'],
184
+ when: ['User attempts to cancel'],
185
+ then: ['RUN_NOT_CANCELLABLE error is returned'],
186
+ },
187
+ ],
188
+ examples: [
189
+ {
190
+ key: 'cancel-basic',
191
+ input: { runId: 'run-456', reason: 'User requested' },
192
+ output: { success: true, status: 'cancelled' },
193
+ },
194
+ ],
195
+ },
196
196
  });
197
197
 
198
198
  /**
199
199
  * GetRunQuery - Retrieves a run by ID.
200
200
  */
201
201
  export const GetRunQuery = defineQuery({
202
- meta: {
203
- key: 'agent.run.get',
204
- version: '1.0.0',
205
- stability: 'stable',
206
- owners: [...OWNERS],
207
- tags: ['run', 'get'],
208
- description: 'Retrieves a run by its ID with optional details.',
209
- goal: 'View detailed run information.',
210
- context: 'Run details page or monitoring.',
211
- },
212
- io: {
213
- input: defineSchemaModel({
214
- name: 'GetRunInput',
215
- fields: {
216
- runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
217
- includeSteps: { type: ScalarTypeEnum.Boolean(), isOptional: true },
218
- includeLogs: { type: ScalarTypeEnum.Boolean(), isOptional: true },
219
- },
220
- }),
221
- output: RunModel,
222
- errors: {
223
- RUN_NOT_FOUND: {
224
- description: 'The specified run does not exist',
225
- http: 404,
226
- gqlCode: 'RUN_NOT_FOUND',
227
- when: 'Run ID is invalid',
228
- },
229
- },
230
- },
231
- policy: { auth: 'user' },
232
- acceptance: {
233
- scenarios: [
234
- {
235
- key: 'get-run-happy-path',
236
- given: ['Run exists'],
237
- when: ['User requests run by ID'],
238
- then: ['Run details are returned'],
239
- },
240
- ],
241
- examples: [
242
- {
243
- key: 'get-with-steps',
244
- input: { runId: 'run-456', includeSteps: true, includeLogs: false },
245
- output: { id: 'run-456', status: 'completed', steps: [] },
246
- },
247
- ],
248
- },
202
+ meta: {
203
+ key: 'agent.run.get',
204
+ version: '1.0.0',
205
+ stability: 'stable',
206
+ owners: [...OWNERS],
207
+ tags: ['run', 'get'],
208
+ description: 'Retrieves a run by its ID with optional details.',
209
+ goal: 'View detailed run information.',
210
+ context: 'Run details page or monitoring.',
211
+ },
212
+ io: {
213
+ input: defineSchemaModel({
214
+ name: 'GetRunInput',
215
+ fields: {
216
+ runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
217
+ includeSteps: { type: ScalarTypeEnum.Boolean(), isOptional: true },
218
+ includeLogs: { type: ScalarTypeEnum.Boolean(), isOptional: true },
219
+ },
220
+ }),
221
+ output: RunModel,
222
+ errors: {
223
+ RUN_NOT_FOUND: {
224
+ description: 'The specified run does not exist',
225
+ http: 404,
226
+ gqlCode: 'RUN_NOT_FOUND',
227
+ when: 'Run ID is invalid',
228
+ },
229
+ },
230
+ },
231
+ policy: { auth: 'user' },
232
+ acceptance: {
233
+ scenarios: [
234
+ {
235
+ key: 'get-run-happy-path',
236
+ given: ['Run exists'],
237
+ when: ['User requests run by ID'],
238
+ then: ['Run details are returned'],
239
+ },
240
+ ],
241
+ examples: [
242
+ {
243
+ key: 'get-with-steps',
244
+ input: { runId: 'run-456', includeSteps: true, includeLogs: false },
245
+ output: { id: 'run-456', status: 'completed', steps: [] },
246
+ },
247
+ ],
248
+ },
249
249
  });
250
250
 
251
251
  /**
252
252
  * ListRunsQuery - Lists runs for an organization or agent.
253
253
  */
254
254
  export const ListRunsQuery = defineQuery({
255
- meta: {
256
- key: 'agent.run.list',
257
- version: '1.0.0',
258
- stability: 'stable',
259
- owners: [...OWNERS],
260
- tags: ['run', 'list'],
261
- description: 'Lists runs with optional filtering.',
262
- goal: 'Browse and search run history.',
263
- context: 'Run history/dashboard view.',
264
- },
265
- io: {
266
- input: defineSchemaModel({
267
- name: 'ListRunsInput',
268
- fields: {
269
- organizationId: {
270
- type: ScalarTypeEnum.String_unsecure(),
271
- isOptional: true,
272
- },
273
- agentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
274
- userId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
275
- sessionId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
276
- status: { type: RunStatusEnum, isOptional: true },
277
- startDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
278
- endDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
279
- limit: {
280
- type: ScalarTypeEnum.Int_unsecure(),
281
- isOptional: true,
282
- defaultValue: 20,
283
- },
284
- offset: {
285
- type: ScalarTypeEnum.Int_unsecure(),
286
- isOptional: true,
287
- defaultValue: 0,
288
- },
289
- },
290
- }),
291
- output: defineSchemaModel({
292
- name: 'ListRunsOutput',
293
- fields: {
294
- items: { type: RunSummaryModel, isArray: true, isOptional: false },
295
- total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
296
- hasMore: { type: ScalarTypeEnum.Boolean(), isOptional: false },
297
- },
298
- }),
299
- },
300
- policy: { auth: 'user' },
301
- acceptance: {
302
- scenarios: [
303
- {
304
- key: 'list-runs-happy-path',
305
- given: ['Organization has runs'],
306
- when: ['User lists runs'],
307
- then: ['Paginated list of runs is returned'],
308
- },
309
- ],
310
- examples: [
311
- {
312
- key: 'list-by-agent',
313
- input: { agentId: 'agent-123', limit: 20, offset: 0 },
314
- output: { items: [], total: 0, hasMore: false },
315
- },
316
- ],
317
- },
255
+ meta: {
256
+ key: 'agent.run.list',
257
+ version: '1.0.0',
258
+ stability: 'stable',
259
+ owners: [...OWNERS],
260
+ tags: ['run', 'list'],
261
+ description: 'Lists runs with optional filtering.',
262
+ goal: 'Browse and search run history.',
263
+ context: 'Run history/dashboard view.',
264
+ },
265
+ io: {
266
+ input: defineSchemaModel({
267
+ name: 'ListRunsInput',
268
+ fields: {
269
+ organizationId: {
270
+ type: ScalarTypeEnum.String_unsecure(),
271
+ isOptional: true,
272
+ },
273
+ agentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
274
+ userId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
275
+ sessionId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
276
+ status: { type: RunStatusEnum, isOptional: true },
277
+ startDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
278
+ endDate: { type: ScalarTypeEnum.DateTime(), isOptional: true },
279
+ limit: {
280
+ type: ScalarTypeEnum.Int_unsecure(),
281
+ isOptional: true,
282
+ defaultValue: 20,
283
+ },
284
+ offset: {
285
+ type: ScalarTypeEnum.Int_unsecure(),
286
+ isOptional: true,
287
+ defaultValue: 0,
288
+ },
289
+ },
290
+ }),
291
+ output: defineSchemaModel({
292
+ name: 'ListRunsOutput',
293
+ fields: {
294
+ items: { type: RunSummaryModel, isArray: true, isOptional: false },
295
+ total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
296
+ hasMore: { type: ScalarTypeEnum.Boolean(), isOptional: false },
297
+ },
298
+ }),
299
+ },
300
+ policy: { auth: 'user' },
301
+ acceptance: {
302
+ scenarios: [
303
+ {
304
+ key: 'list-runs-happy-path',
305
+ given: ['Organization has runs'],
306
+ when: ['User lists runs'],
307
+ then: ['Paginated list of runs is returned'],
308
+ },
309
+ ],
310
+ examples: [
311
+ {
312
+ key: 'list-by-agent',
313
+ input: { agentId: 'agent-123', limit: 20, offset: 0 },
314
+ output: { items: [], total: 0, hasMore: false },
315
+ },
316
+ ],
317
+ },
318
318
  });
319
319
 
320
320
  /**
321
321
  * GetRunStepsQuery - Retrieves steps for a run.
322
322
  */
323
323
  export const GetRunStepsQuery = defineQuery({
324
- meta: {
325
- key: 'agent.run.getSteps',
326
- version: '1.0.0',
327
- stability: 'stable',
328
- owners: [...OWNERS],
329
- tags: ['run', 'steps'],
330
- description: 'Retrieves all steps for a specific run.',
331
- goal: 'View step-by-step execution details.',
332
- context: 'Run details page - steps tab.',
333
- },
334
- io: {
335
- input: defineSchemaModel({
336
- name: 'GetRunStepsInput',
337
- fields: {
338
- runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
339
- },
340
- }),
341
- output: defineSchemaModel({
342
- name: 'GetRunStepsOutput',
343
- fields: {
344
- steps: { type: RunStepModel, isArray: true, isOptional: false },
345
- },
346
- }),
347
- },
348
- policy: { auth: 'user' },
349
- acceptance: {
350
- scenarios: [
351
- {
352
- key: 'get-run-steps-happy-path',
353
- given: ['Run exists with steps'],
354
- when: ['User requests steps'],
355
- then: ['Steps list is returned'],
356
- },
357
- ],
358
- examples: [
359
- {
360
- key: 'get-steps-basic',
361
- input: { runId: 'run-456' },
362
- output: { steps: [] },
363
- },
364
- ],
365
- },
324
+ meta: {
325
+ key: 'agent.run.getSteps',
326
+ version: '1.0.0',
327
+ stability: 'stable',
328
+ owners: [...OWNERS],
329
+ tags: ['run', 'steps'],
330
+ description: 'Retrieves all steps for a specific run.',
331
+ goal: 'View step-by-step execution details.',
332
+ context: 'Run details page - steps tab.',
333
+ },
334
+ io: {
335
+ input: defineSchemaModel({
336
+ name: 'GetRunStepsInput',
337
+ fields: {
338
+ runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
339
+ },
340
+ }),
341
+ output: defineSchemaModel({
342
+ name: 'GetRunStepsOutput',
343
+ fields: {
344
+ steps: { type: RunStepModel, isArray: true, isOptional: false },
345
+ },
346
+ }),
347
+ },
348
+ policy: { auth: 'user' },
349
+ acceptance: {
350
+ scenarios: [
351
+ {
352
+ key: 'get-run-steps-happy-path',
353
+ given: ['Run exists with steps'],
354
+ when: ['User requests steps'],
355
+ then: ['Steps list is returned'],
356
+ },
357
+ ],
358
+ examples: [
359
+ {
360
+ key: 'get-steps-basic',
361
+ input: { runId: 'run-456' },
362
+ output: { steps: [] },
363
+ },
364
+ ],
365
+ },
366
366
  });
367
367
 
368
368
  /**
369
369
  * GetRunLogsQuery - Retrieves logs for a run.
370
370
  */
371
371
  export const GetRunLogsQuery = defineQuery({
372
- meta: {
373
- key: 'agent.run.getLogs',
374
- version: '1.0.0',
375
- stability: 'stable',
376
- owners: [...OWNERS],
377
- tags: ['run', 'logs'],
378
- description: 'Retrieves all logs for a specific run.',
379
- goal: 'Debug and audit run execution.',
380
- context: 'Run details page - logs tab.',
381
- },
382
- io: {
383
- input: defineSchemaModel({
384
- name: 'GetRunLogsInput',
385
- fields: {
386
- runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
387
- level: { type: LogLevelEnum, isOptional: true },
388
- stepId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
389
- limit: {
390
- type: ScalarTypeEnum.Int_unsecure(),
391
- isOptional: true,
392
- defaultValue: 100,
393
- },
394
- offset: {
395
- type: ScalarTypeEnum.Int_unsecure(),
396
- isOptional: true,
397
- defaultValue: 0,
398
- },
399
- },
400
- }),
401
- output: defineSchemaModel({
402
- name: 'GetRunLogsOutput',
403
- fields: {
404
- items: { type: RunLogModel, isArray: true, isOptional: false },
405
- total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
406
- hasMore: { type: ScalarTypeEnum.Boolean(), isOptional: false },
407
- },
408
- }),
409
- },
410
- policy: { auth: 'user' },
411
- acceptance: {
412
- scenarios: [
413
- {
414
- key: 'get-run-logs-happy-path',
415
- given: ['Run exists with logs'],
416
- when: ['User requests logs'],
417
- then: ['Paginated logs list is returned'],
418
- },
419
- ],
420
- examples: [
421
- {
422
- key: 'get-logs-filtered',
423
- input: { runId: 'run-456', level: 'error', limit: 50 },
424
- output: { items: [], total: 0, hasMore: false },
425
- },
426
- ],
427
- },
372
+ meta: {
373
+ key: 'agent.run.getLogs',
374
+ version: '1.0.0',
375
+ stability: 'stable',
376
+ owners: [...OWNERS],
377
+ tags: ['run', 'logs'],
378
+ description: 'Retrieves all logs for a specific run.',
379
+ goal: 'Debug and audit run execution.',
380
+ context: 'Run details page - logs tab.',
381
+ },
382
+ io: {
383
+ input: defineSchemaModel({
384
+ name: 'GetRunLogsInput',
385
+ fields: {
386
+ runId: { type: ScalarTypeEnum.String_unsecure(), isOptional: false },
387
+ level: { type: LogLevelEnum, isOptional: true },
388
+ stepId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
389
+ limit: {
390
+ type: ScalarTypeEnum.Int_unsecure(),
391
+ isOptional: true,
392
+ defaultValue: 100,
393
+ },
394
+ offset: {
395
+ type: ScalarTypeEnum.Int_unsecure(),
396
+ isOptional: true,
397
+ defaultValue: 0,
398
+ },
399
+ },
400
+ }),
401
+ output: defineSchemaModel({
402
+ name: 'GetRunLogsOutput',
403
+ fields: {
404
+ items: { type: RunLogModel, isArray: true, isOptional: false },
405
+ total: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
406
+ hasMore: { type: ScalarTypeEnum.Boolean(), isOptional: false },
407
+ },
408
+ }),
409
+ },
410
+ policy: { auth: 'user' },
411
+ acceptance: {
412
+ scenarios: [
413
+ {
414
+ key: 'get-run-logs-happy-path',
415
+ given: ['Run exists with logs'],
416
+ when: ['User requests logs'],
417
+ then: ['Paginated logs list is returned'],
418
+ },
419
+ ],
420
+ examples: [
421
+ {
422
+ key: 'get-logs-filtered',
423
+ input: { runId: 'run-456', level: 'error', limit: 50 },
424
+ output: { items: [], total: 0, hasMore: false },
425
+ },
426
+ ],
427
+ },
428
428
  });
429
429
 
430
430
  /**
431
431
  * GetRunMetricsQuery - Retrieves aggregated metrics for runs.
432
432
  */
433
433
  export const GetRunMetricsQuery = defineQuery({
434
- meta: {
435
- key: 'agent.run.getMetrics',
436
- version: '1.0.0',
437
- stability: 'stable',
438
- owners: [...OWNERS],
439
- tags: ['run', 'metrics'],
440
- description: 'Retrieves aggregated metrics for runs within a time period.',
441
- goal: 'Monitor and analyze agent usage.',
442
- context: 'Analytics dashboard.',
443
- },
444
- io: {
445
- input: defineSchemaModel({
446
- name: 'GetRunMetricsInput',
447
- fields: {
448
- organizationId: {
449
- type: ScalarTypeEnum.String_unsecure(),
450
- isOptional: false,
451
- },
452
- agentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
453
- startDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
454
- endDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
455
- granularity: {
456
- type: GranularityEnum,
457
- isOptional: true,
458
- defaultValue: 'day',
459
- },
460
- },
461
- }),
462
- output: defineSchemaModel({
463
- name: 'GetRunMetricsOutput',
464
- fields: {
465
- totalRuns: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
466
- completedRuns: {
467
- type: ScalarTypeEnum.Int_unsecure(),
468
- isOptional: false,
469
- },
470
- failedRuns: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
471
- totalTokens: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
472
- totalCostUsd: {
473
- type: ScalarTypeEnum.Float_unsecure(),
474
- isOptional: false,
475
- },
476
- averageDurationMs: {
477
- type: ScalarTypeEnum.Float_unsecure(),
478
- isOptional: false,
479
- },
480
- successRate: {
481
- type: ScalarTypeEnum.Float_unsecure(),
482
- isOptional: false,
483
- },
484
- timeline: {
485
- type: TimelineDataPointModel,
486
- isArray: true,
487
- isOptional: false,
488
- },
489
- },
490
- }),
491
- },
492
- policy: { auth: 'user' },
493
- acceptance: {
494
- scenarios: [
495
- {
496
- key: 'get-run-metrics-happy-path',
497
- given: ['Organization has run history'],
498
- when: ['User requests metrics for date range'],
499
- then: ['Aggregated metrics are returned'],
500
- },
501
- ],
502
- examples: [
503
- {
504
- key: 'get-daily-metrics',
505
- input: {
506
- organizationId: 'org-123',
507
- startDate: '2025-01-01',
508
- endDate: '2025-01-31',
509
- granularity: 'day',
510
- },
511
- output: {
512
- totalRuns: 100,
513
- completedRuns: 90,
514
- failedRuns: 10,
515
- totalTokens: 50000,
516
- totalCostUsd: 5.0,
517
- averageDurationMs: 2500,
518
- successRate: 0.9,
519
- timeline: [],
520
- },
521
- },
522
- ],
523
- },
434
+ meta: {
435
+ key: 'agent.run.getMetrics',
436
+ version: '1.0.0',
437
+ stability: 'stable',
438
+ owners: [...OWNERS],
439
+ tags: ['run', 'metrics'],
440
+ description: 'Retrieves aggregated metrics for runs within a time period.',
441
+ goal: 'Monitor and analyze agent usage.',
442
+ context: 'Analytics dashboard.',
443
+ },
444
+ io: {
445
+ input: defineSchemaModel({
446
+ name: 'GetRunMetricsInput',
447
+ fields: {
448
+ organizationId: {
449
+ type: ScalarTypeEnum.String_unsecure(),
450
+ isOptional: false,
451
+ },
452
+ agentId: { type: ScalarTypeEnum.String_unsecure(), isOptional: true },
453
+ startDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
454
+ endDate: { type: ScalarTypeEnum.DateTime(), isOptional: false },
455
+ granularity: {
456
+ type: GranularityEnum,
457
+ isOptional: true,
458
+ defaultValue: 'day',
459
+ },
460
+ },
461
+ }),
462
+ output: defineSchemaModel({
463
+ name: 'GetRunMetricsOutput',
464
+ fields: {
465
+ totalRuns: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
466
+ completedRuns: {
467
+ type: ScalarTypeEnum.Int_unsecure(),
468
+ isOptional: false,
469
+ },
470
+ failedRuns: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
471
+ totalTokens: { type: ScalarTypeEnum.Int_unsecure(), isOptional: false },
472
+ totalCostUsd: {
473
+ type: ScalarTypeEnum.Float_unsecure(),
474
+ isOptional: false,
475
+ },
476
+ averageDurationMs: {
477
+ type: ScalarTypeEnum.Float_unsecure(),
478
+ isOptional: false,
479
+ },
480
+ successRate: {
481
+ type: ScalarTypeEnum.Float_unsecure(),
482
+ isOptional: false,
483
+ },
484
+ timeline: {
485
+ type: TimelineDataPointModel,
486
+ isArray: true,
487
+ isOptional: false,
488
+ },
489
+ },
490
+ }),
491
+ },
492
+ policy: { auth: 'user' },
493
+ acceptance: {
494
+ scenarios: [
495
+ {
496
+ key: 'get-run-metrics-happy-path',
497
+ given: ['Organization has run history'],
498
+ when: ['User requests metrics for date range'],
499
+ then: ['Aggregated metrics are returned'],
500
+ },
501
+ ],
502
+ examples: [
503
+ {
504
+ key: 'get-daily-metrics',
505
+ input: {
506
+ organizationId: 'org-123',
507
+ startDate: '2025-01-01',
508
+ endDate: '2025-01-31',
509
+ granularity: 'day',
510
+ },
511
+ output: {
512
+ totalRuns: 100,
513
+ completedRuns: 90,
514
+ failedRuns: 10,
515
+ totalTokens: 50000,
516
+ totalCostUsd: 5.0,
517
+ averageDurationMs: 2500,
518
+ successRate: 0.9,
519
+ timeline: [],
520
+ },
521
+ },
522
+ ],
523
+ },
524
524
  });