@automate.ax/api-contract 0.54.0 → 0.56.0

package/src/runtime.ts

@@ -94,6 +94,7 @@ const ACTION_INVOCATION_SCHEMA = z.union([
 
 const ACTION_RUN_INVOCATION_BASE_SCHEMA = ACTION_INVOCATION_BASE_SCHEMA.extend({
   actionInvocationId: z.string(),
+  contextId: z.string(),
 })
 
 const ACTION_RUN_INVOCATION_SCHEMA = z.union([
@@ -127,15 +128,66 @@ const SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA = z.object({
   slot: z.number().int().nonnegative(),
 })
 
+const BUFFER_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 CORRELATION_STREAM_NAMES_SCHEMA = z
+  .string()
+  .min(1)
+  .array()
+  .min(2)
+  .refine((names) => new Set(names).size === names.length, {
+    message: "Correlation stream names must be unique.",
+  })
+
 const CORRELATION_ENTRY_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
   key: encodableSchema,
-  order: z.string().min(1).array().min(2).optional(),
+  order: CORRELATION_STREAM_NAMES_SCHEMA.optional(),
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
   streamName: z.string().min(1),
-  streamNames: z.string().min(1).array().min(2),
+  streamNames: CORRELATION_STREAM_NAMES_SCHEMA,
   ttl: z.union([z.string().min(1), z.number().nonnegative()]).optional(),
+}).superRefine((entry, context) => {
+  if (!entry.streamNames.includes(entry.streamName)) {
+    context.addIssue({
+      code: "custom",
+      message: "Correlation stream must be included in streamNames.",
+      path: ["streamName"],
+    })
+  }
+  if (
+    entry.order &&
+    (entry.order.length !== entry.streamNames.length ||
+      entry.order.some((name) => !entry.streamNames.includes(name)))
+  ) {
+    context.addIssue({
+      code: "custom",
+      message: "Correlation order must name every stream exactly once.",
+      path: ["order"],
+    })
+  }
 })
 
+const COLLECTION_ENTRY_SCHEMA = SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
+  count: z.number().int().positive(),
+  key: encodableSchema,
+  outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  primaryPosition: BUFFER_PRIMARY_POSITION_SCHEMA,
+  ttl: z.union([z.string().min(1), z.number().nonnegative()]).optional(),
+}).extend(BUFFER_PARAMETER_DEPENDENCIES_SCHEMA.shape)
+
+const WINDOW_ENTRY_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,
+  ttl: z.union([z.string().min(1), z.number().nonnegative()]).optional(),
+}).extend(BUFFER_PARAMETER_DEPENDENCIES_SCHEMA.shape)
+
 const SIGNAL_INVOCATION_SCHEMA = z.union([
   SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
     outcomeSeq: OUTCOME_SEQUENCE_SCHEMA.optional(),
@@ -154,6 +206,7 @@ const SIGNAL_INVOCATION_SCHEMA = z.union([
 
 const SIGNAL_BATCH_OUTCOME_BASE_SCHEMA =
   SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.extend({
+    contextId: z.string(),
     outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
     signalInvocationId: z.string(),
   })
@@ -171,44 +224,55 @@ const SIGNAL_BATCH_OUTCOME_SCHEMA = z.union([
   SIGNAL_BATCH_OUTCOME_BASE_SCHEMA.extend({ status: z.literal("succeeded") }),
 ])
 
+const ACTION_VALUE_OUTCOME_BASE_SCHEMA = z.object({
+  actionInvocationId: z.string(),
+  contextId: z.string(),
+  outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  slot: z.number().int(),
+})
+
 const ACTION_VALUE_OUTCOME_SCHEMA = z.union([
-  z.object({
-    actionInvocationId: z.string(),
+  ACTION_VALUE_OUTCOME_BASE_SCHEMA.extend({
     outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
-    slot: z.number().int(),
     status: z.literal("failed"),
     failure: SIGNAL_FAILURE_SCHEMA,
   }),
-  z.object({
-    actionInvocationId: z.string(),
-    outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  ACTION_VALUE_OUTCOME_BASE_SCHEMA.extend({
     reason: z.literal("closed-dependency"),
-    slot: z.number().int(),
     status: z.literal("skipped"),
   }),
-  z.object({
-    actionInvocationId: z.string(),
+  ACTION_VALUE_OUTCOME_BASE_SCHEMA.extend({
     failure: SIGNAL_FAILURE_SCHEMA,
-    outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
     reason: z.literal("failed-dependency"),
-    slot: z.number().int(),
     status: z.literal("skipped"),
   }),
-  z.object({
-    actionInvocationId: z.string(),
-    outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
+  ACTION_VALUE_OUTCOME_BASE_SCHEMA.extend({
     output: encodableSchema,
-    slot: z.number().int(),
     status: z.literal("succeeded"),
   }),
 ])
 
 const SIGNAL_VALUE_OUTCOME_BASE_SCHEMA = z.object({
+  contextId: z.string(),
   outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
   signalInvocationId: z.string(),
   slot: z.number().int(),
 })
 
+const RUNTIME_CONTEXT_PARENT_SCHEMA = z.object({
+  contextId: z.string(),
+  isPrimary: z.boolean(),
+  parentContextId: z.string(),
+  position: z.number().int().nonnegative(),
+})
+
+const BUFFER_VALUE_GROUP_SCHEMA = z.object({
+  items: SIGNAL_INVOCATION_DEPENDENCIES_SCHEMA.omit({ slot: true })
+    .extend({ contextId: z.string() })
+    .array(),
+  signalInvocationId: z.string(),
+})
+
 const SIGNAL_VALUE_OUTCOME_SCHEMA = z.union([
   SIGNAL_VALUE_OUTCOME_BASE_SCHEMA.extend({
     selectedIndex: z.number().int().nonnegative().optional(),
@@ -227,10 +291,13 @@ 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(),
   contextId: z.string(),
+  contextParents: RUNTIME_CONTEXT_PARENT_SCHEMA.array(),
   events: z
     .object({
       automationEventId: z.string(),
+      contextId: z.string(),
       outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
       payload: encodableSchema,
       slot: z.number().int(),
@@ -242,9 +309,11 @@ const RUNTIME_VALUE_CONTEXT_SCHEMA = z.object({
 const RUNTIME_RUN_CONTEXT_SCHEMA = z.object({
   actions: ACTION_RUN_INVOCATION_SCHEMA.array(),
   contextId: z.string(),
+  contextParents: RUNTIME_CONTEXT_PARENT_SCHEMA.array(),
   events: z
     .object({
       automationEventId: z.string(),
+      contextId: z.string(),
       outcomeSeq: OUTCOME_SEQUENCE_SCHEMA,
       slot: z.number().int(),
     })
@@ -406,9 +475,11 @@ export const runtimeContract = {
     .input(
       z.object({
         actionInvocations: ACTION_INVOCATION_SCHEMA.array().default([]),
+        collectionEntries: COLLECTION_ENTRY_SCHEMA.array().default([]),
         correlationEntries: CORRELATION_ENTRY_SCHEMA.array().default([]),
         settled: z.boolean().default(true),
         signalInvocations: SIGNAL_INVOCATION_SCHEMA.array().default([]),
+        windowEntries: WINDOW_ENTRY_SCHEMA.array().default([]),
       }),
     )
     .output(z.void()),