Add URL to PDF example

Author: krasun

README.md

@@ -9,6 +9,7 @@ All examples contain a README with instructions on how to build and run them.
 ### Node.js
 
 1. [Google Slides Scrolling Screenshots](./nodejs/google-slides-scrolling-screenshots) is a simple application that uses ScreenshotOne API to render scrolling screenshots of Google Slides presentations.
+2. [URL to PDF](./nodejs/url-to-pdf) is a simple application that uses ScreenshotOne API to render a URL as PDF.
 
 ### Python
 

nodejs/url-to-pdf/.gitignore

@@ -0,0 +1,3 @@
+.env
+node_modules/
+*.pdf 

nodejs/url-to-pdf/README.md

@@ -0,0 +1,72 @@
+# URL to PDF Converter
+
+A simple Node.js program to render a URL as PDF using [the ScreenshotOne API](https://screenshotone.com/).
+
+## Prerequisites
+
+-   Node.js
+-   npm
+-   [ScreenshotOne API](https://screenshotone.com/) access key
+
+## Installation
+
+1. Clone this repository or download the source code.
+
+```bash
+git clone https://github.com/screenshotone/examples.git
+```
+
+2. Navigate to the project directory.
+
+```bash
+cd examples/nodejs/url-to-pdf
+```
+
+3. Install the dependencies:
+
+```bash
+npm install
+```
+
+4. Create a `.env` file in the project root directory and add your ScreenshotOne API access key:
+
+```
+SCREENSHOTONE_ACCESS_KEY=your_access_key
+```
+
+You can get your API access key by signing up at [ScreenshotOne](https://screenshotone.com/).
+
+## Usage
+
+### Basic Usage
+
+Run the program with a URL to convert it to PDF:
+
+```bash
+node index.js https://example.com
+```
+
+This will generate a PDF file named `output.pdf` in the project directory.
+
+### Custom Output Path
+
+You can specify a custom output path for the PDF file:
+
+```bash
+node index.js https://example.com /path/to/output.pdf
+```
+
+### Retry Mechanism
+
+The application includes a built-in retry mechanism that will automatically retry failed requests up to 3 times with an exponential backoff delay between retries. This helps handle temporary network issues or API rate limits.
+
+You can modify the retry parameters in the `main()` function in `index.js`:
+
+```javascript
+const maxRetries = 3; // Maximum number of retry attempts
+const retryDelay = 2000; // Initial delay between retries in milliseconds
+```
+
+### Advanced Options
+
+You can modify the `options` object in the `main()` function in `index.js` to customize the PDF generation. For a complete list of options, refer to the [ScreenshotOne API documentation](https://screenshotone.com/docs/options/).

nodejs/url-to-pdf/index.js

@@ -0,0 +1,144 @@
+const axios = require("axios");
+const fs = require("fs");
+const path = require("path");
+require("dotenv").config();
+
+// ScreenshotOne API credentials
+const accessKey = process.env.SCREENSHOTONE_ACCESS_KEY;
+
+if (!accessKey) {
+    console.error(
+        "Error: ScreenshotOne API access key is missing. Please check your .env file."
+    );
+    process.exit(1);
+}
+
+// Sleep function for retries
+const sleep = (ms) => new Promise((resolve) => setTimeout(resolve, ms));
+
+// Function to convert URL to PDF with retries
+async function urlToPdf(
+    url,
+    outputPath,
+    options = {},
+    maxRetries = 3,
+    retryDelay = 2000
+) {
+    let retries = 0;
+
+    while (retries <= maxRetries) {
+        try {
+            // Default options for PDF generation
+            const defaultOptions = {
+                url,
+                access_key: accessKey,
+                format: "pdf",
+                pdf_fit_one_page: "true",
+                full_page: "true",
+                wait_until: "networkidle0",
+                pdf_print_background: "true",
+            };
+
+            // Merge default options with custom options
+            const mergedOptions = { ...defaultOptions, ...options };
+
+            // Build query string
+            const queryString = new URLSearchParams(mergedOptions).toString();
+
+            // ScreenshotOne API endpoint
+            const apiUrl = `https://api.screenshotone.com/take?${queryString}`;
+
+            console.log(
+                `Generating PDF for ${url}... (Attempt ${retries + 1}/${
+                    maxRetries + 1
+                })`
+            );
+
+            // Make request to ScreenshotOne API
+            const response = await axios({
+                method: "get",
+                url: apiUrl,
+                responseType: "stream",
+                timeout: 30000, // 30 seconds timeout
+            });
+
+            // Create write stream for output file
+            const writer = fs.createWriteStream(outputPath);
+
+            // Pipe response data to file
+            response.data.pipe(writer);
+
+            return new Promise((resolve, reject) => {
+                writer.on("finish", () => {
+                    console.log(`PDF saved to ${outputPath}`);
+                    resolve(outputPath);
+                });
+                writer.on("error", reject);
+            });
+        } catch (error) {
+            retries++;
+
+            if (retries > maxRetries) {
+                console.error(
+                    `Error generating PDF after ${maxRetries + 1} attempts:`,
+                    error.message
+                );
+                if (error.response) {
+                    console.error(
+                        "API response status:",
+                        error.response.status
+                    );
+                }
+                throw new Error(
+                    `Failed to generate PDF after ${maxRetries + 1} attempts: ${
+                        error.message
+                    }`
+                );
+            }
+
+            console.warn(
+                `Attempt ${retries}/${
+                    maxRetries + 1
+                } failed. Retrying in ${retryDelay}ms...`
+            );
+            console.error("Error:", error.message);
+
+            // Wait before retrying
+            await sleep(retryDelay);
+
+            // Increase retry delay for next attempt (exponential backoff)
+            retryDelay *= 1.5;
+        }
+    }
+}
+
+// Example usage
+async function main() {
+    const url = process.argv[2] || "https://www.example.com";
+    const outputPath = process.argv[3] || path.join(__dirname, "output.pdf");
+
+    try {
+        // Additional options (optional)
+        const options = {
+            // Add any custom options here
+            // delay: 2000,
+            // device_scale_factor: 1,
+            // block_ads: 'true',
+            // pdf_print_background: 'true',
+            // pdf_fit_one_page: 'true',
+        };
+
+        // Set retry parameters
+        const maxRetries = 3; // Maximum number of retry attempts
+        const retryDelay = 2000; // Initial delay between retries in milliseconds
+
+        await urlToPdf(url, outputPath, options, maxRetries, retryDelay);
+        console.log("PDF generation completed successfully!");
+    } catch (error) {
+        console.error("PDF generation failed:", error.message);
+        process.exit(1);
+    }
+}
+
+// Run the main function
+main();