# real-sdk

> TypeScript/JavaScript SDK for interaction with REAL Auth.

Latest version **0.28.7** (published 2023-09-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install real-sdk
pnpm add real-sdk
yarn add real-sdk
bun add real-sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.28.7 |
| Published | 2023-09-09 |
| First published | 2021-12-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=10 |
| Dependencies | 14 |
| Unpacked size | 222.1 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | REAL |
| Maintainers | michaelauderer |

## Links

- npm: https://www.npmjs.com/package/real-sdk
- Repository: https://github.com/real-app-platform/real-sdk
- Homepage: https://github.com/real-app-platform/real-sdk#readme
- Issues: https://github.com/real-app-platform/real-sdk/issues
- npm.io page: https://npm.io/package/real-sdk

## Dependencies (14)

- [uuid](https://npm.io/package/uuid.md) ^9.0.0
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [xstate](https://npm.io/package/xstate.md) ^4.37.2
- [jwt-decode](https://npm.io/package/jwt-decode.md) ^3.1.2
- [@types/uuid](https://npm.io/package/@types/uuid.md) ^9.0.1
- [@aws-sdk/types](https://npm.io/package/@aws-sdk/types.md) ^3.338.0
- [@aws-amplify/core](https://npm.io/package/@aws-amplify/core.md) ^5.3.0
- [@lifeomic/attempt](https://npm.io/package/@lifeomic/attempt.md) ^3.0.3
- [zen-observable-ts](https://npm.io/package/zen-observable-ts.md) ^1.1.0
- [regenerator-runtime](https://npm.io/package/regenerator-runtime.md) ^0.13.11
- [@types/zen-observable](https://npm.io/package/@types/zen-observable.md) ^0.8.3
- [@aws-sdk/client-cognito-identity](https://npm.io/package/@aws-sdk/client-cognito-identity.md) ^3.338.0
- [@aws-sdk/client-cognito-identity-provider](https://npm.io/package/@aws-sdk/client-cognito-identity-provider.md) ^3.338.0
- [@react-native-async-storage/async-storage](https://npm.io/package/@react-native-async-storage/async-storage.md) ^1.18.1

## Recent versions

- 0.28.7 (latest) — 2023-09-09
- 0.28.6 — 2023-06-13
- 0.28.5 — 2023-06-12
- 0.28.4 — 2023-06-04
- 0.28.3 — 2023-06-04
- 0.28.2 — 2023-06-04
- 0.28.1 — 2023-05-28
- 0.28.0 — 2023-05-26
- 0.27.8 — 2023-05-25
- 0.27.7 — 2023-01-10
- 0.27.6 — 2023-01-02
- 0.27.5 — 2022-12-23
- 0.27.4 — 2022-11-28
- 0.27.3 — 2022-11-24
- 0.27.2 — 2022-10-18
- … 30 more at https://npm.io/package/real-sdk/versions

## README

# REAL Auth SDK

TypeScript/JavaScript SDK for interaction with REAL Auth.

## Commands

To run the dev serve
r, use:

```bash
npm start # or yarn start
```

This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.

To do a one-off build, use `npm run build`.

To run tests, use `npm test`.

## Configuration

Code quality is set up with `prettier`, `husky`, and `lint-staged`.

### Jest

Jest tests are set up to run with `npm test`.

### Bundle Analysis

[`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of this library with `npm run size` and visualize the bundle with `npm run analyze`.

### Rollup

TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.

## Continuous Integration

### GitHub Actions

The following actions exist:

-   `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-   `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)

## Optimizations

Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:

```js
// ./types/index.d.ts
declare var __DEV__: boolean

// inside your code...
if (__DEV__) {
	console.log("foo")
}
```

You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.

## Publishing

To publish a new version, update the `version` parameter in `package.json`. When this change is pushed to the `main` branch, it will automatically deploy to GitHub Packages if tests and build are successful.

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