@pushwoosh/http-client 1.0.2 → 1.1.0

package/dist/http-client.d.ts

@@ -0,0 +1,171 @@
+import { History } from 'history';
+import { Body, Config, DeleteOptions, GetOptions, Introspect, Method, PatchOptions, PostOptions, PutOptions, Query, RequestOptions, Response } from './http-client.types';
+export declare class HttpClient {
+    /**
+     * Имя куки в которой будет сохранена случайная строка для проверки ответа авторизации.
+     * Для более подробной информации: RFC 6749 https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.1.
+     */
+    static STORIED_AUTHORIZATION_STATE_COOKIE_NAME: string;
+    /**
+     * Имя куки в которой будет сохранен полный текущий адрес страницы.
+     */
+    static STORIED_URL_COOKIE_NAME: string;
+    /**
+     * Библиотека для управления навигацией.
+     */
+    private readonly history;
+    /**
+     * Параметры конфигурации.
+     */
+    private readonly config;
+    /**
+     * Токен доступа.
+     */
+    private accessToken;
+    /**
+     * Токен обновления.
+     */
+    private refreshToken;
+    /**
+     * Происходит ли сейчас обновление токенов.
+     */
+    private isRefreshing;
+    /**
+     * Был ли установлен токен доступа вручную.
+     */
+    private isAccessTokenSetManual;
+    constructor(history: History, config: Config);
+    /**
+     * Разобрать ответ от сервера, и вернуть результат выполнения запроса.
+     *
+     * @param { Response<*> } response - ответ от сервера.
+     */
+    basicResponseMiddleware: <R extends unknown>(response: Response<R>) => R;
+    /**
+     * Проверить наличие авторизации.
+     */
+    private guardAuthorization;
+    /**
+     * Обновить токены.
+     * Для более подробной информации: RFC 6749 https://www.rfc-editor.org/rfc/rfc6749.html.
+     *
+     * @param { UpdateTokensPairQuery } query - параметры запроса для обновления токенов.
+     */
+    private updateTokensPair;
+    /**
+     * Обновить токены с помощью кода авторизации.
+     * Для более подробной информации: RFC 6749 https://www.rfc-editor.org/rfc/rfc6749.html#section-4.1.3.
+     *
+     * @param { string } authorizationCode - код авторизации, полученный от сервера авторизации.
+     */
+    private updateTokensPairByAuthorizationCode;
+    /**
+     * Обновить токены с помощью токена обновления.
+     * Для более подробной информации: RFC 6749 https://www.rfc-editor.org/rfc/rfc6749.html#section-6.
+     *
+     * @param { string } refreshToken - токен обновления, полученный от сервера авторизации.
+     * @param { Introspect } introspect - содержимое токена доступа.
+     */
+    private updateTokensPairByRefreshToken;
+    /**
+     * Инициализировать модуль, если передан authorizationCode и authorizationState будет выполнена попытка обновить токены.
+     *
+     * @param { string } authorizationCode - код авторизации, полученный от сервера авторизации.
+     * @param { string } authorizationState - уникальная строка, переданная клиентом серверу при авторизации, полученная от сервера авторизации.
+     */
+    initialize: (authorizationCode: string | null, authorizationState: string | null) => Promise<Introspect | null>;
+    /**
+     * Начать сессию.
+     */
+    login: () => Promise<void>;
+    /**
+     * Завершить сессию.
+     */
+    logout: () => Promise<void>;
+    /**
+     * Временный костыль, чтобы установить токен доступа из сессии.
+     */
+    setAccessToken: (accessToken: string) => void;
+    /**
+     * Получить токен доступа, если время жизни токена закончилось, будет осуществлена попытка обновить токен.
+     */
+    getAccessToken: () => Promise<string>;
+    /**
+     * Выполнить запрос на сервер.
+     *
+     * Дженерик:
+     * Method - тип запроса.
+     * Placeholders - параметры, которые будут подставлены в шаблон пути.
+     * Query - параметры, которые будут преобразованы в строку запроса.
+     * Body - тело запроса (never для GET).
+     * Result - ожидаемый результат выполнения запроса.
+     *
+     * @param { string } url - адрес запроса.
+     * @param { Options<Method, Params, Query, Body> } options - параметры запроса.
+     */
+    request: <M extends Method, P extends Record<string, string | number>, Q extends Query, B extends Body, R extends unknown>(url: string, options: RequestOptions<M, P, Q, B>) => Promise<Response<R>>;
+    /**
+     * Выполнить GET запрос на сервер.
+     *
+     * Дженерик:
+     * Params - параметры, которые будут подставлены в шаблон пути.
+     * Query - параметры, которые будут преобразованы в строку запроса.
+     * Result - ожидаемый результат выполнения запроса.
+     *
+     * @param { string } url - адрес запроса.
+     * @param { GetOptions<Params, Query> } options - параметры GET запроса.
+     */
+    get: <P extends Record<string, string | number>, Q extends Query, R extends unknown>(url: string, options: GetOptions<P, Q, R>) => Promise<R>;
+    /**
+     * Выполнить POST запрос на сервер.
+     *
+     * Дженерик:
+     * Params - параметры, которые будут подставлены в шаблон пути.
+     * Query - параметры, которые будут преобразованы в строку запроса.
+     * Body - тело запроса.
+     * Result - ожидаемый результат выполнения запроса.
+     *
+     * @param { string } url - адрес запроса.
+     * @param { PostOptions<Params, Query, Body> } options - параметры POST запроса.
+     */
+    post: <P extends Record<string, string | number>, Q extends Query, B extends Body, R extends unknown>(url: string, options: PostOptions<P, Q, B, R>) => Promise<R>;
+    /**
+     * Выполнить PUT запрос на сервер.
+     *
+     * Дженерик:
+     * Params - параметры, которые будут подставлены в шаблон пути.
+     * Query - параметры, которые будут преобразованы в строку запроса.
+     * Body - тело запроса.
+     * Result - ожидаемый результат выполнения запроса.
+     *
+     * @param { string } url - адрес запроса.
+     * @param { PutOptions<Params, Query, Body> } options - параметры PUT запроса.
+     */
+    put: <P extends Record<string, string | number>, Q extends Query, B extends Body, R extends unknown>(url: string, options: PutOptions<P, Q, B, R>) => Promise<R>;
+    /**
+     * Выполнить PATCH запрос на сервер.
+     *
+     * Дженерик:
+     * Params - параметры, которые будут подставлены в шаблон пути.
+     * Query - параметры, которые будут преобразованы в строку запроса.
+     * Body - тело запроса.
+     * Result - ожидаемый результат выполнения запроса.
+     *
+     * @param { string } url - адрес запроса.
+     * @param { PatchOptions<Params, Query, Body> } options - параметры PATCH запроса.
+     */
+    patch: <P extends Record<string, string | number>, Q extends Query, B extends Body, R extends unknown>(url: string, options: PatchOptions<P, Q, B, R>) => Promise<R>;
+    /**
+     * Выполнить DELETE запрос на сервер.
+     *
+     * Дженерик:
+     * Params - параметры, которые будут подставлены в шаблон пути.
+     * Query - параметры, которые будут преобразованы в строку запроса.
+     * Body - тело запроса.
+     * Result - ожидаемый результат выполнения запроса.
+     *
+     * @param { string } url - адрес запроса.
+     * @param { DeleteOptions<Params, Query, Body> } options - параметры DELETE запроса.
+     */
+    delete: <P extends Record<string, string | number>, Q extends Query, B extends Body, R extends unknown>(url: string, options: DeleteOptions<P, Q, B, R>) => Promise<R>;
+}

package/{lib → dist}/http-client.errors.d.ts

@@ -1,105 +1,111 @@
 /**
- * Класс описывающий ошибку связанную с модулем HttpClient
+ * Класс описывающий ошибку связанную с модулем HttpClient.
  */
 export declare class HttpClientError extends Error {
     readonly name: string;
     /**
-     * Статус ошибки
+     * Статус ошибки.
      */
     readonly status: number;
     /**
-     * Детали ошибки
+     * Детали ошибки.
      */
     readonly details: string | null;
     constructor(message: string, status: number, details: string | null);
 }
 /**
- * Класс описывающий внутреннюю ошибку связанную с модулем HttpClient
+ * Класс описывающий внутреннюю ошибку связанную с модулем HttpClient.
  */
 export declare class InternalError extends HttpClientError {
     readonly name: string;
     constructor(message: string, details: string | null);
 }
 /**
- * Класс описывающий неизвестную ошибку
+ * Класс описывающий неизвестную ошибку.
  */
 export declare class UnknownError extends HttpClientError {
     constructor(code: number, details: string);
 }
 /**
- * Класс описывающий ошибку "Плохой запрос"
- * Это означает, что сервер не понимает запрос из-за неверного синтаксиса
+ * Класс описывающий ошибку валидации ответа от сервера.
+ */
+export declare class ValidationError extends HttpClientError {
+    constructor(details: string);
+}
+/**
+ * Класс описывающий ошибку "Плохой запрос".
+ * Это означает, что сервер не понимает запрос из-за неверного синтаксиса.
  */
 export declare class BadRequestError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Не авторизовано"
- * Это означает. что для получения запрашиваемого ответа нужна аутентификация
+ * Класс описывающий ошибку "Не авторизовано".
+ * Это означает. что для получения запрашиваемого ответа нужна аутентификация.
  */
 export declare class UnauthorizedError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Запрещено"
- * Это означает, что у клиента нет прав доступа к содержимому
+ * Класс описывающий ошибку "Запрещено".
+ * Это означает, что у клиента нет прав доступа к содержимому.
  */
 export declare class ForbiddenError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Не найден"
- * Это означает, что сервер не может найти запрашиваемый ресурс
+ * Класс описывающий ошибку "Не найден".
+ * Это означает, что сервер не может найти запрашиваемый ресурс.
  */
 export declare class NotFoundError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Метод не доступен"
- * Это означает, что серверу известен запрос, но он был отключен и не может быть использован
+ * Класс описывающий ошибку "Метод не доступен".
+ * Это означает, что серверу известен запрос, но он был отключен и не может быть использован.
  */
 export declare class MethodNotAllowedError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Медиа формат не поддерживается сервером"
- * Это означает, что сервер не поддерживает медиа формат запрашиваемых данных
+ * Класс описывающий ошибку "Медиа формат не поддерживается сервером".
+ * Это означает, что сервер не поддерживает медиа формат запрашиваемых данных.
  */
 export declare class UnsupportedMediaTypeError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Сервер не может обработать запрос"
- * Это означает, что сервер понимает тип содержимого в теле запроса
- * и синтаксис запроса является корректным, но серверу не удалось обработать инструкции содержимого
+ * Класс описывающий ошибку "Сервер не может обработать запрос".
+ * Это означает, что сервер понимает тип содержимого в теле запроса.
+ * и синтаксис запроса является корректным, но серверу не удалось обработать инструкции содержимого.
  */
 export declare class UnprocessableEntityError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Внутренняя ошибка сервера"
- * Это означает, что сервер столкнулся с ситуацией, которую он не знает как обработать
+ * Класс описывающий ошибку "Внутренняя ошибка сервера".
+ * Это означает, что сервер столкнулся с ситуацией, которую он не знает как обработать.
  */
 export declare class InternalServerError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Плохой шлюз"
- * Это означает, что сервер действует как шлюз шлюз и получил недопустимый ответ
+ * Класс описывающий ошибку "Плохой шлюз".
+ * Это означает, что сервер действует как шлюз и получил недопустимый ответ.
  */
 export declare class BadGatewayError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Сервис недоступен"
- * Это означает, что сервер не готов обрабатывать запрос
+ * Класс описывающий ошибку "Сервис недоступен".
+ * Это означает, что сервер не готов обрабатывать запрос.
  */
 export declare class ServiceUnavailableError extends HttpClientError {
     constructor(details: string);
 }
 /**
- * Класс описывающий ошибку "Вышло время ожидания ответа"
- * Это означает, что сервер действует как шлюз и не может получить ответ вовремя
+ * Класс описывающий ошибку "Вышло время ожидания ответа".
+ * Это означает, что сервер действует как шлюз и не может получить ответ вовремя.
  */
 export declare class GatewayTimeoutError extends HttpClientError {
     constructor(details: string);

package/{lib → dist}/http-client.types.d.ts

@@ -7,8 +7,11 @@ export declare type Config = {
         readonly token: string;
         readonly logout: string;
     };
+    cookie: Omit<CookieAttributes, 'domain'> & {
+        readonly domain: string;
+    };
+    readonly errorMiddleware?: (error: unknown) => Promise<never> | never;
 };
-export declare type CookieOptions = CookieAttributes;
 export declare type GetMethod = 'GET';
 export declare type PostMethod = 'POST';
 export declare type PutMethod = 'PUT';
@@ -19,13 +22,21 @@ export declare type Params = Record<string, string | number> | never;
 export declare type Query = Record<string, Primitives> | URLSearchParams | string | never;
 export declare type Body = Record<string, unknown> | FormData | never;
 export declare type Result = unknown | void;
+export declare type Response<R extends Result> = {
+    readonly result: R;
+    readonly status: number;
+    readonly message: string;
+};
 declare type BaseRequestOptions<M extends Method> = {
     readonly method: M;
     readonly headers?: Record<string, string>;
     readonly withAuthorization: boolean;
     readonly withCredentials?: boolean;
 };
-export declare type Options<M extends Method, P extends Params, Q extends Query, B extends Body> = M extends GetMethod ? [P] extends [never] ? [Q] extends [never] ? BaseRequestOptions<GetMethod> : BaseRequestOptions<GetMethod> & {
+declare type SimpleRequestOptions<R extends Result> = {
+    readonly responseMiddleware?: (response: Response<any>) => R;
+};
+export declare type RequestOptions<M extends Method, P extends Params, Q extends Query, B extends Body> = M extends GetMethod ? [P] extends [never] ? [Q] extends [never] ? BaseRequestOptions<GetMethod> : BaseRequestOptions<GetMethod> & {
     query: Q;
 } : [Q] extends [never] ? BaseRequestOptions<GetMethod> & {
     params: P;
@@ -52,19 +63,15 @@ export declare type Options<M extends Method, P extends Params, Q extends Query,
     query: Q;
     body: B;
 };
-export declare type GetOptions<P extends Params, Q extends Query> = Omit<Options<GetMethod, P, Q, never>, 'method'>;
-export declare type PostOptions<P extends Params, Q extends Query, B extends Body> = Omit<Options<PostMethod, P, Q, B>, 'method'>;
-export declare type PutOptions<P extends Params, Q extends Query, B extends Body> = Omit<Options<PutMethod, P, Q, B>, 'method'>;
-export declare type PatchOptions<P extends Params, Q extends Query, B extends Body> = Omit<Options<PatchMethod, P, Q, B>, 'method'>;
-export declare type DeleteOptions<P extends Params, Q extends Query, B extends Body> = Omit<Options<DeleteMethod, P, Q, B>, 'method'>;
-export declare type Response<R extends Result> = {
-    readonly result: R;
-    readonly status: number;
-    readonly message: string;
-};
+export declare type GetOptions<P extends Params, Q extends Query, R extends Result> = Omit<RequestOptions<GetMethod, P, Q, never>, 'method'> & SimpleRequestOptions<R>;
+export declare type PostOptions<P extends Params, Q extends Query, B extends Body, R extends Result> = Omit<RequestOptions<PostMethod, P, Q, B>, 'method'> & SimpleRequestOptions<R>;
+export declare type PutOptions<P extends Params, Q extends Query, B extends Body, R extends Result> = Omit<RequestOptions<PutMethod, P, Q, B>, 'method'> & SimpleRequestOptions<R>;
+export declare type PatchOptions<P extends Params, Q extends Query, B extends Body, R extends Result> = Omit<RequestOptions<PatchMethod, P, Q, B>, 'method'> & SimpleRequestOptions<R>;
+export declare type DeleteOptions<P extends Params, Q extends Query, B extends Body, R extends Result> = Omit<RequestOptions<DeleteMethod, P, Q, B>, 'method'> & SimpleRequestOptions<R>;
 export declare type Introspect = {
     readonly user_id: string | number;
     readonly username: string | number;
+    readonly is_su?: boolean;
     readonly account_id: string | number;
     readonly expired_at: number;
 };