@configdirector/react-web-sdk 1.5.1 → 1.6.1

package/dist/types-CU9VmelO.d.mts

@@ -0,0 +1,210 @@
+//#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;
+};
+type ConnectionMode = "streaming" | "polling";
+//#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[];
+    removedKeys: 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;
+  /**
+   * Whether the client is trying to get its very first payload from the server. Upon client creation,
+   * it is `false`. It becomes `true` when `initialize` is called on a client that has never received a
+   * payload, stays `true` through timeouts and retries, and becomes `false` when the first payload
+   * arrives, when a fatal connection error stops the retries, or on `close`. `updateContext` and
+   * `resumeNetwork` never set it, and once a payload has been received it is never `true` again.
+   */
+  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
+export { ConfigDirectorLoggingLevel as a, ConfigDirectorLogger as i, ConfigDirectorClient as n, ConfigValueType as o, ConfigDirectorContext as r, ConnectionMode as s, ClientHooks as t };
+//# sourceMappingURL=types-CU9VmelO.d.mts.map

package/dist/types-CU9VmelO.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-CU9VmelO.d.mts","names":[],"sources":["../../js-client-core/src/Emitter.ts","../../shared/src/types.ts","../../js-client-core/src/types.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;ED1D2E;;;;;;;;ECmErF,EAAA;EDpE4C;;;;EC0E5C,IAAA;ED1EmD;;;;ECgFnD,MAAA;IAAA,CAAY,GAAA;EAAA;ED/E0D;;;;;;;ECwFtE,SAAA;AAAA;AAAA,KAYU,cAAA;;;KCOA,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;IAAgB,WAAA;EAAA;EAClC,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;;ADrEhE;;;;;;;;UCgFiB,oBAAA,SAA6B,aAAA,CAAc,YAAA;EDlDjD;;AAYX;;;;;;;;ACOA;;;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;;;;;;AAIrD;EAJqD,IA2E/C,cAAA;;;;AArEN;;;;;;EAgFE,QAAA,WAAmB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,GAAI,CAAA;EAhFe;;;;;;;;AAE1F;;;EA2FE,KAAA,WAAgB,eAAA,EAAiB,SAAA,UAAmB,YAAA,EAAc,CAAA,EAAG,QAAA,EAAU,YAAA,CAAa,CAAA;EAxFjE;;;;;;;;EAkG3B,OAAA,WAAkB,eAAA,EAAiB,SAAA,UAAmB,QAAA,GAAW,YAAA,CAAa,CAAA;EAnG/D;;;EAwGf,UAAA;EAvG2B;;;;;;;EAgH3B,YAAA;EA9G+B;AAGjC;;;EAiHE,aAAA,IAAiB,OAAA;EAjHM;;;;;;EAyHvB,OAAA;AAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configdirector/react-web-sdk",
-  "version": "1.5.1",
+  "version": "1.6.1",
   "description": "React web client SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",
@@ -31,10 +31,27 @@
         "types": "./dist/configdirector-react-client.d.mts",
         "default": "./dist/configdirector-react-client.mjs"
       }
+    },
+    "./testing": {
+      "require": {
+        "types": "./dist/configdirector-react-client-testing.d.cts",
+        "default": "./dist/configdirector-react-client-testing.cjs"
+      },
+      "default": {
+        "types": "./dist/configdirector-react-client-testing.d.mts",
+        "default": "./dist/configdirector-react-client-testing.mjs"
+      }
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "testing": [
+        "./dist/configdirector-react-client-testing.d.mts"
+      ]
     }
   },
   "files": [
-    "dist/*client.*"
+    "dist"
   ],
   "types": "dist/configdirector-react-client.d.mts",
   "browser": "dist/configdirector-react-client.mjs",