@configdirector/react-native-sdk 1.5.1 → 1.6.0

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

@@ -1,296 +1,7 @@
+import { a as ConfigDirectorLogMessageDecorator, c as ConfigValueType, i as ConfigDirectorContext, l as ConnectionMode, n as ConfigDirectorClient, o as ConfigDirectorLogger, r as ConfigDirectorClientOptions, s as ConfigDirectorLoggingLevel, t as ClientHooks } from "./types-fcPMBgiX.mjs";
 import { Component, PropsWithChildren } 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;
-}
-interface ConfigDirectorLogMessageDecorator {
-  decorateMessage(message: string): string;
-}
-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;
-};
-/**
- * Metadata about your application. It is recommended you include these values when configuring
- * a ConfigDirector client so that you can use them in targeting rules.
- */
-type ConfigDirectorMetaContext = {
-  appVersion?: string;
-  appName?: string;
-};
-type ConnectionMode = "streaming" | "polling";
-//#endregion
-//#region ../js-client-core/src/types.d.ts
-/**
- * Configuration options for the {@link ConfigDirectorClient}
- */
-type ConfigDirectorClientOptions = {
-  /**
-   * Application metadata that remains constant through the lifetime of the connection
-   */
-  metadata?: ConfigDirectorMetaContext;
-  /**
-   * Connection options
-   */
-  connection?: {
-    /**
-     * The connection mode to be used, one of `streaming` (default) or `polling`.
-     * If set to `streaming`, the connection will remain open and receive updates whenever
-     * config state is updated on the ConfigDirector dashboard.
-     * When set to `polling`, there will be an initial request to retrieve config state during
-     * initialization, and additional requests on a `pollingInterval`.
-     *
-     * Defaults to `streaming`
-     */
-    mode?: ConnectionMode;
-    /**
-     * The polling interval in _seconds_ when the `mode` is set to `polling`. This option has no
-     * effect when the `mode` is set to `streaming`.
-     *
-     * Defaults to 300 seconds (5 minutes). Values below the minimum of 60 seconds are raised
-     * to 60 seconds.
-     */
-    pollingInterval?: number;
-    /**
-     * The timeout, in _milliseconds_, to be used in initialization and when updating the context.
-     * If streaming is enabled, the operation (initialization or context update) may still succeed
-     * after it times out if no unrecoverable errors are encountered (like an invalid SDK key).
-     * If streaming is disabled, if the operation times out, it will not be retried.
-     */
-    timeout?: number;
-    /**
-     * The base URL to the ConfigDirector SDK server. To be used only when needing to route through a
-     * proxy to connect to the ConfigDirector SDK server. Please refer to the docs on how to configure
-     * a proxy for the client SDK.
-     */
-    url?: string;
-  };
-  /**
-   * A logger that implements {@link ConfigDirectorLogger}. It defaults to the ConfigDirector console
-   * logger set to 'warn' level.
-   *
-   * The log level of the default logger can be adjusted by creating a default logger with the desired
-   * level and providing it in this property:
-   * @example
-   * import { createClient, createConsoleLogger } from "@configdirector/client-sdk";
-   * const client = createClient(
-   *   "YOUR-SDK-KEY",
-   *   { logger: createConsoleLogger("debug") },
-   * );
-   */
-  logger?: ConfigDirectorLogger;
-  /**
-   * Handlers for hooks/events emitted by the client. Each hook accepts either a single event handler or
-   * an array of event handlers.
-   *
-   * @example
-   * import { createClient, createConsoleLogger } from "@configdirector/client-sdk";
-   * const client = createClient(
-   *   "YOUR-SDK-KEY",
-   *   {
-   *     hooks: {
-   *       configEvaluated: (event) => { console.log(event.evaluation); }
-   *     },
-   *   },
-   * );
-   */
-  hooks?: ClientHooks;
-};
-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 ../shared/src/logger.d.ts
 declare class DefaultConsoleLogger implements ConfigDirectorLogger {
   private readonly level;
@@ -333,20 +44,63 @@ 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;
   netInfoSubscribe?: NetInfoSubscribe;
 };
+/**
+ * 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;
+  netInfoSubscribe?: NetInfoSubscribe;
+};
+/**
+ * Props of `ConfigDirectorProvider`: either the options to build a client from, or an existing client.
+ */
+type ConfigDirectorProviderProps = ConfigDirectorProviderOptions | ConfigDirectorProviderClientProps;
 //#endregion
 //#region src/provider.d.ts
-declare class ConfigDirectorProvider extends Component<PropsWithChildren<ConfigDirectorProviderOptions>, ConfigDirectorProviderState> {
+declare class ConfigDirectorProvider extends Component<PropsWithChildren<ConfigDirectorProviderProps>, ConfigDirectorProviderState> {
   private appStateSubscription;
   private netInfoUnsubscribe;
   private wasOffline;
-  constructor(props: ConfigDirectorProviderOptions);
+  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>;
   private handleAppStateChange;
   private handleConnectivityChange;
   private reconnect;
@@ -379,4 +133,4 @@ declare class ConfigDirectorReactContextError extends Error {
 //#region src/logger.d.ts
 declare const createConsoleLogger: (level?: ConfigDirectorLoggingLevel) => DefaultConsoleLogger;
 //#endregion
-export { type ClientStatus, type ConfigDirectorClient, type ConfigDirectorClientOptions, type ConfigDirectorContext, type ConfigDirectorLogger, type ConfigDirectorLoggingLevel, ConfigDirectorProvider, type ConfigDirectorProviderOptions, ConfigDirectorReactContextError, type NetInfoSubscribe, createClient, createConsoleLogger, useClient, useConfigValue, useContext };
+export { type ClientStatus, type ConfigDirectorClient, type ConfigDirectorClientOptions, type ConfigDirectorContext, type ConfigDirectorLogger, type ConfigDirectorLoggingLevel, ConfigDirectorProvider, type ConfigDirectorProviderClientProps, type ConfigDirectorProviderOptions, type ConfigDirectorProviderProps, ConfigDirectorReactContextError, type ConnectionMode, type NetInfoSubscribe, createClient, createConsoleLogger, useClient, useConfigValue, useContext };