@pushwoosh/http-client 1.0.3 → 1.1.0

package/dist/http-client.d.ts

@@ -1,21 +1,23 @@
-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> {
+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.
      */
-    private static STORIED_AUTHORIZATION_STATE_COOKIE_NAME;
+    static STORIED_AUTHORIZATION_STATE_COOKIE_NAME: string;
     /**
-     * Имя куки в которой будет сохранен текущий адрес страницы.
+     * Имя куки в которой будет сохранен полный текущий адрес страницы.
      */
-    private static STORIED_URL_COOKIE_NAME;
+    static STORIED_URL_COOKIE_NAME: string;
     /**
-     * Параметры конфигурации.
+     * Библиотека для управления навигацией.
      */
-    private readonly config;
+    private readonly history;
     /**
-     * Параметры куки.
+     * Параметры конфигурации.
      */
-    private readonly cookieOptions;
+    private readonly config;
     /**
      * Токен доступа.
      */
@@ -32,13 +34,13 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * Был ли установлен токен доступа вручную.
      */
     private isAccessTokenSetManual;
-    constructor(config: Config, cookieOptions?: CookieOptions);
+    constructor(history: History, config: Config);
     /**
      * Разобрать ответ от сервера, и вернуть результат выполнения запроса.
      *
-     * @param { Response<*> } response - ответ от сервера в формате Axios.
+     * @param { Response<*> } response - ответ от сервера.
      */
-    static parseResponse<R extends Result>(response: Response<R>): R;
+    basicResponseMiddleware: <R extends unknown>(response: Response<R>) => R;
     /**
      * Проверить наличие авторизации.
      */
@@ -71,23 +73,23 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @param { string } authorizationCode - код авторизации, полученный от сервера авторизации.
      * @param { string } authorizationState - уникальная строка, переданная клиентом серверу при авторизации, полученная от сервера авторизации.
      */
-    initialize(authorizationCode: string | null, authorizationState: string | null): Promise<I | null>;
+    initialize: (authorizationCode: string | null, authorizationState: string | null) => Promise<Introspect | null>;
     /**
      * Начать сессию.
      */
-    login(): Promise<void>;
+    login: () => Promise<void>;
     /**
      * Завершить сессию.
      */
-    logout(): Promise<void>;
+    logout: () => Promise<void>;
     /**
      * Временный костыль, чтобы установить токен доступа из сессии.
      */
-    setAccessToken(accessToken: string): void;
+    setAccessToken: (accessToken: string) => void;
     /**
      * Получить токен доступа, если время жизни токена закончилось, будет осуществлена попытка обновить токен.
      */
-    getAccessToken(): Promise<string>;
+    getAccessToken: () => Promise<string>;
     /**
      * Выполнить запрос на сервер.
      *
@@ -101,7 +103,7 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @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>>;
+    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 запрос на сервер.
      *
@@ -113,7 +115,7 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @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>;
+    get: <P extends Record<string, string | number>, Q extends Query, R extends unknown>(url: string, options: GetOptions<P, Q, R>) => Promise<R>;
     /**
      * Выполнить POST запрос на сервер.
      *
@@ -126,7 +128,7 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @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>;
+    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 запрос на сервер.
      *
@@ -139,7 +141,7 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @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>;
+    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 запрос на сервер.
      *
@@ -152,7 +154,7 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @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>;
+    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 запрос на сервер.
      *
@@ -165,5 +167,5 @@ export declare class HttpClient<I extends Introspect = Introspect> {
      * @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>;
+    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/dist/http-client.errors.d.ts

@@ -26,6 +26,12 @@ export declare class InternalError extends HttpClientError {
 export declare class UnknownError extends HttpClientError {
     constructor(code: number, details: string);
 }
+/**
+ * Класс описывающий ошибку валидации ответа от сервера.
+ */
+export declare class ValidationError extends HttpClientError {
+    constructor(details: string);
+}
 /**
  * Класс описывающий ошибку "Плохой запрос".
  * Это означает, что сервер не понимает запрос из-за неверного синтаксиса.

package/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;
 };