renderscreenshot 1.0.0

package/dist/types/options.d.ts

@@ -0,0 +1,265 @@
+import type { TakeOptionsConfig, ImageFormat, WaitCondition, BlockableResource, MediaType, StorageAcl, Preset, Device, PdfPaperSize, Cookie } from './types.js';
+/**
+ * Fluent builder for screenshot options
+ */
+export declare class TakeOptions {
+    private readonly config;
+    private constructor();
+    /**
+     * Create options with a URL target
+     */
+    static url(url: string): TakeOptions;
+    /**
+     * Create options with HTML content
+     */
+    static html(html: string): TakeOptions;
+    /**
+     * Create options from an existing config
+     */
+    static from(config: TakeOptionsConfig): TakeOptions;
+    /**
+     * Set viewport width in pixels
+     */
+    width(value: number): TakeOptions;
+    /**
+     * Set viewport height in pixels
+     */
+    height(value: number): TakeOptions;
+    /**
+     * Set device scale factor (1-3)
+     */
+    scale(value: number): TakeOptions;
+    /**
+     * Enable mobile emulation
+     */
+    mobile(value?: boolean): TakeOptions;
+    /**
+     * Capture full scrollable page
+     */
+    fullPage(value?: boolean): TakeOptions;
+    /**
+     * Capture specific element by CSS selector
+     */
+    element(selector: string): TakeOptions;
+    /**
+     * Set output format
+     */
+    format(value: ImageFormat): TakeOptions;
+    /**
+     * Set JPEG/WebP quality (1-100)
+     */
+    quality(value: number): TakeOptions;
+    /**
+     * Set wait condition
+     */
+    waitFor(value: WaitCondition): TakeOptions;
+    /**
+     * Add delay after page load (milliseconds)
+     */
+    delay(value: number): TakeOptions;
+    /**
+     * Wait for CSS selector to appear
+     */
+    waitForSelector(selector: string): TakeOptions;
+    /**
+     * Maximum wait time in milliseconds
+     */
+    waitForTimeout(value: number): TakeOptions;
+    /**
+     * Use a preset configuration
+     */
+    preset(value: Preset): TakeOptions;
+    /**
+     * Emulate a specific device
+     */
+    device(value: Device): TakeOptions;
+    /**
+     * Block ad network domains
+     */
+    blockAds(value?: boolean): TakeOptions;
+    /**
+     * Block analytics/tracking
+     */
+    blockTrackers(value?: boolean): TakeOptions;
+    /**
+     * Auto-dismiss cookie popups
+     */
+    blockCookieBanners(value?: boolean): TakeOptions;
+    /**
+     * Block chat widgets
+     */
+    blockChatWidgets(value?: boolean): TakeOptions;
+    /**
+     * Block URLs matching patterns (glob)
+     */
+    blockUrls(patterns: string[]): TakeOptions;
+    /**
+     * Block specific resource types
+     */
+    blockResources(types: BlockableResource[]): TakeOptions;
+    /**
+     * Inject JavaScript (inline or URL)
+     */
+    injectScript(script: string): TakeOptions;
+    /**
+     * Inject CSS (inline or URL)
+     */
+    injectStyle(style: string): TakeOptions;
+    /**
+     * Click element before capture
+     */
+    click(selector: string): TakeOptions;
+    /**
+     * Hide elements (visibility: hidden)
+     */
+    hide(selectors: string[]): TakeOptions;
+    /**
+     * Remove elements from DOM
+     */
+    remove(selectors: string[]): TakeOptions;
+    /**
+     * Enable dark mode (prefers-color-scheme: dark)
+     */
+    darkMode(value?: boolean): TakeOptions;
+    /**
+     * Enable reduced motion preference
+     */
+    reducedMotion(value?: boolean): TakeOptions;
+    /**
+     * Set media type emulation
+     */
+    mediaType(value: MediaType): TakeOptions;
+    /**
+     * Set custom user agent
+     */
+    userAgent(value: string): TakeOptions;
+    /**
+     * Set timezone (IANA format)
+     */
+    timezone(value: string): TakeOptions;
+    /**
+     * Set locale (BCP 47 format)
+     */
+    locale(value: string): TakeOptions;
+    /**
+     * Set geolocation coordinates
+     */
+    geolocation(latitude: number, longitude: number, accuracy?: number): TakeOptions;
+    /**
+     * Set custom HTTP headers
+     */
+    headers(value: Record<string, string>): TakeOptions;
+    /**
+     * Set cookies
+     */
+    cookies(value: Cookie[]): TakeOptions;
+    /**
+     * Set HTTP Basic authentication
+     */
+    authBasic(username: string, password: string): TakeOptions;
+    /**
+     * Set Bearer token authentication
+     */
+    authBearer(token: string): TakeOptions;
+    /**
+     * Bypass Content Security Policy
+     */
+    bypassCsp(value?: boolean): TakeOptions;
+    /**
+     * Set cache TTL in seconds (3600-2592000)
+     */
+    cacheTtl(value: number): TakeOptions;
+    /**
+     * Force cache refresh
+     */
+    cacheRefresh(value?: boolean): TakeOptions;
+    /**
+     * Set PDF paper size
+     */
+    pdfPaperSize(value: PdfPaperSize): TakeOptions;
+    /**
+     * Set custom PDF width (CSS units)
+     */
+    pdfWidth(value: string): TakeOptions;
+    /**
+     * Set custom PDF height (CSS units)
+     */
+    pdfHeight(value: string): TakeOptions;
+    /**
+     * Set PDF landscape orientation
+     */
+    pdfLandscape(value?: boolean): TakeOptions;
+    /**
+     * Set uniform PDF margin (CSS units)
+     */
+    pdfMargin(value: string): TakeOptions;
+    /**
+     * Set PDF top margin
+     */
+    pdfMarginTop(value: string): TakeOptions;
+    /**
+     * Set PDF right margin
+     */
+    pdfMarginRight(value: string): TakeOptions;
+    /**
+     * Set PDF bottom margin
+     */
+    pdfMarginBottom(value: string): TakeOptions;
+    /**
+     * Set PDF left margin
+     */
+    pdfMarginLeft(value: string): TakeOptions;
+    /**
+     * Set PDF scale factor (0.1-2.0)
+     */
+    pdfScale(value: number): TakeOptions;
+    /**
+     * Include background graphics in PDF
+     */
+    pdfPrintBackground(value?: boolean): TakeOptions;
+    /**
+     * Set PDF page ranges (e.g., "1-5, 8")
+     */
+    pdfPageRanges(value: string): TakeOptions;
+    /**
+     * Set PDF header HTML template
+     */
+    pdfHeader(value: string): TakeOptions;
+    /**
+     * Set PDF footer HTML template
+     */
+    pdfFooter(value: string): TakeOptions;
+    /**
+     * Fit content to single PDF page
+     */
+    pdfFitOnePage(value?: boolean): TakeOptions;
+    /**
+     * Use CSS-defined page size for PDF
+     */
+    pdfPreferCssPageSize(value?: boolean): TakeOptions;
+    /**
+     * Enable custom storage upload
+     */
+    storageEnabled(value?: boolean): TakeOptions;
+    /**
+     * Set storage path template
+     */
+    storagePath(value: string): TakeOptions;
+    /**
+     * Set storage ACL
+     */
+    storageAcl(value: StorageAcl): TakeOptions;
+    /**
+     * Get the raw configuration object
+     */
+    toConfig(): TakeOptionsConfig;
+    /**
+     * Convert to API request parameters (for POST body)
+     */
+    toParams(): Record<string, unknown>;
+    /**
+     * Convert to query string (for GET requests)
+     */
+    toQueryString(): string;
+}
+//# sourceMappingURL=options.d.ts.map

package/dist/types/options.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"options.d.ts","sourceRoot":"","sources":["../../src/options.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,iBAAiB,EACjB,SAAS,EACT,UAAU,EACV,MAAM,EACN,MAAM,EACN,YAAY,EACZ,MAAM,EAEP,MAAM,YAAY,CAAC;AAEpB;;GAEG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAoB;IAE3C,OAAO;IAIP;;OAEG;IACH,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,WAAW;IAIpC;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;IAItC;;OAEG;IACH,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,iBAAiB,GAAG,WAAW;IAMnD;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIjC;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIlC;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIjC;;OAEG;IACH,MAAM,CAAC,KAAK,UAAO,GAAG,WAAW;IAMjC;;OAEG;IACH,QAAQ,CAAC,KAAK,UAAO,GAAG,WAAW;IAInC;;OAEG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW;IAItC;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,WAAW,GAAG,WAAW;IAIvC;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAMnC;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,aAAa,GAAG,WAAW;IAI1C;;OAEG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIjC;;OAEG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW;IAI9C;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAM1C;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIlC;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAMlC;;OAEG;IACH,QAAQ,CAAC,KAAK,UAAO,GAAG,WAAW;IAInC;;OAEG;IACH,aAAa,CAAC,KAAK,UAAO,GAAG,WAAW;IAIxC;;OAEG;IACH,kBAAkB,CAAC,KAAK,UAAO,GAAG,WAAW;IAI7C;;OAEG;IACH,gBAAgB,CAAC,KAAK,UAAO,GAAG,WAAW;IAI3C;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,WAAW;IAI1C;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,iBAAiB,EAAE,GAAG,WAAW;IAMvD;;OAEG;IACH,YAAY,CAAC,MAAM,EAAE,MAAM,GAAG,WAAW;IAIzC;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIvC;;OAEG;IACH,KAAK,CAAC,QAAQ,EAAE,MAAM,GAAG,WAAW;IAIpC;;OAEG;IACH,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,WAAW;IAItC;;OAEG;IACH,MAAM,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,WAAW;IAMxC;;OAEG;IACH,QAAQ,CAAC,KAAK,UAAO,GAAG,WAAW;IAInC;;OAEG;IACH,aAAa,CAAC,KAAK,UAAO,GAAG,WAAW;IAIxC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,SAAS,GAAG,WAAW;IAIxC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIrC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIpC;;OAEG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIlC;;OAEG;IACH,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,WAAW;IAUhF;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,WAAW;IAInD;;OAEG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,WAAW;IAIrC;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,WAAW;IAI1D;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAItC;;OAEG;IACH,SAAS,CAAC,KAAK,UAAO,GAAG,WAAW;IAMpC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIpC;;OAEG;IACH,YAAY,CAAC,KAAK,UAAO,GAAG,WAAW;IAMvC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,YAAY,GAAG,WAAW;IAI9C;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIpC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIrC;;OAEG;IACH,YAAY,CAAC,KAAK,UAAO,GAAG,WAAW;IAIvC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIrC;;OAEG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIxC;;OAEG;IACH,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAI1C;;OAEG;IACH,eAAe,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAI3C;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIzC;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIpC;;OAEG;IACH,kBAAkB,CAAC,KAAK,UAAO,GAAG,WAAW;IAI7C;;OAEG;IACH,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIzC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIrC;;OAEG;IACH,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIrC;;OAEG;IACH,aAAa,CAAC,KAAK,UAAO,GAAG,WAAW;IAIxC;;OAEG;IACH,oBAAoB,CAAC,KAAK,UAAO,GAAG,WAAW;IAM/C;;OAEG;IACH,cAAc,CAAC,KAAK,UAAO,GAAG,WAAW;IAIzC;;OAEG;IACH,WAAW,CAAC,KAAK,EAAE,MAAM,GAAG,WAAW;IAIvC;;OAEG;IACH,UAAU,CAAC,KAAK,EAAE,UAAU,GAAG,WAAW;IAM1C;;OAEG;IACH,QAAQ,IAAI,iBAAiB;IAI7B;;OAEG;IACH,QAAQ,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IA+JnC;;OAEG;IACH,aAAa,IAAI,MAAM;CAiExB"}

package/dist/types/types.d.ts

@@ -0,0 +1,249 @@
+/**
+ * Client configuration options
+ */
+export interface ClientOptions {
+    /** Base URL for the API (defaults to https://api.renderscreenshot.com) */
+    baseUrl?: string;
+    /** Request timeout in milliseconds (defaults to 30000) */
+    timeout?: number;
+}
+/**
+ * Screenshot format options
+ */
+export type ImageFormat = 'png' | 'jpeg' | 'webp' | 'pdf';
+/**
+ * Wait condition types
+ */
+export type WaitCondition = 'load' | 'networkidle' | 'domcontentloaded';
+/**
+ * Resource types that can be blocked
+ */
+export type BlockableResource = 'font' | 'media' | 'image' | 'script' | 'stylesheet';
+/**
+ * Media type emulation
+ */
+export type MediaType = 'screen' | 'print';
+/**
+ * Storage ACL options
+ */
+export type StorageAcl = 'public-read' | 'private';
+/**
+ * Preset identifiers
+ */
+export type Preset = 'og_card' | 'twitter_card' | 'twitter_card_large' | 'full_page' | 'mobile' | 'mobile_landscape' | 'desktop_hd' | 'desktop_4k' | 'link_preview' | 'pdf_document';
+/**
+ * Device identifiers
+ */
+export type Device = 'iphone_14_pro' | 'iphone_14' | 'iphone_se' | 'pixel_7' | 'pixel_7_pro' | 'samsung_galaxy_s23' | 'ipad_pro_12' | 'ipad_air' | 'macbook_pro_16' | 'macbook_air_15' | 'imac_24' | 'desktop_1080p' | 'desktop_1440p' | 'desktop_4k' | 'surface_pro';
+/**
+ * PDF paper size options
+ */
+export type PdfPaperSize = 'a0' | 'a1' | 'a2' | 'a3' | 'a4' | 'a5' | 'a6' | 'letter' | 'legal' | 'tabloid';
+/**
+ * Cookie configuration
+ */
+export interface Cookie {
+    name: string;
+    value: string;
+    domain?: string;
+    path?: string;
+    expires?: number;
+    httpOnly?: boolean;
+    secure?: boolean;
+    sameSite?: 'Strict' | 'Lax' | 'None';
+}
+/**
+ * Geolocation configuration
+ */
+export interface Geolocation {
+    latitude: number;
+    longitude: number;
+    accuracy?: number;
+}
+/**
+ * Screenshot options configuration
+ */
+export interface TakeOptionsConfig {
+    url?: string;
+    html?: string;
+    width?: number;
+    height?: number;
+    scale?: number;
+    mobile?: boolean;
+    fullPage?: boolean;
+    element?: string;
+    format?: ImageFormat;
+    quality?: number;
+    waitFor?: WaitCondition;
+    delay?: number;
+    waitForSelector?: string;
+    waitForTimeout?: number;
+    preset?: Preset;
+    device?: Device;
+    blockAds?: boolean;
+    blockTrackers?: boolean;
+    blockCookieBanners?: boolean;
+    blockChatWidgets?: boolean;
+    blockUrls?: string[];
+    blockResources?: BlockableResource[];
+    injectScript?: string;
+    injectStyle?: string;
+    click?: string;
+    hide?: string[];
+    remove?: string[];
+    darkMode?: boolean;
+    reducedMotion?: boolean;
+    mediaType?: MediaType;
+    userAgent?: string;
+    timezone?: string;
+    locale?: string;
+    geolocation?: Geolocation;
+    headers?: Record<string, string>;
+    cookies?: Cookie[];
+    authBasic?: {
+        username: string;
+        password: string;
+    };
+    authBearer?: string;
+    bypassCsp?: boolean;
+    cacheTtl?: number;
+    cacheRefresh?: boolean;
+    pdfPaperSize?: PdfPaperSize;
+    pdfWidth?: string;
+    pdfHeight?: string;
+    pdfLandscape?: boolean;
+    pdfMargin?: string;
+    pdfMarginTop?: string;
+    pdfMarginRight?: string;
+    pdfMarginBottom?: string;
+    pdfMarginLeft?: string;
+    pdfScale?: number;
+    pdfPrintBackground?: boolean;
+    pdfPageRanges?: string;
+    pdfHeader?: string;
+    pdfFooter?: string;
+    pdfFitOnePage?: boolean;
+    pdfPreferCssPageSize?: boolean;
+    storageEnabled?: boolean;
+    storagePath?: string;
+    storageAcl?: StorageAcl;
+}
+/**
+ * Screenshot response from takeJson
+ */
+export interface ScreenshotResponse {
+    /** URL to the screenshot image */
+    url: string;
+    /** Cache URL (CDN link) */
+    cacheUrl?: string;
+    /** Screenshot width in pixels */
+    width: number;
+    /** Screenshot height in pixels */
+    height: number;
+    /** Image format */
+    format: ImageFormat;
+    /** File size in bytes */
+    size: number;
+    /** Cache key for the screenshot */
+    cacheKey?: string;
+    /** Time to live in seconds */
+    ttl?: number;
+    /** Whether the response was served from cache */
+    cached: boolean;
+    /** Storage path if BYOS was used */
+    storagePath?: string;
+}
+/**
+ * Batch request item
+ */
+export interface BatchRequestItem {
+    url: string;
+    options?: Partial<TakeOptionsConfig>;
+}
+/**
+ * Batch response item
+ */
+export interface BatchResponseItem {
+    url: string;
+    success: boolean;
+    response?: ScreenshotResponse;
+    error?: {
+        code: string;
+        message: string;
+    };
+}
+/**
+ * Batch response
+ */
+export interface BatchResponse {
+    id: string;
+    status: 'pending' | 'processing' | 'completed' | 'failed';
+    total: number;
+    completed: number;
+    failed: number;
+    results: BatchResponseItem[];
+}
+/**
+ * Cache entry metadata
+ */
+export interface CacheEntry {
+    key: string;
+    url: string;
+    createdAt: Date;
+    expiresAt: Date;
+    size: number;
+    format: ImageFormat;
+}
+/**
+ * Purge operation result
+ */
+export interface PurgeResult {
+    purged: number;
+    keys: string[];
+}
+/**
+ * Webhook event types
+ */
+export type WebhookEventType = 'screenshot.completed' | 'screenshot.failed' | 'batch.completed' | 'batch.failed';
+/**
+ * Webhook event payload
+ */
+export interface WebhookEvent {
+    id: string;
+    type: WebhookEventType;
+    timestamp: Date;
+    data: {
+        url?: string;
+        batchId?: string;
+        response?: ScreenshotResponse;
+        error?: {
+            code: string;
+            message: string;
+        };
+    };
+}
+/**
+ * Preset metadata
+ */
+export interface PresetInfo {
+    id: Preset;
+    name: string;
+    description: string;
+    width: number;
+    height: number;
+    scale?: number;
+    format?: ImageFormat;
+}
+/**
+ * Device metadata
+ */
+export interface DeviceInfo {
+    id: Device;
+    name: string;
+    width: number;
+    height: number;
+    scale: number;
+    mobile: boolean;
+    userAgent: string;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0DAA0D;IAC1D,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC;AAE1D;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,GAAG,aAAa,GAAG,kBAAkB,CAAC;AAExE;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY,CAAC;AAErF;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,OAAO,CAAC;AAE3C;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,aAAa,GAAG,SAAS,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,SAAS,GACT,cAAc,GACd,oBAAoB,GACpB,WAAW,GACX,QAAQ,GACR,kBAAkB,GAClB,YAAY,GACZ,YAAY,GACZ,cAAc,GACd,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,MAAM,GACd,eAAe,GACf,WAAW,GACX,WAAW,GACX,SAAS,GACT,aAAa,GACb,oBAAoB,GACpB,aAAa,GACb,UAAU,GACV,gBAAgB,GAChB,gBAAgB,GAChB,SAAS,GACT,eAAe,GACf,eAAe,GACf,YAAY,GACZ,aAAa,CAAC;AAElB;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,IAAI,GACJ,QAAQ,GACR,OAAO,GACP,SAAS,CAAC;AAEd;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAEhC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IAGd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;IAGjB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IAGjB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,cAAc,CAAC,EAAE,MAAM,CAAC;IAGxB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAGhB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC;IACrB,cAAc,CAAC,EAAE,iBAAiB,EAAE,CAAC;IAGrC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAGlB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,WAAW,CAAC;IAG1B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACjC,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,SAAS,CAAC,EAAE;QAAE,QAAQ,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACnD,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,OAAO,CAAC;IAGpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,YAAY,CAAC,EAAE,OAAO,CAAC;IAGvB,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAG/B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kCAAkC;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,2BAA2B;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,KAAK,EAAE,MAAM,CAAC;IACd,kCAAkC;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,mBAAmB;IACnB,MAAM,EAAE,WAAW,CAAC;IACpB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8BAA8B;IAC9B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,MAAM,EAAE,OAAO,CAAC;IAChB,oCAAoC;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,OAAO,CAAC,iBAAiB,CAAC,CAAC;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;IAC9B,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,SAAS,GAAG,YAAY,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC1D,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,iBAAiB,EAAE,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,IAAI,CAAC;IAChB,SAAS,EAAE,IAAI,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,MAAM,gBAAgB,GACxB,sBAAsB,GACtB,mBAAmB,GACnB,iBAAiB,GACjB,cAAc,CAAC;AAEnB;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,gBAAgB,CAAC;IACvB,SAAS,EAAE,IAAI,CAAC;IAChB,IAAI,EAAE;QACJ,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,kBAAkB,CAAC;QAC9B,KAAK,CAAC,EAAE;YACN,IAAI,EAAE,MAAM,CAAC;YACb,OAAO,EAAE,MAAM,CAAC;SACjB,CAAC;KACH,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACnB"}

package/dist/types/webhooks.d.ts

@@ -0,0 +1,60 @@
+import type { WebhookEvent } from './types.js';
+/**
+ * Verify a webhook signature
+ *
+ * Webhooks are signed using HMAC-SHA256 with the format:
+ * `sha256=hmac(secret, "${timestamp}.${payload}")`
+ *
+ * @param payload - The raw request body as a string
+ * @param signature - The X-Webhook-Signature header value
+ * @param timestamp - The X-Webhook-Timestamp header value
+ * @param secret - Your webhook signing secret from the dashboard
+ * @returns true if the signature is valid
+ *
+ * @example
+ * ```typescript
+ * import { verifyWebhook } from 'renderscreenshot';
+ *
+ * // In your webhook handler
+ * const signature = req.headers['x-webhook-signature'];
+ * const timestamp = req.headers['x-webhook-timestamp'];
+ * const payload = JSON.stringify(req.body);
+ *
+ * if (verifyWebhook(payload, signature, timestamp, process.env.WEBHOOK_SECRET)) {
+ *   // Process webhook
+ * } else {
+ *   res.status(401).send('Invalid signature');
+ * }
+ * ```
+ */
+export declare function verifyWebhook(payload: string, signature: string, timestamp: string, secret: string): boolean;
+/**
+ * Parse a webhook payload into a typed event object
+ *
+ * @param payload - The raw request body (string or parsed object)
+ * @returns Typed webhook event
+ *
+ * @example
+ * ```typescript
+ * import { parseWebhook, verifyWebhook } from 'renderscreenshot';
+ *
+ * // After verifying signature
+ * const event = parseWebhook(req.body);
+ *
+ * if (event.type === 'screenshot.completed') {
+ *   console.log(`Screenshot ready: ${event.data.response?.url}`);
+ * }
+ * ```
+ */
+export declare function parseWebhook(payload: string | Record<string, unknown>): WebhookEvent;
+/**
+ * Extract webhook headers from a request-like object
+ *
+ * @param headers - Headers object (works with Express, Node http, etc.)
+ * @returns Object with signature and timestamp
+ */
+export declare function extractWebhookHeaders(headers: Record<string, string | string[] | undefined> | Headers): {
+    signature: string;
+    timestamp: string;
+};
+//# sourceMappingURL=webhooks.d.ts.map

package/dist/types/webhooks.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhooks.d.ts","sourceRoot":"","sources":["../../src/webhooks.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAoB,MAAM,YAAY,CAAC;AA2BjE;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,aAAa,CAC3B,OAAO,EAAE,MAAM,EACf,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GACb,OAAO,CA6BT;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAgB,YAAY,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,YAAY,CAuDpF;AAED;;;;;GAKG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,GAAG,OAAO,GAC/D;IAAE,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,CAgB1C"}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "renderscreenshot",
+  "version": "1.0.0",
+  "description": "Official Node.js/TypeScript SDK for RenderScreenshot - A developer-friendly screenshot API",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc --project tsconfig.cjs.json",
+    "build:esm": "tsc --project tsconfig.esm.json",
+    "build:types": "tsc --project tsconfig.types.json",
+    "clean": "rm -rf dist",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src tests",
+    "lint:fix": "eslint src tests --fix",
+    "format": "prettier --write \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "format:check": "prettier --check \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "typecheck": "tsc --noEmit",
+    "prepare": "husky"
+  },
+  "keywords": [
+    "screenshot",
+    "screenshot-api",
+    "web-screenshot",
+    "renderscreenshot",
+    "headless-browser",
+    "pdf-generation",
+    "og-image",
+    "social-cards",
+    "link-preview"
+  ],
+  "author": "RenderScreenshot",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Render-Screenshot/rs-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Render-Screenshot/rs-node/issues"
+  },
+  "homepage": "https://renderscreenshot.com/docs/sdks/node",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.0.0",
+    "@types/node": "^20.11.0",
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "husky": "^9.0.0",
+    "lint-staged": "^15.2.0",
+    "prettier": "^3.2.0",
+    "typescript": "^5.3.0",
+    "typescript-eslint": "^8.0.0",
+    "vitest": "^4.0.18"
+  },
+  "lint-staged": {
+    "*.ts": [
+      "eslint --fix",
+      "prettier --write"
+    ]
+  }
+}