@f-o-t/pdf 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,808 @@
+/**
+* PDF object types
+*/
+type PDFObjectType = "boolean" | "number" | "string" | "name" | "array" | "dictionary" | "stream" | "null" | "indirect";
+/**
+* PDF reference to indirect object
+*/
+type PDFRef = {
+	readonly objectNumber: number;
+	readonly generation: number;
+};
+/**
+* PDF indirect object
+*/
+type PDFIndirectObject = {
+	ref: PDFRef;
+	value: PDFValue;
+};
+/**
+* PDF value types
+*/
+type PDFValue = boolean | number | string | PDFName | PDFArray | PDFDictionary | PDFStream | null | PDFRef;
+/**
+* PDF Name object
+*/
+type PDFName = {
+	readonly type: "name";
+	readonly value: string;
+};
+/**
+* PDF Array
+*/
+type PDFArray = PDFValue[];
+/**
+* PDF Dictionary
+*/
+type PDFDictionary = Record<string, PDFValue>;
+/**
+* PDF Stream
+*/
+type PDFStream = {
+	readonly dictionary: PDFDictionary;
+	readonly data: Uint8Array;
+};
+/**
+* PDF Page size presets
+*/
+type PageSize = "A4" | "Letter" | "Legal" | "A3" | "A5" | "Tabloid" | {
+	width: number;
+	height: number;
+};
+/**
+* PDF Color
+*/
+type PDFColor = {
+	type: "rgb";
+	r: number;
+	g: number;
+	b: number;
+} | {
+	type: "cmyk";
+	c: number;
+	m: number;
+	y: number;
+	k: number;
+} | {
+	type: "gray";
+	gray: number;
+};
+/**
+* Text options
+*/
+type TextOptions = {
+	x: number;
+	y: number;
+	size?: number;
+	font?: string;
+	color?: PDFColor;
+	align?: "left" | "center" | "right";
+};
+/**
+* Rectangle options
+*/
+type RectOptions = {
+	x: number;
+	y: number;
+	width: number;
+	height: number;
+	fill?: PDFColor;
+	stroke?: PDFColor;
+	lineWidth?: number;
+};
+/**
+* Line options
+*/
+type LineOptions = {
+	x1: number;
+	y1: number;
+	x2: number;
+	y2: number;
+	color?: PDFColor;
+	lineWidth?: number;
+};
+/**
+* PDF metadata
+*/
+type PDFMetadata = {
+	title?: string;
+	author?: string;
+	subject?: string;
+	keywords?: string[];
+	creator?: string;
+	producer?: string;
+	creationDate?: Date;
+	modificationDate?: Date;
+};
+/**
+* PDF version
+*/
+type PDFVersion = "1.4" | "1.5" | "1.6" | "1.7";
+type PDFPageOptions = {
+	size?: PageSize;
+	parent?: PDFRef;
+};
+/**
+* PDF Page class
+*/
+declare class PDFPage {
+	ref: PDFRef;
+	size: PageSize;
+	parent?: PDFRef;
+	contentStream: string[];
+	private resources;
+	constructor(ref: PDFRef, options?: PDFPageOptions);
+	/**
+	* Get page dimensions in points
+	*/
+	getDimensions(): {
+		width: number;
+		height: number;
+	};
+	/**
+	* Set fill color
+	*/
+	private setFillColor;
+	/**
+	* Set stroke color
+	*/
+	private setStrokeColor;
+	/**
+	* Draw text on the page
+	*/
+	drawText(text: string, options: TextOptions): void;
+	/**
+	* Draw a rectangle
+	*/
+	drawRectangle(options: RectOptions): void;
+	/**
+	* Draw a line
+	*/
+	drawLine(options: LineOptions): void;
+	/**
+	* Get content stream reference
+	*/
+	getContentStreamRef(): PDFRef;
+	/**
+	* Generate content stream as PDFStream
+	*/
+	toContentStream(): PDFStream;
+	/**
+	* Convert page to PDF dictionary
+	*/
+	toDictionary(): PDFDictionary;
+}
+type PDFDocumentOptions = {
+	version?: PDFVersion;
+	metadata?: PDFMetadata;
+};
+/**
+* Main PDF Document class for generation
+*
+* @property version - PDF version (1.4, 1.5, 1.6, or 1.7)
+* @property metadata - Document metadata (title, author, etc.)
+* @property catalog - Reference to the document catalog
+* @property pages - Reference to the pages tree root
+*/
+declare class PDFDocument {
+	version: PDFVersion;
+	metadata: PDFMetadata;
+	private objects;
+	private nextObjectNumber;
+	catalog: PDFRef;
+	pages: PDFRef;
+	private pagesArray;
+	constructor(options?: PDFDocumentOptions);
+	/**
+	* Allocate a new object reference
+	*/
+	private allocateRef;
+	/**
+	* Add a page to the document
+	*/
+	addPage(options?: PDFPageOptions): PDFPage;
+	/**
+	* Save PDF to bytes
+	*/
+	save(): Uint8Array;
+}
+/**
+* PDF Standard 14 Fonts
+* These fonts are guaranteed to be available in all PDF readers
+*/
+declare const STANDARD_FONTS: {
+	readonly "Times-Roman": "Times-Roman";
+	readonly "Times-Bold": "Times-Bold";
+	readonly "Times-Italic": "Times-Italic";
+	readonly "Times-BoldItalic": "Times-BoldItalic";
+	readonly Helvetica: "Helvetica";
+	readonly "Helvetica-Bold": "Helvetica-Bold";
+	readonly "Helvetica-Oblique": "Helvetica-Oblique";
+	readonly "Helvetica-BoldOblique": "Helvetica-BoldOblique";
+	readonly Courier: "Courier";
+	readonly "Courier-Bold": "Courier-Bold";
+	readonly "Courier-Oblique": "Courier-Oblique";
+	readonly "Courier-BoldOblique": "Courier-BoldOblique";
+	readonly Symbol: "Symbol";
+	readonly ZapfDingbats: "ZapfDingbats";
+};
+type StandardFont = keyof typeof STANDARD_FONTS;
+/**
+* Font families for convenience
+*/
+declare const FONT_FAMILIES: {
+	times: {
+		regular: StandardFont;
+		bold: StandardFont;
+		italic: StandardFont;
+		boldItalic: StandardFont;
+	};
+	helvetica: {
+		regular: StandardFont;
+		bold: StandardFont;
+		oblique: StandardFont;
+		boldOblique: StandardFont;
+	};
+	courier: {
+		regular: StandardFont;
+		bold: StandardFont;
+		oblique: StandardFont;
+		boldOblique: StandardFont;
+	};
+	symbol: {
+		regular: StandardFont;
+	};
+	zapfDingbats: {
+		regular: StandardFont;
+	};
+};
+/**
+* Check if a font is a standard PDF font
+*/
+declare function isStandardFont(font: string): font is StandardFont;
+/**
+* Get font object reference name
+*/
+declare function getFontRefName(font: StandardFont): string;
+/**
+* Serialize a PDF value to string
+*/
+declare function serializeValue(value: PDFValue): string;
+/**
+* Serialize a PDF stream
+*/
+declare function serializeStream(stream: PDFStream): Uint8Array;
+/**
+* Serialize an indirect object
+*/
+declare function serializeObject(objectNumber: number, generation: number, value: any): Uint8Array;
+/**
+* PDF token types
+*/
+declare enum TokenType {
+	NUMBER = "NUMBER",
+	STRING = "STRING",
+	NAME = "NAME",
+	BOOLEAN = "BOOLEAN",
+	NULL = "NULL",
+	ARRAY_START = "ARRAY_START",
+	ARRAY_END = "ARRAY_END",
+	DICT_START = "DICT_START",
+	DICT_END = "DICT_END",
+	OBJ = "OBJ",
+	ENDOBJ = "ENDOBJ",
+	STREAM = "STREAM",
+	ENDSTREAM = "ENDSTREAM",
+	XREF = "XREF",
+	TRAILER = "TRAILER",
+	STARTXREF = "STARTXREF",
+	R = "R",
+	EOF = "EOF"
+}
+/**
+* PDF token
+*/
+interface Token {
+	type: TokenType;
+	value: any;
+	position: number;
+}
+/**
+* PDF Lexer
+*/
+declare class PDFLexer {
+	private data;
+	private position;
+	constructor(data: Uint8Array);
+	/**
+	* Get next token
+	*/
+	nextToken(): Token;
+	/**
+	* Peek at next character without consuming
+	*/
+	private peek;
+	/**
+	* Skip whitespace and comments
+	*/
+	private skipWhitespace;
+	/**
+	* Read a name token
+	*/
+	private readName;
+	/**
+	* Read a string token
+	*/
+	private readString;
+	/**
+	* Read a number token
+	*/
+	private readNumber;
+	/**
+	* Read a keyword token
+	*/
+	private readKeyword;
+	/**
+	* Check if character is delimiter
+	*/
+	private isDelimiter;
+	/**
+	* Check if byte is whitespace
+	*/
+	private isWhitespace;
+}
+/**
+* PDF Parser
+*/
+declare class PDFParser {
+	private lexer;
+	private currentToken;
+	private nextToken;
+	private data;
+	constructor(data: Uint8Array);
+	/**
+	* Parse a PDF value
+	*/
+	parseValue(): PDFValue;
+	/**
+	* Parse number or reference (number number R)
+	*/
+	private parseNumberOrRef;
+	/**
+	* Parse string
+	*/
+	private parseString;
+	/**
+	* Parse name
+	*/
+	private parseName;
+	/**
+	* Parse boolean
+	*/
+	private parseBoolean;
+	/**
+	* Parse null
+	*/
+	private parseNull;
+	/**
+	* Parse array
+	*/
+	private parseArray;
+	/**
+	* Parse dictionary
+	*/
+	private parseDictionary;
+	/**
+	* Parse indirect object
+	*/
+	parseIndirectObject(): {
+		ref: PDFRef;
+		value: PDFValue;
+	};
+	/**
+	* Parse stream (dictionary already parsed)
+	*/
+	private parseStream;
+	/**
+	* Advance to next token
+	*/
+	private advance;
+	/**
+	* Check if more tokens available
+	*/
+	hasMore(): boolean;
+}
+/**
+* Parsed PDF Document
+*/
+interface ParsedPDF {
+	version: string;
+	catalog: PDFRef;
+	pages: PDFPage2[];
+	objects: Map<number, any>;
+}
+/**
+* Parsed PDF Page
+*/
+interface PDFPage2 {
+	ref: PDFRef;
+	size: {
+		width: number;
+		height: number;
+	};
+	content: string;
+}
+/**
+* PDF Reader - reads and parses existing PDFs
+*/
+declare class PDFReader {
+	private data;
+	private objects;
+	constructor(data: Uint8Array);
+	/**
+	* Parse PDF file
+	*/
+	parse(): ParsedPDF;
+	/**
+	* Find startxref offset
+	*/
+	private findStartXRef;
+	/**
+	* Parse xref table
+	*/
+	private parseXRefTable;
+	/**
+	* Parse trailer dictionary
+	*/
+	private parseTrailer;
+	/**
+	* Read all objects from xref table
+	*/
+	private readObjects;
+	/**
+	* Parse PDF version from header
+	*/
+	private parseVersion;
+	/**
+	* Parse pages from catalog
+	*/
+	private parsePages;
+	/**
+	* Parse a single page
+	*/
+	private parsePage;
+	/**
+	* Extract text from content stream
+	*/
+	private extractText;
+}
+/**
+* Create a PDF Name object
+*/
+declare function createName(value: string): PDFName;
+/**
+* Create a PDF Reference
+*/
+declare function createRef(objectNumber: number, generation?: number): PDFRef;
+/**
+* Create a PDF Dictionary
+*/
+declare function createDictionary(entries?: Record<string, PDFValue>): PDFDictionary;
+/**
+* Create a PDF Array
+*/
+declare function createArray(values?: PDFValue[]): PDFArray;
+/**
+* Create a PDF Stream
+*/
+declare function createStream(data: Uint8Array, dictionary?: PDFDictionary): PDFStream;
+/**
+* Type guard for PDF Reference
+*/
+declare function isRef(value: unknown): value is PDFRef;
+/**
+* Type guard for PDF Name
+*/
+declare function isName(value: unknown): value is PDFName;
+/**
+* Type guard for PDF Dictionary
+*/
+declare function isDictionary(value: unknown): value is PDFDictionary;
+/**
+* Type guard for PDF Stream
+*/
+declare function isStream(value: unknown): value is PDFStream;
+/**
+* Type guard for PDF Array
+*/
+declare function isArray(value: unknown): value is PDFArray;
+/**
+* Base error class for all PDF errors
+*/
+declare class PDFError extends Error {
+	constructor(message: string);
+}
+/**
+* Error thrown when PDF parsing fails
+*/
+declare class PDFParseError extends PDFError {
+	readonly offset?: number | undefined;
+	constructor(message: string, offset?: number | undefined);
+}
+/**
+* Error thrown when PDF generation fails
+*/
+declare class PDFGenerationError extends PDFError {
+	constructor(message: string);
+}
+/**
+* Error thrown when PDF object is invalid
+*/
+declare class InvalidPDFObjectError extends PDFError {
+	readonly objectType: string;
+	constructor(objectType: string, reason: string);
+}
+/**
+* Error thrown when font is not found
+*/
+declare class FontNotFoundError extends PDFError {
+	readonly fontName: string;
+	constructor(fontName: string);
+}
+/**
+* Error thrown when image is invalid
+*/
+declare class InvalidImageError extends PDFError {
+	constructor(reason: string);
+}
+/**
+* Error thrown when PDF signature fails
+*/
+declare class PDFSignatureError extends PDFError {
+	constructor(reason: string);
+}
+/**
+* Error thrown when PDF encryption fails
+*/
+declare class PDFEncryptionError extends PDFError {
+	constructor(reason: string);
+}
+/**
+* Error thrown when required feature is not implemented
+*/
+declare class NotImplementedError extends PDFError {
+	constructor(feature: string);
+}
+import { z } from "zod";
+/**
+* PDF Reference schema
+*/
+declare const PDFRefSchema: z.ZodObject<{
+	objectNumber: z.ZodNumber;
+	generation: z.ZodNumber;
+}, z.core.$strip>;
+/**
+* PDF Name schema
+*/
+declare const PDFNameSchema: z.ZodObject<{
+	type: z.ZodLiteral<"name">;
+	value: z.ZodString;
+}, z.core.$strip>;
+/**
+* Page size schema
+*/
+declare const PageSizeSchema: z.ZodUnion<readonly [z.ZodEnum<{
+	A4: "A4";
+	Letter: "Letter";
+	Legal: "Legal";
+	A3: "A3";
+	A5: "A5";
+	Tabloid: "Tabloid";
+}>, z.ZodObject<{
+	width: z.ZodNumber;
+	height: z.ZodNumber;
+}, z.core.$strip>]>;
+/**
+* RGB color schema
+*/
+declare const RGBColorSchema: z.ZodObject<{
+	type: z.ZodLiteral<"rgb">;
+	r: z.ZodNumber;
+	g: z.ZodNumber;
+	b: z.ZodNumber;
+}, z.core.$strip>;
+/**
+* CMYK color schema
+*/
+declare const CMYKColorSchema: z.ZodObject<{
+	type: z.ZodLiteral<"cmyk">;
+	c: z.ZodNumber;
+	m: z.ZodNumber;
+	y: z.ZodNumber;
+	k: z.ZodNumber;
+}, z.core.$strip>;
+/**
+* Gray color schema
+*/
+declare const GrayColorSchema: z.ZodObject<{
+	type: z.ZodLiteral<"gray">;
+	gray: z.ZodNumber;
+}, z.core.$strip>;
+/**
+* PDF Color schema
+*/
+declare const PDFColorSchema: z.ZodUnion<readonly [z.ZodObject<{
+	type: z.ZodLiteral<"rgb">;
+	r: z.ZodNumber;
+	g: z.ZodNumber;
+	b: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+	type: z.ZodLiteral<"cmyk">;
+	c: z.ZodNumber;
+	m: z.ZodNumber;
+	y: z.ZodNumber;
+	k: z.ZodNumber;
+}, z.core.$strip>, z.ZodObject<{
+	type: z.ZodLiteral<"gray">;
+	gray: z.ZodNumber;
+}, z.core.$strip>]>;
+/**
+* Text options schema
+*/
+declare const TextOptionsSchema: z.ZodObject<{
+	x: z.ZodNumber;
+	y: z.ZodNumber;
+	size: z.ZodOptional<z.ZodNumber>;
+	font: z.ZodOptional<z.ZodString>;
+	color: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+		type: z.ZodLiteral<"rgb">;
+		r: z.ZodNumber;
+		g: z.ZodNumber;
+		b: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"cmyk">;
+		c: z.ZodNumber;
+		m: z.ZodNumber;
+		y: z.ZodNumber;
+		k: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"gray">;
+		gray: z.ZodNumber;
+	}, z.core.$strip>]>>;
+	align: z.ZodOptional<z.ZodEnum<{
+		left: "left";
+		center: "center";
+		right: "right";
+	}>>;
+}, z.core.$strip>;
+/**
+* Rectangle options schema
+*/
+declare const RectOptionsSchema: z.ZodObject<{
+	x: z.ZodNumber;
+	y: z.ZodNumber;
+	width: z.ZodNumber;
+	height: z.ZodNumber;
+	fill: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+		type: z.ZodLiteral<"rgb">;
+		r: z.ZodNumber;
+		g: z.ZodNumber;
+		b: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"cmyk">;
+		c: z.ZodNumber;
+		m: z.ZodNumber;
+		y: z.ZodNumber;
+		k: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"gray">;
+		gray: z.ZodNumber;
+	}, z.core.$strip>]>>;
+	stroke: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+		type: z.ZodLiteral<"rgb">;
+		r: z.ZodNumber;
+		g: z.ZodNumber;
+		b: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"cmyk">;
+		c: z.ZodNumber;
+		m: z.ZodNumber;
+		y: z.ZodNumber;
+		k: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"gray">;
+		gray: z.ZodNumber;
+	}, z.core.$strip>]>>;
+	lineWidth: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+* Line options schema
+*/
+declare const LineOptionsSchema: z.ZodObject<{
+	x1: z.ZodNumber;
+	y1: z.ZodNumber;
+	x2: z.ZodNumber;
+	y2: z.ZodNumber;
+	color: z.ZodOptional<z.ZodUnion<readonly [z.ZodObject<{
+		type: z.ZodLiteral<"rgb">;
+		r: z.ZodNumber;
+		g: z.ZodNumber;
+		b: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"cmyk">;
+		c: z.ZodNumber;
+		m: z.ZodNumber;
+		y: z.ZodNumber;
+		k: z.ZodNumber;
+	}, z.core.$strip>, z.ZodObject<{
+		type: z.ZodLiteral<"gray">;
+		gray: z.ZodNumber;
+	}, z.core.$strip>]>>;
+	lineWidth: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+/**
+* PDF metadata schema
+*/
+declare const PDFMetadataSchema: z.ZodObject<{
+	title: z.ZodOptional<z.ZodString>;
+	author: z.ZodOptional<z.ZodString>;
+	subject: z.ZodOptional<z.ZodString>;
+	keywords: z.ZodOptional<z.ZodArray<z.ZodString>>;
+	creator: z.ZodOptional<z.ZodString>;
+	producer: z.ZodOptional<z.ZodString>;
+	creationDate: z.ZodOptional<z.ZodDate>;
+	modificationDate: z.ZodOptional<z.ZodDate>;
+}, z.core.$strip>;
+/**
+* PDF Dictionary schema (recursive)
+*/
+declare const PDFDictionarySchema: z.ZodType<Record<string, any>>;
+/**
+* PDF Array schema (recursive)
+*/
+declare const PDFArraySchema: z.ZodType<any[]>;
+/**
+* PDF Stream schema
+*/
+declare const PDFStreamSchema: z.ZodObject<{
+	dictionary: z.ZodType<Record<string, any>, unknown, z.core.$ZodTypeInternals<Record<string, any>, unknown>>;
+	data: z.ZodCustom<Uint8Array<ArrayBuffer>, Uint8Array<ArrayBuffer>>;
+}, z.core.$strip>;
+/**
+* PDF Value schema (recursive union)
+*/
+declare const PDFValueSchema: z.ZodType<any>;
+/**
+* PDF Indirect Object schema
+*/
+declare const PDFIndirectObjectSchema: z.ZodObject<{
+	ref: z.ZodObject<{
+		objectNumber: z.ZodNumber;
+		generation: z.ZodNumber;
+	}, z.core.$strip>;
+	value: z.ZodType<any, unknown, z.core.$ZodTypeInternals<any, unknown>>;
+}, z.core.$strip>;
+/**
+* PDF Object Type schema
+*/
+declare const PDFObjectTypeSchema: z.ZodEnum<{
+	string: "string";
+	number: "number";
+	boolean: "boolean";
+	name: "name";
+	null: "null";
+	array: "array";
+	dictionary: "dictionary";
+	stream: "stream";
+	indirect: "indirect";
+}>;
+/**
+* PDF version schema
+*/
+declare const PDFVersionSchema: z.ZodEnum<{
+	1.4: "1.4";
+	1.5: "1.5";
+	1.6: "1.6";
+	1.7: "1.7";
+}>;
+export { serializeValue, serializeStream, serializeObject, isStream, isStandardFont, isRef, isName, isDictionary, isArray, getFontRefName, createStream, createRef, createName, createDictionary, createArray, TokenType, Token, TextOptionsSchema, TextOptions, StandardFont, STANDARD_FONTS, RectOptionsSchema, RectOptions, RGBColorSchema, ParsedPDF, PageSizeSchema, PageSize, PDFVersionSchema, PDFVersion, PDFValueSchema, PDFValue, PDFStreamSchema, PDFStream, PDFSignatureError, PDFRefSchema, PDFRef, PDFReader, PDFParser, PDFParseError, PDFPageOptions, PDFObjectTypeSchema, PDFObjectType, PDFNameSchema, PDFName, PDFMetadataSchema, PDFMetadata, PDFLexer, PDFIndirectObjectSchema, PDFIndirectObject, PDFGenerationError, PDFError, PDFEncryptionError, PDFDocumentOptions, PDFDocument, PDFDictionarySchema, PDFDictionary, PDFColorSchema, PDFColor, PDFArraySchema, PDFArray, NotImplementedError, LineOptionsSchema, LineOptions, InvalidPDFObjectError, InvalidImageError, GrayColorSchema, FontNotFoundError, FONT_FAMILIES, CMYKColorSchema };