# circle-access

> Circle Access - Node.js typescript client for [Circle Access API](https://circleauth.gocircle.ai/docs/)

Latest version **1.2.11** (published 2022-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install circle-access
pnpm add circle-access
yarn add circle-access
bun add circle-access
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.11 |
| Published | 2022-09-23 |
| First published | 2022-09-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 5 |
| Unpacked size | 655.1 KB |
| Known vulnerabilities | 0 (+23 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Circle Systems |
| Maintainers | unicauth |
| Keywords | circle, circle access, authentication, package, typescript, no credentials, credential free |

## Links

- npm: https://www.npmjs.com/package/circle-access
- Repository: https://github.com/circlesystems/circle-access-typescript
- Issues: https://github.com/circlesystems/circle-access-typescript/issues
- npm.io page: https://npm.io/package/circle-access

## Dependencies (5)

- [axios](https://npm.io/package/axios.md) ^0.27.2
- [buffer](https://npm.io/package/buffer.md) ^6.0.3
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7
- [crypto-browserify](https://npm.io/package/crypto-browserify.md) ^3.12.0
- [stream-browserify](https://npm.io/package/stream-browserify.md) ^3.0.0

## Alternatives

- [@clerk/clerk-expo](https://npm.io/package/@clerk/clerk-expo.md) — 133.6K weekly downloads
- [@pothos/plugin-authz](https://npm.io/package/@pothos/plugin-authz.md) — 12.4K weekly downloads
- [@bounded-sh/client](https://npm.io/package/@bounded-sh/client.md) — 3.2K weekly downloads
- [@luigi-project/plugin-auth-oauth2](https://npm.io/package/@luigi-project/plugin-auth-oauth2.md) — 2.3K weekly downloads
- [@nocobase/plugin-verification](https://npm.io/package/@nocobase/plugin-verification.md) — 2.0K weekly downloads

## Recent versions

- 1.2.11 (latest) — 2022-09-23
- 1.2.10 — 2022-09-23
- 1.2.9 — 2022-09-22

## README

# Circle Access

Circle Access - Node.js typescript client for [Circle Access API](https://circleauth.gocircle.ai/docs/)
<br>

Circle Access allows you to quickly implement userless/passwordless login and 2FA (no more paying for SMS to have 2FA)

## Installation

First make sure to get your credentials on [Circle Access Console](https://console.gocircle.ai/), if you want to test first, use [Circle Access- Demo](https://circleauth.gocircle.ai/demo)

### For [Node.js](https://nodejs.org/)

#### npm

Install it via:

```shell
npm install circle-access --save
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
import { CircleAccess } from 'circle-access'

const ca = new CircleAccess(
  'app9KrRWQS9DjtpzNgWcbHNt68S7Y1DfUJJV',
  'readFk4HtTqLNcTZYZzmHUNfT3jjt1EwqYRu3',
  'writeNRZpXhseVhV3pk1mrw7rxvEJLa4AXwzzH')

try {
  const session = await ca.getSession("session2YHiFKTTAwuvfL7kWMKRzzeVjNxMiwEbC");
  console.log('API called successfully. Returned data: ');
  console.log(session);
} catch (error) {
  console.error(error);
}
```

## Documentation

Check the test folder to see ALL calls that are available

## Distribuition

1.  Update package `version` at `package.json`.
2.  Open terminal and run `npm publish`.
3.  Visit https://www.npmjs.com/package/circle-access to check latest version.

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