@automate.ax/integration-contracts 0.83.0 → 0.83.2

package/dist/convex/api.d.ts

@@ -8,7 +8,7 @@ export declare const CONVEX_SECRET_SCHEMA: z.ZodUnion<readonly [z.ZodObject<{
 }, z.core.$strip>, z.ZodObject<{
     deployKey: z.ZodString;
     deploymentUrl: z.ZodURL;
-    webhookSecret: z.ZodString;
+    webhookSecret: z.ZodOptional<z.ZodString>;
 }, z.core.$strip>]>;
 export interface ConvexDeployment {
     deploymentUrl: string;

package/dist/convex/api.js

@@ -1,4 +1,4 @@
-import { convexToJson, jsonToConvex } from "convex/values";
+import { ConvexError, convexToJson, jsonToConvex } from "convex/values";
 import * as z from "zod";
 import { CONVEX_VALUE_SCHEMA } from "./schemas.js";
 const CONVEX_OAUTH_SECRET_SCHEMA = z.object({
@@ -21,21 +21,31 @@ export const CONVEX_DEPLOYMENT_URL_SCHEMA = z.url().refine((value) => {
 const CONVEX_DEPLOY_KEY_SECRET_SCHEMA = z.object({
     deployKey: z.string(),
     deploymentUrl: CONVEX_DEPLOYMENT_URL_SCHEMA,
-    webhookSecret: z.string(),
+    webhookSecret: z.string().min(32).optional(),
 });
 export const CONVEX_SECRET_SCHEMA = z.union([
     CONVEX_OAUTH_SECRET_SCHEMA,
     CONVEX_DEPLOY_KEY_SECRET_SCHEMA,
 ]);
-const CONVEX_DEPLOYMENT_SCHEMA = z.object({
-    deploymentUrl: CONVEX_DEPLOYMENT_URL_SCHEMA,
-    name: z.string(),
-    reference: z.string(),
-});
+const CONVEX_DEPLOYMENT_SCHEMA = z.discriminatedUnion("kind", [
+    z.object({
+        deploymentUrl: CONVEX_DEPLOYMENT_URL_SCHEMA,
+        kind: z.literal("cloud"),
+        name: z.string(),
+        reference: z.string(),
+    }),
+    z.object({ kind: z.literal("local"), name: z.string() }),
+]);
+const CONVEX_PLATFORM_ID_SCHEMA = z
+    .number()
+    .int()
+    .nonnegative()
+    .max(Number.MAX_SAFE_INTEGER)
+    .transform(String);
 const CONVEX_DEPLOYMENT_INFO_SCHEMA = z.discriminatedUnion("kind", [
     z.object({
         kind: z.literal("cloud"),
-        projectId: z.string(),
+        projectId: CONVEX_PLATFORM_ID_SCHEMA,
         projectName: z.string().nullable().optional(),
         reference: z.string().nullable().optional(),
     }),
@@ -43,7 +53,11 @@ const CONVEX_DEPLOYMENT_INFO_SCHEMA = z.discriminatedUnion("kind", [
 ]);
 const CONVEX_FUNCTION_RESPONSE_SCHEMA = z.discriminatedUnion("status", [
     z.object({ status: z.literal("success"), value: z.json() }),
-    z.object({ errorMessage: z.string(), status: z.literal("error") }),
+    z.object({
+        errorData: z.json().optional(),
+        errorMessage: z.string(),
+        status: z.literal("error"),
+    }),
 ]);
 /**
  * Resolves the authenticated Convex deployment represented by an account.
@@ -72,6 +86,9 @@ export async function resolveConvexDeployment(secret, deployment = "prod") {
         throw new Error(`Convex could not resolve deployment ${deployment} (${response.status}).`);
     }
     const resolved = CONVEX_DEPLOYMENT_SCHEMA.parse(await response.json());
+    if (resolved.kind === "local") {
+        throw new Error(`Convex deployment ${deployment} is local and cannot be reached by Automate.ax.`);
+    }
     return {
         deploymentUrl: resolved.deploymentUrl,
         reference: resolved.reference,
@@ -156,8 +173,14 @@ async function requestConvexFunction(kind, deployment, functionName, arguments_
         throw new Error(`Convex function call failed (${response.status})${details ? `: ${details}` : "."}`);
     }
     const result = CONVEX_FUNCTION_RESPONSE_SCHEMA.parse(await response.json());
-    if (result.status === "error")
+    if (result.status === "error") {
+        if (result.errorData !== undefined) {
+            const error = new ConvexError(decodeConvexValue(result.errorData));
+            error.message = result.errorMessage;
+            throw error;
+        }
         throw new Error(result.errorMessage);
+    }
     return decodeConvexValue(result.value);
 }
 /**

package/dist/convex/schemas.js

@@ -1,9 +1,10 @@
 import * as z from "zod";
+const CONVEX_NUMBER_SCHEMA = z.custom((value) => typeof value === "number", "Expected a Convex number.");
 /** Recursive schema for values accepted and returned by Convex functions. */
 export const CONVEX_VALUE_SCHEMA = z.lazy(() => z.union([
     z.null(),
     z.boolean(),
-    z.number(),
+    CONVEX_NUMBER_SCHEMA,
     z.bigint(),
     z.string(),
     z.instanceof(ArrayBuffer),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@automate.ax/integration-contracts",
-  "version": "0.83.0",
+  "version": "0.83.2",
   "description": "Shared integration payload contracts and provider primitives for Automate.ax.",
   "license": "MIT",
   "repository": {
@@ -43,7 +43,7 @@
     }
   },
   "dependencies": {
-    "@automate.ax/codec": "0.83.0",
+    "@automate.ax/codec": "0.83.2",
     "@googleapis/calendar": "^15.0.0",
     "@googleapis/forms": "^6.0.1",
     "@googleapis/gmail": "^12.0.0",

package/src/convex/api.ts

@@ -1,4 +1,4 @@
-import { convexToJson, jsonToConvex } from "convex/values"
+import { ConvexError, convexToJson, jsonToConvex } from "convex/values"
 import type { JSONValue } from "convex/values"
 import * as z from "zod"
 import { CONVEX_VALUE_SCHEMA, type ConvexValue } from "./schemas"
@@ -24,22 +24,32 @@ export const CONVEX_DEPLOYMENT_URL_SCHEMA = z.url().refine((value) => {
 const CONVEX_DEPLOY_KEY_SECRET_SCHEMA = z.object({
   deployKey: z.string(),
   deploymentUrl: CONVEX_DEPLOYMENT_URL_SCHEMA,
-  webhookSecret: z.string(),
+  webhookSecret: z.string().min(32).optional(),
 })
 export const CONVEX_SECRET_SCHEMA = z.union([
   CONVEX_OAUTH_SECRET_SCHEMA,
   CONVEX_DEPLOY_KEY_SECRET_SCHEMA,
 ])
 
-const CONVEX_DEPLOYMENT_SCHEMA = z.object({
-  deploymentUrl: CONVEX_DEPLOYMENT_URL_SCHEMA,
-  name: z.string(),
-  reference: z.string(),
-})
+const CONVEX_DEPLOYMENT_SCHEMA = z.discriminatedUnion("kind", [
+  z.object({
+    deploymentUrl: CONVEX_DEPLOYMENT_URL_SCHEMA,
+    kind: z.literal("cloud"),
+    name: z.string(),
+    reference: z.string(),
+  }),
+  z.object({ kind: z.literal("local"), name: z.string() }),
+])
+const CONVEX_PLATFORM_ID_SCHEMA = z
+  .number()
+  .int()
+  .nonnegative()
+  .max(Number.MAX_SAFE_INTEGER)
+  .transform(String)
 const CONVEX_DEPLOYMENT_INFO_SCHEMA = z.discriminatedUnion("kind", [
   z.object({
     kind: z.literal("cloud"),
-    projectId: z.string(),
+    projectId: CONVEX_PLATFORM_ID_SCHEMA,
     projectName: z.string().nullable().optional(),
     reference: z.string().nullable().optional(),
   }),
@@ -47,7 +57,11 @@ const CONVEX_DEPLOYMENT_INFO_SCHEMA = z.discriminatedUnion("kind", [
 ])
 const CONVEX_FUNCTION_RESPONSE_SCHEMA = z.discriminatedUnion("status", [
   z.object({ status: z.literal("success"), value: z.json() }),
-  z.object({ errorMessage: z.string(), status: z.literal("error") }),
+  z.object({
+    errorData: z.json().optional(),
+    errorMessage: z.string(),
+    status: z.literal("error"),
+  }),
 ])
 
 export interface ConvexDeployment {
@@ -96,6 +110,11 @@ export async function resolveConvexDeployment(
     )
   }
   const resolved = CONVEX_DEPLOYMENT_SCHEMA.parse(await response.json())
+  if (resolved.kind === "local") {
+    throw new Error(
+      `Convex deployment ${deployment} is local and cannot be reached by Automate.ax.`,
+    )
+  }
   return {
     deploymentUrl: resolved.deploymentUrl,
     reference: resolved.reference,
@@ -218,7 +237,14 @@ async function requestConvexFunction(
     )
   }
   const result = CONVEX_FUNCTION_RESPONSE_SCHEMA.parse(await response.json())
-  if (result.status === "error") throw new Error(result.errorMessage)
+  if (result.status === "error") {
+    if (result.errorData !== undefined) {
+      const error = new ConvexError(decodeConvexValue(result.errorData))
+      error.message = result.errorMessage
+      throw error
+    }
+    throw new Error(result.errorMessage)
+  }
   return decodeConvexValue(result.value)
 }
 

package/src/convex/schemas.ts

@@ -1,11 +1,16 @@
 import * as z from "zod"
 
+const CONVEX_NUMBER_SCHEMA = z.custom<number>(
+  (value) => typeof value === "number",
+  "Expected a Convex number.",
+)
+
 /** Recursive schema for values accepted and returned by Convex functions. */
 export const CONVEX_VALUE_SCHEMA: z.ZodType<ConvexValue> = z.lazy(() =>
   z.union([
     z.null(),
     z.boolean(),
-    z.number(),
+    CONVEX_NUMBER_SCHEMA,
     z.bigint(),
     z.string(),
     z.instanceof(ArrayBuffer),