@flag-engine/core 0.0.9 → 0.0.11

package/dist/evaluateFlag.d.ts

@@ -1,3 +1,10 @@
 import { FlagConfiguration, UserConfiguration } from "./types";
+/**
+ * Evaluates a feature flag for a given user configuration.
+ *
+ * @param flagConfig - The flag configuration to evaluate
+ * @param userConfiguration - The user context containing __id and custom fields
+ * @returns true if flag is enabled with no variants, variant name if matched, false otherwise
+ */
 export declare const evaluateFlag: (flagConfig: FlagConfiguration, userConfiguration: UserConfiguration) => string | boolean;
 //# sourceMappingURL=evaluateFlag.d.ts.map

package/dist/evaluateFlag.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"evaluateFlag.d.ts","sourceRoot":"","sources":["../src/evaluateFlag.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE/D,eAAO,MAAM,YAAY,GACvB,YAAY,iBAAiB,EAC7B,mBAAmB,iBAAiB,qBAgBrC,CAAC"}
+{"version":3,"file":"evaluateFlag.d.ts","sourceRoot":"","sources":["../src/evaluateFlag.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAE/D;;;;;;GAMG;AACH,eAAO,MAAM,YAAY,GACvB,YAAY,iBAAiB,EAC7B,mBAAmB,iBAAiB,KACnC,MAAM,GAAG,OAiBX,CAAC"}

package/dist/getEligibleStrategy.d.ts

@@ -1,4 +1,20 @@
-import { FlagConfiguration, Rule, UserConfiguration } from "./types";
-export declare const isEligibleForStrategy: (rules: Rule[], userConfiguration: UserConfiguration) => boolean;
-export declare const getEligibleStrategy: (flagConfig: FlagConfiguration, userConfiguration: UserConfiguration) => import("./types").Strategy | undefined;
+import { FlagConfiguration, Rule, Strategy, UserConfiguration } from "./types";
+/**
+ * Evaluates whether a user matches all rules in a strategy.
+ * Supports nested segment evaluation with cycle/depth protection.
+ *
+ * @param rules - Array of rules to evaluate
+ * @param userConfiguration - User context with __id and custom fields
+ * @param depth - Current recursion depth for cycle protection
+ * @returns true if user matches all rules, false otherwise
+ */
+export declare const isEligibleForStrategy: (rules: Rule[], userConfiguration: UserConfiguration, depth?: number) => boolean;
+/**
+ * Finds the first strategy in a flag configuration that the user is eligible for.
+ *
+ * @param flagConfig - The flag configuration containing strategies
+ * @param userConfiguration - User context with __id and custom fields
+ * @returns The first matching strategy, or undefined if none match
+ */
+export declare const getEligibleStrategy: (flagConfig: FlagConfiguration, userConfiguration: UserConfiguration) => Strategy | undefined;
 //# sourceMappingURL=getEligibleStrategy.d.ts.map

package/dist/getEligibleStrategy.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getEligibleStrategy.d.ts","sourceRoot":"","sources":["../src/getEligibleStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAOrE,eAAO,MAAM,qBAAqB,GAChC,OAAO,IAAI,EAAE,EACb,mBAAmB,iBAAiB,KACnC,OAuEF,CAAC;AAEF,eAAO,MAAM,mBAAmB,GAC9B,YAAY,iBAAiB,EAC7B,mBAAmB,iBAAiB,2CAKrC,CAAC"}
+{"version":3,"file":"getEligibleStrategy.d.ts","sourceRoot":"","sources":["../src/getEligibleStrategy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,IAAI,EAAE,QAAQ,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAY/E;;;;;;;;GAQG;AACH,eAAO,MAAM,qBAAqB,GAChC,OAAO,IAAI,EAAE,EACb,mBAAmB,iBAAiB,EACpC,QAAO,MAAU,KAChB,OA6EF,CAAC;AAEF;;;;;;GAMG;AACH,eAAO,MAAM,mBAAmB,GAC9B,YAAY,iBAAiB,EAC7B,mBAAmB,iBAAiB,KACnC,QAAQ,GAAG,SAIb,CAAC"}

package/dist/index.cjs.js

@@ -1 +1 @@
-"use strict";var e=require("murmurhash-js");const t=e=>"string"==typeof e,r=e=>null==e,n=(e,a)=>0===e.length||e.every((e=>{if("inSegment"in e)return n(e.inSegment.rules,a);switch(e.operator){case"equals":return a[e.field]===e.value;case"not_equals":return a[e.field]!==e.value;case"greater_than":{const t=a[e.field];return!r(t)&&!r(e.value)&&t>e.value}case"less_than":{const t=a[e.field];return!r(t)&&!r(e.value)&&t<e.value}case"contains":{const r=a[e.field];return t(r)&&t(e.value)&&r.includes(e.value)}case"not_contains":{const r=a[e.field];return t(r)&&t(e.value)&&!r.includes(e.value)}case"in":{const t=a[e.field];return Array.isArray(e.value)&&-1!==e.value.indexOf(t)}case"not_in":{const t=a[e.field];return Array.isArray(e.value)&&-1===e.value.indexOf(t)}default:return!1}})),a=Math.pow(2,32),s=(t,r)=>{if(0===t.strategies.length)return!0;const s=((e,t)=>e.strategies.find((e=>n(e.rules,t))))(t,r);if(!s)return!1;if(0===s.variants.length)return!0;const u=((t,r)=>{t.variants.sort(((e,t)=>e.percent-t.percent));let n=0;const s=`${t.name}-${r}`,u=e.murmur3(s),l=t.variants.find((e=>{const t=u/a*100;if(n+=e.percent,t<=n)return e}));return l||!1})(s,r.__id);return!!u&&u.name};exports.createFlagEngine=e=>({createUserContext:t=>((e,t)=>{let r=t;return{evaluateAll:()=>{const t={};for(const n of e)t[n.key]="enabled"===n.status&&s(n,r);return t},evaluate:t=>{const n=e.find((e=>e.key===t));return!!n&&"disabled"!==n.status&&s(n,r)},setUserConfiguration:e=>{r=e}}})(e,t)});
+"use strict";var e=require("murmurhash-js");const r=e=>"string"==typeof e,t=e=>null==e,n=(e,a,s=0)=>!(s>10)&&(0===e.length||e.every((e=>{if("inSegment"in e)return n(e.inSegment.rules,a,s+1);switch(e.operator){case"equals":return a[e.field]===e.value;case"not_equals":return a[e.field]!==e.value;case"greater_than":{const r=a[e.field];return!t(r)&&!t(e.value)&&r>e.value}case"less_than":{const r=a[e.field];return!t(r)&&!t(e.value)&&r<e.value}case"contains":{const t=a[e.field];return r(t)&&r(e.value)&&t.includes(e.value)}case"not_contains":{const t=a[e.field];return!!r(e.value)&&(!r(t)||!t.includes(e.value))}case"in":{const r=a[e.field];return Array.isArray(e.value)&&-1!==e.value.indexOf(r)}case"not_in":{const r=a[e.field];return!!Array.isArray(e.value)&&-1===e.value.indexOf(r)}default:return!1}}))),a=2**32,s=(r,t)=>{if(0===r.strategies.length)return!0;const s=((e,r)=>e.strategies.find((e=>n(e.rules,r))))(r,t);if(!s)return!1;if(0===s.variants.length)return!0;const u=((r,t)=>{const n=[...r.variants].sort(((e,r)=>e.percent-r.percent)),s=`${r.name}-${t}`,u=e.murmur3(s)/a*100;let l=0;for(const e of n)if(l+=e.percent,u<l)return e;return!1})(s,t.__id);return!1!==u&&u.name};exports.createFlagEngine=e=>({createUserContext:r=>((e,r)=>{let t=r;return{evaluateAll:()=>{const r={};for(const n of e)r[n.key]="enabled"===n.status&&s(n,t);return r},evaluate:r=>{const n=e.find((e=>e.key===r));return!!n&&"enabled"===n.status&&s(n,t)},setUserConfiguration:e=>{t=e}}})(e,r)});

package/dist/index.d.ts

@@ -1,4 +1,17 @@
 import { EvaluationMachine, FlagsConfiguration } from "./types";
+/**
+ * Creates a feature flag evaluation engine.
+ *
+ * @param flagsConfig - Array of flag configurations with strategies and variants
+ * @returns An evaluation machine that can create user contexts for flag evaluation
+ *
+ * @example
+ * ```ts
+ * const engine = createFlagEngine(flagsConfig);
+ * const userContext = engine.createUserContext({ __id: 'user-123', plan: 'premium' });
+ * const isEnabled = userContext.evaluate('my-feature');
+ * ```
+ */
 export declare const createFlagEngine: (flagsConfig: FlagsConfiguration) => EvaluationMachine;
 export type { FlagsConfiguration, UserConfiguration } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EAEjB,kBAAkB,EAEnB,MAAM,SAAS,CAAC;AAoCjB,eAAO,MAAM,gBAAgB,GAC3B,aAAa,kBAAkB,KAC9B,iBAKF,CAAC;AAEF,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,iBAAiB,EAEjB,kBAAkB,EAGnB,MAAM,SAAS,CAAC;AAoCjB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,gBAAgB,GAC3B,aAAa,kBAAkB,KAC9B,iBAKF,CAAC;AAEF,YAAY,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC"}

package/dist/index.mjs

@@ -1 +1 @@
-import{murmur3 as e}from"murmurhash-js";const t=e=>"string"==typeof e,n=e=>null==e,r=(e,a)=>0===e.length||e.every((e=>{if("inSegment"in e)return r(e.inSegment.rules,a);switch(e.operator){case"equals":return a[e.field]===e.value;case"not_equals":return a[e.field]!==e.value;case"greater_than":{const t=a[e.field];return!n(t)&&!n(e.value)&&t>e.value}case"less_than":{const t=a[e.field];return!n(t)&&!n(e.value)&&t<e.value}case"contains":{const n=a[e.field];return t(n)&&t(e.value)&&n.includes(e.value)}case"not_contains":{const n=a[e.field];return t(n)&&t(e.value)&&!n.includes(e.value)}case"in":{const t=a[e.field];return Array.isArray(e.value)&&-1!==e.value.indexOf(t)}case"not_in":{const t=a[e.field];return Array.isArray(e.value)&&-1===e.value.indexOf(t)}default:return!1}})),a=Math.pow(2,32),s=(t,n)=>{if(0===t.strategies.length)return!0;const s=((e,t)=>e.strategies.find((e=>r(e.rules,t))))(t,n);if(!s)return!1;if(0===s.variants.length)return!0;const u=((t,n)=>{t.variants.sort(((e,t)=>e.percent-t.percent));let r=0;const s=`${t.name}-${n}`,u=e(s),l=t.variants.find((e=>{const t=u/a*100;if(r+=e.percent,t<=r)return e}));return l||!1})(s,n.__id);return!!u&&u.name},u=e=>({createUserContext:t=>((e,t)=>{let n=t;return{evaluateAll:()=>{const t={};for(const r of e)t[r.key]="enabled"===r.status&&s(r,n);return t},evaluate:t=>{const r=e.find((e=>e.key===t));return!!r&&"disabled"!==r.status&&s(r,n)},setUserConfiguration:e=>{n=e}}})(e,t)});export{u as createFlagEngine};
+import{murmur3 as e}from"murmurhash-js";const t=e=>"string"==typeof e,r=e=>null==e,n=(e,a,s=0)=>!(s>10)&&(0===e.length||e.every((e=>{if("inSegment"in e)return n(e.inSegment.rules,a,s+1);switch(e.operator){case"equals":return a[e.field]===e.value;case"not_equals":return a[e.field]!==e.value;case"greater_than":{const t=a[e.field];return!r(t)&&!r(e.value)&&t>e.value}case"less_than":{const t=a[e.field];return!r(t)&&!r(e.value)&&t<e.value}case"contains":{const r=a[e.field];return t(r)&&t(e.value)&&r.includes(e.value)}case"not_contains":{const r=a[e.field];return!!t(e.value)&&(!t(r)||!r.includes(e.value))}case"in":{const t=a[e.field];return Array.isArray(e.value)&&-1!==e.value.indexOf(t)}case"not_in":{const t=a[e.field];return!!Array.isArray(e.value)&&-1===e.value.indexOf(t)}default:return!1}}))),a=2**32,s=(t,r)=>{if(0===t.strategies.length)return!0;const s=((e,t)=>e.strategies.find((e=>n(e.rules,t))))(t,r);if(!s)return!1;if(0===s.variants.length)return!0;const u=((t,r)=>{const n=[...t.variants].sort(((e,t)=>e.percent-t.percent)),s=`${t.name}-${r}`,u=e(s)/a*100;let l=0;for(const e of n)if(l+=e.percent,u<l)return e;return!1})(s,r.__id);return!1!==u&&u.name},u=e=>({createUserContext:t=>((e,t)=>{let r=t;return{evaluateAll:()=>{const t={};for(const n of e)t[n.key]="enabled"===n.status&&s(n,r);return t},evaluate:t=>{const n=e.find((e=>e.key===t));return!!n&&"enabled"===n.status&&s(n,r)},setUserConfiguration:e=>{r=e}}})(e,t)});export{u as createFlagEngine};

package/dist/resolveStrategyVariant.d.ts

@@ -1,3 +1,12 @@
-import { Strategy } from "./types";
-export declare const resolveStrategyVariant: (strategy: Strategy, userKey: string) => false | import("./types").Variant;
+import { Strategy, Variant } from "./types";
+/**
+ * Resolves which variant a user should see based on consistent hashing.
+ * Uses MurmurHash3 to generate a deterministic percentage for the user,
+ * then maps that to a variant based on cumulative percentages.
+ *
+ * @param strategy - The strategy containing variants with percentages
+ * @param userKey - Unique identifier for the user
+ * @returns The resolved variant, or false if no variant matches
+ */
+export declare const resolveStrategyVariant: (strategy: Strategy, userKey: string) => Variant | false;
 //# sourceMappingURL=resolveStrategyVariant.d.ts.map

package/dist/resolveStrategyVariant.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resolveStrategyVariant.d.ts","sourceRoot":"","sources":["../src/resolveStrategyVariant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAInC,eAAO,MAAM,sBAAsB,GAAI,UAAU,QAAQ,EAAE,SAAS,MAAM,sCAsBzE,CAAC"}
+{"version":3,"file":"resolveStrategyVariant.d.ts","sourceRoot":"","sources":["../src/resolveStrategyVariant.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAI5C;;;;;;;;GAQG;AACH,eAAO,MAAM,sBAAsB,GACjC,UAAU,QAAQ,EAClB,SAAS,MAAM,KACd,OAAO,GAAG,KAoBZ,CAAC"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@flag-engine/core",
   "private": false,
-  "version": "0.0.9",
+  "version": "0.0.11",
   "description": "Feature flags evaluation engine, runtime agnostic",
   "type": "module",
   "main": "./dist/index.cjs.js",

package/vitest.config.ts

@@ -3,5 +3,10 @@ import { defineConfig } from "vitest/config";
 export default defineConfig({
   test: {
     testTimeout: 15000,
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "html", "lcov"],
+      exclude: ["**/__tests__/**", "**/*.test.ts", "vitest.config.ts"],
+    },
   },
 });