feat(node-sdk): add getFeatureDefinitions

roncohen · roncohen · commit 50d0d6c03e34 · 2025-03-23T11:39:49.000+01:00
diff --git a/packages/node-sdk/src/client.ts b/packages/node-sdk/src/client.ts
@@ -19,6 +19,7 @@ import { newRateLimiter } from "./rate-limiter";
 import type {
   EvaluatedFeaturesAPIResponse,
   FeatureAPIResponse,
+  FeatureDefinition,
   FeatureOverridesFn,
   IdType,
   RawFeature,
@@ -482,6 +483,22 @@ export class BucketClient {
     await this._config.batchBuffer.flush();
   }
 
+  /**
+   * Gets the feature definitions, including all config values.
+   * To evaluate which features are enabled for a given user/company, use `getFeatures`.
+   *
+   * @returns The features definitions.
+   */
+  public async getFeatureDefinitions(): Promise<FeatureDefinition[]> {
+    const features = this.getFeaturesCache().get()?.features || [];
+    return features.map((f) => ({
+      key: f.key,
+      description: f.description,
+      isEnabled: f.targeting,
+      config: f.config,
+    }));
+  }
+
   /**
    * Gets the evaluated features for the current context which includes the user, company, and custom context.
    *
diff --git a/packages/node-sdk/src/types.ts b/packages/node-sdk/src/types.ts
@@ -190,6 +190,56 @@ export type FeatureOverride =
     })
   | boolean;
 
+/**
+ * Describes a feature definition.
+ */
+export type FeatureDefinition = {
+  /**
+   * The key of the feature.
+   */
+  key: string;
+
+  /**
+   * Description of the feature.
+   */
+  description: string | null;
+
+  /**
+   * The targeting rules for the feature.
+   */
+  isEnabled: {
+    /**
+     * The version of the targeting rules.
+     */
+    version: number;
+
+    /**
+     * The targeting rules.
+     */
+    rules: {
+      /**
+       * The filter for the rule.
+       */
+      filter: RuleFilter;
+    }[];
+  };
+
+  /**
+   * The remote configuration for the feature.
+   */
+  config?: {
+    /**
+     * The version of the remote configuration.
+     */
+    version: number;
+
+    /**
+     * The variants of the remote configuration.
+     */
+    variants: FeatureConfigVariant[];
+  };
+};
+
 /**
  * Describes a collection of evaluated features.
  *
@@ -264,6 +314,11 @@ export type FeatureAPIResponse = {
    */
   key: string;
 
+  /**
+   * Description of the feature.
+   */
+  description: string | null;
+
   /**
    * The targeting rules for the feature.
    */
