storyblok 3.24.1 → 3.25.0

package/README.md

@@ -247,10 +247,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
-* `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
 
@@ -261,14 +257,6 @@ $ 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.24.1",
+  "version": "3.25.0",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",
@@ -42,7 +42,7 @@
     "p-series": "^2.1.0",
     "path": "^0.12.7",
     "simple-uuid": "^0.0.1",
-    "storyblok-js-client": "^4.5.6",
+    "storyblok-js-client": "^5.12.0",
     "update-notifier": "^5.1.0",
     "xml-js": "^1.6.11"
   },

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, buildFilterQuery } = require('./utils')
+const { getQuestions, lastStep, api, creds } = require('./utils')
 const { SYNC_TYPES, COMMANDS } = require('./constants')
 
 clear()
@@ -271,11 +271,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('--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`)
@@ -287,18 +282,15 @@ program
 
       const {
         type,
-        source,
         target,
-        startsWith,
-        filter,
-        keys,
-        operations,
-        values,
+        source,
         componentsGroups
       } = options
 
       const _componentsGroups = componentsGroups ? componentsGroups.split(',') : null
 
+      const token = creds.get().token || null
+
       const _types = type.split(',') || []
       _types.forEach(_type => {
         if (!SYNC_TYPES.includes(_type)) {
@@ -306,16 +298,11 @@ program
         }
       })
 
-      const filterQuery = filter ? buildFilterQuery(keys, operations, values) : undefined
-
-      const token = creds.get().token || null
       await tasks.sync(_types, {
         api,
         token,
-        source,
         target,
-        startsWith,
-        filterQuery,
+        source,
         _componentsGroups
       })
 

package/src/constants.js

@@ -28,6 +28,11 @@ const COMMANDS = {
   SYNC: 'sync'
 }
 
+const DEFAULT_AGENT = {
+  SB_Agent: 'SB-CLI',
+  SB_Agent_Version: process.env.npm_package_version || '3.0.0'
+}
+
 module.exports = {
   LOGIN_URL,
   SIGNUP_URL,
@@ -35,5 +40,6 @@ module.exports = {
   SYNC_TYPES,
   US_API_URL,
   CN_API_URL,
-  COMMANDS
+  COMMANDS,
+  DEFAULT_AGENT
 }

package/src/tasks/sync.js

@@ -3,7 +3,6 @@ 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: [],
@@ -15,8 +14,6 @@ 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
   },
@@ -60,9 +57,7 @@ const SyncSpaces = {
     }
 
     const all = await this.client.getAll(`spaces/${this.sourceSpaceId}/stories`, {
-      story_only: 1,
-      ...(this.startsWith ? { starts_with: this.startsWith } : {}),
-      ...(this.filterQuery ? { filter_query: this.filterQuery } : {})
+      story_only: 1
     })
 
     for (let i = 0; i < all.length; i++) {

package/src/utils/api.js

@@ -5,7 +5,7 @@ const inquirer = require('inquirer')
 
 const creds = require('./creds')
 const getQuestions = require('./get-questions')
-const { SIGNUP_URL, API_URL, US_API_URL, CN_API_URL } = require('../constants')
+const { SIGNUP_URL, API_URL, US_API_URL, CN_API_URL, DEFAULT_AGENT } = require('../constants')
 
 module.exports = {
   accessToken: '',
@@ -20,7 +20,10 @@ module.exports = {
       return new Storyblok({
         accessToken: this.accessToken,
         oauthToken: this.oauthToken,
-        region: this.region
+        region: this.region,
+        headers: {
+          ...DEFAULT_AGENT
+        }
       }, this.apiSwitcher(region))
     } catch (error) {
       throw new Error(error)
@@ -277,7 +280,10 @@ module.exports = {
     const customClient = new Storyblok({
       accessToken: this.accessToken,
       oauthToken: this.oauthToken,
-      region
+      region,
+      headers: {
+        ...DEFAULT_AGENT
+      }
     }, this.apiSwitcher(region))
     return await customClient
       .get('spaces/', {})

package/src/utils/index.js

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

package/src/utils/build-filter-query.js

@@ -1,23 +0,0 @@
-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