Skip to content

Commit

Permalink
feat: overwrite skipNativeAuth configuration option (capawesome-tea…
Browse files Browse the repository at this point in the history 
…m#194)
  • Loading branch information
@robingenz @Paso
robingenz authored and Paso committed Apr 19, 2023
1 parent 942bd92 commit e2aeb9e
Show file tree
Hide file tree
Showing 6 changed files with 156 additions and 78 deletions.
5 changes: 5 additions & 0 deletions .changeset/selfish-windows-leave.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@capacitor-firebase/authentication": minor
---

feat: overwrite `skipNativeAuth` configuration option
115 changes: 62 additions & 53 deletions packages/authentication/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,23 @@ export default config;

</docgen-config>

## FAQ

1. **What does this plugin do?**
This plugin enables the use of [Firebase Authentication](https://firebase.google.com/docs/auth) in a Capacitor app.
It uses the Firebase SDK for [Java](https://firebase.google.com/docs/reference/android) (Android), [Swift](https://firebase.google.com/docs/reference/swift) (iOS) and [JavaScript](https://firebase.google.com/docs/reference/js).
1. **What is the difference between the web implementation of this plugin and the Firebase JS SDK?**
The web implementation of this plugin encapsulates the Firebase JS SDK and enables a consistent interface across all platforms.
You can decide if you prefer to use the web implementation or the Firebase JS SDK.
1. **What is the difference between the native and web authentication?**
For web authentication, the Firebase JS SDK is used. This only works to a limited extent on Android and iOS in the WebViews (see [here](https://developers.googleblog.com/2016/08/modernizing-oauth-interactions-in-native-apps.html)).
For native authentication, the native SDKs from Firebase, Google, etc. are used.
These offer all the functionalities that the Firebase JS SDK also offers on the web.
However, after a login with the native SDK, the user is only logged in on the native layer of the app.
If the user should also be logged in on the web layer, additional steps are required (see [here](/packages/authentication/docs/firebase-js-sdk.md)).
1. **How can I use this plugin with the Firebase JavaScript SDK?**
See [here](/packages/authentication/docs/firebase-js-sdk.md).

## Demo

A working example can be found here: [robingenz/capacitor-firebase-authentication-demo](https://github.com/robingenz/capacitor-firebase-authentication-demo)
Expand Down Expand Up @@ -575,14 +592,14 @@ Sets the tenant id.
### signInWithApple(...)

```typescript
signInWithApple(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithApple(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Apple sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand Down Expand Up @@ -654,14 +671,14 @@ Signs in using an email and sign-in email link.
### signInWithFacebook(...)

```typescript
signInWithFacebook(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithFacebook(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Facebook sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand All @@ -673,14 +690,14 @@ Starts the Facebook sign-in flow.
### signInWithGithub(...)

```typescript
signInWithGithub(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithGithub(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the GitHub sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand All @@ -692,14 +709,14 @@ Starts the GitHub sign-in flow.
### signInWithGoogle(...)

```typescript
signInWithGoogle(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithGoogle(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Google sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand All @@ -711,14 +728,14 @@ Starts the Google sign-in flow.
### signInWithMicrosoft(...)

```typescript
signInWithMicrosoft(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithMicrosoft(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Microsoft sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand Down Expand Up @@ -753,14 +770,14 @@ Only available for Android and iOS.
### signInWithPlayGames(...)

```typescript
signInWithPlayGames(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithPlayGames(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Play Games sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand All @@ -772,14 +789,14 @@ Starts the Play Games sign-in flow.
### signInWithTwitter(...)

```typescript
signInWithTwitter(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithTwitter(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Twitter sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand All @@ -791,14 +808,14 @@ Starts the Twitter sign-in flow.
### signInWithYahoo(...)

```typescript
signInWithYahoo(options?: SignInOptions | undefined) => Promise<SignInResult>
signInWithYahoo(options?: SignInOptions | SignInWithOAuthOptions | undefined) => Promise<SignInResult>
```

Starts the Yahoo sign-in flow.

| Param | Type |
| ------------- | ------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a></code> |
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------------------------- |
| **`options`** | <code><a href="#signinoptions">SignInOptions</a> \| <a href="#signinwithoauthoptions">SignInWithOAuthOptions</a></code> |

**Returns:** <code>Promise&lt;<a href="#signinresult">SignInResult</a>&gt;</code>

Expand Down Expand Up @@ -1075,10 +1092,11 @@ bundle identifiers.

#### SignInOptions

| Prop | Type | Description | Since |
| ---------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------- | ----- |
| **`customParameters`** | <code>SignInCustomParameter[]</code> | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. | 0.1.0 |
| **`scopes`** | <code>string[]</code> | Scopes to request from provider. | 0.3.1 |
| Prop | Type | Description | Since |
| ---------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----- |
| **`customParameters`** | <code>SignInCustomParameter[]</code> | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. | 0.1.0 |
| **`scopes`** | <code>string[]</code> | Scopes to request from provider. | 0.3.1 |
| **`skipNativeAuth`** | <code>boolean</code> | Whether the plugin should skip the native authentication or not. Only needed if you want to use the Firebase JavaScript SDK. This value overwrites the configrations value of the `skipNativeAuth` option. If no value is set, the configuration value is used. **Note that the plugin may behave differently across the platforms.** `skipNativeAuth` cannot be used in combination with `signInWithCustomToken`, `createUserWithEmailAndPassword` or `signInWithEmailAndPassword`. Only available for Android and iOS. | 1.1.0 |


#### SignInCustomParameter
Expand All @@ -1089,6 +1107,14 @@ bundle identifiers.
| **`value`** | <code>string</code> | The custom parameter value (e.g. `user@firstadd.onmicrosoft.com`). | 0.1.0 |


#### SignInWithOAuthOptions

| Prop | Type | Description | Since |
| ---------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------- | ----- |
| **`customParameters`** | <code>SignInCustomParameter[]</code> | Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. | 1.1.0 |
| **`scopes`** | <code>string[]</code> | Scopes to request from provider. | 1.1.0 |


#### SignInWithCustomTokenOptions

| Prop | Type | Description | Since |
Expand Down Expand Up @@ -1175,23 +1201,6 @@ Callback to receive the user's sign-in state change notifications.

</docgen-api>

## FAQ

1. **What does this plugin do?**
This plugin enables the use of [Firebase Authentication](https://firebase.google.com/docs/auth) in a Capacitor app.
It uses the Firebase SDK for [Java](https://firebase.google.com/docs/reference/android) (Android), [Swift](https://firebase.google.com/docs/reference/swift) (iOS) and [JavaScript](https://firebase.google.com/docs/reference/js).
1. **What is the difference between the web implementation of this plugin and the Firebase JS SDK?**
The web implementation of this plugin encapsulates the Firebase JS SDK and enables a consistent interface across all platforms.
You can decide if you prefer to use the web implementation or the Firebase JS SDK.
1. **What is the difference between the native and web authentication?**
For web authentication, the Firebase JS SDK is used. This only works to a limited extent on Android and iOS in the WebViews (see [here](https://developers.googleblog.com/2016/08/modernizing-oauth-interactions-in-native-apps.html)).
For native authentication, the native SDKs from Firebase, Google, etc. are used.
These offer all the functionalities that the Firebase JS SDK also offers on the web.
However, after a login with the native SDK, the user is only logged in on the native layer of the app.
If the user should also be logged in on the web layer, additional steps are required (see [here](/packages/authentication/docs/firebase-js-sdk.md)).
1. **How can I use this plugin with the Firebase JavaScript SDK?**
See [here](/packages/authentication/docs/firebase-js-sdk.md).

## Changelog

See [CHANGELOG.md](/packages/authentication/CHANGELOG.md).
Expand Down
8 changes: 4 additions & 4 deletions ...ava/io/capawesome/capacitorjs/plugins/firebase/authentication/FirebaseAuthentication.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public void applyActionCode(@NonNull String oobCode, @NonNull Runnable callback)
}

public void createUserWithEmailAndPassword(PluginCall call) {
boolean skipNativeAuth = this.config.getSkipNativeAuth();
boolean skipNativeAuth = call.getBoolean("skipNativeAuth", this.config.getSkipNativeAuth());
if (skipNativeAuth) {
call.reject(FirebaseAuthenticationPlugin.ERROR_EMAIL_SIGN_IN_SKIP_NATIVE_AUTH);
return;
Expand Down Expand Up @@ -232,7 +232,7 @@ public void signInWithYahoo(final PluginCall call) {
}

public void signInWithCustomToken(final PluginCall call) {
boolean skipNativeAuth = this.config.getSkipNativeAuth();
boolean skipNativeAuth = call.getBoolean("skipNativeAuth", this.config.getSkipNativeAuth());
if (skipNativeAuth) {
call.reject(FirebaseAuthenticationPlugin.ERROR_CUSTOM_TOKEN_SKIP_NATIVE_AUTH);
return;
Expand All @@ -259,7 +259,7 @@ public void signInWithCustomToken(final PluginCall call) {
}

public void signInWithEmailAndPassword(final PluginCall call) {
boolean skipNativeAuth = this.config.getSkipNativeAuth();
boolean skipNativeAuth = call.getBoolean("skipNativeAuth", this.config.getSkipNativeAuth());
if (skipNativeAuth) {
call.reject(FirebaseAuthenticationPlugin.ERROR_EMAIL_SIGN_IN_SKIP_NATIVE_AUTH);
return;
Expand Down Expand Up @@ -383,7 +383,7 @@ public void handleSuccessfulSignIn(
@Nullable String accessToken,
@Nullable AdditionalUserInfo additionalUserInfo
) {
boolean skipNativeAuth = this.config.getSkipNativeAuth();
boolean skipNativeAuth = call.getBoolean("skipNativeAuth", this.config.getSkipNativeAuth());
if (skipNativeAuth) {
JSObject signInResult = FirebaseAuthenticationHelper.createSignInResult(
null,
Expand Down
Loading

0 comments on commit e2aeb9e

Please sign in to comment.