tencentcloud-sdk-nodejs 4.0.1042-beta.1 → 4.0.1042-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tencentcloud-sdk-nodejs",
-  "version": "4.0.1042-beta.1",
+  "version": "4.0.1042-beta.2",
   "description": "腾讯云 API NODEJS SDK",
   "main": "./tencentcloud/index.js",
   "module": "./es/index.js",

package/tencentcloud/common/abstract_client.d.ts

@@ -0,0 +1,62 @@
+import { ClientProfile, Credential, ClientConfig, HttpProfile, DynamicCredential } from "./interface";
+export declare type ResponseCallback<TReuslt = any> = (error: string, rep: TReuslt) => void;
+export interface RequestOptions extends Partial<Pick<HttpProfile, "headers">> {
+    multipart?: boolean;
+    /**
+     * 中止请求信号
+     */
+    signal?: AbortSignal;
+}
+declare type ResponseData = any;
+/**
+ * @inner
+ */
+export declare class AbstractClient {
+    sdkVersion: string;
+    path: string;
+    credential: Credential | DynamicCredential;
+    region: string;
+    apiVersion: string;
+    endpoint: string;
+    profile: ClientProfile;
+    /**
+     * 实例化client对象
+     * @param {string} endpoint 接入点域名
+     * @param {string} version 产品版本
+     * @param {Credential} credential 认证信息实例
+     * @param {string} region 产品地域
+     * @param {ClientProfile} profile 可选配置实例
+     */
+    constructor(endpoint: string, version: string, { credential, region, profile }: ClientConfig);
+    getCredential(): Promise<Credential>;
+    /**
+     * @inner
+     */
+    request(action: string, req: any, options?: ResponseCallback | RequestOptions, cb?: ResponseCallback): Promise<ResponseData>;
+    /**
+     * @inner
+     */
+    requestOctetStream(action: string, req: any, options?: ResponseCallback | RequestOptions, cb?: ResponseCallback): Promise<any>;
+    /**
+     * @inner
+     */
+    private doRequest;
+    /**
+     * @inner
+     */
+    private doRequestWithSign3;
+    private parseResponse;
+    /**
+     * @inner
+     */
+    private mergeData;
+    /**
+     * @inner
+     */
+    private formatRequestData;
+    /**
+     * @inner
+     */
+    private formatSignString;
+}
+export {};

package/tencentcloud/common/abstract_client.js

@@ -9,9 +9,23 @@ const http_connection_1 = require("./http/http_connection");
 const tencent_cloud_sdk_exception_1 = tslib_1.__importDefault(require("./exception/tencent_cloud_sdk_exception"));
 const sse_response_model_1 = require("./sse_response_model");
 const uuid_1 = require("uuid");
+/**
+ * @inner
+ */
 class AbstractClient {
+    /**
+     * 实例化client对象
+     * @param {string} endpoint 接入点域名
+     * @param {string} version 产品版本
+     * @param {Credential} credential 认证信息实例
+     * @param {string} region 产品地域
+     * @param {ClientProfile} profile 可选配置实例
+     */
     constructor(endpoint, version, { credential, region, profile = {} }) {
         this.path = "/";
+        /**
+         * 认证信息实例
+         */
         if (credential && "getCredential" in credential) {
             this.credential = credential;
         }
@@ -22,10 +36,17 @@ class AbstractClient {
                 token: null,
             }, credential);
         }
+        /**
+         * 产品地域
+         */
         this.region = region || null;
         this.sdkVersion = "SDK_NODEJS_" + sdk_version_1.sdkVersion;
         this.apiVersion = version;
         this.endpoint = (profile && profile.httpProfile && profile.httpProfile.endpoint) || endpoint;
+        /**
+         * 可选配置实例
+         * @type {ClientProfile}
+         */
         this.profile = {
             signMethod: (profile && profile.signMethod) || "TC3-HMAC-SHA256",
             httpProfile: Object.assign({
@@ -46,6 +67,9 @@ class AbstractClient {
         }
         return this.credential;
     }
+    /**
+     * @inner
+     */
     async request(action, req, options, cb) {
         if (typeof options === "function") {
             cb = options;
@@ -61,6 +85,9 @@ class AbstractClient {
             throw e;
         }
     }
+    /**
+     * @inner
+     */
     async requestOctetStream(action, req, options, cb) {
         if (typeof options === "function") {
             cb = options;
@@ -80,6 +107,9 @@ class AbstractClient {
             throw e;
         }
     }
+    /**
+     * @inner
+     */
     async doRequest(action, req, options = {}) {
         if (this.profile.signMethod === "TC3-HMAC-SHA256") {
             return this.doRequestWithSign3(action, req, options);
@@ -116,6 +146,9 @@ class AbstractClient {
         }
         return this.parseResponse(res);
     }
+    /**
+     * @inner
+     */
     async doRequestWithSign3(action, params, options = {}) {
         const headers = Object.assign({}, this.profile.httpProfile.headers, options.headers);
         let traceId = "";
@@ -182,6 +215,9 @@ class AbstractClient {
             }
         }
     }
+    /**
+     * @inner
+     */
     mergeData(data, prefix = "") {
         const ret = {};
         for (const k in data) {
@@ -197,6 +233,9 @@ class AbstractClient {
         }
         return ret;
     }
+    /**
+     * @inner
+     */
     async formatRequestData(action, params) {
         params.Action = action;
         params.RequestClient = this.sdkVersion;
@@ -223,6 +262,9 @@ class AbstractClient {
         params.Signature = sign_1.default.sign(credential.secretKey, signStr, this.profile.signMethod);
         return params;
     }
+    /**
+     * @inner
+     */
     formatSignString(params) {
         let strParam = "";
         const keys = Object.keys(params);
@@ -231,6 +273,7 @@ class AbstractClient {
             if (!keys.hasOwnProperty(k)) {
                 continue;
             }
+            //k = k.replace(/_/g, '.');
             strParam += "&" + keys[k] + "=" + params[keys[k]];
         }
         const strSign = this.profile.httpProfile.reqMethod.toLocaleUpperCase() +

package/tencentcloud/common/common_client.d.ts

@@ -0,0 +1,3 @@
+import { AbstractClient } from "./abstract_client";
+export declare class CommonClient extends AbstractClient {
+}

package/tencentcloud/common/cvm_role_credential.d.ts

@@ -0,0 +1,17 @@
+import { Credential, DynamicCredential } from "./interface";
+interface CvmRoleCredentialResult {
+    TmpSecretId: string;
+    TmpSecretKey: string;
+    ExpiredTime: 1671330188;
+    Expiration: string;
+    Token: string;
+    Code: string;
+}
+export default class CvmRoleCredential implements DynamicCredential {
+    protected roleNameTask: Promise<string> | null;
+    protected credentialTask: Promise<CvmRoleCredentialResult> | null;
+    protected getRoleName(): Promise<string>;
+    protected getRoleCredential(roleName: string): Promise<CvmRoleCredentialResult>;
+    getCredential(): Promise<Credential>;
+}
+export {};

package/tencentcloud/common/cvm_role_credential.js

@@ -33,6 +33,7 @@ class CvmRoleCredential {
             this.credentialTask = this.getRoleCredential(roleName);
         }
         const credential = await this.credentialTask;
+        // expired
         if (credential.ExpiredTime * 1000 - EXPIRE_BUFFER <= Date.now()) {
             this.credentialTask = null;
             return this.getCredential();

package/tencentcloud/common/exception/tencent_cloud_sdk_exception.d.ts

@@ -0,0 +1,27 @@
+/**
+ * @inner
+ */
+export default class TencentCloudSDKHttpException extends Error {
+    /**
+     * 请求id
+     */
+    requestId: string;
+    /**
+     * 请求traceId
+     */
+    traceId: string;
+    /**
+     * http状态码
+     */
+    httpCode?: number;
+    /**
+     * 接口返回状态码
+     */
+    code?: string;
+    constructor(error: string, requestId?: string, traceId?: string);
+    getMessage(): string;
+    getRequestId(): string;
+    getTraceId(): string;
+    toString(): string;
+    toLocaleString(): string;
+}

package/tencentcloud/common/exception/tencent_cloud_sdk_exception.js

@@ -1,5 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @inner
+ */
 class TencentCloudSDKHttpException extends Error {
     constructor(error, requestId = "", traceId = "") {
         super(error);

package/tencentcloud/common/http/fetch.d.ts

@@ -0,0 +1,7 @@
+import { RequestInit, Response } from "node-fetch";
+export interface FetchOptions extends Omit<RequestInit, "signal"> {
+    proxy?: string;
+    headers?: Record<string, string>;
+    signal?: AbortSignal;
+}
+export default function (url: string, options: FetchOptions): Promise<Response>;

package/tencentcloud/common/http/http_connection.d.ts

@@ -0,0 +1,38 @@
+/// <reference types="node" />
+import { Response } from "node-fetch";
+import { Agent } from "http";
+/**
+ * @inner
+ */
+export declare class HttpConnection {
+    static doRequest({ method, url, data, timeout, headers, agent, proxy, signal, }: {
+        method: string;
+        url: string;
+        data: any;
+        timeout: number;
+        headers?: Record<string, string>;
+        agent?: Agent;
+        proxy?: string;
+        signal?: AbortSignal;
+    }): Promise<Response>;
+    static doRequestWithSign3({ method, url, data, service, action, region, version, secretId, secretKey, multipart, timeout, token, requestClient, language, headers, agent, proxy, signal, }: {
+        method: string;
+        url: string;
+        data: any;
+        service: string;
+        action: string;
+        region: string;
+        version: string;
+        secretId: string;
+        secretKey: string;
+        multipart?: boolean;
+        timeout?: number;
+        token: string;
+        requestClient: string;
+        language: string;
+        headers?: Record<string, string>;
+        agent?: Agent;
+        proxy?: string;
+        signal?: AbortSignal;
+    }): Promise<Response>;
+}

package/tencentcloud/common/http/http_connection.js

@@ -11,6 +11,9 @@ const sign_1 = tslib_1.__importDefault(require("../sign"));
 const fetch_1 = tslib_1.__importDefault(require("./fetch"));
 const json_bigint_1 = tslib_1.__importDefault(require("json-bigint"));
 const JSONbigNative = json_bigint_1.default({ useNativeBigInt: true });
+/**
+ * @inner
+ */
 class HttpConnection {
     static async doRequest({ method, url, data, timeout, headers = {}, agent, proxy, signal, }) {
         const config = {
@@ -31,12 +34,17 @@ class HttpConnection {
         return await fetch_1.default(url, config);
     }
     static async doRequestWithSign3({ method, url, data, service, action, region, version, secretId, secretKey, multipart = false, timeout = 60000, token, requestClient, language, headers = {}, agent, proxy, signal, }) {
+        // data 中可能带有 readStream，由于需要计算整个 body 的 hash，
+        // 所以这里把 readStream 转为 Buffer
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
         await convertReadStreamToBuffer(data);
+        // eslint-disable-next-line @typescript-eslint/no-use-before-define
         data = deepRemoveNull(data);
         const timestamp = parseInt(String(new Date().getTime() / 1000));
         method = method.toUpperCase();
         let payload = "";
         if (method === "GET") {
+            // eslint-disable-next-line @typescript-eslint/no-use-before-define
             data = mergeData(data);
             url += "?" + querystring_1.default.stringify(data);
         }

package/tencentcloud/common/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./abstract_client";
+export * from "./common_client";
+export * from "./interface";

package/tencentcloud/common/interface.d.ts

@@ -0,0 +1,117 @@
+/// <reference types="node" />
+import { Agent } from "http";
+/**
+ * 初始化client对象参数类型
+ */
+export interface ClientConfig {
+    /**
+     * @param {Credential} credential 认证信息
+     * 必选
+     */
+    credential: Credential | DynamicCredential;
+    /**
+     * @param {string} region 产品地域
+     * 对于要求区分地域的产品，此参数必选（如 cvm）；对于不区分地域的产品（如 sms），无需传入。
+     */
+    region?: string;
+    /**
+     * @param {ClientProfile} profile 可选配置实例
+     * 可选，没有特殊需求可以跳过。
+     */
+    profile?: ClientProfile;
+}
+/**
+ * 可选配置实例
+ */
+export interface ClientProfile {
+    /**
+     * 签名方法 (TC3-HMAC-SHA256 HmacSHA1 HmacSHA256)
+     * @type {string}
+     * 非必选
+     */
+    signMethod?: "TC3-HMAC-SHA256" | "HmacSHA256" | "HmacSHA1";
+    /**
+     * http相关选项实例
+     * @type {HttpProfile}
+     * 非必选
+     */
+    httpProfile?: HttpProfile;
+    /**
+     * api请求时附带的 language 字段
+     * @type {"zh-CN" | "en-US"}
+     * 非必选
+     */
+    language?: "zh-CN" | "en-US";
+}
+export interface HttpProfile {
+    /**
+     * 请求方法
+     * @type {"POST" | "GET"}
+     * 非必选
+     */
+    reqMethod?: "POST" | "GET";
+    /**
+     * 接入点域名，形如（cvm.ap-shanghai.tencentcloud.com）
+     * @type {string}
+     * 非必选
+     */
+    endpoint?: string;
+    /**
+     * 协议，目前支持（https://）
+     * @type {string}
+     * 非必选
+     */
+    protocol?: string;
+    /**
+     *  请求超时时间，默认60s
+     * @type {number}
+     * 非必选
+     */
+    reqTimeout?: number;
+    /**
+     * 自定义请求头，例如 { "X-TC-TraceId": "ffe0c072-8a5d-4e17-8887-a8a60252abca" }
+     * @type {Record<string, string>}
+     * 非必选
+     */
+    headers?: Record<string, string>;
+    /**
+     * 高级请求代理，例如 new HttpsProxyAgent("http://127.0.0.1:8899")
+     *
+     * 优先级高于 proxy 配置
+     */
+    agent?: Agent;
+    /**
+     * http请求代理，例如 "http://127.0.0.1:8899"
+     */
+    proxy?: string;
+}
+/**
+ * ClientProfile.language 属性支持的取值列表
+ */
+export declare const SUPPORT_LANGUAGE_LIST: string[];
+/**
+ * 认证信息类
+ */
+export interface Credential {
+    /**
+     * 腾讯云账户secretId，secretKey
+     * 非必选，和 token 二选一
+     */
+    secretId?: string;
+    /**
+     * 腾讯云账户secretKey
+     * 非必选，和 token 二选一
+     */
+    secretKey?: string;
+    /**
+     * 腾讯云账户token
+     * 非必选，和 secretId 二选一
+     */
+    token?: string;
+}
+/**
+ * 动态认证信息
+ */
+export interface DynamicCredential {
+    getCredential(): Promise<Credential>;
+}

package/tencentcloud/common/interface.js

@@ -1,4 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SUPPORT_LANGUAGE_LIST = void 0;
+/**
+ * ClientProfile.language 属性支持的取值列表
+ */
 exports.SUPPORT_LANGUAGE_LIST = ["zh-CN", "en-US"];

package/tencentcloud/common/sdk_version.d.ts

@@ -0,0 +1 @@
+export declare const sdkVersion = "4.0.1041";

package/tencentcloud/common/sign.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @inner
+ */
+export default class Sign {
+    static sign(secretKey: string, signStr: string, signMethod: string): string;
+    static sign3({ method, url, payload, timestamp, service, secretId, secretKey, multipart, boundary, headers: configHeaders, }: {
+        method?: string;
+        url?: string;
+        payload: any;
+        timestamp: number;
+        service: string;
+        secretId: string;
+        secretKey: string;
+        multipart: boolean;
+        boundary: string;
+        headers: Record<string, string>;
+    }): string;
+}

package/tencentcloud/common/sign.js

@@ -6,6 +6,9 @@ const crypto = tslib_1.__importStar(require("crypto"));
 const url_1 = require("url");
 const json_bigint_1 = tslib_1.__importDefault(require("json-bigint"));
 const JSONbigNative = json_bigint_1.default({ useNativeBigInt: true });
+/**
+ * @inner
+ */
 class Sign {
     static sign(secretKey, signStr, signMethod) {
         const signMethodMap = {
@@ -21,6 +24,7 @@ class Sign {
     static sign3({ method = "POST", url = "", payload, timestamp, service, secretId, secretKey, multipart, boundary, headers: configHeaders = {}, }) {
         const urlObj = new url_1.URL(url);
         const contentType = configHeaders["Content-Type"];
+        // 通用头部
         let headers = "";
         let signedHeaders = "";
         if (method === "GET") {

package/tencentcloud/common/sse_response_model.d.ts

@@ -0,0 +1,32 @@
+/// <reference types="node" />
+interface EventSourceMessage {
+    /** The event ID to set the EventSource object's last event ID value. */
+    id: string;
+    /** A string identifying the type of event described. */
+    event: string;
+    /** The event data */
+    data: string;
+    /** The reconnection interval (in milliseconds) to wait before retrying the connection */
+    retry?: number;
+}
+export declare class SSEResponseModel {
+    private stream;
+    private eventSource;
+    constructor(stream: NodeJS.ReadableStream);
+    /**
+     * @inner
+     */
+    private init;
+    /**
+     * @inner
+     */
+    private parseSSEMessage;
+    on(event: "message", listener: (message: EventSourceMessage) => void): this;
+    on(event: "close", listener: () => void): this;
+    on(event: "error", listener: (err: Error) => void): this;
+    removeListener(event: "message", listener: (message: EventSourceMessage) => void): this;
+    removeListener(event: "close", listener: () => void): this;
+    removeListener(event: "error", listener: (err: Error) => void): this;
+    [Symbol.asyncIterator](): AsyncIterableIterator<EventSourceMessage>;
+}
+export {};

package/tencentcloud/common/sse_response_model.js

@@ -10,6 +10,9 @@ class SSEResponseModel {
         this.eventSource = new SSEEventEmitter();
         this.init();
     }
+    /**
+     * @inner
+     */
     init() {
         const { stream, eventSource } = this;
         stream.on("data", (chunk) => {
@@ -29,6 +32,9 @@ class SSEResponseModel {
             eventSource.emit("error", err);
         });
     }
+    /**
+     * @inner
+     */
     parseSSEMessage(chunk) {
         const message = {
             data: "",
@@ -39,9 +45,10 @@ class SSEResponseModel {
         const lines = chunk.split("\n");
         for (let i = 0; i < lines.length; i++) {
             const line = lines[i];
+            // line is of format "<field>:<value>" or "<field>: <value>"
             const colonIndex = line.indexOf(":");
             if (colonIndex <= 0)
-                continue;
+                continue; // exclude comments and lines with no values
             const field = line.slice(0, colonIndex);
             const value = line.slice(colonIndex + (line[colonIndex + 1] === " " ? 2 : 1));
             switch (field) {
@@ -57,6 +64,7 @@ class SSEResponseModel {
                 case "retry":
                     const retry = parseInt(value, 10);
                     if (!isNaN(retry)) {
+                        // per spec, ignore non-integers
                         message.retry = retry;
                     }
                     break;

package/tencentcloud/index.d.ts

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