优化文档、示例、依赖导入及npm分发内容 (#269)

tczzz · larrytzhang · web-flow · commit 42ad5db15508 · 2025-03-19T21:05:17.000+08:00
* refactor: 依赖导入方式修改

* feat: 示例更新

* doc: 优化通过源码包安装文档

* chore: 构建及文件结构调整

* feat: 示例模块导入修改

* fix: sse 按行读取数据方式修改

---------

Co-authored-by: larrytzhang &lt;larrytzhang@tencent.com&gt;
diff --git a/.npmignore b/.npmignore
diff --git a/README.md b/README.md
@@ -52,10 +52,24 @@ npm install tencentcloud-sdk-nodejs --save
 
 ## 通过源码包安装
 
-1. 前往 [GitHub 仓库](https://github.com/tencentcloud/tencentcloud-sdk-nodejs) 或者 [Gitee 仓库](https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs) 下载源码压缩包。
-2. 解压源码包到您项目合适的位置，例如 `sdk/tencentcloud-sdk-nodejs`。
-3. 执行 `npm install ./sdk/tencentcloud-sdk-nodejs`。
-4. 使用 `require("tencentcloud-sdk-nodejs")` 的方式引入 SDK，具体可参考示例。
+1. clone 代码到本地：
+```
+git clone https://github.com/tencentcloud/tencentcloud-sdk-nodejs
+# 或者
+git clone https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs
+```
+2. 在项目根目录执行以下命令完成构建：
+```
+npm install && npm run build
+```
+3. 打包 NPM 压缩文件，例如 `tencentcloud-sdk-nodejs-4.0.0.tgz`
+```
+npm pack
+```
+4. 安装包到你的项目里：
+```
+npm install /path/to/tencentcloud-sdk-nodejs/tencentcloud-sdk-nodejs-4.0.0.tgz
+```
 
 # 示例
 
diff --git a/examples/cbs/v20170312/describe_disks.js b/examples/cbs/v20170312/describe_disks.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../../tencentcloud-sdk-nodejs")
+const { cbs } = require("tencentcloud-sdk-nodejs-cbs")
 
 // 导入对应产品模块的client models
-const CbsClient = tencentcloud.cbs.v20170312.Client
+const CbsClient = cbs.v20170312.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new CbsClient({
diff --git a/examples/cbs/v20170312/describe_disks.ts b/examples/cbs/v20170312/describe_disks.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { cbs } from "tencentcloud-sdk-nodejs-cbs"
 
 // 导入对应产品模块的client models
-const CbsClient = tencentcloud.cbs.v20170312.Client
+const CbsClient = cbs.v20170312.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new CbsClient({
diff --git a/examples/cls/v20201016/upload_log.js b/examples/cls/v20201016/upload_log.js
@@ -1,4 +1,4 @@
-const { CommonClient } = require("../../../tencentcloud/common/common_client")
+const { CommonClient } = require("tencentcloud-sdk-nodejs-common")
 const protobuf = require("protobufjs")
 const lz4 = require("lz4")
 const path = require("path")
diff --git a/examples/common/common_client.js b/examples/common/common_client.js
@@ -1,6 +1,4 @@
-const tencentcloud = require("../../../tencentcloud-sdk-nodejs")
-const TencentCloudCommon = tencentcloud.common;
-const CommonClient = TencentCloudCommon.CommonClient;
+const { CommonClient } = require("tencentcloud-sdk-nodejs-common")
 
 // 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密
 // 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305
diff --git a/examples/common/common_client.ts b/examples/common/common_client.ts
@@ -1,6 +1,4 @@
-import * as tencentcloud from "../../../tencentcloud-sdk-nodejs"
-const TencentCloudCommon = tencentcloud.common;
-const CommonClient = TencentCloudCommon.CommonClient;
+import { CommonClient } from "tencentcloud-sdk-nodejs-common"
 
 // 实例化一个认证对象，入参需要传入腾讯云账户 SecretId 和 SecretKey，此处还需注意密钥对的保密
 // 代码泄露可能会导致 SecretId 和 SecretKey 泄露，并威胁账号下所有资源的安全性。以下代码示例仅供参考，建议采用更安全的方式来使用密钥，请参见：https://cloud.tencent.com/document/product/1278/85305
diff --git a/examples/cvm/v20170312/describe_instances.js b/examples/cvm/v20170312/describe_instances.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../../tencentcloud-sdk-nodejs")
+const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
 
 // 导入对应产品模块的client models。
-const CvmClient = tencentcloud.cvm.v20170312.Client
+const CvmClient = cvm.v20170312.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new CvmClient({
diff --git a/examples/cvm/v20170312/describe_instances.ts b/examples/cvm/v20170312/describe_instances.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { cvm } from "tencentcloud-sdk-nodejs-cvm"
 
 // 导入对应产品模块的client models
-const CvmClient = tencentcloud.cvm.v20170312.Client
+const CvmClient = cvm.v20170312.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new CvmClient({
diff --git a/examples/cvm/v20170312/describe_zones.js b/examples/cvm/v20170312/describe_zones.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../../tencentcloud-sdk-nodejs")
+const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
 
 // 导入对应产品模块的client models。
-const CvmClient = tencentcloud.cvm.v20170312.Client
+const CvmClient = cvm.v20170312.Client
 // 实例化要请求产品的client对象
 const client = new CvmClient({
   credential: {
diff --git a/examples/cvm/v20170312/describe_zones.ts b/examples/cvm/v20170312/describe_zones.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { cvm } from "tencentcloud-sdk-nodejs-cvm"
 
 // 导入对应产品模块的client models。
-const CvmClient = tencentcloud.cvm.v20170312.Client
+const CvmClient = cvm.v20170312.Client
 
 // 实例化要请求产品的client对象
 const client = new CvmClient({
diff --git a/examples/cvm/v20170312/inquiry_price_run_instances.ts b/examples/cvm/v20170312/inquiry_price_run_instances.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../tencentcloud"
+import { cvm } from "tencentcloud-sdk-nodejs-cvm"
 
 // 导入对应产品模块的client models。
-const CvmClient = tencentcloud.cvm.v20170312.Client
+const CvmClient = cvm.v20170312.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new CvmClient({
diff --git a/examples/cvm/v20170312/run_instances.js b/examples/cvm/v20170312/run_instances.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../../tencentcloud-sdk-nodejs")
+const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
 
 // 导入对应产品模块的client models。
-const CvmClient = tencentcloud.cvm.v20170312.Client
+const CvmClient = cvm.v20170312.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new CvmClient({
diff --git a/examples/cvm/v20170312/run_instances.ts b/examples/cvm/v20170312/run_instances.ts
@@ -1,4 +1,4 @@
-import * as tencentcloud from "../../../tencentcloud"
+import { cvm } from "tencentcloud-sdk-nodejs-cvm"
 
 // 导入对应产品模块的client models。
 const CvmClient = tencentcloud.cvm.v20170312.Client
diff --git a/examples/cvm_role.js b/examples/cvm_role.js
@@ -1,27 +1,20 @@
-const tencentcloud = require("../../tencentcloud-sdk-nodejs")
-// const tencentcloud = require("tencentcloud-sdk-nodejs")
-const CvmRoleCredential = require("../../tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
-// const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
+const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
+const CvmRoleCredential = require("tencentcloud-sdk-nodejs-common/tencentcloud/common/cvm_role_credential")
 
-async function main() {
-    // 导入对应产品模块的client models。
-    const CvmClient = tencentcloud.cvm.v20170312.Client
-    // 实例化要请求产品的client对象
-    const client = new CvmClient({
-        credential: new CvmRoleCredential(),
-        region: "ap-shanghai",
-    })
-    // 通过client对象调用想要访问的接口，需要传入请求对象以及响应回调函数
-    client.DescribeZones(null, function (err, response) {
-        // 请求异常返回，打印异常信息
-        if (err) {
-            console.log(err)
-            return
-        }
-        // 请求正常返回，打印response对象
-        console.log(response)
-    })
-
-}
-
-main().catch(console.error)
+// 导入对应产品模块的client models。
+const CvmClient = cvm.v20170312.Client
+// 实例化要请求产品的client对象
+const client = new CvmClient({
+  credential: new CvmRoleCredential(),
+  region: "ap-shanghai",
+})
+// 通过client对象调用想要访问的接口，需要传入请求对象以及响应回调函数
+client.DescribeZones(null, function (err, response) {
+  // 请求异常返回，打印异常信息
+  if (err) {
+    console.log(err)
+    return
+  }
+  // 请求正常返回，打印response对象
+  console.log(response)
+})
diff --git a/examples/cvm_role.ts b/examples/cvm_role.ts
@@ -1,28 +1,20 @@
-import * as tencentcloud from "../../tencentcloud-sdk-nodejs"
-// import * as tencentcloud from "tencentcloud-sdk-nodejs"
-import CvmRoleCredential from "../../tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential"
-// import CvmRoleCredential from "tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential"
+import { cvm } from "tencentcloud-sdk-nodejs-cvm"
+import CvmRoleCredential from "tencentcloud-sdk-nodejs-common/tencentcloud/common/cvm_role_credential"
 
-
-async function main() {
-    // 导入对应产品模块的client models。
-    const CvmClient = tencentcloud.cvm.v20170312.Client
-    // 实例化要请求产品的client对象
-    const client = new CvmClient({
-        credential: new CvmRoleCredential(),
-        region: "ap-shanghai",
-    })
-    // 通过client对象调用想要访问的接口，需要传入请求对象以及响应回调函数
-    client.DescribeZones(null, function (err, response) {
-        // 请求异常返回，打印异常信息
-        if (err) {
-            console.log(err)
-            return
-        }
-        // 请求正常返回，打印response对象
-        console.log(response)
-    })
-
-}
-
-main().catch(console.error)
+// 导入对应产品模块的client models。
+const CvmClient = cvm.v20170312.Client
+// 实例化要请求产品的client对象
+const client = new CvmClient({
+  credential: new CvmRoleCredential(),
+  region: "ap-shanghai",
+})
+// 通过client对象调用想要访问的接口，需要传入请求对象以及响应回调函数
+client.DescribeZones(null, function (err, response) {
+  // 请求异常返回，打印异常信息
+  if (err) {
+    console.log(err)
+    return
+  }
+  // 请求正常返回，打印response对象
+  console.log(response)
+})
diff --git a/examples/ecc/v20181213/ecc_correct.js b/examples/ecc/v20181213/ecc_correct.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../../tencentcloud-sdk-nodejs")
+const { ecc } = require("tencentcloud-sdk-nodejs-ecc")
 
 // 导入对应产品模块的client models
-const EccClient = tencentcloud.ecc.v20181213.Client
+const EccClient = ecc.v20181213.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new EccClient({
diff --git a/examples/ecc/v20181213/ecc_correct.ts b/examples/ecc/v20181213/ecc_correct.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { ecc } from "tencentcloud-sdk-nodejs-ecc"
 
 // 导入对应产品模块的client models
-const EccClient = tencentcloud.ecc.v20181213.Client
+const EccClient = ecc.v20181213.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new EccClient({
diff --git a/examples/ecc/v20181213/ecc_ocr.js b/examples/ecc/v20181213/ecc_ocr.js
diff --git a/examples/ecc/v20181213/ecc_ocr.ts b/examples/ecc/v20181213/ecc_ocr.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { ecc } from "tencentcloud-sdk-nodejs-ecc"
 
 // 导入对应产品模块的client models
-const EccClient = tencentcloud.ecc.v20181213.Client
+const EccClient = ecc.v20181213.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new EccClient({
diff --git a/examples/hcm/v20181106/hcm_ocr.js b/examples/hcm/v20181106/hcm_ocr.js
diff --git a/examples/hcm/v20181106/hcm_ocr.ts b/examples/hcm/v20181106/hcm_ocr.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { hcm } from "tencentcloud-sdk-nodejs-hcm"
 
 // 导入对应产品模块的client models
-const HcmClient = tencentcloud.hcm.v20181106.Client
+const HcmClient = hcm.v20181106.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new HcmClient({
diff --git a/examples/hunyuan/v20230901/chat_completions.js b/examples/hunyuan/v20230901/chat_completions.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../tencentcloud")
+const { hunyuan } = require("tencentcloud-sdk-nodejs-hunyuan")
 
 // 导入对应产品模块的client models
-const HunyuanClient = tencentcloud.hunyuan.v20230901.Client
+const HunyuanClient = hunyuan.v20230901.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new HunyuanClient({
diff --git a/examples/hunyuan/v20230901/chat_completions.ts b/examples/hunyuan/v20230901/chat_completions.ts
@@ -1,9 +1,8 @@
-import * as tencentcloud from "../../../tencentcloud"
-import { SSEResponseModel } from "../../../tencentcloud/common/sse_response_model"
-import { ChatStdResponse } from "../../../tencentcloud/services/hunyuan/v20230901/hunyuan_models"
+import { hunyuan } from "tencentcloud-sdk-nodejs-hunyuan"
+import { SSEResponseModel } from 'tencentcloud-sdk-nodejs-common/tencentcloud/common/sse_response_model'
 
 // 导入对应产品模块的client models
-const HunyuanClient = tencentcloud.hunyuan.v20230901.Client
+const HunyuanClient = hunyuan.v20230901.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new HunyuanClient({
@@ -30,11 +29,11 @@ client.ChatCompletions({
   Stream: true, // 流式调用开关，默认为 true
 }).then(
   async (res) => {
-    res.on('message', (message) => {
+    (res as SSEResponseModel).on('message', (message) => {
       console.log(message)
     })
     // 或者
-    for await (let message of res) {
+    for await (let message of (res as SSEResponseModel)) {
       console.log(message)
     }
   },
diff --git a/examples/soe/v20180903/init_oral_process.js b/examples/soe/v20180903/init_oral_process.js
@@ -1,7 +1,7 @@
-const tencentcloud = require("../../../../tencentcloud-sdk-nodejs")
+const { soe } = require("tencentcloud-sdk-nodejs-soe")
 
 // 导入对应产品模块的client models
-const SoeClient = tencentcloud.soe.v20180724.Client
+const SoeClient = soe.v20180724.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new SoeClient({
diff --git a/examples/soe/v20180903/init_oral_process.ts b/examples/soe/v20180903/init_oral_process.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { soe } from "tencentcloud-sdk-nodejs-soe"
 
 // 导入对应产品模块的client models
-const SoeClient = tencentcloud.soe.v20180724.Client
+const SoeClient = soe.v20180724.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new SoeClient({
diff --git a/examples/soe/v20180903/transmit_oral_process.js b/examples/soe/v20180903/transmit_oral_process.js
diff --git a/examples/soe/v20180903/transmit_oral_process.ts b/examples/soe/v20180903/transmit_oral_process.ts
@@ -1,7 +1,7 @@
-import * as tencentcloud from "../../../../tencentcloud-sdk-nodejs"
+import { soe } from "tencentcloud-sdk-nodejs-soe"
 
 // 导入对应产品模块的client models
-const SoeClient = tencentcloud.soe.v20180724.Client
+const SoeClient = soe.v20180724.Client
 
 // 实例化要请求产品的client对象。profile可选。
 const client = new SoeClient({
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/common/http/fetch.ts b/src/common/http/fetch.ts
diff --git a/src/common/http/http_connection.ts b/src/common/http/http_connection.ts
diff --git a/src/common/sign.ts b/src/common/sign.ts
diff --git a/src/common/sse_response_model.ts b/src/common/sse_response_model.ts
diff --git a/tsconfig.es.json b/tsconfig.es.json
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-const { CommonClient } = require("../../../tencentcloud/common/common_client")`
	`1`	`+const { CommonClient } = require("tencentcloud-sdk-nodejs-common")`
`2`	`2`	`const protobuf = require("protobufjs")`
`3`	`3`	`const lz4 = require("lz4")`
`4`	`4`	`const path = require("path")`