@pushwoosh/http-client 1.5.0 → 1.5.1

package/src/http-client.main.ts

@@ -1,451 +0,0 @@
-import axios, { AxiosInstance, AxiosRequestConfig } from 'axios';
-import { History } from 'history';
-import Cookies from 'js-cookie';
-import decodeJwt from 'jwt-decode';
-import { compile } from 'path-to-regexp';
-import { stringify } from 'qs';
-
-import {
-  LogicError,
-  UnauthorizedError,
-  UnprocessableEntityError,
-} from './http-client.errors';
-import {
-  AccessToken,
-  BasicAuthorization,
-  Body,
-  Config,
-  DeleteOptions,
-  GetOptions,
-  Introspect,
-  Method,
-  Params,
-  PatchOptions,
-  PostOptions,
-  PutOptions,
-  Query,
-  RefreshToken,
-  RequestDetails,
-  RequestOptions,
-  Result,
-} from './http-client.types';
-
-type UpdateTokensByAuthorizationCodeQuery = {
-  readonly grant_type: 'authorization_code';
-  readonly code: string;
-  readonly redirect_uri: string;
-};
-
-type UpdateTokensByRefreshTokenQuery = {
-  readonly grant_type: 'refresh_token';
-  readonly refresh_token: string;
-};
-
-type UpdateTokensQuery =
-  | UpdateTokensByAuthorizationCodeQuery
-  | UpdateTokensByRefreshTokenQuery;
-
-type UpdateTokensPairResult = {
-  readonly access_token: string;
-  readonly refresh_token: string;
-};
-
-export class HttpClient {
-  /**
-   * Имя куки, используемое для сохранения состояния авторизации
-   * Для более подробной информации смотри https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1
-   */
-  public static AUTHORIZATION_STATE_COOKIE_NAME = '__PW_AUTHORIZATION_STATE';
-
-  /**
-   * Имя куки, используемое для сохранения адреса страницы перед авторизацией
-   */
-  public static URL_BEFORE_AUTHORIZATION_COOKIE_NAME = '__PW_URL_BEFORE_AUTHORIZATION';
-
-  /**
-   * Экземпляр Axios
-   */
-  private readonly instance: AxiosInstance;
-
-  /**
-   * API для работы с навигацией
-   */
-  private readonly history: History;
-
-  /**
-   * Конфигурация Http Client
-   */
-  private readonly config: Config;
-
-  /**
-   * Токен доступа, используемый для доступа к защищенным ресурсам
-   * Для более подробной информации смотри https://www.rfc-editor.org/rfc/rfc6749.html#section-1.4
-   */
-  private accessToken: AccessToken | null;
-
-  /**
-   * Токен обновления, используемый для обновления токена доступа.
-   * Для более подробной информации смотри https://www.rfc-editor.org/rfc/rfc6749.html#section-1.5
-   */
-  private refreshToken: RefreshToken | null;
-
-  /**
-   * Происходит ли сейчас обновление токенов
-   */
-  private isRefreshing: boolean;
-
-  /**
-   * Проверить наличие авторизации
-   *
-   * @param details - детали запроса к защищенным ресурсам
-   */
-  private checkAuthorization = async (details: RequestDetails | null): Promise<void> => {
-    // если происходит процесс обновления токенов, ждем 100 мс и пробуем проверить авторизацию заново
-    if (this.isRefreshing) {
-      await new Promise((resolve) => {
-        setTimeout(resolve, 100);
-      });
-
-      await this.checkAuthorization(details);
-      return;
-    }
-
-    // если нет токена доступа, то клиент точно не авторизован
-    if (!this.accessToken) {
-      throw new UnauthorizedError('Unauthorized!', details);
-    }
-
-    // если время жизни токена вышло, нужно попробовать обновить его с помощью токена обновления
-    const currentTime = new Date().getTime() / 1000;
-    const introspect = decodeJwt<any>(this.accessToken);
-    const isTokenExpired = introspect.expired_at < currentTime;
-    if (isTokenExpired) {
-      await this.updateTokenByRefreshToken(details);
-      await this.checkAuthorization(details);
-    }
-  };
-
-  /**
-   * Обновить токен доступа
-   * Для более подробной информации смотри:
-   * https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.3
-   * https://www.rfc-editor.org/rfc/rfc6749.html#section-6
-   *
-   * @param query - параметры запроса, участвующие в обновлении
-   */
-  private updateToken = async (query: UpdateTokensQuery): Promise<void> => {
-    // идентификация клиента происходит с помощью заголовка
-    const clientIdInBase64 = btoa(`${this.config.clientId}:`);
-    const authorizationHeader = `Basic ${clientIdInBase64}`;
-
-    try {
-      this.isRefreshing = true;
-
-      const tokens = await this.post<UpdateTokensPairResult, never, UpdateTokensQuery, never>(
-        this.config.urls.token,
-        {
-          headers: {
-            Authorization: authorizationHeader,
-          },
-          query,
-          withAuthorization: false,
-          withCredentials: true,
-        },
-      );
-
-      this.accessToken = tokens.access_token;
-      this.refreshToken = tokens.refresh_token;
-      this.isRefreshing = false;
-    } catch (error) {
-      this.accessToken = null;
-      this.refreshToken = null;
-      this.isRefreshing = false;
-
-      throw error;
-    }
-  };
-
-  /**
-   * Обновить токен доступа с помощью кода авторизации
-   * Для более подробной информации смотри: https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.3
-   *
-   * @param authorizationCode - код авторизации, полученный от сервера авторизации
-   */
-  public updateTokenByAuthorizationCode = async (authorizationCode: string): Promise<void> => {
-    await this.updateToken({
-      grant_type: 'authorization_code',
-      code: authorizationCode,
-      redirect_uri: `${window.location.origin}${window.location.pathname}`,
-    });
-  };
-
-  /**
-   * Обновить токен доступа с помощью токена обновления
-   * Для более подробной информации смотри: https://www.rfc-editor.org/rfc/rfc6749.html#section-6
-   *
-   * @param details - детали запроса к защищенным ресурсам
-   */
-  public updateTokenByRefreshToken = async (details: RequestDetails | null): Promise<void> => {
-    if (!this.refreshToken) {
-      this.accessToken = null;
-      throw new UnauthorizedError('Unauthorized!', details);
-    }
-
-    await this.updateToken({
-      grant_type: 'refresh_token',
-      refresh_token: this.refreshToken,
-    });
-  };
-
-  /**
-   * Создать экземпляр класса
-   *
-   * @param history - API для работы с навигацией
-   * @param config - конфигурация Http Client
-   */
-  public constructor(history: History, config: Config) {
-    this.instance = axios.create({ paramsSerializer: stringify });
-
-    this.history = history;
-    this.config = config;
-    this.accessToken = null;
-    this.refreshToken = null;
-    this.isRefreshing = false;
-  }
-
-  /**
-   * Выполнить запрос
-   *
-   * @param url - адрес запроса
-   * @param method - метод запроса
-   * @param options - конфигурация запроса
-   */
-  public request = async <M extends Method, R extends Result, P extends Params | never, Q extends Query | never, B extends Body | never>(url: string, method: M, options: RequestOptions<M, R, P, Q, B>): Promise<R> => {
-    const { basicErrorMiddleware, basicResponseMiddleware } = this.config;
-    const { errorMiddleware = basicErrorMiddleware, responseMiddleware = basicResponseMiddleware } = options;
-    // формируем детали запроса
-    const details = {
-      url,
-      method,
-      headers: options.headers,
-      params: (options as any).params,
-      query: (options as any).query,
-      body: (options as any).body,
-      withCredentials: options.withCredentials,
-      withAuthorization: options.withAuthorization,
-    };
-
-    // формируем конфигурацию запроса
-    const config: AxiosRequestConfig = {
-      url,
-      method,
-      headers: options.headers,
-      validateStatus: null,
-      withCredentials: options.withCredentials,
-    };
-
-    if ('params' in options) {
-      config.url = compile(url)(options.params);
-    }
-    if ('query' in options) {
-      config.params = options.query;
-    }
-    if ('body' in options) {
-      config.data = options.body;
-    }
-
-    if (options.withAuthorization) {
-      await this.checkAuthorization(details);
-      config.headers = config.headers || {};
-      config.headers['Authorization'] = `Bearer ${this.accessToken}`;
-    }
-
-    // запрос может быть выполнен дважды, если произошла ошибка UnauthorizedError,
-    // чтобы была возможность автоматически обновить access token с помощью refresh token
-    let result;
-    try {
-      const response = await this.instance.request<R>(config);
-      result = await responseMiddleware({
-        result: response.data,
-        status: response.status,
-        message: response.statusText,
-        details,
-      });
-    } catch (firstError) {
-      // если ошибка возникшая во время первого запроса не Unauthorized, то прокидываем ее дальше
-      if (!(firstError instanceof UnauthorizedError)) {
-        await errorMiddleware(firstError);
-        // если вдруг в errorMiddleware не кинуто исключение, делаем это за него
-        throw firstError;
-      }
-
-      // вторая попытка выполнить запрос, но уже с обновлением токенов
-      try {
-        if (options.withAuthorization) {
-          await this.updateTokenByRefreshToken(details);
-          await this.checkAuthorization(details);
-          config.headers = config.headers || {};
-          config.headers['Authorization'] = `Bearer ${this.accessToken}`;
-        }
-
-        const response = await this.instance.request<R>(config);
-        result = await responseMiddleware({
-          result: response.data,
-          status: response.status,
-          message: response.statusText,
-          details,
-        });
-      } catch (secondError) {
-        await errorMiddleware(secondError);
-        // если вдруг в errorMiddleware не кинуто исключение, делаем это за него
-        throw secondError;
-      }
-    }
-
-    return result;
-  };
-
-  /**
-   * Выполнить GET запрос
-   *
-   * @param url - адрес запроса
-   * @param options - конфигурация GET запроса
-   */
-  public get = <R extends Result, P extends Params | never, Q extends Query | never>(url: string, options: GetOptions<R, P, Q>): Promise<R> => (
-    this.request<Method.GET, R, P, Q, never>(url, Method.GET, options as RequestOptions<Method.GET, R, P, Q, never>)
-  );
-
-  /**
-   * Выполнить POST запрос
-   *
-   * @param url - адрес запроса
-   * @param options - конфигурация POST запроса
-   */
-  public post = <R extends Result, P extends Params | never, Q extends Query | never, B extends Body>(url: string, options: PostOptions<R, P, Q, B>): Promise<R> => (
-    this.request<Method.POST, R, P, Q, B>(url, Method.POST, options as RequestOptions<Method.POST, R, P, Q, B>)
-  );
-
-  /**
-   * Выполнить PUT запрос
-   *
-   * @param url - адрес запроса
-   * @param options - конфигурация PUT запроса
-   */
-  public put = <R extends Result, P extends Params | never, Q extends Query | never, B extends Body>(url: string, options: PutOptions<R, P, Q, B>): Promise<R> => (
-    this.request<Method.PUT, R, P, Q, B>(url, Method.PUT, options as RequestOptions<Method.PUT, R, P, Q, B>)
-  );
-
-  /**
-   * Выполнить PATCH запрос
-   *
-   * @param url - адрес запроса
-   * @param options - конфигурация PATCH запроса
-   */
-  public patch = <R extends Result, P extends Params | never, Q extends Query | never, B extends Body>(url: string, options: PatchOptions<R, P, Q, B>): Promise<R> => (
-    this.request<Method.PATCH, R, P, Q, B>(url, Method.PATCH, options as RequestOptions<Method.PATCH, R, P, Q, B>)
-  );
-
-  /**
-   * Выполнить DELETE запрос
-   *
-   * @param url - адрес запроса
-   * @param options - конфигурация DELETE запроса
-   */
-  public delete = <R extends Result, P extends Params | never, Q extends Query | never, B extends Body>(url: string, options: DeleteOptions<R, P, Q, B>): Promise<R> => (
-    this.request<Method.DELETE, R, P, Q, B>(url, Method.DELETE, options as RequestOptions<Method.DELETE, R, P, Q, B>)
-  );
-
-  /**
-   * Выполнить первый шаг авторизации клиента (базовая авторизация)
-   * Для более подробной информации смотри https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1
-   */
-  public login = async (): Promise<void> => {
-    const newAuthorizationState = Math.random().toString().slice(2, 12);
-    Cookies.set(HttpClient.AUTHORIZATION_STATE_COOKIE_NAME, newAuthorizationState);
-    Cookies.set(HttpClient.URL_BEFORE_AUTHORIZATION_COOKIE_NAME, window.location.href, this.config.cookie);
-
-    const query = stringify({
-      response_type: 'code',
-      client_id: this.config.clientId,
-      // scope: this.config.scope,
-      redirect_uri: `${window.location.origin}${window.location.pathname}`,
-      state: newAuthorizationState,
-    });
-
-    window.location.href = `${this.config.urls.authorize}?${query}`;
-
-    return new Promise(() => {
-    });
-  };
-
-  /**
-   * Выполнить второй шаг авторизации клиента (получить access token и refresh token)
-   * Для более подробной информации смотри https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.3
-   *
-   * @param authorization - данные о базовой авторизации клиента.
-   */
-  public authorize = async <I extends Introspect>(authorization: BasicAuthorization): Promise<I> => {
-    const storiedAuthorizationState = Cookies.get(HttpClient.AUTHORIZATION_STATE_COOKIE_NAME);
-    const storiedAuthorizationUrl = Cookies.get(HttpClient.URL_BEFORE_AUTHORIZATION_COOKIE_NAME);
-
-    Cookies.remove(HttpClient.AUTHORIZATION_STATE_COOKIE_NAME);
-    Cookies.remove(HttpClient.URL_BEFORE_AUTHORIZATION_COOKIE_NAME);
-
-    if (storiedAuthorizationUrl) {
-      const url = new URL(storiedAuthorizationUrl);
-      this.history.replace({
-        pathname: url.pathname,
-        search: url.search,
-        hash: url.hash,
-      });
-    }
-
-    if (storiedAuthorizationState !== authorization.state) {
-      throw new UnprocessableEntityError('Storied authorization state and received authorization state NOT equals!');
-    }
-
-    await this.updateTokenByAuthorizationCode(authorization.code);
-    if (!this.accessToken) {
-      throw new LogicError('Access token is null after update tokens!');
-    }
-
-    return decodeJwt<I>(this.accessToken);
-  };
-
-  /**
-   * Закончить сеанс
-   */
-  public logout = async (): Promise<void> => {
-    this.accessToken = null;
-    this.refreshToken = null;
-
-    await this.get<void, never, never>(
-      this.config.urls.logout,
-      {
-        withAuthorization: false,
-        withCredentials: true,
-      },
-    );
-  };
-
-  /**
-   * Получить токен доступа
-   */
-  public getAccessToken = async (): Promise<AccessToken> => {
-    await this.checkAuthorization(null);
-    if (!this.accessToken) {
-      throw new LogicError('Access token is null after check authorization!');
-    }
-
-    return this.accessToken;
-  };
-
-  /**
-   * Установить токен доступа вручную
-   *
-   * @param accessToken - токен доступа
-   */
-  public setAccessToken = (accessToken: string): void => {
-    this.accessToken = accessToken;
-  };
-}

package/src/http-client.types.ts

@@ -1,102 +0,0 @@
-import { CookieAttributes } from 'js-cookie';
-
-export type AccessToken = string;
-export type RefreshToken = string;
-
-export enum Method {
-  GET = 'GET',
-  POST = 'POST',
-  PUT = 'PUT',
-  PATCH = 'PATCH',
-  DELETE = 'DELETE',
-}
-
-export type Headers = Record<string, string | number | boolean>;
-export type Params = Record<string, string | number>;
-export type Query = Record<string, string> | URLSearchParams | string;
-export type Body = Record<string, unknown> | FormData;
-export type Result = unknown;
-
-export type RequestDetails = {
-  readonly url: string;
-  readonly method: Method;
-  readonly params: Params;
-  readonly query: Query;
-  readonly body: Body;
-  readonly withCredentials?: boolean;
-  readonly withAuthorization: boolean;
-};
-
-export type Response = {
-  readonly result: any;
-  readonly status: number;
-  readonly message?: string;
-  readonly details: RequestDetails;
-};
-
-export type CommonRequestOptions<R extends Result> = {
-  readonly headers?: Headers;
-  readonly withAuthorization: boolean;
-  readonly withCredentials?: boolean;
-  readonly responseMiddleware?: (response: Response) => Promise<R> | R;
-  readonly errorMiddleware?: (error: unknown) => Promise<never> | never;
-};
-
-export type RequestOptions<
-  M extends Method,
-  R extends Result,
-  P extends Params | never,
-  Q extends Query | never,
-  B extends Body | never,
-> =
-  M extends Method.GET
-    ? [P] extends [never]
-      ? [Q] extends [never]
-        ? CommonRequestOptions<R>
-        : CommonRequestOptions<R> & { readonly query: Q; }
-      : [Q] extends [never]
-        ? CommonRequestOptions<R> & { readonly params: P; }
-        : CommonRequestOptions<R> & { readonly query: Q; readonly params: P; }
-    : [P] extends [never]
-      ? [Q] extends [never]
-        ? [B] extends [never]
-          ? CommonRequestOptions<R>
-          : CommonRequestOptions<R> & { readonly body: B; }
-        : [B] extends [never]
-          ? CommonRequestOptions<R> & { readonly query: Q; }
-          : CommonRequestOptions<R> & { readonly query: Q; readonly body: B; }
-      : [Q] extends [never]
-        ? [B] extends [never]
-          ? CommonRequestOptions<R> & { readonly params: P; }
-          : CommonRequestOptions<R> & { readonly params: P; readonly body: B; }
-        : [B] extends [never]
-          ? CommonRequestOptions<R> & { readonly params: P; readonly query: Q; }
-          : CommonRequestOptions<R> & { readonly params: P; readonly query: Q, readonly body: B; };
-
-export type GetOptions<R extends Result, P extends Params | never, Q extends Query | never> = Omit<RequestOptions<Method.GET, R, P, Q, never>, 'method'>;
-export type PostOptions<R extends Result, P extends Params | never, Q extends Query | never, B extends Body> = Omit<RequestOptions<Method.POST, R, P, Q, B>, 'method'>;
-export type PutOptions<R extends Result, P extends Params | never, Q extends Query | never, B extends Body> = Omit<RequestOptions<Method.PUT, R, P, Q, B>, 'method'>;
-export type PatchOptions<R extends Result, P extends Params | never, Q extends Query | never, B extends Body> = Omit<RequestOptions<Method.PATCH, R, P, Q, B>, 'method'>;
-export type DeleteOptions<R extends Result, P extends Params | never, Q extends Query | never, B extends Body> = Omit<RequestOptions<Method.DELETE, R, P, Q, B>, 'method'>;
-
-export type Config = {
-  readonly urls: {
-    readonly authorize: string;
-    readonly token: string;
-    readonly logout: string;
-  };
-  readonly clientId: string;
-  readonly scope: string;
-  readonly cookie: Omit<CookieAttributes, 'domain'> & {
-    readonly domain: string;
-  };
-  readonly basicResponseMiddleware: <R extends Result>(response: Response) => Promise<R> | R;
-  readonly basicErrorMiddleware: (error: unknown) => Promise<never> | never;
-};
-
-export type BasicAuthorization = {
-  readonly state: string;
-  readonly code: string;
-};
-
-export type Introspect = Record<string, unknown>;

package/src/http-client.utilities.ts

@@ -1,84 +0,0 @@
-import {
-  BadGatewayError,
-  BadRequestError,
-  ForbiddenError,
-  GatewayTimeoutError,
-  InternalServerError,
-  MethodNotAllowedError,
-  NotFoundError,
-  NotImplementedError,
-  PayloadTooLargeError,
-  ServiceUnavailableError,
-  TooManyRequestsError,
-  UnauthorizedError,
-  UnprocessableEntityError,
-  UnsupportedMediaTypeError,
-  UntiledError,
-} from './http-client.errors';
-import {
-  Response,
-  Result,
-} from './http-client.types';
-
-/**
- * Проверить, выполнился ли запрос успешно.
- *
- * @param response - ответ от сервера.
- */
-export function checkIsResponseSuccess(response: Response): boolean {
-  return response.status >= 200 && response.status < 300;
-}
-
-/**
- * Обработчик ответа от сервера по умолчанию.
- *
- * @param response - ответ от сервера.
- */
-export function defaultResponseMiddleware<R extends Result>(response: Response): R {
-  if (checkIsResponseSuccess(response)) {
-    return response.result;
-  }
-
-  const message: string | undefined = response.message || response.result?.message;
-  switch (response.status) {
-    case 400:
-      throw new BadRequestError(message, response.details);
-    case 401:
-      throw new UnauthorizedError(message, response.details);
-    case 403:
-      throw new ForbiddenError(message, response.details);
-    case 404:
-      throw new NotFoundError(message, response.details);
-    case 405:
-      throw new MethodNotAllowedError(message, response.details);
-    case 413:
-      throw new PayloadTooLargeError(message, response.details);
-    case 415:
-      throw new UnsupportedMediaTypeError(message, response.details);
-    case 422:
-      throw new UnprocessableEntityError(message, response.details);
-    case 429:
-      throw new TooManyRequestsError(message, response.details);
-    case 500:
-      throw new InternalServerError(message, response.details);
-    case 501:
-      throw new NotImplementedError(message, response.details);
-    case 502:
-      throw new BadGatewayError(message, response.details);
-    case 503:
-      throw new ServiceUnavailableError(message, response.details);
-    case 504:
-      throw new GatewayTimeoutError(message, response.details);
-    default:
-      throw new UntiledError(message || 'Untiled Error!', response.status, response.details);
-  }
-}
-
-/**
- * Обработчик ошибки по умолчанию.
- *
- * @param error - ошибка.
- */
-export function defaultErrorMiddleware(error: unknown): never {
-  throw error;
-}

package/tsconfig.eslint.json

@@ -1,9 +0,0 @@
-{
-  "extends": "./tsconfig.json",
-  "compilerOptions": {
-    "rootDir": "./"
-  },
-  "include": [
-    "./**/*"
-  ]
-}

package/tsconfig.json

@@ -1,51 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES5",
-    "module": "ESNext",
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "baseUrl": "./",
-    "lib": [
-      "ESNext",
-      "DOM"
-    ],
-    /* Type Checking */
-    "strict": true,
-    "allowUnreachableCode": false,
-    "allowUnusedLabels": false,
-    "exactOptionalPropertyTypes": false,
-    "noFallthroughCasesInSwitch": true,
-    "noImplicitReturns": true,
-    "noPropertyAccessFromIndexSignature": true,
-    "noUncheckedIndexedAccess": true,
-    "noUnusedLocals": true,
-    "noUnusedParameters": true,
-    /* Modules */
-    "moduleResolution": "node",
-    "resolveJsonModule": true,
-    /* Emit */
-    "declaration": true,
-    "declarationMap": true,
-    "importHelpers": true,
-    "preserveValueImports": false,
-    "sourceMap": true,
-    /* JavaScript Support */
-    "allowJs": false,
-    /* Interop Constraints */
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true,
-    "isolatedModules": true,
-    /* Language and Environment */
-    "emitDecoratorMetadata": true,
-    "experimentalDecorators": true
-  },
-  "include": [
-    "./src/**/*",
-    "./tests/**/*",
-  ],
-  "exclude": [
-    "./dist/**/*",
-    "./node_modules/**/*"
-  ]
-}