@automate.ax/integration-contracts 0.89.2 → 0.91.0

package/src/jobnimbus/schemas.ts

@@ -0,0 +1,351 @@
+import * as z from "zod"
+
+import { JOB_NIMBUS_VALUE_SCHEMA } from "./api"
+
+export const JOB_NIMBUS_ID_SCHEMA = z.string().trim().min(1)
+
+const NULLABLE_STRING_SCHEMA = z.string().nullable().optional()
+const NULLABLE_NUMBER_SCHEMA = z.number().nullable().optional()
+const DATE_SCHEMA = z.date().nullable().optional()
+
+export const JOB_NIMBUS_CUSTOM_FIELDS_SCHEMA = z.record(
+  z.string().min(1),
+  z.union([z.boolean(), z.number(), z.string(), z.null()]),
+)
+
+export const JOB_NIMBUS_REFERENCE_SCHEMA = z
+  .object({
+    id: JOB_NIMBUS_ID_SCHEMA,
+    name: NULLABLE_STRING_SCHEMA,
+    number: NULLABLE_STRING_SCHEMA,
+    type: NULLABLE_STRING_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_OWNER_SCHEMA = z
+  .object({
+    id: JOB_NIMBUS_ID_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_LOCATION_SCHEMA = z
+  .object({
+    id: z.number(),
+    name: NULLABLE_STRING_SCHEMA,
+    parentId: z.number().nullable().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_GEO_SCHEMA = z.object({
+  lat: z.number(),
+  lon: z.number(),
+})
+
+const CRM_BASE_FIELDS = {
+  dateCreated: DATE_SCHEMA,
+  createdBy: NULLABLE_STRING_SCHEMA,
+  createdByName: NULLABLE_STRING_SCHEMA,
+  customer: NULLABLE_STRING_SCHEMA,
+  customFields: JOB_NIMBUS_CUSTOM_FIELDS_SCHEMA.optional(),
+  id: JOB_NIMBUS_ID_SCHEMA,
+  isActive: z.boolean().optional(),
+  isArchived: z.boolean().optional(),
+  location: JOB_NIMBUS_LOCATION_SCHEMA.nullable().optional(),
+  owners: JOB_NIMBUS_OWNER_SCHEMA.array().optional(),
+  recordId: z.number().optional(),
+  recordType: NULLABLE_NUMBER_SCHEMA,
+  recordTypeName: NULLABLE_STRING_SCHEMA,
+  related: JOB_NIMBUS_REFERENCE_SCHEMA.array().optional(),
+  tags: z.string().array().optional(),
+  type: NULLABLE_STRING_SCHEMA,
+  dateUpdated: DATE_SCHEMA,
+}
+
+const ADDRESS_FIELDS = {
+  addressLine1: NULLABLE_STRING_SCHEMA,
+  addressLine2: NULLABLE_STRING_SCHEMA,
+  city: NULLABLE_STRING_SCHEMA,
+  countryName: NULLABLE_STRING_SCHEMA,
+  stateText: NULLABLE_STRING_SCHEMA,
+  zip: NULLABLE_STRING_SCHEMA,
+}
+
+const WORKFLOW_FIELDS = {
+  isClosed: z.boolean().optional(),
+  isLead: z.boolean().optional(),
+  salesRep: NULLABLE_STRING_SCHEMA,
+  salesRepName: NULLABLE_STRING_SCHEMA,
+  source: NULLABLE_NUMBER_SCHEMA,
+  sourceName: NULLABLE_STRING_SCHEMA,
+  status: NULLABLE_NUMBER_SCHEMA,
+  statusName: NULLABLE_STRING_SCHEMA,
+}
+
+export const JOB_NIMBUS_CONTACT_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    ...ADDRESS_FIELDS,
+    ...WORKFLOW_FIELDS,
+    company: NULLABLE_STRING_SCHEMA,
+    description: NULLABLE_STRING_SCHEMA,
+    displayName: NULLABLE_STRING_SCHEMA,
+    email: NULLABLE_STRING_SCHEMA,
+    faxNumber: NULLABLE_STRING_SCHEMA,
+    firstName: NULLABLE_STRING_SCHEMA,
+    geo: JOB_NIMBUS_GEO_SCHEMA.nullable().optional(),
+    homePhone: NULLABLE_STRING_SCHEMA,
+    lastName: NULLABLE_STRING_SCHEMA,
+    mobilePhone: NULLABLE_STRING_SCHEMA,
+    website: NULLABLE_STRING_SCHEMA,
+    workPhone: NULLABLE_STRING_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_JOB_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    ...ADDRESS_FIELDS,
+    ...WORKFLOW_FIELDS,
+    description: NULLABLE_STRING_SCHEMA,
+    geo: JOB_NIMBUS_GEO_SCHEMA.nullable().optional(),
+    name: z.string(),
+    number: NULLABLE_STRING_SCHEMA,
+    primary: JOB_NIMBUS_REFERENCE_SCHEMA.nullable().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_TASK_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    actualTime: NULLABLE_NUMBER_SCHEMA,
+    dateEnd: DATE_SCHEMA,
+    dateStart: DATE_SCHEMA,
+    description: NULLABLE_STRING_SCHEMA,
+    estimatedTime: NULLABLE_NUMBER_SCHEMA,
+    isCompleted: z.boolean().optional(),
+    number: NULLABLE_STRING_SCHEMA,
+    priority: NULLABLE_NUMBER_SCHEMA,
+    primary: JOB_NIMBUS_REFERENCE_SCHEMA.nullable().optional(),
+    title: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_PRODUCT_UOM_SCHEMA = z
+  .object({
+    labor: z
+      .object({ cost: z.number().optional(), price: z.number().optional() })
+      .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+      .optional(),
+    material: z
+      .object({ cost: z.number().optional(), price: z.number().optional() })
+      .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+      .optional(),
+    uom: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_PRODUCT_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    description: NULLABLE_STRING_SCHEMA,
+    externalId: NULLABLE_STRING_SCHEMA,
+    itemType: z.enum(["labor", "labor+material", "material"]).optional(),
+    locationId: z.number().nullable().optional(),
+    name: z.string(),
+    suppliers: z.array(JOB_NIMBUS_VALUE_SCHEMA).optional(),
+    taxExempt: z.boolean().optional(),
+    uoms: JOB_NIMBUS_PRODUCT_UOM_SCHEMA.array().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_FILE_SCHEMA = z
+  .object({
+    ...CRM_BASE_FIELDS,
+    description: NULLABLE_STRING_SCHEMA,
+    filename: NULLABLE_STRING_SCHEMA,
+    isPrivate: z.boolean().optional(),
+    name: NULLABLE_STRING_SCHEMA,
+    size: NULLABLE_NUMBER_SCHEMA,
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+/**
+ * Wraps a legacy item schema in JobNimbus's offset-page response.
+ *
+ * @param itemSchema - Schema for one legacy result.
+ */
+export function jobNimbusPageSchema<TSchema extends z.ZodType>(
+  itemSchema: TSchema,
+) {
+  return z
+    .object({
+      count: z.number().int().nonnegative(),
+      results: itemSchema.array(),
+    })
+    .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+}
+
+export const JOB_NIMBUS_ACTIVITY_RECORD_INPUT_SCHEMA = z.object({
+  id: JOB_NIMBUS_ID_SCHEMA,
+  type: z.string().trim().min(1),
+})
+
+export const JOB_NIMBUS_ACTIVITY_RECORD_SCHEMA = z.object({
+  ...JOB_NIMBUS_ACTIVITY_RECORD_INPUT_SCHEMA.shape,
+  name: z.string().nullable().optional(),
+})
+
+export const JOB_NIMBUS_ACTIVITY_ACTOR_SCHEMA = z
+  .object({
+    id: JOB_NIMBUS_ID_SCHEMA,
+    name: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_ACTIVITY_SCHEMA = z
+  .object({
+    activityAction: z.string(),
+    activityTypeId: z.number().int(),
+    content: z.string(),
+    createdAt: z
+      .union([z.date(), z.iso.datetime({ offset: true })])
+      .transform((value) => (value instanceof Date ? value : new Date(value))),
+    createdBy: JOB_NIMBUS_ACTIVITY_ACTOR_SCHEMA,
+    hasFiles: z.boolean(),
+    id: JOB_NIMBUS_ID_SCHEMA,
+    isEditable: z.boolean(),
+    isPrivate: z.boolean(),
+    primaryRecord: JOB_NIMBUS_ACTIVITY_RECORD_SCHEMA,
+    relatedRecords: JOB_NIMBUS_ACTIVITY_RECORD_SCHEMA.array(),
+    updatedAt: z
+      .union([z.date(), z.iso.datetime({ offset: true })])
+      .transform((value) => (value instanceof Date ? value : new Date(value))),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_ACTIVITY_TYPE_SCHEMA = z.object({
+  displayName: z.string(),
+  id: z.number().int(),
+  isArchived: z.boolean(),
+  isSystem: z.boolean(),
+})
+
+/**
+ * Wraps a Platform response schema in JobNimbus's data envelope.
+ *
+ * @param dataSchema - Schema for the enveloped data value.
+ */
+export function jobNimbusDataSchema<TSchema extends z.ZodType>(
+  dataSchema: TSchema,
+) {
+  return z.object({ data: dataSchema }).catchall(JOB_NIMBUS_VALUE_SCHEMA)
+}
+
+export const JOB_NIMBUS_ACTIVITY_PAGE_SCHEMA = z
+  .object({
+    data: JOB_NIMBUS_ACTIVITY_SCHEMA.array(),
+    pagination: z.object({
+      nextCursor: z.string().nullable(),
+      pageSize: z.number().int().positive(),
+    }),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_WORKFLOW_STATUS_SCHEMA = z
+  .object({
+    id: z.number().int(),
+    isActive: z.boolean(),
+    isArchived: z.boolean(),
+    isClosed: z.boolean(),
+    isLead: z.boolean(),
+    name: z.string(),
+    order: z.number().int(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_WORKFLOW_SCHEMA = z
+  .object({
+    id: z.number().int(),
+    isActive: z.boolean(),
+    name: z.string(),
+    objectType: z.enum(["contact", "job", "workorder"]),
+    order: z.number().int(),
+    status: JOB_NIMBUS_WORKFLOW_STATUS_SCHEMA.array(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_FILE_TYPE_SCHEMA = z.object({
+  fileTypeId: z.number().int(),
+  isActive: z.boolean(),
+  typeName: z.string(),
+})
+
+export const JOB_NIMBUS_TASK_TYPE_SCHEMA = z.object({
+  defaultName: z.string(),
+  hideFromCalendarView: z.boolean(),
+  hideFromTaskList: z.boolean(),
+  icon: z.string(),
+  isActive: z.boolean(),
+  taskTypeId: z.number().int(),
+  typeName: z.string(),
+})
+
+export const JOB_NIMBUS_LEGACY_ACTIVITY_TYPE_SCHEMA = z.object({
+  activityTypeId: z.number().int(),
+  isActive: z.boolean(),
+  showInJobShare: z.boolean(),
+  typeName: z.string(),
+})
+
+export const JOB_NIMBUS_SOURCE_SCHEMA = z.object({
+  isActive: z.boolean(),
+  jobSourceId: z.number().int(),
+  sourceName: z.string(),
+})
+
+export const JOB_NIMBUS_ACCOUNT_SETTINGS_SCHEMA = z
+  .object({
+    activityTypes: JOB_NIMBUS_LEGACY_ACTIVITY_TYPE_SCHEMA.array().optional(),
+    fileTypes: JOB_NIMBUS_FILE_TYPE_SCHEMA.array().optional(),
+    sources: JOB_NIMBUS_SOURCE_SCHEMA.array().optional(),
+    taskTypes: JOB_NIMBUS_TASK_TYPE_SCHEMA.array().optional(),
+    workflows: JOB_NIMBUS_WORKFLOW_SCHEMA.array().optional(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_GROUP_SCHEMA = z
+  .object({
+    managers: JOB_NIMBUS_ID_SCHEMA.array(),
+    members: JOB_NIMBUS_ID_SCHEMA.array(),
+    name: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_USER_SCHEMA = z
+  .object({
+    calendarColor: NULLABLE_STRING_SCHEMA,
+    email: z.email(),
+    firstName: z.string(),
+    id: JOB_NIMBUS_ID_SCHEMA,
+    imageUrl: NULLABLE_STRING_SCHEMA,
+    isActive: z.boolean(),
+    lastName: z.string(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_USERS_RESPONSE_SCHEMA = z
+  .object({
+    dateUpdated: z.date().optional(),
+    users: JOB_NIMBUS_USER_SCHEMA.array(),
+  })
+  .catchall(JOB_NIMBUS_VALUE_SCHEMA)
+
+export const JOB_NIMBUS_COMPANY_SCHEMA = z.object({
+  companyId: JOB_NIMBUS_ID_SCHEMA,
+  companyLogoUrl: z.string().nullable(),
+  companyName: z.string(),
+  isCurrent: z.boolean(),
+  isPrimary: z.boolean(),
+  lastAccessedAt: z.iso.datetime({ offset: true }).nullable(),
+  userAvatarUrl: z.string().nullable(),
+})

package/src/notion/index.ts

@@ -21,9 +21,11 @@ export const NOTION_WEBHOOK_EVENT_TYPES = [
   "data_source.moved",
   "data_source.schema_updated",
   "data_source.undeleted",
+  "database.content_updated",
   "database.created",
   "database.deleted",
   "database.moved",
+  "database.schema_updated",
   "database.undeleted",
   "file_upload.completed",
   "file_upload.created",
@@ -52,9 +54,11 @@ type NotionSemanticTriggerTypes = {
   readonly "notion.comment.created": "comment.created"
   readonly "notion.comment.deleted": "comment.deleted"
   readonly "notion.comment.updated": "comment.updated"
+  readonly "notion.database.contentUpdated": "database.content_updated"
   readonly "notion.database.created": "database.created"
   readonly "notion.database.deleted": "database.deleted"
   readonly "notion.database.moved": "database.moved"
+  readonly "notion.database.schemaUpdated": "database.schema_updated"
   readonly "notion.database.undeleted": "database.undeleted"
   readonly "notion.dataSource.contentUpdated": "data_source.content_updated"
   readonly "notion.dataSource.created": "data_source.created"
@@ -98,9 +102,11 @@ export const notionEventTypeMap = {
   "data_source.moved": "notion.dataSource.moved",
   "data_source.schema_updated": "notion.dataSource.schemaUpdated",
   "data_source.undeleted": "notion.dataSource.undeleted",
+  "database.content_updated": "notion.database.contentUpdated",
   "database.created": "notion.database.created",
   "database.deleted": "notion.database.deleted",
   "database.moved": "notion.database.moved",
+  "database.schema_updated": "notion.database.schemaUpdated",
   "database.undeleted": "notion.database.undeleted",
   "file_upload.completed": "notion.fileUpload.completed",
   "file_upload.created": "notion.fileUpload.created",
@@ -128,9 +134,13 @@ export const notionTriggerContracts: NotionTriggerContracts = {
   "notion.comment.created": semanticContract("comment.created"),
   "notion.comment.deleted": semanticContract("comment.deleted"),
   "notion.comment.updated": semanticContract("comment.updated"),
+  "notion.database.contentUpdated": semanticContract(
+    "database.content_updated",
+  ),
   "notion.database.created": semanticContract("database.created"),
   "notion.database.deleted": semanticContract("database.deleted"),
   "notion.database.moved": semanticContract("database.moved"),
+  "notion.database.schemaUpdated": semanticContract("database.schema_updated"),
   "notion.database.undeleted": semanticContract("database.undeleted"),
   "notion.dataSource.contentUpdated": semanticContract(
     "data_source.content_updated",

package/src/notion/schemas.ts

@@ -8,9 +8,11 @@ import type {
   DataSourceMovedWebhookPayload,
   DataSourceSchemaUpdatedWebhookPayload,
   DataSourceUndeletedWebhookPayload,
+  DatabaseContentUpdatedWebhookPayload,
   DatabaseCreatedWebhookPayload,
   DatabaseDeletedWebhookPayload,
   DatabaseMovedWebhookPayload,
+  DatabaseSchemaUpdatedWebhookPayload,
   DatabaseUndeletedWebhookPayload,
   FileUploadCompletedWebhookPayload,
   FileUploadCreatedWebhookPayload,
@@ -41,9 +43,11 @@ type OfficialNotionWebhookEvent =
   | DataSourceMovedWebhookPayload
   | DataSourceSchemaUpdatedWebhookPayload
   | DataSourceUndeletedWebhookPayload
+  | DatabaseContentUpdatedWebhookPayload
   | DatabaseCreatedWebhookPayload
   | DatabaseDeletedWebhookPayload
   | DatabaseMovedWebhookPayload
+  | DatabaseSchemaUpdatedWebhookPayload
   | DatabaseUndeletedWebhookPayload
   | FileUploadCompletedWebhookPayload
   | FileUploadCreatedWebhookPayload
@@ -193,6 +197,14 @@ const RAW_NOTION_EVENT_SCHEMA = z.discriminatedUnion("type", [
     DATABASE_ENTITY_SCHEMA,
     PARENT_DATA_SCHEMA,
   ),
+  eventWithDataSchema(
+    "database.content_updated",
+    DATABASE_ENTITY_SCHEMA,
+    z.object({
+      parent: PARENT_SCHEMA,
+      updated_blocks: UPDATED_BLOCK_SCHEMA.array(),
+    }),
+  ),
   eventWithDataSchema(
     "database.created",
     DATABASE_ENTITY_SCHEMA,
@@ -208,6 +220,21 @@ const RAW_NOTION_EVENT_SCHEMA = z.discriminatedUnion("type", [
     DATABASE_ENTITY_SCHEMA,
     PARENT_DATA_SCHEMA,
   ),
+  eventWithDataSchema(
+    "database.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(
     "database.undeleted",
     DATABASE_ENTITY_SCHEMA,