@cloudbase/cli 1.11.0 → 1.12.2-alpha.1

package/src/types.ts

@@ -435,4 +435,99 @@ export interface ITurnOffStandaloneGateway {
 export interface IDestroyStandaloneGateway {
     envId: string,
     gatewayName: string
+}
+
+export interface IPublishVersionParams {
+    envId: string
+    functionName: string
+    description?: string
+}
+export interface IListFunctionVersionParams {
+    envId: string
+    functionName: string
+    offset?: number
+    limit?: number
+    order?: string
+    orderBy?: string
+}
+
+export interface IFunctionVersion {
+    Version: string
+    Description: string
+    AddTime: string
+    ModTime: string
+    Status: string //
+}
+
+export interface IFunctionVersionsRes {
+    FunctionVersion: string[]
+    Versions: IFunctionVersion[]
+    TotalCount: number
+}
+
+export interface ISetProvisionedConcurrencyConfig {
+    envId: string
+    functionName: string
+    qualifier: string
+    versionProvisionedConcurrencyNum: number
+}
+
+export interface IGetProvisionedConcurrencyConfig {
+    functionName: string
+    qualifier?: string
+    envId: string
+}
+
+export interface IGetProvisionedConcurrencyRes {
+    UnallocatedConcurrencyNum: number
+    Allocated: IVersionProvisionedConcurrencyInfo[]
+}
+
+export interface IVersionProvisionedConcurrencyInfo {
+    AllocatedProvisionedConcurrencyNum: number // 设置的预置并发数。
+    AvailableProvisionedConcurrencyNum: number // 当前已完成预置的并发数。
+    Status: string // 预置任务状态，Done表示已完成，InProgress表示进行中，Failed表示部分或全部失败。
+    StatusReason: string // 对预置任务状态Status的说明。
+    Qualifier: string // 版本号
+}
+
+export interface IUpdateFunctionAliasConfig {
+    envId: string
+    functionName: string // 函数名
+    name: string // 函数别名 如$DEFAULT
+    functionVersion: string // 函数版本
+    description?: string // 别名描述
+    routingConfig?: IRoutingConfig
+}
+
+export interface IRoutingConfig {
+    AdditionalVersionWeights?: IVersionWeight[]
+    AddtionVersionMatchs?: IVersionMatch[]
+}
+
+export interface IVersionMatch {
+    Version: string // 函数版本名称
+    Key: string // 匹配规则的key，调用时通过传key来匹配规则路由到指定版本 header方式：key填写"invoke.headers.User"，并在 invoke 调用函数时传参 RoutingKey：{"User":"value"}规则匹配调用
+    Method: string // 匹配方式。取值范围：range：范围匹配 exact：字符串精确匹配
+    Expression: string //
+}
+
+export interface IVersionWeight {
+    Version: string
+    Weight: number
+}
+
+export interface IGetFunctionAlias {
+    envId: string
+    functionName: string // 函数名称
+    name: string // 别名
+}
+
+export interface IGetFunctionAliasRes {
+    FunctionVersion: string
+    Name: string
+    RoutingConfig: IRoutingConfig
+    Description: string
+    AddTime: string
+    ModTime: string
 }

package/tsconfig.json

@@ -6,6 +6,7 @@
         "outDir": "lib",
         "removeComments": true,
         "types": ["node"],
+        "skipLibCheck": true,
         "esModuleInterop": true,
         "declaration": true,
         "declarationDir": "./types",

package/types/auth/index.d.ts

@@ -0,0 +1,2 @@
+export * from './login';
+export * from './logout';

package/types/auth/login.d.ts

@@ -0,0 +1,20 @@
+import { Credential } from '@cloudbase/toolbox';
+import { ILoginOptions } from '../types';
+export declare function loginByWebAuth(): Promise<{
+    code: string;
+    msg: string;
+} | {
+    code: string;
+    msg: string;
+    credential: Credential;
+}>;
+export declare function loginWithKey(secretId?: string, secretKey?: string, token?: string): Promise<{
+    code: string;
+    msg: string;
+}>;
+export declare function login(options?: ILoginOptions): Promise<{
+    code: string;
+    msg: string;
+    credential?: Credential;
+}>;
+export declare function checkLogin(): Promise<void>;

package/types/auth/logout.d.ts

@@ -0,0 +1 @@
+export declare function logout(): Promise<void>;

package/types/commands/account/index.d.ts

@@ -0,0 +1,2 @@
+export * from './login';
+export * from './logout';

package/types/commands/account/login.d.ts

@@ -0,0 +1,15 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class LoginCommand extends Command {
+    get options(): {
+        cmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+        requiredEnvId: boolean;
+        withoutAuth: boolean;
+    };
+    execute(options: any, log: Logger): Promise<never>;
+}

package/types/commands/account/logout.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class LogoutCommand extends Command {
+    get options(): {
+        cmd: string;
+        options: any[];
+        desc: string;
+        requiredEnvId: boolean;
+        withoutAuth: boolean;
+    };
+    execute(log: Logger): Promise<void>;
+}

package/types/commands/common.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { ICommandContext } from '../types';
+interface ICommandOption {
+    flags: string;
+    desc: string;
+    hideHelp?: boolean;
+}
+export interface ICommandOptions {
+    deprecateCmd?: string;
+    cmd: string;
+    childCmd?: string | {
+        cmd: string;
+        desc: string;
+    };
+    childSubCmd?: string;
+    options: ICommandOption[];
+    desc: string;
+    requiredEnvId?: boolean;
+    withoutAuth?: boolean;
+}
+export declare function ICommand(): ClassDecorator;
+export declare function registerCommands(): void;
+export declare abstract class Command extends EventEmitter {
+    on(event: 'preHandle' | 'afterHandle', listener: (ctx: ICommandContext, args: any[]) => void): this;
+    init(): void;
+    private createProgram;
+    private preHandle;
+    private afterHandle;
+    abstract execute(...args: any[]): void;
+    abstract get options(): ICommandOptions;
+}
+export {};

package/types/commands/env/base.d.ts

@@ -0,0 +1,27 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class EnvListCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: any[];
+        desc: string;
+        requiredEnvId: boolean;
+    };
+    execute(log: Logger): Promise<void>;
+}
+export declare class EnvRenameCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+        requiredEnvId: boolean;
+    };
+    execute(envId: any, params: any, log: Logger): Promise<void>;
+}

package/types/commands/env/create.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '../common';
+export declare class CreateCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: any[];
+        desc: string;
+        requiredEnvId: boolean;
+    };
+    execute(params: any): Promise<void>;
+}

package/types/commands/env/domain.d.ts

@@ -0,0 +1,53 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class ListAuthDoaminCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(envId: any): Promise<void>;
+}
+export declare class CreateAuthDomainCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(params: any, envId: any, log: Logger): Promise<void>;
+}
+export declare class DeleteAuthDomainCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(envId: any, log: Logger): Promise<void>;
+}

package/types/commands/env/index.d.ts

@@ -0,0 +1,4 @@
+export * from './base';
+export * from './create';
+export * from './domain';
+export * from './login';

package/types/commands/env/login.d.ts

@@ -0,0 +1,47 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class ListLoginCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(envId: any): Promise<void>;
+}
+export declare class CreateLoginCommand extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(envId: any, log: Logger): Promise<void>;
+}
+export declare class UpdateLogin extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(envId: any, log: Logger): Promise<void>;
+}

package/types/commands/framework/index.d.ts

@@ -0,0 +1,42 @@
+import { Command } from '../common';
+import { ICommandContext } from '../../types';
+import { Logger } from '../../decorators';
+export declare class FrameworkDeploy extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: ICommandContext, logger: Logger, params: any): Promise<void>;
+}
+export declare class FrameworkCompile extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: ICommandContext, logger: Logger, params: any): Promise<void>;
+}
+export declare class FrameworkRun extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: ICommandContext, logger: Logger, params: any, options: any): Promise<void>;
+}

package/types/commands/functions/alias/getRoute.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '../../common';
+export declare class getFunctionRoutingConfig extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/alias/index.d.ts

@@ -0,0 +1,2 @@
+export * from './setRoute';
+export * from './getRoute';

package/types/commands/functions/alias/setRoute.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '../../common';
+export declare class setFunctionRoutingConfig extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/code-download.d.ts

@@ -0,0 +1,18 @@
+import { Command } from '../common';
+export declare class CodeDownload extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/code-update.d.ts

@@ -0,0 +1,18 @@
+import { Command } from '../common';
+export declare class CodeUpdate extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/concurrency/delete.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '../../common';
+export declare class deleteProvisionedConcurrency extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/concurrency/index.d.ts

@@ -0,0 +1,3 @@
+export * from './delete';
+export * from './list';
+export * from './set';

package/types/commands/functions/concurrency/list.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '../../common';
+export declare class getProvisionedConcurrency extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any, options: any): Promise<void>;
+}

package/types/commands/functions/concurrency/set.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '../../common';
+export declare class setProvisionedConcurrency extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/config-update.d.ts

@@ -0,0 +1,19 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class ConfigUpdate extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: {
+            cmd: string;
+            desc: string;
+        };
+        childSubCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any, log: Logger): Promise<void>;
+}

package/types/commands/functions/copy.d.ts

@@ -0,0 +1,15 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class FunctionCopy extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(envId: any, options: any, params: any, log: Logger): Promise<void>;
+}

package/types/commands/functions/delete.d.ts

@@ -0,0 +1,14 @@
+import { Command } from '../common';
+export declare class DeleteFunction extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+}

package/types/commands/functions/deploy.d.ts

@@ -0,0 +1,21 @@
+import { Command } from '../common';
+import { CloudBaseError } from '../../error';
+import { ICreateFunctionOptions } from '../../types';
+import { Logger } from '../../decorators';
+export declare class FunctionDeploy extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any, log: Logger): Promise<void>;
+    deployAllFunction(options: any): Promise<void>;
+    handleDeployFail(e: CloudBaseError, options: ICreateFunctionOptions): Promise<void>;
+    printSuccessTips(envId: string, log?: Logger): Promise<void>;
+    genApiGateway(envId: string, name: string): Promise<void>;
+}

package/types/commands/functions/detail.d.ts

@@ -0,0 +1,16 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class FunctionDetail extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, params: any): Promise<void>;
+    logDetail(info: any, name: any, log?: Logger): void;
+}

package/types/commands/functions/index.d.ts

@@ -0,0 +1,16 @@
+export * from './deploy';
+export * from './list';
+export * from './delete';
+export * from './config-update';
+export * from './invoke';
+export * from './log';
+export * from './detail';
+export * from './copy';
+export * from './run';
+export * from './trigger-create';
+export * from './trigger-delete';
+export * from './code-update';
+export * from './code-download';
+export * from './version';
+export * from './concurrency';
+export * from './alias';

package/types/commands/functions/invoke.d.ts

@@ -0,0 +1,15 @@
+import { Command } from '../common';
+import { Logger } from '../../decorators';
+export declare class InvokeFunction extends Command {
+    get options(): {
+        cmd: string;
+        childCmd: string;
+        deprecateCmd: string;
+        options: {
+            flags: string;
+            desc: string;
+        }[];
+        desc: string;
+    };
+    execute(ctx: any, argsParams: any, log: Logger): Promise<any[]>;
+}