@automate.ax/integration-contracts 0.102.0 → 0.103.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.
@@ -12,12 +12,32 @@ const RESOURCE_REFERENCE_SCHEMA = z.object({
12
12
  id: z.string().min(1),
13
13
  name: z.string().min(1),
14
14
  });
15
+ const AUTOMATE_ERROR_BASE_SCHEMA = z.object({
16
+ code: z.string().min(1),
17
+ details: z.json().optional(),
18
+ message: z.string(),
19
+ name: z.string().optional(),
20
+ });
21
+ const AUTOMATE_ERROR_DEPTH_0_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
22
+ cause: z.never().optional(),
23
+ });
24
+ const AUTOMATE_ERROR_DEPTH_1_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
25
+ cause: AUTOMATE_ERROR_DEPTH_0_SCHEMA.optional(),
26
+ });
27
+ const AUTOMATE_ERROR_DEPTH_2_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
28
+ cause: AUTOMATE_ERROR_DEPTH_1_SCHEMA.optional(),
29
+ });
30
+ export const AUTOMATE_ERROR_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
31
+ cause: AUTOMATE_ERROR_DEPTH_2_SCHEMA.optional(),
32
+ });
15
33
  export const AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA = z.object({
16
34
  automationId: z.string().min(1),
17
35
  });
18
36
  export const AUTOMATE_DEPLOYMENT_TRIGGER_CONFIG_SCHEMA = z.object({
19
37
  projectId: z.string().min(1),
20
38
  });
39
+ export const AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA = AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA;
40
+ export const AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA = AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA;
21
41
  export const AUTOMATE_AUTOMATION_STATE_EVENT_SCHEMA = z.object({
22
42
  automation: z.object({
23
43
  description: z.string(),
@@ -72,7 +92,122 @@ export const AUTOMATE_DEPLOYMENT_SUCCEEDED_EVENT_SCHEMA = AUTOMATE_TERMINAL_DEPL
72
92
  failure: z.null(),
73
93
  status: z.literal("succeeded"),
74
94
  });
95
+ const AUTOMATE_EXECUTION_STATUS_SCHEMA = z.enum([
96
+ "running",
97
+ "settled",
98
+ "failed",
99
+ ]);
100
+ export const AUTOMATE_EXECUTION_EVENT_SCHEMA = z.object({
101
+ automation: z.object({
102
+ description: z.string(),
103
+ id: z.string().min(1),
104
+ identityKey: z.string().min(1),
105
+ }),
106
+ eventTypes: z.string().array(),
107
+ execution: z.object({
108
+ createdAt: z.date(),
109
+ id: z.string().min(1),
110
+ settledAt: z.date().nullable(),
111
+ status: AUTOMATE_EXECUTION_STATUS_SCHEMA,
112
+ }),
113
+ failure: AUTOMATE_ERROR_SCHEMA.nullable(),
114
+ organization: RESOURCE_REFERENCE_SCHEMA,
115
+ project: RESOURCE_REFERENCE_SCHEMA,
116
+ transitionedAt: z.date(),
117
+ });
118
+ export const AUTOMATE_EXECUTION_SETTLED_EVENT_SCHEMA = AUTOMATE_EXECUTION_EVENT_SCHEMA.extend({
119
+ execution: AUTOMATE_EXECUTION_EVENT_SCHEMA.shape.execution.extend({
120
+ settledAt: z.date(),
121
+ status: z.literal("settled"),
122
+ }),
123
+ failure: z.null(),
124
+ });
125
+ export const AUTOMATE_EXECUTION_FAILED_EVENT_SCHEMA = AUTOMATE_EXECUTION_EVENT_SCHEMA.extend({
126
+ execution: AUTOMATE_EXECUTION_EVENT_SCHEMA.shape.execution.extend({
127
+ settledAt: z.date(),
128
+ status: z.literal("failed"),
129
+ }),
130
+ failure: AUTOMATE_ERROR_SCHEMA,
131
+ });
132
+ const AUTOMATE_ACTION_ATTEMPT_STATUS_SCHEMA = z.enum([
133
+ "running",
134
+ "retrying",
135
+ "succeeded",
136
+ "failed",
137
+ "indeterminate",
138
+ ]);
139
+ export const AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA = z.object({
140
+ action: z.object({
141
+ id: z.string().min(1),
142
+ maxAttempts: z.number().int().positive(),
143
+ name: z.string(),
144
+ replaySafety: z.enum(["safe", "unsafe"]).nullable(),
145
+ slot: z.number().int().nonnegative(),
146
+ status: z.enum(["pending", "succeeded", "skipped", "failed"]),
147
+ }),
148
+ attempt: z.object({
149
+ completedAt: z.date().nullable(),
150
+ id: z.string().min(1),
151
+ ordinal: z.number().int().positive(),
152
+ retryAt: z.date().nullable(),
153
+ startedAt: z.date(),
154
+ status: AUTOMATE_ACTION_ATTEMPT_STATUS_SCHEMA,
155
+ }),
156
+ automation: z.object({
157
+ id: z.string().min(1),
158
+ identityKey: z.string().min(1),
159
+ }),
160
+ execution: z.object({ id: z.string().min(1) }),
161
+ failure: AUTOMATE_ERROR_SCHEMA.nullable(),
162
+ organization: RESOURCE_REFERENCE_SCHEMA,
163
+ project: RESOURCE_REFERENCE_SCHEMA,
164
+ transitionedAt: z.date(),
165
+ });
166
+ export const AUTOMATE_ACTION_RETRY_SCHEDULED_EVENT_SCHEMA = AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.extend({
167
+ attempt: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.attempt.extend({
168
+ completedAt: z.date(),
169
+ retryAt: z.date(),
170
+ status: z.literal("retrying"),
171
+ }),
172
+ failure: AUTOMATE_ERROR_SCHEMA,
173
+ });
174
+ export const AUTOMATE_ACTION_FAILED_EVENT_SCHEMA = AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.extend({
175
+ action: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.action.extend({
176
+ status: z.literal("failed"),
177
+ }),
178
+ attempt: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.attempt.extend({
179
+ completedAt: z.date(),
180
+ status: z.literal("failed"),
181
+ }),
182
+ failure: AUTOMATE_ERROR_SCHEMA,
183
+ });
184
+ export const AUTOMATE_ACTION_INDETERMINATE_EVENT_SCHEMA = AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.extend({
185
+ action: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.action.extend({
186
+ status: z.literal("failed"),
187
+ }),
188
+ attempt: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.attempt.extend({
189
+ completedAt: z.date(),
190
+ status: z.literal("indeterminate"),
191
+ }),
192
+ failure: AUTOMATE_ERROR_SCHEMA,
193
+ });
75
194
  export const automateTriggerContracts = {
195
+ "automate.action.failed": {
196
+ configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
197
+ eventSchema: AUTOMATE_ACTION_FAILED_EVENT_SCHEMA,
198
+ },
199
+ "automate.action.indeterminate": {
200
+ configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
201
+ eventSchema: AUTOMATE_ACTION_INDETERMINATE_EVENT_SCHEMA,
202
+ },
203
+ "automate.action.retryScheduled": {
204
+ configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
205
+ eventSchema: AUTOMATE_ACTION_RETRY_SCHEDULED_EVENT_SCHEMA,
206
+ },
207
+ "automate.actionAttempt.event": {
208
+ configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
209
+ eventSchema: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA,
210
+ },
76
211
  "automate.automation.disabled": {
77
212
  configSchema: AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA,
78
213
  eventSchema: AUTOMATE_AUTOMATION_DISABLED_EVENT_SCHEMA,
@@ -105,4 +240,16 @@ export const automateTriggerContracts = {
105
240
  configSchema: AUTOMATE_DEPLOYMENT_TRIGGER_CONFIG_SCHEMA,
106
241
  eventSchema: AUTOMATE_DEPLOYMENT_SUCCEEDED_EVENT_SCHEMA,
107
242
  },
243
+ "automate.execution.event": {
244
+ configSchema: AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA,
245
+ eventSchema: AUTOMATE_EXECUTION_EVENT_SCHEMA,
246
+ },
247
+ "automate.execution.failed": {
248
+ configSchema: AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA,
249
+ eventSchema: AUTOMATE_EXECUTION_FAILED_EVENT_SCHEMA,
250
+ },
251
+ "automate.execution.settled": {
252
+ configSchema: AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA,
253
+ eventSchema: AUTOMATE_EXECUTION_SETTLED_EVENT_SCHEMA,
254
+ },
108
255
  };
@@ -1549,8 +1549,8 @@ export declare const CLOSE_ACTIVITY_SCHEMA: z.ZodDiscriminatedUnion<[z.ZodObject
1549
1549
  destinationLeadId: z.ZodString;
1550
1550
  errorMessage: z.ZodNullable<z.ZodString>;
1551
1551
  mergeStatus: z.ZodEnum<{
1552
- completed: "completed";
1553
1552
  pending: "pending";
1553
+ completed: "completed";
1554
1554
  in_progress: "in_progress";
1555
1555
  errored: "errored";
1556
1556
  }>;
@@ -1421,26 +1421,26 @@ export declare const LINEAR_ISSUE_REFERENCE_SCHEMA: z.ZodObject<{
1421
1421
  /** Lifecycle states returned for Linear agent sessions. */
1422
1422
  export declare const LINEAR_AGENT_SESSION_STATUS_SCHEMA: z.ZodEnum<{
1423
1423
  error: "error";
1424
- active: "active";
1425
1424
  pending: "pending";
1425
+ active: "active";
1426
1426
  stale: "stale";
1427
1427
  awaitingInput: "awaitingInput";
1428
1428
  complete: "complete";
1429
1429
  }>;
1430
1430
  /** Lifecycle states returned for one Linear agent-session plan step. */
1431
1431
  export declare const LINEAR_AGENT_SESSION_PLAN_ITEM_STATUS_SCHEMA: z.ZodEnum<{
1432
+ pending: "pending";
1432
1433
  completed: "completed";
1433
1434
  canceled: "canceled";
1434
- pending: "pending";
1435
1435
  inProgress: "inProgress";
1436
1436
  }>;
1437
1437
  /** One step in a Linear agent session's execution plan. */
1438
1438
  export declare const LINEAR_AGENT_SESSION_PLAN_ITEM_SCHEMA: z.ZodObject<{
1439
1439
  content: z.ZodString;
1440
1440
  status: z.ZodEnum<{
1441
+ pending: "pending";
1441
1442
  completed: "completed";
1442
1443
  canceled: "canceled";
1443
- pending: "pending";
1444
1444
  inProgress: "inProgress";
1445
1445
  }>;
1446
1446
  }, z.core.$strip>;
@@ -1471,9 +1471,9 @@ export declare const LINEAR_AGENT_SESSION_SCHEMA: z.ZodObject<{
1471
1471
  plan: z.ZodNullable<z.ZodArray<z.ZodObject<{
1472
1472
  content: z.ZodString;
1473
1473
  status: z.ZodEnum<{
1474
+ pending: "pending";
1474
1475
  completed: "completed";
1475
1476
  canceled: "canceled";
1476
- pending: "pending";
1477
1477
  inProgress: "inProgress";
1478
1478
  }>;
1479
1479
  }, z.core.$strip>>>;
@@ -1481,8 +1481,8 @@ export declare const LINEAR_AGENT_SESSION_SCHEMA: z.ZodObject<{
1481
1481
  startedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1482
1482
  status: z.ZodEnum<{
1483
1483
  error: "error";
1484
- active: "active";
1485
1484
  pending: "pending";
1485
+ active: "active";
1486
1486
  stale: "stale";
1487
1487
  awaitingInput: "awaitingInput";
1488
1488
  complete: "complete";
@@ -1711,6 +1711,7 @@ export declare const LINEAR_PROVIDER_PROJECT_SCHEMA: z.ZodObject<{
1711
1711
  type: z.ZodString;
1712
1712
  }, z.core.$strip>;
1713
1713
  completedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1714
+ startedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1714
1715
  color: z.ZodString;
1715
1716
  url: z.ZodString;
1716
1717
  updatedAt: z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>;
@@ -1741,7 +1742,6 @@ export declare const LINEAR_PROVIDER_PROJECT_SCHEMA: z.ZodObject<{
1741
1742
  archivedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1742
1743
  canceledAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1743
1744
  priorityLabel: z.ZodString;
1744
- startedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1745
1745
  slugId: z.ZodString;
1746
1746
  targetDate: z.ZodNullable<z.ZodISODate>;
1747
1747
  resourceCount: z.ZodNumber;
@@ -1788,6 +1788,7 @@ export declare const LINEAR_PROVIDER_ISSUE_SCHEMA: z.ZodObject<{
1788
1788
  }, z.core.$strip>>;
1789
1789
  description: z.ZodNullable<z.ZodString>;
1790
1790
  completedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1791
+ startedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1791
1792
  team: z.ZodObject<{
1792
1793
  displayName: z.ZodString;
1793
1794
  id: z.ZodString;
@@ -1832,7 +1833,6 @@ export declare const LINEAR_PROVIDER_ISSUE_SCHEMA: z.ZodObject<{
1832
1833
  canceledAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1833
1834
  estimate: z.ZodNullable<z.ZodNumber>;
1834
1835
  priorityLabel: z.ZodString;
1835
- startedAt: z.ZodNullable<z.ZodUnion<readonly [z.ZodDate, z.ZodPipe<z.ZodISODateTime, z.ZodTransform<Date, string>>]>>;
1836
1836
  trashed: z.ZodNullable<z.ZodBoolean>;
1837
1837
  branchName: z.ZodString;
1838
1838
  delegate: z.ZodNullable<z.ZodObject<{