@hyperttp/core 1.3.0 → 1.3.3

package/Core/HyperCore.d.ts

@@ -1,61 +1,238 @@
 import type { IHyperCore, HyperTransport, HttpClientOptions, HyperPlugin, InternalRequest, HttpResponse, RequestInterface, StreamResponse, RequestBodyData } from "@hyperttp/types";
+/**
+ * @ru Основной класс HTTP-клиента с поддержкой плагинов, потоковой передачи, кэширования URL и гибкой настройки.
+ * @en Core HTTP client class with plugin support, streaming, URL caching and flexible configuration.
+ * @implements {IHyperCore}
+ */
 export declare class HyperCore implements IHyperCore {
+    /**
+     * @ru Активная конфигурация клиента (объединена с настройками по умолчанию).
+     * @en Current client configuration (merged with default settings).
+     */
     config: HttpClientOptions;
     private readonly transportManager;
     private readonly defaultHeaders;
     private readonly pluginCtx;
     private readonly pipelines;
+    /**
+     * @ru Создаёт экземпляр HyperCore.
+     * @en Creates a HyperCore instance.
+     * @param config - Client configuration (overrides defaults).
+     * @param transport - Optional transport layer (auto‑selected if omitted).
+     */
     constructor(config?: HttpClientOptions, transport?: HyperTransport);
+    /**
+     * @ru Возвращает текущий транспортный экземпляр (или null, если он ещё не инициализирован).
+     * @en Returns the current transport instance (or null if not yet initialized).
+     */
     private get transport();
+    getTransportName(): Promise<string>;
+    /**
+     * @ru Гарантирует наличие готового к работе транспорта (асинхронная инициализация при необходимости).
+     * @en Ensures a ready‑to‑use transport (async initialization if needed).
+     * @returns Promise resolving to a transport instance.
+     */
     private ensureTransport;
     /**
-     * Центральный метод обработки запросов
+     * @ru Внутренний метод диспетчеризации запроса, обрабатывающий как обычные, так и стриминговые ответы.
+     * @en Internal request dispatcher handling both regular and streaming responses.
+     * @param req - Internal request object.
+     * @returns Promise resolving to a response (HttpResponse or StreamResponse).
      */
     private dispatchInternal;
+    /**
+     * @ru Отправляет HTTP-запрос и возвращает обычный (нестриминговый) ответ.
+     * @en Sends an HTTP request and returns a regular (non‑streaming) response.
+     * @param req - Internal request object.
+     * @returns Promise resolving to a typed HTTP response.
+     */
     dispatch<T = unknown>(req: InternalRequest): Promise<HttpResponse<T>>;
     /**
-     * Регистрация плагинов
+     * @ru Регистрирует плагин в клиенте. Плагин может добавлять хуки на различных этапах обработки запроса/ответа.
+     * @en Registers a plugin with the client. The plugin can add hooks at various request/response processing stages.
+     * @param plugin - Plugin instance to register.
+     * @returns This instance for chaining.
      */
     use(plugin: HyperPlugin): this;
     /**
-     * Публичные HTTP методы-помощники
+     * @ru Выполняет GET-запрос с потоковым ответом.
+     * @en Performs a GET request with a streaming response.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to a StreamResponse.
      */
     stream(req: RequestInterface | string, signal?: AbortSignal): Promise<StreamResponse<unknown>>;
+    /**
+     * @ru Выполняет POST-запрос с потоковым ответом.
+     * @en Performs a POST request with a streaming response.
+     * @param req - Request URL or configuration object.
+     * @param body - Request body data.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to a StreamResponse.
+     */
     postStream<T = unknown>(req: RequestInterface | string, body?: RequestBodyData, signal?: AbortSignal): Promise<StreamResponse<T>>;
+    /**
+     * @ru Выполняет GET-запрос.
+     * @en Performs a GET request.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse.
+     */
     get<T = unknown>(req: RequestInterface | string, signal?: AbortSignal): Promise<HttpResponse<T>>;
+    /**
+     * @ru Выполняет POST-запрос.
+     * @en Performs a POST request.
+     * @param req - Request URL or configuration object.
+     * @param body - Request body data.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse.
+     */
     post<T = unknown>(req: RequestInterface | string, body?: RequestBodyData, signal?: AbortSignal): Promise<HttpResponse<T>>;
+    /**
+     * @ru Выполняет PUT-запрос.
+     * @en Performs a PUT request.
+     * @param req - Request URL or configuration object.
+     * @param body - Request body data.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse.
+     */
     put<T = unknown>(req: RequestInterface | string, body?: RequestBodyData, signal?: AbortSignal): Promise<HttpResponse<T>>;
+    /**
+     * @ru Выполняет PATCH-запрос.
+     * @en Performs a PATCH request.
+     * @param req - Request URL or configuration object.
+     * @param body - Request body data.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse.
+     */
     patch<T = unknown>(req: RequestInterface | string, body?: RequestBodyData, signal?: AbortSignal): Promise<HttpResponse<T>>;
+    /**
+     * @ru Выполняет DELETE-запрос.
+     * @en Performs a DELETE request.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse.
+     */
     delete<T = unknown>(req: RequestInterface | string, signal?: AbortSignal): Promise<HttpResponse<T>>;
+    /**
+     * @ru Выполняет OPTIONS-запрос.
+     * @en Performs an OPTIONS request.
+     * @param req - Request URL or configuration object.
+     * @param body - Request body data.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse.
+     */
     options<T = unknown>(req: RequestInterface | string, body?: RequestBodyData, signal?: AbortSignal): Promise<HttpResponse<T>>;
+    /**
+     * @ru Выполняет HEAD-запрос.
+     * @en Performs a HEAD request.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to an HttpResponse with null body.
+     */
     head(req: RequestInterface | string, signal?: AbortSignal): Promise<HttpResponse<null>>;
+    /**
+     * @ru Создаёт новый экземпляр HyperCore путём расширения текущей конфигурации.
+     * @en Creates a new HyperCore instance by extending the current configuration.
+     * @param options - Partial configuration overrides.
+     * @returns New HyperCore instance.
+     */
     extend(options: Partial<HttpClientOptions>): HyperCore;
+    /**
+     * @ru Алиас для {@link extend}. Создаёт новый экземпляр с переопределёнными опциями.
+     * @en Alias for {@link extend}. Creates a new instance with overridden options.
+     * @param options - Partial configuration overrides.
+     * @returns New HyperCore instance.
+     */
     create(options: Partial<HttpClientOptions>): HyperCore;
+    /**
+     * @ru Завершает работу клиента: закрывает транспортные соединения.
+     * @en Shuts down the client: closes transport connections.
+     * @param graceful - If true, attempts graceful shutdown (waiting for pending requests).
+     * @returns Promise that resolves when shutdown is complete.
+     */
     destroy(graceful?: boolean): Promise<void>;
+    /**
+     * @ru Выполняет запрос и возвращает распарсенный JSON-ответ.
+     * @en Performs a request and returns parsed JSON response.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to the parsed JSON value.
+     * @throws If response body cannot be parsed as JSON.
+     */
     json<T = unknown>(req: RequestInterface | string, signal?: AbortSignal): Promise<T>;
+    /**
+     * @ru Выполняет запрос и возвращает ответ в виде текста.
+     * @en Performs a request and returns response as text.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise resolving to the response body as string.
+     * @throws If response body cannot be read as text.
+     */
     text(req: RequestInterface | string, signal?: AbortSignal): Promise<string>;
+    /**
+     * @ru Выполняет запрос и полностью потребляет тело ответа (без обработки).
+     * @en Performs a request and fully consumes the response body (no processing).
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal to cancel the request.
+     * @returns Promise that resolves when response body is drained.
+     */
     dump(req: RequestInterface | string, signal?: AbortSignal): Promise<void>;
     /**
-     * ПРИВАТНЫЕ МЕТОДЫ-ПОМОЩНИКИ (РЕФАКТОРИНГ)
+     * @ru Выполняет пайплайн обработки ответа (мутаторы и сайд-эффекты).
+     * @en Executes response processing pipeline (mutators and side effects).
+     * @param response - Response object (HttpResponse or StreamResponse).
+     * @param req - Original internal request.
      */
     private runResponsePipeline;
     /**
-     * Изолированная обработка ошибок пайплайна ответа
+     * @ru Обрабатывает ошибки, возникшие при выполнении запроса, с учётом пайплайна ошибок.
+     * @en Handles errors occurring during request execution, considering the error pipeline.
+     * @param error - The caught error.
+     * @param req - Internal request that caused the error.
+     * @returns If recovered, returns a response; otherwise throws the error.
+     * @throws The original error if no plugin recovers it.
      */
     private handleDispatchError;
     /**
-     * Применение встроенной декомпрессии на основе заголовков ответа транспорта
+     * @ru Применяет декомпрессию к телу ответа в зависимости от заголовка Content-Encoding.
+     * @en Applies decompression to the response body based on the Content-Encoding header.
+     * @param rawResponse - Raw transport response object (mutated in place).
      */
     private applyDecompression;
     /**
-     * Сборка внутреннего объекта запроса InternalRequest
+     * @ru Строит внутренний объект запроса на основе пользовательских параметров.
+     * @en Builds an internal request object from user parameters.
+     * @param method - HTTP method.
+     * @param req - Request URL or configuration object.
+     * @param body - Request body (optional).
+     * @param signal - AbortSignal (optional).
+     * @returns Fully constructed InternalRequest.
+     * @throws If URL is undefined or invalid.
      */
     private buildInternalRequest;
     /**
-     * Фабрика сохранения прототипа исходного запроса с подменой дескрипторов базовых свойств
+     * @ru Создаёт объект запроса, сохраняя прототип исходного объекта (если есть).
+     * @en Creates a request object preserving the prototype of the source object (if any).
+     * @param source - Original request object (may have a custom prototype).
+     * @param overrides - Properties to override or add.
+     * @returns New object with merged properties and inherited prototype.
      */
     private createInternalRequestObject;
+    /**
+     * @ru Добавляет параметры запроса к URL-объекту.
+     * @en Appends query parameters to a URL object.
+     * @param url - URL object to mutate.
+     * @param query - Record of query parameters (supports arrays).
+     */
     private appendQueryParams;
+    /**
+     * @ru Упрощённый метод для текстовых/JSON-запросов, определяющий метод из объекта запроса.
+     * @en Shortcut method for text/JSON requests, determining method from the request object.
+     * @param req - Request URL or configuration object.
+     * @param signal - Optional AbortSignal.
+     * @returns Promise resolving to HttpResponse.
+     */
     private dispatchShortcut;
 }
 //# sourceMappingURL=HyperCore.d.ts.map

package/Core/HyperCore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HyperCore.d.ts","sourceRoot":"","sources":["../../src/Core/HyperCore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,iBAAiB,EAEjB,WAAW,EACX,eAAe,EACf,YAAY,EAEZ,gBAAgB,EAChB,cAAc,EACd,eAAe,EAEhB,MAAM,iBAAiB,CAAC;AA4BzB,qBAAa,SAAU,YAAW,UAAU;IACnC,MAAM,EAAE,iBAAiB,CAAC;IACjC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IACpD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAoC;IACnE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;gBAG7C,MAAM,GAAE,iBAAiC,EACzC,SAAS,CAAC,EAAE,cAAc;IAoB5B,OAAO,KAAK,SAAS,GAEpB;IAED,OAAO,CAAC,eAAe;IAIvB;;OAEG;YACW,gBAAgB;IA4CjB,QAAQ,CAAC,CAAC,GAAG,OAAO,EAC/B,GAAG,EAAE,eAAe,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI3B;;OAEG;IACI,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IA+CrC;;OAEG;IACU,MAAM,CACjB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAatB,UAAU,CAAC,CAAC,GAAG,OAAO,EACjC,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAMtB,GAAG,CAAC,CAAC,GAAG,OAAO,EACpB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMpB,IAAI,CAAC,CAAC,GAAG,OAAO,EACrB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMpB,GAAG,CAAC,CAAC,GAAG,OAAO,EACpB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMpB,KAAK,CAAC,CAAC,GAAG,OAAO,EACtB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMpB,MAAM,CAAC,CAAC,GAAG,OAAO,EACvB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMpB,OAAO,CAAC,CAAC,GAAG,OAAO,EACxB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAMpB,IAAI,CACT,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAMvB,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,SAAS;IAWtD,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,SAAS;IAIhD,OAAO,CAAC,QAAQ,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAIvC,IAAI,CAAC,CAAC,GAAG,OAAO,EAC3B,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,CAAC,CAAC;IASA,IAAI,CACf,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC;IASL,IAAI,CACf,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC;IAShB;;OAEG;YAEW,mBAAmB;IAmBjC;;OAEG;YACW,mBAAmB;IAmBjC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA2B1B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAsE5B;;OAEG;IACH,OAAO,CAAC,2BAA2B;IA2BnC,OAAO,CAAC,iBAAiB;YAiBX,gBAAgB;CAc/B"}
+{"version":3,"file":"HyperCore.d.ts","sourceRoot":"","sources":["../../src/Core/HyperCore.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,UAAU,EACV,cAAc,EACd,iBAAiB,EAEjB,WAAW,EACX,eAAe,EACf,YAAY,EAEZ,gBAAgB,EAChB,cAAc,EACd,eAAe,EAEhB,MAAM,iBAAiB,CAAC;AAwCzB;;;;GAIG;AACH,qBAAa,SAAU,YAAW,UAAU;IAC1C;;;OAGG;IACI,MAAM,EAAE,iBAAiB,CAAC;IAEjC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAmB;IACpD,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAoC;IACnE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAgB;IAC1C,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAqB;IAE/C;;;;;OAKG;gBAED,MAAM,GAAE,iBAAiC,EACzC,SAAS,CAAC,EAAE,cAAc;IAoB5B;;;OAGG;IACH,OAAO,KAAK,SAAS,GAEpB;IAEY,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC;IAKhD;;;;OAIG;IACH,OAAO,CAAC,eAAe;IAIvB;;;;;OAKG;YACW,gBAAgB;IA6C9B;;;;;OAKG;IACU,QAAQ,CAAC,CAAC,GAAG,OAAO,EAC/B,GAAG,EAAE,eAAe,GACnB,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;IAI3B;;;;;OAKG;IACI,GAAG,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAgDrC;;;;;;OAMG;IACU,MAAM,CACjB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IAcnC;;;;;;;OAOG;IACU,UAAU,CAAC,CAAC,GAAG,OAAO,EACjC,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;IAO7B;;;;;;OAMG;IACI,GAAG,CAAC,CAAC,GAAG,OAAO,EACpB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW;IAOtB;;;;;;;OAOG;IACI,IAAI,CAAC,CAAC,GAAG,OAAO,EACrB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW;IAOtB;;;;;;;OAOG;IACI,GAAG,CAAC,CAAC,GAAG,OAAO,EACpB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW;IAOtB;;;;;;;OAOG;IACI,KAAK,CAAC,CAAC,GAAG,OAAO,EACtB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW;IAOtB;;;;;;OAMG;IACI,MAAM,CAAC,CAAC,GAAG,OAAO,EACvB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW;IAOtB;;;;;;;OAOG;IACI,OAAO,CAAC,CAAC,GAAG,OAAO,EACxB,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,IAAI,CAAC,EAAE,eAAe,EACtB,MAAM,CAAC,EAAE,WAAW;IAOtB;;;;;;OAMG;IACI,IAAI,CAAC,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAAE,MAAM,CAAC,EAAE,WAAW;IAMhE;;;;;OAKG;IACI,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,SAAS;IAW7D;;;;;OAKG;IACI,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,SAAS;IAI7D;;;;;OAKG;IACU,OAAO,CAAC,QAAQ,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAIpD;;;;;;;OAOG;IACU,IAAI,CAAC,CAAC,GAAG,OAAO,EAC3B,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,CAAC,CAAC;IAKb;;;;;;;OAOG;IACU,IAAI,CACf,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,MAAM,CAAC;IAKlB;;;;;;OAMG;IACU,IAAI,CACf,GAAG,EAAE,gBAAgB,GAAG,MAAM,EAC9B,MAAM,CAAC,EAAE,WAAW,GACnB,OAAO,CAAC,IAAI,CAAC;IAKhB;;;;;OAKG;YACW,mBAAmB;IAmBjC;;;;;;;OAOG;YACW,mBAAmB;IAkBjC;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAgB1B;;;;;;;;;OASG;IACH,OAAO,CAAC,oBAAoB;IA2D5B;;;;;;OAMG;IACH,OAAO,CAAC,2BAA2B;IAQnC;;;;;OAKG;IACH,OAAO,CAAC,iBAAiB;IAezB;;;;;;OAMG;YACW,gBAAgB;CAW/B"}