@configdirector/react-native-sdk 0.8.0 → 0.9.0

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

@@ -26,6 +26,15 @@ interface ConfigDirectorLogger {
 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.
@@ -131,8 +140,31 @@ type ConfigDirectorClientOptions = {
    * );
    */
   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">[];
 };
 type ClientConnectAction = "initialization" | "context update" | "network resume";
+type HookHandler<TEvent extends keyof ClientEvents> = (payload: ClientEvents[TEvent]) => void;
 type ClientEvents = {
   configsUpdated: {
     keys: string[];
@@ -143,6 +175,9 @@ type ClientEvents = {
   contextUpdated: {
     context: ConfigDirectorContext | undefined;
   };
+  configEvaluated: {
+    evaluation: ConfigEvaluation;
+  };
 };
 type WatchHandler<T extends ConfigValueType> = (message: T) => void;
 /**
@@ -297,6 +332,7 @@ type ConfigDirectorProviderOptions = {
   timeout?: number;
   context?: ConfigDirectorContext;
   logger?: ConfigDirectorLogger;
+  hooks?: ClientHooks;
   netInfoSubscribe?: NetInfoSubscribe;
 };
 //#endregion

package/dist/configdirector-react-native.mjs

@@ -564,7 +564,7 @@ const parseConfigValue = (configState, defaultValue) => {
 		usedDefault: false,
 		reason: "found-match"
 	};
-	if (typeof defaultValue === "boolean" && configState.type === "boolean") {
+	if (typeof defaultValue === "boolean" && (configState.type === "boolean" || configState.type === "string")) {
 		const boolValue = parseConfigBoolean(value);
 		const hasBoolean = typeof boolValue === "boolean";
 		return {
@@ -586,7 +586,7 @@ const parseConfigValue = (configState, defaultValue) => {
 			reason: hasNumber ? "found-match" : "invalid-number"
 		};
 	}
-	if (isNumericNativeType(typeof defaultValue) && (configState.type === "float" || configState.type === "enum")) {
+	if (isNumericNativeType(typeof defaultValue) && (configState.type === "float" || configState.type === "enum" || configState.type === "string")) {
 		const numValue = parseConfigFloat(value);
 		const hasNumber = typeof numValue === "number";
 		return {
@@ -873,7 +873,7 @@ const CLIENT_BASE_URL = "https://client-sdk-api.configdirector.com";
 const MAX_EXPONENTIAL_DELAY = 9;
 var DefaultConfigDirectorClient = class {
 	constructor(telemetryClient, clientSdkKey, sdkOptions, clientOptions, internalClientOptions) {
-		var _clientOptions$logger, _clientOptions$connec, _clientOptions$connec2, _internalClientOption, _this$parseUrl, _clientOptions$connec3, _clientOptions$connec4, _clientOptions$connec5, _navigator, _internalClientOption2, _clientOptions$connec6;
+		var _clientOptions$logger, _clientOptions$connec, _clientOptions$connec2, _internalClientOption, _this$parseUrl, _clientOptions$connec3, _clientOptions$connec4, _clientOptions$connec5, _navigator, _internalClientOption2, _clientOptions$connec6, _clientOptions$hooks, _clientOptions$hooks2, _clientOptions$hooks3, _clientOptions$hooks4;
 		_defineProperty(this, "logger", void 0);
 		_defineProperty(this, "telemetryClient", void 0);
 		_defineProperty(this, "configSet", void 0);
@@ -921,18 +921,27 @@ var DefaultConfigDirectorClient = class {
 			const configKeys = Object.keys(configSet.configs);
 			if (!this.configSet || configSet.kind == "full") {
 				this.configSet = configSet;
-				this.eventEmitter.emit("configsUpdated", { keys: configKeys });
+				this.emit("configsUpdated", { keys: configKeys });
 				this.updateWatchers(configSet.configs);
 			} else {
 				this.configSet.configs = {
 					...this.configSet.configs,
 					...configSet.configs
 				};
-				this.eventEmitter.emit("configsUpdated", { keys: configKeys });
+				this.emit("configsUpdated", { keys: configKeys });
 				this.updateWatchers(configSet.configs);
 			}
 			this.logger.debug("[ConfigDirectorClient] ConfigSet updated from server:", { keys: configKeys });
 		});
+		this.registerHandler("clientReady", clientOptions === null || clientOptions === void 0 || (_clientOptions$hooks = clientOptions.hooks) === null || _clientOptions$hooks === void 0 ? void 0 : _clientOptions$hooks.clientReady);
+		this.registerHandler("configEvaluated", clientOptions === null || clientOptions === void 0 || (_clientOptions$hooks2 = clientOptions.hooks) === null || _clientOptions$hooks2 === void 0 ? void 0 : _clientOptions$hooks2.configEvaluated);
+		this.registerHandler("configsUpdated", clientOptions === null || clientOptions === void 0 || (_clientOptions$hooks3 = clientOptions.hooks) === null || _clientOptions$hooks3 === void 0 ? void 0 : _clientOptions$hooks3.configsUpdated);
+		this.registerHandler("contextUpdated", clientOptions === null || clientOptions === void 0 || (_clientOptions$hooks4 = clientOptions.hooks) === null || _clientOptions$hooks4 === void 0 ? void 0 : _clientOptions$hooks4.contextUpdated);
+	}
+	registerHandler(event, handler) {
+		if (!handler) return;
+		const handlers = Array.isArray(handler) ? handler : [handler];
+		for (const h of handlers) if (typeof h === "function") this.on(event, h);
 	}
 	getTransportConstructor(connectionMode) {
 		switch (connectionMode) {
@@ -959,14 +968,14 @@ var DefaultConfigDirectorClient = class {
 			}).then(() => {
 				this.ready = true;
 				this.initializing = false;
-				this.eventEmitter.emit("clientReady", { action: caller });
+				this.emit("clientReady", { action: caller });
 				this.logger.debug("[ConfigDirectorClient] Received initial payload from the server, client is ready");
 			});
 			const startTime = (/* @__PURE__ */ new Date()).getTime();
 			await this.transport.connect(context !== null && context !== void 0 ? context : {}, this.timeout);
 			this.currentContext = context;
 			this.telemetryClient.updateContext(context);
-			this.eventEmitter.emit("contextUpdated", { context });
+			this.emit("contextUpdated", { context });
 			const elapsedTime = (/* @__PURE__ */ new Date()).getTime() - startTime;
 			const remainingTimeout = this.timeout - elapsedTime;
 			clearTimeout(this.timeoutTimer);
@@ -1016,10 +1025,11 @@ var DefaultConfigDirectorClient = class {
 		return this.getValueFromConfigState(configKey, configState, defaultValue);
 	}
 	getValueFromConfigState(configKey, configState, defaultValue) {
-		var _this$currentContext2;
+		var _this$currentContext2, _parseResult$parsedVa;
 		if (!configState) {
 			var _this$currentContext;
 			this.logger.debug(`[ConfigDirectorClient] No config state found for '${configKey}', returning default value '${defaultValue}'`);
+			const reason = this.isReady ? "config-state-missing" : "client-not-ready";
 			this.telemetryClient.evaluatedConfig({
 				contextId: (_this$currentContext = this.currentContext) === null || _this$currentContext === void 0 ? void 0 : _this$currentContext.id,
 				key: configKey,
@@ -1027,7 +1037,14 @@ var DefaultConfigDirectorClient = class {
 				requestedType: getRequestedType(defaultValue),
 				evaluatedValue: defaultValue,
 				usedDefault: true,
-				evaluationReason: "config-state-missing"
+				evaluationReason: reason
+			});
+			this.dispatchEvaluationEvent({
+				key: configKey,
+				value: defaultValue,
+				isDefaultValue: true,
+				reason,
+				context: this.context
 			});
 			return defaultValue;
 		}
@@ -1043,9 +1060,27 @@ var DefaultConfigDirectorClient = class {
 			usedDefault: parseResult.usedDefault,
 			evaluationReason: parseResult.reason
 		});
+		this.dispatchEvaluationEvent({
+			key: configKey,
+			value: parseResult.parsedValue,
+			valueId: (_parseResult$parsedVa = parseResult.parsedValueId) !== null && _parseResult$parsedVa !== void 0 ? _parseResult$parsedVa : void 0,
+			isDefaultValue: parseResult.usedDefault,
+			reason: parseResult.reason,
+			context: this.context
+		});
 		this.logger.debug(`[ConfigDirectorClient] Evaluated '${configKey}' to '${parseResult.parsedValue}'`);
 		return parseResult.parsedValue;
 	}
+	dispatchEvaluationEvent(event) {
+		setTimeout(() => this.emit("configEvaluated", { evaluation: event }), 0);
+	}
+	emit(name, payload) {
+		try {
+			this.eventEmitter.emit(name, payload);
+		} catch (error) {
+			this.logger.error(`[ConfigDirectorClient] Error executing event handlers for '${name}'`, error);
+		}
+	}
 	parseUrl(url, urlFactory) {
 		if (!url) return;
 		try {
@@ -1530,13 +1565,12 @@ const toBase62 = (buf, length) => {
 	}
 	return result.padStart(length, "0");
 };
+const BASE62_LENGTH = Math.ceil(128 / Math.log2(62));
 //#endregion
 //#region src/value-id-generator.ts
-const DIGEST_BYTES = 16;
-const BASE62_LENGTH = Math.ceil(DIGEST_BYTES * 8 / Math.log2(62));
 const generateValueId = (v) => {
 	var _v$toString;
-	return toBase62(sha256(encodeUtf8((_v$toString = v === null || v === void 0 ? void 0 : v.toString()) !== null && _v$toString !== void 0 ? _v$toString : "")).subarray(0, DIGEST_BYTES), BASE62_LENGTH);
+	return toBase62(sha256(encodeUtf8((_v$toString = v === null || v === void 0 ? void 0 : v.toString()) !== null && _v$toString !== void 0 ? _v$toString : "")).subarray(0, 16), BASE62_LENGTH);
 };
 //#endregion
 //#region src/ReactNativeTelemetryClient.ts
@@ -1597,7 +1631,7 @@ const createClient = (clientSdkKey, clientOptions) => {
 	const logger = (_clientOptions$logger = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.logger) !== null && _clientOptions$logger !== void 0 ? _clientOptions$logger : createConsoleLogger("warn");
 	return new DefaultConfigDirectorClient(new ReactNativeTelemetryClient(clientSdkKey, (clientOptions === null || clientOptions === void 0 || (_clientOptions$connec = clientOptions.connection) === null || _clientOptions$connec === void 0 ? void 0 : _clientOptions$connec.url) ? urlFactory(clientOptions.connection.url) : CLIENT_BASE_URL, logger, urlFactory), clientSdkKey, {
 		sdkName: "react-native-sdk",
-		sdkVersion: "0.8.0"
+		sdkVersion: "0.9.0"
 	}, {
 		...clientOptions,
 		logger
@@ -1647,7 +1681,8 @@ var ConfigDirectorProvider = class extends Component {
 					appName: props.appName,
 					appVersion: props.appVersion
 				},
-				logger: (_props$logger = props.logger) !== null && _props$logger !== void 0 ? _props$logger : createConsoleLogger("warn")
+				logger: (_props$logger = props.logger) !== null && _props$logger !== void 0 ? _props$logger : createConsoleLogger("warn"),
+				hooks: props.hooks
 			}),
 			status: "loading"
 		};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configdirector/react-native-sdk",
-  "version": "0.8.0",
+  "version": "0.9.0",
   "description": "React Native client SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",