@configdirector/react-native-sdk 1.6.1 → 1.8.0

package/dist/{types-fcPMBgiX.d.mts → types-DoORnGTD.d.mts}

@@ -33,27 +33,40 @@ type ConfigEvaluation = {
   context?: ConfigDirectorContext;
 };
 /**
- * The user's context to be sent to ConfigDirector. This context will be used for targeting
- * rules evaluation.
+ * The context to be sent to ConfigDirector: the user or other entity, such as a device or an
+ * organization, that configs are evaluated for. 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.
+   * The context's identifier. This should be a value that uniquely identifies the user or other
+   * entity among contexts of the same {@link kind}.
    * 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.
+   * value is used for segmenting contexts in percentage rollouts, and changes to the {@link id}
+   * could result in the context being assigned to a different percentile.
    */
   id?: string;
   /**
-   * The user's display name. This will be shown in the ConfigDirector dashboard and may be
+   * The kind of entity this context represents, such as `user`, `device`, `organization`,
+   * `tenant` or `listing`. You can use any other kind that fits your application. A kind has 1
+   * to 64 characters, using only lowercase letters (`a`-`z`), digits, `-` and `_`. It is used
+   * exactly as given, without trimming or changing its case.
+   *
+   * A context with an invalid kind is ignored as a whole: the SDK logs an error and evaluates
+   * as if no context had been provided.
+   *
+   * @default "user"
+   */
+  kind?: string;
+  /**
+   * The context'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.
+   * Any arbitrary traits for the context. They will be shown in the ConfigDirector dashboard
+   * and may be used for targeting rules.
    */
   traits?: {
     [key: string]: unknown;
@@ -75,9 +88,76 @@ type ConfigDirectorMetaContext = {
   appVersion?: string;
   appName?: string;
 };
-type ConnectionMode = "streaming" | "polling";
+type ConnectionMode = "streaming" | "polling" | "offline";
+//#endregion
+//#region ../shared/src/native-values.d.ts
+type NativeJsonValue = boolean | number | string | null | NativeJsonValue[] | {
+  [key: string]: NativeJsonValue;
+};
+type NativeValue = boolean | number | string | NativeJsonValue[] | {
+  [key: string]: NativeJsonValue;
+};
+type NativeValues = Record<string, NativeValue>;
 //#endregion
 //#region ../js-client-core/src/types.d.ts
+/**
+ * One value an offline client serves for a config key. The config type follows from the value: a
+ * boolean, an integral number (`integer`), any other number (`float`), a string, or a plain object
+ * or array (`json`).
+ */
+type OfflineValue = NativeValue;
+/**
+ * The values an offline client serves, keyed by config key. See {@link OfflineValue} for how each
+ * value's config type is decided. Every context receives the same value.
+ */
+type OfflineValues = NativeValues;
+/**
+ * Connection options of the {@link ConfigDirectorClient}
+ */
+type ConnectionOptions = {
+  /**
+   * The connection mode to be used, one of `streaming` (default), `polling` or `offline`.
+   * 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`.
+   * When set to `offline`, the client never connects to ConfigDirector and sends nothing: it serves
+   * the values given in {@link values} to every context, or the in-code default values when none
+   * are given. No SDK key is needed.
+   *
+   * Defaults to `streaming`
+   */
+  mode?: ConnectionMode;
+  /**
+   * The values to serve in `offline` mode, keyed by config key. A value such as `null` makes
+   * `initialize` reject with a `ConfigDirectorInitializationError`.
+   *
+   * Can be given only in `offline` mode; otherwise `initialize` rejects.
+   */
+  values?: OfflineValues;
+  /**
+   * The polling interval in _seconds_ when the `mode` is set to `polling`. This option has no
+   * effect in the other modes.
+   *
+   * Defaults to 60 seconds. The minimum is 30 seconds. A value below the minimum is raised to the
+   * minimum and a warning is logged.
+   */
+  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. This option has
+   * no effect in `offline` mode.
+   */
+  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. This option has no effect in `offline` mode.
+   */
+  url?: string;
+};
 /**
  * Configuration options for the {@link ConfigDirectorClient}
  */
@@ -89,39 +169,7 @@ type ConfigDirectorClientOptions = {
   /**
    * 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 60 seconds. The minimum is 30 seconds. A value below the minimum is raised to the
-     * minimum and a warning is logged.
-     */
-    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;
-  };
+  connection?: ConnectionOptions;
   /**
    * A logger that implements {@link ConfigDirectorLogger}. It defaults to the ConfigDirector console
    * logger set to 'warn' level.
@@ -202,17 +250,25 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
    * 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).
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, and the client connects as if no context had been provided.
+   *
+   * @param context The current 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.
+   * Updates the context and re-evaluates all config and flag values based on the new context.
+   *
+   * A context whose {@link ConfigDirectorContext.kind} is invalid is ignored as a whole: an error is
+   * logged, the previous context is no longer used, and the client connects as if no context had been
+   * provided.
    *
-   * @param context The current user's context to be used for evaluating targeting rules (required).
+   * @param context The current 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.
+   * Returns the current context the client is configured with, or undefined if there is no context,
+   * including after a context with an invalid kind was ignored.
    *
    * 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
@@ -292,4 +348,4 @@ interface ConfigDirectorClient extends EventProvider<ClientEvents> {
   dispose(): void;
 }
 //#endregion
-export { ConfigDirectorLogMessageDecorator as a, ConfigValueType as c, ConfigDirectorContext as i, ConnectionMode as l, ConfigDirectorClient as n, ConfigDirectorLogger as o, ConfigDirectorClientOptions as r, ConfigDirectorLoggingLevel as s, ClientHooks as t };
+export { OfflineValues as a, NativeValues as c, ConfigDirectorLogger as d, ConfigDirectorLoggingLevel as f, OfflineValue as i, ConfigDirectorContext as l, ConnectionMode as m, ConfigDirectorClient as n, NativeJsonValue as o, ConfigValueType as p, ConfigDirectorClientOptions as r, NativeValue as s, ClientHooks as t, ConfigDirectorLogMessageDecorator as u };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configdirector/react-native-sdk",
-  "version": "1.6.1",
+  "version": "1.8.0",
   "description": "React Native client SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",
@@ -71,7 +71,9 @@
   },
   "devDependencies": {
     "@babel/core": "^7.29.0",
+    "@babel/plugin-transform-dynamic-import": "^7",
     "@eslint/js": "^10.0.1",
+    "@react-native-async-storage/async-storage": "^3.1.1",
     "@react-native/babel-preset": "^0.85.0",
     "@react-native/jest-preset": "^0.86.2",
     "@rollup/plugin-replace": "^6.0.3",
@@ -96,11 +98,15 @@
     "wtfnode": "^0.10.1"
   },
   "peerDependencies": {
+    "@react-native-async-storage/async-storage": ">=1.0.0",
     "expo": ">=52",
     "react": "*",
     "react-native": ">=0.75"
   },
   "peerDependenciesMeta": {
+    "@react-native-async-storage/async-storage": {
+      "optional": true
+    },
     "expo": {
       "optional": true
     }
@@ -130,7 +136,7 @@
       "^@eventsource/(.*)$": "<rootDir>/../eventsource/src/$1"
     },
     "transformIgnorePatterns": [
-      "node_modules/(?!((jest-)?react-native|@react-native(-community)?|@noble)/)"
+      "node_modules/(?!((jest-)?react-native|@react-native(-community|-async-storage)?|@noble)/)"
     ]
   }
 }