@pushwoosh/http-client 1.0.1 → 1.0.3

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

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

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

@@ -1,105 +1,105 @@
 /**
- * Класс описывающий ошибку связанную с модулем 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 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);