flagsmith-nodejs 2.3.0 → 2.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/.vscode/launch.json +18 -0
  2. package/build/flagsmith-engine/segments/constants.d.ts +6 -0
  3. package/build/flagsmith-engine/segments/constants.js +8 -2
  4. package/build/flagsmith-engine/segments/evaluators.d.ts +2 -1
  5. package/build/flagsmith-engine/segments/evaluators.js +9 -2
  6. package/build/flagsmith-engine/segments/models.d.ts +3 -3
  7. package/build/flagsmith-engine/segments/models.js +26 -1
  8. package/build/sdk/index.js +2 -1
  9. package/examples/caching/package-lock.json +2488 -6600
  10. package/examples/caching/package.json +1 -1
  11. package/examples/custom-fetch-agent/package-lock.json +2583 -6609
  12. package/examples/custom-fetch-agent/package.json +1 -1
  13. package/examples/local-evaluation/package-lock.json +2493 -6601
  14. package/examples/local-evaluation/package.json +1 -1
  15. package/flagsmith-engine/segments/constants.ts +7 -1
  16. package/flagsmith-engine/segments/evaluators.ts +10 -6
  17. package/flagsmith-engine/segments/models.ts +15 -5
  18. package/package.json +1 -1
  19. package/sdk/index.ts +2 -1
  20. package/tests/engine/engine-tests/engine-test-data/data/environment_n9fbf9h3v4fFgH3U3ngWhb.json +12591 -0
  21. package/tests/engine/engine-tests/engine-test-data/readme.md +30 -0
  22. package/tests/engine/unit/segments/segment_evaluators.test.ts +27 -0
  23. package/tests/engine/unit/segments/segments_model.test.ts +8 -1
  24. package/tests/sdk/data/environment.json +23 -1
  25. package/tests/sdk/flagsmith-identity-flags.test.ts +18 -1
  26. package/tests/sdk/flagsmith.test.ts +25 -9
  27. package/.idea/flagsmith-nodejs-client.iml +0 -12
  28. package/.idea/modules.xml +0 -8
  29. package/.idea/vcs.xml +0 -6
  30. package/examples/api-proxy/.idea/api-proxy.iml +0 -12
  31. package/examples/api-proxy/.idea/codeStyles/Project.xml +0 -60
  32. package/examples/api-proxy/.idea/codeStyles/codeStyleConfig.xml +0 -5
  33. package/examples/api-proxy/.idea/inspectionProfiles/Project_Default.xml +0 -6
  34. package/examples/api-proxy/.idea/modules.xml +0 -8
  35. package/examples/api-proxy/.idea/vcs.xml +0 -6
@@ -0,0 +1,18 @@
1
+ {
2
+ "version": "1.0.0",
3
+ "configurations": [
4
+ {
5
+ "type": "node",
6
+ "request": "launch",
7
+ "name": "Jest: current file",
8
+ //"env": { "NODE_ENV": "test" },
9
+ "program": "${workspaceFolder}/node_modules/.bin/jest",
10
+ "args": ["${file}", "--config", "jest.config.js"],
11
+ "console": "integratedTerminal",
12
+ "disableOptimisticBPs": true,
13
+ "windows": {
14
+ "program": "${workspaceFolder}/node_modules/jest/bin/jest"
15
+ }
16
+ }
17
+ ]
18
+ }
@@ -12,6 +12,9 @@ export declare const NOT_CONTAINS = "NOT_CONTAINS";
12
12
  export declare const NOT_EQUAL = "NOT_EQUAL";
13
13
  export declare const REGEX = "REGEX";
14
14
  export declare const PERCENTAGE_SPLIT = "PERCENTAGE_SPLIT";
15
+ export declare const IS_SET = "IS_SET";
16
+ export declare const IS_NOT_SET = "IS_NOT_SET";
17
+ export declare const MODULO = "MODULO";
15
18
  export declare const CONDITION_OPERATORS: {
16
19
  EQUAL: string;
17
20
  GREATER_THAN: string;
@@ -23,4 +26,7 @@ export declare const CONDITION_OPERATORS: {
23
26
  NOT_EQUAL: string;
24
27
  REGEX: string;
25
28
  PERCENTAGE_SPLIT: string;
29
+ IS_SET: string;
30
+ IS_NOT_SET: string;
31
+ MODULO: string;
26
32
  };
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.CONDITION_OPERATORS = exports.PERCENTAGE_SPLIT = exports.REGEX = exports.NOT_EQUAL = exports.NOT_CONTAINS = exports.GREATER_THAN_INCLUSIVE = exports.CONTAINS = exports.LESS_THAN_INCLUSIVE = exports.LESS_THAN = exports.GREATER_THAN = exports.EQUAL = exports.RULE_TYPES = exports.NONE_RULE = exports.ANY_RULE = exports.ALL_RULE = void 0;
3
+ exports.CONDITION_OPERATORS = exports.MODULO = exports.IS_NOT_SET = exports.IS_SET = exports.PERCENTAGE_SPLIT = exports.REGEX = exports.NOT_EQUAL = exports.NOT_CONTAINS = exports.GREATER_THAN_INCLUSIVE = exports.CONTAINS = exports.LESS_THAN_INCLUSIVE = exports.LESS_THAN = exports.GREATER_THAN = exports.EQUAL = exports.RULE_TYPES = exports.NONE_RULE = exports.ANY_RULE = exports.ALL_RULE = void 0;
4
4
  // Segment Rules
5
5
  exports.ALL_RULE = 'ALL';
6
6
  exports.ANY_RULE = 'ANY';
@@ -17,6 +17,9 @@ exports.NOT_CONTAINS = 'NOT_CONTAINS';
17
17
  exports.NOT_EQUAL = 'NOT_EQUAL';
18
18
  exports.REGEX = 'REGEX';
19
19
  exports.PERCENTAGE_SPLIT = 'PERCENTAGE_SPLIT';
20
+ exports.IS_SET = 'IS_SET';
21
+ exports.IS_NOT_SET = 'IS_NOT_SET';
22
+ exports.MODULO = 'MODULO';
20
23
  exports.CONDITION_OPERATORS = {
21
24
  EQUAL: exports.EQUAL,
22
25
  GREATER_THAN: exports.GREATER_THAN,
@@ -27,5 +30,8 @@ exports.CONDITION_OPERATORS = {
27
30
  NOT_CONTAINS: exports.NOT_CONTAINS,
28
31
  NOT_EQUAL: exports.NOT_EQUAL,
29
32
  REGEX: exports.REGEX,
30
- PERCENTAGE_SPLIT: exports.PERCENTAGE_SPLIT
33
+ PERCENTAGE_SPLIT: exports.PERCENTAGE_SPLIT,
34
+ IS_SET: exports.IS_SET,
35
+ IS_NOT_SET: exports.IS_NOT_SET,
36
+ MODULO: exports.MODULO
31
37
  };
@@ -1,6 +1,7 @@
1
1
  import { EnvironmentModel } from '../environments/models';
2
2
  import { IdentityModel } from '../identities/models';
3
3
  import { TraitModel } from '../identities/traits/models';
4
- import { SegmentModel } from './models';
4
+ import { SegmentConditionModel, SegmentModel } from './models';
5
5
  export declare function getIdentitySegments(environment: EnvironmentModel, identity: IdentityModel, overrideTraits?: TraitModel[]): SegmentModel[];
6
6
  export declare function evaluateIdentityInSegment(identity: IdentityModel, segment: SegmentModel, overrideTraits?: TraitModel[]): boolean;
7
+ export declare function traitsMatchSegmentCondition(identityTraits: TraitModel[], condition: SegmentConditionModel, segmentId: number | string, identityId: number | string): boolean;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.evaluateIdentityInSegment = exports.getIdentitySegments = void 0;
3
+ exports.traitsMatchSegmentCondition = exports.evaluateIdentityInSegment = exports.getIdentitySegments = void 0;
4
4
  var hashing_1 = require("../utils/hashing");
5
5
  var constants_1 = require("./constants");
6
6
  function getIdentitySegments(environment, identity, overrideTraits) {
@@ -29,9 +29,16 @@ function traitsMatchSegmentRule(identityTraits, rule, segmentId, identityId) {
29
29
  }
30
30
  function traitsMatchSegmentCondition(identityTraits, condition, segmentId, identityId) {
31
31
  if (condition.operator == constants_1.PERCENTAGE_SPLIT) {
32
- return (0, hashing_1.getHashedPercentateForObjIds)([segmentId, identityId]) <= parseFloat(condition.value);
32
+ return (0, hashing_1.getHashedPercentateForObjIds)([segmentId, identityId]) <= parseFloat(String(condition.value));
33
33
  }
34
34
  var traits = identityTraits.filter(function (t) { return t.traitKey === condition.property_; });
35
35
  var trait = traits.length > 0 ? traits[0] : undefined;
36
+ if (condition.operator === constants_1.IS_SET) {
37
+ return !!trait;
38
+ }
39
+ else if (condition.operator === constants_1.IS_NOT_SET) {
40
+ return trait == undefined;
41
+ }
36
42
  return trait ? condition.matchesTraitValue(trait.traitValue) : false;
37
43
  }
44
+ exports.traitsMatchSegmentCondition = traitsMatchSegmentCondition;
@@ -15,9 +15,9 @@ export declare class SegmentConditionModel {
15
15
  [key: string]: string;
16
16
  };
17
17
  operator: string;
18
- value: string;
19
- property_: string | undefined;
20
- constructor(operator: string, value: string, property?: string);
18
+ value: string | null | undefined;
19
+ property_: string | null | undefined;
20
+ constructor(operator: string, value?: string | null | undefined, property?: string | null | undefined);
21
21
  matchesTraitValue(traitValue: any): any;
22
22
  }
23
23
  export declare class SegmentRuleModel {
@@ -10,6 +10,22 @@ var __assign = (this && this.__assign) || function () {
10
10
  };
11
11
  return __assign.apply(this, arguments);
12
12
  };
13
+ var __read = (this && this.__read) || function (o, n) {
14
+ var m = typeof Symbol === "function" && o[Symbol.iterator];
15
+ if (!m) return o;
16
+ var i = m.call(o), r, ar = [], e;
17
+ try {
18
+ while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
19
+ }
20
+ catch (error) { e = { error: error }; }
21
+ finally {
22
+ try {
23
+ if (r && !r.done && (m = i["return"])) m.call(i);
24
+ }
25
+ finally { if (e) throw e.error; }
26
+ }
27
+ return ar;
28
+ };
13
29
  var __importDefault = (this && this.__importDefault) || function (mod) {
14
30
  return (mod && mod.__esModule) ? mod : { "default": mod };
15
31
  };
@@ -52,6 +68,7 @@ var SegmentConditionModel = /** @class */ (function () {
52
68
  this.EXCEPTION_OPERATOR_METHODS = (_a = {},
53
69
  _a[constants_1.NOT_CONTAINS] = 'evaluateNotContains',
54
70
  _a[constants_1.REGEX] = 'evaluateRegex',
71
+ _a[constants_1.MODULO] = 'evaluateModulo',
55
72
  _a);
56
73
  this.operator = operator;
57
74
  this.value = value;
@@ -64,7 +81,15 @@ var SegmentConditionModel = /** @class */ (function () {
64
81
  return !traitValue.includes(_this.value);
65
82
  },
66
83
  evaluateRegex: function (traitValue) {
67
- return !!traitValue.match(new RegExp(_this.value));
84
+ return !!_this.value && !!traitValue.match(new RegExp(_this.value));
85
+ },
86
+ evaluateModulo: function (traitValue) {
87
+ if (isNaN(parseFloat(traitValue)) || !_this.value) {
88
+ return false;
89
+ }
90
+ var parts = (_this.value).split("|");
91
+ var _a = __read([parseFloat(parts[0]), parseFloat(parts[1])], 2), divisor = _a[0], reminder = _a[1];
92
+ return traitValue % divisor === reminder;
68
93
  }
69
94
  };
70
95
  // TODO: move this logic to the evaluator module
@@ -415,7 +415,8 @@ var Flagsmith = /** @class */ (function () {
415
415
  flags = models_3.Flags.fromFeatureStateModels({
416
416
  featureStates: featureStates,
417
417
  analyticsProcessor: this.analyticsProcessor,
418
- defaultFlagHandler: this.defaultFlagHandler
418
+ defaultFlagHandler: this.defaultFlagHandler,
419
+ identityID: identityModel.djangoID || identityModel.identityUuid
419
420
  });
420
421
  if (!!!this.cache) return [3 /*break*/, 2];
421
422
  // @ts-ignore node-cache types are incorrect, ttl should be optional