@elevasis/core 0.27.0 → 0.29.0

package/src/business/acquisition/api-schemas.ts

@@ -1,7 +1,6 @@
 import { z } from 'zod'
 import { UuidSchema, NonEmptyStringSchema } from '../../platform/utils/validation'
 import { CredentialRequirementSchema, RecordColumnConfigSchema } from '../../organization-model/domains/prospecting'
-import { isProspectingBuildTemplateId } from './build-templates'
 export { CrmPriorityBucketKeySchema, CrmPriorityBucketOverrideSchema, CrmPriorityOverrideSchema } from './crm-priority'
 export type { CrmPriorityBucketOverride, CrmPriorityOverride, ResolvedCrmPriorityRuleConfig } from './crm-priority'
 
@@ -508,12 +507,15 @@ export const PipelineStageSchema = z.object({
   order: z.number().int().optional()
 })
 
+export const DataModeSchema = z.enum(['mock', 'live'])
+
 /**
  * Pipeline presentation contract stored in `acq_lists.pipeline_config` jsonb.
  * `stages[].key` validates against the catalog; the rest is presentation only.
  */
 export const PipelineConfigSchema = z.object({
-  stages: z.array(PipelineStageSchema).optional()
+  stages: z.array(PipelineStageSchema).optional(),
+  dataMode: DataModeSchema.optional()
 })
 
 export const BuildPlanSnapshotStepSchema = z
@@ -584,9 +586,10 @@ export const AcqListMetadataSchema = z
   })
   .catchall(z.unknown())
 
-export const ProspectingBuildTemplateIdSchema = z.string().trim().min(1).max(100).refine(isProspectingBuildTemplateId, {
-  message: 'buildTemplateId must match a known prospecting build template'
-})
+// Build-template IDs are tenant-owned OM catalog entries. Published core only
+// validates the transport shape; API/services validate membership against the
+// tenant's resolved Organization Model before creating or changing snapshots.
+export const ProspectingBuildTemplateIdSchema = z.string().trim().min(1).max(100)
 
 // ---------------------------------------------------------------------------
 // List telemetry / progress schemas
@@ -1360,6 +1363,7 @@ export const AcqListSchemas = {
   ScrapingConfig: ScrapingConfigSchema,
   IcpRubric: IcpRubricSchema,
   PipelineConfig: PipelineConfigSchema,
+  DataMode: DataModeSchema,
   PipelineStage: PipelineStageSchema,
   BuildPlanSnapshot: BuildPlanSnapshotSchema,
   BuildPlanSnapshotStep: BuildPlanSnapshotStepSchema,
@@ -1459,6 +1463,7 @@ export type ListStatus = z.infer<typeof ListStatusSchema>
 export type ScrapingConfig = z.infer<typeof ScrapingConfigSchema>
 export type IcpRubric = z.infer<typeof IcpRubricSchema>
 export type PipelineStage = z.infer<typeof PipelineStageSchema>
+export type DataMode = z.infer<typeof DataModeSchema>
 export type PipelineConfig = z.infer<typeof PipelineConfigSchema>
 export type BuildPlanSnapshotStep = z.infer<typeof BuildPlanSnapshotStepSchema>
 export type BuildPlanSnapshot = z.infer<typeof BuildPlanSnapshotSchema>

package/src/business/acquisition/build-templates.test.ts

@@ -1,240 +1,187 @@
-import { describe, expect, it } from 'vitest'
-import {
-  DEFAULT_PROSPECTING_BUILD_TEMPLATE_ID,
-  PROSPECTING_BUILD_TEMPLATE_OPTIONS,
-  createBuildPlanSnapshotFromTemplateId,
-  isProspectingBuildTemplateId
-} from './build-templates'
-
-// ---------------------------------------------------------------------------
-// isProspectingBuildTemplateId
-// ---------------------------------------------------------------------------
-
-describe('isProspectingBuildTemplateId', () => {
-  it('returns true for every id in PROSPECTING_BUILD_TEMPLATE_OPTIONS', () => {
-    for (const option of PROSPECTING_BUILD_TEMPLATE_OPTIONS) {
-      expect(isProspectingBuildTemplateId(option.id)).toBe(true)
-    }
-  })
-
-  it('returns true for the known "local-services" template id', () => {
-    expect(isProspectingBuildTemplateId('local-services')).toBe(true)
-  })
-
-  it('returns true for the known "dtc-subscription-apollo-clickup" template id', () => {
-    expect(isProspectingBuildTemplateId('dtc-subscription-apollo-clickup')).toBe(true)
-  })
-
-  it('returns false for an unknown string', () => {
-    expect(isProspectingBuildTemplateId('not-a-template')).toBe(false)
-  })
-
-  it('returns false for an empty string', () => {
-    expect(isProspectingBuildTemplateId('')).toBe(false)
-  })
-
-  it('returns false for a partial id match', () => {
-    expect(isProspectingBuildTemplateId('local')).toBe(false)
-    expect(isProspectingBuildTemplateId('dtc-subscription')).toBe(false)
-  })
-
-  it('returns false for a whitespace-padded id', () => {
-    expect(isProspectingBuildTemplateId(' local-services ')).toBe(false)
-  })
-
-  it('verifies PROSPECTING_BUILD_TEMPLATE_OPTIONS contains at least two entries', () => {
-    expect(PROSPECTING_BUILD_TEMPLATE_OPTIONS.length).toBeGreaterThanOrEqual(2)
-  })
-
-  it('verifies DEFAULT_PROSPECTING_BUILD_TEMPLATE_ID is itself a valid template id', () => {
-    expect(isProspectingBuildTemplateId(DEFAULT_PROSPECTING_BUILD_TEMPLATE_ID)).toBe(true)
-  })
-})
-
-// ---------------------------------------------------------------------------
-// createBuildPlanSnapshotFromTemplateId — unknown id
-// ---------------------------------------------------------------------------
-
-describe('createBuildPlanSnapshotFromTemplateId — unknown id', () => {
-  it('returns null for an unknown template id', () => {
-    expect(createBuildPlanSnapshotFromTemplateId('not-a-template')).toBeNull()
-  })
-
-  it('returns null for an empty string', () => {
-    expect(createBuildPlanSnapshotFromTemplateId('')).toBeNull()
-  })
-})
-
-// ---------------------------------------------------------------------------
-// createBuildPlanSnapshotFromTemplateId — "local-services"
-// ---------------------------------------------------------------------------
-
-describe('createBuildPlanSnapshotFromTemplateId — "local-services"', () => {
-  const snapshot = createBuildPlanSnapshotFromTemplateId('local-services')
-
-  it('returns a non-null snapshot', () => {
-    expect(snapshot).not.toBeNull()
-  })
-
-  it('preserves the template id in the snapshot', () => {
-    expect(snapshot?.templateId).toBe('local-services')
-  })
-
-  it('includes a non-empty templateLabel', () => {
-    expect(snapshot?.templateLabel).toBeTruthy()
-  })
-
-  it('produces a steps array with length matching the catalog (7 steps)', () => {
-    expect(snapshot?.steps).toHaveLength(7)
-  })
-
-  it('every step has required fields: id, label, primaryEntity, outputs, stageKey, dependencyMode, actionKey', () => {
-    for (const step of snapshot?.steps ?? []) {
-      expect(step.id).toBeTruthy()
-      expect(step.label).toBeTruthy()
-      expect(['company', 'contact']).toContain(step.primaryEntity)
-      expect(step.outputs.length).toBeGreaterThanOrEqual(1)
-      expect(step.stageKey).toBeTruthy()
-      expect(step.dependencyMode).toBe('per-record-eligibility')
-      expect(step.actionKey).toBeTruthy()
-    }
-  })
-
-  it('every step has positive defaultBatchSize and maxBatchSize', () => {
-    for (const step of snapshot?.steps ?? []) {
-      expect(step.defaultBatchSize).toBeGreaterThan(0)
-      expect(step.maxBatchSize).toBeGreaterThanOrEqual(step.defaultBatchSize)
-    }
-  })
-
-  it('steps with declared dependsOn in the catalog have dependsOn in the snapshot', () => {
-    const withDeps = snapshot?.steps.filter((step) => step.dependsOn !== undefined) ?? []
-    expect(withDeps.length).toBeGreaterThan(0)
-    for (const step of withDeps) {
-      expect(Array.isArray(step.dependsOn)).toBe(true)
-      expect((step.dependsOn ?? []).length).toBeGreaterThan(0)
-    }
-  })
-
-  it('the first step (source-companies) has no dependsOn', () => {
-    const first = snapshot?.steps[0]
-    expect(first?.id).toBe('source-companies')
-    expect(first?.dependsOn).toBeUndefined()
-  })
-
-  it('outputs arrays are copies (mutation does not affect subsequent calls)', () => {
-    const snapshotA = createBuildPlanSnapshotFromTemplateId('local-services')
-    const snapshotB = createBuildPlanSnapshotFromTemplateId('local-services')
-    snapshotA?.steps[0]?.outputs.push('export' as never)
-    expect(snapshotB?.steps[0]?.outputs).not.toContain('export')
-  })
-})
-
-// ---------------------------------------------------------------------------
-// createBuildPlanSnapshotFromTemplateId — "dtc-subscription-apollo-clickup"
-// ---------------------------------------------------------------------------
-
-describe('createBuildPlanSnapshotFromTemplateId — "dtc-subscription-apollo-clickup"', () => {
-  const snapshot = createBuildPlanSnapshotFromTemplateId('dtc-subscription-apollo-clickup')
-
-  it('returns a non-null snapshot', () => {
-    expect(snapshot).not.toBeNull()
-  })
-
-  it('preserves the template id in the snapshot', () => {
-    expect(snapshot?.templateId).toBe('dtc-subscription-apollo-clickup')
-  })
-
-  it('produces a steps array with length matching the catalog (6 steps)', () => {
-    expect(snapshot?.steps).toHaveLength(6)
-  })
-
-  it('every step has required fields: id, label, primaryEntity, outputs, stageKey, dependencyMode, actionKey', () => {
-    for (const step of snapshot?.steps ?? []) {
-      expect(step.id).toBeTruthy()
-      expect(step.label).toBeTruthy()
-      expect(['company', 'contact']).toContain(step.primaryEntity)
-      expect(step.outputs.length).toBeGreaterThanOrEqual(1)
-      expect(step.stageKey).toBeTruthy()
-      expect(step.dependencyMode).toBe('per-record-eligibility')
-      expect(step.actionKey).toBeTruthy()
-    }
-  })
-
-  it('every step has positive defaultBatchSize and maxBatchSize', () => {
-    for (const step of snapshot?.steps ?? []) {
-      expect(step.defaultBatchSize).toBeGreaterThan(0)
-      expect(step.maxBatchSize).toBeGreaterThanOrEqual(step.defaultBatchSize)
-    }
-  })
-
-  it('the first step (import-apollo-search) has no dependsOn', () => {
-    const first = snapshot?.steps[0]
-    expect(first?.id).toBe('import-apollo-search')
-    expect(first?.dependsOn).toBeUndefined()
-  })
-
-  it('the first step outputs both company and contact', () => {
-    const first = snapshot?.steps[0]
-    expect(first?.outputs).toContain('company')
-    expect(first?.outputs).toContain('contact')
-  })
-
-  it('preserves Apollo credential requirements for source import and decision-maker enrichment', () => {
-    const importApolloSearch = snapshot?.steps.find((step) => step.id === 'import-apollo-search')
-    const enrichDecisionMakers = snapshot?.steps.find((step) => step.id === 'enrich-decision-makers')
-
-    const expectedRequirement = {
-      key: 'apollo',
-      provider: 'apollo',
-      credentialType: 'api-key-secret',
-      label: 'Apollo API key',
-      required: true,
-      selectionMode: 'single',
-      inputPath: 'credential'
-    }
-
-    expect(importApolloSearch?.credentialRequirements).toEqual([expectedRequirement])
-    expect(enrichDecisionMakers?.credentialRequirements).toEqual([expectedRequirement])
-  })
-
-  it('the final step (review-and-export) outputs export', () => {
-    const last = snapshot?.steps[snapshot.steps.length - 1]
-    expect(last?.id).toBe('review-and-export')
-    expect(last?.outputs).toContain('export')
-  })
-
-  it('preserves contact records metadata for the company-owned decision-maker step', () => {
-    const decisionMakers = snapshot?.steps.find((step) => step.id === 'enrich-decision-makers')
-    expect(decisionMakers).toMatchObject({
-      primaryEntity: 'company',
-      recordEntity: 'contact',
-      stageKey: 'decision-makers-enriched'
-    })
-    expect(decisionMakers?.recordColumns?.contact?.length).toBeGreaterThan(0)
-  })
-
-  it('steps with descriptions in the catalog include description in the snapshot', () => {
-    const withDesc = snapshot?.steps.filter((step) => step.description !== undefined) ?? []
-    expect(withDesc.length).toBeGreaterThan(0)
-    for (const step of withDesc) {
-      expect(typeof step.description).toBe('string')
-      expect(step.description!.length).toBeGreaterThan(0)
-    }
-  })
-})
-
-// ---------------------------------------------------------------------------
-// Snapshot shape contract — applies to every valid template id
-// ---------------------------------------------------------------------------
-
-describe('createBuildPlanSnapshotFromTemplateId — shape contract for all templates', () => {
-  it('returns a snapshot for every id that isProspectingBuildTemplateId reports valid', () => {
-    for (const option of PROSPECTING_BUILD_TEMPLATE_OPTIONS) {
-      const snapshot = createBuildPlanSnapshotFromTemplateId(option.id)
-      expect(snapshot).not.toBeNull()
-      expect(snapshot?.templateId).toBe(option.id)
-      expect(snapshot?.steps.length).toBeGreaterThan(0)
-    }
-  })
-})
+import { describe, expect, it } from 'vitest'
+import type { ProspectingBuildTemplate } from '../../organization-model/domains/prospecting'
+import {
+  createBuildPlanSnapshotFromTemplate,
+  createBuildPlanSnapshotFromTemplateId,
+  getProspectingBuildTemplateOptions,
+  isProspectingBuildTemplateId
+} from './build-templates'
+
+const templates: ProspectingBuildTemplate[] = [
+  {
+    id: 'source-and-qualify',
+    label: 'Source and Qualify',
+    description: 'Source companies, analyze websites, and qualify fit.',
+    steps: [
+      {
+        id: 'source-companies',
+        label: 'Companies found',
+        primaryEntity: 'company',
+        outputs: ['company'],
+        stageKey: 'populated',
+        dependencyMode: 'per-record-eligibility',
+        actionKey: 'lead-gen.company.source',
+        defaultBatchSize: 100,
+        maxBatchSize: 250,
+        recordColumns: {
+          company: [{ key: 'name', label: 'Company', path: 'company.name' }]
+        }
+      },
+      {
+        id: 'qualify-companies',
+        label: 'Companies qualified',
+        description: 'Score companies against the active ICP.',
+        primaryEntity: 'company',
+        outputs: ['company'],
+        stageKey: 'qualified',
+        dependsOn: ['source-companies'],
+        dependencyMode: 'per-record-eligibility',
+        actionKey: 'lead-gen.company.qualify',
+        defaultBatchSize: 50,
+        maxBatchSize: 100
+      }
+    ]
+  },
+  {
+    id: 'export-ready',
+    label: 'Export Ready',
+    steps: [
+      {
+        id: 'review-and-export',
+        label: 'Reviewed and exported',
+        primaryEntity: 'company',
+        outputs: ['export'],
+        stageKey: 'uploaded',
+        recordsStageKey: 'uploaded',
+        recordSourceStageKey: 'qualified',
+        dependencyMode: 'per-record-eligibility',
+        actionKey: 'lead-gen.export.list',
+        defaultBatchSize: 25,
+        maxBatchSize: 100,
+        credentialRequirements: [
+          {
+            key: 'export',
+            provider: 'export-provider',
+            credentialType: 'api-key-secret',
+            label: 'Export API token',
+            required: true,
+            selectionMode: 'single',
+            inputPath: 'credential',
+            verifyOnRun: true
+          }
+        ]
+      }
+    ]
+  }
+]
+
+describe('getProspectingBuildTemplateOptions', () => {
+  it('projects option metadata from caller-supplied templates', () => {
+    expect(getProspectingBuildTemplateOptions(templates)).toEqual([
+      {
+        id: 'source-and-qualify',
+        label: 'Source and Qualify',
+        description: 'Source companies, analyze websites, and qualify fit.'
+      },
+      {
+        id: 'export-ready',
+        label: 'Export Ready',
+        description: undefined
+      }
+    ])
+  })
+})
+
+describe('isProspectingBuildTemplateId', () => {
+  it('checks membership against caller-supplied templates', () => {
+    expect(isProspectingBuildTemplateId('source-and-qualify', templates)).toBe(true)
+    expect(isProspectingBuildTemplateId('not-a-template', templates)).toBe(false)
+  })
+
+  it('has no published default template catalog', () => {
+    expect(isProspectingBuildTemplateId('source-and-qualify')).toBe(false)
+  })
+})
+
+describe('createBuildPlanSnapshotFromTemplate', () => {
+  it('creates an immutable build-plan snapshot shape from a supplied template', () => {
+    const snapshot = createBuildPlanSnapshotFromTemplate(templates[0]!)
+
+    expect(snapshot).toMatchObject({
+      templateId: 'source-and-qualify',
+      templateLabel: 'Source and Qualify',
+      steps: [
+        {
+          id: 'source-companies',
+          label: 'Companies found',
+          primaryEntity: 'company',
+          outputs: ['company'],
+          stageKey: 'populated',
+          recordsStageKey: 'populated',
+          recordSourceStageKey: 'populated',
+          dependencyMode: 'per-record-eligibility',
+          actionKey: 'lead-gen.company.source',
+          defaultBatchSize: 100,
+          maxBatchSize: 250,
+          recordColumns: {
+            company: [{ key: 'name', label: 'Company', path: 'company.name' }]
+          }
+        },
+        {
+          id: 'qualify-companies',
+          dependsOn: ['source-companies'],
+          description: 'Score companies against the active ICP.'
+        }
+      ]
+    })
+  })
+
+  it('copies array/object fields so subsequent snapshots are isolated', () => {
+    const snapshotA = createBuildPlanSnapshotFromTemplate(templates[0]!)
+    const snapshotB = createBuildPlanSnapshotFromTemplate(templates[0]!)
+
+    snapshotA.steps[0]?.outputs.push('export')
+    snapshotA.steps[0]?.recordColumns?.company?.push({ key: 'domain', label: 'Domain', path: 'company.domain' })
+
+    expect(snapshotB.steps[0]?.outputs).toEqual(['company'])
+    expect(snapshotB.steps[0]?.recordColumns?.company).toEqual([
+      { key: 'name', label: 'Company', path: 'company.name' }
+    ])
+  })
+
+  it('preserves credential requirements and explicit record stage fields', () => {
+    const snapshot = createBuildPlanSnapshotFromTemplate(templates[1]!)
+
+    expect(snapshot.steps[0]).toMatchObject({
+      id: 'review-and-export',
+      recordsStageKey: 'uploaded',
+      recordSourceStageKey: 'qualified',
+      credentialRequirements: [
+        {
+          key: 'export',
+          provider: 'export-provider',
+          credentialType: 'api-key-secret',
+          label: 'Export API token',
+          required: true,
+          selectionMode: 'single',
+          inputPath: 'credential',
+          verifyOnRun: true
+        }
+      ]
+    })
+  })
+})
+
+describe('createBuildPlanSnapshotFromTemplateId', () => {
+  it('creates snapshots from caller-supplied template catalogs', () => {
+    const snapshot = createBuildPlanSnapshotFromTemplateId('export-ready', templates)
+
+    expect(snapshot?.templateId).toBe('export-ready')
+    expect(snapshot?.steps).toHaveLength(1)
+  })
+
+  it('returns null for unknown ids or when no template catalog is supplied', () => {
+    expect(createBuildPlanSnapshotFromTemplateId('not-a-template', templates)).toBeNull()
+    expect(createBuildPlanSnapshotFromTemplateId('source-and-qualify')).toBeNull()
+  })
+})