Merge "master" into "cloud_detect-Node.js-2023-08-31-online-2189-2026_01_15_17_22_09"

Conflicts:
meta.json

Author: bytestarter

.github/workflows/ci.yml

@@ -16,12 +16,12 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 18
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v2
         with:
-          version: 8
+          version: 9
 
       - name: Install Dependencies
         run: pnpm install

.github/workflows/release.yml

@@ -20,12 +20,12 @@ jobs:
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 18
 
       - name: Setup pnpm
         uses: pnpm/action-setup@v2
         with:
-          version: 8
+          version: 9
 
       - name: Install Dependencies
         run: pnpm install

.gitignore

@@ -1,7 +1,7 @@
 # Dependencies
 node_modules/
 .pnpm-store
-
+.npmrc
 
 # Build outputs
 dist/

README.EN.md

@@ -2,14 +2,16 @@ English | [中文](README.md)
 
 # Volcengine SDK for Node.js
 
-## Installation
-
-### Requirements
+## Requirements
 
 - Node.js >= 18
 
+## Installation
+
 Recommended to use `pnpm` for installation. `npm` and `yarn` are also supported.
 
+1. Installation Core Packages
+
 ```bash
 # pnpm
 pnpm add @volcengine/sdk-core
@@ -21,6 +23,21 @@ npm install @volcengine/sdk-core
 yarn add @volcengine/sdk-core
 ```
 
+2. Installation Service Packages
+
+   Take installing ECS service SDK package as an example:
+
+```bash
+# pnpm
+pnpm add @volcengine/ecs
+
+# npm
+npm install @volcengine/ecs
+
+# yarn
+yarn add @volcengine/ecs
+```
+
 ## Environment Variables
 
 The SDK automatically reads the following environment variables as access credentials:
@@ -35,34 +52,26 @@ export VOLCSTACK_ACCESS_KEY_ID="YOUR_AK"
 export VOLCSTACK_SECRET_ACCESS_KEY="YOUR_SK"
 ```
 
-## Endpoint Configuration
-
-The SDK supports multiple ways to configure the Endpoint, with the following priority (highest to lowest):
-
-1.  **Custom Endpoint**: Specify `EndpointWithEndpoint` in the client configuration (e.g. `iam.example.com`).
-2.  **Automatic Addressing**: Specify `region`, and the SDK will automatically construct the Endpoint based on the service name and region (e.g. `ecs.cn-beijing.volcengineapi.com`).
-3.  **Default**: If not specified and cannot be deduced, `open.volcengineapi.com` is used by default.
-
 ## Quick Start
 
 The following example shows how to initialize the client and send a request.
-Install the corresponding service SDK package (e.g., `@volcengine/iam`).
+Install the corresponding service SDK package (e.g., `@volcengine/ecs`).
 
 ```bash
 # pnpm
-pnpm add @volcengine/iam
+pnpm add @volcengine/ecs
 ```
 
 ```typescript
-import { IAMClient, ListUsersCommand } from "@volcengine/iam"; // Need to install the corresponding service package
+import { ECSClient, DescribeZonesCommand } from "@volcengine/ecs"; // Need to install the corresponding service package
 
 // 1. Use AK/SK from environment variables and specify Region
-const client = new IAMClient({
+const client = new ECSClient({
   region: "cn-beijing",
 });
 
 // 2. Or explicitly pass AK/SK in the code
-// const client = new IAMClient({
+// const client = new ECSClient({
 //   accessKeyId: "YOUR_AK",
 //   secretAccessKey: "YOUR_SK",
 //   region: "cn-beijing",
@@ -71,7 +80,7 @@ const client = new IAMClient({
 async function main() {
   try {
     // Send request (refer to service SDK documentation for specific Commands)
-    const command = new ListUsersCommand({});
+    const command = new DescribeZonesCommand({});
     const response = await client.send(command);
     console.log(response);
   } catch (error) {

README.md

@@ -1,14 +1,16 @@
-中文 | [English](README.EN.MD)
+中文 | [English](README.EN.md)
 
 # Volcengine SDK for Node.js
 
-## 安装
-
-### 环境要求
+## 环境要求
 
 - Node.js >= 18
 
-  推荐使用 `pnpm` 进行安装，同时支持 `npm` 和 `yarn`。
+## 安装
+
+推荐使用 `pnpm` 进行安装，同时支持 `npm` 和 `yarn`。
+
+1. 安装 Core 包
 
 ```bash
 # pnpm
@@ -21,6 +23,21 @@ npm install @volcengine/sdk-core
 yarn add @volcengine/sdk-core
 ```
 
+2. 安装云产品 SDK 包
+
+   以安装 ECS 业务 SDK 包为例：
+
+```bash
+# pnpm
+pnpm add @volcengine/ecs
+
+# npm
+npm install @volcengine/ecs
+
+# yarn
+yarn add @volcengine/ecs
+```
+
 ## 环境变量设置
 
 SDK 会自动读取以下环境变量作为访问凭据：
@@ -35,35 +52,20 @@ export VOLCSTACK_ACCESS_KEY_ID="YOUR_AK"
 export VOLCSTACK_SECRET_ACCESS_KEY="YOUR_SK"
 ```
 
-## Endpoint 设置
-
-SDK 支持多种方式配置 Endpoint，优先级从高到低：
-
-1.  **自定义 Endpoint**: 在客户端配置中指定 `host` (e.g. `open.volcengineapi.com`).
-2.  **自动寻址**: 指定 `region`，SDK 会根据服务名和区域自动构造 Endpoint (e.g. `ecs.cn-beijing.volcengineapi.com`).
-3.  **默认**: 如果未指定且无法推导，默认使用 `open.volcengineapi.com`.
-
 ## 快速开始
 
 以下示例展示了如何初始化客户端并发送请求。
-安装对应的业务 SDK 包（如 `@volcengine/iam`）。
-
-```bash
-# pnpm
-pnpm add @volcengine/iam
-
-```
 
 ```typescript
-import { IAMClient } from "@volcengine/iam"; // 需安装对应的业务包
+import { ECSClient, DescribeZonesCommand } from "@volcengine/ecs"; // 需安装对应的业务包
 
 // 1. 使用环境变量中的 AK/SK，并指定 Region
-const client = new IAMClient({
+const client = new ECSClient({
   region: "cn-beijing",
 });
 
 // 2. 或者在代码中显式传入 AK/SK
-// const client = new IAMClient({
+// const client = new ECSClient({
 //   accessKeyId: "YOUR_AK",
 //   secretAccessKey: "YOUR_SK",
 //   region: "cn-beijing",
@@ -72,7 +74,7 @@ const client = new IAMClient({
 async function main() {
   try {
     // 发送请求 (具体 Command 需参考业务 SDK 文档)
-    const command = new ListUsersCommand({});
+    const command = new DescribeZonesCommand({});
     const response = await client.send(command);
     console.log(response);
   } catch (error) {

SDK_Integration.md

@@ -5,7 +5,6 @@ English | [中文](SDK_Integration_zh.md)
 - [Environment and Installation](#environment-and-installation)
   - [Environment Requirements](#environment-requirements)
   - [Installation](#installation)
-- [Quick Start](#quick-start)
 - [Credentials](#credentials)
   - [AK/SK (Access Key)](#aksk-access-key)
   - [STS Token (Security Token Service)](#sts-token-security-token-service)
@@ -29,7 +28,6 @@ English | [中文](SDK_Integration_zh.md)
   - [Backoff Strategy](#backoff-strategy)
   - [Custom Retry Strategy](#custom-retry-strategy)
 - [Exception Handling](#exception-handling)
-  - [Output Raw Response](#output-raw-response)
   - [Resource Cleanup](#resource-cleanup)
 - [Debug Mechanism](#debug-mechanism)
 - [Environment Variables Description](#environment-variables-description)
@@ -44,6 +42,8 @@ English | [中文](SDK_Integration_zh.md)
 
 It is recommended to use `pnpm` for installation, but `npm` and `yarn` are also supported.
 
+1. Installation Core Packages
+
 ```bash
 # pnpm
 pnpm add @volcengine/sdk-core
@@ -55,6 +55,21 @@ npm install @volcengine/sdk-core
 yarn add @volcengine/sdk-core
 ```
 
+2. Installation Service Packages
+
+   Take installing ECS service SDK package as an example:
+
+```bash
+# pnpm
+pnpm add @volcengine/ecs
+
+# npm
+npm install @volcengine/ecs
+
+# yarn
+yarn add @volcengine/ecs
+```
+
 ## Credentials
 
 The SDK supports multiple ways to configure credentials, with the following priority from high to low:
@@ -441,9 +456,10 @@ The backoff strategy determines the wait time between each retry. You can choose
 - `ExponentialWithRandomJitterBackoffStrategy` (Default): Exponential backoff with jitter. Adds a random delay on top of exponential backoff to help avoid "thundering herd" effects.
 
 ```typescript
+import { StrategyName } from "@volcengine/sdk-core";
 const client = new EcsClient({
   // ... other configurations
-  retryMode: "ExponentialBackoffStrategy",
+  strategyName: StrategyName.ExponentialWithRandomJitterBackoffStrategy,
 });
 ```
 
@@ -502,7 +518,7 @@ try {
     if (error.status !== undefined) {
       // 1.1 SSL Error (status === 0)
       if (error.status === 0) {
-        console.error(`❌ SSL Error: ${error.message}`);
+        console.error(`❌ SSL Error`);
       }
       // 1.2 Server returned error (status > 0)
       else {
@@ -514,7 +530,6 @@ try {
           console.error(`   RequestId: ${RequestId}`);
         } else {
           // Other HTTP errors (such as 404, 500, 502, etc.)
-          console.error(`❌ HTTP Error ${error.status}: ${error.message}`);
         }
       }
     }
@@ -530,17 +545,12 @@ try {
     }
     // 3. Handle other SDK exceptions (Exception)
     else {
-      console.error("❌ SDK Exception Occurred:");
-      console.error(`   Message: ${error.message}`);
-      console.error(`   Name:    ${error.name}`);
-      if (error.originalError) {
-        console.error("   Cause:", error.originalError);
-      }
+      console.error("❌ SDK Exception Occurred");
     }
   }
   // 4. Unknown error (Error not thrown by SDK)
   else {
-    console.error("❌ Unknown Error:", error);
+    console.error("❌ Unknown Error");
   }
 }
 ```