storyblok 3.23.0 → 3.24.1

package/.github/workflows/unit-tests.yml

@@ -0,0 +1,22 @@
+name: 'Unit Tests Production'
+
+on:
+  pull_request:
+    branches:
+      - 'master' 
+
+jobs:
+  unit-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'yarn'
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Clear jest cache
+        run: yarn test:unit --clearCache
+      - name: Run unit tests
+        run: yarn test:unit --silent --ci

package/README.md

@@ -192,7 +192,25 @@ storyblok delete-components <SOURCE> --space <SPACE_ID>
 ```
 
 #### 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**
+
+```sh
+$ storyblok push-components https://raw.githubusercontent.com/storyblok/nuxtdoc/master/seed.components.json --space 67819
+```
+
+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_id`: the space where the command should be executed.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.23.0",
+  "version": "3.24.1",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",
@@ -19,7 +19,7 @@
   "scripts": {
     "lint": "eslint src/",
     "lint:fix": "eslint src/ --fix",
-    "test": "jest --silent",
+    "test:unit": "jest --silent",
     "test:coverage": "jest --coverage"
   },
   "author": "Dominik Angerer <dominikangerer1@gmail.com>, Alexander Feiglstorfer <delooks@gmail.com>",

package/src/tasks/delete-components.js

@@ -7,26 +7,46 @@ 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
+ * @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]
+}
+
 /**
  * Delete all components from your Space that occur in your Local JSON.
  * @param api {Object}
@@ -37,7 +57,8 @@ const getDataFromSource = async (source) => {
  */
 const deleteComponents = async (api, { source, reversed = false, dryRun = false }) => {
   try {
-    const sourceComponents = (await getDataFromSource(source)).components || []
+    const rawComponents = (await getDataFromPath(source)) || []
+    const sourceComponents = createContentList(rawComponents, 'components')
     if (!reversed) {
       return deleteAllComponents(api, sourceComponents, dryRun)
     }
@@ -71,19 +92,17 @@ const deleteAllComponents = async (api, components, dryrun) => {
  * @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)
+  const toDeleteSpaceComponents = spaceComponents
+    .filter(spaceComponent => components.findIndex(o => o.name === spaceComponent.name) < 0)
   console.log(chalk.blue('-') + ' Deleting all components which do not appear in the given source.')
-  for (const c of toDelete) {
+  for (const c of toDeleteSpaceComponents) {
     await deleteComponentAndSkip(api, c, dryrun)
   }
 }
 
 const deleteComponentAndSkip = async (api, c, dryrun) => {
   try {
-    return await deleteComponent(api, { comp: c.id, dryrun: dryrun })
+    return await deleteComponent(api, { comp: c.name, dryrun: dryrun })
   } catch (e) {
     console.log(chalk.red('-') + ' Error deleting component ' + chalk.blue(c.name) + '! Skipped...')
   }

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

@@ -19,6 +19,9 @@ describe('testing deleteComponents', () => {
         const id = path.split('/')[1]
         return Promise.resolve({ data: { component: components[id] } })
       }),
+      getComponents: jest.fn(() => {
+        return components
+      }),
       delete: jest.fn(() => Promise.resolve())
     }
     return deleteComponents(api, { source, reversed: false }).then(() => {
@@ -29,18 +32,16 @@ describe('testing deleteComponents', () => {
   it('api.deleteComponents reverse', () => {
     const source = 'components.js'
     const components = FAKE_COMPONENTS()
-    const spy = jest.spyOn(fs, 'readFileSync').mockReturnValue(JSON.stringify({
-      components
-    }))
+    const copy = [...components]
+    copy.splice(2, 1)
+    const spy = jest.spyOn(fs, 'readFileSync').mockReturnValue(JSON.stringify([...copy]))
     const api = {
       get: jest.fn((path) => {
         const id = path.split('/')[1]
         return Promise.resolve({ data: { component: components[id] } })
       }),
       getComponents: jest.fn(() => {
-        const copy = [...components]
-        copy.splice(3, 1)
-        return copy
+        return components
       }),
       delete: jest.fn(() => Promise.resolve())
     }

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

@@ -40,7 +40,7 @@ describe('testing pullComponents', () => {
     }
 
     const options = {
-      compFileName: SPACE
+      fileName: SPACE
     }
 
     const expectFileName = `components.${SPACE}.json`
@@ -71,7 +71,7 @@ describe('testing pullComponents', () => {
     }
 
     const options = {
-      space: SPACE
+      fileName: SPACE
     }
 
     const expectComponentFileName = `components.${SPACE}.json`
@@ -108,7 +108,7 @@ describe('testing pullComponents', () => {
     }
 
     const options = {
-      space: SPACE,
+      fileName: SPACE,
       separateFiles: true
     }
 
@@ -117,7 +117,7 @@ describe('testing pullComponents', () => {
         expect(fs.writeFile.mock.calls.length).toBe(FAKE_COMPONENTS().length)
 
         for (const comp in FAKE_COMPONENTS()) {
-          const compFileName = `${FAKE_COMPONENTS()[comp].name}-${SPACE}.json`
+          const fileName = `${FAKE_COMPONENTS()[comp].name}-${SPACE}.json`
           let data = FAKE_COMPONENTS()[comp]
           const [compPath, compData] = fs.writeFile.mock.calls[comp]
 
@@ -125,7 +125,7 @@ describe('testing pullComponents', () => {
             data = { ...FAKE_COMPONENTS()[comp], component_group_name: '' }
           }
 
-          expect(compPath).toBe(`./${compFileName}`)
+          expect(compPath).toBe(`./${fileName}`)
           expect(JSON.parse(compData)).toEqual(data)
         }
       })