@serverless-devs/s 2.0.95 → 2.0.97-beta.5

package/docs/zh/yaml_and_cli.md

@@ -1,67 +0,0 @@
-# Yaml 模式 Cli 模式对比
-
-Serverless Devs 开发者工具从根本上提供了两种使用方法。
-- Yaml模式：需要依赖资源描述文档进行操作的模式
-- Cli模式：可以在任何目录下直接执行，而不需要依赖资源描述文档；
-
-这两者的核心区别是：
-
-1. 如果想要使用 Yaml 模式，在当前目录下，必须要有`s.yaml`/`s.yml`文件，或通过`-t`/`--template`指定的资源部描述文件；
-2. 如果想要试用 Cli 模式，则必须是 `s cli 组件名 方法 参数`的格式进行，此时不需要 Yaml 文件；
-
-举一个非常简单的例子，如果有一个应用的资源描述文件`s.yaml`如下：
-
-```yaml
-name: myApp
-edition: 1.0.0
-access: "myaccess"
-
-services:
-  website-starter:
-    component: devsapp/website
-    props:
-      bucket: testbucket
-  backend-starter:
-    component: devsapp/demo
-    props:
-      service:
-        name: serviceName
-      function:
-        name: functionName
-      region: cn-hangzhou
-```
-
-此时，可以执行`s deploy`进行`myApp`应用部署，如果执行`s backend-starter deploy`则可以进行`myApp`应用下的`backend-starter`项目/服务部署。
-
-此时，部署过程中，所需要的相关参数，可以通过该 Yaml 文件进行读取。
-
-但是，在某些情况下，并不方便直接使用 Serverless Devs 规范的 Yaml 文件（例如，将线上资源同步到本地，或者要将 Funcraft 的 Yaml 转换成为 Serverless Devs 的 Yaml），此时可以选择纯命令行形式，即`s cli`模式。
-
-在 `s cli` 模式下，由于不会读取 Yaml 等资源描述文件，所以很多参数都需要自行填写，这时的填写方法有两种：
-
-1. 通过 `s cli` 天然支持的 `-p`/`--prop` 参数，进行相关 Yaml 参数的赋值，例如上述案例的`s backend-starter deploy`，此时可以改写成：
-    ```shell script
-    s cli devsapp/demo -p "{\"service\":{\"name\":\"serviceName\"},\"function\":{\"name\":\"functionName\"},\"region\":\"cn-hangzhou\"}"
-    ```
-2. 通过 demo 组件本身所支持的一些参数，例如通过`s cli devsapp/demo -h`，可以得到帮助信息，部分内容如下：
-    ```shell script
-      --region [region]               [C-Required] Specify the fc region, value: cn-hangzhou/cn-beijing/cn-beijing/cn-hangzhou/cn-shanghai/cn-qingdao/cn-zhangjiakou/cn-huhehaote/cn-shenzhen/cn-chengdu/cn-hongkong/ap-southeast-1/ap-southeast-2/ap-southeast-3/ap-southeast-5/ap-northeast-1/eu-central-1/eu-west-1/us-west-1/us-east-1/ap-south-1  
-      --service-name [serviceName]    [C-Required] Specify the fc service name  
-      --function-name [functionName]  [Optional] Specify the fc function name   
-    ```
-    此时，就可与通过下面的命令实现上述功能：
-    ```shell script
-    s cli devsapp/demo --region cn-hangzhou --service-name serviceName --function-name functionName
-    ```
-
-## 特点对比
-
-| 模式 | 使用方法 | 优势 |  劣势 |  适用场景  |
-| --- | --- | --- | --- | --- |
-| Yaml模式 | 在具有符合Serverless Devs规范，且存在资源/行为描述的Yaml文件的应用目录下，执行组件对应的命令，即可直接使用，例如`s deploy`，`s servicename build`等 | 可以一键部署一个完整的应用（例如，某个应用中规定了多个Service，可以通过该命令一键部署）；同时，通过资源/行为描述文档，可以更佳简单，清晰的对应用进行描述； | 需要学习Yaml的规范，且在某些时候与一些自动化流程进行结合，会比较复杂； | 部署、运维等操作，尤其是批量操作时更为合适； |
-| 纯Cli模式 | 在任何目录下，通过子命令`cli`进行触发，同样适用全部组件，例如`s cli deploy -p "{/"function/": /"function-name/"}"`，`s cli fc-api listFunctions --service-name my-service` | 相对来说可以更加简单，快速上手工具，并且可以非常简单的与自动化流程进行结合，降低了Yaml格式/规范的学习难度 | 对于一些复杂项目而言，需要在命令行中写过多的参数，出错的概率会比较高； | 更适合项目的管理，源自化操作 |
-
-## 设计思路
-
-> ❓ 为什么要同时存在 Yaml 模式和 Cli 模式？   
-> 💬 因为在长期的实践过程中，我们发现通过 Yaml 进行资源描述会相对来说更简单和方便，例如 K8S 等也都是通过 Yaml 进行资源描述的；但是，在某些情况下，Yaml 文件也可能成为一种负担，例如想要查看某个服务下的函数列表，查看某个地区下的服务列表，因为这样一个简单的事情要额外的去完成一个 Yaml 文件，就显得过于臃肿，所以，在 Serverless Devs 项目中，同时保留了两种使用方法。

package/jest.setup.ts

@@ -1,37 +0,0 @@
-/** @format */
-import path from 'path';
-import os from 'os';
-import core from './src/utils/core';
-const { fse: fs, jsyaml: yaml } = core;
-import logger from './src/utils/logger';
-
-jestBeforeDetection();
-
-function jestBeforeDetection() {
-  if (!detectioIsExist('.s/access.yaml')) {
-    logger.error(`Failed to execute:\n
-  ❌ Message: Please install S component
-  😈 If you have questions, please tell us: https://github.com/Serverless-Devs/Serverless-Devs/issues\n`);
-    process.exit(1);
-  }
-  if (Object.keys(getAccessFile()).length === 0) {
-    logger.error(`Failed to execute:\n
-    ❌ Message: Please configure your Secret
-    😈 If you have questions, please tell us: https://github.com/Serverless-Devs/Serverless-Devs/issues\n`);
-    process.exit(1);
-  }
-}
-
-function detectioIsExist(road) {
-  return fs.existsSync(getPath(road));
-}
-
-function getAccessFile() {
-  const accessFile = getPath('.s/access.yaml');
-  const accessFileInfo = yaml.load(fs.readFileSync(accessFile, 'utf-8') || '{}');
-  return accessFileInfo;
-}
-
-function getPath(road) {
-  return path.join(os.homedir(), road);
-}

package/lib/clean/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/cli/cli-manager.d.ts

@@ -1,13 +0,0 @@
-/** @format */
-export interface CliParams {
-    component: string;
-    command: string;
-    access: string;
-    props: string;
-}
-export default class CliManager {
-    protected inputs: CliParams;
-    constructor(inputs: CliParams);
-    getTempCommandStr(commands: string, length: number): string;
-    init(): Promise<any>;
-}

package/lib/cli/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export {};

package/lib/component/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/config/add/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/config/common/common.d.ts

@@ -1,46 +0,0 @@
-/** @format */
-export declare type ProviderName = 'alibaba' | 'baidu' | 'huawei' | 'aws' | 'azure' | 'google' | 'tencent';
-export declare enum ProviderObject {
-    alibaba = "Alibaba Cloud (alibaba)",
-    baidu = "Baidu Cloud (baidu)",
-    huawei = "Huawei Cloud (huawei)",
-    aws = "AWS (aws)",
-    azure = "Azure (azure)",
-    google = "Google Cloud (google)",
-    tencent = "Tencent Cloud (tencent)"
-}
-export declare const providerArray: ProviderName[];
-export declare type ProviderCollectionConfig = {
-    [k in ProviderName]: {
-        type: string;
-        message: string;
-        name: string;
-        default: string;
-    }[];
-};
-export declare const providerCollection: ProviderCollectionConfig;
-export interface AccessFormat {
-    AccountID?: string;
-    AccessKeyID?: string;
-    AccessKeySecret?: string;
-    SecretAccessKey?: string;
-    KeyVaultName?: string;
-    TenantID?: string;
-    ClientID?: string;
-    ClientSecret?: string;
-    SecretID?: string;
-    PrivateKeyData?: string;
-}
-export declare const providerAccessFormat: {
-    [k in ProviderName]: (keyof AccessFormat)[];
-};
-export declare const checkProviderList: {
-    type: string;
-    name: string;
-    message: string;
-    choices: {
-        name: ProviderObject;
-        value: ProviderName;
-    }[];
-}[];
-export declare function getInputData(program: AccessFormat): AccessFormat;

package/lib/config/delete/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export {};

package/lib/config/get/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/config/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export {};

package/lib/constants/static-variable.d.ts

@@ -1,4 +0,0 @@
-/** @format */
-export declare const PROCESS_ENV_TEMPLATE_NAME = "templateFile";
-export declare const DEFAULT_REGIRSTRY = "http://registry.devsapp.cn/simple";
-export declare const UPDATE_CHECK_INTERVAL: number;

package/lib/core/command/command-manager.d.ts

@@ -1,12 +0,0 @@
-import { Parse } from '../../specification';
-import { ComponentConfig } from '../component';
-export declare class CommandManager {
-    protected templateFile: string;
-    protected method: string;
-    protected customerCommandName?: string;
-    protected deployParams: any;
-    constructor(templateFile: string, method: string, customerCommandName?: string, params?: any);
-    assemblyProjectConfig(parse: Parse, projectName: string, parsedObj: any): Promise<ComponentConfig>;
-    warnEnvironmentVariables(realVariables: any): Promise<void>;
-    init(): Promise<void>;
-}

package/lib/core/component/hook.d.ts

@@ -1,17 +0,0 @@
-/** @format */
-export interface HookConfig {
-    Pre: boolean;
-    Plugin?: string;
-    Hook?: string;
-    Path?: string;
-}
-export declare class Hook {
-    preHooks: HookConfig[];
-    afterHooks: HookConfig[];
-    constructor(extendsParams?: HookConfig[]);
-    executePreHook(): Promise<void>;
-    executeAfterHook(): Promise<void>;
-    commandExecute(command: string, executePath: string | undefined): Promise<void>;
-    pluginExecute(name: string): Promise<void>;
-    executeByConfig(hookConfig: HookConfig): Promise<void>;
-}

package/lib/core/component/index.d.ts

@@ -1,53 +0,0 @@
-/** @format */
-import { PackageType } from '../../entiry';
-import { Parse } from '../../specification';
-import { Hook } from './hook';
-export interface ComponentConfig {
-    component: string;
-    provider: string;
-    Access?: string;
-    access?: string;
-    Extends: any;
-    props: {
-        [key: string]: any;
-    };
-    Params: any;
-    ProjectName: string;
-}
-export interface VersionCheckParams {
-    name: string;
-    type: PackageType;
-    provider: string;
-}
-export interface GenerateComponentExeParams {
-    list: string[];
-    parse: Parse;
-    parsedObj: any;
-    method: string;
-    params: string;
-}
-export declare function synchronizeExecuteComponentList(list?: any, index?: any, initData?: any): Promise<any>;
-export declare function generateSynchronizeComponentExeList({ list, parse, parsedObj, method, params }: GenerateComponentExeParams, equipment: (parse: Parse, projectName: string, parsedObj: any) => Promise<ComponentConfig>): any[];
-interface IComponentExeCute {
-    componentConfig: ComponentConfig;
-    method: string;
-    version: string;
-    customerCommandName?: string;
-}
-export declare class ComponentExeCute {
-    private credentials;
-    private componentConfig;
-    private method;
-    private version;
-    private customerCommandName;
-    constructor(config: IComponentExeCute);
-    init(): Promise<any>;
-    getCredentials(): Promise<any>;
-    private loadExtends;
-    loadPreExtends(extend: Hook | null): Promise<void>;
-    loadAfterExtend(extend: Hook | null): Promise<void>;
-    invokeMethod(componentInstance: any, method: string, data: any): Promise<any>;
-    executeCommand(): Promise<any>;
-    startExecute(): Promise<any>;
-}
-export {};

package/lib/core/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export { CommandManager } from './command/command-manager';

package/lib/core/plugin/index.d.ts

@@ -1,13 +0,0 @@
-/** @format */
-export interface PluginConifg {
-    name: string;
-}
-export declare class PluginExeCute {
-    protected pluginConfig: PluginConifg;
-    protected pluginPath: string;
-    constructor(pluginConfig: PluginConifg);
-    init(): Promise<void>;
-    pluginExist(): boolean;
-    downLoadPlugin(name: string): Promise<void>;
-    loadPlugin(): Promise<any>;
-}

package/lib/entiry/cli.d.ts

@@ -1,27 +0,0 @@
-/** @format */
-export declare enum PackageType {
-    application = 0,
-    component = 1,
-    plugin = 2
-}
-export interface CommandType {
-    type: string;
-    message: string;
-    name: string;
-    default?: string;
-    choices?: any;
-}
-export interface InquirerCommand {
-    [key: string]: CommandType;
-}
-export interface RepoTemplate {
-    zipFile: string;
-    subPath?: string;
-    hasSubPath: boolean;
-}
-export interface GitRepoTemplate extends RepoTemplate {
-    host: string | null;
-    ownerName: string;
-    branch: string;
-    repoName: string;
-}

package/lib/entiry/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export { PackageType, CommandType, InquirerCommand, RepoTemplate, GitRepoTemplate } from './cli';

package/lib/error/command-error.d.ts

@@ -1,5 +0,0 @@
-/** @format */
-import { ServerlessError } from './serverless-error';
-export declare class CommandError extends ServerlessError {
-    constructor(message: string, params?: any);
-}

package/lib/error/config-delete-error.d.ts

@@ -1,5 +0,0 @@
-/** @format */
-import { ServerlessError } from './serverless-error';
-export declare class ConfigDeleteError extends ServerlessError {
-    constructor(message: string, params?: any);
-}

package/lib/error/config-error.d.ts

@@ -1,5 +0,0 @@
-/** @format */
-import { ServerlessError } from './serverless-error';
-export declare class ConfigError extends ServerlessError {
-    constructor(message: string, params?: any);
-}

package/lib/error/config-get-error.d.ts

@@ -1,5 +0,0 @@
-/** @format */
-import { ServerlessError } from './serverless-error';
-export declare class ConfigGetError extends ServerlessError {
-    constructor(message: string, params?: any);
-}

package/lib/error/human-error.d.ts

@@ -1,13 +0,0 @@
-interface IConfigs {
-    errorMessage: string;
-    tips?: string;
-}
-interface IReport {
-    error: Error;
-}
-export declare class HumanError {
-    private errorMessage;
-    constructor(configs: IConfigs);
-    report(configs: IReport): Promise<void>;
-}
-export {};

package/lib/error/human-warning.d.ts

@@ -1,8 +0,0 @@
-interface IConfigs {
-    warningMessage: string;
-    tips?: string;
-}
-export declare class HumanWarning {
-    constructor(configs: IConfigs);
-}
-export {};

package/lib/error/index.d.ts

@@ -1,17 +0,0 @@
-export { CommandError } from './command-error';
-export { ConfigDeleteError } from './config-delete-error';
-export { ConfigError } from './config-error';
-export { ConfigGetError } from './config-get-error';
-export { InitError } from './init-error';
-export { ServerlessError } from './serverless-error';
-export { HumanError } from './human-error';
-export { HumanWarning } from './human-warning';
-interface IConfigs {
-    error: Error;
-    prefix?: string;
-}
-export declare class HandleError {
-    private traceId;
-    constructor(configs: IConfigs);
-    report(error: Error): Promise<void>;
-}

package/lib/error/init-error.d.ts

@@ -1,5 +0,0 @@
-/** @format */
-import { ServerlessError } from './serverless-error';
-export declare class InitError extends ServerlessError {
-    constructor(message: string, params?: any);
-}

package/lib/error/serverless-error.d.ts

@@ -1,4 +0,0 @@
-/** @format */
-export declare class ServerlessError {
-    constructor(phase: string, message: string, params?: any);
-}

package/lib/execDaemon.d.ts

@@ -1,6 +0,0 @@
-/** @format */
-interface IConfig {
-    [key: string]: any;
-}
-export declare function execDaemon(filename: string, config?: IConfig): void;
-export {};

package/lib/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export {};

package/lib/init/index.d.ts

@@ -1,2 +0,0 @@
-/** @format */
-export {};

package/lib/init/init-config.d.ts

@@ -1,43 +0,0 @@
-export declare const ALL_TEMPLATE: {
-    name: string;
-    value: string;
-}[];
-export declare const APPLICATION_TEMPLATE: ({
-    type: string;
-    name: string;
-    loop: boolean;
-    message: string;
-    default: string;
-    source: (answersSoFar: any, input: any) => Promise<{
-        name: string;
-        value: string;
-    }[]>;
-} | {
-    type: string;
-    name: string;
-    message: any;
-    default: string;
-    loop: boolean;
-    when(answers: any): boolean;
-    source: (answersSoFar: any, input: any) => Promise<{
-        name: string;
-        value: string;
-    }[]>;
-} | {
-    type: string;
-    name: string;
-    when(answers: any): boolean;
-    default: string;
-    message: any;
-    source: (answersSoFar: any, input: any) => Promise<{
-        name: string;
-        value: string;
-    }[]>;
-    loop?: undefined;
-})[];
-export declare const PROJECT_NAME_INPUT: {
-    type: string;
-    name: string;
-    message: string;
-    validate(input: any): true | "You must provide a project name";
-};

package/lib/init/init-manager.d.ts

@@ -1,17 +0,0 @@
-/** @format */
-export declare class InitManager {
-    protected promps: any;
-    constructor();
-    initSconfig(appPath: string): Promise<string>;
-    initEnvConfig(appPath: string): Promise<void>;
-    assemblySpecialApp(appName: any, { projectName, appPath }: {
-        projectName: any;
-        appPath: any;
-    }): Promise<void>;
-    executeInit(name: string, dir?: string, downloadurl?: boolean): Promise<{
-        appPath: any;
-    }>;
-    gitCloneProject(name: string, dir?: string): Promise<unknown>;
-    deploy(appPath: string): Promise<void>;
-    init(name?: string, dir?: string): Promise<void>;
-}

package/lib/onboarding/index.d.ts

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

package/lib/set/analysis/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/set/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/set/locale/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/set/registry/index.d.ts

@@ -1,10 +0,0 @@
-export declare const registryInquire: {
-    type: string;
-    name: string;
-    message: string;
-    choices: {
-        key: string;
-        name: string;
-        value: string;
-    }[];
-}[];

package/lib/set/workspace/index.d.ts

@@ -1 +0,0 @@
-export {};

package/lib/specification/analysis.d.ts

@@ -1,12 +0,0 @@
-/** @format */
-export declare class Analysis {
-    protected readonly parsedObj: any;
-    protected readonly dependenciesMap: any;
-    protected componentOrderKeyMap: {
-        [key: string]: any;
-    };
-    constructor(parsedObj: any, dependenciesMap: any);
-    private getComponentOrderKeyMap;
-    private calculateOrderNumber;
-    getProjectOrder(): string[];
-}

package/lib/specification/index.d.ts

@@ -1,4 +0,0 @@
-/** @format */
-export { Parse } from './parse';
-export { Analysis } from './analysis';
-export { default as version } from './version';

package/lib/specification/parse.d.ts

@@ -1,24 +0,0 @@
-interface MAP_OBJECT {
-    [key: string]: any;
-}
-export declare class Parse {
-    protected path: string;
-    protected parsedObj: any;
-    dependenciesMap: {
-        [key: string]: any;
-    };
-    protected globalJsonKeyMap: any;
-    protected globalKeyArr: any[];
-    protected magicVariablesArray: any[];
-    constructor(path: string);
-    getFileObj(filePath: string): {};
-    init(filePath: string): Promise<void>;
-    getOriginalParsedObj(): any;
-    private findVariableValue;
-    generateMagicVariables(value: any, arr?: any[], parentStr?: string): any[];
-    isProjectProperties(topKey: string, parentKey: any): boolean;
-    iteratorToSetValue(objValue: any, topKey: string, parentKey?: any): any;
-    replaceVariable(variable: any | MAP_OBJECT): any;
-    getRealVariables(parsedObj: any): Promise<any>;
-}
-export {};

package/lib/specification/version.d.ts

@@ -1,35 +0,0 @@
-/** @format */
-export declare function getSubcommand(configData: any): string[];
-export declare function getServiceConfig(configData: any, serviceName: string): string[];
-export declare function getServiceConfigDetail(configData: any): {
-    name: any;
-    provider: any;
-    access: any;
-    autoCredential: any;
-};
-export declare function getServiceInputs(configData: any, version: string, options: any): {
-    Properties: any;
-    Credentials: any;
-    Project: {
-        ProjectName: any;
-        Component: any;
-        Provider: any;
-        AccessAlias: any;
-    };
-    Command: any;
-    Args: any;
-    Path: {
-        ConfigPath: string;
-    };
-};
-export declare function getServiceActions(configData: any, version: string, options: any): any;
-export declare function getServiceList(configData: any): any;
-declare const _default: {
-    getSubcommand: typeof getSubcommand;
-    getServiceConfig: typeof getServiceConfig;
-    getServiceConfigDetail: typeof getServiceConfigDetail;
-    getServiceInputs: typeof getServiceInputs;
-    getServiceActions: typeof getServiceActions;
-    getServiceList: typeof getServiceList;
-};
-export default _default;

package/lib/update-notifier/index.d.ts

@@ -1,10 +0,0 @@
-declare class UpdateNotifier {
-    constructor();
-    config(key?: string): any;
-    check(): boolean;
-    init(): this;
-    update(): Promise<void>;
-    install(): void;
-    notify(): void;
-}
-export = UpdateNotifier;

package/lib/utils/command-util.d.ts

@@ -1,18 +0,0 @@
-export declare function setEnvbyDotenv(templateFile: string): Promise<void>;
-export declare function createUniversalCommand(command: string, customerCommandName?: string, description?: string): import("commander").Command;
-export declare function getCommandDetail(name: any, provider: any, version: any): Promise<any[]>;
-export declare function getParsedTemplateObj(templateFile: any): Promise<any>;
-export declare function getCustomerCommandInfo(parsedTemplateObj: any): string[];
-export declare function createCustomerCommand(templateFile: string): Promise<any[]>;
-export declare function registerCommandChecker(program: any): void;
-export declare function registerCustomerCommand(system_command: any, templateFile: string): Promise<void>;
-export declare function registerUniversalCommand(system_command: any, templateFile: string): Promise<void>;
-export declare function registerVerbose(program: any): void;
-export declare function recordCommandHistory(argv: string[]): void;
-declare const _default: {
-    registerCommandChecker: typeof registerCommandChecker;
-    recordCommandHistory: typeof recordCommandHistory;
-    registerCustomerCommand: typeof registerCustomerCommand;
-    registerUniversalCommand: typeof registerUniversalCommand;
-};
-export default _default;