@openfeature/react-sdk 0.2.3-experimental → 0.2.4-experimental

package/README.md

@@ -16,8 +16,8 @@
     <img alt="Specification" src="https://img.shields.io/static/v1?label=specification&message=v0.7.0&color=yellow&style=for-the-badge" />
   </a>
   <!-- x-release-please-start-version -->
-  <a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.2.3-experimental">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.3-experimental&color=blue&style=for-the-badge" />
+  <a href="https://github.com/open-feature/js-sdk/releases/tag/react-sdk-v0.2.4-experimental">
+    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.4-experimental&color=blue&style=for-the-badge" />
   </a>
   <!-- x-release-please-end -->
   <br/>
@@ -87,10 +87,12 @@ The following list contains the peer dependencies of `@openfeature/react-sdk` wi
 
 ### Usage
 
+The `OpenFeatureProvider` represents a scope for feature flag evaluations within a React application.
+It binds an OpenFeature client to all evaluations within child components, and allows the use of evaluation hooks.
 The example below shows how to use the `OpenFeatureProvider` with OpenFeature's `InMemoryProvider`.
 
 ```tsx
-import { EvaluationContext, OpenFeatureProvider, useBooleanFlagValue, useBooleanFlagDetails, OpenFeature, InMemoryProvider } from '@openfeature/react-sdk';
+import { EvaluationContext, OpenFeatureProvider, useFlag, OpenFeature, InMemoryProvider } from '@openfeature/react-sdk';
 
 const flagConfig = {
   'new-message': {
@@ -109,8 +111,11 @@ const flagConfig = {
   },
 };
 
+// Instantiate and set our provider (be sure this only happens once)!
+// Note: there's no need to await its initialization, the React SDK handles re-rendering and suspense for you!
 OpenFeature.setProvider(new InMemoryProvider(flagConfig));
 
+// Enclose your content in the configured provider
 function App() {
   return (
     <OpenFeatureProvider>
@@ -120,11 +125,12 @@ function App() {
 }
 
 function Page() {
-  const newMessage = useBooleanFlagValue('new-message', false);
+  // Use the "query-style" flag evaluation hook.
+  const { value: showNewMessage } = useFlag('new-message', true);
   return (
     <div className="App">
       <header className="App-header">
-        {newMessage ? <p>Welcome to this OpenFeature-enabled React app!</p> : <p>Welcome to this React app.</p>}
+        {showNewMessage ? <p>Welcome to this OpenFeature-enabled React app!</p> : <p>Welcome to this React app.</p>}
       </header>
     </div>
   )
@@ -132,12 +138,19 @@ function Page() {
 
 export default App;
 ```
+You can use the strongly-typed flag value and flag evaluation detail hooks as well, if you prefer.
 
-You use the detailed flag evaluation hooks to evaluate the flag and get additional information about the flag and the evaluation.
+```tsx
+import { useBooleanFlagValue } from '@openfeature/react-sdk';
+
+// boolean flag evaluation
+const value = useBooleanFlagValue('new-message', false);
+```
 
 ```tsx
 import { useBooleanFlagDetails } from '@openfeature/react-sdk';
 
+// "detailed" boolean flag evaluation
 const {
   value,
   variant,
@@ -178,7 +191,7 @@ You can disable this feature in the hook options:
 
 ```tsx
 function Page() {
-  const newMessage = useBooleanFlagValue('new-message', false, { updateOnContextChanged: false });
+  const showNewMessage = useBooleanFlagValue('new-message', false, { updateOnContextChanged: false });
   return (
     <MyComponents></MyComponents>
   )
@@ -195,7 +208,7 @@ You can disable this feature in the hook options:
 
 ```tsx
 function Page() {
-  const newMessage = useBooleanFlagValue('new-message', false, { updateOnConfigurationChanged: false });
+  const showNewMessage = useBooleanFlagValue('new-message', false, { updateOnConfigurationChanged: false });
   return (
     <MyComponents></MyComponents>
   )
@@ -222,11 +235,11 @@ function Content() {
 
 function Message() {
   // component to render after READY.
-  const newMessage = useBooleanFlagValue('new-message', false);
+  const showNewMessage = useBooleanFlagValue('new-message', false);
 
   return (
     <>
-      {newMessage ? (
+      {showNewMessage ? (
         <p>Welcome to this OpenFeature-enabled React app!</p>
       ) : (
         <p>Welcome to this plain old React app!</p>

package/dist/cjs/index.js

@@ -34,6 +34,7 @@ __export(src_exports, {
   OpenFeatureProvider: () => OpenFeatureProvider,
   useBooleanFlagDetails: () => useBooleanFlagDetails,
   useBooleanFlagValue: () => useBooleanFlagValue,
+  useFlag: () => useFlag,
   useNumberFlagDetails: () => useNumberFlagDetails,
   useNumberFlagValue: () => useNumberFlagValue,
   useObjectFlagDetails: () => useObjectFlagDetails,
@@ -44,11 +45,11 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/use-feature-flag.ts
+// src/evaluation/use-feature-flag.ts
 var import_web_sdk2 = require("@openfeature/web-sdk");
 var import_react = require("react");
 
-// src/provider.tsx
+// src/provider/provider.tsx
 var React = __toESM(require("react"));
 var import_web_sdk = require("@openfeature/web-sdk");
 var Context = React.createContext(void 0);
@@ -68,44 +69,68 @@ var useOpenFeatureClient = () => {
   return client;
 };
 
-// src/use-feature-flag.ts
+// src/evaluation/use-feature-flag.ts
 var DEFAULT_OPTIONS = {
   updateOnContextChanged: true,
   updateOnConfigurationChanged: true,
   suspendUntilReady: true,
   suspendWhileReconciling: false
 };
+function useFlag(flagKey, defaultValue, options) {
+  const query = typeof defaultValue === "boolean" ? new HookFlagQuery(useBooleanFlagDetails(flagKey, defaultValue, options)) : typeof defaultValue === "number" ? new HookFlagQuery(useNumberFlagDetails(flagKey, defaultValue, options)) : typeof defaultValue === "string" ? new HookFlagQuery(useStringFlagDetails(flagKey, defaultValue, options)) : new HookFlagQuery(useObjectFlagDetails(flagKey, defaultValue, options));
+  return query;
+}
 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);
+  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);
+  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);
+  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);
+  return attachHandlersAndResolve(
+    flagKey,
+    defaultValue,
+    (client) => {
+      return client.getObjectDetails;
+    },
+    options
+  );
 }
 function attachHandlersAndResolve(flagKey, defaultValue, resolver, options) {
   const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };
@@ -115,7 +140,13 @@ function attachHandlersAndResolve(flagKey, defaultValue, resolver, options) {
     updateState({});
   };
   const suspendRef = () => {
-    suspend(client, updateState, import_web_sdk2.ProviderEvents.ContextChanged, import_web_sdk2.ProviderEvents.ConfigurationChanged, import_web_sdk2.ProviderEvents.Ready);
+    suspend(
+      client,
+      updateState,
+      import_web_sdk2.ProviderEvents.ContextChanged,
+      import_web_sdk2.ProviderEvents.ConfigurationChanged,
+      import_web_sdk2.ProviderEvents.Ready
+    );
   };
   (0, import_react.useEffect)(() => {
     if (client.providerStatus === import_web_sdk2.ProviderStatus.NOT_READY) {
@@ -166,16 +197,13 @@ function suspend(client, updateState, ...resumeEvents) {
 function suspenseWrapper(promise) {
   let status = 0 /* Pending */;
   let result;
-  const suspended = promise.then(
-    (value) => {
-      status = 1 /* Success */;
-      result = value;
-    },
-    (error) => {
-      status = 2 /* Error */;
-      result = error;
-    }
-  );
+  const suspended = promise.then((value) => {
+    status = 1 /* Success */;
+    result = value;
+  }).catch((error) => {
+    status = 2 /* Error */;
+    result = error;
+  });
   return () => {
     switch (status) {
       case 0 /* Pending */:
@@ -189,6 +217,41 @@ function suspenseWrapper(promise) {
     }
   };
 }
+var HookFlagQuery = class {
+  constructor(_details) {
+    this._details = _details;
+  }
+  get details() {
+    return this._details;
+  }
+  get value() {
+    return this._details?.value;
+  }
+  get variant() {
+    return this._details.variant;
+  }
+  get flagMetadata() {
+    return this._details.flagMetadata;
+  }
+  get reason() {
+    return this._details.reason;
+  }
+  get isError() {
+    return !!this._details?.errorCode || this._details.reason == import_web_sdk2.StandardResolutionReasons.ERROR;
+  }
+  get errorCode() {
+    return this._details?.errorCode;
+  }
+  get errorMessage() {
+    return this._details?.errorMessage;
+  }
+  get isAuthoritative() {
+    return !this.isError && this._details.reason != import_web_sdk2.StandardResolutionReasons.STALE && this._details.reason != import_web_sdk2.StandardResolutionReasons.DISABLED;
+  }
+  get type() {
+    return typeof this._details.value;
+  }
+};
 
 // src/index.ts
 __reExport(src_exports, require("@openfeature/web-sdk"), module.exports);

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, 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 show suspense fallbacks until the provider is initialized.\n   * Defaults to true.\n   */\n  suspendUntilReady?: boolean,\n  /**\n   * Suspend flag evaluations while the provider's context is being reconciled.\n   * Set to true if you want to show suspense fallbacks while flags are re-evaluated after context changes.\n   * Defaults to false.\n   */\n  suspendWhileReconciling?: 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  suspendUntilReady: true,\n  suspendWhileReconciling: false,\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 client = useOpenFeatureClient();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const suspendRef = () => {\n    suspend(client, updateState, ProviderEvents.ContextChanged, ProviderEvents.ConfigurationChanged, ProviderEvents.Ready);\n  };\n\n  useEffect(() => {\n    if (client.providerStatus === ProviderStatus.NOT_READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspendUntilReady) {\n        suspend(client, updateState, ProviderEvents.Ready);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n      if (defaultedOptions.suspendWhileReconciling) {\n        client.addHandler(ProviderEvents.Reconciling, suspendRef);\n      }\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.Reconciling, suspendRef);\n    };\n  }, []);\n  \n  useEffect(() => {\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, []);\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 * @param {ProviderEvents[]} resumeEvents list of events which will resume the suspend\n */\nfunction suspend(client: Client, updateState: Dispatch<SetStateAction<object | undefined>>, ...resumeEvents: ProviderEvents[]) {\n\n  let suspendResolver: () => void;\n  \n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      resumeEvents.forEach((e) => {\n        client.removeHandler(e, suspendResolver); // remove handlers once they've run\n      });\n      client.removeHandler(ProviderEvents.Error, suspendResolver);\n    };\n    resumeEvents.forEach((e) => {\n      client.addHandler(e, suspendResolver);\n    });\n    client.addHandler(ProviderEvents.Error, suspendResolver); // we never want to throw, resolve with errors - we may make this configurable later\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 ClientOrDomain =\n  | {\n      /**\n       * An identifier which logically binds clients with providers\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      domain?: string;\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client?: Client;\n      domain?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrDomain;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, domain, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(domain);\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;AAuBpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,QAAQ,SAAS,MAAqB;AAClF,MAAI,CAAC,QAAQ;AACX,aAAS,2BAAY,UAAU,MAAM;AAAA,EACvC;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;;;ADXA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,mBAAmB;AAAA,EACnB,yBAAyB;AAC3B;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,EAAE,GAAG,iBAAiB,GAAG,QAAQ;AAC1D,QAAM,CAAC,EAAE,WAAW,QAAI,uBAA6B;AACrD,QAAM,SAAS,qBAAqB;AACpC,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,aAAa,MAAM;AACvB,YAAQ,QAAQ,aAAa,+BAAe,gBAAgB,+BAAe,sBAAsB,+BAAe,KAAK;AAAA,EACvH;AAEA,8BAAU,MAAM;AACd,QAAI,OAAO,mBAAmB,+BAAe,WAAW;AAEtD,aAAO,WAAW,+BAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,mBAAmB;AACtC,gBAAQ,QAAQ,aAAa,+BAAe,KAAK;AAAA,MACnD;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,+BAAe,gBAAgB,WAAW;AAC5D,UAAI,iBAAiB,yBAAyB;AAC5C,eAAO,WAAW,+BAAe,aAAa,UAAU;AAAA,MAC1D;AAAA,IACF;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,+BAAe,OAAO,WAAW;AACtD,aAAO,cAAc,+BAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,+BAAe,aAAa,UAAU;AAAA,IAC7D;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,8BAAU,MAAM;AACd,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,+BAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,+BAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO,SAAS,MAAM,EAAE,KAAK,QAAQ,SAAS,YAAY;AAC5D;AAQA,SAAS,QAAQ,QAAgB,gBAA8D,cAAgC;AAE7H,MAAI;AAEJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,mBAAa,QAAQ,CAAC,MAAM;AAC1B,eAAO,cAAc,GAAG,eAAe;AAAA,MACzC,CAAC;AACD,aAAO,cAAc,+BAAe,OAAO,eAAe;AAAA,IAC5D;AACA,iBAAa,QAAQ,CAAC,MAAM;AAC1B,aAAO,WAAW,GAAG,eAAe;AAAA,IACtC,CAAC;AACD,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;;;ADrQA,wBAAc,iCAHd;",
+  "sources": ["../../src/index.ts", "../../src/evaluation/use-feature-flag.ts", "../../src/provider/provider.tsx"],
+  "sourcesContent": ["export * from './evaluation';\nexport * from './query';\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 {\n  Client,\n  EvaluationDetails,\n  FlagEvaluationOptions,\n  FlagValue,\n  JsonValue,\n  ProviderEvents,\n  ProviderStatus,\n  StandardResolutionReasons,\n} from '@openfeature/web-sdk';\nimport { Dispatch, SetStateAction, useEffect, useState } from 'react';\nimport { useOpenFeatureClient } from '../provider';\nimport { FlagQuery } from '../query';\n\ntype ReactFlagEvaluationOptions = {\n  /**\n   * Suspend flag evaluations while the provider is not ready.\n   * Set to false if you don't want to show suspense fallbacks until the provider is initialized.\n   * Defaults to true.\n   */\n  suspendUntilReady?: boolean;\n  /**\n   * Suspend flag evaluations while the provider's context is being reconciled.\n   * Set to true if you want to show suspense fallbacks while flags are re-evaluated after context changes.\n   * Defaults to false.\n   */\n  suspendWhileReconciling?: 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  suspendUntilReady: true,\n  suspendWhileReconciling: false,\n};\n\nenum SuspendState {\n  Pending,\n  Success,\n  Error,\n}\n\n// This type is a bit wild-looking, but I think we need it.\n// We have to use the conditional, because otherwise useFlag('key', false) would return false, not boolean (too constrained).\n// We have a duplicate for the hook return below, this one is just used for casting because the name isn't as clear\ntype ConstrainedFlagQuery<T> = FlagQuery<\n  T extends boolean\n    ? boolean\n    : T extends number\n      ? number\n      : T extends string\n        ? string\n        : T extends JsonValue\n          ? T\n          : JsonValue\n>;\n\n/**\n * Evaluates a feature flag generically, returning an react-flavored queryable object.\n * The resolver method to use is based on the type of the defaultValue.\n * For type-specific hooks, use {@link useBooleanFlagValue}, {@link useBooleanFlagDetails} and equivalents.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {FlagValue} T A optional generic argument constraining the default.\n * @param {T} defaultValue the default value; used to determine what resolved type should be used.\n * @param {ReactFlagEvaluationOptions} options for this evaluation\n * @returns { FlagQuery } a queryable object containing useful information about the flag.\n */\nexport function useFlag<T extends FlagValue = FlagValue>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): FlagQuery<\nT extends boolean\n  ? boolean\n  : T extends number\n    ? number\n    : T extends string\n      ? string\n      : T extends JsonValue\n        ? T\n        : JsonValue\n> {\n  // use the default value to determine the resolver to call\n  const query =\n    typeof defaultValue === 'boolean'\n      ? new HookFlagQuery<boolean>(useBooleanFlagDetails(flagKey, defaultValue, options))\n      : typeof defaultValue === 'number'\n        ? new HookFlagQuery<number>(useNumberFlagDetails(flagKey, defaultValue, options))\n        : typeof defaultValue === 'string'\n          ? new HookFlagQuery<string>(useStringFlagDetails(flagKey, defaultValue, options))\n          : new HookFlagQuery<JsonValue>(useObjectFlagDetails(flagKey, defaultValue, options));\n  // TS sees this as HookFlagQuery<JsonValue>, because the compiler isn't aware of the `typeof` checks above.\n  return query as unknown as ConstrainedFlagQuery<T>;\n}\n\n/**\n * Evaluates a feature flag, returning a boolean.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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(\n  flagKey: string,\n  defaultValue: boolean,\n  options?: ReactFlagEvaluationOptions,\n): 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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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(\n  flagKey: string,\n  defaultValue: boolean,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<boolean> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getBooleanDetails;\n    },\n    options,\n  );\n}\n\n/**\n * Evaluates a feature flag, returning a string.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): string {\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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<string> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getStringDetails<T>;\n    },\n    options,\n  );\n}\n\n/**\n * Evaluates a feature flag, returning a number.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): number {\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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<number> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getNumberDetails<T>;\n    },\n    options,\n  );\n}\n\n/**\n * Evaluates a feature flag, returning an object.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): 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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<T> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getObjectDetails<T>;\n    },\n    options,\n  );\n}\n\nfunction attachHandlersAndResolve<T extends FlagValue>(\n  flagKey: string,\n  defaultValue: T,\n  resolver: (client: Client) => (flagKey: string, defaultValue: T) => EvaluationDetails<T>,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<T> {\n  const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };\n  const [, updateState] = useState<object | undefined>();\n  const client = useOpenFeatureClient();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const suspendRef = () => {\n    suspend(\n      client,\n      updateState,\n      ProviderEvents.ContextChanged,\n      ProviderEvents.ConfigurationChanged,\n      ProviderEvents.Ready,\n    );\n  };\n\n  useEffect(() => {\n    if (client.providerStatus === ProviderStatus.NOT_READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspendUntilReady) {\n        suspend(client, updateState, ProviderEvents.Ready);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n      if (defaultedOptions.suspendWhileReconciling) {\n        client.addHandler(ProviderEvents.Reconciling, suspendRef);\n      }\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.Reconciling, suspendRef);\n    };\n  }, []);\n\n  useEffect(() => {\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, []);\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 * @param {ProviderEvents[]} resumeEvents list of events which will resume the suspend\n */\nfunction suspend(\n  client: Client,\n  updateState: Dispatch<SetStateAction<object | undefined>>,\n  ...resumeEvents: ProviderEvents[]\n) {\n  let suspendResolver: () => void;\n\n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      resumeEvents.forEach((e) => {\n        client.removeHandler(e, suspendResolver); // remove handlers once they've run\n      });\n      client.removeHandler(ProviderEvents.Error, suspendResolver);\n    };\n    resumeEvents.forEach((e) => {\n      client.addHandler(e, suspendResolver);\n    });\n    client.addHandler(ProviderEvents.Error, suspendResolver); // we never want to throw, resolve with errors - we may make this configurable later\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\n    .then((value) => {\n      status = SuspendState.Success;\n      result = value;\n    })\n    .catch((error) => {\n      status = SuspendState.Error;\n      result = error;\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}\n\n// FlagQuery implementation, do not export\nclass HookFlagQuery<T extends FlagValue = FlagValue> implements FlagQuery {\n  constructor(private _details: EvaluationDetails<T>) {}\n\n  get details() {\n    return this._details;\n  }\n\n  get value() {\n    return this._details?.value;\n  }\n\n  get variant() {\n    return this._details.variant;\n  }\n\n  get flagMetadata() {\n    return this._details.flagMetadata;\n  }\n\n  get reason() {\n    return this._details.reason;\n  }\n\n  get isError() {\n    return !!this._details?.errorCode || this._details.reason == StandardResolutionReasons.ERROR;\n  }\n\n  get errorCode() {\n    return this._details?.errorCode;\n  }\n\n  get errorMessage() {\n    return this._details?.errorMessage;\n  }\n\n  get isAuthoritative() {\n    return (\n      !this.isError &&\n      this._details.reason != StandardResolutionReasons.STALE &&\n      this._details.reason != StandardResolutionReasons.DISABLED\n    );\n  }\n\n  get type() {\n    return typeof this._details.value;\n  }\n}\n", "import * as React from 'react';\nimport { Client, OpenFeature } from '@openfeature/web-sdk';\n\ntype ClientOrDomain =\n  | {\n      /**\n       * An identifier which logically binds clients with providers\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      domain?: string;\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client?: Client;\n      domain?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrDomain;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, domain, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(domain);\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;AAAA;;;ACAA,IAAAA,kBASO;AACP,mBAA8D;;;ACV9D,YAAuB;AACvB,qBAAoC;AAuBpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,QAAQ,SAAS,MAAqB;AAClF,MAAI,CAAC,QAAQ;AACX,aAAS,2BAAY,UAAU,MAAM;AAAA,EACvC;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;;;ADDA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,mBAAmB;AAAA,EACnB,yBAAyB;AAC3B;AAkCO,SAAS,QACd,SACA,cACA,SAWA;AAEA,QAAM,QACJ,OAAO,iBAAiB,YACpB,IAAI,cAAuB,sBAAsB,SAAS,cAAc,OAAO,CAAC,IAChF,OAAO,iBAAiB,WACtB,IAAI,cAAsB,qBAAqB,SAAS,cAAc,OAAO,CAAC,IAC9E,OAAO,iBAAiB,WACtB,IAAI,cAAsB,qBAAqB,SAAS,cAAc,OAAO,CAAC,IAC9E,IAAI,cAAyB,qBAAqB,SAAS,cAAc,OAAO,CAAC;AAE3F,SAAO;AACT;AAWO,SAAS,oBACd,SACA,cACA,SACS;AACT,SAAO,sBAAsB,SAAS,cAAc,OAAO,EAAE;AAC/D;AAWO,SAAS,sBACd,SACA,cACA,SAC4B;AAC5B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAYO,SAAS,mBACd,SACA,cACA,SACQ;AACR,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAYO,SAAS,qBACd,SACA,cACA,SAC2B;AAC3B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAYO,SAAS,mBACd,SACA,cACA,SACQ;AACR,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAYO,SAAS,qBACd,SACA,cACA,SAC2B;AAC3B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAYO,SAAS,mBACd,SACA,cACA,SACG;AACH,SAAO,qBAAwB,SAAS,cAAc,OAAO,EAAE;AACjE;AAYO,SAAS,qBACd,SACA,cACA,SACsB;AACtB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,yBACP,SACA,cACA,UACA,SACsB;AACtB,QAAM,mBAAmB,EAAE,GAAG,iBAAiB,GAAG,QAAQ;AAC1D,QAAM,CAAC,EAAE,WAAW,QAAI,uBAA6B;AACrD,QAAM,SAAS,qBAAqB;AACpC,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,aAAa,MAAM;AACvB;AAAA,MACE;AAAA,MACA;AAAA,MACA,+BAAe;AAAA,MACf,+BAAe;AAAA,MACf,+BAAe;AAAA,IACjB;AAAA,EACF;AAEA,8BAAU,MAAM;AACd,QAAI,OAAO,mBAAmB,+BAAe,WAAW;AAEtD,aAAO,WAAW,+BAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,mBAAmB;AACtC,gBAAQ,QAAQ,aAAa,+BAAe,KAAK;AAAA,MACnD;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,+BAAe,gBAAgB,WAAW;AAC5D,UAAI,iBAAiB,yBAAyB;AAC5C,eAAO,WAAW,+BAAe,aAAa,UAAU;AAAA,MAC1D;AAAA,IACF;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,+BAAe,OAAO,WAAW;AACtD,aAAO,cAAc,+BAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,+BAAe,aAAa,UAAU;AAAA,IAC7D;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,8BAAU,MAAM;AACd,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,+BAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,+BAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO,SAAS,MAAM,EAAE,KAAK,QAAQ,SAAS,YAAY;AAC5D;AAQA,SAAS,QACP,QACA,gBACG,cACH;AACA,MAAI;AAEJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,mBAAa,QAAQ,CAAC,MAAM;AAC1B,eAAO,cAAc,GAAG,eAAe;AAAA,MACzC,CAAC;AACD,aAAO,cAAc,+BAAe,OAAO,eAAe;AAAA,IAC5D;AACA,iBAAa,QAAQ,CAAC,MAAM;AAC1B,aAAO,WAAW,GAAG,eAAe;AAAA,IACtC,CAAC;AACD,WAAO,WAAW,+BAAe,OAAO,eAAe;AAAA,EACzD,CAAC;AACD,cAAY,gBAAgB,cAAc,CAAC;AAC7C;AAQA,SAAS,gBAAmB,SAAqB;AAC/C,MAAI,SAAuB;AAC3B,MAAI;AAEJ,QAAM,YAAY,QACf,KAAK,CAAC,UAAU;AACf,aAAS;AACT,aAAS;AAAA,EACX,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,aAAS;AACT,aAAS;AAAA,EACX,CAAC;AAEH,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;AAGA,IAAM,gBAAN,MAA0E;AAAA,EACxE,YAAoB,UAAgC;AAAhC;AAAA,EAAiC;AAAA,EAErD,IAAI,UAAU;AACZ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,CAAC,CAAC,KAAK,UAAU,aAAa,KAAK,SAAS,UAAU,0CAA0B;AAAA,EACzF;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA,EAEA,IAAI,kBAAkB;AACpB,WACE,CAAC,KAAK,WACN,KAAK,SAAS,UAAU,0CAA0B,SAClD,KAAK,SAAS,UAAU,0CAA0B;AAAA,EAEtD;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,OAAO,KAAK,SAAS;AAAA,EAC9B;AACF;;;AD9bA,wBAAc,iCAJd;",
   "names": ["import_web_sdk"]
 }

package/dist/esm/index.js

@@ -1,8 +1,12 @@
-// src/use-feature-flag.ts
-import { ProviderEvents, ProviderStatus } from "@openfeature/web-sdk";
+// src/evaluation/use-feature-flag.ts
+import {
+  ProviderEvents,
+  ProviderStatus,
+  StandardResolutionReasons
+} from "@openfeature/web-sdk";
 import { useEffect, useState } from "react";
 
-// src/provider.tsx
+// src/provider/provider.tsx
 import * as React from "react";
 import { OpenFeature } from "@openfeature/web-sdk";
 var Context = React.createContext(void 0);
@@ -22,44 +26,68 @@ var useOpenFeatureClient = () => {
   return client;
 };
 
-// src/use-feature-flag.ts
+// src/evaluation/use-feature-flag.ts
 var DEFAULT_OPTIONS = {
   updateOnContextChanged: true,
   updateOnConfigurationChanged: true,
   suspendUntilReady: true,
   suspendWhileReconciling: false
 };
+function useFlag(flagKey, defaultValue, options) {
+  const query = typeof defaultValue === "boolean" ? new HookFlagQuery(useBooleanFlagDetails(flagKey, defaultValue, options)) : typeof defaultValue === "number" ? new HookFlagQuery(useNumberFlagDetails(flagKey, defaultValue, options)) : typeof defaultValue === "string" ? new HookFlagQuery(useStringFlagDetails(flagKey, defaultValue, options)) : new HookFlagQuery(useObjectFlagDetails(flagKey, defaultValue, options));
+  return query;
+}
 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);
+  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);
+  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);
+  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);
+  return attachHandlersAndResolve(
+    flagKey,
+    defaultValue,
+    (client) => {
+      return client.getObjectDetails;
+    },
+    options
+  );
 }
 function attachHandlersAndResolve(flagKey, defaultValue, resolver, options) {
   const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };
@@ -69,7 +97,13 @@ function attachHandlersAndResolve(flagKey, defaultValue, resolver, options) {
     updateState({});
   };
   const suspendRef = () => {
-    suspend(client, updateState, ProviderEvents.ContextChanged, ProviderEvents.ConfigurationChanged, ProviderEvents.Ready);
+    suspend(
+      client,
+      updateState,
+      ProviderEvents.ContextChanged,
+      ProviderEvents.ConfigurationChanged,
+      ProviderEvents.Ready
+    );
   };
   useEffect(() => {
     if (client.providerStatus === ProviderStatus.NOT_READY) {
@@ -120,16 +154,13 @@ function suspend(client, updateState, ...resumeEvents) {
 function suspenseWrapper(promise) {
   let status = 0 /* Pending */;
   let result;
-  const suspended = promise.then(
-    (value) => {
-      status = 1 /* Success */;
-      result = value;
-    },
-    (error) => {
-      status = 2 /* Error */;
-      result = error;
-    }
-  );
+  const suspended = promise.then((value) => {
+    status = 1 /* Success */;
+    result = value;
+  }).catch((error) => {
+    status = 2 /* Error */;
+    result = error;
+  });
   return () => {
     switch (status) {
       case 0 /* Pending */:
@@ -143,6 +174,41 @@ function suspenseWrapper(promise) {
     }
   };
 }
+var HookFlagQuery = class {
+  constructor(_details) {
+    this._details = _details;
+  }
+  get details() {
+    return this._details;
+  }
+  get value() {
+    return this._details?.value;
+  }
+  get variant() {
+    return this._details.variant;
+  }
+  get flagMetadata() {
+    return this._details.flagMetadata;
+  }
+  get reason() {
+    return this._details.reason;
+  }
+  get isError() {
+    return !!this._details?.errorCode || this._details.reason == StandardResolutionReasons.ERROR;
+  }
+  get errorCode() {
+    return this._details?.errorCode;
+  }
+  get errorMessage() {
+    return this._details?.errorMessage;
+  }
+  get isAuthoritative() {
+    return !this.isError && this._details.reason != StandardResolutionReasons.STALE && this._details.reason != StandardResolutionReasons.DISABLED;
+  }
+  get type() {
+    return typeof this._details.value;
+  }
+};
 
 // src/index.ts
 export * from "@openfeature/web-sdk";
@@ -150,6 +216,7 @@ export {
   OpenFeatureProvider,
   useBooleanFlagDetails,
   useBooleanFlagValue,
+  useFlag,
   useNumberFlagDetails,
   useNumberFlagValue,
   useObjectFlagDetails,

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, 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 show suspense fallbacks until the provider is initialized.\n   * Defaults to true.\n   */\n  suspendUntilReady?: boolean,\n  /**\n   * Suspend flag evaluations while the provider's context is being reconciled.\n   * Set to true if you want to show suspense fallbacks while flags are re-evaluated after context changes.\n   * Defaults to false.\n   */\n  suspendWhileReconciling?: 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  suspendUntilReady: true,\n  suspendWhileReconciling: false,\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 client = useOpenFeatureClient();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const suspendRef = () => {\n    suspend(client, updateState, ProviderEvents.ContextChanged, ProviderEvents.ConfigurationChanged, ProviderEvents.Ready);\n  };\n\n  useEffect(() => {\n    if (client.providerStatus === ProviderStatus.NOT_READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspendUntilReady) {\n        suspend(client, updateState, ProviderEvents.Ready);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n      if (defaultedOptions.suspendWhileReconciling) {\n        client.addHandler(ProviderEvents.Reconciling, suspendRef);\n      }\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.Reconciling, suspendRef);\n    };\n  }, []);\n  \n  useEffect(() => {\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, []);\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 * @param {ProviderEvents[]} resumeEvents list of events which will resume the suspend\n */\nfunction suspend(client: Client, updateState: Dispatch<SetStateAction<object | undefined>>, ...resumeEvents: ProviderEvents[]) {\n\n  let suspendResolver: () => void;\n  \n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      resumeEvents.forEach((e) => {\n        client.removeHandler(e, suspendResolver); // remove handlers once they've run\n      });\n      client.removeHandler(ProviderEvents.Error, suspendResolver);\n    };\n    resumeEvents.forEach((e) => {\n      client.addHandler(e, suspendResolver);\n    });\n    client.addHandler(ProviderEvents.Error, suspendResolver); // we never want to throw, resolve with errors - we may make this configurable later\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 ClientOrDomain =\n  | {\n      /**\n       * An identifier which logically binds clients with providers\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      domain?: string;\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client?: Client;\n      domain?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrDomain;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, domain, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(domain);\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;AAuBpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,QAAQ,SAAS,MAAqB;AAClF,MAAI,CAAC,QAAQ;AACX,aAAS,YAAY,UAAU,MAAM;AAAA,EACvC;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;;;ADXA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,mBAAmB;AAAA,EACnB,yBAAyB;AAC3B;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,EAAE,GAAG,iBAAiB,GAAG,QAAQ;AAC1D,QAAM,CAAC,EAAE,WAAW,IAAI,SAA6B;AACrD,QAAM,SAAS,qBAAqB;AACpC,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,aAAa,MAAM;AACvB,YAAQ,QAAQ,aAAa,eAAe,gBAAgB,eAAe,sBAAsB,eAAe,KAAK;AAAA,EACvH;AAEA,YAAU,MAAM;AACd,QAAI,OAAO,mBAAmB,eAAe,WAAW;AAEtD,aAAO,WAAW,eAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,mBAAmB;AACtC,gBAAQ,QAAQ,aAAa,eAAe,KAAK;AAAA,MACnD;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,eAAe,gBAAgB,WAAW;AAC5D,UAAI,iBAAiB,yBAAyB;AAC5C,eAAO,WAAW,eAAe,aAAa,UAAU;AAAA,MAC1D;AAAA,IACF;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,eAAe,OAAO,WAAW;AACtD,aAAO,cAAc,eAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,eAAe,aAAa,UAAU;AAAA,IAC7D;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,YAAU,MAAM;AACd,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,eAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,eAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO,SAAS,MAAM,EAAE,KAAK,QAAQ,SAAS,YAAY;AAC5D;AAQA,SAAS,QAAQ,QAAgB,gBAA8D,cAAgC;AAE7H,MAAI;AAEJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,mBAAa,QAAQ,CAAC,MAAM;AAC1B,eAAO,cAAc,GAAG,eAAe;AAAA,MACzC,CAAC;AACD,aAAO,cAAc,eAAe,OAAO,eAAe;AAAA,IAC5D;AACA,iBAAa,QAAQ,CAAC,MAAM;AAC1B,aAAO,WAAW,GAAG,eAAe;AAAA,IACtC,CAAC;AACD,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;;;AErQA,cAAc;",
+  "sources": ["../../src/evaluation/use-feature-flag.ts", "../../src/provider/provider.tsx", "../../src/index.ts"],
+  "sourcesContent": ["import {\n  Client,\n  EvaluationDetails,\n  FlagEvaluationOptions,\n  FlagValue,\n  JsonValue,\n  ProviderEvents,\n  ProviderStatus,\n  StandardResolutionReasons,\n} from '@openfeature/web-sdk';\nimport { Dispatch, SetStateAction, useEffect, useState } from 'react';\nimport { useOpenFeatureClient } from '../provider';\nimport { FlagQuery } from '../query';\n\ntype ReactFlagEvaluationOptions = {\n  /**\n   * Suspend flag evaluations while the provider is not ready.\n   * Set to false if you don't want to show suspense fallbacks until the provider is initialized.\n   * Defaults to true.\n   */\n  suspendUntilReady?: boolean;\n  /**\n   * Suspend flag evaluations while the provider's context is being reconciled.\n   * Set to true if you want to show suspense fallbacks while flags are re-evaluated after context changes.\n   * Defaults to false.\n   */\n  suspendWhileReconciling?: 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  suspendUntilReady: true,\n  suspendWhileReconciling: false,\n};\n\nenum SuspendState {\n  Pending,\n  Success,\n  Error,\n}\n\n// This type is a bit wild-looking, but I think we need it.\n// We have to use the conditional, because otherwise useFlag('key', false) would return false, not boolean (too constrained).\n// We have a duplicate for the hook return below, this one is just used for casting because the name isn't as clear\ntype ConstrainedFlagQuery<T> = FlagQuery<\n  T extends boolean\n    ? boolean\n    : T extends number\n      ? number\n      : T extends string\n        ? string\n        : T extends JsonValue\n          ? T\n          : JsonValue\n>;\n\n/**\n * Evaluates a feature flag generically, returning an react-flavored queryable object.\n * The resolver method to use is based on the type of the defaultValue.\n * For type-specific hooks, use {@link useBooleanFlagValue}, {@link useBooleanFlagDetails} and equivalents.\n * By default, components will re-render when the flag value changes.\n * @param {string} flagKey the flag identifier\n * @template {FlagValue} T A optional generic argument constraining the default.\n * @param {T} defaultValue the default value; used to determine what resolved type should be used.\n * @param {ReactFlagEvaluationOptions} options for this evaluation\n * @returns { FlagQuery } a queryable object containing useful information about the flag.\n */\nexport function useFlag<T extends FlagValue = FlagValue>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): FlagQuery<\nT extends boolean\n  ? boolean\n  : T extends number\n    ? number\n    : T extends string\n      ? string\n      : T extends JsonValue\n        ? T\n        : JsonValue\n> {\n  // use the default value to determine the resolver to call\n  const query =\n    typeof defaultValue === 'boolean'\n      ? new HookFlagQuery<boolean>(useBooleanFlagDetails(flagKey, defaultValue, options))\n      : typeof defaultValue === 'number'\n        ? new HookFlagQuery<number>(useNumberFlagDetails(flagKey, defaultValue, options))\n        : typeof defaultValue === 'string'\n          ? new HookFlagQuery<string>(useStringFlagDetails(flagKey, defaultValue, options))\n          : new HookFlagQuery<JsonValue>(useObjectFlagDetails(flagKey, defaultValue, options));\n  // TS sees this as HookFlagQuery<JsonValue>, because the compiler isn't aware of the `typeof` checks above.\n  return query as unknown as ConstrainedFlagQuery<T>;\n}\n\n/**\n * Evaluates a feature flag, returning a boolean.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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(\n  flagKey: string,\n  defaultValue: boolean,\n  options?: ReactFlagEvaluationOptions,\n): 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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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(\n  flagKey: string,\n  defaultValue: boolean,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<boolean> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getBooleanDetails;\n    },\n    options,\n  );\n}\n\n/**\n * Evaluates a feature flag, returning a string.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): string {\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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<string> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getStringDetails<T>;\n    },\n    options,\n  );\n}\n\n/**\n * Evaluates a feature flag, returning a number.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): number {\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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<number> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getNumberDetails<T>;\n    },\n    options,\n  );\n}\n\n/**\n * Evaluates a feature flag, returning an object.\n * By default, components will re-render when the flag value changes.\n * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): 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 * For a generic hook returning a queryable interface, see {@link useFlag}.\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>(\n  flagKey: string,\n  defaultValue: T,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<T> {\n  return attachHandlersAndResolve(\n    flagKey,\n    defaultValue,\n    (client) => {\n      return client.getObjectDetails<T>;\n    },\n    options,\n  );\n}\n\nfunction attachHandlersAndResolve<T extends FlagValue>(\n  flagKey: string,\n  defaultValue: T,\n  resolver: (client: Client) => (flagKey: string, defaultValue: T) => EvaluationDetails<T>,\n  options?: ReactFlagEvaluationOptions,\n): EvaluationDetails<T> {\n  const defaultedOptions = { ...DEFAULT_OPTIONS, ...options };\n  const [, updateState] = useState<object | undefined>();\n  const client = useOpenFeatureClient();\n  const forceUpdate = () => {\n    updateState({});\n  };\n  const suspendRef = () => {\n    suspend(\n      client,\n      updateState,\n      ProviderEvents.ContextChanged,\n      ProviderEvents.ConfigurationChanged,\n      ProviderEvents.Ready,\n    );\n  };\n\n  useEffect(() => {\n    if (client.providerStatus === ProviderStatus.NOT_READY) {\n      // update when the provider is ready\n      client.addHandler(ProviderEvents.Ready, forceUpdate);\n      if (defaultedOptions.suspendUntilReady) {\n        suspend(client, updateState, ProviderEvents.Ready);\n      }\n    }\n\n    if (defaultedOptions.updateOnContextChanged) {\n      // update when the context changes\n      client.addHandler(ProviderEvents.ContextChanged, forceUpdate);\n      if (defaultedOptions.suspendWhileReconciling) {\n        client.addHandler(ProviderEvents.Reconciling, suspendRef);\n      }\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.Ready, forceUpdate);\n      client.removeHandler(ProviderEvents.ContextChanged, forceUpdate);\n      client.removeHandler(ProviderEvents.Reconciling, suspendRef);\n    };\n  }, []);\n\n  useEffect(() => {\n    if (defaultedOptions.updateOnConfigurationChanged) {\n      // update when the provider configuration changes\n      client.addHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    }\n    return () => {\n      // cleanup the handlers\n      client.removeHandler(ProviderEvents.ConfigurationChanged, forceUpdate);\n    };\n  }, []);\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 * @param {ProviderEvents[]} resumeEvents list of events which will resume the suspend\n */\nfunction suspend(\n  client: Client,\n  updateState: Dispatch<SetStateAction<object | undefined>>,\n  ...resumeEvents: ProviderEvents[]\n) {\n  let suspendResolver: () => void;\n\n  const suspendPromise = new Promise<void>((resolve) => {\n    suspendResolver = () => {\n      resolve();\n      resumeEvents.forEach((e) => {\n        client.removeHandler(e, suspendResolver); // remove handlers once they've run\n      });\n      client.removeHandler(ProviderEvents.Error, suspendResolver);\n    };\n    resumeEvents.forEach((e) => {\n      client.addHandler(e, suspendResolver);\n    });\n    client.addHandler(ProviderEvents.Error, suspendResolver); // we never want to throw, resolve with errors - we may make this configurable later\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\n    .then((value) => {\n      status = SuspendState.Success;\n      result = value;\n    })\n    .catch((error) => {\n      status = SuspendState.Error;\n      result = error;\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}\n\n// FlagQuery implementation, do not export\nclass HookFlagQuery<T extends FlagValue = FlagValue> implements FlagQuery {\n  constructor(private _details: EvaluationDetails<T>) {}\n\n  get details() {\n    return this._details;\n  }\n\n  get value() {\n    return this._details?.value;\n  }\n\n  get variant() {\n    return this._details.variant;\n  }\n\n  get flagMetadata() {\n    return this._details.flagMetadata;\n  }\n\n  get reason() {\n    return this._details.reason;\n  }\n\n  get isError() {\n    return !!this._details?.errorCode || this._details.reason == StandardResolutionReasons.ERROR;\n  }\n\n  get errorCode() {\n    return this._details?.errorCode;\n  }\n\n  get errorMessage() {\n    return this._details?.errorMessage;\n  }\n\n  get isAuthoritative() {\n    return (\n      !this.isError &&\n      this._details.reason != StandardResolutionReasons.STALE &&\n      this._details.reason != StandardResolutionReasons.DISABLED\n    );\n  }\n\n  get type() {\n    return typeof this._details.value;\n  }\n}\n", "import * as React from 'react';\nimport { Client, OpenFeature } from '@openfeature/web-sdk';\n\ntype ClientOrDomain =\n  | {\n      /**\n       * An identifier which logically binds clients with providers\n       * @see OpenFeature.setProvider() and overloads.\n       */\n      domain?: string;\n      client?: never;\n    }\n  | {\n      /**\n       * OpenFeature client to use.\n       */\n      client?: Client;\n      domain?: never;\n    };\n\ntype ProviderProps = {\n  children?: React.ReactNode;\n} & ClientOrDomain;\n\nconst Context = React.createContext<Client | undefined>(undefined);\n\nexport const OpenFeatureProvider = ({ client, domain, children }: ProviderProps) => {\n  if (!client) {\n    client = OpenFeature.getClient(domain);\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 './evaluation';\nexport * from './query';\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;AAAA,EAME;AAAA,EACA;AAAA,EACA;AAAA,OACK;AACP,SAAmC,WAAW,gBAAgB;;;ACV9D,YAAY,WAAW;AACvB,SAAiB,mBAAmB;AAuBpC,IAAM,UAAgB,oBAAkC,MAAS;AAE1D,IAAM,sBAAsB,CAAC,EAAE,QAAQ,QAAQ,SAAS,MAAqB;AAClF,MAAI,CAAC,QAAQ;AACX,aAAS,YAAY,UAAU,MAAM;AAAA,EACvC;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;;;ADDA,IAAM,kBAA8C;AAAA,EAClD,wBAAwB;AAAA,EACxB,8BAA8B;AAAA,EAC9B,mBAAmB;AAAA,EACnB,yBAAyB;AAC3B;AAkCO,SAAS,QACd,SACA,cACA,SAWA;AAEA,QAAM,QACJ,OAAO,iBAAiB,YACpB,IAAI,cAAuB,sBAAsB,SAAS,cAAc,OAAO,CAAC,IAChF,OAAO,iBAAiB,WACtB,IAAI,cAAsB,qBAAqB,SAAS,cAAc,OAAO,CAAC,IAC9E,OAAO,iBAAiB,WACtB,IAAI,cAAsB,qBAAqB,SAAS,cAAc,OAAO,CAAC,IAC9E,IAAI,cAAyB,qBAAqB,SAAS,cAAc,OAAO,CAAC;AAE3F,SAAO;AACT;AAWO,SAAS,oBACd,SACA,cACA,SACS;AACT,SAAO,sBAAsB,SAAS,cAAc,OAAO,EAAE;AAC/D;AAWO,SAAS,sBACd,SACA,cACA,SAC4B;AAC5B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAYO,SAAS,mBACd,SACA,cACA,SACQ;AACR,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAYO,SAAS,qBACd,SACA,cACA,SAC2B;AAC3B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAYO,SAAS,mBACd,SACA,cACA,SACQ;AACR,SAAO,qBAAqB,SAAS,cAAc,OAAO,EAAE;AAC9D;AAYO,SAAS,qBACd,SACA,cACA,SAC2B;AAC3B,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAYO,SAAS,mBACd,SACA,cACA,SACG;AACH,SAAO,qBAAwB,SAAS,cAAc,OAAO,EAAE;AACjE;AAYO,SAAS,qBACd,SACA,cACA,SACsB;AACtB,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA,CAAC,WAAW;AACV,aAAO,OAAO;AAAA,IAChB;AAAA,IACA;AAAA,EACF;AACF;AAEA,SAAS,yBACP,SACA,cACA,UACA,SACsB;AACtB,QAAM,mBAAmB,EAAE,GAAG,iBAAiB,GAAG,QAAQ;AAC1D,QAAM,CAAC,EAAE,WAAW,IAAI,SAA6B;AACrD,QAAM,SAAS,qBAAqB;AACpC,QAAM,cAAc,MAAM;AACxB,gBAAY,CAAC,CAAC;AAAA,EAChB;AACA,QAAM,aAAa,MAAM;AACvB;AAAA,MACE;AAAA,MACA;AAAA,MACA,eAAe;AAAA,MACf,eAAe;AAAA,MACf,eAAe;AAAA,IACjB;AAAA,EACF;AAEA,YAAU,MAAM;AACd,QAAI,OAAO,mBAAmB,eAAe,WAAW;AAEtD,aAAO,WAAW,eAAe,OAAO,WAAW;AACnD,UAAI,iBAAiB,mBAAmB;AACtC,gBAAQ,QAAQ,aAAa,eAAe,KAAK;AAAA,MACnD;AAAA,IACF;AAEA,QAAI,iBAAiB,wBAAwB;AAE3C,aAAO,WAAW,eAAe,gBAAgB,WAAW;AAC5D,UAAI,iBAAiB,yBAAyB;AAC5C,eAAO,WAAW,eAAe,aAAa,UAAU;AAAA,MAC1D;AAAA,IACF;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,eAAe,OAAO,WAAW;AACtD,aAAO,cAAc,eAAe,gBAAgB,WAAW;AAC/D,aAAO,cAAc,eAAe,aAAa,UAAU;AAAA,IAC7D;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,YAAU,MAAM;AACd,QAAI,iBAAiB,8BAA8B;AAEjD,aAAO,WAAW,eAAe,sBAAsB,WAAW;AAAA,IACpE;AACA,WAAO,MAAM;AAEX,aAAO,cAAc,eAAe,sBAAsB,WAAW;AAAA,IACvE;AAAA,EACF,GAAG,CAAC,CAAC;AAEL,SAAO,SAAS,MAAM,EAAE,KAAK,QAAQ,SAAS,YAAY;AAC5D;AAQA,SAAS,QACP,QACA,gBACG,cACH;AACA,MAAI;AAEJ,QAAM,iBAAiB,IAAI,QAAc,CAAC,YAAY;AACpD,sBAAkB,MAAM;AACtB,cAAQ;AACR,mBAAa,QAAQ,CAAC,MAAM;AAC1B,eAAO,cAAc,GAAG,eAAe;AAAA,MACzC,CAAC;AACD,aAAO,cAAc,eAAe,OAAO,eAAe;AAAA,IAC5D;AACA,iBAAa,QAAQ,CAAC,MAAM;AAC1B,aAAO,WAAW,GAAG,eAAe;AAAA,IACtC,CAAC;AACD,WAAO,WAAW,eAAe,OAAO,eAAe;AAAA,EACzD,CAAC;AACD,cAAY,gBAAgB,cAAc,CAAC;AAC7C;AAQA,SAAS,gBAAmB,SAAqB;AAC/C,MAAI,SAAuB;AAC3B,MAAI;AAEJ,QAAM,YAAY,QACf,KAAK,CAAC,UAAU;AACf,aAAS;AACT,aAAS;AAAA,EACX,CAAC,EACA,MAAM,CAAC,UAAU;AAChB,aAAS;AACT,aAAS;AAAA,EACX,CAAC;AAEH,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;AAGA,IAAM,gBAAN,MAA0E;AAAA,EACxE,YAAoB,UAAgC;AAAhC;AAAA,EAAiC;AAAA,EAErD,IAAI,UAAU;AACZ,WAAO,KAAK;AAAA,EACd;AAAA,EAEA,IAAI,QAAQ;AACV,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,SAAS;AACX,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA,EAEA,IAAI,UAAU;AACZ,WAAO,CAAC,CAAC,KAAK,UAAU,aAAa,KAAK,SAAS,UAAU,0BAA0B;AAAA,EACzF;AAAA,EAEA,IAAI,YAAY;AACd,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA,EAEA,IAAI,eAAe;AACjB,WAAO,KAAK,UAAU;AAAA,EACxB;AAAA,EAEA,IAAI,kBAAkB;AACpB,WACE,CAAC,KAAK,WACN,KAAK,SAAS,UAAU,0BAA0B,SAClD,KAAK,SAAS,UAAU,0BAA0B;AAAA,EAEtD;AAAA,EAEA,IAAI,OAAO;AACT,WAAO,OAAO,KAAK,SAAS;AAAA,EAC9B;AACF;;;AE9bA,cAAc;",
   "names": []
 }

package/dist/types.d.ts

@@ -1,7 +1,56 @@
-import { EvaluationDetails, JsonValue, FlagEvaluationOptions, Client } from '@openfeature/web-sdk';
+import { FlagValue as FlagValue$1, JsonValue, EvaluationDetails as EvaluationDetails$1, FlagEvaluationOptions, Client } from '@openfeature/web-sdk';
 export * from '@openfeature/web-sdk';
+import { FlagValue, EvaluationDetails, FlagMetadata, StandardResolutionReasons, ErrorCode } from '@openfeature/core';
 import * as React from 'react';
 
+interface FlagQuery<T extends FlagValue = FlagValue> {
+    /**
+     * A structure representing the result of the flag evaluation process
+     */
+    readonly details: EvaluationDetails<T>;
+    /**
+     * The flag value
+     */
+    readonly value: T;
+    /**
+     * A variant is a semantic identifier for a value.
+     * Not available from all providers.
+     */
+    readonly variant: string | undefined;
+    /**
+     * Arbitrary data associated with this flag or evaluation.
+     * Not available from all providers.
+     */
+    readonly flagMetadata: FlagMetadata;
+    /**
+     * The reason the evaluation resolved to the particular value.
+     * Not available from all providers.
+     */
+    readonly reason: typeof StandardResolutionReasons | string | undefined;
+    /**
+     * Indicates if this flag defaulted due to an error.
+     * Specifically, indicates reason equals {@link StandardResolutionReasons.ERROR} or the errorCode is set, this field is truthy.
+     */
+    readonly isError: boolean;
+    /**
+     * The error code, see {@link ErrorCode}.
+     */
+    readonly errorCode: ErrorCode | undefined;
+    /**
+     * A message associated with the error.
+     */
+    readonly errorMessage: string | undefined;
+    /**
+     * Indicates this flag is up-to-date and in sync with the source of truth.
+     * Specifically, indicates the evaluation did not default due to error, and the reason is neither {@link StandardResolutionReasons.STALE} or {@link StandardResolutionReasons.DISABLED}.
+     */
+    readonly isAuthoritative: boolean;
+    /**
+     * The type of the value, as returned by "typeof" operator.
+     */
+    readonly type: 'string' | 'number' | 'bigint' | 'boolean' | 'symbol' | 'undefined' | 'object' | 'function';
+}
+
 type ReactFlagEvaluationOptions = {
     /**
      * Suspend flag evaluations while the provider is not ready.
@@ -30,9 +79,22 @@ type ReactFlagEvaluationOptions = {
      */
     updateOnContextChanged?: boolean;
 } & FlagEvaluationOptions;
+/**
+ * Evaluates a feature flag generically, returning an react-flavored queryable object.
+ * The resolver method to use is based on the type of the defaultValue.
+ * For type-specific hooks, use {@link useBooleanFlagValue}, {@link useBooleanFlagDetails} and equivalents.
+ * By default, components will re-render when the flag value changes.
+ * @param {string} flagKey the flag identifier
+ * @template {FlagValue} T A optional generic argument constraining the default.
+ * @param {T} defaultValue the default value; used to determine what resolved type should be used.
+ * @param {ReactFlagEvaluationOptions} options for this evaluation
+ * @returns { FlagQuery } a queryable object containing useful information about the flag.
+ */
+declare function useFlag<T extends FlagValue$1 = FlagValue$1>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): FlagQuery<T extends boolean ? boolean : T extends number ? number : T extends string ? string : T extends JsonValue ? T : JsonValue>;
 /**
  * Evaluates a feature flag, returning a boolean.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @param {string} flagKey the flag identifier
  * @param {boolean} defaultValue the default value
  * @param {ReactFlagEvaluationOptions} options options for this evaluation
@@ -42,55 +104,61 @@ declare function useBooleanFlagValue(flagKey: string, defaultValue: boolean, opt
 /**
  * Evaluates a feature flag, returning evaluation details.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @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>;
+declare function useBooleanFlagDetails(flagKey: string, defaultValue: boolean, options?: ReactFlagEvaluationOptions): EvaluationDetails$1<boolean>;
 /**
  * Evaluates a feature flag, returning a string.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @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;
+declare function useStringFlagValue<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): string;
 /**
  * Evaluates a feature flag, returning evaluation details.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @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>;
+declare function useStringFlagDetails<T extends string = string>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails$1<string>;
 /**
  * Evaluates a feature flag, returning a number.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @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;
+declare function useNumberFlagValue<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): number;
 /**
  * Evaluates a feature flag, returning evaluation details.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @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>;
+declare function useNumberFlagDetails<T extends number = number>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails$1<number>;
 /**
  * Evaluates a feature flag, returning an object.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @param {string} flagKey the flag identifier
  * @template {JsonValue} [T=JsonValue] A optional generic argument describing the structure
  * @param {T} defaultValue the default value
@@ -101,13 +169,14 @@ declare function useObjectFlagValue<T extends JsonValue = JsonValue>(flagKey: st
 /**
  * Evaluates a feature flag, returning evaluation details.
  * By default, components will re-render when the flag value changes.
+ * For a generic hook returning a queryable interface, see {@link useFlag}.
  * @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
  * @returns { EvaluationDetails<T>} a EvaluationDetails object for this evaluation
  */
-declare function useObjectFlagDetails<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails<T>;
+declare function useObjectFlagDetails<T extends JsonValue = JsonValue>(flagKey: string, defaultValue: T, options?: ReactFlagEvaluationOptions): EvaluationDetails$1<T>;
 
 type ClientOrDomain = {
     /**
@@ -129,4 +198,4 @@ type ProviderProps = {
 declare const OpenFeatureProvider: ({ client, domain, children }: ProviderProps) => React.JSX.Element;
 declare const useOpenFeatureClient: () => Client;
 
-export { OpenFeatureProvider, useBooleanFlagDetails, useBooleanFlagValue, useNumberFlagDetails, useNumberFlagValue, useObjectFlagDetails, useObjectFlagValue, useOpenFeatureClient, useStringFlagDetails, useStringFlagValue };
+export { FlagQuery, OpenFeatureProvider, useBooleanFlagDetails, useBooleanFlagValue, useFlag, useNumberFlagDetails, useNumberFlagValue, useObjectFlagDetails, useObjectFlagValue, useOpenFeatureClient, useStringFlagDetails, useStringFlagValue };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/react-sdk",
-  "version": "0.2.3-experimental",
+  "version": "0.2.4-experimental",
   "description": "OpenFeature React SDK",
   "main": "./dist/cjs/index.js",
   "files": [
@@ -46,7 +46,7 @@
   },
   "homepage": "https://github.com/open-feature/js-sdk#readme",
   "peerDependencies": {
-    "@openfeature/web-sdk": ">=1.0.0",
+    "@openfeature/web-sdk": "^1.0.2",
     "react": ">=16.8.0"
   },
   "devDependencies": {