@pipedream/trello 0.4.0 → 1.0.0

package/sources/card-archived/card-archived.mjs

@@ -1,11 +1,12 @@
 import common from "../common/common-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   ...common,
   key: "trello-card-archived",
-  name: "Card Archived (Instant)",
+  name: "Card Archived (Instant)", /* eslint-disable-line pipedream/source-name */
   description: "Emit new event for each card archived.",
-  version: "0.1.0",
+  version: "0.1.1",
   type: "source",
   props: {
     ...common.props,
@@ -16,7 +17,6 @@ export default {
       ],
     },
     lists: {
-      optional: true,
       propDefinition: [
         common.props.app,
         "lists",
@@ -24,47 +24,35 @@ export default {
           board: c.board,
         }),
       ],
+      description: "If specified, events will only be emitted when a card in one of the selected lists is archived",
     },
   },
   methods: {
     ...common.methods,
-    getFilteredCards({
-      boardId, ...args
-    } = {}) {
-      return this.app._makeRequest({
-        path: `/boards/${boardId}/cards`,
-        ...args,
-      });
-    },
-    async getSampleEvents() {
-      const cards = await this.getFilteredCards({
+    getSampleEvents() {
+      return this.app.getFilteredCards({
         boardId: this.board,
-        params: {
-          filter: "closed",
-        },
+        filter: "closed",
       });
-      return {
-        sampleEvents: cards,
-        sortField: "dateLastActivity",
-      };
     },
-    isCorrectEventType(event) {
-      const eventTranslationKey = event.body?.action?.display?.translationKey;
-      return eventTranslationKey === "action_archived_card";
+    getSortField() {
+      return "dateLastActivity";
+    },
+    isCorrectEventType({ display }) {
+      return display?.translationKey === "action_archived_card";
     },
-    async getResult(event) {
-      const cardId = event.body?.action?.data?.card?.id;
+    getResult({ data }) {
       return this.app.getCard({
-        cardId,
+        cardId: data?.card?.id,
       });
     },
     isRelevant({ result: card }) {
       return (
         (!this.board || this.board === card.idBoard) &&
-        (!this.lists ||
-          this.lists.length === 0 ||
+        (!this.lists?.length ||
           this.lists.includes(card.idList))
       );
     },
   },
+  sampleEmit,
 };

package/sources/card-archived/test-event.mjs

@@ -0,0 +1,64 @@
+export default {
+  "id": "5f4ee830046a92139596173a",
+  "badges": {
+    "attachmentsByType": {
+      "trello": {
+        "board": 0,
+        "card": 0
+      }
+    },
+    "externalSource": null,
+    "location": false,
+    "votes": 0,
+    "viewingMemberVoted": false,
+    "subscribed": false,
+    "fogbugz": "",
+    "checkItems": 0,
+    "checkItemsChecked": 0,
+    "checkItemsEarliestDue": null,
+    "comments": 0,
+    "attachments": 0,
+    "description": false,
+    "due": null,
+    "dueComplete": false,
+    "start": null,
+    "lastUpdatedByAi": false
+  },
+  "checkItemStates": [],
+  "closed": true,
+  "dueComplete": false,
+  "dateLastActivity": "2020-09-02T00:34:22.602Z",
+  "desc": "",
+  "descData": null,
+  "due": null,
+  "dueReminder": null,
+  "email": null,
+  "idBoard": "5f4d7be6c45c22583f75fa02",
+  "idChecklists": [],
+  "idList": "5f4d7f78bdd7ce4d2d25fdda",
+  "idMembers": [],
+  "idMembersVoted": [],
+  "idShort": 10,
+  "idAttachmentCover": null,
+  "labels": [],
+  "idLabels": [],
+  "manualCoverAttachment": false,
+  "name": "a new card",
+  "pinned": false,
+  "pos": 65535,
+  "shortLink": "eBapV0gL",
+  "shortUrl": "https://trello.com/c/eBapV0gL",
+  "start": null,
+  "subscribed": false,
+  "url": "https://trello.com/c/eBapV0gL/10-a-new-card",
+  "cover": {
+    "idAttachment": null,
+    "color": null,
+    "idUploadedBackground": null,
+    "size": "normal",
+    "brightness": "light",
+    "idPlugin": null
+  },
+  "isTemplate": false,
+  "cardRole": null
+}

package/sources/card-due-date-reminder/card-due-date-reminder.mjs

@@ -1,19 +1,24 @@
+import taskScheduler from "../../../pipedream/sources/new-scheduled-tasks/new-scheduled-tasks.mjs";
+import trello from "../../trello.app.mjs";
 import ms from "ms";
-import common from "../common/common-polling.mjs";
+import constants from "../../common/constants.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
-  ...common,
   key: "trello-card-due-date-reminder",
-  name: "Card Due Date Reminder",
+  name: "Card Due Date Reminder", /* eslint-disable-line pipedream/source-name */
   description: "Emit new event at a specified time before a card is due.",
-  version: "0.1.0",
+  version: "0.1.1",
   type: "source",
   dedupe: "unique",
   props: {
-    ...common.props,
+    pipedream: taskScheduler.props.pipedream,
+    trello,
+    db: "$.service.db",
+    http: "$.interface.http",
     board: {
       propDefinition: [
-        common.props.app,
+        trello,
         "board",
       ],
     },
@@ -22,25 +27,43 @@ export default {
       label: "Time Before",
       description: "How far before the due time the event should trigger. For example, `5 minutes`, `10 minutes`, `1 hour`.",
       default: "5 minutes",
-      options: [
-        "5 minutes",
-        "10 minutes",
-        "15 minutes",
-        "30 minutes",
-        "1 hour",
-        "2 hours",
-        "3 hours",
-        "6 hours",
-        "12 hours",
-        "1 day",
-        "2 days",
-        "3 days",
-        "1 week",
-      ],
+      options: constants.NOTIFICATION_TIMES,
+      reloadProps: true,
+    },
+  },
+  async additionalProps() {
+    const props = {};
+    if (this.timeBefore) {
+      props.timer = {
+        type: "$.interface.timer",
+        description: "Poll the API to schedule alerts for any newly created events",
+        default: {
+          intervalSeconds: ms(this.timeBefore) / 1000,
+        },
+      };
+    }
+    return props;
+  },
+  hooks: {
+    async deactivate() {
+      const ids = this._getScheduledEventIds();
+      if (!ids?.length) {
+        return;
+      }
+      for (const id of ids) {
+        if (await this.deleteEvent({
+          body: {
+            id,
+          },
+        })) {
+          console.log("Cancelled scheduled event");
+        }
+      }
+      this._setScheduledEventIds();
     },
   },
   methods: {
-    ...common.methods,
+    ...taskScheduler.methods,
     generateMeta({
       id, name: summary,
     }, now) {
@@ -50,32 +73,87 @@ export default {
         ts: now,
       };
     },
+    _getScheduledEventIds() {
+      return this.db.get("scheduledEventIds");
+    },
+    _setScheduledEventIds(ids) {
+      this.db.set("scheduledEventIds", ids);
+    },
+    _getScheduledCardIds() {
+      return this.db.get("scheduledCardIds");
+    },
+    _setScheduledCardIds(ids) {
+      this.db.set("scheduledCardIds", ids);
+    },
+    _hasDeployed() {
+      const result = this.db.get("hasDeployed");
+      this.db.set("hasDeployed", true);
+      return result;
+    },
     emitEvent(card, now) {
       const meta = this.generateMeta(card, now);
       this.$emit(card, meta);
     },
   },
   async run(event) {
-    const boardId = this.board;
     const now = event.timestamp * 1000;
 
-    const timeBeforeMs = ms(this.timeBefore);
-    if (!timeBeforeMs) {
-      throw new Error(`Invalid timeBefore value: ${this.timeBefore}`);
+    // self subscribe only on the first time
+    if (!this._hasDeployed()) {
+      await this.selfSubscribe();
+    }
+
+    let scheduledEventIds = this._getScheduledEventIds() || [];
+
+    // incoming scheduled event
+    if (event.$channel === this.selfChannel()) {
+      const remainingScheduledEventIds = scheduledEventIds.filter((id) => id !== event["$id"]);
+      this._setScheduledEventIds(remainingScheduledEventIds);
+      this.emitEvent(event, now);
+      return;
     }
 
-    const cards = await this.app.getCards({
-      boardId,
+    // schedule new events
+    const scheduledCardIds = this._getScheduledCardIds() || {};
+    const cards = await this.trello.getCards({
+      boardId: this.board,
     });
+
     for (const card of cards) {
-      if (!card.due) {
+      const dueDate = card.due
+        ? new Date(card.due)
+        : null;
+      if (!dueDate || dueDate.getTime() < Date.now()) {
+        delete scheduledCardIds[card.id];
         continue;
       }
-      const due = Date.parse(card.due);
-      const notifyAt = due - timeBeforeMs;
-      if (notifyAt <= now) {
-        this.emitEvent(card, now);
+
+      const later = new Date(dueDate.getTime() - ms(this.timeBefore));
+
+      if (scheduledCardIds[card.id]) {
+        // reschedule if card's due date has changed
+        if (card.due !== scheduledCardIds[card.id].dueDate) {
+          await this.deleteEvent({
+            body: {
+              id: scheduledCardIds[card.id].eventId,
+            },
+          });
+          scheduledEventIds = scheduledEventIds
+            .filter((id) => id !== scheduledCardIds[card.id].eventId);
+        } else {
+          continue;
+        }
       }
+
+      const scheduledEventId = this.emitScheduleEvent(card, later);
+      scheduledEventIds.push(scheduledEventId);
+      scheduledCardIds[card.id] = {
+        eventId: scheduledEventId,
+        dueDate: card.due,
+      };
     }
+    this._setScheduledEventIds(scheduledEventIds);
+    this._setScheduledCardIds(scheduledCardIds);
   },
+  sampleEmit,
 };

package/sources/card-due-date-reminder/test-event.mjs

@@ -0,0 +1,75 @@
+export default {
+  "id": "61818a303e545129af23695d",
+  "badges": {
+    "attachmentsByType": {
+      "trello": {
+        "board": 0,
+        "card": 0
+      }
+    },
+    "externalSource": null,
+    "location": false,
+    "votes": 0,
+    "viewingMemberVoted": false,
+    "subscribed": true,
+    "fogbugz": "",
+    "checkItems": 1,
+    "checkItemsChecked": 1,
+    "checkItemsEarliestDue": null,
+    "comments": 2,
+    "attachments": 1,
+    "description": false,
+    "due": "2024-10-01T19:20:00.000Z",
+    "dueComplete": false,
+    "start": null,
+    "lastUpdatedByAi": false
+  },
+  "checkItemStates": [
+    {
+      "idCheckItem": "6181a5f18e239e6aff9799a4",
+      "state": "complete"
+    }
+  ],
+  "closed": false,
+  "dueComplete": false,
+  "dateLastActivity": "2024-10-01T19:08:51.312Z",
+  "desc": "",
+  "descData": {
+    "emoji": {}
+  },
+  "due": "2024-10-01T19:20:00.000Z",
+  "dueReminder": -1,
+  "email": null,
+  "idBoard": "5f4d7be6c45c22583f75fa02",
+  "idChecklists": [
+    "6181a5ef401ae66c357732b4"
+  ],
+  "idList": "5f4d7f78bdd7ce4d2d25fdda",
+  "idMembers": [],
+  "idMembersVoted": [],
+  "idShort": 68,
+  "idAttachmentCover": "62c884dce32d46579ecfd5f0",
+  "labels": [],
+  "idLabels": [],
+  "manualCoverAttachment": false,
+  "name": "test",
+  "pinned": false,
+  "pos": 131071,
+  "shortLink": "QVLahShU",
+  "shortUrl": "https://trello.com/c/QVLahShU",
+  "start": null,
+  "subscribed": true,
+  "url": "https://trello.com/c/QVLahShU/68-sfsfdsfd",
+  "cover": {
+    "idAttachment": "62c884dce32d46579ecfd5f0",
+    "color": null,
+    "idUploadedBackground": null,
+    "size": "normal",
+    "brightness": "dark",
+    "idPlugin": null
+  },
+  "isTemplate": false,
+  "cardRole": null,
+  "$channel": "self",
+  "$id": "62377726-40b9-41a8-85c7-b01f3f5f8fbe"
+}

package/sources/card-moved/card-moved.mjs

@@ -1,11 +1,12 @@
 import common from "../common/common-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   ...common,
   key: "trello-card-moved",
-  name: "Card Moved (Instant)",
+  name: "Card Moved (Instant)", /* eslint-disable-line pipedream/source-name */
   description: "Emit new event each time a card is moved to a list.",
-  version: "0.1.0",
+  version: "0.1.1",
   type: "source",
   props: {
     ...common.props,
@@ -23,22 +24,23 @@ export default {
           board: c.board,
         }),
       ],
+      description: "If specified, events will only be emitted if a card is moved to or from one of the selected lists",
     },
   },
   methods: {
     ...common.methods,
     async getSampleEvents() {
-      const cards = this.lists && this.lists.length > 0
+      const cards = this.lists?.length > 0
         ? await this.app.getCardsInList({
           listId: this.lists[0],
         })
         : await this.app.getCards({
           boardId: this.board,
         });
-      return {
-        sampleEvents: cards,
-        sortFilter: "dateLastActivity",
-      };
+      return cards;
+    },
+    getSortField() {
+      return "dateLastActivity";
     },
     _getListAfter() {
       return this.db.get("listAfter");
@@ -46,37 +48,31 @@ export default {
     _setListAfter(listAfter) {
       this.db.set("listAfter", listAfter);
     },
-    isCorrectEventType(event) {
-      const eventTranslationKey = event.body?.action?.display?.translationKey;
-      return eventTranslationKey === "action_move_card_from_list_to_list";
+    isCorrectEventType({ display }) {
+      return display?.translationKey === "action_move_card_from_list_to_list";
     },
-    async getResult(event) {
-      const cardId = event.body?.action?.data?.card?.id;
-      const listAfter = event.body?.action?.data?.listAfter?.name;
+    getResult({ data }) {
       /** Record listAfter to use in generateMeta() */
-      this._setListAfter(listAfter);
+      this._setListAfter(data?.listAfter?.name);
       return this.app.getCard({
-        cardId,
+        cardId: data?.card?.id,
       });
     },
     isRelevant({
-      result: card, event,
+      result: card, action,
     }) {
-      const listIdAfter = event.body?.action?.data?.listAfter?.id;
-      const listIdBefore = event.body?.action?.data?.listBefore?.id;
-
       return (
         (!this.board || this.board === card.idBoard) &&
-        (!this.lists ||
-          this.lists.length === 0 ||
-          this.lists.includes(listIdAfter) ||
-          this.lists.includes(listIdBefore))
+        (!this.lists?.length ||
+          this.lists.includes(action?.data?.listAfter?.id) ||
+          this.lists.includes(action?.data?.listBefore?.id))
       );
     },
     generateMeta({
       id, name,
     }) {
       const listAfter = this._getListAfter();
+      name = name || id;
       const summary = listAfter
         ? `${name} - moved to ${listAfter}`
         : name;
@@ -87,4 +83,5 @@ export default {
       };
     },
   },
+  sampleEmit,
 };

package/sources/card-moved/test-event.mjs

@@ -0,0 +1,78 @@
+export default {
+  "id": "60836bac2ed2ef78f4cf850d",
+  "badges": {
+    "attachmentsByType": {
+      "trello": {
+        "board": 0,
+        "card": 0
+      }
+    },
+    "externalSource": null,
+    "location": false,
+    "votes": 0,
+    "viewingMemberVoted": false,
+    "subscribed": true,
+    "fogbugz": "",
+    "checkItems": 1,
+    "checkItemsChecked": 0,
+    "checkItemsEarliestDue": null,
+    "comments": 3,
+    "attachments": 1,
+    "description": false,
+    "due": "2021-05-10T21:50:00.000Z",
+    "dueComplete": false,
+    "start": null,
+    "lastUpdatedByAi": false
+  },
+  "checkItemStates": [],
+  "closed": false,
+  "dueComplete": false,
+  "dateLastActivity": "2021-11-02T23:02:44.876Z",
+  "desc": "",
+  "descData": null,
+  "due": "2021-05-10T21:50:00.000Z",
+  "dueReminder": 1440,
+  "email": null,
+  "idBoard": "5f4d7be6c45c22583f75fa02",
+  "idChecklists": [
+    "608b2037ea7ac07da59c17be"
+  ],
+  "idList": "5f4ec9f69028408fed04c0b1",
+  "idMembers": [],
+  "idMembersVoted": [],
+  "idShort": 54,
+  "idAttachmentCover": "6099aece406c0b7a97e71535",
+  "labels": [
+    {
+      "id": "608b2273586147300cc73046",
+      "idBoard": "5f4d7be6c45c22583f75fa02",
+      "idOrganization": "6047c17c2f558003144e04d7",
+      "name": "orange",
+      "nodeId": "ari:cloud:trello::label/workspace/6047c17c2f558003144e04d7/608b2273586147300cc73046",
+      "color": "orange",
+      "uses": 4
+    },
+  ],
+  "idLabels": [
+    "608b2273586147300cc73046",
+  ],
+  "manualCoverAttachment": false,
+  "name": "new card",
+  "pinned": false,
+  "pos": 655359,
+  "shortLink": "fo2GH2y2",
+  "shortUrl": "https://trello.com/c/fo2GH2y2",
+  "start": null,
+  "subscribed": true,
+  "url": "https://trello.com/c/fo2GH2y2/54-new-card",
+  "cover": {
+    "idAttachment": "6099aece406c0b7a97e71535",
+    "color": null,
+    "idUploadedBackground": null,
+    "size": "normal",
+    "brightness": "dark",
+    "idPlugin": null
+  },
+  "isTemplate": false,
+  "cardRole": null
+}

package/sources/card-updates/card-updates.mjs

@@ -1,11 +1,12 @@
 import common from "../common/common-webhook.mjs";
+import sampleEmit from "./test-event.mjs";
 
 export default {
   ...common,
   key: "trello-card-updates",
-  name: "Card Updates (Instant)",
+  name: "Card Updated (Instant)", /* eslint-disable-line pipedream/source-name */
   description: "Emit new event for each update to a Trello card.",
-  version: "0.1.0",
+  version: "0.1.1",
   type: "source",
   props: {
     ...common.props,
@@ -24,58 +25,50 @@ export default {
         }),
       ],
     },
-    customFieldItems: {
-      propDefinition: [
-        common.props.app,
-        "customFieldItems",
-      ],
-    },
   },
   methods: {
     ...common.methods,
     async getSampleEvents() {
       let cards = [];
-      if (this.cards && this.cards.length > 0) {
+      const params = {
+        customFieldItems: true,
+      };
+      if (this.cards?.length > 0) {
         for (const cardId of this.cards) {
           const card = await this.app.getCard({
             cardId,
-            params: {
-              customFieldItems: this.customFieldItems,
-            },
+            params,
           });
           cards.push(card);
         }
       } else {
         cards = await this.app.getCards({
           boardId: this.board,
-          params: {
-            customFieldItems: this.customFieldItems,
-          },
+          params,
         });
       }
-      return {
-        sampleEvents: cards,
-        sortField: "dateLastActivity",
-      };
+      return cards;
+    },
+    getSortField() {
+      return "dateLastActivity";
     },
-    isCorrectEventType(event) {
-      const eventType = event.body?.action?.type;
-      return eventType === "updateCard";
+    isCorrectEventType({ type }) {
+      return type === "updateCard";
     },
-    async getResult(event) {
-      const cardId = event.body?.action?.data?.card?.id;
+    getResult({ data }) {
       return this.app.getCard({
-        cardId,
+        cardId: data?.card?.id,
         params: {
-          customFieldItems: this.customFieldItems,
+          customFieldItems: true,
         },
       });
     },
     isRelevant({ result: card }) {
       return (
         (!this.board || this.board === card.idBoard) &&
-        (!this.cards || this.cards.length === 0 || this.cards.includes(card.id))
+        (!this.cards?.length || this.cards.includes(card.id))
       );
     },
   },
+  sampleEmit,
 };