@automate.ax/integration-contracts 0.110.0 → 0.111.0

package/src/asana/schemas.ts

@@ -1,20 +1,14 @@
 import * as z from "zod"
-
-export const ASANA_RESOURCE_SCHEMA = z.object({
-  /** Stable Asana globally unique identifier. */
-  id: z.string(),
-
-  /** Human-readable resource name, when available. */
-  name: z.string().optional(),
-
-  /** Provider resource type. */
-  type: z.string().optional(),
-})
-
-export const ASANA_PAGE_INFO_SCHEMA = z.object({
-  /** Opaque token for the next page, when more results are available. */
-  nextOffset: z.string().optional(),
-})
+import {
+  ASANA_PROVIDER_RESOURCE_SCHEMA,
+  ASANA_RESOURCE_SCHEMA,
+  toAsanaResource,
+} from "./base"
+import {
+  ASANA_CUSTOM_FIELD_VALUE_SCHEMA,
+  ASANA_PROVIDER_CUSTOM_FIELD_VALUE_SCHEMA,
+  toAsanaCustomFieldValue,
+} from "./resources"
 
 export const ASANA_WORKSPACE_SCHEMA = ASANA_RESOURCE_SCHEMA.extend({
   /** Domains associated with this workspace. */
@@ -114,8 +108,8 @@ export const ASANA_TASK_SCHEMA = ASANA_RESOURCE_SCHEMA.extend({
   /** User who created the task. */
   createdBy: ASANA_RESOURCE_SCHEMA.optional(),
 
-  /** Provider-native custom field values. */
-  customFields: z.json().array(),
+  /** Typed custom field values with camelCase nested fields. */
+  customFields: ASANA_CUSTOM_FIELD_VALUE_SCHEMA.array(),
 
   /** Task due timestamp, for tasks with a due time. */
   dueAt: z.string().optional(),
@@ -325,22 +319,6 @@ export const ASANA_COMMENT_ADDED_EVENT_SCHEMA = ASANA_STORY_SCHEMA.extend({
   type: z.literal("story"),
 })
 
-export const ASANA_PROVIDER_RESOURCE_SCHEMA = z.looseObject({
-  gid: z.string(),
-  name: z.string().optional(),
-  resource_subtype: z.string().optional(),
-  resource_type: z.string().optional(),
-})
-
-export const ASANA_PROVIDER_PAGE_SCHEMA = z.looseObject({
-  next_page: z
-    .looseObject({
-      offset: z.string(),
-    })
-    .nullable()
-    .optional(),
-})
-
 const ASANA_PROVIDER_MEMBERSHIP_SCHEMA = z.looseObject({
   project: ASANA_PROVIDER_RESOURCE_SCHEMA,
   section: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
@@ -348,8 +326,8 @@ const ASANA_PROVIDER_MEMBERSHIP_SCHEMA = z.looseObject({
 
 export const ASANA_PROVIDER_WORKSPACE_SCHEMA =
   ASANA_PROVIDER_RESOURCE_SCHEMA.extend({
-    email_domains: z.string().array().prefault([]),
-    is_organization: z.boolean().prefault(false),
+    email_domains: z.string().array(),
+    is_organization: z.boolean(),
   })
 
 export const ASANA_PROVIDER_USER_SCHEMA = ASANA_PROVIDER_RESOURCE_SCHEMA.extend(
@@ -360,13 +338,13 @@ export const ASANA_PROVIDER_USER_SCHEMA = ASANA_PROVIDER_RESOURCE_SCHEMA.extend(
         image_128x128: z.string().optional(),
       })
       .nullish(),
-    workspaces: ASANA_PROVIDER_RESOURCE_SCHEMA.array().prefault([]),
+    workspaces: ASANA_PROVIDER_RESOURCE_SCHEMA.array(),
   },
 )
 
 export const ASANA_PROVIDER_PROJECT_SCHEMA =
   ASANA_PROVIDER_RESOURCE_SCHEMA.extend({
-    archived: z.boolean().prefault(false),
+    archived: z.boolean(),
     color: z.string().nullish(),
     created_at: z.string().optional(),
     default_view: z.string().optional(),
@@ -375,7 +353,7 @@ export const ASANA_PROVIDER_PROJECT_SCHEMA =
     modified_at: z.string().optional(),
     notes: z.string().optional(),
     permalink_url: z.string().optional(),
-    public: z.boolean().prefault(false),
+    public: z.boolean(),
     start_on: z.string().nullish(),
     team: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
     workspace: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
@@ -391,26 +369,26 @@ export const ASANA_PROVIDER_TASK_SCHEMA = ASANA_PROVIDER_RESOURCE_SCHEMA.extend(
   {
     assignee: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
     assignee_status: z.string().optional(),
-    completed: z.boolean().prefault(false),
+    completed: z.boolean(),
     completed_at: z.string().nullish(),
     completed_by: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
     created_at: z.string().optional(),
     created_by: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
-    custom_fields: z.json().array().prefault([]),
+    custom_fields: ASANA_PROVIDER_CUSTOM_FIELD_VALUE_SCHEMA.array().optional(),
     due_at: z.string().nullish(),
     due_on: z.string().nullish(),
-    followers: ASANA_PROVIDER_RESOURCE_SCHEMA.array().prefault([]),
+    followers: ASANA_PROVIDER_RESOURCE_SCHEMA.array(),
     html_notes: z.string().optional(),
-    memberships: ASANA_PROVIDER_MEMBERSHIP_SCHEMA.array().prefault([]),
+    memberships: ASANA_PROVIDER_MEMBERSHIP_SCHEMA.array(),
     modified_at: z.string().optional(),
     notes: z.string().optional(),
     parent: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
     permalink_url: z.string().optional(),
-    projects: ASANA_PROVIDER_RESOURCE_SCHEMA.array().prefault([]),
+    projects: ASANA_PROVIDER_RESOURCE_SCHEMA.array(),
     resource_subtype: z.string().optional(),
     start_at: z.string().nullish(),
     start_on: z.string().nullish(),
-    tags: ASANA_PROVIDER_RESOURCE_SCHEMA.array().prefault([]),
+    tags: ASANA_PROVIDER_RESOURCE_SCHEMA.array(),
     workspace: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
   },
 )
@@ -420,10 +398,10 @@ export const ASANA_PROVIDER_STORY_SCHEMA =
     created_at: z.string().optional(),
     created_by: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
     html_text: z.string().optional(),
-    is_edited: z.boolean().prefault(false),
-    is_pinned: z.boolean().prefault(false),
+    is_edited: z.boolean(),
+    is_pinned: z.boolean(),
     resource_subtype: z.string().optional(),
-    text: z.string().prefault(""),
+    text: z.string(),
   })
 
 const ASANA_PROVIDER_EVENT_CHANGE_SCHEMA = z.looseObject({
@@ -444,32 +422,6 @@ export const ASANA_PROVIDER_EVENT_SCHEMA = z.looseObject({
   user: ASANA_PROVIDER_RESOURCE_SCHEMA.nullish(),
 })
 
-/**
- * Converts an Asana compact resource to the public camel-cased shape.
- *
- * @param value - Provider-native compact resource.
- */
-export function toAsanaResource(
-  value: z.output<typeof ASANA_PROVIDER_RESOURCE_SCHEMA>,
-) {
-  return {
-    id: value.gid,
-    name: value.name,
-    type: value.resource_type,
-  }
-}
-
-/**
- * Converts Asana offset pagination metadata.
- *
- * @param value - Provider-native response page.
- */
-export function toAsanaPageInfo(
-  value: z.output<typeof ASANA_PROVIDER_PAGE_SCHEMA>,
-) {
-  return { nextOffset: value.next_page?.offset }
-}
-
 /**
  * Converts an Asana workspace to the public camel-cased shape.
  *
@@ -561,7 +513,7 @@ export function toAsanaTask(
       : undefined,
     createdAt: value.created_at,
     createdBy: value.created_by ? toAsanaResource(value.created_by) : undefined,
-    customFields: value.custom_fields,
+    customFields: (value.custom_fields ?? []).map(toAsanaCustomFieldValue),
     dueAt: value.due_at ?? undefined,
     dueOn: value.due_on ?? undefined,
     followers: value.followers.map(toAsanaResource),
@@ -616,10 +568,10 @@ export function normalizeAsanaEvent(value: unknown, watchedResourceId: string) {
     change: event.change
       ? {
           action: event.change.action,
-          addedValue: event.change.added_value,
-          field: event.change.field,
-          newValue: event.change.new_value,
-          removedValue: event.change.removed_value,
+          addedValue: camelCaseAsanaValue(event.change.added_value),
+          field: camelCaseAsanaKey(event.change.field),
+          newValue: camelCaseAsanaValue(event.change.new_value),
+          removedValue: camelCaseAsanaValue(event.change.removed_value),
         }
       : undefined,
     createdAt: event.created_at,
@@ -653,3 +605,49 @@ export function normalizeAsanaTask(value: unknown) {
     toAsanaTask(ASANA_PROVIDER_TASK_SCHEMA.parse(value)),
   )
 }
+
+/**
+ * Converts arbitrary provider JSON keys to camelCase recursively.
+ *
+ * @param value - Provider value to normalize.
+ */
+export function camelCaseAsanaValue(value: unknown): unknown {
+  if (Array.isArray(value)) return value.map(camelCaseAsanaValue)
+  if (value === null || typeof value !== "object") return value
+  const gid = "gid" in value ? value.gid : undefined
+  const name = "name" in value ? value.name : undefined
+  const resourceType =
+    "resource_type" in value ? value.resource_type : undefined
+  if (typeof gid === "string" && "resource_type" in value) {
+    return {
+      ...Object.fromEntries(
+        Object.entries(value)
+          .filter(([key]) => !["gid", "name", "resource_type"].includes(key))
+          .map(([key, item]) => [
+            camelCaseAsanaKey(key),
+            camelCaseAsanaValue(item),
+          ]),
+      ),
+      id: gid,
+      ...(typeof name === "string" && { name }),
+      ...(typeof resourceType === "string" && { type: resourceType }),
+    }
+  }
+  return Object.fromEntries(
+    Object.entries(value).map(([key, item]) => [
+      camelCaseAsanaKey(key),
+      camelCaseAsanaValue(item),
+    ]),
+  )
+}
+
+/**
+ * Converts one snake_case provider key to camelCase.
+ *
+ * @param value - Provider key.
+ */
+function camelCaseAsanaKey(value: string) {
+  return value.replace(/_([a-z0-9])/g, (_, character: string) =>
+    character.toUpperCase(),
+  )
+}

package/src/asana/semantic-events.ts

@@ -0,0 +1,201 @@
+import * as z from "zod"
+import { ASANA_RESOURCE_SCHEMA } from "./base"
+import {
+  ASANA_EVENT_CHANGE_SCHEMA,
+  ASANA_EVENT_SCHEMA,
+  ASANA_TASK_SCHEMA,
+} from "./schemas"
+
+/**
+ * Builds a lifecycle-event schema for one resource and action.
+ *
+ * @param resourceType - Provider resource category.
+ * @param action - Provider lifecycle action.
+ */
+function resourceEventSchema<
+  TResourceType extends string,
+  TAction extends string,
+>(resourceType: TResourceType, action: TAction) {
+  return ASANA_RESOURCE_SCHEMA.extend({
+    event: ASANA_EVENT_SCHEMA.extend({
+      action: z.literal(action),
+      resourceType: z.literal(resourceType),
+    }),
+    type: z.literal(resourceType),
+  })
+}
+
+/**
+ * Builds a field-change event schema for one resource field.
+ *
+ * @param resourceType - Provider resource category.
+ * @param field - Normalized changed field.
+ * @param changeAction - Provider field-change action.
+ */
+function changedFieldEventSchema<
+  TResourceType extends string,
+  TField extends string,
+  TChangeAction extends "added" | "changed" | "removed",
+>(resourceType: TResourceType, field: TField, changeAction: TChangeAction) {
+  return ASANA_RESOURCE_SCHEMA.extend({
+    event: ASANA_EVENT_SCHEMA.extend({
+      action: z.literal("changed"),
+      change: ASANA_EVENT_CHANGE_SCHEMA.extend({
+        action: z.literal(changeAction),
+        field: z.literal(field),
+      }),
+      resourceType: z.literal(resourceType),
+    }),
+    type: z.literal(resourceType),
+  })
+}
+
+export const ASANA_TASK_RESTORED_EVENT_SCHEMA = resourceEventSchema(
+  "task",
+  "undeleted",
+)
+const ASANA_TASK_COMPLETION_CHANGED_EVENT_SCHEMA = ASANA_EVENT_SCHEMA.extend({
+  action: z.literal("changed"),
+  change: ASANA_EVENT_CHANGE_SCHEMA.extend({
+    action: z.literal("changed"),
+    field: z.literal("completed"),
+  }),
+  resourceType: z.literal("task"),
+})
+export const ASANA_TASK_INCOMPLETE_EVENT_SCHEMA = ASANA_TASK_SCHEMA.extend({
+  completed: z.literal(false),
+  event: ASANA_TASK_COMPLETION_CHANGED_EVENT_SCHEMA,
+  type: z.literal("task"),
+})
+const ASANA_TASK_ASSIGNEE_CHANGED_EVENT_SCHEMA = ASANA_EVENT_SCHEMA.extend({
+  action: z.literal("changed"),
+  change: ASANA_EVENT_CHANGE_SCHEMA.extend({
+    action: z.literal("changed"),
+    field: z.literal("assignee"),
+  }),
+  resourceType: z.literal("task"),
+})
+export const ASANA_TASK_ASSIGNED_EVENT_SCHEMA = ASANA_RESOURCE_SCHEMA.extend({
+  event: ASANA_TASK_ASSIGNEE_CHANGED_EVENT_SCHEMA.extend({
+    change: ASANA_TASK_ASSIGNEE_CHANGED_EVENT_SCHEMA.shape.change.extend({
+      newValue: ASANA_RESOURCE_SCHEMA,
+    }),
+  }),
+  type: z.literal("task"),
+})
+export const ASANA_TASK_UNASSIGNED_EVENT_SCHEMA = ASANA_RESOURCE_SCHEMA.extend({
+  event: ASANA_TASK_ASSIGNEE_CHANGED_EVENT_SCHEMA.extend({
+    change: ASANA_TASK_ASSIGNEE_CHANGED_EVENT_SCHEMA.shape.change.extend({
+      newValue: z.null().optional(),
+    }),
+  }),
+  type: z.literal("task"),
+})
+export const ASANA_TASK_DUE_DATE_CHANGED_EVENT_SCHEMA = z.union([
+  changedFieldEventSchema("task", "dueAt", "changed"),
+  changedFieldEventSchema("task", "dueOn", "changed"),
+])
+export const ASANA_TASK_FOLLOWER_ADDED_EVENT_SCHEMA = changedFieldEventSchema(
+  "task",
+  "followers",
+  "added",
+)
+export const ASANA_TASK_FOLLOWER_REMOVED_EVENT_SCHEMA = changedFieldEventSchema(
+  "task",
+  "followers",
+  "removed",
+)
+export const ASANA_TASK_PROJECT_ADDED_EVENT_SCHEMA = changedFieldEventSchema(
+  "task",
+  "projects",
+  "added",
+)
+export const ASANA_TASK_PROJECT_REMOVED_EVENT_SCHEMA = changedFieldEventSchema(
+  "task",
+  "projects",
+  "removed",
+)
+export const ASANA_TASK_TAG_ADDED_EVENT_SCHEMA = changedFieldEventSchema(
+  "task",
+  "tags",
+  "added",
+)
+export const ASANA_TASK_TAG_REMOVED_EVENT_SCHEMA = changedFieldEventSchema(
+  "task",
+  "tags",
+  "removed",
+)
+
+export const ASANA_COMMENT_UPDATED_EVENT_SCHEMA = resourceEventSchema(
+  "story",
+  "changed",
+)
+export const ASANA_COMMENT_DELETED_EVENT_SCHEMA = resourceEventSchema(
+  "story",
+  "removed",
+)
+export const ASANA_COMMENT_RESTORED_EVENT_SCHEMA = resourceEventSchema(
+  "story",
+  "undeleted",
+)
+
+export const ASANA_SECTION_ADDED_EVENT_SCHEMA = resourceEventSchema(
+  "section",
+  "added",
+)
+export const ASANA_SECTION_CHANGED_EVENT_SCHEMA = resourceEventSchema(
+  "section",
+  "changed",
+)
+export const ASANA_SECTION_DELETED_EVENT_SCHEMA = resourceEventSchema(
+  "section",
+  "deleted",
+)
+export const ASANA_SECTION_RESTORED_EVENT_SCHEMA = resourceEventSchema(
+  "section",
+  "undeleted",
+)
+
+export const ASANA_PROJECT_ADDED_EVENT_SCHEMA = resourceEventSchema(
+  "project",
+  "added",
+)
+export const ASANA_PROJECT_CHANGED_EVENT_SCHEMA = resourceEventSchema(
+  "project",
+  "changed",
+)
+export const ASANA_PROJECT_REMOVED_EVENT_SCHEMA = resourceEventSchema(
+  "project",
+  "removed",
+)
+export const ASANA_PROJECT_DELETED_EVENT_SCHEMA = resourceEventSchema(
+  "project",
+  "deleted",
+)
+export const ASANA_PROJECT_RESTORED_EVENT_SCHEMA = resourceEventSchema(
+  "project",
+  "undeleted",
+)
+
+export const ASANA_ATTACHMENT_DELETED_EVENT_SCHEMA = resourceEventSchema(
+  "attachment",
+  "deleted",
+)
+export const ASANA_ATTACHMENT_RESTORED_EVENT_SCHEMA = resourceEventSchema(
+  "attachment",
+  "undeleted",
+)
+
+export const ASANA_TAG_ADDED_EVENT_SCHEMA = resourceEventSchema("tag", "added")
+export const ASANA_TAG_CHANGED_EVENT_SCHEMA = resourceEventSchema(
+  "tag",
+  "changed",
+)
+export const ASANA_TAG_DELETED_EVENT_SCHEMA = resourceEventSchema(
+  "tag",
+  "deleted",
+)
+export const ASANA_TAG_RESTORED_EVENT_SCHEMA = resourceEventSchema(
+  "tag",
+  "undeleted",
+)