@automate.ax/api-contract 0.75.0 → 0.77.0

package/src/runtime.ts

@@ -2,14 +2,22 @@ import { encodableSchema } from "@automate.ax/codec"
 import type { GatewayModelId } from "@ai-sdk/gateway"
 import { oc } from "@orpc/contract"
 import stableStringify from "fast-json-stable-stringify"
-import { z } from "zod"
+import * as z from "zod"
 import { automationErrorSchema } from "./errors"
 
+export type { GatewayModelId } from "@ai-sdk/gateway"
+
 /** Default model used by the platform Vercel AI Gateway account. */
 export const DEFAULT_GATEWAY_MODEL_ID =
   "openai/gpt-4.1-nano" satisfies GatewayModelId
 export const AUTOMATION_INVOCATION_DEFAULT_ENTRYPOINT = "default"
 export const AUTOMATION_INVOCATION_RESERVED_ENTRYPOINT_PREFIX = "__$"
+export const AUTOMATION_LOG_MAX_ENTRIES = 1_000
+export const AUTOMATION_TRACE_MAX_SPANS = 250
+export const AUTOMATION_OBSERVABILITY_MAX_FIELDS = 64
+export const AUTOMATION_OBSERVABILITY_MAX_ENCODED_BYTES = 64 * 1_024
+export const AUTOMATION_LOG_MAX_MESSAGE_LENGTH = 16_384
+export const AUTOMATION_TRACE_MAX_NAME_LENGTH = 256
 
 const OUTCOME_SEQUENCE_SCHEMA = z.number().int().positive()
 const HOOK_SCOPE_PATH_SCHEMA = z
@@ -18,6 +26,23 @@ const HOOK_SCOPE_PATH_SCHEMA = z
   .nonnegative()
   .array()
   .default([])
+const OBSERVABILITY_FIELDS_SCHEMA = z
+  .record(z.string().min(1).max(128), encodableSchema)
+  .refine(
+    (fields) =>
+      Object.keys(fields).length <= AUTOMATION_OBSERVABILITY_MAX_FIELDS,
+    `Observability fields may contain at most ${AUTOMATION_OBSERVABILITY_MAX_FIELDS} entries.`,
+  )
+const LOG_INDEX_SCHEMA = z
+  .number()
+  .int()
+  .min(0)
+  .max(AUTOMATION_LOG_MAX_ENTRIES - 1)
+const TRACE_SPAN_INDEX_SCHEMA = z
+  .number()
+  .int()
+  .min(0)
+  .max(AUTOMATION_TRACE_MAX_SPANS - 1)
 
 const AUTOMATION_INVOCATION_RUN_AT_SCHEMA = z.union([
   z.date(),
@@ -683,6 +708,24 @@ export const runtimeContract = {
       ]),
     )
     .output(z.void()),
+  completeTraceSpan: oc
+    .input(
+      z
+        .object({
+          completedAt: z.date(),
+          spanIndex: TRACE_SPAN_INDEX_SCHEMA,
+        })
+        .and(
+          z.union([
+            z.object({ status: z.literal("succeeded") }),
+            z.object({
+              failure: automationErrorSchema,
+              status: z.literal("failed"),
+            }),
+          ]),
+        ),
+    )
+    .output(z.void()),
   generate: oc
     .input(RUNTIME_GENERATION_INPUT_SCHEMA)
     .output(generationResultSchema),
@@ -713,7 +756,7 @@ export const runtimeContract = {
     )
     .output(
       z.object({
-        connectionId: z.string().min(1),
+        connectionMethodId: z.string().min(1),
         secret: z.record(z.string(), z.unknown()),
         serviceId: z.string(),
       }),
@@ -729,6 +772,29 @@ export const runtimeContract = {
       }),
     )
     .output(z.void()),
+  sendLog: oc
+    .input(
+      z.object({
+        fields: OBSERVABILITY_FIELDS_SCHEMA.optional(),
+        level: z.enum(["debug", "info", "warn", "error"]),
+        logIndex: LOG_INDEX_SCHEMA,
+        message: z.string().min(1).max(AUTOMATION_LOG_MAX_MESSAGE_LENGTH),
+        spanIndex: TRACE_SPAN_INDEX_SCHEMA.optional(),
+        timestamp: z.date(),
+      }),
+    )
+    .output(z.void()),
+  startTraceSpan: oc
+    .input(
+      z.object({
+        attributes: OBSERVABILITY_FIELDS_SCHEMA.optional(),
+        name: z.string().min(1).max(AUTOMATION_TRACE_MAX_NAME_LENGTH),
+        parentSpanIndex: TRACE_SPAN_INDEX_SCHEMA.optional(),
+        spanIndex: TRACE_SPAN_INDEX_SCHEMA,
+        startedAt: z.date(),
+      }),
+    )
+    .output(z.void()),
   sendEmail: oc
     .input(
       z

package/src/schemas.ts

@@ -1,3 +1,25 @@
-import { z } from "zod"
+import * as z from "zod"
+
+export const cursorPaginationInputSchema = z.object({
+  cursor: z.string().min(1).optional(),
+  limit: z.number().int().min(1).max(100).default(50),
+})
+
+export const cursorPageInfoSchema = z.object({
+  hasMore: z.boolean(),
+  nextCursor: z.string().nullable(),
+})
+
+/**
+ * Builds the common cursor-paginated collection response.
+ *
+ * @param itemSchema - Schema for one collection item.
+ */
+export function cursorPageOutputSchema<T extends z.ZodType>(itemSchema: T) {
+  return z.object({
+    items: itemSchema.array(),
+    pageInfo: cursorPageInfoSchema,
+  })
+}
 
 export const reasonableNameSchema = z.string().min(1).max(255).trim()