Merge pull request #877 from storyblok/feat-int-728-cli-china-region

feat(int 728): china region

Author: Thiago Saife

README.md

@@ -10,9 +10,13 @@ You found an issue?<br>Tell us about it - <a href="https://github.com/storyblok/
 [![GitHub issues](https://img.shields.io/github/issues/storyblok/storyblok.svg?style=flat-square&v=1)](https://github.com/storyblok/storyblok/issues?q=is%3Aopen+is%3Aissue)
 [![GitHub closed issues](https://img.shields.io/github/issues-closed/storyblok/storyblok.svg?style=flat-square&v=1)](https://github.com/storyblok/storyblok/issues?q=is%3Aissue+is%3Aclosed)
 
+## BREAKING CHANGE
+
+We added the `region` option upon login. If you are using the CLI, please `logout` and `login` again providing your user region.
+
 ## Installation
 
-Make sure you've node `>= 9.11.0` installed.
+Make sure you have Node `>= 9.11.0` installed.
 
 ```sh
 $ npm i storyblok -g
@@ -51,7 +55,6 @@ $ storyblok pull-components --space <SPACE_ID> --region <REGION>
 #### Options
 
 * `space`: your space id
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 
 ### push-components
 
@@ -64,7 +67,6 @@ $ storyblok push-components <SOURCE> --space <SPACE_ID> --region <REGION> --pres
 #### Parameters
 
 * `source`: can be a URL or path to JSON file.
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 
 Using an **URL**
 
@@ -81,7 +83,6 @@ $ storyblok push-components ./components.json --space 67819
 #### Options
 
 * `space`: your space id
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 * `presets-source` (optional): it can be a URL or path to JSON file with the presets
 
 #### Examples
@@ -170,7 +171,6 @@ $ storyblok sync --type <COMMAND> --source <SPACE_ID> --target <SPACE_ID>
 * `type`: describe the command type to execute. Can be: `folders`, `components`, `stories`, `datasources` or `roles`. It's possible pass multiple types separated by comma (`,`).
 * `source`: the source space to use to sync
 * `target`: the target space to use to sync
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 
 #### Examples
 
@@ -205,6 +205,11 @@ Login to the Storyblok cli
 ```sh
 $ storyblok login
 ```
+#### Options
+
+* `email`: your user's email address
+* `password`: your user's password
+* `region`: your user's region (default: `eu`). You can use `us`, `cn` or `eu`. This region will be used for the other cli's commands.
 
 ### user
 
@@ -228,7 +233,6 @@ It's important to note that the `component` and `field` parameters are required
 * `space`: space where the component is
 * `component`: component name. It needs to be a valid component
 * `field`: name of field
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 
 ### run-migration
 
@@ -255,7 +259,6 @@ $ storyblok run-migration --publish published --space 1234 --component article -
   * `published`: only publish stories that already are published and don't have unpublished changes
   * `published-with-changes`: publish stories that are published and have unpublished changes
 * `publish-languages` (optional): publish specific languages. You can publish more than one language at a time by separating the languages by `,`
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 
 ### rollback-migration
 
@@ -275,6 +278,7 @@ $ storyblok rollback-migration --space 1234 --component Product --field title
 
 ### spaces
 
+
 List all spaces of the logged account
 
 ```sh

src/cli.js

@@ -39,7 +39,7 @@ program
 program
   .command(COMMANDS.LOGIN)
   .description('Login to the Storyblok cli')
-  .action(async () => {
+  .action(async (options) => {
     if (api.isAuthorized()) {
       console.log(chalk.green('✓') + ' The user has been already logged. If you want to change the logged user, you must logout and login again')
       return
@@ -63,8 +63,11 @@ program
       try {
         const user = await api.getUser()
         console.log(chalk.green('✓') + ` Hi ${user.friendly_name}, you current logged in with: ${creds.get().email}`)
-      } catch (e) {}
-      return
+      } catch (e) {
+        console.log(chalk.red('X') + ` Please check if your current region matches your user's region: ${e.message}.`)
+      } finally {
+        process.exit(0)
+      }
     }
     console.log(chalk.red('X') + ' There is currently no user logged.')
   })
@@ -112,9 +115,8 @@ program
 // pull-components
 program
   .command(COMMANDS.PULL_COMPONENTS)
-  .option('-r, --region [value]', 'region', 'eu')
   .description("Download your space's components schema as json")
-  .action(async (source) => {
+  .action(async () => {
     console.log(`${chalk.blue('-')} Executing pull-components task`)
     const space = program.space
     if (!space) {
@@ -127,11 +129,6 @@ program
         await api.processLogin()
       }
 
-      const { region } = source
-      if (program.args.length > 0) {
-        api.setRegion(region)
-      }
-
       api.setSpaceId(space)
       await tasks.pullComponents(api, { space })
     } catch (e) {
@@ -143,7 +140,6 @@ program
 program
   .command(COMMANDS.PUSH_COMPONENTS + ' <source>')
   .option('-p, --presets-source <presetsSource>', 'Path to presets file')
-  .option('-r, --region [value]', 'region', 'eu')
   .description("Download your space's components schema as json. The source parameter can be a URL to your JSON file or a path to it")
   .action(async (source, options) => {
     console.log(`${chalk.blue('-')} Executing push-components task`)
@@ -160,11 +156,6 @@ program
         await api.processLogin()
       }
 
-      const { region } = options
-      if (program.args.length > 0) {
-        api.setRegion(region)
-      }
-
       api.setSpaceId(space)
       await tasks.pushComponents(api, { source, presetsSource })
     } catch (e) {
@@ -176,7 +167,7 @@ program
 program
   .command('delete-component <component>')
   .description('Delete a single component on your space.')
-  .action(async (component, options) => {
+  .action(async (component) => {
     console.log(`${chalk.blue('-')} Executing delete-component task`)
     const space = program.space
     if (!space) {
@@ -187,6 +178,7 @@ program
       if (!api.isAuthorized()) {
         await api.processLogin()
       }
+
       api.setSpaceId(space)
       await tasks.deleteComponent(api, { comp: component })
     } catch (e) {
@@ -212,6 +204,7 @@ program
       if (!api.isAuthorized()) {
         await api.processLogin()
       }
+
       api.setSpaceId(space)
       await tasks.deleteComponents(api, { source, dryRun: !!options.dryrun, reversed: !!options.reverse })
     } catch (e) {
@@ -268,7 +261,6 @@ program
   .requiredOption('--type <TYPE>', 'Define what will be sync. Can be components, folders, stories, datasources or roles')
   .requiredOption('--source <SPACE_ID>', 'Source space id')
   .requiredOption('--target <SPACE_ID>', 'Target space id')
-  .option('-r, --region [value]', 'region', 'eu')
   .action(async (options) => {
     console.log(`${chalk.blue('-')} Sync data between spaces\n`)
 
@@ -280,12 +272,9 @@ program
       const {
         type,
         source,
-        target,
-        region
+        target
       } = options
 
-      api.setRegion(region)
-
       const _types = type.split(',') || []
       _types.forEach(_type => {
         if (!SYNC_TYPES.includes(_type)) {
@@ -314,6 +303,10 @@ program
   .description('Start a project quickly')
   .action(async () => {
     try {
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
       const space = program.space
       const questions = getQuestions('quickstart', { space }, api)
       const answers = await inquirer.prompt(questions)
@@ -327,7 +320,6 @@ program
 program
   .command(COMMANDS.GENERATE_MIGRATION)
   .description('Generate a content migration file')
-  .option('-r, --region [value]', 'region', 'eu')
   .requiredOption('-c, --component <COMPONENT_NAME>', 'Name of the component')
   .requiredOption('-f, --field <FIELD_NAME>', 'Name of the component field')
   .action(async (options) => {
@@ -347,9 +339,6 @@ program
         await api.processLogin()
       }
 
-      const { region } = options
-      api.setRegion(region)
-
       api.setSpaceId(space)
       await tasks.generateMigration(api, component, field)
     } catch (e) {
@@ -363,7 +352,6 @@ program
   .description('Run a migration file')
   .requiredOption('-c, --component <COMPONENT_NAME>', 'Name of the component')
   .requiredOption('-f, --field <FIELD_NAME>', 'Name of the component field')
-  .option('-r, --region [value]', 'region', 'eu')
   .option('--dryrun', 'Do not update the story content')
   .option('--publish <PUBLISH_OPTION>', 'Publish the content. It can be: all, published or published-with-changes')
   .option('--publish-languages <LANGUAGES>', 'Publish specific languages')
@@ -450,7 +438,7 @@ program
 
       await tasks.listSpaces(api)
     } catch (e) {
-      console.log(chalk.red('X') + ' An error ocurred to listing sapces : ' + e.message)
+      console.log(chalk.red('X') + ' An error ocurred to listing spaces: ' + e.message)
       process.exit(1)
     }
   })
@@ -496,7 +484,7 @@ if (program.rawArgs.length <= 2) {
 
 function errorHandler (e, command) {
   if (/404/.test(e.message)) {
-    console.log(chalk.yellow('/!\\') + ' If your space was created under US region, you must provide the region as argument --region us. Otherwise, you can use the default --region eu or omit this flag.')
+    console.log(chalk.yellow('/!\\') + ' If your space was created under US or CN region, you must provide the region us or cn upon login.')
   } else {
     console.log(chalk.red('X') + ' An error occurred when executing the ' + command + ' task: ' + e || e.message)
   }

src/constants.js

@@ -1,8 +1,8 @@
 const API_URL = 'https://api.storyblok.com/v1/'
 const US_API_URL = 'https://api-us.storyblok.com/v1/'
+const CN_API_URL = 'https://api.storyblokchina.cn/v1/'
 const LOGIN_URL = `${API_URL}users/login`
 const SIGNUP_URL = `${API_URL}users/signup`
-const USER_INFO = `${API_URL}users/me`
 
 const SYNC_TYPES = [
   'folders',
@@ -33,7 +33,7 @@ module.exports = {
   SIGNUP_URL,
   API_URL,
   SYNC_TYPES,
-  USER_INFO,
   US_API_URL,
+  CN_API_URL,
   COMMANDS
 }