@authress/login-react-native 0.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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,466 @@
+<p align="center">
+  <img src="https://authress.io/static/images/linkedin-banner.png" alt="Authress media banner">
+</p>
+
+# @authress/login-react-native
+
+<p align="center">
+    <a href="https://www.npmjs.com/package/@authress/login-react-native" alt="Authress SDK on npm"><img src="https://badge.fury.io/js/@authress%2Flogin-react-native.svg"></a>
+    <a href="./LICENSE" alt="Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg"></a>
+    <a href="https://authress.io/community" alt="authress community"><img src="https://img.shields.io/badge/Community-Authress-fbaf0b.svg"></a>
+</p>
+
+Authress authentication SDK for React Native. Implements the full OAuth 2.0 login flow with native mobile storage and deep link handling for iOS and Android.
+
+## Installation
+
+```sh
+npm install @authress/login-react-native react-native-encrypted-storage react-native-nitro-cookies react-native-quick-crypto
+```
+
+## Setup
+
+### Android
+
+**1. Configure the deep link intent filter**
+
+In `android/app/src/main/AndroidManifest.xml`, add an intent filter to your main activity so Android routes the redirect URI back to your app:
+
+```xml
+<activity
+  android:name=".MainActivity"
+  android:launchMode="singleTask"
+  ...>
+
+  <!-- existing intent filters -->
+
+  <intent-filter>
+    <action android:name="android.intent.action.VIEW" />
+    <!-- DEFAULT: required for the activity to receive implicit intents from outside the app -->
+    <category android:name="android.intent.category.DEFAULT" />
+    <!-- BROWSABLE: required so Chrome and Chrome Custom Tabs can trigger this intent -->
+    <category android:name="android.intent.category.BROWSABLE" />
+    <!-- Must match the redirectUri you pass to LoginClient -->
+    <data android:scheme="com.yourapp" android:host="auth" android:pathPrefix="/callback" />
+  </intent-filter>
+</activity>
+```
+
+**2. Forward the deep link to React Native**
+
+In `android/app/src/main/java/.../MainActivity.kt`, if you aren't already processing intents, you need to accept the callback:
+
+```kotlin
+import android.content.Intent
+import com.facebook.react.ReactActivity
+
+class MainActivity : ReactActivity() {
+  override fun onNewIntent(intent: Intent) {
+    super.onNewIntent(intent)
+    setIntent(intent)
+  }
+}
+```
+
+### iOS
+
+**1. Register the URL scheme**
+
+In `ios/YourApp/Info.plist`, add:
+
+```xml
+<key>CFBundleURLTypes</key>
+<array>
+  <dict>
+    <key>CFBundleURLSchemes</key>
+    <array>
+      <!-- Must match the scheme in the redirectUri you pass to LoginClient -->
+      <string>com.yourapp</string>
+    </array>
+  </dict>
+</array>
+```
+
+**2. Forward the deep link to React Native**
+
+In `ios/YourApp/AppDelegate.swift`:
+
+```swift
+import React
+
+@UIApplicationMain
+class AppDelegate: UIResponder, UIApplicationDelegate {
+  func application(_ app: UIApplication, open url: URL,
+                   options: [UIApplication.OpenURLOptionsKey: Any] = [:]) -> Bool {
+    return RCTLinkingManager.application(app, open: url, options: options)
+  }
+}
+```
+
+Or in `AppDelegate.mm` (Objective-C):
+
+```objc
+#import <React/RCTLinkingManager.h>
+
+- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url options:(NSDictionary<UIApplicationOpenURLOptionsKey,id> *)options {
+  return [RCTLinkingManager application:application openURL:url options:options];
+}
+```
+
+**3. Install native pods**
+
+```sh
+cd ios && pod install
+```
+
+## Setup
+
+Create a single `LoginClient` instance for your app — typically in a module you import wherever authentication is needed.
+
+```ts
+import { LoginClient } from '@authress/login-react-native';
+
+export const loginClient = new LoginClient({
+  // Your Authress custom domain — https://authress.io/app/#/setup?focus=domain
+  authressApiUrl: 'https://login.yourdomain.com',
+
+  // Your application ID — https://authress.io/app/#/manage?focus=applications
+  applicationId: 'app_your-app-id',
+
+  // The deep link URI Authress redirects back to after login.
+  // Must match a registered redirect URI for the application.
+  redirectUri: 'com.yourapp://auth/callback',
+});
+```
+
+The constructor throws synchronously if any required setting is missing or invalid. It also automatically registers a deep link listener — when the user returns from the Authress login page, the SDK completes the authentication request without any extra wiring in your app.
+
+### Optional logger
+
+Pass any `console`-compatible logger as the second argument to see debug output:
+
+```ts
+const loginClient = new LoginClient(settings, console);
+```
+
+---
+
+## Usage
+
+All methods return a [`Result`](https://github.com/supermacro/neverthrow) from the `neverthrow` library. A `Result` is either `Ok(value)` or `Err(error)` — it never throws. Use `.match()`, `.isOk()`, `.isErr()`, or `.unwrapOr()` to handle both cases.
+
+### Check if the user is logged in
+
+Call this on every route change to keep session state current. It uses a cached token when available; otherwise it calls the Authress server.
+
+```ts
+const isLoggedIn = await loginClient.userIsLoggedIn();
+if (isLoggedIn) {
+  // session is valid — proceed to the app
+} else {
+  // no active session — show the login screen
+}
+```
+
+### Log in — full authentication flow
+
+Start the login request, open the browser, and the SDK takes care of the rest — it listens for the deep link redirect and completes the authentication automatically.
+
+```ts
+import { Linking } from 'react-native';
+
+const result = await loginClient.authenticate({
+  // Optional: specify a connection directly, or let the user pick on the Authress-hosted login page
+  connectionId: 'google',
+});
+
+if (result.isOk()) {
+  // Open the Authress-hosted login page in the device browser
+  await Linking.openURL(result.value.authenticationUrl);
+} else {
+  console.error('Failed to start login', result.error);
+}
+```
+
+When the user returns via the deep link, the SDK automatically calls `completeAuthenticationRequest` and resolves any pending `waitForToken` calls.
+
+### Get a token for API calls
+
+Use `waitForToken` when you need a bearer token and are willing to wait for a session to become active (e.g. on app startup while restoring a previous session).
+
+```ts
+const result = await loginClient.waitForToken({ timeoutInMillis: 5000 });
+
+if (result.isOk()) {
+  // Token is available — retrieve it with getToken()
+  const tokenResult = await loginClient.getToken();
+  if (tokenResult.isOk()) {
+    const token = tokenResult.value;
+    // Use as: Authorization: Bearer <token>
+  }
+} else {
+  // result.error.code === 'TokenTimeoutError'
+  // No token arrived within the timeout — redirect to login
+}
+```
+
+Use `getToken()` directly when you need the token string immediately with no waiting:
+
+```ts
+const tokenResult = await loginClient.getToken();
+if (tokenResult.isOk()) {
+  const token = tokenResult.value;
+}
+// Returns Err(NotLoggedInError) immediately if there is no active session
+```
+
+### Get user identity
+
+Returns decoded claims from the session token — useful for personalising the UI.
+
+```ts
+const result = await loginClient.getUserIdentity();
+
+if (result.isOk()) {
+  console.log(result.value.userId); // e.g. 'user|00001'
+  // result.value also contains all other JWT claims
+} else {
+  // result.error.code === 'NotLoggedInError'
+}
+```
+
+### Get full user profile
+
+Fetches the user's profile from Authress, including all linked identities. Requires an active session.
+
+```ts
+const result = await loginClient.getUserProfile();
+
+if (result.isOk()) {
+  for (const { connection } of result.value.linkedIdentities) {
+    console.log(connection.connectionId, connection.userId);
+  }
+} else if (result.error.code === 'NotLoggedInError') {
+  // user is not logged in
+} else {
+  // HTTP error
+}
+```
+
+### Log out
+
+Clears the local session and invalidates the server-side session.
+
+```ts
+await loginClient.logout();
+// Result is always Ok — errors during server-side logout are swallowed
+```
+
+After logout, `getToken()` returns `Err`, `waitForToken()` blocks again, and `userIsLoggedIn()` returns `false`.
+
+### Link an additional identity
+
+Links a new identity provider to the currently logged-in user. Follows the same flow as `authenticate` — open `authenticationUrl` in the browser and the SDK handles the redirect automatically. Either `connectionId` or `tenantLookupIdentifier` is required.
+
+```ts
+const result = await loginClient.linkIdentity({ connectionId: 'github' });
+
+if (result.isOk()) {
+  await Linking.openURL(result.value.authenticationUrl);
+} else if (result.error.code === 'NotLoggedInError') {
+  // user must be logged in to link an identity
+} else {
+  console.error('Link identity failed', result.error);
+}
+```
+
+### MFA devices
+
+```ts
+// List registered MFA devices
+const devicesResult = await loginClient.getDevices();
+const devices = devicesResult.unwrapOr([]);
+
+// Remove a device
+const deleteResult = await loginClient.deleteDevice(deviceId);
+if (deleteResult.isErr()) {
+  console.error('Failed to remove device', deleteResult.error);
+}
+```
+
+---
+
+## Error handling
+
+All errors are typed and carry a discriminating property. No method throws — use `.isErr()` to check for failure, then inspect the error.
+
+### Application errors
+
+Returned as `Err` values when a precondition is not met. Match on `error.code`:
+
+| Class | `error.code` | When |
+|---|---|---|
+| `NotLoggedInError` | `'NotLoggedInError'` | Operation requires a logged-in session |
+| `NoAuthenticationRequestInProgressError` | `'NoAuthenticationRequestInProgressError'` | `completeAuthenticationRequest` called with no pending login |
+| `AuthenticationRequestMismatchError` | `'AuthenticationRequestMismatchError'` | `authenticationRequestId` in the redirect does not match the pending request |
+| `TokenTimeoutError` | `'TokenTimeoutError'` | `waitForToken` timeout elapsed before a session arrived |
+| `InvalidConnectionError` | `'InvalidConnectionError'` | `linkIdentity` called without `connectionId` or `tenantLookupIdentifier` |
+| `SecurityContextError` | `'SecurityContextError'` | Encrypted storage is unavailable (device security context error) |
+
+### HTTP errors
+
+Returned when a network request to the Authress service fails. All three types are part of the `AuthressHttpError` union. Match on `error.name`:
+
+| `error.name` | When |
+|---|---|
+| `'AuthressHttpNetworkError'` | Request never reached the server (network offline, DNS failure). Retried up to 5 times before returning this error. |
+| `'AuthressHttpClientError'` | Authress returned a 4xx response |
+| `'AuthressHttpServiceError'` | Authress returned a 5xx response |
+
+Each HTTP error includes `url`, `method`, and `data`. Client and service errors also include `status` and `headers`.
+
+### Example: handling all error cases
+
+```ts
+import type { AuthressHttpError } from '@authress/login-react-native';
+
+const result = await loginClient.authenticate({ connectionId: 'google' });
+
+if (result.isErr()) {
+  const error = result.error;
+
+  // Application errors — check error.code
+  if (error.code === 'SecurityContextError') {
+    // encrypted storage unavailable — device security context error
+  }
+
+  // HTTP errors — check error.name
+  else if (error.name === 'AuthressHttpNetworkError') {
+    // device is offline
+  } else if (error.name === 'AuthressHttpClientError') {
+    console.error(`Bad request: ${error.status}`, error.data);
+  } else if (error.name === 'AuthressHttpServiceError') {
+    console.error(`Authress service error: ${error.status}`);
+  }
+}
+```
+
+---
+
+## API reference
+
+### `new LoginClient(settings, logger?)`
+
+| Parameter | Type | Required | Description |
+|---|---|---|---|
+| `authressApiUrl` | `string` | Yes | Your Authress custom domain |
+| `applicationId` | `string` | Yes | Your Authress application ID |
+| `redirectUri` | `string` | Yes | Deep link URI registered for the application |
+| `logger` | `Logger` | No | Optional logger (`console` works) |
+
+Throws synchronously on invalid settings.
+
+---
+
+### `userIsLoggedIn()`
+
+`Promise<boolean>`
+
+Checks if a valid session exists. Uses the cached token when available; otherwise calls the Authress API. Returns `Ok(true)` if the session is active, `Ok(false)` if not logged in or if the server call fails.
+
+Call on every route change.
+
+---
+
+### `authenticate(options?)`
+
+`Promise<Result<AuthenticateResponse, AuthressHttpError | SecurityContextError>>`
+
+Starts the login flow. Returns `authenticationUrl` to open in the device browser. The SDK automatically handles the deep link redirect to complete the flow.
+
+| Option | Type | Description |
+|---|---|---|
+| `connectionId` | `string` | Log in directly with a specific provider connection |
+| `tenantLookupIdentifier` | `string` | Resolve the connection from a tenant identifier |
+| `inviteId` | `string` | Accept an invitation |
+| `redirectUrl` | `string` | Override the redirect URI from settings |
+| `scopes` | `string[]` | Additional scopes to request |
+| `audiences` | `string[]` | Additional audiences for the token |
+| `connectionProperties` | `Record<string, string>` | Provider-specific properties |
+| `multiAccount` | `boolean` | Enable multi-account login (default: `false`) |
+
+---
+
+### `completeAuthenticationRequest(params)`
+
+`Promise<Result<void, AuthFlowError | AuthressHttpError>>`
+
+Completes the login flow after the deep link redirect. Called automatically by the SDK when the deep link is received — you only need to call this directly if you are managing the deep link yourself.
+
+---
+
+### `getToken()`
+
+`Promise<Result<string, NotLoggedInError>>`
+
+Returns the current bearer token, or `Err(NotLoggedInError)` if there is no active session. Does not wait or make network calls.
+
+---
+
+### `waitForToken(options?)`
+
+`Promise<Result<void, TokenTimeoutError>>`
+
+Blocks until a session token is available or the timeout elapses. Use `getToken()` after this resolves to retrieve the token string.
+
+| Option | Type | Default | Description |
+|---|---|---|---|
+| `timeoutInMillis` | `number` | `5000` | Timeout in ms. `0` = fail immediately. `-1` = wait indefinitely. |
+
+---
+
+### `logout()`
+
+`Promise<Result<void, never>>`
+
+Clears the local session and calls the Authress logout endpoint. Always resolves `Ok` — server-side errors are swallowed.
+
+---
+
+### `getUserIdentity()`
+
+`Promise<Result<UserIdentity, NotLoggedInError>>`
+
+Returns decoded claims from the session token. `identity.userId` is the user's unique identifier. The identity object also contains all other JWT claims.
+
+---
+
+### `getUserProfile()`
+
+`Promise<Result<UserProfile, AuthressHttpError | NotLoggedInError>>`
+
+Fetches the user's full profile from Authress, including all linked identities (`profile.linkedIdentities`).
+
+---
+
+### `linkIdentity(options)`
+
+`Promise<Result<AuthenticateResponse, AuthressHttpError | SecurityContextError | NotLoggedInError | InvalidConnectionError>>`
+
+Links a new identity provider to the current user. Returns `authenticationUrl` to open in the device browser. Either `connectionId` or `tenantLookupIdentifier` is required.
+
+---
+
+### `getDevices()`
+
+`Promise<Result<Device[], AuthressHttpError | NotLoggedInError>>`
+
+Returns the list of MFA devices registered for the current user. Returns `Ok([])` if not logged in or no devices are registered.
+
+---
+
+### `deleteDevice(deviceId)`
+
+`Promise<Result<void, AuthressHttpError | NotLoggedInError>>`
+
+Removes the MFA device with the given `deviceId`.