storyblok 3.17.1 → 3.18.0

package/.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 18
           cache: 'yarn'
       - name: Install dependencies
         run: yarn
@@ -20,4 +20,4 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_PUBLISH }}
-        run: npx semantic-release
+        run: npx semantic-release

package/README.md

@@ -5,8 +5,8 @@
 
 [![npm](https://img.shields.io/npm/v/storyblok.svg)](https://www.npmjs.com/package/storyblok)
 [![npm](https://img.shields.io/npm/dt/storyblok.svg)](ttps://img.shields.io/npm/dt/storyblok.svg)
-[![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)
+[![GitHub issues](https://img.shields.io/github/issues/storyblok/storyblok-cli.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-cli.svg?style=flat-square&v=1)](https://github.com/storyblok/storyblok-cli/issues?q=is%3Aissue+is%3Aclosed)
 
 ## BREAKING CHANGE
 
@@ -22,6 +22,43 @@ $ npm i storyblok -g
 
 ## Commands
 
+
+### login
+
+Login to the Storyblok cli
+
+```sh
+$ storyblok login
+```
+#### Login options
+
+##### Options for Login with email and password
+* `email`: your user's email address
+* `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
+
+**For Both login options you nedd to pass the region**
+
+* `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.
+
+### logout
+
+Logout from the Storyblok cli
+
+```sh
+$ storyblok logout
+```
+### user
+
+Get the currently logged in user
+
+```sh
+$ storyblok user
+```
+
+
 ### select
 
 Usage to kickstart a boilerplate, fieldtype or theme
@@ -188,35 +225,6 @@ Create a space in Storyblok and select the boilerplate to use
 $ storyblok quickstart
 ```
 
-### logout
-
-Logout from the Storyblok cli
-
-```sh
-$ storyblok logout
-```
-
-### login
-
-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
 
 Create a migration file (with the name `change_<COMPONENT>_<FIELD>.js`) inside the `migrations` folder. Check **Migrations** section to more details

package/package.json

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

package/src/cli.js

@@ -16,7 +16,7 @@ const { getQuestions, lastStep, api, creds } = require('./utils')
 const { SYNC_TYPES, COMMANDS } = require('./constants')
 
 clear()
-console.log(chalk.cyan(figlet.textSync('Storyblok')))
+console.log(chalk.cyan(figlet.textSync('storyblok')))
 console.log()
 console.log()
 console.log('Hi, welcome to the Storyblok CLI')

package/src/constants.js

@@ -1,6 +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 CN_API_URL = 'https://app.storyblokchina.cn/v1/'
 const LOGIN_URL = `${API_URL}users/login`
 const SIGNUP_URL = `${API_URL}users/signup`
 

package/src/utils/api.js

@@ -35,7 +35,8 @@ module.exports = {
     return path
   },
 
-  async login (email, password, region) {
+  async login (content) {
+    const { email, password, region } = content
     try {
       const response = await axios.post(`${this.apiSwitcher(region)}users/login`, {
         email: email,
@@ -68,10 +69,10 @@ module.exports = {
           otp_attempt: code
         })
 
-        return this.persistCredentials(email, newResponse.data || {}, region)
+        return this.persistCredentials(email, newResponse.data.access_token || {}, region)
       }
 
-      return this.persistCredentials(email, data, region)
+      return this.persistCredentials(email, data.access_token, region)
     } catch (e) {
       return Promise.reject(e)
     }
@@ -92,27 +93,37 @@ module.exports = {
     }
   },
 
-  persistCredentials (email, data, region = 'eu') {
-    const token = this.extractToken(data)
+  persistCredentials (email, token = null, region = 'eu') {
     if (token) {
       this.oauthToken = token
       creds.set(email, token, region)
 
-      return Promise.resolve(data)
+      return Promise.resolve(token)
     }
     return Promise.reject(new Error('The code could not be authenticated.'))
   },
 
   async processLogin () {
     try {
-      const questions = getQuestions('login')
-      const { email, password, region } = await inquirer.prompt(questions)
+      let content = {}
+      await inquirer
+        .prompt(getQuestions('login-strategy'))
+        .then(async ({ strategy }) => {
+          content = await inquirer.prompt(getQuestions(strategy))
+        })
+        .catch((error) => {
+          console.log(error)
+        })
 
-      const data = await this.login(email, password, region)
+      if (!content.token) {
+        await this.login(content)
+      } else {
+        await this.loginWithToken(content)
+      }
 
       console.log(chalk.green('✓') + ' Log in successfully! Token has been added to .netrc file.')
 
-      return Promise.resolve(data)
+      return Promise.resolve(content)
     } catch (e) {
       if (e.response && e.response.data && e.response.data.error) {
         console.error(chalk.red('X') + ' An error ocurred when login the user: ' + e.response.data.error)
@@ -125,8 +136,20 @@ module.exports = {
     }
   },
 
-  extractToken (data) {
-    return data.access_token
+  async loginWithToken (content) {
+    const { token, region } = content
+    try {
+      const { data } = await axios.get(`${this.apiSwitcher(region)}users/me`, {
+        headers: {
+          Authorization: token
+        }
+      })
+
+      this.persistCredentials(data.user.email, token, region)
+      return data.user
+    } catch (e) {
+      return Promise.reject(e)
+    }
   },
 
   logout (unauthorized) {

package/src/utils/get-questions.js

@@ -1,5 +1,24 @@
 const getOptions = (subCommand, argv = {}, api = {}) => {
   let email = ''
+  const moreOptions = [
+    'delete-templates',
+    'pull-components',
+    'push-components',
+    'scaffold'
+  ]
+  const regionInput = {
+    type: 'input',
+    name: 'region',
+    message: 'Enter your user\'s region (us, eu or cn):',
+    validate: function (value) {
+      const flagList = ['us', 'cn', 'eu']
+      if (flagList.indexOf(value) > -1) {
+        return true
+      }
+
+      return 'Please enter a valid region: us, eu or cn'
+    }
+  }
 
   if (subCommand === 'select') {
     return [
@@ -103,7 +122,29 @@ const getOptions = (subCommand, argv = {}, api = {}) => {
     ]
   }
 
-  if (subCommand === 'login') {
+  if (subCommand === 'login-strategy') {
+    return [
+      {
+        type: 'list',
+        name: 'strategy',
+        message: 'Select the login strategy: ',
+        choices: [
+          {
+            name: 'With email and password (Common users with storyblok account)',
+            value: 'login-with-email',
+            short: 'Email'
+          },
+          {
+            name: 'With Token (Most recommended for SSO users)',
+            value: 'login-with-token',
+            short: 'Token'
+          }
+        ]
+      }
+    ]
+  }
+
+  if (subCommand === 'login-with-email') {
     return [
       {
         type: 'input',
@@ -129,29 +170,27 @@ const getOptions = (subCommand, argv = {}, api = {}) => {
           return 'Please enter a valid password:'
         }
       },
+      regionInput
+    ]
+  }
+
+  if (subCommand === 'login-with-token') {
+    return [
       {
         type: 'input',
-        name: 'region',
-        message: 'Enter your user\'s region (us, eu or cn):',
+        name: 'token',
+        message: 'Enter your token:',
         validate: function (value) {
-          const flagList = ['us', 'cn', 'eu']
-          if (flagList.indexOf(value) > -1) {
+          if (value.length > 0) {
             return true
           }
-
-          return 'Please enter a valid region: us, eu or cn'
+          return 'Please enter a valid token:'
         }
-      }
+      },
+      regionInput
     ]
   }
 
-  const moreOptions = [
-    'delete-templates',
-    'pull-components',
-    'push-components',
-    'scaffold'
-  ]
-
   if (moreOptions.indexOf(subCommand) > -1) {
     const loginQuestions = [
       {