@elevasis/core 0.29.0 → 0.31.0

package/src/business/pdf/sections/__tests__/proposal-document.test.ts

@@ -0,0 +1,146 @@
+/**
+ * Tests for the shared PDF proposal document builder.
+ *
+ * Verifies that provider branding is fully caller-supplied and no
+ * hardcoded "Elevasis" strings leak into the shared @repo/core builder.
+ */
+
+import { describe, it, expect } from 'vitest'
+import { buildProposalDocument } from '../proposal-document'
+import { acceptanceSection } from '../acceptance'
+import type { AutomationConfig } from '../types'
+
+// ---------------------------------------------------------------------------
+// Fixtures
+// ---------------------------------------------------------------------------
+
+const sampleAutomation: AutomationConfig = {
+  title: 'Test Automation',
+  howItWorks: 'Does stuff automatically.',
+  workflow: ['Step 1', 'Step 2'],
+  impact: ['Saves time'],
+  hoursPerWeek: 5,
+  annualSavings: 10000
+}
+
+const baseConfig = {
+  company: 'Acme Corp',
+  contact: 'Jane Doe',
+  vertical: 'Tech',
+  solutions: 'Automation',
+  executiveSummary: 'Summary text.',
+  automations: [sampleAutomation],
+  tier: 'tier2' as const,
+  initialFee: 5000,
+  monthlyFee: 2500
+}
+
+// ---------------------------------------------------------------------------
+// buildProposalDocument
+// ---------------------------------------------------------------------------
+
+describe('buildProposalDocument', () => {
+  it('sets metadata.author from providerName', () => {
+    const doc = buildProposalDocument({ ...baseConfig, providerName: 'Elevasis' })
+    expect(doc.metadata.author).toBe('Elevasis')
+  })
+
+  it('sets metadata.author to a different caller-supplied value', () => {
+    const doc = buildProposalDocument({ ...baseConfig, providerName: 'Acme Solutions' })
+    expect(doc.metadata.author).toBe('Acme Solutions')
+  })
+
+  it('does not hardcode "Elevasis" in metadata when a different providerName is given', () => {
+    const doc = buildProposalDocument({ ...baseConfig, providerName: 'OtherProvider' })
+    expect(doc.metadata.author).not.toBe('Elevasis')
+  })
+
+  it('includes the providerName in the acceptance page text', () => {
+    const doc = buildProposalDocument({ ...baseConfig, providerName: 'MyAgency' })
+    // The acceptance page is the last page
+    const lastPage = doc.pages[doc.pages.length - 1]
+    const allText = JSON.stringify(lastPage)
+    expect(allText).toContain('MyAgency')
+    expect(allText).not.toContain('Elevasis')
+  })
+
+  it('includes correct metadata title', () => {
+    const doc = buildProposalDocument({ ...baseConfig, providerName: 'Elevasis' })
+    expect(doc.metadata.title).toBe('Proposal for Acme Corp')
+  })
+
+  it('builds the correct number of pages (cover + summary + automations + summary-investment + acceptance)', () => {
+    const doc = buildProposalDocument({ ...baseConfig, providerName: 'Elevasis' })
+    // 1 cover + 1 summary + 1 automation + 1 summary-investment + 1 acceptance = 5
+    expect(doc.pages).toHaveLength(5)
+  })
+})
+
+// ---------------------------------------------------------------------------
+// acceptanceSection
+// ---------------------------------------------------------------------------
+
+describe('acceptanceSection', () => {
+  it('uses providerName in the acceptance statement', () => {
+    const page = acceptanceSection({
+      companyName: 'Acme Corp',
+      contactName: 'Jane Doe',
+      tier: 'tier2',
+      initialFee: 5000,
+      providerName: 'Elevasis'
+    })
+    const text = JSON.stringify(page)
+    expect(text).toContain('authorizes Elevasis to proceed')
+  })
+
+  it('uses a different providerName when supplied', () => {
+    const page = acceptanceSection({
+      companyName: 'Acme Corp',
+      contactName: 'Jane Doe',
+      tier: 'tier1',
+      initialFee: 3000,
+      providerName: 'AnotherAgency'
+    })
+    const text = JSON.stringify(page)
+    expect(text).toContain('authorizes AnotherAgency to proceed')
+    expect(text).not.toContain('Elevasis')
+  })
+
+  it('includes companyName and contactName in the acceptance statement', () => {
+    const page = acceptanceSection({
+      companyName: 'TestCo',
+      contactName: 'Bob Smith',
+      tier: 'tier2',
+      initialFee: 4000,
+      providerName: 'MyProvider'
+    })
+    const text = JSON.stringify(page)
+    expect(text).toContain('Bob Smith')
+    expect(text).toContain('TestCo')
+  })
+
+  it('omits monthly fee term when monthlyFee is not provided', () => {
+    const page = acceptanceSection({
+      companyName: 'Acme',
+      contactName: 'Alice',
+      tier: 'tier1',
+      initialFee: 2000,
+      providerName: 'Elevasis'
+    })
+    const text = JSON.stringify(page)
+    expect(text).not.toContain('Monthly fee')
+  })
+
+  it('includes monthly fee term when monthlyFee is provided', () => {
+    const page = acceptanceSection({
+      companyName: 'Acme',
+      contactName: 'Alice',
+      tier: 'tier2',
+      initialFee: 5000,
+      monthlyFee: 1500,
+      providerName: 'Elevasis'
+    })
+    const text = JSON.stringify(page)
+    expect(text).toContain('Monthly fee')
+  })
+})

package/src/business/pdf/sections/acceptance.ts

@@ -1,112 +1,114 @@
-/**
- * Acceptance Section Builder
- *
- * Creates a dedicated signature/acceptance page for proposals.
- * This page contains minimal terms and signature fields placement area.
- *
- * Pattern: Content-only configuration, styling handled by theme system.
- *
- * @example
- * ```typescript
- * import { acceptanceSection } from '@repo/core/pdf/sections'
- *
- * const page = acceptanceSection({
- *   companyName: 'Acme Corp',
- *   contactName: 'John Smith',
- *   tier: 'tier2',
- *   initialFee: 5000,
- *   monthlyFee: 2500  // optional
- * })
- * ```
- */
-
-import type { Page } from '../types'
-
-/**
- * Configuration for acceptance section
- */
-export interface AcceptanceSectionConfig {
-  /** Company name for personalization */
-  companyName: string
-  /** Contact name for personalization */
-  contactName: string
-  /** Service tier being proposed */
-  tier: 'tier1' | 'tier2' | 'tier3' | 'custom'
-  /** Initial fee amount in dollars (one-time implementation fee) */
-  initialFee: number
-  /** Monthly fee amount in dollars (optional, for ongoing support) */
-  monthlyFee?: number
-}
-
-/**
- * Build acceptance page with simplified terms and signature area
- *
- * Creates a dedicated page at the end of the proposal with:
- * - Pricing summary
- * - Key terms (audit timeline, training, support, guarantee)
- * - Acceptance statement
- * - Space for electronic signature fields (added by SignatureAPI)
- *
- * @param config - Acceptance section configuration
- * @returns Page structure for terms and acceptance
- */
-export function acceptanceSection(config: AcceptanceSectionConfig): Page {
-  const { companyName, contactName, tier, initialFee, monthlyFee } = config
-
-  const tierDescriptions = {
-    tier1: 'Standard Implementation',
-    tier2: 'Professional Implementation',
-    tier3: 'Enterprise Implementation',
-    custom: 'Custom Implementation'
-  }
-
-  // Build simplified terms list
-  const terms: string[] = [
-    `Initial fee: $${initialFee.toLocaleString()} (${tierDescriptions[tier]})`,
-    ...(monthlyFee ? [`Monthly fee: $${monthlyFee.toLocaleString()}/month`] : []),
-    'Detailed audit begins within 5 business days of payment',
-    'Training materials provided',
-    ...(monthlyFee ? ['Ongoing maintenance, support, and optimization included'] : []),
-    'Payment link provided via email after signing',
-    '60-day money-back guarantee'
-  ]
-
-  return {
-    header: { title: 'Agreement & Terms', variant: 'accent' },
-    footer: true,
-    sections: [
-      {
-        type: 'card',
-        content: [
-          {
-            type: 'list',
-            ordered: false,
-            items: terms
-          }
-        ]
-      },
-      {
-        type: 'text',
-        content: `By signing below, ${contactName} of ${companyName} authorizes Elevasis to proceed.`,
-        variant: 'body'
-      },
-      {
-        type: 'card',
-        title: 'Signature',
-        variant: 'light',
-        content: [
-          {
-            type: 'text',
-            content: 'Electronic signature will be captured below via SignatureAPI',
-            variant: 'caption'
-          },
-          {
-            type: 'text',
-            content: '\n\n\n\n\n',
-            variant: 'body'
-          }
-        ]
-      }
-    ]
-  }
-}
+/**
+ * Acceptance Section Builder
+ *
+ * Creates a dedicated signature/acceptance page for proposals.
+ * This page contains minimal terms and signature fields placement area.
+ *
+ * Pattern: Content-only configuration, styling handled by theme system.
+ *
+ * @example
+ * ```typescript
+ * import { acceptanceSection } from '@repo/core/pdf/sections'
+ *
+ * const page = acceptanceSection({
+ *   companyName: 'Acme Corp',
+ *   contactName: 'John Smith',
+ *   tier: 'tier2',
+ *   initialFee: 5000,
+ *   monthlyFee: 2500  // optional
+ * })
+ * ```
+ */
+
+import type { Page } from '../types'
+
+/**
+ * Configuration for acceptance section
+ */
+export interface AcceptanceSectionConfig {
+  /** Company name for personalization */
+  companyName: string
+  /** Contact name for personalization */
+  contactName: string
+  /** Service tier being proposed */
+  tier: 'tier1' | 'tier2' | 'tier3' | 'custom'
+  /** Initial fee amount in dollars (one-time implementation fee) */
+  initialFee: number
+  /** Monthly fee amount in dollars (optional, for ongoing support) */
+  monthlyFee?: number
+  /** Name of the service provider issuing the proposal (e.g. "Elevasis") */
+  providerName: string
+}
+
+/**
+ * Build acceptance page with simplified terms and signature area
+ *
+ * Creates a dedicated page at the end of the proposal with:
+ * - Pricing summary
+ * - Key terms (audit timeline, training, support, guarantee)
+ * - Acceptance statement
+ * - Space for electronic signature fields (added by SignatureAPI)
+ *
+ * @param config - Acceptance section configuration
+ * @returns Page structure for terms and acceptance
+ */
+export function acceptanceSection(config: AcceptanceSectionConfig): Page {
+  const { companyName, contactName, tier, initialFee, monthlyFee, providerName } = config
+
+  const tierDescriptions = {
+    tier1: 'Standard Implementation',
+    tier2: 'Professional Implementation',
+    tier3: 'Enterprise Implementation',
+    custom: 'Custom Implementation'
+  }
+
+  // Build simplified terms list
+  const terms: string[] = [
+    `Initial fee: $${initialFee.toLocaleString()} (${tierDescriptions[tier]})`,
+    ...(monthlyFee ? [`Monthly fee: $${monthlyFee.toLocaleString()}/month`] : []),
+    'Detailed audit begins within 5 business days of payment',
+    'Training materials provided',
+    ...(monthlyFee ? ['Ongoing maintenance, support, and optimization included'] : []),
+    'Payment link provided via email after signing',
+    '60-day money-back guarantee'
+  ]
+
+  return {
+    header: { title: 'Agreement & Terms', variant: 'accent' },
+    footer: true,
+    sections: [
+      {
+        type: 'card',
+        content: [
+          {
+            type: 'list',
+            ordered: false,
+            items: terms
+          }
+        ]
+      },
+      {
+        type: 'text',
+        content: `By signing below, ${contactName} of ${companyName} authorizes ${providerName} to proceed.`,
+        variant: 'body'
+      },
+      {
+        type: 'card',
+        title: 'Signature',
+        variant: 'light',
+        content: [
+          {
+            type: 'text',
+            content: 'Electronic signature will be captured below via SignatureAPI',
+            variant: 'caption'
+          },
+          {
+            type: 'text',
+            content: '\n\n\n\n\n',
+            variant: 'body'
+          }
+        ]
+      }
+    ]
+  }
+}