@configdirector/react-native-sdk 0.7.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

@@ -1,3 +1,4 @@
+import { sha256 } from "@noble/hashes/sha2.js";
 import React, { Component, useContext as useContext$1 } from "react";
 import { AppState } from "react-native";
 import { jsx } from "react/jsx-runtime";
@@ -550,22 +551,25 @@ const parseConfigValue = (configState, defaultValue) => {
 	const requestedType = getRequestedType(defaultValue);
 	if (!value) return {
 		parsedValue: defaultValue,
+		parsedValueId: void 0,
 		requestedType,
 		usedDefault: true,
 		reason: "value-missing"
 	};
-	if (configState.type === "json") return parseJson(value, defaultValue, requestedType);
+	if (configState.type === "json") return parseJson(value, defaultValue, requestedType, configState.valueId);
 	if (typeof defaultValue === "string") return {
 		parsedValue: value,
+		parsedValueId: configState.valueId,
 		requestedType,
 		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 {
 			parsedValue: hasBoolean ? boolValue : defaultValue,
+			parsedValueId: hasBoolean ? configState.valueId : void 0,
 			requestedType,
 			usedDefault: !hasBoolean,
 			reason: hasBoolean ? "found-match" : "invalid-boolean"
@@ -576,16 +580,18 @@ const parseConfigValue = (configState, defaultValue) => {
 		const hasNumber = typeof numValue === "number";
 		return {
 			parsedValue: hasNumber ? numValue : defaultValue,
+			parsedValueId: hasNumber ? configState.valueId : void 0,
 			requestedType,
 			usedDefault: !hasNumber,
 			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 {
 			parsedValue: hasNumber ? numValue : defaultValue,
+			parsedValueId: hasNumber ? configState.valueId : void 0,
 			requestedType,
 			usedDefault: !hasNumber,
 			reason: hasNumber ? "found-match" : "invalid-number"
@@ -593,6 +599,7 @@ const parseConfigValue = (configState, defaultValue) => {
 	}
 	return {
 		parsedValue: value,
+		parsedValueId: configState.valueId,
 		requestedType,
 		usedDefault: false,
 		reason: "found-match"
@@ -616,9 +623,10 @@ const parseConfigFloat = (value) => {
 	if (isNaN(num) || !isFinite(num)) return;
 	return num;
 };
-const parseJson = (jsonString, defaultValue, requestedType) => {
+const parseJson = (jsonString, defaultValue, requestedType, valueId) => {
 	if (typeof defaultValue === "string") return {
 		parsedValue: jsonString,
+		parsedValueId: valueId,
 		requestedType,
 		usedDefault: false,
 		reason: "found-match"
@@ -626,6 +634,7 @@ const parseJson = (jsonString, defaultValue, requestedType) => {
 	try {
 		return {
 			parsedValue: JSON.parse(jsonString),
+			parsedValueId: valueId,
 			requestedType,
 			usedDefault: false,
 			reason: "found-match"
@@ -633,6 +642,7 @@ const parseJson = (jsonString, defaultValue, requestedType) => {
 	} catch {
 		return {
 			parsedValue: defaultValue,
+			parsedValueId: void 0,
 			requestedType,
 			usedDefault: true,
 			reason: "invalid-json"
@@ -863,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);
@@ -911,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) {
@@ -949,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);
@@ -1006,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,
@@ -1017,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;
 		}
@@ -1029,12 +1056,31 @@ var DefaultConfigDirectorClient = class {
 			defaultValue,
 			requestedType: parseResult.requestedType,
 			evaluatedValue: parseResult.parsedValue,
+			evaluatedValueId: parseResult.parsedValueId,
 			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 {
@@ -1094,26 +1140,36 @@ var DefaultConfigDirectorClient = class {
 //#endregion
 //#region ../shared/src/telemetry/utils.ts
 const CONFIG_VALUE_MAX_LENGTH = 500;
-const sanitizeValue = (value, type) => {
-	if (type === "json" || type == null && typeof value === "object") try {
-		return { digest: djb2Hash(JSON.stringify(value)) };
-	} catch {
-		return { digest: value.toString() };
+const compactTelemetryValue = async (tv, valueIdGenerator) => {
+	if (tv.valueId) return { valueId: tv.valueId };
+	if (tv.value) {
+		if (tv.value.length <= CONFIG_VALUE_MAX_LENGTH && tv.type != "json") return { value: tv.value };
+		return { valueId: await valueIdGenerator(tv.value) };
 	}
-	if (value.toString().length > CONFIG_VALUE_MAX_LENGTH) return { digest: djb2Hash(value.toString()) };
-	else return { value: value.toString() };
+	return tv;
 };
-const djb2Hash = (data) => {
-	return djb2(new TextEncoder().encode(data)).toString(16).padStart(8, "0");
-};
-const djb2 = (bytes) => {
-	let hash = 5381;
-	for (let i = 0; i < bytes.length; i++) {
-		var _bytes$i;
-		hash = (hash << 5) + hash + ((_bytes$i = bytes[i]) !== null && _bytes$i !== void 0 ? _bytes$i : 0);
-		hash = hash >>> 0;
-	}
-	return hash;
+const mapToTelemetryValue = (ev) => {
+	var _ev$value;
+	if (ev.type === "json" || ev.type == null && typeof ev.value === "object") {
+		if (ev.valueId) return {
+			valueId: ev.valueId,
+			type: "json"
+		};
+		try {
+			return {
+				value: JSON.stringify(ev.value),
+				type: "json"
+			};
+		} catch {
+			return {
+				value: ev.value.toString(),
+				type: "json"
+			};
+		}
+	}
+	const stringValue = (_ev$value = ev.value) === null || _ev$value === void 0 ? void 0 : _ev$value.toString();
+	if (stringValue && stringValue.length <= CONFIG_VALUE_MAX_LENGTH) return { value: stringValue };
+	return ev.valueId ? { valueId: ev.valueId } : { value: stringValue };
 };
 const isEventListEmpty = (eventList) => {
 	const keys = Object.keys(eventList);
@@ -1289,9 +1345,6 @@ var TelemetryEventCollector = class {
 		const initialDelay = (_options$initialFlush = options.initialFlushIntervalDelay) !== null && _options$initialFlush !== void 0 ? _options$initialFlush : 5e3;
 		this.flushTimeout = setTimeout(() => this.flushAndScheduleNext(), initialDelay);
 	}
-	sanitizeValue(value, type) {
-		return sanitizeValue(value, type);
-	}
 	async flushAndScheduleNext() {
 		if ((await this.flush()).fatalError) {
 			this.collectEvents = false;
@@ -1299,20 +1352,6 @@ var TelemetryEventCollector = class {
 			this.logger.warn("[TelemetryEventCollector] Received a fatal error from telemetry collection. No longer collecting events.");
 		} else this.flushTimeout = setTimeout(() => this.flushAndScheduleNext(), this.flushIntervalDelay);
 	}
-	async flush() {
-		var _this$reporter;
-		if (!this.reporter) return {
-			success: false,
-			fatalError: false
-		};
-		const evaluationSnapshot = this.evaluationEventQueue.takeSnapshot();
-		return await ((_this$reporter = this.reporter) === null || _this$reporter === void 0 ? void 0 : _this$reporter.report({
-			context: this._context,
-			discreteEvents: {},
-			aggregatedEvents: { evaluatedConfig: this.aggregator.aggregate(evaluationSnapshot) },
-			droppedEvents: { evaluatedConfig: evaluationSnapshot.droppedCount }
-		}));
-	}
 	cancelScheduledFlush() {
 		clearTimeout(this.flushTimeout);
 	}
@@ -1327,13 +1366,36 @@ var TelemetryEventCollector = class {
 	}
 };
 //#endregion
+//#region ../shared/src/telemetry/EvaluatedConfigEventPreprocessor.ts
+var EvaluatedConfigEventPreprocessor = class {
+	constructor(valueIdGenerator) {
+		this.valueIdGenerator = valueIdGenerator;
+		this.valueIdGenerator = valueIdGenerator;
+	}
+	async process(snapshot) {
+		const events = await Promise.all(snapshot.events.map(async (e) => {
+			return {
+				...e,
+				defaultValue: await compactTelemetryValue(e.defaultValue, this.valueIdGenerator),
+				evaluatedValue: await compactTelemetryValue(e.evaluatedValue, this.valueIdGenerator)
+			};
+		}));
+		return {
+			...snapshot,
+			events
+		};
+	}
+};
+//#endregion
 //#region ../js-client-core/src/telemetry/ClientTelemetryEventCollector.ts
 var ClientTelemetryEventCollector = class extends TelemetryEventCollector {
 	constructor(options) {
 		super(options);
+		_defineProperty(this, "evaluationEventSnapshotPreprocessor", void 0);
 		_defineProperty(this, "reporter", void 0);
 		_defineProperty(this, "_context", void 0);
 		this.reporter = new ClientEventReporter(options);
+		this.evaluationEventSnapshotPreprocessor = new EvaluatedConfigEventPreprocessor(options.valueIdGenerator);
 	}
 	async updateContext(value) {
 		this.cancelScheduledFlush();
@@ -1349,6 +1411,20 @@ var ClientTelemetryEventCollector = class extends TelemetryEventCollector {
 		this.cancelScheduledFlush();
 		await this.flushAndScheduleNext();
 	}
+	async flush() {
+		var _this$reporter;
+		if (!this.reporter) return {
+			success: false,
+			fatalError: false
+		};
+		const evaluationSnapshot = await this.evaluationEventSnapshotPreprocessor.process(this.evaluationEventQueue.takeSnapshot());
+		return await ((_this$reporter = this.reporter) === null || _this$reporter === void 0 ? void 0 : _this$reporter.report({
+			context: this._context,
+			discreteEvents: {},
+			aggregatedEvents: { evaluatedConfig: this.aggregator.aggregate(evaluationSnapshot) },
+			droppedEvents: { evaluatedConfig: evaluationSnapshot.droppedCount }
+		}));
+	}
 };
 //#endregion
 //#region src/logger.ts
@@ -1475,6 +1551,28 @@ const parseHeaders = (raw) => {
 	return headers;
 };
 //#endregion
+//#region ../shared/src/base62-encoder.ts
+const BASE62 = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
+const toBase62 = (buf, length) => {
+	const ZERO = BigInt(0);
+	const BASE = BigInt(62);
+	const hex = Array.from(buf).map((b) => b.toString(16).padStart(2, "0")).join("");
+	let n = BigInt("0x" + hex);
+	let result = "";
+	while (n > ZERO) {
+		result = BASE62[Number(n % BASE)] + result;
+		n /= BASE;
+	}
+	return result.padStart(length, "0");
+};
+const BASE62_LENGTH = Math.ceil(128 / Math.log2(62));
+//#endregion
+//#region src/value-id-generator.ts
+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, 16), BASE62_LENGTH);
+};
+//#endregion
 //#region src/ReactNativeTelemetryClient.ts
 var ReactNativeTelemetryClient = class {
 	constructor(sdkKey, baseUrl, logger, urlFactory) {
@@ -1483,7 +1581,8 @@ var ReactNativeTelemetryClient = class {
 			sdkKey,
 			logger,
 			baseUrl,
-			urlFactory
+			urlFactory,
+			valueIdGenerator: async (v) => generateValueId(v)
 		});
 	}
 	async updateContext(value) {
@@ -1498,8 +1597,15 @@ var ReactNativeTelemetryClient = class {
 	sanitizeEvaluatedConfigEvent(event) {
 		return {
 			...event,
-			defaultValue: sanitizeValue(event.defaultValue, event.type),
-			evaluatedValue: sanitizeValue(event.evaluatedValue, event.type)
+			defaultValue: mapToTelemetryValue({
+				value: event.defaultValue,
+				type: event.type
+			}),
+			evaluatedValue: mapToTelemetryValue({
+				value: event.evaluatedValue,
+				valueId: event.evaluatedValueId,
+				type: event.type
+			})
 		};
 	}
 };
@@ -1525,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.7.0"
+		sdkVersion: "0.9.0"
 	}, {
 		...clientOptions,
 		logger
@@ -1575,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.7.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",
@@ -52,6 +52,9 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
   },
+  "dependencies": {
+    "@noble/hashes": "^2.2.0"
+  },
   "devDependencies": {
     "@babel/core": "^7.29.0",
     "@eslint/js": "^10.0.1",
@@ -112,7 +115,7 @@
       "^@eventsource/(.*)$": "<rootDir>/../eventsource/src/$1"
     },
     "transformIgnorePatterns": [
-      "node_modules/(?!((jest-)?react-native|@react-native(-community)?)/)"
+      "node_modules/(?!((jest-)?react-native|@react-native(-community)?|@noble)/)"
     ]
   }
 }