v4.0.0 (#125)

Author: josmithua

.editorconfig

@@ -0,0 +1,2 @@
+// @generated by expo-module-scripts
+module.exports = require('expo-module-scripts/eslintrc.base.js');

.eslintrc.js

@@ -6,12 +6,10 @@
 .expo/
 
 # VSCode
-.vscode/
-jsconfig.json
+.history/
 
 # Xcode
 #
-build/
 *.pbxuser
 !default.pbxuser
 *.mode1v3
@@ -31,6 +29,9 @@ project.xcworkspace
 
 # Android/IJ
 #
+/example/android/**/build/
+/android/**/build/
+/build
 .idea
 .gradle
 local.properties

.gitignore

@@ -1,4 +1,4 @@
 #!/bin/sh
 . "$(dirname "$0")/_/husky.sh"
 
-yarn lint && yarn typescript
+yarn lint && yarn expo-module tsc --noEmit

.husky/pre-commit

@@ -0,0 +1,13 @@
+# Exclude all top-level hidden directories by convention
+/.*/
+
+__mocks__
+__tests__
+
+/babel.config.js
+/android/src/androidTest/
+/android/src/test/
+
+/example/
+/docs/
+/_assets/

.npmignore

@@ -0,0 +1,5 @@
+{
+    "cSpell.words": [
+        "RNMSAL"
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,3 @@
+# Override Yarn command so we can automatically setup the repo on running `yarn`
+
+yarn-path "scripts/bootstrap.js"

.yarnrc

@@ -1,5 +1,37 @@
 # CHANGELOG
 
+## 4.0.0-beta.6
+
+### Breaking changes
+
+- `acquireToken`, `acquireTokenSilent`, and `getAccount` may return `Promise<undefined>`. This matches what the underlying native libraries return.
+- The Android `msal_config.json` file that was previously required is no longer needed and is ignored. You can safely delete this file. All options are now configurable in the config object which is passed to the `PublicClientApplication` constructor
+- The `PublicClientApplication` constructor no longer takes a second `init` boolean argument, and initialization must be done manually by calling the `init` method:
+  ```diff
+  -const pca = new PublicClientApplication(config, false)
+  +const pca = new PublicClientApplication(config) // No longer initializes client. You must do this manually 👇
+  try {
+    await pca.init();
+  } catch (error) {
+    console.log("problem in configuration/setup:", error)
+  }
+  ```
+- A new maven repository is required to be added to your project `build.gradle` (if you are using Expo this is done automatically for you):
+  ```gradle
+  allProjects {
+    repositories {
+      // ...
+      maven {
+        url "https://pkgs.dev.azure.com/MicrosoftDeviceSDK/DuoSDK-Public/_packaging/Duo-SDK-Feed/maven/v1"
+      }
+    }
+  }
+  ```
+
+### Features
+
+- Now supports Expo apps through a config plugin! To configure, please follow the [Expo setup guide](/docs/expo_setup.md)
+
 ## [3.0.0](https://github.com/stashenergy/react-native-msal/compare/v2.0.3...v3.0.0)
 
 ### Breaking changes

CHANGELOG.md

@@ -6,7 +6,7 @@
 [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
 
 <p align="center">
-  <img src="_assets/ReactNativeMSALLogo.png" width="300">
+  <img src="_assets/ReactNativeMSALLogo.webp" width="300">
 </p>
 
 ## Live Demo (Web)
@@ -27,104 +27,78 @@
 
 **Requires React Native >=0.61**
 
-Stable version:  
+Stable version:
 `$ yarn add react-native-msal`
 
-Beta version:  
+Beta version:
 `$ yarn add react-native-msal@beta`
 
 Don't forget to run `npx pod-install` after!
 
 ## Setup
 
-1. Register your application in the Azure Portal
-2. Follow the [Android Setup](/docs/android_setup.md) steps
-3. Follow the [iOS Setup](/docs/ios_setup.md) steps
+### Expo
 
-## Use
+Follow the [Expo setup guide](/docs/expo_setup.md)
 
-### `PublicClientApplication` class
+### Non-expo
 
-This class is designed to be a thin wrapper around the native functionality of the Android and iOS MSAL libraries.
+Follow the [Android setup guide](/docs/android_setup.md) and the [iOS setup guide](/docs/ios_setup.md)
 
-#### Creating an instance
+## Use
 
 ```typescript
-import PublicClientApplication, { MSALConfiguration } from 'react-native-msal';
+import PublicClientApplication from 'react-native-msal';
+import type { MSALConfiguration /*, etc */ } from 'react-native-msal';
 
 const config: MSALConfiguration = {
   auth: {
     clientId: 'your-client-id',
-    // authority: 'default-authority',
+    // This authority is used as the default in `acquireToken` and `acquireTokenSilent` if not provided to those methods.
+    // Defaults to 'https://login.microsoftonline.com/common'
+    authority: 'https://<authority url>',
   },
 };
+const scopes = ['scope1', 'scope2'];
 
-// Option 1: Constructor calls an asynchronous init method for you, but you won't know when it's done and can't catch errors
+// Initialize the public client application:
 const pca = new PublicClientApplication(config);
-
-// Option 2 (RECOMMENDED): Skips init, so you can call it yourself and handle errors
-const pca = new PublicClientApplication(config, false);
 try {
   await pca.init();
 } catch (error) {
-  console.error('Problem in configuration/setup:', error);
+  console.error('Error initializing the pca, check your config.', error);
 }
-```
-
-If you don't provide an authority, the common one will be used. This authority will be used as the default for calls to `acquireToken` and `acquireTokenSilent`.
-
-#### Signing in interactively
 
-```typescript
-const params: MSALInteractiveParams = {
-  scopes: ['scope1', 'scope2'],
-};
-const result: MSALResult = await pca.acquireToken(params);
-```
+// Acquiring a token for the first time, you must call pca.acquireToken
+const params: MSALInteractiveParams = { scopes };
+const result: MSALResult | undefined = await pca.acquireToken(params);
 
-You must use this method before any calls to `acquireTokenSilent`.
-Use the `accessToken` from the MSALResult to call your API.
-Store the `account` from the result for acquiring tokens silently or for removing the account.
-
-#### Acquiring tokens silently
-
-```typescript
+// On subsequent token acquisitions, you can call `pca.acquireTokenSilent`
+// Force the token to refresh with the `forceRefresh` option
 const params: MSALSilentParams = {
-  scopes: ['scope1', 'scope2'],
-  account: result.account,
-  // forceRefresh: true,
+  account: result!.account, // or get this by filtering the result from `pca.getAccounts` (see below)
+  scopes,
+  forceRefresh: true,
 };
-const result = await pca.acquireTokenSilent(params);
-```
-
-You can force the token to refresh with the `forceRefresh` option
-
-#### Listing all accounts for which the application has refresh tokens
+const result: MSALResult | undefined = await pca.acquireTokenSilent(params);
 
-```typescript
+// Get all accounts for which this application has refresh tokens
 const accounts: MSALAccount[] = await pca.getAccounts();
-```
 
-Instead of storing the `account` from a MSALResult for an `acquireTokenSilent` method call, you can filter the MSALAccount[] result for a particular account and use it.
+// Retrieve the account matching the identifier
+const account: MSALAccount | undefined = await pca.getAccount(result!.account.identifier);
 
-#### Signing out
+// Remove all tokens from the cache for this application for the provided account
+const success: boolean = await pca.removeAccount(result!.account);
 
-```typescript
-const res: boolean = await pca.removeAccount(result.account);
-```
-
-Alternatively, you can call the `signOut` method:
-
-```typescript
+// Same as `pca.removeAccount` with the exception that, if called on iOS with the `signoutFromBrowser` option set to true, it will additionally remove the account from the system browser
 const params: MSALSignoutParams = {
-  account: result.account,
-  // signoutFromBrowser: true
+  account: result!.account,
+  signoutFromBrowser: true,
 };
-const res: boolean = await pca.signOut(params);
+const success: boolean = await pca.signOut(params);
 ```
 
-On Android, this is the same as `removeAccount`, but on iOS, if you call it with `signoutFromBrowser: true`, it will sign you out of the browser as well.
-
 ### B2C Applications
 
 The `PublicClientApplication` class is a bit too bare bones for dealing with a B2C application, and you will need to write a bit of code to get the desired behavior.
@@ -137,10 +111,10 @@ If you would like to see this class included in the library itself, please let u
 
 As mentioned above, the example app demonstrates a B2C implementation
 
-To run the example locally, first clone the repo and run `$ yarn bootstrap` to install the depedencies. Then run the following for the desired platform:
+To run the example locally, first clone the repo and run `$ yarn` to bootstrap the project. Then run the following for the desired platform:
 
-iOS: `$ yarn example ios`  
-Android: `$ yarn example android`  
+iOS: `$ yarn example ios`
+Android: `$ yarn example android`
 Web: `$ yarn example web` (the example app is also running live [here](https://stashenergy.github.io/react-native-msal/))
 
 If you want to run the example using your own Azure application information:
@@ -150,8 +124,7 @@ If you want to run the example using your own Azure application information:
    - iOS: `msauth.com.example://auth`
    - Web (SPA): `http://localhost:19006`
 1. Update the `b2cConfig` and `b2cScopes` variables in `msalConfig.ts` with your details.
-1. Update the `msal_config.json` Android asset file with your details.
 
-## Migrating from v2 to v3
+## Migrating between major versions
 
-See breaking changes in [CHANGELOG.md](CHANGELOG.md#300).
+See breaking changes in [CHANGELOG.md](CHANGELOG.md).