business-as-code/dist/index.d.ts

Primitives for expressing business logic and processes as code

/**
 * business-as-code - Primitives for expressing business logic and processes as code
 *
 * This package provides primitives for defining business entities, goals, products,
 * services, processes, workflows, KPIs, OKRs, and financial metrics.
 *
 * @example
 * ```ts
 * 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,
 * })
 *
 * // Define goals
 * const goals = Goals([
 *   {
 *     name: 'Launch MVP',
 *     category: 'strategic',
 *     status: 'in-progress',
 *     progress: 65,
 *   },
 * ])
 *
 * // Track KPIs
 * const kpiList = kpis([
 *   {
 *     name: 'Monthly Recurring Revenue',
 *     category: 'financial',
 *     target: 100000,
 *     current: 85000,
 *   },
 * ])
 *
 * // Define OKRs
 * const okrList = okrs([
 *   {
 *     objective: 'Achieve Product-Market Fit',
 *     keyResults: [
 *       {
 *         description: 'Increase NPS',
 *         metric: 'NPS',
 *         targetValue: 60,
 *         currentValue: 52,
 *       },
 *     ],
 *   },
 * ])
 *
 * // Calculate financials
 * const metrics = financials({
 *   revenue: 1000000,
 *   cogs: 300000,
 *   operatingExpenses: 500000,
 * })
 *
 * // Use $ helper for calculations
 * console.log($.format(1234.56)) // "$1,234.56"
 * console.log($.growth(120, 100)) // 20
 * console.log($.margin(100, 60)) // 40
 * ```
 *
 * @packageDocumentation
 */
export type { Currency, TimePeriod, BusinessDefinition, OrganizationalStructure, Department, Team, VisionDefinition, GoalDefinition, ProductDefinition, ServiceDefinition, RoadmapItem, ServiceLevelAgreement, ProcessDefinition, ProcessStep, ProcessMetric, WorkflowDefinition, WorkflowAction, WorkflowTrigger, KPIDefinition, OKRDefinition, KeyResult, FinancialMetrics, FinancialStatement, BusinessContext, BusinessOperations, } from './types.js';
export { Business, getTotalBudget, getTotalTeamSize, getDepartment, getTeam, validateBusiness, } from './business.js';
export { Vision, checkIndicator, calculateProgress, validateVision } from './vision.js';
export { Goals, Goal, updateProgress, markAtRisk, complete, isOverdue, getGoalsByCategory, getGoalsByStatus, getGoalsByOwner, calculateOverallProgress, hasCircularDependencies, sortByDependencies, validateGoals, toOrgGoal, fromOrgGoal, } from './goals.js';
export type { OrgGoal, OrgGoals, GoalStatus, GoalCategory, GoalPriority, GoalStatus as OrgGoalStatus, GoalCategory as OrgGoalCategory, GoalPriority as OrgGoalPriority, } from './goals.js';
export { Product, calculateGrossMargin, calculateGrossProfit, getRoadmapByStatus, getRoadmapByPriority, getOverdueRoadmapItems, updateRoadmapItem, addFeature, removeFeature, validateProduct, } from './product.js';
export { Service, calculateHourlyPrice, calculateMonthlyRetainer, checkSLAUptime, parseDeliveryTimeToDays, estimateCompletionDate, calculateValueBasedPrice, validateService, } from './service.js';
export { Process, getStepsInOrder, getStepsByAutomationLevel, calculateTotalDuration, formatDuration, calculateAutomationPercentage, getMetric, meetsTarget, calculateMetricAchievement, updateMetric, addStep, removeStep, validateProcess, } from './process.js';
export { Workflow, getActionsInOrder, getActionsByType, getConditionalActions, addAction, removeAction, updateAction, isEventTrigger, isScheduleTrigger, isWebhookTrigger, parseWaitDuration, evaluateCondition, fillTemplate, validateWorkflow, } from './workflow.js';
export { kpis, kpi, calculateAchievement, meetsTarget as kpiMeetsTarget, updateCurrent, updateTarget, getKPIsByCategory, getKPIsByFrequency, getKPIsOnTarget, getKPIsOffTarget, calculateHealthScore, groupByCategory, calculateVariance, calculateVariancePercentage, formatValue, comparePerformance, validateKPIs, toOrgKPI, fromOrgKPI, } from './kpis.js';
export type { OrgKPI, KPICategory, KPITrend, KPIFrequency, KPIHistoryEntry } from './kpis.js';
export { okrs, okr, calculateKeyResultProgress, calculateOKRProgress, calculateConfidence, updateKeyResult, isKeyResultOnTrack, isOKROnTrack, getKeyResultsOnTrack, getKeyResultsAtRisk, getOKRsByOwner, getOKRsByPeriod, getOKRsByStatus, calculateSuccessRate, formatKeyResult, compareOKRPerformance, validateOKRs, toOrgOKR, fromOrgOKR, toOrgKeyResult, fromOrgKeyResult, } from './okrs.js';
export type { OrgOKR, OrgKeyResult, OKRStatus, KeyResultStatus } from './okrs.js';
export { financials, calculateGrossMargin as calculateFinancialGrossMargin, calculateOperatingMargin, calculateNetMargin, calculateEBITDAMargin, calculateBurnRate, calculateRunway, calculateCAC, calculateLTV, calculateLTVtoCAC, calculatePaybackPeriod, calculateARR, calculateMRR, calculateGrowthRate, calculateCAGR, calculateROI, calculateROE, calculateROA, calculateQuickRatio, calculateCurrentRatio, calculateDebtToEquity, formatCurrency, createStatement, getLineItem, compareMetrics, validateFinancials, } from './financials.js';
export { $, createBusinessOperations, updateContext, getContext, resetContext } from './dollar.js';
export type { DateRange, MetricPeriod, DataPoint, TimeSeries, MRR, ARR, NRR, GRR, ARPU, RevenueSegment, CAC, LTV, LTVtoCAC, Churn, RetentionCohort, GrowthRate, QuickRatio, MagicNumber, BurnMultiple, RuleOf40, EfficiencyScore, Pipeline, PipelineStage, SalesVelocity, NPS, CustomerHealth, HealthFactor, SaaSMetrics, } from './metrics.js';
export { calculateMRR as calculateMRRMetric, calculateARRFromMRR as calculateARRMetric, calculateNRR as calculateNRRMetric, calculateGRR as calculateGRRMetric, calculateCACMetric, calculateLTVMetric, calculateLTVtoCACRatio, calculateQuickRatioMetric, calculateMagicNumberMetric, calculateBurnMultipleMetric, calculateRuleOf40Metric, calculateGrowthRates, calculateChurnMetrics, aggregateTimeSeries, createMetricPeriod, } from './metrics.js';
export type { Granularity, AggregateFunction, Operator, SortDirection, Dimension, Measure, CalculatedMeasure, Filter, Sort, TimeRange, Query, ResolvedQuery, View, Dashboard, DashboardLayout, DashboardItem, Visualization, QueryRow, QueryResult, QueryExecutor, StreamingQueryResult, StreamingQueryExecutor, } from './queries.js';
export { StandardDimensions, StandardMeasures, CalculatedMetrics, query, QueryBuilder, view, ViewBuilder, dashboard, DashboardBuilder, MrrOverview, ArrBySegment, CohortRetention, UnitEconomics, RevenueByChannel, GrowthMetrics, ExecutiveDashboard, } from './queries.js';
export type { BusinessRoleType, BusinessRole, TaskStatus, TaskPriority, TaskAssignment, AssigneeRef, TaskRoutingRule, WorkflowRole, OrgRole, OrgRoleType, RoleWorkerType, } from './roles.js';
export type { Worker, WorkerRef } from './roles.js';
export { StandardBusinessRoles, createBusinessRole, hasPermission, canHandleTask, canApproveRequest, canDelegateTask, findRoleForTask, createTaskAssignment, transitionTaskStatus, workerRefToAssignee, assigneeToWorkerRef, } from './roles.js';
export type { Organization, OrganizationSettings, Address, Department as OrgDepartment, Team as OrgTeam, TeamResources, TeamChannels, Position, PositionRef, Compensation, Budget, ResourceHierarchy, ResourceHierarchyNode, ApprovalChain, ApprovalLevel, ApproverSpec, EscalationRule, ResolvedPermissions, } from './organization.js';
export { resolvePermissions, getApprovalChainForRequest, findManager } from './organization.js';
export { Business as BusinessEntity, Vision as VisionEntity, Value as ValueEntity, BusinessEntities, BusinessCategories, Organization as OrganizationEntity, Department as DepartmentEntity, Team as TeamEntity, Position as PositionEntity, Role as RoleEntity, Worker as WorkerEntity, OrganizationEntities, OrganizationCategories, Goal as GoalEntity, OKR as OKREntity, KeyResult as KeyResultEntity, KPI as KPIEntity, Metric as MetricEntity, Initiative as InitiativeEntity, GoalEntities, GoalCategories, Product as ProductEntity, Service as ServiceEntity, Feature as FeatureEntity, PricingPlan as PricingPlanEntity, RoadmapItem as RoadmapItemEntity, OfferingEntities, OfferingCategories, Process as ProcessEntity, ProcessStep as ProcessStepEntity, Workflow as WorkflowEntity, WorkflowAction as WorkflowActionEntity, WorkflowRun as WorkflowRunEntity, Policy as PolicyEntity, OperationsEntities, OperationsCategories, Budget as BudgetEntity, Revenue as RevenueEntity, Expense as ExpenseEntity, Investment as InvestmentEntity, FinancialPeriod as FinancialPeriodEntity, Forecast as ForecastEntity, FinancialEntities, FinancialCategories, AllBusinessEntities, BusinessEntityCategories, Entities, type BusinessEntityCategory, } from './entities/index.js';
//# sourceMappingURL=index.d.ts.map