Axios OAuth Client

Common errors

• Cannot find module 'axios'

  cause The peer dependency 'axios' is not installed or not resolvable by the module system.
  fix Install axios: `npm install axios` or `yarn add axios`.

• TypeError: axios.create is not a function

  cause An incompatible or incorrect version of Axios is installed, or Axios was not imported correctly.
  fix Ensure you have a compatible version of Axios (e.g., `^1.2.1`) and that you are importing `axios` as a default import: `import axios from 'axios'`.

• Request failed with status code 400 (or other HTTP error) when calling an OAuth grant function.

  cause Incorrect OAuth client ID, client secret, token endpoint URL, grant type parameters (e.g., authorization code), or scopes were provided to the OAuth server.
  fix Verify all OAuth client credentials, endpoint URLs, and grant-specific parameters (like the authorization code or refresh token) are correct and match the configuration on your OAuth provider. Check the response body for specific error details from the OAuth server.

Warnings

• gotcha This library requires 'axios' as a peer dependency. It must be installed separately alongside 'axios-oauth-client' and meet the specified version range (e.g., '^1.2.1').
  Fix: Ensure 'axios' is installed: `npm install axios` or `yarn add axios`.
• gotcha axios-oauth-client provides functions for acquiring tokens but does not handle token storage, automatic refreshing before expiry, or attaching tokens to subsequent requests. Users must implement their own token management logic.
  Fix: Implement an Axios interceptor or manual logic to store tokens, check expiry, refresh tokens, and attach the current access token to outbound requests.
• gotcha The library directly exposes functions for different OAuth 2.0 grant types. There is no unified client instance that manages state across different grant types or automatically uses a refresh token if available from a previous grant.
  Fix: Developers must explicitly call the appropriate grant function (e.g., `clientCredentials`, `refreshToken`) based on their application's current authentication state.

Install

• npm install axios-oauth-client npm
• yarn add axios-oauth-client yarn
• pnpm add axios-oauth-client pnpm

Imports

• authorizationCode
  wrong:

  const { authorizationCode } = require('axios-oauth-client')

  correct:

  import { authorizationCode } from 'axios-oauth-client'

  The library primarily uses ES Modules, though CommonJS might be supported via transpilation.
• clientCredentials
  wrong:

  import clientCredentials from 'axios-oauth-client'

  correct:

  import { clientCredentials } from 'axios-oauth-client'

  Functions are exported as named exports, not default.
• refreshToken
  wrong:

  const refreshToken = require('axios-oauth-client').refreshToken

  correct:

  import { refreshToken } from 'axios-oauth-client'

  Ensure your environment supports ES Module imports (Node.js >=14 with appropriate configuration, or bundlers).

Quickstart

Demonstrates how to obtain an access token using the Client Credentials grant and then refresh it.

import axios from 'axios';
import { clientCredentials, refreshToken } from 'axios-oauth-client';

const tokenEndpoint = 'https://oauth.com/2.0/token';
const clientId = process.env.OAUTH_CLIENT_ID ?? 'YOUR_CLIENT_ID';
const clientSecret = process.env.OAUTH_CLIENT_SECRET ?? 'YOUR_CLIENT_SECRET';

async function authenticateAndRefresh() {
  const axiosInstance = axios.create();

  // Client Credentials Grant
  console.log('Attempting Client Credentials grant...');
  const getClientCredentials = clientCredentials(
    axiosInstance,
    tokenEndpoint,
    clientId,
    clientSecret
  );
  const initialAuth = await getClientCredentials('read write');
  console.log('Initial access token acquired:', initialAuth.access_token);

  // Simulate refreshing the token
  if (initialAuth.refresh_token) {
    console.log('Attempting Refresh Token grant...');
    const getRefreshToken = refreshToken(
      axiosInstance,
      tokenEndpoint,
      clientId,
      clientSecret
    );
    const refreshedAuth = await getRefreshToken(initialAuth.refresh_token, 'read write');
    console.log('Refreshed access token acquired:', refreshedAuth.access_token);
  } else {
    console.log('No refresh token available from client credentials grant. Skipping refresh example.');
  }
}

authenticateAndRefresh().catch(error => {
  console.error('Authentication error:', error.response?.data || error.message);
});