fix(react-sdk): improve type definitions for useFeature hook (#324)

pavkam · roncohen · commit 51fffb7aa9f4 · 2025-02-26T10:37:32.000+01:00
Refactor type handling for useFeature to better support different
feature configurations and improve type safety
diff --git a/packages/react-sdk/package.json b/packages/react-sdk/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@bucketco/react-sdk",
-  "version": "3.0.0-alpha.5",
+  "version": "3.0.0-alpha.6",
   "license": "MIT",
   "repository": {
     "type": "git",
diff --git a/packages/react-sdk/src/index.tsx b/packages/react-sdk/src/index.tsx
@@ -30,10 +30,6 @@ type MaterializedFeatures = keyof Features extends never
   : Features;
 
 export type FeatureKey = keyof MaterializedFeatures;
-export type FeatureConfig<TKey extends FeatureKey> =
-  MaterializedFeatures[TKey] extends boolean
-    ? never
-    : MaterializedFeatures[TKey];
 
 type ProviderContextType = {
   client?: BucketClient;
@@ -167,18 +163,22 @@ type RequestFeedbackOptions = Omit<
   "featureKey" | "featureId"
 >;
 
+type EmptyConfig = {
+  key: undefined;
+  payload: undefined;
+};
+
 type Feature<TKey extends FeatureKey> = {
   isEnabled: boolean;
   isLoading: boolean;
-  config:
-    | {
-        key: string;
-        payload: FeatureConfig<TKey>;
-      }
-    | {
-        key: undefined;
-        payload: undefined;
-      };
+  config: MaterializedFeatures[TKey] extends boolean
+    ? EmptyConfig
+    :
+        | {
+            key: string;
+            payload: MaterializedFeatures[TKey];
+          }
+        | EmptyConfig;
   track: () => void;
   requestFeedback: (opts: RequestFeedbackOptions) => void;
 };
@@ -194,7 +194,9 @@ type Feature<TKey extends FeatureKey> = {
  * }
  * ```
  */
-export function useFeature<TKey extends FeatureKey>(key: TKey): Feature<TKey> {
+export function useFeature<TKey extends FeatureKey>(
+  key: TKey,
+): Feature<typeof key> {
   const {
     features: { isLoading },
     client,
@@ -226,7 +228,7 @@ export function useFeature<TKey extends FeatureKey>(key: TKey): Feature<TKey> {
       return feature.isEnabled ?? false;
     },
     get config() {
-      return feature.config ?? { key: undefined, payload: undefined };
+      return feature.config as Feature<typeof key>["config"];
     },
   };
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@bucketco/react-sdk",`
`3`		`- "version": "3.0.0-alpha.5",`
	`3`	`+ "version": "3.0.0-alpha.6",`
`4`	`4`	`"license": "MIT",`
`5`	`5`	`"repository": {`
`6`	`6`	`"type": "git",`