flagsmith-nodejs 3.3.3 → 4.0.0

package/build/esm/sdk/utils.js

@@ -0,0 +1,56 @@
+export function isTraitConfig(traitValue) {
+    return !!traitValue && typeof traitValue == 'object' && traitValue.value !== undefined;
+}
+export function generateIdentitiesData(identifier, traits, transient) {
+    const traitsGenerated = Object.entries(traits).map(([key, value]) => {
+        if (isTraitConfig(value)) {
+            return {
+                trait_key: key,
+                trait_value: value?.value,
+                transient: value?.transient,
+            };
+        }
+        else {
+            return {
+                trait_key: key,
+                trait_value: value,
+            };
+        }
+    });
+    if (transient) {
+        return {
+            identifier: identifier,
+            traits: traitsGenerated,
+            transient: true
+        };
+    }
+    return {
+        identifier: identifier,
+        traits: traitsGenerated
+    };
+}
+export const delay = (ms) => new Promise(resolve => setTimeout(() => resolve(undefined), ms));
+export const retryFetch = (url, 
+// built-in RequestInit type doesn't have dispatcher/agent
+fetchOptions, retries = 3, timeoutMs = 10, // set an overall timeout for this function
+customFetch) => {
+    return new Promise((resolve, reject) => {
+        const retryWrapper = (n) => {
+            customFetch(url, {
+                ...fetchOptions,
+                signal: AbortSignal.timeout(timeoutMs)
+            })
+                .then(res => resolve(res))
+                .catch(async (err) => {
+                if (n > 0) {
+                    await delay(1000);
+                    retryWrapper(--n);
+                }
+                else {
+                    reject(err);
+                }
+            });
+        };
+        retryWrapper(retries);
+    });
+};

package/flagsmith-engine/environments/models.ts

@@ -1,6 +1,6 @@
-import { FeatureStateModel } from '../features/models';
-import { IdentityModel } from '../identities/models';
-import { ProjectModel } from '../projects/models';
+import { FeatureStateModel } from '../features/models.js';
+import { IdentityModel } from '../identities/models.js';
+import { ProjectModel } from '../projects/models.js';
 
 export class EnvironmentAPIKeyModel {
     id: number;

package/flagsmith-engine/environments/util.ts

@@ -1,7 +1,7 @@
-import { buildFeatureStateModel } from '../features/util';
-import { buildIdentityModel } from '../identities/util';
-import { buildProjectModel } from '../projects/util';
-import { EnvironmentAPIKeyModel, EnvironmentModel } from './models';
+import { buildFeatureStateModel } from '../features/util.js';
+import { buildIdentityModel } from '../identities/util.js';
+import { buildProjectModel } from '../projects/util.js';
+import { EnvironmentAPIKeyModel, EnvironmentModel } from './models.js';
 
 export function buildEnvironmentModel(environmentJSON: any) {
     const project = buildProjectModel(environmentJSON.project);

package/flagsmith-engine/features/models.ts

@@ -1,5 +1,5 @@
-import { v4 as uuidv4 } from 'uuid';
-import { getHashedPercentateForObjIds } from '../utils/hashing';
+import { randomUUID as uuidv4 } from "node:crypto";
+import { getHashedPercentateForObjIds } from '../utils/hashing/index.js';
 
 export class FeatureModel {
     id: number;

package/flagsmith-engine/features/util.ts

@@ -4,7 +4,7 @@ import {
     FeatureStateModel,
     MultivariateFeatureOptionModel,
     MultivariateFeatureStateValueModel
-} from './models';
+} from './models.js';
 
 export function buildFeatureModel(featuresModelJSON: any): FeatureModel {
     return new FeatureModel(featuresModelJSON.id, featuresModelJSON.name, featuresModelJSON.type);

package/flagsmith-engine/identities/models.ts

@@ -1,8 +1,7 @@
-import { FeatureStateModel } from '../features/models';
-import { IdentityFeaturesList } from '../utils/collections';
-import { TraitModel } from './traits/models';
+import { IdentityFeaturesList } from '../utils/collections.js';
+import { TraitModel } from './traits/models.js';
 
-const { v4: uuidv4 } = require('uuid');
+import { randomUUID as uuidv4 } from 'node:crypto';
 
 export class IdentityModel {
     identifier: string;
@@ -20,7 +19,7 @@ export class IdentityModel {
         environmentApiKey: string,
         identifier: string,
         identityUuid?: string,
-        djangoID?: number
+        djangoID?: number,
     ) {
         this.identityUuid = identityUuid || uuidv4();
         this.createdDate = Date.parse(created_date) || Date.now();

package/flagsmith-engine/identities/traits/models.ts

@@ -1,7 +1,6 @@
 export class TraitModel {
     traitKey: string;
     traitValue: any;
-
     constructor(key: string, value: any) {
         this.traitKey = key;
         this.traitValue = value;

package/flagsmith-engine/identities/util.ts

@@ -1,7 +1,7 @@
-import { buildFeatureStateModel } from '../features/util';
-import { IdentityFeaturesList } from '../utils/collections';
-import { IdentityModel } from './models';
-import { TraitModel } from './traits/models';
+import { buildFeatureStateModel } from '../features/util.js';
+import { IdentityFeaturesList } from '../utils/collections.js';
+import { IdentityModel } from './models.js';
+import { TraitModel } from './traits/models.js';
 
 export function buildTraitModel(traitJSON: any): TraitModel {
     return new TraitModel(traitJSON.trait_key, traitJSON.trait_value);

package/flagsmith-engine/index.ts

@@ -1,17 +1,17 @@
-import { EnvironmentModel } from './environments/models';
-import { FeatureStateModel } from './features/models';
-import { IdentityModel } from './identities/models';
-import { TraitModel } from './identities/traits/models';
-import { getIdentitySegments } from './segments/evaluators';
-import { SegmentModel } from './segments/models';
-import { FeatureStateNotFound } from './utils/errors';
+import { EnvironmentModel } from './environments/models.js';
+import { FeatureStateModel } from './features/models.js';
+import { IdentityModel } from './identities/models.js';
+import { TraitModel } from './identities/traits/models.js';
+import { getIdentitySegments } from './segments/evaluators.js';
+import { SegmentModel } from './segments/models.js';
+import { FeatureStateNotFound } from './utils/errors.js';
 
-export { EnvironmentModel } from './environments/models';
-export { FeatureStateModel } from './features/models';
-export { IdentityModel } from './identities/models';
-export { TraitModel } from './identities/traits/models';
-export { SegmentModel } from './segments/models';
-export { OrganisationModel } from './organisations/models';
+export { EnvironmentModel } from './environments/models.js';
+export { FeatureStateModel } from './features/models.js';
+export { IdentityModel } from './identities/models.js';
+export { TraitModel } from './identities/traits/models.js';
+export { SegmentModel } from './segments/models.js';
+export { OrganisationModel } from './organisations/models.js';
 
 function getIdentityFeatureStatesDict(
     environment: EnvironmentModel,

package/flagsmith-engine/organisations/util.ts

@@ -1,4 +1,4 @@
-import { OrganisationModel } from './models';
+import { OrganisationModel } from './models.js';
 
 export function buildOrganizationModel(organizationJSON: any): OrganisationModel {
     return new OrganisationModel(

package/flagsmith-engine/projects/models.ts

@@ -1,5 +1,5 @@
-import { OrganisationModel } from '../organisations/models';
-import { SegmentModel } from '../segments/models';
+import { OrganisationModel } from '../organisations/models.js';
+import { SegmentModel } from '../segments/models.js';
 
 export class ProjectModel {
     id: number;

package/flagsmith-engine/projects/util.ts

@@ -1,7 +1,7 @@
-import { buildOrganizationModel } from '../organisations/util';
-import { SegmentModel } from '../segments/models';
-import { buildSegmentModel } from '../segments/util';
-import { ProjectModel } from './models';
+import { buildOrganizationModel } from '../organisations/util.js';
+import { SegmentModel } from '../segments/models.js';
+import { buildSegmentModel } from '../segments/util.js';
+import { ProjectModel } from './models.js';
 
 export function buildProjectModel(projectJSON: any): ProjectModel {
     const segments: SegmentModel[] = projectJSON['segments']

package/flagsmith-engine/segments/evaluators.ts

@@ -1,9 +1,9 @@
-import { EnvironmentModel } from '../environments/models';
-import { IdentityModel } from '../identities/models';
-import { TraitModel } from '../identities/traits/models';
-import { getHashedPercentateForObjIds } from '../utils/hashing';
-import { PERCENTAGE_SPLIT, IS_SET, IS_NOT_SET } from './constants';
-import { SegmentConditionModel, SegmentModel, SegmentRuleModel } from './models';
+import { EnvironmentModel } from '../environments/models.js';
+import { IdentityModel } from '../identities/models.js';
+import { TraitModel } from '../identities/traits/models.js';
+import { getHashedPercentateForObjIds } from '../utils/hashing/index.js';
+import { PERCENTAGE_SPLIT, IS_SET, IS_NOT_SET } from './constants.js';
+import { SegmentConditionModel, SegmentModel, SegmentRuleModel } from './models.js';
 
 export function getIdentitySegments(
     environment: EnvironmentModel,

package/flagsmith-engine/segments/models.ts

@@ -1,7 +1,7 @@
-import semver from 'semver';
+import * as semver from 'semver';
 
-import { FeatureStateModel } from '../features/models';
-import { getCastingFunction as getCastingFunction } from '../utils';
+import { FeatureStateModel } from '../features/models.js';
+import { getCastingFunction as getCastingFunction } from '../utils/index.js';
 import {
     ALL_RULE,
     ANY_RULE,
@@ -11,8 +11,8 @@ import {
     MODULO,
     IN,
     CONDITION_OPERATORS
-} from './constants';
-import { isSemver } from './util';
+} from './constants.js';
+import { isSemver } from './util.js';
 
 export const all = (iterable: Array<any>) => iterable.filter(e => !!e).length === iterable.length;
 export const any = (iterable: Array<any>) => iterable.filter(e => !!e).length > 0;

package/flagsmith-engine/segments/util.ts

@@ -1,5 +1,5 @@
-import { buildFeatureStateModel } from '../features/util';
-import { SegmentConditionModel, SegmentModel, SegmentRuleModel } from './models';
+import { buildFeatureStateModel } from '../features/util.js';
+import { SegmentConditionModel, SegmentModel, SegmentRuleModel } from './models.js';
 
 export function buildSegmentConditionModel(segmentConditionJSON: any): SegmentConditionModel {
     return new SegmentConditionModel(
@@ -34,4 +34,4 @@ export function isSemver(value: any) {
 
 export function removeSemverSuffix(value: string) {
     return value.replace(':semver', '');
-}
+}

package/flagsmith-engine/utils/collections.ts

@@ -1,3 +1,3 @@
-import { FeatureStateModel } from '../features/models';
+import { FeatureStateModel } from '../features/models.js';
 
 export class IdentityFeaturesList extends Array<FeatureStateModel> {}

package/flagsmith-engine/utils/hashing/index.ts

@@ -1,35 +1,11 @@
-import md5 from 'md5';
-import bigInt from 'big-integer';
+import {BinaryLike, createHash} from "node:crypto";
+
+const md5 = (data: BinaryLike) => createHash('md5').update(data).digest('hex')
 
 const makeRepeated = (arr: Array<any>, repeats: number) =>
     Array.from({ length: repeats }, () => arr).flat();
 
 // https://stackoverflow.com/questions/12532871/how-to-convert-a-very-large-hex-number-to-decimal-in-javascript
-function h2d(s: any): string {
-    function add(x: any, y: any) {
-        var c = 0,
-            r = [];
-        var x = x.split('').map(Number);
-        var y = y.split('').map(Number);
-        while (x.length || y.length) {
-            var s = (x.pop() || 0) + (y.pop() || 0) + c;
-            r.unshift(s < 10 ? s : s - 10);
-            c = s < 10 ? 0 : 1;
-        }
-        if (c) r.unshift(c);
-        return r.join('');
-    }
-
-    var dec = '0';
-    s.split('').forEach(function (chr: any) {
-        var n = parseInt(chr, 16);
-        for (var t = 8; t; t >>= 1) {
-            dec = add(dec, dec);
-            if (n & t) dec = add(dec, '1');
-        }
-    });
-    return dec;
-}
 /**
  * Given a list of object ids, get a floating point number between 0 and 1 based on
  * the hash of those ids. This should give the same value every time for any list of ids.
@@ -41,8 +17,8 @@ function h2d(s: any): string {
 export function getHashedPercentateForObjIds(objectIds: Array<any>, iterations = 1): number {
     let toHash = makeRepeated(objectIds, iterations).join(',');
     const hashedValue = md5(toHash);
-    const hashedInt = bigInt(h2d(hashedValue));
-    const value = (hashedInt.mod(9999).toJSNumber() / 9998) * 100;
+    const hashedInt = BigInt('0x' + hashedValue);
+    const value = (Number((hashedInt % 9999n)) / 9998.0) * 100;
 
     // we ignore this for it's nearly impossible use case to catch
     /* istanbul ignore next */

package/flagsmith-engine/utils/index.ts

@@ -1,4 +1,4 @@
-import { removeSemverSuffix } from "../segments/util";
+import { removeSemverSuffix } from "../segments/util.js";
 
 export function getCastingFunction(traitType: 'boolean' | 'string' | 'number' | 'semver' | any): CallableFunction {
     switch (traitType) {

package/index.ts

@@ -1,5 +1,3 @@
-import Flagsmith from "./sdk";
-
 export {
   AnalyticsProcessor,
   FlagsmithAPIError,
@@ -8,12 +6,12 @@ export {
   FlagsmithCache,
   DefaultFlag,
   Flags,
-  default
-} from './sdk';
+  Flagsmith,
+} from './sdk/index.js';
 
 export {
   FlagsmithConfig
-} from './sdk/types'
+} from './sdk/types.js'
 
 export {
   EnvironmentModel,
@@ -22,6 +20,4 @@ export {
   TraitModel,
   SegmentModel,
   OrganisationModel
-} from './flagsmith-engine';
-
-module.exports = Flagsmith;
+} from './flagsmith-engine/index.js';

package/package.json

@@ -1,8 +1,16 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "3.3.3",
+  "version": "4.0.0",
   "description": "Flagsmith lets you manage features flags and remote config across web, mobile and server side applications. Deliver true Continuous Integration. Get builds out faster. Control who has access to new features.",
-  "main": "build/index.js",
+  "main": "./build/cjs/index.js",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "exports": {
+    "import": "./build/esm/index.js",
+    "require": "./build/cjs/index.js"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/Flagsmith/flagsmith-nodejs-client"
@@ -42,33 +50,30 @@
   "license": "MIT",
   "scripts": {
     "lint": "prettier --write .",
-    "test": "jest --coverage --coverageReporters='text'",
-    "test:watch": "jest --coverage --watch --coverageReporters='text'",
-    "test:debug": "node --inspect-brk node_modules/.bin/jest --coverage --watch --coverageReporters='text'",
-    "build": "tsc",
+    "test": "vitest --coverage --run",
+    "test:watch": "vitest",
+    "test:debug": "vitest --inspect-brk --no-file-parallelism --coverage",
+    "prebuild": "rm -rf ./build",
+    "build": "tsc -b tsconfig.cjs.json tsconfig.esm.json && echo '{\"type\": \"commonjs\"}'> build/cjs/package.json",
     "deploy": "npm i && npm run build && npm publish",
     "deploy:beta": "npm i && npm run build && npm publish --tag beta",
     "prepare": "husky install"
   },
   "dependencies": {
-    "big-integer": "^1.6.51",
-    "md5": "^2.3.0",
-    "node-fetch": "^2.1.2",
     "pino": "^8.8.0",
     "semver": "^7.3.7",
-    "uuid": "^8.3.2"
+    "undici-types": "^6.19.8"
   },
   "devDependencies": {
-    "@types/jest": "^27.4.1",
-    "@types/md5": "^2.3.2",
-    "@types/node-fetch": "^2.6.1",
+    "@types/node": "^20.16.10",
     "@types/semver": "^7.3.9",
     "@types/uuid": "^8.3.4",
+    "@vitest/coverage-v8": "^2.1.2",
     "esbuild": "^0.14.25",
     "husky": "^7.0.4",
-    "jest": "^27.5.1",
     "prettier": "^2.2.1",
-    "ts-jest": "^27.1.3",
-    "typescript": "^4.6.2"
+    "typescript": "^4.9.5",
+    "undici": "^6.19.8",
+    "vitest": "^2.1.2"
   }
 }

package/sdk/analytics.ts

@@ -1,5 +1,5 @@
-import fetch from 'node-fetch';
-import pino, { Logger } from 'pino';
+import { pino, Logger } from 'pino';
+import { Fetch } from "./types.js";
 
 const ANALYTICS_ENDPOINT = 'analytics/flags/';
 
@@ -14,6 +14,7 @@ export class AnalyticsProcessor {
     private requestTimeoutMs: number = 3000;
     private logger: Logger;
     private currentFlush: ReturnType<typeof fetch> | undefined;
+    private customFetch: Fetch;
 
     /**
      * AnalyticsProcessor is used to track how often individual Flags are evaluated within
@@ -24,13 +25,14 @@ export class AnalyticsProcessor {
      * @param data.requestTimeoutMs used to tell requests to stop waiting for a response after a
             given number of milliseconds
      */
-    constructor(data: { environmentKey: string; baseApiUrl: string; requestTimeoutMs?: number, logger?: Logger }) {
+    constructor(data: { environmentKey: string; baseApiUrl: string; requestTimeoutMs?: number, logger?: Logger, fetch?: Fetch }) {
         this.analyticsEndpoint = data.baseApiUrl + ANALYTICS_ENDPOINT;
         this.environmentKey = data.environmentKey;
         this.lastFlushed = Date.now();
         this.analyticsData = {};
         this.requestTimeoutMs = data.requestTimeoutMs || this.requestTimeoutMs;
         this.logger = data.logger || pino();
+        this.customFetch = data.fetch ?? fetch;
     }
     /**
      * Sends all the collected data to the api asynchronously and resets the timer
@@ -41,10 +43,10 @@ export class AnalyticsProcessor {
         }
 
         try {
-            this.currentFlush = fetch(this.analyticsEndpoint, {
+            this.currentFlush = this.customFetch(this.analyticsEndpoint, {
                 method: 'POST',
                 body: JSON.stringify(this.analyticsData),
-                timeout: this.requestTimeoutMs,
+                signal: AbortSignal.timeout(this.requestTimeoutMs),
                 headers: {
                     'Content-Type': 'application/json',
                     'X-Environment-Key': this.environmentKey