@hyperttp/parser 1.0.2 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,13 +1,10 @@
1
1
  {
2
2
  "name": "@hyperttp/parser",
3
- "version": "1.0.2",
3
+ "version": "1.0.9",
4
4
  "description": "Automated response parsing and content conversion plugin for Hyperttp client",
5
5
  "type": "module",
6
- "main": "./dist/index.js",
7
- "types": "./dist/index.d.ts",
8
- "files": [
9
- "dist"
10
- ],
6
+ "main": "./index.js",
7
+ "types": "./index.d.ts",
11
8
  "keywords": [
12
9
  "hyperttp"
13
10
  ],
@@ -26,4 +23,4 @@
26
23
  "fast-xml-builder": "^1.2.0",
27
24
  "fast-xml-parser": "^5.8.0"
28
25
  }
29
- }
26
+ }
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EAGZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAGpE,wBAAgB,UAAU,CACxB,MAAM,EAAE,SAAS,EACjB,OAAO,CAAC,EAAE,wBAAwB,GACjC,SAAS,CAsEX;AAED,OAAO,QAAQ,gBAAgB,CAAC;IAC9B,UAAU,wBAAwB;QAChC,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;KAC9C;CACF;AAED,eAAO,MAAM,YAAY,EAAE,WAM1B,CAAC"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,WAAW,EAGZ,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAGpE,wBAAgB,UAAU,CACxB,MAAM,EAAE,SAAS,EACjB,OAAO,CAAC,EAAE,wBAAwB,GACjC,SAAS,CAiEX;AAED,OAAO,QAAQ,gBAAgB,CAAC;IAC9B,UAAU,wBAAwB;QAChC,iBAAiB,CAAC,EAAE,wBAAwB,CAAC;KAC9C;CACF;AAED,eAAO,MAAM,YAAY,EAAE,WAM1B,CAAC"}
@@ -2,6 +2,18 @@ import { ResponseConverter } from "./utils/ResponseConverter.js";
2
2
  export function withParser(client, options) {
3
3
  const next = client.dispatch.bind(client);
4
4
  const converter = new ResponseConverter(options);
5
+ const safeDestroy = (body) => {
6
+ if (!body)
7
+ return;
8
+ if (typeof body.on === "function")
9
+ body.on("error", () => { });
10
+ if (typeof body.cancel === "function") {
11
+ body.cancel().catch(() => { });
12
+ }
13
+ else if (typeof body.destroy === "function") {
14
+ body.destroy();
15
+ }
16
+ };
5
17
  client.dispatch = async (req) => {
6
18
  const responseType = req.meta?.responseType || "auto";
7
19
  if (req.method === "HEAD" ||
@@ -10,35 +22,17 @@ export function withParser(client, options) {
10
22
  return next(req);
11
23
  }
12
24
  const rawResponse = await next(req);
13
- if (!rawResponse ||
14
- rawResponse.body === undefined ||
15
- rawResponse.body === null) {
25
+ if (!rawResponse?.body) {
16
26
  return rawResponse;
17
27
  }
28
+ safeDestroy(rawResponse.body);
18
29
  if (rawResponse.status && rawResponse.status >= 400) {
19
- if (typeof rawResponse.body.cancel === "function") {
20
- await rawResponse.body.cancel().catch(() => { });
21
- }
22
- else if (typeof rawResponse.body.destroy === "function") {
23
- rawResponse.body.destroy();
24
- }
25
- else {
26
- await converter.readBody(rawResponse.body).catch(() => { });
27
- }
28
30
  return rawResponse;
29
31
  }
30
32
  const { headers, body } = rawResponse;
31
33
  const isLogging = req.meta?.trackTimings;
32
34
  const start = isLogging ? process.hrtime.bigint() : 0n;
33
- let bufferBody;
34
- try {
35
- bufferBody = await converter.readBody(body);
36
- }
37
- catch (readError) {
38
- if (typeof body.cancel === "function")
39
- await body.cancel().catch(() => { });
40
- throw readError;
41
- }
35
+ const bufferBody = await converter.readBody(body);
42
36
  const currentUrl = (rawResponse.url || req.url);
43
37
  const parsedData = await converter.convert(bufferBody, responseType, {
44
38
  contentType: headers["content-type"] || headers["Content-Type"],
package/plugin.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,MAAM,UAAU,UAAU,CACxB,MAAiB,EACjB,OAAkC;IAElC,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEjD,MAAM,WAAW,GAAG,CAAC,IAAS,EAAE,EAAE;QAChC,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,UAAU;YAAE,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAE9D,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;YACtC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;QAChC,CAAC;aAAM,IAAI,OAAO,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YAC9C,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC;IACH,CAAC,CAAC;IAEF,MAAM,CAAC,QAAQ,GAAG,KAAK,EAAW,GAAoB,EAAc,EAAE;QACpE,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,EAAE,YAAY,IAAI,MAAM,CAAC;QAEtD,IACE,GAAG,CAAC,MAAM,KAAK,MAAM;YACrB,YAAY,KAAK,QAAQ;YACzB,YAAY,KAAK,QAAQ,EACzB,CAAC;YACD,OAAO,IAAI,CAAC,GAAG,CAAM,CAAC;QACxB,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAM,GAAG,CAAC,CAAC;QAEzC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC;YACvB,OAAO,WAAgB,CAAC;QAC1B,CAAC;QAED,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QAE9B,IAAI,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACpD,OAAO,WAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QACtC,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC;QACzC,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEvD,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAElD,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAuB,CAAC;QAEtE,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE;YACnE,WAAW,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,cAAc,CAAC;YAC/D,eAAe,EACb,OAAO,CAAC,kBAAkB,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC;YAC5D,GAAG,EAAE,UAAU;SAChB,CAAC,CAAC;QAEH,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1B,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;YAC1C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC;QACzD,CAAC;QAED,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC;QAC9B,OAAO,WAAgB,CAAC;IAC1B,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAQD,MAAM,CAAC,MAAM,YAAY,GAAgB;IACvC,IAAI,EAAE,iBAAiB;IACvB,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI;IACnB,KAAK,EAAE,CAAC,MAAiB,EAAE,MAAyB,EAAE,EAAE,CACtD,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,iBAAiB,CAAC;CAC/C,CAAC"}
package/LICENSE DELETED
@@ -1,21 +0,0 @@
1
- MIT License
2
-
3
- Copyright (c) 2026 IT IF OR
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
package/README.md DELETED
@@ -1,109 +0,0 @@
1
- # @hyperttp/parser
2
-
3
- Официальный плагин автоматического парсинга и
4
- конвертации ответов для HTTP-клиента **Hyperttp**.
5
- Работает на фазе `FORMAT`, вычитывает входящий поток данных (body stream) и
6
- преобразует его в JavaScript-объекты, XML, строки или
7
- полноценные DOM-деревья Cheerio на основе заголовков `Content-Type` или
8
- параметра `responseType`.
9
-
10
- ## Особенности
11
-
12
- - 🤖 **Автоматическое определение (`auto`)**:
13
- Самостоятельно распознает форматы `JSON`, `XML` и `Text`,
14
- избавляя от необходимости вызывать `.json()` вручную.
15
- - 🦅 **Интеграция с Cheerio**:
16
- При получении HTML-страниц автоматически оборачивает тело ответа в
17
- инстанс `cheerio`,
18
- позволяя сразу выполнять jQuery-подобные запросы для парсинга и скрейпинга.
19
- - ⏱️ **Метрики производительности**: Точно замеряет время,
20
- затраченное на десериализацию данных, и
21
- сохраняет результат в `req.meta.timings.parsingMs` (при включенном `trackTimings`).
22
- - 🧹 **Безопасная очистка (Stream Cleanup)**:
23
- В случае ответов с ошибками (HTTP Status >= 400) или
24
- сбоев вычитки плагин корректно закрывает/вызывает `cancel()` / `destroy()` у
25
- нативных стримов, предотвращая утечки памяти.
26
-
27
- ## Установка
28
-
29
- ```bash
30
- # С использованием bun
31
- bun add @hyperttp/parser
32
-
33
- # С использованием npm/pnpm
34
- npm install @hyperttp/parser
35
-
36
- ```
37
-
38
- ## Использование
39
-
40
- Плагин автоматически активируется на фазе `FORMAT` для всех типов запросов,
41
- кроме `HEAD`, `buffer` и `stream`.
42
-
43
- ### Базовый пример
44
-
45
- ```typescript
46
- import { HyperClient } from "@hyperttp/core";
47
- import "@hyperttp/parser"; // Подключение расширения типов HttpClientOptions
48
-
49
- const client = new HyperClient({
50
- responseConverter: {
51
- // Опции конфигурации парсера (передаются в экземпляр ResponseConverter)
52
- charset: "utf-8"
53
- }
54
- });
55
-
56
- // 1. Автоматический парсинг JSON
57
- const jsonResult = await client.get<{ id: number }>("https://api.example.com/user/1");
58
- console.log(jsonResult.id);
59
-
60
- // 2. Автоматический парсинг HTML в Cheerio
61
- const $ = await client.get<any>("https://example.com/page", {
62
- meta: { responseType: "html" }
63
- });
64
- const pageTitle = $("head title").text();
65
-
66
- ```
67
-
68
- ### Мониторинг времени парсинга
69
-
70
- Если активирован трекинг таймингов, плагин обогатит объект `meta`:
71
-
72
- ```typescript
73
- const req = {
74
- url: "[https://api.example.com/heavy-data](https://api.example.com/heavy-data)",
75
- method: "GET",
76
- meta: { trackTimings: true }
77
- };
78
-
79
- const data = await client.execute(req);
80
- console.log(Время парсинга: ${req.meta.timings?.parsingMs} ms);
81
-
82
- ```
83
-
84
- ## Как это работает (Архитектура)
85
-
86
- Плагин перехватывает управление в момент возврата ответа из сети на фазе **`FORMAT`**:
87
-
88
- ```mermaid
89
- graph TD
90
- Net[Ответ из сети NETWORK] --> Hook[Фаза FORMAT]
91
- Hook --> CheckType{Тип ответа HEAD, buffer или stream?}
92
-
93
- CheckType -- Да --> Bypass[Пропустить без изменений] --> Return[Возврат пользователю]
94
- CheckType -- Нет --> CheckStatus{Status >= 400?}
95
-
96
- CheckStatus -- Да --> Clean[Очистка/Закрытие Стрима] --> Return
97
- CheckStatus -- Нет --> Read[Вычитка потока данных в буфер]
98
-
99
- Read --> Convert[Конвертация: JSON / XML / Cheerio / Text]
100
- Convert --> Track{trackTimings === true?}
101
-
102
- Track -- Да --> Calc[Вычисление parsingMs] --> Return
103
- Track -- Нет --> Return
104
-
105
- ```
106
-
107
- ## Лицензия
108
-
109
- MIT © dirold2
@@ -1 +0,0 @@
1
- {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAEjE,MAAM,UAAU,UAAU,CACxB,MAAiB,EACjB,OAAkC;IAElC,MAAM,IAAI,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1C,MAAM,SAAS,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEjD,MAAM,CAAC,QAAQ,GAAG,KAAK,EAAW,GAAoB,EAAc,EAAE;QACpE,MAAM,YAAY,GAAG,GAAG,CAAC,IAAI,EAAE,YAAY,IAAI,MAAM,CAAC;QAEtD,IACE,GAAG,CAAC,MAAM,KAAK,MAAM;YACrB,YAAY,KAAK,QAAQ;YACzB,YAAY,KAAK,QAAQ,EACzB,CAAC;YACD,OAAO,IAAI,CAAC,GAAG,CAAM,CAAC;QACxB,CAAC;QAED,MAAM,WAAW,GAAG,MAAM,IAAI,CAAM,GAAG,CAAC,CAAC;QAEzC,IACE,CAAC,WAAW;YACZ,WAAW,CAAC,IAAI,KAAK,SAAS;YAC9B,WAAW,CAAC,IAAI,KAAK,IAAI,EACzB,CAAC;YACD,OAAO,WAAgB,CAAC;QAC1B,CAAC;QAED,IAAI,WAAW,CAAC,MAAM,IAAI,WAAW,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;YACpD,IAAI,OAAO,WAAW,CAAC,IAAI,CAAC,MAAM,KAAK,UAAU,EAAE,CAAC;gBAClD,MAAM,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAClD,CAAC;iBAAM,IAAI,OAAO,WAAW,CAAC,IAAI,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;gBAC1D,WAAW,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAC7B,CAAC;iBAAM,CAAC;gBACN,MAAM,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YAC7D,CAAC;YACD,OAAO,WAAgB,CAAC;QAC1B,CAAC;QAED,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;QACtC,MAAM,SAAS,GAAG,GAAG,CAAC,IAAI,EAAE,YAAY,CAAC;QACzC,MAAM,KAAK,GAAG,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAEvD,IAAI,UAAe,CAAC;QACpB,IAAI,CAAC;YACH,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC9C,CAAC;QAAC,OAAO,SAAS,EAAE,CAAC;YACnB,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,UAAU;gBACnC,MAAM,IAAI,CAAC,MAAM,EAAE,CAAC,KAAK,CAAC,GAAG,EAAE,GAAE,CAAC,CAAC,CAAC;YACtC,MAAM,SAAS,CAAC;QAClB,CAAC;QAED,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,GAAG,IAAI,GAAG,CAAC,GAAG,CAAuB,CAAC;QAEtE,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,UAAU,EAAE,YAAY,EAAE;YACnE,WAAW,EAAE,OAAO,CAAC,cAAc,CAAC,IAAI,OAAO,CAAC,cAAc,CAAC;YAC/D,eAAe,EACb,OAAO,CAAC,kBAAkB,CAAC,IAAI,OAAO,CAAC,kBAAkB,CAAC;YAC5D,GAAG,EAAE,UAAU;SAChB,CAAC,CAAC;QAEH,IAAI,SAAS,EAAE,CAAC;YACd,MAAM,GAAG,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC;YACpC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,IAAI,IAAI,EAAE,CAAC;YAC1B,GAAG,CAAC,IAAI,CAAC,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CAAC;YAC1C,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,SAAS,GAAG,MAAM,CAAC,GAAG,GAAG,KAAK,CAAC,GAAG,GAAG,CAAC;QACzD,CAAC;QAED,WAAW,CAAC,IAAI,GAAG,UAAU,CAAC;QAC9B,OAAO,WAAgB,CAAC;IAC1B,CAAC,CAAC;IAEF,OAAO,MAAM,CAAC;AAChB,CAAC;AAQD,MAAM,CAAC,MAAM,YAAY,GAAgB;IACvC,IAAI,EAAE,iBAAiB;IACvB,KAAK,EAAE,QAAQ;IACf,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI;IACnB,KAAK,EAAE,CAAC,MAAiB,EAAE,MAAyB,EAAE,EAAE,CACtD,UAAU,CAAC,MAAM,EAAE,MAAM,CAAC,iBAAiB,CAAC;CAC/C,CAAC"}
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes