@copperline/rendex 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Copperline Labs LLC
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,171 @@
+# @copperline/rendex
+
+Official TypeScript SDK for the [Rendex](https://rendex.dev) screenshot API. Capture any webpage as a high-quality image with a single function call.
+
+- Zero runtime dependencies (uses native `fetch`)
+- Full TypeScript types with IntelliSense
+- Works in Node.js 18+, Deno, Bun, and browsers
+- Typed error handling with API error codes
+
+## Install
+
+```bash
+npm install @copperline/rendex
+# or
+pnpm add @copperline/rendex
+# or
+bun add @copperline/rendex
+```
+
+## Quick Start
+
+```typescript
+import { Rendex } from "@copperline/rendex";
+
+const rendex = new Rendex("your-api-key");
+
+// Capture a screenshot (returns binary image)
+const { image, metadata } = await rendex.screenshot({
+  url: "https://example.com",
+  format: "png",
+  fullPage: true,
+});
+
+// Write to file (Node.js)
+import { writeFile } from "node:fs/promises";
+await writeFile("screenshot.png", image);
+
+console.log(`${metadata.bytesSize} bytes, loaded in ${metadata.loadTimeMs}ms`);
+```
+
+## API Reference
+
+### `new Rendex(apiKey, config?)`
+
+Create a new Rendex client.
+
+```typescript
+const rendex = new Rendex("your-api-key", {
+  baseUrl: "https://api.rendex.dev", // optional, default
+});
+```
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `apiKey` | `string` | Your Rendex API key. Get one at [rendex.dev](https://rendex.dev) |
+| `config.baseUrl` | `string` | Override the API base URL |
+| `config.fetch` | `typeof fetch` | Custom fetch implementation (for testing) |
+
+### `rendex.screenshot(options)`
+
+Capture a screenshot and return the binary image with metadata.
+
+```typescript
+const { image, metadata } = await rendex.screenshot({
+  url: "https://example.com",
+  format: "webp",
+  width: 1920,
+  height: 1080,
+  darkMode: true,
+});
+```
+
+**Returns** `Promise<ScreenshotResult>`:
+- `image` — `Uint8Array` of the captured image
+- `metadata` — `ScreenshotMetadata` with URL, dimensions, format, bytes, load time, quality signal
+
+### `rendex.screenshotJson(options)`
+
+Capture a screenshot and return JSON with a base64-encoded image.
+
+```typescript
+const result = await rendex.screenshotJson({
+  url: "https://example.com",
+});
+
+console.log(result.data.image);          // base64 string
+console.log(result.data.bytesSize);      // 45823
+console.log(result.meta.usage?.remaining); // 499
+```
+
+**Returns** `Promise<ScreenshotJsonResponse>` with `data` (image + metadata) and `meta` (request ID, usage).
+
+### `rendex.screenshotUrl(options)`
+
+Generate a GET URL for embedding. No network call — pure URL builder.
+
+```typescript
+const url = rendex.screenshotUrl({
+  url: "https://example.com",
+  format: "png",
+  width: 1200,
+});
+// Use in <img> tags, OpenGraph, etc.
+```
+
+> **Note**: The API key is included in the URL. Use server-side only.
+
+**Returns** `string` — a complete URL to the screenshot endpoint.
+
+### Screenshot Options
+
+All options except `url` are optional:
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `url` | `string` | *required* | The webpage URL to capture |
+| `format` | `"png" \| "jpeg" \| "webp" \| "pdf"` | `"png"` | Output format |
+| `width` | `number` | `1280` | Viewport width (320–3840) |
+| `height` | `number` | `800` | Viewport height (240–2160) |
+| `fullPage` | `boolean` | `false` | Capture the full scrollable page |
+| `quality` | `number` | — | JPEG/WebP quality (1–100) |
+| `delay` | `number` | `0` | Delay before capture in ms (0–10000) |
+| `darkMode` | `boolean` | `false` | Emulate dark mode |
+| `deviceScaleFactor` | `number` | `1` | Device pixel ratio (1–3) for Retina |
+| `blockAds` | `boolean` | `true` | Block ads and trackers |
+| `blockResourceTypes` | `string[]` | — | Block: `"font"`, `"image"`, `"media"`, `"stylesheet"`, `"other"` |
+| `timeout` | `number` | `30` | Page load timeout in seconds (5–60) |
+| `waitUntil` | `string` | `"networkidle2"` | Wait strategy: `"load"`, `"domcontentloaded"`, `"networkidle0"`, `"networkidle2"` |
+| `waitForSelector` | `string` | — | CSS selector to wait for before capture |
+| `bestAttempt` | `boolean` | `true` | Return best-effort screenshot on timeout |
+| `selector` | `string` | — | Capture a specific element by CSS selector |
+
+## Error Handling
+
+```typescript
+import { Rendex, RendexApiError, RendexNetworkError } from "@copperline/rendex";
+
+const rendex = new Rendex("your-api-key");
+
+try {
+  await rendex.screenshot({ url: "https://example.com" });
+} catch (error) {
+  if (error instanceof RendexApiError) {
+    // API returned an error
+    console.error(error.errorCode);  // "RATE_LIMITED", "VALIDATION_ERROR", etc.
+    console.error(error.statusCode); // 429, 400, etc.
+    console.error(error.requestId);  // For debugging with Rendex support
+    console.error(error.details);    // Validation details (if any)
+  } else if (error instanceof RendexNetworkError) {
+    // Network failure (DNS, timeout, connection refused)
+    console.error("Network error:", error.message);
+  }
+}
+```
+
+### Error Codes
+
+| Code | HTTP Status | Description |
+|------|-------------|-------------|
+| `VALIDATION_ERROR` | 400 | Invalid request parameters |
+| `INVALID_URL` | 400 | URL failed SSRF validation |
+| `TIMEOUT` | 408 | Page took too long to load |
+| `CAPTURE_FAILED` | 500 | Browser rendering error |
+| `RATE_LIMITED` | 429 | Rate limit exceeded |
+| `USAGE_EXCEEDED` | 429 | Monthly credit limit reached |
+| `MISSING_API_KEY` | 401 | No API key provided |
+| `INVALID_API_KEY` | 401 | API key verification failed |
+
+## License
+
+MIT - [Copperline Labs LLC](https://copperlinelabs.com)

package/dist/client.d.ts

@@ -0,0 +1,72 @@
+import type { BatchCreateResponse, BatchOptions, BatchStatusResponse, JobStatusResponse, RendexConfig, ScreenshotJsonResponse, ScreenshotOptions, ScreenshotResult } from "./types.js";
+export declare class Rendex {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly _fetch;
+    constructor(apiKey: string, config?: RendexConfig);
+    /**
+     * Capture a screenshot and return the binary image with metadata.
+     *
+     * ```ts
+     * const { image, metadata } = await rendex.screenshot({ url: "https://example.com" });
+     * ```
+     */
+    screenshot(options: ScreenshotOptions): Promise<ScreenshotResult>;
+    /**
+     * Capture a screenshot and return a JSON response with base64-encoded image.
+     *
+     * ```ts
+     * const result = await rendex.screenshotJson({ url: "https://example.com" });
+     * console.log(result.data.bytesSize, result.meta.usage?.remaining);
+     * ```
+     */
+    screenshotJson(options: ScreenshotOptions): Promise<ScreenshotJsonResponse>;
+    /**
+     * Generate a signed GET URL for embedding (no network call).
+     *
+     * Useful for `<img>` tags, OpenGraph images, or anywhere you need a URL.
+     *
+     * **Note**: The API key is included in the URL. Use server-side only.
+     *
+     * ```ts
+     * const url = rendex.screenshotUrl({ url: "https://example.com" });
+     * // => "https://api.rendex.dev/v1/screenshot?url=...&key=..."
+     * ```
+     */
+    screenshotUrl(options: ScreenshotOptions): string;
+    /**
+     * Submit a batch of URLs for async capture.
+     *
+     * ```ts
+     * const batch = await rendex.batch({
+     *   urls: ["https://example.com", "https://github.com"],
+     *   defaults: { format: "webp", fullPage: true },
+     * });
+     * console.log(batch.data.batchId); // poll with batchStatus()
+     * ```
+     */
+    batch(options: BatchOptions): Promise<BatchCreateResponse>;
+    /**
+     * Check the status of an async job.
+     *
+     * ```ts
+     * const job = await rendex.jobStatus("uuid-here");
+     * if (job.data.status === "completed") console.log(job.data.resultUrl);
+     * ```
+     */
+    jobStatus(jobId: string): Promise<JobStatusResponse>;
+    /**
+     * Check the status of a batch and all its jobs.
+     *
+     * ```ts
+     * const batch = await rendex.batchStatus("uuid-here");
+     * console.log(`${batch.data.completedJobs}/${batch.data.totalJobs} done`);
+     * ```
+     */
+    batchStatus(batchId: string): Promise<BatchStatusResponse>;
+    private _post;
+    private _get;
+    private _handleErrorResponse;
+    private _parseMetadataHeaders;
+}
+//# sourceMappingURL=client.d.ts.map

package/dist/client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,mBAAmB,EACnB,YAAY,EACZ,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,sBAAsB,EAEtB,iBAAiB,EACjB,gBAAgB,EACjB,MAAM,YAAY,CAAC;AAIpB,qBAAa,MAAM;IACjB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0B;gBAErC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,YAAY;IASjD;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASvE;;;;;;;OAOG;IACG,cAAc,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,sBAAsB,CAAC;IAiBjF;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,OAAO,EAAE,iBAAiB,GAAG,MAAM;IAqBjD;;;;;;;;;;OAUG;IACG,KAAK,CAAC,OAAO,EAAE,YAAY,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAiBhE;;;;;;;OAOG;IACG,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAiB1D;;;;;;;OAOG;IACG,WAAW,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;YAmBlD,KAAK;YAyBL,IAAI;YAuBJ,oBAAoB;IAoBlC,OAAO,CAAC,qBAAqB;CAc9B"}

package/dist/client.js

@@ -0,0 +1,195 @@
+// ─── Rendex SDK Client ───────────────────────────────────────────────
+import { RendexApiError, RendexError, RendexNetworkError } from "./errors.js";
+const DEFAULT_BASE_URL = "https://api.rendex.dev";
+export class Rendex {
+    apiKey;
+    baseUrl;
+    _fetch;
+    constructor(apiKey, config) {
+        if (!apiKey) {
+            throw new RendexError("API key is required. Get one at https://rendex.dev");
+        }
+        this.apiKey = apiKey;
+        this.baseUrl = (config?.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
+        this._fetch = config?.fetch ?? globalThis.fetch;
+    }
+    /**
+     * Capture a screenshot and return the binary image with metadata.
+     *
+     * ```ts
+     * const { image, metadata } = await rendex.screenshot({ url: "https://example.com" });
+     * ```
+     */
+    async screenshot(options) {
+        const response = await this._post("/v1/screenshot", options);
+        const image = new Uint8Array(await response.arrayBuffer());
+        const metadata = this._parseMetadataHeaders(response.headers, image.byteLength);
+        return { image, metadata };
+    }
+    /**
+     * Capture a screenshot and return a JSON response with base64-encoded image.
+     *
+     * ```ts
+     * const result = await rendex.screenshotJson({ url: "https://example.com" });
+     * console.log(result.data.bytesSize, result.meta.usage?.remaining);
+     * ```
+     */
+    async screenshotJson(options) {
+        const response = await this._post("/v1/screenshot/json", options);
+        const body = await response.json();
+        if (!body.success) {
+            throw new RendexApiError(body.error?.message ?? "Unknown error", response.status, body.error?.code ?? "UNKNOWN", body.meta?.requestId, body.error?.details);
+        }
+        return body;
+    }
+    /**
+     * Generate a signed GET URL for embedding (no network call).
+     *
+     * Useful for `<img>` tags, OpenGraph images, or anywhere you need a URL.
+     *
+     * **Note**: The API key is included in the URL. Use server-side only.
+     *
+     * ```ts
+     * const url = rendex.screenshotUrl({ url: "https://example.com" });
+     * // => "https://api.rendex.dev/v1/screenshot?url=...&key=..."
+     * ```
+     */
+    screenshotUrl(options) {
+        const params = new URLSearchParams();
+        params.set("key", this.apiKey);
+        // Only simple scalars and arrays go in query params.
+        // Complex objects (cookies, headers, pdfMargin) are POST-only.
+        for (const [key, value] of Object.entries(options)) {
+            if (value === undefined || value === null)
+                continue;
+            if (typeof value === "object" && !Array.isArray(value))
+                continue;
+            if (Array.isArray(value)) {
+                for (const item of value) {
+                    params.append(key, String(item));
+                }
+            }
+            else {
+                params.set(key, String(value));
+            }
+        }
+        return `${this.baseUrl}/v1/screenshot?${params.toString()}`;
+    }
+    /**
+     * Submit a batch of URLs for async capture.
+     *
+     * ```ts
+     * const batch = await rendex.batch({
+     *   urls: ["https://example.com", "https://github.com"],
+     *   defaults: { format: "webp", fullPage: true },
+     * });
+     * console.log(batch.data.batchId); // poll with batchStatus()
+     * ```
+     */
+    async batch(options) {
+        const response = await this._post("/v1/screenshot/batch", options);
+        const body = await response.json();
+        if (!body.success) {
+            throw new RendexApiError(body.error?.message ?? "Unknown error", response.status, body.error?.code ?? "UNKNOWN", body.meta?.requestId, body.error?.details);
+        }
+        return body;
+    }
+    /**
+     * Check the status of an async job.
+     *
+     * ```ts
+     * const job = await rendex.jobStatus("uuid-here");
+     * if (job.data.status === "completed") console.log(job.data.resultUrl);
+     * ```
+     */
+    async jobStatus(jobId) {
+        const response = await this._get(`/v1/jobs/${jobId}`);
+        const body = await response.json();
+        if (!body.success) {
+            throw new RendexApiError(body.error?.message ?? "Unknown error", response.status, body.error?.code ?? "UNKNOWN", body.meta?.requestId, body.error?.details);
+        }
+        return body;
+    }
+    /**
+     * Check the status of a batch and all its jobs.
+     *
+     * ```ts
+     * const batch = await rendex.batchStatus("uuid-here");
+     * console.log(`${batch.data.completedJobs}/${batch.data.totalJobs} done`);
+     * ```
+     */
+    async batchStatus(batchId) {
+        const response = await this._get(`/v1/batches/${batchId}`);
+        const body = await response.json();
+        if (!body.success) {
+            throw new RendexApiError(body.error?.message ?? "Unknown error", response.status, body.error?.code ?? "UNKNOWN", body.meta?.requestId, body.error?.details);
+        }
+        return body;
+    }
+    // ─── Private ─────────────────────────────────────────────────────
+    async _post(path, body) {
+        let response;
+        try {
+            response = await this._fetch(`${this.baseUrl}${path}`, {
+                method: "POST",
+                headers: {
+                    "Content-Type": "application/json",
+                    Authorization: `Bearer ${this.apiKey}`,
+                },
+                body: JSON.stringify(body),
+            });
+        }
+        catch (err) {
+            throw new RendexNetworkError(`Network request to ${this.baseUrl}${path} failed: ${err instanceof Error ? err.message : String(err)}`, err);
+        }
+        if (!response.ok) {
+            await this._handleErrorResponse(response);
+        }
+        return response;
+    }
+    async _get(path) {
+        let response;
+        try {
+            response = await this._fetch(`${this.baseUrl}${path}`, {
+                method: "GET",
+                headers: {
+                    Authorization: `Bearer ${this.apiKey}`,
+                },
+            });
+        }
+        catch (err) {
+            throw new RendexNetworkError(`Network request to ${this.baseUrl}${path} failed: ${err instanceof Error ? err.message : String(err)}`, err);
+        }
+        if (!response.ok) {
+            await this._handleErrorResponse(response);
+        }
+        return response;
+    }
+    async _handleErrorResponse(response) {
+        let body;
+        try {
+            body = await response.json();
+        }
+        catch {
+            // Response body isn't JSON — throw with status info only
+        }
+        const error = body?.error;
+        const meta = body?.meta;
+        throw new RendexApiError(error?.message ?? `HTTP ${response.status}`, response.status, error?.code ?? "UNKNOWN", meta?.requestId, error?.details);
+    }
+    _parseMetadataHeaders(headers, fallbackSize) {
+        return {
+            url: headers.get("x-screenshot-url") ?? "",
+            width: parseInt(headers.get("x-screenshot-width") ?? "0", 10),
+            height: parseInt(headers.get("x-screenshot-height") ?? "0", 10),
+            format: headers.get("x-rendex-format") ?? "png",
+            bytesSize: parseInt(headers.get("x-screenshot-size") ?? String(fallbackSize), 10),
+            capturedAt: headers.get("x-screenshot-captured-at") ?? new Date().toISOString(),
+            quality: (headers.get("x-rendex-quality") ?? "full"),
+            waitStrategy: headers.get("x-rendex-wait-strategy") ?? "unknown",
+            loadTimeMs: parseInt(headers.get("x-rendex-load-time-ms") ?? "0", 10),
+            truncated: headers.get("x-rendex-truncated") === "true",
+        };
+    }
+}
+//# sourceMappingURL=client.js.map

package/dist/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,wEAAwE;AAExE,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAa9E,MAAM,gBAAgB,GAAG,wBAAwB,CAAC;AAElD,MAAM,OAAO,MAAM;IACA,MAAM,CAAS;IACf,OAAO,CAAS;IAChB,MAAM,CAA0B;IAEjD,YAAY,MAAc,EAAE,MAAqB;QAC/C,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,MAAM,IAAI,WAAW,CAAC,oDAAoD,CAAC,CAAC;QAC9E,CAAC;QACD,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,OAAO,GAAG,CAAC,MAAM,EAAE,OAAO,IAAI,gBAAgB,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,GAAG,MAAM,EAAE,KAAK,IAAI,UAAU,CAAC,KAAK,CAAC;IAClD,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,OAA0B;QACzC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,gBAAgB,EAAE,OAAO,CAAC,CAAC;QAE7D,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC,CAAC;QAC3D,MAAM,QAAQ,GAAG,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;QAEhF,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,OAA0B;QAC7C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,qBAAqB,EAAE,OAAO,CAAC,CAAC;QAClE,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,cAAc,CACtB,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,eAAe,EACtC,QAAQ,CAAC,MAAM,EACf,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAC7B,IAAI,CAAC,IAAI,EAAE,SAAS,EACpB,IAAI,CAAC,KAAK,EAAE,OAAO,CACpB,CAAC;QACJ,CAAC;QAED,OAAO,IAA8B,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,OAA0B;QACtC,MAAM,MAAM,GAAG,IAAI,eAAe,EAAE,CAAC;QACrC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAE/B,qDAAqD;QACrD,+DAA+D;QAC/D,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACnD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,IAAI;gBAAE,SAAS;YACpD,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC;gBAAE,SAAS;YACjE,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC;gBACnC,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACjC,CAAC;QACH,CAAC;QAED,OAAO,GAAG,IAAI,CAAC,OAAO,kBAAkB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,KAAK,CAAC,OAAqB;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,sBAAsB,EAAE,OAAO,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,cAAc,CACtB,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,eAAe,EACtC,QAAQ,CAAC,MAAM,EACf,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAC7B,IAAI,CAAC,IAAI,EAAE,SAAS,EACpB,IAAI,CAAC,KAAK,EAAE,OAAO,CACpB,CAAC;QACJ,CAAC;QAED,OAAO,IAA2B,CAAC;IACrC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,SAAS,CAAC,KAAa;QAC3B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,YAAY,KAAK,EAAE,CAAC,CAAC;QACtD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,cAAc,CACtB,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,eAAe,EACtC,QAAQ,CAAC,MAAM,EACf,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAC7B,IAAI,CAAC,IAAI,EAAE,SAAS,EACpB,IAAI,CAAC,KAAK,EAAE,OAAO,CACpB,CAAC;QACJ,CAAC;QAED,OAAO,IAAyB,CAAC;IACnC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,OAAe;QAC/B,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,IAAI,CAAC,eAAe,OAAO,EAAE,CAAC,CAAC;QAC3D,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAEnC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,IAAI,cAAc,CACtB,IAAI,CAAC,KAAK,EAAE,OAAO,IAAI,eAAe,EACtC,QAAQ,CAAC,MAAM,EACf,IAAI,CAAC,KAAK,EAAE,IAAI,IAAI,SAAS,EAC7B,IAAI,CAAC,IAAI,EAAE,SAAS,EACpB,IAAI,CAAC,KAAK,EAAE,OAAO,CACpB,CAAC;QACJ,CAAC;QAED,OAAO,IAA2B,CAAC;IACrC,CAAC;IAED,oEAAoE;IAE5D,KAAK,CAAC,KAAK,CAAC,IAAY,EAAE,IAAa;QAC7C,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;gBACrD,MAAM,EAAE,MAAM;gBACd,OAAO,EAAE;oBACP,cAAc,EAAE,kBAAkB;oBAClC,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACvC;gBACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC3B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,kBAAkB,CAC1B,sBAAsB,IAAI,CAAC,OAAO,GAAG,IAAI,YAAY,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EACvG,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,IAAI,CAAC,IAAY;QAC7B,IAAI,QAAkB,CAAC;QACvB,IAAI,CAAC;YACH,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,OAAO,GAAG,IAAI,EAAE,EAAE;gBACrD,MAAM,EAAE,KAAK;gBACb,OAAO,EAAE;oBACP,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,EAAE;iBACvC;aACF,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,MAAM,IAAI,kBAAkB,CAC1B,sBAAsB,IAAI,CAAC,OAAO,GAAG,IAAI,YAAY,GAAG,YAAY,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EACvG,GAAG,CACJ,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,MAAM,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;QAC5C,CAAC;QAED,OAAO,QAAQ,CAAC;IAClB,CAAC;IAEO,KAAK,CAAC,oBAAoB,CAAC,QAAkB;QACnD,IAAI,IAAyC,CAAC;QAC9C,IAAI,CAAC;YACH,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC/B,CAAC;QAAC,MAAM,CAAC;YACP,yDAAyD;QAC3D,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,EAAE,KAA4C,CAAC;QACjE,MAAM,IAAI,GAAG,IAAI,EAAE,IAA2C,CAAC;QAE/D,MAAM,IAAI,cAAc,CACrB,KAAK,EAAE,OAAkB,IAAI,QAAQ,QAAQ,CAAC,MAAM,EAAE,EACvD,QAAQ,CAAC,MAAM,EACd,KAAK,EAAE,IAAe,IAAI,SAAS,EACpC,IAAI,EAAE,SAA+B,EACrC,KAAK,EAAE,OAAO,CACf,CAAC;IACJ,CAAC;IAEO,qBAAqB,CAAC,OAAgB,EAAE,YAAoB;QAClE,OAAO;YACL,GAAG,EAAE,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,EAAE;YAC1C,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC;YAC7D,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC;YAC/D,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,IAAI,KAAK;YAC/C,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,IAAI,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,CAAC;YACjF,UAAU,EAAE,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE;YAC/E,OAAO,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAC,IAAI,MAAM,CAAkC;YACrF,YAAY,EAAE,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAC,IAAI,SAAS;YAChE,UAAU,EAAE,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC;YACrE,SAAS,EAAE,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,KAAK,MAAM;SACxD,CAAC;IACJ,CAAC;CACF"}

package/dist/errors.d.ts

@@ -0,0 +1,24 @@
+import type { ApiErrorCode } from "./types.js";
+/** Base error for all Rendex SDK errors. */
+export declare class RendexError extends Error {
+    constructor(message: string);
+}
+/** Error returned by the Rendex API (non-2xx response with a parsed body). */
+export declare class RendexApiError extends RendexError {
+    /** HTTP status code (e.g. 400, 401, 429, 500). */
+    readonly statusCode: number;
+    /** API error code (e.g. "RATE_LIMITED", "VALIDATION_ERROR"). */
+    readonly errorCode: ApiErrorCode | string;
+    /** Unique request ID for debugging with Rendex support. */
+    readonly requestId: string | undefined;
+    /** Additional error details (e.g. validation field errors). */
+    readonly details: unknown;
+    constructor(message: string, statusCode: number, errorCode: string, requestId?: string, details?: unknown);
+}
+/** Network-level error (DNS failure, timeout, connection refused, etc.). */
+export declare class RendexNetworkError extends RendexError {
+    /** The underlying error from fetch. */
+    readonly cause: unknown;
+    constructor(message: string, cause: unknown);
+}
+//# sourceMappingURL=errors.d.ts.map

package/dist/errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,4CAA4C;AAC5C,qBAAa,WAAY,SAAQ,KAAK;gBACxB,OAAO,EAAE,MAAM;CAI5B;AAED,8EAA8E;AAC9E,qBAAa,cAAe,SAAQ,WAAW;IAC7C,kDAAkD;IAClD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,SAAS,EAAE,YAAY,GAAG,MAAM,CAAC;IAC1C,2DAA2D;IAC3D,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,+DAA+D;IAC/D,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;gBAGxB,OAAO,EAAE,MAAM,EACf,UAAU,EAAE,MAAM,EAClB,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,OAAO;CASpB;AAED,4EAA4E;AAC5E,qBAAa,kBAAmB,SAAQ,WAAW;IACjD,uCAAuC;IACvC,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;gBAEZ,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO;CAK5C"}

package/dist/errors.js

@@ -0,0 +1,38 @@
+// ─── Rendex SDK Errors ───────────────────────────────────────────────
+/** Base error for all Rendex SDK errors. */
+export class RendexError extends Error {
+    constructor(message) {
+        super(message);
+        this.name = "RendexError";
+    }
+}
+/** Error returned by the Rendex API (non-2xx response with a parsed body). */
+export class RendexApiError extends RendexError {
+    /** HTTP status code (e.g. 400, 401, 429, 500). */
+    statusCode;
+    /** API error code (e.g. "RATE_LIMITED", "VALIDATION_ERROR"). */
+    errorCode;
+    /** Unique request ID for debugging with Rendex support. */
+    requestId;
+    /** Additional error details (e.g. validation field errors). */
+    details;
+    constructor(message, statusCode, errorCode, requestId, details) {
+        super(message);
+        this.name = "RendexApiError";
+        this.statusCode = statusCode;
+        this.errorCode = errorCode;
+        this.requestId = requestId;
+        this.details = details;
+    }
+}
+/** Network-level error (DNS failure, timeout, connection refused, etc.). */
+export class RendexNetworkError extends RendexError {
+    /** The underlying error from fetch. */
+    cause;
+    constructor(message, cause) {
+        super(message);
+        this.name = "RendexNetworkError";
+        this.cause = cause;
+    }
+}
+//# sourceMappingURL=errors.js.map

package/dist/errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"errors.js","sourceRoot":"","sources":["../src/errors.ts"],"names":[],"mappings":"AAAA,wEAAwE;AAIxE,4CAA4C;AAC5C,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YAAY,OAAe;QACzB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,8EAA8E;AAC9E,MAAM,OAAO,cAAe,SAAQ,WAAW;IAC7C,kDAAkD;IACzC,UAAU,CAAS;IAC5B,gEAAgE;IACvD,SAAS,CAAwB;IAC1C,2DAA2D;IAClD,SAAS,CAAqB;IACvC,+DAA+D;IACtD,OAAO,CAAU;IAE1B,YACE,OAAe,EACf,UAAkB,EAClB,SAAiB,EACjB,SAAkB,EAClB,OAAiB;QAEjB,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC;QAC7B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;CACF;AAED,4EAA4E;AAC5E,MAAM,OAAO,kBAAmB,SAAQ,WAAW;IACjD,uCAAuC;IAC9B,KAAK,CAAU;IAExB,YAAY,OAAe,EAAE,KAAc;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,IAAI,GAAG,oBAAoB,CAAC;QACjC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { Rendex } from "./client.js";
+export { RendexError, RendexApiError, RendexNetworkError } from "./errors.js";
+export type { ScreenshotOptions, ScreenshotResult, ScreenshotMetadata, ScreenshotJsonResponse, ScreenshotData, BatchOptions, BatchCreateResponse, BatchStatusResponse, JobStatusResponse, JobStatus, BatchStatus, CookieParam, PdfMargin, ResponseMeta, UsageInfo, RendexConfig, ApiErrorCode, } from "./types.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAC9E,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,sBAAsB,EACtB,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,SAAS,EACT,WAAW,EACX,WAAW,EACX,SAAS,EACT,YAAY,EACZ,SAAS,EACT,YAAY,EACZ,YAAY,GACb,MAAM,YAAY,CAAC"}

package/dist/index.js

@@ -0,0 +1,4 @@
+// ─── @copperline/rendex — Official TypeScript SDK ────────────────────
+export { Rendex } from "./client.js";
+export { RendexError, RendexApiError, RendexNetworkError } from "./errors.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,wEAAwE;AAExE,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,219 @@
+/** Cookie to set before navigation. */
+export interface CookieParam {
+    name: string;
+    value: string;
+    /** Cookie domain. Auto-derived from URL if omitted. */
+    domain?: string;
+    /** Cookie path. @default "/" */
+    path?: string;
+    httpOnly?: boolean;
+    secure?: boolean;
+    sameSite?: "Strict" | "Lax" | "None";
+    /** Unix timestamp for expiry. */
+    expires?: number;
+}
+/** PDF margin configuration (CSS units: "0", "1cm", "20px", etc.). */
+export interface PdfMargin {
+    top?: string;
+    right?: string;
+    bottom?: string;
+    left?: string;
+}
+/** Options for capturing a screenshot or PDF. Provide either `url` or `html` (not both). */
+export interface ScreenshotOptions {
+    /** The URL to capture. Mutually exclusive with `html`. */
+    url?: string;
+    /** Raw HTML to render. Mutually exclusive with `url`. Max 5MB. */
+    html?: string;
+    /** Output format. "pdf" returns a PDF document instead of an image. @default "png" */
+    format?: "png" | "jpeg" | "webp" | "pdf";
+    /** Viewport width in pixels (320–3840). @default 1280 */
+    width?: number;
+    /** Viewport height in pixels (240–2160). @default 800 */
+    height?: number;
+    /** Capture the full scrollable page. @default false */
+    fullPage?: boolean;
+    /** JPEG/WebP quality (1–100). Ignored for PNG and PDF. */
+    quality?: number;
+    /** Delay in milliseconds before capture (0–10000). @default 0 */
+    delay?: number;
+    /** Emulate dark mode (prefers-color-scheme: dark). @default false */
+    darkMode?: boolean;
+    /** Device pixel ratio (1–3). @default 1 */
+    deviceScaleFactor?: number;
+    /** Block ads and trackers. @default true */
+    blockAds?: boolean;
+    /** Resource types to block. */
+    blockResourceTypes?: ("font" | "image" | "media" | "stylesheet" | "other")[];
+    /** Page load timeout in seconds (5–60). @default 30 */
+    timeout?: number;
+    /** Navigation wait strategy. @default "networkidle2" */
+    waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2";
+    /** Wait for a CSS selector to appear before capture. */
+    waitForSelector?: string;
+    /** Return best-effort screenshot on timeout instead of erroring. @default true */
+    bestAttempt?: boolean;
+    /** CSS selector to capture a specific element instead of the full page. */
+    selector?: string;
+    /** Custom CSS to inject into the page before capture. Max 50KB. */
+    css?: string;
+    /** Custom JavaScript to execute in the page before capture. Max 50KB. */
+    js?: string;
+    /** Cookies to set before navigation. Max 50. */
+    cookies?: CookieParam[];
+    /** Custom HTTP headers for the navigation request. */
+    headers?: Record<string, string>;
+    /** Override the browser user agent string. */
+    userAgent?: string;
+    /** PDF page size. @default "A4" */
+    pdfFormat?: "A4" | "Letter" | "Legal" | "Tabloid" | "A3";
+    /** PDF landscape orientation. @default false */
+    pdfLandscape?: boolean;
+    /** Print background colors/images in PDF. @default true */
+    pdfPrintBackground?: boolean;
+    /** PDF page margins (CSS units). */
+    pdfMargin?: PdfMargin;
+    /** PDF scale factor (0.1–2). @default 1 */
+    pdfScale?: number;
+    /** ISO 3166-1 alpha-2 country code for geo-targeted capture (e.g., "US", "DE", "JP"). Pro/Enterprise only. */
+    geo?: string;
+    /** City for more precise geo-targeting. Requires `geo` to be set. */
+    geoCity?: string;
+    /** State/region for more precise geo-targeting. Requires `geo` to be set. */
+    geoState?: string;
+    /** Return a job ID immediately instead of waiting for the result. */
+    async?: boolean;
+    /** URL to receive a webhook when the capture completes. */
+    webhookUrl?: string;
+    /** How long the signed result URL stays valid, in seconds (3600–2592000). @default 86400 */
+    cacheTtl?: number;
+}
+/** Metadata extracted from response headers for binary screenshots. */
+export interface ScreenshotMetadata {
+    url: string;
+    width: number;
+    height: number;
+    format: string;
+    bytesSize: number;
+    capturedAt: string;
+    quality: "full" | "degraded" | "best_attempt";
+    waitStrategy: string;
+    loadTimeMs: number;
+    truncated: boolean;
+    renderingEngine?: "cf-browser" | "decodo-proxy";
+    geoCountry?: string;
+}
+/** Result from `Rendex.screenshot()` — binary image with metadata. */
+export interface ScreenshotResult {
+    /** Raw image bytes. Write to file, upload to S3, etc. */
+    image: Uint8Array;
+    /** Capture metadata extracted from response headers. */
+    metadata: ScreenshotMetadata;
+}
+/** Usage information from the API response. */
+export interface UsageInfo {
+    credits: number;
+    remaining: number;
+}
+/** Response metadata envelope. */
+export interface ResponseMeta {
+    requestId: string;
+    timestamp: string;
+    usage?: UsageInfo;
+}
+/** Screenshot data from the JSON endpoint. */
+export interface ScreenshotData {
+    /** Base64-encoded image data. */
+    image: string;
+    contentType: string;
+    url: string;
+    width: number;
+    height: number;
+    format: string;
+    bytesSize: number;
+    capturedAt: string;
+    quality: "full" | "degraded" | "best_attempt";
+    waitStrategy: string;
+    loadTimeMs: number;
+    truncated?: boolean;
+}
+/** Result from `Rendex.screenshotJson()`. */
+export interface ScreenshotJsonResponse {
+    success: true;
+    data: ScreenshotData;
+    meta: ResponseMeta;
+}
+/** SDK configuration options. */
+export interface RendexConfig {
+    /** Override the base API URL. @default "https://api.rendex.dev" */
+    baseUrl?: string;
+    /** Custom fetch implementation (for testing or custom environments). */
+    fetch?: typeof globalThis.fetch;
+}
+/** Job status from `GET /v1/jobs/:jobId`. */
+export type JobStatus = "queued" | "processing" | "completed" | "failed";
+/** Response from `Rendex.jobStatus()`. */
+export interface JobStatusResponse {
+    success: true;
+    data: {
+        jobId: string;
+        status: JobStatus;
+        resultUrl?: string;
+        error?: string;
+        createdAt: string;
+        completedAt?: string;
+    };
+    meta: ResponseMeta;
+}
+/** Batch status. */
+export type BatchStatus = "processing" | "completed" | "partial" | "failed";
+/** Options for `Rendex.batch()`. */
+export interface BatchOptions {
+    /** URLs to capture (1–500 depending on plan). */
+    urls: string[];
+    /** Default capture params applied to all URLs. */
+    defaults?: Omit<ScreenshotOptions, "url" | "html" | "async" | "webhookUrl" | "cacheTtl">;
+    /** Webhook URL called when the entire batch completes. */
+    webhookUrl?: string;
+    /** Signed URL TTL in seconds (3600–2592000). @default 86400 */
+    cacheTtl?: number;
+}
+/** Response from `Rendex.batch()` — 202 Accepted. */
+export interface BatchCreateResponse {
+    success: true;
+    data: {
+        batchId: string;
+        totalJobs: number;
+        jobs: Array<{
+            jobId: string;
+            url: string;
+            status: "queued";
+        }>;
+    };
+    meta: ResponseMeta;
+}
+/** Response from `Rendex.batchStatus()`. */
+export interface BatchStatusResponse {
+    success: true;
+    data: {
+        batchId: string;
+        status: BatchStatus;
+        totalJobs: number;
+        completedJobs: number;
+        failedJobs: number;
+        createdAt: string;
+        completedAt?: string;
+        jobs: Array<{
+            jobId: string;
+            status: JobStatus;
+            resultUrl?: string;
+            error?: string;
+            createdAt: string;
+            completedAt?: string;
+        }>;
+    };
+    meta: ResponseMeta;
+}
+/** Known API error codes returned by the Rendex API. */
+export type ApiErrorCode = "VALIDATION_ERROR" | "INVALID_URL" | "INVALID_JSON" | "TIMEOUT" | "CAPTURE_FAILED" | "MISSING_API_KEY" | "INVALID_API_KEY" | "KEY_DISABLED" | "RATE_LIMITED" | "USAGE_EXCEEDED" | "NOT_FOUND" | "GEO_FEATURE_UNAVAILABLE" | "PLAN_UPGRADE_REQUIRED" | "CONFIGURATION_ERROR";
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAEA,uCAAuC;AACvC,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,gCAAgC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;IACrC,iCAAiC;IACjC,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,sEAAsE;AACtE,MAAM,WAAW,SAAS;IACxB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,4FAA4F;AAC5F,MAAM,WAAW,iBAAiB;IAChC,0DAA0D;IAC1D,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sFAAsF;IACtF,MAAM,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;IACzC,yDAAyD;IACzD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,yDAAyD;IACzD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uDAAuD;IACvD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,qEAAqE;IACrE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,2CAA2C;IAC3C,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+BAA+B;IAC/B,kBAAkB,CAAC,EAAE,CAAC,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,YAAY,GAAG,OAAO,CAAC,EAAE,CAAC;IAC7E,uDAAuD;IACvD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wDAAwD;IACxD,SAAS,CAAC,EAAE,MAAM,GAAG,kBAAkB,GAAG,cAAc,GAAG,cAAc,CAAC;IAC1E,wDAAwD;IACxD,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kFAAkF;IAClF,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,mEAAmE;IACnE,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,yEAAyE;IACzE,EAAE,CAAC,EAAE,MAAM,CAAC;IAGZ,gDAAgD;IAChD,OAAO,CAAC,EAAE,WAAW,EAAE,CAAC;IACxB,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAC;IAGnB,mCAAmC;IACnC,SAAS,CAAC,EAAE,IAAI,GAAG,QAAQ,GAAG,OAAO,GAAG,SAAS,GAAG,IAAI,CAAC;IACzD,gDAAgD;IAChD,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,2DAA2D;IAC3D,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,oCAAoC;IACpC,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,2CAA2C;IAC3C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,8GAA8G;IAC9G,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,qEAAqE;IACrE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,MAAM,CAAC;IAGlB,qEAAqE;IACrE,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,2DAA2D;IAC3D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,4FAA4F;IAC5F,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,uEAAuE;AACvE,MAAM,WAAW,kBAAkB;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc,CAAC;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,OAAO,CAAC;IACnB,eAAe,CAAC,EAAE,YAAY,GAAG,cAAc,CAAC;IAChD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,sEAAsE;AACtE,MAAM,WAAW,gBAAgB;IAC/B,yDAAyD;IACzD,KAAK,EAAE,UAAU,CAAC;IAClB,wDAAwD;IACxD,QAAQ,EAAE,kBAAkB,CAAC;CAC9B;AAED,+CAA+C;AAC/C,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,kCAAkC;AAClC,MAAM,WAAW,YAAY;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,8CAA8C;AAC9C,MAAM,WAAW,cAAc;IAC7B,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,GAAG,UAAU,GAAG,cAAc,CAAC;IAC9C,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,6CAA6C;AAC7C,MAAM,WAAW,sBAAsB;IACrC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE,cAAc,CAAC;IACrB,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,iCAAiC;AACjC,MAAM,WAAW,YAAY;IAC3B,mEAAmE;IACnE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,wEAAwE;IACxE,KAAK,CAAC,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACjC;AAID,6CAA6C;AAC7C,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;AAEzE,0CAA0C;AAC1C,MAAM,WAAW,iBAAiB;IAChC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,SAAS,CAAC;QAClB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;IACF,IAAI,EAAE,YAAY,CAAC;CACpB;AAID,oBAAoB;AACpB,MAAM,MAAM,WAAW,GAAG,YAAY,GAAG,WAAW,GAAG,SAAS,GAAG,QAAQ,CAAC;AAE5E,oCAAoC;AACpC,MAAM,WAAW,YAAY;IAC3B,iDAAiD;IACjD,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,kDAAkD;IAClD,QAAQ,CAAC,EAAE,IAAI,CAAC,iBAAiB,EAAE,KAAK,GAAG,MAAM,GAAG,OAAO,GAAG,YAAY,GAAG,UAAU,CAAC,CAAC;IACzF,0DAA0D;IAC1D,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qDAAqD;AACrD,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,KAAK,CAAC;YAAE,KAAK,EAAE,MAAM,CAAC;YAAC,GAAG,EAAE,MAAM,CAAC;YAAC,MAAM,EAAE,QAAQ,CAAA;SAAE,CAAC,CAAC;KAC/D,CAAC;IACF,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,4CAA4C;AAC5C,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,IAAI,CAAC;IACd,IAAI,EAAE;QACJ,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,WAAW,CAAC;QACpB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,EAAE,MAAM,CAAC;QACtB,UAAU,EAAE,MAAM,CAAC;QACnB,SAAS,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,KAAK,CAAC;YACV,KAAK,EAAE,MAAM,CAAC;YACd,MAAM,EAAE,SAAS,CAAC;YAClB,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,SAAS,EAAE,MAAM,CAAC;YAClB,WAAW,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC,CAAC;KACJ,CAAC;IACF,IAAI,EAAE,YAAY,CAAC;CACpB;AAED,wDAAwD;AACxD,MAAM,MAAM,YAAY,GACpB,kBAAkB,GAClB,aAAa,GACb,cAAc,GACd,SAAS,GACT,gBAAgB,GAChB,iBAAiB,GACjB,iBAAiB,GACjB,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,WAAW,GACX,yBAAyB,GACzB,uBAAuB,GACvB,qBAAqB,CAAC"}

package/dist/types.js

@@ -0,0 +1,3 @@
+// ─── Rendex SDK Types ────────────────────────────────────────────────
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,wEAAwE"}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@copperline/rendex",
+  "version": "1.0.0",
+  "description": "Official TypeScript SDK for the Rendex screenshot API — capture any webpage as an image",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "dev": "tsc --watch",
+    "prepublishOnly": "tsc"
+  },
+  "keywords": [
+    "rendex",
+    "screenshot",
+    "screenshot-api",
+    "webpage-capture",
+    "sdk",
+    "typescript",
+    "copperline",
+    "ai-agent",
+    "mcp"
+  ],
+  "author": "Copperline Labs LLC",
+  "license": "MIT",
+  "homepage": "https://rendex.dev",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/copperline-labs/copperline-labs",
+    "directory": "packages/rendex-js"
+  },
+  "devDependencies": {
+    "typescript": "^5.7.0"
+  }
+}