@automate.ax/integration-contracts 0.145.2 → 0.146.0

package/src/highlevel/schemas.ts

@@ -0,0 +1,85 @@
+/* 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 operationData from "./openapi-operations.generated.json" with { type: "json" }
+import type { HighLevelOperationKey } from "./operation-manifest"
+import type { HighLevelOperationInput, HighLevelOperationOutput } from "./types"
+
+interface HighLevelRuntimeOperation {
+  apiVersion: string
+  bodyParameters: string[]
+  inputSchema: Record<string, unknown>
+  locationPlacements: ("body" | "path" | "query")[]
+  locationParameterNames: Partial<Record<"body" | "path" | "query", string>>
+  method: "DELETE" | "GET" | "PATCH" | "POST" | "PUT"
+  outputSchema: Record<string, unknown>
+  path: string
+  pathParameters: string[]
+  queryParameters: {
+    explode: boolean
+    name: string
+    providerName: string
+    style: string
+  }[]
+  responseMode: "binary" | "json"
+  requiredScope: string
+}
+
+const OPERATIONS = operationData.operations as unknown as Record<
+  HighLevelOperationKey,
+  HighLevelRuntimeOperation
+>
+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 HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export function highLevelOperation<TKey extends HighLevelOperationKey>(
+  key: TKey,
+) {
+  return OPERATIONS[key]
+}
+
+/**
+ * Validates flattened input for one frozen HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export function highLevelOperationInputSchema<
+  TKey extends HighLevelOperationKey,
+>(key: TKey): z.ZodType<HighLevelOperationInput<TKey>> {
+  return z.custom<HighLevelOperationInput<TKey>>(
+    (value) => VALIDATOR.validate({ [`${key}:input`]: value }).valid,
+    { message: `Input does not match HighLevel operation ${key}.` },
+  )
+}
+
+/**
+ * Validates the documented success response for one HighLevel operation.
+ *
+ * @param key - Frozen operation key.
+ */
+export function highLevelOperationOutputSchema<
+  TKey extends HighLevelOperationKey,
+>(key: TKey): z.ZodType<HighLevelOperationOutput<TKey>> {
+  return z.custom<HighLevelOperationOutput<TKey>>(
+    (value) => VALIDATOR.validate({ [`${key}:output`]: value }).valid,
+    { message: `Output does not match HighLevel operation ${key}.` },
+  )
+}

package/src/highlevel/types.ts

@@ -0,0 +1,91 @@
+import type { Encodable } from "@automate.ax/codec"
+import type { HighLevelOperationMap } from "./openapi-types.generated"
+import type { HighLevelOperationKey } from "./operation-manifest"
+
+type Operation<TKey extends HighLevelOperationKey> =
+  TKey extends keyof HighLevelOperationMap ? HighLevelOperationMap[TKey] : never
+
+type Parameters<TOperation, TLocation extends string> = TOperation extends {
+  parameters: infer TParameters
+}
+  ? TLocation extends keyof TParameters
+    ? NonNullable<TParameters[TLocation]>
+    : object
+  : object
+
+/** JSON request body from one generated OpenAPI operation. */
+type JsonBody<TOperation> = TOperation extends { requestBody: infer TBody }
+  ? NonNullable<TBody> extends { content: infer TContent }
+    ? "application/json" extends keyof TContent
+      ? TContent["application/json"]
+      : object
+    : object
+  : object
+
+/** JSON payload from one generated response entry. */
+type JsonResponse<TResponse> = TResponse extends { content: infer TContent }
+  ? "application/json" extends keyof TContent
+    ? TContent["application/json"]
+    : null
+  : null
+
+/** First supported successful response for one operation. */
+type SuccessResponse<TOperation> = TOperation extends {
+  responses: infer TResponses
+}
+  ? JsonResponse<
+      TResponses[Extract<
+        keyof TResponses,
+        200 | 201 | 202 | 203 | 204 | "default"
+      >]
+    >
+  : never
+
+type SnakeToCamel<TValue extends string> =
+  TValue extends `${infer THead}_${infer TTail}`
+    ? `${THead}${Capitalize<SnakeToCamel<TTail>>}`
+    : TValue
+
+type PublicKeys<TValue> = TValue extends unknown
+  ? {
+      [TKey in keyof TValue as TKey extends string
+        ? SnakeToCamel<TKey>
+        : TKey]: TValue[TKey]
+    }
+  : never
+
+type WithoutLocationId<TValue> = TValue extends unknown
+  ? Omit<TValue, "locationId" | "location_id">
+  : never
+
+/** Flattens intersections for public editor display. */
+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
+
+type HighLevelRawOperationInput<TKey extends HighLevelOperationKey> = Simplify<
+  PublicKeys<WithoutLocationId<Parameters<Operation<TKey>, "path">>> &
+    PublicKeys<WithoutLocationId<Parameters<Operation<TKey>, "query">>> &
+    PublicKeys<WithoutLocationId<JsonBody<Operation<TKey>>>>
+>
+
+/** Flattened, location-safe input for one frozen HighLevel operation. */
+export type HighLevelOperationInput<TKey extends HighLevelOperationKey> = {
+  [TField in keyof HighLevelRawOperationInput<TKey>]: EncodableValue<
+    HighLevelRawOperationInput<TKey>[TField]
+  >
+}
+
+/** Documented successful JSON response for one frozen HighLevel operation. */
+export type HighLevelOperationOutput<TKey extends HighLevelOperationKey> =
+  EncodableValue<SuccessResponse<Operation<TKey>>>

package/src/triggers.ts

@@ -21,6 +21,7 @@ import type { googleMeetTriggerContracts } from "./google-meet"
 import type { googleAdsTriggerContracts } from "./google-ads"
 import type { googleSheetsTriggerContracts } from "./google-sheets"
 import type { hubspotTriggerContracts } from "./hubspot"
+import type { highLevelTriggerContracts } from "./highlevel"
 import type { linearTriggerContracts } from "./linear"
 import type { millionVerifierTriggerContracts } from "./millionverifier"
 import type { metaAdsTriggerContracts } from "./meta-ads"
@@ -60,6 +61,7 @@ export type TriggerContractMap = typeof airtableTriggerContracts &
   typeof googleAdsTriggerContracts &
   typeof googleSheetsTriggerContracts &
   typeof hubspotTriggerContracts &
+  typeof highLevelTriggerContracts &
   typeof linearTriggerContracts &
   typeof millionVerifierTriggerContracts &
   typeof metaAdsTriggerContracts &