@automate.ax/api-contract 0.56.1 → 0.57.0

package/src/deployment.ts

@@ -31,14 +31,7 @@ const GIT_SOURCE_SCHEMA = z.object({
 })
 
 export const deploymentContract = {
-  cancel: oc
-    .input(
-      z.object({
-        deploymentId: z.string(),
-        projectId: z.string(),
-      }),
-    )
-    .output(z.void()),
+  cancel: oc.input(z.object({ deploymentId: z.string() })).output(z.void()),
   create: oc
     .errors({ DEPLOYMENT_IN_PROGRESS: DEPLOYMENT_IN_PROGRESS_ERROR })
     .input(
@@ -71,47 +64,48 @@ export const deploymentContract = {
       }),
     )
     .output(z.object({ id: z.string() })),
-  get: oc
-    .input(
-      z.object({
-        deploymentId: z.string(),
-        projectId: z.string(),
-      }),
-    )
-    .output(
-      z.object({
-        automations: z
-          .object({
-            description: z.string(),
-            id: z.string(),
-            identityKey: z.string(),
-            subscriptions: z
-              .object({
-                config: z.json(),
-                eventType: z.string(),
-                hookSlot: z.number().int().nonnegative(),
-              })
-              .array(),
-          })
-          .array(),
-        createdAt: z.date(),
-        id: z.string(),
-        git: GIT_SOURCE_SCHEMA.nullable(),
-        job: z
-          .object({
-            attempts: z.number().int().nonnegative(),
-            error: z.string().nullable(),
-            maxAttempts: z.number().int().positive(),
-            nextRunAt: z.date(),
-          })
-          .nullable(),
-        project: z.object({
+  get: oc.input(z.object({ deploymentId: z.string() })).output(
+    z.object({
+      automations: z
+        .object({
+          description: z.string(),
           id: z.string(),
-          name: z.string(),
-        }),
-        status: DEPLOYMENT_STATUS_SCHEMA,
+          identityKey: z.string(),
+          scopes: z
+            .object({
+              name: z.string().optional(),
+              path: z.number().int().nonnegative().array().min(1),
+              presentation: z.enum(["collapsed", "expanded", "hidden"]),
+            })
+            .array(),
+          subscriptions: z
+            .object({
+              config: z.json(),
+              eventType: z.string(),
+              hookSlot: z.number().int().nonnegative(),
+              scopePath: z.number().int().nonnegative().array().default([]),
+            })
+            .array(),
+        })
+        .array(),
+      createdAt: z.date(),
+      id: z.string(),
+      git: GIT_SOURCE_SCHEMA.nullable(),
+      job: z
+        .object({
+          attempts: z.number().int().nonnegative(),
+          error: z.string().nullable(),
+          maxAttempts: z.number().int().positive(),
+          nextRunAt: z.date(),
+        })
+        .nullable(),
+      project: z.object({
+        id: z.string(),
+        name: z.string(),
       }),
-    ),
+      status: DEPLOYMENT_STATUS_SCHEMA,
+    }),
+  ),
   redeploy: oc
     .errors({ DEPLOYMENT_IN_PROGRESS: DEPLOYMENT_IN_PROGRESS_ERROR })
     .input(

package/src/runtime.ts

@@ -15,6 +15,12 @@ const SIGNAL_FAILURE_SCHEMA = z.object({
 })
 
 const OUTCOME_SEQUENCE_SCHEMA = z.number().int().positive()
+const HOOK_SCOPE_PATH_SCHEMA = z
+  .number()
+  .int()
+  .nonnegative()
+  .array()
+  .default([])
 
 const AUTOMATION_INVOCATION_RUN_AT_SCHEMA = z.union([
   z.date(),
@@ -75,6 +81,7 @@ const ACTION_INVOCATION_BASE_SCHEMA = z.object({
   eventDependencyIds: z.string().array(),
   inputHash: z.string(),
   name: z.string(),
+  scopePath: HOOK_SCOPE_PATH_SCHEMA,
   signalDependencyIds: z.string().array(),
   slot: z.number().int().nonnegative(),
 })
@@ -124,17 +131,18 @@ const ACTION_RUN_INVOCATION_SCHEMA = z.union([
 const SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA = z.object({
   actionDependencyIds: z.string().array(),
   eventDependencyIds: z.string().array(),
+  scopePath: HOOK_SCOPE_PATH_SCHEMA,
   signalDependencyIds: z.string().array(),
   slot: z.number().int().nonnegative(),
 })
 
-const BUFFER_PARAMETER_DEPENDENCIES_SCHEMA = z.object({
+const COORDINATION_PARAMETER_DEPENDENCIES_SCHEMA = z.object({
   parameterActionDependencyIds: z.string().array(),
   parameterEventDependencyIds: z.string().array(),
   parameterSignalDependencyIds: z.string().array(),
 })
 
-const BUFFER_PRIMARY_POSITION_SCHEMA = z.enum(["first", "last"])
+const COORDINATION_PRIMARY_POSITION_SCHEMA = z.enum(["first", "last"])
 const CORRELATION_STREAM_NAMES_SCHEMA = z
   .string()
   .min(1)
@@ -144,10 +152,11 @@ const CORRELATION_STREAM_NAMES_SCHEMA = z
     message: "Correlation stream names must be unique.",
   })
 
-const CORRELATION_ENTRY_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
+const CORRELATION_OFFER_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
   key: encodableSchema,
   order: CORRELATION_STREAM_NAMES_SCHEMA.optional(),
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  policy: z.literal("correlate"),
   streamName: z.string().min(1),
   streamNames: CORRELATION_STREAM_NAMES_SCHEMA,
   ttl: z.union([z.string().min(1), z.number().nonnegative()]).optional(),
@@ -172,21 +181,23 @@ const CORRELATION_ENTRY_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
   }
 })
 
-const COLLECTION_ENTRY_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
+const COLLECTION_OFFER_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
   count: z.number().int().positive(),
   key: encodableSchema,
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
-  primaryPosition: BUFFER_PRIMARY_POSITION_SCHEMA,
+  policy: z.literal("collect"),
+  primaryPosition: COORDINATION_PRIMARY_POSITION_SCHEMA,
   ttl: z.union([z.string().min(1), z.number().nonnegative()]).optional(),
-}).extend(BUFFER_PARAMETER_DEPENDENCIES_SCHEMA.shape)
+}).extend(COORDINATION_PARAMETER_DEPENDENCIES_SCHEMA.shape)
 
-const WINDOW_ENTRY_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
+const WINDOW_OFFER_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
   duration: z.union([z.string().min(1), z.number().nonnegative()]),
   key: encodableSchema,
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
-  primaryPosition: BUFFER_PRIMARY_POSITION_SCHEMA,
+  policy: z.literal("window"),
+  primaryPosition: COORDINATION_PRIMARY_POSITION_SCHEMA,
   ttl: z.union([z.string().min(1), z.number().nonnegative()]).optional(),
-}).extend(BUFFER_PARAMETER_DEPENDENCIES_SCHEMA.shape)
+}).extend(COORDINATION_PARAMETER_DEPENDENCIES_SCHEMA.shape)
 
 const SIGNAL_INVOCATION_SCHEMA = z.union([
   SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
@@ -228,6 +239,7 @@ const ACTION_VALUE_OUTCOME_BASE_SCHEMA = z.object({
   actionInvocationId: z.string(),
   contextId: z.string(),
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  scopePath: HOOK_SCOPE_PATH_SCHEMA,
   slot: z.number().int(),
 })
 
@@ -255,6 +267,7 @@ const ACTION_VALUE_OUTCOME_SCHEMA = z.union([
 const SIGNAL_VALUE_OUTCOME_BASE_SCHEMA = z.object({
   contextId: z.string(),
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  scopePath: HOOK_SCOPE_PATH_SCHEMA,
   signalInvocationId: z.string(),
   slot: z.number().int(),
 })
@@ -266,8 +279,11 @@ const RUNTIME_CONTEXT_PARENT_SCHEMA = z.object({
   position: z.number().int().nonnegative(),
 })
 
-const BUFFER_VALUE_GROUP_SCHEMA = z.object({
-  items: SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.omit({ slot: true })
+const COORDINATION_SELECTION_SCHEMA = z.object({
+  items: SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.omit({
+    scopePath: true,
+    slot: true,
+  })
     .extend({ contextId: z.string() })
     .array(),
   signalInvocationId: z.string(),
@@ -291,7 +307,7 @@ const SIGNAL_VALUE_OUTCOME_SCHEMA = z.union([
 
 const RUNTIME_VALUE_CONTEXT_SCHEMA = z.object({
   actionOutputs: ACTION_VALUE_OUTCOME_SCHEMA.array(),
-  bufferGroups: BUFFER_VALUE_GROUP_SCHEMA.array(),
+  coordinationSelections: COORDINATION_SELECTION_SCHEMA.array(),
   contextId: z.string(),
   contextParents: RUNTIME_CONTEXT_PARENT_SCHEMA.array(),
   events: z
@@ -300,6 +316,7 @@ const RUNTIME_VALUE_CONTEXT_SCHEMA = z.object({
       contextId: z.string(),
       outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
       payload: encodableSchema,
+      scopePath: HOOK_SCOPE_PATH_SCHEMA,
       slot: z.number().int(),
     })
     .array(),
@@ -315,6 +332,7 @@ const RUNTIME_RUN_CONTEXT_SCHEMA = z.object({
       automationEventId: z.string(),
       contextId: z.string(),
       outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+      scopePath: HOOK_SCOPE_PATH_SCHEMA,
       slot: z.number().int(),
     })
     .array(),
@@ -325,11 +343,13 @@ const TARGET_ACTION_SCHEMA = z.union([
   z.object({
     context: RUNTIME_VALUE_CONTEXT_SCHEMA,
     id: z.string(),
+    scopePath: HOOK_SCOPE_PATH_SCHEMA,
     slot: z.number().int(),
     status: z.literal("pending"),
   }),
   z.object({
     id: z.string(),
+    scopePath: HOOK_SCOPE_PATH_SCHEMA,
     slot: z.number().int(),
     status: z.enum(["failed", "skipped", "succeeded"]),
   }),
@@ -475,11 +495,16 @@ export const runtimeContract = {
     .input(
       z.object({
         actionInvocations: ACTION_INVOCATION_SCHEMA.array().default([]),
-        collectionEntries: COLLECTION_ENTRY_SCHEMA.array().default([]),
-        correlationEntries: CORRELATION_ENTRY_SCHEMA.array().default([]),
+        coordinationOffers: z
+          .union([
+            COLLECTION_OFFER_SCHEMA,
+            CORRELATION_OFFER_SCHEMA,
+            WINDOW_OFFER_SCHEMA,
+          ])
+          .array()
+          .default([]),
         settled: z.boolean().default(true),
         signalInvocations: SIGNAL_INVOCATION_SCHEMA.array().default([]),
-        windowEntries: WINDOW_ENTRY_SCHEMA.array().default([]),
       }),
     )
     .output(z.void()),
@@ -520,7 +545,12 @@ export const runtimeContract = {
     }),
   ),
   loadValues: oc
-    .input(SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.omit({ slot: true }))
+    .input(
+      SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.omit({
+        scopePath: true,
+        slot: true,
+      }),
+    )
     .output(RUNTIME_VALUE_CONTEXT_SCHEMA),
   resolveAccountInput: oc
     .input(