# pi-access-sdk

> This is a SDK for the PI Access API.

Latest version **0.6.8** (published 2024-12-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install pi-access-sdk
pnpm add pi-access-sdk
yarn add pi-access-sdk
bun add pi-access-sdk
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.8 |
| Published | 2024-12-17 |
| First published | 2023-09-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 19.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Mehedi Hasan |
| Maintainers | coder-mehedi, mahmuds |

## Links

- npm: https://www.npmjs.com/package/pi-access-sdk
- npm.io page: https://npm.io/package/pi-access-sdk

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^1.5.0
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2

## Recent versions

- 0.6.8 (latest) — 2024-12-17
- 0.6.7 — 2024-12-17
- 0.6.6 — 2024-08-29
- 0.6.5 — 2024-08-28
- 0.6.4 — 2024-08-23
- 0.6.3 — 2024-08-23
- 0.6.2 — 2024-08-23
- 0.6.1 — 2024-08-23
- 0.6.0 — 2024-08-22
- 0.5.8 — 2024-08-20
- 0.5.7 — 2024-08-20
- 0.5.6 — 2024-08-20
- 0.5.5 — 2024-08-15
- 0.5.4 — 2024-08-15
- 0.5.3 — 2024-03-20
- … 48 more at https://npm.io/package/pi-access-sdk/versions

## README

### Import type and Access class

```
import {
  Access,
  AccessBase,
  LoginInput,
  LogoutInput,
  RefreshTokenInput,
  RegisterInput,
} from 'pi-access-sdk';
```

### Store the common input in a variable

```
const commonInput = {
  organization_id: '03e9eacf-0a50-4eef-855e-ab91f97f05d5',
  application_id: 'c80178cb-7b1e-4013-9fea-b4abf4c4cb02',
  client_id: '1ce52ca341',
  client_secret: 'cc0eb7dbb2c663850555',
};
```

### Create a new client instance of AccessBase or AccessAdvanced

```
const basic = new AccessBase({
  application_id: "f8f5fc52-e6cf-42a9-b0a8-89f5c4e1a6e1",
  organization_id: "e7c80e31-9ce2-47b7-b4de-bc6c95755ff0",
  url: "http://wellteam.me",
});

const advaced = new AccessAdvanced({
  application_id: "f8f5fc52-e6cf-42a9-b0a8-89f5c4e1a6e1",
  organization_id: "e7c80e31-9ce2-47b7-b4de-bc6c95755ff0",
  client_id: "def25c0319",
  client_secret: "de04a1d0279491f26d89",
  url: "http://wellteam.me",
});


```

#### Now you can use the client to call the api methods like below

```
const loginInput: LoginInput = {
  type: 'login-username',
  response_type: 'token',
  username: 'mehedi',
  password: 'mehedi',
  email: 'mehedi@yopmail.com',
  phone: '1479503550',
  region: 'US',
  // redirect_uri: '',
  country_code: '',
  session_option: 'clear-all',
};

const loginRes = await client.login(loginInput);
console.log(loginRes.data.data.data.user_id);
```

you can use sign_in_resp_fields && field_name_mappings to get the user_id from the response

sign_in_resp_fields -> ["user_id"] &&
field_name_mappings -> {"user_id": "id"}

```
const logoutInput: LogoutInput = {
  refresh_token: '',
};

const logoutRes = await client.logout(logoutInput);
console.log(logoutRes);
```

```
const refreshTokenInput: RefreshTokenInput = {
  refresh_token: '',
  grant_type: 'refresh_token',
};

const refreshTokenRes = await client.refreshToken(refreshTokenInput);
console.log(refreshTokenRes);
```

```
const registerInput: RegisterInput = {
  metadata: {
    name: 'onimesh mitra2',
    profile_picture: 'somecdnlink',
    has_business: false,
  },
  sdk_type: '',
  username: 'mehedi',
  password: 'mehedi',
  name: 'Mehedi Hasan',
  first_name: 'Mehedi',
  last_name: 'Hasan',
  email: 'mehedi@yopmail.com',
  phone: '1479503550',
  affiliation: '',
  id_card: '',
  region: '',
  provider: '',
  code: '',
  state: '',
  redirect_uri: 'https://example.com/callback',
  method: 'POST',
  email_code: '',
  phone_code: '',
  country_code: 'BD',
  auto_sign_in: true,
  relay_state: '',
  captcha_type: '',
  captcha_token: '',
  mfa_type: '',
  passcode: '',
  recovery_code: '',
};

const registerRes = await client.register(registerInput);
console.log(registerRes);
```

```
const getUserRes = await client.getUser({
  user_id: 'cf188dae-bcf5-4069-9b4a-f4800561db31',
  sdk_type: 'frontend',
});
console.log(getUserRes);
```

```
const changePasswordRes = await client.changePassword({
  sdk_type: 'frontend',
  user_id: 'cf188dae-bcf5-4069-9b4a-f4800561db31',
  current_password: 'mehedi',
  new_password: 'mehedi',
});
console.log(changePasswordRes);
```

```
const forgetPasswordOTPSendRes = await client.forgetPasswordOTPSend({
  sdk_type: 'frontend',
  receiver_type: 'forget-phone',
  receiver: '1479503550',
  channel_type: 'email' | 'phone' //optional
});
console.log(forgetPasswordOTPSendRes);

```

```
const forgetPasswordOTPVerifyRes = await client.forgetPasswordOTPVerify({
  sdk_type: 'frontend',
  receiver_type: 'forget-phone',
  receiver: '1479503550',
  code: '597985',
  channel_type: 'email' | 'phone' //optional
});
console.log(forgetPasswordOTPVerifyRes);
```

```
const forgetPasswordRes = await client.forgetPassword({
  sdk_type: 'frontend',
  reference: 'n7gaHtXVmc0X',
  password_confirm: 'mehedi',
  password: 'mehedi',
});
console.log({ forgetPasswordRes });
```

```
const getOrganizationRes = await client.getOrganization(commonInput);
console.log(getOrganizationRes);
```

```
const getApplicationRes = await client.getApplication({
  with_organization: true,
});
console.log(getApplicationRes);

```

---
_Source: https://npm.io/package/pi-access-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._