ai-pdf-builder 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,461 @@
+/**
+ * @strykr/pdf-builder - TypeScript Types
+ * Professional PDF generation from Markdown using Pandoc and LaTeX
+ */
+/**
+ * Document metadata for PDF generation
+ */
+interface DocumentMetadata {
+    /** Document title (required) */
+    title: string;
+    /** Document subtitle */
+    subtitle?: string;
+    /** Author name(s) */
+    author?: string;
+    /** Document date */
+    date?: string;
+    /** Version string */
+    version?: string;
+    /** Additional custom metadata */
+    [key: string]: string | undefined;
+}
+/**
+ * Custom color configuration for document styling
+ */
+interface ColorConfig {
+    /** Primary brand color (RGB format: "59,130,246") */
+    primary?: string;
+    /** Secondary color for accents */
+    secondary?: string;
+    /** Accent color for highlights */
+    accent?: string;
+}
+/**
+ * Page layout configuration
+ */
+interface LayoutConfig {
+    /** Page margins (e.g., "1in", "1.5in") */
+    margin?: string;
+    /** Font size in points (10, 11, 12) */
+    fontSize?: number;
+    /** Line spacing (1, 1.15, 1.5) */
+    lineSpacing?: number;
+    /** Paper size ("letter", "a4") */
+    paperSize?: "letter" | "a4";
+}
+/**
+ * Options for PDF generation
+ */
+interface PDFOptions {
+    /** Markdown content to convert */
+    content: string;
+    /** Document metadata */
+    metadata?: DocumentMetadata;
+    /** Template name or path to custom template */
+    template?: string;
+    /** Custom color configuration */
+    customColors?: ColorConfig;
+    /** Output file path. If not provided, returns buffer */
+    outputPath?: string;
+    /** Include table of contents */
+    toc?: boolean;
+    /** Depth of TOC (1-3) */
+    tocDepth?: number;
+    /** Number sections automatically */
+    numberSections?: boolean;
+    /** Font size in points */
+    fontSize?: number;
+    /** Page margins */
+    margin?: string;
+    /** Paper size */
+    paperSize?: "letter" | "a4";
+    /** Working directory for temporary files */
+    workDir?: string;
+    /** Timeout in milliseconds (default: 60000) */
+    timeout?: number;
+}
+/**
+ * Result from PDF generation
+ */
+interface PDFResult {
+    /** Whether generation was successful */
+    success: boolean;
+    /** Generated PDF as Buffer (if outputPath not specified) */
+    buffer?: Buffer;
+    /** Path to generated PDF (if outputPath specified) */
+    path?: string;
+    /** Error message if generation failed */
+    error?: string;
+    /** Number of pages in generated PDF */
+    pageCount?: number;
+    /** File size in bytes */
+    fileSize?: number;
+    /** Generation time in milliseconds */
+    generationTime?: number;
+}
+/**
+ * Template configuration
+ */
+interface TemplateConfig {
+    /** Unique template name */
+    name: string;
+    /** Path to .latex template file */
+    path: string;
+    /** Human-readable description */
+    description: string;
+    /** Document types this template supports */
+    supportedDocTypes: DocumentType[];
+}
+/**
+ * Supported document types
+ */
+type DocumentType = "memo" | "whitepaper" | "agreement" | "termsheet" | "report" | "proposal" | "generic";
+/**
+ * Check if Pandoc is available
+ */
+interface PandocCheck {
+    available: boolean;
+    version?: string;
+    path?: string;
+    error?: string;
+}
+/**
+ * Check if LaTeX is available
+ */
+interface LaTeXCheck {
+    available: boolean;
+    engine?: string;
+    version?: string;
+    path?: string;
+    error?: string;
+}
+/**
+ * System requirements check result
+ */
+interface SystemCheck {
+    pandoc: PandocCheck;
+    latex: LaTeXCheck;
+    ready: boolean;
+    message: string;
+}
+
+/**
+ * @strykr/pdf-builder - PDF Generator
+ * Core PDF generation logic using Pandoc and LaTeX
+ */
+
+/**
+ * Generate a PDF from Markdown content
+ *
+ * @param options - PDF generation options
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const result = await generatePDF({
+ *   content: '# Hello World\n\nThis is my document.',
+ *   metadata: { title: 'My Document', author: 'John Doe' },
+ *   template: 'default'
+ * });
+ *
+ * if (result.success) {
+ *   fs.writeFileSync('output.pdf', result.buffer);
+ * }
+ * ```
+ */
+declare function generatePDF(options: PDFOptions): Promise<PDFResult>;
+
+/**
+ * @strykr/pdf-builder - Template Management
+ * Handle built-in and custom LaTeX templates
+ */
+
+/**
+ * Get template content by name
+ *
+ * @param name - Template name or path
+ * @returns Template content as string, or null if not found
+ *
+ * @example
+ * ```typescript
+ * const template = getTemplate('memo');
+ * const customTemplate = getTemplate('/path/to/custom.latex');
+ * ```
+ */
+declare function getTemplate(name: string): string | null;
+/**
+ * Get the file path for a template
+ *
+ * @param name - Template name
+ * @returns Path to template file, or null if not found
+ */
+declare function getTemplatePath(name: string): string | null;
+/**
+ * List all available templates (built-in and custom)
+ *
+ * @returns Array of template configurations
+ *
+ * @example
+ * ```typescript
+ * const templates = listTemplates();
+ * templates.forEach(t => console.log(t.name, t.description));
+ * ```
+ */
+declare function listTemplates(): TemplateConfig[];
+/**
+ * Get a specific template configuration
+ *
+ * @param name - Template name
+ * @returns Template configuration or null
+ */
+declare function getTemplateConfig(name: string): TemplateConfig | null;
+/**
+ * Register a custom template
+ *
+ * @param config - Template configuration
+ * @throws Error if template file doesn't exist
+ *
+ * @example
+ * ```typescript
+ * registerTemplate({
+ *   name: 'company-branded',
+ *   path: './templates/company.latex',
+ *   description: 'Company branded template',
+ *   supportedDocTypes: ['memo', 'whitepaper']
+ * });
+ * ```
+ */
+declare function registerTemplate(config: TemplateConfig): void;
+/**
+ * Unregister a custom template
+ *
+ * @param name - Template name to remove
+ * @returns true if template was removed, false if not found
+ */
+declare function unregisterTemplate(name: string): boolean;
+/**
+ * Check if a template exists
+ *
+ * @param name - Template name
+ * @returns true if template exists
+ */
+declare function hasTemplate(name: string): boolean;
+/**
+ * Get templates that support a specific document type
+ *
+ * @param docType - Document type to filter by
+ * @returns Array of matching template configurations
+ */
+declare function getTemplatesForDocType(docType: DocumentType): TemplateConfig[];
+/**
+ * Clear the template cache
+ * Useful when template files are updated
+ */
+declare function clearTemplateCache(): void;
+/**
+ * Get the templates directory path
+ * Useful for locating bundled templates
+ */
+declare function getTemplatesDirectory(): string;
+
+/**
+ * @strykr/pdf-builder - Preset Document Generators
+ * Pre-configured generators for common document types
+ */
+
+/**
+ * Generate a business memo PDF
+ *
+ * Uses the memo template with settings optimized for executive summaries
+ * and internal communications.
+ *
+ * @param content - Markdown content for the memo
+ * @param metadata - Document metadata (title, author, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const memo = await generateMemo(
+ *   '# Executive Summary\n\nKey findings...',
+ *   { title: 'Q4 Report', author: 'Jane Doe' }
+ * );
+ * ```
+ */
+declare function generateMemo(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a legal agreement PDF
+ *
+ * Uses the agreement template with formal legal document formatting,
+ * suitable for contracts, advisor agreements, and other legal documents.
+ *
+ * @param content - Markdown content for the agreement
+ * @param metadata - Document metadata (title, parties, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const agreement = await generateAgreement(
+ *   '# Advisor Agreement\n\n## 1. Services\n\nThe Advisor agrees to...',
+ *   { title: 'Advisor Agreement', subtitle: 'Strykr AI Inc.' }
+ * );
+ * ```
+ */
+declare function generateAgreement(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a term sheet PDF
+ *
+ * Uses the termsheet template optimized for investment term sheets,
+ * with structured sections for deal terms.
+ *
+ * @param content - Markdown content for the term sheet
+ * @param metadata - Document metadata (title, company, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const termsheet = await generateTermsheet(
+ *   '# Series Seed Term Sheet\n\n## Investment Amount\n\n$2,000,000...',
+ *   { title: 'Series Seed Term Sheet', subtitle: 'Strykr AI Inc.' }
+ * );
+ * ```
+ */
+declare function generateTermsheet(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a whitepaper PDF
+ *
+ * Uses the default template with settings optimized for technical
+ * whitepapers and litepapers, including table of contents.
+ *
+ * @param content - Markdown content for the whitepaper
+ * @param metadata - Document metadata (title, author, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const whitepaper = await generateWhitepaper(
+ *   '# Abstract\n\nThis paper presents...\n\n# Introduction\n\n...',
+ *   { title: 'STRYKR PRISM', subtitle: 'Intelligence Infrastructure', author: 'Ty Blackard' }
+ * );
+ * ```
+ */
+declare function generateWhitepaper(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a report PDF
+ *
+ * Uses the default template with settings optimized for business
+ * reports and analysis documents.
+ *
+ * @param content - Markdown content for the report
+ * @param metadata - Document metadata (title, author, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const report = await generateReport(
+ *   '# Market Analysis\n\n## Key Findings\n\n...',
+ *   { title: 'Q4 Market Report', date: 'January 2026' }
+ * );
+ * ```
+ */
+declare function generateReport(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a proposal PDF
+ *
+ * Uses the default template with settings optimized for business
+ * proposals and pitch documents.
+ *
+ * @param content - Markdown content for the proposal
+ * @param metadata - Document metadata (title, company, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const proposal = await generateProposal(
+ *   '# Executive Summary\n\n## Opportunity\n\n...',
+ *   { title: 'Partnership Proposal', subtitle: 'Strategic Alliance' }
+ * );
+ * ```
+ */
+declare function generateProposal(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a capital introduction agreement PDF
+ *
+ * Specialized for fundraising referral agreements with milestone-based
+ * compensation structures.
+ *
+ * @param content - Markdown content for the agreement
+ * @param metadata - Document metadata (title, parties, etc.)
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ *
+ * @example
+ * ```typescript
+ * const agreement = await generateCapitalIntroAgreement(
+ *   '# Capital Introduction Agreement\n\n## 1. Services\n\n...',
+ *   { title: 'Capital Introduction Agreement', subtitle: 'Strykr AI Inc.' }
+ * );
+ * ```
+ */
+declare function generateCapitalIntroAgreement(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate a SAFE document PDF
+ *
+ * Uses the agreement template optimized for Simple Agreement for
+ * Future Equity documents.
+ *
+ * @param content - Markdown content for the SAFE
+ * @param metadata - Document metadata
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ */
+declare function generateSAFE(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+/**
+ * Generate an NDA PDF
+ *
+ * Uses the agreement template optimized for Non-Disclosure Agreements.
+ *
+ * @param content - Markdown content for the NDA
+ * @param metadata - Document metadata
+ * @param options - Additional PDF options (optional)
+ * @returns Promise resolving to PDFResult
+ */
+declare function generateNDA(content: string, metadata: DocumentMetadata, options?: Partial<PDFOptions>): Promise<PDFResult>;
+
+/**
+ * @strykr/pdf-builder - Utility Functions
+ */
+
+/**
+ * Check if Pandoc is installed and available
+ */
+declare function checkPandoc(): PandocCheck;
+/**
+ * Check if LaTeX/pdflatex is installed and available
+ */
+declare function checkLaTeX(): LaTeXCheck;
+/**
+ * Check system requirements for PDF generation
+ */
+declare function checkSystem(): SystemCheck;
+/**
+ * Sanitize content for LaTeX safety
+ * Removes dangerous LaTeX commands that could be security risks
+ */
+declare function sanitizeContent(content: string): string;
+/**
+ * Parse RGB color string to components
+ * Accepts formats: "RGB(59,130,246)" or "59,130,246" or "#3B82F6"
+ */
+declare function parseColor(color: string): string;
+/**
+ * Get file size in human-readable format
+ */
+declare function formatFileSize(bytes: number): string;
+
+export { type ColorConfig, type DocumentMetadata, type DocumentType, type LaTeXCheck, type LayoutConfig, type PDFOptions, type PDFResult, type PandocCheck, type SystemCheck, type TemplateConfig, checkLaTeX, checkPandoc, checkSystem, clearTemplateCache, formatFileSize, generateAgreement, generateCapitalIntroAgreement, generateMemo, generateNDA, generatePDF, generateProposal, generateReport, generateSAFE, generateTermsheet, generateWhitepaper, getTemplate, getTemplateConfig, getTemplatePath, getTemplatesDirectory, getTemplatesForDocType, hasTemplate, listTemplates, parseColor, registerTemplate, sanitizeContent, unregisterTemplate };