storyblok 3.19.1 → 3.21.0

package/README.md

@@ -37,7 +37,10 @@ $ 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**
 
@@ -47,7 +50,7 @@ $ storyblok login
 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
@@ -225,6 +228,10 @@ $ 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
+* `starts-with`: sync only stories that starts with the given string
+* `filter`: sync stories based on the given filter. Required Options: Required options: `--keys`, `--operations`, `--values`
+* `keys`: Multiple keys should be separated by comma. Example: `--keys key1,key2`, `--keys key1`
+* `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.
 
 #### Examples
 
@@ -234,6 +241,15 @@ $ storyblok sync --type components --source 00001 --target 00002
 
 # Sync components and stories from `00001` space to `00002` space
 $ storyblok sync --type components,stories --source 00001 --target 00002
+
+# Sync only stories that starts with `myStartsWithString` from `00001` space to `00002` space
+$ storyblok sync --type stories --source 00001 --target 00002 --starts-with myStartsWithString
+
+# Sync only stories with a category field like `reference` from `00001` space to `00002` space
+$ storyblok sync --type stories --source 00001 --target 00002 --filter --keys category --operations like --values reference
+
+# Sync only stories with a category field like `reference` and a name field not like `demo` from `00001` space to `00002` space
+$ storyblok sync --type stories --source 00001 --target 00002 --filter --keys category,name --operations like,not_like --values reference,demo
 ```
 
 ### quickstart

package/package.json

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

package/src/cli.js

@@ -12,7 +12,7 @@ const updateNotifier = require('update-notifier')
 const pkg = require('../package.json')
 
 const tasks = require('./tasks')
-const { getQuestions, lastStep, api, creds } = require('./utils')
+const { getQuestions, lastStep, api, creds, buildFilterQuery } = require('./utils')
 const { SYNC_TYPES, COMMANDS } = require('./constants')
 
 clear()
@@ -268,6 +268,12 @@ 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('--starts-with <STARTS_WITH>', 'Sync only stories that starts with the given string')
+  .option('--filter', 'Enable filter options to sync only stories that match the given filter. Required options: --keys; --operations; --values')
+  .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`)
 
@@ -279,9 +285,17 @@ program
       const {
         type,
         source,
-        target
+        target,
+        startsWith,
+        filter,
+        keys,
+        operations,
+        values,
+        componentsGroups
       } = options
 
+      const _componentsGroups = componentsGroups ? componentsGroups.split(',') : null
+
       const _types = type.split(',') || []
       _types.forEach(_type => {
         if (!SYNC_TYPES.includes(_type)) {
@@ -289,13 +303,17 @@ program
         }
       })
 
-      const token = creds.get().token || null
+      const filterQuery = filter ? buildFilterQuery(keys, operations, values) : undefined
 
+      const token = creds.get().token || null
       await tasks.sync(_types, {
         api,
         token,
         source,
-        target
+        target,
+        startsWith,
+        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

@@ -3,6 +3,7 @@ const chalk = require('chalk')
 const SyncComponents = require('./sync-commands/components')
 const SyncDatasources = require('./sync-commands/datasources')
 const { capitalize } = require('../utils')
+const { startsWith } = require('lodash/string')
 
 const SyncSpaces = {
   targetComponents: [],
@@ -14,7 +15,10 @@ const SyncSpaces = {
     this.sourceSpaceId = options.source
     this.targetSpaceId = options.target
     this.oauthToken = options.token
+    this.startsWith = options.startsWith
+    this.filterQuery = options.filterQuery
     this.client = api.getClient()
+    this.componentsGroups = options._componentsGroups
   },
 
   async getStoryWithTranslatedSlugs (sourceStory, targetStory) {
@@ -56,7 +60,9 @@ const SyncSpaces = {
     }
 
     const all = await this.client.getAll(`spaces/${this.sourceSpaceId}/stories`, {
-      story_only: 1
+      story_only: 1,
+      ...(this.startsWith ? { starts_with: this.startsWith } : {}),
+      ...(this.filterQuery ? { filter_query: this.filterQuery } : {})
     })
 
     for (let i = 0; i < all.length; i++) {
@@ -226,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/build-filter-query.js

@@ -0,0 +1,23 @@
+const buildFilterQuery = (keys, operations, values) => {
+  const operators = ['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']
+  if (!keys || !operations || !values) {
+    throw new Error('Filter options are required: --keys; --operations; --values')
+  }
+  const _keys = keys.split(',')
+  const _operations = operations.split(',')
+  const _values = values.split(',')
+  if (_keys.length !== _operations.length || _keys.length !== _values.length) {
+    throw new Error('The number of keys, operations and values must be the same')
+  }
+  const invalidOperators = _operations.filter((o) => !operators.includes(o))
+  if (invalidOperators.length) {
+    throw new Error('Invalid operator(s) applied for filter: ' + invalidOperators.join(' '))
+  }
+  const filterQuery = {}
+  _keys.forEach((key, index) => {
+    filterQuery[key] = { [_operations[index]]: _values[index] }
+  })
+  return filterQuery
+}
+
+module.exports = buildFilterQuery

package/src/utils/index.js

@@ -6,5 +6,6 @@ module.exports = {
   capitalize: require('./capitalize'),
   findByProperty: require('./find-by-property'),
   parseError: require('./parse-error'),
+  buildFilterQuery: require('./build-filter-query'),
   saveFileFactory: require('./save-file-factory')
-}
+}