storyblok 3.20.0 → 3.22.0

package/README.md

@@ -37,17 +37,20 @@ $ storyblok login
 * `password`: your user's password
 
 ##### Options for Login with token (Recomended to SSO user's but works with all user accounts)
-* `token`: your access token
+* `token`: your personal access token
+
+**Get your personal access token**
+* Go to [https://app.storyblok.com/#/me/account?tab=token](https://app.storyblok.com/#/me/account?tab=token) and click on Generate new token.
 
 **For Both login options you nedd to pass the region**
 
-* `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.
+* `region`: region you would like to work in. Please keep in mind that the region must match the region of your space. You can use `us`, `cn` or `eu`, if left empty, default is `eu`. This region flag will be used for the other cli's commands. 
 
 #### Login with token flag
 You can also add the token directly from the login’s command, like the example below:
 
 ```sh
-$ storyblok login --token <YOUR_OUTH_TOKEN> --region eu 
+$ storyblok login --token <PERSONAL_ACCESS_TOKEN> --region eu 
 ```
 
 ### logout

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.20.0",
+  "version": "3.22.0",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",

package/src/cli.js

@@ -40,7 +40,7 @@ program
   .command(COMMANDS.LOGIN)
   .description('Login to the Storyblok cli')
   .option('-t, --token <token>', 'Token to login directly without questions, like for CI enviroments')
-  .option('-r, --region <region>', 'Region of the user')
+  .option('-r, --region <region>', 'The region you would like to work in. Please keep in mind that the region must match the region of your space. You can use us, cn or eu, if left empty, default is eu. This region flag will be used for the other cli\'s commands')
   .action(async (options) => {
     const { token, region } = options
 
@@ -273,6 +273,7 @@ program
   .option('--keys <KEYS>', 'Field names in your story object which should be used for filtering. Multiple keys should separated by comma.')
   .option('--operations <OPERATIONS>', 'Operations to be used for filtering. Can be: is, in, not_in, like, not_like, any_in_array, all_in_array, gt_date, lt_date, gt_int, lt_int, gt_float, lt_float. Multiple operations should be separated by comma.')
   .option('--values <VALUES>', 'Values to be used for filtering. Any string or number. If you want to use multiple values, separate them with a comma. Multiple values should be separated by comma.')
+  .option('--components-groups <UUIDs>', 'Synchronize components based on their group UUIDs separated by commas')
   .action(async (options) => {
     console.log(`${chalk.blue('-')} Sync data between spaces\n`)
 
@@ -289,9 +290,12 @@ program
         filter,
         keys,
         operations,
-        values
+        values,
+        componentsGroups
       } = options
 
+      const _componentsGroups = componentsGroups ? componentsGroups.split(',') : null
+
       const _types = type.split(',') || []
       _types.forEach(_type => {
         if (!SYNC_TYPES.includes(_type)) {
@@ -308,7 +312,8 @@ program
         source,
         target,
         startsWith,
-        filterQuery
+        filterQuery,
+        _componentsGroups
       })
 
       console.log('\n' + chalk.green('✓') + ' Sync data between spaces successfully completed')

package/src/tasks/sync-commands/components.js

@@ -18,6 +18,7 @@ class SyncComponents {
     this.oauthToken = options.oauthToken
     this.client = api.getClient()
     this.presetsLib = new PresetsLib({ oauthToken: options.oauthToken, targetSpaceId: this.targetSpaceId })
+    this.componentsGroups = options.componentsGroups
   }
 
   async sync () {
@@ -70,6 +71,14 @@ class SyncComponents {
 
       const sourceGroupUuid = component.component_group_uuid
 
+      if (this.componentsGroups && !this.componentsGroups.includes(sourceGroupUuid)) {
+        console.log(
+          chalk.yellow("-") +
+            ` Component ${component.name} does not belong to the ${this.componentsGroups} group(s).`
+        );
+        continue;
+      }
+
       // if the component belongs to a group
       if (sourceGroupUuid) {
         const sourceGroup = findByProperty(

package/src/tasks/sync.js

@@ -18,6 +18,7 @@ const SyncSpaces = {
     this.startsWith = options.startsWith
     this.filterQuery = options.filterQuery
     this.client = api.getClient()
+    this.componentsGroups = options._componentsGroups
   },
 
   async getStoryWithTranslatedSlugs (sourceStory, targetStory) {
@@ -231,7 +232,8 @@ const SyncSpaces = {
     const syncComponentsInstance = new SyncComponents({
       sourceSpaceId: this.sourceSpaceId,
       targetSpaceId: this.targetSpaceId,
-      oauthToken: this.oauthToken
+      oauthToken: this.oauthToken,
+      componentsGroups: this.componentsGroups
     })
 
     try {

package/src/utils/get-questions.js

@@ -9,7 +9,7 @@ const getOptions = (subCommand, argv = {}, api = {}) => {
   const regionInput = {
     type: 'input',
     name: 'region',
-    message: 'Enter your user\'s region (us, eu or cn):',
+    message: 'Please enter the region you would like to work in (us, eu or cn) - if not set, default is eu:',
     validate: function (value) {
       const flagList = ['us', 'cn', 'eu']
       if (flagList.indexOf(value) > -1) {