polyv-live-cli 1.0.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 PolyV Team
+
+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

@@ -0,0 +1,417 @@
+# PolyV Live CLI 保利威直播云CLI工具
+
+<div align="center">
+
+![NPM Version](https://img.shields.io/npm/v/polyv-live-cli?style=flat-square&color=blue)
+![NPM Downloads](https://img.shields.io/npm/dm/polyv-live-cli?style=flat-square&color=green)
+![GitHub License](https://img.shields.io/github/license/terryso/polyv-live-cli?style=flat-square)
+![Node Version](https://img.shields.io/node/v/polyv-live-cli?style=flat-square&color=brightgreen)
+
+[![CI](https://img.shields.io/github/actions/workflow/status/terryso/polyv-live-cli/ci.yml?branch=develop&style=flat-square&label=CI)](https://github.com/terryso/polyv-live-cli/actions/workflows/ci.yml)
+[![Release](https://img.shields.io/github/actions/workflow/status/terryso/polyv-live-cli/release.yml?style=flat-square&label=Release)](https://github.com/terryso/polyv-live-cli/actions/workflows/release.yml)
+[![Codecov](https://img.shields.io/codecov/c/github/terryso/polyv-live-cli?style=flat-square)](https://codecov.io/gh/terryso/polyv-live-cli)
+
+![GitHub Stars](https://img.shields.io/github/stars/terryso/polyv-live-cli?style=flat-square&color=yellow)
+![GitHub Forks](https://img.shields.io/github/forks/terryso/polyv-live-cli?style=flat-square&color=blue)
+![GitHub Issues](https://img.shields.io/github/issues/terryso/polyv-live-cli?style=flat-square&color=red)
+![GitHub Pull Requests](https://img.shields.io/github/issues-pr/terryso/polyv-live-cli?style=flat-square&color=purple)
+
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.3.0-blue?style=flat-square&logo=typescript)](https://www.typescriptlang.org/)
+[![Node.js](https://img.shields.io/badge/Node.js-18%2B-green?style=flat-square&logo=node.js)](https://nodejs.org/)
+[![Commander.js](https://img.shields.io/badge/Commander.js-11.1.0-orange?style=flat-square)](https://github.com/tj/commander.js)
+
+</div>
+
+一个强大的命令行工具，用于管理保利威(PolyV)直播云服务。支持频道管理、直播流控制等核心功能，提供完整的API集成和友好的用户体验。
+
+
+## ✨ 特性
+
+### 🏗️ 核心功能
+- **频道管理**: 创建、查看、更新、删除直播频道
+- **流控制**: 获取推流密钥、开始/停止直播、实时状态监控
+- **认证集成**: 完整的PolyV OpenAPI认证支持
+- **多输出格式**: 支持表格和JSON格式输出
+
+### 🛠️ 技术特性
+- **TypeScript**: 完整的类型安全和智能提示
+- **分层架构**: 清晰的命令、处理器、服务分层设计
+- **错误处理**: 用户友好的错误消息和详细的调试信息
+- **配置灵活**: 支持环境变量、命令行参数、配置文件
+- **测试完备**: 80%+测试覆盖率，包含单元测试和集成测试
+
+## 📦 安装
+
+### 全局安装
+```bash
+npm install -g polyv-live-cli
+```
+
+### 本地开发
+```bash
+git clone https://github.com/your-repo/polyv-cli.git
+cd polyv-cli
+npm install
+npm run build
+```
+
+## 🚀 快速开始
+
+### 1. 配置认证信息
+
+**方法一：环境变量**
+```bash
+export POLYV_APP_ID="your_app_id"
+export POLYV_APP_SECRET="your_app_secret"
+export POLYV_USER_ID="your_user_id"  # 可选
+```
+
+**方法二：命令行参数**
+```bash
+polyv-cli --appId your_app_id --appSecret your_app_secret [command]
+```
+
+### 2. 基础使用示例
+
+```bash
+# 查看帮助
+polyv-cli --help
+
+# 查看版本
+polyv-cli --version
+
+# 创建频道
+polyv-cli channel create --name "我的直播间" --scene topclass
+
+# 查看频道列表
+polyv-cli channel list
+
+# 获取推流密钥
+polyv-cli stream get-key --channelId 3151318
+
+# 开始直播
+polyv-cli stream start --channelId 3151318
+
+# 查看直播状态
+polyv-cli stream status --channelId 3151318
+
+# 停止直播
+polyv-cli stream stop --channelId 3151318
+```
+
+## 📋 命令参考
+
+### 频道管理 (Channel Management)
+
+#### 创建频道
+```bash
+polyv-cli channel create [options]
+
+选项:
+  --name <string>           频道名称 (必需)
+  --scene <string>          场景类型: topclass|ppt|pure (必需)
+  --description <string>    频道描述
+  --publisher <string>      主持人名称
+  --password <string>       频道密码
+  --max-viewers <number>    最大观看人数
+  --output <format>         输出格式: table|json (默认: table)
+```
+
+#### 查看频道列表
+```bash
+polyv-cli channel list [options]
+
+选项:
+  --page <number>           页码 (默认: 1)
+  --per-page <number>       每页数量 (默认: 20)
+  --output <format>         输出格式: table|json (默认: table)
+```
+
+#### 获取频道详情
+```bash
+polyv-cli channel get --channelId <id> [options]
+
+选项:
+  --channelId <string>      频道ID (必需)
+  --output <format>         输出格式: table|json (默认: table)
+```
+
+#### 更新频道
+```bash
+polyv-cli channel update --channelId <id> [options]
+
+选项:
+  --channelId <string>      频道ID (必需)
+  --name <string>           频道名称
+  --description <string>    频道描述
+  --publisher <string>      主持人名称
+  --password <string>       频道密码
+  --max-viewers <number>    最大观看人数
+  --start-time <timestamp>  开始时间 (13位时间戳)
+  --end-time <timestamp>    结束时间 (13位时间戳)
+  --page-views <number>     累积观看数
+  --likes <number>          点赞数
+  --cover-img <url>         封面图片URL
+  --splash-img <url>        引导页图片URL
+  --output <format>         输出格式: table|json (默认: table)
+```
+
+#### 删除频道
+```bash
+polyv-cli channel delete --channelId <id>
+
+选项:
+  --channelId <string>      频道ID (必需)
+```
+
+### 流控制 (Stream Control)
+
+#### 获取推流密钥
+```bash
+polyv-cli stream get-key --channelId <id> [options]
+
+选项:
+  --channelId <string>      频道ID (必需)
+  --output <format>         输出格式: table|json (默认: table)
+```
+
+#### 开始直播
+```bash
+polyv-cli stream start --channelId <id>
+
+选项:
+  --channelId <string>      频道ID (必需)
+```
+
+#### 停止直播
+```bash
+polyv-cli stream stop --channelId <id>
+
+选项:
+  --channelId <string>      频道ID (必需)
+```
+
+#### 查看流状态
+```bash
+polyv-cli stream status --channelId <id> [options]
+
+选项:
+  --channelId <string>      频道ID (必需)
+  --output <format>         输出格式: table|json (默认: table)
+  --watch                   持续监控模式 (5秒更新)
+```
+
+## 🎯 使用场景
+
+### 1. 批量频道管理
+```bash
+# 批量创建频道
+for i in {1..5}; do
+  polyv-cli channel create --name "批量频道$i" --scene topclass --publisher "主持人$i"
+done
+
+# 查看所有频道
+polyv-cli channel list --per-page 50 --output json
+```
+
+### 2. 自动化直播流程
+```bash
+#!/bin/bash
+CHANNEL_ID="3151318"
+
+echo "🚀 开始直播..."
+polyv-cli stream start --channelId $CHANNEL_ID
+
+echo "📡 获取推流信息..."
+polyv-cli stream get-key --channelId $CHANNEL_ID
+
+echo "📊 监控直播状态..."
+polyv-cli stream status --channelId $CHANNEL_ID --watch
+```
+
+### 3. CI/CD集成
+```bash
+# 在CI/CD流水线中使用
+polyv-cli channel create \
+  --name "自动化测试频道" \
+  --scene topclass \
+  --description "CI/CD自动创建" \
+  --output json > channel_info.json
+
+CHANNEL_ID=$(cat channel_info.json | jq -r '.channelId')
+echo "创建的频道ID: $CHANNEL_ID"
+```
+
+## ⚙️ 配置选项
+
+### 环境变量
+| 变量名 | 说明 | 必需 |
+|--------|------|------|
+| `POLYV_APP_ID` | PolyV应用ID | ✅ |
+| `POLYV_APP_SECRET` | PolyV应用密钥 | ✅ |
+| `POLYV_USER_ID` | PolyV用户ID | ❌ |
+| `POLYV_BASE_URL` | API基础URL | ❌ |
+| `POLYV_TIMEOUT` | 请求超时时间(ms) | ❌ |
+| `DEBUG` | 调试模式 | ❌ |
+
+### 优先级顺序
+1. 命令行参数 (最高优先级)
+2. 环境变量
+3. 配置文件
+4. 默认值 (最低优先级)
+
+## 🔐 认证与安全
+
+### PolyV API认证
+本工具使用PolyV官方的MD5签名认证机制：
+
+1. **参数收集**: 收集appId、timestamp、channelId等参数
+2. **参数排序**: 按字典序排序参数
+3. **字符串拼接**: 格式为 `appSecret + 排序后参数 + appSecret`
+4. **MD5签名**: 计算MD5哈希值并转换为大写
+5. **请求发送**: 将签名作为sign参数发送
+
+### 安全最佳实践
+- ✅ 使用环境变量存储敏感信息
+- ✅ 敏感数据在输出中自动脱敏
+- ✅ 不在日志中记录密钥信息
+- ✅ 支持用户级别的权限控制
+
+## 🧪 测试
+
+### 运行测试
+```bash
+# 运行所有测试
+npm test
+
+# 运行单元测试
+npm run test:unit
+
+# 运行集成测试
+npm run test:integration
+
+# 查看测试覆盖率
+npm run test:coverage
+```
+
+### 测试覆盖率
+- **单元测试**: 80%+ 代码覆盖率
+- **集成测试**: 核心工作流全覆盖
+- **错误处理**: 各种异常场景测试
+
+## 🐛 故障排除
+
+### 常见问题
+
+#### 1. 认证失败
+```bash
+❌ 认证失败: 无效的appId或appSecret
+
+解决方案:
+- 检查POLYV_APP_ID和POLYV_APP_SECRET环境变量
+- 确认PolyV控制台中的应用凭据
+- 验证网络连接和防火墙设置
+```
+
+#### 2. 频道未找到
+```bash
+❌ 频道未找到: 频道ID 3151318 不存在
+
+解决方案:
+- 确认频道ID是否正确
+- 检查账号是否有访问该频道的权限
+- 使用 channel list 命令查看可用频道
+```
+
+#### 3. 推流密钥获取失败
+```bash
+❌ 获取推流密钥失败: 频道未在直播状态
+
+解决方案:
+- 使用 stream start 命令先开始直播
+- 确认频道类型支持推流功能
+- 检查频道配置是否正确
+```
+
+### 调试模式
+```bash
+# 启用详细调试信息
+DEBUG=1 polyv-cli [command]
+
+# 或设置环境变量
+export DEBUG=1
+polyv-cli [command]
+```
+
+## 🏗️ 开发
+
+### 项目结构
+```
+src/
+├── commands/          # CLI命令定义
+│   ├── channel.commands.ts
+│   └── stream.commands.ts
+├── handlers/          # 业务逻辑处理器
+│   ├── channel.handler.ts
+│   └── stream.handler.ts
+├── services/          # API服务层
+│   ├── channel.service.ts
+│   └── stream.service.ts
+├── types/             # TypeScript类型定义
+│   ├── channel.ts
+│   ├── stream.ts
+│   └── auth.ts
+├── utils/             # 工具函数
+│   ├── errors.ts
+│   ├── formatter.ts
+│   └── signature.ts
+└── config/            # 配置管理
+    └── manager.ts
+```
+
+### 开发命令
+```bash
+# 开发模式
+npm run dev
+
+# 构建项目
+npm run build
+
+# 代码检查
+npm run lint
+
+# 类型检查
+npm run type-check
+
+# 清理构建
+npm run clean
+```
+
+### 贡献指南
+1. Fork 项目仓库
+2. 创建功能分支: `git checkout -b feature/new-feature`
+3. 提交变更: `git commit -m 'feat: add new feature'`
+4. 推送分支: `git push origin feature/new-feature`
+5. 创建Pull Request
+
+## 📄 许可证
+
+本项目基于 [MIT License](LICENSE) 开源协议。
+
+## 🆘 支持
+
+### 获取帮助
+- 📖 [PolyV官方文档](https://dev.polyv.net/)
+- 🐛 [问题反馈](https://github.com/your-repo/polyv-cli/issues)
+- 💬 [讨论区](https://github.com/your-repo/polyv-cli/discussions)
+
+### 联系方式
+- 邮箱: support@polyv.net
+- 官网: https://www.polyv.net/
+- 技术支持: 400-993-9533
+
+---
+
+**Made with ❤️ by PolyV Team**
+
+> 🎯 让直播管理更简单，让开发者更高效！

package/dist/commands/channel.commands.d.ts

@@ -0,0 +1,9 @@
+import { Command } from 'commander';
+export declare function registerChannelCommands(program: Command): void;
+declare function parseInteger(value: string): number;
+declare function validateScene(value: string): 'topclass' | 'cloudclass' | 'telecast' | 'akt';
+declare function validateTemplate(value: string): 'ppt' | 'video';
+declare function validateLimit(value: string): number;
+declare function validateOutputFormat(value: string): 'table' | 'json';
+export { parseInteger, validateScene, validateTemplate, validateLimit, validateOutputFormat };
+//# sourceMappingURL=channel.commands.d.ts.map

package/dist/commands/channel.commands.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"channel.commands.d.ts","sourceRoot":"","sources":["../../src/commands/channel.commands.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAUpC,wBAAgB,uBAAuB,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAud9D;AAOD,iBAAS,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAM3C;AAOD,iBAAS,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,UAAU,GAAG,YAAY,GAAG,UAAU,GAAG,KAAK,CAMpF;AAOD,iBAAS,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAMxD;AAOD,iBAAS,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAS5C;AAOD,iBAAS,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,GAAG,MAAM,CAM7D;AAGD,OAAO,EACL,YAAY,EACZ,aAAa,EACb,gBAAgB,EAChB,aAAa,EACb,oBAAoB,EACrB,CAAC"}