# Approw - Node.js/JavaScript
Approw JavaScript/Node SDK consists of two parts: `ManagementClient` and `AuthenticationClient`. `AuthenticationClient` includes methods such as registering and logging in, resetting mobile phone number email, modifying account information, etc. It sends requests based on end user and is suitable for browsers and back-end use. `ManagementClient` is suitable for use in a back-end or **trusted** front-end environment.Generally speaking, all the operations you can do in the [Approw console](https://console.approw.com/console/userpool) can be done with this SDK.
## Install
Use `npm`:
```
npm install approw-js-sdk
```
Use `yarn`:
```
yarn add approw-js-sdk
```
> If you want to use it in the React Native environment, you need to first run this command in the RN project root directory:
```
npx rn-nodeify --install "crypto,stream"
```
> After that, a `shim.js` file will be generated in the project root directory. Then import shim.js in the first line of App.js.
```
import './shim.js'
```
Use CDN:
```html
```
## Use authentication client
### Initialize
Initialization of `AuthenticationClient` needs `AppId`：
> You can check your application list in **Applications** on your console.
```js
import { AuthenticationClient } from 'approw-js-sdk';
const approw = new AuthenticationClient({
appId: 'YOUR_APP_ID',
});
```
The complete parameter list is as follows:
- `appId`: {{$localeConfig.brandName}} application ID (required);
- `appDomain`: The host address of {{$localeConfig.brandName}} application (required), such as `https://my-awesome-app.approw.com`;
- `token`: Initialize the SDK through the user's `id_token` (optional, you can cache the user `id_token` in the front-end localStorage to implement remember the login).
- `timeout`: Request timeout time, in milliseconds, the default is 10000 (10 seconds).
- `onError`: Error handling function, you can use it to globally catch all exceptions requested by the {{$localeConfig.brandName}} client.See [this document](https://docs.approw.com/reference/error-code.html) for the complete error code. The function is defined as:
```js
(code: number, message: string, data: any) => void
```
- `host`: Approw server address.If you are using the public cloud version, please ignore the parameter. If you are using a privatized deployment version, this parameter is required.The format is as follows: `https://approw-api.mydomain.com` (without / at the end).
- `preflight`: Precheck of whether the network status enabled or not, the default is false.This parameter is suitable for checking whether the Approw server domain name is blocked on the user's network (some companies' intranets will block third-party websites). If the check is successful, it won't send any notification. The error handling function will be called if the check fails. After performing the pre-check, the SDK initialization speed will slow down. Please use it with caution.
- `cdnPreflight`: Precheck of whether the network status enabled or not, the default is false. This parameter is suitable for checking whether the user's network can connect to Qiniu Cloud CDN (it is not accessible in some scenarios such as using proxy). If the check is successful, it won't send any notification. The error handling function will be called if the check fails. After performing the CDN pre-check, the SDK initialization speed will slow down. Please use it with caution.
### Instrcutions
If you use the SDK in a browser environment, after the user logs in, the SDK will write the user's `token` to `localStorage`, and subsequent requests will carry the `token` for access.
```js
const email = 'test@example.com';
const password = 'passw0rd';
const user = await approw.loginByEmail(email, password); // store the token in localStorage after successfully logging in
// this operation can be performed after logging in
await approw.updateProfile((nickname: 'Bob'));
```
### Social login
Send an authorized login request through `authenticationClient.social.authorize`. This method will directly open a new window and redirect to the login authorization page of a third-party social login service provider (such as GitHub etc.). After the user completes the authorization,this window will be automatically closed, and the `onSuccess` callback function will be triggered. Through this function, you can get user information.
Example：
```javascript
const authenticationClient = new AuthenticationClient({
appId: 'YOUR_APP_ID',
});
await authenticationClient.social.authorize('github', {
onSuccess: (user) => {
console.log(user);
},
onError: (code, message) => {},
// customize the postion where the window pops up
position: {
w: 100,
h: 100,
},
});
```
View the list of supported social logins and introducing procedures
Approw currently supports more than 20 social logins around the world, such as GitHub, Sign in with Apple, Google, etc. The following is a complete list:
!!!include(common/social-connections-table.md)!!!