@launchdarkly/react-native-client-sdk 0.1.0-alpha

package/CHANGELOG.md

@@ -0,0 +1,3 @@
+# Changelog
+
+All notable changes to the LaunchDarkly SDK for React Native will be documented in this file. This project adheres to [Semantic Versioning](https://semver.org).

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Catamorphic, Co.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,120 @@
+# LaunchDarkly React Native SDK
+
+> [!WARNING]  
+> UNSUPPORTED This SDK is in pre-release development and is not supported.
+
+[![NPM][sdk-react-native-npm-badge]][sdk-react-native-npm-link]
+[![Actions Status][sdk-react-native-ci-badge]][sdk-react-native-ci]
+[![Documentation][sdk-react-native-ghp-badge]][sdk-react-native-ghp-link]
+[![NPM][sdk-react-native-dm-badge]][sdk-react-native-npm-link]
+[![NPM][sdk-react-native-dt-badge]][sdk-react-native-npm-link]
+
+The LaunchDarkly React Native SDK is designed primarily for use in mobile environments. It follows the client-side LaunchDarkly model for multi-user contexts.
+
+This SDK is a replacement of [launchdarkly-react-native-client-sdk](https://github.com/launchdarkly/react-native-client-sdk). Please consider updating your application to use this package instead.
+
+For more information, see the [complete reference guide for this SDK](https://docs.launchdarkly.com/sdk/client-side/react-native).
+
+## Install
+
+```shell
+yarn add @launchdarkly/react-native-client-sdk
+```
+
+Additionally, the LaunchDarkly React-Native SDK uses
+[@react-native-async-storage/async-storage](https://github.com/react-native-async-storage/async-storage)
+for bootstrapping. This is a native dependency.
+
+If you are using expo, then installing this package from npm like above and re-running pod install should suffice.
+
+If you are not using expo, you will need to explicitly add
+@react-native-async-storage/async-storage as a dependency to your project
+and re-run pod install for [auto-linking to work](https://github.com/react-native-community/cli/issues/1347).
+
+## Quickstart
+
+1. Wrap your application with `LDProvider` passing it an LDClient and
+   an LDContext:
+
+```jsx
+// App.tsx
+import { LDProvider, ReactNativeLDClient } from '@launchdarkly/react-native-client-sdk';
+
+const featureClient = new ReactNativeLDClient('mobile-key');
+const userContext = { kind: 'user', key: 'test-user-1' };
+
+const App = () => (
+  <LDProvider client={featureClient} context={userContext}>
+    <Welcome />
+  </LDProvider>
+);
+
+export default App;
+```
+
+2. Then in a child component, evaluate flags with `useBoolVariation`:
+
+```jsx
+import { useBoolVariation } from '@launchdarkly/react-native-client-sdk';
+
+export default function Welcome() {
+  const flagValue = useBoolVariation('flag-key', false);
+
+  return (
+    <View style={styles.container}>
+      <Text>Welcome to LaunchDarkly</Text>
+      <Text>Flag value is {`${flagValue}`}</Text>
+    </View>
+  );
+}
+```
+
+See the full [example app](https://github.com/launchdarkly/js-core/tree/main/packages/sdk/react-native/example).
+
+## Developing this SDK
+
+1. Build all the code in the `js-core` repo:
+
+```shell
+# at js-core repo root
+yarn && yarn build
+```
+
+2. The example app uses [react-native-dotenv](https://github.com/goatandsheep/react-native-dotenv)
+   to manage environment variables. Under `packages/sdk/react-native/example`
+   create an `.env` file and add your mobile key:
+
+```shell
+echo "MOBILE_KEY=mob-abc" >> packages/sdk/react-native/example/.env
+```
+
+3. Run the example app. This will link the local react-native sdk code to the
+   example app for development:
+
+```shell
+# in react-native/example
+yarn && yarn ios-go
+```
+
+## About LaunchDarkly
+
+- LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
+  - Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
+  - Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
+  - Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
+  - Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
+- LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read [our documentation](https://docs.launchdarkly.com/sdk) for a complete list.
+- Explore LaunchDarkly
+  - [launchdarkly.com](https://www.launchdarkly.com/ 'LaunchDarkly Main Website') for more information
+  - [docs.launchdarkly.com](https://docs.launchdarkly.com/ 'LaunchDarkly Documentation') for our documentation and SDK reference guides
+  - [apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/ 'LaunchDarkly API Documentation') for our API documentation
+  - [blog.launchdarkly.com](https://blog.launchdarkly.com/ 'LaunchDarkly Blog Documentation') for the latest product updates
+
+[sdk-react-native-ci-badge]: https://github.com/launchdarkly/js-core/actions/workflows/react-native.yml/badge.svg
+[sdk-react-native-ci]: https://github.com/launchdarkly/js-core/actions/workflows/react-native.yml
+[sdk-react-native-npm-badge]: https://img.shields.io/npm/v/@launchdarkly/react-native-client-sdk.svg?style=flat-square
+[sdk-react-native-npm-link]: https://www.npmjs.com/package/@launchdarkly/react-native-client-sdk
+[sdk-react-native-ghp-badge]: https://img.shields.io/static/v1?label=GitHub+Pages&message=API+reference&color=00add8
+[sdk-react-native-ghp-link]: https://launchdarkly.github.io/js-core/packages/sdk/react-native/docs/
+[sdk-react-native-dm-badge]: https://img.shields.io/npm/dm/@launchdarkly/react-native-client-sdk.svg?style=flat-square
+[sdk-react-native-dt-badge]: https://img.shields.io/npm/dt/@launchdarkly/react-native-client-sdk.svg?style=flat-square

package/dist/package.json

@@ -0,0 +1,77 @@
+{
+    "name": "@launchdarkly/react-native-client-sdk",
+    "version": "0.1.0-alpha",
+    "description": "React Native LaunchDarkly SDK",
+    "homepage": "https://github.com/launchdarkly/js-core/tree/main/packages/sdk/react-native",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/launchdarkly/js-core.git"
+    },
+    "license": "Apache-2.0",
+    "packageManager": "yarn@3.4.1",
+    "keywords": [
+        "launchdarkly",
+        "react-native"
+    ],
+    "type": "commonjs",
+    "main": "./dist/src/index.js",
+    "types": "./dist/src/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/src/index.d.ts",
+            "default": "./dist/src/index.js"
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "scripts": {
+        "clean": "rimraf dist",
+        "build": "npx tsc && yarn link-dev",
+        "tsw": "yarn tsc --watch",
+        "start": "rimraf dist && yarn tsw",
+        "lint": "eslint . --ext .ts",
+        "prettier": "prettier --write '**/*.@(js|ts|tsx|json|css)' --ignore-path ../../../.prettierignore",
+        "test": "NODE_OPTIONS=\"--experimental-vm-modules --no-warnings\" jest --ci --runInBand",
+        "coverage": "yarn test --coverage",
+        "check": "yarn prettier && yarn lint && yarn build && yarn test",
+        "link-dev": "./link-dev.sh",
+        "android": "yarn && yarn ./example && yarn build && (cd example/ && yarn android-release)",
+        "ios": "yarn && yarn ./example && yarn build && (cd example/ && yarn ios-go)"
+    },
+    "peerDependencies": {
+        "react": "*",
+        "react-native": "*"
+    },
+    "dependencies": {
+        "@launchdarkly/js-client-sdk-common": "0.1.0-alpha",
+        "@react-native-async-storage/async-storage": "^1.21.0",
+        "base64-js": "^1.5.1",
+        "event-target-shim": "^6.0.2"
+    },
+    "devDependencies": {
+        "@trivago/prettier-plugin-sort-imports": "^4.1.1",
+        "@types/jest": "^29.5.0",
+        "@types/react": "^18.2.31",
+        "@typescript-eslint/eslint-plugin": "^6.1.0",
+        "@typescript-eslint/parser": "^6.1.0",
+        "eslint": "^8.45.0",
+        "eslint-config-airbnb-base": "^15.0.0",
+        "eslint-config-airbnb-typescript": "^17.1.0",
+        "eslint-config-prettier": "^8.8.0",
+        "eslint-plugin-import": "^2.27.5",
+        "eslint-plugin-prettier": "^5.0.0",
+        "jest": "^29.5.0",
+        "launchdarkly-js-test-helpers": "^2.2.0",
+        "prettier": "^3.0.0",
+        "react": "^18.2.0",
+        "react-native": "^0.73.1",
+        "rimraf": "^5.0.5",
+        "ts-jest": "^29.1.0",
+        "typedoc": "0.25.0",
+        "typescript": "5.1.6"
+    },
+    "installConfig": {
+        "hoistingLimits": "workspaces"
+    }
+}

package/dist/src/ReactNativeLDClient.d.ts

@@ -0,0 +1,6 @@
+import { LDClientImpl, type LDContext, type LDOptions } from '@launchdarkly/js-client-sdk-common';
+export default class ReactNativeLDClient extends LDClientImpl {
+    constructor(sdkKey: string, options?: LDOptions);
+    createStreamUriPath(context: LDContext): string;
+}
+//# sourceMappingURL=ReactNativeLDClient.d.ts.map

package/dist/src/ReactNativeLDClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReactNativeLDClient.d.ts","sourceRoot":"","sources":["../../src/ReactNativeLDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,YAAY,EACZ,KAAK,SAAS,EACd,KAAK,SAAS,EACf,MAAM,oCAAoC,CAAC;AAI5C,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,YAAY;gBAC/C,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,SAAc;IAiB1C,mBAAmB,CAAC,OAAO,EAAE,SAAS;CAGhD"}

package/dist/src/ReactNativeLDClient.js

@@ -0,0 +1,21 @@
+import { base64UrlEncode, BasicLogger, LDClientImpl, } from '@launchdarkly/js-client-sdk-common';
+import createPlatform from './platform';
+export default class ReactNativeLDClient extends LDClientImpl {
+    constructor(sdkKey, options = {}) {
+        var _a;
+        const logger = (_a = options.logger) !== null && _a !== void 0 ? _a : new BasicLogger({
+            level: 'debug',
+            // eslint-disable-next-line no-console
+            destination: console.log,
+        });
+        const internalOptions = {
+            analyticsEventPath: `/mobile`,
+            diagnosticEventPath: `/mobile/events/diagnostic`,
+        };
+        super(sdkKey, createPlatform(logger), Object.assign(Object.assign({}, options), { logger }), internalOptions);
+    }
+    createStreamUriPath(context) {
+        return `/meval/${base64UrlEncode(JSON.stringify(context), this.platform.encoding)}`;
+    }
+}
+//# sourceMappingURL=ReactNativeLDClient.js.map

package/dist/src/ReactNativeLDClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ReactNativeLDClient.js","sourceRoot":"","sources":["../../src/ReactNativeLDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,WAAW,EAEX,YAAY,GAGb,MAAM,oCAAoC,CAAC;AAE5C,OAAO,cAAc,MAAM,YAAY,CAAC;AAExC,MAAM,CAAC,OAAO,OAAO,mBAAoB,SAAQ,YAAY;IAC3D,YAAY,MAAc,EAAE,UAAqB,EAAE;;QACjD,MAAM,MAAM,GACV,MAAA,OAAO,CAAC,MAAM,mCACd,IAAI,WAAW,CAAC;YACd,KAAK,EAAE,OAAO;YACd,sCAAsC;YACtC,WAAW,EAAE,OAAO,CAAC,GAAG;SACzB,CAAC,CAAC;QAEL,MAAM,eAAe,GAA+B;YAClD,kBAAkB,EAAE,SAAS;YAC7B,mBAAmB,EAAE,2BAA2B;SACjD,CAAC;QAEF,KAAK,CAAC,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,kCAAO,OAAO,KAAE,MAAM,KAAI,eAAe,CAAC,CAAC;IACjF,CAAC;IAEQ,mBAAmB,CAAC,OAAkB;QAC7C,OAAO,UAAU,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAS,CAAC,EAAE,CAAC;IACvF,CAAC;CACF"}

package/dist/src/hooks/index.d.ts

@@ -0,0 +1,4 @@
+import useLDClient from './useLDClient';
+export * from './variation';
+export { useLDClient };
+//# sourceMappingURL=index.d.ts.map

package/dist/src/hooks/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,cAAc,aAAa,CAAC;AAE5B,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/src/hooks/index.js

@@ -0,0 +1,4 @@
+import useLDClient from './useLDClient';
+export * from './variation';
+export { useLDClient };
+//# sourceMappingURL=index.js.map

package/dist/src/hooks/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/hooks/index.ts"],"names":[],"mappings":"AAAA,OAAO,WAAW,MAAM,eAAe,CAAC;AAExC,cAAc,aAAa,CAAC;AAE5B,OAAO,EAAE,WAAW,EAAE,CAAC"}

package/dist/src/hooks/useLDClient.d.ts

@@ -0,0 +1,3 @@
+declare const useLDClient: () => import("@launchdarkly/js-client-sdk-common").LDClient;
+export default useLDClient;
+//# sourceMappingURL=useLDClient.d.ts.map

package/dist/src/hooks/useLDClient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLDClient.d.ts","sourceRoot":"","sources":["../../../src/hooks/useLDClient.ts"],"names":[],"mappings":"AAIA,QAAA,MAAM,WAAW,6DAGhB,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/src/hooks/useLDClient.js

@@ -0,0 +1,8 @@
+import { useContext } from 'react';
+import { context } from '../provider/reactContext';
+const useLDClient = () => {
+    const { client } = useContext(context);
+    return client;
+};
+export default useLDClient;
+//# sourceMappingURL=useLDClient.js.map

package/dist/src/hooks/useLDClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useLDClient.js","sourceRoot":"","sources":["../../../src/hooks/useLDClient.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAC;AAEnC,OAAO,EAAE,OAAO,EAAgB,MAAM,0BAA0B,CAAC;AAEjE,MAAM,WAAW,GAAG,GAAG,EAAE;IACvB,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAe,OAAO,CAAC,CAAC;IACrD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF,eAAe,WAAW,CAAC"}

package/dist/src/hooks/variation/index.d.ts

@@ -0,0 +1,3 @@
+export * from './useVariation';
+export * from './useTypedVariation';
+//# sourceMappingURL=index.d.ts.map

package/dist/src/hooks/variation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/hooks/variation/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

package/dist/src/hooks/variation/index.js

@@ -0,0 +1,3 @@
+export * from './useVariation';
+export * from './useTypedVariation';
+//# sourceMappingURL=index.js.map

package/dist/src/hooks/variation/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/hooks/variation/index.ts"],"names":[],"mappings":"AAAA,cAAc,gBAAgB,CAAC;AAC/B,cAAc,qBAAqB,CAAC"}

package/dist/src/hooks/variation/useTypedVariation.d.ts

@@ -0,0 +1,32 @@
+import { LDEvaluationDetailTyped } from '@launchdarkly/js-client-sdk-common';
+/**
+ * Determines the strongly typed variation of a feature flag.
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The strongly typed value.
+ */
+export declare const useTypedVariation: <T extends unknown>(key: string, defaultValue: T) => T;
+/**
+ * Determines the strongly typed variation of a feature flag for a context, along with information about
+ * how it was calculated.
+ *
+ * The `reason` property of the result will also be included in analytics events, if you are
+ * capturing detailed event data for this flag.
+ *
+ * If the flag variation does not have the specified type, defaultValue is returned. The reason will
+ * indicate an error of the type `WRONG_KIND` in this case.
+ *
+ * For more information, see the [SDK reference
+ * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *  The result (as an {@link LDEvaluationDetailTyped<T>}).
+ */
+export declare const useTypedVariationDetail: <T extends unknown>(key: string, defaultValue: T) => LDEvaluationDetailTyped<T>;
+//# sourceMappingURL=useTypedVariation.d.ts.map

package/dist/src/hooks/variation/useTypedVariation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTypedVariation.d.ts","sourceRoot":"","sources":["../../../../src/hooks/variation/useTypedVariation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAI7E;;;;;;;;GAQG;AACH,eAAO,MAAM,iBAAiB,2BACvB,MAAM,uBAkBZ,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,uBAAuB,2BAC7B,MAAM,gDA2BZ,CAAC"}

package/dist/src/hooks/variation/useTypedVariation.js

@@ -0,0 +1,62 @@
+import useLDClient from '../useLDClient';
+/**
+ * Determines the strongly typed variation of a feature flag.
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The strongly typed value.
+ */
+export const useTypedVariation = (key, defaultValue) => {
+    const ldClient = useLDClient();
+    switch (typeof defaultValue) {
+        case 'boolean':
+            return ldClient.boolVariation(key, defaultValue);
+        case 'number':
+            return ldClient.numberVariation(key, defaultValue);
+        case 'string':
+            return ldClient.stringVariation(key, defaultValue);
+        case 'undefined':
+        case 'object':
+            return ldClient.jsonVariation(key, defaultValue);
+        default:
+            return ldClient.variation(key, defaultValue);
+    }
+};
+/**
+ * Determines the strongly typed variation of a feature flag for a context, along with information about
+ * how it was calculated.
+ *
+ * The `reason` property of the result will also be included in analytics events, if you are
+ * capturing detailed event data for this flag.
+ *
+ * If the flag variation does not have the specified type, defaultValue is returned. The reason will
+ * indicate an error of the type `WRONG_KIND` in this case.
+ *
+ * For more information, see the [SDK reference
+ * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *  The result (as an {@link LDEvaluationDetailTyped<T>}).
+ */
+export const useTypedVariationDetail = (key, defaultValue) => {
+    const ldClient = useLDClient();
+    switch (typeof defaultValue) {
+        case 'boolean':
+            return ldClient.boolVariationDetail(key, defaultValue);
+        case 'number':
+            return ldClient.numberVariationDetail(key, defaultValue);
+        case 'string':
+            return ldClient.stringVariationDetail(key, defaultValue);
+        case 'undefined':
+        case 'object':
+            return ldClient.jsonVariationDetail(key, defaultValue);
+        default:
+            return ldClient.variationDetail(key, defaultValue);
+    }
+};
+//# sourceMappingURL=useTypedVariation.js.map

package/dist/src/hooks/variation/useTypedVariation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useTypedVariation.js","sourceRoot":"","sources":["../../../../src/hooks/variation/useTypedVariation.ts"],"names":[],"mappings":"AAEA,OAAO,WAAW,MAAM,gBAAgB,CAAC;AAEzC;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAW,EACX,YAAe,EACZ,EAAE;IACL,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAE/B,QAAQ,OAAO,YAAY,EAAE;QAC3B,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,YAAuB,CAAM,CAAC;QACnE,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,YAAsB,CAAM,CAAC;QACpE,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,YAAsB,CAAM,CAAC;QACpE,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,aAAa,CAAC,GAAG,EAAE,YAAY,CAAM,CAAC;QACxD;YACE,OAAO,QAAQ,CAAC,SAAS,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;KAChD;AACH,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CACrC,GAAW,EACX,YAAe,EACa,EAAE;IAC9B,MAAM,QAAQ,GAAG,WAAW,EAAE,CAAC;IAE/B,QAAQ,OAAO,YAAY,EAAE;QAC3B,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC,mBAAmB,CACjC,GAAG,EACH,YAAuB,CACM,CAAC;QAClC,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,qBAAqB,CACnC,GAAG,EACH,YAAsB,CACO,CAAC;QAClC,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,qBAAqB,CACnC,GAAG,EACH,YAAsB,CACO,CAAC;QAClC,KAAK,WAAW,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC,mBAAmB,CAAC,GAAG,EAAE,YAAY,CAA+B,CAAC;QACvF;YACE,OAAO,QAAQ,CAAC,eAAe,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;KACtD;AACH,CAAC,CAAC"}

package/dist/src/hooks/variation/useVariation.d.ts

@@ -0,0 +1,131 @@
+/**
+ * Determines the boolean variation of a feature flag.
+ *
+ * If the flag variation does not have a boolean value, defaultValue is returned.
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The boolean value.
+ */
+export declare const useBoolVariation: (key: string, defaultValue: boolean) => boolean;
+/**
+ * Determines the boolean variation of a feature flag for a context, along with information about
+ * how it was calculated.
+ *
+ * The `reason` property of the result will also be included in analytics events, if you are
+ * capturing detailed event data for this flag.
+ *
+ * If the flag variation does not have a boolean value, defaultValue is returned. The reason will
+ * indicate an error of the type `WRONG_KIND` in this case.
+ *
+ * For more information, see the [SDK reference
+ * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *  The result (as an {@link LDEvaluationDetailTyped<boolean>}).
+ */
+export declare const useBoolVariationDetail: (key: string, defaultValue: boolean) => import("@launchdarkly/js-sdk-common").LDEvaluationDetailTyped<boolean>;
+/**
+ * Determines the numeric variation of a feature flag.
+ *
+ * If the flag variation does not have a numeric value, defaultValue is returned.
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The numeric value.
+ */
+export declare const useNumberVariation: (key: string, defaultValue: number) => number;
+/**
+ * Determines the numeric variation of a feature flag for a context, along with information about
+ * how it was calculated.
+ *
+ * The `reason` property of the result will also be included in analytics events, if you are
+ * capturing detailed event data for this flag.
+ *
+ * If the flag variation does not have a numeric value, defaultValue is returned. The reason will
+ * indicate an error of the type `WRONG_KIND` in this case.
+ *
+ * For more information, see the [SDK reference
+ * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The result (as an {@link LDEvaluationDetailTyped<number>}).
+ */
+export declare const useNumberVariationDetail: (key: string, defaultValue: number) => import("@launchdarkly/js-sdk-common").LDEvaluationDetailTyped<number>;
+/**
+ * Determines the string variation of a feature flag.
+ *
+ * If the flag variation does not have a string value, defaultValue is returned.
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The string value.
+ */
+export declare const useStringVariation: (key: string, defaultValue: string) => string;
+/**
+ * Determines the string variation of a feature flag for a context, along with information about
+ * how it was calculated.
+ *
+ * The `reason` property of the result will also be included in analytics events, if you are
+ * capturing detailed event data for this flag.
+ *
+ * If the flag variation does not have a string value, defaultValue is returned. The reason will
+ * indicate an error of the type `WRONG_KIND` in this case.
+ *
+ * For more information, see the [SDK reference
+ * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The result (as an {@link LDEvaluationDetailTyped<string>}).
+ */
+export declare const useStringVariationDetail: (key: string, defaultValue: string) => import("@launchdarkly/js-sdk-common").LDEvaluationDetailTyped<string>;
+/**
+ * Determines the json variation of a feature flag.
+ *
+ * This version may be favored in TypeScript versus `variation` because it returns
+ * an `unknown` type instead of `any`. `unknown` will require a cast before usage.
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   The json value.
+ */
+export declare const useJsonVariation: (key: string, defaultValue: unknown) => unknown;
+/**
+ * Determines the json variation of a feature flag for a context, along with information about how it
+ * was calculated.
+ *
+ * The `reason` property of the result will also be included in analytics events, if you are
+ * capturing detailed event data for this flag.
+ *
+ * This version may be favored in TypeScript versus `variation` because it returns
+ * an `unknown` type instead of `any`. `unknown` will require a cast before usage.
+ *
+ * For more information, see the [SDK reference
+ * guide](https://docs.launchdarkly.com/sdk/features/evaluation-reasons#react-native).
+ *
+ * @param key The unique key of the feature flag.
+ * @param defaultValue The default value of the flag, to be used if the value is not available
+ *   from LaunchDarkly.
+ * @returns
+ *   If you provided a callback, then nothing. Otherwise, a Promise which will be resolved with
+ *   the result (as an{@link LDEvaluationDetailTyped<unknown>}).
+ */
+export declare const useJsonVariationDetail: (key: string, defaultValue: unknown) => import("@launchdarkly/js-sdk-common").LDEvaluationDetailTyped<unknown>;
+//# sourceMappingURL=useVariation.d.ts.map

package/dist/src/hooks/variation/useVariation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useVariation.d.ts","sourceRoot":"","sources":["../../../../src/hooks/variation/useVariation.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;GAUG;AACH,eAAO,MAAM,gBAAgB,QAAS,MAAM,gBAAgB,OAAO,YACpB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,sBAAsB,QAAS,MAAM,gBAAgB,OAAO,2EACpB,CAAC;AAEtD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,QAAS,MAAM,gBAAgB,MAAM,WACtB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,wBAAwB,QAAS,MAAM,gBAAgB,MAAM,0EACtB,CAAC;AAErD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,kBAAkB,QAAS,MAAM,gBAAgB,MAAM,WACtB,CAAC;AAE/C;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,wBAAwB,QAAS,MAAM,gBAAgB,MAAM,0EACtB,CAAC;AAErD;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,QAAS,MAAM,gBAAgB,OAAO,YACpB,CAAC;AAEhD;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,sBAAsB,QAAS,MAAM,gBAAgB,OAAO,2EACpB,CAAC"}