@cloudbase/manager-node 4.2.10 → 4.3.0

package/types/cloudrun/type.d.ts

@@ -0,0 +1,315 @@
+export declare enum CloudrunServerType {
+    /**
+     * 函数型服务
+     */
+    Function = "function",
+    /**
+     * 容器型服务
+     */
+    Container = "container"
+}
+/**
+ * 服务基础信息接口
+ */
+export interface ICloudrunServerBaseInfo {
+    /**
+     * 服务名称
+     * @example "serverName"
+     */
+    ServerName: string;
+    /**
+     * 默认服务域名
+     * @example "http://xxx.xxx.xxx"
+     */
+    DefaultDomainName: string;
+    /**
+     * 自定义域名
+     * @example "http://xxx.xxx.xxx"
+     */
+    CustomDomainName: string;
+    /**
+     * 服务状态
+     * @example "running" | "deploying" | "deploy_failed"
+     */
+    Status: 'running' | 'deploying' | 'deploy_failed';
+    /**
+     * 更新时间
+     * @example "2022-03-09 14:00:00"
+     */
+    UpdateTime: string;
+    /**
+     * 公网访问类型数组
+     * @example ["OA","MINIAPP","VPC"]
+     */
+    AccessTypes: string[];
+    /**
+     * 展示自定义域名数组
+     * @example ["http://xxx.xxx.xxx","http://xxx.xxx.xxx"]
+     */
+    CustomDomainNames: string[];
+    /**
+     * 服务类型
+     * @example "function" | "container"
+     */
+    ServerType: CloudrunServerType;
+    /**
+     * 流量类型（请根据实际业务补充具体类型定义）
+     */
+    TrafficType?: string;
+}
+/**
+ * 扩缩容策略配置
+ */
+export interface ICloudrunHpaPolicy {
+    /**
+     * 扩缩容类型
+     * @example "cpu" | "mem" | "cpu/mem"
+     */
+    PolicyType: string;
+    /**
+     * 扩缩容阈值(百分比)
+     * @example 60
+     */
+    PolicyThreshold: number;
+}
+/**
+ * 定时扩缩容配置
+ */
+export interface ICloudrunTimerScale {
+    /**
+     * 循环类型
+     * @example "none"
+     */
+    CycleType?: string;
+    /**
+     * 循环起始日期
+     * @example "2022-09-08"
+     */
+    StartDate?: string;
+    /**
+     * 循环结束日期
+     * @example "2022-09-08"
+     */
+    EndDate?: string;
+    /**
+     * 起始时间
+     * @example "00:00:00"
+     */
+    StartTime?: string;
+    /**
+     * 结束时间
+     * @example "23:59:00"
+     */
+    EndTime?: string;
+    /**
+     * 副本个数
+     * @example 1
+     */
+    ReplicaNum?: number;
+}
+/**
+ * 服务基础配置信息
+ */
+export interface ICloudrunServerBaseConfig {
+    /**
+     * 环境 ID
+     * @example "test-1gbtbgkjf8f48e2c"
+     */
+    EnvId: string;
+    /**
+     * 服务名称
+     * @example "server-name"
+     */
+    ServerName: string;
+    /**
+     * 公网访问类型数组
+     * @example ["PUBLIC", "OA", "MINIAPP", "VPC", ""]
+     */
+    OpenAccessTypes: string[];
+    /**
+     * CPU 规格
+     * @example 0.25
+     */
+    Cpu: number;
+    /**
+     * 内存规格
+     * @example 0.25
+     */
+    Mem: number;
+    /**
+     * 最小副本数
+     * @example 1
+     */
+    MinNum: number;
+    /**
+     * 最大副本数
+     * @example 2
+     */
+    MaxNum: number;
+    /**
+     * 扩缩容配置
+     * @example cpu, mem, cpu/mem
+     */
+    PolicyDetails: ICloudrunHpaPolicy[];
+    /**
+     * 日志采集路径
+     * @example "stdout"
+     */
+    CustomLogs: string;
+    /**
+     * 环境变量
+     * @example {"MYSQL_USERNAME":"root"}
+     */
+    EnvParams: string;
+    /**
+     * 延迟检测时间(秒)
+     * @example 2
+     */
+    InitialDelaySeconds: number;
+    /**
+     * 创建时间
+     * @example "2022-03-10 19:44:07"
+     */
+    CreateTime: string;
+    /**
+     * 服务端口
+     * @example 8080
+     */
+    Port: number;
+    /**
+     * 是否有 Dockerfile
+     * @example true
+     */
+    HasDockerfile: boolean;
+    /**
+     * Dockerfile 文件名
+     * @example "Dockerfile"
+     */
+    Dockerfile: string;
+    /**
+     * 构建目录
+     * @example "src/"
+     */
+    BuildDir: string;
+    /**
+     * 日志类型
+     * @example "none" | "default" | "custom"
+     */
+    LogType?: string;
+    /**
+     * CLS 日志集 ID
+     * @example "dafslakfjkdal"
+     */
+    LogSetId?: string;
+    /**
+     * CLS 主题 ID
+     * @example "sfafkslkfj"
+     */
+    LogTopicId?: string;
+    /**
+     * 日志解析类型
+     * @example "json" | "line"
+     */
+    LogParseType?: string;
+    /**
+     * 服务标签
+     * @example "function"
+     */
+    Tag?: string;
+    /**
+     * 内网访问开关
+     * @example "close" | "open"
+     */
+    InternalAccess?: string;
+    /**
+     * 内网域名
+     * @example "https://sdfsdf"
+     */
+    InternalDomain?: string;
+    /**
+     * 运行模式
+     * @example "custom"
+     */
+    OperationMode?: string;
+    /**
+     * 定时扩缩容配置
+     */
+    TimerScale?: ICloudrunTimerScale[];
+    /**
+     * Dockerfile EntryPoint 参数
+     * @example ["echo", "test"]
+     */
+    EntryPoint?: string[];
+    /**
+     * Dockerfile Cmd 参数
+     * @example ["echo", "test"]
+     */
+    Cmd?: string[];
+}
+/**
+ * 在线版本信息
+ */
+export interface ICloudrunOnlineVersionInfo {
+    /**
+     * 版本名称
+     * @example "test-001"
+     */
+    VersionName: string;
+    /**
+     * 镜像URL
+     * @example "imageurl"
+     */
+    ImageUrl: string;
+    /**
+     * 流量比例
+     * @example "100"
+     */
+    FlowRatio: string;
+}
+/**
+ * 服务列表响应接口
+ */
+export interface ICloudrunListResponse {
+    /**
+     * 服务列表数组
+     */
+    ServerList: ICloudrunServerBaseInfo[];
+    /**
+     * 服务总数
+     * @example 10
+     */
+    Total: number;
+    /**
+     * 请求ID
+     */
+    RequestId: string;
+}
+/**
+ * 服务详情响应接口
+ */
+export interface ICloudrunDetailResponse {
+    /**
+     * 服务基本信息
+     */
+    BaseInfo: ICloudrunServerBaseInfo;
+    /**
+     * 服务配置信息
+     */
+    ServerConfig: ICloudrunServerBaseConfig;
+    /**
+     * 在线版本信息
+     */
+    OnlineVersionInfos: ICloudrunOnlineVersionInfo[];
+    /**
+     * 请求ID
+     */
+    RequestId: string;
+}
+export interface ITemplate {
+    identifier: string;
+    title: string;
+    description: string;
+    runtimeVersion: string;
+    language: string;
+    zipFileStore: string;
+}

package/types/env/index.d.ts

@@ -1,6 +1,6 @@
 import { Environment } from '../environment';
 import { IResponseInfo, AuthDomain, EnvInfo, LoginConfigItem, ICheckTcbServiceRes, ICreatePostpayRes } from '../interfaces';
-declare type SOURCE = 'miniapp' | 'qcloud';
+type SOURCE = 'miniapp' | 'qcloud';
 interface IDeleteDomainRes {
     RequestId: string;
     Deleted: number;

package/types/environment.d.ts

@@ -1,5 +1,6 @@
 import { DatabaseService } from './database';
 import { FunctionService } from './function';
+import { CloudRunService } from './cloudrun';
 import { StorageService } from './storage';
 import { EnvService } from './env';
 import { CommonService } from './common';
@@ -17,6 +18,7 @@ export declare class Environment {
     private envId;
     private envType?;
     private functionService;
+    private cloudRunService;
     private databaseService;
     private storageService;
     private envService;
@@ -32,6 +34,7 @@ export declare class Environment {
     getStorageService(): StorageService;
     getDatabaseService(): DatabaseService;
     getFunctionService(): FunctionService;
+    getCloudRunService(): CloudRunService;
     getEnvService(): EnvService;
     getHostingService(): HostingService;
     getThirdService(): ThirdService;

package/types/function/types.d.ts

@@ -60,7 +60,7 @@ export interface IFunctionLog {
 export interface ILogFilter {
     RetCode?: 'not0' | 'is0' | 'TimeLimitExceeded' | 'ResourceLimitExceeded' | 'UserCodeException';
 }
-export declare type IRegion = number;
+export type IRegion = number;
 export interface IEnvVariable {
     Key: string;
     Value: string;

package/types/hosting/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Environment } from '../environment';
 import { IListFileInfo } from '../interfaces';
 export interface IProgressData {
@@ -7,8 +6,8 @@ export interface IProgressData {
     speed: number;
     percent: number;
 }
-export declare type OnProgress = (progressData: IProgressData) => void;
-export declare type OnFileFinish = (error: Error, res: any, fileData: any) => void;
+export type OnProgress = (progressData: IProgressData) => void;
+export type OnFileFinish = (error: Error, res: any, fileData: any) => void;
 export interface IHostingFileOptions {
     localPath: string;
     cloudPath?: string;
@@ -37,7 +36,7 @@ export interface IHostingFilesOptions {
     retryCount?: number;
     retryInterval?: number;
 }
-export declare type IHostingOptions = IHostingFileOptions | IHostingFilesOptions;
+export type IHostingOptions = IHostingFileOptions | IHostingFilesOptions;
 export interface IHostingCloudOptions {
     cloudPath: string;
     isDir: boolean;

package/types/index.d.ts

@@ -1,5 +1,6 @@
 import { EnvService } from './env';
 import { FunctionService } from './function';
+import { CloudRunService } from './cloudrun';
 import { StorageService } from './storage';
 import { DatabaseService } from './database';
 import { CommonService } from './common';
@@ -37,6 +38,7 @@ declare class CloudBase {
     addEnvironment(envId: string): void;
     currentEnvironment(): Environment;
     get functions(): FunctionService;
+    get cloudrun(): CloudRunService;
     get storage(): StorageService;
     get database(): DatabaseService;
     get hosting(): HostingService;

package/types/storage/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Environment } from '../environment';
 import { IUploadMetadata, IListFileInfo, IFileInfo, ITempUrlInfo, IResponseInfo } from '../interfaces';
 export interface IProgressData {
@@ -60,9 +59,9 @@ export interface IGetBucketOpions {
     marker?: string;
     maxKeys?: number;
 }
-export declare type AclType = 'READONLY' | 'PRIVATE' | 'ADMINWRITE' | 'ADMINONLY';
-declare type OnProgress = (progressData: IProgressData) => void;
-declare type OnFileFinish = (error: Error, res: any, fileData: any) => void;
+export type AclType = 'READONLY' | 'PRIVATE' | 'ADMINWRITE' | 'ADMINONLY';
+type OnProgress = (progressData: IProgressData) => void;
+type OnFileFinish = (error: Error, res: any, fileData: any) => void;
 export declare class StorageService {
     private environment;
     private tcbService;

package/types/user/types.d.ts

@@ -17,4 +17,4 @@ export interface EndUserInfo {
     HasPassword: boolean;
     UserName: string;
 }
-export declare type EndUserStatus = 'ENABLE' | 'DISABLE';
+export type EndUserStatus = 'ENABLE' | 'DISABLE';

package/types/utils/fs.d.ts

@@ -1,4 +1,4 @@
-declare type SizeUnit = 'MB' | 'GB';
+type SizeUnit = 'MB' | 'GB';
 export declare function checkFullAccess(dest: string, throwError?: boolean): boolean;
 export declare function checkReadable(dest: string, throwError?: boolean): boolean;
 export declare function isDirectory(dest: string): boolean;

package/types/utils/http-request.d.ts

@@ -1,2 +1,3 @@
-export declare function fetch(url: string, config: Record<string, any>, proxy: any): Promise<any>;
-export declare function fetchStream(url: string, config: Record<string, any>, proxy: any): Promise<import("node-fetch").Response>;
+import _fetch from 'node-fetch';
+export declare function fetch(url: string, config?: Record<string, any>, proxy?: any): Promise<any>;
+export declare function fetchStream(url: string, config?: Record<string, any>, proxy?: any): Promise<_fetch.Response>;

package/types/utils/index.d.ts

@@ -1,10 +1,11 @@
-export { guid6 } from './uuid';
-export * from './cloud-api-request';
+import { ITemplate } from '../cloudrun/type';
 export * from './auth';
+export * from './cloud-api-request';
 export * from './cloudbase-request';
-export * from './http-request';
 export * from './envLazy';
 export * from './fs';
+export * from './http-request';
+export { guid6 } from './uuid';
 interface IZipOption {
     dirPath: string;
     outputPath: string;
@@ -12,9 +13,23 @@ interface IZipOption {
     pattern?: string;
 }
 export declare function compressToZip(option: IZipOption): Promise<unknown>;
+/**
+ * 下载并解压云托管模板到指定目录
+ * @param {string} downloadUrl 模板下载地址
+ * @param {string} targetPath 目标路径
+ * @returns {Promise<void>}
+ * @throws 当下载失败或解压失败时抛出错误
+ */
+export declare function downloadAndExtractRemoteZip(downloadUrl: string, targetPath: string): Promise<void>;
 export declare function getRuntime(): string;
 export declare function getEnvVar(envName: string): string;
 export declare function rsaEncrypt(data: string): string;
 export declare function sleep(time: number): Promise<void>;
 export declare function upperCaseStringFisrt(str: string): string;
 export declare function upperCaseObjKey(object: any): any;
+/**
+ * 获取函数模板列表
+ * @param type 函数模板类型，支持 'scfFunc' 和 'tcbrFunc'
+ * @returns
+ */
+export declare function fetchTemplates(types: ('scfFunc' | 'tcbrFunc' | 'tcbrContainer')[]): Promise<ITemplate[]>;

package/types/utils/parallel.d.ts

@@ -1,4 +1,4 @@
-export declare type AsyncTask = () => Promise<any>;
+export type AsyncTask = () => Promise<any>;
 /**
  * 异步任务并发控制器，以一定的并发数执行所有任务
  * 不具备队列性质，异步任务随机执行