import puppeteer from "../../puppeteer.app.mjs";
import constants from "../../common/constants.mjs";
import common from "../common/common.mjs";
import fs from "fs";
import { ConfigurationError } from "@pipedream/platform";
export default {
...common,
key: "puppeteer-screenshot-page",
name: "Screenshot a Page",
description:
"Captures a screenshot of a page using Puppeteer. [See the documentation](https://pptr.dev/api/puppeteer.page.screenshot)",
version: "1.0.2",
type: "action",
props: {
puppeteer,
...common.props,
downloadPath: {
type: "string",
label: "Download Path",
description:
"Download the screenshot to the `/tmp` directory with the specified filename",
optional: true,
},
captureBeyondViewport: {
type: "boolean",
label: "Capture Beyond Viewport",
description: "Capture the screenshot beyond the viewport.",
optional: true,
default: true,
},
clipHeight: {
type: "string",
label: "Clip Height",
description: "Specifies the height of the region of the page to clip.",
optional: true,
},
clipScale: {
type: "string",
label: "Clip Scale",
description: "Specifies the scale of the region of the page to clip.",
default: "1",
optional: true,
},
clipWidth: {
type: "string",
label: "Clip Width",
description: "Specifies the width of the region of the page to clip.",
optional: true,
},
clipX: {
type: "string",
label: "Clip X",
description: "Specifies the X value of the region of the page to clip.",
optional: true,
},
clipY: {
type: "string",
label: "Clip Y",
description: "Specifies Y value of the region of the page to clip.",
optional: true,
},
encoding: {
type: "string",
label: "Encoding",
description: "Encoding of the image.",
optional: true,
default: "binary",
options: constants.IMAGE_ENCODING,
},
fromSurface: {
type: "boolean",
label: "From Surface",
description:
"Capture the screenshot from the surface, rather than the view.",
optional: true,
default: false,
},
fullPage: {
type: "boolean",
label: "Full Page",
description: "When true, takes a screenshot of the full page.",
optional: true,
default: false,
},
omitBackground: {
type: "boolean",
label: "Omit Background",
description:
"Hides default white background and allows capturing screenshots with transparency.",
optional: true,
default: false,
},
optimizeForSpeed: {
type: "boolean",
label: "Optimize For Speed",
description: "Optimize for speed.",
optional: true,
default: false,
},
quality: {
type: "integer",
label: "Quality",
description:
"Quality of the image, between 0-100. Not applicable to png images.",
optional: true,
},
type: {
type: "string",
label: "Type",
description: "Type of the screenshot image.",
optional: true,
default: "png",
options: constants.SCREENSHOT_TYPE,
},
},
methods: {
async downloadToTMP(screenshot) {
const path = this.downloadPath.includes("/tmp")
? this.downloadPath
: `/tmp/${this.downloadPath}`;
fs.writeFileSync(path, screenshot);
return path;
},
},
async run({ $ }) {
if (
(this.clipHeight || this.clipWidth || this.clipX || this.clipY) &&
!(this.clipHeight && this.clipWidth && this.clipX && this.clipY)
) {
throw new ConfigurationError(
"Clip height, width, X, and Y must be specified to create clip.",
);
}
const clip =
this.clipHeight || this.clipWidth || this.clipX || this.clipY
? {
height: parseFloat(this.clipHeight),
scale: parseFloat(this.clipScale),
width: parseFloat(this.clipWidth),
x: parseFloat(this.clipX),
y: parseFloat(this.clipY),
}
: undefined;
const options = {
captureBeyondViewport: this.captureBeyondViewport,
clip,
encoding: this.encoding,
fromSurface: this.fromSurface,
fullPage: this.fullPage,
omitBackground: this.omitBackground,
optimizeForSpeed: this.optimizeForSpeed,
quality: this.quality,
type: this.type,
};
const url = this.normalizeUrl();
const browser = await this.puppeteer.launch();
const page = await browser.newPage();
await page.goto(url);
const screenshot = await page.screenshot(options);
await browser.close();
const filePath =
screenshot && this.downloadPath
? await this.downloadToTMP(screenshot)
: undefined;
if (screenshot) {
$.export("$summary", `Successfully captured screenshot from ${url}`);
}
return filePath
? {
screenshot: screenshot.toString("base64"),
filePath,
}
: screenshot.toString("base64");
},
};
Chase Roberts@chsrbrts@benedictevans If you haven’t used @pipedream yet, then you haven’t lived.
✨Ellie Day✨@heyelliedayEvaluation update: @pipedream has quite literally been a dream to work with! I’m excited to leverage this tool for all the various workflows I need to write. I’m currently at 11k invocations a day from the initial workflows I’ve written in the past couple weeks.
Michael Braedley@MBraedleyUpdate: I got it working properly, and it's working so well that I'm dropping IFTTT. @pipedream can do everything that IFTTT basic can, and most (if not all things) IFTTT pro can for free or at a reasonable price if you need it. I am recommending it for basically any power user.
Thomas Cutting@mrthomascuttingWant quick+dirty integrations for a serverless workflow - @pipedream is my new go-to 😃
Matthew Roberts@mattdotrobertsday 013 - finally hit node js. This is the secret sauce of taking #nocode projects that one step further. Pumped about getting deeper into @pipedream now
Kenneth Auchenberg 💭@auchenbergYahoo Pipes is back! Kinda 😍 @pipedream
Raymond Camden 🥑@raymondcamdenAwesome video by the @pipedream folks showing real time twitter sentiment analysis integrated with Google Sheets. This is where Pipedream *really* shines, connecting systems together in easy workflows.
Nacho Caballero@nachocaballeroI couldn't recommend @pipedream more. It's an amazing service to integrate different APIs. Much more powerful than Zapier and more user-friendly than AWS Lambda. I'm very proud to wear this t-shirt #NoCode
Jason Snow@jyksnwDeveloped a working prototype environmental sensor IoT solution with @particle Photon, @pipedream, and @MongoDB with full graphing and alerting in less than a day! All amazing technology, will def. be exploring these more.
Steven Terrana@steven_terrana@burgwyn you've inspired me to finally set up my own blog. I'll make sure my first blog post explains the tech behind the setup. think @obsdmd + @GatsbyJS + @pipedream.
🚄 James Augeri, PhD@DotDotJamesWant to low-code your back end, need more horsepower than @Bubble / @KnackHQ, or just miss Yahoo! Pipes? Check out @PipeDream
Sébastien Chopin@AtinuxGitHub issues should be like @linear_app for maintainers. Looking forward more integrations with GH actions or tools like @pipedream 👀
Raul@raul_predescuIf you're a dev and not using @pipedream, you're missing out. Been using it for months, daily. FREE for devs. Plenty of integrations and good limits. Absolutely love it.
Bruno Skvorc@bitfallsSo @pipedream is pretty amazing. In 3 minutes I just made a flow which adds @rickastley's Never Gonna Give You Up to my @spotify playlist whenever a new pull request arrives in an old repo of mine.
Zach Lanich@ZachLanichUm, wow 🤯 @pipedream
Steven Bell@bellontechI just used @pipedream to build a Shopify App. Wow, they make small backed tasks easy.
Jay Hack 🎩🇺🇸@_jayhack_Very impressed with this bad boi - it reminds me of a @PalantirTech internal tool, but geared towards integrations instead of data analysis and far more customizable. Great expectations here 🚀🤩
Tree Sturgeon 🔥🚴♂️🌳@philsturgeonFor context this is day 2 of a really challenging and stupid migration from Notion to @airtable with disparate/missing data. It's going better than expected and thanks to @pipedream I don't have to bother the iOS dev to add W3W.