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

package/types/cloudApp/types.d.ts

@@ -0,0 +1,325 @@
+/**
+ * CloudApp 统一部署服务类型定义
+ * 支持 static-hosting（静态托管）和 http-function（预留）两种部署类型
+ *
+ * 命名规范：
+ * - 入参接口（IXxxParams）：camelCase，通过 upperCaseObjKey 转换后透传给 API
+ * - 返回值接口（IXxxResult）：PascalCase，与 API 响应字段保持一致
+ */
+/**
+ * 部署类型
+ * - static-hosting: 静态托管部署
+ * - http-function: HTTP 云函数部署（预留）
+ */
+export type DeployType = 'static-hosting' | 'http-function';
+/**
+ * 构建类型
+ * - GIT: 从 Git 仓库构建
+ * - ZIP: 从 ZIP 包构建
+ * - TEMPLATE: 从模板构建
+ */
+export type BuildType = 'GIT' | 'ZIP' | 'TEMPLATE';
+/**
+ * 构建状态
+ */
+export type BuildStatus = 'BUILDING' | 'SUCCESS' | 'FAILED';
+/**
+ * 构建命令配置（入参）
+ */
+export interface IStaticCmd {
+    buildCmd?: string;
+    installCmd?: string;
+    deployCmd?: string;
+}
+/**
+ * 静态环境变量配置（入参）
+ */
+export interface IStaticEnv {
+    variables?: Array<{
+        key: string;
+        value: string;
+    }>;
+}
+/**
+ * 静态托管配置（入参）
+ */
+export interface IStaticConfig {
+    /** 框架类型：vue、react、nextjs 等 */
+    framework?: string;
+    /** Node.js 版本，默认 20 */
+    nodeJsVersion?: string;
+    /** 访问路径 */
+    appPath?: string;
+    /** 构建目录 */
+    buildPath?: string;
+    /** ZIP 文件地址（BuildType=ZIP/TEMPLATE 时使用） */
+    zipFileUrl?: string;
+    /** COS 时间戳（通过 uploadCode 上传后获取，BuildType=ZIP 时使用） */
+    cosTimestamp?: string;
+    /** COS 文件后缀 */
+    cosSuffix?: string;
+    /** 代码源平台：github、gitlab、gitee */
+    codeSource?: string;
+    /** 代码仓库 */
+    codeRepo?: string;
+    /** 代码分支 */
+    codeBranch?: string;
+    /** 构建命令配置 */
+    staticCmd?: IStaticCmd;
+    /** 构建环境变量 */
+    staticEnv?: IStaticEnv;
+}
+/**
+ * 静态托管构建命令配置（API 响应）
+ */
+export interface StaticCmd {
+    BuildCmd?: string;
+    InstallCmd?: string;
+    DeployCmd?: string;
+}
+/**
+ * 静态托管环境变量配置（API 响应，对应文档 StaticEnvironment）
+ */
+export interface StaticEnv {
+    /** 环境变量数组，可能为 null */
+    Variables?: Array<{
+        Key: string;
+        Value: string;
+    }> | null;
+}
+/**
+ * 静态托管配置（API 响应，对应文档 StaticConfig）
+ * 被 CreateCloudApp、DescribeCloudAppVersion、DescribeCloudAppVersionList 引用
+ * 注意：所有字段均可能返回 null
+ */
+export interface CloudAppStaticConfig {
+    /** 框架类型：vue、react、nextjs 等 */
+    Framework?: string | null;
+    /** Node.js 版本，默认 20 */
+    NodeJsVersion?: string | null;
+    /** 访问路径 */
+    AppPath?: string | null;
+    /** 构建目录 */
+    BuildPath?: string | null;
+    /** ZIP 文件地址（BuildType=ZIP/TEMPLATE 时使用） */
+    ZipFileUrl?: string | null;
+    /** COS 时间戳 */
+    CosTimestamp?: string | null;
+    /** COS 文件后缀 */
+    CosSuffix?: string | null;
+    /** 代码源平台：github、gitlab、gitee */
+    CodeSource?: string | null;
+    /** 代码仓库 */
+    CodeRepo?: string | null;
+    /** 代码分支 */
+    CodeBranch?: string | null;
+    /** 构建命令配置 */
+    StaticCmd?: StaticCmd | null;
+    /** 构建环境变量 */
+    StaticEnv?: StaticEnv | null;
+}
+/**
+ * 应用列表项（API 响应 CloudAppServiceItem）
+ */
+export interface CloudAppServiceItem {
+    ServiceName: string;
+    DeployType: string;
+    Framework?: string;
+    Domain?: string;
+    AppPath?: string;
+    CreateTime: string;
+    LatestVersionName?: string;
+    LatestStatus?: string;
+    LatestBuildTime?: string;
+}
+/** @deprecated 请使用 CloudAppServiceItem */
+export type CloudAppItem = CloudAppServiceItem;
+/**
+ * 版本信息（API 响应 CloudAppVersionItem）
+ */
+export interface CloudAppVersion {
+    VersionName: string;
+    BuildId: string;
+    BuildType?: string;
+    Status: string;
+    Framework?: string;
+    BuildTime?: string;
+    StaticConfig?: CloudAppStaticConfig;
+}
+export interface ICreateCloudAppParams {
+    /** 环境 ID（可选，默认从 Environment 获取） */
+    envId?: string;
+    /** 部署类型：static-hosting / http-function */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+    /** 构建类型：GIT / ZIP / TEMPLATE */
+    buildType?: BuildType;
+    /** 静态托管配置（deployType 为 static-hosting 时使用） */
+    staticConfig?: IStaticConfig;
+}
+export interface ICreateCloudAppResult {
+    ServiceName: string;
+    BuildId: string;
+    VersionName: string;
+    RequestId: string;
+}
+export interface IDescribeCloudAppListParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 页码（从 1 开始） */
+    pageNo?: number;
+    /** 每页大小 */
+    pageSize?: number;
+    /** 搜索关键字，按应用名模糊搜索 */
+    searchKey?: string;
+}
+export interface IDescribeCloudAppListResult {
+    Total: number;
+    ServiceList: CloudAppServiceItem[];
+    RequestId: string;
+}
+export interface IDescribeCloudAppInfoParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+}
+export interface IDescribeCloudAppInfoResult {
+    ServiceName: string;
+    DeployType: string;
+    Framework?: string;
+    Domain?: string;
+    AppPath?: string;
+    CreateTime: string;
+    LatestVersionName?: string;
+    LatestStatus?: string;
+    LatestBuildTime?: string;
+    RequestId: string;
+}
+export interface IDeleteCloudAppParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+}
+export interface IDeleteCloudAppResult {
+    Result: boolean;
+    RequestId: string;
+}
+export interface IDescribeCloudAppVersionParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+    /** 版本名称（与 buildId 二选一） */
+    versionName?: string;
+    /** 构建 ID（与 versionName 二选一） */
+    buildId?: string;
+}
+export interface IDescribeCloudAppVersionResult {
+    BuildType: string;
+    BuildId: string;
+    Status: BuildStatus;
+    Framework?: string;
+    StaticConfig?: CloudAppStaticConfig;
+    BuildTime?: string;
+    RequestId: string;
+}
+export interface IDescribeCloudAppVersionListParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+    /** 页码（从 1 开始） */
+    pageNo?: number;
+    /** 每页大小 */
+    pageSize?: number;
+}
+export interface IDescribeCloudAppVersionListResult {
+    Total: number;
+    VersionList: CloudAppVersion[] | null;
+    RequestId: string;
+}
+export interface IDeleteCloudAppVersionParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+    /** 版本名称 */
+    versionName: string;
+}
+export interface IDeleteCloudAppVersionResult {
+    Result: boolean;
+    RequestId: string;
+}
+export interface IDescribeCloudAppCosInfoParams {
+    /** 环境 ID（可选） */
+    envId?: string;
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+    /** Unix 时间戳（用于指定文件路径，不传则自动生成） */
+    unixTimestamp?: string;
+    /** 文件后缀（默认 .zip） */
+    suffix?: string;
+    /** 是否需要下载 URL */
+    needDownload?: boolean;
+}
+export interface CosHeader {
+    Key: string;
+    Value: string;
+}
+export interface IDescribeCloudAppCosInfoResult {
+    UploadUrl: string;
+    UploadHeaders?: CosHeader[];
+    DownloadUrl?: string;
+    DownloadHeaders?: CosHeader[];
+    UnixTimestamp: string;
+    RequestId: string;
+}
+/**
+ * 上传进度信息
+ */
+export interface IProgressData {
+    loaded: number;
+    total: number;
+    percent: number;
+}
+/**
+ * 上传代码参数
+ */
+export interface IUploadCloudAppCodeParams {
+    /** 部署类型 */
+    deployType: DeployType;
+    /** 服务名称 */
+    serviceName: string;
+    /** 本地文件夹路径 */
+    localPath: string;
+    /** 忽略的文件/目录模式 */
+    ignore?: string[];
+    /** 进度回调 */
+    onProgress?: (progress: IProgressData) => void;
+}
+/**
+ * 上传代码结果
+ */
+export interface IUploadCloudAppCodeResult {
+    /** COS 时间戳（用于 createApp 时传入 staticConfig.cosTimestamp） */
+    cosTimestamp: string;
+    /** Unix 时间戳（与 cosTimestamp 相同） */
+    unixTimestamp: string;
+}

package/types/environment.d.ts

@@ -13,7 +13,9 @@ import { AccessService } from './access';
 import { UserService } from './user';
 import { CloudBaseRunService } from './cloudBaseRun';
 import { MysqlService } from './mysql';
+import { CloudAppService } from './cloudApp';
 import { EnvInfo } from './interfaces';
+import { PermissionService } from './permission';
 export declare class Environment {
     inited: boolean;
     cloudBaseContext: CloudBaseContext;
@@ -33,6 +35,8 @@ export declare class Environment {
     private userService;
     private cloudBaseRunService;
     private mysqlService;
+    private permissionService;
+    private cloudAppService;
     constructor(context: CloudBaseContext, envId: string);
     lazyInit(): Promise<any>;
     getEnvId(): string;
@@ -50,6 +54,8 @@ export declare class Environment {
     getUserService(): UserService;
     getCloudBaseRunService(): CloudBaseRunService;
     getMysqlService(): MysqlService;
+    getCloudAppService(): CloudAppService;
+    getPermissionService(): PermissionService;
     getCommonService(serviceType: string, serviceVersion: any): CommonService;
     getServicesEnvInfo(): Promise<any>;
     getAuthConfig(): {

package/types/index.d.ts

@@ -15,6 +15,8 @@ import { UserService } from './user';
 import { CloudBaseRunService } from './cloudBaseRun';
 import { MysqlService } from './mysql';
 import { DocsService } from './docs';
+import { PermissionService } from './permission';
+import { CloudAppService } from './cloudApp';
 interface CloudBaseConfig {
     secretId?: string;
     secretKey?: string;
@@ -52,12 +54,32 @@ declare class CloudBase {
     get hosting(): HostingService;
     get access(): AccessService;
     get mysql(): MysqlService;
+    /**
+     * 云托管服务（CloudBaseRun）
+     * 提供云托管版本流量配置等能力
+     * @deprecated 请使用 cloudBaseRun 代替，避免与 cloudAppService 混淆
+     */
     get cloudApp(): CloudBaseRunService;
+    /**
+     * 云托管服务（CloudBaseRun）
+     * 提供云托管版本流量配置等能力
+     */
+    get cloudBaseRun(): CloudBaseRunService;
+    /**
+     * 云应用服务（CloudApp 统一部署）
+     * 提供 Web 应用的创建、部署、版本管理等能力
+     */
+    get cloudAppService(): CloudAppService;
+    /**
+     * 获取云应用服务
+     */
+    getCloudAppService(): CloudAppService;
     commonService(service?: string, version?: string): CommonService;
     get env(): EnvService;
     get log(): LogService;
     get third(): ThirdService;
     get user(): UserService;
+    get permission(): PermissionService;
     get docs(): DocsService;
     getEnvironmentManager(): EnvironmentManager;
     getManagerConfig(): CloudBaseConfig;

package/types/interfaces/cloudApp.interface.d.ts

@@ -0,0 +1,4 @@
+/**
+ * CloudApp 统一部署服务接口导出
+ */
+export * from '../cloudApp/types';

package/types/interfaces/index.d.ts

@@ -5,3 +5,4 @@ export * from './base.interface';
 export * from './storage.interface';
 export * from './cam.interface';
 export * from './billing.interface';
+export * from './cloudApp.interface';

package/types/log/index.d.ts

@@ -1,11 +1,43 @@
 import { Environment } from '../environment';
 import { ISearchClsLogParams, ISearchClsLogResponse } from './types';
 export * from './types';
+export interface ICreateEnvResourceResponse {
+    RequestId: string;
+}
+export interface ILogServiceEntry {
+    LogsetId?: string;
+    TopicId?: string;
+    TopicName?: string;
+    Region?: string;
+}
+/**
+ * 纯函数：根据 DescribeEnvs 返回的 LogServices 列表判断日志服务是否已开通。
+ * 已开通条件：至少一个条目有有效的 TopicId。
+ */
+export declare function isLogServiceEnabled(logServices?: ILogServiceEntry[]): boolean;
 export declare class LogService {
     private envId;
     private cloudService;
     private tcbrService;
     constructor(environment: Environment);
+    /**
+     * 检查当前环境的日志服务是否已开通
+     *
+     * 通过 DescribeEnvs 接口获取环境信息，判断 LogServices 字段中是否包含有效的
+     * 日志主题（TopicId 不为空）。
+     *
+     * @returns true 表示已开通，false 表示未开通或开通中
+     */
+    checkLogServiceEnabled(): Promise<boolean>;
+    /**
+     * 开通环境日志服务（异步操作）
+     *
+     * 调用 CreateEnvResource 接口开通日志资源。
+     * 注意：接口调用成功不代表日志资源立即可用，需通过 checkLogServiceEnabled() 轮询确认。
+     *
+     * @returns 请求 ID
+     */
+    createLogService(): Promise<ICreateEnvResourceResponse>;
     /**
      * 搜索 CLS 日志
      *

package/types/permission/index.d.ts

@@ -0,0 +1,31 @@
+import { Environment } from '../environment';
+import { ModifyResourcePermissionOptions, ModifyResourcePermissionResp, DescribeResourcePermissionOptions, DescribeResourcePermissionResp, CreateRoleOptions, CreateRoleResp, DescribeRoleListOptions, DescribeRoleListResp, ModifyRoleOptions, ModifyRoleResp, DeleteRolesOptions, DeleteRolesResp } from './types';
+export declare class PermissionService {
+    private environment;
+    private tcbService;
+    constructor(environment: Environment);
+    modifyResourcePermission(options: ModifyResourcePermissionOptions): Promise<{
+        Data: ModifyResourcePermissionResp;
+        RequestId: string;
+    }>;
+    describeResourcePermission(options: DescribeResourcePermissionOptions): Promise<{
+        Data: DescribeResourcePermissionResp;
+        RequestId: string;
+    }>;
+    createRole(options: CreateRoleOptions): Promise<{
+        Data: CreateRoleResp;
+        RequestId: string;
+    }>;
+    describeRoleList(options?: DescribeRoleListOptions): Promise<{
+        Data: DescribeRoleListResp;
+        RequestId: string;
+    }>;
+    modifyRole(options: ModifyRoleOptions): Promise<{
+        Data: ModifyRoleResp;
+        RequestId: string;
+    }>;
+    deleteRoles(options: DeleteRolesOptions): Promise<{
+        Data: DeleteRolesResp;
+        RequestId: string;
+    }>;
+}

package/types/permission/types.d.ts

@@ -0,0 +1,127 @@
+export type PermissionResourceType = 'function' | 'storage' | 'table' | 'collection';
+export type BasePermission = 'READONLY' | 'PRIVATE' | 'ADMINWRITE' | 'ADMINONLY' | 'CUSTOM';
+export interface ModifyResourcePermissionOptions {
+    resourceType: PermissionResourceType;
+    resource: string;
+    permission: BasePermission;
+    securityRule?: string;
+}
+export interface ModifyResourcePermissionResp {
+    Success: boolean;
+}
+export interface DescribeResourcePermissionOptions {
+    resourceType: PermissionResourceType;
+    resources?: string[];
+}
+export interface ResourcePermission {
+    ResourceType?: PermissionResourceType;
+    Resource?: string;
+    Permission?: BasePermission | string;
+    SecurityRule?: string;
+}
+export interface DescribeResourcePermissionResp {
+    TotalCount: number;
+    PermissionList: ResourcePermission[];
+}
+export type QueryConditionRel = 'eq' | 'neq' | 'lt' | 'gt' | 'gte' | 'lte' | 'in' | 'nin' | 'search';
+export interface QueryConditionItem {
+    Key: string;
+    Rel: QueryConditionRel;
+    Val: string;
+    ValueType?: string;
+}
+export interface QueryCondition {
+    Key: string;
+    Value: string;
+    QueryConditions?: QueryConditionItem[];
+}
+export interface WorkBenchFeatureItem {
+    Code?: string;
+    Name?: string;
+    IsAccess?: boolean;
+    ParentCode?: string;
+    SubPermissions?: WorkBenchFeatureItem[];
+}
+export interface WorkBenchPermission {
+    AllPermission?: boolean;
+    PartPermission?: boolean;
+    Permissions?: WorkBenchFeatureItem[];
+}
+export interface PermissionPolicyItem {
+    ResourceType: string;
+    Resource: string;
+    ResourceName?: string;
+    Permission?: string;
+    Effect?: string;
+    IsBindAllAccess?: boolean;
+    SubResourceIdList?: string[];
+    RowPermission?: QueryCondition[];
+    FeatureAuth?: WorkBenchPermission;
+    GatewayPolicyCode?: string;
+    GatewayPolicyName?: string;
+    GatewayPolicyDescription?: string;
+    GatewayPolicyExpression?: string;
+}
+export interface CreateRoleOptions {
+    roleName: string;
+    roleIdentity: string;
+    description?: string;
+    memberUids?: string[];
+    policies?: PermissionPolicyItem[];
+}
+export interface CreateRoleResp {
+    RoleId?: string;
+    MemberUids?: string[];
+    Policies?: PermissionPolicyItem[];
+}
+export interface MemberInfo {
+    Uid?: string;
+    Name?: string;
+    NickName?: string;
+}
+export interface RoleItem {
+    RoleId?: string;
+    RoleIdentity?: string;
+    RoleName?: string;
+    RoleType?: 'system' | 'custom';
+    Description?: string;
+    Members?: MemberInfo[];
+    Policies?: PermissionPolicyItem[];
+}
+export interface DescribeRoleListOptions {
+    pageNumber?: number;
+    pageSize?: number;
+    roleId?: string;
+    roleIdentity?: string;
+    roleName?: string;
+    loadDetails?: boolean;
+}
+export interface DescribeRoleListResp {
+    TotalCount?: number;
+    CustomTotalCount?: number;
+    SystemRoles?: RoleItem[];
+    CustomRoles?: RoleItem[];
+}
+export interface ModifyRoleOptions {
+    roleId: string;
+    roleName?: string;
+    description?: string;
+    addMemberUids?: string[];
+    removeMemberUids?: string[];
+    addPolicies?: PermissionPolicyItem[];
+    removePolicies?: PermissionPolicyItem[];
+}
+export interface ModifyRoleResp {
+    Success?: boolean;
+    AddedMemberUids?: string[];
+    RemovedMemberUids?: string[];
+    AddedPolicies?: PermissionPolicyItem[];
+    RemovedPolicies?: PermissionPolicyItem[];
+}
+export interface DeleteRolesOptions {
+    roleIds: string[];
+}
+export interface DeleteRolesResp {
+    SuccessCount?: number;
+    FailedCount?: number;
+}