[Components] pdfmonkey #13201

Sources
 - New Document Generated

Actions
 - Generate Document
 - Delete Document
 - Find Document

Author: luancazarine

components/pdfmonkey/.gitignore

@@ -1,11 +1,10 @@
 import pdfmonkey from "../../pdfmonkey.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "pdfmonkey-delete-document",
   name: "Delete Document",
   description: "Deletes a specific document using its ID. [See the documentation](https://docs.pdfmonkey.io/references/api/documents)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     pdfmonkey,
@@ -17,7 +16,10 @@ export default {
     },
   },
   async run({ $ }) {
-    const response = await this.pdfmonkey.deleteDocument(this.documentId);
+    const response = await this.pdfmonkey.deleteDocument({
+      $,
+      documentId: this.documentId,
+    });
     $.export("$summary", `Deleted document with ID ${this.documentId}`);
     return response;
   },

components/pdfmonkey/actions/delete-document/delete-document.mjs

@@ -1,11 +1,10 @@
 import pdfmonkey from "../../pdfmonkey.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "pdfmonkey-find-document",
   name: "Find Document",
   description: "Find a document within PDFMonkey. [See the documentation](https://docs.pdfmonkey.io/references/api/documents)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     pdfmonkey,
@@ -17,7 +16,10 @@ export default {
     },
   },
   async run({ $ }) {
-    const document = await this.pdfmonkey.findDocument(this.documentId);
+    const document = await this.pdfmonkey.getDocument({
+      $,
+      documentId: this.documentId,
+    });
     $.export("$summary", `Successfully found document with ID ${this.documentId}`);
     return document;
   },

components/pdfmonkey/actions/find-document/find-document.mjs

@@ -1,10 +1,11 @@
+import { STATUS_OPTIONS } from "../../common/constants.mjs";
 import pdfmonkey from "../../pdfmonkey.app.mjs";
 
 export default {
   key: "pdfmonkey-generate-document",
   name: "Generate Document",
   description: "Generates a new document using a specified template. [See the documentation](https://docs.pdfmonkey.io/references/api/documents)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     pdfmonkey,
@@ -14,24 +15,37 @@ export default {
         "templateId",
       ],
     },
-    data: {
-      propDefinition: [
-        pdfmonkey,
-        "data",
-      ],
+    payload: {
+      type: "object",
+      label: "Payload",
+      description: "Data to use for the Document generation.",
+      optional: true,
     },
-    metadata: {
-      propDefinition: [
-        pdfmonkey,
-        "metadata",
-      ],
+    meta: {
+      type: "object",
+      label: "Meta",
+      description: "Meta-Data to attach to the Document.",
+      optional: true,
+    },
+    status: {
+      type: "string",
+      label: "Status",
+      description: "The status of the document",
+      options: STATUS_OPTIONS,
+      optional: true,
     },
   },
   async run({ $ }) {
     const response = await this.pdfmonkey.createDocument({
-      templateId: this.templateId,
-      data: this.data,
-      metadata: this.metadata,
+      $,
+      data: {
+        document: {
+          document_template_id: this.templateId,
+          payload: this.payload,
+          meta: this.meta,
+          status: this.status,
+        },
+      },
     });
 
     $.export("$summary", `Successfully generated document with ID ${response.document.id}`);

components/pdfmonkey/actions/generate-document/generate-document.mjs

@@ -0,0 +1,10 @@
+export const STATUS_OPTIONS = [
+  {
+    label: "Draft (Default)",
+    value: "draft",
+  },
+  {
+    label: "Pending (To trigger generation)",
+    value: "pending",
+  },
+];

components/pdfmonkey/app/pdfmonkey.app.ts

@@ -1,18 +1,18 @@
 {
   "name": "@pipedream/pdfmonkey",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Pipedream PDFMonkey Components",
-  "main": "dist/app/pdfmonkey.app.mjs",
+  "main": "pdfmonkey.app.mjs",
   "keywords": [
     "pipedream",
     "pdfmonkey"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/pdfmonkey",
   "author": "Pipedream <[email protected]> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }

components/pdfmonkey/common/constants.mjs

@@ -4,100 +4,132 @@ export default {
   type: "app",
   app: "pdfmonkey",
   propDefinitions: {
-    documentId: {
-      type: "string",
-      label: "Document ID",
-      description: "The unique identifier of the document.",
-    },
     templateId: {
       type: "string",
       label: "Template ID",
       description: "The unique identifier of the document template.",
+      async options({ page }) {
+        const { document_template_cards: data } = await this.listTemplates({
+          params: {
+            "page[number]": page,
+          },
+        });
+
+        return data.map(({
+          id: value, identifier: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
     },
-    data: {
-      type: "object",
-      label: "Payload",
-      description: "Data used for the document generation.",
-      optional: true,
-    },
-    metadata: {
-      type: "object",
-      label: "Metadata",
-      description: "Metadata to attach to the document.",
-      optional: true,
-    },
-    documentName: {
+    documentId: {
       type: "string",
-      label: "Document Name",
-      description: "Optional name for the document.",
-      optional: true,
-    },
-    additionalMetadata: {
-      type: "object",
-      label: "Additional Metadata",
-      description: "Optional additional metadata for the document.",
-      optional: true,
+      label: "Document ID",
+      description: "The unique identifier of the document.",
+      async options({ page }) {
+        const { document_cards: data } = await this.listDocuments({
+          params: {
+            "page[number]": page,
+          },
+        });
+
+        return data.map(({
+          id: value, filename,
+        }) => ({
+          label: `${value}${filename
+            ? ` - ${filename}`
+            : ""}`,
+          value,
+        }));
+      },
     },
   },
   methods: {
     _baseUrl() {
       return "https://api.pdfmonkey.io/api/v1";
     },
-    async _makeRequest(opts = {}) {
-      const {
-        $ = this, method = "GET", path = "/", headers, ...otherOpts
-      } = opts;
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.api_key}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
       return axios($, {
-        ...otherOpts,
-        method,
         url: this._baseUrl() + path,
-        headers: {
-          ...headers,
-          "Authorization": `Bearer ${this.$auth.api_key}`,
-          "Content-Type": "application/json",
-        },
+        headers: this._headers(),
+        ...opts,
       });
     },
-    async createDocument({
-      templateId, data, metadata,
-    }) {
+    createDocument(opts = {}) {
       return this._makeRequest({
         method: "POST",
         path: "/documents",
-        data: {
-          document: {
-            document_template_id: templateId,
-            status: "pending",
-            payload: data,
-            meta: metadata,
-          },
-        },
+        ...opts,
       });
     },
-    async deleteDocument(documentId) {
+    deleteDocument({
+      documentId, ...opts
+    }) {
       return this._makeRequest({
         method: "DELETE",
         path: `/documents/${documentId}`,
+        ...opts,
       });
     },
-    async findDocument(documentId) {
+    getDocument({
+      documentId, ...opts
+    }) {
       return this._makeRequest({
-        method: "GET",
         path: `/documents/${documentId}`,
+        ...opts,
+      });
+    },
+    listDocuments(opts = {}) {
+      return this._makeRequest({
+        path: "/document_cards",
+        ...opts,
+      });
+    },
+    listTemplates(opts = {}) {
+      return this._makeRequest({
+        path: "/document_template_cards",
+        ...opts,
       });
     },
-    async emitDocumentCompletion({
-      documentId, documentName, additionalMetadata,
+    async *paginate({
+      fn, params = {}, maxResults = null, ...opts
     }) {
-      const document = await this.findDocument(documentId);
-      if (document.status === "success") {
-        this.$emit(document, {
-          id: document.id,
-          summary: `Document ${documentName || document.filename} Generation Completed`,
-          ts: Date.now(),
-          additionalMetadata,
+      let hasMore = false;
+      let count = 0;
+      let page = 0;
+
+      do {
+        params["page[number]"] = ++page;
+
+        const {
+          document_cards: data,
+          meta: {
+            current_page, total_pages,
+          },
+        } = await fn({
+          params,
+          ...opts,
         });
-      }
+
+        for (const d of data) {
+          yield d;
+
+          if (maxResults && ++count === maxResults) {
+            return count;
+          }
+        }
+
+        hasMore = !(current_page == total_pages);
+
+      } while (hasMore);
     },
   },
 };