feat: refactoring triggers, update 8base types

README.md

@@ -1,6 +1,6 @@
 # 8base CLI  [![Build Status](https://travis-ci.org/8base/cli.svg?branch=master)](https://travis-ci.org/8base/cli)
 
-[**Sign Up for 8Base**](https://app.8base.com)	🤘	[**Documentation Home**](https://docs.8base.com)	📑	[**Getting Started**](https://docs.8base.com/getting-started/quick-start)	🚀	[**8base Plans**](https://www.8base.com/pricing)
+[**Sign Up for 8Base**](https://app.8base.com)	🤘	[**Documentation Home**](https://docs.8base.com)	📑	[**Getting Started**](https://docs.8base.com/projects/backend/getting-started)	🚀	[**8base Plans**](https://www.8base.com/pricing)
 
 The 8base Command Line Interface (CLI) makes it easy to generate custom functions and manage workspaces straight from the terminal.
 
@@ -37,27 +37,33 @@ $ 8base login --email="my@email.com" --password="myP@ssw0rd"
 Once successfully authenticated, a file will be updated at `~/.8baserc` with a JSON payload for the authenticated session.
 
 ## Further Information
-For more information about commands and configuration options, please refer the [8base CLI documentation](https://docs.8base.com/development-tools/cli). You can also learn about the different commands from the CLI by running `--help` with the package itself, or a given command.
+For more information about commands and configuration options, please refer the [8base CLI documentation](https://docs.8base.com/projects/backend/development-tools/cli). You can also learn about the different commands from the CLI by running `--help` with the package itself, or a given command.
 
 ```
 DESCRIPTION
-  The 8base Command Line Interface is a unified tool to manage your 8base workspaces services.
+The 8base Command Line Interface is a unified tool to manage your 8base workspaces services.
 
 USAGE
-  8base <command> [OPTIONS]
+8base <command> [OPTIONS]
 
-  Use 8base command \`--help\` for information on a specific command. Use 8base help topics to view a list of available help topics. The synopsis for each command shows its parameters and their usage. Optional options are shown in square brackets.
+Use 8base command `--help` for information on a specific command. Use 8base help topics to view a list of
+available help topics. The synopsis for each command shows its parameters and their usage. Optional options
+are shown in square brackets.
 
 COMMANDS
   8base backup <command>       Backup commands.
   8base configure              Allows you to select a default workspace and retrieve the API endpoint URL.
-  8base deploy                 Deploys project described in 8base.yml config file from your current local directory to 8base server. You must be in the root directory of your local 8base project to use this command.
-  8base describe [name]        Describes your 8base project’s functions and their types through 8base.yml file.
+  8base deploy                 Deploys project described in 8base.yml config file from your current local
+                               directory to 8base server. You must be in the root directory of your local
+                               8base project to use this command.
+  8base describe [name]        Describes your 8base project’s functions and their types through 8base.yml
+                               file.
   8base environment <command>  Environment commands.
   8base export                 Exports current workspace data schema
-  8base generate <command>     Generator for server and client side resources  [aliases: g]
+  8base generate <command>     Generator for server and client side resources                     [aliases: g]
   8base import                 Imports 8base schema file and data to the current - or specified - workspace.
-  8base init [name]            Initializes a new project with example directory structure and custom functions.
+  8base init [name]            Initializes a new project with example directory structure and custom
+                               functions.
   8base invoke <name>          Invokes a custom function in the production workspace.
   8base invoke-local <name>    Invokes the custom function in the local development workspace.
   8base login                  Authenticates the command line user by letting them log into an 8base account.
@@ -69,9 +75,9 @@ COMMANDS
   8base whoami                 Displays the current authenticated user.
 
 OPTIONS
-  -v, --version  Show version number  [boolean]
-  -d, --debug    Turn on debug logs  [boolean]
-  -h, --help     Show help  [boolean]
+  -v, --version  Show version number                                                                 [boolean]
+  -d, --debug    Turn on debug logs                                                                  [boolean]
+  -h, --help     Show help                                                                           [boolean]
 ```
 
 ## Contributing

e2e/tests/__snapshots__/help.test.ts.snap

@@ -218,7 +218,7 @@ COMMANDS
   8base generate resolver <name>       Generator for a custom resolver function.
   8base generate scaffold <tableName>  Generates CRUD screens for a table in a specific framework (framework availability: react)
   8base generate task <name>           Generator for a custom task function.
-  8base generate trigger <name>        Generator for a custom trigger function.
+  8base generate trigger <tableName>   Generator for a custom trigger function.
   8base generate webhook <name>        Generator for a custom webhook function.
 
 OPTIONS
@@ -292,16 +292,16 @@ OPTIONS
 `;
 
 exports[`As a user, I can use help flag for see help information about \`[ 'generate', 'trigger' ]\`. 1`] = `
-"8base generate trigger <name> [OPTIONS]
+"8base generate trigger <tableName> [OPTIONS]
 
 POSITIONALS
-  name  The name of the trigger  [string] [required]
+  tableName  The name of table to make trigger for  [string] [required]
 
 OPTIONS
   -d, --debug      Turn on debug logs  [boolean]
   -h, --help       Show help  [boolean]
-  -t, --type       The trigger type  [string] [choices: "before", "after"]
-  -o, --operation  Operation that invokes the trigger  [string]
+  -t, --type       The trigger type  [string] [choices: "before", "after"] [default: "before"]
+  -o, --operation  Operation that invokes the trigger  [string] [choices: "create", "update", "delete"] [default: "create"]
   -x, --mocks      Included mocks dir and files  [boolean] [default: true]
   -s, --syntax     Syntax for the generated file  [string] [choices: "js", "ts"] [default: "ts"]
       --silent     Disable printing extra info to the console  [boolean] [default: false]"
@@ -317,7 +317,7 @@ OPTIONS
   -d, --debug   Turn on debug logs  [boolean]
   -h, --help    Show help  [boolean]
   -p, --path    Path for the url (https:<endpoint>/<path>)  [string]
-  -m, --method  HTTP verb to invoke the function  [string] [choices: "POST", "GET", "DELETE", "PUT"]
+  -m, --method  HTTP verb to invoke the function  [string] [choices: "POST", "GET", "DELETE", "PUT"] [default: "POST"]
   -x, --mocks   Included mocks dir and files  [boolean] [default: true]
   -s, --syntax  Syntax for the generated file  [string] [choices: "js", "ts"] [default: "ts"]
       --silent  Disable printing extra info to the console  [boolean] [default: false]"
@@ -352,7 +352,7 @@ POSITIONALS
 OPTIONS
   -d, --debug        Turn on debug logs  [boolean]
   -h, --help         Show help  [boolean]
-  -f, --functions    List of functions  [array] [default: ["resolver:resolver","task:task","webhook:webhook","trigger:trigger"]]
+  -f, --functions    List of functions  [array] [default: ["resolver:resolver","task:task","webhook:webhook","trigger:Users:create:before"]]
   -e, --empty        Skip examples  [boolean] [default: false]
   -x, --mocks        Included mocks dir and files  [boolean] [default: true]
   -s, --syntax       Syntax for the generated file  [string] [choices: "js", "ts"] [default: "ts"]

e2e/tests/__snapshots__/init.test.ts.snap

@@ -40,10 +40,11 @@ testdir_init
     │       └── mocks
     │           └── request.json
     ├── triggers
-    │   └── trigger
-    │       ├── handler.ts
-    │       └── mocks
-    │           └── request.json
+    │   └── Users
+    │       └── create
+    │           ├── before.ts
+    │           └── mocks
+    │               └── request.json
     └── webhooks
         └── webhook
             ├── handler.ts

e2e/utils.ts

@@ -5,6 +5,7 @@ import * as cuid from '@paralleldrive/cuid2';
 import * as yaml from 'js-yaml';
 import stripAnsi from 'strip-ansi';
 import { CLI_BIN } from './consts';
+import { ProjectConfig } from '../src/common/context';
 
 export const prepareTestEnvironment = async (
   repName: string = cuid.createId(),
@@ -36,7 +37,7 @@ export const addResolverToProject = async (
   await fs.writeFile(path.join(projectPath, subDir, funcName).concat(ext), code);
   await fs.writeFile(path.join(projectPath, subDir, funcName).concat('.graphql'), graphQLData);
   const yamlFilePath = path.join(projectPath, '8base.yml');
-  const yamlData: { functions: { [key: string]: any } } = <any>yaml.load(await fs.readFile(yamlFilePath, 'utf8'));
+  const yamlData = <ProjectConfig>yaml.load(await fs.readFile(yamlFilePath, 'utf8'));
 
   yamlData.functions[funcName] = {
     handler: {

src/common/context.ts

@@ -30,10 +30,10 @@ export type WorkspaceConfig = {
   readonly apiHost: string;
 };
 
-type Plugin = { name: string; path: string };
+export type Plugin = { name: string; path: string };
 
 export type ProjectConfig = {
-  functions: Object;
+  functions: Record<string, any>;
   plugins?: Plugin[];
 };
 

src/config/static.ts

@@ -16,10 +16,6 @@ export class StaticConfig {
     return this.staticData.pluginTemplatePath;
   }
 
-  static get mockTemplatePath(): string {
-    return this.staticData.mockTemplatePath;
-  }
-
   static get rootProjectDir(): string {
     return this.staticData.projectDir;
   }

src/engine/commands/generate/commands/scaffold.ts

@@ -101,9 +101,9 @@ export default {
 
     context.spinner.stop();
 
-    let eightBaseConfig: EightBaseConfig;
+    let eightBaseConfig;
     try {
-      eightBaseConfig = <any>yaml.load(await fs.readFile('.8base.yml', 'utf8'));
+      eightBaseConfig = <EightBaseConfig>yaml.load(await fs.readFile('.8base.yml', 'utf8'));
     } catch (err) {
       if (err.code === 'ENOENT') {
         throw new Error(translations.i18n.t('generate_scaffold_project_file_error', { projectFileName: '.8base.yml' }));

src/engine/commands/generate/commands/trigger.ts

@@ -2,33 +2,29 @@ import yargs from 'yargs';
 
 import { Context } from '../../../../common/context';
 import { translations } from '../../../../common/translations';
-import { ExtensionType, SyntaxType, TriggerType } from '../../../../interfaces/Extensions';
+import { ExtensionType, SyntaxType, TriggerOperation, TriggerType } from '../../../../interfaces/Extensions';
 import { ProjectController } from '../../../controllers/projectController';
 
 type TriggerGenerateParams = {
-  name: string;
-  type?: string;
-  operation?: string;
+  tableName: string;
+  type: TriggerType;
+  operation: TriggerOperation;
   mocks: boolean;
   syntax: SyntaxType;
   silent: boolean;
 };
 
 export default {
-  command: 'trigger <name>',
+  command: 'trigger <tableName>',
 
   handler: async (params: TriggerGenerateParams, context: Context) => {
-    let { name, type, operation, mocks, syntax, silent } = params;
-
-    if (operation && !/[\w\d]+\.(create|update|delete)/.test(operation)) {
-      throw new Error(translations.i18n.t('generate_trigger_invalid_operation'));
-    }
+    const { tableName, type, operation, mocks, syntax, silent } = params;
 
     await ProjectController.generateFunction(
       context,
       {
         type: ExtensionType.trigger,
-        name,
+        name: tableName,
         mocks,
         syntax,
         silent,
@@ -45,8 +41,8 @@ export default {
   builder: (args: yargs.Argv): yargs.Argv =>
     args
       .usage(translations.i18n.t('generate_trigger_usage'))
-      .positional('name', {
-        describe: translations.i18n.t('generate_trigger_name'),
+      .positional('tableName', {
+        describe: translations.i18n.t('generate_trigger_table_name'),
         type: 'string',
       })
       .option('type', {
@@ -55,11 +51,14 @@ export default {
         type: 'string',
         choices: Object.values(TriggerType),
         requiresArg: true,
+        default: TriggerType.before,
       })
       .option('operation', {
         alias: 'o',
         describe: translations.i18n.t('generate_trigger_operation_describe'),
         type: 'string',
+        choices: Object.values(TriggerOperation),
+        default: TriggerOperation.create,
         requiresArg: true,
       })
       .option('mocks', {

src/engine/commands/generate/commands/webhook.ts

@@ -2,13 +2,13 @@ import yargs from 'yargs';
 
 import { Context } from '../../../../common/context';
 import { translations } from '../../../../common/translations';
-import { ExtensionType, SyntaxType } from '../../../../interfaces/Extensions';
+import { ExtensionType, SyntaxType, WebhookMethod } from '../../../../interfaces/Extensions';
 import { ProjectController } from '../../../controllers/projectController';
 
 type WebhookGenerateParams = {
   name: string;
-  path?: string;
-  method?: string;
+  path: string;
+  method: WebhookMethod;
   mocks: boolean;
   syntax: SyntaxType;
   silent: boolean;
@@ -18,7 +18,7 @@ export default {
   command: 'webhook <name>',
 
   handler: async (params: WebhookGenerateParams, context: Context) => {
-    let { name, path, method, mocks, syntax, silent } = params;
+    const { name, path, method, mocks, syntax, silent } = params;
 
     await ProjectController.generateFunction(
       context,
@@ -55,7 +55,8 @@ export default {
         alias: 'm',
         describe: translations.i18n.t('generate_webhook_method_describe'),
         type: 'string',
-        choices: ['POST', 'GET', 'DELETE', 'PUT'],
+        choices: Object.values(WebhookMethod),
+        default: WebhookMethod.post,
         requiresArg: true,
       })
       .option('mocks', {

src/engine/commands/init/index.ts

@@ -12,7 +12,7 @@ import { Context } from '../../../common/context';
 import { translations } from '../../../common/translations';
 import { Colors } from '../../../consts/Colors';
 import { ProjectController } from '../../controllers/projectController';
-import { ExtensionType, SyntaxType } from '../../../interfaces/Extensions';
+import { ExtensionType, SyntaxType, TriggerOperation, TriggerType } from '../../../interfaces/Extensions';
 import { Interactive } from '../../../common/interactive';
 import { DEFAULT_ENVIRONMENT_NAME } from '../../../consts/Environment';
 import { StaticConfig } from '../../../config';
@@ -76,7 +76,7 @@ export default {
 
     if (!empty && Array.isArray(functions)) {
       functions.forEach(declaration => {
-        const [type, name] = declaration.split(':');
+        const [type, name, triggerOperation, triggerType] = declaration.split(':');
 
         if (!(type in ExtensionType)) {
           throw new Error(translations.i18n.t('init_invalid_function_type', { type }));
@@ -85,6 +85,10 @@ export default {
         if (!name) {
           throw new Error(translations.i18n.t('init_undefined_function_name'));
         }
+
+        if (type === ExtensionType.trigger && !(triggerOperation in TriggerOperation && triggerType in TriggerType)) {
+          throw new Error(translations.i18n.t('init_incorrect_trigger'));
+        }
       });
     }
 
@@ -140,19 +144,23 @@ export default {
     }
 
     /* Generate project files before printing tree */
-    if (!empty && Array.isArray(params.functions)) {
+    if (!empty && Array.isArray(functions)) {
       await Promise.all(
-        params.functions.map(async (declaration: string) => {
-          const [type, functionName] = declaration.split(':');
-
-          await ProjectController.generateFunction(context, {
-            type: <ExtensionType>type,
-            name: functionName,
-            mocks,
-            syntax,
-            projectPath: name,
-            silent: true,
-          });
+        functions.map(async (declaration: string) => {
+          const [type, functionName, triggerOperation, triggerType] = declaration.split(':');
+
+          await ProjectController.generateFunction(
+            context,
+            {
+              type: <ExtensionType>type,
+              name: functionName,
+              mocks,
+              syntax,
+              projectPath: name,
+              silent: true,
+            },
+            { type: <TriggerType>triggerType, operation: <TriggerOperation>triggerOperation },
+          );
         }),
       );
     }
@@ -192,7 +200,7 @@ export default {
         alias: 'f',
         describe: translations.i18n.t('init_functions_describe'),
         type: 'array',
-        default: ['resolver:resolver', 'task:task', 'webhook:webhook', 'trigger:trigger'],
+        default: ['resolver:resolver', 'task:task', 'webhook:webhook', 'trigger:Users:create:before'],
       })
       .option('empty', {
         alias: 'e',

src/engine/commands/login/webLogin.ts

@@ -5,7 +5,7 @@ import 'isomorphic-fetch';
 import { SessionInfo } from '../../../interfaces/Common';
 import { Utils } from '../../../common/utils';
 
-export const webLogin = async (params: any, context: Context): Promise<SessionInfo> => {
+export const webLogin = async (params: { w: string }, context: Context): Promise<SessionInfo> => {
   context.spinner.start(context.i18n.t('login_in_progress'));
   const session = cuid.createId();