@cloudbase/manager-node 4.2.4 → 4.2.6

package/types/function/types.d.ts

@@ -0,0 +1,154 @@
+export interface ITag {
+    TagKey: string;
+    TagValue: string[];
+}
+/**
+ * VPC
+ */
+export interface IVpc {
+    VpcId: string;
+    VpcName: string;
+    CidrBlock: string;
+    Ipv6CidrBlock: string;
+    IsDefault: false;
+    EnableMulticast: false;
+    CreatedTime: string;
+    EnableDhcp: boolean;
+    DhcpOptionsId: string;
+    DnsServerSet: string[];
+    DomainName: string;
+    TagSet: any[];
+    AssistantCidrSet: any[];
+}
+/**
+ * 子网
+ */
+export interface ISubnet {
+    VpcId: string;
+    SubnetId: string;
+    SubnetName: string;
+    CidrBlock: string;
+    Ipv6CidrBlock: string;
+    IsDefault: boolean;
+    IsRemoteVpcSnat: boolean;
+    EnableBroadcast: boolean;
+    Zone: string;
+    RouteTableId: string;
+    NetworkAclId: string;
+    TotalIpAddressCount: number;
+    AvailableIpAddressCount: number;
+    CreatedTime: string;
+    TagSet: any[];
+}
+/**
+ * 函数
+ */
+export interface IFunctionLog {
+    FunctionName: string;
+    RetMsg: string;
+    RequestId: string;
+    StartTime?: string;
+    RetCode?: number;
+    InvokeFinished?: number;
+    Duration?: number;
+    BillDuration?: number;
+    MemUsage: number;
+    Log?: string;
+    Level?: string;
+    Source?: string;
+}
+export interface ILogFilter {
+    RetCode?: 'not0' | 'is0' | 'TimeLimitExceeded' | 'ResourceLimitExceeded' | 'UserCodeException';
+}
+export declare type IRegion = number;
+export interface IEnvVariable {
+    Key: string;
+    Value: string;
+}
+export interface ITrigger {
+    Name: string;
+    Type: string;
+    Config: string;
+    TriggerName: string;
+    TriggerDesc: string;
+}
+export interface IFunctionInfo {
+    FunctionName: string;
+    FunctionId: string;
+    Runtime: string;
+    Handler: string;
+    CodeSize: number;
+    Timeout: number;
+    FunctionVersion: string;
+    MemorySize: number;
+    UseGpu: 'TRUE' | 'FALSE';
+    CodeInfo: string;
+    CodeResult: string;
+    CodeError: string;
+    ErrNo: number;
+    Role: string;
+    InstallDependency: 'FALSE' | 'TRUE';
+    AddTime: string;
+    ModTime: string;
+    Namespace: string;
+    Status: string;
+    StatusDesc: string;
+    Description: string;
+    Tags: ITag[];
+    VpcConfig: {
+        VpcId?: string;
+        SubnetId?: string;
+        vpc?: string;
+        subnet?: string;
+    };
+    Environment: {
+        Variables: IEnvVariable[];
+    };
+    Type: string;
+    EipConfig: {
+        EipFixed: 'FALSE' | 'TRUE';
+        Eips: string[];
+    };
+    PublicNetConfig: {
+        PublicNetStatus: 'ENABLE' | 'DISABLE';
+        EipConfig: {
+            EipStatus: 'ENABLE' | 'DISABLE';
+            EipAddress: string[];
+        };
+    };
+    Triggers: ITrigger[];
+}
+export interface IFunctionCode {
+    CosBucketName?: string;
+    CosObjectName?: string;
+    ZipFile: string;
+}
+export interface ILayerVersionItem {
+    LayerName: string;
+    LayerVersion: number;
+}
+export interface IFunctionUpdateAttribute {
+    Code: IFunctionCode;
+    Description: string;
+    FunctionName: string;
+    MemorySize: number;
+    Timeout: number;
+    UseGpu: 'FALSE' | 'TRUE';
+    Namespace: string;
+    Environment: {
+        Variables: IEnvVariable[];
+    };
+    VpcConfig: {
+        VpcId: string;
+        SubnetId: string;
+    };
+    InstallDependency?: 'FALSE' | 'TRUE';
+    PublicNetConfig: {
+        PublicNetStatus: string;
+        EipConfig: {
+            EipStatus: string;
+            EipAddress: string[];
+        };
+    };
+    Layers?: ILayerVersionItem[];
+}

package/types/hosting/index.d.ts

@@ -0,0 +1,253 @@
+/// <reference types="node" />
+import { Environment } from '../environment';
+import { IListFileInfo } from '../interfaces';
+export interface IProgressData {
+    loaded: number;
+    total: number;
+    speed: number;
+    percent: number;
+}
+export declare type OnProgress = (progressData: IProgressData) => void;
+export declare type OnFileFinish = (error: Error, res: any, fileData: any) => void;
+export interface IHostingFileOptions {
+    localPath: string;
+    cloudPath?: string;
+    parallel?: number;
+    files?: {
+        localPath: string;
+        cloudPath: string;
+    }[];
+    onProgress?: OnProgress;
+    onFileFinish?: OnFileFinish;
+    ignore?: string | string[];
+    retryCount?: number;
+    retryInterval?: number;
+}
+export interface IHostingFilesOptions {
+    localPath?: string;
+    cloudPath?: string;
+    parallel?: number;
+    files: {
+        localPath: string;
+        cloudPath: string;
+    }[];
+    onProgress?: OnProgress;
+    onFileFinish?: OnFileFinish;
+    ignore?: string | string[];
+    retryCount?: number;
+    retryInterval?: number;
+}
+export declare type IHostingOptions = IHostingFileOptions | IHostingFilesOptions;
+export interface IHostingCloudOptions {
+    cloudPath: string;
+    isDir: boolean;
+}
+export interface IBindDomainOptions {
+    domain: string;
+    certId: string;
+}
+export interface ICheckSourceOptions {
+    domains: string[];
+}
+export interface ITcbOrigin {
+    Master: string;
+    Slave: string;
+}
+export interface IIpFilter {
+    Switch: string;
+    FilterType?: string;
+    Filters?: string[];
+}
+export interface IIpFreqLimit {
+    Switch: string;
+    Qps?: number;
+}
+export interface ITcbAuthentication {
+    Switch: string;
+    SecretKey: string;
+    SignParam?: string;
+    TimeParam?: string;
+    ExpireTime?: string;
+}
+export interface ITcbCache {
+    RuleType: string;
+    RuleValue: string;
+    CacheTtl: number;
+}
+export interface ITcbRefererRule {
+    RefererType: string;
+    Referers: string[];
+    AllowEmpty: boolean;
+}
+export interface ITcbReferer {
+    Switch: string;
+    RefererRules?: ITcbRefererRule[];
+}
+export interface ITcbDomainConfig {
+    Cache?: ITcbCache[];
+    IpFilter?: IIpFilter;
+    IpFreqLimit?: IIpFreqLimit;
+    Refer?: ITcbReferer;
+}
+export interface IModifyOptions {
+    domain: string;
+    domainId: number;
+    domainConfig: ITcbDomainConfig;
+}
+export interface IDeleteDomainOptions {
+    domain: string;
+}
+export interface IDomainInfo {
+    Domain: string;
+    DomainId: number;
+    Status: 'process' | 'online' | 'offline';
+    DomainConfig: Record<string, string>;
+    CName: String;
+}
+export interface IHostingInfo {
+    EnvId: string;
+    CdnDomain: string;
+    Bucket: string;
+    Regoin: string;
+    Status: string;
+    MaxDomain: number;
+    Id: number;
+    PolicyId: number;
+}
+export interface IRoutingRules {
+    keyPrefixEquals?: string;
+    httpErrorCodeReturnedEquals?: string;
+    replaceKeyWith?: string;
+    replaceKeyPrefixWith?: string;
+}
+export interface IBucketWebsiteOptiosn {
+    indexDocument: string;
+    errorDocument?: string;
+    routingRules?: Array<IRoutingRules>;
+}
+export interface IFindOptions {
+    prefix?: string;
+    marker?: string;
+    maxKeys?: number;
+}
+export declare class HostingService {
+    private environment;
+    private tcbService;
+    private cdnService;
+    constructor(environment: Environment);
+    /**
+     * 获取 hosting 信息
+     */
+    getInfo(): Promise<IHostingInfo[]>;
+    /**
+     * 开启 hosting 服务，异步任务
+     */
+    enableService(): Promise<{
+        code: number;
+        requestId: string;
+    }>;
+    findFiles(options: IFindOptions): Promise<any>;
+    /**
+     * 展示文件列表
+     */
+    listFiles(): Promise<IListFileInfo[]>;
+    /**
+     * 销毁静态托管服务
+     */
+    destroyService(): Promise<{
+        code: number;
+        requestId: string;
+    }>;
+    /**
+     * 支持上传单个文件，文件夹，或多个文件
+     * @param options
+     */
+    uploadFiles(options: IHostingOptions): Promise<any>;
+    /**
+     * 删除文件或文件夹
+     * @param options
+     */
+    deleteFiles(options: IHostingCloudOptions): Promise<{
+        Deleted: {
+            Key: string;
+        }[];
+        Error: Object[];
+    } | {
+        Deleted: any[];
+        Error: any[];
+    }>;
+    /**
+     * 下载文件
+     * @param {string} cloudPath 云端文件路径
+     * @param {string} localPath 文件本地存储路径，文件需指定文件名称
+     * @returns {Promise<NodeJS.ReadableStream>}
+     */
+    downloadFile(options: {
+        cloudPath: string;
+        localPath?: string;
+    }): Promise<NodeJS.ReadableStream | string>;
+    /**
+     * 下载文件夹
+     * @param {string} cloudPath 云端文件路径
+     * @param {string} localPath 本地文件夹存储路径
+     * @returns {Promise<(NodeJS.ReadableStream | string)[]>}
+     */
+    downloadDirectory(options: {
+        cloudPath: string;
+        localPath?: string;
+    }): Promise<void>;
+    walkLocalDir(envId: string, dir: string): Promise<string[]>;
+    /**
+     * 绑定自定义域名
+     * @param {IBindDomainOptions} options
+     * @returns
+     * @memberof HostingService
+     */
+    CreateHostingDomain(options: IBindDomainOptions): Promise<{}>;
+    /**
+     * 删除托管域名
+     *
+     * @param {IBindDomainOptions} options
+     * @returns
+     * @memberof HostingService
+     */
+    deleteHostingDomain(options: IDeleteDomainOptions): Promise<{
+        RequestId: string;
+    }>;
+    /**
+     * 查询域名状态信息
+     * @param options
+     */
+    tcbCheckResource(options: ICheckSourceOptions): Promise<{
+        Domains: IDomainInfo[];
+        RecordCount: number;
+        RequestId: string;
+    }>;
+    /**
+     * 域名配置变更
+     * @param options
+     */
+    tcbModifyAttribute(options: IModifyOptions): Promise<{}>;
+    /**
+     * 查询静态网站配置
+     * @memberof HostingService
+     */
+    getWebsiteConfig(): Promise<any>;
+    /**
+     * 配置静态网站文档
+     * @param options
+     */
+    setWebsiteDocument(options: IBucketWebsiteOptiosn): Promise<any>;
+    /**
+     * 检查 hosting 服务状态
+     */
+    private checkStatus;
+    /**
+     * 获取配置
+     */
+    private getHostingConfig;
+    /**
+     * 将 cloudPath 转换成 cloudPath/ 形式
+     */
+    private getCloudKey;
+}

package/types/index.d.ts

@@ -0,0 +1,52 @@
+import { EnvService } from './env';
+import { FunctionService } from './function';
+import { StorageService } from './storage';
+import { DatabaseService } from './database';
+import { CommonService } from './common';
+import { HostingService } from './hosting';
+import { Environment } from './environment';
+import { EnvironmentManager } from './environmentManager';
+import { ThirdService } from './third';
+import { AccessService } from './access';
+import { UserService } from './user';
+import { CloudBaseRunService } from './cloudBaseRun';
+interface CloudBaseConfig {
+    secretId?: string;
+    secretKey?: string;
+    token?: string;
+    envId?: string;
+    proxy?: string;
+    region?: string;
+    envType?: string;
+}
+declare class CloudBase {
+    private static cloudBase;
+    /**
+     * init 初始化 为单例
+     *
+     * @static
+     * @param {ManagerConfig} config
+     * @returns {CloudBase}
+     * @memberof CloudBase
+     */
+    static init(config: CloudBaseConfig): CloudBase;
+    private context;
+    private cloudBaseConfig;
+    private environmentManager;
+    constructor(config?: CloudBaseConfig);
+    addEnvironment(envId: string): void;
+    currentEnvironment(): Environment;
+    get functions(): FunctionService;
+    get storage(): StorageService;
+    get database(): DatabaseService;
+    get hosting(): HostingService;
+    get access(): AccessService;
+    get cloudApp(): CloudBaseRunService;
+    commonService(service?: string, version?: string): CommonService;
+    get env(): EnvService;
+    get third(): ThirdService;
+    get user(): UserService;
+    getEnvironmentManager(): EnvironmentManager;
+    getManagerConfig(): CloudBaseConfig;
+}
+export = CloudBase;

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

@@ -0,0 +1,7 @@
+export interface IResponseInfo {
+    RequestId: string;
+}
+export interface IServiceVersion {
+    service: string;
+    version: string;
+}

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

@@ -0,0 +1,18 @@
+import { IResponseInfo } from './base.interface';
+export interface IGoodItem {
+    GoodsCategoryId: number;
+    RegionId: number;
+    ZoneId: number;
+    GoodsNum: number;
+    ProjectId: number;
+    PayMode: number;
+    Platform: number;
+    GoodsDetail: string;
+}
+export interface IGenerateDealsRes extends IResponseInfo {
+    OrderIds: Array<string>;
+}
+export interface IPayDealsRes extends IResponseInfo {
+    OrderIds: Array<string>;
+    ResourceIds: Array<string>;
+}

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

@@ -0,0 +1,24 @@
+import { IResponseInfo } from './base.interface';
+interface IRoleInfo {
+    RoleId: string;
+    RoleName: string;
+    PolicyDocument: string;
+    Description: string;
+    AddTime: string;
+    UpdateTime: string;
+    ConsoleLogin: number;
+}
+export interface IRoleListRes extends IResponseInfo {
+    List: Array<IRoleInfo>;
+    TotalNum: number;
+}
+export interface ICreateRoleRes extends IResponseInfo {
+    RoleId: string;
+}
+export interface ICheckTcbServiceRes extends IResponseInfo {
+    Initialized: boolean;
+}
+export interface IGetRoleRes extends IResponseInfo {
+    RoleInfo: IRoleInfo;
+}
+export {};

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

@@ -0,0 +1,67 @@
+export interface IExistsRes {
+    RequestId: string;
+    Msg?: string;
+    Exists: boolean;
+}
+export interface IDatabaseTableReq {
+    Tag: string;
+    TableName: string;
+}
+export interface IndexInfo {
+    Name: string;
+    Size: number;
+    Keys: Indexkey[];
+    Accesses: IndexAccesses;
+    Unique: boolean;
+}
+export interface IndexAccesses {
+    Ops: number;
+    Since: string;
+}
+export interface Indexkey {
+    Name?: string;
+    Direction?: string;
+}
+export interface DropIndex {
+    IndexName: string;
+}
+export interface CreateIndex {
+    IndexName: string;
+    MgoKeySchema: MgoKeySchema;
+}
+export interface MgoKeySchema {
+    MgoIndexKeys: MgoIndexKeys[];
+    MgoIsUnique: boolean;
+}
+export interface Pager {
+    Offset: number;
+    Limit: number;
+    Total: number;
+}
+export interface MgoIndexKeys {
+    Name: string;
+    Direction: string;
+}
+export interface TableInfo {
+    TableName: string;
+    CollectionName: string;
+    Count: number;
+    Size: number;
+    IndexCount: number;
+    IndexSize: number;
+}
+export interface GoodsDetail {
+    QuataId: string;
+    DiskSize?: number;
+    ConnNum?: number;
+    ReadOperands?: number;
+    WriteOperands?: number;
+    CollectionLimits?: number;
+    SingleCollectionIndexLimits?: number;
+}
+export interface ResourceAmount {
+    UsedDiskSize?: number;
+    ReadOperands?: number;
+    WriteOperands?: number;
+    TableNum?: number;
+}

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

@@ -0,0 +1,65 @@
+export interface IFunctionVPC {
+    subnetId: string;
+    vpcId: string;
+}
+export interface ICloudFunctionTrigger {
+    name: string;
+    type: string;
+    config: string;
+}
+export interface ICloudFunctionConfig {
+    timeout?: number;
+    envVariables?: Record<string, string | number | boolean>;
+    runtime?: string;
+    vpc?: IFunctionVPC;
+    installDependency?: boolean;
+    l5?: boolean;
+    memorySize?: number;
+    role?: string;
+}
+export interface LayerVersionSimple {
+    LayerName: string;
+    LayerVersion: number;
+}
+export interface ICloudFunction extends ICloudFunctionConfig {
+    name: string;
+    handler?: string;
+    codeSecret?: string;
+    isWaitInstall?: boolean;
+    ignore?: string | string[];
+    layers?: {
+        name: string;
+        version: number;
+    }[];
+    triggers?: ICloudFunctionTrigger[];
+}
+export interface IFunctionLogOptions {
+    name: string;
+    offset?: number;
+    limit?: number;
+    order?: string;
+    orderBy?: string;
+    startTime?: string;
+    endTime?: string;
+    requestId?: string;
+}
+export interface IFunctionInvokeRes {
+    RequestId: string;
+    Log: string;
+    RetMsg: string;
+    ErrMsg: string;
+    MemUsage: number;
+    Duration: number;
+    BillDuration: number;
+    FunctionRequestId: string;
+}
+export interface IFunctionLogRes {
+    RequestId: string;
+    Data: [];
+    TotalCount: number;
+}
+export interface IFunctionDownloadUrlRes {
+    Url: string;
+    RequestId: string;
+    CodeSha256: string;
+}

package/types/interfaces/index.d.ts

@@ -0,0 +1,7 @@
+export * from './function.interface';
+export * from './flexdb.interface';
+export * from './tcb.interface';
+export * from './base.interface';
+export * from './storage.interface';
+export * from './cam.interface';
+export * from './billing.interface';

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

@@ -0,0 +1,26 @@
+export interface IUploadMetadata {
+    token: string;
+    url: string;
+    authorization: string;
+    fileId: string;
+    cosFileId: string;
+    download_url: string;
+}
+export interface IListFileInfo {
+    Key: string;
+    LastModified: string;
+    ETag: string;
+    Size: string;
+    Owner: string;
+    StorageClass: string;
+}
+export interface IFileInfo {
+    Size: string;
+    Type: string;
+    Date: string;
+    ETag: string;
+}
+export interface ITempUrlInfo {
+    cloudPath: string;
+    maxAge?: number;
+}