@naturalcycles/abba 1.15.1 → 1.15.3

package/dist/types.d.ts

@@ -49,9 +49,27 @@ export declare enum AssignmentStatus {
 }
 export interface SegmentationRule {
     key: string;
-    operator: '==' | '!=' | 'semver' | 'regex' | 'boolean';
-    value: string | boolean | number;
+    operator: SegmentationRuleOperator;
+    value: string;
 }
+export declare enum SegmentationRuleOperator {
+    IsSet = "isSet",
+    IsNotSet = "isNotSet",
+    EqualsText = "equalsText",
+    NotEqualsText = "notEqualsText",
+    Semver = "semver",
+    Regex = "regex",
+    Boolean = "boolean",
+    /**
+     * @deprecated
+     */
+    Equals = "==",
+    /**
+     * @deprecated
+     */
+    NotEquals = "!="
+}
+export type SegmentationRuleFn = (segmentationProp: string | boolean | number | null | undefined, ruleValue: SegmentationRule['value']) => boolean;
 export interface AssignmentStatistics {
     sampled: number;
     buckets: {

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AssignmentStatus = void 0;
+exports.SegmentationRuleOperator = exports.AssignmentStatus = void 0;
 var AssignmentStatus;
 (function (AssignmentStatus) {
     /**
@@ -16,3 +16,22 @@ var AssignmentStatus;
      */
     AssignmentStatus[AssignmentStatus["Inactive"] = 3] = "Inactive";
 })(AssignmentStatus = exports.AssignmentStatus || (exports.AssignmentStatus = {}));
+var SegmentationRuleOperator;
+(function (SegmentationRuleOperator) {
+    SegmentationRuleOperator["IsSet"] = "isSet";
+    SegmentationRuleOperator["IsNotSet"] = "isNotSet";
+    SegmentationRuleOperator["EqualsText"] = "equalsText";
+    SegmentationRuleOperator["NotEqualsText"] = "notEqualsText";
+    SegmentationRuleOperator["Semver"] = "semver";
+    SegmentationRuleOperator["Regex"] = "regex";
+    /* eslint-disable id-blacklist*/
+    SegmentationRuleOperator["Boolean"] = "boolean";
+    /**
+     * @deprecated
+     */
+    SegmentationRuleOperator["Equals"] = "==";
+    /**
+     * @deprecated
+     */
+    SegmentationRuleOperator["NotEquals"] = "!=";
+})(SegmentationRuleOperator = exports.SegmentationRuleOperator || (exports.SegmentationRuleOperator = {}));

package/dist/util.d.ts

@@ -1,5 +1,5 @@
 import { Saved } from '@naturalcycles/js-lib';
-import { Bucket, ExclusionSet, Experiment, ExperimentWithBuckets, SegmentationData, SegmentationRule, UserAssignment } from './types';
+import { Bucket, ExclusionSet, Experiment, ExperimentWithBuckets, SegmentationData, SegmentationRule, SegmentationRuleFn, SegmentationRuleOperator, UserAssignment } from './types';
 /**
  * Generate a new assignment for a given user.
  * Doesn't save it.
@@ -30,9 +30,9 @@ export declare const validateTotalBucketRatio: (buckets: Bucket[]) => void;
  */
 export declare const validateSegmentationRules: (rules: SegmentationRule[], segmentationData: SegmentationData) => boolean;
 /**
- * Validate a users segmentation data against a single rule
+ * Map of segmentation rule validators
  */
-export declare const validateSegmentationRule: (rule: SegmentationRule, data: SegmentationData) => boolean;
+export declare const segmentationRuleMap: Record<SegmentationRuleOperator, SegmentationRuleFn>;
 /**
  * Returns true if an experiment is able to generate new assignments based on status and start/end dates
  */

package/dist/util.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getUserExclusionSet = exports.canGenerateNewAssignments = exports.validateSegmentationRule = exports.validateSegmentationRules = exports.validateTotalBucketRatio = exports.determineBucket = exports.determineAssignment = exports.rollDie = exports.generateUserAssignmentData = void 0;
+exports.getUserExclusionSet = exports.canGenerateNewAssignments = exports.segmentationRuleMap = exports.validateSegmentationRules = exports.validateTotalBucketRatio = exports.determineBucket = exports.determineAssignment = exports.rollDie = exports.generateUserAssignmentData = void 0;
 const js_lib_1 = require("@naturalcycles/js-lib");
 const semver_1 = require("semver");
 const types_1 = require("./types");
@@ -81,35 +81,46 @@ exports.validateTotalBucketRatio = validateTotalBucketRatio;
  */
 const validateSegmentationRules = (rules, segmentationData) => {
     for (const rule of rules) {
-        if (!(0, exports.validateSegmentationRule)(rule, segmentationData))
+        const { key, value, operator } = rule;
+        if (!exports.segmentationRuleMap[operator](segmentationData[key], value))
             return false;
     }
     return true;
 };
 exports.validateSegmentationRules = validateSegmentationRules;
 /**
- * Validate a users segmentation data against a single rule
+ * Map of segmentation rule validators
  */
-const validateSegmentationRule = (rule, data) => {
-    const { key, value, operator } = rule;
-    if (operator === '==') {
-        return data[key] === value;
-    }
-    else if (operator === '!=') {
-        return data[key] !== value;
-    }
-    else if (operator === 'semver') {
-        return (0, semver_1.satisfies)(data[key]?.toString() || '', value.toString());
-    }
-    else if (operator === 'regex') {
-        return new RegExp(value.toString()).test(data[key]?.toString() || '');
-    }
-    else if (operator === 'boolean') {
-        return Boolean(value) === data[key];
-    }
-    return false;
+exports.segmentationRuleMap = {
+    [types_1.SegmentationRuleOperator.IsSet](keyValue) {
+        return !!keyValue;
+    },
+    [types_1.SegmentationRuleOperator.IsNotSet](keyValue) {
+        return !keyValue;
+    },
+    [types_1.SegmentationRuleOperator.EqualsText](keyValue, ruleValue) {
+        return keyValue?.toString() === ruleValue.toString();
+    },
+    [types_1.SegmentationRuleOperator.NotEqualsText](keyValue, ruleValue) {
+        return keyValue?.toString() !== ruleValue.toString();
+    },
+    [types_1.SegmentationRuleOperator.Semver](keyValue, ruleValue) {
+        return (0, semver_1.satisfies)(keyValue?.toString() || '', ruleValue.toString());
+    },
+    [types_1.SegmentationRuleOperator.Regex](keyValue, ruleValue) {
+        return new RegExp(`${ruleValue}`).test(keyValue?.toString() || '');
+    },
+    [types_1.SegmentationRuleOperator.Boolean](keyValue, ruleValue) {
+        // If it's true, then must be true
+        if (ruleValue === 'true')
+            return keyValue === 'true';
+        // Anything else cannot be true
+        return keyValue !== 'true';
+    },
+    // Deprecated
+    [types_1.SegmentationRuleOperator.Equals]: (keyValue, ruleValue) => keyValue === ruleValue,
+    [types_1.SegmentationRuleOperator.NotEquals]: (keyValue, ruleValue) => keyValue !== ruleValue,
 };
-exports.validateSegmentationRule = validateSegmentationRule;
 /**
  * Returns true if an experiment is able to generate new assignments based on status and start/end dates
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@naturalcycles/abba",
-  "version": "1.15.1",
+  "version": "1.15.3",
   "scripts": {
     "prepare": "husky install",
     "build": "build",
@@ -14,7 +14,7 @@
   },
   "devDependencies": {
     "@naturalcycles/dev-lib": "^13.15.0",
-    "@types/node": "^18.11.18",
+    "@types/node": "^20.2.4",
     "@types/semver": "^7.3.9",
     "jest": "^29.3.1"
   },

package/src/types.ts

@@ -60,10 +60,34 @@ export enum AssignmentStatus {
 
 export interface SegmentationRule {
   key: string
-  operator: '==' | '!=' | 'semver' | 'regex' | 'boolean'
-  value: string | boolean | number
+  operator: SegmentationRuleOperator
+  value: string
 }
 
+export enum SegmentationRuleOperator {
+  IsSet = 'isSet',
+  IsNotSet = 'isNotSet',
+  EqualsText = 'equalsText',
+  NotEqualsText = 'notEqualsText',
+  Semver = 'semver',
+  Regex = 'regex',
+  /* eslint-disable id-blacklist*/
+  Boolean = 'boolean',
+  /**
+   * @deprecated
+   */
+  Equals = '==',
+  /**
+   * @deprecated
+   */
+  NotEquals = '!=',
+}
+
+export type SegmentationRuleFn = (
+  segmentationProp: string | boolean | number | null | undefined,
+  ruleValue: SegmentationRule['value'],
+) => boolean
+
 export interface AssignmentStatistics {
   sampled: number
   buckets: {

package/src/util.ts

@@ -8,6 +8,8 @@ import {
   ExperimentWithBuckets,
   SegmentationData,
   SegmentationRule,
+  SegmentationRuleFn,
+  SegmentationRuleOperator,
   UserAssignment,
 } from './types'
 
@@ -99,31 +101,43 @@ export const validateSegmentationRules = (
   segmentationData: SegmentationData,
 ): boolean => {
   for (const rule of rules) {
-    if (!validateSegmentationRule(rule, segmentationData)) return false
+    const { key, value, operator } = rule
+    if (!segmentationRuleMap[operator](segmentationData[key], value)) return false
   }
   return true
 }
 
 /**
- * Validate a users segmentation data against a single rule
+ * Map of segmentation rule validators
  */
-export const validateSegmentationRule = (
-  rule: SegmentationRule,
-  data: SegmentationData,
-): boolean => {
-  const { key, value, operator } = rule
-  if (operator === '==') {
-    return data[key] === value
-  } else if (operator === '!=') {
-    return data[key] !== value
-  } else if (operator === 'semver') {
-    return satisfies(data[key]?.toString() || '', value.toString())
-  } else if (operator === 'regex') {
-    return new RegExp(value.toString()).test(data[key]?.toString() || '')
-  } else if (operator === 'boolean') {
-    return Boolean(value) === data[key]
-  }
-  return false
+export const segmentationRuleMap: Record<SegmentationRuleOperator, SegmentationRuleFn> = {
+  [SegmentationRuleOperator.IsSet](keyValue) {
+    return !!keyValue
+  },
+  [SegmentationRuleOperator.IsNotSet](keyValue) {
+    return !keyValue
+  },
+  [SegmentationRuleOperator.EqualsText](keyValue, ruleValue) {
+    return keyValue?.toString() === ruleValue.toString()
+  },
+  [SegmentationRuleOperator.NotEqualsText](keyValue, ruleValue) {
+    return keyValue?.toString() !== ruleValue.toString()
+  },
+  [SegmentationRuleOperator.Semver](keyValue, ruleValue) {
+    return satisfies(keyValue?.toString() || '', ruleValue.toString())
+  },
+  [SegmentationRuleOperator.Regex](keyValue, ruleValue) {
+    return new RegExp(`${ruleValue}`).test(keyValue?.toString() || '')
+  },
+  [SegmentationRuleOperator.Boolean](keyValue, ruleValue) {
+    // If it's true, then must be true
+    if (ruleValue === 'true') return keyValue === 'true'
+    // Anything else cannot be true
+    return keyValue !== 'true'
+  },
+  // Deprecated
+  [SegmentationRuleOperator.Equals]: (keyValue, ruleValue) => keyValue === ruleValue,
+  [SegmentationRuleOperator.NotEquals]: (keyValue, ruleValue) => keyValue !== ruleValue,
 }
 
 /**