Merge pull request #162 from Flagsmith/feat/v4

feat!: Custom fetch support, remove node-fetch, ESM+CJS dual build, migrate to vitest, TS fixes, test improvements

.github/workflows/publish.yml

@@ -14,9 +14,9 @@ jobs:
       - name: Cloning repo
         uses: actions/checkout@v3
 
-      - uses: actions/setup-node@v3
+      - uses: actions/setup-node@v4
         with:
-          node-version: '16.x'
+          node-version: '18.x'
           registry-url: 'https://registry.npmjs.org'
 
       - run: npm ci

.github/workflows/pull_request.yaml

@@ -23,9 +23,9 @@ jobs:
           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/setup-node@v1
+      - uses: actions/setup-node@v4
         with:
-          node-version: "15.x"
+          node-version: "18.x"
       - name: cache node modules
         uses: actions/cache@v1
         with:
@@ -34,8 +34,7 @@ jobs:
           restore-keys: |
             npm-${{ hashFiles('package-lock.json') }}
             npm-
-      - run: npm i -g [email protected]
-      - run: npm install
+      - run: npm ci
       - run: npm test
         env:
           CI: true

.gitignore

@@ -8,5 +8,6 @@
 
 node_modules/
 build/
+coverage/
 
 .tool-versions

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;

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);

flagsmith-engine/features/models.ts

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

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);

flagsmith-engine/identities/models.ts

@@ -1,6 +1,5 @@
-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');
 

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);

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,

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(

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;

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']

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,

flagsmith-engine/segments/models.ts

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

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', '');
-}
+}

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> {}

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) {

index.ts

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