@openfeature/react-sdk 0.2.2-experimental → 0.2.3-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.2-experimental">
-    <img alt="Release" src="https://img.shields.io/static/v1?label=release&message=v0.2.2-experimental&color=blue&style=for-the-badge" />
+  <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>
   <!-- x-release-please-end -->
   <br/>
@@ -43,7 +43,7 @@ The OpenFeature React SDK adds React-specific functionality to the [OpenFeature
 In addition to the feature provided by the [web sdk](https://openfeature.dev/docs/reference/technologies/client/web), capabilities include:
 
 - [Overview](#overview)
-- [🚀 Quick start](#-quick-start)
+- [Quick start](#quick-start)
   - [Requirements](#requirements)
   - [Install](#install)
     - [npm](#npm)
@@ -56,7 +56,7 @@ In addition to the feature provided by the [web sdk](https://openfeature.dev/doc
   - [Suspense Support](#suspense-support)
 - [Resources](#resources)
 
-## 🚀 Quick start
+## Quick start
 
 ### Requirements
 
@@ -82,7 +82,7 @@ yarn add @openfeature/react-sdk @openfeature/web-sdk @openfeature/core
 
 The following list contains the peer dependencies of `@openfeature/react-sdk` with its expected and compatible versions:
 
-* `@openfeature/web-sdk`: >=0.4.14
+* `@openfeature/web-sdk`: >=1.0.0
 * `react`: >=16.8.0
 
 ### Usage
@@ -243,4 +243,4 @@ function Fallback() {
 
 ## Resources
 
- - [Example repo](https://github.com/open-feature/react-test-app)
+ - [Example repo](https://github.com/open-feature/react-test-app)

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"],
+  "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;",
   "names": ["import_web_sdk"]
 }

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"],
+  "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;",
   "names": []
 }

package/dist/types.d.ts

@@ -114,13 +114,13 @@ type ClientOrDomain = {
      * An identifier which logically binds clients with providers
      * @see OpenFeature.setProvider() and overloads.
      */
-    domain: string;
+    domain?: string;
     client?: never;
 } | {
     /**
      * OpenFeature client to use.
      */
-    client: Client;
+    client?: Client;
     domain?: never;
 };
 type ProviderProps = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfeature/react-sdk",
-  "version": "0.2.2-experimental",
+  "version": "0.2.3-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": ">=0.4.14",
+    "@openfeature/web-sdk": ">=1.0.0",
     "react": ">=16.8.0"
   },
   "devDependencies": {