@pipedream/trello 0.3.14 → 0.4.1

package/sources/common/actions.mjs

@@ -0,0 +1,206 @@
+export default [
+  {
+    label: "Accept Enterprise Join Request",
+    value: "acceptEnterpriseJoinRequest",
+  },
+  {
+    label: "Add Attachment To Card",
+    value: "addAttachmentToCard",
+  },
+  {
+    label: "Add Checklist To Card",
+    value: "addChecklistToCard",
+  },
+  {
+    label: "Add Member To Board",
+    value: "addMemberToBoard",
+  },
+  {
+    label: "Add Member To Card",
+    value: "addMemberToCard",
+  },
+  {
+    label: "Add Member To Organization",
+    value: "addMemberToOrganization",
+  },
+  {
+    label: "Add Organization To Enterprise",
+    value: "addOrganizationToEnterprise",
+  },
+  {
+    label: "Add To Enterprise Plugin Whitelist",
+    value: "addToEnterprisePluginWhitelist",
+  },
+  {
+    label: "Add To Organization Board",
+    value: "addToOrganizationBoard",
+  },
+  {
+    label: "Comment Card",
+    value: "commentCard",
+  },
+  {
+    label: "Convert To Card From Check Item",
+    value: "convertToCardFromCheckItem",
+  },
+  {
+    label: "Copy Board",
+    value: "copyBoard",
+  },
+  {
+    label: "Copy Card",
+    value: "copyCard",
+  },
+  {
+    label: "Copy Comment Card",
+    value: "copyCommentCard",
+  },
+  {
+    label: "Create Board",
+    value: "createBoard",
+  },
+  {
+    label: "Create Card",
+    value: "createCard",
+  },
+  {
+    label: "Create List",
+    value: "createList",
+  },
+  {
+    label: "Create Organization",
+    value: "createOrganization",
+  },
+  {
+    label: "Delete Board Invitation",
+    value: "deleteBoardInvitation",
+  },
+  {
+    label: "Delete Card",
+    value: "deleteCard",
+  },
+  {
+    label: "Delete Organization Invitation",
+    value: "deleteOrganizationInvitation",
+  },
+  {
+    label: "Disable Enterprise Plugin Whitelist",
+    value: "disableEnterprisePluginWhitelist",
+  },
+  {
+    label: "Disable Plugin",
+    value: "disablePlugin",
+  },
+  {
+    label: "Disable Power Up",
+    value: "disablePowerUp",
+  },
+  {
+    label: "Email Card",
+    value: "emailCard",
+  },
+  {
+    label: "Enable Enterprise Plugin Whitelist",
+    value: "enableEnterprisePluginWhitelist",
+  },
+  {
+    label: "Enable Plugin",
+    value: "enablePlugin",
+  },
+  {
+    label: "Enable Power Up",
+    value: "enablePowerUp",
+  },
+  {
+    label: "Make Admin Of Board",
+    value: "makeAdminOfBoard",
+  },
+  {
+    label: "Make Normal Member Of Board",
+    value: "makeNormalMemberOfBoard",
+  },
+  {
+    label: "Make Normal Member Of Organization",
+    value: "makeNormalMemberOfOrganization",
+  },
+  {
+    label: "Make Observer Of Board",
+    value: "makeObserverOfBoard",
+  },
+  {
+    label: "Member Joined Trello",
+    value: "memberJoinedTrello",
+  },
+  {
+    label: "Move Card From Board",
+    value: "moveCardFromBoard",
+  },
+  {
+    label: "Move Card To Board",
+    value: "moveCardToBoard",
+  },
+  {
+    label: "Move List From Board",
+    value: "moveListFromBoard",
+  },
+  {
+    label: "Move List To Board",
+    value: "moveListToBoard",
+  },
+  {
+    label: "Remove Checklist From Card",
+    value: "removeChecklistFromCard",
+  },
+  {
+    label: "Remove From Enterprise Plugin Whitelist",
+    value: "removeFromEnterprisePluginWhitelist",
+  },
+  {
+    label: "Remove From Organization Board",
+    value: "removeFromOrganizationBoard",
+  },
+  {
+    label: "Remove Member From Card",
+    value: "removeMemberFromCard",
+  },
+  {
+    label: "Remove Organization From Enterprise",
+    value: "removeOrganizationFromEnterprise",
+  },
+  {
+    label: "Unconfirmed Board Invitation",
+    value: "unconfirmedBoardInvitation",
+  },
+  {
+    label: "Unconfirmed Organization Invitation",
+    value: "unconfirmedOrganizationInvitation",
+  },
+  {
+    label: "Update Board",
+    value: "updateBoard",
+  },
+  {
+    label: "Update Card",
+    value: "updateCard",
+  },
+  {
+    label: "Update Check Item State On Card",
+    value: "updateCheckItemStateOnCard",
+  },
+  {
+    label: "Update Checklist",
+    value: "updateChecklist",
+  },
+  {
+    label: "Update List",
+    value: "updateList",
+  },
+  {
+    label: "Update Member",
+    value: "updateMember",
+  },
+  {
+    label: "Update Organization",
+    value: "updateOrganization",
+  },
+];

package/sources/common/common-board-based.mjs

@@ -9,12 +9,12 @@ export default {
     ...base.props,
     board: {
       propDefinition: [
-        base.props.trello,
+        base.props.app,
         "board",
       ],
     },
     onlyEventsRelatedWithAuthenticatedUser: {
-      label: "Only Events Related With Me",
+      label: "Only Events Related To Me",
       description: "Only will emit events from the cards related with the authenticated user",
       type: "boolean",
       default: false,
@@ -32,17 +32,24 @@ export default {
         return false;
       }
 
-      const member = await this.trello.getMember("me");
+      if (this.lists?.length) {
+        const list = await this.app.getCardList({
+          cardId: result.idCard,
+        });
+        if (!this.lists.includes(list.id)) {
+          return false;
+        }
+      }
+
+      const member = await this.app.getMember({
+        memberId: "me",
+      });
 
-      if (
+      return !(
         this.onlyEventsRelatedWithAuthenticatedUser &&
         result?.idMembers?.length &&
         !result.idMembers.includes(member.id)
-      ) {
-        return false;
-      }
-
-      return true;
+      );
     },
   },
 };

package/sources/common/common-webhook.mjs

@@ -1,3 +1,4 @@
+import { createHmac } from "crypto";
 import common from "./common.mjs";
 
 export default {
@@ -8,52 +9,83 @@ export default {
   },
   hooks: {
     async deploy() {
-      const {
-        sampleEvents, sortField,
-      } = await this.getSampleEvents();
-      sampleEvents.sort((a, b) => (Date.parse(a[sortField]) > Date.parse(b[sortField]))
-        ? 1
-        : -1);
+      let sampleEvents = await this.getSampleEvents();
+      const sortField = this.getSortField();
+      sampleEvents = this.sortItemsByDate(sampleEvents, sortField);
       for (const event of sampleEvents.slice(-25)) {
         this.emitEvent(event);
       }
     },
     async activate() {
       const modelId = await this.getModelId();
-      const { id } = await this.trello.createHook({
-        id: modelId,
-        endpoint: this.http.endpoint,
+      const { id } = await this.createHook({
+        params: {
+          idModel: modelId,
+          description: "Pipedream Source ID",
+          callbackURL: this.http.endpoint,
+        },
       });
-      this.db.set("hookId", id);
+      this._setHookId(id);
     },
     async deactivate() {
-      const hookId = this.db.get("hookId");
-      await this.trello.deleteHook({
-        hookId,
-      });
+      const hookId = this._getHookId();
+      if (hookId) {
+        await this.deleteHook({
+          hookId,
+        });
+      }
     },
   },
   methods: {
     ...common.methods,
+    _getHookId() {
+      return this.db.get("hookId");
+    },
+    _setHookId(hookId) {
+      this.db.set("hookId", hookId);
+    },
+    getBase64Digest(data) {
+      const { secret } = this.app.getToken();
+      return createHmac("sha1", secret)
+        .update(data)
+        .digest("base64");
+    },
+    // Do not remove the async keyword from this function
+    async isValidSignature({
+      body, bodyRaw, headers,
+    }) {
+      const data = bodyRaw + body.webhook?.callbackURL;
+      const doubleHash = this.getBase64Digest(data);
+      const headerHash = headers["x-trello-webhook"];
+      return doubleHash === headerHash;
+    },
+    createHook(args = {}) {
+      return this.app.post({
+        ...args,
+        path: "/webhooks/",
+      });
+    },
+    deleteHook({
+      hookId, ...args
+    } = {}) {
+      return this.app.delete({
+        ...args,
+        path: `/webhooks/${hookId}`,
+      });
+    },
     /**
      * Returns the ID of the current board selected. If no board is selected, returns
      * the id of the authenticated user.
      */
     async getModelId() {
-      if (this.board) return this.board;
-      const member = await this.trello.getMember("me");
+      if (this.board) {
+        return this.board;
+      }
+      const member = await this.app.getMember({
+        memberId: "me",
+      });
       return member.id;
     },
-    /**
-     * Verifies that the event received was sent from Trello.
-     * @param {object} event - The event returned from a webhook
-     */
-    verifyEvent(event) {
-      return (
-        this.trello.verifyTrelloWebhookRequest(event, this.http.endpoint) &&
-        event.body !== undefined
-      );
-    },
     /**
      * Default isCorrectEventType. Used in components to verify that the event received is
      * of the type that the component is watching for.
@@ -68,22 +100,44 @@ export default {
     isRelevant() {
       return true;
     },
+    getResult(action) {
+      return action;
+    },
     getSampleEvents() {
       throw new Error("getSampleEvents not implemented");
     },
+    getSortField() {
+      throw new Error("getSortField is not implemented");
+    },
   },
   async run(event) {
-    if (!this.verifyEvent(event)) {
+    if (event.body === undefined) {
+      console.log("Event body is undefined. Skipping...");
+      return;
+    }
+
+    if (!this.isValidSignature(event)) {
       console.log("The event failed the verification. Skipping...");
       return;
     }
-    if (!this.isCorrectEventType(event)) return;
 
-    const result = await this.getResult(event);
-    if (!(await this.isRelevant({
+    const { action } = event.body;
+
+    if (!this.isCorrectEventType(action)) {
+      console.log("The event is not of the correct type. Skipping...");
+      return;
+    }
+
+    const result = await this.getResult(action);
+    const isRelevant = await this.isRelevant({
       result,
-      event,
-    }))) return;
+      action,
+    });
+
+    if (!isRelevant) {
+      console.log("The event is not relevant. Skipping...");
+      return;
+    }
 
     this.emitEvent(result);
   },

package/sources/common/common.mjs

@@ -1,8 +1,8 @@
-import trello from "../../trello.app.mjs";
+import app from "../../trello.app.mjs";
 
 export default {
   props: {
-    trello,
+    app,
     db: "$.service.db",
   },
   methods: {
@@ -13,11 +13,11 @@ export default {
      * @param {string} name - The name of the item of the book.
      */
     generateMeta({
-      id, name: summary,
+      id, name,
     }) {
       return {
         id,
-        summary,
+        summary: name || `${id}`,
         ts: Date.now(),
       };
     },
@@ -30,5 +30,8 @@ export default {
       const meta = this.generateMeta(result);
       this.$emit(result, meta);
     },
+    sortItemsByDate(items, sortField) {
+      return items.sort((a, b) => (Date.parse(a[sortField]) > Date.parse(b[sortField])));
+    },
   },
 };

package/sources/custom-webhook-events/custom-webhook-events.mjs

@@ -1,29 +1,31 @@
 import common from "../common/common-webhook.mjs";
+import events from "../common/events.mjs";
 
 export default {
   ...common,
   key: "trello-custom-webhook-events",
-  name: "Custom Webhook Events (Instant)",
+  name: "Custom Webhook Events (Instant)", /* eslint-disable-line pipedream/source-name */
   description: "Emit new events for activity matching a board, event types, lists and/or cards.",
-  version: "0.0.11",
+  version: "0.1.1",
   type: "source",
   props: {
     ...common.props,
     board: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
     },
     eventTypes: {
-      propDefinition: [
-        common.props.trello,
-        "eventTypes",
-      ],
+      type: "string[]",
+      label: "Event Types",
+      optional: true,
+      description: "Only emit events for the selected event types (e.g., `updateCard`).",
+      options: events,
     },
     lists: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "lists",
         (c) => ({
           board: c.board,
@@ -32,7 +34,7 @@ export default {
     },
     cards: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "cards",
         (c) => ({
           board: c.board,
@@ -40,69 +42,55 @@ export default {
       ],
     },
   },
-  hooks: {
-    ...common.hooks,
-    async deploy() {
-      const {
-        sampleEvents, sortField,
-      } = await this.getSampleEvents();
-      sampleEvents.sort((a, b) => (Date.parse(a[sortField]) > Date.parse(b[sortField]))
-        ? 1
-        : -1);
-      for (const action of sampleEvents.slice(-25)) {
-        this.emitEvent({
-          action,
-        });
-      }
-    },
-  },
   methods: {
     ...common.methods,
-    async getSampleEvents() {
-      const eventTypes = this.eventTypes && this.eventTypes.length > 0
+    getSampleEvents() {
+      const eventTypes = this.eventTypes?.length
         ? this.eventTypes.join(",")
         : null;
-      const actions = await this.trello.getBoardActivity(this.board, eventTypes);
-      return {
-        sampleEvents: actions,
-        sortField: "date",
-      };
+      return this.app.getBoardActivity({
+        boardId: this.board,
+        params: {
+          filter: eventTypes,
+        },
+      });
+    },
+    getSortField() {
+      return "date";
     },
-    isCorrectEventType(event) {
-      const eventType = event.body?.action?.type;
+    isCorrectEventType({ type }) {
       return (
-        (eventType) &&
-        (!this.eventTypes ||
-        this.eventTypes.length === 0 ||
-        this.eventTypes.includes(eventType))
+        (type) &&
+        (!this.eventTypes?.length ||
+        this.eventTypes.includes(type))
       );
     },
-    async getResult(event) {
-      return event.body;
-    },
     async isRelevant({ result: body }) {
       let listId = body.action?.data?.list?.id;
       const cardId = body.action?.data?.card?.id;
       // If listId not returned, see if we can get it from the cardId
-      if (cardId && !listId)
-        listId = (await this.trello.getCardList(cardId)).id;
+      if (cardId && !listId) {
+        const res = await this.app.getCardList({
+          cardId,
+        });
+        listId = res.id;
+      }
       return (
-        (!this.lists ||
-          this.lists.length === 0 ||
+        (!this.lists?.length ||
           !listId ||
           this.lists.includes(listId)) &&
-        (!this.cards || this.cards.length === 0 || !cardId || this.cards.includes(cardId))
+        (!this.cards?.length || !cardId || this.cards.includes(cardId))
       );
     },
-    generateMeta({ action }) {
+    generateMeta(action) {
       const {
         id,
-        type: summary,
+        type,
         date,
       } = action;
       return {
         id,
-        summary,
+        summary: `New ${type} event`,
         ts: Date.parse(date),
       };
     },

package/sources/new-activity/new-activity.mjs

@@ -1,62 +1,55 @@
 import common from "../common/common-webhook.mjs";
+import actions from "../common/actions.mjs";
 
 export default {
   ...common,
   key: "trello-new-activity",
-  name: "New Activity (Instant)",
+  name: "New Board Activity (Instant)",
   description: "Emit new event for new activity on a board.",
-  version: "0.0.9",
+  version: "0.1.1",
   type: "source",
   props: {
     ...common.props,
     board: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
     },
-  },
-  hooks: {
-    ...common.hooks,
-    async deploy() {
-      const {
-        sampleEvents, sortField,
-      } = await this.getSampleEvents();
-      sampleEvents.sort((a, b) => (Date.parse(a[sortField]) > Date.parse(b[sortField]))
-        ? 1
-        : -1);
-      for (const action of sampleEvents.slice(-25)) {
-        this.emitEvent({
-          action,
-        });
-      }
+    activityTypes: {
+      type: "string[]",
+      label: "Activity Types",
+      description: "Filter incoming events by the activity type",
+      options: actions,
+      optional: true,
     },
   },
   methods: {
     ...common.methods,
-    async getSampleEvents() {
-      const actions = await this.trello.getBoardActivity(this.board);
-      return {
-        sampleEvents: actions,
-        sortField: "date",
-      };
+    getSampleEvents() {
+      return this.app.getBoardActivity({
+        boardId: this.board,
+      });
     },
-    async getResult(event) {
-      return event.body;
+    getSortField() {
+      return "date";
     },
-    isRelevant({ event }) {
-      const boardId = event.body?.action?.data?.board?.id;
-      return !this.board || this.board === boardId;
+    isRelevant({ action }) {
+      const {
+        data, type,
+      } = action;
+      return ((!this.board || this.board === data?.board?.id)
+        && (!this.activityTypes?.length || this.activityTypes.includes(type)));
     },
-    generateMeta({ action }) {
+    generateMeta(action) {
       const {
         id,
-        type: summary,
+        type,
         date,
       } = action;
       return {
         id,
-        summary,
+        summary: `New ${type} activity`,
         ts: Date.parse(date),
       };
     },