@pushwoosh/http-client 1.1.2 → 1.2.1

package/README.md

@@ -115,12 +115,9 @@ try {
 `withCredentials` - передавать идентификационные данные в кросс доменных запросах
 
 `response` - ответ от сервера:
+
 ```typescript
-type Response<R extends Result> = {
-  readonly result: R;
-  readonly status: number;
-  readonly message: string;
-};
+type Response<R extends Result> = | ResponseFailure | ResponseSuccess<R>;
 ```
 
 #### GET, POST, PUT, UPDATE, DELETE запросы
@@ -139,7 +136,7 @@ try {
     withCredentials: false,
     responseMiddleware: (response: Response): { some: string } => { // если стандартный middleware для разбора ответа от сервера не подходит
         const jsonResponse = httpClient.baseResponseMiddleware(response);
-        const result = httpClient.baseResponseMiddleware(response);
+        const result = httpClient.baseResponseMiddleware(jsonResponse);
         return result;
     },
   });
@@ -210,7 +207,3 @@ try {
 `ServiceUnavailableError (extends HttpClientError)` - Класс описывающий ошибку "Сервис недоступен"
 
 `GatewayTimeoutError (extends HttpClientError)` - Класс описывающий ошибку "Вышло время ожидания ответа"
-
-#### Ошибки связанные с валидацией ответа:
-
-`ValidationError (extends HttpClientError)` - Класс описывающий ошибку валидации

package/dist/http-client.errors.d.ts

@@ -1,78 +1,85 @@
+import { ResponseDetails } from './http-client.types';
 /**
  * Класс описывающий ошибку связанную с модулем 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);
+    constructor(message: string, status: number);
 }
 /**
  * Класс описывающий внутреннюю ошибку связанную с модулем 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);
+    constructor(message: string);
 }
 /**
  * Класс описывающий ошибку "Плохой запрос".
  * Это означает, что сервер не понимает запрос из-за неверного синтаксиса.
  */
 export declare class BadRequestError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Не авторизовано".
  * Это означает. что для получения запрашиваемого ответа нужна аутентификация.
  */
 export declare class UnauthorizedError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Запрещено".
  * Это означает, что у клиента нет прав доступа к содержимому.
  */
 export declare class ForbiddenError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Не найден".
  * Это означает, что сервер не может найти запрашиваемый ресурс.
  */
 export declare class NotFoundError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Метод не доступен".
  * Это означает, что серверу известен запрос, но он был отключен и не может быть использован.
  */
 export declare class MethodNotAllowedError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Медиа формат не поддерживается сервером".
  * Это означает, что сервер не поддерживает медиа формат запрашиваемых данных.
  */
 export declare class UnsupportedMediaTypeError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Сервер не может обработать запрос".
@@ -80,33 +87,63 @@ export declare class UnsupportedMediaTypeError extends HttpClientError {
  * и синтаксис запроса является корректным, но серверу не удалось обработать инструкции содержимого.
  */
 export declare class UnprocessableEntityError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Внутренняя ошибка сервера".
  * Это означает, что сервер столкнулся с ситуацией, которую он не знает как обработать.
  */
 export declare class InternalServerError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Плохой шлюз".
  * Это означает, что сервер действует как шлюз и получил недопустимый ответ.
  */
 export declare class BadGatewayError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Сервис недоступен".
  * Это означает, что сервер не готов обрабатывать запрос.
  */
 export declare class ServiceUnavailableError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
 }
 /**
  * Класс описывающий ошибку "Вышло время ожидания ответа".
  * Это означает, что сервер действует как шлюз и не может получить ответ вовремя.
  */
 export declare class GatewayTimeoutError extends HttpClientError {
-    constructor(details: string);
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, details?: ResponseDetails);
+}
+/**
+ * Класс описывающий неизвестную ошибку пришедшую с сервера.
+ */
+export declare class UnknownServerError extends HttpClientError {
+    /**
+     * Детали запроса.
+     */
+    readonly details?: ResponseDetails;
+    constructor(message: string, code: number, details?: ResponseDetails);
 }

package/dist/http-client.helpers.d.ts

@@ -0,0 +1,2 @@
+import { Response, ResponseFailure, Result } from './http-client.types';
+export declare function checkIsFailureResponse<R extends Result>(response: Response<R>): response is ResponseFailure;

package/dist/http-client.types.d.ts

@@ -7,7 +7,7 @@ export declare type Config = {
         readonly token: string;
         readonly logout: string;
     };
-    cookie: Omit<CookieAttributes, 'domain'> & {
+    readonly cookie: Omit<CookieAttributes, 'domain'> & {
         readonly domain: string;
     };
     readonly errorMiddleware?: (error: unknown) => Promise<never> | never;
@@ -18,18 +18,58 @@ export declare type PutMethod = 'PUT';
 export declare type PatchMethod = 'PATCH';
 export declare type DeleteMethod = 'DELETE';
 export declare type Method = GetMethod | PutMethod | PostMethod | PatchMethod | DeleteMethod;
+export declare type Headers = Record<string, string>;
 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> = {
+export declare enum ResponseSuccessStatus {
+    OK = 200,
+    CREATED = 201,
+    ACCEPT = 202,
+    NON_CONTENT = 203
+}
+export declare type ResponseDetails = {
+    readonly url: string;
+    readonly method: Method;
+    readonly headers: Headers | undefined;
+    readonly params: any;
+    readonly query: any;
+    readonly body: any;
+    readonly withCredentials: boolean | undefined;
+    readonly withAuthorization: boolean | undefined;
+};
+export declare type ResponseSuccess<R extends Result> = {
     readonly result: R;
-    readonly status: number;
+    readonly status: ResponseSuccessStatus;
     readonly message: string;
+    readonly details?: ResponseDetails;
+};
+export declare enum ResponseFailureStatus {
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    UNPROCESSABLE_ENTITY = 422,
+    INTERNAL_SERVER_ERROR = 500,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504
+}
+export declare type ResponseFailure = {
+    readonly result?: {
+        readonly message?: string;
+    };
+    readonly status: number;
+    readonly message?: string;
+    readonly details: ResponseDetails;
 };
+export declare type Response<R extends Result> = ResponseFailure | ResponseSuccess<R>;
 declare type BaseRequestOptions<M extends Method> = {
     readonly method: M;
-    readonly headers?: Record<string, string>;
+    readonly headers?: Headers;
     readonly withAuthorization: boolean;
     readonly withCredentials?: boolean;
 };

package/dist/index.d.ts

@@ -1,3 +1,4 @@
 export * from './http-client';
 export * from './http-client.errors';
+export * from './http-client.helpers';
 export * from './http-client.types';