flagsmith-nodejs 4.0.0-beta.1 → 5.0.0

package/.github/workflows/pull_request.yaml

@@ -14,20 +14,14 @@ jobs:
   build-and-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
-      - name: Checkout submodules # checkout rest
-        shell: bash
-        run: |
-          # If your submodules are configured to use SSH instead of HTTPS please uncomment the following line
-          git config --global url."https://github.com/".insteadOf "git@github.com:"
-          auth_header="$(git config --local --get http.https://github.com/.extraheader)"
-          git submodule sync --recursive
-          git -c "http.extraheader=$auth_header" -c protocol.version=2 submodule update --init --force --recursive --depth=1
+      - uses: actions/checkout@v4
+        with:
+          submodules: true
       - uses: actions/setup-node@v4
         with:
           node-version: "18.x"
       - name: cache node modules
-        uses: actions/cache@v1
+        uses: actions/cache@v4
         with:
           path: ~/.npm # npm cache files are stored in `~/.npm` on Linux/macOS
           key: npm-${{ hashFiles('package-lock.json') }}

package/build/cjs/flagsmith-engine/features/models.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FeatureSegment = exports.FeatureStateModel = exports.MultivariateFeatureStateValueModel = exports.MultivariateFeatureOptionModel = exports.FeatureModel = void 0;
-const uuid_1 = require("uuid");
+const node_crypto_1 = require("node:crypto");
 const index_js_1 = require("../utils/hashing/index.js");
 class FeatureModel {
     id;
@@ -30,7 +30,7 @@ class MultivariateFeatureStateValueModel {
     multivariateFeatureOption;
     percentageAllocation;
     id;
-    mvFsValueUuid = (0, uuid_1.v4)();
+    mvFsValueUuid = (0, node_crypto_1.randomUUID)();
     constructor(multivariate_feature_option, percentage_allocation, id, mvFsValueUuid) {
         this.id = id;
         this.percentageAllocation = percentage_allocation;
@@ -43,11 +43,11 @@ class FeatureStateModel {
     feature;
     enabled;
     djangoID;
-    featurestateUUID = (0, uuid_1.v4)();
+    featurestateUUID = (0, node_crypto_1.randomUUID)();
     featureSegment;
     value;
     multivariateFeatureStateValues = [];
-    constructor(feature, enabled, djangoID, value, featurestateUuid = (0, uuid_1.v4)()) {
+    constructor(feature, enabled, djangoID, value, featurestateUuid = (0, node_crypto_1.randomUUID)()) {
         this.feature = feature;
         this.enabled = enabled;
         this.djangoID = djangoID;

package/build/cjs/flagsmith-engine/identities/models.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IdentityModel = void 0;
 const collections_js_1 = require("../utils/collections.js");
-const { v4: uuidv4 } = require('uuid');
+const node_crypto_1 = require("node:crypto");
 class IdentityModel {
     identifier;
     environmentApiKey;
@@ -12,7 +12,7 @@ class IdentityModel {
     identityUuid;
     djangoID;
     constructor(created_date, identityTraits, identityFeatures, environmentApiKey, identifier, identityUuid, djangoID) {
-        this.identityUuid = identityUuid || uuidv4();
+        this.identityUuid = identityUuid || (0, node_crypto_1.randomUUID)();
         this.createdDate = Date.parse(created_date) || Date.now();
         this.identityTraits = identityTraits;
         this.identityFeatures = new collections_js_1.IdentityFeaturesList(...identityFeatures);

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

@@ -1,10 +1,7 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SegmentModel = exports.SegmentRuleModel = exports.SegmentConditionModel = exports.getMatchingFunctions = exports.semverMatchingFunction = exports.matchingFunctions = exports.any = exports.all = void 0;
-const semver_1 = __importDefault(require("semver"));
+const semver = require("semver");
 const index_js_1 = require("../utils/index.js");
 const constants_js_1 = require("./constants.js");
 const util_js_1 = require("./util.js");
@@ -23,11 +20,11 @@ exports.matchingFunctions = {
 };
 exports.semverMatchingFunction = {
     ...exports.matchingFunctions,
-    [constants_js_1.CONDITION_OPERATORS.EQUAL]: (thisValue, otherValue) => semver_1.default.eq(thisValue, otherValue),
-    [constants_js_1.CONDITION_OPERATORS.GREATER_THAN]: (thisValue, otherValue) => semver_1.default.gt(otherValue, thisValue),
-    [constants_js_1.CONDITION_OPERATORS.GREATER_THAN_INCLUSIVE]: (thisValue, otherValue) => semver_1.default.gte(otherValue, thisValue),
-    [constants_js_1.CONDITION_OPERATORS.LESS_THAN]: (thisValue, otherValue) => semver_1.default.gt(thisValue, otherValue),
-    [constants_js_1.CONDITION_OPERATORS.LESS_THAN_INCLUSIVE]: (thisValue, otherValue) => semver_1.default.gte(thisValue, otherValue),
+    [constants_js_1.CONDITION_OPERATORS.EQUAL]: (thisValue, otherValue) => semver.eq(thisValue, otherValue),
+    [constants_js_1.CONDITION_OPERATORS.GREATER_THAN]: (thisValue, otherValue) => semver.gt(otherValue, thisValue),
+    [constants_js_1.CONDITION_OPERATORS.GREATER_THAN_INCLUSIVE]: (thisValue, otherValue) => semver.gte(otherValue, thisValue),
+    [constants_js_1.CONDITION_OPERATORS.LESS_THAN]: (thisValue, otherValue) => semver.gt(thisValue, otherValue),
+    [constants_js_1.CONDITION_OPERATORS.LESS_THAN_INCLUSIVE]: (thisValue, otherValue) => semver.gte(thisValue, otherValue),
 };
 const getMatchingFunctions = (semver) => (semver ? exports.semverMatchingFunction : exports.matchingFunctions);
 exports.getMatchingFunctions = getMatchingFunctions;

package/build/cjs/flagsmith-engine/utils/hashing/index.js

@@ -1,38 +1,10 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getHashedPercentateForObjIds = void 0;
-const md5_1 = __importDefault(require("md5"));
-const big_integer_1 = __importDefault(require("big-integer"));
+const node_crypto_1 = require("node:crypto");
+const md5 = (data) => (0, node_crypto_1.createHash)('md5').update(data).digest('hex');
 const makeRepeated = (arr, repeats) => 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) {
-    function add(x, y) {
-        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) {
-        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.
@@ -43,9 +15,9 @@ function h2d(s) {
  */
 function getHashedPercentateForObjIds(objectIds, iterations = 1) {
     let toHash = makeRepeated(objectIds, iterations).join(',');
-    const hashedValue = (0, md5_1.default)(toHash);
-    const hashedInt = (0, big_integer_1.default)(h2d(hashedValue));
-    const value = (hashedInt.mod(9999).toJSNumber() / 9998) * 100;
+    const hashedValue = md5(toHash);
+    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 */
     if (value === 100) {

package/build/cjs/index.d.ts

@@ -1,3 +1,4 @@
-export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags, default } from './sdk/index.js';
+export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags, Flagsmith, } from './sdk/index.js';
+export { BaseOfflineHandler, LocalFileHandler, } from './sdk/offline_handlers.js';
 export { FlagsmithConfig } from './sdk/types.js';
 export { EnvironmentModel, FeatureStateModel, IdentityModel, TraitModel, SegmentModel, OrganisationModel } from './flagsmith-engine/index.js';

package/build/cjs/index.js

@@ -1,23 +1,21 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.EnvironmentModel = exports.default = exports.Flags = exports.DefaultFlag = exports.EnvironmentDataPollingManager = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
-const index_js_1 = __importDefault(require("./sdk/index.js"));
-var index_js_2 = require("./sdk/index.js");
-Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return index_js_2.AnalyticsProcessor; } });
-Object.defineProperty(exports, "FlagsmithAPIError", { enumerable: true, get: function () { return index_js_2.FlagsmithAPIError; } });
-Object.defineProperty(exports, "FlagsmithClientError", { enumerable: true, get: function () { return index_js_2.FlagsmithClientError; } });
-Object.defineProperty(exports, "EnvironmentDataPollingManager", { enumerable: true, get: function () { return index_js_2.EnvironmentDataPollingManager; } });
-Object.defineProperty(exports, "DefaultFlag", { enumerable: true, get: function () { return index_js_2.DefaultFlag; } });
-Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return index_js_2.Flags; } });
-Object.defineProperty(exports, "default", { enumerable: true, get: function () { return __importDefault(index_js_2).default; } });
-var index_js_3 = require("./flagsmith-engine/index.js");
-Object.defineProperty(exports, "EnvironmentModel", { enumerable: true, get: function () { return index_js_3.EnvironmentModel; } });
-Object.defineProperty(exports, "FeatureStateModel", { enumerable: true, get: function () { return index_js_3.FeatureStateModel; } });
-Object.defineProperty(exports, "IdentityModel", { enumerable: true, get: function () { return index_js_3.IdentityModel; } });
-Object.defineProperty(exports, "TraitModel", { enumerable: true, get: function () { return index_js_3.TraitModel; } });
-Object.defineProperty(exports, "SegmentModel", { enumerable: true, get: function () { return index_js_3.SegmentModel; } });
-Object.defineProperty(exports, "OrganisationModel", { enumerable: true, get: function () { return index_js_3.OrganisationModel; } });
-module.exports = index_js_1.default;
+exports.OrganisationModel = exports.SegmentModel = exports.TraitModel = exports.IdentityModel = exports.FeatureStateModel = exports.EnvironmentModel = exports.LocalFileHandler = exports.BaseOfflineHandler = exports.Flagsmith = exports.Flags = exports.DefaultFlag = exports.EnvironmentDataPollingManager = exports.FlagsmithClientError = exports.FlagsmithAPIError = exports.AnalyticsProcessor = void 0;
+var index_js_1 = require("./sdk/index.js");
+Object.defineProperty(exports, "AnalyticsProcessor", { enumerable: true, get: function () { return index_js_1.AnalyticsProcessor; } });
+Object.defineProperty(exports, "FlagsmithAPIError", { enumerable: true, get: function () { return index_js_1.FlagsmithAPIError; } });
+Object.defineProperty(exports, "FlagsmithClientError", { enumerable: true, get: function () { return index_js_1.FlagsmithClientError; } });
+Object.defineProperty(exports, "EnvironmentDataPollingManager", { enumerable: true, get: function () { return index_js_1.EnvironmentDataPollingManager; } });
+Object.defineProperty(exports, "DefaultFlag", { enumerable: true, get: function () { return index_js_1.DefaultFlag; } });
+Object.defineProperty(exports, "Flags", { enumerable: true, get: function () { return index_js_1.Flags; } });
+Object.defineProperty(exports, "Flagsmith", { enumerable: true, get: function () { return index_js_1.Flagsmith; } });
+var offline_handlers_js_1 = require("./sdk/offline_handlers.js");
+Object.defineProperty(exports, "BaseOfflineHandler", { enumerable: true, get: function () { return offline_handlers_js_1.BaseOfflineHandler; } });
+Object.defineProperty(exports, "LocalFileHandler", { enumerable: true, get: function () { return offline_handlers_js_1.LocalFileHandler; } });
+var index_js_2 = require("./flagsmith-engine/index.js");
+Object.defineProperty(exports, "EnvironmentModel", { enumerable: true, get: function () { return index_js_2.EnvironmentModel; } });
+Object.defineProperty(exports, "FeatureStateModel", { enumerable: true, get: function () { return index_js_2.FeatureStateModel; } });
+Object.defineProperty(exports, "IdentityModel", { enumerable: true, get: function () { return index_js_2.IdentityModel; } });
+Object.defineProperty(exports, "TraitModel", { enumerable: true, get: function () { return index_js_2.TraitModel; } });
+Object.defineProperty(exports, "SegmentModel", { enumerable: true, get: function () { return index_js_2.SegmentModel; } });
+Object.defineProperty(exports, "OrganisationModel", { enumerable: true, get: function () { return index_js_2.OrganisationModel; } });

package/build/cjs/sdk/index.js

@@ -117,10 +117,6 @@ class Flagsmith {
             this.environment = this.offlineHandler.getEnvironment();
         }
         if (!!data.cache) {
-            const missingMethods = ['has', 'get', 'set'].filter(method => data.cache && !data.cache[method]);
-            if (missingMethods.length > 0) {
-                throw new Error(`Please implement the following methods in your cache: ${missingMethods.join(', ')}`);
-            }
             this.cache = data.cache;
         }
         if (!this.offlineMode) {

package/build/cjs/sdk/offline_handlers.js

@@ -1,30 +1,7 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LocalFileHandler = exports.BaseOfflineHandler = void 0;
-const fs = __importStar(require("fs"));
+const fs = require("fs");
 const util_js_1 = require("../flagsmith-engine/environments/util.js");
 class BaseOfflineHandler {
     getEnvironment() {

package/build/cjs/sdk/types.d.ts

@@ -4,11 +4,21 @@ import { Dispatcher } from 'undici-types';
 import { Logger } from 'pino';
 import { BaseOfflineHandler } from './offline_handlers.js';
 export type IFlagsmithValue<T = string | number | boolean | null> = T;
+/**
+ * Stores and retrieves {@link Flags} from a cache.
+ */
 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;
+    /**
+     * Retrieve the cached {@link Flags} for the given environment or identity, or `undefined` if no cached value exists.
+     * @param key An environment ID or identity identifier, which is used as the cache key.
+     */
+    get(key: string): Promise<Flags | undefined>;
+    /**
+     * Persist an environment or identity's {@link Flags} in the cache.
+     * @param key An environment ID or identity identifier, which is used as the cache key.
+     * @param value The {@link Flags} to be stored in the cache.
+     */
+    set(key: string, value: Flags): Promise<void>;
 }
 export type Fetch = typeof fetch;
 export interface FlagsmithConfig {

package/build/esm/flagsmith-engine/features/models.js

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

package/build/esm/flagsmith-engine/identities/models.js

@@ -1,5 +1,5 @@
 import { IdentityFeaturesList } from '../utils/collections.js';
-const { v4: uuidv4 } = require('uuid');
+import { randomUUID as uuidv4 } from 'node:crypto';
 export class IdentityModel {
     identifier;
     environmentApiKey;

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

@@ -1,4 +1,4 @@
-import semver from 'semver';
+import * as semver from 'semver';
 import { getCastingFunction as getCastingFunction } from '../utils/index.js';
 import { ALL_RULE, ANY_RULE, NONE_RULE, NOT_CONTAINS, REGEX, MODULO, IN, CONDITION_OPERATORS } from './constants.js';
 import { isSemver } from './util.js';

package/build/esm/flagsmith-engine/utils/hashing/index.js

@@ -1,32 +1,7 @@
-import md5 from 'md5';
-import bigInt from 'big-integer';
+import { createHash } from "node:crypto";
+const md5 = (data) => createHash('md5').update(data).digest('hex');
 const makeRepeated = (arr, repeats) => 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) {
-    function add(x, y) {
-        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) {
-        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.
@@ -38,8 +13,8 @@ function h2d(s) {
 export function getHashedPercentateForObjIds(objectIds, iterations = 1) {
     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 */
     if (value === 100) {

package/build/esm/index.d.ts

@@ -1,3 +1,4 @@
-export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags, default } from './sdk/index.js';
+export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, FlagsmithCache, DefaultFlag, Flags, Flagsmith, } from './sdk/index.js';
+export { BaseOfflineHandler, LocalFileHandler, } from './sdk/offline_handlers.js';
 export { FlagsmithConfig } from './sdk/types.js';
 export { EnvironmentModel, FeatureStateModel, IdentityModel, TraitModel, SegmentModel, OrganisationModel } from './flagsmith-engine/index.js';

package/build/esm/index.js

@@ -1,4 +1,3 @@
-import Flagsmith from "./sdk/index.js";
-export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, DefaultFlag, Flags, default } from './sdk/index.js';
+export { AnalyticsProcessor, FlagsmithAPIError, FlagsmithClientError, EnvironmentDataPollingManager, DefaultFlag, Flags, Flagsmith, } from './sdk/index.js';
+export { BaseOfflineHandler, LocalFileHandler, } from './sdk/offline_handlers.js';
 export { EnvironmentModel, FeatureStateModel, IdentityModel, TraitModel, SegmentModel, OrganisationModel } from './flagsmith-engine/index.js';
-module.exports = Flagsmith;

package/build/esm/sdk/index.js

@@ -108,10 +108,6 @@ export class Flagsmith {
             this.environment = this.offlineHandler.getEnvironment();
         }
         if (!!data.cache) {
-            const missingMethods = ['has', 'get', 'set'].filter(method => data.cache && !data.cache[method]);
-            if (missingMethods.length > 0) {
-                throw new Error(`Please implement the following methods in your cache: ${missingMethods.join(', ')}`);
-            }
             this.cache = data.cache;
         }
         if (!this.offlineMode) {

package/build/esm/sdk/types.d.ts

@@ -4,11 +4,21 @@ import { Dispatcher } from 'undici-types';
 import { Logger } from 'pino';
 import { BaseOfflineHandler } from './offline_handlers.js';
 export type IFlagsmithValue<T = string | number | boolean | null> = T;
+/**
+ * Stores and retrieves {@link Flags} from a cache.
+ */
 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;
+    /**
+     * Retrieve the cached {@link Flags} for the given environment or identity, or `undefined` if no cached value exists.
+     * @param key An environment ID or identity identifier, which is used as the cache key.
+     */
+    get(key: string): Promise<Flags | undefined>;
+    /**
+     * Persist an environment or identity's {@link Flags} in the cache.
+     * @param key An environment ID or identity identifier, which is used as the cache key.
+     * @param value The {@link Flags} to be stored in the cache.
+     */
+    set(key: string, value: Flags): Promise<void>;
 }
 export type Fetch = typeof fetch;
 export interface FlagsmithConfig {

package/flagsmith-engine/features/models.ts

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

package/flagsmith-engine/identities/models.ts

@@ -1,7 +1,7 @@
 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;

package/flagsmith-engine/segments/models.ts

@@ -1,4 +1,4 @@
-import semver from 'semver';
+import * as semver from 'semver';
 
 import { FeatureStateModel } from '../features/models.js';
 import { getCastingFunction as getCastingFunction } from '../utils/index.js';

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/index.ts

@@ -1,5 +1,3 @@
-import Flagsmith from "./sdk/index.js";
-
 export {
   AnalyticsProcessor,
   FlagsmithAPIError,
@@ -8,9 +6,14 @@ export {
   FlagsmithCache,
   DefaultFlag,
   Flags,
-  default
+  Flagsmith,
 } from './sdk/index.js';
 
+export {
+  BaseOfflineHandler,
+  LocalFileHandler,
+} from './sdk/offline_handlers.js';
+
 export {
   FlagsmithConfig
 } from './sdk/types.js'
@@ -23,5 +26,3 @@ export {
   SegmentModel,
   OrganisationModel
 } from './flagsmith-engine/index.js';
-
-module.exports = Flagsmith;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flagsmith-nodejs",
-  "version": "4.0.0-beta.1",
+  "version": "5.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/cjs/index.js",
   "type": "module",
@@ -60,25 +60,18 @@
     "prepare": "husky install"
   },
   "dependencies": {
-    "big-integer": "^1.6.51",
-    "md5": "^2.3.0",
     "pino": "^8.8.0",
     "semver": "^7.3.7",
-    "undici-types": "^6.19.8",
-    "uuid": "^8.3.2"
+    "undici-types": "^6.19.8"
   },
   "devDependencies": {
-    "@types/jest": "^27.4.1",
-    "@types/md5": "^2.3.2",
     "@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.9.5",
     "undici": "^6.19.8",
     "vitest": "^2.1.2"

package/sdk/index.ts

@@ -128,17 +128,6 @@ export class Flagsmith {
         }
 
         if (!!data.cache) {
-            const missingMethods: string[] = ['has', 'get', 'set'].filter(
-                method => data.cache && !data.cache[method]
-            );
-
-            if (missingMethods.length > 0) {
-                throw new Error(
-                    `Please implement the following methods in your cache: ${missingMethods.join(
-                        ', '
-                    )}`
-                );
-            }
             this.cache = data.cache;
         }
 

package/sdk/types.ts

@@ -5,11 +5,24 @@ import { Logger } from 'pino';
 import { BaseOfflineHandler } from './offline_handlers.js';
 
 export type IFlagsmithValue<T = string | number | boolean | null> = T;
+
+
+/**
+ * Stores and retrieves {@link Flags} from a cache.
+ */
 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;
+    /**
+     * Retrieve the cached {@link Flags} for the given environment or identity, or `undefined` if no cached value exists.
+     * @param key An environment ID or identity identifier, which is used as the cache key.
+     */
+    get(key: string): Promise<Flags | undefined>;
+
+    /**
+     * Persist an environment or identity's {@link Flags} in the cache.
+     * @param key An environment ID or identity identifier, which is used as the cache key.
+     * @param value The {@link Flags} to be stored in the cache.
+     */
+    set(key: string, value: Flags): Promise<void>;
 }
 
 export type Fetch = typeof fetch

package/tests/engine/e2e/engine.test.ts

@@ -1,18 +1,17 @@
-import { readFileSync } from 'fs';
 import { getIdentityFeatureStates } from '../../../flagsmith-engine/index.js';
 import { EnvironmentModel } from '../../../flagsmith-engine/environments/models.js';
 import { buildEnvironmentModel } from '../../../flagsmith-engine/environments/util.js';
 import { IdentityModel } from '../../../flagsmith-engine/identities/models.js';
 import { buildIdentityModel } from '../../../flagsmith-engine/identities/util.js';
+import * as testData from '../engine-tests/engine-test-data/data/environment_n9fbf9h3v4fFgH3U3ngWhb.json'
 
 function extractTestCases(
-    filePath: string
+    data: any
 ): {
     environment: EnvironmentModel;
     identity: IdentityModel;
     response: any;
 }[] {
-    const data = JSON.parse(readFileSync(filePath, 'utf-8'));
     const environmentModel = buildEnvironmentModel(data['environment']);
     const test_data = data['identities_and_responses'].map((test_case: any) => {
         const identity = buildIdentityModel(test_case['identity']);
@@ -27,9 +26,7 @@ function extractTestCases(
 }
 
 test('Test Engine', () => {
-    const testCases = extractTestCases(
-        __dirname + '/../engine-tests/engine-test-data/data/environment_n9fbf9h3v4fFgH3U3ngWhb.json'
-    );
+    const testCases = extractTestCases(testData);
     for (const testCase of testCases) {
         const engine_response = getIdentityFeatureStates(testCase.environment, testCase.identity);
         const sortedEngineFlags = engine_response.sort((a, b) =>

package/tests/engine/unit/utils/utils.test.ts

@@ -1,4 +1,4 @@
-import { v4 as uuidv4 } from 'uuid';
+import { randomUUID as uuidv4 } from 'node:crypto';
 import { getHashedPercentateForObjIds } from '../../../../flagsmith-engine/utils/hashing/index.js';
 
 describe('getHashedPercentageForObjIds', () => {

package/tests/sdk/flagsmith-cache.test.ts

@@ -4,15 +4,6 @@ beforeEach(() => {
   vi.clearAllMocks();
 });
 
-test('test_wrong_cache_interface_throws_an_error', async () => {
-  const cache = {
-    set: () => { },
-    get: () => { },
-  };
-
-  expect(() => { const flg = flagsmith({ cache }); }).toThrow();
-});
-
 test('test_empty_cache_not_read_but_populated', async () => {
   fetch.mockResolvedValue(new Response(flagsJSON));
 
@@ -23,7 +14,7 @@ test('test_empty_cache_not_read_but_populated', async () => {
   const allFlags = (await flg.getEnvironmentFlags()).allFlags();
 
   expect(set).toBeCalled();
-  expect(await cache.has('flags')).toBe(true);
+  expect(await cache.get('flags')).toBeTruthy();
 
   expect(fetch).toBeCalledTimes(1);
   expect(allFlags[0].enabled).toBe(true);
@@ -42,7 +33,7 @@ test('test_api_not_called_when_cache_present', async () => {
   const allFlags = await (await flg.getEnvironmentFlags()).allFlags();
 
   expect(set).toBeCalled();
-  expect(await cache.has('flags')).toBe(true);
+  expect(await cache.get('flags')).toBeTruthy();
 
   expect(fetch).toBeCalledTimes(1);
   expect(allFlags[0].enabled).toBe(true);
@@ -97,7 +88,7 @@ test('test_cache_used_for_identity_flags', async () => {
   const identityFlags = (await flg.getIdentityFlags(identifier, traits)).allFlags();
 
   expect(set).toBeCalled();
-  expect(await cache.has('flags-identifier')).toBe(true);
+  expect(await cache.get('flags-identifier')).toBeTruthy();
 
   expect(fetch).toBeCalledTimes(1);
 
@@ -124,7 +115,7 @@ test('test_cache_used_for_identity_flags_local_evaluation', async () => {
   const identityFlags = (await flg.getIdentityFlags(identifier, traits)).allFlags();
 
   expect(set).toBeCalled();
-  expect(await cache.has('flags-identifier')).toBe(true);
+  expect(await cache.get('flags-identifier')).toBeTruthy();
 
   expect(fetch).toBeCalledTimes(1);
 

package/tests/sdk/offline-handlers.test.ts

@@ -2,7 +2,7 @@ import * as fs from 'fs';
 import { LocalFileHandler } from '../../sdk/offline_handlers.js';
 import { EnvironmentModel } from '../../flagsmith-engine/index.js';
 
-const offlineEnvironment = require('./data/offline-environment.json');
+import * as offlineEnvironment from "./data/offline-environment.json";
 
 vi.mock('fs')
 

package/tests/sdk/utils.ts

@@ -10,17 +10,12 @@ const DATA_DIR = __dirname + '/data/';
 export class TestCache implements FlagsmithCache {
     cache: Record<string, Flags> = {};
 
-    async get(name: string): Promise<Flags> {
+    async get(name: string): Promise<Flags | undefined> {
         return this.cache[name];
     }
 
-    async has(name: string): Promise<boolean> {
-        return !!this.cache[name];
-    }
-
-    async set(name: string, value: Flags, ttl: number|string) {
+    async set(name: string, value: Flags) {
         this.cache[name] = value;
-        return true
     }
 }
 

package/tsconfig.json

@@ -11,12 +11,12 @@
     /* Modules */
     "module": "ESNext",
     "moduleResolution": "Node16",
-    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables `allowSyntheticDefaultImports` for type compatibility. */
     "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
     "declaration": true,
     "strict": true,                                      /* Enable all strict type-checking options. */
     "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied `any` type.. */
     "skipLibCheck": true,                                 /* Skip type checking all .d.ts files. */
+    "resolveJsonModule": true,
     "types": [
       "vitest/globals"
     ]