@aezakmiproject/telemt-sdk-nest 1.0.0 → 1.1.0

package/README.md

@@ -7,19 +7,30 @@ NestJS module for the [Telemt](https://github.com/telemt/telemt) Control API.
 
 Wraps [`@aezakmiproject/telemt-sdk`](https://www.npmjs.com/package/@aezakmiproject/telemt-sdk) in an injectable provider: one configured `TelemtAPI` per registration, resolved through Nest DI, with sync and async registration and an opt-in helper that turns the SDK's no-throw envelope into a thrown exception.
 
-Requires **Node.js 18+** (the SDK uses global `fetch` and `AbortSignal.timeout`).
+Requires **Node.js 22.12+**. `@nestjs/common` v12 is ESM-only while this package is published as CommonJS, so it relies on `require(esm)`, which is unflagged only from that version.
 
 This project is an independent open-source client. It is not affiliated with Telegram or the Telemt authors.
 
 ## Install
 
+This package declares its runtime dependencies as peers, so install the SDK alongside it:
+
 ```bash
-npm install @aezakmiproject/telemt-sdk-nest
+npm install @aezakmiproject/telemt-sdk-nest @aezakmiproject/telemt-sdk
 # or
-pnpm add @aezakmiproject/telemt-sdk-nest
+pnpm add @aezakmiproject/telemt-sdk-nest @aezakmiproject/telemt-sdk
 ```
 
-`@nestjs/common` and `@nestjs/core` are expected to be present in the host application.
+The full peer set is:
+
+| Peer | Range | Notes |
+| --- | --- | --- |
+| `@aezakmiproject/telemt-sdk` | `^1.2.0` | The client this module wraps — install it explicitly |
+| `@nestjs/common` | `^12.0.0` | Already present in any Nest application |
+| `reflect-metadata` | `^0.2.0` | Already present in any Nest application |
+
+Keeping the SDK a peer means your application owns its version, and the module does
+not pin a second copy of the client into your tree.
 
 ## Quick start
 
@@ -126,9 +137,13 @@ Thin, stateless facade over the underlying `TelemtAPI`. Each getter forwards to
 | `runtime` | Gates, ME pool/quality, events, TLS fingerprints |
 | `security` | API posture and IP whitelist |
 | `limits` | Effective timeouts / pool / per-user limits |
+| `web` | WEB-proxy session control — **requires Telemt 3.5.1+** |
 | `client` | The raw `TelemtAPI`, for anything not surfaced above |
 | `unwrap(res)` | Returns `data`, or throws `TelemtApiException` |
 
+`web` is version-gated: on a Telemt older than 3.5.1 its calls come back as a failed
+`ISdkResponse` rather than throwing, like every other SDK call.
+
 The full method list and request/response types live in the [SDK's API reference](https://github.com/AezakmiProject/telemt-sdk/blob/main/docs/api.md).
 
 ## Responses and `unwrap`
@@ -181,8 +196,6 @@ A `202` from a user mutation is still `isOk: true` — the write is on disk, but
 
 Each registration builds its own client, so registering the module in two places gives two independent `TelemtAPI` instances. The module is **not** global: every consuming module must import it, and only `TelemtService` is exported — `TELEMT_CLIENT` and `TELEMT_MODULE_OPTIONS` stay internal to the module.
 
-WEB-proxy session control (`api.web`) is not implemented in the SDK, so it is deliberately not surfaced here.
-
 ## Development
 
 ```bash

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aezakmiproject/telemt-sdk-nest",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "NestJS module for the Telemt MTProto proxy Control API: injectable typed client, sync and async registration, no-throw responses, Node 22+",
   "homepage": "https://github.com/AezakmiProject/telemt-sdk-nest#readme",
   "repository": {