tturn 0.1.2 → 0.1.4

package/README.md

@@ -1,6 +1,6 @@
 # Tturn
 
-[English (default)](./README.md) | [中文](./README.zh-CN.md)
+[English (default)](./README.md) | [中文](./README.zh-CN.md) | [Changelog](./CHANGELOG.md)
 
 `tturn` is a high-performance TURN server package for Node.js.
 It embeds a native Rust core via N-API, so you can install from npm and run directly.
@@ -93,10 +93,12 @@ Optional env:
 
 - `TURN_PUBLIC_IP`
 - `TURN_PORT`
+- `TURN_MIN_PORT` (must be provided together with `TURN_MAX_PORT`)
+- `TURN_MAX_PORT` (must be provided together with `TURN_MIN_PORT`)
 - `TTURN_TTL_SEC`
 - `TTURN_USER_ID`
 - `TTURN_USERNAME` (or `TURN_USERNAME`)
-- `TTURN_DISABLE_CREDENTIAL_EXPIRY` (`1` or `true`)
+- `TTURN_DISABLE_CREDENTIAL_EXPIRY` (`1`/`true` keeps credentials non-expiring; set `0`/`false` to enable expiry)
 
 ## API options
 
@@ -108,8 +110,12 @@ Optional env:
 - `listeningIp` (default `0.0.0.0`): bind address.
 - `username` / `userId` (optional): default credential username seed. `username` has higher priority.
 - `ttlSec` (optional): default credential TTL used by `start()` and `issueCredential()`.
-- `disableCredentialExpiry` (optional): disable timestamp expiry check and issue non-expiring credentials.
-- `minPort` / `maxPort`: reserved for relay port range control in next iterations.
+- `disableCredentialExpiry` (optional, default `true`): disable timestamp expiry check and issue non-expiring credentials. Set to `false` to enforce expiry.
+- `minPort` / `maxPort`: relay allocation port range (must be configured as a pair).
+
+Transport note:
+
+- Current native implementation exposes UDP relay URLs only (`turn:...?...transport=udp`).
 
 At least one of `authSecret` or `password` must be provided.
 

package/README.zh-CN.md

@@ -1,6 +1,6 @@
 # Tturn（中文）
 
-[English（主文档）](./README.md) | [中文](./README.zh-CN.md)
+[English（主文档）](./README.md) | [中文](./README.zh-CN.md) | [更新日志](./CHANGELOG.md)
 
 `tturn` 是一个高性能的 Node.js TURN 服务包。
 它使用内嵌原生核心（Rust + N-API），可以直接通过 npm 安装并运行，不依赖 Docker，也不需要额外安装 `turnserver.exe` 作为运行时。
@@ -91,8 +91,12 @@ TURN_REALM=turn.example.com TURN_USERNAME=alice TURN_PASSWORD=alice-pass TTURN_D
 - `listeningIp`（默认 `0.0.0.0`）：本地绑定地址。
 - `username` / `userId`（可选）：默认凭证用户名种子，`username` 优先级更高。
 - `ttlSec`（可选）：`start()` 与 `issueCredential()` 的默认凭证时效。
-- `disableCredentialExpiry`（可选）：禁用时间戳过期校验，生成不过期凭证。
-- `minPort` / `maxPort`：预留给后续中继端口范围控制。
+- `disableCredentialExpiry`（可选，默认 `true`）：禁用时间戳过期校验，生成不过期凭证。设置为 `false` 时启用过期校验。
+- `minPort` / `maxPort`：中继分配端口范围（必须成对配置）。
+
+传输协议说明：
+
+- 当前 native 实现只返回 UDP 中继地址（`turn:...?...transport=udp`）。
 
 `authSecret` 和 `password` 至少需要提供一个。
 

package/dist/app.js

@@ -3,10 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const index_1 = require("./index");
 const APP_CONFIG = {
     realm: "turn.example.com",
-    publicIp: "192.168.3.66",
-    listenPort: 22224,
-    username: "metadigiee",
-    password: "22222",
+    authSecret: "",
+    password: "replace-with-your-password",
+    publicIp: "1.2.3.4",
+    listenPort: 3478,
+    username: "google-test",
     ttlSec: 600,
     disableCredentialExpiry: true
 };

package/dist/cli.js

@@ -12,6 +12,9 @@ async function run() {
             authSecret: authOptions.authSecret,
             password: authOptions.password,
             publicIp: process.env.TURN_PUBLIC_IP,
+            listenPort: process.env.TURN_PORT ? Number(process.env.TURN_PORT) : 3478,
+            minPort: process.env.TURN_MIN_PORT ? Number(process.env.TURN_MIN_PORT) : undefined,
+            maxPort: process.env.TURN_MAX_PORT ? Number(process.env.TURN_MAX_PORT) : undefined,
             disableCredentialExpiry: readBoolEnv("TTURN_DISABLE_CREDENTIAL_EXPIRY") ?? Boolean(authOptions.password)
         });
         const ice = service.issueCredential({
@@ -31,6 +34,8 @@ async function run() {
             password: authOptions.password,
             publicIp: process.env.TURN_PUBLIC_IP,
             listenPort: process.env.TURN_PORT ? Number(process.env.TURN_PORT) : 3478,
+            minPort: process.env.TURN_MIN_PORT ? Number(process.env.TURN_MIN_PORT) : undefined,
+            maxPort: process.env.TURN_MAX_PORT ? Number(process.env.TURN_MAX_PORT) : undefined,
             ttlSec: process.env.TTURN_TTL_SEC ? Number(process.env.TTURN_TTL_SEC) : 3600,
             username: readUsernameEnv(),
             userId: process.env.TTURN_USER_ID,
@@ -64,7 +69,7 @@ function printUsage() {
         "  TURN_REALM",
         "  TURN_SECRET or TURN_PASSWORD",
         "optional env:",
-        "  TURN_PUBLIC_IP, TURN_PORT, TTURN_TTL_SEC, TTURN_USER_ID, TTURN_USERNAME (or TURN_USERNAME), TTURN_DISABLE_CREDENTIAL_EXPIRY"
+        "  TURN_PUBLIC_IP, TURN_PORT, TURN_MIN_PORT, TURN_MAX_PORT, TTURN_TTL_SEC, TTURN_USER_ID, TTURN_USERNAME (or TURN_USERNAME), TTURN_DISABLE_CREDENTIAL_EXPIRY"
     ].join("\n") + "\n");
 }
 function readUsernameEnv() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tturn",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "High-performance TURN server for Node.js with embedded native core",
   "keywords": [
     "turn",
@@ -42,9 +42,11 @@
     "build": "npm run build:native && tsc -p tsconfig.json",
     "build:ts": "tsc -p tsconfig.json"
   },
-  "dependencies": {},
   "devDependencies": {
-    "@types/node": "^22.13.10",
+    "@types/node": "^22.19.13",
     "typescript": "^5.8.2"
+  },
+  "dependencies": {
+    "superpowers": "^0.0.2"
   }
 }