business-as-code 2.1.3 → 2.3.0

package/src/canvas/index.ts

@@ -1,206 +0,0 @@
-/**
- * Business Model Canvas
- *
- * A complete implementation of the Business Model Canvas framework
- * with types, builder functions, unit economics, and financial projections.
- *
- * The Business Model Canvas has 9 building blocks:
- * 1. Customer Segments - Who are your customers?
- * 2. Value Propositions - What value do you deliver?
- * 3. Channels - How do you reach customers?
- * 4. Customer Relationships - How do you interact with customers?
- * 5. Revenue Streams - How do you make money?
- * 6. Key Resources - What do you need to operate?
- * 7. Key Activities - What do you do?
- * 8. Key Partnerships - Who helps you?
- * 9. Cost Structure - What are your costs?
- *
- * @example
- * ```ts
- * import {
- *   createCanvas,
- *   createCustomerSegment,
- *   createValueProposition,
- *   createRevenueStream,
- *   calculateUnitEconomics,
- *   generateCanvasSummary,
- * } from 'business-as-code/canvas'
- *
- * const canvas = createCanvas({
- *   name: 'My SaaS Business',
- *   customerSegments: [
- *     createCustomerSegment({ name: 'Enterprise', type: 'segmented', size: 10000 }),
- *   ],
- *   valuePropositions: [
- *     createValueProposition({ name: 'AI Automation', benefits: ['Speed', 'Accuracy'] }),
- *   ],
- *   // ... other building blocks
- * })
- *
- * const summary = generateCanvasSummary(canvas)
- * console.log(summary.projectedAnnualRevenue)
- * ```
- *
- * @packageDocumentation
- */
-
-// =============================================================================
-// Types
-// =============================================================================
-
-export type {
-  // Customer Segments
-  CustomerSegment,
-  CustomerSegmentType,
-
-  // Value Propositions
-  ValueProposition,
-  ValueType,
-
-  // Channels
-  Channel,
-  ChannelType,
-  ChannelPhase,
-
-  // Customer Relationships
-  CustomerRelationship,
-  RelationshipType,
-
-  // Revenue Streams
-  RevenueStream,
-  RevenueType,
-  PricingModel,
-  PricingTier,
-
-  // Key Resources
-  KeyResource,
-  ResourceType,
-
-  // Key Activities
-  KeyActivity,
-  ActivityCategory,
-
-  // Key Partnerships
-  KeyPartnership,
-  PartnershipType,
-
-  // Cost Structure
-  CostItem,
-  CostCategory,
-
-  // Canvas
-  BusinessModelCanvas,
-  CanvasValidation,
-  CanvasSummary,
-  CanvasStrengthAnalysis,
-  CanvasGaps,
-
-  // Unit Economics
-  UnitEconomics,
-  LTVInput,
-  CACInput,
-  UnitEconomicsInput,
-  Margins,
-  MarginsInput,
-
-  // Financial Projections
-  FinancialProjection,
-  RevenueProjection,
-  CostProjection,
-  ProfitabilityProjection,
-  MonthlyRevenue,
-  MonthlyCost,
-  MonthlyProfitability,
-  RevenueProjectionInput,
-  CostProjectionInput,
-  ProfitabilityProjectionInput,
-} from './types.js'
-
-// =============================================================================
-// Customer Segments
-// =============================================================================
-
-export { createCustomerSegment, type CreateCustomerSegmentInput } from './segments.js'
-
-// =============================================================================
-// Value Propositions
-// =============================================================================
-
-export { createValueProposition, type CreateValuePropositionInput } from './value.js'
-
-// =============================================================================
-// Channels
-// =============================================================================
-
-export { createChannel, type CreateChannelInput } from './channels.js'
-
-// =============================================================================
-// Customer Relationships
-// =============================================================================
-
-export { createCustomerRelationship, type CreateCustomerRelationshipInput } from './relationships.js'
-
-// =============================================================================
-// Revenue Streams
-// =============================================================================
-
-export { createRevenueStream, type CreateRevenueStreamInput } from './revenue.js'
-
-// =============================================================================
-// Key Resources
-// =============================================================================
-
-export { createKeyResource, type CreateKeyResourceInput } from './resources.js'
-
-// =============================================================================
-// Key Activities
-// =============================================================================
-
-export { createKeyActivity, type CreateKeyActivityInput } from './activities.js'
-
-// =============================================================================
-// Key Partnerships
-// =============================================================================
-
-export { createKeyPartnership, type CreateKeyPartnershipInput } from './partnerships.js'
-
-// =============================================================================
-// Cost Structure
-// =============================================================================
-
-export { createCostItem, type CreateCostItemInput } from './costs.js'
-
-// =============================================================================
-// Unit Economics
-// =============================================================================
-
-export {
-  calculateLTV,
-  calculateCAC,
-  calculateUnitEconomics,
-  calculateMargins,
-} from './economics.js'
-
-// =============================================================================
-// Financial Projections
-// =============================================================================
-
-export {
-  projectRevenue,
-  projectCosts,
-  projectProfitability,
-  createProjection,
-} from './projections.js'
-
-// =============================================================================
-// Canvas Operations
-// =============================================================================
-
-export {
-  createCanvas,
-  validateCanvas,
-  generateCanvasSummary,
-  analyzeCanvasStrength,
-  identifyCanvasGaps,
-  type CreateCanvasInput,
-} from './canvas.js'

package/src/canvas/partnerships.ts

@@ -1,34 +0,0 @@
-/**
- * Key Partnerships
- *
- * Functions for creating and working with key partnerships.
- */
-
-import type { KeyPartnership, PartnershipType } from './types.js'
-
-export interface CreateKeyPartnershipInput {
-  name: string
-  type: PartnershipType
-  purpose?: string
-  benefits?: string[]
-  contractValue?: number
-  contractTerm?: number
-  sharedActivities?: string[]
-}
-
-/**
- * Create a key partnership
- */
-export function createKeyPartnership(input: CreateKeyPartnershipInput): KeyPartnership {
-  const { name, type, purpose, benefits, contractValue, contractTerm, sharedActivities } = input
-
-  return {
-    name,
-    type,
-    purpose,
-    benefits,
-    contractValue,
-    contractTerm,
-    sharedActivities,
-  }
-}

package/src/canvas/projections.ts

@@ -1,141 +0,0 @@
-/**
- * Financial Projections
- *
- * Functions for projecting revenue, costs, and profitability.
- */
-
-import type {
-  RevenueProjection,
-  CostProjection,
-  ProfitabilityProjection,
-  MonthlyRevenue,
-  MonthlyCost,
-  MonthlyProfitability,
-  RevenueProjectionInput,
-  CostProjectionInput,
-  ProfitabilityProjectionInput,
-  FinancialProjection,
-} from './types.js'
-
-/**
- * Project revenue growth
- */
-export function projectRevenue(input: RevenueProjectionInput): RevenueProjection {
-  const { startingMRR, monthlyGrowthRate, months } = input
-
-  const monthlyData: MonthlyRevenue[] = []
-  let currentMRR = startingMRR
-
-  for (let i = 0; i < months; i++) {
-    if (i > 0) {
-      currentMRR = currentMRR * (1 + monthlyGrowthRate)
-    }
-
-    monthlyData.push({
-      month: i + 1,
-      mrr: currentMRR,
-      arr: currentMRR * 12,
-    })
-  }
-
-  const lastMonth = monthlyData[monthlyData.length - 1]
-
-  return {
-    months: monthlyData,
-    endingMRR: lastMonth?.mrr ?? 0,
-    endingARR: lastMonth?.arr ?? 0,
-  }
-}
-
-/**
- * Project costs
- *
- * Note: fixedCosts is the monthly fixed cost amount
- */
-export function projectCosts(input: CostProjectionInput): CostProjection {
-  const { fixedCosts, variableCostPerUser, startingUsers, monthlyUserGrowth, months } = input
-
-  const monthlyData: MonthlyCost[] = []
-  let currentUsers = startingUsers
-  let totalCosts = 0
-
-  for (let i = 0; i < months; i++) {
-    if (i > 0) {
-      currentUsers = currentUsers * (1 + monthlyUserGrowth)
-    }
-
-    const variableCosts = currentUsers * variableCostPerUser
-    const total = fixedCosts + variableCosts
-
-    totalCosts += total
-
-    monthlyData.push({
-      month: i + 1,
-      fixedCosts,
-      variableCosts,
-      totalCost: total,
-    })
-  }
-
-  return {
-    months: monthlyData,
-    totalCosts,
-  }
-}
-
-/**
- * Project profitability
- */
-export function projectProfitability(input: ProfitabilityProjectionInput): ProfitabilityProjection {
-  const { startingMRR, monthlyGrowthRate, fixedCosts, grossMargin, months } = input
-
-  const monthlyData: MonthlyProfitability[] = []
-  let currentMRR = startingMRR
-  let cumulativeProfit = 0
-  let breakEvenMonth: number | undefined
-
-  for (let i = 0; i < months; i++) {
-    if (i > 0) {
-      currentMRR = currentMRR * (1 + monthlyGrowthRate)
-    }
-
-    const revenue = currentMRR
-    const grossProfit = revenue * grossMargin
-    const monthlyFixedCosts = fixedCosts / 12
-    const profit = grossProfit - monthlyFixedCosts
-    cumulativeProfit += profit
-
-    if (breakEvenMonth === undefined && cumulativeProfit >= 0) {
-      breakEvenMonth = i + 1
-    }
-
-    monthlyData.push({
-      month: i + 1,
-      revenue,
-      costs: monthlyFixedCosts,
-      profit,
-      cumulativeProfit,
-    })
-  }
-
-  return {
-    months: monthlyData,
-    breakEvenMonth,
-    totalProfit: cumulativeProfit,
-  }
-}
-
-/**
- * Create a comprehensive financial projection
- */
-export function createProjection(
-  revenueInput: RevenueProjectionInput,
-  costInput: CostProjectionInput,
-  profitInput: ProfitabilityProjectionInput
-): FinancialProjection {
-  return {
-    revenue: projectRevenue(revenueInput),
-    costs: projectCosts(costInput),
-    profitability: projectProfitability(profitInput),
-  }
-}

package/src/canvas/relationships.ts

@@ -1,34 +0,0 @@
-/**
- * Customer Relationships
- *
- * Functions for creating and working with customer relationships.
- */
-
-import type { CustomerRelationship, RelationshipType } from './types.js'
-
-export interface CreateCustomerRelationshipInput {
-  name: string
-  type: RelationshipType
-  segment?: string
-  touchFrequency?: string
-  automationLevel?: number
-  supportChannels?: string[]
-  platforms?: string[]
-}
-
-/**
- * Create a customer relationship
- */
-export function createCustomerRelationship(input: CreateCustomerRelationshipInput): CustomerRelationship {
-  const { name, type, segment, touchFrequency, automationLevel, supportChannels, platforms } = input
-
-  return {
-    name,
-    type,
-    segment,
-    touchFrequency,
-    automationLevel,
-    supportChannels,
-    platforms,
-  }
-}

package/src/canvas/resources.ts

@@ -1,43 +0,0 @@
-/**
- * Key Resources
- *
- * Functions for creating and working with key resources.
- */
-
-import type { KeyResource, ResourceType } from './types.js'
-
-export interface CreateKeyResourceInput {
-  name: string
-  type: ResourceType
-  cost?: number
-  depreciation?: string
-  protectionType?: string
-  headcount?: number
-  averageCost?: number
-}
-
-/**
- * Create a key resource
- */
-export function createKeyResource(input: CreateKeyResourceInput): KeyResource {
-  const { name, type, cost, depreciation, protectionType, headcount, averageCost } = input
-
-  // Calculate total cost for human resources
-  let totalCost: number | undefined
-  if (headcount !== undefined && averageCost !== undefined) {
-    totalCost = headcount * averageCost
-  } else if (cost !== undefined) {
-    totalCost = cost
-  }
-
-  return {
-    name,
-    type,
-    cost,
-    depreciation,
-    protectionType,
-    headcount,
-    averageCost,
-    totalCost,
-  }
-}

package/src/canvas/revenue.ts

@@ -1,56 +0,0 @@
-/**
- * Revenue Streams
- *
- * Functions for creating and working with revenue streams.
- */
-
-import type { RevenueStream, RevenueType, PricingModel, PricingTier } from './types.js'
-
-export interface CreateRevenueStreamInput {
-  name: string
-  type: RevenueType
-  pricingModel: PricingModel
-  price?: number
-  billingCycle?: 'monthly' | 'quarterly' | 'annual'
-  pricePerUnit?: number
-  unitName?: string
-  tiers?: PricingTier[]
-  activeCustomers?: number
-}
-
-/**
- * Create a revenue stream
- */
-export function createRevenueStream(input: CreateRevenueStreamInput): RevenueStream {
-  const {
-    name,
-    type,
-    pricingModel,
-    price,
-    billingCycle,
-    pricePerUnit,
-    unitName,
-    tiers,
-    activeCustomers,
-  } = input
-
-  // Calculate annual revenue if we have the required fields
-  let annualRevenue: number | undefined
-  if (price !== undefined && activeCustomers !== undefined) {
-    const multiplier = billingCycle === 'annual' ? 1 : billingCycle === 'quarterly' ? 4 : 12
-    annualRevenue = price * multiplier * activeCustomers
-  }
-
-  return {
-    name,
-    type,
-    pricingModel,
-    price,
-    billingCycle,
-    pricePerUnit,
-    unitName,
-    tiers,
-    activeCustomers,
-    annualRevenue,
-  }
-}

package/src/canvas/segments.ts

@@ -1,42 +0,0 @@
-/**
- * Customer Segments
- *
- * Functions for creating and working with customer segments.
- */
-
-import type { CustomerSegment, CustomerSegmentType } from './types.js'
-
-export interface CreateCustomerSegmentInput {
-  name: string
-  description?: string
-  type: CustomerSegmentType
-  characteristics?: string[]
-  size?: number
-  revenuePerCustomer?: number
-  expectedPenetration?: number
-}
-
-/**
- * Create a customer segment
- */
-export function createCustomerSegment(input: CreateCustomerSegmentInput): CustomerSegment {
-  const { name, description, type, characteristics, size, revenuePerCustomer, expectedPenetration } = input
-
-  // Calculate potential if we have the required fields
-  let potential: number | undefined
-  if (size !== undefined && revenuePerCustomer !== undefined) {
-    const penetration = expectedPenetration ?? 1
-    potential = size * revenuePerCustomer * penetration
-  }
-
-  return {
-    name,
-    description,
-    type,
-    characteristics,
-    size,
-    revenuePerCustomer,
-    expectedPenetration,
-    potential,
-  }
-}