storyblok 3.10.5 → 3.12.0

package/.github/labeler.yml

@@ -0,0 +1,8 @@
+app.storyblok:
+    - '[x] *app.storyblok.com'
+api.storyblok:
+    - '[x] *api.storyblok.com'
+mapi.storyblok:
+    - '[x] *mapi.storyblok.com'
+capi.storyblok:
+    - '[x] *capi.storyblok.com'

package/.github/workflows/issue-label.yml

@@ -0,0 +1,14 @@
+name: "Issue Labeler"
+on:
+  issues:
+    types: [opened]
+
+jobs:
+  triage:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: github/issue-labeler@v2.5 
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        configuration-path: .github/labeler.yml
+        enable-versioned-regex: 0

package/README.md

@@ -33,24 +33,26 @@ $ storyblok select
 Download your space's components schema as json. This command will download 2 files: 1 for the components and 1 for the presets.
 
 ```sh
-$ storyblok pull-components --space <SPACE_ID>
+$ 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
 
 Push your components file to your/another space
 
 ```sh
-$ storyblok push-components <SOURCE> --space <SPACE_ID> --presets-source <PRESETS_SOURCE>
+$ storyblok push-components <SOURCE> --space <SPACE_ID> --region <REGION> --presets-source <PRESETS_SOURCE>
 ```
 
 #### 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**
 
@@ -67,6 +69,7 @@ $ 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
@@ -96,6 +99,7 @@ $ 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
 
@@ -138,12 +142,14 @@ Create a migration file (with the name `change_<COMPONENT>_<FIELD>.js`) inside t
 ```sh
 $ storyblok generate-migration --space <SPACE_ID> --component <COMPONENT_NAME> --field <FIELD>
 ```
+It's important to note that the `component` and `field` parameters are required and must be spelled exactly as they are in Storyblok. You can check the exact name by looking at the `Block library` inside your space.
 
 #### Options
 
 * `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
 
@@ -170,6 +176,7 @@ $ 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
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.10.5",
+  "version": "3.12.0",
   "description": "A simple CLI to start Storyblok from your command line.",
   "keywords": [
     "storyblok",
@@ -37,7 +37,7 @@
     "open": "^6.0.0",
     "p-series": "^2.1.0",
     "path": "^0.12.7",
-    "storyblok-js-client": "^3.3.1",
+    "storyblok-js-client": "^4.5.6",
     "update-notifier": "^5.1.0",
     "xml-js": "^1.6.11"
   },

package/src/cli.js

@@ -13,7 +13,7 @@ const pkg = require('../package.json')
 
 const tasks = require('./tasks')
 const { getQuestions, lastStep, api, creds } = require('./utils')
-const { SYNC_TYPES } = require('./constants')
+const { SYNC_TYPES, COMMANDS } = require('./constants')
 
 clear()
 console.log(chalk.cyan(figlet.textSync('Storyblok')))
@@ -37,7 +37,7 @@ program
 
 // login
 program
-  .command('login')
+  .command(COMMANDS.LOGIN)
   .description('Login to the Storyblok cli')
   .action(async () => {
     if (api.isAuthorized()) {
@@ -56,7 +56,7 @@ program
 
 // logout
 program
-  .command('logout')
+  .command(COMMANDS.LOGOUT)
   .description('Logout from the Storyblok cli')
   .action(async () => {
     try {
@@ -71,9 +71,10 @@ program
 
 // pull-components
 program
-  .command('pull-components')
+  .command(COMMANDS.PULL_COMPONENTS)
+  .option('-r, --region [value]', 'region', 'eu')
   .description("Download your space's components schema as json")
-  .action(async () => {
+  .action(async (source) => {
     console.log(`${chalk.blue('-')} Executing pull-components task`)
     const space = program.space
     if (!space) {
@@ -86,18 +87,23 @@ 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) {
-      console.log(chalk.red('X') + ' An error occurred when executing the pull-components task: ' + e.message)
-      process.exit(1)
+      errorHandler(e, COMMANDS.PULL_COMPONENTS)
     }
   })
 
 // push-components
 program
-  .command('push-components <source>')
+  .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`)
@@ -113,17 +119,22 @@ program
       if (!api.isAuthorized()) {
         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) {
-      console.log(chalk.red('X') + ' An error occurred when executing the push-components task: ' + e.message)
-      process.exit(1)
+      errorHandler(e, COMMANDS.PUSH_COMPONENTS)
     }
   })
 
 // scaffold
 program
-  .command('scaffold <name>')
+  .command(COMMANDS.SCAFFOLD + ' <name>')
   .description('Scaffold <name> component')
   .action(async (name) => {
     console.log(`${chalk.blue('-')} Scaffolding a component\n`)
@@ -146,7 +157,7 @@ program
 
 // select
 program
-  .command('select')
+  .command(COMMANDS.SELECT)
   .description('Usage to kickstart a boilerplate, fieldtype or theme')
   .action(async () => {
     console.log(`${chalk.blue('-')} Select a boilerplate, fieldtype or theme to initialize\n`)
@@ -164,36 +175,40 @@ program
 
 // sync
 program
-  .command('sync')
+  .command(COMMANDS.SYNC)
   .description('Sync schemas, roles, folders and stories between spaces')
   .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`)
 
-    const {
-      type,
-      source,
-      target
-    } = options
-
     try {
-      const _types = type.split(',') || []
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
+      const {
+        type,
+        source,
+        target,
+        region
+      } = options
+
+      api.setRegion(region)
 
+      const _types = type.split(',') || []
       _types.forEach(_type => {
         if (!SYNC_TYPES.includes(_type)) {
           throw new Error(`The type ${_type} is not valid`)
         }
       })
 
-      if (!api.isAuthorized()) {
-        await api.processLogin()
-      }
-
       const token = creds.get().token || null
 
       await tasks.sync(_types, {
+        api,
         token,
         source,
         target
@@ -201,14 +216,13 @@ program
 
       console.log('\n' + chalk.green('✓') + ' Sync data between spaces successfully completed')
     } catch (e) {
-      console.error(chalk.red('X') + ' An error ocurred when syncing spaces: ' + e.message)
-      process.exit(1)
+      errorHandler(e, COMMANDS.SYNC)
     }
   })
 
 // quickstart
 program
-  .command('quickstart')
+  .command(COMMANDS.QUICKSTART)
   .description('Start a project quickly')
   .action(async () => {
     try {
@@ -223,13 +237,14 @@ program
   })
 
 program
-  .command('generate-migration')
+  .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) => {
-    const field = options.field || ''
-    const component = options.component || ''
+    const { field = '' } = options
+    const { component = '' } = options
 
     const space = program.space
     if (!space) {
@@ -244,6 +259,9 @@ program
         await api.processLogin()
       }
 
+      const { region } = options
+      api.setRegion(region)
+
       api.setSpaceId(space)
       await tasks.generateMigration(api, component, field)
     } catch (e) {
@@ -253,10 +271,11 @@ program
   })
 
 program
-  .command('run-migration')
+  .command(COMMANDS.RUN_MIGRATION)
   .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')
@@ -304,7 +323,7 @@ program
   })
 
 program
-  .command('rollback-migration')
+  .command(COMMANDS.ROLLBACK_MIGRATION)
   .description('Rollback-migration a migration file')
   .requiredOption('-c, --component <COMPONENT_NAME>', 'Name of the component')
   .requiredOption('-f, --field <FIELD_NAME>', 'Name of the component field')
@@ -333,7 +352,7 @@ program
 
 // list spaces
 program
-  .command('spaces')
+  .command(COMMANDS.SPACES)
   .description('List all spaces of the logged account')
   .action(async () => {
     try {
@@ -350,7 +369,7 @@ program
 
 // import data
 program
-  .command('import')
+  .command(COMMANDS.IMPORT)
   .description('Import data from other systems and relational databases.')
   .requiredOption('-f, --file <FILE_NAME>', 'Name of the file')
   .requiredOption('-t, --type <TYPE>', 'Type of the content')
@@ -386,3 +405,12 @@ program.parse(process.argv)
 if (program.rawArgs.length <= 2) {
   program.help()
 }
+
+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.')
+  } else {
+    console.log(chalk.red('X') + ' An error occurred when executing the ' + command + ' task: ' + e || e.message)
+  }
+  process.exit(1)
+}

package/src/constants.js

@@ -1,4 +1,5 @@
 const API_URL = 'https://api.storyblok.com/v1/'
+const US_API_URL = 'https://api-us.storyblok.com/v1/'
 const LOGIN_URL = `${API_URL}users/login`
 const SIGNUP_URL = `${API_URL}users/signup`
 
@@ -10,9 +11,27 @@ const SYNC_TYPES = [
   'datasources'
 ]
 
+const COMMANDS = {
+  GENERATE_MIGRATION: 'generate-migration',
+  IMPORT: 'import',
+  LOGIN: 'login',
+  LOGOUT: 'logout',
+  PULL_COMPONENTS: 'pull-components',
+  PUSH_COMPONENTS: 'push-components',
+  QUICKSTART: 'quickstart',
+  ROLLBACK_MIGRATION: 'rollback-migration',
+  RUN_MIGRATION: 'run-migration',
+  SCAFFOLD: 'scaffold',
+  SELECT: 'select',
+  SPACES: 'spaces',
+  SYNC: 'sync'
+}
+
 module.exports = {
   LOGIN_URL,
   SIGNUP_URL,
   API_URL,
-  SYNC_TYPES
+  SYNC_TYPES,
+  US_API_URL,
+  COMMANDS
 }

package/src/tasks/push-components.js

@@ -103,7 +103,7 @@ const push = async (api, components, presets = []) => {
       if (schema) {
         Object.keys(schema).forEach(field => {
           if (schema[field].component_group_whitelist) {
-            schema[field].component_group_whitelist = schema[field].component_group_whitelist.map(uuid => 
+            schema[field].component_group_whitelist = schema[field].component_group_whitelist.map(uuid =>
               getGroupByUuid(componentsGroups, uuid) ? getGroupByUuid(componentsGroups, uuid).uuid : uuid
             )
           }

package/src/tasks/sync.js

@@ -1,6 +1,5 @@
 const pSeries = require('p-series')
 const chalk = require('chalk')
-const StoryblokClient = require('storyblok-js-client')
 const SyncComponents = require('./sync-commands/components')
 const SyncDatasources = require('./sync-commands/datasources')
 const { capitalize } = require('../utils')
@@ -10,13 +9,12 @@ const SyncSpaces = {
   sourceComponents: [],
 
   init (options) {
+    const { api } = options
     console.log(chalk.green('✓') + ' Loading options')
     this.sourceSpaceId = options.source
     this.targetSpaceId = options.target
     this.oauthToken = options.token
-    this.client = new StoryblokClient({
-      oauthToken: options.token
-    }, options.api)
+    this.client = api.getClient()
   },
 
   async getStoryWithTranslatedSlugs (sourceStory, targetStory) {

package/src/utils/api.js

@@ -5,16 +5,21 @@ const inquirer = require('inquirer')
 
 const creds = require('./creds')
 const getQuestions = require('./get-questions')
-const { LOGIN_URL, SIGNUP_URL, API_URL } = require('../constants')
+const { LOGIN_URL, SIGNUP_URL, API_URL, US_API_URL } = require('../constants')
 
 module.exports = {
   accessToken: '',
+  oauthToken: '',
   spaceId: null,
+  region: 'eu',
 
   getClient () {
+    const apiURL = this.region === 'us' ? US_API_URL : API_URL
     return new Storyblok({
-      oauthToken: this.accessToken
-    }, API_URL)
+      accessToken: this.accessToken,
+      oauthToken: this.oauthToken,
+      region: this.region
+    }, apiURL)
   },
 
   getPath (path) {
@@ -70,7 +75,7 @@ module.exports = {
   persistCredentials (email, data) {
     const token = this.extractToken(data)
     if (token) {
-      this.accessToken = token
+      this.oauthToken = token
       creds.set(email, token)
 
       return Promise.resolve(data)
@@ -115,7 +120,7 @@ module.exports = {
     })
       .then(response => {
         const token = this.extractToken(response)
-        this.accessToken = token
+        this.oauthToken = token
         creds.set(email, token)
 
         return Promise.resolve(true)
@@ -127,7 +132,7 @@ module.exports = {
     const { token } = creds.get() || {}
 
     if (token) {
-      this.accessToken = token
+      this.oauthToken = token
       return true
     }
 
@@ -138,6 +143,10 @@ module.exports = {
     this.spaceId = spaceId
   },
 
+  setRegion (region) {
+    this.region = region
+  },
+
   getPresets () {
     const client = this.getClient()
 

package/tests/units/sync-components.spec.js

@@ -99,7 +99,7 @@ const FAKE_PRESETS = {
             title: 'A default hero title',
             subtitle: 'A default hero subtitle',
             component: 'hero',
-            image: 'https://a.storyblok.com/f/002/bd78c087d1/screen-shot.png',
+            image: 'https://a.storyblok.com/f/002/bd78c087d1/screen-shot.png'
           },
           component_id: 3, // from FAKE_COMPONENTS 'hero'
           space_id: '000000',
@@ -221,6 +221,9 @@ describe('testing syncComponents', () => {
     const _types = ['components']
 
     return sync(_types, {
+      api: {
+        getClient: jest.fn(() => ({}))
+      },
       token: TOKEN_TEST,
       source: SOURCE_SPACE_TEST,
       target: TARGET_SPACE_TEST
@@ -291,7 +294,7 @@ describe('testing syncComponents', () => {
           title: 'A default hero title',
           subtitle: 'A default hero subtitle',
           component: 'hero',
-          image: 'https://a.storyblok.com/f/002/bd78c087d1/screen-shot.png',
+          image: 'https://a.storyblok.com/f/002/bd78c087d1/screen-shot.png'
         },
         component_id: 3, // from FAKE_COMPONENTS 'hero'
         space_id: '000000',