refine feature flag definition

Author: Eskibear

src/featureManager.ts

@@ -16,13 +16,13 @@ export class FeatureManager {
     }
 
     listFeatureNames(): string[] {
-        // TODO: whether to deduplicate the feature names?
-        return this.#featureFlags.map((flag) => flag.id);
+        const featureNameSet = new Set(this.#features.map((feature) => feature.id));
+        return Array.from(featureNameSet);
     }
 
     // If multiple feature flags are found, the first one takes precedence.
     async isEnabled(featureId: string, context?: unknown): Promise<boolean> {
-        const featureFlag = this.#featureFlags.find((flag) => flag.id === featureId);
+        const featureFlag = this.#features.find((flag) => flag.id === featureId);
         if (featureFlag === undefined) {
             // If the feature is not found, then it is disabled.
             return false;
@@ -61,7 +61,7 @@ export class FeatureManager {
         }
     }
 
-    get #featureFlags(): FeatureDefinition[] {
+    get #features(): FeatureDefinition[] {
         return this.#provider.getFeatureDefinitions();
     }
 

src/filter/FeatureFilter.ts

@@ -1,7 +1,6 @@
-import { ClientFilterParameters } from "../model";
 
 export interface IFeatureFilter {
     name: string; //e.g. Microsoft.TimeWindow
-    evaluate(parameters?: ClientFilterParameters, appContext?: unknown): Promise<boolean> | boolean;
+    evaluate(parameters?: unknown, appContext?: unknown): Promise<boolean> | boolean;
 }
 

src/filter/TargetingFilter.ts

@@ -1,6 +1,5 @@
-import { ClientFilterParameters } from "../model";
 
-interface TargetingParameters extends ClientFilterParameters {
+interface TargetingParameters {
     // TODO: add targeting parameters.
 }
 

src/model.ts

@@ -3,79 +3,62 @@
 
 // Converted from https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureFlag.v1.1.0.schema.json
 
-/**
- * An ID used to uniquely identify and reference the feature.
- */
-export type FeatureID = string
-/**
- * A description of the feature.
- */
-export type FeatureDescription = string
-/**
- * A display name for the feature to use for display rather than the ID.
- */
-export type FeatureDisplayName = string
-/**
- * A feature is OFF if enabled is false. If enabled is true, then the feature is ON if there are no conditions (null or empty) or if the conditions are satisfied.
- */
-export type EnabledState = boolean
-/**
- * Determines whether any or all registered client filters must be enabled for the feature to be considered enabled.
- */
-export enum RequirementType {
-    Any = "Any",
-    All = "All"
-}
-/**
- * The name used to refer to and require a client filter.
- */
-export type ClientFilterName = string
-/**
- * Filters that must run on the client and be evaluated as true for the feature to be considered enabled.
- */
-export type ClientFilterCollection = ClientFilter[]
-
 export interface FeatureDefinition {
-  id: FeatureID
-  description?: FeatureDescription
-  display_name?: FeatureDisplayName
-  enabled: EnabledState
+  /**
+   * An ID used to uniquely identify and reference the feature.
+   */
+  id: string
+
+  /**
+   * A description of the feature.
+   */
+  description?: string
+
+  /**
+   * A display name for the feature to use for display rather than the ID.
+   */
+  display_name?: string
+
+  /**
+   * A feature is OFF if enabled is false. If enabled is true, then the feature is ON if there are no conditions (null or empty) or if the conditions are satisfied.
+   */
+  enabled: boolean
+
+  /**
+   * The declaration of conditions used to dynamically enable features.
+   */
   conditions?: FeatureEnablementConditions
-  [k: string]: unknown
 }
-/**
- * The declaration of conditions used to dynamically enable features.
- */
+
+export enum RequirementType {
+  Any = "Any",
+  All = "All"
+}
+
 export interface FeatureEnablementConditions {
+  /**
+   * Determines whether any or all registered client filters must be enabled for the feature to be considered enabled.
+   */
   requirement_type?: RequirementType
-  client_filters?: ClientFilterCollection
-  [k: string]: unknown
+
+  /**
+   * Filters that must run on the client and be evaluated as true for the feature to be considered enabled.
+   */
+  client_filters?: ClientFilter[]
 }
+
 export interface ClientFilter {
-  name: ClientFilterName
-  parameters?: ClientFilterParameters
-  [k: string]: unknown
-}
-/**
- * Custom parameters for a given client filter. A client filter can require any set of parameters of any type.
- */
-export interface ClientFilterParameters {
   /**
-   * This interface was referenced by `ClientFilterParameters`'s JSON-Schema definition
-   * via the `patternProperty` "^.*$".
+   * The name used to refer to and require a client filter.
+   */
+  name: string
+  /**
+   * Custom parameters for a given client filter. A client filter can require any set of parameters of any type.
    */
-  [k: string]:
-    | string
-    | null
-    | {
-        [k: string]: unknown
-      }
-    | number
-    | unknown[]
-    | boolean
+  parameters?: unknown
 }
 
-// Feature Management definition
+// Feature Management Section fed into feature manager.
 export const FEATURE_MANAGEMENT_KEY = "FeatureManagement"
 export const FEATURE_FLAGS_KEY = "FeatureFlags"
 export interface FeatureManagement {