business-as-code 2.3.0 → 2.4.0

package/dist/financials.js

@@ -0,0 +1,297 @@
+/**
+ * Financial metrics and calculations
+ */
+/**
+ * Calculate financial metrics from basic inputs
+ *
+ * @example
+ * ```ts
+ * const metrics = financials({
+ *   revenue: 1000000,
+ *   cogs: 300000,
+ *   operatingExpenses: 500000,
+ *   currency: 'USD',
+ *   period: 'monthly',
+ * })
+ *
+ * console.log(metrics.grossMargin) // 70%
+ * console.log(metrics.operatingMargin) // 20%
+ * console.log(metrics.netMargin) // 20%
+ * ```
+ */
+export function financials(metrics) {
+    const revenue = metrics.revenue || 0;
+    const cogs = metrics.cogs || 0;
+    const operatingExpenses = metrics.operatingExpenses || 0;
+    // Calculate derived metrics
+    const grossProfit = revenue - cogs;
+    const grossMargin = revenue > 0 ? (grossProfit / revenue) * 100 : 0;
+    const operatingIncome = grossProfit - operatingExpenses;
+    const operatingMargin = revenue > 0 ? (operatingIncome / revenue) * 100 : 0;
+    const netIncome = metrics.netIncome ?? operatingIncome;
+    const netMargin = revenue > 0 ? (netIncome / revenue) * 100 : 0;
+    // EBITDA (simplified - would need D&A for accurate calculation)
+    const ebitda = metrics.ebitda ?? operatingIncome;
+    const ebitdaMargin = revenue > 0 ? (ebitda / revenue) * 100 : 0;
+    return {
+        ...metrics,
+        revenue,
+        cogs,
+        grossProfit,
+        grossMargin,
+        operatingExpenses,
+        operatingIncome,
+        operatingMargin,
+        netIncome,
+        netMargin,
+        ebitda,
+        ebitdaMargin,
+        currency: metrics.currency || 'USD',
+        period: metrics.period || 'monthly',
+    };
+}
+/**
+ * Calculate gross margin
+ */
+export function calculateGrossMargin(revenue, cogs) {
+    if (revenue === 0)
+        return 0;
+    return ((revenue - cogs) / revenue) * 100;
+}
+/**
+ * Calculate operating margin
+ */
+export function calculateOperatingMargin(revenue, cogs, operatingExpenses) {
+    if (revenue === 0)
+        return 0;
+    const operatingIncome = revenue - cogs - operatingExpenses;
+    return (operatingIncome / revenue) * 100;
+}
+/**
+ * Calculate net margin
+ */
+export function calculateNetMargin(revenue, netIncome) {
+    if (revenue === 0)
+        return 0;
+    return (netIncome / revenue) * 100;
+}
+/**
+ * Calculate EBITDA margin
+ */
+export function calculateEBITDAMargin(revenue, ebitda) {
+    if (revenue === 0)
+        return 0;
+    return (ebitda / revenue) * 100;
+}
+/**
+ * Calculate burn rate (monthly cash burn)
+ */
+export function calculateBurnRate(cashStart, cashEnd, months) {
+    if (months === 0)
+        return 0;
+    return (cashStart - cashEnd) / months;
+}
+/**
+ * Calculate runway (months until cash runs out)
+ */
+export function calculateRunway(cash, monthlyBurnRate) {
+    if (monthlyBurnRate === 0)
+        return Infinity;
+    if (monthlyBurnRate < 0)
+        return Infinity; // Company is profitable
+    return cash / monthlyBurnRate;
+}
+/**
+ * Calculate customer acquisition cost (CAC)
+ */
+export function calculateCAC(marketingSpend, newCustomers) {
+    if (newCustomers === 0)
+        return 0;
+    return marketingSpend / newCustomers;
+}
+/**
+ * Calculate customer lifetime value (LTV)
+ */
+export function calculateLTV(averageRevenuePerCustomer, averageCustomerLifetimeMonths, grossMarginPercent) {
+    return averageRevenuePerCustomer * averageCustomerLifetimeMonths * (grossMarginPercent / 100);
+}
+/**
+ * Calculate LTV:CAC ratio
+ */
+export function calculateLTVtoCAC(ltv, cac) {
+    if (cac === 0)
+        return 0;
+    return ltv / cac;
+}
+/**
+ * Calculate payback period (months to recover CAC)
+ */
+export function calculatePaybackPeriod(cac, monthlyRevPerCustomer) {
+    if (monthlyRevPerCustomer === 0)
+        return 0;
+    return cac / monthlyRevPerCustomer;
+}
+/**
+ * Calculate annual recurring revenue (ARR)
+ */
+export function calculateARR(mrr) {
+    return mrr * 12;
+}
+/**
+ * Calculate monthly recurring revenue (MRR)
+ */
+export function calculateMRR(arr) {
+    return arr / 12;
+}
+/**
+ * Calculate revenue growth rate
+ */
+export function calculateGrowthRate(currentRevenue, previousRevenue) {
+    if (previousRevenue === 0)
+        return 0;
+    return ((currentRevenue - previousRevenue) / previousRevenue) * 100;
+}
+/**
+ * Calculate compound annual growth rate (CAGR)
+ */
+export function calculateCAGR(beginningValue, endingValue, years) {
+    if (beginningValue === 0 || years === 0)
+        return 0;
+    return (Math.pow(endingValue / beginningValue, 1 / years) - 1) * 100;
+}
+/**
+ * Calculate return on investment (ROI)
+ */
+export function calculateROI(gain, cost) {
+    if (cost === 0)
+        return 0;
+    return ((gain - cost) / cost) * 100;
+}
+/**
+ * Calculate return on equity (ROE)
+ */
+export function calculateROE(netIncome, shareholderEquity) {
+    if (shareholderEquity === 0)
+        return 0;
+    return (netIncome / shareholderEquity) * 100;
+}
+/**
+ * Calculate return on assets (ROA)
+ */
+export function calculateROA(netIncome, totalAssets) {
+    if (totalAssets === 0)
+        return 0;
+    return (netIncome / totalAssets) * 100;
+}
+/**
+ * Calculate quick ratio (liquidity)
+ */
+export function calculateQuickRatio(currentAssets, inventory, currentLiabilities) {
+    if (currentLiabilities === 0)
+        return 0;
+    return (currentAssets - inventory) / currentLiabilities;
+}
+/**
+ * Calculate current ratio (liquidity)
+ */
+export function calculateCurrentRatio(currentAssets, currentLiabilities) {
+    if (currentLiabilities === 0)
+        return 0;
+    return currentAssets / currentLiabilities;
+}
+/**
+ * Calculate debt-to-equity ratio
+ */
+export function calculateDebtToEquity(totalDebt, totalEquity) {
+    if (totalEquity === 0)
+        return 0;
+    return totalDebt / totalEquity;
+}
+/**
+ * Format currency value
+ */
+export function formatCurrency(amount, currency = 'USD') {
+    const symbol = getCurrencySymbol(currency);
+    const formatted = Math.abs(amount).toLocaleString(undefined, {
+        minimumFractionDigits: 0,
+        maximumFractionDigits: 2,
+    });
+    const sign = amount < 0 ? '-' : '';
+    return `${sign}${symbol}${formatted}`;
+}
+/**
+ * Get currency symbol
+ */
+function getCurrencySymbol(currency) {
+    const symbols = {
+        USD: '$',
+        EUR: '€',
+        GBP: '£',
+        JPY: '¥',
+        CNY: '¥',
+        CAD: 'C$',
+        AUD: 'A$',
+    };
+    return symbols[currency] || currency + ' ';
+}
+/**
+ * Create a financial statement
+ */
+export function createStatement(type, period, lineItems, currency = 'USD') {
+    return {
+        type,
+        period,
+        lineItems,
+        currency,
+    };
+}
+/**
+ * Get line item from financial statement
+ */
+export function getLineItem(statement, name) {
+    return statement.lineItems[name] || 0;
+}
+/**
+ * Compare financial metrics between periods
+ */
+export function compareMetrics(current, previous) {
+    const comparison = {};
+    const keys = [
+        'revenue',
+        'grossProfit',
+        'operatingIncome',
+        'netIncome',
+        'ebitda',
+    ];
+    for (const key of keys) {
+        const currentVal = current[key] || 0;
+        const previousVal = previous[key] || 0;
+        const change = currentVal - previousVal;
+        const changePercent = previousVal !== 0 ? (change / previousVal) * 100 : 0;
+        comparison[key] = { change, changePercent };
+    }
+    return comparison;
+}
+/**
+ * Validate financial metrics
+ */
+export function validateFinancials(metrics) {
+    const errors = [];
+    if (metrics.revenue && metrics.revenue < 0) {
+        errors.push('Revenue cannot be negative');
+    }
+    if (metrics.cogs && metrics.cogs < 0) {
+        errors.push('COGS cannot be negative');
+    }
+    if (metrics.operatingExpenses && metrics.operatingExpenses < 0) {
+        errors.push('Operating expenses cannot be negative');
+    }
+    if (metrics.revenue && metrics.cogs && metrics.cogs > metrics.revenue) {
+        errors.push('COGS cannot exceed revenue');
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+    };
+}
+//# sourceMappingURL=financials.js.map

package/dist/financials.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"financials.js","sourceRoot":"","sources":["../src/financials.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,UAAU,CAAC,OAAkC;IAC3D,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,CAAC,CAAA;IACpC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,CAAC,CAAA;IAC9B,MAAM,iBAAiB,GAAG,OAAO,CAAC,iBAAiB,IAAI,CAAC,CAAA;IAExD,4BAA4B;IAC5B,MAAM,WAAW,GAAG,OAAO,GAAG,IAAI,CAAA;IAClC,MAAM,WAAW,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAEnE,MAAM,eAAe,GAAG,WAAW,GAAG,iBAAiB,CAAA;IACvD,MAAM,eAAe,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3E,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,eAAe,CAAA;IACtD,MAAM,SAAS,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAE/D,gEAAgE;IAChE,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,eAAe,CAAA;IAChD,MAAM,YAAY,GAAG,OAAO,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAE/D,OAAO;QACL,GAAG,OAAO;QACV,OAAO;QACP,IAAI;QACJ,WAAW;QACX,WAAW;QACX,iBAAiB;QACjB,eAAe;QACf,eAAe;QACf,SAAS;QACT,SAAS;QACT,MAAM;QACN,YAAY;QACZ,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,KAAK;QACnC,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,SAAS;KACpC,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,OAAe,EAAE,IAAY;IAChE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC3B,OAAO,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,OAAO,CAAC,GAAG,GAAG,CAAA;AAC3C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,OAAe,EACf,IAAY,EACZ,iBAAyB;IAEzB,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC3B,MAAM,eAAe,GAAG,OAAO,GAAG,IAAI,GAAG,iBAAiB,CAAA;IAC1D,OAAO,CAAC,eAAe,GAAG,OAAO,CAAC,GAAG,GAAG,CAAA;AAC1C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,OAAe,EAAE,SAAiB;IACnE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC3B,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,GAAG,CAAA;AACpC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,OAAe,EAAE,MAAc;IACnE,IAAI,OAAO,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC3B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,GAAG,GAAG,CAAA;AACjC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,SAAiB,EACjB,OAAe,EACf,MAAc;IAEd,IAAI,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC1B,OAAO,CAAC,SAAS,GAAG,OAAO,CAAC,GAAG,MAAM,CAAA;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAY,EAAE,eAAuB;IACnE,IAAI,eAAe,KAAK,CAAC;QAAE,OAAO,QAAQ,CAAA;IAC1C,IAAI,eAAe,GAAG,CAAC;QAAE,OAAO,QAAQ,CAAA,CAAC,wBAAwB;IACjE,OAAO,IAAI,GAAG,eAAe,CAAA;AAC/B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,cAAsB,EAAE,YAAoB;IACvE,IAAI,YAAY,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAChC,OAAO,cAAc,GAAG,YAAY,CAAA;AACtC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAC1B,yBAAiC,EACjC,6BAAqC,EACrC,kBAA0B;IAE1B,OAAO,yBAAyB,GAAG,6BAA6B,GAAG,CAAC,kBAAkB,GAAG,GAAG,CAAC,CAAA;AAC/F,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAAC,GAAW,EAAE,GAAW;IACxD,IAAI,GAAG,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACvB,OAAO,GAAG,GAAG,GAAG,CAAA;AAClB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,sBAAsB,CAAC,GAAW,EAAE,qBAA6B;IAC/E,IAAI,qBAAqB,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACzC,OAAO,GAAG,GAAG,qBAAqB,CAAA;AACpC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,GAAG,EAAE,CAAA;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,OAAO,GAAG,GAAG,EAAE,CAAA;AACjB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,cAAsB,EAAE,eAAuB;IACjF,IAAI,eAAe,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACnC,OAAO,CAAC,CAAC,cAAc,GAAG,eAAe,CAAC,GAAG,eAAe,CAAC,GAAG,GAAG,CAAA;AACrE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,aAAa,CAC3B,cAAsB,EACtB,WAAmB,EACnB,KAAa;IAEb,IAAI,cAAc,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACjD,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,WAAW,GAAG,cAAc,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAA;AACtE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAY,EAAE,IAAY;IACrD,IAAI,IAAI,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACxB,OAAO,CAAC,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,GAAG,CAAA;AACrC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB,EAAE,iBAAyB;IACvE,IAAI,iBAAiB,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACrC,OAAO,CAAC,SAAS,GAAG,iBAAiB,CAAC,GAAG,GAAG,CAAA;AAC9C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,SAAiB,EAAE,WAAmB;IACjE,IAAI,WAAW,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,CAAC,SAAS,GAAG,WAAW,CAAC,GAAG,GAAG,CAAA;AACxC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CACjC,aAAqB,EACrB,SAAiB,EACjB,kBAA0B;IAE1B,IAAI,kBAAkB,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACtC,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC,GAAG,kBAAkB,CAAA;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,aAAqB,EAAE,kBAA0B;IACrF,IAAI,kBAAkB,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IACtC,OAAO,aAAa,GAAG,kBAAkB,CAAA;AAC3C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,SAAiB,EAAE,WAAmB;IAC1E,IAAI,WAAW,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAC/B,OAAO,SAAS,GAAG,WAAW,CAAA;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,WAAqB,KAAK;IACvE,MAAM,MAAM,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAA;IAC1C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,SAAS,EAAE;QAC3D,qBAAqB,EAAE,CAAC;QACxB,qBAAqB,EAAE,CAAC;KACzB,CAAC,CAAA;IAEF,MAAM,IAAI,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAA;IAClC,OAAO,GAAG,IAAI,GAAG,MAAM,GAAG,SAAS,EAAE,CAAA;AACvC,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,QAAkB;IAC3C,MAAM,OAAO,GAA2B;QACtC,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,GAAG;QACR,GAAG,EAAE,IAAI;QACT,GAAG,EAAE,IAAI;KACV,CAAA;IACD,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,QAAQ,GAAG,GAAG,CAAA;AAC5C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAgC,EAChC,MAAc,EACd,SAAiC,EACjC,WAAqB,KAAK;IAE1B,OAAO;QACL,IAAI;QACJ,MAAM;QACN,SAAS;QACT,QAAQ;KACT,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,WAAW,CAAC,SAA6B,EAAE,IAAY;IACrE,OAAO,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAC5B,OAAyB,EACzB,QAA0B;IAE1B,MAAM,UAAU,GAA8D,EAAE,CAAA;IAEhF,MAAM,IAAI,GAA+B;QACvC,SAAS;QACT,aAAa;QACb,iBAAiB;QACjB,WAAW;QACX,QAAQ;KACT,CAAA;IAED,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,MAAM,UAAU,GAAI,OAAO,CAAC,GAAG,CAAY,IAAI,CAAC,CAAA;QAChD,MAAM,WAAW,GAAI,QAAQ,CAAC,GAAG,CAAY,IAAI,CAAC,CAAA;QAClD,MAAM,MAAM,GAAG,UAAU,GAAG,WAAW,CAAA;QACvC,MAAM,aAAa,GAAG,WAAW,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,WAAW,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;QAE1E,UAAU,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,aAAa,EAAE,CAAA;IAC7C,CAAC;IAED,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAChC,OAAyB;IAEzB,MAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,GAAG,CAAC,EAAE,CAAC;QAC3C,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;IAC3C,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QACrC,MAAM,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAA;IACxC,CAAC;IAED,IAAI,OAAO,CAAC,iBAAiB,IAAI,OAAO,CAAC,iBAAiB,GAAG,CAAC,EAAE,CAAC;QAC/D,MAAM,CAAC,IAAI,CAAC,uCAAuC,CAAC,CAAA;IACtD,CAAC;IAED,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC;QACtE,MAAM,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAAA;IAC3C,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;KACP,CAAA;AACH,CAAC"}

package/dist/goals.d.ts

@@ -0,0 +1,106 @@
+/**
+ * Business goals definition and tracking
+ *
+ * Uses org.ai Goal types for standardized goal definitions across the ecosystem.
+ */
+import type { GoalDefinition } from './types.js';
+import type { Goal as OrgGoal, Goals as OrgGoals, GoalStatus, GoalCategory, GoalPriority } from 'org.ai';
+export type { OrgGoal, OrgGoals, GoalStatus, GoalCategory, GoalPriority };
+/**
+ * Convert a business-as-code GoalDefinition to an org.ai Goal
+ *
+ * @param definition - Business goal definition
+ * @param id - Unique identifier for the goal
+ * @returns org.ai Goal object
+ */
+export declare function toOrgGoal(definition: GoalDefinition, id: string): OrgGoal;
+/**
+ * Convert an org.ai Goal to a business-as-code GoalDefinition
+ *
+ * @param goal - org.ai Goal object
+ * @returns Business goal definition
+ */
+export declare function fromOrgGoal(goal: OrgGoal): GoalDefinition;
+/**
+ * Define a business goal with metrics and tracking
+ *
+ * @example
+ * ```ts
+ * const goals = Goals([
+ *   {
+ *     name: 'Launch MVP',
+ *     description: 'Ship minimum viable product to early customers',
+ *     category: 'strategic',
+ *     targetDate: new Date('2024-06-30'),
+ *     owner: 'Product Team',
+ *     metrics: ['User signups', 'Feature completion rate'],
+ *     status: 'in-progress',
+ *     progress: 65,
+ *   },
+ *   {
+ *     name: 'Achieve Product-Market Fit',
+ *     description: 'Validate product value with target customers',
+ *     category: 'strategic',
+ *     targetDate: new Date('2024-12-31'),
+ *     owner: 'CEO',
+ *     metrics: ['NPS > 50', 'Churn < 5%', '100+ paying customers'],
+ *     status: 'in-progress',
+ *     progress: 30,
+ *     dependencies: ['Launch MVP'],
+ *   },
+ * ])
+ * ```
+ */
+export declare function Goals(definitions: GoalDefinition[]): GoalDefinition[];
+/**
+ * Define a single goal
+ */
+export declare function Goal(definition: GoalDefinition): GoalDefinition;
+/**
+ * Update goal progress
+ */
+export declare function updateProgress(goal: GoalDefinition, progress: number): GoalDefinition;
+/**
+ * Mark goal as at-risk
+ */
+export declare function markAtRisk(goal: GoalDefinition): GoalDefinition;
+/**
+ * Mark goal as completed
+ */
+export declare function complete(goal: GoalDefinition): GoalDefinition;
+/**
+ * Check if goal is overdue
+ */
+export declare function isOverdue(goal: GoalDefinition): boolean;
+/**
+ * Get goals by category
+ */
+export declare function getGoalsByCategory(goals: GoalDefinition[], category: GoalDefinition['category']): GoalDefinition[];
+/**
+ * Get goals by status
+ */
+export declare function getGoalsByStatus(goals: GoalDefinition[], status: GoalDefinition['status']): GoalDefinition[];
+/**
+ * Get goals by owner
+ */
+export declare function getGoalsByOwner(goals: GoalDefinition[], owner: string): GoalDefinition[];
+/**
+ * Calculate overall progress across all goals
+ */
+export declare function calculateOverallProgress(goals: GoalDefinition[]): number;
+/**
+ * Check for circular dependencies
+ */
+export declare function hasCircularDependencies(goals: GoalDefinition[]): boolean;
+/**
+ * Get goals in dependency order
+ */
+export declare function sortByDependencies(goals: GoalDefinition[]): GoalDefinition[];
+/**
+ * Validate goals
+ */
+export declare function validateGoals(goals: GoalDefinition[]): {
+    valid: boolean;
+    errors: string[];
+};
+//# sourceMappingURL=goals.d.ts.map

package/dist/goals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"goals.d.ts","sourceRoot":"","sources":["../src/goals.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,KAAK,EACV,IAAI,IAAI,OAAO,EACf,KAAK,IAAI,QAAQ,EACjB,UAAU,EACV,YAAY,EACZ,YAAY,EACb,MAAM,QAAQ,CAAA;AAGf,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAEzE;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,UAAU,EAAE,cAAc,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAmBzE;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAC,IAAI,EAAE,OAAO,GAAG,cAAc,CAiBzD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,wBAAgB,KAAK,CAAC,WAAW,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE,CAErE;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,UAAU,EAAE,cAAc,GAAG,cAAc,CAE/D;AAqBD;;GAEG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,GAAG,cAAc,CAqBrF;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,cAAc,GAAG,cAAc,CAK/D;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,IAAI,EAAE,cAAc,GAAG,cAAc,CAM7D;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAGvD;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,cAAc,EAAE,EACvB,QAAQ,EAAE,cAAc,CAAC,UAAU,CAAC,GACnC,cAAc,EAAE,CAElB;AAED;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,cAAc,EAAE,EACvB,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,GAC/B,cAAc,EAAE,CAElB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,cAAc,EAAE,EAAE,KAAK,EAAE,MAAM,GAAG,cAAc,EAAE,CAExF;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,MAAM,CAKxE;AAED;;GAEG;AACH,wBAAgB,uBAAuB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,OAAO,CAqBxE;AAED;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG,cAAc,EAAE,CA4B5E;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,EAAE,GAAG;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,EAAE,CAAA;CAAE,CA8B3F"}

package/dist/goals.js

@@ -0,0 +1,284 @@
+/**
+ * Business goals definition and tracking
+ *
+ * Uses org.ai Goal types for standardized goal definitions across the ecosystem.
+ */
+/**
+ * Convert a business-as-code GoalDefinition to an org.ai Goal
+ *
+ * @param definition - Business goal definition
+ * @param id - Unique identifier for the goal
+ * @returns org.ai Goal object
+ */
+export function toOrgGoal(definition, id) {
+    const result = {
+        id,
+        name: definition.name,
+        description: definition.description || definition.name,
+        target: 100,
+        progress: definition.progress || 0,
+        status: definition.status || 'not-started',
+    };
+    if (definition.targetDate) {
+        result.targetDate = definition.targetDate;
+        result.deadline = definition.targetDate;
+    }
+    if (definition.owner)
+        result.owner = definition.owner;
+    if (definition.category)
+        result.category = definition.category;
+    if (definition.metrics)
+        result.metrics = definition.metrics;
+    if (definition.dependencies)
+        result.dependencies = definition.dependencies;
+    if (definition.metadata)
+        result.metadata = definition.metadata;
+    return result;
+}
+/**
+ * Convert an org.ai Goal to a business-as-code GoalDefinition
+ *
+ * @param goal - org.ai Goal object
+ * @returns Business goal definition
+ */
+export function fromOrgGoal(goal) {
+    const result = {
+        name: goal.name,
+        progress: typeof goal.progress === 'number' ? goal.progress : 0,
+    };
+    if (goal.description)
+        result.description = goal.description;
+    const cat = goal.category;
+    if (cat)
+        result.category = cat;
+    if (goal.targetDate)
+        result.targetDate = goal.targetDate;
+    else if (goal.deadline)
+        result.targetDate = goal.deadline;
+    if (goal.owner)
+        result.owner = goal.owner;
+    if (goal.metrics)
+        result.metrics = goal.metrics;
+    const st = goal.status;
+    if (st)
+        result.status = st;
+    if (goal.dependencies)
+        result.dependencies = goal.dependencies;
+    if (goal.metadata)
+        result.metadata = goal.metadata;
+    return result;
+}
+/**
+ * Define a business goal with metrics and tracking
+ *
+ * @example
+ * ```ts
+ * const goals = Goals([
+ *   {
+ *     name: 'Launch MVP',
+ *     description: 'Ship minimum viable product to early customers',
+ *     category: 'strategic',
+ *     targetDate: new Date('2024-06-30'),
+ *     owner: 'Product Team',
+ *     metrics: ['User signups', 'Feature completion rate'],
+ *     status: 'in-progress',
+ *     progress: 65,
+ *   },
+ *   {
+ *     name: 'Achieve Product-Market Fit',
+ *     description: 'Validate product value with target customers',
+ *     category: 'strategic',
+ *     targetDate: new Date('2024-12-31'),
+ *     owner: 'CEO',
+ *     metrics: ['NPS > 50', 'Churn < 5%', '100+ paying customers'],
+ *     status: 'in-progress',
+ *     progress: 30,
+ *     dependencies: ['Launch MVP'],
+ *   },
+ * ])
+ * ```
+ */
+export function Goals(definitions) {
+    return definitions.map((goal) => validateAndNormalizeGoal(goal));
+}
+/**
+ * Define a single goal
+ */
+export function Goal(definition) {
+    return validateAndNormalizeGoal(definition);
+}
+/**
+ * Validate and normalize a goal definition
+ */
+function validateAndNormalizeGoal(goal) {
+    if (!goal.name) {
+        throw new Error('Goal name is required');
+    }
+    return {
+        ...goal,
+        category: goal.category || 'operational',
+        status: goal.status || 'not-started',
+        progress: goal.progress || 0,
+        metrics: goal.metrics || [],
+        dependencies: goal.dependencies || [],
+        metadata: goal.metadata || {},
+    };
+}
+/**
+ * Update goal progress
+ */
+export function updateProgress(goal, progress) {
+    if (progress < 0 || progress > 100) {
+        throw new Error('Progress must be between 0 and 100');
+    }
+    // Auto-update status based on progress
+    let status;
+    if (progress === 0) {
+        status = 'not-started';
+    }
+    else if (progress === 100) {
+        status = 'completed';
+    }
+    else {
+        status = 'in-progress';
+    }
+    const result = {
+        ...goal,
+        progress,
+    };
+    if (status !== undefined)
+        result.status = status;
+    return result;
+}
+/**
+ * Mark goal as at-risk
+ */
+export function markAtRisk(goal) {
+    return {
+        ...goal,
+        status: 'at-risk',
+    };
+}
+/**
+ * Mark goal as completed
+ */
+export function complete(goal) {
+    return {
+        ...goal,
+        status: 'completed',
+        progress: 100,
+    };
+}
+/**
+ * Check if goal is overdue
+ */
+export function isOverdue(goal) {
+    if (!goal.targetDate)
+        return false;
+    return new Date() > goal.targetDate && goal.status !== 'completed';
+}
+/**
+ * Get goals by category
+ */
+export function getGoalsByCategory(goals, category) {
+    return goals.filter((g) => g.category === category);
+}
+/**
+ * Get goals by status
+ */
+export function getGoalsByStatus(goals, status) {
+    return goals.filter((g) => g.status === status);
+}
+/**
+ * Get goals by owner
+ */
+export function getGoalsByOwner(goals, owner) {
+    return goals.filter((g) => g.owner === owner);
+}
+/**
+ * Calculate overall progress across all goals
+ */
+export function calculateOverallProgress(goals) {
+    if (goals.length === 0)
+        return 0;
+    const totalProgress = goals.reduce((sum, goal) => sum + (goal.progress || 0), 0);
+    return totalProgress / goals.length;
+}
+/**
+ * Check for circular dependencies
+ */
+export function hasCircularDependencies(goals) {
+    const goalMap = new Map(goals.map((g) => [g.name, g]));
+    function checkCircular(goalName, visited = new Set()) {
+        if (visited.has(goalName))
+            return true;
+        const goal = goalMap.get(goalName);
+        if (!goal || !goal.dependencies)
+            return false;
+        visited.add(goalName);
+        for (const dep of goal.dependencies) {
+            if (checkCircular(dep, new Set(visited))) {
+                return true;
+            }
+        }
+        return false;
+    }
+    return goals.some((goal) => checkCircular(goal.name));
+}
+/**
+ * Get goals in dependency order
+ */
+export function sortByDependencies(goals) {
+    const goalMap = new Map(goals.map((g) => [g.name, g]));
+    const sorted = [];
+    const visited = new Set();
+    function visit(goalName) {
+        if (visited.has(goalName))
+            return;
+        const goal = goalMap.get(goalName);
+        if (!goal)
+            return;
+        visited.add(goalName);
+        // Visit dependencies first
+        if (goal.dependencies) {
+            for (const dep of goal.dependencies) {
+                visit(dep);
+            }
+        }
+        sorted.push(goal);
+    }
+    for (const goal of goals) {
+        visit(goal.name);
+    }
+    return sorted;
+}
+/**
+ * Validate goals
+ */
+export function validateGoals(goals) {
+    const errors = [];
+    for (const goal of goals) {
+        if (!goal.name) {
+            errors.push('Goal name is required');
+        }
+        if (goal.progress && (goal.progress < 0 || goal.progress > 100)) {
+            errors.push(`Goal ${goal.name} progress must be between 0 and 100`);
+        }
+        if (goal.dependencies) {
+            const goalNames = new Set(goals.map((g) => g.name));
+            for (const dep of goal.dependencies) {
+                if (!goalNames.has(dep)) {
+                    errors.push(`Goal ${goal.name} depends on unknown goal: ${dep}`);
+                }
+            }
+        }
+    }
+    if (hasCircularDependencies(goals)) {
+        errors.push('Circular dependencies detected in goals');
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+    };
+}
+//# sourceMappingURL=goals.js.map