tencentads-cli 1.1.0 → 1.1.1

package/README.md

@@ -2,244 +2,108 @@
 
 通用腾讯广告 API CLI 工具 — 封装鉴权与 API 调用。
 
-零运行时依赖，同时提供 **CLI 命令行** 和 **Node.js SDK** 两种使用方式。
-
 ## 安装
 
 ```bash
-# 全局安装（CLI 工具）
-npm install -g tencentads-cli@1.0.0
-
-# 项目依赖（SDK）
-npm install tencentads-cli@1.0.0
-```
-
-## 配置鉴权
-
-在使用之前，需要保存 API Key 到本地凭证文件 `~/.tencent-ads/credentials.json`：
-
-```bash
-# 方式一：手动创建
-mkdir -p ~/.tencent-ads
-echo '{"apiKey":"YOUR_API_KEY"}' > ~/.tencent-ads/credentials.json
-
-# 方式二：通过环境变量自定义存储路径
-export TENCENT_ADS_CONFIG_DIR=/your/custom/path
+npm install -g tencentads-cli
 ```
 
-查看当前鉴权状态：
+npm 会根据当前操作系统自动安装对应平台的子包（`optionalDependencies`）：
 
-```bash
-tencentads-cli auth status
-```
+| 子包 | 平台 |
+|------|------|
+| `tencentads-darwin-x64` | macOS Intel |
+| `tencentads-darwin-arm64` | macOS Apple Silicon |
+| `tencentads-linux-x64` | Linux x64 |
+| `tencentads-linux-arm64` | Linux ARM64 |
+| `tencentads-windows-amd64` | Windows x64 |
+| `tencentads-windows-arm64` | Windows ARM64 |
 
 ## CLI 使用
 
-> 全局安装后可用的命令为 `tencentads-cli`（对应 `package.json` 的 `bin` 字段）。
-
-### JSON 模式
-
 ```bash
-# GET 请求
-tencentads-cli api '{"method":"GET","path":"/v3.0/adgroups/get","account_id":"123456"}'
-
-# POST 请求
-tencentads-cli api '{"method":"POST","path":"/v3.0/adgroups/add","account_id":"123456","body":{"campaign_id":100}}'
+# 登录鉴权
+tencentads auth login
 
-# 带查询参数
-tencentads-cli api '{"method":"GET","path":"/v3.0/campaigns/get","account_id":"123456","params":{"page":1,"page_size":10}}'
-```
+# 查看鉴权状态
+tencentads auth status
 
-### Flag 模式
+# 退出登录
+tencentads auth logout
 
-```bash
-# GET 请求
-tencentads-cli api --method GET --path /v3.0/adgroups/get --account-id 123456
+# API 调用（JSON 模式）
+tencentads api '{"method":"GET","path":"/v3.0/adgroups/get","account_id":123456}'
 
-# POST 请求
-tencentads-cli api --method POST --path /v3.0/adgroups/add --account-id 123456 --body '{"campaign_id":100}'
+# API 调用（Flag 模式）
+tencentads api --method GET --path /v3.0/adgroups/get --account-id 123456
 
-# 带查询参数
-tencentads-cli api --method GET --path /v3.0/campaigns/get --account-id 123456 --params '{"page":1,"page_size":10}'
+# 查看帮助
+tencentads help
 ```
 
-### 查看帮助
-
-```bash
-tencentads-cli help
-```
+## 发布流程
 
-## SDK 使用
+> 源码位于 `marketing-legion/`，发布脚本位于本仓库 `scripts/publish-cli-go.sh`。
 
-### callApi — 高级调用函数
+### 前置条件
 
-自动加载本地凭证，返回结构化结果：
+在 [npmjs.com → Access Tokens](https://www.npmjs.com/settings/~/tokens) 生成一个 **Granular Access Token**，对 `tencentads-*` 包授予 Read and Write 权限。
 
-```typescript
-import { callApi } from 'tencentads-cli';
+### 完整发布步骤
 
-const result = await callApi({
-  method: 'GET',
-  path: '/v3.0/adgroups/get',
-  accountId: '123456',
-  params: { page: 1, page_size: 10 },
-});
+**1. 更新版本号**
 
-if (result.success) {
-  console.log(result.data);
-} else {
-  console.error(result.error.message);
-}
+```bash
+# 修改 tencentads/VERSION
+echo "1.x.x" > /path/to/tencentads/VERSION
 ```
 
-### TencentAdsClient — HTTP 客户端
-
-支持自定义鉴权、超时和重试策略：
-
-```typescript
-import { TencentAdsClient, ENDPOINTS } from 'tencentads-cli';
-
-const client = new TencentAdsClient({
-  auth: {
-    applyAuth(headers) {
-      headers.set('X-MKT-API-Key', 'YOUR_API_KEY');
-      headers.set('Host', 'api.e.qq.com');
-    },
-  },
-  baseUrl: ENDPOINTS.MARKETING_API,
-  timeout: 30000,
-  retry: { maxRetries: 3, baseDelay: 1000 },
-});
-
-// GET
-const data = await client.get('/v3.0/campaigns/get', { account_id: '123456' });
+**2. 编译 Go 二进制（全平台）**
 
-// POST
-const resp = await client.post('/v3.0/adgroups/add', { campaign_id: 100 });
+```bash
+cd /path/to/tencentads
+bash build.sh --mode=release
 ```
 
-### TencentAdsAuth — 凭证管理
-
-```typescript
-import { TencentAdsAuth } from 'tencentads-cli';
-
-const auth = new TencentAdsAuth();
+**3. 打包 npm 子包**
 
-// 保存 API Key
-auth.saveApiKey('your-api-key');
-
-// 读取凭证
-const cred = auth.read();
-// => { apiKey: 'your-api-key', updatedAt: '2025-01-01T00:00:00.000Z' }
-
-// 查看鉴权状态
-const status = auth.getStatus(); // 'active' | 'not_configured'
-const info = auth.getInfo();
+```bash
+cd /path/to/marketing-legion
+node scripts/build-cli-go.mjs   # 默认 multi 模式，输出到 dist/tencentads-skills/tencentads-cli-npmjs/packages/
 ```
 
-### 枚举工具
+**4. 同步到发布仓库**
 
-内置腾讯广告 API 常用枚举及转换工具：
-
-```typescript
-import {
-  resolveEnum,
-  resolveEnumKey,
-  deriveProductType,
-  resolveTargetingFields,
-  MARKETING_GOAL,
-  MARKETING_CARRIER_TYPE,
-} from 'tencentads-cli';
+```bash
+bash release-skills.sh --sync
+```
 
-// 枚举名 → 数值
-resolveEnum('MARKETING_GOAL', 'MARKETING_GOAL_PRODUCT_SALES'); // => 2
+**5. 发布到 npm**
 
-// 数值 → 枚举名
-resolveEnumKey('MARKETING_GOAL', 2); // => 'MARKETING_GOAL_PRODUCT_SALES'
+```bash
+cd dist/tencentads-skills-repo
 
-// 自动推导 product_type
-deriveProductType('MARKETING_CARRIER_TYPE_WECHAT_OFFICIAL_ACCOUNT');
+# 使用 Access Token（推荐）
+bash scripts/publish-cli-go.sh --version 1.x.x --token <NPM_TOKEN>
 
-// 智能展开定向字段（支持中文简写）
-resolveTargetingFields({
-  os: 'ANDROID_10+',
-  device_price: '2500以上',
-  education: '本科',
-});
+# 或通过环境变量
+export NPM_TOKEN=<your-token>
+bash scripts/publish-cli-go.sh --version 1.x.x
 ```
 
-**可用枚举：**
+发布脚本会依次发布 6 个平台子包 + 主包 `tencentads-cli`，共 7 个包。
 
-| 枚举 | 说明 |
-|------|------|
-| `MARKETING_GOAL` | 营销目标（拉新、促销、品牌等） |
-| `MARKETING_SUB_GOAL` | 营销子目标 |
-| `MARKETING_CARRIER_TYPE` | 推广载体类型（Android/iOS/微信等） |
-| `MARKETING_TARGET_TYPE` | 推广业务类型 |
-| `SITE_SET` | 广告投放版位 |
-| `SMART_DELIVERY_PLATFORM` | 智能投放平台 |
-| `EXPLORATION_STRATEGY` | 探索策略 |
-| `CONFIGURED_STATUS` | 配置状态 |
-
-## 特性
-
-- **零运行时依赖** — 仅使用 Node.js 内置模块
-- **TypeScript** — 完整类型定义，开箱即用
-- **自动重试** — 指数退避策略，默认重试 3 次
-- **鉴权管理** — API Key 凭证自动加载
-- **枚举映射** — 双向转换 + 中文定向字段智能展开
-- **ESM 模块** — 原生 ES Module 支持
-
-## 构建
+**6. 验证发布结果**
 
 ```bash
-cd tools/tencent-ads-cli
-npm install
-npm run build        # tsc 编译 → dist/
+for pkg in tencentads-cli tencentads-darwin-x64 tencentads-darwin-arm64 tencentads-linux-x64 tencentads-linux-arm64 tencentads-windows-amd64 tencentads-windows-arm64; do
+  echo -n "$pkg: "; npm view $pkg version
+done
 ```
 
-构建产物在 `dist/` 目录，包含 `.js` 和 `.d.ts` 文件。
-
-## 发布到 npm
-
-1. **登录 npm**
-
-   ```bash
-   npm login
-   ```
-
-2. **确认当前已发布版本**
-
-   ```bash
-   npm info tencentads-cli
-   ```
-
-3. **更新版本号**
-
-   ```bash
-   npm version patch   # 修复：0.1.0 → 0.1.1
-   npm version minor   # 新功能：0.1.0 → 0.2.0
-   npm version major   # 破坏性变更：0.1.0 → 1.0.0
-   ```
-
-4. **构建并发布**
-
-   ```bash
-   npm run build
-   npm publish
-   ```
-
-5. **验证发布结果**
-
-   ```bash
-   npm info tencentads-cli version
-   ```
-
-> **注意**：发布后，使用 `release-skills.sh --cli-version <新版本>` 可以将 skills 仓库中的 `tencentads-cli` 依赖版本锁定到最新发布的版本。
-
 ## 环境要求
 
-- Node.js >= 20.0.0
+- Node.js >= 18.0.0
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentads-cli",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "通用腾讯广告 API CLI 工具 — 封装鉴权与 API 调用",
   "license": "MIT",
   "keywords": [
@@ -22,12 +22,12 @@
     "README.md"
   ],
   "optionalDependencies": {
-    "tencentads-darwin-x64": "1.1.0",
-    "tencentads-darwin-arm64": "1.1.0",
-    "tencentads-linux-x64": "1.1.0",
-    "tencentads-linux-arm64": "1.1.0",
-    "tencentads-windows-amd64": "1.1.0",
-    "tencentads-windows-arm64": "1.1.0"
+    "tencentads-darwin-x64": "1.1.1",
+    "tencentads-darwin-arm64": "1.1.1",
+    "tencentads-linux-x64": "1.1.1",
+    "tencentads-linux-arm64": "1.1.1",
+    "tencentads-windows-amd64": "1.1.1",
+    "tencentads-windows-arm64": "1.1.1"
   },
   "scripts": {
     "publish:npm": "bash ../scripts/publish-cli-go.sh --version 1.1.0 --registry https://registry.npmjs.org",