storyblok 3.14.0 → 3.16.0

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,19 +1,12 @@
 ---
 name: Bug report
-about: Create a report to help us improve Storyblok
+about: Create a report to help us improve the CLI
 title: ''
 labels: bug
 assignees: ''
 
 ---
 
-**The issue occurs while working with:** (check one with "x")   
-- [ ] *app.storyblok.com (CMS - Interface)*   
-- [ ] *api.storyblok.com (CMS - Content Delivery API)*
-- [ ] *mapi.storyblok.com (CMS - Management API)*
-- [ ] *a.storyblok.com (CMS - Image Service)*
-- [ ] *storyblok.com (Website)*
-- [ ] *Other:* <!-- => If you've got an issue with on of our boilerplates or themes - please create an issue in the specific repo -->
 
 **Current behavior:**
 <!-- Describe how the bug manifests. -->

package/.github/workflows/release.yml

@@ -0,0 +1,23 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: 'yarn'
+      - name: Install dependencies
+        run: yarn
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_PUBLISH }}
+        run: npx semantic-release

package/README.md

@@ -10,9 +10,13 @@ You found an issue?<br>Tell us about it - <a href="https://github.com/storyblok/
 [![GitHub issues](https://img.shields.io/github/issues/storyblok/storyblok.svg?style=flat-square&v=1)](https://github.com/storyblok/storyblok/issues?q=is%3Aopen+is%3Aissue)
 [![GitHub closed issues](https://img.shields.io/github/issues-closed/storyblok/storyblok.svg?style=flat-square&v=1)](https://github.com/storyblok/storyblok/issues?q=is%3Aissue+is%3Aclosed)
 
+## BREAKING CHANGE
+
+We added the `region` option upon login. If you are using the CLI, please `logout` and `login` again providing your user region.
+
 ## Installation
 
-Make sure you've node `>= 9.11.0` installed.
+Make sure you have Node `>= 9.11.0` installed.
 
 ```sh
 $ npm i storyblok -g
@@ -28,6 +32,18 @@ Usage to kickstart a boilerplate, fieldtype or theme
 $ storyblok select
 ```
 
+### pull-languages
+
+Download your space's languages schema as json. This command will download 1 file.
+
+```sh
+$ storyblok pull-languages --space <SPACE_ID>
+```
+
+#### Options
+
+* `space`: your 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.
@@ -39,7 +55,6 @@ $ 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
 
@@ -52,7 +67,6 @@ $ storyblok push-components <SOURCE> --space <SPACE_ID> --region <REGION> --pres
 #### 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**
 
@@ -69,7 +83,6 @@ $ 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
@@ -86,6 +99,65 @@ Using a **path** to file
 $ storyblok push-components ./components.json --presets-source ./presets.json --space 67819
 ```
 
+### delete-component
+
+Delete a single component on your space.
+
+```sh
+storyblok delete-component <component> --space <SPACE_ID>
+```
+
+#### Parameters
+* `component`: The name or id of the component
+
+#### Options
+* `space_id`: the space where the command should be executed.
+
+#### Examples
+
+Delete a component on your space.
+```sh
+storyblok delete-component 111111 --space 67819
+```
+
+```sh
+storyblok delete-component teaser --space 67819
+```
+
+### delete-components
+
+Delete all components from your Space that occur in your Local JSON.
+Or delete those components on your Space that do not appear in the JSON. (`--reverse`)
+
+```sh
+storyblok delete-components <SOURCE> --space <SPACE_ID>
+```
+
+#### Parameters
+* `source`: can be a URL or path to JSON file.
+
+#### Options
+* `space_id`: the space where the command should be executed.
+* `reverse`: When passed as an argument, deletes only those components on your space that do not appear in the JSON.
+* `dryrun`: when passed as an argument, does not perform any changes on the given space.
+
+#### Examples
+
+Delete all components on a certain space that occur in your local JSON.
+```sh
+storyblok delete-components ./components.json --space 67819
+```
+
+Delete only those components which do not occur in your local json from your space.
+```sh
+storyblok delete-components ./components.json --space 67819 --reverse
+```
+
+To see the result in your console output but to not perform the command on your space, use the `--dryrun` argument.
+```sh
+storyblok delete-components ./components.json --space 67819 --reverse --dryrun
+```
+
 ### sync
 
 Sync components, folder, roles, datasources or stories between spaces
@@ -99,7 +171,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
-* `region`: your space region (default: `eu`). If your space was created under US region, you should use `us` instead.
 
 #### Examples
 
@@ -134,6 +205,19 @@ Login to the Storyblok cli
 ```sh
 $ storyblok login
 ```
+#### Options
+
+* `email`: your user's email address
+* `password`: your user's password
+* `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.
+
+### user
+
+Get the currently logged in user
+
+```sh
+$ storyblok user
+```
 
 ### generate-migration
 
@@ -149,7 +233,6 @@ It's important to note that the `component` and `field` parameters are required
 * `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
 
@@ -176,7 +259,6 @@ $ 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
 
@@ -196,6 +278,7 @@ $ storyblok rollback-migration --space 1234 --component Product --field title
 
 ### spaces
 
+
 List all spaces of the logged account
 
 ```sh

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "storyblok",
-  "version": "3.14.0",
+  "version": "3.16.0",
   "description": "A simple CLI to start Storyblok from your command line.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/storyblok/storyblok-cli.git"
+  },
   "keywords": [
     "storyblok",
     "cli",
@@ -55,5 +59,10 @@
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
     "jest": "^26.1.0"
+  },
+  "release": {
+    "branches": [
+      "master"
+    ]
   }
 }

package/pull_request_template.md

@@ -0,0 +1,29 @@
+<!--- Please provide a general summary of your changes in the title above -->
+
+## Pull request type
+
+Jira Link: [INT-](url)
+
+<!-- Please try to limit your pull request to one type, submit multiple pull requests if needed.
+
+Please check the type of change your PR introduces:-->
+
+- [ ] Bugfix
+- [ ] Feature
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes, no api changes)
+- [ ] Other (please describe):
+
+## How to test this PR
+
+<!-- Please provide the steps on how to test this PR. -->
+
+## What is the new behavior?
+
+<!-- Please describe the behavior or changes that are being added by this PR. -->
+
+-
+-
+-
+
+## Other information

package/src/cli.js

@@ -39,7 +39,7 @@ program
 program
   .command(COMMANDS.LOGIN)
   .description('Login to the Storyblok cli')
-  .action(async () => {
+  .action(async (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
@@ -54,6 +54,24 @@ program
     }
   })
 
+// getUser
+program
+  .command('user')
+  .description('Get the currently logged in user')
+  .action(async () => {
+    if (api.isAuthorized()) {
+      try {
+        const user = await api.getUser()
+        console.log(chalk.green('✓') + ` Hi ${user.friendly_name}, you current logged in with: ${creds.get().email}`)
+      } catch (e) {
+        console.log(chalk.red('X') + ` Please check if your current region matches your user's region: ${e.message}.`)
+      } finally {
+        process.exit(0)
+      }
+    }
+    console.log(chalk.red('X') + ' There is currently no user logged.')
+  })
+
 // logout
 program
   .command(COMMANDS.LOGOUT)
@@ -69,12 +87,36 @@ program
     }
   })
 
+// pull-languages
+program
+  .command('pull-languages')
+  .description("Download your space's languages schema as json")
+  .action(async () => {
+    console.log(`${chalk.blue('-')} Executing pull-languages task`)
+    const space = program.space
+    if (!space) {
+      console.log(chalk.red('X') + ' Please provide the space as argument --space YOUR_SPACE_ID.')
+      process.exit(0)
+    }
+
+    try {
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
+      api.setSpaceId(space)
+      await tasks.pullLanguages(api, { space })
+    } catch (e) {
+      console.log(chalk.red('X') + ' An error occurred when executing the pull-languages task: ' + e.message)
+      process.exit(1)
+    }
+  })
+
 // pull-components
 program
   .command(COMMANDS.PULL_COMPONENTS)
-  .option('-r, --region [value]', 'region', 'eu')
   .description("Download your space's components schema as json")
-  .action(async (source) => {
+  .action(async () => {
     console.log(`${chalk.blue('-')} Executing pull-components task`)
     const space = program.space
     if (!space) {
@@ -87,11 +129,6 @@ 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) {
@@ -103,7 +140,6 @@ program
 program
   .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`)
@@ -120,11 +156,6 @@ program
         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) {
@@ -132,6 +163,56 @@ program
     }
   })
 
+// delete-component
+program
+  .command('delete-component <component>')
+  .description('Delete a single component on your space.')
+  .action(async (component) => {
+    console.log(`${chalk.blue('-')} Executing delete-component task`)
+    const space = program.space
+    if (!space) {
+      console.log(chalk.red('X') + ' Please provide the space as argument --space YOUR_SPACE_ID.')
+      process.exit(0)
+    }
+    try {
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
+      api.setSpaceId(space)
+      await tasks.deleteComponent(api, { comp: component })
+    } catch (e) {
+      console.log(chalk.red('X') + ' An error occurred when executing the delete-component task: ' + e.message)
+      process.exit(1)
+    }
+  })
+
+// delete-components
+program
+  .command('delete-components <source>')
+  .description('Delete all components in your space that occur in your source file.')
+  .option('-r, --reverse', 'Delete all components in your space that do not appear in your source.', false)
+  .option('--dryrun', 'Does not perform any delete changes on your space.')
+  .action(async (source, options) => {
+    console.log(`${chalk.blue('-')} Executing delete-components task`)
+    const space = program.space
+    if (!space) {
+      console.log(chalk.red('X') + ' Please provide the space as argument --space YOUR_SPACE_ID.')
+      process.exit(0)
+    }
+    try {
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
+      api.setSpaceId(space)
+      await tasks.deleteComponents(api, { source, dryRun: !!options.dryrun, reversed: !!options.reverse })
+    } catch (e) {
+      console.log(chalk.red('X') + ' An error occurred when executing the delete-component task: ' + e.message)
+      process.exit(1)
+    }
+  })
+
 // scaffold
 program
   .command(COMMANDS.SCAFFOLD + ' <name>')
@@ -180,7 +261,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('-r, --region [value]', 'region', 'eu')
   .action(async (options) => {
     console.log(`${chalk.blue('-')} Sync data between spaces\n`)
 
@@ -192,12 +272,9 @@ program
       const {
         type,
         source,
-        target,
-        region
+        target
       } = options
 
-      api.setRegion(region)
-
       const _types = type.split(',') || []
       _types.forEach(_type => {
         if (!SYNC_TYPES.includes(_type)) {
@@ -226,6 +303,10 @@ program
   .description('Start a project quickly')
   .action(async () => {
     try {
+      if (!api.isAuthorized()) {
+        await api.processLogin()
+      }
+
       const space = program.space
       const questions = getQuestions('quickstart', { space }, api)
       const answers = await inquirer.prompt(questions)
@@ -239,7 +320,6 @@ program
 program
   .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) => {
@@ -259,9 +339,6 @@ program
         await api.processLogin()
       }
 
-      const { region } = options
-      api.setRegion(region)
-
       api.setSpaceId(space)
       await tasks.generateMigration(api, component, field)
     } catch (e) {
@@ -275,7 +352,6 @@ program
   .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')
@@ -362,7 +438,7 @@ program
 
       await tasks.listSpaces(api)
     } catch (e) {
-      console.log(chalk.red('X') + ' An error ocurred to listing sapces : ' + e.message)
+      console.log(chalk.red('X') + ' An error ocurred to listing spaces: ' + e.message)
       process.exit(1)
     }
   })
@@ -408,7 +484,7 @@ if (program.rawArgs.length <= 2) {
 
 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.')
+    console.log(chalk.yellow('/!\\') + ' If your space was created under US or CN region, you must provide the region us or cn upon login.')
   } else {
     console.log(chalk.red('X') + ' An error occurred when executing the ' + command + ' task: ' + e || e.message)
   }

package/src/constants.js

@@ -1,5 +1,6 @@
 const API_URL = 'https://api.storyblok.com/v1/'
 const US_API_URL = 'https://api-us.storyblok.com/v1/'
+const CN_API_URL = 'https://api.storyblokchina.cn/v1/'
 const LOGIN_URL = `${API_URL}users/login`
 const SIGNUP_URL = `${API_URL}users/signup`
 
@@ -33,5 +34,6 @@ module.exports = {
   API_URL,
   SYNC_TYPES,
   US_API_URL,
+  CN_API_URL,
   COMMANDS
 }

package/src/tasks/delete-component.js

@@ -0,0 +1,32 @@
+const chalk = require('chalk')
+const { getComponentsFromName } = require('./migrations/utils')
+
+/**
+ *
+ * @param api {Object}
+ * @param comp {String | Number}
+ * @param dryrun {Boolean}
+ * @returns {Promise<void>}
+ */
+const deleteComponent = async (api, { comp, dryrun = false }) => {
+  try {
+    let component
+    if (!isNaN(comp)) {
+      const { data } = await api.get(`components/${comp}`)
+      component = data.component
+    } else {
+      component = await getComponentsFromName(api, comp)
+    }
+    if (Object.keys(component).length === 0) {
+      return Promise.reject(new Error(`Component ${comp} not found.`))
+    }
+    if (!dryrun) {
+      await api.delete(`components/${component.id}`)
+    }
+    console.log(chalk.green('✓') + ' Component ' + chalk.blue(component.name) + ' deleted.')
+  } catch (e) {
+    console.error(`${chalk.red('X')} An error occurred in delete-component task.`)
+    return Promise.reject(new Error(e))
+  }
+}
+module.exports = deleteComponent

package/src/tasks/delete-components.js

@@ -0,0 +1,92 @@
+const chalk = require('chalk')
+const axios = require('axios')
+const fs = require('fs')
+const deleteComponent = require('./delete-component')
+
+const isUrl = source => source.indexOf('http') === 0
+
+/**
+ * Get the data from a local or remote JSON file
+ * @param {string} source 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) {
+    return {}
+  }
+
+  try {
+    if (isUrl(source)) {
+      return (await axios.get(source)).data
+    } else {
+      return JSON.parse(fs.readFileSync(source, 'utf8'))
+    }
+  } catch (err) {
+    console.error(`${chalk.red('X')} Can not load json file from ${source}`)
+    return Promise.reject(err)
+  }
+}
+
+/**
+ * Delete all components from your Space that occur in your Local JSON.
+ * @param api {Object}
+ * @param source {String}
+ * @param reversed {Boolean} Or delete those components on your Space that do not appear in the JSON.
+ * @param dryRun {Boolean}
+ * @returns {Promise<void>}
+ */
+const deleteComponents = async (api, { source, reversed = false, dryRun = false }) => {
+  try {
+    const sourceComponents = (await getDataFromSource(source)).components || []
+    if (!reversed) {
+      return deleteAllComponents(api, sourceComponents, dryRun)
+    }
+    const spaceComponents = await api.getComponents()
+    return deleteComponentsReversed(api, sourceComponents, spaceComponents, dryRun)
+  } catch (e) {
+    console.error(`${chalk.red('X')} Can not delete with invalid json - please provide a valid json file`)
+    return Promise.reject(new Error('Can not delete with invalid json - please provide a valid json file'))
+  }
+}
+
+/**
+ * Delete all given components
+ * @param api {Object}
+ * @param components {Object[]}
+ * @param dryrun {Boolean}
+ * @returns {Promise<void>}
+ */
+const deleteAllComponents = async (api, components, dryrun) => {
+  for (const c of components) {
+    await deleteComponentAndSkip(api, c, dryrun)
+  }
+}
+
+/**
+ * Delete all components which do not appear in components but in the space components
+ * @param api {Object}
+ * @param components {Object[]}
+ * @param spaceComponents {Object[]}
+ * @param dryrun {Boolean}
+ * @returns {Promise<void>}
+ */
+const deleteComponentsReversed = async (api, components, spaceComponents, dryrun) => {
+  const unifiedComps = components.concat([...spaceComponents])
+  const toDelete = unifiedComps
+    .filter((value, index, self) =>
+      self.findIndex((o, i) => o.id === value.id && i !== index) < 0)
+  console.log(chalk.blue('-') + ' Deleting all components which do not appear in the given source.')
+  for (const c of toDelete) {
+    await deleteComponentAndSkip(api, c, dryrun)
+  }
+}
+
+const deleteComponentAndSkip = async (api, c, dryrun) => {
+  try {
+    return await deleteComponent(api, { comp: c.id, dryrun: dryrun })
+  } catch (e) {
+    console.log(chalk.red('-') + ' Error deleting component ' + chalk.blue(c.name) + '! Skipped...')
+  }
+}
+
+module.exports = deleteComponents

package/src/tasks/index.js

@@ -3,10 +3,13 @@ module.exports = {
   scaffold: require('./scaffold'),
   quickstart: require('./quickstart'),
   pullComponents: require('./pull-components'),
+  pullLanguages: require('./pull-languages'),
   pushComponents: require('./push-components'),
   generateMigration: require('./migrations/generate'),
   runMigration: require('./migrations/run'),
   rollbackMigration: require('./migrations/rollback'),
   listSpaces: require('./list-spaces'),
-  importFiles: require('./import/import')
+  importFiles: require('./import/import'),
+  deleteComponent: require('./delete-component'),
+  deleteComponents: require('./delete-components')
 }

package/src/tasks/migrations/run.js

@@ -91,7 +91,7 @@ const runMigration = async (api, component, field, options = {}) => {
         const storyData = await api.getSingleStory(story.id)
         const oldContent = cloneDeep(storyData.content)
 
-        await processMigration(storyData.content, component, migrationFn)
+        await processMigration(storyData.content, component, migrationFn, story.full_slug)
 
         const isChangeContent = !isEqual(oldContent, storyData.content)