@openfeature/react-sdk 0.0.6-experimental → 0.1.0-experimental

package/README.md

@@ -33,7 +33,7 @@ Here's a basic example of how to use the current API with the in-memory provider
 ```tsx
 import logo from './logo.svg';
 import './App.css';
-import { OpenFeatureProvider, useFeatureFlag, OpenFeature } from '@openfeature/react-sdk';
+import { EvaluationContext, OpenFeatureProvider, useBooleanFlagValue, useBooleanFlagDetails, OpenFeature } from '@openfeature/react-sdk';
 import { FlagdWebProvider } from '@openfeature/flagd-web-provider';
 
 const flagConfig = {
@@ -64,12 +64,12 @@ function App() {
 }
 
 function Page() {
-  const booleanFlag = useFeatureFlag('new-message', false);
+  const newMessage = useBooleanFlagValue('new-message', false);
   return (
     <div className="App">
       <header className="App-header">
         <img src={logo} className="App-logo" alt="logo" />
-        {booleanFlag.value ? <p>Welcome to this OpenFeature-enabled React app!</p> : <p>Welcome to this React app.</p>}
+        {newMessage ? <p>Welcome to this OpenFeature-enabled React app!</p> : <p>Welcome to this React app.</p>}
       </header>
     </div>
   )
@@ -78,6 +78,19 @@ function Page() {
 export default App;
 ```
 
+You use the detailed flag evaluation hooks to evaluate the flag and get additional information about the flag and the evaluation.
+
+```tsx
+import { useBooleanFlagDetails} from '@openfeature/react-sdk';
+
+const {
+    value,
+    variant,
+    reason,
+    flagMetadata
+  } = useBooleanFlagDetails('new-message', false);
+```
+
 ### Multiple Providers and Scoping
 
 Multiple providers and scoped clients can be configured by passing a `clientName` to the `OpenFeatureProvider`:
@@ -103,11 +116,11 @@ OpenFeature.getClient('myClient');
 
 By default, if the OpenFeature [evaluation context](https://openfeature.dev/docs/reference/concepts/evaluation-context) is modified, components will be re-rendered.
 This is useful in cases where flag values are dependant on user-attributes or other application state (user logged in, items in card, etc).
-You can disable this feature in the `useFeatureFlag` hook options:
+You can disable this feature in the hook options:
 
 ```tsx
 function Page() {
-  const booleanFlag = useFeatureFlag('new-message', false, { updateOnContextChanged: false });
+  const newMessage = useBooleanFlagValue('new-message', false, { updateOnContextChanged: false });
   return (
     <MyComponents></MyComponents>
   )
@@ -120,11 +133,11 @@ For more information about how evaluation context works in the React SDK, see th
 
 By default, if the underlying provider emits a `ConfigurationChanged` event, components will be re-rendered.
 This is useful if you want your UI to immediately reflect changes in the backend flag configuration.
-You can disable this feature in the `useFeatureFlag` hook options:
+You can disable this feature in the hook options:
 
 ```tsx
 function Page() {
-  const booleanFlag = useFeatureFlag('new-message', false, { updateOnConfigurationChanged: false });
+  const newMessage = useBooleanFlagValue('new-message', false, { updateOnConfigurationChanged: false });
   return (
     <MyComponents></MyComponents>
   )
@@ -151,11 +164,11 @@ function Content() {
 
 function Message() {
   // component to render after READY.
-  const { value: showNewMessage } = useFeatureFlag('new-message', false);
+  const newMessage = useBooleanFlagValue('new-message', false);
 
   return (
     <>
-      {showNewMessage ? (
+      {newMessage ? (
         <p>Welcome to this OpenFeature-enabled React app!</p>
       ) : (
         <p>Welcome to this plain old React app!</p>
@@ -168,4 +181,4 @@ function Fallback() {
   // component to render before READY.
   return <p>Waiting for provider to be ready...</p>;
 }
-```
+```

package/dist/cjs/index.js

@@ -46,8 +46,15 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var src_exports = {};
 __export(src_exports, {
   OpenFeatureProvider: () => OpenFeatureProvider,
-  useFeatureFlag: () => useFeatureFlag,
-  useOpenFeatureClient: () => useOpenFeatureClient
+  useBooleanFlagDetails: () => useBooleanFlagDetails,
+  useBooleanFlagValue: () => useBooleanFlagValue,
+  useNumberFlagDetails: () => useNumberFlagDetails,
+  useNumberFlagValue: () => useNumberFlagValue,
+  useObjectFlagDetails: () => useObjectFlagDetails,
+  useObjectFlagValue: () => useObjectFlagValue,
+  useOpenFeatureClient: () => useOpenFeatureClient,
+  useStringFlagDetails: () => useStringFlagDetails,
+  useStringFlagValue: () => useStringFlagValue
 });
 module.exports = __toCommonJS(src_exports);
 
@@ -81,7 +88,39 @@ var DEFAULT_OPTIONS = {
   updateOnConfigurationChanged: true,
   suspend: true
 };
-function useFeatureFlag(flagKey, defaultValue, options) {
+function useBooleanFlagValue(flagKey, defaultValue, options) {
+  return useBooleanFlagDetails(flagKey, defaultValue, options).value;
+}
+function useBooleanFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getBooleanDetails;
+  }, options);
+}
+function useStringFlagValue(flagKey, defaultValue, options) {
+  return useStringFlagDetails(flagKey, defaultValue, options).value;
+}
+function useStringFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getStringDetails;
+  }, options);
+}
+function useNumberFlagValue(flagKey, defaultValue, options) {
+  return useNumberFlagDetails(flagKey, defaultValue, options).value;
+}
+function useNumberFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getNumberDetails;
+  }, options);
+}
+function useObjectFlagValue(flagKey, defaultValue, options) {
+  return useObjectFlagDetails(flagKey, defaultValue, options).value;
+}
+function useObjectFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getObjectDetails;
+  }, options);
+}
+function attachHandlersAndResolve(flagKey, defaultValue, resolver, options) {
   const defaultedOptions = __spreadValues(__spreadValues({}, DEFAULT_OPTIONS), options);
   const [, updateState] = (0, import_react.useState)();
   const forceUpdate = () => {
@@ -107,18 +146,7 @@ function useFeatureFlag(flagKey, defaultValue, options) {
       client.removeHandler(import_web_sdk2.ProviderEvents.ConfigurationChanged, forceUpdate);
     };
   }, [client]);
-  return getFlag(client, flagKey, defaultValue);
-}
-function getFlag(client, flagKey, defaultValue) {
-  if (typeof defaultValue === "boolean") {
-    return client.getBooleanDetails(flagKey, defaultValue);
-  } else if (typeof defaultValue === "string") {
-    return client.getStringDetails(flagKey, defaultValue);
-  } else if (typeof defaultValue === "number") {
-    return client.getNumberDetails(flagKey, defaultValue);
-  } else {
-    return client.getObjectDetails(flagKey, defaultValue);
-  }
+  return resolver(client).call(client, flagKey, defaultValue);
 }
 function suspend(client, updateState) {
   let suspendResolver;

package/dist/cjs/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/index.ts", "../../src/use-feature-flag.ts", "../../src/provider.tsx"],
-  "sourcesContent": ["export * from './use-feature-flag';\nexport * from './provider';\n// re-export the web-sdk so consumers can access that API from the react-sdk\nexport * from '@openfeature/web-sdk';\n", "import { Client, EvaluationDetails, FlagEvaluationOptions, FlagValue, ProviderEvents, ProviderStatus } from '@openfeature/web-sdk';\nimport { Dispatch, SetStateAction, useEffect, useState } from 'react';\nimport { useOpenFeatureClient } from './provider';\n\ntype ReactFlagEvaluationOptions = {\n  /**\n   * Suspend flag evaluations while the provider is not ready.\n   * Set to false if you don't want to use React Suspense API.\n   * Defaults to true.\n   */\n  suspend?: boolean,\n  /**\n   * Update the component if the provider emits a ConfigurationChanged event.\n   * Set to false to prevent components from re-rendering when flag value changes\n   * are received by the associated provider.\n   * Defaults to true.\n   */\n  updateOnConfigurationChanged?: boolean,\n  /**\n   * Update the component when the OpenFeature context changes.\n   * Set to false to prevent components from re-rendering when attributes which \n   * may be factors in flag evaluation change.\n   * Defaults to true.\n   */\n  updateOnContextChanged?: boolean,\n} & FlagEvaluationOptions;\n\nconst DEFAULT_OPTIONS: ReactFlagEvaluationOptions = {\n  updateOnContextChanged: true,\n  updateOnConfigurationChanged: true,\n  suspend: true,\n};\n\nenum SuspendState {\n  Pending,\n  Success,\n  Error\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * @param {string}flagKey the flag identifier\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @template T flag type\n * @returns { EvaluationDetails<T>} a EvaluationDetails object for this evaluation\n */\nexport function useFeatureFlag<T extends FlagValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };\n  const [, updateState] = useState<object | undefined>();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const client = useOpenFeatureClient();\n\n  useEffect(() => {\n\n    if (client.providerStatus !== ProviderStatus.READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspend) {\n        suspend(client, updateState);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n    }\n\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers (we can do this unconditionally with no impact)\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, [client]);\n\n  return getFlag(client, flagKey, defaultValue);\n}\n\nfunction getFlag<T extends FlagValue>(client: Client, flagKey: string, defaultValue: T): EvaluationDetails<T> {\n  if (typeof defaultValue === 'boolean') {\n    return client.getBooleanDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  } else if (typeof defaultValue === 'string') {\n    return client.getStringDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  } else if (typeof defaultValue === 'number') {\n    return client.getNumberDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  } else {\n    return client.getObjectDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  }\n}\n\n/**\n * Suspend function. If this runs, components using the calling hook will be suspended.\n * @param {Client} client the OpenFeature client\n * @param {Function} updateState the state update function\n */\nfunction suspend(client: Client, updateState: Dispatch<SetStateAction<object | undefined>>) {\n  let suspendResolver: () => void;\n  let suspendRejecter: () => void;\n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      client.removeHandler(ProviderEvents.Ready, suspendResolver); // remove handler once it's run\n    };\n    suspendRejecter = () => {\n      resolve(); // we still resolve here, since we don't want to throw errors\n      client.removeHandler(ProviderEvents.Error, suspendRejecter); // remove handler once it's run\n    };\n    client.addHandler(ProviderEvents.Ready, suspendResolver);\n    client.addHandler(ProviderEvents.Error, suspendRejecter);\n  });\n  updateState(suspenseWrapper(suspendPromise));\n}\n\n/**\n * Promise wrapper that throws unresolved promises to support React suspense.\n * @param {Promise<T>} promise to wrap\n * @template T flag type\n * @returns {Function} suspense-compliant lambda\n */\nfunction suspenseWrapper <T>(promise: Promise<T>) {\n  let status: SuspendState = SuspendState.Pending;\n  let result: T;\n\n  const suspended = promise.then(\n    (value) => {\n      status = SuspendState.Success;\n      result = value;\n    },\n    (error) => {\n      status = SuspendState.Error;\n      result = error;\n    }\n  );\n\n  return () => {\n    switch (status) {\n      case SuspendState.Pending:\n        throw suspended;\n      case SuspendState.Success:\n        return result;\n      case SuspendState.Error:\n        throw result;\n      default:\n        throw new Error('Suspending promise is in an unknown state.');\n    }\n  };\n};", "import * as React from 'react';\nimport { Client, OpenFeature } from '@openfeature/web-sdk';\n\ntype ClientOrClientName =\n  | {\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName: string;\n      /**\n       * OpenFeature client to use.\n       */\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client: Client;\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrClientName;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, clientName, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(clientName);\n  }\n\n  return <Context.Provider value={client}>{children}</Context.Provider>;\n};\n\nexport const useOpenFeatureClient = () => {\n  const client = React.useContext(Context);\n\n  if (!client) {\n    throw new Error(\n      'No OpenFeature client available - components using OpenFeature must be wrapped with an <OpenFeatureProvider>'\n    );\n  }\n\n  return client;\n};\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,kBAA4G;AAC5G,mBAA8D;;;ACD9D,YAAuB;AACvB,qBAAoC;AA8BpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,YAAY,SAAS,MAAqB;AACtF,MAAI,CAAC,QAAQ;AACX,aAAS,2BAAY,UAAU,UAAU;AAAA,EAC3C;AAEA,SAAO,oCAAC,QAAQ,UAAR,EAAiB,OAAO,UAAS,QAAS;AACpD;AAEO,IAAM,uBAAuB,MAAM;AACxC,QAAM,SAAe,iBAAW,OAAO;AAEvC,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;;;ADxBA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,SAAS;AACX;AAgBO,SAAS,eAAoC,SAAiB,cAAiB,SAA4D;AAChJ,QAAM,mBAAmB,kCAAK,kBAAoB;AAClD,QAAM,CAAC,EAAE,WAAW,QAAI,uBAA6B;AACrD,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,SAAS,qBAAqB;AAEpC,8BAAU,MAAM;AAEd,QAAI,OAAO,mBAAmB,+BAAe,OAAO;AAElD,aAAO,WAAW,+BAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,SAAS;AAC5B,gBAAQ,QAAQ,WAAW;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,+BAAe,gBAAgB,WAAW;AAAA,IAC9D;AAEA,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,+BAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,+BAAe,OAAO,WAAW;AACtD,aAAO,cAAc,+BAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,+BAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,SAAO,QAAQ,QAAQ,SAAS,YAAY;AAC9C;AAEA,SAAS,QAA6B,QAAgB,SAAiB,cAAuC;AAC5G,MAAI,OAAO,iBAAiB,WAAW;AACrC,WAAO,OAAO,kBAAkB,SAAS,YAAY;AAAA,EACvD,WAAW,OAAO,iBAAiB,UAAU;AAC3C,WAAO,OAAO,iBAAiB,SAAS,YAAY;AAAA,EACtD,WAAW,OAAO,iBAAiB,UAAU;AAC3C,WAAO,OAAO,iBAAiB,SAAS,YAAY;AAAA,EACtD,OAAO;AACL,WAAO,OAAO,iBAAiB,SAAS,YAAY;AAAA,EACtD;AACF;AAOA,SAAS,QAAQ,QAAgB,aAA2D;AAC1F,MAAI;AACJ,MAAI;AACJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,+BAAe,OAAO,eAAe;AAAA,IAC5D;AACA,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,+BAAe,OAAO,eAAe;AAAA,IAC5D;AACA,WAAO,WAAW,+BAAe,OAAO,eAAe;AACvD,WAAO,WAAW,+BAAe,OAAO,eAAe;AAAA,EACzD,CAAC;AACD,cAAY,gBAAgB,cAAc,CAAC;AAC7C;AAQA,SAAS,gBAAoB,SAAqB;AAChD,MAAI,SAAuB;AAC3B,MAAI;AAEJ,QAAM,YAAY,QAAQ;AAAA,IACxB,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,IACA,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,EACF;AAEA,SAAO,MAAM;AACX,YAAQ,QAAQ;AAAA,MACd,KAAK;AACH,cAAM;AAAA,MACR,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,cAAM;AAAA,MACR;AACE,cAAM,IAAI,MAAM,4CAA4C;AAAA,IAChE;AAAA,EACF;AACF;;;ADtJA,wBAAc,iCAHd;",
+  "sourcesContent": ["export * from './use-feature-flag';\nexport * from './provider';\n// re-export the web-sdk so consumers can access that API from the react-sdk\nexport * from '@openfeature/web-sdk';\n", "import { Client, EvaluationDetails, FlagEvaluationOptions, FlagValue, JsonValue, ProviderEvents, ProviderStatus } from '@openfeature/web-sdk';\nimport { Dispatch, SetStateAction, useEffect, useState } from 'react';\nimport { useOpenFeatureClient } from './provider';\n\ntype ReactFlagEvaluationOptions = {\n  /**\n   * Suspend flag evaluations while the provider is not ready.\n   * Set to false if you don't want to use React Suspense API.\n   * Defaults to true.\n   */\n  suspend?: boolean,\n  /**\n   * Update the component if the provider emits a ConfigurationChanged event.\n   * Set to false to prevent components from re-rendering when flag value changes\n   * are received by the associated provider.\n   * Defaults to true.\n   */\n  updateOnConfigurationChanged?: boolean,\n  /**\n   * Update the component when the OpenFeature context changes.\n   * Set to false to prevent components from re-rendering when attributes which \n   * may be factors in flag evaluation change.\n   * Defaults to true.\n   */\n  updateOnContextChanged?: boolean,\n} & FlagEvaluationOptions;\n\nconst DEFAULT_OPTIONS: ReactFlagEvaluationOptions = {\n  updateOnContextChanged: true,\n  updateOnConfigurationChanged: true,\n  suspend: true,\n};\n\nenum SuspendState {\n  Pending,\n  Success,\n  Error\n}\n\n/**\n * Evaluates a feature flag, returning a boolean.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @param {boolean} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useBooleanFlagValue(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): boolean {\n  return useBooleanFlagDetails(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @param {boolean} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<boolean>} a EvaluationDetails object for this evaluation\n */\nexport function useBooleanFlagDetails(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): EvaluationDetails<boolean> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getBooleanDetails;\n  },  options);\n}\n\n/**\n * Evaluates a feature flag, returning a string.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {string} [T=string] A optional generic argument constraining the string\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useStringFlagValue<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T {\n  return useStringFlagDetails(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {string} [T=string] A optional generic argument constraining the string\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<string>} a EvaluationDetails object for this evaluation\n */\nexport function useStringFlagDetails<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getStringDetails<T>;\n  },  options);\n}\n\n/**\n * Evaluates a feature flag, returning a number.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {number} [T=number] A optional generic argument constraining the number\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useNumberFlagValue<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T {\n  return useNumberFlagDetails(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {number} [T=number] A optional generic argument constraining the number\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<number>} a EvaluationDetails object for this evaluation\n */\nexport function useNumberFlagDetails<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getNumberDetails<T>;\n  },  options);\n}\n\n/**\n * Evaluates a feature flag, returning an object.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useObjectFlagValue<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T {\n  return useObjectFlagDetails<T>(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @param {T} defaultValue the default value\n * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<T>} a EvaluationDetails object for this evaluation\n */\nexport function useObjectFlagDetails<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getObjectDetails<T>;\n  },  options);\n}\n\nfunction attachHandlersAndResolve<T extends FlagValue>(flagKey: string, defaultValue: T, resolver: (client: Client) => (flagKey: string, defaultValue: T) => EvaluationDetails<T>, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };\n  const [, updateState] = useState<object | undefined>();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const client = useOpenFeatureClient();\n\n  useEffect(() => {\n\n    if (client.providerStatus !== ProviderStatus.READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspend) {\n        suspend(client, updateState);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n    }\n\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers (we can do this unconditionally with no impact)\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, [client]);\n\n  return resolver(client).call(client, flagKey, defaultValue);\n}\n\n/**\n * Suspend function. If this runs, components using the calling hook will be suspended.\n * @param {Client} client the OpenFeature client\n * @param {Function} updateState the state update function\n */\nfunction suspend(client: Client, updateState: Dispatch<SetStateAction<object | undefined>>) {\n  let suspendResolver: () => void;\n  let suspendRejecter: () => void;\n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      client.removeHandler(ProviderEvents.Ready, suspendResolver); // remove handler once it's run\n    };\n    suspendRejecter = () => {\n      resolve(); // we still resolve here, since we don't want to throw errors\n      client.removeHandler(ProviderEvents.Error, suspendRejecter); // remove handler once it's run\n    };\n    client.addHandler(ProviderEvents.Ready, suspendResolver);\n    client.addHandler(ProviderEvents.Error, suspendRejecter);\n  });\n  updateState(suspenseWrapper(suspendPromise));\n}\n\n/**\n * Promise wrapper that throws unresolved promises to support React suspense.\n * @param {Promise<T>} promise to wrap\n * @template T flag type\n * @returns {Function} suspense-compliant lambda\n */\nfunction suspenseWrapper <T>(promise: Promise<T>) {\n  let status: SuspendState = SuspendState.Pending;\n  let result: T;\n\n  const suspended = promise.then(\n    (value) => {\n      status = SuspendState.Success;\n      result = value;\n    },\n    (error) => {\n      status = SuspendState.Error;\n      result = error;\n    }\n  );\n\n  return () => {\n    switch (status) {\n      case SuspendState.Pending:\n        throw suspended;\n      case SuspendState.Success:\n        return result;\n      case SuspendState.Error:\n        throw result;\n      default:\n        throw new Error('Suspending promise is in an unknown state.');\n    }\n  };\n};", "import * as React from 'react';\nimport { Client, OpenFeature } from '@openfeature/web-sdk';\n\ntype ClientOrClientName =\n  | {\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName: string;\n      /**\n       * OpenFeature client to use.\n       */\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client: Client;\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrClientName;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, clientName, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(clientName);\n  }\n\n  return <Context.Provider value={client}>{children}</Context.Provider>;\n};\n\nexport const useOpenFeatureClient = () => {\n  const client = React.useContext(Context);\n\n  if (!client) {\n    throw new Error(\n      'No OpenFeature client available - components using OpenFeature must be wrapped with an <OpenFeatureProvider>'\n    );\n  }\n\n  return client;\n};\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,IAAAA,kBAAuH;AACvH,mBAA8D;;;ACD9D,YAAuB;AACvB,qBAAoC;AA8BpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,YAAY,SAAS,MAAqB;AACtF,MAAI,CAAC,QAAQ;AACX,aAAS,2BAAY,UAAU,UAAU;AAAA,EAC3C;AAEA,SAAO,oCAAC,QAAQ,UAAR,EAAiB,OAAO,UAAS,QAAS;AACpD;AAEO,IAAM,uBAAuB,MAAM;AACxC,QAAM,SAAe,iBAAW,OAAO;AAEvC,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;;;ADxBA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,SAAS;AACX;AAgBO,SAAS,oBAAoB,SAAiB,cAAuB,SAA+C;AACzH,SAAO,sBAAsB,SAAS,cAAc,OAAO,EAAE;AAC/D;AAUO,SAAS,sBAAsB,SAAiB,cAAuB,SAAkE;AAC9I,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAWO,SAAS,mBAA8C,SAAiB,cAAiB,SAAyC;AACvI,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAWO,SAAS,qBAAgD,SAAiB,cAAiB,SAA4D;AAC5J,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAWO,SAAS,mBAA8C,SAAiB,cAAiB,SAAyC;AACvI,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAWO,SAAS,qBAAgD,SAAiB,cAAiB,SAA4D;AAC5J,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAWO,SAAS,mBAAoD,SAAiB,cAAiB,SAAyC;AAC7I,SAAO,qBAAwB,SAAS,cAAc,OAAO,EAAE;AACjE;AAWO,SAAS,qBAAsD,SAAiB,cAAiB,SAA4D;AAClK,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAEA,SAAS,yBAA8C,SAAiB,cAAiB,UAA0F,SAA4D;AAC7O,QAAM,mBAAmB,kCAAK,kBAAoB;AAClD,QAAM,CAAC,EAAE,WAAW,QAAI,uBAA6B;AACrD,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,SAAS,qBAAqB;AAEpC,8BAAU,MAAM;AAEd,QAAI,OAAO,mBAAmB,+BAAe,OAAO;AAElD,aAAO,WAAW,+BAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,SAAS;AAC5B,gBAAQ,QAAQ,WAAW;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,+BAAe,gBAAgB,WAAW;AAAA,IAC9D;AAEA,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,+BAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,+BAAe,OAAO,WAAW;AACtD,aAAO,cAAc,+BAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,+BAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,SAAO,SAAS,MAAM,EAAE,KAAK,QAAQ,SAAS,YAAY;AAC5D;AAOA,SAAS,QAAQ,QAAgB,aAA2D;AAC1F,MAAI;AACJ,MAAI;AACJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,+BAAe,OAAO,eAAe;AAAA,IAC5D;AACA,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,+BAAe,OAAO,eAAe;AAAA,IAC5D;AACA,WAAO,WAAW,+BAAe,OAAO,eAAe;AACvD,WAAO,WAAW,+BAAe,OAAO,eAAe;AAAA,EACzD,CAAC;AACD,cAAY,gBAAgB,cAAc,CAAC;AAC7C;AAQA,SAAS,gBAAoB,SAAqB;AAChD,MAAI,SAAuB;AAC3B,MAAI;AAEJ,QAAM,YAAY,QAAQ;AAAA,IACxB,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,IACA,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,EACF;AAEA,SAAO,MAAM;AACX,YAAQ,QAAQ;AAAA,MACd,KAAK;AACH,cAAM;AAAA,MACR,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,cAAM;AAAA,MACR;AACE,cAAM,IAAI,MAAM,4CAA4C;AAAA,IAChE;AAAA,EACF;AACF;;;ADhPA,wBAAc,iCAHd;",
   "names": ["import_web_sdk"]
 }

package/dist/esm/index.js

@@ -45,7 +45,39 @@ var DEFAULT_OPTIONS = {
   updateOnConfigurationChanged: true,
   suspend: true
 };
-function useFeatureFlag(flagKey, defaultValue, options) {
+function useBooleanFlagValue(flagKey, defaultValue, options) {
+  return useBooleanFlagDetails(flagKey, defaultValue, options).value;
+}
+function useBooleanFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getBooleanDetails;
+  }, options);
+}
+function useStringFlagValue(flagKey, defaultValue, options) {
+  return useStringFlagDetails(flagKey, defaultValue, options).value;
+}
+function useStringFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getStringDetails;
+  }, options);
+}
+function useNumberFlagValue(flagKey, defaultValue, options) {
+  return useNumberFlagDetails(flagKey, defaultValue, options).value;
+}
+function useNumberFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getNumberDetails;
+  }, options);
+}
+function useObjectFlagValue(flagKey, defaultValue, options) {
+  return useObjectFlagDetails(flagKey, defaultValue, options).value;
+}
+function useObjectFlagDetails(flagKey, defaultValue, options) {
+  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {
+    return client.getObjectDetails;
+  }, options);
+}
+function attachHandlersAndResolve(flagKey, defaultValue, resolver, options) {
   const defaultedOptions = __spreadValues(__spreadValues({}, DEFAULT_OPTIONS), options);
   const [, updateState] = useState();
   const forceUpdate = () => {
@@ -71,18 +103,7 @@ function useFeatureFlag(flagKey, defaultValue, options) {
       client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);
     };
   }, [client]);
-  return getFlag(client, flagKey, defaultValue);
-}
-function getFlag(client, flagKey, defaultValue) {
-  if (typeof defaultValue === "boolean") {
-    return client.getBooleanDetails(flagKey, defaultValue);
-  } else if (typeof defaultValue === "string") {
-    return client.getStringDetails(flagKey, defaultValue);
-  } else if (typeof defaultValue === "number") {
-    return client.getNumberDetails(flagKey, defaultValue);
-  } else {
-    return client.getObjectDetails(flagKey, defaultValue);
-  }
+  return resolver(client).call(client, flagKey, defaultValue);
 }
 function suspend(client, updateState) {
   let suspendResolver;
@@ -132,7 +153,14 @@ function suspenseWrapper(promise) {
 export * from "@openfeature/web-sdk";
 export {
   OpenFeatureProvider,
-  useFeatureFlag,
-  useOpenFeatureClient
+  useBooleanFlagDetails,
+  useBooleanFlagValue,
+  useNumberFlagDetails,
+  useNumberFlagValue,
+  useObjectFlagDetails,
+  useObjectFlagValue,
+  useOpenFeatureClient,
+  useStringFlagDetails,
+  useStringFlagValue
 };
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/use-feature-flag.ts", "../../src/provider.tsx", "../../src/index.ts"],
-  "sourcesContent": ["import { Client, EvaluationDetails, FlagEvaluationOptions, FlagValue, ProviderEvents, ProviderStatus } from '@openfeature/web-sdk';\nimport { Dispatch, SetStateAction, useEffect, useState } from 'react';\nimport { useOpenFeatureClient } from './provider';\n\ntype ReactFlagEvaluationOptions = {\n  /**\n   * Suspend flag evaluations while the provider is not ready.\n   * Set to false if you don't want to use React Suspense API.\n   * Defaults to true.\n   */\n  suspend?: boolean,\n  /**\n   * Update the component if the provider emits a ConfigurationChanged event.\n   * Set to false to prevent components from re-rendering when flag value changes\n   * are received by the associated provider.\n   * Defaults to true.\n   */\n  updateOnConfigurationChanged?: boolean,\n  /**\n   * Update the component when the OpenFeature context changes.\n   * Set to false to prevent components from re-rendering when attributes which \n   * may be factors in flag evaluation change.\n   * Defaults to true.\n   */\n  updateOnContextChanged?: boolean,\n} & FlagEvaluationOptions;\n\nconst DEFAULT_OPTIONS: ReactFlagEvaluationOptions = {\n  updateOnContextChanged: true,\n  updateOnConfigurationChanged: true,\n  suspend: true,\n};\n\nenum SuspendState {\n  Pending,\n  Success,\n  Error\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * @param {string}flagKey the flag identifier\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @template T flag type\n * @returns { EvaluationDetails<T>} a EvaluationDetails object for this evaluation\n */\nexport function useFeatureFlag<T extends FlagValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };\n  const [, updateState] = useState<object | undefined>();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const client = useOpenFeatureClient();\n\n  useEffect(() => {\n\n    if (client.providerStatus !== ProviderStatus.READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspend) {\n        suspend(client, updateState);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n    }\n\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers (we can do this unconditionally with no impact)\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, [client]);\n\n  return getFlag(client, flagKey, defaultValue);\n}\n\nfunction getFlag<T extends FlagValue>(client: Client, flagKey: string, defaultValue: T): EvaluationDetails<T> {\n  if (typeof defaultValue === 'boolean') {\n    return client.getBooleanDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  } else if (typeof defaultValue === 'string') {\n    return client.getStringDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  } else if (typeof defaultValue === 'number') {\n    return client.getNumberDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  } else {\n    return client.getObjectDetails(flagKey, defaultValue) as EvaluationDetails<T>;\n  }\n}\n\n/**\n * Suspend function. If this runs, components using the calling hook will be suspended.\n * @param {Client} client the OpenFeature client\n * @param {Function} updateState the state update function\n */\nfunction suspend(client: Client, updateState: Dispatch<SetStateAction<object | undefined>>) {\n  let suspendResolver: () => void;\n  let suspendRejecter: () => void;\n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      client.removeHandler(ProviderEvents.Ready, suspendResolver); // remove handler once it's run\n    };\n    suspendRejecter = () => {\n      resolve(); // we still resolve here, since we don't want to throw errors\n      client.removeHandler(ProviderEvents.Error, suspendRejecter); // remove handler once it's run\n    };\n    client.addHandler(ProviderEvents.Ready, suspendResolver);\n    client.addHandler(ProviderEvents.Error, suspendRejecter);\n  });\n  updateState(suspenseWrapper(suspendPromise));\n}\n\n/**\n * Promise wrapper that throws unresolved promises to support React suspense.\n * @param {Promise<T>} promise to wrap\n * @template T flag type\n * @returns {Function} suspense-compliant lambda\n */\nfunction suspenseWrapper <T>(promise: Promise<T>) {\n  let status: SuspendState = SuspendState.Pending;\n  let result: T;\n\n  const suspended = promise.then(\n    (value) => {\n      status = SuspendState.Success;\n      result = value;\n    },\n    (error) => {\n      status = SuspendState.Error;\n      result = error;\n    }\n  );\n\n  return () => {\n    switch (status) {\n      case SuspendState.Pending:\n        throw suspended;\n      case SuspendState.Success:\n        return result;\n      case SuspendState.Error:\n        throw result;\n      default:\n        throw new Error('Suspending promise is in an unknown state.');\n    }\n  };\n};", "import * as React from 'react';\nimport { Client, OpenFeature } from '@openfeature/web-sdk';\n\ntype ClientOrClientName =\n  | {\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName: string;\n      /**\n       * OpenFeature client to use.\n       */\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client: Client;\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrClientName;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, clientName, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(clientName);\n  }\n\n  return <Context.Provider value={client}>{children}</Context.Provider>;\n};\n\nexport const useOpenFeatureClient = () => {\n  const client = React.useContext(Context);\n\n  if (!client) {\n    throw new Error(\n      'No OpenFeature client available - components using OpenFeature must be wrapped with an <OpenFeatureProvider>'\n    );\n  }\n\n  return client;\n};\n", "export * from './use-feature-flag';\nexport * from './provider';\n// re-export the web-sdk so consumers can access that API from the react-sdk\nexport * from '@openfeature/web-sdk';\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA,SAAsE,gBAAgB,sBAAsB;AAC5G,SAAmC,WAAW,gBAAgB;;;ACD9D,YAAY,WAAW;AACvB,SAAiB,mBAAmB;AA8BpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,YAAY,SAAS,MAAqB;AACtF,MAAI,CAAC,QAAQ;AACX,aAAS,YAAY,UAAU,UAAU;AAAA,EAC3C;AAEA,SAAO,oCAAC,QAAQ,UAAR,EAAiB,OAAO,UAAS,QAAS;AACpD;AAEO,IAAM,uBAAuB,MAAM;AACxC,QAAM,SAAe,iBAAW,OAAO;AAEvC,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;;;ADxBA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,SAAS;AACX;AAgBO,SAAS,eAAoC,SAAiB,cAAiB,SAA4D;AAChJ,QAAM,mBAAmB,kCAAK,kBAAoB;AAClD,QAAM,CAAC,EAAE,WAAW,IAAI,SAA6B;AACrD,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,SAAS,qBAAqB;AAEpC,YAAU,MAAM;AAEd,QAAI,OAAO,mBAAmB,eAAe,OAAO;AAElD,aAAO,WAAW,eAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,SAAS;AAC5B,gBAAQ,QAAQ,WAAW;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,eAAe,gBAAgB,WAAW;AAAA,IAC9D;AAEA,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,eAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,eAAe,OAAO,WAAW;AACtD,aAAO,cAAc,eAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,eAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,SAAO,QAAQ,QAAQ,SAAS,YAAY;AAC9C;AAEA,SAAS,QAA6B,QAAgB,SAAiB,cAAuC;AAC5G,MAAI,OAAO,iBAAiB,WAAW;AACrC,WAAO,OAAO,kBAAkB,SAAS,YAAY;AAAA,EACvD,WAAW,OAAO,iBAAiB,UAAU;AAC3C,WAAO,OAAO,iBAAiB,SAAS,YAAY;AAAA,EACtD,WAAW,OAAO,iBAAiB,UAAU;AAC3C,WAAO,OAAO,iBAAiB,SAAS,YAAY;AAAA,EACtD,OAAO;AACL,WAAO,OAAO,iBAAiB,SAAS,YAAY;AAAA,EACtD;AACF;AAOA,SAAS,QAAQ,QAAgB,aAA2D;AAC1F,MAAI;AACJ,MAAI;AACJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,eAAe,OAAO,eAAe;AAAA,IAC5D;AACA,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,eAAe,OAAO,eAAe;AAAA,IAC5D;AACA,WAAO,WAAW,eAAe,OAAO,eAAe;AACvD,WAAO,WAAW,eAAe,OAAO,eAAe;AAAA,EACzD,CAAC;AACD,cAAY,gBAAgB,cAAc,CAAC;AAC7C;AAQA,SAAS,gBAAoB,SAAqB;AAChD,MAAI,SAAuB;AAC3B,MAAI;AAEJ,QAAM,YAAY,QAAQ;AAAA,IACxB,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,IACA,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,EACF;AAEA,SAAO,MAAM;AACX,YAAQ,QAAQ;AAAA,MACd,KAAK;AACH,cAAM;AAAA,MACR,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,cAAM;AAAA,MACR;AACE,cAAM,IAAI,MAAM,4CAA4C;AAAA,IAChE;AAAA,EACF;AACF;;;AEtJA,cAAc;",
+  "sourcesContent": ["import { Client, EvaluationDetails, FlagEvaluationOptions, FlagValue, JsonValue, ProviderEvents, ProviderStatus } from '@openfeature/web-sdk';\nimport { Dispatch, SetStateAction, useEffect, useState } from 'react';\nimport { useOpenFeatureClient } from './provider';\n\ntype ReactFlagEvaluationOptions = {\n  /**\n   * Suspend flag evaluations while the provider is not ready.\n   * Set to false if you don't want to use React Suspense API.\n   * Defaults to true.\n   */\n  suspend?: boolean,\n  /**\n   * Update the component if the provider emits a ConfigurationChanged event.\n   * Set to false to prevent components from re-rendering when flag value changes\n   * are received by the associated provider.\n   * Defaults to true.\n   */\n  updateOnConfigurationChanged?: boolean,\n  /**\n   * Update the component when the OpenFeature context changes.\n   * Set to false to prevent components from re-rendering when attributes which \n   * may be factors in flag evaluation change.\n   * Defaults to true.\n   */\n  updateOnContextChanged?: boolean,\n} & FlagEvaluationOptions;\n\nconst DEFAULT_OPTIONS: ReactFlagEvaluationOptions = {\n  updateOnContextChanged: true,\n  updateOnConfigurationChanged: true,\n  suspend: true,\n};\n\nenum SuspendState {\n  Pending,\n  Success,\n  Error\n}\n\n/**\n * Evaluates a feature flag, returning a boolean.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @param {boolean} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useBooleanFlagValue(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): boolean {\n  return useBooleanFlagDetails(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @param {boolean} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<boolean>} a EvaluationDetails object for this evaluation\n */\nexport function useBooleanFlagDetails(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): EvaluationDetails<boolean> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getBooleanDetails;\n  },  options);\n}\n\n/**\n * Evaluates a feature flag, returning a string.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {string} [T=string] A optional generic argument constraining the string\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useStringFlagValue<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T {\n  return useStringFlagDetails(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {string} [T=string] A optional generic argument constraining the string\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<string>} a EvaluationDetails object for this evaluation\n */\nexport function useStringFlagDetails<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getStringDetails<T>;\n  },  options);\n}\n\n/**\n * Evaluates a feature flag, returning a number.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {number} [T=number] A optional generic argument constraining the number\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useNumberFlagValue<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T {\n  return useNumberFlagDetails(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {number} [T=number] A optional generic argument constraining the number\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<number>} a EvaluationDetails object for this evaluation\n */\nexport function useNumberFlagDetails<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getNumberDetails<T>;\n  },  options);\n}\n\n/**\n * Evaluates a feature flag, returning an object.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure\n * @param {T} defaultValue the default value\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { boolean} a EvaluationDetails object for this evaluation\n */\nexport function useObjectFlagValue<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T {\n  return useObjectFlagDetails<T>(flagKey, defaultValue, options).value;\n}\n\n/**\n * Evaluates a feature flag, returning evaluation details.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @param {T} defaultValue the default value\n * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure\n * @param {ReactFlagEvaluationOptions} options options for this evaluation\n * @returns { EvaluationDetails<T>} a EvaluationDetails object for this evaluation\n */\nexport function useObjectFlagDetails<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  return attachHandlersAndResolve(flagKey, defaultValue, (client) => {\n    return client.getObjectDetails<T>;\n  },  options);\n}\n\nfunction attachHandlersAndResolve<T extends FlagValue>(flagKey: string, defaultValue: T, resolver: (client: Client) => (flagKey: string, defaultValue: T) => EvaluationDetails<T>, options?: ReactFlagEvaluationOptions): EvaluationDetails<T> {\n  const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };\n  const [, updateState] = useState<object | undefined>();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const client = useOpenFeatureClient();\n\n  useEffect(() => {\n\n    if (client.providerStatus !== ProviderStatus.READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspend) {\n        suspend(client, updateState);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n    }\n\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers (we can do this unconditionally with no impact)\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, [client]);\n\n  return resolver(client).call(client, flagKey, defaultValue);\n}\n\n/**\n * Suspend function. If this runs, components using the calling hook will be suspended.\n * @param {Client} client the OpenFeature client\n * @param {Function} updateState the state update function\n */\nfunction suspend(client: Client, updateState: Dispatch<SetStateAction<object | undefined>>) {\n  let suspendResolver: () => void;\n  let suspendRejecter: () => void;\n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      client.removeHandler(ProviderEvents.Ready, suspendResolver); // remove handler once it's run\n    };\n    suspendRejecter = () => {\n      resolve(); // we still resolve here, since we don't want to throw errors\n      client.removeHandler(ProviderEvents.Error, suspendRejecter); // remove handler once it's run\n    };\n    client.addHandler(ProviderEvents.Ready, suspendResolver);\n    client.addHandler(ProviderEvents.Error, suspendRejecter);\n  });\n  updateState(suspenseWrapper(suspendPromise));\n}\n\n/**\n * Promise wrapper that throws unresolved promises to support React suspense.\n * @param {Promise<T>} promise to wrap\n * @template T flag type\n * @returns {Function} suspense-compliant lambda\n */\nfunction suspenseWrapper <T>(promise: Promise<T>) {\n  let status: SuspendState = SuspendState.Pending;\n  let result: T;\n\n  const suspended = promise.then(\n    (value) => {\n      status = SuspendState.Success;\n      result = value;\n    },\n    (error) => {\n      status = SuspendState.Error;\n      result = error;\n    }\n  );\n\n  return () => {\n    switch (status) {\n      case SuspendState.Pending:\n        throw suspended;\n      case SuspendState.Success:\n        return result;\n      case SuspendState.Error:\n        throw result;\n      default:\n        throw new Error('Suspending promise is in an unknown state.');\n    }\n  };\n};", "import * as React from 'react';\nimport { Client, OpenFeature } from '@openfeature/web-sdk';\n\ntype ClientOrClientName =\n  | {\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName: string;\n      /**\n       * OpenFeature client to use.\n       */\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client: Client;\n      /**\n       * The name of the client.\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      clientName?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrClientName;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, clientName, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(clientName);\n  }\n\n  return <Context.Provider value={client}>{children}</Context.Provider>;\n};\n\nexport const useOpenFeatureClient = () => {\n  const client = React.useContext(Context);\n\n  if (!client) {\n    throw new Error(\n      'No OpenFeature client available - components using OpenFeature must be wrapped with an <OpenFeatureProvider>'\n    );\n  }\n\n  return client;\n};\n", "export * from './use-feature-flag';\nexport * from './provider';\n// re-export the web-sdk so consumers can access that API from the react-sdk\nexport * from '@openfeature/web-sdk';\n"],
+  "mappings": ";;;;;;;;;;;;;;;;;;AAAA,SAAiF,gBAAgB,sBAAsB;AACvH,SAAmC,WAAW,gBAAgB;;;ACD9D,YAAY,WAAW;AACvB,SAAiB,mBAAmB;AA8BpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,YAAY,SAAS,MAAqB;AACtF,MAAI,CAAC,QAAQ;AACX,aAAS,YAAY,UAAU,UAAU;AAAA,EAC3C;AAEA,SAAO,oCAAC,QAAQ,UAAR,EAAiB,OAAO,UAAS,QAAS;AACpD;AAEO,IAAM,uBAAuB,MAAM;AACxC,QAAM,SAAe,iBAAW,OAAO;AAEvC,MAAI,CAAC,QAAQ;AACX,UAAM,IAAI;AAAA,MACR;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;;;ADxBA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,SAAS;AACX;AAgBO,SAAS,oBAAoB,SAAiB,cAAuB,SAA+C;AACzH,SAAO,sBAAsB,SAAS,cAAc,OAAO,EAAE;AAC/D;AAUO,SAAS,sBAAsB,SAAiB,cAAuB,SAAkE;AAC9I,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAWO,SAAS,mBAA8C,SAAiB,cAAiB,SAAyC;AACvI,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAWO,SAAS,qBAAgD,SAAiB,cAAiB,SAA4D;AAC5J,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAWO,SAAS,mBAA8C,SAAiB,cAAiB,SAAyC;AACvI,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAWO,SAAS,qBAAgD,SAAiB,cAAiB,SAA4D;AAC5J,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAWO,SAAS,mBAAoD,SAAiB,cAAiB,SAAyC;AAC7I,SAAO,qBAAwB,SAAS,cAAc,OAAO,EAAE;AACjE;AAWO,SAAS,qBAAsD,SAAiB,cAAiB,SAA4D;AAClK,SAAO,yBAAyB,SAAS,cAAc,CAAC,WAAW;AACjE,WAAO,OAAO;AAAA,EAChB,GAAI,OAAO;AACb;AAEA,SAAS,yBAA8C,SAAiB,cAAiB,UAA0F,SAA4D;AAC7O,QAAM,mBAAmB,kCAAK,kBAAoB;AAClD,QAAM,CAAC,EAAE,WAAW,IAAI,SAA6B;AACrD,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,SAAS,qBAAqB;AAEpC,YAAU,MAAM;AAEd,QAAI,OAAO,mBAAmB,eAAe,OAAO;AAElD,aAAO,WAAW,eAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,SAAS;AAC5B,gBAAQ,QAAQ,WAAW;AAAA,MAC7B;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,eAAe,gBAAgB,WAAW;AAAA,IAC9D;AAEA,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,eAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,eAAe,OAAO,WAAW;AACtD,aAAO,cAAc,eAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,eAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,MAAM,CAAC;AAEX,SAAO,SAAS,MAAM,EAAE,KAAK,QAAQ,SAAS,YAAY;AAC5D;AAOA,SAAS,QAAQ,QAAgB,aAA2D;AAC1F,MAAI;AACJ,MAAI;AACJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,eAAe,OAAO,eAAe;AAAA,IAC5D;AACA,sBAAkB,MAAM;AACtB,cAAQ;AACR,aAAO,cAAc,eAAe,OAAO,eAAe;AAAA,IAC5D;AACA,WAAO,WAAW,eAAe,OAAO,eAAe;AACvD,WAAO,WAAW,eAAe,OAAO,eAAe;AAAA,EACzD,CAAC;AACD,cAAY,gBAAgB,cAAc,CAAC;AAC7C;AAQA,SAAS,gBAAoB,SAAqB;AAChD,MAAI,SAAuB;AAC3B,MAAI;AAEJ,QAAM,YAAY,QAAQ;AAAA,IACxB,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,IACA,CAAC,UAAU;AACT,eAAS;AACT,eAAS;AAAA,IACX;AAAA,EACF;AAEA,SAAO,MAAM;AACX,YAAQ,QAAQ;AAAA,MACd,KAAK;AACH,cAAM;AAAA,MACR,KAAK;AACH,eAAO;AAAA,MACT,KAAK;AACH,cAAM;AAAA,MACR;AACE,cAAM,IAAI,MAAM,4CAA4C;AAAA,IAChE;AAAA,EACF;AACF;;;AEhPA,cAAc;",
   "names": []
 }

package/dist/types.d.ts

@@ -1014,15 +1014,84 @@ type ReactFlagEvaluationOptions = {
      */
     updateOnContextChanged?: boolean;
 } & FlagEvaluationOptions;
+/**
+ * Evaluates a feature flag, returning a boolean.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @param {boolean} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { boolean} a EvaluationDetails object for this evaluation
+ */
+declare function useBooleanFlagValue(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): boolean;
+/**
+ * Evaluates a feature flag, returning evaluation details.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @param {boolean} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { EvaluationDetails<boolean>} a EvaluationDetails object for this evaluation
+ */
+declare function useBooleanFlagDetails(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): EvaluationDetails<boolean>;
+/**
+ * Evaluates a feature flag, returning a string.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @template {string} [T=string] A optional generic argument constraining the string
+ * @param {T} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { boolean} a EvaluationDetails object for this evaluation
+ */
+declare function useStringFlagValue<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T;
+/**
+ * Evaluates a feature flag, returning evaluation details.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @template {string} [T=string] A optional generic argument constraining the string
+ * @param {T} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { EvaluationDetails<string>} a EvaluationDetails object for this evaluation
+ */
+declare function useStringFlagDetails<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T>;
+/**
+ * Evaluates a feature flag, returning a number.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @template {number} [T=number] A optional generic argument constraining the number
+ * @param {T} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { boolean} a EvaluationDetails object for this evaluation
+ */
+declare function useNumberFlagValue<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T;
+/**
+ * Evaluates a feature flag, returning evaluation details.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @template {number} [T=number] A optional generic argument constraining the number
+ * @param {T} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { EvaluationDetails<number>} a EvaluationDetails object for this evaluation
+ */
+declare function useNumberFlagDetails<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T>;
+/**
+ * Evaluates a feature flag, returning an object.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure
+ * @param {T} defaultValue the default value
+ * @param {ReactFlagEvaluationOptions} options options for this evaluation
+ * @returns { boolean} a EvaluationDetails object for this evaluation
+ */
+declare function useObjectFlagValue<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): T;
 /**
  * Evaluates a feature flag, returning evaluation details.
- * @param {string}flagKey the flag identifier
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
  * @param {T} defaultValue the default value
+ * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure
  * @param {ReactFlagEvaluationOptions} options options for this evaluation
- * @template T flag type
  * @returns { EvaluationDetails<T>} a EvaluationDetails object for this evaluation
  */
-declare function useFeatureFlag<T extends FlagValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T>;
+declare function useObjectFlagDetails<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T>;
 
 type ClientOrClientName = {
     /**
@@ -1051,4 +1120,4 @@ type ProviderProps = {
 declare const OpenFeatureProvider: ({ client, clientName, children }: ProviderProps) => React.JSX.Element;
 declare const useOpenFeatureClient: () => Client;
 
-export { ClientProviderEvents as AllProviderEvents, AnyProviderEvent, BaseHook, BeforeHookContext, Client, ClientMetadata, ClientProviderEvents, CommonEventDetails, CommonProvider, ConfigChangeEvent, DefaultLogger, ErrorCode, ErrorEvent, EvaluationContext, EvaluationContextValue, EvaluationDetails, EvaluationLifeCycle, EventContext, EventDetails, EventHandler, EventMetadata, Eventing, Features, FlagEvaluationOptions, FlagMetadata, FlagNotFoundError, FlagValue, FlagValueType, GeneralError, GenericEventEmitter, Hook, HookContext, HookHints, InMemoryProvider, InvalidContextError, JsonArray, JsonObject, JsonValue, LOG_LEVELS, Logger, ManageContext, ManageLogger, Metadata, NOOP_PROVIDER, OpenFeature, OpenFeatureAPI, OpenFeatureClient, OpenFeatureCommonAPI, OpenFeatureError, OpenFeatureEventEmitter, OpenFeatureProvider, Paradigm, ParseError, PrimitiveValue, Provider, ProviderEmittableEvents, ClientProviderEvents as ProviderEvents, ProviderMetadata, ProviderNotReadyError, ProviderStatus, ReadyEvent, ResolutionDetails, ResolutionReason, SafeLogger, ServerProviderEvents, StaleEvent, StandardResolutionReasons, TargetingKeyMissingError, TypeMismatchError, isObject, isString, objectOrUndefined, statusMatchesEvent, stringOrUndefined, useFeatureFlag, useOpenFeatureClient };
+export { ClientProviderEvents as AllProviderEvents, AnyProviderEvent, BaseHook, BeforeHookContext, Client, ClientMetadata, ClientProviderEvents, CommonEventDetails, CommonProvider, ConfigChangeEvent, DefaultLogger, ErrorCode, ErrorEvent, EvaluationContext, EvaluationContextValue, EvaluationDetails, EvaluationLifeCycle, EventContext, EventDetails, EventHandler, EventMetadata, Eventing, Features, FlagEvaluationOptions, FlagMetadata, FlagNotFoundError, FlagValue, FlagValueType, GeneralError, GenericEventEmitter, Hook, HookContext, HookHints, InMemoryProvider, InvalidContextError, JsonArray, JsonObject, JsonValue, LOG_LEVELS, Logger, ManageContext, ManageLogger, Metadata, NOOP_PROVIDER, OpenFeature, OpenFeatureAPI, OpenFeatureClient, OpenFeatureCommonAPI, OpenFeatureError, OpenFeatureEventEmitter, OpenFeatureProvider, Paradigm, ParseError, PrimitiveValue, Provider, ProviderEmittableEvents, ClientProviderEvents as ProviderEvents, ProviderMetadata, ProviderNotReadyError, ProviderStatus, ReadyEvent, ResolutionDetails, ResolutionReason, SafeLogger, ServerProviderEvents, StaleEvent, StandardResolutionReasons, TargetingKeyMissingError, TypeMismatchError, isObject, isString, objectOrUndefined, statusMatchesEvent, stringOrUndefined, useBooleanFlagDetails, useBooleanFlagValue, useNumberFlagDetails, useNumberFlagValue, useObjectFlagDetails, useObjectFlagValue, useOpenFeatureClient, useStringFlagDetails, useStringFlagValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/react-sdk",
-  "version": "0.0.6-experimental",
+  "version": "0.1.0-experimental",
   "description": "OpenFeature React SDK",
   "main": "./dist/cjs/index.js",
   "files": [