typizer 0.0.0-stage → 0.2.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.
Files changed (54) hide show
  1. package/CHANGELOG.md +60 -0
  2. package/LICENSE +21 -0
  3. package/README.md +361 -2
  4. package/dist/client.d.ts +323 -0
  5. package/dist/client.js +629 -0
  6. package/dist/core.d.ts +109 -0
  7. package/dist/core.js +339 -0
  8. package/dist/errors.d.ts +146 -0
  9. package/dist/errors.js +281 -0
  10. package/dist/files.d.ts +42 -0
  11. package/dist/files.js +159 -0
  12. package/dist/gen/client/client.gen.d.ts +2 -0
  13. package/dist/gen/client/client.gen.js +216 -0
  14. package/dist/gen/client/index.d.ts +10 -0
  15. package/dist/gen/client/index.js +6 -0
  16. package/dist/gen/client/types.gen.d.ts +120 -0
  17. package/dist/gen/client/types.gen.js +2 -0
  18. package/dist/gen/client/utils.gen.d.ts +37 -0
  19. package/dist/gen/client/utils.gen.js +228 -0
  20. package/dist/gen/client.gen.d.ts +12 -0
  21. package/dist/gen/client.gen.js +3 -0
  22. package/dist/gen/core/auth.gen.d.ts +25 -0
  23. package/dist/gen/core/auth.gen.js +14 -0
  24. package/dist/gen/core/bodySerializer.gen.d.ts +25 -0
  25. package/dist/gen/core/bodySerializer.gen.js +57 -0
  26. package/dist/gen/core/params.gen.d.ts +43 -0
  27. package/dist/gen/core/params.gen.js +109 -0
  28. package/dist/gen/core/pathSerializer.gen.d.ts +33 -0
  29. package/dist/gen/core/pathSerializer.gen.js +106 -0
  30. package/dist/gen/core/queryKeySerializer.gen.d.ts +18 -0
  31. package/dist/gen/core/queryKeySerializer.gen.js +92 -0
  32. package/dist/gen/core/serverSentEvents.gen.d.ts +71 -0
  33. package/dist/gen/core/serverSentEvents.gen.js +132 -0
  34. package/dist/gen/core/types.gen.d.ts +83 -0
  35. package/dist/gen/core/types.gen.js +2 -0
  36. package/dist/gen/core/utils.gen.d.ts +19 -0
  37. package/dist/gen/core/utils.gen.js +87 -0
  38. package/dist/gen/index.d.ts +2 -0
  39. package/dist/gen/index.js +2 -0
  40. package/dist/gen/sdk.gen.d.ts +864 -0
  41. package/dist/gen/sdk.gen.js +1714 -0
  42. package/dist/gen/types.gen.d.ts +6986 -0
  43. package/dist/gen/types.gen.js +2 -0
  44. package/dist/index.d.ts +43 -0
  45. package/dist/index.js +46 -0
  46. package/dist/pagination.d.ts +30 -0
  47. package/dist/pagination.js +49 -0
  48. package/dist/run.d.ts +48 -0
  49. package/dist/run.js +45 -0
  50. package/dist/version.d.ts +2 -0
  51. package/dist/version.js +2 -0
  52. package/dist/webhooks.d.ts +40 -0
  53. package/dist/webhooks.js +208 -0
  54. package/package.json +55 -4
package/CHANGELOG.md ADDED
@@ -0,0 +1,60 @@
1
+ # Изменения
2
+
3
+ Формат — [Keep a Changelog](https://keepachangelog.com/ru/1.1.0/), версии — [SemVer](https://semver.org/lang/ru/).
4
+
5
+ ## [0.2.0] — 2026-11-14
6
+
7
+ Версия без поломок: всё из 0.1.0 работает как раньше, новый клиент добавлен рядом.
8
+
9
+ ### Добавлено
10
+
11
+ - Клиент `Typizer` (`import Typizer from 'typizer'` или `import { Typizer } from 'typizer'`) по
12
+ единой спецификации SDK Typizer: ключ из `TYPIZER_API_KEY`, адрес по умолчанию
13
+ `https://api.typizer.ru`, таймаут попытки 75 с, `withOptions()`.
14
+ - `client.extract({ file, schema | catalog | typizer })` — документ и схема → данные одним вызовом:
15
+ локальный файл (путь, `Blob`/`File`, `Uint8Array`, `ReadableStream`) уходит в том же запросе
16
+ (`multipart/form-data`), SDK ждёт результат (серверное ожидание до 60 с, затем опрос, всего до
17
+ 5 минут) и бросает `RunFailedError`/`WaitTimeoutError`.
18
+ - Ресурсы `client.runs` (`create`, `get`, `wait`, `list`, `output`, `retry`), `client.files`,
19
+ `client.typizers` (`versions`, `catalogUpdate`, `generate`, `xsd`), `client.catalog`,
20
+ `client.batches`, `client.webhookEndpoints` (`deliveries`, `test`); `client.me()`,
21
+ `client.balance()`, `client.usage()`, `client.organization()`, `client.status()`.
22
+ - Типизированные ошибки: `TypizerError` → `APIError` (`BadRequestError`, `AuthenticationError`,
23
+ `InsufficientBalanceError`, `PermissionDeniedError`, `NotFoundError`, `ConflictError`,
24
+ `IdempotencyConflictError`, `FileTooLargeError`, `UnsupportedFileTypeError`,
25
+ `UnprocessableDocumentError`, `RateLimitError`, `InternalServerError`,
26
+ `ServiceUnavailableError`), `APIConnectionError`/`APITimeoutError`, `RunFailedError`,
27
+ `WaitTimeoutError`, `WebhookVerificationError`, `ConfigurationError`.
28
+ - Автоматические повторы (сеть, таймаут, 408, 429, 500, 502–504) с `Retry-After` и экспоненциальной
29
+ паузой; `Idempotency-Key` на каждом `POST`, один на все повторы вызова.
30
+ - `.withResponse()` у каждого метода: `Response`, `requestId`, `idempotentReplayed`.
31
+ - Автопагинация: `for await (const run of client.runs.list())`, `Page` с `nextPage()`.
32
+ - Проверка подписи вебхуков без зависимостей: `verifyWebhook`, `isValidWebhook`,
33
+ `Typizer.webhooks.verify`; помощники прогона `run.needsReview`, `run.fieldsToReview()`,
34
+ `run.isTerminal`.
35
+ - Отмена через `AbortSignal`, опции `proxy` (с пакетом `undici`), `fetch`, `defaultHeaders`,
36
+ `appInfo`, логи (`logger`, `logLevel`, `TYPIZER_LOG`); ключ API в логах и строковых представлениях
37
+ маскируется.
38
+ - `VERSION`; заголовок `User-Agent: typizer-ts/<версия> (node/<версия>; <ОС>/<архитектура>)`.
39
+
40
+ ### Исправлено
41
+
42
+ - `createTypizerClient` больше не ждёт ответа бесконечно: таймаут 75 с по умолчанию (опция
43
+ `timeout`, `0` — без таймаута) и заголовок `User-Agent: typizer-ts/<версия>`.
44
+
45
+ ### Устарело
46
+
47
+ - Функции внутренних операций Кабинета (`startLogin`, `createCheckout`, `createApiKey`,
48
+ `createAgentThread`, `createDemoRun`, `deleteMe` и другие — всего 45, с ключом API они не работают)
49
+ помечены `@deprecated` и будут удалены в 1.0.0, вместе с переходом низкоуровневого слоя на
50
+ публичное описание API.
51
+
52
+ ## [0.1.0] — 2026-11-07
53
+
54
+ ### Добавлено
55
+
56
+ - Первый выпуск: функции для каждой операции API, сгенерированные из OpenAPI, типы моделей и
57
+ `createTypizerClient({ apiKey, baseUrl?, fetch? })`.
58
+
59
+ [0.2.0]: https://www.npmjs.com/package/typizer/v/0.2.0
60
+ [0.1.0]: https://www.npmjs.com/package/typizer/v/0.1.0
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,362 @@
1
- # Temporary Holding Version
1
+ # typizer — TypeScript SDK для Typizer API
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Официальный TypeScript SDK для [Typizer](https://typizer.ru) — сервиса, который извлекает данные из
4
+ документов (счета, УПД, накладные, договоры, сканы и фото) в JSON по вашей схеме.
5
+
6
+ Один клиент `Typizer` и одна строка на главный сценарий: документ и схема → данные. Повторы,
7
+ ключи идемпотентности, ожидание результата, типизированные ошибки, постраничный обход списков и
8
+ проверка подписи вебхуков — уже внутри. Полная документация — [docs.typizer.ru](https://docs.typizer.ru).
9
+
10
+ ## Установка
11
+
12
+ ```sh
13
+ npm i typizer
14
+ ```
15
+
16
+ Пакет — только ESM, с типами в комплекте. Работает в Node.js 20+, Bun и Deno; зависимостей нет.
17
+
18
+ ## Ключ API
19
+
20
+ 1. Зарегистрируйтесь в кабинете [my.typizer.ru](https://my.typizer.ru).
21
+ 2. Откройте раздел «Ключи API» и создайте ключ со скоупом `runs:write` (для запуска прогонов) —
22
+ подробнее о скоупах в [«Ключах API»](https://docs.typizer.ru/how-to/api-keys/).
23
+ 3. Ключ (`tz_live_…`) показывается один раз. Сохраните его в переменную окружения:
24
+
25
+ ```sh
26
+ export TYPIZER_API_KEY="tz_live_…"
27
+ ```
28
+
29
+ `new Typizer()` читает ключ из `TYPIZER_API_KEY` (или `new Typizer({ apiKey })`) и сразу падает с
30
+ `ConfigurationError`, если ключа нет. Адрес API — `https://api.typizer.ru` (меняется опцией
31
+ `baseUrl` или `TYPIZER_BASE_URL`). Ключ API — секрет сервера: не используйте его в коде, который
32
+ выполняется в браузере. Создайте один клиент на приложение — он безопасен для параллельных вызовов.
33
+
34
+ ## Быстрый старт
35
+
36
+ ```ts
37
+ import Typizer from 'typizer';
38
+
39
+ const client = new Typizer();
40
+
41
+ const run = await client.extract({
42
+ file: 'invoice.pdf', // путь, Blob/File, Uint8Array или ReadableStream
43
+ schema: {
44
+ type: 'object',
45
+ properties: {
46
+ invoice_number: { type: 'string' },
47
+ total: { type: 'number' },
48
+ inn: { type: 'string', 'x-typizer-check': 'inn' },
49
+ },
50
+ required: ['invoice_number', 'total'],
51
+ },
52
+ });
53
+
54
+ console.log(run.output); // { invoice_number: 'А-1024', total: 3660, inn: '7707083893' }
55
+
56
+ // Поля, которые не прошли проверку (контрольная сумма ИНН, сумма строк) или не найдены:
57
+ if (run.needsReview) {
58
+ for (const field of run.fieldsToReview()) {
59
+ console.log(field.path, field.status, field.reason, field.sources?.[0]?.page);
60
+ }
61
+ }
62
+ ```
63
+
64
+ `extract` отправляет файл и схему **одним** запросом (`POST /v1/extract`), ждёт результат (до
65
+ 5 минут: сервер держит запрос до 60 секунд, дальше SDK опрашивает прогон) и возвращает прогон
66
+ `succeeded`. Документ по ссылке — `{ url: 'https://typizer.ru/samples/invoice.pdf' }`, уже
67
+ загруженный файл — `{ fileId: 'file_…' }`. Порядок свойств схемы сохраняется: по нему идут столбцы
68
+ CSV/XLSX и элементы XML.
69
+
70
+ Тип результата можно задать самому:
71
+
72
+ ```ts
73
+ import { Typizer } from 'typizer';
74
+
75
+ interface Invoice {
76
+ invoice_number: string;
77
+ total: number;
78
+ }
79
+
80
+ const client = new Typizer();
81
+ const run = await client.extract<Invoice>({
82
+ url: 'https://typizer.ru/samples/invoice.pdf',
83
+ schema: {
84
+ type: 'object',
85
+ properties: { invoice_number: { type: 'string' }, total: { type: 'number' } },
86
+ required: ['invoice_number', 'total'],
87
+ },
88
+ timeout: 120_000, // ждать не дольше 2 минут (по умолчанию 5)
89
+ });
90
+ console.log(run.output?.total);
91
+ ```
92
+
93
+ ## Схема из каталога
94
+
95
+ Готовые схемы для типовых документов — [каталог](https://docs.typizer.ru/how-to/catalog/):
96
+ счёт-фактура, УПД, ТОРГ-12 и другие. Ссылка — `slug`, `slug@мажорная-версия` или
97
+ `издатель/slug@версия` для схем сообщества:
98
+
99
+ ```ts
100
+ import { Typizer } from 'typizer';
101
+
102
+ const client = new Typizer();
103
+
104
+ const run = await client.extract({ file: 'invoice.pdf', catalog: 'schet-faktura@1' });
105
+ console.log(run.catalog?.ref, run.output);
106
+
107
+ for await (const entry of client.catalog.list({ category: 'invoices' })) {
108
+ console.log(entry.ref, entry.title);
109
+ }
110
+ ```
111
+
112
+ ## Типизатор
113
+
114
+ Схему, которой вы пользуетесь постоянно, сохраните как типизатор и запускайте по `id`:
115
+
116
+ ```ts
117
+ import { Typizer } from 'typizer';
118
+
119
+ const client = new Typizer();
120
+
121
+ const typizer = await client.typizers.create({
122
+ name: 'Счета поставщиков',
123
+ schema: {
124
+ type: 'object',
125
+ properties: {
126
+ invoice_number: { type: 'string' },
127
+ total: { type: 'number' },
128
+ },
129
+ required: ['invoice_number', 'total'],
130
+ },
131
+ });
132
+
133
+ const run = await client.extract({ file: 'invoice.pdf', typizer: typizer.id });
134
+ console.log(run.output);
135
+
136
+ // Все прогоны типизатора — постранично, следующая страница запрашивается сама:
137
+ for await (const r of client.runs.list({ typizerId: typizer.id })) {
138
+ console.log(r.id, r.status);
139
+ }
140
+ ```
141
+
142
+ Другие ресурсы клиента: `client.runs` (`create`, `get`, `wait`, `list`, `output`, `retry`),
143
+ `client.files`, `client.typizers` (с `versions` и `catalogUpdate`), `client.catalog`,
144
+ `client.batches`, `client.webhookEndpoints`, а также `client.me()`, `client.balance()`,
145
+ `client.usage()`, `client.status()`. Поля моделей называются как в JSON API (`run.output_expired`,
146
+ `run.created_at`), параметры методов — в `camelCase` (`typizerId`, `webhookUrl`).
147
+
148
+ ## Ошибки
149
+
150
+ Всё, что бросает SDK, — подкласс `TypizerError`. Ответ API с ошибкой — `APIError` с полями
151
+ `status`, `code`, `detail`, `param`, `requestId` (приложите его к обращению в поддержку),
152
+ `retryable` и `retryAfter`; класс выбирается по коду из [«Кодов ошибок»](https://docs.typizer.ru/reference/errors/):
153
+
154
+ ```ts
155
+ import {
156
+ APIConnectionError,
157
+ APIError,
158
+ InsufficientBalanceError,
159
+ RateLimitError,
160
+ RunFailedError,
161
+ Typizer,
162
+ WaitTimeoutError,
163
+ } from 'typizer';
164
+
165
+ const client = new Typizer();
166
+
167
+ try {
168
+ const run = await client.extract({ file: 'invoice.pdf', catalog: 'upd' });
169
+ console.log(run.output);
170
+ } catch (err) {
171
+ if (err instanceof RunFailedError) {
172
+ console.log('документ не распознан:', err.code, err.detail); // document_unreadable, …
173
+ } else if (err instanceof WaitTimeoutError) {
174
+ // прогон продолжается и будет оплачен — дождитесь его позже
175
+ const run = await client.runs.wait(err.runId);
176
+ console.log(run.status);
177
+ } else if (err instanceof InsufficientBalanceError) {
178
+ console.log('пополните баланс в кабинете');
179
+ } else if (err instanceof RateLimitError) {
180
+ console.log(`лимит запросов, повторить через ${err.retryAfter} с`);
181
+ } else if (err instanceof APIError) {
182
+ console.log(err.message); // [code] detail (HTTP 400, request_id=req_…, https://docs.typizer.ru/errors/…)
183
+ } else if (err instanceof APIConnectionError) {
184
+ console.log('нет связи с API'); // APITimeoutError — если истёк таймаут попытки
185
+ } else {
186
+ throw err;
187
+ }
188
+ }
189
+ ```
190
+
191
+ Ошибки в аргументах (нет схемы, два документа сразу, `instructions` без `schema`) — обычный
192
+ `TypeError` до отправки запроса.
193
+
194
+ ## Повторы и идемпотентность
195
+
196
+ SDK сам повторяет запрос (по умолчанию до 2 раз) при сетевой ошибке и таймауте, `429`, `500`,
197
+ `502`–`504` и `408`: ровно через `Retry-After`, если сервер его прислал, иначе с экспоненциальной
198
+ паузой 0,5 → 1 → 2 → 4 → 8 с. Каждый `POST` уходит с заголовком `Idempotency-Key` — один и тот же
199
+ во всех повторах, поэтому повтор не создаст второй прогон и не спишет страницы дважды. Таймаут
200
+ одной попытки — 75 секунд.
201
+
202
+ Если одна и та же операция может повториться между процессами (тот же счёт из той же очереди),
203
+ передайте свой ключ — сервер вернёт сохранённый ответ вместо нового прогона:
204
+
205
+ ```ts
206
+ import { Typizer } from 'typizer';
207
+
208
+ const client = new Typizer({ maxRetries: 4, timeout: 30_000 });
209
+ const invoiceId = '42';
210
+
211
+ const {
212
+ data: run,
213
+ idempotentReplayed,
214
+ requestId,
215
+ } = await client
216
+ .extract({
217
+ file: 'invoice.pdf',
218
+ catalog: 'schet-faktura',
219
+ idempotencyKey: `invoice-${invoiceId}`,
220
+ })
221
+ .withResponse();
222
+ console.log(run.id, idempotentReplayed, requestId);
223
+
224
+ // Настройки для отдельного вызова: { timeout, maxRetries, idempotencyKey, extraHeaders, signal }
225
+ const balance = await client.balance({ maxRetries: 0 });
226
+ console.log(balance.pages_available);
227
+ ```
228
+
229
+ `.withResponse()` есть у каждого метода: кроме результата он отдаёт `Response` с заголовками
230
+ (`X-Request-Id`, `RateLimit-*`, `Location`) и признак `idempotentReplayed`. Учтите: повтор создания
231
+ конечной точки вебхука с тем же ключом отдаёт `secret: null` — секрет приходит только в первом
232
+ ответе. Ожидание можно отменить: `signal` (`AbortSignal`) прерывает и запрос, и паузу, и опрос.
233
+
234
+ ## Вебхуки
235
+
236
+ Вместо ожидания результат можно получать вебхуком: `webhookUrl` в `extract`/`runs.create` или
237
+ конечная точка:
238
+
239
+ ```ts
240
+ import { Typizer } from 'typizer';
241
+
242
+ const client = new Typizer();
243
+
244
+ const endpoint = await client.webhookEndpoints.create({
245
+ url: 'https://your-server.example/typizer/webhook',
246
+ events: ['run.succeeded', 'run.failed'],
247
+ });
248
+ console.log(endpoint.secret); // whsec_… — ключ для проверки подписи, храните как секрет
249
+
250
+ await client.webhookEndpoints.test(endpoint.id); // пришлёт тестовый run.succeeded
251
+ ```
252
+
253
+ Доставки подписаны по [Standard Webhooks](https://www.standardwebhooks.com). `verifyWebhook`
254
+ проверяет подпись и время (±5 минут) и возвращает событие; клиент и ключ API для этого не нужны.
255
+ Передайте **сырое** тело запроса — в Express это `express.raw`:
256
+
257
+ ```ts
258
+ import express from 'express';
259
+ import { verifyWebhook, WebhookVerificationError } from 'typizer';
260
+
261
+ const app = express();
262
+
263
+ app.post('/typizer/webhook', express.raw({ type: 'application/json' }), (req, res) => {
264
+ try {
265
+ const event = verifyWebhook(
266
+ req.body,
267
+ req.headers,
268
+ process.env.TYPIZER_WEBHOOK_SECRET as string,
269
+ );
270
+ if (event.run) console.log(event.type, event.run.id, event.run.output); // run.succeeded / run.failed
271
+ res.sendStatus(200);
272
+ } catch (err) {
273
+ if (err instanceof WebhookVerificationError) return res.sendStatus(400); // err.reason
274
+ throw err;
275
+ }
276
+ });
277
+
278
+ app.listen(3000);
279
+ ```
280
+
281
+ `event.id` — ключ дедупликации (одно событие может прийти дважды). Есть и `isValidWebhook(...)`,
282
+ который возвращает `true`/`false` вместо исключения, и `Typizer.webhooks.verify(...)`.
283
+
284
+ ## Прокси и свой HTTP-клиент
285
+
286
+ Встроенный `fetch` Node.js переменные `HTTPS_PROXY`/`NO_PROXY` не учитывает, пока не задан
287
+ `NODE_USE_ENV_PROXY=1` (Node.js 24+). Явный прокси — опция `proxy` (нужен пакет `undici`:
288
+ `npm i undici`; логин и пароль можно передать в URL). Свой `fetch` — опция `fetch`: тогда прокси и
289
+ TLS настраивает он. Корпоративный корневой сертификат подключается штатно:
290
+ `NODE_EXTRA_CA_CERTS=/path/to/ca.pem`. Отключать проверку TLS SDK не предлагает.
291
+
292
+ ```ts
293
+ import { Typizer } from 'typizer';
294
+
295
+ const viaProxy = new Typizer({ proxy: 'http://user:password@proxy.local:3128' });
296
+
297
+ const withOwnFetch = new Typizer({
298
+ fetch: (input, init) => fetch(input, init), // ваш fetch: агент, прокси, тесты
299
+ appInfo: { name: 'acme-erp', version: '2.1.0' }, // попадёт в User-Agent
300
+ });
301
+ console.log(String(viaProxy), String(withOwnFetch)); // ключ в строке маскируется: tz_live_…a1b2
302
+ ```
303
+
304
+ ## Логи
305
+
306
+ SDK пишет в `console` только предупреждения (например, о плановых работах — один раз). Подробнее:
307
+ `TYPIZER_LOG=debug` (строка на каждую HTTP-попытку: метод, путь, статус, `request_id`,
308
+ длительность) или `TYPIZER_LOG=info` (каждый повтор и его причина), либо опции `logLevel` и `logger`
309
+ (любой объект с методами `debug`, `info`, `warn`):
310
+
311
+ ```ts
312
+ import { Typizer } from 'typizer';
313
+
314
+ const client = new Typizer({ logLevel: 'debug', logger: console });
315
+ await client.me(); // typizer: GET /v1/me -> 200 in 0.12s (request_id=req_…, attempt 1/3)
316
+ ```
317
+
318
+ Ключ API, тела запросов и ответов, имена файлов, `metadata` и секреты в логи не попадают никогда.
319
+
320
+ ## Низкоуровневый клиент
321
+
322
+ Функции версии 0.1 — по одной на каждую операцию API, с именами `operationId` из
323
+ [справочника API](https://docs.typizer.ru/reference/api/) — остаются и работают как раньше;
324
+ `createTypizerClient` теперь отправляет `User-Agent` и ограничивает запрос 75 секундами (опция
325
+ `timeout`). Функции возвращают `{ data, error, response }` и сами не повторяют запросы:
326
+
327
+ ```ts
328
+ import { createTypizerClient, extract, getRun } from 'typizer';
329
+
330
+ const client = createTypizerClient({ apiKey: process.env.TYPIZER_API_KEY as string });
331
+
332
+ const { data: run, error } = await extract({
333
+ client,
334
+ body: {
335
+ url: 'https://typizer.ru/samples/invoice.pdf',
336
+ schema: { type: 'object', properties: { total: { type: 'number' } } },
337
+ },
338
+ query: { wait: 60 },
339
+ headers: { 'Idempotency-Key': crypto.randomUUID() },
340
+ });
341
+ if (error) throw new Error(`${error.code}: ${error.detail}`);
342
+ const fresh = await getRun({ client, path: { id: run.id } });
343
+ console.log(fresh.data?.status);
344
+ ```
345
+
346
+ Тип `Typizer` по-прежнему означает модель сохранённой схемы (`import type { Typizer } from
347
+ 'typizer'`); тип экземпляра клиента — `TypizerClient`. Функции внутренних операций Кабинета (вход,
348
+ оплата, ключи API и другие — с ключом API они не работают) помечены `@deprecated` и уйдут в 1.0.
349
+
350
+ ## Документация
351
+
352
+ - [Документация Typizer](https://docs.typizer.ru)
353
+ - [SDK](https://docs.typizer.ru/reference/sdks/)
354
+ - [Справочник API](https://docs.typizer.ru/reference/api/)
355
+ - [Первый вызов API](https://docs.typizer.ru/tutorials/first-api-call/)
356
+ - [Изменения](CHANGELOG.md)
357
+
358
+ Вопросы и проблемы — support@typizer.ru.
359
+
360
+ ## Лицензия
361
+
362
+ MIT — см. файл [LICENSE](LICENSE).