@configdirector/react-web-sdk 1.5.0 → 1.6.0

package/dist/configdirector-react-client.d.cts

@@ -1,209 +1,7 @@
+import { a as ConfigDirectorLoggingLevel, i as ConfigDirectorLogger, n as ConfigDirectorClient, o as ConfigValueType, r as ConfigDirectorContext, s as ConnectionMode, t as ClientHooks } from "./types-3Pw7bIUn.cjs";
 import * as _$react_jsx_runtime0 from "react/jsx-runtime";
 import { Component, PropsWithChildren, ReactNode } from "react";
 
-//#region ../js-client-core/src/Emitter.d.ts
-type EventType = string | symbol;
-type EventsRecord = Record<EventType, any>;
-type Handler<TEventsRecord extends EventsRecord, TKey extends keyof TEventsRecord> = (payload: TEventsRecord[TKey]) => void;
-interface EventProvider<TEventsRecord extends EventsRecord> {
-  on<TName extends keyof TEventsRecord>(name: TName, handler: Handler<TEventsRecord, TName>): void;
-  off<TName extends keyof TEventsRecord>(name: TName, handler?: Handler<TEventsRecord, TName>): void;
-  clear(): void;
-}
-//#endregion
-//#region ../shared/src/types.d.ts
-type ConfigEnumLikeType = {
-  [key: string]: string | number;
-};
-type ConfigValueType = string | number | boolean | object | ConfigEnumLikeType;
-type ConfigDirectorLoggingLevel = "debug" | "info" | "warn" | "error" | "off";
-interface ConfigDirectorLogger {
-  debug(message: string, ...args: any): void;
-  info(message: string, ...args: any): void;
-  warn(message: string, ...args: any): void;
-  error(message: string, ...args: any): void;
-}
-type EvaluationReason = "found-match" | "config-state-missing" | "client-not-ready" | "type-mismatch" | "value-missing" | "invalid-number" | "invalid-json" | "invalid-boolean";
-type ConfigEvaluation = {
-  key: string;
-  value: ConfigValueType;
-  valueId?: string;
-  isDefaultValue: boolean;
-  reason: EvaluationReason;
-  context?: ConfigDirectorContext;
-};
-/**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
- */
-type ConfigDirectorContext = {
-  /**
-   * The user's identifier. This should be a value that uniquely identifies an application
-   * user.
-   * In the case of anonymous users, you could generate a UUID or alternatively not provide
-   * the {@link id} and the SDK will generate a random UUID. However, keep in mind that this
-   * value is used for segmenting users in percentage rollouts, and changes to the {@link id}
-   * could result in the user being assigned to a different percentile.
-   */
-  id?: string;
-  /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
-   * used for targeting rules.
-   */
-  name?: string;
-  /**
-   * Any arbitrary traits for the current user. They will be shown in the ConfigDirector
-   * dashboard and may be used for targeting rules.
-   */
-  traits?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Whether or not to treat the context as anonymous during evaluation. When `true`, the
-   * context values will be used for targeting rules evaluation but the context will not be
-   * persisted and will not appear in the dashboard.
-   *
-   * @default false
-   */
-  anonymous?: boolean;
-};
-//#endregion
-//#region ../js-client-core/src/types.d.ts
-type ClientHooks = {
-  clientReady?: HookHandler<"clientReady"> | HookHandler<"clientReady">[];
-  configsUpdated?: HookHandler<"configsUpdated"> | HookHandler<"configsUpdated">[];
-  contextUpdated?: HookHandler<"contextUpdated"> | HookHandler<"contextUpdated">[];
-  configEvaluated?: HookHandler<"configEvaluated"> | HookHandler<"configEvaluated">[];
-  connectionError?: HookHandler<"connectionError"> | HookHandler<"connectionError">[];
-};
-type ClientConnectAction = "initialization" | "context update" | "network resume";
-type HookHandler<TEvent extends keyof ClientEvents> = (payload: ClientEvents[TEvent]) => void;
-type ClientEvents = {
-  configsUpdated: {
-    keys: string[];
-  };
-  clientReady: {
-    action: ClientConnectAction;
-  };
-  contextUpdated: {
-    context: ConfigDirectorContext | undefined;
-  };
-  configEvaluated: {
-    evaluation: ConfigEvaluation;
-  };
-  connectionError: {
-    error: Error;
-  };
-};
-type WatchHandler<T extends ConfigValueType> = (message: T) => void;
-/**
- * The ConfigDirector SDK client object.
- *
- * Applications should create a single instance of `ConfigDirectorClient`, and call
- * {@link initialize} during application initialization.
- *
- * After initialization, to update the user's context, so that targeting rules are evaluated
- * with the updated context, call {@link updateContext}.
- */
-interface ConfigDirectorClient extends EventProvider<ClientEvents> {
-  /**
-   * Initializes the connection to ConfigDirector to retrieve config evaluations. Until
-   * initialization is successful, all flags will return their default value provided to
-   * {@link watch} or {@link getValue}.
-   *
-   * If the connection fails or is interrupted with a transient error (network error,
-   * internal server error, etc) the client will continue to attempt to connect. However,
-   * if the connection fails with a persistent error, like an invalid SDK key, the client will
-   * not attempt to re-connect and an error will be logged to the console or the provided
-   * logger.
-   *
-   * @param context The current user's context to be used for evaluating targeting rules (optional).
-   */
-  initialize(context?: ConfigDirectorContext): Promise<void>;
-  /**
-   * Updates the user's context and re-evaluates all config and flag values based on the new context.
-   *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
-   */
-  updateContext(context: ConfigDirectorContext): Promise<void>;
-  /**
-   * Returns the current context the client is configured with, or undefined if there is no context.
-   *
-   * Note that the value returned does not updated immediately after calling {@link updateContext}. Only
-   * once the underlying connection was successful or timed out, the current context is updated. This is
-   * because while the context update is in progress, configs are still evaluated on the previous context.
-   *
-   */
-  get context(): ConfigDirectorContext | undefined;
-  /**
-   * Returns whether or not the client is ready after calling {@link initialize} or {@link updateContext}
-   *
-   * The definition of ready is that the connection to the server was successful, and config state
-   * was received.
-   */
-  get isReady(): boolean;
-  /**
-   * Returns whether or not the client is currently initializing. Upon client creation, it is `false`.
-   * It is `true` after calling `initialize` and becomes `false` again once initialization is completed.
-   */
-  get isInitializing(): boolean;
-  /**
-   * Evaluates a config and returns its value based on the current context and targeting rules
-   *
-   * @returns The evaluated config value, or the `defaultValue` if the config state was unavailable
-   * @param configKey The config key to evaluate
-   * @param defaultValue The default value to be returned if the config state is unavailable. For
-   * example, if the client cannot connect to the server due to network conditions, or if getValue
-   * is called before initialization is done.
-   */
-  getValue<T extends ConfigValueType>(configKey: string, defaultValue: T): T;
-  /**
-   * Watches for changes to a a config evaluation value. Whenever the config value changes, the
-   * provided callback function will be called with the new value. Changes can happen due to updates
-   * to the config in the ConfigDirector dashboard, or if the context is updated via {@link updateContext}.
-   *
-   * @returns An 'unwatch' function that can be called to remove the subscriber
-   *
-   * @param configKey The config key to watch
-   * @param defaultValue The default value to be referenced if the config state is unavailable
-   * @param callback The callback function to be called whenever the config value is updated
-   */
-  watch<T extends ConfigValueType>(configKey: string, defaultValue: T, callback: WatchHandler<T>): () => void;
-  /**
-   * Removes a particular subscriber to the given `configKey`, or all subscribers if no callback
-   * is provided.
-   *
-   * @param configKey The config key to remove subscribers from
-   * @param callback The subscriber to be removed. If not provided, all subscribers are removed for
-   * the given `configKey`.
-   */
-  unwatch<T extends ConfigValueType>(configKey: string, callback?: WatchHandler<T>): void;
-  /**
-   * Removes all subscribers from all config keys
-   */
-  unwatchAll(): void;
-  /**
-   * Pauses the network connection without clearing event handlers, watch handlers, or config
-   * state. Intended for mobile environments where the OS may kill background connections (e.g.
-   * when the app is backgrounded on iOS/Android).
-   *
-   * Call {@link resumeNetwork} to re-establish the connection.
-   */
-  pauseNetwork(): void;
-  /**
-   * Resumes a connection that was paused via {@link pauseNetwork}, using the last context that
-   * was provided to {@link initialize} or {@link updateContext}.
-   */
-  resumeNetwork(): Promise<void>;
-  /**
-   * Disposes of the client. All connections are closed, and all event and config key subscribers
-   * are removed.
-   *
-   * Intended to be called when your application shuts down
-   */
-  dispose(): void;
-}
-//#endregion
 //#region src/types.d.ts
 type ClientStatus = "loading" | "ready" | "default";
 interface ConfigDirectorContextData {
@@ -218,10 +16,48 @@ type ConfigDirectorProviderOptions = {
   appVersion?: string;
   url?: string;
   timeout?: number;
+  /**
+   * The connection mode, one of `streaming` or `polling`. In `streaming` mode the connection stays
+   * open and receives config updates as they happen. In `polling` mode configs are fetched once during
+   * initialization and then again on every `pollingInterval`.
+   *
+   * Defaults to `streaming`.
+   */
+  mode?: ConnectionMode;
+  /**
+   * The polling interval in seconds when `mode` is `polling`. Has no effect in `streaming` mode.
+   *
+   * Defaults to 60 seconds. A value below the minimum of 30 seconds is raised to 30 seconds and a
+   * warning is logged.
+   */
+  pollingInterval?: number;
   context?: ConfigDirectorContext;
   logger?: ConfigDirectorLogger;
   hooks?: ClientHooks;
 };
+/**
+ * Props of a `ConfigDirectorProvider` given an existing client instead of the options to build one,
+ * for example a test client's `client`.
+ */
+type ConfigDirectorProviderClientProps = {
+  /**
+   * The client to provide. The provider never disposes it. If the client is not ready and not
+   * initializing, the provider initializes it with `context`; if it is ready and `context` is given
+   * and differs from the client's context, the provider updates the context; otherwise it leaves the
+   * client as it is and reports ready as soon as the client is.
+   */
+  client: ConfigDirectorClient;
+  context?: ConfigDirectorContext;
+  /**
+   * Event handlers registered on the client while the provider is mounted, and removed when it
+   * unmounts.
+   */
+  hooks?: ClientHooks;
+};
+/**
+ * Props of `ConfigDirectorProvider`: either the options to build a client from, or an existing client.
+ */
+type ConfigDirectorProviderProps = ConfigDirectorProviderOptions | ConfigDirectorProviderClientProps;
 //#endregion
 //#region src/withProvider.d.ts
 declare const withProvider: (options: ConfigDirectorProviderOptions) => Promise<({
@@ -231,10 +67,14 @@ declare const withProvider: (options: ConfigDirectorProviderOptions) => Promise<
 }) => _$react_jsx_runtime0.JSX.Element>;
 //#endregion
 //#region src/provider.d.ts
-declare class ConfigDirectorProvider extends Component<PropsWithChildren<ConfigDirectorProviderOptions>, ConfigDirectorProviderState> {
-  constructor(props: ConfigDirectorProviderOptions);
+declare class ConfigDirectorProvider extends Component<PropsWithChildren<ConfigDirectorProviderProps>, ConfigDirectorProviderState> {
+  private readonly ownsClient;
+  private disposedOwnClient;
+  private handlers;
+  constructor(props: ConfigDirectorProviderProps);
   componentDidMount(): Promise<void>;
-  componentDidUpdate(prevProps: PropsWithChildren<ConfigDirectorProviderOptions>): Promise<void>;
+  private connect;
+  componentDidUpdate(prevProps: PropsWithChildren<ConfigDirectorProviderProps>): Promise<void>;
   componentWillUnmount(): void;
   render(): _$react_jsx_runtime0.JSX.Element;
 }
@@ -255,5 +95,5 @@ declare const useClient: () => {
 //#region src/logger.d.ts
 declare const createConsoleLogger: (level: ConfigDirectorLoggingLevel) => ConfigDirectorLogger;
 //#endregion
-export { ConfigDirectorProvider, createConsoleLogger, useClient, useConfigValue, useContext, withProvider };
+export { type ClientStatus, type ConfigDirectorClient, type ConfigDirectorContext, ConfigDirectorProvider, type ConfigDirectorProviderClientProps, type ConfigDirectorProviderOptions, type ConfigDirectorProviderProps, type ConnectionMode, createConsoleLogger, useClient, useConfigValue, useContext, withProvider };
 //# sourceMappingURL=configdirector-react-client.d.cts.map

package/dist/configdirector-react-client.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"configdirector-react-client.d.cts","names":[],"sources":["../../js-client-core/src/Emitter.ts","../../shared/src/types.ts","../../js-client-core/src/types.ts","../src/types.ts","../src/withProvider.tsx","../src/provider.tsx","../src/hooks.tsx","../src/logger.ts"],"mappings":";;;;KAAK,SAAA;AAAA,KACA,YAAA,GAAe,MAAA,CAAO,SAAA;AAAA,KAEtB,OAAA,uBAA8B,YAAA,qBAAiC,aAAA,KAClE,OAAA,EAAS,aAAA,CAAc,IAAA;AAAA,UAGR,aAAA,uBAAoC,YAAA;EACnD,EAAA,qBAAuB,aAAA,EAAe,IAAA,EAAM,KAAA,EAAO,OAAA,EAAS,OAAA,CAAQ,aAAA,EAAe,KAAA;EACnF,GAAA,qBAAwB,aAAA,EAAe,IAAA,EAAM,KAAA,EAAO,OAAA,GAAU,OAAA,CAAQ,aAAA,EAAe,KAAA;EACrF,KAAA;AAAA;;;KCEU,kBAAA;EAAA,CAAwB,GAAA;AAAA;AAAA,KAExB,eAAA,wCAAuD,kBAAA;AAAA,KAevD,0BAAA;AAAA,UAEK,oBAAA;EACf,KAAA,CAAM,OAAA,aAAoB,IAAA;EAE1B,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,KAAA,CAAM,OAAA,aAAoB,IAAA;AAAA;AAAA,KAOhB,gBAAA;AAAA,KAUA,gBAAA;EACV,GAAA;EACA,KAAA,EAAO,eAAA;EACP,OAAA;EACA,cAAA;EACA,MAAA,EAAQ,gBAAA;EACR,OAAA,GAAU,qBAAA;AAAA;;;;;KAMA,qBAAA;ED1Dc;;;;;;;;ECmExB,EAAA;EDpEA;;;;EC0EA,IAAA;ED1E4D;;;;ECgF5D,MAAA;IAAA,CAAY,GAAA;EAAA;ED/EiC;;;;;;;ECwF7C,SAAA;AAAA;;;KCkBU,WAAA;EACV,WAAA,GAAc,WAAA,kBAA6B,WAAA;EAC3C,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;EACnD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;AAAA;AAAA,KAGzC,mBAAA;AAAA,KAEA,WAAA,sBAAiC,YAAA,KAAiB,OAAA,EAAS,YAAA,CAAa,MAAA;AAAA,KAExE,YAAA;EACV,cAAA;IAAkB,IAAA;EAAA;EAClB,WAAA;IAAe,MAAA,EAAQ,mBAAA;EAAA;EACvB,cAAA;IAAkB,OAAA,EAAS,qBAAA;EAAA;EAC3B,eAAA;IAAmB,UAAA,EAAY,gBAAA;EAAA;EAC/B,eAAA;IAAmB,KAAA,EAAO,KAAA;EAAA;AAAA;AAAA,KAGhB,YAAA,WAAuB,eAAA,KAAoB,OAAA,EAAS,CAAA;;;;;;;ADpEhE;;;UC+EiB,oBAAA,SAA6B,aAAA,CAAc,YAAA;EDtE1D;;;;;;;;;;ACuCF;;;EA6CE,UAAA,CAAW,OAAA,GAAU,qBAAA,GAAwB,OAAA;EA5CF;;;;;EAmD3C,aAAA,CAAc,OAAA,EAAS,qBAAA,GAAwB,OAAA;EAhDI;;;;;;;;EAAA,IA0D/C,OAAA,IAAW,qBAAA;EA5DE;;;;;;EAAA,IAoEb,OAAA;EAlE+C;;;;EAAA,IAwE/C,cAAA;EAvE0D;AAGhE;;;;;AAEA;;;EA6EE,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,GAAI,CAAA;EA7EJ;;;;;;;;;;;EA0FrE,KAAA,WAAgB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,QAAA,EAAU,YAAA,CAAa,CAAA;EAxFtE;;;;;;;;EAkGtB,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAjG5D;;;EAsGlB,UAAA;EApGA;;;;;;;EA6GA,YAAA;EA3G0B;;;AAG5B;EA8GE,aAAA,IAAiB,OAAA;EA9GK;;;;;;EAsHtB,OAAA;AAAA;;;KCtPU,YAAA;AAAA,UAEK,yBAAA;EACf,MAAA,GAAS,oBAAA;EACT,SAAA,GAAY,IAAA;EACZ,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,2BAAA,GAA8B,yBAAA;AAAA,KAE9B,6BAAA;EACV,MAAA;EACA,OAAA;EACA,UAAA;EACA,GAAA;EACA,OAAA;EACA,OAAA,GAAU,qBAAA;EACV,MAAA,GAAS,oBAAA;EACT,KAAA,GAAQ,WAAA;AAAA;;;cCnBG,YAAA,GAAsB,OAAA,EAAS,6BAAA,KAA6B,OAAA;EAAA;AAAA;EAUvB,QAAA,EAAU,SAAA;AAAA,MAAW,oBAAA,CAAA,GAAA,CAAA,OAAA;;;cCV1D,sBAAA,SAA+B,SAAA,CAC1C,iBAAA,CAAkB,6BAAA,GAClB,2BAAA;cAEY,KAAA,EAAO,6BAAA;EAaJ,iBAAA,CAAA,GAAqB,OAAA;EAarB,kBAAA,CACb,SAAA,EAAW,iBAAA,CAAkB,6BAAA,IAC5B,OAAA;EAUM,oBAAA,CAAA;EAIA,MAAA,CAAA,GAAM,oBAAA,CAAA,GAAA,CAAA,OAAA;AAAA;;;cCrCX,cAAA,aAA4B,eAAA,EAChC,GAAA,UACA,YAAA,EAAc,CAAA;EAEd,KAAA,EAAO,CAAA;EACP,WAAA,EAAa,YAAA;EACb,OAAA;AAAA;AAAA,cAYI,UAAA;2BAMkC,qBAAA,KAAqB,OAAA;AAAA;AAAA,cAOvD,SAAA;UAOL,oBAAA;AAAA;;;cCvCY,mBAAA,GAAuB,KAAA,EAAO,0BAAA,KAA6B,oBAAA"}
+{"version":3,"file":"configdirector-react-client.d.cts","names":[],"sources":["../src/types.ts","../src/withProvider.tsx","../src/provider.tsx","../src/hooks.tsx","../src/logger.ts"],"mappings":";;;;;KAQY,YAAA;AAAA,UAEK,yBAAA;EACf,MAAA,GAAS,oBAAA;EACT,SAAA,GAAY,IAAA;EACZ,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,2BAAA,GAA8B,yBAAA;AAAA,KAE9B,6BAAA;EACV,MAAA;EACA,OAAA;EACA,UAAA;EACA,GAAA;EACA,OAAA;EAXY;;;;;;;EAmBZ,IAAA,GAAO,cAAA;EAlBP;;;;AAGF;;EAsBE,eAAA;EACA,OAAA,GAAU,qBAAA;EACV,MAAA,GAAS,oBAAA;EACT,KAAA,GAAQ,WAAA;AAAA;;;;;KAOE,iCAAA;EAPS;;;;;;EAcnB,MAAA,EAAQ,oBAAA;EACR,OAAA,GAAU,qBAAA;EAzBH;;;;EA8BP,KAAA,GAAQ,WAAA;AAAA;;;;KAME,2BAAA,GAA8B,6BAAA,GAAgC,iCAAA;;;cC1D7D,YAAA,GAAsB,OAAA,EAAS,6BAAA,KAA6B,OAAA;EAAA;AAAA;EAcvB,QAAA,EAAU,SAAA;AAAA,MAAW,oBAAA,CAAA,GAAA,CAAA,OAAA;;;cCb1D,sBAAA,SAA+B,SAAA,CAC1C,iBAAA,CAAkB,2BAAA,GAClB,2BAAA;EAAA,iBAEiB,UAAA;EAAA,QACT,iBAAA;EAAA,QACA,QAAA;cAEI,KAAA,EAAO,2BAAA;EAOJ,iBAAA,CAAA,GAAqB,OAAA;EAAA,QAoBtB,OAAA;EAiBC,kBAAA,CAAmB,SAAA,EAAW,iBAAA,CAAkB,2BAAA,IAA+B,OAAA;EAerF,oBAAA,CAAA;EASA,MAAA,CAAA,GAAM,oBAAA,CAAA,GAAA,CAAA,OAAA;AAAA;;;cCvEX,cAAA,aAA4B,eAAA,EAChC,GAAA,UACA,YAAA,EAAc,CAAA;EAEd,KAAA,EAAO,CAAA;EACP,WAAA,EAAa,YAAA;EACb,OAAA;AAAA;AAAA,cAYI,UAAA;2BAMkC,qBAAA,KAAqB,OAAA;AAAA;AAAA,cAOvD,SAAA;UAOL,oBAAA;AAAA;;;cCvCY,mBAAA,GAAuB,KAAA,EAAO,0BAAA,KAA6B,oBAAA"}

package/dist/configdirector-react-client.d.mts

@@ -1,209 +1,7 @@
+import { a as ConfigDirectorLoggingLevel, i as ConfigDirectorLogger, n as ConfigDirectorClient, o as ConfigValueType, r as ConfigDirectorContext, s as ConnectionMode, t as ClientHooks } from "./types-CU9VmelO.mjs";
 import { Component, PropsWithChildren, ReactNode } from "react";
 import * as _$react_jsx_runtime0 from "react/jsx-runtime";
 
-//#region ../js-client-core/src/Emitter.d.ts
-type EventType = string | symbol;
-type EventsRecord = Record<EventType, any>;
-type Handler<TEventsRecord extends EventsRecord, TKey extends keyof TEventsRecord> = (payload: TEventsRecord[TKey]) => void;
-interface EventProvider<TEventsRecord extends EventsRecord> {
-  on<TName extends keyof TEventsRecord>(name: TName, handler: Handler<TEventsRecord, TName>): void;
-  off<TName extends keyof TEventsRecord>(name: TName, handler?: Handler<TEventsRecord, TName>): void;
-  clear(): void;
-}
-//#endregion
-//#region ../shared/src/types.d.ts
-type ConfigEnumLikeType = {
-  [key: string]: string | number;
-};
-type ConfigValueType = string | number | boolean | object | ConfigEnumLikeType;
-type ConfigDirectorLoggingLevel = "debug" | "info" | "warn" | "error" | "off";
-interface ConfigDirectorLogger {
-  debug(message: string, ...args: any): void;
-  info(message: string, ...args: any): void;
-  warn(message: string, ...args: any): void;
-  error(message: string, ...args: any): void;
-}
-type EvaluationReason = "found-match" | "config-state-missing" | "client-not-ready" | "type-mismatch" | "value-missing" | "invalid-number" | "invalid-json" | "invalid-boolean";
-type ConfigEvaluation = {
-  key: string;
-  value: ConfigValueType;
-  valueId?: string;
-  isDefaultValue: boolean;
-  reason: EvaluationReason;
-  context?: ConfigDirectorContext;
-};
-/**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
- */
-type ConfigDirectorContext = {
-  /**
-   * The user's identifier. This should be a value that uniquely identifies an application
-   * user.
-   * In the case of anonymous users, you could generate a UUID or alternatively not provide
-   * the {@link id} and the SDK will generate a random UUID. However, keep in mind that this
-   * value is used for segmenting users in percentage rollouts, and changes to the {@link id}
-   * could result in the user being assigned to a different percentile.
-   */
-  id?: string;
-  /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
-   * used for targeting rules.
-   */
-  name?: string;
-  /**
-   * Any arbitrary traits for the current user. They will be shown in the ConfigDirector
-   * dashboard and may be used for targeting rules.
-   */
-  traits?: {
-    [key: string]: unknown;
-  };
-  /**
-   * Whether or not to treat the context as anonymous during evaluation. When `true`, the
-   * context values will be used for targeting rules evaluation but the context will not be
-   * persisted and will not appear in the dashboard.
-   *
-   * @default false
-   */
-  anonymous?: boolean;
-};
-//#endregion
-//#region ../js-client-core/src/types.d.ts
-type ClientHooks = {
-  clientReady?: HookHandler<"clientReady"> | HookHandler<"clientReady">[];
-  configsUpdated?: HookHandler<"configsUpdated"> | HookHandler<"configsUpdated">[];
-  contextUpdated?: HookHandler<"contextUpdated"> | HookHandler<"contextUpdated">[];
-  configEvaluated?: HookHandler<"configEvaluated"> | HookHandler<"configEvaluated">[];
-  connectionError?: HookHandler<"connectionError"> | HookHandler<"connectionError">[];
-};
-type ClientConnectAction = "initialization" | "context update" | "network resume";
-type HookHandler<TEvent extends keyof ClientEvents> = (payload: ClientEvents[TEvent]) => void;
-type ClientEvents = {
-  configsUpdated: {
-    keys: string[];
-  };
-  clientReady: {
-    action: ClientConnectAction;
-  };
-  contextUpdated: {
-    context: ConfigDirectorContext | undefined;
-  };
-  configEvaluated: {
-    evaluation: ConfigEvaluation;
-  };
-  connectionError: {
-    error: Error;
-  };
-};
-type WatchHandler<T extends ConfigValueType> = (message: T) => void;
-/**
- * The ConfigDirector SDK client object.
- *
- * Applications should create a single instance of `ConfigDirectorClient`, and call
- * {@link initialize} during application initialization.
- *
- * After initialization, to update the user's context, so that targeting rules are evaluated
- * with the updated context, call {@link updateContext}.
- */
-interface ConfigDirectorClient extends EventProvider<ClientEvents> {
-  /**
-   * Initializes the connection to ConfigDirector to retrieve config evaluations. Until
-   * initialization is successful, all flags will return their default value provided to
-   * {@link watch} or {@link getValue}.
-   *
-   * If the connection fails or is interrupted with a transient error (network error,
-   * internal server error, etc) the client will continue to attempt to connect. However,
-   * if the connection fails with a persistent error, like an invalid SDK key, the client will
-   * not attempt to re-connect and an error will be logged to the console or the provided
-   * logger.
-   *
-   * @param context The current user's context to be used for evaluating targeting rules (optional).
-   */
-  initialize(context?: ConfigDirectorContext): Promise<void>;
-  /**
-   * Updates the user's context and re-evaluates all config and flag values based on the new context.
-   *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
-   */
-  updateContext(context: ConfigDirectorContext): Promise<void>;
-  /**
-   * Returns the current context the client is configured with, or undefined if there is no context.
-   *
-   * Note that the value returned does not updated immediately after calling {@link updateContext}. Only
-   * once the underlying connection was successful or timed out, the current context is updated. This is
-   * because while the context update is in progress, configs are still evaluated on the previous context.
-   *
-   */
-  get context(): ConfigDirectorContext | undefined;
-  /**
-   * Returns whether or not the client is ready after calling {@link initialize} or {@link updateContext}
-   *
-   * The definition of ready is that the connection to the server was successful, and config state
-   * was received.
-   */
-  get isReady(): boolean;
-  /**
-   * Returns whether or not the client is currently initializing. Upon client creation, it is `false`.
-   * It is `true` after calling `initialize` and becomes `false` again once initialization is completed.
-   */
-  get isInitializing(): boolean;
-  /**
-   * Evaluates a config and returns its value based on the current context and targeting rules
-   *
-   * @returns The evaluated config value, or the `defaultValue` if the config state was unavailable
-   * @param configKey The config key to evaluate
-   * @param defaultValue The default value to be returned if the config state is unavailable. For
-   * example, if the client cannot connect to the server due to network conditions, or if getValue
-   * is called before initialization is done.
-   */
-  getValue<T extends ConfigValueType>(configKey: string, defaultValue: T): T;
-  /**
-   * Watches for changes to a a config evaluation value. Whenever the config value changes, the
-   * provided callback function will be called with the new value. Changes can happen due to updates
-   * to the config in the ConfigDirector dashboard, or if the context is updated via {@link updateContext}.
-   *
-   * @returns An 'unwatch' function that can be called to remove the subscriber
-   *
-   * @param configKey The config key to watch
-   * @param defaultValue The default value to be referenced if the config state is unavailable
-   * @param callback The callback function to be called whenever the config value is updated
-   */
-  watch<T extends ConfigValueType>(configKey: string, defaultValue: T, callback: WatchHandler<T>): () => void;
-  /**
-   * Removes a particular subscriber to the given `configKey`, or all subscribers if no callback
-   * is provided.
-   *
-   * @param configKey The config key to remove subscribers from
-   * @param callback The subscriber to be removed. If not provided, all subscribers are removed for
-   * the given `configKey`.
-   */
-  unwatch<T extends ConfigValueType>(configKey: string, callback?: WatchHandler<T>): void;
-  /**
-   * Removes all subscribers from all config keys
-   */
-  unwatchAll(): void;
-  /**
-   * Pauses the network connection without clearing event handlers, watch handlers, or config
-   * state. Intended for mobile environments where the OS may kill background connections (e.g.
-   * when the app is backgrounded on iOS/Android).
-   *
-   * Call {@link resumeNetwork} to re-establish the connection.
-   */
-  pauseNetwork(): void;
-  /**
-   * Resumes a connection that was paused via {@link pauseNetwork}, using the last context that
-   * was provided to {@link initialize} or {@link updateContext}.
-   */
-  resumeNetwork(): Promise<void>;
-  /**
-   * Disposes of the client. All connections are closed, and all event and config key subscribers
-   * are removed.
-   *
-   * Intended to be called when your application shuts down
-   */
-  dispose(): void;
-}
-//#endregion
 //#region src/types.d.ts
 type ClientStatus = "loading" | "ready" | "default";
 interface ConfigDirectorContextData {
@@ -218,10 +16,48 @@ type ConfigDirectorProviderOptions = {
   appVersion?: string;
   url?: string;
   timeout?: number;
+  /**
+   * The connection mode, one of `streaming` or `polling`. In `streaming` mode the connection stays
+   * open and receives config updates as they happen. In `polling` mode configs are fetched once during
+   * initialization and then again on every `pollingInterval`.
+   *
+   * Defaults to `streaming`.
+   */
+  mode?: ConnectionMode;
+  /**
+   * The polling interval in seconds when `mode` is `polling`. Has no effect in `streaming` mode.
+   *
+   * Defaults to 60 seconds. A value below the minimum of 30 seconds is raised to 30 seconds and a
+   * warning is logged.
+   */
+  pollingInterval?: number;
   context?: ConfigDirectorContext;
   logger?: ConfigDirectorLogger;
   hooks?: ClientHooks;
 };
+/**
+ * Props of a `ConfigDirectorProvider` given an existing client instead of the options to build one,
+ * for example a test client's `client`.
+ */
+type ConfigDirectorProviderClientProps = {
+  /**
+   * The client to provide. The provider never disposes it. If the client is not ready and not
+   * initializing, the provider initializes it with `context`; if it is ready and `context` is given
+   * and differs from the client's context, the provider updates the context; otherwise it leaves the
+   * client as it is and reports ready as soon as the client is.
+   */
+  client: ConfigDirectorClient;
+  context?: ConfigDirectorContext;
+  /**
+   * Event handlers registered on the client while the provider is mounted, and removed when it
+   * unmounts.
+   */
+  hooks?: ClientHooks;
+};
+/**
+ * Props of `ConfigDirectorProvider`: either the options to build a client from, or an existing client.
+ */
+type ConfigDirectorProviderProps = ConfigDirectorProviderOptions | ConfigDirectorProviderClientProps;
 //#endregion
 //#region src/withProvider.d.ts
 declare const withProvider: (options: ConfigDirectorProviderOptions) => Promise<({
@@ -231,10 +67,14 @@ declare const withProvider: (options: ConfigDirectorProviderOptions) => Promise<
 }) => _$react_jsx_runtime0.JSX.Element>;
 //#endregion
 //#region src/provider.d.ts
-declare class ConfigDirectorProvider extends Component<PropsWithChildren<ConfigDirectorProviderOptions>, ConfigDirectorProviderState> {
-  constructor(props: ConfigDirectorProviderOptions);
+declare class ConfigDirectorProvider extends Component<PropsWithChildren<ConfigDirectorProviderProps>, ConfigDirectorProviderState> {
+  private readonly ownsClient;
+  private disposedOwnClient;
+  private handlers;
+  constructor(props: ConfigDirectorProviderProps);
   componentDidMount(): Promise<void>;
-  componentDidUpdate(prevProps: PropsWithChildren<ConfigDirectorProviderOptions>): Promise<void>;
+  private connect;
+  componentDidUpdate(prevProps: PropsWithChildren<ConfigDirectorProviderProps>): Promise<void>;
   componentWillUnmount(): void;
   render(): _$react_jsx_runtime0.JSX.Element;
 }
@@ -255,5 +95,5 @@ declare const useClient: () => {
 //#region src/logger.d.ts
 declare const createConsoleLogger: (level: ConfigDirectorLoggingLevel) => ConfigDirectorLogger;
 //#endregion
-export { ConfigDirectorProvider, createConsoleLogger, useClient, useConfigValue, useContext, withProvider };
+export { type ClientStatus, type ConfigDirectorClient, type ConfigDirectorContext, ConfigDirectorProvider, type ConfigDirectorProviderClientProps, type ConfigDirectorProviderOptions, type ConfigDirectorProviderProps, type ConnectionMode, createConsoleLogger, useClient, useConfigValue, useContext, withProvider };
 //# sourceMappingURL=configdirector-react-client.d.mts.map

package/dist/configdirector-react-client.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"configdirector-react-client.d.mts","names":[],"sources":["../../js-client-core/src/Emitter.ts","../../shared/src/types.ts","../../js-client-core/src/types.ts","../src/types.ts","../src/withProvider.tsx","../src/provider.tsx","../src/hooks.tsx","../src/logger.ts"],"mappings":";;;;KAAK,SAAA;AAAA,KACA,YAAA,GAAe,MAAA,CAAO,SAAA;AAAA,KAEtB,OAAA,uBAA8B,YAAA,qBAAiC,aAAA,KAClE,OAAA,EAAS,aAAA,CAAc,IAAA;AAAA,UAGR,aAAA,uBAAoC,YAAA;EACnD,EAAA,qBAAuB,aAAA,EAAe,IAAA,EAAM,KAAA,EAAO,OAAA,EAAS,OAAA,CAAQ,aAAA,EAAe,KAAA;EACnF,GAAA,qBAAwB,aAAA,EAAe,IAAA,EAAM,KAAA,EAAO,OAAA,GAAU,OAAA,CAAQ,aAAA,EAAe,KAAA;EACrF,KAAA;AAAA;;;KCEU,kBAAA;EAAA,CAAwB,GAAA;AAAA;AAAA,KAExB,eAAA,wCAAuD,kBAAA;AAAA,KAevD,0BAAA;AAAA,UAEK,oBAAA;EACf,KAAA,CAAM,OAAA,aAAoB,IAAA;EAE1B,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,IAAA,CAAK,OAAA,aAAoB,IAAA;EAEzB,KAAA,CAAM,OAAA,aAAoB,IAAA;AAAA;AAAA,KAOhB,gBAAA;AAAA,KAUA,gBAAA;EACV,GAAA;EACA,KAAA,EAAO,eAAA;EACP,OAAA;EACA,cAAA;EACA,MAAA,EAAQ,gBAAA;EACR,OAAA,GAAU,qBAAA;AAAA;;;;;KAMA,qBAAA;ED1Dc;;;;;;;;ECmExB,EAAA;EDpEA;;;;EC0EA,IAAA;ED1E4D;;;;ECgF5D,MAAA;IAAA,CAAY,GAAA;EAAA;ED/EiC;;;;;;;ECwF7C,SAAA;AAAA;;;KCkBU,WAAA;EACV,WAAA,GAAc,WAAA,kBAA6B,WAAA;EAC3C,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,cAAA,GAAiB,WAAA,qBAAgC,WAAA;EACjD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;EACnD,eAAA,GAAkB,WAAA,sBAAiC,WAAA;AAAA;AAAA,KAGzC,mBAAA;AAAA,KAEA,WAAA,sBAAiC,YAAA,KAAiB,OAAA,EAAS,YAAA,CAAa,MAAA;AAAA,KAExE,YAAA;EACV,cAAA;IAAkB,IAAA;EAAA;EAClB,WAAA;IAAe,MAAA,EAAQ,mBAAA;EAAA;EACvB,cAAA;IAAkB,OAAA,EAAS,qBAAA;EAAA;EAC3B,eAAA;IAAmB,UAAA,EAAY,gBAAA;EAAA;EAC/B,eAAA;IAAmB,KAAA,EAAO,KAAA;EAAA;AAAA;AAAA,KAGhB,YAAA,WAAuB,eAAA,KAAoB,OAAA,EAAS,CAAA;;;;;;;ADpEhE;;;UC+EiB,oBAAA,SAA6B,aAAA,CAAc,YAAA;EDtE1D;;;;;;;;;;ACuCF;;;EA6CE,UAAA,CAAW,OAAA,GAAU,qBAAA,GAAwB,OAAA;EA5CF;;;;;EAmD3C,aAAA,CAAc,OAAA,EAAS,qBAAA,GAAwB,OAAA;EAhDI;;;;;;;;EAAA,IA0D/C,OAAA,IAAW,qBAAA;EA5DE;;;;;;EAAA,IAoEb,OAAA;EAlE+C;;;;EAAA,IAwE/C,cAAA;EAvE0D;AAGhE;;;;;AAEA;;;EA6EE,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,GAAI,CAAA;EA7EJ;;;;;;;;;;;EA0FrE,KAAA,WAAgB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,QAAA,EAAU,YAAA,CAAa,CAAA;EAxFtE;;;;;;;;EAkGtB,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAjG5D;;;EAsGlB,UAAA;EApGA;;;;;;;EA6GA,YAAA;EA3G0B;;;AAG5B;EA8GE,aAAA,IAAiB,OAAA;EA9GK;;;;;;EAsHtB,OAAA;AAAA;;;KCtPU,YAAA;AAAA,UAEK,yBAAA;EACf,MAAA,GAAS,oBAAA;EACT,SAAA,GAAY,IAAA;EACZ,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,2BAAA,GAA8B,yBAAA;AAAA,KAE9B,6BAAA;EACV,MAAA;EACA,OAAA;EACA,UAAA;EACA,GAAA;EACA,OAAA;EACA,OAAA,GAAU,qBAAA;EACV,MAAA,GAAS,oBAAA;EACT,KAAA,GAAQ,WAAA;AAAA;;;cCnBG,YAAA,GAAsB,OAAA,EAAS,6BAAA,KAA6B,OAAA;EAAA;AAAA;EAUvB,QAAA,EAAU,SAAA;AAAA,MAAW,oBAAA,CAAA,GAAA,CAAA,OAAA;;;cCV1D,sBAAA,SAA+B,SAAA,CAC1C,iBAAA,CAAkB,6BAAA,GAClB,2BAAA;cAEY,KAAA,EAAO,6BAAA;EAaJ,iBAAA,CAAA,GAAqB,OAAA;EAarB,kBAAA,CACb,SAAA,EAAW,iBAAA,CAAkB,6BAAA,IAC5B,OAAA;EAUM,oBAAA,CAAA;EAIA,MAAA,CAAA,GAAM,oBAAA,CAAA,GAAA,CAAA,OAAA;AAAA;;;cCrCX,cAAA,aAA4B,eAAA,EAChC,GAAA,UACA,YAAA,EAAc,CAAA;EAEd,KAAA,EAAO,CAAA;EACP,WAAA,EAAa,YAAA;EACb,OAAA;AAAA;AAAA,cAYI,UAAA;2BAMkC,qBAAA,KAAqB,OAAA;AAAA;AAAA,cAOvD,SAAA;UAOL,oBAAA;AAAA;;;cCvCY,mBAAA,GAAuB,KAAA,EAAO,0BAAA,KAA6B,oBAAA"}
+{"version":3,"file":"configdirector-react-client.d.mts","names":[],"sources":["../src/types.ts","../src/withProvider.tsx","../src/provider.tsx","../src/hooks.tsx","../src/logger.ts"],"mappings":";;;;;KAQY,YAAA;AAAA,UAEK,yBAAA;EACf,MAAA,GAAS,oBAAA;EACT,SAAA,GAAY,IAAA;EACZ,MAAA,EAAQ,YAAA;AAAA;AAAA,KAGE,2BAAA,GAA8B,yBAAA;AAAA,KAE9B,6BAAA;EACV,MAAA;EACA,OAAA;EACA,UAAA;EACA,GAAA;EACA,OAAA;EAXY;;;;;;;EAmBZ,IAAA,GAAO,cAAA;EAlBP;;;;AAGF;;EAsBE,eAAA;EACA,OAAA,GAAU,qBAAA;EACV,MAAA,GAAS,oBAAA;EACT,KAAA,GAAQ,WAAA;AAAA;;;;;KAOE,iCAAA;EAPS;;;;;;EAcnB,MAAA,EAAQ,oBAAA;EACR,OAAA,GAAU,qBAAA;EAzBH;;;;EA8BP,KAAA,GAAQ,WAAA;AAAA;;;;KAME,2BAAA,GAA8B,6BAAA,GAAgC,iCAAA;;;cC1D7D,YAAA,GAAsB,OAAA,EAAS,6BAAA,KAA6B,OAAA;EAAA;AAAA;EAcvB,QAAA,EAAU,SAAA;AAAA,MAAW,oBAAA,CAAA,GAAA,CAAA,OAAA;;;cCb1D,sBAAA,SAA+B,SAAA,CAC1C,iBAAA,CAAkB,2BAAA,GAClB,2BAAA;EAAA,iBAEiB,UAAA;EAAA,QACT,iBAAA;EAAA,QACA,QAAA;cAEI,KAAA,EAAO,2BAAA;EAOJ,iBAAA,CAAA,GAAqB,OAAA;EAAA,QAoBtB,OAAA;EAiBC,kBAAA,CAAmB,SAAA,EAAW,iBAAA,CAAkB,2BAAA,IAA+B,OAAA;EAerF,oBAAA,CAAA;EASA,MAAA,CAAA,GAAM,oBAAA,CAAA,GAAA,CAAA,OAAA;AAAA;;;cCvEX,cAAA,aAA4B,eAAA,EAChC,GAAA,UACA,YAAA,EAAc,CAAA;EAEd,KAAA,EAAO,CAAA;EACP,WAAA,EAAa,YAAA;EACb,OAAA;AAAA;AAAA,cAYI,UAAA;2BAMkC,qBAAA,KAAqB,OAAA;AAAA;AAAA,cAOvD,SAAA;UAOL,oBAAA;AAAA;;;cCvCY,mBAAA,GAAuB,KAAA,EAAO,0BAAA,KAA6B,oBAAA"}