business-as-code 0.2.1 → 2.0.1

package/src/okrs.ts

@@ -0,0 +1,325 @@
+/**
+ * Objectives and Key Results (OKRs) management
+ */
+
+import type { OKRDefinition, KeyResult } from './types.js'
+
+/**
+ * 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: OKRDefinition[]): OKRDefinition[] {
+  return definitions.map(okr => validateAndNormalizeOKR(okr))
+}
+
+/**
+ * Define a single OKR
+ */
+export function okr(definition: OKRDefinition): OKRDefinition {
+  return validateAndNormalizeOKR(definition)
+}
+
+/**
+ * Validate and normalize an OKR definition
+ */
+function validateAndNormalizeOKR(okr: OKRDefinition): OKRDefinition {
+  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: KeyResult): number {
+  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: OKRDefinition): number {
+  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: KeyResult[]): number {
+  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: OKRDefinition,
+  krDescription: string,
+  currentValue: number
+): OKRDefinition {
+  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: number,
+  confidence: number
+): OKRDefinition['status'] {
+  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: KeyResult): boolean {
+  const progress = kr.progress ?? calculateKeyResultProgress(kr)
+  return progress >= 70
+}
+
+/**
+ * Check if OKR is on track
+ */
+export function isOKROnTrack(okr: OKRDefinition): boolean {
+  const progress = calculateOKRProgress(okr)
+  return progress >= 70 && (okr.confidence ?? 0) >= 60
+}
+
+/**
+ * Get key results that are on track
+ */
+export function getKeyResultsOnTrack(okr: OKRDefinition): KeyResult[] {
+  return okr.keyResults?.filter(isKeyResultOnTrack) || []
+}
+
+/**
+ * Get key results that are at risk
+ */
+export function getKeyResultsAtRisk(okr: OKRDefinition): KeyResult[] {
+  return okr.keyResults?.filter(kr => !isKeyResultOnTrack(kr)) || []
+}
+
+/**
+ * Get OKRs by owner
+ */
+export function getOKRsByOwner(okrs: OKRDefinition[], owner: string): OKRDefinition[] {
+  return okrs.filter(okr => okr.owner === owner)
+}
+
+/**
+ * Get OKRs by period
+ */
+export function getOKRsByPeriod(okrs: OKRDefinition[], period: string): OKRDefinition[] {
+  return okrs.filter(okr => okr.period === period)
+}
+
+/**
+ * Get OKRs by status
+ */
+export function getOKRsByStatus(
+  okrs: OKRDefinition[],
+  status: OKRDefinition['status']
+): OKRDefinition[] {
+  return okrs.filter(okr => okr.status === status)
+}
+
+/**
+ * Calculate success rate across all OKRs
+ */
+export function calculateSuccessRate(okrs: OKRDefinition[]): number {
+  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: KeyResult): string {
+  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: OKRDefinition,
+  previous: OKRDefinition
+): {
+  progressDelta: number
+  confidenceDelta: number
+  improved: boolean
+} {
+  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: OKRDefinition[]): { valid: boolean; errors: string[] } {
+  const errors: string[] = []
+
+  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,
+  }
+}