typizer 0.0.0-stage → 0.1.0
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/LICENSE +21 -0
- package/README.md +222 -2
- package/dist/gen/client/client.gen.d.ts +2 -0
- package/dist/gen/client/client.gen.js +216 -0
- package/dist/gen/client/index.d.ts +10 -0
- package/dist/gen/client/index.js +6 -0
- package/dist/gen/client/types.gen.d.ts +120 -0
- package/dist/gen/client/types.gen.js +2 -0
- package/dist/gen/client/utils.gen.d.ts +37 -0
- package/dist/gen/client/utils.gen.js +228 -0
- package/dist/gen/client.gen.d.ts +12 -0
- package/dist/gen/client.gen.js +3 -0
- package/dist/gen/core/auth.gen.d.ts +25 -0
- package/dist/gen/core/auth.gen.js +14 -0
- package/dist/gen/core/bodySerializer.gen.d.ts +25 -0
- package/dist/gen/core/bodySerializer.gen.js +57 -0
- package/dist/gen/core/params.gen.d.ts +43 -0
- package/dist/gen/core/params.gen.js +109 -0
- package/dist/gen/core/pathSerializer.gen.d.ts +33 -0
- package/dist/gen/core/pathSerializer.gen.js +106 -0
- package/dist/gen/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/gen/core/queryKeySerializer.gen.js +92 -0
- package/dist/gen/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/gen/core/serverSentEvents.gen.js +132 -0
- package/dist/gen/core/types.gen.d.ts +83 -0
- package/dist/gen/core/types.gen.js +2 -0
- package/dist/gen/core/utils.gen.d.ts +19 -0
- package/dist/gen/core/utils.gen.js +87 -0
- package/dist/gen/index.d.ts +2 -0
- package/dist/gen/index.js +2 -0
- package/dist/gen/sdk.gen.d.ts +540 -0
- package/dist/gen/sdk.gen.js +1130 -0
- package/dist/gen/types.gen.d.ts +4741 -0
- package/dist/gen/types.gen.js +2 -0
- package/dist/index.d.ts +20 -0
- package/dist/index.js +17 -0
- package/package.json +52 -3
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Typizer
|
|
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
CHANGED
|
@@ -1,3 +1,223 @@
|
|
|
1
|
-
#
|
|
1
|
+
# typizer — TypeScript SDK для Typizer API
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Официальный TypeScript SDK для [Typizer](https://typizer.ru) — сервиса, который извлекает данные из
|
|
4
|
+
документов (счета, УПД, накладные, договоры, сканы и фото) в JSON по вашей схеме.
|
|
5
|
+
|
|
6
|
+
SDK сгенерирован из OpenAPI-описания Typizer API: одна функция на каждую операцию REST API, с теми
|
|
7
|
+
же именами полей и кодами ошибок, и типы TypeScript для каждого запроса и ответа. Полная
|
|
8
|
+
документация — [docs.typizer.ru](https://docs.typizer.ru).
|
|
9
|
+
|
|
10
|
+
## Установка
|
|
11
|
+
|
|
12
|
+
```sh
|
|
13
|
+
npm i typizer
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
Пакет — только ESM, с типами в комплекте (`@types/…` не нужен). Работает в Node.js 20+, Bun, Deno
|
|
17
|
+
и других средах с глобальным `fetch`. Зависимостей нет.
|
|
18
|
+
|
|
19
|
+
## Ключ API
|
|
20
|
+
|
|
21
|
+
1. Зарегистрируйтесь в кабинете [my.typizer.ru](https://my.typizer.ru).
|
|
22
|
+
2. Откройте раздел «Ключи API» и создайте ключ со скоупом `runs:write` (для запуска прогонов) —
|
|
23
|
+
подробнее о скоупах в [«Ключах API»](https://docs.typizer.ru/how-to/api-keys/).
|
|
24
|
+
3. Ключ (`tz_live_…`) показывается один раз. Сохраните его, например в переменную окружения:
|
|
25
|
+
|
|
26
|
+
```sh
|
|
27
|
+
export TYPIZER_API_KEY="tz_live_…"
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
Ключ API — секрет сервера: не используйте его в коде, который выполняется в браузере.
|
|
31
|
+
|
|
32
|
+
## Быстрый старт
|
|
33
|
+
|
|
34
|
+
Извлечь данные из документа по разовой схеме (`POST /v1/extract`). `wait: 60` держит запрос до
|
|
35
|
+
завершения прогона, но не дольше 60 секунд:
|
|
36
|
+
|
|
37
|
+
```ts
|
|
38
|
+
import { createTypizerClient, extract } from 'typizer';
|
|
39
|
+
|
|
40
|
+
const client = createTypizerClient({
|
|
41
|
+
apiKey: process.env.TYPIZER_API_KEY as string,
|
|
42
|
+
// baseUrl по умолчанию — https://api.typizer.ru
|
|
43
|
+
});
|
|
44
|
+
|
|
45
|
+
const { data: run, error } = await extract({
|
|
46
|
+
client,
|
|
47
|
+
body: {
|
|
48
|
+
url: 'https://typizer.ru/samples/invoice.pdf',
|
|
49
|
+
schema: {
|
|
50
|
+
type: 'object',
|
|
51
|
+
properties: {
|
|
52
|
+
invoice_number: { type: 'string' },
|
|
53
|
+
total: { type: 'number' },
|
|
54
|
+
inn: { type: 'string', 'x-typizer-check': 'inn' },
|
|
55
|
+
},
|
|
56
|
+
required: ['invoice_number', 'total'],
|
|
57
|
+
},
|
|
58
|
+
},
|
|
59
|
+
query: { wait: 60 },
|
|
60
|
+
headers: { 'Idempotency-Key': crypto.randomUUID() }, // новый ключ на каждую операцию
|
|
61
|
+
});
|
|
62
|
+
if (error) throw new Error(`${error.code}: ${error.detail} (${error.doc_url})`);
|
|
63
|
+
|
|
64
|
+
console.log(run.status); // 'succeeded' | 'failed' | 'queued' | 'processing'
|
|
65
|
+
console.log(run.output); // результат в формате JSON по вашей схеме
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
Если прогон не успел завершиться за `wait`, придёт `Run` со статусом `queued` или `processing` —
|
|
69
|
+
дождитесь его через `getRun({ client, path: { id: run.id } })` или вебхук (см. ниже и
|
|
70
|
+
[«Получить результат»](https://docs.typizer.ru/how-to/get-results/)).
|
|
71
|
+
|
|
72
|
+
## Типизатор: схема, сохранённая один раз
|
|
73
|
+
|
|
74
|
+
Схему удобно сохранить как типизатор (`POST /v1/typizers`) и запускать его по `id`. Файл с диска
|
|
75
|
+
сначала загружается через `createFile`, затем передаётся в прогон по `file_id`:
|
|
76
|
+
|
|
77
|
+
```ts
|
|
78
|
+
import { openAsBlob } from 'node:fs';
|
|
79
|
+
import { createFile, createRun, createTypizer, createTypizerClient } from 'typizer';
|
|
80
|
+
|
|
81
|
+
const client = createTypizerClient({ apiKey: process.env.TYPIZER_API_KEY as string });
|
|
82
|
+
|
|
83
|
+
const { data: typizer, error: typizerError } = await createTypizer({
|
|
84
|
+
client,
|
|
85
|
+
body: {
|
|
86
|
+
name: 'Счета поставщиков',
|
|
87
|
+
schema: {
|
|
88
|
+
type: 'object',
|
|
89
|
+
properties: {
|
|
90
|
+
invoice_number: { type: 'string' },
|
|
91
|
+
total: { type: 'number' },
|
|
92
|
+
},
|
|
93
|
+
required: ['invoice_number', 'total'],
|
|
94
|
+
},
|
|
95
|
+
},
|
|
96
|
+
});
|
|
97
|
+
if (typizerError) throw new Error(typizerError.detail);
|
|
98
|
+
|
|
99
|
+
const { data: file, error: fileError } = await createFile({
|
|
100
|
+
client,
|
|
101
|
+
body: { file: await openAsBlob('invoice.pdf', { type: 'application/pdf' }) },
|
|
102
|
+
});
|
|
103
|
+
if (fileError) throw new Error(fileError.detail);
|
|
104
|
+
|
|
105
|
+
const { data: run } = await createRun({
|
|
106
|
+
client,
|
|
107
|
+
path: { id: typizer.id },
|
|
108
|
+
body: { file_id: file.id },
|
|
109
|
+
query: { wait: 60 },
|
|
110
|
+
headers: { 'Idempotency-Key': crypto.randomUUID() },
|
|
111
|
+
});
|
|
112
|
+
console.log(run?.output);
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
## Вызовы и типы
|
|
116
|
+
|
|
117
|
+
Каждая операция API — отдельная асинхронная функция с тем же именем, что `operationId` в
|
|
118
|
+
[справочнике API](https://docs.typizer.ru/reference/api/): `extract`, `createRun`, `getRun`,
|
|
119
|
+
`listRuns`, `createTypizer`, `createBatch`, `getBalance`, `createWebhookEndpoint` и другие.
|
|
120
|
+
Функция принимает `{ client, path?, query?, body?, headers? }` и возвращает
|
|
121
|
+
`Promise<{ data, error, request, response }>`:
|
|
122
|
+
- `data` — разобранный ответ при успехе, `error` — тело ошибки при коде 4xx/5xx; заполнено ровно
|
|
123
|
+
одно из двух, и после проверки `if (error)` TypeScript знает, что `data` определено;
|
|
124
|
+
- `response` — исходный `Response` (статус, заголовки вроде `Retry-After` и `X-Request-Id`).
|
|
125
|
+
|
|
126
|
+
Типы моделей экспортируются из пакета:
|
|
127
|
+
|
|
128
|
+
```ts
|
|
129
|
+
import type { Problem, Run, Typizer, WebhookEndpoint } from 'typizer';
|
|
130
|
+
|
|
131
|
+
function summary(run: Run): string {
|
|
132
|
+
return `${run.id}: ${run.status}, страниц списано ${run.pages.billed ?? 0}`;
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
`createTypizerClient({ apiKey, baseUrl?, fetch? })` добавляет заголовок
|
|
137
|
+
`Authorization: Bearer <apiKey>`; `fetch` можно подменить (тесты, свой агент или прокси).
|
|
138
|
+
|
|
139
|
+
## Обработка ошибок
|
|
140
|
+
|
|
141
|
+
Любая ошибка API приходит в формате `application/problem+json` (RFC 9457). По умолчанию функции не
|
|
142
|
+
бросают исключение, а возвращают тело ошибки в `error` (тип `Problem`):
|
|
143
|
+
- `code` — машиночитаемый код: `'invalid_request'`, `'unauthorized'`, `'insufficient_balance'`,
|
|
144
|
+
`'rate_limited'`, …;
|
|
145
|
+
- `detail` — описание конкретного случая, `param` — поле запроса, если виновато оно;
|
|
146
|
+
- `doc_url` — страница этого кода: `https://docs.typizer.ru/errors/<code>/`;
|
|
147
|
+
- `request_id` — приложите его к обращению в поддержку (support@typizer.ru).
|
|
148
|
+
|
|
149
|
+
```ts
|
|
150
|
+
import { createRun, createTypizerClient } from 'typizer';
|
|
151
|
+
|
|
152
|
+
const client = createTypizerClient({ apiKey: process.env.TYPIZER_API_KEY as string });
|
|
153
|
+
|
|
154
|
+
const { error, response } = await createRun({
|
|
155
|
+
client,
|
|
156
|
+
path: { id: 'tz_…' },
|
|
157
|
+
body: { url: 'https://typizer.ru/samples/invoice.pdf' },
|
|
158
|
+
headers: { 'Idempotency-Key': crypto.randomUUID() },
|
|
159
|
+
});
|
|
160
|
+
if (error) {
|
|
161
|
+
switch (error.code) {
|
|
162
|
+
case 'rate_limited':
|
|
163
|
+
console.log(`повторить через ${response?.headers.get('Retry-After')} с`);
|
|
164
|
+
break;
|
|
165
|
+
case 'insufficient_balance':
|
|
166
|
+
console.log('пополните баланс в кабинете');
|
|
167
|
+
break;
|
|
168
|
+
default:
|
|
169
|
+
console.log(error.code, error.detail, error.doc_url, error.request_id);
|
|
170
|
+
}
|
|
171
|
+
}
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
Повторять имеет смысл `rate_limited` (после `Retry-After`), `upstream_unavailable` и
|
|
175
|
+
`internal_error`; при сетевой ошибке повторяйте запрос с тем же `Idempotency-Key` — второй раз
|
|
176
|
+
ничего не создастся и не спишется. Остальные коды не исчезнут от повтора: сначала исправьте причину.
|
|
177
|
+
Все коды со статусами HTTP — [«Коды ошибок»](https://docs.typizer.ru/reference/errors/), правила
|
|
178
|
+
повторов — [«Обработка ошибок и повторов»](https://docs.typizer.ru/how-to/errors/).
|
|
179
|
+
|
|
180
|
+
Сетевая ошибка (нет ответа сервера) тоже попадает в `error` — как исключение `fetch`, а не
|
|
181
|
+
`Problem`. Если удобнее исключения, передайте `throwOnError: true` в вызов: тогда функция бросает
|
|
182
|
+
тело ошибки, а возвращает `{ data }` без `error`.
|
|
183
|
+
|
|
184
|
+
## Вебхуки
|
|
185
|
+
|
|
186
|
+
Вместо ожидания результат можно получать вебхуком: укажите `webhook_url` в запросе на прогон или
|
|
187
|
+
создайте конечную точку:
|
|
188
|
+
|
|
189
|
+
```ts
|
|
190
|
+
import { createTypizerClient, createWebhookEndpoint, testWebhookEndpoint } from 'typizer';
|
|
191
|
+
|
|
192
|
+
const client = createTypizerClient({ apiKey: process.env.TYPIZER_API_KEY as string });
|
|
193
|
+
|
|
194
|
+
const { data: endpoint, error } = await createWebhookEndpoint({
|
|
195
|
+
client,
|
|
196
|
+
body: {
|
|
197
|
+
url: 'https://your-server.example/typizer/webhook',
|
|
198
|
+
events: ['run.succeeded', 'run.failed'],
|
|
199
|
+
},
|
|
200
|
+
});
|
|
201
|
+
if (error) throw new Error(error.detail);
|
|
202
|
+
console.log(endpoint.secret); // whsec_… — ключ для проверки подписи, храните как секрет
|
|
203
|
+
|
|
204
|
+
await testWebhookEndpoint({ client, path: { id: endpoint.id } }); // пришлёт тестовый run.succeeded
|
|
205
|
+
```
|
|
206
|
+
|
|
207
|
+
Вебхуки подписываются по спецификации [Standard Webhooks](https://www.standardwebhooks.com)
|
|
208
|
+
(HMAC-SHA256). Функции проверки подписи в SDK нет: готовая реализация на `node:crypto` без
|
|
209
|
+
сторонних пакетов и тестовый вектор — в [«Приёме вебхуков»](https://docs.typizer.ru/how-to/webhooks/).
|
|
210
|
+
Никогда не обрабатывайте тело вебхука, не проверив подпись.
|
|
211
|
+
|
|
212
|
+
## Документация
|
|
213
|
+
|
|
214
|
+
- [Документация Typizer](https://docs.typizer.ru)
|
|
215
|
+
- [SDK для TypeScript и Python](https://docs.typizer.ru/reference/sdks/)
|
|
216
|
+
- [Справочник API](https://docs.typizer.ru/reference/api/) — REST-операция за каждой функцией SDK
|
|
217
|
+
- [Первый вызов API](https://docs.typizer.ru/tutorials/first-api-call/)
|
|
218
|
+
|
|
219
|
+
Вопросы и проблемы — support@typizer.ru.
|
|
220
|
+
|
|
221
|
+
## Лицензия
|
|
222
|
+
|
|
223
|
+
MIT — см. файл [LICENSE](LICENSE).
|
|
@@ -0,0 +1,216 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
import { createSseClient } from '../core/serverSentEvents.gen.js';
|
|
3
|
+
import { getValidRequestBody } from '../core/utils.gen.js';
|
|
4
|
+
import { buildUrl, createConfig, createInterceptors, getParseAs, mergeConfigs, mergeHeaders, setAuthParams, } from './utils.gen.js';
|
|
5
|
+
export const createClient = (config = {}) => {
|
|
6
|
+
let _config = mergeConfigs(createConfig(), config);
|
|
7
|
+
const getConfig = () => ({ ..._config });
|
|
8
|
+
const setConfig = (config) => {
|
|
9
|
+
_config = mergeConfigs(_config, config);
|
|
10
|
+
return getConfig();
|
|
11
|
+
};
|
|
12
|
+
const interceptors = createInterceptors();
|
|
13
|
+
const beforeRequest = async (options) => {
|
|
14
|
+
const opts = {
|
|
15
|
+
..._config,
|
|
16
|
+
...options,
|
|
17
|
+
fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
|
|
18
|
+
headers: mergeHeaders(_config.headers, options.headers),
|
|
19
|
+
serializedBody: undefined,
|
|
20
|
+
};
|
|
21
|
+
if (opts.security) {
|
|
22
|
+
await setAuthParams(opts);
|
|
23
|
+
}
|
|
24
|
+
if (opts.requestValidator) {
|
|
25
|
+
await opts.requestValidator(opts);
|
|
26
|
+
}
|
|
27
|
+
if (opts.body !== undefined && opts.bodySerializer) {
|
|
28
|
+
opts.serializedBody = opts.bodySerializer(opts.body);
|
|
29
|
+
}
|
|
30
|
+
// remove Content-Type header if body is empty to avoid sending invalid requests
|
|
31
|
+
if (opts.body === undefined || opts.serializedBody === '') {
|
|
32
|
+
opts.headers.delete('Content-Type');
|
|
33
|
+
}
|
|
34
|
+
const resolvedOpts = opts;
|
|
35
|
+
const url = buildUrl(resolvedOpts);
|
|
36
|
+
return { opts: resolvedOpts, url };
|
|
37
|
+
};
|
|
38
|
+
const request = async (options) => {
|
|
39
|
+
const throwOnError = options.throwOnError ?? _config.throwOnError;
|
|
40
|
+
const responseStyle = options.responseStyle ?? _config.responseStyle;
|
|
41
|
+
let request;
|
|
42
|
+
let response;
|
|
43
|
+
try {
|
|
44
|
+
const { opts, url } = await beforeRequest(options);
|
|
45
|
+
const requestInit = {
|
|
46
|
+
redirect: 'follow',
|
|
47
|
+
...opts,
|
|
48
|
+
body: getValidRequestBody(opts),
|
|
49
|
+
};
|
|
50
|
+
request = new Request(url, requestInit);
|
|
51
|
+
for (const fn of interceptors.request.fns) {
|
|
52
|
+
if (fn) {
|
|
53
|
+
request = await fn(request, opts);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
// fetch must be assigned here, otherwise it would throw the error:
|
|
57
|
+
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
|
|
58
|
+
const _fetch = opts.fetch;
|
|
59
|
+
response = await _fetch(request);
|
|
60
|
+
for (const fn of interceptors.response.fns) {
|
|
61
|
+
if (fn) {
|
|
62
|
+
response = await fn(response, request, opts);
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
const result = {
|
|
66
|
+
request,
|
|
67
|
+
response,
|
|
68
|
+
};
|
|
69
|
+
if (response.ok) {
|
|
70
|
+
const parseAs = (opts.parseAs === 'auto'
|
|
71
|
+
? getParseAs(response.headers.get('Content-Type'))
|
|
72
|
+
: opts.parseAs) ?? 'json';
|
|
73
|
+
if (response.status === 204 || response.headers.get('Content-Length') === '0') {
|
|
74
|
+
let emptyData;
|
|
75
|
+
switch (parseAs) {
|
|
76
|
+
case 'arrayBuffer':
|
|
77
|
+
case 'blob':
|
|
78
|
+
case 'text':
|
|
79
|
+
emptyData = await response[parseAs]();
|
|
80
|
+
break;
|
|
81
|
+
case 'formData':
|
|
82
|
+
emptyData = new FormData();
|
|
83
|
+
break;
|
|
84
|
+
case 'stream':
|
|
85
|
+
emptyData = response.body;
|
|
86
|
+
break;
|
|
87
|
+
case 'json':
|
|
88
|
+
default:
|
|
89
|
+
emptyData = {};
|
|
90
|
+
break;
|
|
91
|
+
}
|
|
92
|
+
return opts.responseStyle === 'data'
|
|
93
|
+
? emptyData
|
|
94
|
+
: {
|
|
95
|
+
data: emptyData,
|
|
96
|
+
...result,
|
|
97
|
+
};
|
|
98
|
+
}
|
|
99
|
+
let data;
|
|
100
|
+
switch (parseAs) {
|
|
101
|
+
case 'arrayBuffer':
|
|
102
|
+
case 'blob':
|
|
103
|
+
case 'formData':
|
|
104
|
+
case 'text':
|
|
105
|
+
data = await response[parseAs]();
|
|
106
|
+
break;
|
|
107
|
+
case 'json': {
|
|
108
|
+
// Some servers return 200 with no Content-Length and empty body.
|
|
109
|
+
// response.json() would throw; read as text and parse if non-empty.
|
|
110
|
+
const text = await response.text();
|
|
111
|
+
data = text ? JSON.parse(text) : {};
|
|
112
|
+
break;
|
|
113
|
+
}
|
|
114
|
+
case 'stream':
|
|
115
|
+
return opts.responseStyle === 'data'
|
|
116
|
+
? response.body
|
|
117
|
+
: {
|
|
118
|
+
data: response.body,
|
|
119
|
+
...result,
|
|
120
|
+
};
|
|
121
|
+
}
|
|
122
|
+
if (parseAs === 'json') {
|
|
123
|
+
if (opts.responseValidator) {
|
|
124
|
+
await opts.responseValidator(data);
|
|
125
|
+
}
|
|
126
|
+
if (opts.responseTransformer) {
|
|
127
|
+
data = await opts.responseTransformer(data);
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
return opts.responseStyle === 'data'
|
|
131
|
+
? data
|
|
132
|
+
: {
|
|
133
|
+
data,
|
|
134
|
+
...result,
|
|
135
|
+
};
|
|
136
|
+
}
|
|
137
|
+
const textError = await response.text();
|
|
138
|
+
let jsonError;
|
|
139
|
+
try {
|
|
140
|
+
jsonError = JSON.parse(textError);
|
|
141
|
+
}
|
|
142
|
+
catch {
|
|
143
|
+
// noop
|
|
144
|
+
}
|
|
145
|
+
throw jsonError ?? textError;
|
|
146
|
+
}
|
|
147
|
+
catch (error) {
|
|
148
|
+
let finalError = error;
|
|
149
|
+
for (const fn of interceptors.error.fns) {
|
|
150
|
+
if (fn) {
|
|
151
|
+
finalError = await fn(finalError, response, request, options);
|
|
152
|
+
}
|
|
153
|
+
}
|
|
154
|
+
finalError = finalError || {};
|
|
155
|
+
if (throwOnError) {
|
|
156
|
+
throw finalError;
|
|
157
|
+
}
|
|
158
|
+
// TODO: we probably want to return error and improve types
|
|
159
|
+
return responseStyle === 'data'
|
|
160
|
+
? undefined
|
|
161
|
+
: {
|
|
162
|
+
error: finalError,
|
|
163
|
+
request,
|
|
164
|
+
response,
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
};
|
|
168
|
+
const makeMethodFn = (method) => (options) => request({ ...options, method });
|
|
169
|
+
const makeSseFn = (method) => async (options) => {
|
|
170
|
+
const { opts, url } = await beforeRequest(options);
|
|
171
|
+
return createSseClient({
|
|
172
|
+
...opts,
|
|
173
|
+
body: opts.body,
|
|
174
|
+
method,
|
|
175
|
+
onRequest: async (url, init) => {
|
|
176
|
+
let request = new Request(url, init);
|
|
177
|
+
for (const fn of interceptors.request.fns) {
|
|
178
|
+
if (fn) {
|
|
179
|
+
request = await fn(request, opts);
|
|
180
|
+
}
|
|
181
|
+
}
|
|
182
|
+
return request;
|
|
183
|
+
},
|
|
184
|
+
serializedBody: getValidRequestBody(opts),
|
|
185
|
+
url,
|
|
186
|
+
});
|
|
187
|
+
};
|
|
188
|
+
const _buildUrl = (options) => buildUrl({ ..._config, ...options });
|
|
189
|
+
return {
|
|
190
|
+
buildUrl: _buildUrl,
|
|
191
|
+
connect: makeMethodFn('CONNECT'),
|
|
192
|
+
delete: makeMethodFn('DELETE'),
|
|
193
|
+
get: makeMethodFn('GET'),
|
|
194
|
+
getConfig,
|
|
195
|
+
head: makeMethodFn('HEAD'),
|
|
196
|
+
interceptors,
|
|
197
|
+
options: makeMethodFn('OPTIONS'),
|
|
198
|
+
patch: makeMethodFn('PATCH'),
|
|
199
|
+
post: makeMethodFn('POST'),
|
|
200
|
+
put: makeMethodFn('PUT'),
|
|
201
|
+
request,
|
|
202
|
+
setConfig,
|
|
203
|
+
sse: {
|
|
204
|
+
connect: makeSseFn('CONNECT'),
|
|
205
|
+
delete: makeSseFn('DELETE'),
|
|
206
|
+
get: makeSseFn('GET'),
|
|
207
|
+
head: makeSseFn('HEAD'),
|
|
208
|
+
options: makeSseFn('OPTIONS'),
|
|
209
|
+
patch: makeSseFn('PATCH'),
|
|
210
|
+
post: makeSseFn('POST'),
|
|
211
|
+
put: makeSseFn('PUT'),
|
|
212
|
+
trace: makeSseFn('TRACE'),
|
|
213
|
+
},
|
|
214
|
+
trace: makeMethodFn('TRACE'),
|
|
215
|
+
};
|
|
216
|
+
};
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export type { Auth } from '../core/auth.gen.js';
|
|
2
|
+
export type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
|
|
3
|
+
export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
|
|
4
|
+
export { buildClientParams } from '../core/params.gen.js';
|
|
5
|
+
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
|
|
6
|
+
export type { ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
|
|
7
|
+
export type { ClientMeta } from '../core/types.gen.js';
|
|
8
|
+
export { createClient } from './client.gen.js';
|
|
9
|
+
export type { Client, ClientOptions, Config, CreateClientConfig, Options, RequestOptions, RequestResult, ResolvedRequestOptions, ResponseStyle, TDataShape, } from './types.gen.js';
|
|
10
|
+
export { createConfig, mergeHeaders } from './utils.gen.js';
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
// This file is auto-generated by @hey-api/openapi-ts
|
|
2
|
+
export { formDataBodySerializer, jsonBodySerializer, urlSearchParamsBodySerializer, } from '../core/bodySerializer.gen.js';
|
|
3
|
+
export { buildClientParams } from '../core/params.gen.js';
|
|
4
|
+
export { serializeQueryKeyValue } from '../core/queryKeySerializer.gen.js';
|
|
5
|
+
export { createClient } from './client.gen.js';
|
|
6
|
+
export { createConfig, mergeHeaders } from './utils.gen.js';
|
|
@@ -0,0 +1,120 @@
|
|
|
1
|
+
import type { Auth } from '../core/auth.gen.js';
|
|
2
|
+
import type { ServerSentEventsOptions, ServerSentEventsResult } from '../core/serverSentEvents.gen.js';
|
|
3
|
+
import type { Client as CoreClient, Config as CoreConfig } from '../core/types.gen.js';
|
|
4
|
+
import type { Middleware } from './utils.gen.js';
|
|
5
|
+
export type ResponseStyle = 'data' | 'fields';
|
|
6
|
+
export interface Config<T extends ClientOptions = ClientOptions> extends Omit<RequestInit, 'body' | 'headers' | 'method'>, CoreConfig {
|
|
7
|
+
/**
|
|
8
|
+
* Base URL for all requests made by this client.
|
|
9
|
+
*/
|
|
10
|
+
baseUrl?: T['baseUrl'];
|
|
11
|
+
/**
|
|
12
|
+
* Fetch API implementation. You can use this option to provide a custom
|
|
13
|
+
* fetch instance.
|
|
14
|
+
*
|
|
15
|
+
* @default globalThis.fetch
|
|
16
|
+
*/
|
|
17
|
+
fetch?: typeof fetch;
|
|
18
|
+
/**
|
|
19
|
+
* Please don't use the Fetch client for Next.js applications. The `next`
|
|
20
|
+
* options won't have any effect.
|
|
21
|
+
*
|
|
22
|
+
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
|
23
|
+
*/
|
|
24
|
+
next?: never;
|
|
25
|
+
/**
|
|
26
|
+
* Return the response data parsed in a specified format. By default, `auto`
|
|
27
|
+
* will infer the appropriate method from the `Content-Type` response header.
|
|
28
|
+
* You can override this behavior with any of the {@link Body} methods.
|
|
29
|
+
* Select `stream` if you don't want to parse response data at all.
|
|
30
|
+
*
|
|
31
|
+
* @default 'auto'
|
|
32
|
+
*/
|
|
33
|
+
parseAs?: 'arrayBuffer' | 'auto' | 'blob' | 'formData' | 'json' | 'stream' | 'text';
|
|
34
|
+
/**
|
|
35
|
+
* Should we return only data or multiple fields (data, error, response, etc.)?
|
|
36
|
+
*
|
|
37
|
+
* @default 'fields'
|
|
38
|
+
*/
|
|
39
|
+
responseStyle?: ResponseStyle;
|
|
40
|
+
/**
|
|
41
|
+
* Throw an error instead of returning it in the response?
|
|
42
|
+
*
|
|
43
|
+
* @default false
|
|
44
|
+
*/
|
|
45
|
+
throwOnError?: T['throwOnError'];
|
|
46
|
+
}
|
|
47
|
+
export interface RequestOptions<TData = unknown, TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends Config<{
|
|
48
|
+
responseStyle: TResponseStyle;
|
|
49
|
+
throwOnError: ThrowOnError;
|
|
50
|
+
}>, Pick<ServerSentEventsOptions<TData>, 'onRequest' | 'onSseError' | 'onSseEvent' | 'sseDefaultRetryDelay' | 'sseMaxRetryAttempts' | 'sseMaxRetryDelay'> {
|
|
51
|
+
/**
|
|
52
|
+
* Any body that you want to add to your request.
|
|
53
|
+
*
|
|
54
|
+
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
|
55
|
+
*/
|
|
56
|
+
body?: unknown;
|
|
57
|
+
path?: Record<string, unknown>;
|
|
58
|
+
query?: Record<string, unknown>;
|
|
59
|
+
/**
|
|
60
|
+
* Security mechanism(s) to use for the request.
|
|
61
|
+
*/
|
|
62
|
+
security?: ReadonlyArray<Auth>;
|
|
63
|
+
url: Url;
|
|
64
|
+
}
|
|
65
|
+
export interface ResolvedRequestOptions<TResponseStyle extends ResponseStyle = 'fields', ThrowOnError extends boolean = boolean, Url extends string = string> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
|
66
|
+
headers: Headers;
|
|
67
|
+
serializedBody?: string;
|
|
68
|
+
}
|
|
69
|
+
export type RequestResult<TData = unknown, TError = unknown, ThrowOnError extends boolean = boolean, TResponseStyle extends ResponseStyle = 'fields'> = ThrowOnError extends true ? Promise<TResponseStyle extends 'data' ? TData extends Record<string, unknown> ? TData[keyof TData] : TData : {
|
|
70
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
71
|
+
request: Request;
|
|
72
|
+
response: Response;
|
|
73
|
+
}> : Promise<TResponseStyle extends 'data' ? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined : ({
|
|
74
|
+
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData;
|
|
75
|
+
error: undefined;
|
|
76
|
+
} | {
|
|
77
|
+
data: undefined;
|
|
78
|
+
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError;
|
|
79
|
+
}) & {
|
|
80
|
+
/** request may be undefined, because error may be from building the request object itself */
|
|
81
|
+
request?: Request;
|
|
82
|
+
/** response may be undefined, because error may be from building the request object itself or from a network error */
|
|
83
|
+
response?: Response;
|
|
84
|
+
}>;
|
|
85
|
+
export interface ClientOptions {
|
|
86
|
+
baseUrl?: string;
|
|
87
|
+
responseStyle?: ResponseStyle;
|
|
88
|
+
throwOnError?: boolean;
|
|
89
|
+
}
|
|
90
|
+
type MethodFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
91
|
+
type SseFn = <TData = unknown, _TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<never, TResponseStyle, ThrowOnError>, 'method'>) => Promise<ServerSentEventsResult<TData>>;
|
|
92
|
+
type RequestFn = <TData = unknown, TError = unknown, ThrowOnError extends boolean = false, TResponseStyle extends ResponseStyle = 'fields'>(options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, 'method'> & Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, 'method'>) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>;
|
|
93
|
+
type BuildUrlFn = <TData extends {
|
|
94
|
+
body?: unknown;
|
|
95
|
+
path?: Record<string, unknown>;
|
|
96
|
+
query?: Record<string, unknown>;
|
|
97
|
+
url: string;
|
|
98
|
+
}>(options: TData & Options<TData>) => string;
|
|
99
|
+
export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
|
100
|
+
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>;
|
|
101
|
+
};
|
|
102
|
+
/**
|
|
103
|
+
* The `createClientConfig()` function will be called on client initialization
|
|
104
|
+
* and the returned object will become the client's initial configuration.
|
|
105
|
+
*
|
|
106
|
+
* You may want to initialize your client this way instead of calling
|
|
107
|
+
* `setConfig()`. This is useful for example if you're using Next.js
|
|
108
|
+
* to ensure your client always has the correct values.
|
|
109
|
+
*/
|
|
110
|
+
export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (override?: Config<ClientOptions & T>) => Config<Required<ClientOptions> & T>;
|
|
111
|
+
export interface TDataShape {
|
|
112
|
+
body?: unknown;
|
|
113
|
+
headers?: unknown;
|
|
114
|
+
path?: unknown;
|
|
115
|
+
query?: unknown;
|
|
116
|
+
url: string;
|
|
117
|
+
}
|
|
118
|
+
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>;
|
|
119
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown, TResponseStyle extends ResponseStyle = 'fields'> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, 'body' | 'path' | 'query' | 'url'> & ([TData] extends [never] ? unknown : Omit<TData, 'url'>);
|
|
120
|
+
export {};
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
import type { QuerySerializerOptions } from '../core/bodySerializer.gen.js';
|
|
2
|
+
import type { Client, ClientOptions, Config, RequestOptions } from './types.gen.js';
|
|
3
|
+
export declare const createQuerySerializer: <T = unknown>({ parameters, ...args }?: QuerySerializerOptions) => ((queryParams: T) => string);
|
|
4
|
+
/**
|
|
5
|
+
* Infers parseAs value from provided Content-Type header.
|
|
6
|
+
*/
|
|
7
|
+
export declare const getParseAs: (contentType: string | null) => Exclude<Config["parseAs"], "auto">;
|
|
8
|
+
export declare function setAuthParams(options: Pick<RequestOptions, 'auth' | 'query' | 'security'> & {
|
|
9
|
+
headers: Headers;
|
|
10
|
+
}): Promise<void>;
|
|
11
|
+
export declare const buildUrl: Client['buildUrl'];
|
|
12
|
+
export declare const mergeConfigs: (a: Config, b: Config) => Config;
|
|
13
|
+
export declare const mergeHeaders: (...headers: Array<Required<Config>["headers"] | undefined>) => Headers;
|
|
14
|
+
type ErrInterceptor<Err, Res, Req, Options> = (error: Err,
|
|
15
|
+
/** response may be undefined due to a network error where no response object is produced */
|
|
16
|
+
response: Res | undefined,
|
|
17
|
+
/** request may be undefined, because error may be from building the request object itself */
|
|
18
|
+
request: Req | undefined, options: Options) => Err | Promise<Err>;
|
|
19
|
+
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>;
|
|
20
|
+
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>;
|
|
21
|
+
declare class Interceptors<Interceptor> {
|
|
22
|
+
fns: Array<Interceptor | null>;
|
|
23
|
+
clear(): void;
|
|
24
|
+
eject(id: number | Interceptor): void;
|
|
25
|
+
exists(id: number | Interceptor): boolean;
|
|
26
|
+
getInterceptorIndex(id: number | Interceptor): number;
|
|
27
|
+
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false;
|
|
28
|
+
use(fn: Interceptor): number;
|
|
29
|
+
}
|
|
30
|
+
export interface Middleware<Req, Res, Err, Options> {
|
|
31
|
+
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>;
|
|
32
|
+
request: Interceptors<ReqInterceptor<Req, Options>>;
|
|
33
|
+
response: Interceptors<ResInterceptor<Res, Req, Options>>;
|
|
34
|
+
}
|
|
35
|
+
export declare const createInterceptors: <Req, Res, Err, Options>() => Middleware<Req, Res, Err, Options>;
|
|
36
|
+
export declare const createConfig: <T extends ClientOptions = ClientOptions>(override?: Config<Omit<ClientOptions, keyof T> & T>) => Config<Omit<ClientOptions, keyof T> & T>;
|
|
37
|
+
export {};
|