resonant-oauth-client

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #typescript #llm #android #rust #linux #java #cli #awesome-list #pytorch #mcp

resonant-oauth-client

(★ 9)

A TypeScript library for performing OAuth2 login to a Resonant server.

resonant-oauth-client 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# resonant-oauth-client
[![npm (scoped)](https://img.shields.io/npm/v/@resonant/oauth-client)](https://www.npmjs.com/package/@resonant/oauth-client)

A TypeScript library for performing OAuth login to a Resonant server.

## Description
This provides support for authenticating with Resonant servers,
using the OAuth2.0 Authorization Code Grant with PKCE flow.

## Supported environments
This library is published as untranspiled ES2024 JavaScript, so it requires either:
* a browser with full
  [ES2024 support](https://compat-table.github.io/compat-table/es2016plus/)
* or Node 22+, for non-browser environments (such as server-side rendering)

## Usage
* Install the library:

```bash
  npm install @resonant/oauth-client
  ```

* Instantiate an `OauthClient` with your application-specific configuration:
  ```typescript
  import OauthClient from '@resonant/oauth-client';

const oauthClient = new OauthClient(
    new URL(process.env.OAUTH_API_ROOT), // e.g. 'http://localhost:8000/oauth/'
    process.env.OAUTH_CLIENT_ID, // e.g. 'Qir0Aq7AKIsAkMDLQe9MEfORbHEBKsViNhAKJf1A'
  );
  ```

* Call `redirectToLogin` when it's time to start a login flow:
  ```typescript
  document.querySelector('#sign-in-link').addEventListener('click', async (event) => {
    event.preventDefault();
    await oauthClient.redirectToLogin();
    // This will redirect away from the current page
  });
  ```

* At the start of *every* page load, unconditionally call `maybeRestoreLogin`, to attempt to
  restore a login state; this will no-op if no login is present. Afterwards, get and store HTTP
  headers for authentication from `authHeaders`.
  ```typescript
  await oauthClient.maybeRestoreLogin();
  const { authHeaders } = oauthClient;
  ```

* Include these headers with every Ajax API request:
  ```typescript
  fetch('http://localhost:8000/api/files', {
    headers: authHeaders,
  });
  ```

* The login state will persist across page refreshes. Call `logout` to clear any active login:
  ```typescript
  document.querySelector('#sign-out-link').addEventListener('click', async (event) => {
    event.preventDefault();
    await oauthClient.logout()
    authHeaders = oauthClient.authHeaders;
  });
  ```

## Development
To develop the library using the example app:
```bash
# From the root of the repository
npm install
npm run watch
```
In another terminal:
```bash
# From the root of the repository
cd example
npm install
npm run serve
```

resonant-oauth-client

resonant-oauth-client 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

resonant-oauth-client

resonant-oauth-client 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README