@automate.ax/integration-contracts 0.83.3 → 0.85.0

package/src/webflow/schemas.ts

@@ -0,0 +1,306 @@
+import { isEncodable, type Encodable } from "@automate.ax/codec"
+import type { Webflow } from "webflow-api"
+import * as serializers from "webflow-api/serialization"
+import * as z from "zod"
+
+export const WEBFLOW_EVENT_TYPES = [
+  "form_submission",
+  "site_publish",
+  "page_created",
+  "page_metadata_updated",
+  "page_deleted",
+  "ecomm_new_order",
+  "ecomm_order_changed",
+  "ecomm_inventory_changed",
+  "collection_item_created",
+  "collection_item_changed",
+  "collection_item_deleted",
+  "collection_item_published",
+  "collection_item_unpublished",
+  "comment_created",
+] as const satisfies readonly Webflow.TriggerType[]
+
+export type WebflowEventType = (typeof WEBFLOW_EVENT_TYPES)[number]
+
+/** JSON representation of a Webflow ecommerce order webhook payload. */
+export type WebflowOrderEvent = Omit<
+  Webflow.Order,
+  | "acceptedOn"
+  | "disputeUpdatedOn"
+  | "disputedOn"
+  | "fulfilledOn"
+  | "refundedOn"
+> & {
+  acceptedOn?: string
+  disputeUpdatedOn?: string | null
+  disputedOn?: string | null
+  fulfilledOn?: string | null
+  refundedOn?: string | null
+}
+
+/** JSON representation of a Webflow collection-item webhook payload. */
+export interface WebflowCollectionItemEvent {
+  cmsLocaleId?: string
+  collectionId: string
+  createdOn?: string
+  fieldData: Record<string, Encodable>
+  id: string
+  isArchived?: boolean
+  isDraft?: boolean
+  lastPublished?: string | null
+  lastUpdated?: string
+  siteId: string
+  workspaceId: string
+}
+
+/** Webflow form-submission webhook payload. */
+export interface WebflowFormSubmissionEvent {
+  data: Record<string, Encodable>
+  formElementId?: string
+  formId: string
+  id: string
+  name: string
+  schema: Array<{
+    fieldElementId: string
+    fieldName: string
+    fieldType: string
+  }>
+  siteId: string
+  submittedAt: string
+}
+
+/** Webflow page lifecycle webhook payload. */
+export interface WebflowPageEvent {
+  archived: boolean
+  createdOn?: string
+  deletedOn?: string
+  draft: boolean
+  isBranch: boolean
+  lastUpdated?: string
+  pageId: string
+  pageName: string | null
+  pageTitle: string
+  publishedPath: string
+  siteId: string
+}
+
+/** Webflow comment or reply webhook payload. */
+export interface WebflowCommentEvent {
+  author: WebflowCommentUser
+  breakpoint: string
+  commentId: string
+  content: string
+  createdOn: string
+  isResolved: boolean
+  lastUpdated: string
+  localeId: string | null
+  mentionedUsers: WebflowCommentUser[]
+  pageId: string
+  siteId: string
+  threadId: string
+  type: "new_comment" | "reply"
+  url: string
+}
+
+/** User identity included in a Webflow comment webhook. */
+export interface WebflowCommentUser {
+  email: string
+  name: string
+  userId: string
+}
+
+/** One authenticated Webflow webhook envelope. */
+export type WebflowEvent = (
+  | WebflowTypedEvent<"collection_item_changed", WebflowCollectionItemEvent>
+  | WebflowTypedEvent<"collection_item_created", WebflowCollectionItemEvent>
+  | WebflowTypedEvent<"collection_item_deleted", WebflowDeletedItemEvent>
+  | WebflowTypedEvent<"collection_item_published", WebflowCollectionItemEvent>
+  | WebflowTypedEvent<"collection_item_unpublished", WebflowDeletedItemEvent>
+  | WebflowTypedEvent<"comment_created", WebflowCommentEvent>
+  | WebflowTypedEvent<"ecomm_inventory_changed", WebflowInventoryEvent>
+  | WebflowTypedEvent<"ecomm_new_order", WebflowOrderEvent>
+  | WebflowTypedEvent<"ecomm_order_changed", WebflowOrderEvent>
+  | WebflowTypedEvent<"form_submission", WebflowFormSubmissionEvent>
+  | WebflowTypedEvent<"page_created", WebflowPageEvent>
+  | WebflowTypedEvent<"page_deleted", WebflowPageEvent>
+  | WebflowTypedEvent<"page_metadata_updated", WebflowPageEvent>
+  | WebflowTypedEvent<"site_publish", WebflowSitePublishEvent>
+) &
+  Encodable
+
+export type WebflowSemanticEvent<TType extends WebflowEventType> = Extract<
+  WebflowEvent,
+  { triggerType: TType }
+>
+
+interface WebflowTypedEvent<TType extends WebflowEventType, TPayload> {
+  payload: TPayload
+  triggerType: TType
+}
+
+interface WebflowDeletedItemEvent {
+  cmsLocaleId?: string
+  collectionId: string
+  id: string
+  siteId: string
+  workspaceId: string
+}
+
+interface WebflowInventoryEvent {
+  id: string
+  inventoryType: "finite" | "infinite"
+  quantity?: number
+}
+
+interface WebflowSitePublishEvent {
+  domains: string[]
+  publishScope?: "page" | "site"
+  publishTime?: string
+  publishedBy: { displayName: string }
+  publishedOn?: string
+  site?: string
+  siteId?: string
+}
+
+const ENCODABLE_RECORD_SCHEMA = z.record(
+  z.string(),
+  z.custom<Encodable>(isEncodable),
+)
+const COLLECTION_ITEM_SCHEMA = z.looseObject({
+  cmsLocaleId: z.string().optional(),
+  collectionId: z.string(),
+  createdOn: z.string().optional(),
+  fieldData: ENCODABLE_RECORD_SCHEMA,
+  id: z.string(),
+  isArchived: z.boolean().optional(),
+  isDraft: z.boolean().optional(),
+  lastPublished: z.string().nullable().optional(),
+  lastUpdated: z.string().optional(),
+  siteId: z.string(),
+  workspaceId: z.string(),
+})
+const DELETED_ITEM_SCHEMA = z.looseObject({
+  cmsLocaleId: z.string().optional(),
+  collectionId: z.string(),
+  id: z.string(),
+  siteId: z.string(),
+  workspaceId: z.string(),
+})
+const FORM_SUBMISSION_SCHEMA = z.looseObject({
+  data: ENCODABLE_RECORD_SCHEMA,
+  formElementId: z.string().optional(),
+  formId: z.string(),
+  id: z.string(),
+  name: z.string(),
+  schema: z.array(
+    z.looseObject({
+      fieldElementId: z.string(),
+      fieldName: z.string(),
+      fieldType: z.string(),
+    }),
+  ),
+  siteId: z.string(),
+  submittedAt: z.string(),
+})
+const PAGE_SCHEMA = z.looseObject({
+  archived: z.boolean(),
+  createdOn: z.string().optional(),
+  deletedOn: z.string().optional(),
+  draft: z.boolean(),
+  isBranch: z.boolean(),
+  lastUpdated: z.string().optional(),
+  pageId: z.string(),
+  pageName: z.string().nullable(),
+  pageTitle: z.string(),
+  publishedPath: z.string(),
+  siteId: z.string(),
+})
+const COMMENT_USER_SCHEMA = z.looseObject({
+  email: z.string(),
+  name: z.string(),
+  userId: z.string(),
+})
+const COMMENT_SCHEMA = z.looseObject({
+  author: COMMENT_USER_SCHEMA,
+  breakpoint: z.string(),
+  commentId: z.string(),
+  content: z.string(),
+  createdOn: z.string(),
+  isResolved: z.boolean(),
+  lastUpdated: z.string(),
+  localeId: z.string().nullable(),
+  mentionedUsers: z.array(COMMENT_USER_SCHEMA),
+  pageId: z.string(),
+  siteId: z.string(),
+  threadId: z.string(),
+  type: z.enum(["new_comment", "reply"]),
+  url: z.string(),
+})
+const INVENTORY_SCHEMA = z.looseObject({
+  id: z.string(),
+  inventoryType: z.enum(["finite", "infinite"]),
+  quantity: z.number().optional(),
+})
+const ORDER_SCHEMA = z.custom<WebflowOrderEvent>(
+  (value) =>
+    serializers.Order.parse(value, { unrecognizedObjectKeys: "fail" }).ok,
+  { message: "Expected a Webflow ecommerce order." },
+)
+const SITE_PUBLISH_SCHEMA = z.looseObject({
+  domains: z.array(z.string()),
+  publishScope: z.enum(["page", "site"]).optional(),
+  publishTime: z.string().optional(),
+  publishedBy: z.looseObject({ displayName: z.string() }),
+  publishedOn: z.string().optional(),
+  site: z.string().optional(),
+  siteId: z.string().optional(),
+})
+
+const WEBFLOW_BASE_EVENT_SCHEMA = z.discriminatedUnion("triggerType", [
+  typedEventSchema("collection_item_changed", COLLECTION_ITEM_SCHEMA),
+  typedEventSchema("collection_item_created", COLLECTION_ITEM_SCHEMA),
+  typedEventSchema("collection_item_deleted", DELETED_ITEM_SCHEMA),
+  typedEventSchema("collection_item_published", COLLECTION_ITEM_SCHEMA),
+  typedEventSchema("collection_item_unpublished", DELETED_ITEM_SCHEMA),
+  typedEventSchema("comment_created", COMMENT_SCHEMA),
+  typedEventSchema("ecomm_inventory_changed", INVENTORY_SCHEMA),
+  typedEventSchema("ecomm_new_order", ORDER_SCHEMA),
+  typedEventSchema("ecomm_order_changed", ORDER_SCHEMA),
+  typedEventSchema("form_submission", FORM_SUBMISSION_SCHEMA),
+  typedEventSchema("page_created", PAGE_SCHEMA),
+  typedEventSchema("page_deleted", PAGE_SCHEMA),
+  typedEventSchema("page_metadata_updated", PAGE_SCHEMA),
+  typedEventSchema("site_publish", SITE_PUBLISH_SCHEMA),
+])
+
+export const WEBFLOW_EVENT_SCHEMA = z.custom<WebflowEvent>(
+  (value) => WEBFLOW_BASE_EVENT_SCHEMA.safeParse(value).success,
+  { message: "Expected a Webflow webhook event." },
+)
+
+/**
+ * Narrows the Webflow event schema to one webhook event type.
+ *
+ * @param type - Webflow webhook event type to require.
+ */
+export function webflowSemanticEventSchema<TType extends WebflowEventType>(
+  type: TType,
+): z.ZodType<WebflowSemanticEvent<TType>> {
+  return z.custom<WebflowSemanticEvent<TType>>((value) => {
+    const event = WEBFLOW_EVENT_SCHEMA.safeParse(value)
+    return event.success && event.data.triggerType === type
+  })
+}
+
+/**
+ * Builds one concrete Webflow event-envelope schema.
+ *
+ * @param type - Provider event discriminator.
+ * @param payloadSchema - Schema for that event's payload.
+ */
+function typedEventSchema<TType extends WebflowEventType>(
+  type: TType,
+  payloadSchema: z.ZodType,
+) {
+  return z.looseObject({ payload: payloadSchema, triggerType: z.literal(type) })
+}