@pipedream/trello 0.3.13 → 0.4.0

package/actions/complete-checklist-item/complete-checklist-item.mjs

@@ -1,49 +1,79 @@
-// legacy_hash_id: a_EViowW
-import { axios } from "@pipedream/platform";
+import app from "../../trello.app.mjs";
 
 export default {
   key: "trello-complete-checklist-item",
   name: "Complete a Checklist Item",
-  description: "Completes an existing checklist item in a card.",
-  version: "0.1.3",
+  description: "Completes an existing checklist item in a card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-id-checkitem-idcheckitem-put).",
+  version: "0.2.0",
   type: "action",
   props: {
-    trello: {
-      type: "app",
-      app: "trello",
+    app,
+    board: {
+      propDefinition: [
+        app,
+        "board",
+      ],
     },
-    id: {
+    cardId: {
+      propDefinition: [
+        app,
+        "cards",
+        (c) => ({
+          board: c.board,
+        }),
+      ],
       type: "string",
+      label: "Card ID",
       description: "The ID of the card.",
+      optional: false,
     },
-    idCheckItem: {
-      type: "string",
-      description: "The ID of the checklist item to complete.",
+    checklistId: {
+      propDefinition: [
+        app,
+        "checklist",
+        ({ cardId }) => ({
+          card: cardId,
+        }),
+      ],
+    },
+    checklistItemId: {
+      propDefinition: [
+        app,
+        "checklistItemId",
+        ({ checklistId }) => ({
+          checklistId,
+        }),
+      ],
+    },
+  },
+  methods: {
+    completeChecklistItem({
+      cardId, checklistItemId, ...args
+    } = {}) {
+      return this.app.put({
+        path: `/cards/${cardId}/checkItem/${checklistItemId}`,
+        ...args,
+      });
     },
   },
   async run({ $ }) {
-    const oauthSignerUri = this.trello.$auth.oauth_signer_uri;
-
-    let id = this.id;
-    let idCheckItem = this.idCheckItem;
-
-    const config = {
-      url: `https://api.trello.com/1/cards/${id}/checkItem/${idCheckItem}?state=complete`,
-      method: "PUT",
-      data: "",
-    };
+    const {
+      completeChecklistItem,
+      cardId,
+      checklistItemId,
+    } = this;
 
-    const token = {
-      key: this.trello.$auth.oauth_access_token,
-      secret: this.trello.$auth.oauth_refresh_token,
-    };
+    const response = await completeChecklistItem({
+      $,
+      cardId,
+      checklistItemId,
+      params: {
+        state: "complete",
+      },
+    });
 
-    const signConfig = {
-      token,
-      oauthSignerUri,
-    };
+    $.export("$summary", "Successfully completed checklist item.");
 
-    const resp = await axios($, config, signConfig);
-    return resp;
+    return response;
   },
 };

package/actions/create-board/create-board.mjs

@@ -1,49 +1,59 @@
-// legacy_hash_id: a_Nqi0GV
-import { axios } from "@pipedream/platform";
+import app from "../../trello.app.mjs";
 
 export default {
   key: "trello-create-board",
   name: "Create a Board",
-  description: "Creates a new Trello board.",
-  version: "0.1.3",
+  description: "Creates a new Trello board. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-boards/#api-boards-post).",
+  version: "0.2.0",
   type: "action",
   props: {
-    trello: {
-      type: "app",
-      app: "trello",
-    },
+    app,
     name: {
       type: "string",
+      label: "Name",
       description: "The new name for the board. 1 to 16384 characters long.",
     },
     defaultLabels: {
       type: "boolean",
+      label: "Default Labels",
       description: "Determines whether to use the default set of labels.",
       optional: true,
     },
     defaultLists: {
       type: "boolean",
+      label: "Default Lists",
       description: "Determines whether to add the default set of lists to a board (To Do, Doing, Done). It is ignored if idBoardSource is provided.",
       optional: true,
     },
     desc: {
       type: "string",
+      label: "Description",
       description: "A new description for the board, 0 to 16384 characters long",
       optional: true,
     },
     idOrganization: {
       type: "string",
+      label: "Organization ID",
       description: "The id or name of the team the board should belong to.",
-      optional: true,
+      optional: false,
+      propDefinition: [
+        app,
+        "idOrganizations",
+      ],
     },
     idBoardSource: {
-      type: "string",
+      label: "Board Source ID",
       description: "The id of a board to copy into the new board.",
       optional: true,
+      propDefinition: [
+        app,
+        "board",
+      ],
     },
     keepFromSource: {
       type: "string",
-      description: "To keep cards from the original board pass in the value \"cards\".",
+      label: "Keep From Source",
+      description: "To keep cards from the original board pass in the value `cards`.",
       optional: true,
       options: [
         "none",
@@ -52,12 +62,21 @@ export default {
     },
     powerUps: {
       type: "string",
-      description: "The Power-Ups that should be enabled on the new board. One of: all, calendar, cardAging, recap, voting.",
+      label: "Power-Ups",
+      description: "The Power-Ups that should be enabled on the new board. One of: `all`, `calendar`, `cardAging`, `recap`, `voting`.",
       optional: true,
+      options: [
+        "all",
+        "calendar",
+        "cardAging",
+        "recap",
+        "voting",
+      ],
     },
-    prefs_permissionLevel: {
+    prefsPermissionLevel: {
       type: "string",
       description: "The permissions level of the board. One of: org, private, public.",
+      label: "Prefs Permission Level",
       optional: true,
       options: [
         "org",
@@ -65,7 +84,7 @@ export default {
         "public",
       ],
     },
-    prefs_voting: {
+    prefsVoting: {
       type: "string",
       label: "Prefs Voting",
       description: "Who can vote on this board. One of disabled, members, observers, org, public.",
@@ -78,7 +97,7 @@ export default {
         "public",
       ],
     },
-    prefs_comments: {
+    prefsComments: {
       type: "string",
       label: "Prefs Comments",
       description: "Who can comment on cards on this board. One of: disabled, members, observers, org, public.",
@@ -91,7 +110,7 @@ export default {
         "public",
       ],
     },
-    prefs_invitations: {
+    prefsInvitations: {
       type: "string",
       label: "Prefs Invitations",
       description: "Determines what types of members can invite users to join. One of: admins, members.",
@@ -101,24 +120,38 @@ export default {
         "members",
       ],
     },
-    prefs_selfJoin: {
+    prefsSelfJoin: {
       type: "boolean",
+      label: "Prefs Self Join",
       description: "Determines whether users can join the boards themselves or whether they have to be invited.",
       optional: true,
     },
-    prefs_cardCovers: {
+    prefsCardCovers: {
       type: "boolean",
+      label: "Prefs Card Covers",
       description: "Determines whether card covers are enabled.",
       optional: true,
     },
-    prefs_background: {
+    prefsBackground: {
       type: "string",
       label: "Prefs Background",
-      description: "The id of a custom background or one of: blue, orange, green, red, purple, pink, lime, sky, grey.",
+      description: "The id of a custom background or one of: `blue`, `orange`, `green`, `red`, `purple`, `pink`, `lime`, `sky`, `grey`.",
       optional: true,
+      options: [
+        "blue",
+        "orange",
+        "green",
+        "red",
+        "purple",
+        "pink",
+        "lime",
+        "sky",
+        "grey",
+      ],
     },
-    prefs_cardAging: {
+    prefsCardAging: {
       type: "string",
+      label: "Prefs Card Aging",
       description: "Determines the type of card aging that should take place on the board if card aging is enabled. One of: pirate, regular.",
       optional: true,
       options: [
@@ -128,48 +161,50 @@ export default {
     },
   },
   async run({ $ }) {
-    const oauthSignerUri = this.trello.$auth.oauth_signer_uri;
-
-    const trelloParams = [
-      "name",
-      "defaultLabels",
-      "defaultLists",
-      "desc",
-      "idOrganization",
-      "idBoardSource",
-      "keepFromSource",
-      "powerUps",
-      "prefs_permissionLevel",
-      "prefs_voting",
-      "prefs_comments",
-      "prefs_invitations",
-      "prefs_selfJoin",
-      "prefs_cardCovers",
-      "prefs_background",
-      "prefs_cardAging",
-    ];
-    let p = this;
-
-    const queryString = trelloParams.filter((param) => p[param]).map((param) => `${param}=${p[param]}`)
-      .join("&");
-
-    const config = {
-      url: `https://api.trello.com/1/boards?${queryString}`,
-      method: "POST",
-      data: "",
-    };
+    const {
+      app,
+      name,
+      defaultLabels,
+      defaultLists,
+      desc,
+      idOrganization,
+      idBoardSource,
+      keepFromSource,
+      powerUps,
+      prefsPermissionLevel,
+      prefsVoting,
+      prefsComments,
+      prefsInvitations,
+      prefsSelfJoin,
+      prefsCardCovers,
+      prefsBackground,
+      prefsCardAging,
+    } = this;
 
-    const token = {
-      key: this.trello.$auth.oauth_access_token,
-      secret: this.trello.$auth.oauth_refresh_token,
-    };
+    const response = await app.createBoard({
+      $,
+      params: {
+        name,
+        defaultLabels,
+        defaultLists,
+        desc,
+        idOrganization,
+        idBoardSource,
+        keepFromSource,
+        powerUps,
+        prefs_permissionLevel: prefsPermissionLevel,
+        prefs_voting: prefsVoting,
+        prefs_comments: prefsComments,
+        prefs_invitations: prefsInvitations,
+        prefs_selfJoin: prefsSelfJoin,
+        prefs_cardCovers: prefsCardCovers,
+        prefs_background: prefsBackground,
+        prefs_cardAging: prefsCardAging,
+      },
+    });
 
-    const signConfig = {
-      token,
-      oauthSignerUri,
-    };
+    $.export("$summary", `Successfully created board with ID \`${response.id}\`.`);
 
-    const resp = await axios($, config, signConfig);
-    return resp;
+    return response;
   },
 };

package/actions/create-card/create-card.mjs

@@ -1,23 +1,26 @@
+import fs from "fs";
+import FormData from "form-data";
+import { ConfigurationError } from "@pipedream/platform";
 import common from "../common.mjs";
 
 export default {
   ...common,
   key: "trello-create-card",
   name: "Create Card",
-  description: "Creates a new card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-post)",
-  version: "0.0.3",
+  description: "Creates a new card. [See the documentation](https://developer.atlassian.com/cloud/trello/rest/api-group-cards/#api-cards-post).",
+  version: "0.1.0",
   type: "action",
   props: {
     ...common.props,
     board: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "board",
       ],
     },
     name: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "name",
       ],
       description: "The name of the card.",
@@ -25,31 +28,31 @@ export default {
     },
     desc: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "desc",
       ],
     },
     pos: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "pos",
       ],
     },
     due: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "due",
       ],
     },
     dueComplete: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "dueComplete",
       ],
     },
     idList: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "lists",
         (c) => ({
           board: c.board,
@@ -62,7 +65,7 @@ export default {
     },
     idMembers: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "member",
         (c) => ({
           board: c.board,
@@ -75,7 +78,7 @@ export default {
     },
     idLabels: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "label",
         (c) => ({
           board: c.board,
@@ -88,26 +91,25 @@ export default {
     },
     urlSource: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "url",
       ],
-      optional: true,
-    },
-    fileSource: {
-      type: "string",
-      label: "File Attachment Contents",
-      description: "Value must be in binary format",
-      optional: true,
     },
     mimeType: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "mimeType",
       ],
     },
+    file: {
+      propDefinition: [
+        common.props.app,
+        "file",
+      ],
+    },
     idCardSource: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "cards",
         (c) => ({
           board: c.board,
@@ -115,7 +117,7 @@ export default {
       ],
       type: "string",
       label: "Copy Card",
-      description: "Specify an existing card to copy contents from",
+      description: "Specify an existing card to copy contents from. Keep in mind that if you copy a card, the **File Attachment Path**, **File Attachment URL** and **File Attachment Type** fields will be ignored.",
     },
     keepFromSource: {
       type: "string[]",
@@ -135,25 +137,25 @@ export default {
     },
     address: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "address",
       ],
     },
     locationName: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "locationName",
       ],
     },
     coordinates: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "coordinates",
       ],
     },
     customFieldIds: {
       propDefinition: [
-        common.props.trello,
+        common.props.app,
         "customFieldIds",
         (c) => ({
           boardId: c.board,
@@ -168,7 +170,9 @@ export default {
       return props;
     }
     for (const customFieldId of this.customFieldIds) {
-      const customField = await this.trello.getCustomField(customFieldId);
+      const customField = await this.app.getCustomField({
+        customFieldId,
+      });
       props[customFieldId] = {
         type: "string",
         label: `Value for Custom Field - ${customField.name}`,
@@ -187,7 +191,10 @@ export default {
     async getCustomFieldItems($) {
       const customFieldItems = [];
       for (const customFieldId of this.customFieldIds) {
-        const customField = await this.trello.getCustomField(customFieldId, $);
+        const customField = await this.app.getCustomField({
+          $,
+          customFieldId,
+        });
         const customFieldItem = {
           idCustomField: customFieldId,
         };
@@ -206,9 +213,16 @@ export default {
       }
       return customFieldItems;
     },
+    createCard(args = {}) {
+      return this.app.post({
+        path: "/cards",
+        ...args,
+      });
+    },
   },
   async run({ $ }) {
     const {
+      createCard,
       name,
       desc,
       pos,
@@ -218,8 +232,8 @@ export default {
       idMembers,
       idLabels,
       urlSource,
-      fileSource,
       mimeType,
+      file,
       idCardSource,
       keepFromSource,
       address,
@@ -227,7 +241,9 @@ export default {
       coordinates,
       customFieldIds,
     } = this;
-    const res = await this.trello.createCard({
+
+    let response;
+    const params = {
       name,
       desc,
       pos,
@@ -236,25 +252,53 @@ export default {
       idList,
       idMembers,
       idLabels,
-      urlSource,
-      fileSource,
       mimeType,
       idCardSource,
       keepFromSource: keepFromSource?.join(","),
       address,
       locationName,
       coordinates,
-    }, $);
+    };
+
+    if (file && !file?.startsWith("/tmp")) {
+      throw new ConfigurationError("The file path must be in the `/tmp` directory");
+    }
+
+    if (file) {
+      const form = new FormData();
+      form.append("fileSource", fs.createReadStream(file));
+
+      response = await createCard({
+        $,
+        params,
+        headers: form.getHeaders(),
+        data: form,
+      });
+
+    } else {
+      response = await createCard({
+        $,
+        params: {
+          ...params,
+          urlSource,
+        },
+      });
+    }
 
     if (customFieldIds) {
       const customFieldItems = await this.getCustomFieldItems($);
-      const customFields = await this.trello.updateCustomFields(res.id, {
-        customFieldItems,
-      }, $);
-      res.customFields = customFields;
+      const customFields = await this.app.updateCustomFields({
+        $,
+        cardId: response.id,
+        data: {
+          customFieldItems,
+        },
+      });
+      response.customFields = customFields;
     }
 
-    $.export("$summary", `Successfully created card ${res.id}`);
-    return res;
+    $.export("$summary", `Successfully created card \`${response.id}\`.`);
+
+    return response;
   },
 };