Skip to content

Commit eda0559

Browse files
vonovakvonovak
authored
docs: migration table (#58)
1 parent 1b1f232 commit eda0559

File tree

3 files changed

+37
-6
lines changed

3 files changed

+37
-6
lines changed

‎docs/install.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Available on the public npm registry, this version:
4141
- Uses functional, but deprecated [legacy Android Google Sign-In](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating).
4242
- Contains none of the extra features listed above.
4343

44+
> If you want to migrate from the public version to the Universal version, follow the [migration guide](migrating#migrating-from-original-to-universal-sign-in).
45+
4446
## Obtaining Universal Sign In {#obtaining-access}
4547

4648
Universal sign in requires [purchasing a license](https://universal-sign-in.com/#pricing), after which you will be able to configure your (or your colleagues') access to the private npm package and to the private repo with the sources and examples. Alternatively, as an Expo customer, obtain access through this [form](https://forms.gle/tpP7TfUGW1CwgaEZ8).
@@ -106,7 +108,7 @@ If you use another package manager ([such as Bun](https://bun.sh/docs/install/re
106108

107109
</Tabs>
108110

109-
If you're using the Universal version, open the lockfile (`yarn.lock` / `package-lock.json`...) and verify that the package is fetched from the GitHub registry (the entry must point to `npm.pkg.github.com`, not `registry.npmjs.org`). If it does not, it means that your package manager is not configured correctly - try uninstalling and reinstalling the package.
111+
After installing: if you're using the Universal version, open the lockfile (`yarn.lock` / `package-lock.json`...) and verify that the package is fetched from the GitHub registry (the entry must point to `npm.pkg.github.com`, not `registry.npmjs.org`). If it does not, it means that your package manager is not configured correctly - try uninstalling and reinstalling the package.
110112

111113
There are several guides to follow now:
112114

‎docs/migrating.md

+28-5
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,36 @@
11
---
2-
sidebar_position: 90
3-
sidebar_label: Migrating
2+
sidebar_position: 43
43
---
54

6-
# Migrating to new JS API
5+
# Migration guides
6+
7+
There are 2 migrations described here: from Original to Universal Sign In and from the old JS API to the new JS API.
8+
9+
## Migrating from Original to Universal Sign In
10+
11+
Migrating from Original to Universal module is mostly about changing the method names: the table summarizes the mapping from Original module's calls to the Universal (OneTap) module's calls:
12+
13+
| Original Method | Universal (OneTap) Method | Notes |
14+
| ------------------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
15+
| `configure` | `configure` | Same functionality. |
16+
| `signInSilently` | `signIn` | Universal's `signIn` attempts sign in without user interaction. |
17+
| `signIn` | `createAccount` | Universal's `createAccount` is for first-time sign in (but can be used for existing users too). |
18+
| `addScopes` | `requestAuthorization` | Similar functionality, different parameters. On Android, you can call `requestAuthorization` without being signed in! |
19+
| `hasPlayServices` | `checkPlayServices` | Same functionality, different name. |
20+
| `getCurrentUser` | Use `signIn` response | Manage the current user state yourself, or through libraries like [Firebase Auth](https://rnfirebase.io/auth/usage#listening-to-authentication-state) or [Supabase Auth](https://supabase.com/docs/reference/javascript/auth-onauthstatechange). |
21+
| `getTokens` | Use `signIn` or `requestAuthorization` | Tokens are included in the response object. |
22+
| `signOut` | `signOut` | Universal requires email/id parameter on web. |
23+
| `revokeAccess` | Not yet provided by Google. | See [here](https://stackoverflow.com/a/78877334/2070942). |
24+
| `hasPreviousSignIn` | Use `signIn` response | Check for `noSavedCredentialFound` response type. |
25+
| `clearCachedAccessToken` | Not provided, presumably not needed. | - |
26+
27+
---
28+
29+
## Migrating to new JS API
730

831
Version 13 introduced a new JS API, which changes some method response signatures and makes minor changes to error handling (details [here](https://github.com/react-native-google-signin/google-signin/pull/1326)). If you're upgrading from version 12 or earlier, you'll need to make some minor adjustments.
932

10-
## Universal Sign In
33+
### Universal Sign In
1134

1235
1. Add the [`configure`](one-tap#configure) method to your code. This method is required to be called to configure the module.
1336

@@ -66,7 +89,7 @@ await GoogleOneTapSignIn.requestAuthorization({
6689
});
6790
```
6891

69-
## Original Sign In
92+
### Original Sign In
7093

7194
1. Follow step 2. from above for `signIn`, `addScopes` and `signInSilently` methods.
7295
2. remove `SIGN_IN_REQUIRED` mentions. This case is now handled with [`NoSavedCredentialFound`](api#nosavedcredentialfound) object:

‎docs/original.mdx

+6
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,12 @@ sidebar_position: 40
44

55
# Original Google sign in
66

7+
:::tip
8+
9+
To migrate to Universal sign in, follow [this guide](migrating#migrating-from-original-to-universal-sign-in).
10+
11+
:::
12+
713
This module exposes
814

915
- [Legacy Google Sign-In for Android](https://web.archive.org/web/20240308064911/https://developers.google.com/identity/sign-in/android/start-integrating). The underlying SDK is deprecated but functional.

0 commit comments

Comments
 (0)