renderscreenshot 1.0.0

package/dist/cjs/client.js

@@ -0,0 +1,304 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const node_crypto_1 = require("node:crypto");
+const errors_js_1 = require("./errors.js");
+const options_js_1 = require("./options.js");
+const cache_js_1 = require("./cache.js");
+const DEFAULT_BASE_URL = 'https://api.renderscreenshot.com';
+const DEFAULT_TIMEOUT = 30000;
+const API_VERSION = 'v1';
+/**
+ * Parse a response body from the API
+ */
+async function parseResponseBody(response) {
+    const contentType = response.headers.get('content-type') ?? '';
+    if (contentType.includes('application/json')) {
+        return response.json();
+    }
+    return response.text();
+}
+/**
+ * Handle API errors and convert to RenderScreenshotError
+ */
+async function handleApiError(response) {
+    const retryAfterHeader = response.headers.get('retry-after');
+    const retryAfter = retryAfterHeader !== null ? parseInt(retryAfterHeader, 10) : undefined;
+    const body = await parseResponseBody(response);
+    const errorBody = typeof body === 'object' && body !== null ? body : {};
+    const errorParams = {};
+    if (typeof errorBody['code'] === 'string')
+        errorParams.code = errorBody['code'];
+    if (typeof errorBody['message'] === 'string')
+        errorParams.message = errorBody['message'];
+    if (typeof errorBody['error'] === 'string')
+        errorParams.error = errorBody['error'];
+    throw errors_js_1.RenderScreenshotError.fromResponse(response.status, errorParams, retryAfter);
+}
+/**
+ * RenderScreenshot API client
+ */
+class Client {
+    apiKey;
+    baseUrl;
+    timeout;
+    /** Cache management methods */
+    cache;
+    /**
+     * Create a new RenderScreenshot client
+     * @param apiKey - Your API key (rs_live_* or rs_test_*)
+     * @param options - Optional client configuration
+     */
+    constructor(apiKey, options = {}) {
+        if (apiKey === '' || apiKey === undefined) {
+            throw new Error('API key is required');
+        }
+        this.apiKey = apiKey;
+        this.baseUrl = options.baseUrl ?? DEFAULT_BASE_URL;
+        this.timeout = options.timeout ?? DEFAULT_TIMEOUT;
+        this.cache = new cache_js_1.CacheManager(this);
+    }
+    /**
+     * Get the API key for internal use
+     * @internal
+     */
+    getApiKey() {
+        return this.apiKey;
+    }
+    /**
+     * Get the base URL for internal use
+     * @internal
+     */
+    getBaseUrl() {
+        return this.baseUrl;
+    }
+    /**
+     * Get the timeout for internal use
+     * @internal
+     */
+    getTimeout() {
+        return this.timeout;
+    }
+    /**
+     * Make an authenticated request to the API
+     * @internal
+     */
+    async request(method, path, options = {}) {
+        const url = `${this.baseUrl}/${API_VERSION}${path}`;
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => {
+            controller.abort();
+        }, this.timeout);
+        try {
+            const headers = {
+                Authorization: `Bearer ${this.apiKey}`,
+                'User-Agent': 'renderscreenshot-node/1.0.0',
+                ...options.headers,
+            };
+            if (options.body !== undefined) {
+                headers['Content-Type'] = 'application/json';
+            }
+            const fetchOptions = {
+                method,
+                headers,
+                signal: controller.signal,
+            };
+            if (options.body !== undefined) {
+                fetchOptions.body = JSON.stringify(options.body);
+            }
+            const response = await fetch(url, fetchOptions);
+            if (!response.ok) {
+                await handleApiError(response);
+            }
+            if (options.responseType === 'buffer') {
+                const arrayBuffer = await response.arrayBuffer();
+                return Buffer.from(arrayBuffer);
+            }
+            return (await response.json());
+        }
+        catch (error) {
+            if (error instanceof errors_js_1.RenderScreenshotError) {
+                throw error;
+            }
+            if (error instanceof Error && error.name === 'AbortError') {
+                throw errors_js_1.RenderScreenshotError.timeout();
+            }
+            throw errors_js_1.RenderScreenshotError.internal(error instanceof Error ? error.message : 'Unknown error');
+        }
+        finally {
+            clearTimeout(timeoutId);
+        }
+    }
+    /**
+     * Generate a signed URL for embedding screenshots
+     *
+     * @param options - Screenshot options (TakeOptions instance or config object)
+     * @param expiresAt - Expiration time for the signed URL
+     * @returns Signed URL string
+     *
+     * @example
+     * ```typescript
+     * const url = client.generateUrl(
+     *   TakeOptions.url('https://example.com').preset('og_card'),
+     *   new Date(Date.now() + 24 * 60 * 60 * 1000) // 24 hours
+     * );
+     * ```
+     */
+    generateUrl(options, expiresAt) {
+        const config = options instanceof options_js_1.TakeOptions ? options.toConfig() : options;
+        // Extract the public key from api key (rs_pub_xxx or use the full key for signing)
+        // For signed URLs, we need a secret key (rs_secret_xxx) and a public key (rs_pub_xxx)
+        // If user provides rs_live_xxx, we'll use it directly
+        // Build query params from config
+        const params = {};
+        if (config.url !== undefined)
+            params['url'] = config.url;
+        if (config.width !== undefined)
+            params['width'] = String(config.width);
+        if (config.height !== undefined)
+            params['height'] = String(config.height);
+        if (config.scale !== undefined)
+            params['scale'] = String(config.scale);
+        if (config.mobile !== undefined)
+            params['mobile'] = String(config.mobile);
+        if (config.fullPage !== undefined)
+            params['full_page'] = String(config.fullPage);
+        if (config.element !== undefined)
+            params['element'] = config.element;
+        if (config.format !== undefined)
+            params['format'] = config.format;
+        if (config.quality !== undefined)
+            params['quality'] = String(config.quality);
+        if (config.preset !== undefined)
+            params['preset'] = config.preset;
+        if (config.device !== undefined)
+            params['device'] = config.device;
+        if (config.waitFor !== undefined)
+            params['wait_for'] = config.waitFor;
+        if (config.delay !== undefined)
+            params['delay'] = String(config.delay);
+        if (config.blockAds !== undefined)
+            params['block_ads'] = String(config.blockAds);
+        if (config.blockTrackers !== undefined)
+            params['block_trackers'] = String(config.blockTrackers);
+        if (config.blockCookieBanners !== undefined)
+            params['block_cookie_banners'] = String(config.blockCookieBanners);
+        if (config.blockChatWidgets !== undefined)
+            params['block_chat_widgets'] = String(config.blockChatWidgets);
+        if (config.darkMode !== undefined)
+            params['dark_mode'] = String(config.darkMode);
+        if (config.cacheTtl !== undefined)
+            params['cache_ttl'] = String(config.cacheTtl);
+        // Sort params alphabetically and create canonical string
+        const sortedKeys = Object.keys(params).sort();
+        const canonical = sortedKeys.map((k) => `${k}=${params[k]}`).join('&');
+        // Add expiration
+        const expires = Math.floor(expiresAt.getTime() / 1000);
+        const message = `${canonical}&expires=${expires}`;
+        // Generate signature
+        const signature = (0, node_crypto_1.createHmac)('sha256', this.apiKey).update(message).digest('hex');
+        return `${this.baseUrl}/${API_VERSION}/screenshot?${message}&signature=${signature}`;
+    }
+    /**
+     * Take a screenshot and return the binary data
+     *
+     * @param options - Screenshot options (TakeOptions instance or config object)
+     * @returns Buffer containing the screenshot binary data
+     *
+     * @example
+     * ```typescript
+     * const image = await client.take(
+     *   TakeOptions.url('https://example.com').preset('og_card')
+     * );
+     * await fs.writeFile('screenshot.png', image);
+     * ```
+     */
+    async take(options) {
+        const params = options instanceof options_js_1.TakeOptions ? options.toParams() : options_js_1.TakeOptions.from(options).toParams();
+        return this.request('POST', '/screenshot', {
+            body: params,
+            responseType: 'buffer',
+        });
+    }
+    /**
+     * Take a screenshot and return JSON metadata with URLs
+     *
+     * @param options - Screenshot options (TakeOptions instance or config object)
+     * @returns Screenshot response with metadata and URLs
+     *
+     * @example
+     * ```typescript
+     * const response = await client.takeJson(
+     *   TakeOptions.url('https://example.com').preset('og_card')
+     * );
+     * console.log(response.url); // CDN URL to the screenshot
+     * ```
+     */
+    async takeJson(options) {
+        const params = options instanceof options_js_1.TakeOptions ? options.toParams() : options_js_1.TakeOptions.from(options).toParams();
+        return this.request('POST', '/screenshot', {
+            body: { ...params, response_type: 'json' },
+        });
+    }
+    async batch(urlsOrRequests, options) {
+        // Type guard to check if it's an array of strings (URLs)
+        const isUrlArray = (arr) => arr.every((item) => typeof item === 'string');
+        let body;
+        if (isUrlArray(urlsOrRequests)) {
+            const opts = options instanceof options_js_1.TakeOptions
+                ? options.toParams()
+                : options !== undefined
+                    ? options_js_1.TakeOptions.from(options).toParams()
+                    : {};
+            body = {
+                urls: urlsOrRequests,
+                options: opts,
+            };
+        }
+        else {
+            body = {
+                requests: urlsOrRequests.map((req) => ({
+                    url: req.url,
+                    ...options_js_1.TakeOptions.from(req.options ?? {}).toParams(),
+                })),
+            };
+        }
+        return this.request('POST', '/batch', { body });
+    }
+    /**
+     * Get the status of a batch job
+     *
+     * @param batchId - The batch job ID
+     * @returns Batch status and results
+     */
+    async getBatch(batchId) {
+        return this.request('GET', `/batch/${batchId}`);
+    }
+    /**
+     * List all available presets
+     *
+     * @returns Array of preset configurations
+     */
+    async presets() {
+        return this.request('GET', '/presets');
+    }
+    /**
+     * Get a single preset by ID
+     *
+     * @param id - Preset identifier
+     * @returns Preset configuration
+     */
+    async preset(id) {
+        return this.request('GET', `/presets/${id}`);
+    }
+    /**
+     * List all available device presets
+     *
+     * @returns Array of device configurations
+     */
+    async devices() {
+        return this.request('GET', '/devices');
+    }
+}
+exports.Client = Client;
+//# sourceMappingURL=client.js.map

package/dist/cjs/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;AAAA,6CAAyC;AAUzC,2CAAoD;AACpD,6CAA2C;AAC3C,yCAA0C;AAE1C,MAAM,gBAAgB,GAAG,kCAAkC,CAAC;AAC5D,MAAM,eAAe,GAAG,KAAK,CAAC;AAC9B,MAAM,WAAW,GAAG,IAAI,CAAC;AAEzB;;GAEG;AACH,KAAK,UAAU,iBAAiB,CAAC,QAAkB;IACjD,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC;IAC/D,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC,EAAE,CAAC;QAC7C,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;IACzB,CAAC;IACD,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,cAAc,CAAC,QAAkB;IAC9C,MAAM,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IAC7D,MAAM,UAAU,GAAG,gBAAgB,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,gBAAgB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAE1F,MAAM,IAAI,GAAG,MAAM,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,SAAS,GACb,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,CAAC,CAAC,CAAE,IAAgC,CAAC,CAAC,CAAC,EAAE,CAAC;IAErF,MAAM,WAAW,GAAwD,EAAE,CAAC;IAC5E,IAAI,OAAO,SAAS,CAAC,MAAM,CAAC,KAAK,QAAQ;QAAE,WAAW,CAAC,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IAChF,IAAI,OAAO,SAAS,CAAC,SAAS,CAAC,KAAK,QAAQ;QAAE,WAAW,CAAC,OAAO,GAAG,SAAS,CAAC,SAAS,CAAC,CAAC;IACzF,IAAI,OAAO,SAAS,CAAC,OAAO,CAAC,KAAK,QAAQ;QAAE,WAAW,CAAC,KAAK,GAAG,SAAS,CAAC,OAAO,CAAC,CAAC;IAEnF,MAAM,iCAAqB,CAAC,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;AACrF,CAAC;AAED;;GAEG;AACH,MAAa,MAAM;IACA,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,OAAO,CAAS;IAEjC,+BAA+B;IACtB,KAAK,CAAe;IAE7B;;;;OAIG;IACH,YAAY,MAAc,EAAE,UAAyB,EAAE;QACrD,IAAI,MAAM,KAAK,EAAE,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;YAC1C,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,gBAAgB,CAAC;QACnD,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,eAAe,CAAC;QAClD,IAAI,CAAC,KAAK,GAAG,IAAI,uBAAY,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,UAAU;QACR,OAAO,IAAI,CAAC,OAAO,CAAC;IACtB,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,OAAO,CACX,MAAc,EACd,IAAY,EACZ,UAII,EAAE;QAEN,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,IAAI,WAAW,GAAG,IAAI,EAAE,CAAC;QACpD,MAAM,UAAU,GAAG,IAAI,eAAe,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAEjB,IAAI,CAAC;YACH,MAAM,OAAO,GAA2B;gBACtC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;gBACtC,YAAY,EAAE,6BAA6B;gBAC3C,GAAG,OAAO,CAAC,OAAO;aACnB,CAAC;YAEF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC/B,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;YAC/C,CAAC;YAED,MAAM,YAAY,GAAgB;gBAChC,MAAM;gBACN,OAAO;gBACP,MAAM,EAAE,UAAU,CAAC,MAAM;aAC1B,CAAC;YAEF,IAAI,OAAO,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBAC/B,YAAY,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACnD,CAAC;YAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;YAEhD,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,MAAM,cAAc,CAAC,QAAQ,CAAC,CAAC;YACjC,CAAC;YAED,IAAI,OAAO,CAAC,YAAY,KAAK,QAAQ,EAAE,CAAC;gBACtC,MAAM,WAAW,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;gBACjD,OAAO,MAAM,CAAC,IAAI,CAAC,WAAW,CAAM,CAAC;YACvC,CAAC;YAED,OAAO,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAM,CAAC;QACtC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,iCAAqB,EAAE,CAAC;gBAC3C,MAAM,KAAK,CAAC;YACd,CAAC;YACD,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBAC1D,MAAM,iCAAqB,CAAC,OAAO,EAAE,CAAC;YACxC,CAAC;YACD,MAAM,iCAAqB,CAAC,QAAQ,CAClC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,eAAe,CACzD,CAAC;QACJ,CAAC;gBAAS,CAAC;YACT,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,WAAW,CAAC,OAAwC,EAAE,SAAe;QACnE,MAAM,MAAM,GAAG,OAAO,YAAY,wBAAW,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;QAE7E,mFAAmF;QACnF,sFAAsF;QACtF,sDAAsD;QAEtD,iCAAiC;QACjC,MAAM,MAAM,GAA2B,EAAE,CAAC;QAE1C,IAAI,MAAM,CAAC,GAAG,KAAK,SAAS;YAAE,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC,GAAG,CAAC;QACzD,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAC1E,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjF,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC;QACrE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QAClE,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,CAAC,SAAS,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC7E,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QAClE,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS;YAAE,MAAM,CAAC,QAAQ,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC;QAClE,IAAI,MAAM,CAAC,OAAO,KAAK,SAAS;YAAE,MAAM,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,OAAO,CAAC;QACtE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;YAAE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACvE,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjF,IAAI,MAAM,CAAC,aAAa,KAAK,SAAS;YAAE,MAAM,CAAC,gBAAgB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QAChG,IAAI,MAAM,CAAC,kBAAkB,KAAK,SAAS;YACzC,MAAM,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC;QACrE,IAAI,MAAM,CAAC,gBAAgB,KAAK,SAAS;YACvC,MAAM,CAAC,oBAAoB,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC;QACjE,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QACjF,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;YAAE,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAEjF,yDAAyD;QACzD,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,CAAC;QAC9C,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAEvE,iBAAiB;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;QACvD,MAAM,OAAO,GAAG,GAAG,SAAS,YAAY,OAAO,EAAE,CAAC;QAElD,qBAAqB;QACrB,MAAM,SAAS,GAAG,IAAA,wBAAU,EAAC,QAAQ,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAElF,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,WAAW,eAAe,OAAO,cAAc,SAAS,EAAE,CAAC;IACvF,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CAAC,OAAwC;QACjD,MAAM,MAAM,GACV,OAAO,YAAY,wBAAW,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,wBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC,OAAO,CAAS,MAAM,EAAE,aAAa,EAAE;YACjD,IAAI,EAAE,MAAM;YACZ,YAAY,EAAE,QAAQ;SACvB,CAAC,CAAC;IACL,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAwC;QACrD,MAAM,MAAM,GACV,OAAO,YAAY,wBAAW,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,wBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,CAAC;QAC7F,OAAO,IAAI,CAAC,OAAO,CAAqB,MAAM,EAAE,aAAa,EAAE;YAC7D,IAAI,EAAE,EAAE,GAAG,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;IAmCD,KAAK,CAAC,KAAK,CACT,cAA6C,EAC7C,OAAyC;QAEzC,yDAAyD;QACzD,MAAM,UAAU,GAAG,CAAC,GAAc,EAAmB,EAAE,CACrD,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,KAAK,QAAQ,CAAC,CAAC;QAEhD,IAAI,IAA6B,CAAC;QAElC,IAAI,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,GACR,OAAO,YAAY,wBAAW;gBAC5B,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACpB,CAAC,CAAC,OAAO,KAAK,SAAS;oBACrB,CAAC,CAAC,wBAAW,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;oBACtC,CAAC,CAAC,EAAE,CAAC;YACX,IAAI,GAAG;gBACL,IAAI,EAAE,cAAc;gBACpB,OAAO,EAAE,IAAI;aACd,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,IAAI,GAAG;gBACL,QAAQ,EAAE,cAAc,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;oBACrC,GAAG,EAAE,GAAG,CAAC,GAAG;oBACZ,GAAG,wBAAW,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,QAAQ,EAAE;iBAClD,CAAC,CAAC;aACJ,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC,OAAO,CAAgB,MAAM,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,OAAe;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAgB,KAAK,EAAE,UAAU,OAAO,EAAE,CAAC,CAAC;IACjE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,OAAO,CAAe,KAAK,EAAE,UAAU,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,MAAM,CAAC,EAAU;QACrB,OAAO,IAAI,CAAC,OAAO,CAAa,KAAK,EAAE,YAAY,EAAE,EAAE,CAAC,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO;QACX,OAAO,IAAI,CAAC,OAAO,CAAe,KAAK,EAAE,UAAU,CAAC,CAAC;IACvD,CAAC;CACF;AApUD,wBAoUC"}

package/dist/cjs/errors.js

@@ -0,0 +1,85 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RenderScreenshotError = void 0;
+/**
+ * Mapping of error codes to their retryable status
+ */
+const RETRYABLE_ERRORS = new Set([
+    'rate_limited',
+    'timeout',
+    'render_failed',
+    'internal_error',
+]);
+/**
+ * Custom error class for RenderScreenshot API errors
+ */
+class RenderScreenshotError extends Error {
+    /** HTTP status code */
+    httpStatus;
+    /** Error code from the API */
+    code;
+    /** Whether this error can be retried */
+    retryable;
+    /** Seconds to wait before retrying (for rate limits) */
+    retryAfter;
+    constructor(httpStatus, code, message, retryAfter) {
+        super(message);
+        this.name = 'RenderScreenshotError';
+        this.httpStatus = httpStatus;
+        this.code = code;
+        this.retryable = RETRYABLE_ERRORS.has(code);
+        if (retryAfter !== undefined) {
+            this.retryAfter = retryAfter;
+        }
+        // Maintains proper stack trace for where error was thrown (V8 only)
+        if (Error.captureStackTrace !== undefined) {
+            Error.captureStackTrace(this, RenderScreenshotError);
+        }
+    }
+    /**
+     * Create an error from an API response
+     */
+    static fromResponse(httpStatus, body, retryAfter) {
+        const code = (body.code ?? 'internal_error');
+        const message = body.message ?? body.error ?? 'An unknown error occurred';
+        return new RenderScreenshotError(httpStatus, code, message, retryAfter);
+    }
+    /**
+     * Create an invalid URL error
+     */
+    static invalidUrl(url) {
+        return new RenderScreenshotError(400, 'invalid_url', `Invalid URL provided: ${url}`);
+    }
+    /**
+     * Create an invalid request error
+     */
+    static invalidRequest(message) {
+        return new RenderScreenshotError(400, 'invalid_request', message);
+    }
+    /**
+     * Create an unauthorized error
+     */
+    static unauthorized() {
+        return new RenderScreenshotError(401, 'unauthorized', 'Invalid or missing API key');
+    }
+    /**
+     * Create a rate limited error
+     */
+    static rateLimited(retryAfter) {
+        return new RenderScreenshotError(429, 'rate_limited', 'Rate limit exceeded. Please wait before making more requests.', retryAfter);
+    }
+    /**
+     * Create a timeout error
+     */
+    static timeout() {
+        return new RenderScreenshotError(408, 'timeout', 'Screenshot request timed out');
+    }
+    /**
+     * Create an internal error
+     */
+    static internal(message) {
+        return new RenderScreenshotError(500, 'internal_error', message ?? 'An internal error occurred');
+    }
+}
+exports.RenderScreenshotError = RenderScreenshotError;
+//# sourceMappingURL=errors.js.map

package/dist/cjs/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":";;;AAcA;;GAEG;AACH,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAAY;IAC1C,cAAc;IACd,SAAS;IACT,eAAe;IACf,gBAAgB;CACjB,CAAC,CAAC;AAEH;;GAEG;AACH,MAAa,qBAAsB,SAAQ,KAAK;IAC9C,uBAAuB;IACd,UAAU,CAAS;IAE5B,8BAA8B;IACrB,IAAI,CAAY;IAEzB,wCAAwC;IAC/B,SAAS,CAAU;IAE5B,wDAAwD;IAC/C,UAAU,CAAU;IAE7B,YAAY,UAAkB,EAAE,IAAe,EAAE,OAAe,EAAE,UAAmB;QACnF,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,uBAAuB,CAAC;QACpC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,SAAS,GAAG,gBAAgB,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;YAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC/B,CAAC;QAED,oEAAoE;QACpE,IAAI,KAAK,CAAC,iBAAiB,KAAK,SAAS,EAAE,CAAC;YAC1C,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY,CACjB,UAAkB,EAClB,IAAyD,EACzD,UAAmB;QAEnB,MAAM,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,gBAAgB,CAAc,CAAC;QAC1D,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,KAAK,IAAI,2BAA2B,CAAC;QAC1E,OAAO,IAAI,qBAAqB,CAAC,UAAU,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IAC1E,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,UAAU,CAAC,GAAW;QAC3B,OAAO,IAAI,qBAAqB,CAAC,GAAG,EAAE,aAAa,EAAE,yBAAyB,GAAG,EAAE,CAAC,CAAC;IACvF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,cAAc,CAAC,OAAe;QACnC,OAAO,IAAI,qBAAqB,CAAC,GAAG,EAAE,iBAAiB,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,YAAY;QACjB,OAAO,IAAI,qBAAqB,CAAC,GAAG,EAAE,cAAc,EAAE,4BAA4B,CAAC,CAAC;IACtF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,UAAmB;QACpC,OAAO,IAAI,qBAAqB,CAC9B,GAAG,EACH,cAAc,EACd,+DAA+D,EAC/D,UAAU,CACX,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,OAAO;QACZ,OAAO,IAAI,qBAAqB,CAAC,GAAG,EAAE,SAAS,EAAE,8BAA8B,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,OAAgB;QAC9B,OAAO,IAAI,qBAAqB,CAC9B,GAAG,EACH,gBAAgB,EAChB,OAAO,IAAI,4BAA4B,CACxC,CAAC;IACJ,CAAC;CACF;AA5FD,sDA4FC"}

package/dist/cjs/index.js

@@ -0,0 +1,44 @@
+"use strict";
+/**
+ * RenderScreenshot Node.js SDK
+ *
+ * Official Node.js/TypeScript SDK for the RenderScreenshot API.
+ *
+ * @packageDocumentation
+ * @module renderscreenshot
+ *
+ * @example
+ * Basic usage:
+ * ```typescript
+ * import { Client, TakeOptions } from 'renderscreenshot';
+ *
+ * const client = new Client('rs_live_xxxxx');
+ *
+ * // Take a screenshot
+ * const image = await client.take(
+ *   TakeOptions.url('https://example.com').preset('og_card')
+ * );
+ *
+ * // Generate a signed URL for embedding
+ * const url = client.generateUrl(
+ *   TakeOptions.url('https://example.com').preset('og_card'),
+ *   new Date(Date.now() + 24 * 60 * 60 * 1000)
+ * );
+ * ```
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.extractWebhookHeaders = exports.parseWebhook = exports.verifyWebhook = exports.CacheManager = exports.RenderScreenshotError = exports.TakeOptions = exports.Client = void 0;
+// Main exports
+var client_js_1 = require("./client.js");
+Object.defineProperty(exports, "Client", { enumerable: true, get: function () { return client_js_1.Client; } });
+var options_js_1 = require("./options.js");
+Object.defineProperty(exports, "TakeOptions", { enumerable: true, get: function () { return options_js_1.TakeOptions; } });
+var errors_js_1 = require("./errors.js");
+Object.defineProperty(exports, "RenderScreenshotError", { enumerable: true, get: function () { return errors_js_1.RenderScreenshotError; } });
+var cache_js_1 = require("./cache.js");
+Object.defineProperty(exports, "CacheManager", { enumerable: true, get: function () { return cache_js_1.CacheManager; } });
+var webhooks_js_1 = require("./webhooks.js");
+Object.defineProperty(exports, "verifyWebhook", { enumerable: true, get: function () { return webhooks_js_1.verifyWebhook; } });
+Object.defineProperty(exports, "parseWebhook", { enumerable: true, get: function () { return webhooks_js_1.parseWebhook; } });
+Object.defineProperty(exports, "extractWebhookHeaders", { enumerable: true, get: function () { return webhooks_js_1.extractWebhookHeaders; } });
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;;;AAEH,eAAe;AACf,yCAAqC;AAA5B,mGAAA,MAAM,OAAA;AACf,2CAA2C;AAAlC,yGAAA,WAAW,OAAA;AACpB,yCAAoD;AAA3C,kHAAA,qBAAqB,OAAA;AAE9B,uCAA0C;AAAjC,wGAAA,YAAY,OAAA;AACrB,6CAAmF;AAA1E,4GAAA,aAAa,OAAA;AAAE,2GAAA,YAAY,OAAA;AAAE,oHAAA,qBAAqB,OAAA"}