@cloudbase/manager-node 4.1.0 → 4.1.2

package/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "typescript.tsdk": "node_modules\\typescript\\lib"
+}

package/lib/constant.js

@@ -4,7 +4,7 @@
 //     static credentail = 'credential'
 // }
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SCF_STATUS = exports.ROLE_NAME = exports.PUBLIC_RSA_KEY = exports.ERROR = exports.SERVICE_TYPE = exports.ENDPOINT = exports.RUN_ENV = exports.SDK_VERSION = exports.ENV_NAME = void 0;
+exports.COS_SDK_PROTOCOL = exports.USE_INTERNAL_ENDPOINT = exports.SCF_STATUS = exports.ROLE_NAME = exports.PUBLIC_RSA_KEY = exports.ERROR = exports.SERVICE_TYPE = exports.ENDPOINT = exports.RUN_ENV = exports.SDK_VERSION = exports.ENV_NAME = void 0;
 exports.ENV_NAME = {
     ENV_SECRETID: 'TENCENTCLOUD_SECRETID',
     ENV_SECRETKEY: 'TENCENTCLOUD_SECRETKEY',
@@ -49,3 +49,7 @@ exports.SCF_STATUS = {
     UPDATING: 'Updating',
     CREATE_FAILED: 'CreateFailed'
 };
+// 是否使用内网域名
+exports.USE_INTERNAL_ENDPOINT = "USE_INTERNAL_ENDPOINT" in process.env;
+// 允许通过环境变量指定 COS SDK 的协议为 HTTPS 或 HTTP
+exports.COS_SDK_PROTOCOL = "COS_SDK_PROTOCOL";

package/lib/env/index.js

@@ -14,6 +14,7 @@ const cos_nodejs_sdk_v5_1 = __importDefault(require("cos-nodejs-sdk-v5"));
 const util_1 = __importDefault(require("util"));
 const error_1 = require("../error");
 const utils_1 = require("../utils");
+const constant_1 = require("../constant");
 class EnvService {
     constructor(environment) {
         this.environment = environment;
@@ -254,11 +255,16 @@ class EnvService {
     }
     getCos() {
         const { secretId, secretKey, token } = this.environment.getAuthConfig();
-        return new cos_nodejs_sdk_v5_1.default({
+        const cosConfig = {
             SecretId: secretId,
             SecretKey: secretKey,
-            SecurityToken: token
-        });
+            SecurityToken: token,
+            Domain: constant_1.USE_INTERNAL_ENDPOINT ? "{Bucket}.cos-internal.{Region}.tencentcos.cn" /* INTERNAL */ : "{Bucket}.cos.{Region}.tencentcos.cn" /* PUBLIC */
+        };
+        if (constant_1.COS_SDK_PROTOCOL in process.env && process.env.COS_SDK_PROTOCOL.toLowerCase().startsWith('http')) {
+            cosConfig.Protocol = process.env.COS_SDK_PROTOCOL.toLowerCase() + ":";
+        }
+        return new cos_nodejs_sdk_v5_1.default(cosConfig);
     }
     getStorageConfig() {
         var _a;

package/lib/storage/index.js

@@ -20,6 +20,7 @@ const cos_nodejs_sdk_v5_1 = __importDefault(require("cos-nodejs-sdk-v5"));
 const utils_1 = require("../utils");
 const error_1 = require("../error");
 const parallel_1 = require("../utils/parallel");
+const constant_1 = require("../constant");
 const BIG_FILE_SIZE = 5242880; // 5MB 1024*1024*5
 class StorageService {
     constructor(environment) {
@@ -839,13 +840,18 @@ class StorageService {
     getCos(parallel = 20) {
         const { secretId, secretKey, token, proxy } = this.environment.getAuthConfig();
         const cosProxy = process.env.TCB_COS_PROXY;
-        return new cos_nodejs_sdk_v5_1.default({
+        const cosConfig = {
             FileParallelLimit: parallel,
             SecretId: secretId,
             SecretKey: secretKey,
             Proxy: cosProxy || proxy,
-            SecurityToken: token
-        });
+            SecurityToken: token,
+            Domain: constant_1.USE_INTERNAL_ENDPOINT ? "{Bucket}.cos-internal.{Region}.tencentcos.cn" /* INTERNAL */ : "{Bucket}.cos.{Region}.tencentcos.cn" /* PUBLIC */
+        };
+        if (constant_1.COS_SDK_PROTOCOL in process.env && process.env.COS_SDK_PROTOCOL.toLowerCase().startsWith('http')) {
+            cosConfig.Protocol = process.env.COS_SDK_PROTOCOL.toLowerCase() + ":";
+        }
+        return new cos_nodejs_sdk_v5_1.default(cosConfig);
     }
     /**
      * 将 cloudPath 转换成 cloudPath/ 形式

package/lib/utils/cloud-api-request.js

@@ -70,12 +70,11 @@ class CloudService {
             cam: 'https://cam.tencentcloudapi.com',
             cdn: 'https://cdn.tencentcloudapi.com'
         };
-        // 检测环境变量，云梯账号走内网域名
-        const USE_INTERNAL_ENDPOINT = "USE_INTERNAL_ENDPOINT";
+        // 云梯账号走内网域名
         const intranetUrlMap = Object.keys(urlMap).map((service) => ({
             [service]: `https://${service}.internal.tencentcloudapi.com`,
         })).reduce((acc, cur) => (Object.assign(Object.assign({}, acc), cur)), {});
-        if (USE_INTERNAL_ENDPOINT in process.env) {
+        if (constant_1.USE_INTERNAL_ENDPOINT) {
             return intranetUrlMap[this.service];
         }
         if (urlMap[this.service]) {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@cloudbase/manager-node",
-    "version": "4.1.0",
+    "version": "4.1.2",
     "description": "The node manage service api for cloudbase.",
     "main": "lib/index.js",
     "scripts": {
@@ -8,7 +8,8 @@
         "test": "jest --runInBand --detectOpenHandles --coverage --testTimeout=50000",
         "lint": "eslint \"./**/*.ts\"",
         "lint:fix": "eslint --fix \"./**/*.ts\"",
-        "prepublishOnly": "npm run build"
+        "prepublishOnly": "npm run build",
+        "watch": "rimraf lib types && tsc -w"
     },
     "repository": {
         "type": "git",

package/types/constant.d.ts

@@ -35,3 +35,9 @@ export declare const SCF_STATUS: {
     UPDATING: string;
     CREATE_FAILED: string;
 };
+export declare const USE_INTERNAL_ENDPOINT: boolean;
+export declare const enum COS_ENDPOINT {
+    INTERNAL = "{Bucket}.cos-internal.{Region}.tencentcos.cn",
+    PUBLIC = "{Bucket}.cos.{Region}.tencentcos.cn"
+}
+export declare const COS_SDK_PROTOCOL = "COS_SDK_PROTOCOL";

package/src/access/index.ts

@@ -1,168 +0,0 @@
-import { Environment } from '../environment'
-import { CloudService, preLazy } from '../utils'
-import {
-    ICreateAccessOptions,
-    IApi,
-    IUpdateOptions,
-    IService,
-    IDeleteOptions,
-    IGetOptions,
-    IDomainOptions
-} from './types'
-import { IResponseInfo } from '../interfaces'
-
-export class AccessService {
-    private tcbService: CloudService
-    private environment: Environment
-
-    constructor(environment: Environment) {
-        this.environment = environment
-        this.tcbService = new CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08')
-    }
-
-    // 创建云接入路径
-    @preLazy()
-    public async createAccess(options: ICreateAccessOptions) {
-        const { path, name, type = 1, auth } = options
-        const { envId } = this.getEnvInfo()
-
-        return this.tcbService.request<{
-            APIId: string
-            RequestId: string
-        }>('CreateCloudBaseGWAPI', {
-            ServiceId: envId,
-            Path: path,
-            Type: type,
-            Name: name,
-            AuthSwitch: auth ? 1 : 2
-        })
-    }
-
-    // 获取云接入自定义域名列表
-    @preLazy()
-    public async getDomainList() {
-        const { envId } = this.getEnvInfo()
-        return this.tcbService.request<{
-            RequestId: string
-            // 云接入默认域名
-            DefaultDomain: string
-            // 是否开启了云接入服务
-            EnableService: boolean
-            // 云接入服务列表
-            ServiceSet: IService[]
-        }>('DescribeCloudBaseGWService', {
-            ServiceId: envId
-        })
-    }
-
-    // 获取云接入服务列表
-    @preLazy()
-    public async getAccessList(options: IGetOptions = {}) {
-        const { path, name, offset, limit } = options
-        const { envId } = this.getEnvInfo()
-
-        return this.tcbService.request<{
-            RequestId: string
-            APISet: IApi[]
-            Total: number
-            Limit: number
-            Offset: number
-            EnableService: boolean
-        }>('DescribeCloudBaseGWAPI', {
-            ServiceId: envId,
-            Path: path,
-            Name: name,
-            Offset: offset,
-            limit: limit
-        })
-    }
-
-    // 切换云接入服务开关：开启/关闭
-    @preLazy()
-    public async switchAuth(auth: boolean) {
-        const { envId } = this.getEnvInfo()
-        return this.tcbService.request<{
-            Count: number
-            RequestId: string
-        }>('ModifyCloudBaseGWPrivilege', {
-            ServiceId: envId,
-            EnableService: auth,
-            Options: [
-                {
-                    Key: 'serviceswitch',
-                    Value: auth ? 'true' : 'false'
-                }
-            ]
-        })
-    }
-
-    // 更新云接入路径鉴权
-    @preLazy()
-    public async switchPathAuth(options: IUpdateOptions) {
-        const { apiIds, auth } = options
-        const { envId } = this.getEnvInfo()
-        return this.tcbService.request<{
-            Count: number
-            RequestId: string
-        }>('ModifyCloudBaseGWAPIPrivilegeBatch', {
-            ServiceId: envId,
-            APIIdSet: apiIds,
-            Options: [
-                {
-                    Key: 'authswitch',
-                    Value: auth ? 'true' : 'false'
-                }
-            ]
-        })
-    }
-
-    // 删除云接入服务
-    @preLazy()
-    public async deleteAccess(options: IDeleteOptions) {
-        const { name, type = 1, apiId } = options
-        const { envId } = this.getEnvInfo()
-
-        return this.tcbService.request<IResponseInfo>('DeleteCloudBaseGWAPI', {
-            ServiceId: envId,
-            Name: name,
-            Type: type,
-            APIId: apiId
-        })
-    }
-
-    // 添加自定义域名
-    @preLazy()
-    public async addCustomDomain(options: IDomainOptions) {
-        const { domain, certId } = options
-        const { envId } = this.getEnvInfo()
-
-        return this.tcbService.request<IResponseInfo>('BindCloudBaseGWDomain', {
-            Domain: domain,
-            ServiceId: envId,
-            CertId: certId
-        })
-    }
-
-    // 删除自定义域名
-    @preLazy()
-    public async deleteCustomDomain(domain: string) {
-        const { envId } = this.getEnvInfo()
-
-        return this.tcbService.request<IResponseInfo>('DeleteCloudBaseGWDomain', {
-            Domain: domain,
-            ServiceId: envId
-        })
-    }
-
-    private getEnvInfo() {
-        const envConfig = this.environment.lazyEnvironmentConfig
-        const appId = envConfig.Storages[0]?.AppId
-        const { proxy } = this.environment.cloudBaseContext
-
-        return {
-            appId,
-            proxy,
-            envId: envConfig.EnvId
-        }
-    }
-}

package/src/access/types.ts

@@ -1,55 +0,0 @@
-export interface ICreateAccessOptions {
-    path: string
-    // 云函数名或云应用名称
-    name: string
-    // 1 表示云函数，2 表示云应用
-    type?: 1 | 2
-    // 鉴权开关
-    auth?: boolean
-}
-
-export interface IApi {
-    ServiceId: string
-    APIId: string
-    Path: string
-    Type: number
-    Name: string
-    CreateTime: number
-    EnvId: string
-    EnableAuth: boolean
-}
-
-export interface IUpdateOptions {
-    // APIId
-    apiIds: string[]
-    // true 为开启，false 为关闭
-    auth: boolean
-}
-
-export interface IService {
-    ServiceId: string
-    Domain: string
-    OpenTime: number
-    Status?: number
-}
-
-export interface IDeleteOptions {
-    name?: string
-    type?: number
-    apiId?: string
-    path?: string
-}
-
-export interface IGetOptions {
-    path?: string
-    name?: string
-    limit?: number
-    offset?: number
-}
-
-export interface IDomainOptions {
-    // 域名
-    domain: string
-    // 腾讯云 SSL 证书 Id
-    certId?: string
-}

package/src/billing/index.ts

@@ -1,43 +0,0 @@
-import { CloudService } from '../utils'
-import { CloudBaseContext } from '../context'
-import { IServiceVersion, IGoodItem, IGenerateDealsRes, IPayDealsRes } from '../interfaces'
-
-export class BillingService {
-    static billServiceVersion: IServiceVersion = {
-        service: 'billing',
-        version: '2018-07-09'
-    }
-    private billService: CloudService
-
-    constructor(context: CloudBaseContext) {
-        this.billService = new CloudService(
-            context,
-            BillingService.billServiceVersion.service,
-            BillingService.billServiceVersion.version
-        )
-    }
-
-    /**
-     * 创建订单
-     * @param {Array<IGoodItem>} goods
-     * @returns {Promise<IGenerateDealsRes>}
-     * @memberof BillingService
-     */
-    public async GenerateDeals(goods: Array<IGoodItem>): Promise<IGenerateDealsRes> {
-        return this.billService.request<IGenerateDealsRes>('GenerateDeals', {
-            Goods: goods
-        })
-    }
-
-    /**
-     * 支付订单
-     * @param {Array<string>} orderIds
-     * @returns {Promise<IPayDealsRes>}
-     * @memberof BillingService
-     */
-    public async PayDeals(orderIds: Array<string>): Promise<IPayDealsRes> {
-        return this.billService.request<IPayDealsRes>('PayDeals', {
-            OrderIds: orderIds
-        })
-    }
-}

package/src/cam/index.ts

@@ -1,106 +0,0 @@
-import { CloudService } from '../utils'
-import { CloudBaseContext } from '../context'
-import {
-    IServiceVersion,
-    IRoleListRes,
-    ICreateRoleRes,
-    IResponseInfo,
-    IGetRoleRes
-} from '../interfaces'
-
-export class CamService {
-    static camServiceVersion: IServiceVersion = {
-        service: 'cam',
-        version: '2019-01-16'
-    }
-    private camService: CloudService
-
-    constructor(context: CloudBaseContext) {
-        this.camService = new CloudService(
-            context,
-            CamService.camServiceVersion.service,
-            CamService.camServiceVersion.version
-        )
-    }
-
-    /**
-     * 查询账户角色列表
-     * @param {number} page
-     * @param {number} rp
-     * @returns {Promise<IRoleListRes>}
-     * @memberof CamService
-     */
-    public async describeRoleList(page: number, rp: number): Promise<IRoleListRes> {
-        return this.camService.request<IRoleListRes>('DescribeRoleList', {
-            Page: page,
-            Rp: rp
-        })
-    }
-
-    /**
-     * 获取角色详情
-     * @param {string} roleName
-     * @returns {Promise<IGetRoleRes>}
-     * @memberof CamService
-     */
-    public async getRole(roleName: string): Promise<IGetRoleRes> {
-        return this.camService.request<IGetRoleRes>('GetRole', {
-            RoleName: roleName
-        })
-    }
-
-    /**
-     * 创建角色
-     * @param {{
-     *         RoleName: string
-     *         PolicyDocument: string
-     *         Description: string
-     *     }} param
-     * @returns {Promise<ICreateRoleRes>}
-     * @memberof CamService
-     */
-    public async createRole(param: {
-        RoleName: string
-        PolicyDocument: string
-        Description: string
-    }): Promise<ICreateRoleRes> {
-        return this.camService.request<ICreateRoleRes>('CreateRole', param)
-    }
-
-    /**
-     * 绑定角色策略
-     * @param {{
-     *         PolicyId: number
-     *         AttachRoleName: string
-     *     }} param
-     * @returns {Promise<IResponseInfo>}
-     * @memberof CamService
-     */
-    public async attachRolePolicy(param: {
-        PolicyId: number
-        AttachRoleName: string
-    }): Promise<IResponseInfo> {
-        return this.camService.request<IResponseInfo>('AttachRolePolicy', param)
-    }
-
-    public async attachRolePolicies(param: {
-        RoleId?: number
-        RoleName?: string
-        PolicyId?: number[]
-        PolicyName?: string[]
-    }): Promise<IResponseInfo> {
-        return this.camService.request<IResponseInfo>('AttachRolePolicies', param)
-    }
-
-    /**
-     * 删除角色
-     * @param {string} roleName
-     * @returns {Promise<IResponseInfo>}
-     * @memberof CamService
-     */
-    public async deleteRole(roleName: string): Promise<IResponseInfo> {
-        return this.camService.request<IResponseInfo>('DeleteRole', {
-            RoleName: roleName
-        })
-    }
-}

package/src/cloudBaseRun/index.ts

@@ -1,40 +0,0 @@
-import { Environment } from '../environment'
-import { CloudService, preLazy, upperCaseObjKey } from '../utils'
-import { IModifyServerFlowOption } from './types'
-import { IResponseInfo } from '../interfaces'
-
-export class CloudBaseRunService {
-    private tcbService: CloudService
-    private environment: Environment
-
-    constructor(environment: Environment) {
-        this.environment = environment
-        this.tcbService = new CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08')
-    }
-
-    // 修改容器内版本流量配置
-    @preLazy()
-    public async modifyServerFlow(
-        options: IModifyServerFlowOption
-    ): Promise<{
-        Result: string // succ代表成功
-        RequestId: string // 请求ID
-    }> {
-        const { envId } = this.getEnvInfo()
-
-        return this.tcbService.request('ModifyCloudBaseRunServerFlowConf', {
-            EnvId: envId,
-            ServerName: options.serverName,
-            VersionFlowItems: upperCaseObjKey(options.versionFlowItems)
-            // TrafficType: options.trafficType
-        })
-    }
-
-    private getEnvInfo() {
-        const envConfig = this.environment.lazyEnvironmentConfig
-
-        return {
-            envId: envConfig.EnvId
-        }
-    }
-}

package/src/cloudBaseRun/types.ts

@@ -1,24 +0,0 @@
-export interface IModifyServerFlowOption {
-    serverName: string
-    versionFlowItems?: ICloudBaseRunVersionFlowItem[]
-    trafficType?: string
-}
-
-export interface ICloudBaseRunVersionFlowItem {
-    versionName: string // 版本名称
-    flowRatio: number // 流量占比
-    urlParam?: IObjectKV // 流量参数
-    priority?: number // 优先级（数值越小，优先级越高）
-    isDefaultPriority?: boolean // 是否是默认兜底版本
-}
-
-export interface IObjectKV {
-    key: string
-    value: string
-}
-
-export interface IClouBaseRunKVPriority {
-    key: string
-    value: string
-    priority: number
-}

package/src/common/index.ts

@@ -1,54 +0,0 @@
-import { CloudService, preLazy } from '../utils'
-import { CloudBaseContext } from '../context'
-import { CloudBaseError } from '../error'
-import { Environment } from '../environment'
-
-interface ICommonApiServiceOption {
-    Action: string // 接口名称
-    Param: Record<string, any> // 接口传参
-}
-/**
- * 公共的云api调用方法 透传用户参数 无业务逻辑处理
- * @export
- * @class CommonService
- */
-
-const ActionVersionMap = {
-    tcb: '2018-06-08',
-    flexdb: '2018-11-27',
-    scf: '2018-04-16',
-    sts: '2018-04-16',
-    cam: '2018-04-16',
-    lowcode: '2021-01-08'
-}
-
-export class CommonService {
-    private commonService: CloudService
-    private environment: Environment
-
-    constructor(environment: Environment, serviceType: string, serviceVersion: string) {
-        this.environment = environment
-        this.commonService = new CloudService(
-            environment.cloudBaseContext,
-            serviceType,
-            serviceVersion || ActionVersionMap[serviceType]
-        )
-    }
-
-    /**
-     * 公共方法调用
-     * @param {ICommonApiServiceParam} param
-     * @returns {Promise<any>}
-     * @memberof CommonService
-     */
-    public async call(options: ICommonApiServiceOption): Promise<any> {
-        const { Action, Param = {} } = options
-        if (!Action) {
-            throw new CloudBaseError('缺少必填参数 Action')
-        }
-
-        const res = await this.commonService.request(Action, { ...Param })
-
-        return res
-    }
-}

package/src/constant.ts

@@ -1,56 +0,0 @@
-// // cloudbase cli 配置的字段名
-// export class ConfigItems {
-//     static credentail = 'credential'
-// }
-
-export const ENV_NAME = {
-    ENV_SECRETID: 'TENCENTCLOUD_SECRETID',
-    ENV_SECRETKEY: 'TENCENTCLOUD_SECRETKEY',
-    ENV_SESSIONTOKEN: 'TENCENTCLOUD_SESSIONTOKEN',
-    ENV_TCB_ENV_ID: 'TENCENTCLOUD_TCB_ENVID',
-    ENV_RUNENV: 'TENCENTCLOUD_RUNENV',
-    ENV_RUNENV_SCF: 'TENCENTCLOUD_RUNENV=SCF'
-}
-
-export const SDK_VERSION = 'TCB-NODE-MANAGER/1.0.O'
-
-export const RUN_ENV = {
-    SCF: 'SCF'
-}
-
-export const ENDPOINT = {
-    TCB: 'tcb.tencentcloudapi.com',
-    SCF: 'scf.tencentcloudapi.com',
-    COS: 'cos.tencentcloudapi.com',
-    FLEXDB: 'flexdb.tencentcloudapi.com'
-}
-
-export const SERVICE_TYPE = {
-    TCB: 'tcb'
-}
-
-export const ERROR = {
-    MISS_SECRET_INFO_IN_ENV: 'MISS_SECRET_INFO_IN_ENV',
-    MISS_SECRET_INFO_IN_ARGS: 'MISS_SECRET_INFO_IN_ARGS',
-    CURRENT_ENVIRONMENT_IS_NULL: 'CURRENT_ENVIRONMENT_IS_NULL',
-    ENV_ID_NOT_EXISTS: 'ENV_ID_NOT_EXISTS'
-}
-
-export const PUBLIC_RSA_KEY = `
------BEGIN PUBLIC KEY-----
-MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC0ZLB0ZpWWFsHPnDDw++Nc2wI3
-nl2uyOrIJ5FUfxt4GAmt1Faf5pgMxAnL9exEUrrUDUX8Ri1R0KyfnHQQwCvKt8T8
-bgILIJe9UB8e9dvFqgqH2oA8Vqwi0YqDcvFLFJk2BJbm/0QYtZ563FumW8LEXAgu
-UeHi/0OZN9vQ33jWMQIDAQAB
------END PUBLIC KEY-----
-`
-export const ROLE_NAME = {
-    TCB: 'TCB_QcsRole'
-}
-
-export const SCF_STATUS = {
-    ACTIVE: 'Active',
-    CREATING: 'Creating',
-    UPDATING: 'Updating',
-    CREATE_FAILED: 'CreateFailed'
-}