@pipedream/rendex 0.0.1 → 0.1.0

package/actions/render-to-image/render-to-image.mjs

@@ -0,0 +1,63 @@
+import { ConfigurationError } from "@pipedream/platform";
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-render-to-image",
+  name: "Render to Image",
+  description: "Render an HTML string or a page URL to an image (or PDF) via Rendex. Returns base64-encoded image data with metadata. [See the documentation](https://rendex.dev/docs/api-reference#post-screenshot-json).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    html: {
+      propDefinition: [
+        rendex,
+        "html",
+      ],
+    },
+    url: {
+      propDefinition: [
+        rendex,
+        "url",
+      ],
+    },
+    format: {
+      propDefinition: [
+        rendex,
+        "format",
+      ],
+    },
+  },
+  async run({ $ }) {
+    // Rendex requires exactly one of `html` or `url` per request, so reject both
+    // (not just neither) rather than silently dropping `url`.
+    const hasHtml = Boolean(this.html);
+    const hasUrl = Boolean(this.url);
+    if (hasHtml === hasUrl) {
+      throw new ConfigurationError("Provide exactly one of `html` or `url`.");
+    }
+
+    const data = {
+      format: this.format || "png",
+    };
+    if (hasHtml) {
+      data.html = this.html;
+    } else {
+      data.url = this.url;
+    }
+
+    const response = await this.rendex.renderJson({
+      $,
+      data,
+    });
+
+    const result = response.data;
+    $.export("$summary", `Successfully rendered ${result?.format || "image"} (${result?.bytesSize ?? "unknown"} bytes)`);
+    return result;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/rendex",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Rendex Components",
   "main": "rendex.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.1"
   }
 }

package/rendex.app.mjs

@@ -1,11 +1,68 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "rendex",
-  propDefinitions: {},
+  propDefinitions: {
+    html: {
+      type: "string",
+      label: "HTML",
+      description: "The HTML markup to render to an image.",
+      optional: true,
+    },
+    url: {
+      type: "string",
+      label: "URL",
+      description: "A page URL to render (alternative to HTML). Provide either `html` or `url`.",
+      optional: true,
+    },
+    format: {
+      type: "string",
+      label: "Output Format",
+      description: "Output file format. Example values: `png`, `jpeg`, `webp`, or `pdf`.",
+      optional: true,
+      default: "png",
+      options: [
+        "png",
+        "jpeg",
+        "webp",
+        "pdf",
+      ],
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.rendex.dev";
+    },
+    _headers() {
+      return {
+        "Authorization": `Bearer ${this.$auth.api_key}`,
+        "Content-Type": "application/json",
+      };
+    },
+    _makeRequest({
+      $ = this, path, headers, ...opts
+    }) {
+      return axios($, {
+        url: `${this._baseUrl()}${path}`,
+        headers: {
+          ...this._headers(),
+          ...headers,
+        },
+        ...opts,
+      });
+    },
+    /**
+     * Render HTML or a URL to an image/PDF via POST /v1/screenshot/json.
+     * @param {object} opts - axios options; `data` is the JSON request body.
+     * @returns {Promise<object>} `{ success, data: { image, format, bytesSize, ... }, meta }`
+     */
+    renderJson(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/v1/screenshot/json",
+        ...opts,
+      });
     },
   },
-};
+};