@automate.ax/integration-contracts 0.55.0

package/src/trello/schemas.ts

@@ -0,0 +1,507 @@
+import { z } from "zod"
+
+const OPTIONAL_DATE_SCHEMA = z
+  .string()
+  .nullable()
+  .optional()
+  .transform((value) => (value ? new Date(value) : null))
+
+export const TRELLO_MEMBER_SCHEMA = z.object({
+  /** Member avatar URL, when one is configured. */
+  avatarUrl: z.string().nullable(),
+
+  /** Member's display name. */
+  fullName: z.string(),
+
+  /** Stable Trello member ID. */
+  id: z.string(),
+
+  /** Member initials. */
+  initials: z.string().optional(),
+
+  /** Public Trello profile URL, when available. */
+  url: z.string().nullable(),
+
+  /** Unique Trello username. */
+  username: z.string(),
+})
+
+export const TRELLO_BOARD_SCHEMA = z.object({
+  /** Whether the board is archived. */
+  closed: z.boolean(),
+
+  /** Board description. */
+  description: z.string(),
+
+  /** Stable Trello board ID. */
+  id: z.string(),
+
+  /** Workspace ID containing the board, when applicable. */
+  organizationId: z.string().nullable(),
+
+  /** Last board activity time. */
+  lastActivityAt: z.date().nullable(),
+
+  /** Board name. */
+  name: z.string(),
+
+  /** Short public or workspace-visible board URL. */
+  shortUrl: z.string(),
+
+  /** Whether the connected member starred the board. */
+  starred: z.boolean(),
+
+  /** Whether the connected member watches the board. */
+  subscribed: z.boolean(),
+
+  /** Full Trello board URL. */
+  url: z.string(),
+})
+
+export const TRELLO_LIST_SCHEMA = z.object({
+  /** Stable ID of the containing board. */
+  boardId: z.string(),
+
+  /** Whether the list is archived. */
+  closed: z.boolean(),
+
+  /** Stable Trello list ID. */
+  id: z.string(),
+
+  /** List name. */
+  name: z.string(),
+
+  /** Trello ordering position. */
+  position: z.number(),
+
+  /** Whether the connected member watches the list. */
+  subscribed: z.boolean(),
+})
+
+export const TRELLO_LABEL_SCHEMA = z.object({
+  /** Board containing the label, when returned. */
+  boardId: z.string().optional(),
+
+  /** Trello label color, or null for no color. */
+  color: z.string().nullable(),
+
+  /** Stable Trello label ID. */
+  id: z.string(),
+
+  /** Label name. */
+  name: z.string(),
+})
+
+export const TRELLO_CARD_SCHEMA = z.object({
+  /** Whether the card is archived. */
+  closed: z.boolean(),
+
+  /** Stable ID of the containing board. */
+  boardId: z.string(),
+
+  /** Card description. */
+  description: z.string(),
+
+  /** Card due time. */
+  dueAt: z.date().nullable(),
+
+  /** Whether work due on the card is complete. */
+  dueComplete: z.boolean(),
+
+  /** Stable Trello card ID. */
+  id: z.string(),
+
+  /** Labels currently applied to the card. */
+  labels: TRELLO_LABEL_SCHEMA.array(),
+
+  /** Stable IDs of labels currently applied to the card. */
+  labelIds: z.string().array(),
+
+  /** Last card activity time. */
+  lastActivityAt: z.date().nullable(),
+
+  /** Stable ID of the containing list. */
+  listId: z.string(),
+
+  /** Stable IDs of members assigned to the card. */
+  memberIds: z.string().array(),
+
+  /** Card name. */
+  name: z.string(),
+
+  /** Trello ordering position. */
+  position: z.number(),
+
+  /** Card short link used in Trello URLs. */
+  shortLink: z.string(),
+
+  /** Short public or workspace-visible card URL. */
+  shortUrl: z.string(),
+
+  /** Optional work start time. */
+  startAt: z.date().nullable(),
+
+  /** Whether the connected member watches the card. */
+  subscribed: z.boolean(),
+
+  /** Full Trello card URL. */
+  url: z.string(),
+})
+
+export const TRELLO_COMMENT_SCHEMA = z.object({
+  /** Time the comment was created. */
+  commentedAt: z.date(),
+
+  /** Comment author, when returned by Trello. */
+  creator: TRELLO_MEMBER_SCHEMA.nullable(),
+
+  /** Stable Trello action ID for the comment. */
+  id: z.string(),
+
+  /** Comment text. */
+  text: z.string(),
+})
+
+export const TRELLO_ATTACHMENT_SCHEMA = z.object({
+  /** Attachment size in bytes, when known. */
+  bytes: z.number().nullable(),
+
+  /** Time the attachment was created. */
+  createdAt: z.date(),
+
+  /** Stable Trello attachment ID. */
+  id: z.string(),
+
+  /** Whether the attachment is an uploaded file rather than a link. */
+  isUpload: z.boolean(),
+
+  /** MIME type, when known. */
+  mimeType: z.string().nullable(),
+
+  /** Attachment display name. */
+  name: z.string(),
+
+  /** Trello ordering position. */
+  position: z.number(),
+
+  /** Attachment URL. */
+  url: z.string(),
+})
+
+export const TRELLO_CHECK_ITEM_SCHEMA = z.object({
+  /** Time the checklist item is due. */
+  dueAt: z.date().nullable(),
+
+  /** Reminder offset in minutes, when configured. */
+  dueReminder: z.number().nullable(),
+
+  /** Stable Trello checklist item ID. */
+  id: z.string(),
+
+  /** Assigned member ID, when configured. */
+  memberId: z.string().nullable(),
+
+  /** Checklist item name. */
+  name: z.string(),
+
+  /** Trello ordering position. */
+  position: z.number(),
+
+  /** Completion state. */
+  state: z.enum(["complete", "incomplete"]),
+})
+
+export const TRELLO_CHECKLIST_SCHEMA = z.object({
+  /** Stable ID of the containing board. */
+  boardId: z.string(),
+
+  /** Stable ID of the containing card. */
+  cardId: z.string(),
+
+  /** Checklist items, when requested. */
+  checkItems: TRELLO_CHECK_ITEM_SCHEMA.array(),
+
+  /** Stable Trello checklist ID. */
+  id: z.string(),
+
+  /** Checklist name. */
+  name: z.string(),
+
+  /** Trello ordering position. */
+  position: z.number(),
+})
+
+export const TRELLO_PROVIDER_MEMBER_SCHEMA = z.looseObject({
+  avatarUrl: z.string().nullable().optional(),
+  fullName: z.string(),
+  id: z.string(),
+  initials: z.string().optional(),
+  url: z.string().nullable().optional(),
+  username: z.string(),
+})
+
+export const TRELLO_PROVIDER_BOARD_SCHEMA = z.looseObject({
+  closed: z.boolean().prefault(false),
+  dateLastActivity: z.string().nullable().optional(),
+  desc: z.string().prefault(""),
+  id: z.string(),
+  idOrganization: z.string().nullable().optional(),
+  name: z.string(),
+  shortUrl: z.string().prefault(""),
+  starred: z.boolean().prefault(false),
+  subscribed: z.boolean().prefault(false),
+  url: z.string().prefault(""),
+})
+
+export const TRELLO_PROVIDER_LIST_SCHEMA = z.looseObject({
+  closed: z.boolean().prefault(false),
+  id: z.string(),
+  idBoard: z.string(),
+  name: z.string(),
+  pos: z.number(),
+  subscribed: z.boolean().prefault(false),
+})
+
+export const TRELLO_PROVIDER_LABEL_SCHEMA = z.looseObject({
+  color: z.string().nullable().prefault(null),
+  id: z.string(),
+  idBoard: z.string().optional(),
+  name: z.string().prefault(""),
+})
+
+export const TRELLO_PROVIDER_CARD_SCHEMA = z.looseObject({
+  closed: z.boolean().prefault(false),
+  dateLastActivity: z.string().nullable().optional(),
+  desc: z.string().prefault(""),
+  due: z.string().nullable().optional(),
+  dueComplete: z.boolean().prefault(false),
+  id: z.string(),
+  idBoard: z.string(),
+  idLabels: z.string().array().prefault([]),
+  idList: z.string(),
+  idMembers: z.string().array().prefault([]),
+  labels: TRELLO_PROVIDER_LABEL_SCHEMA.array().prefault([]),
+  name: z.string(),
+  pos: z.number(),
+  shortLink: z.string().prefault(""),
+  shortUrl: z.string().prefault(""),
+  start: z.string().nullable().optional(),
+  subscribed: z.boolean().prefault(false),
+  url: z.string().prefault(""),
+})
+
+export const TRELLO_PROVIDER_COMMENT_SCHEMA = z.looseObject({
+  data: z.looseObject({ text: z.string() }),
+  date: z.string(),
+  id: z.string(),
+  memberCreator: TRELLO_PROVIDER_MEMBER_SCHEMA.optional(),
+})
+
+export const TRELLO_PROVIDER_ATTACHMENT_SCHEMA = z.looseObject({
+  bytes: z.number().nullable().optional(),
+  date: z.string(),
+  id: z.string(),
+  isUpload: z.boolean().prefault(false),
+  mimeType: z.string().nullable().optional(),
+  name: z.string(),
+  pos: z.number(),
+  url: z.string(),
+})
+
+export const TRELLO_PROVIDER_CHECK_ITEM_SCHEMA = z.looseObject({
+  due: z.string().nullable().optional(),
+  dueReminder: z.number().nullable().optional(),
+  id: z.string(),
+  idMember: z.string().nullable().optional(),
+  name: z.string(),
+  pos: z.number(),
+  state: z.enum(["complete", "incomplete"]),
+})
+
+export const TRELLO_PROVIDER_CHECKLIST_SCHEMA = z.looseObject({
+  checkItems: TRELLO_PROVIDER_CHECK_ITEM_SCHEMA.array().prefault([]),
+  id: z.string(),
+  idBoard: z.string(),
+  idCard: z.string(),
+  name: z.string(),
+  pos: z.number(),
+})
+
+/**
+ * Normalizes one Trello member response.
+ *
+ * @param member - Provider member resource.
+ */
+export function toTrelloMember(
+  member: z.output<typeof TRELLO_PROVIDER_MEMBER_SCHEMA>,
+): z.output<typeof TRELLO_MEMBER_SCHEMA> {
+  return {
+    avatarUrl: member.avatarUrl ?? null,
+    fullName: member.fullName,
+    id: member.id,
+    initials: member.initials,
+    url: member.url ?? null,
+    username: member.username,
+  }
+}
+
+/**
+ * Normalizes one Trello board response.
+ *
+ * @param board - Provider board resource.
+ */
+export function toTrelloBoard(
+  board: z.output<typeof TRELLO_PROVIDER_BOARD_SCHEMA>,
+): z.output<typeof TRELLO_BOARD_SCHEMA> {
+  return {
+    closed: board.closed,
+    description: board.desc,
+    id: board.id,
+    lastActivityAt: OPTIONAL_DATE_SCHEMA.parse(board.dateLastActivity),
+    name: board.name,
+    organizationId: board.idOrganization ?? null,
+    shortUrl: board.shortUrl,
+    starred: board.starred,
+    subscribed: board.subscribed,
+    url: board.url,
+  }
+}
+
+/**
+ * Normalizes one Trello list response.
+ *
+ * @param list - Provider list resource.
+ */
+export function toTrelloList(
+  list: z.output<typeof TRELLO_PROVIDER_LIST_SCHEMA>,
+): z.output<typeof TRELLO_LIST_SCHEMA> {
+  return {
+    boardId: list.idBoard,
+    closed: list.closed,
+    id: list.id,
+    name: list.name,
+    position: list.pos,
+    subscribed: list.subscribed,
+  }
+}
+
+/**
+ * Normalizes one Trello label response.
+ *
+ * @param label - Provider label resource.
+ */
+export function toTrelloLabel(
+  label: z.output<typeof TRELLO_PROVIDER_LABEL_SCHEMA>,
+): z.output<typeof TRELLO_LABEL_SCHEMA> {
+  return {
+    boardId: label.idBoard,
+    color: label.color,
+    id: label.id,
+    name: label.name,
+  }
+}
+
+/**
+ * Normalizes one Trello card response.
+ *
+ * @param card - Provider card resource.
+ */
+export function toTrelloCard(
+  card: z.output<typeof TRELLO_PROVIDER_CARD_SCHEMA>,
+): z.output<typeof TRELLO_CARD_SCHEMA> {
+  return {
+    boardId: card.idBoard,
+    closed: card.closed,
+    description: card.desc,
+    dueAt: OPTIONAL_DATE_SCHEMA.parse(card.due),
+    dueComplete: card.dueComplete,
+    id: card.id,
+    labelIds: card.idLabels,
+    labels: card.labels.map(toTrelloLabel),
+    lastActivityAt: OPTIONAL_DATE_SCHEMA.parse(card.dateLastActivity),
+    listId: card.idList,
+    memberIds: card.idMembers,
+    name: card.name,
+    position: card.pos,
+    shortLink: card.shortLink,
+    shortUrl: card.shortUrl,
+    startAt: OPTIONAL_DATE_SCHEMA.parse(card.start),
+    subscribed: card.subscribed,
+    url: card.url,
+  }
+}
+
+/**
+ * Normalizes one Trello comment action.
+ *
+ * @param comment - Provider comment action.
+ */
+export function toTrelloComment(
+  comment: z.output<typeof TRELLO_PROVIDER_COMMENT_SCHEMA>,
+): z.output<typeof TRELLO_COMMENT_SCHEMA> {
+  return {
+    commentedAt: new Date(comment.date),
+    creator: comment.memberCreator
+      ? toTrelloMember(comment.memberCreator)
+      : null,
+    id: comment.id,
+    text: comment.data.text,
+  }
+}
+
+/**
+ * Normalizes one Trello card attachment.
+ *
+ * @param attachment - Provider attachment resource.
+ */
+export function toTrelloAttachment(
+  attachment: z.output<typeof TRELLO_PROVIDER_ATTACHMENT_SCHEMA>,
+): z.output<typeof TRELLO_ATTACHMENT_SCHEMA> {
+  return {
+    bytes: attachment.bytes ?? null,
+    createdAt: new Date(attachment.date),
+    id: attachment.id,
+    isUpload: attachment.isUpload,
+    mimeType: attachment.mimeType ?? null,
+    name: attachment.name,
+    position: attachment.pos,
+    url: attachment.url,
+  }
+}
+
+/**
+ * Normalizes one Trello checklist item.
+ *
+ * @param item - Provider checklist-item resource.
+ */
+export function toTrelloCheckItem(
+  item: z.output<typeof TRELLO_PROVIDER_CHECK_ITEM_SCHEMA>,
+): z.output<typeof TRELLO_CHECK_ITEM_SCHEMA> {
+  return {
+    dueAt: OPTIONAL_DATE_SCHEMA.parse(item.due),
+    dueReminder: item.dueReminder ?? null,
+    id: item.id,
+    memberId: item.idMember ?? null,
+    name: item.name,
+    position: item.pos,
+    state: item.state,
+  }
+}
+
+/**
+ * Normalizes one Trello checklist and its items.
+ *
+ * @param checklist - Provider checklist resource.
+ */
+export function toTrelloChecklist(
+  checklist: z.output<typeof TRELLO_PROVIDER_CHECKLIST_SCHEMA>,
+): z.output<typeof TRELLO_CHECKLIST_SCHEMA> {
+  return {
+    boardId: checklist.idBoard,
+    cardId: checklist.idCard,
+    checkItems: checklist.checkItems.map(toTrelloCheckItem),
+    id: checklist.id,
+    name: checklist.name,
+    position: checklist.pos,
+  }
+}

package/src/triggers.ts

@@ -0,0 +1,68 @@
+import { airtableTriggerContracts } from "./airtable"
+import { asanaTriggerContracts } from "./asana"
+import { brevoTriggerContracts } from "./brevo"
+import { githubTriggerContracts } from "./github"
+import { gmailTriggerContracts } from "./gmail"
+import { googleCalendarTriggerContracts } from "./google-calendar"
+import { googleFormsTriggerContracts } from "./google-forms"
+import { linearTriggerContracts } from "./linear"
+import { outlookTriggerContracts } from "./outlook"
+import { resendTriggerContracts } from "./resend"
+import { slackTriggerContracts } from "./slack"
+import { teamsTriggerContracts } from "./teams"
+import { trelloTriggerContracts } from "./trello"
+import { vercelTriggerContracts } from "./vercel"
+import { whatsappTriggerContracts } from "./whatsapp"
+import type { z } from "zod"
+
+type IntegrationTriggerContracts = typeof airtableTriggerContracts &
+  typeof asanaTriggerContracts &
+  typeof brevoTriggerContracts &
+  typeof githubTriggerContracts &
+  typeof gmailTriggerContracts &
+  typeof googleCalendarTriggerContracts &
+  typeof googleFormsTriggerContracts &
+  typeof linearTriggerContracts &
+  typeof outlookTriggerContracts &
+  typeof resendTriggerContracts &
+  typeof slackTriggerContracts &
+  typeof teamsTriggerContracts &
+  typeof trelloTriggerContracts &
+  typeof vercelTriggerContracts &
+  typeof whatsappTriggerContracts
+
+/** Shared schemas for every integration-backed public trigger. */
+export const triggerContracts: IntegrationTriggerContracts = {
+  ...airtableTriggerContracts,
+  ...asanaTriggerContracts,
+  ...brevoTriggerContracts,
+  ...githubTriggerContracts,
+  ...gmailTriggerContracts,
+  ...googleCalendarTriggerContracts,
+  ...googleFormsTriggerContracts,
+  ...linearTriggerContracts,
+  ...outlookTriggerContracts,
+  ...resendTriggerContracts,
+  ...slackTriggerContracts,
+  ...teamsTriggerContracts,
+  ...trelloTriggerContracts,
+  ...vercelTriggerContracts,
+  ...whatsappTriggerContracts,
+}
+
+export type TriggerContractMap = IntegrationTriggerContracts
+export type IntegrationTriggerType = keyof TriggerContractMap
+
+/** Canonical authoring configuration for one integration trigger type. */
+export type TriggerConfig<TType extends IntegrationTriggerType> =
+  z.input<TriggerContractMap[TType]["configSchema"]> extends Record<
+    string,
+    never
+  >
+    ? object
+    : z.input<TriggerContractMap[TType]["configSchema"]>
+
+/** Normalized event payload emitted by one integration trigger type. */
+export type TriggerEvent<TType extends IntegrationTriggerType> = z.output<
+  TriggerContractMap[TType]["eventSchema"]
+>