https://github.com/gobeyondidentity/bi-sdk-react-native
React Native SDK for Beyond Identity Passkeys
https://github.com/gobeyondidentity/bi-sdk-react-native
android authentication ios passkeys react-native
Last synced: 6 days ago
JSON representation
React Native SDK for Beyond Identity Passkeys
- Host: GitHub
- URL: https://github.com/gobeyondidentity/bi-sdk-react-native
- Owner: gobeyondidentity
- License: apache-2.0
- Created: 2021-12-06T15:40:51.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-28T20:51:24.000Z (over 2 years ago)
- Last Synced: 2024-08-11T05:04:08.487Z (over 1 year ago)
- Topics: android, authentication, ios, passkeys, react-native
- Language: C++
- Homepage: https://developers.beyondidentity.com
- Size: 2.46 MB
- Stars: 11
- Watchers: 4
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
Beyond Identity
Universal Passkeys for Developers
All devices. Any protocol. Zero shared secrets.
# Beyond Identity React Native SDK
[](https://opensource.org/licenses/Apache-2.0)
### Embedded SDK
Goodbye, passwords! The Beyond Identity SDK for React Native is a wrapper around our native SDKs ([Android](https://github.com/gobeyondidentity/bi-sdk-android) and [iOS](https://github.com/gobeyondidentity/bi-sdk-swift)), which allows you to embed the Passwordless experience into your product. A set of functions are provided to you through the Embedded namespace. This SDK supports OIDC and OAuth 2.0.
## Installation
### Using [react-native init](https://reactnative.dev/docs/environment-setup).
1. Install the SDK:
```
yarn add @beyondidentity/bi-sdk-react-native
```
or
```
npm install @beyondidentity/bi-sdk-react-native
```
2. Update Native Requirements in your ios/android folders:
Please make sure your iOS project supports "minimum deployment target" 13.0 or later.
In your `ios/Podfile` set:
```sh
platform :ios, '13.0'
```
Go to your ios folder and run:
```sh
pod install
```
Make sure your `android/build.gradle` supports minSdkVersion 26 or later
```
buildscript {
ext {
minSdkVersion = 26
}
}
```
Add the following maven url to your repositories in your `android/build.gradle`
```
allprojects {
repositories {
maven {
url "https://packages.beyondidentity.com/public/bi-sdk-android/maven/"
}
}
}
```
### Using `expo`
> :warning: This package [requires custom native code](https://docs.expo.io/workflow/customizing/) and can be used with [Development builds](https://docs.expo.dev/develop/development-builds/introduction/) or [prebuild](https://docs.expo.dev/workflow/prebuild/) and cannot be used with Expo Go.
1. Install the SDK:
```
npx expo install @beyondidentity/bi-sdk-react-native
```
2. Add the SDK [config plugin](https://docs.expo.dev/guides/config-plugins/) to the [plugins array](https://docs.expo.dev/versions/latest/config/app/#plugins) of your app.{json,config.js,config.ts}:
```
{
"expo": {
"plugins": [
["@beyondidentity/bi-sdk-react-native"],
]
}
}
```
3. Set native requirments with [expo-build-properties](https://docs.expo.dev/versions/latest/sdk/build-properties/). Add [expo-build-properties](https://docs.expo.dev/versions/latest/sdk/build-properties/) to your app.{json,config.js,config.ts}:
```
npx expo install expo-build-properties
```
```
{
"expo": {
"plugins": [
["@beyondidentity/bi-sdk-react-native"],
[
"expo-build-properties",
{
"android": {
"minSdkVersion": 26
},
"ios": {
"deploymentTarget": "13.0"
}
}
]
]
}
}
```
4. Next, rebuild your app as described in the ["Adding custom native code"](https://docs.expo.dev/workflow/customizing/#generate-native-projects-with-prebuild) guide.
## Usage
Check out the [Developer Documentation](https://developer.beyondidentity.com) and the [SDK API Documentation](https://gobeyondidentity.github.io/bi-sdk-react-native/) for more information.
### Setup
First, before calling the Embedded functions, make sure to initialize the SDK. This can be done where you register your root component.
```javascript
import { Embedded } from '@beyondidentity/bi-sdk-react-native';
Embedded.initialize(
biometricAskPrompt: string,
allowedDomains?: string[]
): Promise;
```
You may also add a listener to log native events with `Embedded.logEventEmitter` after initializing.
```javascript
Embedded.logEventEmitter.addListener(
'BeyondIdentityLogger',
(message: string) => {
console.log(message);
}
);
```
## Example App
Clone the following repo and use the available comands to see the SDK in action!
To set up (run this first):
```sh
yarn bootstrap
```
To run the example app on Android:
```sh
yarn example android
```
To run the example app on iOS:
```sh
yarn example ios
```
To start the packager:
```sh
yarn example start
```