@automate.ax/integration-contracts 0.55.0

package/src/google-calendar/index.ts

@@ -0,0 +1,27 @@
+import { z } from "zod"
+import { GOOGLE_CALENDAR_EVENT_DELETED_SCHEMA } from "./event-schemas"
+import { CALENDAR_EVENT_SCHEMA } from "./schemas"
+
+export * from "./event-schemas"
+export * from "./google-calendar"
+export * from "./schemas"
+
+/** Canonical Google Calendar collection selected by one subscription. */
+export const GOOGLE_CALENDAR_TRIGGER_CONFIG_SCHEMA = z.object({
+  calendarId: z.string(),
+})
+
+export const googleCalendarTriggerContracts = {
+  "googleCalendar.event.created": {
+    configSchema: GOOGLE_CALENDAR_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: CALENDAR_EVENT_SCHEMA,
+  },
+  "googleCalendar.event.deleted": {
+    configSchema: GOOGLE_CALENDAR_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: GOOGLE_CALENDAR_EVENT_DELETED_SCHEMA,
+  },
+  "googleCalendar.event.updated": {
+    configSchema: GOOGLE_CALENDAR_TRIGGER_CONFIG_SCHEMA,
+    eventSchema: CALENDAR_EVENT_SCHEMA,
+  },
+} as const

package/src/google-calendar/schemas.ts

@@ -0,0 +1,529 @@
+import { z } from "zod"
+
+export const CALENDAR_REFERENCE_SCHEMA = z.string().trim().min(1)
+export const EVENT_REFERENCE_SCHEMA = z.string().trim().min(1)
+export const RFC3339_SCHEMA = z.iso.datetime({ offset: true })
+export const DATE_SCHEMA = z.iso.date()
+export const SEND_UPDATES_SCHEMA = z.enum(["all", "externalOnly", "none"])
+export const EVENT_STATUS_SCHEMA = z.enum([
+  "confirmed",
+  "tentative",
+  "cancelled",
+])
+export const RESPONSE_STATUS_SCHEMA = z.enum([
+  "needsAction",
+  "declined",
+  "tentative",
+  "accepted",
+])
+
+export const EVENT_TIME_SCHEMA = z.object({
+  /** All-day calendar date, when this is an all-day event. */
+  date: DATE_SCHEMA.optional(),
+
+  /** RFC 3339 instant, when this is a timed event. */
+  dateTime: z.string().optional(),
+
+  /** IANA timezone associated with the date-time. */
+  timeZone: z.string().optional(),
+})
+
+export const EVENT_SCHEDULE_INPUT_SCHEMA = z.union([
+  z
+    .object({
+      /** Inclusive all-day start date. */
+      startDate: DATE_SCHEMA,
+
+      /** Exclusive all-day end date. Defaults to the next day. */
+      endDate: DATE_SCHEMA.optional(),
+    })
+    .refine(
+      ({ endDate, startDate }) => !endDate || endDate > startDate,
+      "The all-day end date must follow the start date.",
+    ),
+  z
+    .object({
+      /** Exclusive RFC 3339 ending instant. */
+      end: RFC3339_SCHEMA,
+
+      /** Inclusive RFC 3339 starting instant. */
+      start: RFC3339_SCHEMA,
+
+      /** IANA timezone used to expand recurrence rules. */
+      timeZone: z.string().min(1).optional(),
+    })
+    .refine(
+      ({ end, start }) => new Date(end).getTime() > new Date(start).getTime(),
+      "The event end must follow its start.",
+    ),
+])
+
+export const EVENT_PRINCIPAL_SCHEMA = z.object({
+  /** Human-readable name. */
+  displayName: z.string().optional(),
+
+  /** Email address, when available. */
+  email: z.string().optional(),
+
+  /** Whether this principal is the authenticated user. */
+  self: z.boolean(),
+})
+
+export const EVENT_ATTENDEE_INPUT_SCHEMA = z.object({
+  /** Number of guests accompanying the attendee. */
+  additionalGuests: z.number().int().nonnegative().optional(),
+
+  /** Optional invitation response comment. */
+  comment: z.string().optional(),
+
+  /** Attendee email address. */
+  email: z.email(),
+
+  /** Human-readable attendee name. */
+  displayName: z.string().optional(),
+
+  /** Whether attendance is optional. */
+  optional: z.boolean().optional(),
+
+  /** Whether this attendee represents a room or other resource. */
+  resource: z.boolean().optional(),
+
+  /** Initial invitation response. */
+  responseStatus: RESPONSE_STATUS_SCHEMA.optional(),
+})
+
+export const EVENT_ATTENDEE_SCHEMA = EVENT_ATTENDEE_INPUT_SCHEMA.extend({
+  /** Whether this attendee organized the event. */
+  organizer: z.boolean(),
+
+  /** Whether this attendee is the authenticated user. */
+  self: z.boolean(),
+})
+
+export const EVENT_ATTACHMENT_INPUT_SCHEMA = z.object({
+  /** Google Drive file ID, when applicable. */
+  fileId: z.string().min(1).optional(),
+
+  /** Public or authenticated URL to the attachment. */
+  fileUrl: z.url(),
+
+  /** Attachment media type. */
+  mimeType: z.string().min(1).optional(),
+
+  /** Human-readable attachment title. */
+  title: z.string().optional(),
+})
+
+export const EVENT_ATTACHMENT_SCHEMA = EVENT_ATTACHMENT_INPUT_SCHEMA.extend({
+  /** Provider icon URL. */
+  iconLink: z.string().optional(),
+})
+
+export const EVENT_REMINDER_SCHEMA = z.object({
+  /** Number of minutes before the event. */
+  minutes: z.number().int().nonnegative(),
+
+  /** Reminder delivery method. */
+  method: z.enum(["email", "popup"]),
+})
+
+export const EVENT_REMINDERS_INPUT_SCHEMA = z.union([
+  z.object({
+    /** Use the calendar's default reminder configuration. */
+    useDefault: z.literal(true),
+  }),
+  z.object({
+    /** Event-specific reminders, including an empty array for no reminders. */
+    overrides: EVENT_REMINDER_SCHEMA.array().max(5),
+
+    /** Use event-specific reminders. */
+    useDefault: z.literal(false),
+  }),
+])
+
+export const EVENT_DETAILS_INPUT_SCHEMA = z.object({
+  /** Event attachments. Google Drive attachment URLs are supported. */
+  attachments: EVENT_ATTACHMENT_INPUT_SCHEMA.array().max(25).optional(),
+
+  /** People and resources invited to the event. */
+  attendees: EVENT_ATTENDEE_INPUT_SCHEMA.array().optional(),
+
+  /** Calendar event color ID. */
+  colorId: z.string().min(1).optional(),
+
+  /** Description, which may contain HTML. */
+  description: z.string().optional(),
+
+  /** Application-defined properties. */
+  extendedProperties: z
+    .object({
+      private: z.record(z.string(), z.string()).optional(),
+      shared: z.record(z.string(), z.string()).optional(),
+    })
+    .optional(),
+
+  /** Whether attendees may invite other people. */
+  guestsCanInviteOthers: z.boolean().optional(),
+
+  /** Whether attendees may modify the event. */
+  guestsCanModify: z.boolean().optional(),
+
+  /** Whether attendees may see one another. */
+  guestsCanSeeOtherGuests: z.boolean().optional(),
+
+  /** Free-form event location. */
+  location: z.string().optional(),
+
+  /** RFC 5545 recurrence lines such as `RRULE:FREQ=WEEKLY;BYDAY=MO`. */
+  recurrence: z.string().min(1).array().optional(),
+
+  /** Event reminder behavior. */
+  reminders: EVENT_REMINDERS_INPUT_SCHEMA.optional(),
+
+  /** Timed or all-day event schedule. */
+  schedule: EVENT_SCHEDULE_INPUT_SCHEMA.optional(),
+
+  /** Human-readable event title. */
+  summary: z.string().trim().min(1).optional(),
+
+  /** Whether the event blocks time. */
+  transparency: z.enum(["opaque", "transparent"]).optional(),
+
+  /** Event visibility. */
+  visibility: z
+    .enum(["default", "public", "private", "confidential"])
+    .optional(),
+})
+
+export const EVENT_CONFERENCE_SCHEMA = z.object({
+  /** Provider conference identifier. */
+  conferenceId: z.string().optional(),
+
+  /** Current asynchronous creation status. */
+  creationStatus: z.enum(["pending", "success", "failure"]).optional(),
+
+  /** Conference entry points such as video, phone, or SIP. */
+  entryPoints: z
+    .object({
+      /** Human-readable entry-point label. */
+      label: z.string().optional(),
+
+      /** PIN or passcode, when applicable. */
+      passcode: z.string().optional(),
+
+      /** Entry-point type. */
+      type: z.string(),
+
+      /** Join URI. */
+      uri: z.string(),
+    })
+    .array(),
+
+  /** Human-readable conference solution name. */
+  name: z.string().optional(),
+})
+
+export const EXTENDED_PROPERTIES_SCHEMA = z.object({
+  /** Properties private to this calendar copy of the event. */
+  private: z.record(z.string(), z.string()),
+
+  /** Properties shared between attendee copies of the event. */
+  shared: z.record(z.string(), z.string()),
+})
+
+export const CALENDAR_EVENT_SCHEMA = z.object({
+  /** Event attachments. */
+  attachments: EVENT_ATTACHMENT_SCHEMA.array(),
+
+  /** Invited people and resources. */
+  attendees: EVENT_ATTENDEE_SCHEMA.array(),
+
+  /** Calendar from which this representation was read. */
+  calendarId: z.string(),
+
+  /** Calendar color palette identifier. */
+  colorId: z.string().optional(),
+
+  /** Conference connection details. */
+  conference: EVENT_CONFERENCE_SCHEMA.optional(),
+
+  /** Event creation timestamp. */
+  createdAt: z.string().optional(),
+
+  /** Event creator. */
+  creator: EVENT_PRINCIPAL_SCHEMA.optional(),
+
+  /** Description, which may contain HTML. */
+  description: z.string().optional(),
+
+  /** Exclusive event end. Omitted on deleted synchronization tombstones. */
+  end: EVENT_TIME_SCHEMA.optional(),
+
+  /** Application-defined properties. */
+  extendedProperties: EXTENDED_PROPERTIES_SCHEMA,
+
+  /** Whether attendees may invite other people. */
+  guestsCanInviteOthers: z.boolean(),
+
+  /** Whether attendees may modify the event. */
+  guestsCanModify: z.boolean(),
+
+  /** Whether attendees may see one another. */
+  guestsCanSeeOtherGuests: z.boolean(),
+
+  /** Google Meet or other primary conference URL. */
+  hangoutLink: z.string().optional(),
+
+  /** Browser URL for this event. */
+  htmlLink: z.string().optional(),
+
+  /** Immutable provider event ID. */
+  id: z.string(),
+
+  /** Cross-calendar iCalendar UID. */
+  iCalUID: z.string().optional(),
+
+  /** Free-form event location. */
+  location: z.string().optional(),
+
+  /** Original scheduled start for a recurring instance. */
+  originalStart: EVENT_TIME_SCHEMA.optional(),
+
+  /** Event organizer. */
+  organizer: EVENT_PRINCIPAL_SCHEMA.optional(),
+
+  /** Recurrence lines using RFC 5545 syntax. */
+  recurrence: z.string().array(),
+
+  /** Parent recurring event ID for an expanded instance. */
+  recurringEventId: z.string().optional(),
+
+  /** Effective reminder configuration. */
+  reminders: z.object({
+    overrides: EVENT_REMINDER_SCHEMA.array(),
+    useDefault: z.boolean(),
+  }),
+
+  /** Event revision sequence. */
+  sequence: z.number().int().nonnegative(),
+
+  /** Inclusive event start. Omitted on deleted synchronization tombstones. */
+  start: EVENT_TIME_SCHEMA.optional(),
+
+  /** Event lifecycle status. */
+  status: EVENT_STATUS_SCHEMA,
+
+  /** Human-readable event title. */
+  summary: z.string(),
+
+  /** Whether the event blocks time. */
+  transparency: z.enum(["opaque", "transparent"]),
+
+  /** Provider event type. */
+  type: z.string(),
+
+  /** Last update timestamp. */
+  updatedAt: z.string().optional(),
+
+  /** Event visibility. */
+  visibility: z.enum(["default", "public", "private", "confidential"]),
+})
+
+export const EVENT_PAGE_SCHEMA = z.object({
+  /** Matching events. */
+  events: CALENDAR_EVENT_SCHEMA.array(),
+
+  /** Token for fetching the next page. */
+  nextPageToken: z.string().optional(),
+
+  /** Token for a future incremental synchronization. */
+  nextSyncToken: z.string().optional(),
+
+  /** Calendar timezone returned by Google. */
+  timeZone: z.string().optional(),
+
+  /** Last modification time of the calendar. */
+  updatedAt: z.string().optional(),
+})
+
+export const REMINDER_SCHEMA = z.object({
+  /** Number of minutes before an event. */
+  minutes: z.number().int().nonnegative(),
+
+  /** Reminder delivery method. */
+  method: z.string(),
+})
+
+export const CALENDAR_NOTIFICATION_SCHEMA = z.object({
+  /** Email notification category. */
+  type: z.enum([
+    "eventCreation",
+    "eventChange",
+    "eventCancellation",
+    "eventResponse",
+    "agenda",
+  ]),
+})
+
+export const CALENDAR_SCHEMA = z.object({
+  /** Access role of the authenticated user. */
+  accessRole: z.string().optional(),
+
+  /** Whether a resource calendar automatically accepts invitations. */
+  autoAcceptInvitations: z.boolean(),
+
+  /** Calendar background color. */
+  backgroundColor: z.string().optional(),
+
+  /** Calendar color palette identifier. */
+  colorId: z.string().optional(),
+
+  /** Conference solution types allowed on this calendar. */
+  conferenceSolutionTypes: z.string().array(),
+
+  /** Default event reminders. */
+  defaultReminders: REMINDER_SCHEMA.array(),
+
+  /** Owner email for a secondary calendar. */
+  dataOwner: z.string().optional(),
+
+  /** Whether this calendar-list entry was deleted. */
+  deleted: z.boolean(),
+
+  /** Human-readable calendar description. */
+  description: z.string().optional(),
+
+  /** Calendar foreground color. */
+  foregroundColor: z.string().optional(),
+
+  /** Whether this calendar is hidden from the list. */
+  hidden: z.boolean(),
+
+  /** Immutable calendar identifier. */
+  id: z.string(),
+
+  /** Free-form calendar location. */
+  location: z.string().optional(),
+
+  /** Email notifications configured for this calendar. */
+  notifications: CALENDAR_NOTIFICATION_SCHEMA.array(),
+
+  /** Whether this is the authenticated user's primary calendar. */
+  primary: z.boolean(),
+
+  /** Whether events appear in the Google Calendar UI. */
+  selected: z.boolean(),
+
+  /** Human-readable calendar title. */
+  summary: z.string(),
+
+  /** User-specific title override. */
+  summaryOverride: z.string().optional(),
+
+  /** IANA calendar timezone. */
+  timeZone: z.string().optional(),
+})
+
+export const CALENDAR_PAGE_SCHEMA = z.object({
+  /** Visible calendars. */
+  calendars: CALENDAR_SCHEMA.array(),
+
+  /** Token for fetching the next page. */
+  nextPageToken: z.string().optional(),
+
+  /** Token for a future incremental synchronization. */
+  nextSyncToken: z.string().optional(),
+})
+
+export const BUSY_PERIOD_SCHEMA = z.object({
+  /** Exclusive busy-period end. */
+  end: z.string(),
+
+  /** Inclusive busy-period start. */
+  start: z.string(),
+})
+
+export const FREE_BUSY_CALENDAR_SCHEMA = z.object({
+  /** Busy periods for the calendar. */
+  busy: BUSY_PERIOD_SCHEMA.array(),
+
+  /** Calendar identifier. */
+  calendarId: z.string(),
+
+  /** Provider errors encountered for this calendar. */
+  errors: z
+    .object({
+      domain: z.string().optional(),
+      reason: z.string().optional(),
+    })
+    .array(),
+})
+
+export const FREE_BUSY_SCHEMA = z.object({
+  /** Per-calendar free/busy results. */
+  calendars: FREE_BUSY_CALENDAR_SCHEMA.array(),
+
+  /** Exclusive query end. */
+  timeMax: z.string(),
+
+  /** Inclusive query start. */
+  timeMin: z.string(),
+})
+
+export const AVAILABILITY_SLOT_SCHEMA = BUSY_PERIOD_SCHEMA.extend({
+  /** Slot duration in minutes. */
+  durationMinutes: z.number().int().positive(),
+})
+
+export const COLOR_PALETTE_SCHEMA = z.object({
+  /** Calendar color definitions keyed by color ID. */
+  calendars: z.record(
+    z.string(),
+    z.object({ background: z.string(), foreground: z.string() }),
+  ),
+
+  /** Event color definitions keyed by color ID. */
+  events: z.record(
+    z.string(),
+    z.object({ background: z.string(), foreground: z.string() }),
+  ),
+
+  /** Palette update timestamp. */
+  updatedAt: z.string().optional(),
+})
+
+export const ACL_SCOPE_SCHEMA = z
+  .object({
+    /** ACL scope type. */
+    type: z.enum(["default", "user", "group", "domain"]),
+
+    /** Email address or domain. Omitted for the default public scope. */
+    value: z.string().min(1).optional(),
+  })
+  .refine(
+    ({ type, value }) =>
+      type === "default" ? value === undefined : value !== undefined,
+    "User, group, and domain scopes require a value; default scope does not.",
+  )
+
+export const ACL_RULE_SCHEMA = z.object({
+  /** Immutable ACL rule identifier. */
+  id: z.string(),
+
+  /** Permission role. */
+  role: z.enum(["none", "freeBusyReader", "reader", "writer", "owner"]),
+
+  /** Principal or public scope receiving access. */
+  scope: ACL_SCOPE_SCHEMA,
+})
+
+export const ACL_PAGE_SCHEMA = z.object({
+  /** Access rules. */
+  rules: ACL_RULE_SCHEMA.array(),
+
+  /** Token for fetching the next page. */
+  nextPageToken: z.string().optional(),
+
+  /** Token for a future incremental synchronization. */
+  nextSyncToken: z.string().optional(),
+})

package/src/google-forms/event-schemas.ts

@@ -0,0 +1,26 @@
+import { FORM_SCHEMA } from "./schemas"
+import { z } from "zod"
+
+export const GOOGLE_FORMS_NOTIFICATION_SCHEMA = z.object({
+  /** Provider event category that caused the notification. */
+  eventType: z.enum(["SCHEMA", "RESPONSES"]),
+
+  /** Google Form that changed. */
+  formId: z.string(),
+
+  /** Pub/Sub message identifier. */
+  messageId: z.string(),
+
+  /** Pub/Sub publication timestamp. */
+  publishTime: z.string(),
+
+  /** Google Forms watch that produced the notification. */
+  watchId: z.string(),
+})
+
+export const GOOGLE_FORMS_FORM_CHANGED_EVENT_SCHEMA = FORM_SCHEMA.extend({
+  /** Original provider notification metadata. */
+  event: GOOGLE_FORMS_NOTIFICATION_SCHEMA.extend({
+    eventType: z.literal("SCHEMA"),
+  }),
+})