@configdirector/react-native-sdk 1.4.0 → 1.5.1

package/README.md

@@ -1,6 +1,36 @@
 # ConfigDirector React Native SDK
 
-This is the React Native SDK for [ConfigDirector](https://www.configdirector.com).
+[![npm][npm-badge]][npm]
+
+React Native SDK for [ConfigDirector](https://www.configdirector.com), remote config and feature flags with typed values, JSON Schema validation, and safe renames of live flags. Start free, no card required.
+
+## Install
+
+```bash
+npm install --save @configdirector/react-native-sdk
+```
+
+## Retrieve a value
+
+```tsx
+import { Text } from "react-native";
+import { ConfigDirectorProvider, useConfigValue } from "@configdirector/react-native-sdk";
+
+export default function App() {
+  return (
+    <ConfigDirectorProvider sdkKey="YOUR-CLIENT-SDK-KEY" appName="MyApp" appVersion="1.0.0">
+      <Home />
+    </ConfigDirectorProvider>
+  );
+}
+
+function Home() {
+  const { value: darkMode } = useConfigValue("dark-mode", false);
+  return <Text>dark-mode: {String(darkMode)}</Text>;
+}
+```
+
+Full details are in the [official documentation](https://docs.configdirector.com/sdks/mobile/react-native).
 
 ## Documentation
 
@@ -10,4 +40,9 @@ There is also [a quickstart guide for ConfigDirector and any of our SDKs](https:
 
 ## Getting Help
 
-Reach out to us via https://www.configdirector.com/support
+- [Ask a question in Discussions](https://github.com/orgs/ConfigDirector/discussions)
+- [Contact support](https://www.configdirector.com/support)
+
+[//]: # "links"
+[npm-badge]: https://img.shields.io/npm/v/@configdirector/react-native-sdk.svg
+[npm]: https://www.npmjs.com/package/@configdirector/react-native-sdk

package/dist/configdirector-react-native.mjs

@@ -553,6 +553,11 @@ const getRequestedType = (defaultValue) => {
 const isNumericNativeType = (requestedType) => {
 	return requestedType === "number" || requestedType === "bigint";
 };
+const configTypesNotReadableAsString = new Set([
+	"boolean",
+	"integer",
+	"float"
+]);
 const parseConfigValue = (configState, defaultValue) => {
 	const value = configState.value;
 	const requestedType = getRequestedType(defaultValue);
@@ -564,13 +569,22 @@ const parseConfigValue = (configState, defaultValue) => {
 		reason: "value-missing"
 	};
 	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 === "string") {
+		if (configTypesNotReadableAsString.has(configState.type)) return {
+			parsedValue: defaultValue,
+			parsedValueId: void 0,
+			requestedType,
+			usedDefault: true,
+			reason: "type-mismatch"
+		};
+		return {
+			parsedValue: value,
+			parsedValueId: configState.valueId,
+			requestedType,
+			usedDefault: false,
+			reason: "found-match"
+		};
+	}
 	if (typeof defaultValue === "boolean" && (configState.type === "boolean" || configState.type === "string" || configState.type === "enum")) {
 		const boolValue = parseConfigBoolean(value);
 		const hasBoolean = typeof boolValue === "boolean";
@@ -1346,12 +1360,14 @@ var ClientEventReporter = class {
 	constructor(options) {
 		_defineProperty(this, "sdkKey", void 0);
 		_defineProperty(this, "sdkIdentity", void 0);
+		_defineProperty(this, "metaContext", void 0);
 		_defineProperty(this, "logger", void 0);
 		_defineProperty(this, "url", void 0);
 		_defineProperty(this, "executeRequests", true);
 		this.sdkKey = options.sdkKey;
 		this.logger = options.logger;
 		this.sdkIdentity = options.sdkIdentity;
+		this.metaContext = options.metaContext;
 		this.url = options.urlFactory("client/telemetry/v1", options.baseUrl);
 	}
 	async report({ context, discreteEvents, aggregatedEvents, droppedEvents }) {
@@ -1363,7 +1379,9 @@ var ClientEventReporter = class {
 			clientSdkKey: this.sdkKey,
 			metaContext: {
 				sdkName: this.sdkIdentity.sdkName,
-				sdkVersion: this.sdkIdentity.sdkVersion
+				sdkVersion: this.sdkIdentity.sdkVersion,
+				appName: this.metaContext.appName,
+				appVersion: this.metaContext.appVersion
 			},
 			context,
 			discreteEvents,
@@ -1798,16 +1816,18 @@ const urlFactory = (input, base) => new MinimalUrl(input, base);
 //#endregion
 //#region src/client.ts
 const createClient = (clientSdkKey, clientOptions) => {
-	var _clientOptions$logger, _clientOptions$connec;
+	var _clientOptions$logger, _clientOptions$connec, _clientOptions$metada;
 	const sdkIdentity = {
 		sdkName: "react-native-sdk",
-		sdkVersion: "1.4.0"
+		sdkVersion: "1.5.1"
 	};
 	const logger = (_clientOptions$logger = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.logger) !== null && _clientOptions$logger !== void 0 ? _clientOptions$logger : createConsoleLogger("warn");
+	const baseUrl = (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;
 	return new DefaultConfigDirectorClient(new ReactNativeTelemetryClient({
 		sdkKey: clientSdkKey,
 		sdkIdentity,
-		baseUrl: (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,
+		metaContext: (_clientOptions$metada = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.metadata) !== null && _clientOptions$metada !== void 0 ? _clientOptions$metada : {},
+		baseUrl,
 		logger,
 		urlFactory
 	}), clientSdkKey, sdkIdentity, {

package/package.json

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