@cloudbase/manager-node 4.2.0 → 4.2.2

package/src/index.ts

@@ -0,0 +1,127 @@
+import { EnvService } from './env'
+import { FunctionService } from './function'
+import { StorageService } from './storage'
+import { DatabaseService } from './database'
+import { CloudBaseContext } from './context'
+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
+}
+
+class CloudBase {
+    private static cloudBase: CloudBase
+
+    /**
+     * init 初始化 为单例
+     *
+     * @static
+     * @param {ManagerConfig} config
+     * @returns {CloudBase}
+     * @memberof CloudBase
+     */
+    public static init(config: CloudBaseConfig): CloudBase {
+        if (!CloudBase.cloudBase) {
+            CloudBase.cloudBase = new CloudBase(config)
+        }
+
+        return CloudBase.cloudBase
+    }
+
+    private context: CloudBaseContext
+    private cloudBaseConfig: CloudBaseConfig = {}
+    private environmentManager: EnvironmentManager
+
+    public constructor(config: CloudBaseConfig = {}) {
+        let { secretId, secretKey, token, envId, proxy, region, envType } = config
+        // config 中传入的 secretId secretkey 必须同时存在
+        if ((secretId && !secretKey) || (!secretId && secretKey)) {
+            throw new Error('secretId and secretKey must be a pair')
+        }
+
+        this.cloudBaseConfig = {
+            secretId,
+            secretKey,
+            token,
+            envId,
+            envType,
+            proxy,
+            region
+        }
+
+        // 初始化 context
+        this.context = new CloudBaseContext(this.cloudBaseConfig)
+
+        this.environmentManager = new EnvironmentManager(this.context)
+        this.environmentManager.add(envId || '')
+    }
+
+    public addEnvironment(envId: string): void {
+        this.environmentManager.add(envId)
+    }
+
+    public currentEnvironment(): Environment {
+        return this.environmentManager.getCurrentEnv()
+    }
+
+    public get functions(): FunctionService {
+        return this.currentEnvironment().getFunctionService()
+    }
+    public get storage(): StorageService {
+        return this.currentEnvironment().getStorageService()
+    }
+    public get database(): DatabaseService {
+        return this.currentEnvironment().getDatabaseService()
+    }
+
+    public get hosting(): HostingService {
+        return this.currentEnvironment().getHostingService()
+    }
+
+    public get access(): AccessService {
+        return this.currentEnvironment().getAccessService()
+    }
+
+    public get cloudApp(): CloudBaseRunService {
+        return this.currentEnvironment().getCloudBaseRunService()
+    }
+
+    public commonService(service?: string, version?: string): CommonService {
+        return this.currentEnvironment().getCommonService(service, version)
+    }
+
+    public get env(): EnvService {
+        return this.currentEnvironment().getEnvService()
+    }
+
+    public get third(): ThirdService {
+        return this.currentEnvironment().getThirdService()
+    }
+
+    public get user(): UserService {
+        return this.currentEnvironment().getUserService()
+    }
+
+    public getEnvironmentManager(): EnvironmentManager {
+        return this.environmentManager
+    }
+
+    public getManagerConfig(): CloudBaseConfig {
+        return this.cloudBaseConfig
+    }
+}
+
+export = CloudBase

package/src/interfaces/base.interface.ts

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

package/src/interfaces/billing.interface.ts

@@ -0,0 +1,21 @@
+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/src/interfaces/cam.interface.ts

@@ -0,0 +1,28 @@
+import { IResponseInfo } from './base.interface'
+
+interface IRoleInfo {
+    RoleId: string // 角色ID
+    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
+}

package/src/interfaces/flexdb.interface.ts

@@ -0,0 +1,104 @@
+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
+    // 方向：specify 1 for ascending or -1 for descending
+    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
+    // 索引类型，当前支持1,-1,2d
+    Direction: string
+}
+export interface TableInfo {
+    // 表名
+    TableName: string
+    CollectionName: string
+    // 表中文档数量
+    Count: number
+    // 表的大小（即表中文档总大小），单位：字节
+    Size: number
+    // 索引数量
+    IndexCount: number
+    // 索引占用空间，单位：字节
+    IndexSize: number
+}
+
+export interface GoodsDetail {
+    // 配额id
+    QuataId: string
+    // 存储GB
+    DiskSize?: number
+    // 同时连接数
+    ConnNum?: number
+    // 读操作数
+    ReadOperands?: number
+    // 写操作数
+    WriteOperands?: number
+    // 集合限制
+    CollectionLimits?: number
+    // 单集合索引限制
+    SingleCollectionIndexLimits?: number
+}
+export interface ResourceAmount {
+    // 已用磁盘容量，单位为MB
+    UsedDiskSize?: number
+    // 当天已消耗读请求个数
+    ReadOperands?: number
+    // 当天已消耗写请求个数
+    WriteOperands?: number
+    // 已创建表个数
+    TableNum?: number
+}

package/src/interfaces/function.interface.ts

@@ -0,0 +1,75 @@
+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 // layer名称
+    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 // 请求 Id
+    Log: string // 表示执行过程中的日志输出
+    RetMsg: string // 表示执行函数的返回
+    ErrMsg: string // 表示执行函数的错误返回信息
+    MemUsage: number // 执行函数时的内存大小，单位为Byte
+    Duration: number // 表示执行函数的耗时，单位是毫秒
+    BillDuration: number // 表示函数的计费耗时，单位是毫秒
+    FunctionRequestId: string // 此次函数执行的Id
+}
+
+export interface IFunctionLogRes {
+    RequestId: string // 请求 Id
+    Data: []
+    TotalCount: number
+}
+
+export interface IFunctionDownloadUrlRes {
+    Url: string
+    RequestId: string
+    CodeSha256: string
+}

package/src/interfaces/index.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/src/interfaces/storage.interface.ts

@@ -0,0 +1,29 @@
+export interface IUploadMetadata {
+    token: string
+    url: string
+    authorization: string
+    fileId: string
+    cosFileId: string
+    download_url: string
+}
+
+export interface IListFileInfo {
+    Key: string // 对象键
+    LastModified: string //	对象最后修改时间，为 ISO8601 格式，如2019-05-24T10:56:40Z	date
+    ETag: string //	对象的实体标签（Entity Tag），是对象被创建时标识对象内容的信息标签，可用于检查对象的内容是否发生变化
+    Size: string // 对象大小，单位为 Byte
+    Owner: string // 对象持有者信息
+    StorageClass: string // 对象存储类型，标准存储 STANDARD
+}
+
+export interface IFileInfo {
+    Size: string // 文件大小 KB
+    Type: string // 文件类型
+    Date: string // 修改时间
+    ETag: string // 对象的实体标签（Entity Tag）
+}
+
+export interface ITempUrlInfo {
+    cloudPath: string
+    maxAge?: number // 单位：秒
+}