@automate.ax/integration-contracts 0.55.0

package/dist/trello/event-schemas.js

@@ -0,0 +1,233 @@
+import { z } from "zod";
+const TRELLO_JSON_OBJECT_SCHEMA = z.record(z.string(), z.json());
+const TRELLO_RESOURCE_SCHEMA = z
+    .looseObject({
+    id: z.string(),
+    name: z.string().optional(),
+})
+    .catchall(z.json());
+const TRELLO_BOARD_SCHEMA = TRELLO_RESOURCE_SCHEMA.extend({
+    closed: z.boolean().optional(),
+    url: z.string().optional(),
+});
+const TRELLO_CARD_SCHEMA = TRELLO_RESOURCE_SCHEMA.extend({
+    closed: z.boolean().optional(),
+    idShort: z.number().int().optional(),
+    shortLink: z.string().optional(),
+});
+const TRELLO_LIST_SCHEMA = TRELLO_RESOURCE_SCHEMA;
+const TRELLO_MEMBER_SCHEMA = TRELLO_RESOURCE_SCHEMA.extend({
+    fullName: z.string().optional(),
+    username: z.string().optional(),
+});
+const TRELLO_ACTION_DATA_SCHEMA = z
+    .looseObject({
+    /** Attachment affected by the action, when applicable. */
+    attachment: TRELLO_RESOURCE_SCHEMA.extend({
+        url: z.string().optional(),
+    }).optional(),
+    /** Board affected by the action. */
+    board: TRELLO_BOARD_SCHEMA.optional(),
+    /** Card affected by the action, when applicable. */
+    card: TRELLO_CARD_SCHEMA.optional(),
+    /** Checklist affected by the action, when applicable. */
+    checklist: TRELLO_RESOURCE_SCHEMA.optional(),
+    /** Checklist item affected by the action, when applicable. */
+    checkItem: TRELLO_RESOURCE_SCHEMA.optional(),
+    /** List associated with the action. */
+    list: TRELLO_LIST_SCHEMA.optional(),
+    /** Destination list for a move action. */
+    listAfter: TRELLO_LIST_SCHEMA.optional(),
+    /** Source list for a move action. */
+    listBefore: TRELLO_LIST_SCHEMA.optional(),
+    /** Member affected by the action, when applicable. */
+    member: TRELLO_MEMBER_SCHEMA.optional(),
+    /** Previous field values supplied for an update action. */
+    old: TRELLO_JSON_OBJECT_SCHEMA.optional(),
+    /** Organization affected by the action, when applicable. */
+    organization: TRELLO_RESOURCE_SCHEMA.optional(),
+    /** Comment or other action text. */
+    text: z.string().optional(),
+})
+    .catchall(z.json());
+const TRELLO_CARD_ACTION_DATA_SCHEMA = TRELLO_ACTION_DATA_SCHEMA.extend({
+    old: z
+        .looseObject({ closed: z.boolean().optional() })
+        .catchall(z.json())
+        .optional(),
+});
+const TRELLO_WEBHOOK_EVENT_SCHEMA = z.object({
+    action: z
+        .looseObject({
+        data: TRELLO_ACTION_DATA_SCHEMA,
+        date: z.iso.datetime({ offset: true }),
+        id: z.string(),
+        memberCreator: TRELLO_MEMBER_SCHEMA.optional(),
+        type: z.string(),
+    })
+        .catchall(z.json()),
+    model: TRELLO_BOARD_SCHEMA,
+    webhook: z.looseObject({ id: z.string() }).catchall(z.json()),
+});
+const TRELLO_CARD_CREATED_ACTION_SCHEMA = z.enum([
+    "copyCard",
+    "convertToCardFromCheckItem",
+    "createCard",
+    "emailCard",
+]);
+const TRELLO_CARD_UPDATED_ACTION_SCHEMA = z.literal("updateCard");
+const TRELLO_CARD_COMMENTED_ACTION_SCHEMA = z.literal("commentCard");
+export const TRELLO_CARD_EVENT_KINDS = [
+    "created",
+    "moved",
+    "updated",
+    "archived",
+    "commented",
+];
+export const TRELLO_BOARD_EVENT_SCHEMA = TRELLO_ACTION_DATA_SCHEMA.extend({
+    /** Stable ID of the Trello action that caused this event. */
+    actionId: z.string(),
+    /** Trello action category, such as `createCard` or `updateCard`. */
+    actionType: z.string(),
+    /** Board affected by the action, falling back to the watched board. */
+    board: TRELLO_BOARD_SCHEMA,
+    /** Complete provider webhook envelope. */
+    event: TRELLO_WEBHOOK_EVENT_SCHEMA,
+    /** Member responsible for the action, when Trello includes one. */
+    memberCreator: TRELLO_MEMBER_SCHEMA.optional(),
+    /** When the underlying Trello action occurred. */
+    occurredAt: z.iso.datetime({ offset: true }),
+    /** Provider webhook that delivered the event. */
+    webhookId: z.string(),
+});
+export const TRELLO_CARD_EVENT_SCHEMA = z.object({
+    /** Stable ID of the Trello action that caused this event. */
+    actionId: z.string(),
+    /** Provider-native Trello action category. */
+    actionType: z.string(),
+    /** Board containing the affected card. */
+    board: TRELLO_BOARD_EVENT_SCHEMA.shape.board,
+    /** Card affected by the action. */
+    card: TRELLO_CARD_SCHEMA,
+    /** Comment text for card-comment events. */
+    commentText: z.string().optional(),
+    /** Complete provider webhook envelope. */
+    event: TRELLO_WEBHOOK_EVENT_SCHEMA,
+    /** List containing the card after the action. */
+    list: TRELLO_LIST_SCHEMA.optional(),
+    /** Member responsible for the action, when supplied by Trello. */
+    memberCreator: TRELLO_BOARD_EVENT_SCHEMA.shape.memberCreator,
+    /** When the underlying Trello action occurred. */
+    occurredAt: z.iso.datetime({ offset: true }),
+    /** List containing the card before a move. */
+    previousList: TRELLO_LIST_SCHEMA.optional(),
+});
+export const TRELLO_CARD_CREATED_EVENT_SCHEMA = TRELLO_CARD_EVENT_SCHEMA.extend({
+    actionType: TRELLO_CARD_CREATED_ACTION_SCHEMA,
+    event: trelloWebhookEventSchema(TRELLO_CARD_CREATED_ACTION_SCHEMA),
+});
+export const TRELLO_CARD_MOVED_EVENT_SCHEMA = TRELLO_CARD_EVENT_SCHEMA.extend({
+    actionType: TRELLO_CARD_UPDATED_ACTION_SCHEMA,
+    event: trelloWebhookEventSchema(TRELLO_CARD_UPDATED_ACTION_SCHEMA),
+    list: TRELLO_LIST_SCHEMA,
+    previousList: TRELLO_LIST_SCHEMA,
+});
+export const TRELLO_CARD_UPDATED_EVENT_SCHEMA = TRELLO_CARD_EVENT_SCHEMA.extend({
+    actionType: TRELLO_CARD_UPDATED_ACTION_SCHEMA,
+    event: trelloWebhookEventSchema(TRELLO_CARD_UPDATED_ACTION_SCHEMA),
+});
+export const TRELLO_CARD_ARCHIVED_EVENT_SCHEMA = TRELLO_CARD_UPDATED_EVENT_SCHEMA.extend({
+    card: TRELLO_CARD_SCHEMA.extend({ closed: z.literal(true) }),
+});
+export const TRELLO_CARD_COMMENTED_EVENT_SCHEMA = TRELLO_CARD_EVENT_SCHEMA.extend({
+    actionType: TRELLO_CARD_COMMENTED_ACTION_SCHEMA,
+    commentText: z.string(),
+    event: trelloWebhookEventSchema(TRELLO_CARD_COMMENTED_ACTION_SCHEMA),
+});
+/**
+ * Normalizes one provider-native Trello board webhook payload.
+ *
+ * @param value - Untrusted Trello webhook body.
+ */
+export function normalizeTrelloBoardEvent(value) {
+    const event = TRELLO_WEBHOOK_EVENT_SCHEMA.parse(value);
+    return TRELLO_BOARD_EVENT_SCHEMA.parse({
+        ...event.action.data,
+        actionId: event.action.id,
+        actionType: event.action.type,
+        board: { ...event.model, ...event.action.data.board },
+        event,
+        memberCreator: event.action.memberCreator,
+        occurredAt: event.action.date,
+        webhookId: event.webhook.id,
+    });
+}
+/**
+ * Classifies one normalized board action into semantic card event categories.
+ *
+ * A single Trello action can intentionally belong to more than one category;
+ * for example, moving a card is also a card update.
+ *
+ * @param event - Normalized board event received from Trello.
+ */
+export function getTrelloCardEventKinds(event) {
+    const data = TRELLO_CARD_ACTION_DATA_SCHEMA.parse(event.event.action.data);
+    return [
+        ...([
+            "createCard",
+            "copyCard",
+            "convertToCardFromCheckItem",
+            "emailCard",
+        ].includes(event.actionType)
+            ? ["created"]
+            : []),
+        ...(event.actionType === "updateCard" &&
+            data.listBefore !== undefined &&
+            data.listAfter !== undefined
+            ? ["moved"]
+            : []),
+        ...(event.actionType === "updateCard" ? ["updated"] : []),
+        ...(event.actionType === "updateCard" &&
+            data.old?.closed === false &&
+            data.card?.closed === true
+            ? ["archived"]
+            : []),
+        ...(event.actionType === "commentCard" ? ["commented"] : []),
+    ];
+}
+/**
+ * Promotes provider-native card action data into the stable semantic payload.
+ *
+ * @param event - Normalized board event classified as a card event.
+ * @throws When the classified Trello action does not identify a card.
+ */
+export function normalizeTrelloCardEvent(event) {
+    const data = TRELLO_CARD_ACTION_DATA_SCHEMA.parse(event.event.action.data);
+    if (!data.card) {
+        throw new Error(`Trello ${event.actionType} action did not include a card.`);
+    }
+    return TRELLO_CARD_EVENT_SCHEMA.parse({
+        actionId: event.actionId,
+        actionType: event.actionType,
+        board: event.board,
+        card: data.card,
+        commentText: data.text,
+        event: event.event,
+        list: data.listAfter ?? data.list,
+        memberCreator: event.memberCreator,
+        occurredAt: event.occurredAt,
+        previousList: data.listBefore,
+    });
+}
+/**
+ * Narrows the provider action type retained under a semantic event.
+ *
+ * @param actionType - Provider action-type schema for the semantic event.
+ */
+function trelloWebhookEventSchema(actionType) {
+    return TRELLO_WEBHOOK_EVENT_SCHEMA.extend({
+        action: TRELLO_WEBHOOK_EVENT_SCHEMA.shape.action.extend({
+            type: actionType,
+        }),
+    });
+}