@runhalo/engine 0.7.0 → 0.9.0

package/dist/tier-context.js

@@ -0,0 +1,241 @@
+"use strict";
+/**
+ * TierContext — 4-tier feature gating for Halo 2.0
+ *
+ * Sprint 19: Every output surface (CLI, GitHub Action, PDF, dashboard, API)
+ * queries tier permissions from this single source.
+ *
+ * Don't Go Backwards Rule: TierContext is the ONLY way to gate features.
+ * No scattered if-statements. One place to update, one place to test, one place to audit.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TIER_DISPLAY_NAMES = exports.TIER_FEATURES = exports.TIER_LIMITS = void 0;
+exports.createTierContext = createTierContext;
+exports.resolveTierFromKey = resolveTierFromKey;
+exports.getUpgradeCTA = getUpgradeCTA;
+exports.getTierComparison = getTierComparison;
+/* ── Tier Definitions ──────────────────────────────────── */
+const TIER_LIMITS = {
+    free: {
+        scansPerDay: 5,
+        repos: 1,
+        seats: 1,
+        rulesAvailable: 25,
+        aiReviewBudgetPerRepo: 0,
+    },
+    pro: {
+        scansPerDay: Infinity,
+        repos: 3,
+        seats: 3,
+        rulesAvailable: 160,
+        aiReviewBudgetPerRepo: 5,
+    },
+    business: {
+        scansPerDay: Infinity,
+        repos: 10,
+        seats: 5,
+        rulesAvailable: 160,
+        aiReviewBudgetPerRepo: 15,
+    },
+    enterprise: {
+        scansPerDay: Infinity,
+        repos: Infinity,
+        seats: Infinity,
+        rulesAvailable: 160,
+        aiReviewBudgetPerRepo: Infinity,
+    },
+};
+exports.TIER_LIMITS = TIER_LIMITS;
+const TIER_FEATURES = {
+    free: {
+        aiReview: false,
+        astAnalysis: false,
+        pdfSummary: false,
+        pdfAttestation: false,
+        sarif: false,
+        recurringScans: false,
+        driftAlerts: false,
+        auditTrail: false,
+        enforcementAlerts: false,
+        dashboardTrend: false,
+        multiRepo: false,
+        roleBasedViews: false,
+        customRules: false,
+        coppa2Countdown: true,
+        scanDiff: false,
+        complianceHistory: false,
+    },
+    pro: {
+        aiReview: true,
+        astAnalysis: true,
+        pdfSummary: true,
+        pdfAttestation: false,
+        sarif: true,
+        recurringScans: false,
+        driftAlerts: false,
+        auditTrail: false,
+        enforcementAlerts: false,
+        dashboardTrend: true,
+        multiRepo: false,
+        roleBasedViews: false,
+        customRules: false,
+        coppa2Countdown: true,
+        scanDiff: false,
+        complianceHistory: false,
+    },
+    business: {
+        aiReview: true,
+        astAnalysis: true,
+        pdfSummary: true,
+        pdfAttestation: true,
+        sarif: true,
+        recurringScans: true,
+        driftAlerts: true,
+        auditTrail: true,
+        enforcementAlerts: true,
+        dashboardTrend: true,
+        multiRepo: true,
+        roleBasedViews: true,
+        customRules: false,
+        coppa2Countdown: true,
+        scanDiff: true,
+        complianceHistory: true,
+    },
+    enterprise: {
+        aiReview: true,
+        astAnalysis: true,
+        pdfSummary: true,
+        pdfAttestation: true,
+        sarif: true,
+        recurringScans: true,
+        driftAlerts: true,
+        auditTrail: true,
+        enforcementAlerts: true,
+        dashboardTrend: true,
+        multiRepo: true,
+        roleBasedViews: true,
+        customRules: true,
+        coppa2Countdown: true,
+        scanDiff: true,
+        complianceHistory: true,
+    },
+};
+exports.TIER_FEATURES = TIER_FEATURES;
+const TIER_DISPLAY_NAMES = {
+    free: 'Free',
+    pro: 'Pro',
+    business: 'Business',
+    enterprise: 'Enterprise',
+};
+exports.TIER_DISPLAY_NAMES = TIER_DISPLAY_NAMES;
+/* ── Factory ───────────────────────────────────────────── */
+/**
+ * Create a TierContext for a given tier.
+ * All feature/limit checks go through this object.
+ */
+function createTierContext(tier) {
+    const limits = TIER_LIMITS[tier];
+    const features = TIER_FEATURES[tier];
+    return {
+        tier,
+        limits,
+        features,
+        displayName: TIER_DISPLAY_NAMES[tier],
+        can(feature) {
+            return features[feature] === true;
+        },
+        withinLimit(limit, current) {
+            const max = limits[limit];
+            if (max === Infinity)
+                return true;
+            return current < max;
+        },
+    };
+}
+/* ── Resolution ────────────────────────────────────────── */
+/**
+ * Resolve tier from a license key string.
+ * Fails gracefully to free tier on any error (network, expired, invalid).
+ * Don't Go Backwards Rule: Never error. Never block the scan.
+ */
+async function resolveTierFromKey(licenseKey, validateFn) {
+    if (!licenseKey)
+        return createTierContext('free');
+    try {
+        if (validateFn) {
+            const tier = await validateFn(licenseKey);
+            return createTierContext(tier);
+        }
+        // If no validation function provided, parse the key format
+        // Key format: halo_{tier}_{uuid} (e.g., halo_pro_abc123)
+        const tierMatch = licenseKey.match(/^halo_(free|pro|business|enterprise)_/);
+        if (tierMatch) {
+            return createTierContext(tierMatch[1]);
+        }
+        // Unrecognized key format — default to free
+        console.warn('[TierContext] Unrecognized license key format, defaulting to free');
+        return createTierContext('free');
+    }
+    catch (err) {
+        console.warn('[TierContext] License validation failed, defaulting to free:', err);
+        return createTierContext('free');
+    }
+}
+/* ── Utilities ─────────────────────────────────────────── */
+/**
+ * Get the upgrade CTA message for a given tier.
+ * Used by CLI, GitHub Action comments, and PDF footers.
+ */
+function getUpgradeCTA(currentTier) {
+    switch (currentTier) {
+        case 'free':
+            return 'Upgrade to Pro ($29/mo) for AI-verified compliance results → runhalo.dev/pricing';
+        case 'pro':
+            return 'Upgrade to Business ($99/mo) for compliance attestation, recurring scans, and audit trail → runhalo.dev/pricing';
+        case 'business':
+            return 'Need custom rules, unlimited repos, or SLA support? → runhalo.dev/enterprise';
+        case 'enterprise':
+            return null; // No upsell for enterprise
+    }
+}
+/**
+ * Get the tier comparison table as structured data.
+ * Used by pricing pages, upgrade modals, and help output.
+ */
+function getTierComparison() {
+    const tiers = ['free', 'pro', 'business', 'enterprise'];
+    const featureNames = {
+        aiReview: 'AI Review Board',
+        astAnalysis: 'AST Structural Analysis',
+        pdfSummary: 'PDF Summary Report',
+        pdfAttestation: 'Compliance Attestation PDF',
+        sarif: 'SARIF Output',
+        recurringScans: 'Scheduled Recurring Scans',
+        driftAlerts: 'Compliance Drift Alerts',
+        auditTrail: 'Immutable Audit Trail',
+        enforcementAlerts: 'Enforcement Intelligence Alerts',
+        dashboardTrend: 'Compliance Trend Charts',
+        multiRepo: 'Multi-Repo Workspace',
+        roleBasedViews: 'Role-Based Views',
+        customRules: 'Custom Rules',
+        coppa2Countdown: 'COPPA 2.0 Countdown',
+        scanDiff: 'PR Scan Diff',
+        complianceHistory: 'Compliance History',
+    };
+    return {
+        tiers,
+        features: Object.keys(featureNames).map(key => ({
+            name: featureNames[key],
+            key,
+            values: Object.fromEntries(tiers.map(t => [t, TIER_FEATURES[t][key]])),
+        })),
+        limits: [
+            { name: 'Scans per day', key: 'scansPerDay', values: { free: '5', pro: 'Unlimited', business: 'Unlimited', enterprise: 'Unlimited' } },
+            { name: 'Repositories', key: 'repos', values: { free: '1', pro: '3', business: '10', enterprise: 'Unlimited' } },
+            { name: 'Team seats', key: 'seats', values: { free: '1', pro: '3', business: '5', enterprise: 'Unlimited' } },
+            { name: 'Rules available', key: 'rulesAvailable', values: { free: '25 COPPA', pro: 'All 160', business: 'All 160', enterprise: 'All + Custom' } },
+        ],
+        prices: { free: '$0', pro: '$29/mo', business: '$99/mo', enterprise: 'Custom' },
+    };
+}
+//# sourceMappingURL=tier-context.js.map

package/dist/tier-context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tier-context.js","sourceRoot":"","sources":["../src/tier-context.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAoKH,8CAoBC;AASD,gDAwBC;AAQD,sCAWC;AAMD,8CA0CC;AAjPD,8DAA8D;AAE9D,MAAM,WAAW,GAAiC;IAChD,IAAI,EAAE;QACJ,WAAW,EAAE,CAAC;QACd,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,cAAc,EAAE,EAAE;QAClB,qBAAqB,EAAE,CAAC;KACzB;IACD,GAAG,EAAE;QACH,WAAW,EAAE,QAAQ;QACrB,KAAK,EAAE,CAAC;QACR,KAAK,EAAE,CAAC;QACR,cAAc,EAAE,GAAG;QACnB,qBAAqB,EAAE,CAAC;KACzB;IACD,QAAQ,EAAE;QACR,WAAW,EAAE,QAAQ;QACrB,KAAK,EAAE,EAAE;QACT,KAAK,EAAE,CAAC;QACR,cAAc,EAAE,GAAG;QACnB,qBAAqB,EAAE,EAAE;KAC1B;IACD,UAAU,EAAE;QACV,WAAW,EAAE,QAAQ;QACrB,KAAK,EAAE,QAAQ;QACf,KAAK,EAAE,QAAQ;QACf,cAAc,EAAE,GAAG;QACnB,qBAAqB,EAAE,QAAQ;KAChC;CACF,CAAC;AAsNO,kCAAW;AApNpB,MAAM,aAAa,GAAmC;IACpD,IAAI,EAAE;QACJ,QAAQ,EAAE,KAAK;QACf,WAAW,EAAE,KAAK;QAClB,UAAU,EAAE,KAAK;QACjB,cAAc,EAAE,KAAK;QACrB,KAAK,EAAE,KAAK;QACZ,cAAc,EAAE,KAAK;QACrB,WAAW,EAAE,KAAK;QAClB,UAAU,EAAE,KAAK;QACjB,iBAAiB,EAAE,KAAK;QACxB,cAAc,EAAE,KAAK;QACrB,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,KAAK;QACrB,WAAW,EAAE,KAAK;QAClB,eAAe,EAAE,IAAI;QACrB,QAAQ,EAAE,KAAK;QACf,iBAAiB,EAAE,KAAK;KACzB;IACD,GAAG,EAAE;QACH,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,KAAK;QACrB,KAAK,EAAE,IAAI;QACX,cAAc,EAAE,KAAK;QACrB,WAAW,EAAE,KAAK;QAClB,UAAU,EAAE,KAAK;QACjB,iBAAiB,EAAE,KAAK;QACxB,cAAc,EAAE,IAAI;QACpB,SAAS,EAAE,KAAK;QAChB,cAAc,EAAE,KAAK;QACrB,WAAW,EAAE,KAAK;QAClB,eAAe,EAAE,IAAI;QACrB,QAAQ,EAAE,KAAK;QACf,iBAAiB,EAAE,KAAK;KACzB;IACD,QAAQ,EAAE;QACR,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,IAAI;QACpB,KAAK,EAAE,IAAI;QACX,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,IAAI;QAChB,iBAAiB,EAAE,IAAI;QACvB,cAAc,EAAE,IAAI;QACpB,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,KAAK;QAClB,eAAe,EAAE,IAAI;QACrB,QAAQ,EAAE,IAAI;QACd,iBAAiB,EAAE,IAAI;KACxB;IACD,UAAU,EAAE;QACV,QAAQ,EAAE,IAAI;QACd,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,IAAI;QAChB,cAAc,EAAE,IAAI;QACpB,KAAK,EAAE,IAAI;QACX,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,IAAI;QACjB,UAAU,EAAE,IAAI;QAChB,iBAAiB,EAAE,IAAI;QACvB,cAAc,EAAE,IAAI;QACpB,SAAS,EAAE,IAAI;QACf,cAAc,EAAE,IAAI;QACpB,WAAW,EAAE,IAAI;QACjB,eAAe,EAAE,IAAI;QACrB,QAAQ,EAAE,IAAI;QACd,iBAAiB,EAAE,IAAI;KACxB;CACF,CAAC;AA2IoB,sCAAa;AAzInC,MAAM,kBAAkB,GAA6B;IACnD,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,QAAQ,EAAE,UAAU;IACpB,UAAU,EAAE,YAAY;CACzB,CAAC;AAoImC,gDAAkB;AAlIvD,8DAA8D;AAE9D;;;GAGG;AACH,SAAgB,iBAAiB,CAAC,IAAc;IAC9C,MAAM,MAAM,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;IACjC,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,CAAC;IAErC,OAAO;QACL,IAAI;QACJ,MAAM;QACN,QAAQ;QACR,WAAW,EAAE,kBAAkB,CAAC,IAAI,CAAC;QAErC,GAAG,CAAC,OAA2B;YAC7B,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,IAAI,CAAC;QACpC,CAAC;QAED,WAAW,CAAC,KAAuB,EAAE,OAAe;YAClD,MAAM,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,GAAG,KAAK,QAAQ;gBAAE,OAAO,IAAI,CAAC;YAClC,OAAO,OAAO,GAAG,GAAG,CAAC;QACvB,CAAC;KACF,CAAC;AACJ,CAAC;AAED,8DAA8D;AAE9D;;;;GAIG;AACI,KAAK,UAAU,kBAAkB,CACtC,UAA8B,EAC9B,UAA+C;IAE/C,IAAI,CAAC,UAAU;QAAE,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;IAElD,IAAI,CAAC;QACH,IAAI,UAAU,EAAE,CAAC;YACf,MAAM,IAAI,GAAG,MAAM,UAAU,CAAC,UAAU,CAAC,CAAC;YAC1C,OAAO,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACjC,CAAC;QACD,2DAA2D;QAC3D,yDAAyD;QACzD,MAAM,SAAS,GAAG,UAAU,CAAC,KAAK,CAAC,uCAAuC,CAAC,CAAC;QAC5E,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,iBAAiB,CAAC,SAAS,CAAC,CAAC,CAAa,CAAC,CAAC;QACrD,CAAC;QACD,4CAA4C;QAC5C,OAAO,CAAC,IAAI,CAAC,mEAAmE,CAAC,CAAC;QAClF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,CAAC,IAAI,CAAC,8DAA8D,EAAE,GAAG,CAAC,CAAC;QAClF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC;AACH,CAAC;AAED,8DAA8D;AAE9D;;;GAGG;AACH,SAAgB,aAAa,CAAC,WAAqB;IACjD,QAAQ,WAAW,EAAE,CAAC;QACpB,KAAK,MAAM;YACT,OAAO,kFAAkF,CAAC;QAC5F,KAAK,KAAK;YACR,OAAO,iHAAiH,CAAC;QAC3H,KAAK,UAAU;YACb,OAAO,8EAA8E,CAAC;QACxF,KAAK,YAAY;YACf,OAAO,IAAI,CAAC,CAAC,2BAA2B;IAC5C,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,SAAgB,iBAAiB;IAM/B,MAAM,KAAK,GAAe,CAAC,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;IAEpE,MAAM,YAAY,GAAuC;QACvD,QAAQ,EAAE,iBAAiB;QAC3B,WAAW,EAAE,yBAAyB;QACtC,UAAU,EAAE,oBAAoB;QAChC,cAAc,EAAE,4BAA4B;QAC5C,KAAK,EAAE,cAAc;QACrB,cAAc,EAAE,2BAA2B;QAC3C,WAAW,EAAE,yBAAyB;QACtC,UAAU,EAAE,uBAAuB;QACnC,iBAAiB,EAAE,iCAAiC;QACpD,cAAc,EAAE,yBAAyB;QACzC,SAAS,EAAE,sBAAsB;QACjC,cAAc,EAAE,kBAAkB;QAClC,WAAW,EAAE,cAAc;QAC3B,eAAe,EAAE,qBAAqB;QACtC,QAAQ,EAAE,cAAc;QACxB,iBAAiB,EAAE,oBAAoB;KACxC,CAAC;IAEF,OAAO;QACL,KAAK;QACL,QAAQ,EAAG,MAAM,CAAC,IAAI,CAAC,YAAY,CAA4B,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC1E,IAAI,EAAE,YAAY,CAAC,GAAG,CAAC;YACvB,GAAG;YACH,MAAM,EAAE,MAAM,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAA8B;SACpG,CAAC,CAAC;QACH,MAAM,EAAE;YACN,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,EAAE,aAAiC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,QAAQ,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE;YAC1J,EAAE,IAAI,EAAE,cAAc,EAAE,GAAG,EAAE,OAA2B,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE;YACpI,EAAE,IAAI,EAAE,YAAY,EAAE,GAAG,EAAE,OAA2B,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,EAAE,WAAW,EAAE,EAAE;YACjI,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,EAAE,gBAAoC,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,UAAU,EAAE,cAAc,EAAE,EAAE;SACtK;QACD,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,QAAQ,EAAE,QAAQ,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE;KAChF,CAAC;AACJ,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@runhalo/engine",
-  "version": "0.7.0",
+  "version": "0.9.0",
   "description": "Halo rule engine — child online safety compliance detection. 130 rules across 10 packs covering COPPA, UK AADC, EU DSA, EU AI Act, and more.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",