tencentcloud-sdk-nodejs-cii 4.0.810 → 4.1.24

package/README.md

@@ -1,36 +1,88 @@
 # 简介
 
-欢迎使用腾讯云开发者工具套件（SDK），NODEJS SDK 4.0 是云 API 3.0 平台的配套工具。目前已经支持 cvm、vpc、cbs 等产品，后续所有的云服务产品都会接入进来。新版 SDK 实现了统一化，具有各个语言版本的 SDK 使用方法相同，接口调用方式相同，统一的错误码和返回包格式这些优点。
-为方便 NODEJS 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 NODEJS 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 NODEJS SDK 并开始调用。
+欢迎使用腾讯云开发者工具套件（SDK），Node.js SDK 4.0 是云 API 3.0 平台的配套工具。
+为方便 Node.js 开发者调试和接入腾讯云产品 API，这里向您介绍适用于 Node.js 的腾讯云开发工具包，并提供首次使用开发工具包的简单示例。让您快速获取腾讯云 Node.js SDK 并开始调用。
 
 # 依赖环境
 
-1. NODEJS 10.0.0 版本及以上
-2. 从腾讯云控制台 开通相应产品
-3. 获取 SecretID、SecretKey 以及调用地址（endpoint），endpoint 一般形式为\*.tencentcloudapi.com，如 CVM 的调用地址为 cvm.tencentcloudapi.com，具体参考各产品说明。
+1. Node.js 10.0.0 版本及以上。
+2. 注意：部分产品需在 [腾讯云控制台](https://console.cloud.tencent.com/) 开通服务后才能使用。
 
 # 获取安装
 
-安装 NODEJS SDK 前，先获取安全凭证。在第一次使用云 API 之前，用户首先需要在腾讯云控制台上申请安全凭证，安全凭证包括 SecretID 和 SecretKey， SecretID 是用于标识 API 调用者的身份，SecretKey 是用于加密签名字符串和服务器端验证签名字符串的密钥。SecretKey 必须严格保管，避免泄露。
+使用 SDK 需要 API 密钥，可前往 [腾讯云控制台 - 访问密钥](https://console.cloud.tencent.com/cam/capi) 页面申请，API 密钥包括 SecretID 和 SecretKey，密钥须严格保管，避免泄露。
 
-## 通过 Npm 安装
+## 通过 npm 安装
 
-通过 npm 获取安装是使用 NODEJS SDK 的推荐方法，npm 是 NODEJS 的包管理工具。关于 npm 详细可参考[ npm 官网](https://www.npmjs.com/) 。
+通过 npm 获取安装是使用 Node.js SDK 的推荐方法，关于 npm 详细可参考 [NPM 官网](https://www.npmjs.com/) 。
 
-1. 执行以下安装命令：
-   > npm install tencentcloud-sdk-nodejs --save
-2. 在您的代码中引用对应模块代码，可参考示例。
-3. 如上引用方式会将腾讯云所有产品sdk下载到本地，可以将tencentcloud-sdk-nodejs换成tencentcloud-sdk-nodejs-cvm/cbs/vpc等，即可引用特定产品的sdk，代码中可将require("tencentcloud-sdk-nodejs")改为require("tencentcloud-sdk-nodejs-cvm/cbs/vpc")，其余不变，可参考示例，可大大节省存储空间。
+### 安装指定产品 SDK（推荐）
+
+安装 CVM SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-cvm --save
+```
+
+安装 VPC SDK：
+
+```
+npm install tencentcloud-sdk-nodejs-vpc --save
+```
+
+具体产品的缩写表请参考 [products.md](./products.md) 中的包名字段。
+
+安装指定产品 SDK 后，注意修改引入的包名：
+
+```diff
+- const tencentcloud = require("tencentcloud-sdk-nodejs")
++ const { cvm } = require("tencentcloud-sdk-nodejs-cvm")
+
+- const CvmClient = tencentcloud.cvm.v20170312.Client
++ const CvmClient = cvm.v20170312.Client
+```
+
+### 安装全产品 SDK
+
+如果项目依赖的云产品较多，可以引入全产品 SDK。
+
+```
+npm install tencentcloud-sdk-nodejs --save
+```
+
+全产品 SDK 包含所有云产品调用代码和 TypeScript 类型文件，体积偏大。对于体积敏感的场景，推荐安装指定产品 SDK。
+
+如果既希望全产品调用，又对包体积比较敏感，可以使用 Slim 版本 SDK。Slim SDK 移除类型文件，并进行了代码压缩，适合体积敏感场景使用：
+
+```
+npm install tencentcloud-sdk-slim-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
+```
 
 # 示例
 
+以云服务器产品查询可用区列表接口为例。
+
 ```js
 const tencentcloud = require("tencentcloud-sdk-nodejs")
 
@@ -73,7 +125,7 @@ client.DescribeZones().then(
 )
 ```
 
-在支持 typescript 项目中，采用如下方式调用
+在支持 TypeScript 项目中，采用如下方式调用
 
 ```js
 import * as tencentcloud from "tencentcloud-sdk-nodejs"
@@ -83,23 +135,31 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
 // ...
 ```
 
-实例化`Client` 的入参支持 `clientConfig` 数据结构和说明 详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)
+实例化 `Client` 的入参支持 `clientConfig`，数据结构和说明详见 [ClientConfig](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts)。
+
+## Common Client
+
+从 4.0.714 版本开始，腾讯云 Node.js SDK 支持使用泛用性的 API 调用方式(Common Client)进行请求。您只需要安装 tencentcloud-sdk-nodejs-common 包，即可向任何产品发起调用。
+
+**注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
+
+详细使用请参阅示例：[使用 Common Client 进行调用](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples/common)
 
 ## 更多示例
 
-更丰富的使用 demo 请在 examples 目录中寻找。
+请参考 [examples](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/tree/master/examples) 目录。
 
 # 相关配置
 
 ## 代理
 
-如果是有代理的环境下，需要配置代理，请在创建Client时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
+如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 [profile.httpProfile.proxy](https://github.com/TencentCloud/tencentcloud-sdk-nodejs/blob/master/src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
 
 # 凭证管理
 
 除显式传入凭证外，从 `v4.0.506` 起支持 [腾讯云实例角色](https://cloud.tencent.com/document/product/213/47668)
 
-在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js示例代码](./examples/cvm_role.js) 或 [ts示例代码](./examples/cvm_role.ts)
+在您为实例绑定角色后，您可以在实例中访问相关元数据接口获取临时凭证。用法可参考 [js 示例代码](./examples/cvm_role.js) 或 [ts 示例代码](./examples/cvm_role.ts)
 ```javascript
 // ...
 const CvmRoleCredential = require("tencentcloud-sdk-nodejs/tencentcloud/common/cvm_role_credential").default
@@ -111,20 +171,16 @@ new XxxClient({
 })
 ```
 
-# 旧版 SDK
-
-我们推荐使用新版 NODEJS SDK，如果一定要用旧版 SDK，请前往[github 仓库](https://github.com/CFETeam/qcloudapi-sdk)下载。
-
 # 常见问题
-- webpack打包出错/浏览器报错
+- webpack 打包出错/浏览器报错
 
-  请**务必不要**将此sdk直接用于web前端(包括小程序等)，暴露密钥在这些环境非常不安全。
+  请**务必不要**将此 SDK 直接用于 Web 前端（包括小程序等），暴露密钥在这些环境非常不安全。
 
-  正确的做法是在自己的服务端引用此sdk，并保存好密钥，做好请求鉴权；前端再调用服务端执行业务流程。
+  正确的做法是在自己的服务端引用此 SDK，并保存好密钥，做好请求鉴权，前端再调用服务端执行业务流程。
 
 - `The "original" argument must be of type Function.`
 
-  通常是因为nodejs版本低于 `v10` ，或处于非node环境，请再次确认执行环境。
+  通常是因为 Node.js 版本低于 `v10` ，或处于非 Node.js 环境，请再次确认执行环境。
 
 - 请求不通
 

package/es/index.js

@@ -0,0 +1 @@
+export * from "./services";

package/es/services/cii/index.js

@@ -0,0 +1,6 @@
+import { v20201210 } from "./v20201210";
+import { v20210408 } from "./v20210408";
+export const cii = {
+    v20201210: v20201210,
+    v20210408: v20210408,
+};

package/es/services/cii/v20201210/cii_client.js

@@ -0,0 +1,15 @@
+import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
+export class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig) {
+        super("cii.tencentcloudapi.com", "2020-12-10", clientConfig);
+    }
+    async DescribeStructCompareData(req, cb) {
+        return this.request("DescribeStructCompareData", req, cb);
+    }
+    async DescribeStructureTaskResult(req, cb) {
+        return this.request("DescribeStructureTaskResult", req, cb);
+    }
+    async CreateStructureTask(req, cb) {
+        return this.request("CreateStructureTask", req, cb);
+    }
+}

package/es/services/cii/v20201210/index.js

@@ -0,0 +1,6 @@
+import * as Models from "./cii_models";
+import { Client } from "./cii_client";
+export const v20201210 = {
+    Client: Client,
+    Models: Models,
+};

package/es/services/cii/v20210408/cii_client.js

@@ -0,0 +1,51 @@
+import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
+export class Client extends TencentCloudCommon.AbstractClient {
+    constructor(clientConfig) {
+        super("cii.tencentcloudapi.com", "2021-04-08", clientConfig);
+    }
+    async DescribeStructureDifference(req, cb) {
+        return this.request("DescribeStructureDifference", req, cb);
+    }
+    async DescribeStructureTaskResult(req, cb) {
+        return this.request("DescribeStructureTaskResult", req, cb);
+    }
+    async UploadMedicalFile(req, cb) {
+        let options = {
+            multipart: true,
+        };
+        return this.request("UploadMedicalFile", req, cb);
+    }
+    async CreateUnderwriteTaskById(req, cb) {
+        return this.request("CreateUnderwriteTaskById", req, cb);
+    }
+    async DescribeUnderwriteTask(req, cb) {
+        return this.request("DescribeUnderwriteTask", req, cb);
+    }
+    async DescribeMachineUnderwrite(req, cb) {
+        return this.request("DescribeMachineUnderwrite", req, cb);
+    }
+    async CreateStructureTask(req, cb) {
+        return this.request("CreateStructureTask", req, cb);
+    }
+    async CreateAutoClassifyStructureTask(req, cb) {
+        return this.request("CreateAutoClassifyStructureTask", req, cb);
+    }
+    async DescribeStructCompareData(req, cb) {
+        return this.request("DescribeStructCompareData", req, cb);
+    }
+    async DescribeQualityScore(req, cb) {
+        let options = {
+            multipart: true,
+        };
+        return this.request("DescribeQualityScore", req, cb);
+    }
+    async DescribeStructureResult(req, cb) {
+        return this.request("DescribeStructureResult", req, cb);
+    }
+    async DescribeReportClassify(req, cb) {
+        return this.request("DescribeReportClassify", req, cb);
+    }
+    async AddSubStructureTasks(req, cb) {
+        return this.request("AddSubStructureTasks", req, cb);
+    }
+}

package/es/services/cii/v20210408/index.js

@@ -0,0 +1,6 @@
+import * as Models from "./cii_models";
+import { Client } from "./cii_client";
+export const v20210408 = {
+    Client: Client,
+    Models: Models,
+};

package/es/services/index.js

@@ -0,0 +1 @@
+export { cii } from "./cii";

package/package.json

@@ -1,16 +1,26 @@
 {
   "name": "tencentcloud-sdk-nodejs-cii",
-  "version": "4.0.810",
-  "description": "Tencent Cloud API NODEJS SDK",
-  "main": "tencentcloud/index.js",
+  "version": "4.1.24",
+  "description": "腾讯云 API NODEJS SDK",
+  "main": "./tencentcloud/index.js",
+  "module": "./es/index.js",
+  "types": "./tencentcloud/index.d.ts",
   "scripts": {
     "test": "mocha -t 10000",
-    "build": "tsc",
-    "prettier": "prettier --config prettier.config.js --write 'src/**/*.{tsx,ts,jsx,js,css,json,vue}'"
+    "build": "concurrently 'npm:build:cjs' 'npm:build:es'",
+    "build:cjs": "tsc -p tsconfig.json",
+    "build:es": "tsc -p tsconfig.es.json",
+    "build:slim": "node ./scripts/build_slim.js",
+    "prettier": "prettier --config prettier.config.js --write 'src/**/*.{tsx,ts,jsx,js,css,json,vue}'",
+    "clean": "rimraf tencentcloud es"
   },
   "engines": {
     "node": ">=10"
   },
+  "files": [
+    "tencentcloud",
+    "es"
+  ],
   "keywords": [
     "tencentcloudapi",
     "tencentcloud",
@@ -22,7 +32,8 @@
   "author": "tencentcloudapi",
   "license": "Apache-2.0",
   "dependencies": {
-    "tencentcloud-sdk-nodejs-common": "^4.0.488"
+    "tencentcloud-sdk-nodejs-common": "*",
+    "tslib": "1.13.0"
   },
   "directories": {
     "example": "examples",
@@ -34,14 +45,22 @@
   },
   "devDependencies": {
     "@types/form-data": "^2.5.0",
+    "@types/json-bigint": "^1.0.1",
     "@types/node": "^14.0.26",
     "@types/node-fetch": "^2.5.7",
+    "@types/uuid": "^9.0.8",
     "@typescript-eslint/eslint-plugin": "^2.34.0",
     "@typescript-eslint/parser": "^2.34.0",
+    "babel-eslint": "^10.0.2",
     "chai": "^4.2.0",
+    "concurrently": "^6.5.1",
+    "esbuild": "^0.25.0",
     "eslint": "^6.8.0",
-    "mocha": "^8.1.1",
+    "eslint-plugin-react": "^7.17.0",
+    "mocha": "^8.4.0",
+    "prettier": "^2.3.0",
+    "rimraf": "^5.0.10",
     "ts-node": "^8.10.2",
     "typescript": "^3.9.7"
   }
-}
+}

package/tencentcloud/services/cii/index.d.ts

@@ -1,10 +1,10 @@
 export declare const cii: {
-    v20210408: {
-        Client: typeof import("./v20210408/cii_client").Client;
-        Models: typeof import("./v20210408/cii_models");
-    };
     v20201210: {
         Client: typeof import("./v20201210/cii_client").Client;
         Models: typeof import("./v20201210/cii_models");
     };
+    v20210408: {
+        Client: typeof import("./v20210408/cii_client").Client;
+        Models: typeof import("./v20210408/cii_models");
+    };
 };

package/tencentcloud/services/cii/index.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.cii = void 0;
-const v20210408_1 = require("./v20210408");
 const v20201210_1 = require("./v20201210");
+const v20210408_1 = require("./v20210408");
 exports.cii = {
-    v20210408: v20210408_1.v20210408,
     v20201210: v20201210_1.v20201210,
+    v20210408: v20210408_1.v20210408,
 };

package/tencentcloud/services/cii/v20201210/cii_client.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
+const tslib_1 = require("tslib");
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /*
  * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
@@ -18,7 +19,7 @@ exports.Client = void 0;
  * specific language governing permissions and limitations
  * under the License.
  */
-const TencentCloudCommon = require("tencentcloud-sdk-nodejs-common");
+const TencentCloudCommon = tslib_1.__importStar(require("tencentcloud-sdk-nodejs-common"));
 /**
  * cii client
  * @class

package/tencentcloud/services/cii/v20201210/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.v20201210 = void 0;
-const Models = require("./cii_models");
+const tslib_1 = require("tslib");
+const Models = tslib_1.__importStar(require("./cii_models"));
 const cii_client_1 = require("./cii_client");
 exports.v20201210 = {
     Client: cii_client_1.Client,

package/tencentcloud/services/cii/v20210408/cii_client.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Client = void 0;
+const tslib_1 = require("tslib");
 /* eslint-disable @typescript-eslint/no-unused-vars */
 /*
  * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
@@ -18,7 +19,7 @@ exports.Client = void 0;
  * specific language governing permissions and limitations
  * under the License.
  */
-const TencentCloudCommon = require("tencentcloud-sdk-nodejs-common");
+const TencentCloudCommon = tslib_1.__importStar(require("tencentcloud-sdk-nodejs-common"));
 /**
  * cii client
  * @class

package/tencentcloud/services/cii/v20210408/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.v20210408 = void 0;
-const Models = require("./cii_models");
+const tslib_1 = require("tslib");
+const Models = tslib_1.__importStar(require("./cii_models"));
 const cii_client_1 = require("./cii_client");
 exports.v20210408 = {
     Client: cii_client_1.Client,

package/index.d.ts

@@ -1,2 +0,0 @@
-import * as tencentcloud from './tencentcloud';
-export default tencentcloud;

package/index.js

@@ -1,6 +0,0 @@
-'use strict'
-Object.defineProperty(exports, '__esModule', { value: true })
-const tslib_1 = require('tslib')
-const tencentcloud = tslib_1.__importStar(require('./tencentcloud'))
-exports.default = tencentcloud
-//# sourceMappingURL=index.js.map

package/prettier.config.js

@@ -1,38 +0,0 @@
-// prettier.config.js
-module.exports = {
-  // 一行最多 100 字符
-  printWidth: 100,
-  // 使用 4 个空格缩进
-  tabWidth: 2,
-  // 不使用缩进符，而使用空格
-  useTabs: false,
-  // 行尾需要有分号
-  semi: false,
-  // 使用单引号
-  singleQuote: false,
-  // 对象的 key 仅在必要时用引号
-  quoteProps: "as-needed",
-  // jsx 不使用单引号，而使用双引号
-  jsxSingleQuote: false,
-  // 末尾不需要逗号
-  trailingComma: "es5",
-  // 大括号内的首尾需要空格
-  bracketSpacing: true,
-  // jsx 标签的反尖括号需要换行
-  jsxBracketSameLine: false,
-  // 箭头函数，只有一个参数的时候，也需要括号
-  arrowParens: "always",
-  // 每个文件格式化的范围是文件的全部内容
-  rangeStart: 0,
-  rangeEnd: Infinity,
-  // 不需要写文件开头的 @prettier
-  requirePragma: false,
-  // 不需要自动在文件开头插入 @prettier
-  insertPragma: false,
-  // 使用默认的折行标准
-  proseWrap: "preserve",
-  // 根据显示样式决定 html 要不要折行
-  htmlWhitespaceSensitivity: "css",
-  // 换行符使用 lf
-  endOfLine: "lf",
-}