storyblok 3.18.0 → 3.19.1

package/README.md

@@ -43,6 +43,13 @@ $ storyblok login
 
 * `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.
 
+#### 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 
+```
+
 ### logout
 
 Logout from the Storyblok cli
@@ -81,27 +88,33 @@ $ storyblok pull-languages --space <SPACE_ID>
 
 ### pull-components
 
-Download your space's components schema as json. This command will download 2 files: 1 for the components and 1 for the presets.
+Download your space's components schema as json. By default this command will download 2 files: 1 for the components and 1 for the presets; But if you pass a flag `--separate-files or --sf` the command will create file for each component and presets. And also you could pass a path `--path or -p` to save your components and presets.
+
+```sh
+$ storyblok pull-components --space <SPACE_ID> # Will save files like components-1234.json
+```
 
 ```sh
-$ storyblok pull-components --space <SPACE_ID> --region <REGION>
+$ storyblok pull-components --space <SPACE_ID> --separate-files # Will save files like feature-1234.json grid-1234.json
 ```
 
 #### Options
 
 * `space`: your space id
+* `separate-files`: boolean flag to save components and presets in single files instead a file with all
+* `path`: the path to save your components and preset files
 
 ### push-components
 
 Push your components file to your/another space
 
 ```sh
-$ storyblok push-components <SOURCE> --space <SPACE_ID> --region <REGION> --presets-source <PRESETS_SOURCE>
+$ storyblok push-components <SOURCE> --space <SPACE_ID> --presets-source <PRESETS_SOURCE>
 ```
 
 #### Parameters
 
-* `source`: can be a URL or path to JSON file.
+* `source`: can be a URL or path to JSON file, the path to a json file could be to a single or multiple files separated by comma, like `./pages-1234.json,../User/components/grid-1234.json`
 
 Using an **URL**
 
@@ -109,12 +122,18 @@ Using an **URL**
 $ storyblok push-components https://raw.githubusercontent.com/storyblok/nuxtdoc/master/seed.components.json --space 67819
 ```
 
-Using a **path** to file
+Using a **path** to a single file
 
 ```sh
 $ storyblok push-components ./components.json --space 67819
 ```
 
+Using a **path** to a multiple files
+
+```sh
+$ storyblok push-components ./page.json,../grid.json,./feature.json --space 67819
+```
+
 #### Options
 
 * `space`: your space id

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.18.0",
+  "version": "3.19.1",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",
@@ -25,7 +25,7 @@
   "author": "Dominik Angerer <dominikangerer1@gmail.com>, Alexander Feiglstorfer <delooks@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "axios": "^0.21.1",
+    "axios": "^0.27.2",
     "chalk": "^4.1.0",
     "clear": "0.1.0",
     "commander": "^5.1.0",

package/src/cli.js

@@ -39,14 +39,18 @@ program
 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')
   .action(async (options) => {
+    const { token, region } = 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
     }
 
     try {
-      await api.processLogin()
+      await api.processLogin(token, region)
       process.exit(0)
     } catch (e) {
       console.log(chalk.red('X') + ' An error occurred when logging the user: ' + e.message)
@@ -115,10 +119,13 @@ program
 // pull-components
 program
   .command(COMMANDS.PULL_COMPONENTS)
+  .option('--sf, --separate-files [value]', 'Argument to create a single file for each component')
+  .option('-p, --path <path>', 'Path to save the component files')
   .description("Download your space's components schema as json")
-  .action(async () => {
+  .action(async (options) => {
     console.log(`${chalk.blue('-')} Executing pull-components task`)
     const space = program.space
+    const { separateFiles, path } = options
     if (!space) {
       console.log(chalk.red('X') + ' Please provide the space as argument --space YOUR_SPACE_ID.')
       process.exit(0)
@@ -130,7 +137,7 @@ program
       }
 
       api.setSpaceId(space)
-      await tasks.pullComponents(api, { space })
+      await tasks.pullComponents(api, { space, separateFiles, path })
     } catch (e) {
       errorHandler(e, COMMANDS.PULL_COMPONENTS)
     }

package/src/tasks/pull-components.js

@@ -1,5 +1,5 @@
-const fs = require('fs')
 const chalk = require('chalk')
+const saveFileFactory = require('../utils/save-file-factory')
 
 /**
  * @method getNameFromComponentGroups
@@ -20,11 +20,11 @@ const getNameFromComponentGroups = (groups, uuid) => {
 /**
  * @method pullComponents
  * @param  {Object} api
- * @param  {Object} options { space: Number }
+ * @param  {Object} options { space: Number, separateFiles: Boolean, path: String }
  * @return {Promise<Object>}
  */
 const pullComponents = async (api, options) => {
-  const { space } = options
+  const { space, separateFiles, path } = options
 
   try {
     const componentGroups = await api.getComponentGroups()
@@ -41,33 +41,40 @@ const pullComponents = async (api, options) => {
       }
     })
 
+    if (separateFiles) {
+      for (const comp in components) {
+        const compFileName = `${components[comp].name}-${space}.json`
+        const data = JSON.stringify(components[comp], null, 2)
+        saveFileFactory(compFileName, data, path)
+      }
+      console.log(`${chalk.green('✓')} We've saved your components in files with the names of each component`)
+
+      if (presets.length === 0) return
+
+      for (const preset in presets) {
+        const presetFileName = `${presets[preset].name}-${space}.json`
+        const data = JSON.stringify(presets[preset], null, 2)
+        saveFileFactory(presetFileName, data, path)
+      }
+      console.log(`${chalk.green('✓')} We've saved your presets in files with the names of each preset`)
+      return
+    }
+
     const file = `components.${space}.json`
     const data = JSON.stringify({ components }, null, 2)
 
     console.log(`${chalk.green('✓')} We've saved your components in the file: ${file}`)
 
-    fs.writeFile(`./${file}`, data, err => {
-      if (err) {
-        Promise.reject(err)
-        return
-      }
+    saveFileFactory(file, data, path)
 
-      Promise.resolve(file)
-    })
+    if (presets.length === 0) return
 
     const presetsFile = `presets.${space}.json`
     const presetsData = JSON.stringify({ presets }, null, 2)
 
     console.log(`${chalk.green('✓')} We've saved your presets in the file: ${presetsFile}`)
 
-    fs.writeFile(`./${presetsFile}`, presetsData, err => {
-      if (err) {
-        Promise.reject(err)
-        return
-      }
-
-      Promise.resolve(presetsFile)
-    })
+    saveFileFactory(presetsFile, presetsData, path)
   } catch (e) {
     console.error(`${chalk.red('X')} An error ocurred in pull-components task when load components data`)
     return Promise.reject(new Error(e))

package/src/tasks/push-components.js

@@ -21,30 +21,53 @@ const getGroupByUuid = (groups, uuid) => {
 
 /**
  * Get the data from a local or remote JSON file
- * @param {string} source the local path or remote url of the file
+ * @param {string} path the local path or remote url of the file
  * @returns {Promise<Object>} return the data from the source or an error
  */
-const getDataFromSource = async (source) => {
-  if (!source) {
+const getDataFromPath = async (path) => {
+  if (!path) {
     return {}
   }
+  const sources = path.split(',')
+  const isList = sources.length > 1
 
   try {
-    if (isUrl(source)) {
-      return (await axios.get(source)).data
+    if (isUrl(path)) {
+      return (await axios.get(path)).data
     } else {
-      return JSON.parse(fs.readFileSync(source, 'utf8'))
+      if (!isList) return JSON.parse(fs.readFileSync(sources[0], 'utf8'))
+
+      const data = []
+      sources.forEach((source) => {
+        data.push(JSON.parse(fs.readFileSync(source, 'utf8')))
+      })
+      return data
     }
   } catch (err) {
-    console.error(`${chalk.red('X')} Can not load json file from ${source}`)
+    console.error(`${chalk.red('X')} Can not load json file from ${path}`)
     return Promise.reject(err)
   }
 }
 
+/**
+ * Creat an array based in the content parameter and the key provided
+ * @param {object} content the data to create a list
+ * @param {string} key key to serch in the content
+ * @returns {Array} return the data from the source or an error
+ */
+const createContentList = (content, key) => {
+  if (content[key]) return content[key]
+  else if (Array.isArray(content)) return [...content]
+  else return [content]
+}
+
 module.exports = async (api, { source, presetsSource }) => {
   try {
-    const components = (await getDataFromSource(source)).components || []
-    const presets = (await getDataFromSource(presetsSource)).presets || []
+    const rawComponents = await getDataFromPath(source)
+    const components = createContentList(rawComponents, 'components')
+    const rawPresets = await getDataFromPath(presetsSource)
+    const presets = createContentList(rawPresets, 'presets')
+
     return push(api, components, presets)
   } catch (err) {
     console.error(`${chalk.red('X')} Can not push invalid json - please provide a valid json file`)

package/src/utils/api.js

@@ -103,8 +103,14 @@ module.exports = {
     return Promise.reject(new Error('The code could not be authenticated.'))
   },
 
-  async processLogin () {
+  async processLogin (token = null, region = null) {
     try {
+      if (token && region) {
+        await this.loginWithToken({ token, region })
+        console.log(chalk.green('✓') + ' Log in successfully! Token has been added to .netrc file.')
+        return Promise.resolve({ token, region })
+      }
+
       let content = {}
       await inquirer
         .prompt(getQuestions('login-strategy'))

package/src/utils/index.js

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

package/src/utils/save-file-factory.js

@@ -0,0 +1,16 @@
+const fs = require('fs')
+
+const saveFileFactory = async (fileName, content, path = './') => {
+  return new Promise((resolve, reject) => {
+    fs.writeFile(`${path}${fileName}`, content, err => {
+      if (err) {
+        Promise.reject(err)
+        return
+      }
+
+      Promise.resolve(true)
+    })
+  })
+}
+
+module.exports = saveFileFactory

package/tests/constants.js

@@ -3,7 +3,7 @@ const PASSWORD_TEST = 'test'
 const TOKEN_TEST = 'storyblok1234'
 const REGION_TEST = 'eu'
 
-// use functions to always returns "new" data
+// use functions to always returns 'new' data
 const FAKE_COMPONENTS = () => [
   {
     name: 'teaser',
@@ -136,7 +136,7 @@ const FAKE_COMPONENTS = () => [
   }
 ]
 
-// use functions to always returns "new" data
+// use functions to always returns 'new' data
 const FAKE_STORIES = () => [
   {
     name: 'About',
@@ -249,6 +249,46 @@ const FAKE_SPACE_OPTIONS = () => ({
   use_translated_stories: false
 })
 
+const FAKE_PRESET = () => ({
+  id: 123,
+  name: 'page_preset',
+  preset: {
+    _uid: '7dce995b-07ed-4e5b-a4bb-5d22447252d8',
+    body: [
+      {
+        _uid: '995e84c1-a08d-45cd-b121-e4db45e9cf50',
+        headline: 'Hello world!',
+        component: 'teaser'
+      },
+      {
+        _uid: 'a6e118ec-1a57-4f0f-b1e9-1ed625a82751',
+        columns: [
+          {
+            _uid: '9b0a9bed-e891-4edc-8f5e-bc29e7ec785c',
+            name: 'Feature 1',
+            component: 'feature'
+          },
+          {
+            _uid: '07863609-7518-48b9-8d28-b1e8037818e2',
+            name: 'Feature 2',
+            component: 'feature'
+          }
+        ],
+        component: 'grid'
+      }
+    ],
+    component: 'page'
+  },
+  component_id: 3481284,
+  space_id: 200378,
+  created_at: '2023-02-24T16:49:14.723Z',
+  updated_at: '2023-02-24T16:49:14.723Z',
+  image: '',
+  color: '',
+  icon: '',
+  description: 'page preset'
+})
+
 module.exports = {
   EMAIL_TEST,
   TOKEN_TEST,
@@ -257,5 +297,6 @@ module.exports = {
   FAKE_COMPONENTS,
   FAKE_SPACES,
   FAKE_SPACE_OPTIONS,
-  REGION_TEST
+  REGION_TEST,
+  FAKE_PRESET
 }

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

@@ -1,6 +1,6 @@
 const fs = require('fs')
 const pullComponents = require('../../src/tasks/pull-components')
-const { FAKE_COMPONENTS } = require('../constants')
+const { FAKE_COMPONENTS, FAKE_PRESET } = require('../constants')
 
 jest.mock('fs')
 
@@ -24,36 +24,12 @@ describe('testing pullComponents', () => {
       })
   })
 
-  it('api.getComponents() should be call fs.writeFile correctly', async () => {
+  it('pull components should be call fs.writeFile correctly and generate component file', async () => {
     const SPACE = 12345
-    const BODY = {
-      components: [
-        {
-          name: 'teaser',
-          display_name: null,
-          created_at: '2019-10-15T17:00:32.212Z',
-          id: 581153,
-          schema: {
-            headline: {
-              type: 'text'
-            }
-          },
-          image: null,
-          preview_field: null,
-          is_root: false,
-          preview_tmpl: null,
-          is_nestable: true,
-          all_presets: [],
-          preset_id: null,
-          real_name: 'teaser',
-          component_group_uuid: null
-        }
-      ]
-    }
 
     const api = {
       getComponents () {
-        return Promise.resolve(BODY.components)
+        return Promise.resolve([FAKE_COMPONENTS()[0]])
       },
       getComponentGroups () {
         return Promise.resolve([])
@@ -73,9 +49,85 @@ describe('testing pullComponents', () => {
       .then(_ => {
         const [path, data] = fs.writeFile.mock.calls[0]
 
-        expect(fs.writeFile.mock.calls.length).toBe(2)
+        expect(fs.writeFile.mock.calls.length).toBe(1)
         expect(path).toBe(`./${expectFileName}`)
-        expect(JSON.parse(data)).toEqual(BODY)
+        expect(JSON.parse(data)).toEqual({ components: [FAKE_COMPONENTS()[0]] })
+      })
+  })
+
+  it('pull components should be call fs.writeFile correctly and generate a component and preset files', async () => {
+    const SPACE = 12345
+
+    const api = {
+      getComponents () {
+        return Promise.resolve([FAKE_COMPONENTS()[0]])
+      },
+      getComponentGroups () {
+        return Promise.resolve([])
+      },
+      getPresets () {
+        return Promise.resolve(FAKE_PRESET())
+      }
+    }
+
+    const options = {
+      space: SPACE
+    }
+
+    const expectComponentFileName = `components.${SPACE}.json`
+    const expectPresetFileName = `presets.${SPACE}.json`
+
+    return pullComponents(api, options)
+      .then(_ => {
+        const [compPath, compData] = fs.writeFile.mock.calls[0]
+        const [presetPath, presetData] = fs.writeFile.mock.calls[1]
+
+        expect(fs.writeFile.mock.calls.length).toBe(2)
+
+        expect(compPath).toBe(`./${expectComponentFileName}`)
+        expect(JSON.parse(compData)).toEqual({ components: [FAKE_COMPONENTS()[0]] })
+
+        expect(presetPath).toBe(`./${expectPresetFileName}`)
+        expect(JSON.parse(presetData)).toEqual({ presets: FAKE_PRESET() })
+      })
+  })
+
+  it('pull components should be call fs.writeFile and generate a single file for each component', async () => {
+    const SPACE = 12345
+
+    const api = {
+      getComponents () {
+        return Promise.resolve(FAKE_COMPONENTS())
+      },
+      getComponentGroups () {
+        return Promise.resolve([])
+      },
+      getPresets () {
+        return Promise.resolve([])
+      }
+    }
+
+    const options = {
+      space: SPACE,
+      separateFiles: true
+    }
+
+    return pullComponents(api, options)
+      .then(_ => {
+        expect(fs.writeFile.mock.calls.length).toBe(FAKE_COMPONENTS().length)
+
+        for (const comp in FAKE_COMPONENTS()) {
+          const compFileName = `${FAKE_COMPONENTS()[comp].name}-${SPACE}.json`
+          let data = FAKE_COMPONENTS()[comp]
+          const [compPath, compData] = fs.writeFile.mock.calls[comp]
+
+          if (FAKE_COMPONENTS()[comp].name === 'logo') {
+            data = { ...FAKE_COMPONENTS()[comp], component_group_name: '' }
+          }
+
+          expect(compPath).toBe(`./${compFileName}`)
+          expect(JSON.parse(compData)).toEqual(data)
+        }
       })
   })
 

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

@@ -1,6 +1,7 @@
 const sync = require('../../src/tasks/sync')
 const PresetsLib = jest.requireActual('../../src/utils/presets-lib')
-const { TOKEN_TEST, FAKE_COMPONENTS } = require('../constants')
+const { TOKEN_TEST, EMAIL_TEST, REGION_TEST, FAKE_COMPONENTS } = require('../constants')
+const creds = require('../../src/utils/creds')
 
 const FAKE_COMPONENTS_TO_TEST = {
   '001': {
@@ -217,6 +218,7 @@ const TARGET_SPACE_TEST = '002'
 
 describe('testing syncComponents', () => {
   beforeAll(() => {
+    creds.set(EMAIL_TEST, TOKEN_TEST, REGION_TEST)
     // we need to execute once this function to test it
     const _types = ['components']