Merging pull request #17955

* Adding download PDF action

* Improvements to download

* Version bumps

Author: GTFalcao

components/tableau/actions/create-project/create-project.mjs

@@ -4,7 +4,7 @@ export default {
   key: "tableau-create-project",
   name: "Create Project",
   description: "Creates a project on the specified site. You can also create project hierarchies by creating a project under the specified parent project on the site. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm#create_project)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

components/tableau/actions/download-pdf/download-pdf.mjs

@@ -0,0 +1,130 @@
+import app from "../../tableau.app.mjs";
+import fs from "fs";
+import path from "path";
+
+export default {
+  key: "tableau-download-pdf",
+  name: "Download PDF",
+  description: "Downloads images of the sheets of a workbook as a PDF file. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_workbooks_and_views.htm#download_workbook_pdf)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    app,
+    siteId: {
+      propDefinition: [
+        app,
+        "siteId",
+      ],
+    },
+    workbookId: {
+      propDefinition: [
+        app,
+        "workbookId",
+        ({ siteId }) => ({
+          siteId,
+        }),
+      ],
+    },
+    maxAge: {
+      type: "integer",
+      label: "Max Age",
+      description: "The maximum number of minutes a workbook PDF will be cached before being refreshed. Minimum interval is one minute",
+      optional: true,
+      min: 1,
+    },
+    orientation: {
+      type: "string",
+      label: "Page Orientation",
+      description: "The orientation of the pages in the PDF file produced",
+      options: [
+        "Portrait",
+        "Landscape",
+      ],
+      default: "Portrait",
+      optional: true,
+    },
+    pageType: {
+      type: "string",
+      label: "Page Type",
+      description: "The type of page, which determines the page dimensions of the PDF file returned",
+      options: [
+        "A3",
+        "A4",
+        "A5",
+        "B5",
+        "Executive",
+        "Folio",
+        "Ledger",
+        "Legal",
+        "Letter",
+        "Note",
+        "Quarto",
+        "Tabloid",
+      ],
+      default: "Legal",
+      optional: true,
+    },
+    vizHeight: {
+      type: "integer",
+      label: "Viz Height",
+      description: "The height of the rendered PDF image in pixels that, along with `Viz Width`, determines its resolution and aspect ratio",
+      optional: true,
+    },
+    vizWidth: {
+      type: "integer",
+      label: "Viz Width",
+      description: "The width of the rendered PDF image in pixels that, along with `Viz Height`, determines its resolution and aspect ratio",
+      optional: true,
+    },
+    outputFilename: {
+      type: "string",
+      label: "Output Filename",
+      description: "The filename for the downloaded PDF file, which will be saved to the `/tmp` folder",
+      default: "workbook.pdf",
+      optional: true,
+    },
+    syncDir: {
+      type: "dir",
+      accessMode: "write",
+      sync: true,
+    },
+  },
+  async run({ $ }) {
+    const {
+      siteId,
+      workbookId,
+      maxAge,
+      orientation,
+      pageType,
+      vizHeight,
+      vizWidth,
+      outputFilename,
+    } = this;
+
+    const response = await this.app.downloadWorkbookPdf({
+      $,
+      siteId,
+      workbookId,
+      params: {
+        "max-age-minutes": maxAge,
+        orientation,
+        "page-type": pageType,
+        "viz-height": vizHeight,
+        "viz-width": vizWidth,
+      },
+      responseType: "arraybuffer",
+    });
+
+    // Write the PDF to the /tmp folder
+    const filename = outputFilename || "workbook.pdf";
+    const filePath = path.join("/tmp", filename);
+
+    await fs.promises.writeFile(filePath, Buffer.from(response));
+
+    $.export("$summary", `Successfully downloaded workbook PDF to \`${filePath}\``);
+    return {
+      filePath,
+      fileContent: response,
+    };
+  },
+};

components/tableau/actions/query-projects/query-projects.mjs

@@ -5,7 +5,7 @@ export default {
   key: "tableau-query-projects",
   name: "Query Projects",
   description: "Returns a list of projects on the specified site. [See the documentation](https://help.tableau.com/current/api/rest_api/en-us/REST/rest_api_ref_projects.htm)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   props: {
     app,

components/tableau/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/tableau",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Pipedream Tableau Components",
   "main": "tableau.app.mjs",
   "keywords": [

components/tableau/sources/label-created-instant/label-created-instant.mjs

@@ -6,7 +6,7 @@ export default {
   key: "tableau-label-created-instant",
   name: "New Label Created (Instant)",
   description: "Emit new event when a label is created in Tableau. [See the documentation](https://help.tableau.com/current/developer/webhooks/en-us/docs/webhooks-events-payload.html)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "source",
   dedupe: "unique",
   methods: {

components/tableau/sources/workbook-created-instant/workbook-created-instant.mjs

@@ -6,7 +6,7 @@ export default {
   key: "tableau-workbook-created-instant",
   name: "New Workbook Created (Instant)",
   description: "Emit new event each time a new workbook is created in Tableau. [See the documentation](https://help.tableau.com/current/developer/webhooks/en-us/docs/webhooks-events-payload.html)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "source",
   dedupe: "unique",
   methods: {

components/tableau/tableau.app.mjs

@@ -47,6 +47,32 @@ export default {
         }));
       },
     },
+    workbookId: {
+      type: "string",
+      label: "Workbook ID",
+      description: "The ID of the workbook to download as PDF",
+      async options({
+        siteId, page,
+      }) {
+        if (!siteId) {
+          return [];
+        }
+        const { workbooks: { workbook: data } } =
+          await this.listWorkbooks({
+            siteId,
+            params: {
+              pageSize: constants.DEFAULT_LIMIT,
+              pageNumber: page + 1,
+            },
+          });
+        return data?.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        })) || [];
+      },
+    },
   },
   methods: {
     getUrl(path) {
@@ -95,6 +121,22 @@ export default {
         ...args,
       });
     },
+    listWorkbooks({
+      siteId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/workbooks`,
+        ...args,
+      });
+    },
+    downloadWorkbookPdf({
+      siteId, workbookId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/sites/${siteId}/workbooks/${workbookId}/pdf`,
+        ...args,
+      });
+    },
     async *getIterations({
       resourcesFn, resourcesFnArgs, resourceName,
       max = constants.DEFAULT_MAX,