@pipedream/rendex 0.1.0 → 0.2.0

package/actions/create-artifact/create-artifact.mjs

@@ -0,0 +1,111 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-create-artifact",
+  name: "Create Artifact",
+  description: "Turn Markdown or HTML plus a small branding theme into a branded PDF + PNG and a hosted share page in one call. Returns `pdfUrl`, `pngUrl`, `shareUrl`, and `expiresAt`. [See the documentation](https://rendex.dev/docs/api-reference#post-artifact).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    content: {
+      type: "string",
+      label: "Content",
+      description: "The Markdown or HTML body to render into a branded artifact.",
+    },
+    inputFormat: {
+      type: "string",
+      label: "Input Format",
+      description: "How to interpret `content`: `markdown` is converted to styled HTML; `html` is used as a body fragment.",
+      optional: true,
+      default: "markdown",
+      options: [
+        "markdown",
+        "html",
+      ],
+    },
+    formats: {
+      type: "string[]",
+      label: "Formats",
+      description: "Which artifact formats to produce. Each format charges 1 credit. Defaults to both.",
+      optional: true,
+      default: [
+        "pdf",
+        "png",
+      ],
+      options: [
+        "pdf",
+        "png",
+      ],
+    },
+    brandName: {
+      type: "string",
+      label: "Brand Name",
+      description: "Plain-text header line shown beside the logo (maps to `branding.header`).",
+      optional: true,
+    },
+    title: {
+      type: "string",
+      label: "Title",
+      description: "Title for the hosted share page. Falls back to **Brand Name** when set; both populate `branding.header` (the API's single header field).",
+      optional: true,
+    },
+    accentColor: {
+      type: "string",
+      label: "Accent Color",
+      description: "CSS color for the accent bar, links, and headings (e.g. `#EA580C`, `rebeccapurple`).",
+      optional: true,
+    },
+    logoUrl: {
+      type: "string",
+      label: "Logo URL",
+      description: "Absolute http(s) URL of a logo image shown in the artifact header.",
+      optional: true,
+    },
+    footer: {
+      type: "string",
+      label: "Footer",
+      description: "Plain-text footer line shown at the bottom of every page.",
+      optional: true,
+    },
+    expiresIn: {
+      propDefinition: [
+        rendex,
+        "expiresIn",
+      ],
+      description: "Seconds until the hosted artifact URLs expire (3600–2592000). Defaults to `86400` (24 hours).",
+    },
+  },
+  async run({ $ }) {
+    const branding = {
+      logo: this.logoUrl,
+      accentColor: this.accentColor,
+      header: this.brandName || this.title,
+      footer: this.footer,
+    };
+    const hasBranding = Object.values(branding).some((value) =>
+      value !== undefined && value !== "");
+
+    const response = await this.rendex.createArtifact({
+      $,
+      data: {
+        content: this.content,
+        inputFormat: this.inputFormat,
+        formats: this.formats,
+        branding: hasBranding
+          ? branding
+          : undefined,
+        expiresIn: this.expiresIn,
+      },
+    });
+
+    const data = response.data;
+    $.export("$summary", `Created artifact (share ${data?.shareUrl})`);
+    return data;
+  },
+};

package/actions/create-render-link/create-render-link.mjs

@@ -0,0 +1,256 @@
+import { ConfigurationError } from "@pipedream/platform";
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-create-render-link",
+  name: "Create Render Link",
+  description: "Mint a signed, hosted render URL for a page or HTML — ideal for `og:image` tags. The returned URL serves the rendered image/PDF directly. [See the documentation](https://rendex.dev/docs/api-reference#post-render-link).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    url: {
+      type: "string",
+      label: "URL",
+      description: "The page URL to render. Provide either `url` or `html`.",
+      optional: true,
+    },
+    html: {
+      propDefinition: [
+        rendex,
+        "html",
+      ],
+    },
+    format: {
+      propDefinition: [
+        rendex,
+        "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",
+      ],
+    },
+    expiresIn: {
+      propDefinition: [
+        rendex,
+        "expiresIn",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const hasHtml = Boolean(this.html);
+    const hasUrl = Boolean(this.url);
+    if (hasHtml === hasUrl) {
+      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 response = await this.rendex.createRenderLink({
+      $,
+      data: {
+        url: hasUrl
+          ? this.url
+          : undefined,
+        html: hasHtml
+          ? this.html
+          : undefined,
+        format: this.format,
+        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,
+        expiresIn: this.expiresIn,
+      },
+    });
+
+    const data = response.data;
+    $.export("$summary", `Created render link (expires ${data?.expiresAt})`);
+    return data;
+  },
+};

package/actions/create-watch/create-watch.mjs

@@ -0,0 +1,141 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-create-watch",
+  name: "Create Watch",
+  description: "Create a watch that monitors a page for visual or text changes. [See the documentation](https://rendex.dev/docs/watch#create-a-watch).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    url: {
+      type: "string",
+      label: "URL",
+      description: "The page URL to monitor for changes.",
+    },
+    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 watch's stored render knobs from the render* props. Returns
+    // undefined when every field is empty so the body omits `renderParams` and
+    // the API keeps its defaults (notably fullPage: true). 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.createWatch({
+      $,
+      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", `Created watch ${watch?.id}`);
+    return watch;
+  },
+};

package/actions/delete-watch/delete-watch.mjs

@@ -0,0 +1,34 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-delete-watch",
+  name: "Delete Watch",
+  description: "Delete a watch and its run history. [See the documentation](https://rendex.dev/docs/watch#endpoints).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  props: {
+    rendex,
+    watchId: {
+      propDefinition: [
+        rendex,
+        "watchId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    await this.rendex.deleteWatch(this.watchId, {
+      $,
+    });
+
+    $.export("$summary", `Deleted watch ${this.watchId}`);
+    return {
+      success: true,
+      watchId: this.watchId,
+    };
+  },
+};

package/actions/extract-content/extract-content.mjs

@@ -0,0 +1,64 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-extract-content",
+  name: "Extract Content",
+  description: "Extract the readable content of a page as Markdown, JSON, or HTML. [See the documentation](https://rendex.dev/docs/api-reference#post-extract).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    rendex,
+    url: {
+      type: "string",
+      label: "URL",
+      description: "The page URL to extract content from.",
+    },
+    extractFormat: {
+      propDefinition: [
+        rendex,
+        "extractFormat",
+      ],
+    },
+    waitUntil: {
+      propDefinition: [
+        rendex,
+        "waitUntil",
+      ],
+    },
+    delay: {
+      propDefinition: [
+        rendex,
+        "delay",
+      ],
+    },
+    timeout: {
+      type: "integer",
+      label: "Timeout (seconds)",
+      description: "Maximum time to wait for the page to load (5–60).",
+      optional: true,
+      min: 5,
+      max: 60,
+    },
+  },
+  async run({ $ }) {
+    const response = await this.rendex.extract({
+      $,
+      data: {
+        url: this.url,
+        extractFormat: this.extractFormat,
+        waitUntil: this.waitUntil,
+        delay: this.delay,
+        timeout: this.timeout,
+      },
+    });
+
+    const data = response.data;
+    $.export("$summary", `Extracted content from ${this.url}`);
+    return data;
+  },
+};

package/actions/get-account/get-account.mjs

@@ -0,0 +1,33 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-get-account",
+  name: "Get Account",
+  description: "Get your Rendex plan and this month's usage (credits used/limit/remaining), rate limit, and recommended upgrade. Read-only and free (no credits charged). [See the documentation](https://rendex.dev/docs/api-reference#get-account).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    rendex,
+  },
+  async run({ $ }) {
+    const response = await this.rendex.getAccount({
+      $,
+    });
+
+    const data = response.data;
+    const usage = data?.usage ?? {};
+    const limitLabel = usage.unlimited
+      ? "unlimited"
+      : usage.limit;
+    const remainingLabel = usage.unlimited
+      ? "unlimited"
+      : usage.remaining;
+    $.export("$summary", `Plan: ${data?.plan} — ${remainingLabel}/${limitLabel} credits left`);
+    return data;
+  },
+};

package/actions/get-watch/get-watch.mjs

@@ -0,0 +1,32 @@
+import rendex from "../../rendex.app.mjs";
+
+export default {
+  key: "rendex-get-watch",
+  name: "Get Watch",
+  description: "Retrieve a single watch by its ID. [See the documentation](https://rendex.dev/docs/watch#endpoints).",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    rendex,
+    watchId: {
+      propDefinition: [
+        rendex,
+        "watchId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.rendex.getWatch(this.watchId, {
+      $,
+    });
+
+    const watch = response.data;
+    $.export("$summary", `Retrieved watch ${this.watchId}`);
+    return watch;
+  },
+};