oauth-v2-client/lib/grant-controls/ImplicitGrantControl.ts

Oauth V2 client based on axios

import { Obj } from "@noreajs/common";
import { parseUrl } from "query-string";
import { OauthClientConfig } from "../interfaces";
import GetAuthorizationUriFuncType from "../interfaces/GetAuthorizationUrlFuncConfig";
import ImplicitGrantOptions from "../interfaces/ImplicitGrantOptions";
import GrantControl from "./GrantControl";

export default class ImplicitGrantControl extends GrantControl {
  private options: ImplicitGrantOptions;
  private redirectUri: string;

  constructor(config: OauthClientConfig, options: ImplicitGrantOptions) {
    super(config);

    this.options = options;

    // callback url
    this.redirectUri = this.options.callbackUrl;
  }

  /**
   * Get authentication url
   * @param {GetAuthorizationUriFuncType} options redirect uri, response type
   */
  getAuthUri(options?: GetAuthorizationUriFuncType) {
    // create local properties
    const localState = options?.state;
    const localScopes = options?.scopes ?? this.options.scopes;
    const localRedirectUrl = options?.callbackUrl ?? this.redirectUri;

    // query params
    const queryParams: any = {
      response_type: "token",
      redirect_uri: localRedirectUrl,
      client_id: this.options.clientId,
      state: localState,
      scope: localScopes ? localScopes.join(" ") : "",
    };

    // merged params
    const mergedParams = Obj.merge(
      queryParams,
      this.requestOptions.query ?? {}
    );

    // constructing the request
    const url = new URL(this.options.authUrl);

    for (const param in mergedParams) {
      if (Object.prototype.hasOwnProperty.call(mergedParams, param)) {
        const value = mergedParams[param];
        // setting the param
        url.searchParams.set(param, value);
      }
    }

    return url.toString();
  }

  /**
   * Extract the token within the callback uri
   * @param callbackUrl the full callback uri
   * @param state state
   */
  getToken<T = any>(callbackUrl: string, state?: string | string[]): T {
    // callback url data
    const urlData = parseUrl(callbackUrl);

    // local state
    let localState = state;

    // force array
    if (localState === null || localState === undefined) {
      localState = [];
    } else if (!Array.isArray(localState)) {
      localState = [localState];
    }

    // state exists
    if (urlData.query.state && !localState.includes(urlData.query.state as string)) {
      if (this.log === true) {
        console.log("Corrupted answer, the state doesn't match.", {
          urlData: urlData,
          localState: localState,
        });
      }
      throw new Error("Corrupted answer, the state doesn't match.");
    }

    return urlData.query as any;
  }
}