fix: rename-custom-to-sdk-metadata

Author: Zaimwa9

flagsmith-engine/evaluation/evaluationContext/mappers.ts

@@ -1,14 +1,13 @@
 import {
     FeaturesWithMetadata,
-    Segments,
     Traits,
     GenericEvaluationContext,
     EnvironmentContext,
     IdentityContext,
     SegmentSource,
-    CustomFeatureMetadata,
+    SDKFeatureMetadata,
     SegmentsWithMetadata,
-    CustomSegmentMetadata
+    SDKSegmentMetadata
 } from '../models.js';
 import { EnvironmentModel } from '../../environments/models.js';
 import { IdentityModel } from '../../identities/models.js';
@@ -47,7 +46,7 @@ function mapEnvironmentModelToEvaluationContext(
         name: environment.project.name
     };
 
-    const features: FeaturesWithMetadata<CustomFeatureMetadata> = {};
+    const features: FeaturesWithMetadata<SDKFeatureMetadata> = {};
     for (const fs of environment.featureStates) {
         const variants =
             fs.multivariateFeatureStateValues?.length > 0
@@ -71,7 +70,7 @@ function mapEnvironmentModelToEvaluationContext(
         };
     }
 
-    const segmentOverrides: SegmentsWithMetadata<CustomSegmentMetadata> = {};
+    const segmentOverrides: SegmentsWithMetadata<SDKSegmentMetadata> = {};
     for (const segment of environment.project.segments) {
         segmentOverrides[segment.id.toString()] = {
             key: segment.id.toString(),
@@ -97,7 +96,7 @@ function mapEnvironmentModelToEvaluationContext(
         };
     }
 
-    let identityOverrideSegments: SegmentsWithMetadata<CustomSegmentMetadata> = {};
+    let identityOverrideSegments: SegmentsWithMetadata<SDKSegmentMetadata> = {};
     if (environment.identityOverrides && environment.identityOverrides.length > 0) {
         identityOverrideSegments = mapIdentityOverridesToSegments(environment.identityOverrides);
     }
@@ -149,8 +148,8 @@ function mapSegmentRuleModelToRule(rule: any): any {
 
 function mapIdentityOverridesToSegments(
     identityOverrides: IdentityModel[]
-): SegmentsWithMetadata<CustomSegmentMetadata> {
-    const segments: SegmentsWithMetadata<CustomSegmentMetadata> = {};
+): SegmentsWithMetadata<SDKSegmentMetadata> {
+    const segments: SegmentsWithMetadata<SDKSegmentMetadata> = {};
     const featuresToIdentifiers = new Map<string, { identifiers: string[]; overrides: any[] }>();
 
     for (const identity of identityOverrides) {

flagsmith-engine/evaluation/models.ts

@@ -24,7 +24,7 @@ export enum SegmentSource {
 }
 
 // Feature types
-export interface CustomFeatureMetadata extends FeatureMetadata {
+export interface SDKFeatureMetadata extends FeatureMetadata {
     id: number;
 }
 
@@ -48,7 +48,7 @@ export type EvaluationResultFlags<T extends FeatureMetadata = FeatureMetadata> =
 >;
 
 // Segment types
-export interface CustomSegmentMetadata extends SegmentMetadata {
+export interface SDKSegmentMetadata extends SegmentMetadata {
     id?: number;
     source?: SegmentSource;
 }
@@ -65,7 +65,7 @@ export type SegmentsWithMetadata<T extends SegmentMetadata = SegmentMetadata> =
 
 export interface SegmentResultWithMetadata {
     name: string;
-    metadata: CustomSegmentMetadata;
+    metadata: SDKSegmentMetadata;
 }
 
 export type EvaluationResultSegments = SegmentResultWithMetadata[];
@@ -83,8 +83,8 @@ export interface GenericEvaluationContext<
 }
 
 export type EvaluationContextWithMetadata = GenericEvaluationContext<
-    CustomFeatureMetadata,
-    CustomSegmentMetadata
+    SDKFeatureMetadata,
+    SDKSegmentMetadata
 >;
 
 // Evaluation result types
@@ -93,4 +93,4 @@ export type EvaluationResult<T extends FeatureMetadata = FeatureMetadata> = {
     segments: EvaluationResultSegments;
 };
 
-export type EvaluationResultWithMetadata = EvaluationResult<CustomFeatureMetadata>;
+export type EvaluationResultWithMetadata = EvaluationResult<SDKFeatureMetadata>;

flagsmith-engine/index.ts

@@ -3,7 +3,7 @@ import {
     EvaluationResultSegments,
     EvaluationResultWithMetadata,
     FeatureContextWithMetadata,
-    CustomFeatureMetadata,
+    SDKFeatureMetadata,
     FlagResultWithMetadata
 } from './evaluation/models.js';
 import { getIdentitySegments, getIdentityKey } from './segments/evaluators.js';
@@ -18,7 +18,7 @@ export { FeatureModel, FeatureStateModel } from './features/models.js';
 export { OrganisationModel } from './organisations/models.js';
 
 type SegmentOverride = {
-    feature: FeatureContextWithMetadata<CustomFeatureMetadata>;
+    feature: FeatureContextWithMetadata<SDKFeatureMetadata>;
     segmentName: string;
 };
 
@@ -121,8 +121,8 @@ export function processSegmentOverrides(identitySegments: any[]): Record<string,
 export function evaluateFeatures(
     context: EvaluationContextWithMetadata,
     segmentOverrides: Record<string, SegmentOverride>
-): EvaluationResultFlags<CustomFeatureMetadata> {
-    const flags: EvaluationResultFlags<CustomFeatureMetadata> = {};
+): EvaluationResultFlags<SDKFeatureMetadata> {
+    const flags: EvaluationResultFlags<SDKFeatureMetadata> = {};
 
     for (const feature of Object.values(context.features || {})) {
         const segmentOverride = segmentOverrides[feature.name];
@@ -141,7 +141,7 @@ export function evaluateFeatures(
             reason:
                 evaluatedReason ??
                 getTargetingMatchReason({ type: 'SEGMENT', override: segmentOverride })
-        } as FlagResultWithMetadata<CustomFeatureMetadata>;
+        } as FlagResultWithMetadata<SDKFeatureMetadata>;
     }
 
     return flags;

sdk/models.ts

@@ -1,5 +1,5 @@
 import {
-    CustomFeatureMetadata,
+    SDKFeatureMetadata,
     FlagResultWithMetadata,
     EvaluationResultWithMetadata
 } from '../flagsmith-engine/evaluation/models.js';