@cloudbase/manager-node 4.11.0-alpha.7 → 4.11.0-alpha.9

package/.claude/settings.local.json

@@ -0,0 +1,9 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(TCB_BASE_URL=https://tcb.pre.tencentcloudapi.woa.com npm test -- --testPathPattern=cloudApp 2>&1)",
+      "Bash(TCB_BASE_URL=https://tcb.pre.tencentcloudapi.woa.com npm test 2>&1)",
+      "Bash(TCB_BASE_URL=https://tcb.pre.tencentcloudapi.woa.com npm test -- --testPathPattern=cloudApp --testNamePattern=\"获取版本列表\")"
+    ]
+  }
+}

package/lib/cloudApp/index.js

@@ -0,0 +1,243 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CloudAppService = void 0;
+const fs_1 = __importDefault(require("fs"));
+const os_1 = __importDefault(require("os"));
+const path_1 = __importDefault(require("path"));
+const error_1 = require("../error");
+const utils_1 = require("../utils");
+const http_request_1 = require("../utils/http-request");
+__exportStar(require("./types"), exports);
+/**
+ * CloudApp 统一部署服务
+ * 提供 Web 应用的创建、查询、删除、版本管理等功能
+ */
+class CloudAppService {
+    constructor(environment) {
+        this.environment = environment;
+        this.tcbService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
+    }
+    // =========== 应用管理 API ===========
+    /**
+     * 创建/更新 CloudApp 应用
+     * @param params 创建参数
+     */
+    async createApp(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType']);
+        return this.tcbService.request('CreateCloudApp', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    /**
+     * 获取 CloudApp 应用列表
+     * @param params 查询参数
+     */
+    async describeAppList(params) {
+        const { envId } = this.getEnvInfo();
+        return this.tcbService.request('DescribeCloudAppList', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    /**
+     * 获取 CloudApp 应用详情
+     * @param params 查询参数
+     */
+    async describeAppInfo(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType']);
+        return this.tcbService.request('DescribeCloudAppInfo', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    /**
+     * 删除 CloudApp 应用
+     * @param params 删除参数
+     */
+    async deleteApp(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType']);
+        return this.tcbService.request('DeleteCloudApp', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    // =========== 版本管理 API ===========
+    /**
+     * 获取 CloudApp 版本详情
+     * 不指定 versionName 或 buildId 时返回最新版本
+     * @param params 查询参数
+     */
+    async describeAppVersion(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType']);
+        return this.tcbService.request('DescribeCloudAppVersion', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    /**
+     * 获取 CloudApp 版本列表
+     * @param params 查询参数
+     */
+    async describeAppVersionList(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType']);
+        return this.tcbService.request('DescribeCloudAppVersionList', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    /**
+     * 删除 CloudApp 版本
+     * @param params 删除参数
+     */
+    async deleteAppVersion(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType', 'versionName']);
+        return this.tcbService.request('DeleteCloudAppVersion', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId })));
+    }
+    // =========== COS 上传相关 API ===========
+    /**
+     * 获取 CloudApp COS 上传信息（预签名 URL）
+     * @param params 查询参数
+     */
+    async describeCosInfo(params) {
+        const { envId } = this.getEnvInfo();
+        this.validateRequiredParams(params, ['serviceName', 'deployType']);
+        return this.tcbService.request('DescribeCloudAppCosInfo', (0, utils_1.upperCaseObjKey)(Object.assign(Object.assign({}, params), { envId: params.envId || envId, suffix: params.suffix || '.zip' })));
+    }
+    // =========== 辅助方法 ===========
+    /**
+     * 上传本地代码到 COS
+     * 自动打包 ZIP 并上传到预签名 URL
+     *
+     * 注意：此方法不依赖应用是否已创建，可在创建应用前调用
+     * 返回的 cosTimestamp 用于 createApp 时传入 staticConfig.cosTimestamp
+     *
+     * @param params 上传参数
+     */
+    async uploadCode(params) {
+        const { serviceName, localPath, ignore = [] } = params;
+        // 1. 验证本地路径
+        if (!fs_1.default.existsSync(localPath)) {
+            throw new error_1.CloudBaseError(`本地路径不存在: ${localPath}`);
+        }
+        const stat = fs_1.default.statSync(localPath);
+        if (!stat.isDirectory()) {
+            throw new error_1.CloudBaseError(`localPath 必须是目录: ${localPath}`);
+        }
+        // 2. 打包本地文件为 ZIP
+        const tmpZipPath = path_1.default.join(os_1.default.tmpdir(), `cloudapp-${Date.now()}-${Math.random().toString(36).slice(2)}.zip`);
+        const defaultIgnore = ['node_modules/**', '.git/**', '.DS_Store', '**/.DS_Store'];
+        await (0, utils_1.compressToZip)({
+            dirPath: localPath,
+            outputPath: tmpZipPath,
+            ignore: [...defaultIgnore, ...ignore]
+        });
+        try {
+            // 3. 获取上传凭证
+            const cosInfo = await this.describeCosInfo({
+                deployType: params.deployType,
+                serviceName,
+                suffix: '.zip'
+            });
+            // 4. 读取 ZIP 文件
+            const zipBuffer = fs_1.default.readFileSync(tmpZipPath);
+            // 5. 构建请求头
+            const headers = {
+                'Content-Type': 'application/zip'
+            };
+            if (cosInfo.UploadHeaders && cosInfo.UploadHeaders.length > 0) {
+                for (const h of cosInfo.UploadHeaders) {
+                    headers[h.Key] = h.Value;
+                }
+            }
+            // 6. 使用预签名 URL 上传
+            const response = await (0, http_request_1.fetchStream)(cosInfo.UploadUrl, {
+                method: 'PUT',
+                body: zipBuffer,
+                headers
+            });
+            if (!response.ok) {
+                let errorDetail = '';
+                try {
+                    const responseText = await response.text();
+                    errorDetail = responseText ? ` - ${responseText.substring(0, 500)}` : '';
+                }
+                catch (_a) {
+                    // 解析失败时 errorDetail 保持空串，不影响主错误抛出
+                }
+                throw new error_1.CloudBaseError(`上传失败: ${response.status} ${response.statusText}${errorDetail}`);
+            }
+            // 7. 返回结果（返回 cosTimestamp，用于创建应用）
+            return {
+                cosTimestamp: cosInfo.UnixTimestamp,
+                unixTimestamp: cosInfo.UnixTimestamp
+            };
+        }
+        finally {
+            // 8. 清理临时文件
+            if (fs_1.default.existsSync(tmpZipPath)) {
+                fs_1.default.unlinkSync(tmpZipPath);
+            }
+        }
+    }
+    /**
+     * 获取环境信息
+     */
+    getEnvInfo() {
+        const envConfig = this.environment.lazyEnvironmentConfig;
+        return {
+            envId: envConfig.EnvId
+        };
+    }
+    /**
+     * 校验必填参数
+     * @param params 参数对象
+     * @param fields 必填字段列表
+     */
+    validateRequiredParams(params, fields) {
+        for (const field of fields) {
+            if (!params[field]) {
+                throw new error_1.CloudBaseError(`${field} 是必填参数`);
+            }
+        }
+    }
+}
+exports.CloudAppService = CloudAppService;
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "createApp", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "describeAppList", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "describeAppInfo", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "deleteApp", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "describeAppVersion", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "describeAppVersionList", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "deleteAppVersion", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "describeCosInfo", null);
+__decorate([
+    (0, utils_1.preLazy)()
+], CloudAppService.prototype, "uploadCode", null);

package/lib/cloudApp/types.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * CloudApp 统一部署服务类型定义
+ * 支持 static-hosting（静态托管）和 http-function（预留）两种部署类型
+ *
+ * 命名规范：
+ * - 入参接口（IXxxParams）：camelCase，通过 upperCaseObjKey 转换后透传给 API
+ * - 返回值接口（IXxxResult）：PascalCase，与 API 响应字段保持一致
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/environment.js

@@ -18,6 +18,8 @@ const access_1 = require("./access");
 const user_1 = require("./user");
 const cloudBaseRun_1 = require("./cloudBaseRun");
 const mysql_1 = require("./mysql");
+const cloudApp_1 = require("./cloudApp");
+const permission_1 = require("./permission");
 class Environment {
     constructor(context, envId) {
         this.inited = false;
@@ -39,6 +41,8 @@ class Environment {
         this.userService = new user_1.UserService(this);
         this.cloudBaseRunService = new cloudBaseRun_1.CloudBaseRunService(this);
         this.mysqlService = new mysql_1.MysqlService(this);
+        this.permissionService = new permission_1.PermissionService(this);
+        this.cloudAppService = new cloudApp_1.CloudAppService(this);
     }
     async lazyInit() {
         if (!this.inited) {
@@ -101,6 +105,12 @@ class Environment {
     getMysqlService() {
         return this.mysqlService;
     }
+    getCloudAppService() {
+        return this.cloudAppService;
+    }
+    getPermissionService() {
+        return this.permissionService;
+    }
     getCommonService(serviceType = 'tcb', serviceVersion) {
         return new common_1.CommonService(this, serviceType, serviceVersion);
     }

package/lib/index.js

@@ -70,9 +70,34 @@ class CloudBase {
     get mysql() {
         return this.currentEnvironment().getMysqlService();
     }
+    /**
+     * 云托管服务（CloudBaseRun）
+     * 提供云托管版本流量配置等能力
+     * @deprecated 请使用 cloudBaseRun 代替，避免与 cloudAppService 混淆
+     */
     get cloudApp() {
         return this.currentEnvironment().getCloudBaseRunService();
     }
+    /**
+     * 云托管服务（CloudBaseRun）
+     * 提供云托管版本流量配置等能力
+     */
+    get cloudBaseRun() {
+        return this.currentEnvironment().getCloudBaseRunService();
+    }
+    /**
+     * 云应用服务（CloudApp 统一部署）
+     * 提供 Web 应用的创建、部署、版本管理等能力
+     */
+    get cloudAppService() {
+        return this.currentEnvironment().getCloudAppService();
+    }
+    /**
+     * 获取云应用服务
+     */
+    getCloudAppService() {
+        return this.currentEnvironment().getCloudAppService();
+    }
     commonService(service, version) {
         return this.currentEnvironment().getCommonService(service, version);
     }
@@ -88,6 +113,9 @@ class CloudBase {
     get user() {
         return this.currentEnvironment().getUserService();
     }
+    get permission() {
+        return this.currentEnvironment().getPermissionService();
+    }
     get docs() {
         if (!this.docsService) {
             this.docsService = new docs_1.DocsService();

package/lib/interfaces/cloudApp.interface.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * CloudApp 统一部署服务接口导出
+ */
+__exportStar(require("../cloudApp/types"), exports);

package/lib/interfaces/index.js

@@ -21,3 +21,4 @@ __exportStar(require("./base.interface"), exports);
 __exportStar(require("./storage.interface"), exports);
 __exportStar(require("./cam.interface"), exports);
 __exportStar(require("./billing.interface"), exports);
+__exportStar(require("./cloudApp.interface"), exports);

package/lib/log/index.js

@@ -15,14 +15,62 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LogService = void 0;
+exports.isLogServiceEnabled = isLogServiceEnabled;
 const utils_1 = require("../utils");
 __exportStar(require("./types"), exports);
+/**
+ * 纯函数：根据 DescribeEnvs 返回的 LogServices 列表判断日志服务是否已开通。
+ * 已开通条件：至少一个条目有有效的 TopicId。
+ */
+function isLogServiceEnabled(logServices) {
+    if (!logServices || logServices.length === 0)
+        return false;
+    return logServices.some(svc => !!svc.TopicId);
+}
 class LogService {
     constructor(environment) {
         this.envId = environment.getEnvId();
         this.cloudService = new utils_1.CloudService(environment.cloudBaseContext, 'tcb', '2018-06-08');
         this.tcbrService = new utils_1.CloudService(environment.cloudBaseContext, 'tcbr', '2022-02-17');
     }
+    /**
+     * 检查当前环境的日志服务是否已开通
+     *
+     * 通过 DescribeEnvs 接口获取环境信息，判断 LogServices 字段中是否包含有效的
+     * 日志主题（TopicId 不为空）。
+     *
+     * @returns true 表示已开通，false 表示未开通或开通中
+     */
+    async checkLogServiceEnabled() {
+        var _a;
+        const res = await this.cloudService.request('DescribeEnvs', {
+            EnvId: this.envId
+        });
+        const envInfo = (_a = res === null || res === void 0 ? void 0 : res.EnvList) === null || _a === void 0 ? void 0 : _a[0];
+        if (!envInfo) {
+            return false;
+        }
+        const logServices = envInfo.LogServices;
+        if (!logServices || logServices.length === 0) {
+            return false;
+        }
+        // 已开通：LogServiceInfo 中存在有效的日志主题 ID
+        return isLogServiceEnabled(logServices);
+    }
+    /**
+     * 开通环境日志服务（异步操作）
+     *
+     * 调用 CreateEnvResource 接口开通日志资源。
+     * 注意：接口调用成功不代表日志资源立即可用，需通过 checkLogServiceEnabled() 轮询确认。
+     *
+     * @returns 请求 ID
+     */
+    async createLogService() {
+        return this.cloudService.request('CreateEnvResource', {
+            EnvId: this.envId,
+            Resources: ['log']
+        });
+    }
     /**
      * 搜索 CLS 日志
      *