@automate.ax/integration-contracts 0.147.0 → 0.148.0

package/src/kit/schemas.ts

@@ -0,0 +1,93 @@
+/* oxlint-disable typescript/no-unsafe-type-assertion -- Generated operation keys index a frozen external contract. */
+import { Validator } from "@cfworker/json-schema"
+import * as z from "zod"
+import { KIT_OPENAPI_DATA } from "./openapi-operations.generated"
+import type { KitOperationKey } from "./operation-manifest"
+import type { KitOperationInput, KitOperationOutput } from "./types"
+
+export interface KitRuntimeParameter {
+  explode: boolean
+  name: string
+  providerName: string
+  style: string
+}
+
+/** Frozen runtime description of one public Kit operation. */
+export interface KitRuntimeOperation {
+  bodyParameters: string[]
+  bodyWireSchema?: Record<string, unknown>
+  inputSchema: Record<string, unknown>
+  method: "DELETE" | "GET" | "PATCH" | "POST" | "PUT"
+  outputSchema: Record<string, unknown>
+  outputWireSchema: Record<string, unknown>
+  path: string
+  pathParameters: KitRuntimeParameter[]
+  queryParameters: KitRuntimeParameter[]
+  responseMode: "json" | "void"
+}
+
+/** Runtime Kit contract narrowed once from the opaque generated payload. */
+const operationData = KIT_OPENAPI_DATA as {
+  definitions: Record<string, Record<string, unknown>>
+  operations: Record<string, unknown>
+  wireDefinitions: Record<string, Record<string, unknown>>
+}
+const OPERATIONS = operationData.operations as unknown as Record<
+  KitOperationKey,
+  KitRuntimeOperation
+>
+const VALIDATOR = new Validator(
+  {
+    $defs: operationData.definitions,
+    $schema: "https://json-schema.org/draft/2020-12/schema",
+    additionalProperties: false,
+    properties: Object.fromEntries(
+      Object.entries(OPERATIONS).flatMap(([key, operation]) => [
+        [`${key}:input`, operation.inputSchema],
+        [`${key}:output`, operation.outputSchema],
+      ]),
+    ),
+    type: "object",
+  },
+  "2020-12",
+)
+
+/**
+ * Returns the immutable runtime descriptor for one Kit operation.
+ *
+ * @param key Public operation name.
+ */
+export function kitOperation<TKey extends KitOperationKey>(key: TKey) {
+  return OPERATIONS[key]
+}
+
+/**
+ * Validates flattened public input for one Kit operation.
+ *
+ * @param key Public operation name.
+ */
+export function kitOperationInputSchema<TKey extends KitOperationKey>(
+  key: TKey,
+): z.ZodType<KitOperationInput<TKey>> {
+  return z.custom<KitOperationInput<TKey>>(
+    (value) => VALIDATOR.validate({ [`${key}:input`]: value }).valid,
+    { message: `Input does not match Kit operation ${key}.` },
+  )
+}
+
+/**
+ * Validates a public successful response for one Kit operation.
+ *
+ * @param key Public operation name.
+ */
+export function kitOperationOutputSchema<TKey extends KitOperationKey>(
+  key: TKey,
+): z.ZodType<KitOperationOutput<TKey>> {
+  return z.custom<KitOperationOutput<TKey>>(
+    (value) => VALIDATOR.validate({ [`${key}:output`]: value }).valid,
+    { message: `Output does not match Kit operation ${key}.` },
+  )
+}
+
+/** Provider-native component schemas used for schema-guided key mapping. */
+export const KIT_WIRE_DEFINITIONS = operationData.wireDefinitions

package/src/kit/types.ts

@@ -0,0 +1,87 @@
+import type { Encodable } from "@automate.ax/codec"
+import type { KitOperationMap } from "./openapi-types.generated"
+import type { KitOperationKey } from "./operation-manifest"
+
+type Operation<TKey extends KitOperationKey> =
+  TKey extends keyof KitOperationMap ? KitOperationMap[TKey] : never
+
+/** Converts absent generated operation sections into intersection identities. */
+type InputPart<TValue> = [NonNullable<TValue>] extends [never]
+  ? unknown
+  : NonNullable<TValue>
+
+type Parameters<TOperation, TLocation extends string> = TOperation extends {
+  parameters?: infer TParameters
+}
+  ? TLocation extends keyof NonNullable<TParameters>
+    ? InputPart<NonNullable<TParameters>[TLocation]>
+    : unknown
+  : unknown
+
+/** Extracts the JSON request body from one generated operation. */
+type JsonBody<TOperation> = TOperation extends { requestBody?: infer TBody }
+  ? [NonNullable<TBody>] extends [never]
+    ? unknown
+    : NonNullable<TBody> extends { content: infer TContent }
+      ? "application/json" extends keyof TContent
+        ? TContent["application/json"]
+        : unknown
+      : unknown
+  : unknown
+
+/** Extracts the JSON response body from one generated response. */
+type JsonResponse<TResponse> = TResponse extends { content: infer TContent }
+  ? "application/json" extends keyof TContent
+    ? TContent["application/json"]
+    : object
+  : object
+
+/** Extracts the union of successful generated operation responses. */
+type SuccessResponse<TOperation> = TOperation extends {
+  responses: infer TResponses
+}
+  ? JsonResponse<
+      TResponses[Extract<keyof TResponses, 200 | 201 | 202 | 203 | 204>]
+    >
+  : never
+
+/** Materializes an intersection as one readable object type. */
+type Simplify<TValue> = { [TKey in keyof TValue]: TValue[TKey] } & {}
+
+type EncodableValue<TValue> = unknown extends TValue
+  ? Encodable
+  : TValue extends undefined | null | boolean | number | string
+    ? TValue
+    : TValue extends readonly (infer TItem)[]
+      ? EncodableValue<TItem>[]
+      : TValue extends object
+        ? keyof TValue extends never
+          ? Record<string, Encodable>
+          : { [TKey in keyof TValue]: EncodableValue<TValue[TKey]> }
+        : never
+
+/** Flattens one generated operation's path, query, and body fields. */
+type RawKitOperationInput<TKey extends KitOperationKey> = Simplify<
+  Parameters<Operation<TKey>, "path"> &
+    Parameters<Operation<TKey>, "query"> &
+    JsonBody<Operation<TKey>>
+>
+
+/** Preserves operation unions and rejects fields on truly empty inputs. */
+type PublicInput<TValue> = TValue extends unknown
+  ? keyof TValue extends never
+    ? Record<string, never>
+    : {
+        [TField in keyof TValue]: EncodableValue<TValue[TField]>
+      }
+  : never
+
+/** Flattened camelCase input for one frozen Kit V4 operation. */
+export type KitOperationInput<TKey extends KitOperationKey> = PublicInput<
+  RawKitOperationInput<TKey>
+>
+
+/** CamelCase successful response for one frozen Kit V4 operation. */
+export type KitOperationOutput<TKey extends KitOperationKey> = EncodableValue<
+  SuccessResponse<Operation<TKey>>
+>

package/src/tally/api.ts

@@ -162,7 +162,7 @@ async function sendTallyRequest(
     redirect: "error",
   })
   const text = await response.text()
-  const parsed = text ? parseJson(text) : undefined
+  const parsed = text ? parseJson(text, response.ok) : undefined
   if (!response.ok) {
     const body = encodableSchema.safeParse(parsed)
     throw new TallyApiError({
@@ -192,12 +192,14 @@ function isTraversalSegment(segment: string) {
  * Parses one JSON response or reports a provider contract failure.
  *
  * @param text Provider response text.
+ * @param requireJson Whether a successful response must contain valid JSON.
  * @throws When the provider response is not valid JSON.
  */
-function parseJson(text: string) {
+function parseJson(text: string, requireJson: boolean) {
   try {
     return JSON.parse(text) as unknown
   } catch {
+    if (!requireJson) return text
     throw new Error("Tally API returned invalid JSON.")
   }
 }

package/src/tally/openapi-schemas.generated.json

@@ -366,7 +366,14 @@
           "type": "string"
         },
         "name": {
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "workspaceId": {
           "type": "string"
@@ -686,7 +693,14 @@
           "type": "string"
         },
         "name": {
-          "type": "string"
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ]
         },
         "index": {
           "type": "integer"
@@ -773,7 +787,7 @@
           "format": "uuid"
         },
         "type": {
-          "$ref": "#/$defs/BlockType"
+          "$ref": "#/$defs/FieldType"
         },
         "blockGroupUuid": {
           "type": "string",
@@ -781,6 +795,9 @@
         },
         "title": {
           "type": "string"
+        },
+        "questionType": {
+          "$ref": "#/$defs/FieldQuestionType"
         }
       }
     },
@@ -4338,7 +4355,19 @@
           "type": "object",
           "properties": {
             "settings": {
-              "$ref": "#/$defs/FormSettings"
+              "anyOf": [
+                {
+                  "type": "object",
+                  "allOf": [
+                    {
+                      "$ref": "#/$defs/FormSettings"
+                    }
+                  ]
+                },
+                {
+                  "type": "null"
+                }
+              ]
             },
             "blocks": {
               "type": "array",
@@ -4595,7 +4624,12 @@
       "required": ["blocks"]
     },
     "PatchFormsFormIdBlocksResponse": {
-      "$ref": "#/$defs/Block"
+      "type": "object",
+      "allOf": [
+        {
+          "$ref": "#/$defs/Form"
+        }
+      ]
     },
     "GetFormsFormIdSubmissionsResponse": {
       "type": "object",

package/src/tally/openapi-types.generated.ts

@@ -207,7 +207,7 @@ export interface components {
     }
     Form: {
       id: string
-      name: string
+      name: string | null
       workspaceId: string
       status: components["schemas"]["FormStatus"]
       numberOfSubmissions: number
@@ -314,7 +314,7 @@ export interface components {
     }
     Workspace: {
       id: string
-      name: string
+      name: string | null
       index: number
       members?: components["schemas"]["User"][]
       invites?: {
@@ -341,10 +341,11 @@ export interface components {
     QuestionField: {
       /** Format: uuid */
       uuid?: string
-      type?: components["schemas"]["BlockType"]
+      type?: components["schemas"]["FieldType"]
       /** Format: uuid */
       blockGroupUuid?: string
       title?: string
+      questionType?: components["schemas"]["FieldQuestionType"]
     }
     Question: {
       id?: string
@@ -2357,7 +2358,7 @@ export interface components {
     }
     PostFormsResponse: components["schemas"]["Form"]
     GetFormsFormIdResponse: components["schemas"]["Form"] & {
-      settings?: components["schemas"]["FormSettings"]
+      settings?: components["schemas"]["FormSettings"] | null
       blocks?: components["schemas"]["Block"][]
     }
     PatchFormsFormIdRequest: {
@@ -2441,7 +2442,7 @@ export interface components {
       blocks: components["schemas"]["Block"][]
       settings?: components["schemas"]["FormSettings"] | null
     }
-    PatchFormsFormIdBlocksResponse: components["schemas"]["Block"]
+    PatchFormsFormIdBlocksResponse: components["schemas"]["Form"]
     GetFormsFormIdSubmissionsResponse: {
       /** Current page number */
       page?: number

package/src/triggers.ts

@@ -22,6 +22,7 @@ import type { googleAdsTriggerContracts } from "./google-ads"
 import type { googleSheetsTriggerContracts } from "./google-sheets"
 import type { hubspotTriggerContracts } from "./hubspot"
 import type { highLevelTriggerContracts } from "./highlevel"
+import type { kitTriggerContracts } from "./kit"
 import type { linearTriggerContracts } from "./linear"
 import type { millionVerifierTriggerContracts } from "./millionverifier"
 import type { metaAdsTriggerContracts } from "./meta-ads"
@@ -63,6 +64,7 @@ export type TriggerContractMap = typeof airtableTriggerContracts &
   typeof googleSheetsTriggerContracts &
   typeof hubspotTriggerContracts &
   typeof highLevelTriggerContracts &
+  typeof kitTriggerContracts &
   typeof linearTriggerContracts &
   typeof millionVerifierTriggerContracts &
   typeof metaAdsTriggerContracts &