flagsmith-nodejs 2.2.2 → 2.4.0

package/build/flagsmith-engine/segments/constants.d.ts

@@ -12,6 +12,9 @@ export declare const NOT_CONTAINS = "NOT_CONTAINS";
 export declare const NOT_EQUAL = "NOT_EQUAL";
 export declare const REGEX = "REGEX";
 export declare const PERCENTAGE_SPLIT = "PERCENTAGE_SPLIT";
+export declare const IS_SET = "IS_SET";
+export declare const IS_NOT_SET = "IS_NOT_SET";
+export declare const MODULO = "MODULO";
 export declare const CONDITION_OPERATORS: {
     EQUAL: string;
     GREATER_THAN: string;
@@ -23,4 +26,7 @@ export declare const CONDITION_OPERATORS: {
     NOT_EQUAL: string;
     REGEX: string;
     PERCENTAGE_SPLIT: string;
+    IS_SET: string;
+    IS_NOT_SET: string;
+    MODULO: string;
 };

package/build/flagsmith-engine/segments/constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
+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;
 // Segment Rules
 exports.ALL_RULE = 'ALL';
 exports.ANY_RULE = 'ANY';
@@ -17,6 +17,9 @@ exports.NOT_CONTAINS = 'NOT_CONTAINS';
 exports.NOT_EQUAL = 'NOT_EQUAL';
 exports.REGEX = 'REGEX';
 exports.PERCENTAGE_SPLIT = 'PERCENTAGE_SPLIT';
+exports.IS_SET = 'IS_SET';
+exports.IS_NOT_SET = 'IS_NOT_SET';
+exports.MODULO = 'MODULO';
 exports.CONDITION_OPERATORS = {
     EQUAL: exports.EQUAL,
     GREATER_THAN: exports.GREATER_THAN,
@@ -27,5 +30,8 @@ exports.CONDITION_OPERATORS = {
     NOT_CONTAINS: exports.NOT_CONTAINS,
     NOT_EQUAL: exports.NOT_EQUAL,
     REGEX: exports.REGEX,
-    PERCENTAGE_SPLIT: exports.PERCENTAGE_SPLIT
+    PERCENTAGE_SPLIT: exports.PERCENTAGE_SPLIT,
+    IS_SET: exports.IS_SET,
+    IS_NOT_SET: exports.IS_NOT_SET,
+    MODULO: exports.MODULO
 };

package/build/flagsmith-engine/segments/evaluators.d.ts

@@ -1,6 +1,7 @@
 import { EnvironmentModel } from '../environments/models';
 import { IdentityModel } from '../identities/models';
 import { TraitModel } from '../identities/traits/models';
-import { SegmentModel } from './models';
+import { SegmentConditionModel, SegmentModel } from './models';
 export declare function getIdentitySegments(environment: EnvironmentModel, identity: IdentityModel, overrideTraits?: TraitModel[]): SegmentModel[];
 export declare function evaluateIdentityInSegment(identity: IdentityModel, segment: SegmentModel, overrideTraits?: TraitModel[]): boolean;
+export declare function traitsMatchSegmentCondition(identityTraits: TraitModel[], condition: SegmentConditionModel, segmentId: number | string, identityId: number | string): boolean;

package/build/flagsmith-engine/segments/evaluators.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.evaluateIdentityInSegment = exports.getIdentitySegments = void 0;
+exports.traitsMatchSegmentCondition = exports.evaluateIdentityInSegment = exports.getIdentitySegments = void 0;
 var hashing_1 = require("../utils/hashing");
 var constants_1 = require("./constants");
 function getIdentitySegments(environment, identity, overrideTraits) {
@@ -29,9 +29,16 @@ function traitsMatchSegmentRule(identityTraits, rule, segmentId, identityId) {
 }
 function traitsMatchSegmentCondition(identityTraits, condition, segmentId, identityId) {
     if (condition.operator == constants_1.PERCENTAGE_SPLIT) {
-        return (0, hashing_1.getHashedPercentateForObjIds)([segmentId, identityId]) <= parseFloat(condition.value);
+        return (0, hashing_1.getHashedPercentateForObjIds)([segmentId, identityId]) <= parseFloat(String(condition.value));
     }
     var traits = identityTraits.filter(function (t) { return t.traitKey === condition.property_; });
     var trait = traits.length > 0 ? traits[0] : undefined;
+    if (condition.operator === constants_1.IS_SET) {
+        return !!trait;
+    }
+    else if (condition.operator === constants_1.IS_NOT_SET) {
+        return trait == undefined;
+    }
     return trait ? condition.matchesTraitValue(trait.traitValue) : false;
 }
+exports.traitsMatchSegmentCondition = traitsMatchSegmentCondition;

package/build/flagsmith-engine/segments/models.d.ts

@@ -15,9 +15,9 @@ export declare class SegmentConditionModel {
         [key: string]: string;
     };
     operator: string;
-    value: string;
-    property_: string | undefined;
-    constructor(operator: string, value: string, property?: string);
+    value: string | null | undefined;
+    property_: string | null | undefined;
+    constructor(operator: string, value?: string | null | undefined, property?: string | null | undefined);
     matchesTraitValue(traitValue: any): any;
 }
 export declare class SegmentRuleModel {

package/build/flagsmith-engine/segments/models.js

@@ -10,6 +10,22 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -52,6 +68,7 @@ var SegmentConditionModel = /** @class */ (function () {
         this.EXCEPTION_OPERATOR_METHODS = (_a = {},
             _a[constants_1.NOT_CONTAINS] = 'evaluateNotContains',
             _a[constants_1.REGEX] = 'evaluateRegex',
+            _a[constants_1.MODULO] = 'evaluateModulo',
             _a);
         this.operator = operator;
         this.value = value;
@@ -64,7 +81,15 @@ var SegmentConditionModel = /** @class */ (function () {
                 return !traitValue.includes(_this.value);
             },
             evaluateRegex: function (traitValue) {
-                return !!traitValue.match(new RegExp(_this.value));
+                return !!_this.value && !!traitValue.match(new RegExp(_this.value));
+            },
+            evaluateModulo: function (traitValue) {
+                if (isNaN(parseFloat(traitValue)) || !_this.value) {
+                    return false;
+                }
+                var parts = (_this.value).split("|");
+                var _a = __read([parseFloat(parts[0]), parseFloat(parts[1])], 2), divisor = _a[0], reminder = _a[1];
+                return traitValue % divisor === reminder;
             }
         };
         // TODO: move this logic to the evaluator module

package/build/sdk/index.d.ts

@@ -1,13 +1,14 @@
+import { RequestInit } from "node-fetch";
 import { EnvironmentModel } from '../flagsmith-engine/environments/models';
 import { DefaultFlag, Flags } from './models';
 import { EnvironmentDataPollingManager } from './polling_manager';
 import { SegmentModel } from '../flagsmith-engine/segments/models';
-import { FlagsmithCache } from './types';
+import { FlagsmithConfig } from './types';
 export { AnalyticsProcessor } from './analytics';
 export { FlagsmithAPIError, FlagsmithClientError } from './errors';
 export { DefaultFlag, Flags } from './models';
 export { EnvironmentDataPollingManager } from './polling_manager';
-export { FlagsmithCache } from './types';
+export { FlagsmithCache, FlagsmithConfig } from './types';
 export declare class Flagsmith {
     environmentKey?: string;
     apiUrl: string;
@@ -15,6 +16,7 @@ export declare class Flagsmith {
         [key: string]: any;
     };
     requestTimeoutSeconds?: number;
+    agent: RequestInit['agent'];
     requestTimeoutMs?: number;
     enableLocalEvaluation?: boolean;
     environmentRefreshIntervalSeconds: number;
@@ -59,21 +61,7 @@ export declare class Flagsmith {
             flags cannot be retrieved from the API or a non existent feature is
             requested
      */
-    constructor(data: {
-        environmentKey: string;
-        apiUrl?: string;
-        customHeaders?: {
-            [key: string]: any;
-        };
-        requestTimeoutSeconds?: number;
-        enableLocalEvaluation?: boolean;
-        environmentRefreshIntervalSeconds?: number;
-        retries?: number;
-        enableAnalytics?: boolean;
-        defaultFlagHandler?: (featureName: string) => DefaultFlag;
-        cache?: FlagsmithCache;
-        onEnvironmentChange?: (error: Error | null, result: EnvironmentModel) => void;
-    });
+    constructor(data: FlagsmithConfig);
     /**
      * Get all the default for flags for the current environment.
      *

package/build/sdk/index.js

@@ -121,6 +121,7 @@ var Flagsmith = /** @class */ (function () {
         this.enableLocalEvaluation = false;
         this.environmentRefreshIntervalSeconds = 60;
         this.enableAnalytics = false;
+        this.agent = data.agent;
         this.environmentKey = data.environmentKey;
         this.apiUrl = data.apiUrl || this.apiUrl;
         this.customHeaders = data.customHeaders;
@@ -348,6 +349,7 @@ var Flagsmith = /** @class */ (function () {
                             }
                         }
                         return [4 /*yield*/, (0, utils_1.retryFetch)(url, {
+                                agent: this.agent,
                                 method: method,
                                 timeout: this.requestTimeoutMs || undefined,
                                 body: JSON.stringify(body),

package/build/sdk/types.d.ts

@@ -1,7 +1,25 @@
-import { Flags } from "./models";
+import { DefaultFlag, Flags } from "./models";
+import { EnvironmentModel } from "../flagsmith-engine";
+import { RequestInit } from "node-fetch";
 export interface FlagsmithCache {
     get(key: string): Promise<Flags | undefined> | undefined;
     set(key: string, value: Flags, ttl: string | number): boolean | Promise<boolean>;
     has(key: string): boolean | Promise<boolean>;
     [key: string]: any;
 }
+export interface FlagsmithConfig {
+    environmentKey: string;
+    apiUrl?: string;
+    agent?: RequestInit['agent'];
+    customHeaders?: {
+        [key: string]: any;
+    };
+    requestTimeoutSeconds?: number;
+    enableLocalEvaluation?: boolean;
+    environmentRefreshIntervalSeconds?: number;
+    retries?: number;
+    enableAnalytics?: boolean;
+    defaultFlagHandler?: (featureName: string) => DefaultFlag;
+    cache?: FlagsmithCache;
+    onEnvironmentChange?: (error: Error | null, result: EnvironmentModel) => void;
+}

package/build/sdk/utils.d.ts

@@ -1,4 +1,4 @@
-import { Response } from 'node-fetch';
+import { RequestInit, Response } from 'node-fetch';
 export declare function generateIdentitiesData(identifier: string, traits: {
     [key: string]: any;
 }): {
@@ -9,4 +9,4 @@ export declare function generateIdentitiesData(identifier: string, traits: {
     }[];
 };
 export declare const delay: (ms: number) => Promise<unknown>;
-export declare const retryFetch: (url: string, fetchOptions: any, retries?: number, timeout?: number | undefined) => Promise<Response>;
+export declare const retryFetch: (url: string, fetchOptions: RequestInit, retries?: number, timeout?: number | undefined) => Promise<Response>;

package/examples/api-proxy/README.md

@@ -0,0 +1,12 @@
+<img width="100%" src="https://github.com/Flagsmith/flagsmith/raw/main/static-files/hero.png"/>
+
+# Flagsmith Node.js example with custom fetch agent
+
+This is a simple Flagsmith Node.js example in local evaluation modes with a custom fetch agent. Using a custom fetch agent lets allows you to specify networking related options such as keep alive and socket timeout, read more on this [here](https://github.com/node-fetch/node-fetch#custom-agent).
+
+## Running the example
+
+```shell
+npm i
+npm run dev
+```