@cloudbase/manager-node 4.2.4 → 4.2.6

package/lib/env/index.js

@@ -0,0 +1,288 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvService = void 0;
+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;
+        this.envId = environment.getEnvId();
+        this.envType = environment.getEnvType();
+        this.cloudService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
+    }
+    /**
+     * 列出所有环境
+     * @returns {Promise<IListEnvRes>}
+     */
+    async listEnvs() {
+        return this.cloudService.request('DescribeEnvs');
+    }
+    /**
+     * 拉取安全域名列表
+     * @returns {Promise<IAuthDomainsRes>}
+     */
+    async getEnvAuthDomains() {
+        return this.cloudService.request('DescribeAuthDomains', {
+            EnvId: this.envId
+        });
+    }
+    /**
+     * 添加环境安全域名
+     * @param {string[]} domains 域名字符串数组
+     * @returns {Promise<IResponseInfo>}
+     */
+    async createEnvDomain(domains) {
+        const res = await this.cloudService.request('CreateAuthDomain', {
+            EnvId: this.envId,
+            Domains: domains
+        });
+        // 添加 COS CORS 域名
+        const promises = domains.map(async (domain) => {
+            this.modifyCosCorsDomain(domain);
+        });
+        await Promise.all(promises);
+        return res;
+    }
+    /**
+     * 删除环境安全域名
+     * @param {string[]} domainIds 域名字符串数组
+     * @returns {Promise<IDeleteDomainRes>}
+     */
+    async deleteEnvDomain(domains) {
+        // 根据域名获取域名 Id
+        const { Domains } = await this.getEnvAuthDomains();
+        const domainIds = Domains.filter(item => domains.includes(item.Domain)).map(item => item.Id);
+        const res = await this.cloudService.request('DeleteAuthDomain', {
+            EnvId: this.envId,
+            DomainIds: domainIds
+        });
+        // 删除 COS CORS 域名
+        const promises = domains.map(async (domain) => {
+            this.modifyCosCorsDomain(domain, true);
+        });
+        await Promise.all(promises);
+        return res;
+    }
+    /**
+     * 检查tcb服务是否开通
+     * @returns {Promise<ICheckTcbServiceRes>}
+     * @memberof CamService
+     */
+    async checkTcbService() {
+        return this.cloudService.request('CheckTcbService', {});
+    }
+    /**
+     * 初始化TCB
+     * @returns {Promise<IResponseInfo>}
+     * @memberof EnvService
+     */
+    async initTcb(param) {
+        let initParam = {};
+        if (param) {
+            initParam = Object.assign({}, param);
+        }
+        return this.cloudService.request('InitTcb', initParam);
+    }
+    /**
+     * 开通后付费套餐
+     * @param {string} envId
+     * @param {SOURCE} [source]
+     * @returns {Promise<ICreatePostpayRes>}
+     * @memberof EnvService
+     */
+    async CreatePostpayPackage(envId, source) {
+        const realSource = source ? source : 'qcloud';
+        return this.cloudService.request('CreatePostpayPackage', {
+            EnvId: envId,
+            Source: realSource
+        });
+    }
+    /**
+     * 销毁环境
+     * @param {string} envId
+     * @returns {Promise<IResponseInfo>}
+     * @memberof EnvService
+     */
+    async destroyEnv(envId) {
+        return this.cloudService.request('DestroyEnv', {
+            EnvId: envId
+        });
+    }
+    /**
+     * 获取环境信息
+     * @returns {Promise<IEnvInfoRes>}
+     */
+    async getEnvInfo() {
+        // NOTE: DescribeEnv 接口废弃，需要使用 DescribeEnvs 接口
+        const params = {
+            EnvId: this.envId
+        };
+        if (this.envType === 'run') {
+            params.EnvType = 'run';
+        }
+        const { EnvList, RequestId } = await this.cloudService.request('DescribeEnvs', params);
+        return {
+            EnvInfo: (EnvList === null || EnvList === void 0 ? void 0 : EnvList.length) ? EnvList[0] : {},
+            RequestId
+        };
+    }
+    /**
+     * 修改环境名称
+     * @param {string} alias 环境名称
+     * @returns {Promise<IResponseInfo>}
+     */
+    async updateEnvInfo(alias) {
+        return this.cloudService.request('ModifyEnv', {
+            EnvId: this.envId,
+            Alias: alias
+        });
+    }
+    /**
+     * 拉取登录配置列表
+     * @returns {Promise<IEnvLoginConfigRes>}
+     */
+    async getLoginConfigList() {
+        return this.cloudService.request('DescribeLoginConfigs', {
+            EnvId: this.envId
+        });
+    }
+    /**
+     * 创建登录方式
+     * 'WECHAT-OPEN'：微信开放平台
+     * 'WECHAT-PUBLIC'：微信公众平台
+     * @param {('WECHAT-OPEN' | 'WECHAT-PUBLIC')} platform 'WECHAT-OPEN' | 'WECHAT-PUBLIC'
+     * @param {string} appId 微信 appId
+     * @param {string} appSecret 微信 appSecret
+     * @returns {Promise<IResponseInfo>}
+     */
+    async createLoginConfig(platform, appId, appSecret) {
+        let finalAppSecret = appSecret;
+        if (platform === 'ANONYMOUS') {
+            finalAppSecret = 'anonymous';
+        }
+        return this.cloudService.request('CreateLoginConfig', {
+            EnvId: this.envId,
+            // 平台， “QQ" "WECHAT-OPEN" "WECHAT-PUBLIC"
+            Platform: platform,
+            PlatformId: appId,
+            PlatformSecret: finalAppSecret ? utils_1.rsaEncrypt(finalAppSecret) : undefined,
+            Status: 'ENABLE'
+        });
+    }
+    /**
+     * 更新登录方式配置
+     * @param {string} configId 配置 Id，从配置列表中获取
+     * @param {string} [status='ENABLE'] 是否启用 'ENABLE', 'DISABLE' ，可选
+     * @param {string} [appId=''] 微信 appId，可选
+     * @param {string} [appSecret=''] 微信 appSecret，可选
+     * @returns {Promise<IResponseInfo>}
+     */
+    /* eslint-disable-next-line */
+    async updateLoginConfig(configId, status = 'ENABLE', appId = '', appSecret = '') {
+        const validStatus = ['ENABLE', 'DISABLE'];
+        let finalAppSecret = appSecret;
+        if (!validStatus.includes(status)) {
+            throw new error_1.CloudBaseError(`Invalid status value: ${status}. Only support 'ENABLE', 'DISABLE'`);
+        }
+        const params = {
+            EnvId: this.envId,
+            ConfigId: configId,
+            Status: status
+        };
+        if (appId === 'anonymous') {
+            finalAppSecret = 'anonymous';
+        }
+        appId && (params.PlatformId = appId);
+        finalAppSecret && (params.PlatformSecret = utils_1.rsaEncrypt(finalAppSecret));
+        return this.cloudService.request('UpdateLoginConfig', params);
+    }
+    // 创建自定义登录私钥
+    async createCustomLoginKeys() {
+        return this.cloudService.request('CreateCustomLoginKeys', {
+            EnvId: this.envId
+        });
+    }
+    // 获取 COS CORS 域名
+    async getCOSDomains() {
+        const cos = this.getCos();
+        const getBucketCors = util_1.default.promisify(cos.getBucketCors).bind(cos);
+        const { bucket, region } = this.getStorageConfig();
+        const res = await getBucketCors({
+            Bucket: bucket,
+            Region: region
+        });
+        return res.CORSRules;
+    }
+    // 添加 COS CORS 域名，和 Web 端行为保持一致
+    async modifyCosCorsDomain(domain, deleted = false) {
+        const cos = this.getCos();
+        const putBucketCors = util_1.default.promisify(cos.putBucketCors).bind(cos);
+        const { bucket, region } = this.getStorageConfig();
+        // 去掉原有此域名CORS配置
+        let corsRules = await this.getCOSDomains();
+        corsRules = corsRules.filter(item => {
+            return !(item.AllowedOrigins &&
+                item.AllowedOrigins.length === 2 &&
+                item.AllowedOrigins[0] === `http://${domain}` &&
+                item.AllowedOrigins[1] === `https://${domain}`);
+        });
+        if (!deleted) {
+            corsRules.push({
+                AllowedOrigin: [`http://${domain}`, `https://${domain}`],
+                AllowedMethod: ['GET', 'POST', 'PUT', 'DELETE', 'HEAD'],
+                AllowedHeader: ['*'],
+                ExposeHeader: ['Etag', 'Date'],
+                MaxAgeSeconds: '5'
+            });
+        }
+        await putBucketCors({
+            Bucket: bucket,
+            Region: region,
+            CORSRules: corsRules
+        });
+    }
+    getCos() {
+        const { secretId, secretKey, token } = this.environment.getAuthConfig();
+        const cosConfig = {
+            SecretId: secretId,
+            SecretKey: secretKey,
+            SecurityToken: token,
+            Domain: constant_1.USE_INTERNAL_ENDPOINT ? "{Bucket}.cos-internal.{Region}.tencentcos.cn" /* INTERNAL */ : "{Bucket}.cos.{Region}.tencentcos.cn" /* PUBLIC */,
+            Protocol: constant_1.USE_INTERNAL_ENDPOINT
+                ? 'http:'
+                : (constant_1.COS_SDK_PROTOCOL === null || constant_1.COS_SDK_PROTOCOL === void 0 ? void 0 : constant_1.COS_SDK_PROTOCOL.endsWith(':')) ? constant_1.COS_SDK_PROTOCOL.toLowerCase()
+                    : constant_1.COS_SDK_PROTOCOL.toLowerCase() + ':'
+        };
+        return new cos_nodejs_sdk_v5_1.default(cosConfig);
+    }
+    getStorageConfig() {
+        var _a;
+        const envConfig = this.environment.lazyEnvironmentConfig;
+        const storageConfig = (_a = envConfig === null || envConfig === void 0 ? void 0 : envConfig.Storages) === null || _a === void 0 ? void 0 : _a[0];
+        const { Region, Bucket } = storageConfig;
+        return {
+            env: envConfig.EnvId,
+            region: Region,
+            bucket: Bucket
+        };
+    }
+}
+__decorate([
+    utils_1.preLazy()
+], EnvService.prototype, "createEnvDomain", null);
+__decorate([
+    utils_1.preLazy()
+], EnvService.prototype, "deleteEnvDomain", null);
+exports.EnvService = EnvService;

package/lib/environment.js

@@ -0,0 +1,124 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Environment = void 0;
+const database_1 = require("./database");
+const function_1 = require("./function");
+const storage_1 = require("./storage");
+const env_1 = require("./env");
+const common_1 = require("./common");
+const error_1 = require("./error");
+const constant_1 = require("./constant");
+const utils_1 = require("./utils");
+const hosting_1 = require("./hosting");
+const third_1 = require("./third");
+const access_1 = require("./access");
+const user_1 = require("./user");
+const cloudBaseRun_1 = require("./cloudBaseRun");
+class Environment {
+    constructor(context, envId) {
+        this.inited = false;
+        this.envId = envId;
+        this.cloudBaseContext = context;
+        this.envType = context.envType;
+        // 拉取当前环境 的环境信息 todo
+        this.functionService = new function_1.FunctionService(this);
+        this.databaseService = new database_1.DatabaseService(this);
+        this.storageService = new storage_1.StorageService(this);
+        this.envService = new env_1.EnvService(this);
+        this.hostingService = new hosting_1.HostingService(this);
+        this.thirdService = new third_1.ThirdService(this);
+        this.accessService = new access_1.AccessService(this);
+        this.userService = new user_1.UserService(this);
+        this.cloudBaseRunService = new cloudBaseRun_1.CloudBaseRunService(this);
+    }
+    async lazyInit() {
+        if (!this.inited) {
+            const envConfig = this.envService;
+            return envConfig.getEnvInfo().then(envInfo => {
+                this.lazyEnvironmentConfig = envInfo.EnvInfo;
+                if (!this.lazyEnvironmentConfig.EnvId) {
+                    throw new error_1.CloudBaseError(`Environment ${this.envId} not found`);
+                }
+                this.inited = true;
+                return this.lazyEnvironmentConfig;
+            });
+        }
+        else {
+            return this.lazyEnvironmentConfig;
+        }
+    }
+    getEnvId() {
+        return this.envId;
+    }
+    getEnvType() {
+        return this.envType;
+    }
+    getStorageService() {
+        return this.storageService;
+    }
+    getDatabaseService() {
+        return this.databaseService;
+    }
+    getFunctionService() {
+        return this.functionService;
+    }
+    getEnvService() {
+        return this.envService;
+    }
+    getHostingService() {
+        return this.hostingService;
+    }
+    getThirdService() {
+        return this.thirdService;
+    }
+    getAccessService() {
+        return this.accessService;
+    }
+    getUserService() {
+        return this.userService;
+    }
+    getCloudBaseRunService() {
+        return this.cloudBaseRunService;
+    }
+    getCommonService(serviceType = 'tcb', serviceVersion) {
+        return new common_1.CommonService(this, serviceType, serviceVersion);
+    }
+    getServicesEnvInfo() {
+        const envConfig = this.envService;
+        return envConfig.getEnvInfo().then(envInfo => {
+            return envInfo.EnvInfo;
+        });
+    }
+    getAuthConfig() {
+        let { secretId, secretKey, token, proxy, region } = this.cloudBaseContext;
+        const envId = this.getEnvId();
+        if (!secretId || !secretKey) {
+            // 未主动传入密钥，从环境变量中读取
+            const envSecretId = utils_1.getEnvVar(constant_1.ENV_NAME.ENV_SECRETID);
+            const envSecretKey = utils_1.getEnvVar(constant_1.ENV_NAME.ENV_SECRETKEY);
+            const envToken = utils_1.getEnvVar(constant_1.ENV_NAME.ENV_SESSIONTOKEN);
+            if (!envSecretId || !envSecretKey) {
+                if (utils_1.getRuntime() === constant_1.RUN_ENV.SCF) {
+                    throw new Error('missing authoration key, redeploy the function');
+                }
+                else {
+                    throw new Error('missing secretId or secretKey of tencent cloud');
+                }
+            }
+            else {
+                secretId = envSecretId;
+                secretKey = envSecretKey;
+                token = envToken;
+            }
+        }
+        return {
+            envId,
+            secretId,
+            secretKey,
+            token,
+            proxy,
+            region
+        };
+    }
+}
+exports.Environment = Environment;

package/lib/environmentManager.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EnvironmentManager = void 0;
+const environment_1 = require("./environment");
+const constant_1 = require("./constant");
+class EnvironmentManager {
+    constructor(context) {
+        this.envs = {};
+        this.currentEnv = null;
+        this.cloudBaseContext = context;
+    }
+    getCurrentEnv() {
+        if (!this.currentEnv) {
+            throw new Error(constant_1.ERROR.CURRENT_ENVIRONMENT_IS_NULL);
+        }
+        return this.currentEnv;
+    }
+    add(envId) {
+        if (!this.envs[envId]) {
+            this.envs[envId] = new environment_1.Environment(this.cloudBaseContext, envId);
+        }
+        if (!this.currentEnv) {
+            this.currentEnv = this.envs[envId];
+        }
+    }
+    remove(envId) {
+        this.envs[envId] = null;
+        delete this.envs[envId];
+    }
+    get(envId) {
+        return this.envs[envId] || null;
+    }
+    switchEnv(envId) {
+        const env = this.envs[envId];
+        if (env) {
+            this.currentEnv = env;
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+}
+exports.EnvironmentManager = EnvironmentManager;

package/lib/error.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudBaseError = void 0;
+class CloudBaseError extends Error {
+    constructor(message, options = {}) {
+        super();
+        this.name = 'CloudBaseError';
+        const { code = '', action = '', original = null, requestId = '' } = options;
+        this.message = action ? `[${action}] ${message}` : message;
+        this.original = original;
+        this.code = code;
+        this.requestId = requestId;
+        this.action = action;
+    }
+}
+exports.CloudBaseError = CloudBaseError;