umay-render
Version:
Free, high-performance HTML to PDF and HTML to Image conversion SDK for both browser and Node.js
1,086 lines (1,085 loc) • 44.2 kB
TypeScript
import { z } from "zod";
export declare const PageSetupOptionsSchema: z.ZodOptional<z.ZodObject<{
viewport: z.ZodOptional<z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
deviceScaleFactor: z.ZodOptional<z.ZodNumber>;
isMobile: z.ZodOptional<z.ZodBoolean>;
hasTouch: z.ZodOptional<z.ZodBoolean>;
isLandscape: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
}, {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
}>>;
emulateMediaType: z.ZodOptional<z.ZodEnum<["screen", "print"]>>;
waitForSelector: z.ZodOptional<z.ZodString>;
waitForTimeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
waitUntil: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodEnum<["load", "domcontentloaded", "networkidle0", "networkidle2"]>, z.ZodArray<z.ZodEnum<["load", "domcontentloaded", "networkidle0", "networkidle2"]>, "many">]>>>;
cookies: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
value: z.ZodString;
url: z.ZodOptional<z.ZodString>;
domain: z.ZodOptional<z.ZodString>;
path: z.ZodOptional<z.ZodString>;
expires: z.ZodOptional<z.ZodNumber>;
httpOnly: z.ZodOptional<z.ZodBoolean>;
secure: z.ZodOptional<z.ZodBoolean>;
sameSite: z.ZodOptional<z.ZodEnum<["Strict", "Lax", "None"]>>;
}, "strip", z.ZodTypeAny, {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}, {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}>, "many">>;
extraHTTPHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
javascriptEnabled: z.ZodOptional<z.ZodBoolean>;
userAgent: z.ZodOptional<z.ZodString>;
evaluateScript: z.ZodOptional<z.ZodString>;
}, "strict", z.ZodTypeAny, {
waitForTimeout: number;
waitUntil: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
}, {
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
waitForTimeout?: number | undefined;
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[] | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
}>>;
export declare const PdfOutputOptionsSchema: z.ZodOptional<z.ZodObject<{
scale: z.ZodOptional<z.ZodNumber>;
displayHeaderFooter: z.ZodOptional<z.ZodBoolean>;
headerTemplate: z.ZodOptional<z.ZodString>;
footerTemplate: z.ZodOptional<z.ZodString>;
printBackground: z.ZodOptional<z.ZodBoolean>;
landscape: z.ZodOptional<z.ZodBoolean>;
pageRanges: z.ZodOptional<z.ZodString>;
format: z.ZodOptional<z.ZodEnum<["Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6"]>>;
width: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
height: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
margin: z.ZodOptional<z.ZodObject<{
top: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
right: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
bottom: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
left: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
}, "strip", z.ZodTypeAny, {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
}, {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
}>>;
preferCSSPageSize: z.ZodOptional<z.ZodBoolean>;
omitBackground: z.ZodOptional<z.ZodBoolean>;
tagged: z.ZodOptional<z.ZodBoolean>;
timeout: z.ZodOptional<z.ZodNumber>;
}, "strict", z.ZodTypeAny, {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
}, {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
}>>;
export declare const ScreenshotOutputOptionsSchema: z.ZodOptional<z.ZodObject<{
quality: z.ZodOptional<z.ZodNumber>;
fullPage: z.ZodOptional<z.ZodBoolean>;
clip: z.ZodOptional<z.ZodObject<{
x: z.ZodNumber;
y: z.ZodNumber;
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
x: number;
y: number;
}, {
width: number;
height: number;
x: number;
y: number;
}>>;
omitBackground: z.ZodOptional<z.ZodBoolean>;
encoding: z.ZodOptional<z.ZodEnum<["base64", "binary"]>>;
captureBeyondViewport: z.ZodOptional<z.ZodBoolean>;
fromSurface: z.ZodOptional<z.ZodBoolean>;
timeout: z.ZodOptional<z.ZodNumber>;
}, "strict", z.ZodTypeAny, {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
}, {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
}>>;
export declare const ConversionRequestSchema: z.ZodEffects<z.ZodEffects<z.ZodEffects<z.ZodObject<{
html: z.ZodOptional<z.ZodString>;
url: z.ZodOptional<z.ZodString>;
outputFormat: z.ZodEnum<["pdf", "png", "jpeg", "webp"]>;
filename: z.ZodOptional<z.ZodString>;
pageSetupOptions: z.ZodOptional<z.ZodObject<{
viewport: z.ZodOptional<z.ZodObject<{
width: z.ZodNumber;
height: z.ZodNumber;
deviceScaleFactor: z.ZodOptional<z.ZodNumber>;
isMobile: z.ZodOptional<z.ZodBoolean>;
hasTouch: z.ZodOptional<z.ZodBoolean>;
isLandscape: z.ZodOptional<z.ZodBoolean>;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
}, {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
}>>;
emulateMediaType: z.ZodOptional<z.ZodEnum<["screen", "print"]>>;
waitForSelector: z.ZodOptional<z.ZodString>;
waitForTimeout: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
waitUntil: z.ZodDefault<z.ZodOptional<z.ZodUnion<[z.ZodEnum<["load", "domcontentloaded", "networkidle0", "networkidle2"]>, z.ZodArray<z.ZodEnum<["load", "domcontentloaded", "networkidle0", "networkidle2"]>, "many">]>>>;
cookies: z.ZodOptional<z.ZodArray<z.ZodObject<{
name: z.ZodString;
value: z.ZodString;
url: z.ZodOptional<z.ZodString>;
domain: z.ZodOptional<z.ZodString>;
path: z.ZodOptional<z.ZodString>;
expires: z.ZodOptional<z.ZodNumber>;
httpOnly: z.ZodOptional<z.ZodBoolean>;
secure: z.ZodOptional<z.ZodBoolean>;
sameSite: z.ZodOptional<z.ZodEnum<["Strict", "Lax", "None"]>>;
}, "strip", z.ZodTypeAny, {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}, {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}>, "many">>;
extraHTTPHeaders: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
javascriptEnabled: z.ZodOptional<z.ZodBoolean>;
userAgent: z.ZodOptional<z.ZodString>;
evaluateScript: z.ZodOptional<z.ZodString>;
}, "strict", z.ZodTypeAny, {
waitForTimeout: number;
waitUntil: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
}, {
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
waitForTimeout?: number | undefined;
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[] | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
}>>;
pdfOptions: z.ZodOptional<z.ZodObject<{
scale: z.ZodOptional<z.ZodNumber>;
displayHeaderFooter: z.ZodOptional<z.ZodBoolean>;
headerTemplate: z.ZodOptional<z.ZodString>;
footerTemplate: z.ZodOptional<z.ZodString>;
printBackground: z.ZodOptional<z.ZodBoolean>;
landscape: z.ZodOptional<z.ZodBoolean>;
pageRanges: z.ZodOptional<z.ZodString>;
format: z.ZodOptional<z.ZodEnum<["Letter", "Legal", "Tabloid", "Ledger", "A0", "A1", "A2", "A3", "A4", "A5", "A6"]>>;
width: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
height: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
margin: z.ZodOptional<z.ZodObject<{
top: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
right: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
bottom: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
left: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodNumber]>>;
}, "strip", z.ZodTypeAny, {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
}, {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
}>>;
preferCSSPageSize: z.ZodOptional<z.ZodBoolean>;
omitBackground: z.ZodOptional<z.ZodBoolean>;
tagged: z.ZodOptional<z.ZodBoolean>;
timeout: z.ZodOptional<z.ZodNumber>;
}, "strict", z.ZodTypeAny, {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
}, {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
}>>;
screenshotOptions: z.ZodOptional<z.ZodObject<{
quality: z.ZodOptional<z.ZodNumber>;
fullPage: z.ZodOptional<z.ZodBoolean>;
clip: z.ZodOptional<z.ZodObject<{
x: z.ZodNumber;
y: z.ZodNumber;
width: z.ZodNumber;
height: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
width: number;
height: number;
x: number;
y: number;
}, {
width: number;
height: number;
x: number;
y: number;
}>>;
omitBackground: z.ZodOptional<z.ZodBoolean>;
encoding: z.ZodOptional<z.ZodEnum<["base64", "binary"]>>;
captureBeyondViewport: z.ZodOptional<z.ZodBoolean>;
fromSurface: z.ZodOptional<z.ZodBoolean>;
timeout: z.ZodOptional<z.ZodNumber>;
}, "strict", z.ZodTypeAny, {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
}, {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
waitForTimeout: number;
waitUntil: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
waitForTimeout?: number | undefined;
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[] | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}>, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
waitForTimeout: number;
waitUntil: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
waitForTimeout?: number | undefined;
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[] | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}>, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
waitForTimeout: number;
waitUntil: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
waitForTimeout?: number | undefined;
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[] | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}>, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
waitForTimeout: number;
waitUntil: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[];
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}, {
outputFormat: "pdf" | "png" | "jpeg" | "webp";
html?: string | undefined;
url?: string | undefined;
filename?: string | undefined;
pageSetupOptions?: {
viewport?: {
width: number;
height: number;
deviceScaleFactor?: number | undefined;
isMobile?: boolean | undefined;
hasTouch?: boolean | undefined;
isLandscape?: boolean | undefined;
} | undefined;
emulateMediaType?: "screen" | "print" | undefined;
waitForSelector?: string | undefined;
waitForTimeout?: number | undefined;
waitUntil?: "load" | "domcontentloaded" | "networkidle0" | "networkidle2" | ("load" | "domcontentloaded" | "networkidle0" | "networkidle2")[] | undefined;
cookies?: {
value: string;
name: string;
path?: string | undefined;
url?: string | undefined;
domain?: string | undefined;
expires?: number | undefined;
httpOnly?: boolean | undefined;
secure?: boolean | undefined;
sameSite?: "Strict" | "Lax" | "None" | undefined;
}[] | undefined;
extraHTTPHeaders?: Record<string, string> | undefined;
javascriptEnabled?: boolean | undefined;
userAgent?: string | undefined;
evaluateScript?: string | undefined;
} | undefined;
pdfOptions?: {
width?: string | number | undefined;
height?: string | number | undefined;
scale?: number | undefined;
displayHeaderFooter?: boolean | undefined;
headerTemplate?: string | undefined;
footerTemplate?: string | undefined;
printBackground?: boolean | undefined;
landscape?: boolean | undefined;
pageRanges?: string | undefined;
format?: "Letter" | "Legal" | "Tabloid" | "Ledger" | "A0" | "A1" | "A2" | "A3" | "A4" | "A5" | "A6" | undefined;
margin?: {
top?: string | number | undefined;
right?: string | number | undefined;
bottom?: string | number | undefined;
left?: string | number | undefined;
} | undefined;
preferCSSPageSize?: boolean | undefined;
omitBackground?: boolean | undefined;
tagged?: boolean | undefined;
timeout?: number | undefined;
} | undefined;
screenshotOptions?: {
omitBackground?: boolean | undefined;
timeout?: number | undefined;
quality?: number | undefined;
fullPage?: boolean | undefined;
clip?: {
width: number;
height: number;
x: number;
y: number;
} | undefined;
encoding?: "base64" | "binary" | undefined;
captureBeyondViewport?: boolean | undefined;
fromSurface?: boolean | undefined;
} | undefined;
}>;
export type ConversionRequest = z.infer<typeof ConversionRequestSchema>;
export type RenderInput = ({
html: string;
url?: never;
} | {
url: string;
html?: never;
}) & {
outputFormat: ConversionRequest["outputFormat"];
} & {
filename?: ConversionRequest["filename"];
pageSetupOptions?: z.input<typeof PageSetupOptionsSchema>;
pdfOptions?: z.input<typeof PdfOutputOptionsSchema>;
screenshotOptions?: z.input<typeof ScreenshotOutputOptionsSchema>;
};
export type PageSetupOptions = z.infer<typeof PageSetupOptionsSchema>;
export type PdfOutputOptions = z.infer<typeof PdfOutputOptionsSchema>;
export type ScreenshotOutputOptions = z.infer<typeof ScreenshotOutputOptionsSchema>;