ai-pdf-builder 0.1.0

package/README.md

@@ -0,0 +1,507 @@
+# ai-pdf-builder
+
+Professional PDF generation from Markdown using Pandoc and LaTeX. Create beautiful whitepapers, memos, agreements, and term sheets with ease.
+
+## Features
+
+- **Multiple Document Types**: Built-in templates for memos, agreements, term sheets, and whitepapers
+- **Custom Styling**: Apply custom colors and branding to any template
+- **TypeScript Support**: Full type definitions included
+- **Flexible Output**: Get PDF as Buffer or save directly to file
+- **Template System**: Use built-in templates or register your own
+- **Security**: Built-in content sanitization for LaTeX safety
+
+## Prerequisites
+
+This package requires **Pandoc** and **LaTeX** to be installed on your system:
+
+### macOS
+
+```bash
+# Install Pandoc
+brew install pandoc
+
+# Install BasicTeX (minimal LaTeX)
+brew install --cask basictex
+
+# After installing BasicTeX, install required packages
+sudo tlmgr update --self
+sudo tlmgr install collection-fontsrecommended fancyhdr titlesec enumitem xcolor booktabs longtable geometry hyperref setspace array multirow listings
+```
+
+### Ubuntu/Debian
+
+```bash
+# Install Pandoc and TeX Live
+sudo apt-get update
+sudo apt-get install -y pandoc texlive-latex-base texlive-latex-extra texlive-fonts-recommended
+```
+
+### Windows
+
+1. Download and install [Pandoc](https://pandoc.org/installing.html)
+2. Download and install [MiKTeX](https://miktex.org/download)
+
+### Docker
+
+For containerized environments, use a Pandoc/LaTeX image:
+
+```dockerfile
+FROM pandoc/latex:latest
+```
+
+## Installation
+
+```bash
+npm install ai-pdf-builder
+```
+
+Or with yarn:
+
+```bash
+yarn add ai-pdf-builder
+```
+
+## Quick Start
+
+```typescript
+import { generatePDF } from 'ai-pdf-builder';
+import * as fs from 'fs';
+
+const result = await generatePDF({
+  content: '# My Document\n\nThis is the content of my PDF.',
+  metadata: {
+    title: 'My First PDF',
+    author: 'John Doe',
+    date: 'January 2026'
+  }
+});
+
+if (result.success && result.buffer) {
+  fs.writeFileSync('output.pdf', result.buffer);
+  console.log(`PDF generated! Size: ${result.fileSize} bytes`);
+}
+```
+
+## Usage Examples
+
+### Basic PDF Generation
+
+```typescript
+import { generatePDF } from 'ai-pdf-builder';
+
+const result = await generatePDF({
+  content: `
+# Executive Summary
+
+This document outlines our strategic initiatives for Q1 2026.
+
+## Key Objectives
+
+- Increase market share by 15%
+- Launch new product line
+- Expand to 3 new markets
+
+## Timeline
+
+Implementation begins February 1st, 2026.
+  `,
+  metadata: {
+    title: 'Q1 Strategic Plan',
+    subtitle: 'Confidential',
+    author: 'Strategy Team',
+    date: 'January 2026',
+    version: 'v1.0'
+  },
+  toc: true,
+  numberSections: true
+});
+```
+
+### Generate a Business Memo
+
+```typescript
+import { generateMemo } from 'ai-pdf-builder';
+
+const memo = await generateMemo(
+  `
+# Executive Summary
+
+Key findings from our market analysis indicate strong growth potential.
+
+## Recommendations
+
+1. Accelerate product development
+2. Increase marketing budget by 20%
+3. Hire 5 additional engineers
+  `,
+  {
+    title: 'STRYKR PRISM',
+    subtitle: 'Intelligence Infrastructure for Financial Markets',
+    author: 'Ty Blackard, COO',
+    date: 'January 2026'
+  }
+);
+```
+
+### Generate a Legal Agreement
+
+```typescript
+import { generateAgreement } from 'ai-pdf-builder';
+
+const agreement = await generateAgreement(
+  `
+# Advisor Agreement
+
+This Advisor Agreement is entered into as of the Effective Date.
+
+## 1. Services
+
+The Advisor agrees to provide strategic guidance and introductions to potential investors.
+
+## 2. Compensation
+
+In consideration of the Services, the Company shall pay the Advisor:
+
+- 8% of cash raised through Advisor's introductions
+- 0.25% equity per $250,000 raised, up to 1% maximum
+
+## 3. Term
+
+This Agreement shall remain in effect for 12 months from the Effective Date.
+  `,
+  {
+    title: 'Capital Introduction Agreement',
+    subtitle: 'Strykr AI Inc.',
+    date: 'January 15, 2026'
+  }
+);
+```
+
+### Generate a Term Sheet
+
+```typescript
+import { generateTermsheet } from 'ai-pdf-builder';
+
+const termsheet = await generateTermsheet(
+  `
+# Series Seed Term Sheet
+
+## Investment Amount
+
+$2,000,000 (Two Million Dollars)
+
+## Pre-Money Valuation
+
+$8,000,000
+
+## Security Type
+
+Series Seed Preferred Stock
+
+## Investors
+
+Lead Investor: TBD
+  `,
+  {
+    title: 'Series Seed',
+    company: 'STRYKR AI',
+    doctype: 'Term Sheet',
+    date: 'January 2026'
+  }
+);
+```
+
+### Generate a Whitepaper
+
+```typescript
+import { generateWhitepaper } from 'ai-pdf-builder';
+
+const whitepaper = await generateWhitepaper(
+  `
+# Abstract
+
+This paper presents a novel approach to financial market intelligence.
+
+# Introduction
+
+Financial markets generate vast amounts of data...
+
+# Technical Architecture
+
+Our system consists of three main components...
+
+# Conclusion
+
+We have demonstrated a scalable solution for...
+  `,
+  {
+    title: 'STRYKR PRISM',
+    subtitle: 'A Canonical Asset Resolution System',
+    author: 'Strykr AI Research',
+    version: 'v1.0',
+    date: 'January 2026'
+  }
+);
+```
+
+### Custom Colors
+
+```typescript
+import { generatePDF } from 'ai-pdf-builder';
+
+const result = await generatePDF({
+  content: '# Branded Document\n\nWith custom colors!',
+  metadata: { title: 'Custom Branded PDF' },
+  customColors: {
+    primary: '#3B82F6',    // Blue
+    secondary: '#6B7280',  // Gray
+    accent: '#111827'      // Dark
+  }
+});
+```
+
+### Save to File
+
+```typescript
+import { generatePDF } from 'ai-pdf-builder';
+
+const result = await generatePDF({
+  content: '# My Document',
+  metadata: { title: 'Saved PDF' },
+  outputPath: './output/my-document.pdf'
+});
+
+if (result.success) {
+  console.log(`PDF saved to: ${result.path}`);
+}
+```
+
+### Custom Templates
+
+```typescript
+import { generatePDF, registerTemplate } from 'ai-pdf-builder';
+
+// Register a custom template
+registerTemplate({
+  name: 'company-branded',
+  path: './templates/company.latex',
+  description: 'Company branded template with logo',
+  supportedDocTypes: ['memo', 'whitepaper', 'report']
+});
+
+// Use the custom template
+const result = await generatePDF({
+  content: '# Company Report',
+  metadata: { title: 'Annual Report' },
+  template: 'company-branded'
+});
+```
+
+### List Available Templates
+
+```typescript
+import { listTemplates } from 'ai-pdf-builder';
+
+const templates = listTemplates();
+templates.forEach(t => {
+  console.log(`${t.name}: ${t.description}`);
+  console.log(`  Supports: ${t.supportedDocTypes.join(', ')}`);
+});
+```
+
+### Check System Requirements
+
+```typescript
+import { checkSystem } from 'ai-pdf-builder';
+
+const status = checkSystem();
+if (status.ready) {
+  console.log('System ready:', status.message);
+} else {
+  console.error('Missing dependencies:', status.message);
+  if (!status.pandoc.available) {
+    console.error('Pandoc:', status.pandoc.error);
+  }
+  if (!status.latex.available) {
+    console.error('LaTeX:', status.latex.error);
+  }
+}
+```
+
+## Integration with Next.js
+
+### API Route Example
+
+```typescript
+// app/api/generate-pdf/route.ts
+import { generatePDF } from 'ai-pdf-builder';
+import { NextResponse } from 'next/server';
+
+export async function POST(request: Request) {
+  const { content, title, type } = await request.json();
+  
+  const result = await generatePDF({
+    content,
+    metadata: { title },
+    template: type === 'memo' ? 'memo' : 'default'
+  });
+
+  if (!result.success) {
+    return NextResponse.json({ error: result.error }, { status: 500 });
+  }
+
+  return new NextResponse(result.buffer, {
+    headers: {
+      'Content-Type': 'application/pdf',
+      'Content-Disposition': `attachment; filename="${title}.pdf"`
+    }
+  });
+}
+```
+
+### Server Action Example
+
+```typescript
+// app/actions/pdf.ts
+'use server';
+
+import { generateMemo } from 'ai-pdf-builder';
+
+export async function createMemo(content: string, title: string) {
+  const result = await generateMemo(content, { title });
+  
+  if (!result.success) {
+    throw new Error(result.error);
+  }
+  
+  return result.buffer?.toString('base64');
+}
+```
+
+## API Reference
+
+### generatePDF(options: PDFOptions): Promise<PDFResult>
+
+Main function to generate a PDF from Markdown content.
+
+#### PDFOptions
+
+| Property | Type | Required | Description |
+|----------|------|----------|-------------|
+| `content` | `string` | Yes | Markdown content to convert |
+| `metadata` | `DocumentMetadata` | No | Document metadata (title, author, etc.) |
+| `template` | `string` | No | Template name or path (default: 'default') |
+| `customColors` | `ColorConfig` | No | Custom color configuration |
+| `outputPath` | `string` | No | Save PDF to this path instead of returning buffer |
+| `toc` | `boolean` | No | Include table of contents (default: true) |
+| `tocDepth` | `number` | No | Depth of TOC (1-3, default: 2) |
+| `numberSections` | `boolean` | No | Number sections (default: true) |
+| `fontSize` | `number` | No | Font size in points (default: 11) |
+| `margin` | `string` | No | Page margins (default: '1in') |
+| `paperSize` | `'letter' \| 'a4'` | No | Paper size (default: 'letter') |
+| `timeout` | `number` | No | Timeout in ms (default: 60000) |
+
+#### PDFResult
+
+| Property | Type | Description |
+|----------|------|-------------|
+| `success` | `boolean` | Whether generation succeeded |
+| `buffer` | `Buffer` | Generated PDF (if outputPath not specified) |
+| `path` | `string` | Path to saved PDF (if outputPath specified) |
+| `error` | `string` | Error message if failed |
+| `pageCount` | `number` | Estimated page count |
+| `fileSize` | `number` | File size in bytes |
+| `generationTime` | `number` | Generation time in ms |
+
+### Preset Functions
+
+All preset functions have the signature:
+
+```typescript
+function preset(
+  content: string,
+  metadata: DocumentMetadata,
+  options?: Partial<PDFOptions>
+): Promise<PDFResult>
+```
+
+Available presets:
+- `generateMemo` - Business memos
+- `generateAgreement` - Legal agreements
+- `generateTermsheet` - Investment term sheets
+- `generateWhitepaper` - Technical whitepapers
+- `generateReport` - Business reports
+- `generateProposal` - Proposals
+- `generateCapitalIntroAgreement` - Fundraising agreements
+- `generateSAFE` - SAFE documents
+- `generateNDA` - Non-disclosure agreements
+
+### Template Functions
+
+- `getTemplate(name: string): string | null` - Get template content
+- `listTemplates(): TemplateConfig[]` - List all templates
+- `registerTemplate(config: TemplateConfig): void` - Register custom template
+- `hasTemplate(name: string): boolean` - Check if template exists
+
+### Utility Functions
+
+- `checkSystem(): SystemCheck` - Check Pandoc/LaTeX availability
+- `checkPandoc(): PandocCheck` - Check Pandoc installation
+- `checkLaTeX(): LaTeXCheck` - Check LaTeX installation
+- `sanitizeContent(content: string): string` - Sanitize for LaTeX safety
+
+## Built-in Templates
+
+| Template | Description | Best For |
+|----------|-------------|----------|
+| `default` | Clean, professional styling | Whitepapers, reports |
+| `memo` | Compact business memo | Executive summaries |
+| `agreement` | Formal legal document | Contracts, agreements |
+| `termsheet` | Premium dark + gold finance | Term sheets, investment docs |
+
+## Troubleshooting
+
+### "Pandoc not found"
+
+Install Pandoc:
+- macOS: `brew install pandoc`
+- Ubuntu: `sudo apt-get install pandoc`
+- Windows: Download from [pandoc.org](https://pandoc.org)
+
+### "pdflatex not found"
+
+Install LaTeX:
+- macOS: `brew install --cask basictex`
+- Ubuntu: `sudo apt-get install texlive-latex-base texlive-latex-extra`
+- Windows: Install [MiKTeX](https://miktex.org)
+
+### Missing LaTeX packages
+
+```bash
+sudo tlmgr install <package-name>
+```
+
+Common packages needed:
+```bash
+sudo tlmgr install fancyhdr titlesec enumitem xcolor booktabs longtable geometry hyperref
+```
+
+### Timeout errors
+
+Increase the timeout for large documents:
+
+```typescript
+const result = await generatePDF({
+  content: longContent,
+  timeout: 120000 // 2 minutes
+});
+```
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions welcome! Please read our contributing guidelines before submitting PRs.