@automate.ax/integration-contracts 0.102.0 → 0.103.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.102.0",
+  "version": "0.103.1",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -49,7 +49,7 @@
     }
   },
   "dependencies": {
-    "@automate.ax/codec": "0.102.0",
+    "@automate.ax/codec": "0.103.1",
     "@cfworker/json-schema": "^4.1.1",
     "@googleapis/calendar": "^15.0.0",
     "@googleapis/forms": "^6.0.1",

package/src/automate/index.ts

@@ -14,6 +14,24 @@ const RESOURCE_REFERENCE_SCHEMA = z.object({
   id: z.string().min(1),
   name: z.string().min(1),
 })
+const AUTOMATE_ERROR_BASE_SCHEMA = z.object({
+  code: z.string().min(1),
+  details: z.json().optional(),
+  message: z.string(),
+  name: z.string().optional(),
+})
+const AUTOMATE_ERROR_DEPTH_0_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
+  cause: z.never().optional(),
+})
+const AUTOMATE_ERROR_DEPTH_1_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
+  cause: AUTOMATE_ERROR_DEPTH_0_SCHEMA.optional(),
+})
+const AUTOMATE_ERROR_DEPTH_2_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
+  cause: AUTOMATE_ERROR_DEPTH_1_SCHEMA.optional(),
+})
+export const AUTOMATE_ERROR_SCHEMA = AUTOMATE_ERROR_BASE_SCHEMA.extend({
+  cause: AUTOMATE_ERROR_DEPTH_2_SCHEMA.optional(),
+})
 
 export const AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA = z.object({
   automationId: z.string().min(1),
@@ -23,6 +41,12 @@ export const AUTOMATE_DEPLOYMENT_TRIGGER_CONFIG_SCHEMA = z.object({
   projectId: z.string().min(1),
 })
 
+export const AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA =
+  AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA
+
+export const AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA =
+  AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA
+
 export const AUTOMATE_AUTOMATION_STATE_EVENT_SCHEMA = z.object({
   automation: z.object({
     description: z.string(),
@@ -93,7 +117,136 @@ export const AUTOMATE_DEPLOYMENT_SUCCEEDED_EVENT_SCHEMA =
     status: z.literal("succeeded"),
   })
 
+const AUTOMATE_EXECUTION_STATUS_SCHEMA = z.enum([
+  "running",
+  "settled",
+  "failed",
+])
+
+export const AUTOMATE_EXECUTION_EVENT_SCHEMA = z.object({
+  automation: z.object({
+    description: z.string(),
+    id: z.string().min(1),
+    identityKey: z.string().min(1),
+  }),
+  eventTypes: z.string().array(),
+  execution: z.object({
+    createdAt: z.date(),
+    id: z.string().min(1),
+    settledAt: z.date().nullable(),
+    status: AUTOMATE_EXECUTION_STATUS_SCHEMA,
+  }),
+  failure: AUTOMATE_ERROR_SCHEMA.nullable(),
+  organization: RESOURCE_REFERENCE_SCHEMA,
+  project: RESOURCE_REFERENCE_SCHEMA,
+  transitionedAt: z.date(),
+})
+
+export const AUTOMATE_EXECUTION_SETTLED_EVENT_SCHEMA =
+  AUTOMATE_EXECUTION_EVENT_SCHEMA.extend({
+    execution: AUTOMATE_EXECUTION_EVENT_SCHEMA.shape.execution.extend({
+      settledAt: z.date(),
+      status: z.literal("settled"),
+    }),
+    failure: z.null(),
+  })
+
+export const AUTOMATE_EXECUTION_FAILED_EVENT_SCHEMA =
+  AUTOMATE_EXECUTION_EVENT_SCHEMA.extend({
+    execution: AUTOMATE_EXECUTION_EVENT_SCHEMA.shape.execution.extend({
+      settledAt: z.date(),
+      status: z.literal("failed"),
+    }),
+    failure: AUTOMATE_ERROR_SCHEMA,
+  })
+
+const AUTOMATE_ACTION_ATTEMPT_STATUS_SCHEMA = z.enum([
+  "running",
+  "retrying",
+  "succeeded",
+  "failed",
+  "indeterminate",
+])
+
+export const AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA = z.object({
+  action: z.object({
+    id: z.string().min(1),
+    maxAttempts: z.number().int().positive(),
+    name: z.string(),
+    replaySafety: z.enum(["safe", "unsafe"]).nullable(),
+    slot: z.number().int().nonnegative(),
+    status: z.enum(["pending", "succeeded", "skipped", "failed"]),
+  }),
+  attempt: z.object({
+    completedAt: z.date().nullable(),
+    id: z.string().min(1),
+    ordinal: z.number().int().positive(),
+    retryAt: z.date().nullable(),
+    startedAt: z.date(),
+    status: AUTOMATE_ACTION_ATTEMPT_STATUS_SCHEMA,
+  }),
+  automation: z.object({
+    id: z.string().min(1),
+    identityKey: z.string().min(1),
+  }),
+  execution: z.object({ id: z.string().min(1) }),
+  failure: AUTOMATE_ERROR_SCHEMA.nullable(),
+  organization: RESOURCE_REFERENCE_SCHEMA,
+  project: RESOURCE_REFERENCE_SCHEMA,
+  transitionedAt: z.date(),
+})
+
+export const AUTOMATE_ACTION_RETRY_SCHEDULED_EVENT_SCHEMA =
+  AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.extend({
+    attempt: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.attempt.extend({
+      completedAt: z.date(),
+      retryAt: z.date(),
+      status: z.literal("retrying"),
+    }),
+    failure: AUTOMATE_ERROR_SCHEMA,
+  })
+
+export const AUTOMATE_ACTION_FAILED_EVENT_SCHEMA =
+  AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.extend({
+    action: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.action.extend({
+      status: z.literal("failed"),
+    }),
+    attempt: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.attempt.extend({
+      completedAt: z.date(),
+      status: z.literal("failed"),
+    }),
+    failure: AUTOMATE_ERROR_SCHEMA,
+  })
+
+export const AUTOMATE_ACTION_INDETERMINATE_EVENT_SCHEMA =
+  AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.extend({
+    action: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.action.extend({
+      status: z.literal("failed"),
+    }),
+    attempt: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA.shape.attempt.extend({
+      completedAt: z.date(),
+      status: z.literal("indeterminate"),
+    }),
+    failure: AUTOMATE_ERROR_SCHEMA,
+  })
+
 export const automateTriggerContracts = {
+  "automate.action.failed": {
+    configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_ACTION_FAILED_EVENT_SCHEMA,
+  },
+  "automate.action.indeterminate": {
+    configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_ACTION_INDETERMINATE_EVENT_SCHEMA,
+  },
+  "automate.action.retryScheduled": {
+    configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_ACTION_RETRY_SCHEDULED_EVENT_SCHEMA,
+  },
+  "automate.actionAttempt.event": {
+    configSchema: AUTOMATE_ACTION_ATTEMPT_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_ACTION_ATTEMPT_EVENT_SCHEMA,
+  },
   "automate.automation.disabled": {
     configSchema: AUTOMATE_AUTOMATION_TRIGGER_CONFIG_SCHEMA,
     eventSchema: AUTOMATE_AUTOMATION_DISABLED_EVENT_SCHEMA,
@@ -126,4 +279,16 @@ export const automateTriggerContracts = {
     configSchema: AUTOMATE_DEPLOYMENT_TRIGGER_CONFIG_SCHEMA,
     eventSchema: AUTOMATE_DEPLOYMENT_SUCCEEDED_EVENT_SCHEMA,
   },
+  "automate.execution.event": {
+    configSchema: AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_EXECUTION_EVENT_SCHEMA,
+  },
+  "automate.execution.failed": {
+    configSchema: AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_EXECUTION_FAILED_EVENT_SCHEMA,
+  },
+  "automate.execution.settled": {
+    configSchema: AUTOMATE_EXECUTION_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: AUTOMATE_EXECUTION_SETTLED_EVENT_SCHEMA,
+  },
 } as const

package/src/slack/event-schemas.ts

@@ -252,13 +252,17 @@ const SLACK_PROVIDER_PINNED_INFO_SCHEMA = z
     pinned_ts: z.number(),
   })
   .catchall(z.json())
+const SLACK_PROVIDER_PIN_COUNT_SCHEMA = z.union([
+  z.number().int().nonnegative(),
+  z.string().regex(/^\d+$/u),
+])
 const SLACK_PROVIDER_PIN_EVENT_BASE_SCHEMA = z
   .object({
     channel_id: z.string(),
     event_ts: SLACK_EVENT_TIMESTAMP_SCHEMA,
     item: SLACK_PROVIDER_PIN_ITEM_SCHEMA,
     item_user: z.string().optional(),
-    pin_count: z.string().optional(),
+    pin_count: SLACK_PROVIDER_PIN_COUNT_SCHEMA.optional(),
     pinned_info: SLACK_PROVIDER_PINNED_INFO_SCHEMA.optional(),
     user: z.string(),
   })