@pipedream/rendex 0.1.0 → 0.2.0

package/actions/list-watch-runs/list-watch-runs.mjs

@@ -0,0 +1,48 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-list-watch-runs",
+  name: "List Watch Runs",
+  description: "List the run history for a watch (most recent first). [See the documentation](https://rendex.dev/docs/watch#reading-run-history).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    rendex,
+    watchId: {
+      propDefinition: [
+        rendex,
+        "watchId",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        rendex,
+        "limit",
+      ],
+    },
+    cursor: {
+      propDefinition: [
+        rendex,
+        "cursor",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.rendex.listRuns(this.watchId, {
+      $,
+      params: {
+        limit: this.limit,
+        cursor: this.cursor,
+      },
+    });
+
+    const data = response.data;
+    $.export("$summary", `Retrieved ${data?.items?.length ?? 0} run(s)`);
+    return data;
+  },
+};

package/actions/list-watches/list-watches.mjs

@@ -0,0 +1,55 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-list-watches",
+  name: "List Watches",
+  description: "List the watches on your Rendex account, optionally filtered by status. [See the documentation](https://rendex.dev/docs/watch#endpoints).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    rendex,
+    status: {
+      type: "string",
+      label: "Status",
+      description: "Filter watches by status.",
+      optional: true,
+      default: "all",
+      options: [
+        "active",
+        "paused",
+        "all",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        rendex,
+        "limit",
+      ],
+    },
+    cursor: {
+      propDefinition: [
+        rendex,
+        "cursor",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.rendex.listWatches({
+      $,
+      params: {
+        status: this.status,
+        limit: this.limit,
+        cursor: this.cursor,
+      },
+    });
+
+    const data = response.data;
+    $.export("$summary", `Retrieved ${data?.items?.length ?? 0} watch(es)`);
+    return data;
+  },
+};

package/actions/render-markdown/render-markdown.mjs

@@ -0,0 +1,49 @@
+import { ConfigurationError } from "@pipedream/platform";
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-render-markdown",
+  name: "Render Markdown",
+  description: "Render a Markdown string to an image or PDF via Rendex — clean default typography, no CSS required. Returns base64-encoded 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,
+    markdown: {
+      propDefinition: [
+        rendex,
+        "markdown",
+      ],
+    },
+    format: {
+      propDefinition: [
+        rendex,
+        "format",
+      ],
+    },
+  },
+  async run({ $ }) {
+    if (!this.markdown) {
+      throw new ConfigurationError("`markdown` is required.");
+    }
+
+    const data = {
+      markdown: this.markdown,
+      format: this.format || "png",
+    };
+
+    const response = await this.rendex.renderJson({
+      $,
+      data,
+    });
+
+    const result = response.data;
+    $.export("$summary", `Successfully rendered ${result?.format || "image"} from Markdown (${result?.bytesSize ?? "unknown"} bytes)`);
+    return result;
+  },
+};

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

@@ -5,7 +5,7 @@ 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",
+  version: "0.1.0",
   type: "action",
   annotations: {
     destructiveHint: false,
@@ -32,6 +32,168 @@ export default {
         "format",
       ],
     },
+    width: {
+      propDefinition: [
+        rendex,
+        "width",
+      ],
+    },
+    height: {
+      propDefinition: [
+        rendex,
+        "height",
+      ],
+    },
+    fullPage: {
+      propDefinition: [
+        rendex,
+        "fullPage",
+      ],
+    },
+    quality: {
+      propDefinition: [
+        rendex,
+        "quality",
+      ],
+    },
+    delay: {
+      propDefinition: [
+        rendex,
+        "delay",
+      ],
+    },
+    darkMode: {
+      propDefinition: [
+        rendex,
+        "darkMode",
+      ],
+    },
+    deviceScaleFactor: {
+      propDefinition: [
+        rendex,
+        "deviceScaleFactor",
+      ],
+    },
+    device: {
+      propDefinition: [
+        rendex,
+        "device",
+      ],
+    },
+    selector: {
+      propDefinition: [
+        rendex,
+        "selector",
+      ],
+    },
+    hideSelectors: {
+      propDefinition: [
+        rendex,
+        "hideSelectors",
+      ],
+    },
+    blockAds: {
+      propDefinition: [
+        rendex,
+        "blockAds",
+      ],
+    },
+    blockCookieBanners: {
+      propDefinition: [
+        rendex,
+        "blockCookieBanners",
+      ],
+    },
+    timeout: {
+      propDefinition: [
+        rendex,
+        "timeout",
+      ],
+    },
+    waitUntil: {
+      propDefinition: [
+        rendex,
+        "waitUntil",
+      ],
+    },
+    bestAttempt: {
+      propDefinition: [
+        rendex,
+        "bestAttempt",
+      ],
+    },
+    css: {
+      propDefinition: [
+        rendex,
+        "css",
+      ],
+    },
+    js: {
+      propDefinition: [
+        rendex,
+        "js",
+      ],
+    },
+    userAgent: {
+      propDefinition: [
+        rendex,
+        "userAgent",
+      ],
+    },
+    cookies: {
+      propDefinition: [
+        rendex,
+        "cookies",
+      ],
+    },
+    headers: {
+      propDefinition: [
+        rendex,
+        "headers",
+      ],
+    },
+    pdfFormat: {
+      propDefinition: [
+        rendex,
+        "pdfFormat",
+      ],
+    },
+    pdfLandscape: {
+      propDefinition: [
+        rendex,
+        "pdfLandscape",
+      ],
+    },
+    pdfPrintBackground: {
+      propDefinition: [
+        rendex,
+        "pdfPrintBackground",
+      ],
+    },
+    pdfScale: {
+      propDefinition: [
+        rendex,
+        "pdfScale",
+      ],
+    },
+    geo: {
+      propDefinition: [
+        rendex,
+        "geo",
+      ],
+    },
+    geoCity: {
+      propDefinition: [
+        rendex,
+        "geoCity",
+      ],
+    },
+    geoState: {
+      propDefinition: [
+        rendex,
+        "geoState",
+      ],
+    },
   },
   async run({ $ }) {
     // Rendex requires exactly one of `html` or `url` per request, so reject both
@@ -42,8 +204,56 @@ export default {
       throw new ConfigurationError("Provide exactly one of `html` or `url`.");
     }
 
+    let cookies;
+    if (this.cookies?.length) {
+      try {
+        cookies = this.cookies.map((cookie) => {
+          const parsed = typeof cookie === "string"
+            ? JSON.parse(cookie)
+            : cookie;
+          if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+            throw new Error("Invalid cookie shape");
+          }
+          return parsed;
+        });
+      } catch {
+        throw new ConfigurationError("Each cookie must be a JSON object, e.g. {\"name\":\"session\",\"value\":\"abc\"}.");
+      }
+    }
+
     const data = {
       format: this.format || "png",
+      width: this.width,
+      height: this.height,
+      fullPage: this.fullPage,
+      quality: this.quality,
+      delay: this.delay,
+      darkMode: this.darkMode,
+      deviceScaleFactor: this.deviceScaleFactor !== undefined
+        ? Number(this.deviceScaleFactor)
+        : undefined,
+      device: this.device,
+      selector: this.selector,
+      hideSelectors: this.hideSelectors,
+      blockAds: this.blockAds,
+      blockCookieBanners: this.blockCookieBanners,
+      timeout: this.timeout,
+      waitUntil: this.waitUntil,
+      bestAttempt: this.bestAttempt,
+      css: this.css,
+      js: this.js,
+      userAgent: this.userAgent,
+      cookies,
+      headers: this.headers,
+      pdfFormat: this.pdfFormat,
+      pdfLandscape: this.pdfLandscape,
+      pdfPrintBackground: this.pdfPrintBackground,
+      pdfScale: this.pdfScale !== undefined
+        ? Number(this.pdfScale)
+        : undefined,
+      geo: this.geo,
+      geoCity: this.geoCity,
+      geoState: this.geoState,
     };
     if (hasHtml) {
       data.html = this.html;

package/actions/run-watch/run-watch.mjs

@@ -0,0 +1,32 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-run-watch",
+  name: "Run Watch Now",
+  description: "Trigger an immediate check for a watch. The run is queued and its diff result is produced asynchronously — poll **List Watch Runs** for the completed run. [See the documentation](https://rendex.dev/docs/watch#endpoints).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    watchId: {
+      propDefinition: [
+        rendex,
+        "watchId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.rendex.runWatch(this.watchId, {
+      $,
+    });
+
+    const result = response.data;
+    $.export("$summary", `Queued run ${result?.runId} for watch ${this.watchId}`);
+    return result;
+  },
+};

package/actions/update-watch/update-watch.mjs

@@ -0,0 +1,148 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-update-watch",
+  name: "Update Watch",
+  description: "Update a watch, including pausing or resuming it. Only the fields you set are changed. [See the documentation](https://rendex.dev/docs/watch#endpoints).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    watchId: {
+      propDefinition: [
+        rendex,
+        "watchId",
+      ],
+    },
+    url: {
+      type: "string",
+      label: "URL",
+      description: "New page URL to monitor. Changing it re-baselines the watch on the next run.",
+      optional: true,
+    },
+    name: {
+      propDefinition: [
+        rendex,
+        "name",
+      ],
+    },
+    intervalMinutes: {
+      propDefinition: [
+        rendex,
+        "intervalMinutes",
+      ],
+    },
+    diffMode: {
+      propDefinition: [
+        rendex,
+        "diffMode",
+      ],
+    },
+    threshold: {
+      propDefinition: [
+        rendex,
+        "threshold",
+      ],
+    },
+    webhookUrl: {
+      propDefinition: [
+        rendex,
+        "webhookUrl",
+      ],
+    },
+    notifyEmail: {
+      propDefinition: [
+        rendex,
+        "notifyEmail",
+      ],
+    },
+    paused: {
+      propDefinition: [
+        rendex,
+        "paused",
+      ],
+    },
+    renderFullPage: {
+      propDefinition: [
+        rendex,
+        "renderFullPage",
+      ],
+    },
+    renderSelector: {
+      propDefinition: [
+        rendex,
+        "renderSelector",
+      ],
+    },
+    ignoreText: {
+      propDefinition: [
+        rendex,
+        "ignoreText",
+      ],
+    },
+    minTextChars: {
+      propDefinition: [
+        rendex,
+        "minTextChars",
+      ],
+    },
+    suppressWhilePresent: {
+      propDefinition: [
+        rendex,
+        "suppressWhilePresent",
+      ],
+    },
+    uaMode: {
+      propDefinition: [
+        rendex,
+        "uaMode",
+      ],
+    },
+  },
+  methods: {
+    // Assemble the render knobs to PATCH from the render* props. Returns undefined
+    // when every field is empty so the body omits `renderParams` and leaves the
+    // watch's stored params untouched. Field names match the API watch schema
+    // (schemas/watch-params.ts → WatchRenderParams).
+    buildRenderParams() {
+      const renderParams = {
+        fullPage: this.renderFullPage,
+        selector: this.renderSelector,
+        ignoreText: this.ignoreText,
+        minTextChars: this.minTextChars,
+        suppressWhilePresent: this.suppressWhilePresent,
+        uaMode: this.uaMode,
+      };
+      return Object.values(renderParams).some((value) => value !== undefined)
+        ? renderParams
+        : undefined;
+    },
+  },
+  async run({ $ }) {
+    const response = await this.rendex.updateWatch(this.watchId, {
+      $,
+      data: {
+        url: this.url,
+        name: this.name,
+        intervalMinutes: this.intervalMinutes,
+        diffMode: this.diffMode,
+        threshold: this.threshold !== undefined
+          ? Number(this.threshold)
+          : undefined,
+        webhookUrl: this.webhookUrl,
+        notifyEmail: this.notifyEmail,
+        paused: this.paused,
+        renderParams: this.buildRenderParams(),
+      },
+    });
+
+    const watch = response.data;
+    $.export("$summary", `Updated watch ${this.watchId}`);
+    return watch;
+  },
+};

package/package.json

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