@elevasis/core 0.27.0 → 0.29.0

package/src/organization-model/domains/customers.ts

@@ -1,78 +1,95 @@
-import { z } from 'zod'
-
-// ---------------------------------------------------------------------------
-// Firmographics — optional demographic/firmographic filters that describe the
-// target customer segment's organizational profile. All fields are optional so
-// a segment can declare only the axes relevant to targeting.
-// ---------------------------------------------------------------------------
-
-export const FirmographicsSchema = z.object({
-  /** Industry vertical (e.g. "Marketing Agency", "Legal", "Real Estate"). */
-  industry: z.string().trim().max(200).optional(),
-  /**
-   * Company headcount band (e.g. "1–10", "11–50", "51–200", "200+").
-   * Free-form string to accommodate any band notation.
-   */
-  companySize: z.string().trim().max(100).optional(),
-  /**
-   * Primary geographic region the segment operates in or is targeted from
-   * (e.g. "North America", "Europe", "Global").
-   */
-  region: z.string().trim().max(200).optional()
-})
-
-// ---------------------------------------------------------------------------
-// Customer segment schema — one entry per distinct buyer archetype.
-// Modeled after Value Proposition Canvas (BMC / VPC) and Business Model Canvas
-// customer-segment language. Fields use plain English throughout.
-// ---------------------------------------------------------------------------
-
-export const CustomerSegmentSchema = z.object({
-  /** Stable unique identifier for the segment (e.g. "segment-smb-agencies"). */
-  id: z.string().trim().min(1).max(100),
-  /** Domain-map iteration order. Convention: multiples of 10 (10, 20, 30, ...) to allow easy insertion. */
-  order: z.number(),
-  /** Human-readable name shown to agents and in UI (e.g. "SMB Marketing Agencies"). */
-  name: z.string().trim().max(200).default(''),
-  /** One or two sentences describing who this segment is. */
-  description: z.string().trim().max(2000).default(''),
-  /**
-   * The primary job(s) this segment is trying to get done — the goal they hire
-   * a product/service to accomplish. Plain-language narrative or bullet list.
-   */
-  jobsToBeDone: z.string().trim().max(2000).default(''),
-  /**
-   * Pains — frustrations, obstacles, and risks the segment experiences
-   * when trying to accomplish their jobs-to-be-done.
-   */
-  pains: z.array(z.string().trim().max(500)).default([]),
-  /**
-   * Gains — outcomes and benefits the segment desires; positive motivators
-   * beyond merely resolving pains.
-   */
-  gains: z.array(z.string().trim().max(500)).default([]),
-  /** Firmographic profile for targeting and filtering. */
-  firmographics: FirmographicsSchema.default({}),
-  /**
-   * Value proposition — one or two sentences stating why this organization's
-   * offering is uniquely suited for this segment's needs.
-   */
-  valueProp: z.string().trim().max(2000).default('')
-})
-
-// ---------------------------------------------------------------------------
-// Customers domain schema — id-keyed map of customer segments.
-// ---------------------------------------------------------------------------
-
-export const CustomersDomainSchema = z
-  .record(z.string(), CustomerSegmentSchema)
-  .refine((record) => Object.entries(record).every(([key, entry]) => entry.id === key), {
-    message: 'Each segment entry id must match its map key'
-  })
-  .default({})
-
-// ---------------------------------------------------------------------------
-// Seed — empty by default; adapters populate with real segment definitions.
-// ---------------------------------------------------------------------------
-
-export const DEFAULT_ORGANIZATION_MODEL_CUSTOMERS: z.infer<typeof CustomersDomainSchema> = {}
+import { z } from 'zod'
+import { defineDomainRecord } from '../helpers'
+
+// ---------------------------------------------------------------------------
+// Firmographics — optional demographic/firmographic filters that describe the
+// target customer segment's organizational profile. All fields are optional so
+// a segment can declare only the axes relevant to targeting.
+// ---------------------------------------------------------------------------
+
+export const FirmographicsSchema = z.object({
+  /** Industry vertical (e.g. "Marketing Agency", "Legal", "Real Estate"). */
+  industry: z.string().trim().max(200).optional(),
+  /**
+   * Company headcount band (e.g. "1–10", "11–50", "51–200", "200+").
+   * Free-form string to accommodate any band notation.
+   */
+  companySize: z.string().trim().max(100).optional(),
+  /**
+   * Primary geographic region the segment operates in or is targeted from
+   * (e.g. "North America", "Europe", "Global").
+   */
+  region: z.string().trim().max(200).optional()
+})
+
+// ---------------------------------------------------------------------------
+// Customer segment schema — one entry per distinct buyer archetype.
+// Modeled after Value Proposition Canvas (BMC / VPC) and Business Model Canvas
+// customer-segment language. Fields use plain English throughout.
+// ---------------------------------------------------------------------------
+
+export const CustomerSegmentSchema = z.object({
+  /** Stable unique identifier for the segment (e.g. "segment-smb-agencies"). */
+  id: z.string().trim().min(1).max(100),
+  /** Domain-map iteration order. Convention: multiples of 10 (10, 20, 30, ...) to allow easy insertion. */
+  order: z.number(),
+  /** Human-readable name shown to agents and in UI (e.g. "SMB Marketing Agencies"). */
+  name: z.string().trim().max(200).default(''),
+  /** One or two sentences describing who this segment is. */
+  description: z.string().trim().max(2000).default(''),
+  /**
+   * The primary job(s) this segment is trying to get done — the goal they hire
+   * a product/service to accomplish. Plain-language narrative or bullet list.
+   */
+  jobsToBeDone: z.string().trim().max(2000).default(''),
+  /**
+   * Pains — frustrations, obstacles, and risks the segment experiences
+   * when trying to accomplish their jobs-to-be-done.
+   */
+  pains: z.array(z.string().trim().max(500)).default([]),
+  /**
+   * Gains — outcomes and benefits the segment desires; positive motivators
+   * beyond merely resolving pains.
+   */
+  gains: z.array(z.string().trim().max(500)).default([]),
+  /** Firmographic profile for targeting and filtering. */
+  firmographics: FirmographicsSchema.default({}),
+  /**
+   * Value proposition — one or two sentences stating why this organization's
+   * offering is uniquely suited for this segment's needs.
+   */
+  valueProp: z.string().trim().max(2000).default('')
+})
+
+// ---------------------------------------------------------------------------
+// Customers domain schema — id-keyed map of customer segments.
+// ---------------------------------------------------------------------------
+
+export const CustomersDomainSchema = z
+  .record(z.string(), CustomerSegmentSchema)
+  .refine((record) => Object.entries(record).every(([key, entry]) => entry.id === key), {
+    message: 'Each segment entry id must match its map key'
+  })
+  .default({})
+
+// ---------------------------------------------------------------------------
+// Seed — empty by default; adapters populate with real segment definitions.
+// ---------------------------------------------------------------------------
+
+export const DEFAULT_ORGANIZATION_MODEL_CUSTOMERS: z.infer<typeof CustomersDomainSchema> = {}
+
+/** Validate and return a single customer segment entry. */
+export function defineCustomer(entry: z.input<typeof CustomerSegmentSchema>): z.infer<typeof CustomerSegmentSchema> {
+  return CustomerSegmentSchema.parse(entry)
+}
+
+/** Validate and return an id-keyed map of customer segment entries. */
+export function defineCustomers(
+  entries: readonly z.input<typeof CustomerSegmentSchema>[]
+): Record<string, z.infer<typeof CustomerSegmentSchema>> {
+  return defineDomainRecord(CustomerSegmentSchema, entries)
+}
+
+export type CustomerSegment = z.infer<typeof CustomerSegmentSchema>
+export type CustomersDomain = z.infer<typeof CustomersDomainSchema>
+export type Firmographics = z.infer<typeof FirmographicsSchema>

package/src/organization-model/domains/entities.ts

@@ -1,144 +1,157 @@
-import { z } from 'zod'
-import { DescriptionSchema, LabelSchema, ModelIdSchema } from './shared'
-
-export const EntityIdSchema = ModelIdSchema
-
-export const EntityLinkKindSchema = z
-  .enum(['belongs-to', 'has-many', 'has-one', 'many-to-many'])
-  .meta({ label: 'Link kind' })
-
-export const EntityLinkSchema = z.object({
-  toEntity: EntityIdSchema.meta({ ref: 'entity' }),
-  kind: EntityLinkKindSchema,
-  via: z.string().trim().min(1).max(255).optional(),
-  label: LabelSchema.optional()
-})
-
-export const EntitySchema = z.object({
-  id: EntityIdSchema,
-  /** Domain-map iteration order. Convention: multiples of 10 (10, 20, 30, ...) to allow easy insertion. */
-  order: z.number(),
-  label: LabelSchema,
-  description: DescriptionSchema.optional(),
-  ownedBySystemId: ModelIdSchema.meta({ ref: 'system' }),
-  table: z.string().trim().min(1).max(255).optional(),
-  rowSchema: ModelIdSchema.optional(),
-  stateCatalogId: ModelIdSchema.optional(),
-  links: z.array(EntityLinkSchema).optional()
-})
-
-export const EntitiesDomainSchema = z
-  .record(z.string(), EntitySchema)
-  .refine((record) => Object.entries(record).every(([key, entry]) => entry.id === key), {
-    message: 'Each entity entry id must match its map key'
-  })
-  .default({})
-
-const ENTITY_ENTRY_INPUTS: z.input<typeof EntitySchema>[] = [
-  {
-    id: 'crm.deal',
-    order: 10,
-    label: 'Deal',
-    description: 'A CRM opportunity or sales pipeline record.',
-    ownedBySystemId: 'sales.crm',
-    table: 'crm_deals',
-    stateCatalogId: 'crm.pipeline',
-    links: [{ toEntity: 'crm.contact', kind: 'has-many', via: 'deal_contacts', label: 'contacts' }]
-  },
-  {
-    id: 'crm.contact',
-    order: 20,
-    label: 'CRM Contact',
-    description: 'A person associated with a CRM relationship or deal.',
-    ownedBySystemId: 'sales.crm',
-    table: 'crm_contacts'
-  },
-  {
-    id: 'leadgen.list',
-    order: 30,
-    label: 'Lead List',
-    description: 'A prospecting list that groups companies and contacts for acquisition workflows.',
-    ownedBySystemId: 'sales.lead-gen',
-    table: 'acq_lists',
-    links: [
-      { toEntity: 'leadgen.company', kind: 'has-many', via: 'acq_list_companies', label: 'companies' },
-      { toEntity: 'leadgen.contact', kind: 'has-many', via: 'acq_list_members', label: 'contacts' }
-    ]
-  },
-  {
-    id: 'leadgen.company',
-    order: 40,
-    label: 'Lead Company',
-    description: 'A company record sourced, enriched, and qualified during prospecting.',
-    ownedBySystemId: 'sales.lead-gen',
-    table: 'acq_list_companies',
-    stateCatalogId: 'lead-gen.company',
-    links: [
-      { toEntity: 'leadgen.list', kind: 'belongs-to', via: 'list_id', label: 'list' },
-      { toEntity: 'leadgen.contact', kind: 'has-many', via: 'company_id', label: 'contacts' }
-    ]
-  },
-  {
-    id: 'leadgen.contact',
-    order: 50,
-    label: 'Lead Contact',
-    description: 'A prospect contact discovered or enriched during lead generation.',
-    ownedBySystemId: 'sales.lead-gen',
-    table: 'acq_list_members',
-    stateCatalogId: 'lead-gen.contact',
-    links: [
-      { toEntity: 'leadgen.list', kind: 'belongs-to', via: 'list_id', label: 'list' },
-      { toEntity: 'leadgen.company', kind: 'belongs-to', via: 'company_id', label: 'company' }
-    ]
-  },
-  {
-    id: 'delivery.project',
-    order: 60,
-    label: 'Project',
-    description: 'A client delivery project.',
-    ownedBySystemId: 'projects',
-    table: 'projects',
-    links: [
-      { toEntity: 'delivery.milestone', kind: 'has-many', via: 'project_id', label: 'milestones' },
-      { toEntity: 'delivery.task', kind: 'has-many', via: 'project_id', label: 'tasks' }
-    ]
-  },
-  {
-    id: 'delivery.milestone',
-    order: 70,
-    label: 'Milestone',
-    description: 'A delivery checkpoint within a project.',
-    ownedBySystemId: 'projects',
-    table: 'project_milestones',
-    links: [
-      { toEntity: 'delivery.project', kind: 'belongs-to', via: 'project_id', label: 'project' },
-      { toEntity: 'delivery.task', kind: 'has-many', via: 'milestone_id', label: 'tasks' }
-    ]
-  },
-  {
-    id: 'delivery.task',
-    order: 80,
-    label: 'Task',
-    description: 'A delivery task that can move through the task status catalog.',
-    ownedBySystemId: 'projects',
-    table: 'project_tasks',
-    stateCatalogId: 'delivery.task',
-    links: [
-      { toEntity: 'delivery.project', kind: 'belongs-to', via: 'project_id', label: 'project' },
-      { toEntity: 'delivery.milestone', kind: 'belongs-to', via: 'milestone_id', label: 'milestone' }
-    ]
-  }
-]
-
-export const DEFAULT_ORGANIZATION_MODEL_ENTITIES: z.infer<typeof EntitiesDomainSchema> = Object.fromEntries(
-  ENTITY_ENTRY_INPUTS.map((entity) => {
-    const parsed = EntitySchema.parse(entity)
-    return [parsed.id, parsed]
-  })
-)
-
-export type EntityId = z.infer<typeof EntityIdSchema>
-export type EntityLinkKind = z.infer<typeof EntityLinkKindSchema>
-export type EntityLink = z.infer<typeof EntityLinkSchema>
-export type Entity = z.infer<typeof EntitySchema>
-export type EntitiesDomain = z.infer<typeof EntitiesDomainSchema>
+import { z } from 'zod'
+import { DescriptionSchema, LabelSchema, ModelIdSchema } from './shared'
+import { defineDomainRecord } from '../helpers'
+
+export const EntityIdSchema = ModelIdSchema
+
+export const EntityLinkKindSchema = z
+  .enum(['belongs-to', 'has-many', 'has-one', 'many-to-many'])
+  .meta({ label: 'Link kind' })
+
+export const EntityLinkSchema = z.object({
+  toEntity: EntityIdSchema.meta({ ref: 'entity' }),
+  kind: EntityLinkKindSchema,
+  via: z.string().trim().min(1).max(255).optional(),
+  label: LabelSchema.optional()
+})
+
+export const EntitySchema = z.object({
+  id: EntityIdSchema,
+  /** Domain-map iteration order. Convention: multiples of 10 (10, 20, 30, ...) to allow easy insertion. */
+  order: z.number(),
+  label: LabelSchema,
+  description: DescriptionSchema.optional(),
+  ownedBySystemId: ModelIdSchema.meta({ ref: 'system' }),
+  table: z.string().trim().min(1).max(255).optional(),
+  rowSchema: ModelIdSchema.optional(),
+  stateCatalogId: ModelIdSchema.optional(),
+  links: z.array(EntityLinkSchema).optional()
+})
+
+export const EntitiesDomainSchema = z
+  .record(z.string(), EntitySchema)
+  .refine((record) => Object.entries(record).every(([key, entry]) => entry.id === key), {
+    message: 'Each entity entry id must match its map key'
+  })
+  .default({})
+
+const ENTITY_ENTRY_INPUTS: z.input<typeof EntitySchema>[] = [
+  {
+    id: 'crm.deal',
+    order: 10,
+    label: 'Deal',
+    description: 'A CRM opportunity or sales pipeline record.',
+    ownedBySystemId: 'sales.crm',
+    table: 'crm_deals',
+    stateCatalogId: 'crm.pipeline',
+    links: [{ toEntity: 'crm.contact', kind: 'has-many', via: 'deal_contacts', label: 'contacts' }]
+  },
+  {
+    id: 'crm.contact',
+    order: 20,
+    label: 'CRM Contact',
+    description: 'A person associated with a CRM relationship or deal.',
+    ownedBySystemId: 'sales.crm',
+    table: 'crm_contacts'
+  },
+  {
+    id: 'leadgen.list',
+    order: 30,
+    label: 'Lead List',
+    description: 'A prospecting list that groups companies and contacts for acquisition workflows.',
+    ownedBySystemId: 'sales.lead-gen',
+    table: 'acq_lists',
+    links: [
+      { toEntity: 'leadgen.company', kind: 'has-many', via: 'acq_list_companies', label: 'companies' },
+      { toEntity: 'leadgen.contact', kind: 'has-many', via: 'acq_list_members', label: 'contacts' }
+    ]
+  },
+  {
+    id: 'leadgen.company',
+    order: 40,
+    label: 'Lead Company',
+    description: 'A company record sourced, enriched, and qualified during prospecting.',
+    ownedBySystemId: 'sales.lead-gen',
+    table: 'acq_list_companies',
+    stateCatalogId: 'lead-gen.company',
+    links: [
+      { toEntity: 'leadgen.list', kind: 'belongs-to', via: 'list_id', label: 'list' },
+      { toEntity: 'leadgen.contact', kind: 'has-many', via: 'company_id', label: 'contacts' }
+    ]
+  },
+  {
+    id: 'leadgen.contact',
+    order: 50,
+    label: 'Lead Contact',
+    description: 'A prospect contact discovered or enriched during lead generation.',
+    ownedBySystemId: 'sales.lead-gen',
+    table: 'acq_list_members',
+    stateCatalogId: 'lead-gen.contact',
+    links: [
+      { toEntity: 'leadgen.list', kind: 'belongs-to', via: 'list_id', label: 'list' },
+      { toEntity: 'leadgen.company', kind: 'belongs-to', via: 'company_id', label: 'company' }
+    ]
+  },
+  {
+    id: 'delivery.project',
+    order: 60,
+    label: 'Project',
+    description: 'A client delivery project.',
+    ownedBySystemId: 'projects',
+    table: 'projects',
+    links: [
+      { toEntity: 'delivery.milestone', kind: 'has-many', via: 'project_id', label: 'milestones' },
+      { toEntity: 'delivery.task', kind: 'has-many', via: 'project_id', label: 'tasks' }
+    ]
+  },
+  {
+    id: 'delivery.milestone',
+    order: 70,
+    label: 'Milestone',
+    description: 'A delivery checkpoint within a project.',
+    ownedBySystemId: 'projects',
+    table: 'project_milestones',
+    links: [
+      { toEntity: 'delivery.project', kind: 'belongs-to', via: 'project_id', label: 'project' },
+      { toEntity: 'delivery.task', kind: 'has-many', via: 'milestone_id', label: 'tasks' }
+    ]
+  },
+  {
+    id: 'delivery.task',
+    order: 80,
+    label: 'Task',
+    description: 'A delivery task that can move through the task status catalog.',
+    ownedBySystemId: 'projects',
+    table: 'project_tasks',
+    stateCatalogId: 'delivery.task',
+    links: [
+      { toEntity: 'delivery.project', kind: 'belongs-to', via: 'project_id', label: 'project' },
+      { toEntity: 'delivery.milestone', kind: 'belongs-to', via: 'milestone_id', label: 'milestone' }
+    ]
+  }
+]
+
+export const DEFAULT_ORGANIZATION_MODEL_ENTITIES: z.infer<typeof EntitiesDomainSchema> = Object.fromEntries(
+  ENTITY_ENTRY_INPUTS.map((entity) => {
+    const parsed = EntitySchema.parse(entity)
+    return [parsed.id, parsed]
+  })
+)
+
+/** Validate and return a single entity entry. */
+export function defineEntity(entry: z.input<typeof EntitySchema>): z.infer<typeof EntitySchema> {
+  return EntitySchema.parse(entry)
+}
+
+/** Validate and return an id-keyed map of entity entries. */
+export function defineEntities(
+  entries: readonly z.input<typeof EntitySchema>[]
+): Record<string, z.infer<typeof EntitySchema>> {
+  return defineDomainRecord(EntitySchema, entries)
+}
+
+export type EntityId = z.infer<typeof EntityIdSchema>
+export type EntityLinkKind = z.infer<typeof EntityLinkKindSchema>
+export type EntityLink = z.infer<typeof EntityLinkSchema>
+export type Entity = z.infer<typeof EntitySchema>
+export type EntitiesDomain = z.infer<typeof EntitiesDomainSchema>