@automate.ax/integration-contracts 0.88.9 → 0.89.0

package/src/notion/schemas.ts

@@ -0,0 +1,365 @@
+import type {
+  CommentCreatedWebhookPayload,
+  CommentDeletedWebhookPayload,
+  CommentUpdatedWebhookPayload,
+  DataSourceContentUpdatedWebhookPayload,
+  DataSourceCreatedWebhookPayload,
+  DataSourceDeletedWebhookPayload,
+  DataSourceMovedWebhookPayload,
+  DataSourceSchemaUpdatedWebhookPayload,
+  DataSourceUndeletedWebhookPayload,
+  DatabaseCreatedWebhookPayload,
+  DatabaseDeletedWebhookPayload,
+  DatabaseMovedWebhookPayload,
+  DatabaseUndeletedWebhookPayload,
+  FileUploadCompletedWebhookPayload,
+  FileUploadCreatedWebhookPayload,
+  FileUploadExpiredWebhookPayload,
+  FileUploadUploadFailedWebhookPayload,
+  PageContentUpdatedWebhookPayload,
+  PageCreatedWebhookPayload,
+  PageDeletedWebhookPayload,
+  PageLockedWebhookPayload,
+  PageMovedWebhookPayload,
+  PagePropertiesUpdatedWebhookPayload,
+  PageTranscriptionBlockTranscriptDeletedWebhookPayload,
+  PageUndeletedWebhookPayload,
+  PageUnlockedWebhookPayload,
+  ViewCreatedWebhookPayload,
+  ViewDeletedWebhookPayload,
+  ViewUpdatedWebhookPayload,
+} from "@notionhq/client"
+import * as z from "zod"
+
+type OfficialNotionWebhookEvent =
+  | CommentCreatedWebhookPayload
+  | CommentDeletedWebhookPayload
+  | CommentUpdatedWebhookPayload
+  | DataSourceContentUpdatedWebhookPayload
+  | DataSourceCreatedWebhookPayload
+  | DataSourceDeletedWebhookPayload
+  | DataSourceMovedWebhookPayload
+  | DataSourceSchemaUpdatedWebhookPayload
+  | DataSourceUndeletedWebhookPayload
+  | DatabaseCreatedWebhookPayload
+  | DatabaseDeletedWebhookPayload
+  | DatabaseMovedWebhookPayload
+  | DatabaseUndeletedWebhookPayload
+  | FileUploadCompletedWebhookPayload
+  | FileUploadCreatedWebhookPayload
+  | FileUploadExpiredWebhookPayload
+  | FileUploadUploadFailedWebhookPayload
+  | PageContentUpdatedWebhookPayload
+  | PageCreatedWebhookPayload
+  | PageDeletedWebhookPayload
+  | PageLockedWebhookPayload
+  | PageMovedWebhookPayload
+  | PagePropertiesUpdatedWebhookPayload
+  | PageTranscriptionBlockTranscriptDeletedWebhookPayload
+  | PageUndeletedWebhookPayload
+  | PageUnlockedWebhookPayload
+  | ViewCreatedWebhookPayload
+  | ViewDeletedWebhookPayload
+  | ViewUpdatedWebhookPayload
+
+/** Actor reported as the author of a current Notion webhook event. */
+export type NotionWebhookAuthor = {
+  id: string
+  type: "agent" | "bot" | "person"
+}
+
+/** Official Notion webhook payload with agent-authored changes included. */
+type ExpectedNotionWebhookEvent =
+  OfficialNotionWebhookEvent extends infer TEvent
+    ? TEvent extends OfficialNotionWebhookEvent
+      ? Omit<TEvent, "authors"> & { authors: NotionWebhookAuthor[] }
+      : never
+    : never
+type OfficialNotionWebhookEventType = ExpectedNotionWebhookEvent["type"]
+
+const UUID_SCHEMA = z.uuid()
+const ACCESS_ACTOR_SCHEMA = z.discriminatedUnion("type", [
+  z.object({ id: UUID_SCHEMA, type: z.literal("person") }),
+  z.object({ id: UUID_SCHEMA, type: z.literal("bot") }),
+])
+const AUTHOR_SCHEMA = z.discriminatedUnion("type", [
+  ...ACCESS_ACTOR_SCHEMA.options,
+  z.object({ id: UUID_SCHEMA, type: z.literal("agent") }),
+])
+const BASE_SHAPE = {
+  accessible_by: ACCESS_ACTOR_SCHEMA.array().optional(),
+  api_version: z.enum(["2022-06-28", "2025-09-03", "2026-03-11"]),
+  attempt_number: z.number().int().min(1).max(8),
+  authors: AUTHOR_SCHEMA.array(),
+  id: UUID_SCHEMA,
+  integration_id: UUID_SCHEMA,
+  subscription_id: UUID_SCHEMA,
+  timestamp: z.iso.datetime({ offset: true }),
+  workspace_id: UUID_SCHEMA,
+  workspace_name: z.string(),
+} as const
+const PARENT_SCHEMA = z.object({
+  data_source_id: UUID_SCHEMA.optional(),
+  id: UUID_SCHEMA,
+  type: z.enum(["space", "block", "page", "database", "team", "agent"]),
+})
+const EXTERNAL_BLOCK_SCHEMA = z.object({
+  id: UUID_SCHEMA,
+  type: z.enum(["page", "database", "block"]),
+})
+const UPDATED_BLOCK_SCHEMA = EXTERNAL_BLOCK_SCHEMA
+const PAGE_ENTITY_SCHEMA = z.object({
+  id: UUID_SCHEMA,
+  type: z.literal("page"),
+})
+const DATABASE_ENTITY_SCHEMA = z.object({
+  id: UUID_SCHEMA,
+  type: z.enum(["block", "database", "data_source"]),
+})
+const COMMENT_ENTITY_SCHEMA = z.object({
+  id: UUID_SCHEMA,
+  type: z.literal("comment"),
+})
+const FILE_UPLOAD_ENTITY_SCHEMA = z.object({
+  id: UUID_SCHEMA,
+  type: z.literal("file_upload"),
+})
+const VIEW_ENTITY_SCHEMA = z.object({
+  id: UUID_SCHEMA,
+  type: z.literal("view"),
+})
+const PARENT_DATA_SCHEMA = z.object({ parent: PARENT_SCHEMA })
+const COMMENT_DATA_SCHEMA = z.object({
+  page_id: UUID_SCHEMA,
+  parent: EXTERNAL_BLOCK_SCHEMA,
+})
+
+const RAW_NOTION_EVENT_SCHEMA = z.discriminatedUnion("type", [
+  eventWithDataSchema(
+    "comment.created",
+    COMMENT_ENTITY_SCHEMA,
+    COMMENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "comment.deleted",
+    COMMENT_ENTITY_SCHEMA,
+    COMMENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "comment.updated",
+    COMMENT_ENTITY_SCHEMA,
+    COMMENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "data_source.content_updated",
+    DATABASE_ENTITY_SCHEMA,
+    z.object({
+      parent: PARENT_SCHEMA,
+      updated_blocks: UPDATED_BLOCK_SCHEMA.array(),
+    }),
+  ),
+  eventWithDataSchema(
+    "data_source.created",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "data_source.deleted",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "data_source.moved",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "data_source.schema_updated",
+    DATABASE_ENTITY_SCHEMA,
+    z.object({
+      parent: PARENT_SCHEMA,
+      updated_properties: z
+        .object({
+          action: z.enum(["created", "updated", "deleted"]),
+          id: z.string(),
+          name: z.string().nullable(),
+        })
+        .array()
+        .optional(),
+    }),
+  ),
+  eventWithDataSchema(
+    "data_source.undeleted",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "database.created",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "database.deleted",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "database.moved",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventWithDataSchema(
+    "database.undeleted",
+    DATABASE_ENTITY_SCHEMA,
+    PARENT_DATA_SCHEMA,
+  ),
+  eventSchema("file_upload.completed", FILE_UPLOAD_ENTITY_SCHEMA),
+  eventSchema("file_upload.created", FILE_UPLOAD_ENTITY_SCHEMA),
+  eventSchema("file_upload.expired", FILE_UPLOAD_ENTITY_SCHEMA),
+  eventWithDataSchema(
+    "file_upload.upload_failed",
+    FILE_UPLOAD_ENTITY_SCHEMA,
+    z.object({
+      file_import_result: z.discriminatedUnion("type", [
+        z.object({
+          imported_time: z.iso.datetime({ offset: true }),
+          success: z.object({}),
+          type: z.literal("success"),
+        }),
+        z.object({
+          error: z.object({
+            code: z.string(),
+            message: z.string(),
+            parameter: z.string().nullable(),
+            status_code: z.number().nullable(),
+            type: z.enum([
+              "validation_error",
+              "internal_system_error",
+              "download_error",
+              "upload_error",
+            ]),
+          }),
+          imported_time: z.iso.datetime({ offset: true }),
+          type: z.literal("error"),
+        }),
+      ]),
+    }),
+  ),
+  eventWithDataSchema(
+    "page.content_updated",
+    PAGE_ENTITY_SCHEMA,
+    z.object({
+      parent: PARENT_SCHEMA,
+      updated_blocks: UPDATED_BLOCK_SCHEMA.array(),
+    }),
+  ),
+  eventWithDataSchema("page.created", PAGE_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema("page.deleted", PAGE_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema("page.locked", PAGE_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema("page.moved", PAGE_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema(
+    "page.properties_updated",
+    PAGE_ENTITY_SCHEMA,
+    z.object({
+      parent: PARENT_SCHEMA,
+      updated_properties: z.string().array(),
+    }),
+  ),
+  eventWithDataSchema(
+    "page.transcription_block.transcript_deleted",
+    PAGE_ENTITY_SCHEMA,
+    z.object({
+      target: EXTERNAL_BLOCK_SCHEMA,
+      transcript_id: z.string().nullable(),
+    }),
+  ),
+  eventWithDataSchema("page.undeleted", PAGE_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema("page.unlocked", PAGE_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema(
+    "view.created",
+    VIEW_ENTITY_SCHEMA,
+    z.object({ parent: PARENT_SCHEMA, view_type: z.string() }),
+  ),
+  eventWithDataSchema("view.deleted", VIEW_ENTITY_SCHEMA, PARENT_DATA_SCHEMA),
+  eventWithDataSchema(
+    "view.updated",
+    VIEW_ENTITY_SCHEMA,
+    z.object({
+      parent: PARENT_SCHEMA,
+      updated_fields: z
+        .enum(["name", "filter", "sorts", "configuration"])
+        .array(),
+    }),
+  ),
+]) satisfies z.ZodType<ExpectedNotionWebhookEvent>
+
+/** Current portable Notion webhook payload validated at ingress. */
+export type NotionWebhookEvent = z.infer<typeof RAW_NOTION_EVENT_SCHEMA>
+
+export type NotionWebhookEventType = NotionWebhookEvent["type"]
+
+export type NotionSemanticWebhookEvent<TType extends NotionWebhookEventType> =
+  Extract<NotionWebhookEvent, { type: TType }>
+
+/** Exact current Notion webhook schema shared by ingress and triggers. */
+export const NOTION_EVENT_SCHEMA = RAW_NOTION_EVENT_SCHEMA
+
+/**
+ * Runtime schema for one semantic Notion webhook event.
+ *
+ * @param type - Official event discriminant to require.
+ */
+export function notionSemanticEventSchema<TType extends NotionWebhookEventType>(
+  type: TType,
+) {
+  return z.custom<NotionSemanticWebhookEvent<TType>>(
+    (value) =>
+      RAW_NOTION_EVENT_SCHEMA.safeParse(value).success &&
+      typeof value === "object" &&
+      value !== null &&
+      "type" in value &&
+      value.type === type,
+    { message: `Expected a Notion ${type} webhook event.` },
+  )
+}
+
+/**
+ * Builds one provider webhook schema over the shared delivery envelope.
+ *
+ * @param type - Official event discriminant.
+ * @param entity - Entity reference schema for the event family.
+ */
+function eventSchema<
+  const TType extends OfficialNotionWebhookEventType,
+  TEntity extends z.ZodType,
+>(type: TType, entity: TEntity) {
+  return z
+    .object({
+      ...BASE_SHAPE,
+      entity,
+      type: z.literal(type),
+    })
+    .catchall(z.json())
+}
+
+/**
+ * Builds one provider webhook schema with event-specific data.
+ *
+ * @param type - Official event discriminant.
+ * @param entity - Entity reference schema for the event family.
+ * @param data - Event-specific data schema.
+ */
+function eventWithDataSchema<
+  const TType extends OfficialNotionWebhookEventType,
+  TEntity extends z.ZodType,
+  TData extends z.ZodType,
+>(type: TType, entity: TEntity, data: TData) {
+  return z
+    .object({
+      ...BASE_SHAPE,
+      data,
+      entity,
+      type: z.literal(type),
+    })
+    .catchall(z.json())
+}

package/src/triggers.ts

@@ -9,6 +9,7 @@ import type { googleCalendarTriggerContracts } from "./google-calendar"
 import type { googleFormsTriggerContracts } from "./google-forms"
 import type { googleMeetTriggerContracts } from "./google-meet"
 import type { linearTriggerContracts } from "./linear"
+import type { notionTriggerContracts } from "./notion"
 import type { outlookTriggerContracts } from "./outlook"
 import type { resendTriggerContracts } from "./resend"
 import type { slackTriggerContracts } from "./slack"
@@ -31,6 +32,7 @@ export type TriggerContractMap = typeof airtableTriggerContracts &
   typeof googleFormsTriggerContracts &
   typeof googleMeetTriggerContracts &
   typeof linearTriggerContracts &
+  typeof notionTriggerContracts &
   typeof outlookTriggerContracts &
   typeof resendTriggerContracts &
   typeof slackTriggerContracts &