business-as-code

Primitives for expressing business logic, strategy, and operations as code. Define your entire business model—from vision and goals to products, services, processes, KPIs, OKRs, and financials—in a declarative, type-safe way.

Installation

``bash npm install business-as-code`

`Quick Start`

`typescript import { Business, Product, Goals, kpis, okrs, financials, $ } from 'business-as-code'

// Define your business const company = Business({ name: 'Acme Corp', mission: 'To make widgets accessible to everyone', values: ['Innovation', 'Customer Focus', 'Integrity'], })

Calculate financial metrics and statements:

`typescript const metrics = financials({ revenue: 1000000, cogs: 300000, operatingExpenses: 500000, currency: 'USD', period: 'monthly', })

// Automatically calculates: // - grossProfit: 700000 // - grossMargin: 70% // - operatingIncome: 200000 // - operatingMargin: 20% // - netIncome: 200000 // - netMargin: 20%

// Helper functions import { calculateGrossMargin, calculateOperatingMargin, calculateNetMargin, calculateEBITDAMargin, calculateBurnRate, calculateRunway, calculateCAC, calculateLTV, calculateLTVtoCAC, calculatePaybackPeriod, calculateARR, calculateMRR, calculateGrowthRate, calculateCAGR, calculateROI, calculateROE, calculateROA, calculateQuickRatio, calculateCurrentRatio, calculateDebtToEquity, formatCurrency, createStatement, compareMetrics, } from 'business-as-code'

// SaaS metrics const mrr = calculateMRR(subscriptions) const arr = calculateARR(mrr) const ltv = calculateLTV(avgRevenue, churnRate) const cac = calculateCAC(marketingSpend, newCustomers) const ltvCacRatio = calculateLTVtoCAC(ltv, cac)

// Startup metrics const burnRate = calculateBurnRate(cashStart, cashEnd, months) const runway = calculateRunway(cash, burnRate) const growth = calculateGrowthRate(current, previous)`

`$3`

Convenient helper for common business calculations:

`typescript import { $ } from 'business-as-code'

// Currency formatting $.format(1234.56) // "$1,234.56" $.format(1234.56, 'EUR') // "€1,234.56"

// Percentages $.percent(25, 100) // 25

// Growth $.growth(120, 100) // 20 (20% growth)

// Margins $.margin(100, 60) // 40 (40% margin)

// ROI $.roi(150, 100) // 50 (50% ROI)

// Customer metrics $.ltv(100, 12, 24) // Lifetime value $.cac(10000, 100) // Customer acquisition cost (100)

// Startup metrics $.burnRate(100000, 70000, 3) // Monthly burn rate (10000) $.runway(100000, 10000) // Runway in months (10)

// Context management $.context // Access business context $.log('event', data) // Log business event`

`$3`

Share business context across your application:

`typescript import { updateContext, getContext, resetContext } from 'business-as-code'

// Set context updateContext({ business: company, goals: goals, kpis: kpiList, financials: metrics, })

// Access context const ctx = getContext() console.log(ctx.business?.name)

// Reset context resetContext()`

`API Reference`

`$3`

| Function | Description | |----------|-------------| |Business(def)| Create a business entity | |Vision(def)| Define business vision | |Goals(defs)| Create goal list | |Goal(def)| Create single goal | |Product(def)| Define a product | |Service(def)| Define a service | |Process(def)| Define a business process | |Workflow(def)| Define an automated workflow | |kpis(defs)| Create KPI list | |kpi(def)| Create single KPI | |okrs(defs)| Create OKR list | |okr(def)| Create single OKR | |financials(data) | Calculate financial metrics |

`$3`

| Method | Description | |--------|-------------| |$.format(amount, currency?)| Format as currency | |$.percent(value, total)| Calculate percentage | |$.growth(current, previous)| Calculate growth rate | |$.margin(revenue, cost)| Calculate margin | |$.roi(gain, cost)| Calculate ROI | |$.ltv(value, frequency, lifetime)| Customer lifetime value | |$.cac(spend, customers)| Customer acquisition cost | |$.burnRate(start, end, months)| Monthly burn rate | |$.runway(cash, burnRate)| Runway in months | |$.context| Access business context | |$.log(event, data?) | Log business event |

`$3`

// All entities by category AllBusinessEntities, BusinessEntityCategories,

// Flat entity access Entities, } from 'business-as-code'

// Access entity definitions console.log(Business.properties) // Property definitions console.log(Business.actions) // Available actions console.log(Business.events) // Possible events

// All 16 entity categories console.log(AllBusinessEntities.business) // Business, Vision, Value console.log(AllBusinessEntities.organization) // Organization, Department, Team, Position, Role, Worker console.log(AllBusinessEntities.goals) // Goal, OKR, KeyResult, KPI, Metric, Initiative console.log(AllBusinessEntities.offerings) // Product, Service, Feature, PricingPlan, RoadmapItem console.log(AllBusinessEntities.operations) // Process, ProcessStep, Workflow, WorkflowAction, WorkflowRun, Policy console.log(AllBusinessEntities.financials) // Budget, Revenue, Expense, Investment, FinancialPeriod, Forecast console.log(AllBusinessEntities.customers) // Customer, Account, Contact, Segment, Persona, Interaction console.log(AllBusinessEntities.sales) // Deal, Pipeline, Stage, Contract, Subscription, Quote, Order, Invoice console.log(AllBusinessEntities.marketing) // Campaign, Lead, Audience, Content, Funnel, FunnelStage, MarketingEvent console.log(AllBusinessEntities.partnerships) // Partner, Vendor, Affiliate, Partnership, Integration, Reseller console.log(AllBusinessEntities.legal) // Agreement, License, IntellectualProperty, Compliance, LegalPolicy, Trademark console.log(AllBusinessEntities.risk) // Risk, Mitigation, Incident, Control, Assessment, Issue console.log(AllBusinessEntities.projects) // Project, Task, Milestone, Sprint, Deliverable, Epic, Story, Resource console.log(AllBusinessEntities.communication) // Meeting, Decision, ActionItem, Announcement, Feedback, Discussion console.log(AllBusinessEntities.assets) // Asset, Inventory, Equipment, Facility, Software, DataAsset console.log(AllBusinessEntities.market) // Market, Competitor, Trend, Opportunity, SWOT, Industry``

---

Use Cases

``bash npm install business-as-code`

`Quick Start`

`typescript import { Business, Product, Goals, kpis, okrs, financials, $ } from 'business-as-code'

// Define your business const company = Business({ name: 'Acme Corp', mission: 'To make widgets accessible to everyone', values: ['Innovation', 'Customer Focus', 'Integrity'], })

// Define products const product = Product({ name: 'Widget Pro', pricingModel: 'subscription', price: 99, cogs: 20, })

Track strategic and operational objectives with dependencies:

`$3`

Define product offerings with pricing and roadmap:

// Helper functions import { calculateGrossMargin, calculateGrossProfit, getRoadmapByStatus, getRoadmapByPriority, getOverdueRoadmapItems, addFeature, removeFeature, } from 'business-as-code'

const margin = calculateGrossMargin(product) // 79.8% const profit = calculateGrossProfit(product) // 79 const highPriority = getRoadmapByPriority(product.roadmap!, 'high')`

`$3`

Define professional services with SLAs:

// Currency formatting $.format(1234.56) // "$1,234.56" $.format(1234.56, 'EUR') // "€1,234.56"

// Percentages $.percent(25, 100) // 25

// Growth $.growth(120, 100) // 20 (20% growth)

// Margins $.margin(100, 60) // 40 (40% margin)

// ROI $.roi(150, 100) // 50 (50% ROI)

// Customer metrics $.ltv(100, 12, 24) // Lifetime value $.cac(10000, 100) // Customer acquisition cost (100)

// Startup metrics $.burnRate(100000, 70000, 3) // Monthly burn rate (10000) $.runway(100000, 10000) // Runway in months (10)

// Context management $.context // Access business context $.log('event', data) // Log business event`

`$3`

Share business context across your application:

`typescript import { updateContext, getContext, resetContext } from 'business-as-code'

// Set context updateContext({ business: company, goals: goals, kpis: kpiList, financials: metrics, })

// Access context const ctx = getContext() console.log(ctx.business?.name)

// Reset context resetContext()`

`API Reference`

Use Cases

License

MIT