business-as-code 0.2.1 → 2.0.2

package/dist/okrs.js

@@ -0,0 +1,269 @@
+/**
+ * Objectives and Key Results (OKRs) management
+ */
+/**
+ * Define Objectives and Key Results for goal tracking
+ *
+ * @example
+ * ```ts
+ * const quarterlyOKRs = okrs([
+ *   {
+ *     objective: 'Achieve Product-Market Fit',
+ *     description: 'Validate that our product solves a real problem for customers',
+ *     period: 'Q2 2024',
+ *     owner: 'CEO',
+ *     keyResults: [
+ *       {
+ *         description: 'Increase Net Promoter Score',
+ *         metric: 'NPS',
+ *         startValue: 40,
+ *         targetValue: 60,
+ *         currentValue: 52,
+ *         unit: 'score',
+ *         progress: 60,
+ *       },
+ *       {
+ *         description: 'Reduce monthly churn rate',
+ *         metric: 'Churn Rate',
+ *         startValue: 8,
+ *         targetValue: 4,
+ *         currentValue: 5.5,
+ *         unit: 'percent',
+ *         progress: 62.5,
+ *       },
+ *       {
+ *         description: 'Achieve customer retention',
+ *         metric: 'Customers with 3+ months',
+ *         startValue: 50,
+ *         targetValue: 200,
+ *         currentValue: 125,
+ *         unit: 'customers',
+ *         progress: 50,
+ *       },
+ *     ],
+ *     status: 'on-track',
+ *     confidence: 75,
+ *   },
+ * ])
+ * ```
+ */
+export function okrs(definitions) {
+    return definitions.map(okr => validateAndNormalizeOKR(okr));
+}
+/**
+ * Define a single OKR
+ */
+export function okr(definition) {
+    return validateAndNormalizeOKR(definition);
+}
+/**
+ * Validate and normalize an OKR definition
+ */
+function validateAndNormalizeOKR(okr) {
+    if (!okr.objective) {
+        throw new Error('OKR objective is required');
+    }
+    // Calculate progress for key results if not set
+    const keyResults = okr.keyResults?.map(kr => ({
+        ...kr,
+        progress: kr.progress ?? calculateKeyResultProgress(kr),
+    }));
+    return {
+        ...okr,
+        keyResults,
+        status: okr.status || 'not-started',
+        confidence: okr.confidence ?? calculateConfidence(keyResults || []),
+        metadata: okr.metadata || {},
+    };
+}
+/**
+ * Calculate key result progress
+ */
+export function calculateKeyResultProgress(kr) {
+    if (kr.currentValue === undefined || kr.startValue === undefined)
+        return 0;
+    const total = kr.targetValue - kr.startValue;
+    if (total === 0)
+        return 100;
+    const current = kr.currentValue - kr.startValue;
+    const progress = (current / total) * 100;
+    return Math.max(0, Math.min(100, progress));
+}
+/**
+ * Calculate overall OKR progress
+ */
+export function calculateOKRProgress(okr) {
+    if (!okr.keyResults || okr.keyResults.length === 0)
+        return 0;
+    const totalProgress = okr.keyResults.reduce((sum, kr) => {
+        return sum + (kr.progress ?? calculateKeyResultProgress(kr));
+    }, 0);
+    return totalProgress / okr.keyResults.length;
+}
+/**
+ * Calculate confidence score based on key results
+ */
+export function calculateConfidence(keyResults) {
+    if (keyResults.length === 0)
+        return 0;
+    const totalProgress = keyResults.reduce((sum, kr) => {
+        return sum + (kr.progress ?? calculateKeyResultProgress(kr));
+    }, 0);
+    const avgProgress = totalProgress / keyResults.length;
+    // Confidence tends to be slightly lower than actual progress
+    return Math.max(0, Math.min(100, avgProgress - 10));
+}
+/**
+ * Update key result current value
+ */
+export function updateKeyResult(okr, krDescription, currentValue) {
+    const keyResults = okr.keyResults?.map(kr => {
+        if (kr.description === krDescription) {
+            const updatedKR = { ...kr, currentValue };
+            return {
+                ...updatedKR,
+                progress: calculateKeyResultProgress(updatedKR),
+            };
+        }
+        return kr;
+    });
+    // Recalculate overall status and confidence
+    const progress = calculateOKRProgress({ ...okr, keyResults });
+    const status = determineOKRStatus(progress, okr.confidence || 0);
+    return {
+        ...okr,
+        keyResults,
+        status,
+        confidence: calculateConfidence(keyResults || []),
+    };
+}
+/**
+ * Determine OKR status based on progress and confidence
+ */
+function determineOKRStatus(progress, confidence) {
+    if (progress === 0)
+        return 'not-started';
+    if (progress === 100)
+        return 'completed';
+    if (confidence < 50 || progress < 30)
+        return 'at-risk';
+    return 'on-track';
+}
+/**
+ * Check if key result is on track
+ */
+export function isKeyResultOnTrack(kr) {
+    const progress = kr.progress ?? calculateKeyResultProgress(kr);
+    return progress >= 70;
+}
+/**
+ * Check if OKR is on track
+ */
+export function isOKROnTrack(okr) {
+    const progress = calculateOKRProgress(okr);
+    return progress >= 70 && (okr.confidence ?? 0) >= 60;
+}
+/**
+ * Get key results that are on track
+ */
+export function getKeyResultsOnTrack(okr) {
+    return okr.keyResults?.filter(isKeyResultOnTrack) || [];
+}
+/**
+ * Get key results that are at risk
+ */
+export function getKeyResultsAtRisk(okr) {
+    return okr.keyResults?.filter(kr => !isKeyResultOnTrack(kr)) || [];
+}
+/**
+ * Get OKRs by owner
+ */
+export function getOKRsByOwner(okrs, owner) {
+    return okrs.filter(okr => okr.owner === owner);
+}
+/**
+ * Get OKRs by period
+ */
+export function getOKRsByPeriod(okrs, period) {
+    return okrs.filter(okr => okr.period === period);
+}
+/**
+ * Get OKRs by status
+ */
+export function getOKRsByStatus(okrs, status) {
+    return okrs.filter(okr => okr.status === status);
+}
+/**
+ * Calculate success rate across all OKRs
+ */
+export function calculateSuccessRate(okrs) {
+    if (okrs.length === 0)
+        return 0;
+    const avgProgress = okrs.reduce((sum, okr) => {
+        return sum + calculateOKRProgress(okr);
+    }, 0) / okrs.length;
+    return avgProgress;
+}
+/**
+ * Format key result for display
+ */
+export function formatKeyResult(kr) {
+    const progress = kr.progress ?? calculateKeyResultProgress(kr);
+    const current = kr.currentValue ?? kr.startValue ?? 0;
+    const target = kr.targetValue;
+    return `${kr.description}: ${current}/${target} ${kr.unit || ''} (${progress.toFixed(0)}%)`;
+}
+/**
+ * Compare OKR performance between periods
+ */
+export function compareOKRPerformance(current, previous) {
+    const currentProgress = calculateOKRProgress(current);
+    const previousProgress = calculateOKRProgress(previous);
+    const progressDelta = currentProgress - previousProgress;
+    const currentConfidence = current.confidence ?? 0;
+    const previousConfidence = previous.confidence ?? 0;
+    const confidenceDelta = currentConfidence - previousConfidence;
+    const improved = progressDelta > 0 && confidenceDelta >= 0;
+    return { progressDelta, confidenceDelta, improved };
+}
+/**
+ * Validate OKR definitions
+ */
+export function validateOKRs(okrs) {
+    const errors = [];
+    for (const okr of okrs) {
+        if (!okr.objective) {
+            errors.push('OKR objective is required');
+        }
+        if (okr.objective && okr.objective.length < 10) {
+            errors.push(`OKR objective "${okr.objective}" should be at least 10 characters`);
+        }
+        if (okr.confidence !== undefined && (okr.confidence < 0 || okr.confidence > 100)) {
+            errors.push(`OKR "${okr.objective}" confidence must be between 0 and 100`);
+        }
+        if (okr.keyResults) {
+            if (okr.keyResults.length === 0) {
+                errors.push(`OKR "${okr.objective}" must have at least one key result`);
+            }
+            if (okr.keyResults.length > 5) {
+                errors.push(`OKR "${okr.objective}" should have no more than 5 key results`);
+            }
+            for (const kr of okr.keyResults) {
+                if (!kr.description) {
+                    errors.push(`Key result in OKR "${okr.objective}" must have a description`);
+                }
+                if (!kr.metric) {
+                    errors.push(`Key result "${kr.description}" must have a metric`);
+                }
+                if (kr.progress !== undefined && (kr.progress < 0 || kr.progress > 100)) {
+                    errors.push(`Key result "${kr.description}" progress must be between 0 and 100`);
+                }
+            }
+        }
+    }
+    return {
+        valid: errors.length === 0,
+        errors,
+    };
+}
+//# sourceMappingURL=okrs.js.map

package/dist/okrs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"okrs.js","sourceRoot":"","sources":["../src/okrs.ts"],"names":[],"mappings":"AAAA;;GAEG;AAIH;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAU,IAAI,CAAC,WAA4B;IAC/C,OAAO,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,uBAAuB,CAAC,GAAG,CAAC,CAAC,CAAA;AAC7D,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,UAAyB;IAC3C,OAAO,uBAAuB,CAAC,UAAU,CAAC,CAAA;AAC5C,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,GAAkB;IACjD,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAA;IAC9C,CAAC;IAED,gDAAgD;IAChD,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC;QAC5C,GAAG,EAAE;QACL,QAAQ,EAAE,EAAE,CAAC,QAAQ,IAAI,0BAA0B,CAAC,EAAE,CAAC;KACxD,CAAC,CAAC,CAAA;IAEH,OAAO;QACL,GAAG,GAAG;QACN,UAAU;QACV,MAAM,EAAE,GAAG,CAAC,MAAM,IAAI,aAAa;QACnC,UAAU,EAAE,GAAG,CAAC,UAAU,IAAI,mBAAmB,CAAC,UAAU,IAAI,EAAE,CAAC;QACnE,QAAQ,EAAE,GAAG,CAAC,QAAQ,IAAI,EAAE;KAC7B,CAAA;AACH,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,0BAA0B,CAAC,EAAa;IACtD,IAAI,EAAE,CAAC,YAAY,KAAK,SAAS,IAAI,EAAE,CAAC,UAAU,KAAK,SAAS;QAAE,OAAO,CAAC,CAAA;IAE1E,MAAM,KAAK,GAAG,EAAE,CAAC,WAAW,GAAG,EAAE,CAAC,UAAU,CAAA;IAC5C,IAAI,KAAK,KAAK,CAAC;QAAE,OAAO,GAAG,CAAA;IAE3B,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,GAAG,EAAE,CAAC,UAAU,CAAA;IAC/C,MAAM,QAAQ,GAAG,CAAC,OAAO,GAAG,KAAK,CAAC,GAAG,GAAG,CAAA;IAExC,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAA;AAC7C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAkB;IACrD,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAE5D,MAAM,aAAa,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;QACtD,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC,QAAQ,IAAI,0BAA0B,CAAC,EAAE,CAAC,CAAC,CAAA;IAC9D,CAAC,EAAE,CAAC,CAAC,CAAA;IAEL,OAAO,aAAa,GAAG,GAAG,CAAC,UAAU,CAAC,MAAM,CAAA;AAC9C,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,UAAuB;IACzD,IAAI,UAAU,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAErC,MAAM,aAAa,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE;QAClD,OAAO,GAAG,GAAG,CAAC,EAAE,CAAC,QAAQ,IAAI,0BAA0B,CAAC,EAAE,CAAC,CAAC,CAAA;IAC9D,CAAC,EAAE,CAAC,CAAC,CAAA;IAEL,MAAM,WAAW,GAAG,aAAa,GAAG,UAAU,CAAC,MAAM,CAAA;IAErD,6DAA6D;IAC7D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,WAAW,GAAG,EAAE,CAAC,CAAC,CAAA;AACrD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,GAAkB,EAClB,aAAqB,EACrB,YAAoB;IAEpB,MAAM,UAAU,GAAG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,CAAC,EAAE;QAC1C,IAAI,EAAE,CAAC,WAAW,KAAK,aAAa,EAAE,CAAC;YACrC,MAAM,SAAS,GAAG,EAAE,GAAG,EAAE,EAAE,YAAY,EAAE,CAAA;YACzC,OAAO;gBACL,GAAG,SAAS;gBACZ,QAAQ,EAAE,0BAA0B,CAAC,SAAS,CAAC;aAChD,CAAA;QACH,CAAC;QACD,OAAO,EAAE,CAAA;IACX,CAAC,CAAC,CAAA;IAEF,4CAA4C;IAC5C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,EAAE,GAAG,GAAG,EAAE,UAAU,EAAE,CAAC,CAAA;IAC7D,MAAM,MAAM,GAAG,kBAAkB,CAAC,QAAQ,EAAE,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,CAAA;IAEhE,OAAO;QACL,GAAG,GAAG;QACN,UAAU;QACV,MAAM;QACN,UAAU,EAAE,mBAAmB,CAAC,UAAU,IAAI,EAAE,CAAC;KAClD,CAAA;AACH,CAAC;AAED;;GAEG;AACH,SAAS,kBAAkB,CACzB,QAAgB,EAChB,UAAkB;IAElB,IAAI,QAAQ,KAAK,CAAC;QAAE,OAAO,aAAa,CAAA;IACxC,IAAI,QAAQ,KAAK,GAAG;QAAE,OAAO,WAAW,CAAA;IACxC,IAAI,UAAU,GAAG,EAAE,IAAI,QAAQ,GAAG,EAAE;QAAE,OAAO,SAAS,CAAA;IACtD,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,kBAAkB,CAAC,EAAa;IAC9C,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,IAAI,0BAA0B,CAAC,EAAE,CAAC,CAAA;IAC9D,OAAO,QAAQ,IAAI,EAAE,CAAA;AACvB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,GAAkB;IAC7C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAA;IAC1C,OAAO,QAAQ,IAAI,EAAE,IAAI,CAAC,GAAG,CAAC,UAAU,IAAI,CAAC,CAAC,IAAI,EAAE,CAAA;AACtD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAkB;IACrD,OAAO,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAA;AACzD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,mBAAmB,CAAC,GAAkB;IACpD,OAAO,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;AACpE,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,cAAc,CAAC,IAAqB,EAAE,KAAa;IACjE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAA;AAChD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,IAAqB,EAAE,MAAc;IACnE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAA;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAqB,EACrB,MAA+B;IAE/B,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,MAAM,KAAK,MAAM,CAAC,CAAA;AAClD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAqB;IACxD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,CAAC,CAAA;IAE/B,MAAM,WAAW,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,GAAG,EAAE,EAAE;QAC3C,OAAO,GAAG,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAA;IACxC,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAA;IAEnB,OAAO,WAAW,CAAA;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,EAAa;IAC3C,MAAM,QAAQ,GAAG,EAAE,CAAC,QAAQ,IAAI,0BAA0B,CAAC,EAAE,CAAC,CAAA;IAC9D,MAAM,OAAO,GAAG,EAAE,CAAC,YAAY,IAAI,EAAE,CAAC,UAAU,IAAI,CAAC,CAAA;IACrD,MAAM,MAAM,GAAG,EAAE,CAAC,WAAW,CAAA;IAE7B,OAAO,GAAG,EAAE,CAAC,WAAW,KAAK,OAAO,IAAI,MAAM,IAAI,EAAE,CAAC,IAAI,IAAI,EAAE,KAAK,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAA;AAC7F,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,OAAsB,EACtB,QAAuB;IAMvB,MAAM,eAAe,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAA;IACrD,MAAM,gBAAgB,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAA;IACvD,MAAM,aAAa,GAAG,eAAe,GAAG,gBAAgB,CAAA;IAExD,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,IAAI,CAAC,CAAA;IACjD,MAAM,kBAAkB,GAAG,QAAQ,CAAC,UAAU,IAAI,CAAC,CAAA;IACnD,MAAM,eAAe,GAAG,iBAAiB,GAAG,kBAAkB,CAAA;IAE9D,MAAM,QAAQ,GAAG,aAAa,GAAG,CAAC,IAAI,eAAe,IAAI,CAAC,CAAA;IAE1D,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAA;AACrD,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,YAAY,CAAC,IAAqB;IAChD,MAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACvB,IAAI,CAAC,GAAG,CAAC,SAAS,EAAE,CAAC;YACnB,MAAM,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAA;QAC1C,CAAC;QAED,IAAI,GAAG,CAAC,SAAS,IAAI,GAAG,CAAC,SAAS,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;YAC/C,MAAM,CAAC,IAAI,CAAC,kBAAkB,GAAG,CAAC,SAAS,oCAAoC,CAAC,CAAA;QAClF,CAAC;QAED,IAAI,GAAG,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,GAAG,CAAC,UAAU,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC;YACjF,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,SAAS,wCAAwC,CAAC,CAAA;QAC5E,CAAC;QAED,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;YACnB,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBAChC,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,SAAS,qCAAqC,CAAC,CAAA;YACzE,CAAC;YAED,IAAI,GAAG,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC9B,MAAM,CAAC,IAAI,CAAC,QAAQ,GAAG,CAAC,SAAS,0CAA0C,CAAC,CAAA;YAC9E,CAAC;YAED,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,UAAU,EAAE,CAAC;gBAChC,IAAI,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC;oBACpB,MAAM,CAAC,IAAI,CAAC,sBAAsB,GAAG,CAAC,SAAS,2BAA2B,CAAC,CAAA;gBAC7E,CAAC;gBAED,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC;oBACf,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,WAAW,sBAAsB,CAAC,CAAA;gBAClE,CAAC;gBAED,IAAI,EAAE,CAAC,QAAQ,KAAK,SAAS,IAAI,CAAC,EAAE,CAAC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC,QAAQ,GAAG,GAAG,CAAC,EAAE,CAAC;oBACxE,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC,WAAW,sCAAsC,CAAC,CAAA;gBAClF,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO;QACL,KAAK,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC;QAC1B,MAAM;KACP,CAAA;AACH,CAAC"}