flagsmith-nodejs 6.1.0 → 7.0.2

package/build/cjs/sdk/models.js

@@ -46,10 +46,15 @@ class Flag extends BaseFlag {
      * The programmatic name for this feature, unique per Flagsmith project.
      */
     featureName;
+    /**
+     * The reason for this feature, unique per Flagsmith project.
+     */
+    reason;
     constructor(params) {
         super(params.value, params.enabled, !!params.isDefault);
         this.featureId = params.featureId;
         this.featureName = params.featureName;
+        this.reason = params.reason;
     }
     static fromFeatureStateModel(fsm, identityId) {
         return new Flag({
@@ -64,7 +69,8 @@ class Flag extends BaseFlag {
             enabled: flagData['enabled'],
             value: flagData['feature_state_value'] ?? flagData['value'],
             featureId: flagData['feature']['id'],
-            featureName: flagData['feature']['name']
+            featureName: flagData['feature']['name'],
+            reason: flagData['feature']['reason']
         });
     }
 }
@@ -78,6 +84,28 @@ class Flags {
         this.defaultFlagHandler = data.defaultFlagHandler;
         this.analyticsProcessor = data.analyticsProcessor;
     }
+    static fromEvaluationResult(evaluationResult, defaultFlagHandler, analyticsProcessor) {
+        const flags = {};
+        for (const flag of Object.values(evaluationResult.flags)) {
+            const flagMetadataId = flag.metadata?.id;
+            if (!flagMetadataId) {
+                throw new Error(`FlagResult metadata.id is missing for feature "${flag.name}". ` +
+                    `This indicates a bug in the SDK, please report it.`);
+            }
+            flags[flag.name] = new Flag({
+                enabled: flag.enabled,
+                value: flag.value ?? null,
+                featureId: flagMetadataId,
+                featureName: flag.name,
+                reason: flag.reason
+            });
+        }
+        return new Flags({
+            flags: flags,
+            defaultFlagHandler: defaultFlagHandler,
+            analyticsProcessor: analyticsProcessor
+        });
+    }
     static fromFeatureStateModels(data) {
         const flags = {};
         for (const fs of data.featureStates) {

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

@@ -56,4 +56,5 @@ export declare class Deferred<T> {
     resolve(value: T | PromiseLike<T>): void;
     reject(reason?: unknown): void;
 }
+export declare function getUserAgent(): string;
 export {};

package/build/cjs/sdk/utils.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Deferred = exports.retryFetch = exports.delay = exports.generateIdentitiesData = exports.isTraitConfig = void 0;
+exports.getUserAgent = exports.Deferred = exports.retryFetch = exports.delay = exports.generateIdentitiesData = exports.isTraitConfig = void 0;
+const FLAGSMITH_USER_AGENT = 'flagsmith-nodejs-sdk';
+const FLAGSMITH_UNKNOWN_VERSION = 'unknown';
 function isTraitConfig(traitValue) {
     return !!traitValue && typeof traitValue == 'object' && traitValue.value !== undefined;
 }
@@ -93,3 +95,14 @@ class Deferred {
     }
 }
 exports.Deferred = Deferred;
+function getUserAgent() {
+    try {
+        const packageJson = require('../package.json');
+        const version = packageJson?.version;
+        return version ? `${FLAGSMITH_USER_AGENT}/${version}` : FLAGSMITH_UNKNOWN_VERSION;
+    }
+    catch {
+        return FLAGSMITH_UNKNOWN_VERSION;
+    }
+}
+exports.getUserAgent = getUserAgent;

package/build/esm/flagsmith-engine/environments/models.d.ts

@@ -18,5 +18,6 @@ export declare class EnvironmentModel {
     project: ProjectModel;
     featureStates: FeatureStateModel[];
     identityOverrides: IdentityModel[];
-    constructor(id: number, apiKey: string, project: ProjectModel);
+    name: string;
+    constructor(id: number, apiKey: string, project: ProjectModel, name: string);
 }

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

@@ -24,9 +24,11 @@ export class EnvironmentModel {
     project;
     featureStates = [];
     identityOverrides = [];
-    constructor(id, apiKey, project) {
+    name;
+    constructor(id, apiKey, project, name) {
         this.id = id;
         this.apiKey = apiKey;
         this.project = project;
+        this.name = name;
     }
 }

package/build/esm/flagsmith-engine/environments/util.js

@@ -5,7 +5,7 @@ import { EnvironmentAPIKeyModel, EnvironmentModel } from './models.js';
 export function buildEnvironmentModel(environmentJSON) {
     const project = buildProjectModel(environmentJSON.project);
     const featureStates = environmentJSON.feature_states.map((fs) => buildFeatureStateModel(fs));
-    const environmentModel = new EnvironmentModel(environmentJSON.id, environmentJSON.api_key, project);
+    const environmentModel = new EnvironmentModel(environmentJSON.id, environmentJSON.api_key, project, environmentJSON.name);
     environmentModel.featureStates = featureStates;
     if (!!environmentJSON.identity_overrides) {
         environmentModel.identityOverrides = environmentJSON.identity_overrides.map((identityData) => buildIdentityModel(identityData));

package/build/esm/flagsmith-engine/evaluation/evaluationContext/evaluationContext.types.d.ts

@@ -0,0 +1,230 @@
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+/**
+ * Unique environment key. May be used for selecting a value for a multivariate feature, or for % split segmentation.
+ */
+export type Key = string;
+/**
+ * An environment's human-readable name.
+ */
+export type Name = string;
+/**
+ * A unique identifier for an identity as displayed in the Flagsmith UI.
+ */
+export type Identifier = string;
+/**
+ * Key used when selecting a value for a multivariate feature, or for % split segmentation. Set to an internal identifier or a composite value based on the environment key and identifier, depending on Flagsmith implementation.
+ */
+export type Key1 = string;
+/**
+ * Unique segment key used for % split segmentation.
+ */
+export type Key2 = string;
+/**
+ * The name of the segment.
+ */
+export type Name1 = string;
+/**
+ * Segment rule type. Represents a logical quantifier for the conditions and sub-rules.
+ */
+export type Type = 'ALL' | 'ANY' | 'NONE';
+export type SegmentCondition = SegmentCondition1 | InSegmentCondition;
+/**
+ * A reference to the identity trait or value in the evaluation context.
+ */
+export type Property = string;
+/**
+ * The operator to use for evaluating the condition.
+ */
+export type Operator = 'EQUAL' | 'GREATER_THAN' | 'LESS_THAN' | 'LESS_THAN_INCLUSIVE' | 'CONTAINS' | 'GREATER_THAN_INCLUSIVE' | 'NOT_CONTAINS' | 'NOT_EQUAL' | 'REGEX' | 'PERCENTAGE_SPLIT' | 'MODULO' | 'IS_SET' | 'IS_NOT_SET' | 'IN';
+/**
+ * The value to compare against the trait or context value.
+ */
+export type Value = string;
+/**
+ * A reference to the identity trait or value in the evaluation context.
+ */
+export type Property1 = string;
+/**
+ * The operator to use for evaluating the condition.
+ */
+export type Operator1 = 'IN';
+/**
+ * The values to compare against the trait or context value.
+ */
+export type Value1 = string[];
+/**
+ * Conditions that must be met for the rule to apply.
+ */
+export type Conditions = SegmentCondition[];
+/**
+ * Sub-rules nested within the segment rule.
+ */
+export type SubRules = SegmentRule[];
+/**
+ * Rules that define the segment.
+ */
+export type Rules = SegmentRule[];
+/**
+ * Unique feature key used when selecting a variant if the feature is multivariate. Set to an internal identifier or a UUID, depending on Flagsmith implementation.
+ */
+export type Key3 = string;
+/**
+ * Feature name.
+ */
+export type Name2 = string;
+/**
+ * Indicates whether the feature is enabled in the environment.
+ */
+export type Enabled = boolean;
+/**
+ * A default environment value for the feature. If the feature is multivariate, this will be the control value.
+ */
+export type Value2 = string | number | boolean | null;
+/**
+ * The value of the feature.
+ */
+export type Value3 = string | number | boolean | null;
+/**
+ * The weight of the feature value variant, as a percentage number (i.e. 100.0).
+ */
+export type Weight = number;
+/**
+ * Priority of the feature flag variant. Lower values indicate a higher priority when multiple variants apply to the same context key.
+ */
+export type VariantPriority = number;
+/**
+ * An array of environment default values associated with the feature. Empty for standard features, or contains multiple values for multivariate features.
+ */
+export type Variants = FeatureValue[];
+/**
+ * Priority of the feature context. Lower values indicate a higher priority when multiple contexts apply to the same feature.
+ */
+export type FeaturePriority = number;
+/**
+ * Feature overrides for the segment.
+ */
+export type Overrides = FeatureContext[];
+/**
+ * A context object containing the necessary information to evaluate Flagsmith feature flags.
+ */
+export interface EvaluationContext {
+    environment: EnvironmentContext;
+    /**
+     * Identity context used for identity-based evaluation.
+     */
+    identity?: IdentityContext | null;
+    segments?: Segments;
+    features?: Features;
+    [k: string]: unknown;
+}
+/**
+ * Environment context required for evaluation.
+ */
+export interface EnvironmentContext {
+    key: Key;
+    name: Name;
+    [k: string]: unknown;
+}
+/**
+ * Represents an identity context for feature flag evaluation.
+ */
+export interface IdentityContext {
+    identifier: Identifier;
+    key?: Key1;
+    traits?: Traits;
+    [k: string]: unknown;
+}
+/**
+ * A map of traits associated with the identity, where the key is the trait name and the value is the trait value.
+ */
+export interface Traits {
+    [k: string]: string | number | boolean | null;
+}
+/**
+ * Segments applicable to the evaluation context.
+ */
+export interface Segments {
+    [k: string]: SegmentContext;
+}
+/**
+ * Represents a segment context for feature flag evaluation.
+ */
+export interface SegmentContext {
+    key: Key2;
+    name: Name1;
+    rules: Rules;
+    overrides?: Overrides;
+    metadata?: SegmentMetadata;
+    [k: string]: unknown;
+}
+/**
+ * Represents a rule within a segment for feature flag evaluation.
+ */
+export interface SegmentRule {
+    type: Type;
+    conditions?: Conditions;
+    rules?: SubRules;
+    [k: string]: unknown;
+}
+/**
+ * Represents a condition within a segment rule for feature flag evaluation.
+ */
+export interface SegmentCondition1 {
+    property: Property;
+    operator: Operator;
+    value: Value;
+    [k: string]: unknown;
+}
+/**
+ * Represents an IN condition within a segment rule for feature flag evaluation.
+ */
+export interface InSegmentCondition {
+    property: Property1;
+    operator: Operator1;
+    value: Value1;
+    [k: string]: unknown;
+}
+/**
+ * Represents a feature context for feature flag evaluation.
+ */
+export interface FeatureContext {
+    key: Key3;
+    name: Name2;
+    enabled: Enabled;
+    value: Value2;
+    variants?: Variants;
+    priority?: FeaturePriority;
+    metadata?: FeatureMetadata;
+    [k: string]: unknown;
+}
+/**
+ * Represents a multivariate value for a feature flag.
+ */
+export interface FeatureValue {
+    value: Value3;
+    weight: Weight;
+    priority: VariantPriority;
+    [k: string]: unknown;
+}
+/**
+ * Additional metadata associated with the feature.
+ */
+export interface FeatureMetadata {
+    [k: string]: unknown;
+}
+/**
+ * Additional metadata associated with the segment.
+ */
+export interface SegmentMetadata {
+    [k: string]: unknown;
+}
+/**
+ * Features to be evaluated in the context.
+ */
+export interface Features {
+    [k: string]: FeatureContext;
+}

package/build/esm/flagsmith-engine/evaluation/evaluationContext/evaluationContext.types.js

@@ -0,0 +1,7 @@
+/* eslint-disable */
+/**
+ * This file was automatically generated by json-schema-to-typescript.
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
+ * and run json-schema-to-typescript to regenerate this file.
+ */
+export {};

package/build/esm/flagsmith-engine/evaluation/evaluationContext/mappers.d.ts

@@ -0,0 +1,5 @@
+import { GenericEvaluationContext } from '../models.js';
+import { EnvironmentModel } from '../../environments/models.js';
+import { IdentityModel } from '../../identities/models.js';
+import { TraitModel } from '../../identities/traits/models.js';
+export declare function getEvaluationContext(environment: EnvironmentModel, identity?: IdentityModel, overrideTraits?: TraitModel[], isEnvironmentEvaluation?: boolean): GenericEvaluationContext;

package/build/esm/flagsmith-engine/evaluation/evaluationContext/mappers.js

@@ -0,0 +1,152 @@
+import { SegmentSource } from '../models.js';
+import { IDENTITY_OVERRIDE_SEGMENT_NAME } from '../../segments/constants.js';
+import { createHash } from 'node:crypto';
+import { uuidToBigInt } from '../../features/util.js';
+export function getEvaluationContext(environment, identity, overrideTraits, isEnvironmentEvaluation = false) {
+    const environmentContext = mapEnvironmentModelToEvaluationContext(environment);
+    if (isEnvironmentEvaluation) {
+        return environmentContext;
+    }
+    const identityContext = identity
+        ? mapIdentityModelToIdentityContext(identity, overrideTraits)
+        : undefined;
+    const context = {
+        ...environmentContext,
+        ...(identityContext && { identity: identityContext })
+    };
+    return context;
+}
+function mapEnvironmentModelToEvaluationContext(environment) {
+    const environmentContext = {
+        key: environment.apiKey,
+        name: environment.name
+    };
+    const features = {};
+    for (const fs of environment.featureStates) {
+        const variants = fs.multivariateFeatureStateValues?.length > 0
+            ? fs.multivariateFeatureStateValues.map(mv => ({
+                value: mv.multivariateFeatureOption.value,
+                weight: mv.percentageAllocation,
+                priority: mv.id ?? uuidToBigInt(mv.mvFsValueUuid)
+            }))
+            : undefined;
+        features[fs.feature.name] = {
+            key: fs.djangoID?.toString() || fs.featurestateUUID,
+            name: fs.feature.name,
+            enabled: fs.enabled,
+            value: fs.getValue(),
+            variants,
+            priority: fs.featureSegment?.priority,
+            metadata: {
+                id: fs.feature.id
+            }
+        };
+    }
+    const segmentOverrides = {};
+    for (const segment of environment.project.segments) {
+        segmentOverrides[segment.id.toString()] = {
+            key: segment.id.toString(),
+            name: segment.name,
+            rules: segment.rules.map(rule => mapSegmentRuleModelToRule(rule)),
+            overrides: segment.featureStates.length > 0
+                ? segment.featureStates.map(fs => ({
+                    key: fs.djangoID?.toString() || fs.featurestateUUID,
+                    name: fs.feature.name,
+                    enabled: fs.enabled,
+                    value: fs.getValue(),
+                    priority: fs.featureSegment?.priority,
+                    metadata: {
+                        id: fs.feature.id
+                    }
+                }))
+                : [],
+            metadata: {
+                source: SegmentSource.API,
+                id: segment.id
+            }
+        };
+    }
+    let identityOverrideSegments = {};
+    if (environment.identityOverrides && environment.identityOverrides.length > 0) {
+        identityOverrideSegments = mapIdentityOverridesToSegments(environment.identityOverrides);
+    }
+    return {
+        environment: environmentContext,
+        features,
+        segments: {
+            ...segmentOverrides,
+            ...identityOverrideSegments
+        }
+    };
+}
+function mapIdentityModelToIdentityContext(identity, overrideTraits) {
+    const traits = overrideTraits || identity.identityTraits;
+    const traitsContext = {};
+    for (const trait of traits) {
+        traitsContext[trait.traitKey] = trait.traitValue;
+    }
+    const identityContext = {
+        identifier: identity.identifier,
+        traits: traitsContext
+    };
+    return identityContext;
+}
+function mapSegmentRuleModelToRule(rule) {
+    return {
+        type: rule.type,
+        conditions: rule.conditions.map((condition) => ({
+            property: condition.property,
+            operator: condition.operator,
+            value: condition.value
+        })),
+        rules: rule.rules.map((subRule) => mapSegmentRuleModelToRule(subRule))
+    };
+}
+function mapIdentityOverridesToSegments(identityOverrides) {
+    const segments = {};
+    const featuresToIdentifiers = new Map();
+    for (const identity of identityOverrides) {
+        if (!identity.identityFeatures || identity.identityFeatures.length === 0) {
+            continue;
+        }
+        const sortedFeatures = [...identity.identityFeatures].sort((a, b) => a.feature.name.localeCompare(b.feature.name));
+        const overridesKey = sortedFeatures.map(fs => ({
+            name: fs.feature.name,
+            enabled: fs.enabled,
+            value: fs.getValue(),
+            priority: -Infinity,
+            metadata: {
+                id: fs.feature.id
+            }
+        }));
+        const overridesHash = createHash('sha1').update(JSON.stringify(overridesKey)).digest('hex');
+        if (!featuresToIdentifiers.has(overridesHash)) {
+            featuresToIdentifiers.set(overridesHash, { identifiers: [], overrides: overridesKey });
+        }
+        featuresToIdentifiers.get(overridesHash).identifiers.push(identity.identifier);
+    }
+    for (const [overrideHash, { identifiers, overrides }] of featuresToIdentifiers.entries()) {
+        const segmentKey = `identity_override_${overrideHash}`;
+        segments[segmentKey] = {
+            key: segmentKey,
+            name: IDENTITY_OVERRIDE_SEGMENT_NAME,
+            rules: [
+                {
+                    type: 'ALL',
+                    conditions: [
+                        {
+                            property: '$.identity.identifier',
+                            operator: 'IN',
+                            value: identifiers.join(',')
+                        }
+                    ]
+                }
+            ],
+            metadata: {
+                source: SegmentSource.IDENTITY_OVERRIDE
+            },
+            overrides: overrides
+        };
+    }
+    return segments;
+}