@media-engine/sdk 1.0.0 → 1.2.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2026 Media Engine contributors
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2026 Media Engine contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -2,14 +2,19 @@
 
 **English** | [Русский](https://github.com/Yaneart/media-engine/blob/main/packages/sdk/README.ru.md)
 
-A typed `fetch` client for the Media Engine REST API.
+A small typed client for the Media Engine HTTP API. Use it in a browser, bot, or another service
+instead of building request URLs by hand.
 
-Use it when your browser, bot, or another service talks to `apps/api` instead of creating `MediaEngine` directly.
+## Install
 
 ```bash
 npm install @media-engine/sdk
 ```
 
+Node.js 20 or newer is required when you use the SDK on the server.
+
+## Basic example
+
 ```ts
 import { MediaEngineClient } from "@media-engine/sdk";
 
@@ -19,34 +24,41 @@ const media = new MediaEngineClient({
 
 const search = await media.search({ title: "Interstellar" });
 const details = await media.getDetails({ imdb: "tt0816692" });
-const torrents = await media.discoverTorrents({ type: "movie", imdb: "tt0816692" });
-const health = await media.getHealth();
-const live = await media.getLiveness();
-const ready = await media.getReadiness();
 ```
 
-Pass a namespaced external ID to `getDetails()`, through `ids` or a shortcut such as `imdb`. The API rejects the deprecated plain `id` lookup with HTTP 400.
-
-The main client methods are:
+The client has methods for the public API:
 
 - `search()`;
 - `getDetails()`;
 - `getAvailability()`;
 - `discoverTorrents()`;
-- `getProviders()`;
-- `getStreamingProviders()`;
-- `getTorrentProviders()`;
-- `getHealth()`.
+- `getProviders()`, `getStreamingProviders()`, and `getTorrentProviders()`;
+- `getHealth()`, `getLiveness()`, and `getReadiness()`.
+
+For details, pass an external ID together with its namespace, for example
+`media.getDetails({ imdb: "tt0816692" })`.
 
-Each method accepts optional headers and an `AbortSignal`. You can also provide your own compatible `fetch` implementation.
+## Requests and errors
 
-Failed HTTP responses and invalid payloads throw `MediaEngineApiError`, which keeps the HTTP status and response body when possible.
+You can set headers once for the whole client or for one request. Every method also accepts an
+`AbortSignal`:
+
+```ts
+const controller = new AbortController();
+
+const request = media.search(
+  { title: "Dune" },
+  { signal: controller.signal },
+);
+```
 
-The SDK does not call providers, render players, or run a torrent client. It only turns typed method calls into HTTP requests.
+You may pass your own fetch-compatible function through the constructor's `fetch` option. Failed
+HTTP responses and invalid JSON throw `MediaEngineApiError`; it keeps the HTTP status and response
+body when available.
 
-See the [public API guide](https://github.com/Yaneart/media-engine/blob/main/docs/public-api.md) for query examples.
-For a complete browser-to-NestJS setup, follow the
-[beginner quick start](https://github.com/Yaneart/media-engine/blob/main/docs/quick-start.md).
+The SDK only talks to the API. It does not call providers directly, render players, or run a torrent
+client. Follow the [beginner quick start](https://github.com/Yaneart/media-engine/blob/main/docs/quick-start.md)
+for a complete backend and frontend example.
 
 ## License
 

package/README.ru.md

@@ -2,14 +2,19 @@
 
 [English](https://github.com/Yaneart/media-engine/blob/main/packages/sdk/README.md) | **Русский**
 
-Типизированный `fetch`-клиент для REST API Media Engine.
+Это небольшой типизированный клиент для HTTP API Media Engine. Используйте его в браузере, боте или
+другом сервисе, чтобы не собирать URL запросов вручную.
 
-Он нужен, когда браузер, бот или другой сервис обращается к `apps/api`, а не создаёт `MediaEngine` напрямую.
+## Установка
 
 ```bash
 npm install @media-engine/sdk
 ```
 
+Для серверного использования нужен Node.js 20 или новее.
+
+## Простой пример
+
 ```ts
 import { MediaEngineClient } from "@media-engine/sdk";
 
@@ -19,34 +24,41 @@ const media = new MediaEngineClient({
 
 const search = await media.search({ title: "Интерстеллар" });
 const details = await media.getDetails({ imdb: "tt0816692" });
-const torrents = await media.discoverTorrents({ type: "movie", imdb: "tt0816692" });
-const health = await media.getHealth();
-const live = await media.getLiveness();
-const ready = await media.getReadiness();
 ```
 
-В `getDetails()` передавайте внешний ID с указанием источника — через `ids` или сокращение вроде `imdb`. API отклоняет устаревший запрос с одним обычным `id` и возвращает HTTP 400.
-
-Основные методы клиента:
+У клиента есть методы для всего публичного API:
 
 - `search()`;
 - `getDetails()`;
 - `getAvailability()`;
 - `discoverTorrents()`;
-- `getProviders()`;
-- `getStreamingProviders()`;
-- `getTorrentProviders()`;
-- `getHealth()`.
+- `getProviders()`, `getStreamingProviders()` и `getTorrentProviders()`;
+- `getHealth()`, `getLiveness()` и `getReadiness()`.
+
+Для подробностей передавайте внешний ID вместе с его типом, например
+`media.getDetails({ imdb: "tt0816692" })`.
 
-Каждый метод принимает дополнительные заголовки и `AbortSignal`. При необходимости можно передать собственную совместимую реализацию `fetch`.
+## Запросы и ошибки
 
-При неуспешном HTTP-ответе или неверных данных SDK выбрасывает `MediaEngineApiError` и по возможности сохраняет HTTP-статус и тело ответа.
+Headers можно задать сразу для всего клиента или только для одного запроса. Каждый метод также
+принимает `AbortSignal`:
+
+```ts
+const controller = new AbortController();
+
+const request = media.search(
+  { title: "Дюна" },
+  { signal: controller.signal },
+);
+```
 
-SDK не вызывает провайдеры, не рисует плееры и не запускает torrent-клиент. Он только превращает типизированные методы в HTTP-запросы.
+Через опцию `fetch` конструктора можно передать свою fetch-совместимую функцию. При неуспешном HTTP
+ответе или неверном JSON SDK выбрасывает `MediaEngineApiError`. В ошибке по возможности сохраняются
+HTTP status и тело ответа.
 
-Примеры запросов есть в [описании публичного API](https://github.com/Yaneart/media-engine/blob/main/docs/public-api.md).
-Полная настройка связи browser с NestJS показана в
-[быстром старте для новичка](https://github.com/Yaneart/media-engine/blob/main/docs/quick-start.ru.md).
+SDK только общается с API. Он не вызывает провайдеры напрямую, не рисует плееры и не запускает
+torrent-клиент. Полный пример backend и frontend есть в
+[быстром старте](https://github.com/Yaneart/media-engine/blob/main/docs/quick-start.ru.md).
 
 ## Лицензия
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@media-engine/sdk",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "description": "Typed HTTP SDK for Media Engine API clients.",
   "license": "MIT",
   "homepage": "https://github.com/Yaneart/media-engine#readme",
@@ -47,7 +47,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@media-engine/core": "1.0.0"
+    "@media-engine/core": "1.2.0"
   },
   "scripts": {
     "clean": "node ../../scripts/clean-package-dist.mjs",