@cloudbase/manager-node 4.11.0-alpha.1 → 4.11.0-alpha.11

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/database/index.d.ts

@@ -15,6 +15,38 @@ interface IMgoQueryInfo {
     MgoLimit?: number;
     MgoOffset?: number;
 }
+/** 待执行命令参数 */
+interface IMgoCommandParam {
+    /** 表名 */
+    TableName: string;
+    /** 操作类型：UPDATE / QUERY / INSERT / DELETE / COMMAND */
+    CommandType: string;
+    /** 待执行命令（JSON 字符串） */
+    Command: string;
+}
+/** MongoDB 连接器配置 */
+interface IMongoConnector {
+    /** 连接器实例 ID */
+    InstanceId?: string;
+    /** MongoDB 数据库名 */
+    DatabaseName?: string;
+}
+/** RunCommands 请求参数 */
+interface IRunCommandsOptions {
+    /** 待执行命令列表 */
+    MgoCommands: IMgoCommandParam[];
+    /** 实例 ID，如 tnt-xxxx。不传则自动使用当前环境的数据库实例 ID */
+    Tag?: string;
+    /** 环境 ID。不传则自动使用当前环境 ID */
+    EnvId?: string;
+    /** Mongo 连接器实例信息 */
+    MongoConnector?: IMongoConnector;
+}
+/** RunCommands 返回结果 */
+interface IRunCommandsResult extends IResponseInfo {
+    /** 返回结果，每个元素是一个 JSON 字符串 */
+    Data: string[];
+}
 interface ICollectionInfo extends IResponseInfo {
     Collections: Array<TableInfo>;
     Pager: Pager;
@@ -38,6 +70,52 @@ interface IDatabaseMigrateQueryInfo extends IResponseInfo {
 interface IDatabaseImportAndExportInfo extends IResponseInfo {
     JobId: number;
 }
+/** 回档表格名称映射信息 */
+interface IModifyTableNamesInfo {
+    /** 原表名 */
+    OldTableName: string;
+    /** 新表名 */
+    NewTableName: string;
+}
+/** 回档任务信息 */
+interface IRestoreTask {
+    /** 恢复任务ID */
+    TaskId?: string;
+    /** 任务状态 */
+    Status?: string;
+    /** 任务创建时间 */
+    Time?: string;
+    /** 环境ID */
+    EnvId?: string;
+    /** 恢复类型 */
+    Type?: string;
+}
+/** 任意时间回档范围 */
+interface IRestoreTableTimeRange {
+    [key: string]: any;
+}
+/** 获取可回档表格返回结果 */
+interface IDescribeRestoreTablesResult extends IResponseInfo {
+    /** 可回档表格列表 */
+    Tables: string[];
+}
+/** 获取回档任务返回结果 */
+interface IDescribeRestoreTaskResult extends IResponseInfo {
+    /** 回档任务列表 */
+    Tasks: IRestoreTask[];
+}
+/** 获取可回档时间返回结果 */
+interface IDescribeRestoreTimeResult extends IResponseInfo {
+    /** 可回档时间列表 */
+    RestoreTimes: string[];
+    /** 任意时间回档列表 */
+    RestoreTimeRanges: IRestoreTableTimeRange[];
+}
+/** 实例表格回档返回结果 */
+interface IRestoreTCBTablesResult extends IResponseInfo {
+    /** 流程ID */
+    FlowId: number;
+}
 export declare class DatabaseService {
     static tcbServiceVersion: IServiceVersion;
     static flexdbServiceVersion: IServiceVersion;
@@ -62,5 +140,39 @@ export declare class DatabaseService {
     migrateStatus(jobId: number): Promise<IDatabaseMigrateQueryInfo>;
     import(collectionName: string, file: any, options: any): Promise<IDatabaseImportAndExportInfo>;
     export(collectionName: string, file: any, options: any): Promise<IDatabaseImportAndExportInfo>;
+    /**
+     * 获取可回档表格
+     * @param time 回档时间，格式 YYYY-MM-DD HH:MM:SS
+     * @param filters 过滤器（可选）
+     * @param instanceId 实例ID（可选，不传则自动使用当前环境的数据库实例 ID）
+     * @returns 可回档表格列表
+     */
+    describeRestoreTables(time: string, filters?: string[], instanceId?: string): Promise<IDescribeRestoreTablesResult>;
+    /**
+     * 获取回档任务
+     * @param instanceId 实例ID（可选，不传则自动使用当前环境的数据库实例 ID）
+     * @returns 回档任务列表
+     */
+    describeRestoreTask(instanceId?: string): Promise<IDescribeRestoreTaskResult>;
+    /**
+     * 获取可回档时间
+     * @param instanceId 实例ID（可选，不传则自动使用当前环境的数据库实例 ID）
+     * @returns 可回档时间列表及任意时间回档列表
+     */
+    describeRestoreTime(instanceId?: string): Promise<IDescribeRestoreTimeResult>;
+    /**
+     * 实例表格回档
+     * @param time 回档时间，格式 YYYY-MM-DD HH:MM:SS
+     * @param modifyTableNamesInfo 回档表格信息（原表名 → 新表名映射）
+     * @param instanceId 实例ID（可选，不传则自动使用当前环境的数据库实例 ID）
+     * @returns 流程ID
+     */
+    restoreTables(time: string, modifyTableNamesInfo: IModifyTableNamesInfo[], instanceId?: string): Promise<IRestoreTCBTablesResult>;
+    /**
+     * 执行文档型数据库命令
+     * @param options 命令参数（命令列表、可选的 Tag/EnvId/MongoConnector）
+     * @returns 执行结果，Data 为 JSON 字符串数组
+     */
+    runCommands(options: IRunCommandsOptions): Promise<IRunCommandsResult>;
 }
 export {};

package/types/docs/index.d.ts

@@ -0,0 +1,37 @@
+import { SearchResult, ModuleDocs } from './types';
+export declare class DocsService {
+    listModules(): Promise<string[]>;
+    /**
+     * Case: tcb docs read 快速开始
+     * 根据模块名获取该模块下的所有文档（返回嵌套的对象结构）
+     */
+    listModuleDocs(moduleName: string): Promise<ModuleDocs>;
+    /**
+     * Case: tcb docs read <任意输入>
+     * 统一的查找入口，自动识别输入格式并返回模块数据或文档URL
+     *
+     * 支持的输入格式：
+     * 1. URL路径格式（包含 /，相对或完整）: tcb docs read quick-start/create-env
+     * 2. 点分隔路径: tcb docs read 云托管.快速开始..NET 快速开始
+     * 3. 模块名: tcb docs read 快速开始 「命中第一个 底下其他同理」
+     * 4. 嵌套模块名: tcb docs read 微信生态（嵌套在"社区.最佳实践"下）
+     * 5. 文档标题: tcb docs read 小程序快速开始
+     * 6. 前缀模糊匹配: tcb docs read PHP（匹配 "PHP 快速开始"）
+     */
+    findByName(input: string): Promise<{
+        type: 'module';
+        data: ModuleDocs;
+    } | {
+        type: 'doc';
+        data: string;
+    }>;
+    readDoc(docPath: string): Promise<string>;
+    searchDocs(query: string): Promise<SearchResult[]>;
+    private getCategory;
+    private findByKeyPrefix;
+    private findByDotPath;
+    private searchDotPathInTree;
+    private matchDotPath;
+    private findNestedModule;
+    private findDocPathByTitle;
+}

package/types/docs/types.d.ts

@@ -0,0 +1,24 @@
+export type CategoryNode = string | {
+    [key: string]: CategoryNode;
+};
+export interface Category {
+    [key: string]: CategoryNode;
+}
+export interface ModuleDocs {
+    [key: string]: CategoryNode;
+}
+export interface DocEntry {
+    title: string;
+    path: string;
+}
+export interface SearchHit {
+    url: string;
+    content: string | null;
+    type: string;
+    hierarchy: Record<string, string | null>;
+}
+export interface SearchResult {
+    url: string;
+    title: string;
+    content: string | null;
+}

package/types/env/index.d.ts

@@ -1,6 +1,6 @@
 import { Environment } from '../environment';
 import { IResponseInfo, AuthDomain, EnvInfo, LoginConfigItem, ICheckTcbServiceRes, ICreatePostpayRes, EnvBillingInfoItem, PriceResult } from '../interfaces';
-import { CalculatePackageCreatePriceParams, CalculatePackageRenewPriceParams, CalculatePackageModifyPriceParams } from './type';
+import { CalculatePackageCreatePriceParams, CalculatePackageRenewPriceParams, CalculatePackageModifyPriceParams, DescribeHttpServiceRouteParams, DescribeHttpServiceRouteRes, CreateHttpServiceRouteParams, CreateHttpServiceRouteRes, ModifyHttpServiceRouteParams, ModifyHttpServiceRouteRes, DeleteHttpServiceRouteParams, DeleteHttpServiceRouteRes, BindCustomDomainParams, BindCustomDomainRes, DeleteCustomDomainParams, DeleteCustomDomainRes } from './type';
 import { CreateBillingDealParams, CreateEnvParams, BaasPackageInfo, DescribeBaasPackageListParams, ModifyEnvPlanParams, RenewEnvParams, DestroyEnvParams, DescribeEnvsParams, DescribeEnvAccountCircleParams, DescribeEnvAccountCircleRes, DescribeCreditsUsageDetailParams, EnvPkgCreditsUsage } from '../interfaces/tcb.interface';
 type SOURCE = 'miniapp' | 'qcloud';
 interface IDeleteDomainRes {
@@ -264,6 +264,44 @@ export declare class EnvService {
         Usages: EnvPkgCreditsUsage[];
         RequestId: string;
     }>;
+    /**
+     * 查询HTTP访问服务域名路由信息
+     * @param {DescribeHttpServiceRouteParams} params 查询参数
+     * @returns {Promise<DescribeHttpServiceRouteRes>}
+     */
+    describeHttpServiceRoute(params: DescribeHttpServiceRouteParams): Promise<DescribeHttpServiceRouteRes>;
+    /**
+     * 创建HTTP访问服务域名路由
+     * @param {CreateHttpServiceRouteParams} params 创建参数
+     * @returns {Promise<CreateHttpServiceRouteRes>}
+     */
+    createHttpServiceRoute(params: CreateHttpServiceRouteParams): Promise<CreateHttpServiceRouteRes>;
+    /**
+     * 修改HTTP访问服务域名路由
+     * @param {ModifyHttpServiceRouteParams} params 修改参数
+     * @returns {Promise<ModifyHttpServiceRouteRes>}
+     */
+    modifyHttpServiceRoute(params: ModifyHttpServiceRouteParams): Promise<ModifyHttpServiceRouteRes>;
+    /**
+     * 删除HTTP访问服务域名路由
+     * @param {DeleteHttpServiceRouteParams} params 删除参数
+     * @returns {Promise<DeleteHttpServiceRouteRes>}
+     */
+    deleteHttpServiceRoute(params: DeleteHttpServiceRouteParams): Promise<DeleteHttpServiceRouteRes>;
+    /**
+     * 绑定自定义域名到HTTP访问服务
+     * 底层调用 CreateHTTPServiceRoute API，专用于域名绑定场景
+     * @param {BindCustomDomainParams} params 绑定参数
+     * @returns {Promise<BindCustomDomainRes>}
+     */
+    bindCustomDomain(params: BindCustomDomainParams): Promise<BindCustomDomainRes>;
+    /**
+     * 删除自定义域名
+     * 仅当域名下无路由绑定时可删除，否则抛出错误
+     * @param {DeleteCustomDomainParams} params 删除参数
+     * @returns {Promise<DeleteCustomDomainRes>}
+     */
+    deleteCustomDomain(params: DeleteCustomDomainParams): Promise<DeleteCustomDomainRes>;
     private getCOSDomains;
     private modifyCosCorsDomain;
     private getCos;