storyblok 3.28.0 → 3.28.1

package/.eslintrc.js

@@ -0,0 +1,23 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true,
+    'jest/globals': true
+  },
+  extends: [
+    'standard'
+  ],
+  globals: {
+    Atomics: 'readonly',
+    SharedArrayBuffer: 'readonly'
+  },
+  parserOptions: {
+    ecmaVersion: 2018
+  },
+  plugins: [
+    'jest'
+  ],
+  rules: {
+  }
+}

package/.github/.dependabot.yml

@@ -0,0 +1,13 @@
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+# https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    allow:
+      - dependency-name: "@storyblok/region-helper"
+    reviewers:
+      - "storyblok/plugins-team"

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve the CLI
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+
+**Current behavior:**
+<!-- Describe how the bug manifests. -->
+
+**Expected behavior:**
+<!-- Describe what the behavior would be without the bug. -->
+
+**Steps to reproduce:**
+<!-- If you are able to illustrate the bug or feature request with an example, please provide steps to reproduce and if possible also a demo.-->
+
+**Related code:**
+
+```
+insert any relevant code here
+```
+
+**Other information:**
+<!-- List any other information that is relevant to your issue. Stack traces, related issues, suggestions on how to fix, Stack Overflow links, forum links, etc. -->

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: 20.11
+          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/.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

@@ -1,6 +1,6 @@
 <p align="center">
   <h1 align="center">Storyblok CLI</h1>
-  <p align="center">A simple CLI for scaffolding <a href="https://www.storyblok.com" target="_blank">Storyblok</a> projects and fieldtypes.</p>
+  <p align="center">A simple CLI for scaffolding <a href="https://www.storyblok.com?utm_source=github.com&utm_medium=readme&utm_campaign=storyblok" target="_blank">Storyblok</a> projects and fieldtypes.</p>
 </p>
 
 [![npm](https://img.shields.io/npm/v/storyblok.svg)](https://www.npmjs.com/package/storyblok)
@@ -554,92 +554,6 @@ module.exports = function (block) {
 }
 ```
 
-## Typescript
-It is possible to generate Typescript type definitions for your Storyblok components. The type definitions are based on the components' JSON Schema that can be retrieved with the [pull-components](#pull-components) command.
-
-### generate-typescript-typedefs
-
-Generate a file with the type definitions for the specified components' JSON Schemas.
-
-```sh
-$ storyblok generate-typescript-typedefs
-  --sourceFilePaths <PATHS>
-  --destinationFilePath <PATH>
-  --typeNamesPrefix <STRING>
-  --typeNamesSuffix <STRING>
-  --JSONSchemaToTSOptionsPath <PATH>
-  --customFieldTypesParserPath <PATH>
-```
-
-#### Options
-
-* `sourceFilePaths` <sub>(alias `source`)</sub> : Path(s) to the components JSON file(s) as comma separated values
-* `destinationFilePath` <sub>(alias `target`) *optional*</sub> : Path to the Typescript file that will be generated (*default*: `storyblok-component-types.d.ts`)
-* `typeNamesPrefix` <sub>(alias `titlePrefix`) *optional*</sub> : A prefix that will be prepended to all the names of the generated types
-* `typeNamesSuffix` <sub>(alias `titleSuffix`) *optional*</sub> : A suffix that will be appended to all the names of the generated types (*default*: `Storyblok`)
-* `JSONSchemaToTSOptionsPath` <sub>(alias `compilerOptions`) *optional*</sub> : Path to a JSON file with a list of options supported by `json-schema-to-typescript`
-* `customFieldTypesParserPath` <sub>(alias `customTypeParser`) *optional*</sub> : Path to the parser file for Custom Field Types
-
-#### Examples
-
-```sh
-# Generate typedefs for the components retrieved for the space `12345` via the `storyblok pull-components` command
-$ storyblok generate-typescript-typedefs --sourceFilePaths ./components.12345.json
-
-# Generate typedefs for multiple components sources
-$ storyblok generate-typescript-typedefs --sourceFilePaths ./fooComponent-12345.json,./barComponent-12345.json
-
-# Custom path for the typedefs file
-$ storyblok generate-typescript-typedefs --sourceFilePaths ./components.12345.json --destinationFilePath ./types/my-custom-type-file.d.ts
-
-# Provide customized options for the JSON-schema-to-typescript lib
-$ storyblok generate-typescript-typedefs --sourceFilePaths ./components.12345.json --JSONSchemaToTSOptionsPath ./PathToJSONFileWithCustomOptions.json
-
-# Provide a custom field types parser
-$ storyblok generate-typescript-typedefs --sourceFilePaths ./components.12345.json --customFieldTypesParserPath ./customFieldTypesParser.js
-
-```
-
-##### JSON Schema to Typescript options
-This script uses the `json-schema-to-typescript` library under the hood. Values of the [JSON Schema to Typescript options](https://www.npmjs.com/package/json-schema-to-typescript#options) can be customized providing a JSON file to the `JSONSchemaToTSOptionsPath`.
-
-The default values used for the `storyblok generate-typescript-typedefs` command are the same defaults for the library except for two properties:
-* `bannerComment` - The default value is `""` to remove noise from the generated Typedefs file
-* `unknownAny` - The default value is `false` because it can help a smoother Typescript adoption on a JS project
-
-Example `JSONSchemaToTSOptions` JSON file to remove `additionalProperties` from the generated type definitions:
-
-```json
-{
-  "additionalProperties": false,
-}
-```
-
-##### Custom Field Types parser
-Storyblok [Custom Field Types](https://www.storyblok.com/docs/plugins/field-plugins/introduction) do not have inherent JSONSchema definitions. To overcome this issue, you can provide a path to a script exporting a parser function that should render a [JSONSchema Node](https://json-schema.org/learn/getting-started-step-by-step#define-properties) for each of your Custom Field Types. The parser function should be exported as a default export, like in the following example:
-```js
-export default function (key, obj) {
-  switch (obj.field_type) {
-    case 'my-custom-field-type-name':
-      return {
-        [key]: {
-          type: 'object',
-          properties: {
-            color: { type: 'string' }
-          },
-          required: ['color']
-        }
-      }
-    default:
-      return {}
-  }
-}
-```
-
-
-
-
-
 ## You're looking for a headstart?
 
 Check out our guides for client side apps (VueJS, Angular, React, ...), static site (Jekyll, NuxtJs, ...), dynamic site examples (Node, PHP, Python, Laravel, ...) on our [Getting Started](https://www.storyblok.com/getting-started) page.

package/__mocks__/axios.js

@@ -0,0 +1,31 @@
+const { USERS_ROUTES, EMAIL_TEST, PASSWORD_TEST, TOKEN_TEST } = require('../tests/constants')
+
+const isCredCorrects = (email, pass) => {
+  return email === EMAIL_TEST && pass === PASSWORD_TEST
+}
+
+const axios = {
+  post: jest.fn((path, data) => {
+    const { email, password } = data || {}
+
+    if (path === USERS_ROUTES.LOGIN && isCredCorrects(email, password)) {
+      return Promise.resolve({
+        data: {
+          access_token: TOKEN_TEST
+        }
+      })
+    }
+
+    if (path === USERS_ROUTES.SIGNUP && isCredCorrects(email, password)) {
+      return Promise.resolve({
+        data: {
+          access_token: TOKEN_TEST
+        }
+      })
+    }
+
+    return Promise.reject(new Error('Incorrect access'))
+  })
+}
+
+module.exports = axios

package/__mocks__/fs-extra.js

@@ -0,0 +1,63 @@
+const fs = jest.genMockFromModule('fs-extra')
+
+let mockFiles = Object.create(null)
+
+// used by pull-components.spec.js
+const pathExists = jest.fn((key) => {
+  return !!mockFiles[key]
+})
+
+const existsSync = jest.fn((key) => {
+  return `${process.cwd()}/migrations/rollback`
+})
+
+const readdirSync = jest.fn((key) => {
+  return ['rollback_product_title.json', 'rollback_product_text.json']
+})
+
+const readFile = jest.fn((path) => {
+  mockFiles = path
+  return Promise.resolve(JSON.stringify([
+    {
+      "id": 0,
+      "full_slug": "another-post",
+      "content": {
+        "_uid": "5647c21f-8813-4f8a-ad38-b9f74e0e7c89",
+        "text": "Donec tortor mauris, mollis vel pretium vitae, lacinia nec sapien. Donec erat neque, ullamcorper tincidunt iaculis sit amet, pharetra bibendum ipsum. Nunc mattis risus ac ante consequat nec pulvinar neque molestie. Etiam interdum nunc at metus lacinia non varius erat dignissim. Integer elementum, felis id facilisis vulputate, ipsum tellus venenatis dui, at blandit nibh massa in dolor. Cras a ultricies sapien. Vivamus adipiscing feugiat pharetra.",
+        "image": "https://a.storyblok.com/f/51376/884x750/3bff01d851/international.svg",
+        "title": "test",
+        "category": "news",
+        "component": "Product"
+      }
+    }
+  ]))
+})
+
+const outputFile = jest.fn((path, data, fn) => {
+  mockFiles[path] = data
+  return Promise.resolve(true)
+})
+
+const __clearMockFiles = () => {
+  mockFiles = Object.create(null)
+}
+
+const __setMockFiles = (mock) => {
+  mockFiles = mock
+}
+
+fs.pathExists = pathExists
+
+fs.existsSync = existsSync
+
+fs.readdirSync = readdirSync
+
+fs.readFile = readFile
+
+fs.outputFile = outputFile
+
+fs.__clearMockFiles = __clearMockFiles
+
+fs.__setMockFiles = __setMockFiles
+
+module.exports = fs

package/__mocks__/fs.js

@@ -0,0 +1,51 @@
+const fs = jest.genMockFromModule('fs')
+
+const mockFiles = Object.create(null)
+
+// used by pull-components.spec.js
+const writeFile = jest.fn((key, data, _) => {
+  mockFiles[key] = data
+})
+
+// used by scaffold.spec.js
+const writeFileSync = jest.fn((key, data) => {
+  mockFiles[key] = data
+})
+
+// used by push-components.spec.js
+const readFileSync = jest.fn((key) => {
+  if (key === 'components.js') {
+    return JSON.stringify({
+      components: [
+        {
+          name: 'doc',
+          display_name: null,
+          created_at: '2018-04-06T12:26:58.539Z',
+          id: 66594,
+          schema: {
+            content: {
+              type: 'markdown'
+            },
+            summary: {
+              type: 'textarea'
+            }
+          },
+          image: null,
+          preview_field: null,
+          is_root: true,
+          is_nestable: false
+        }
+      ]
+    })
+  }
+
+  return {}
+})
+
+fs.writeFile = writeFile
+
+fs.readFileSync = readFileSync
+
+fs.writeFileSync = writeFileSync
+
+module.exports = fs

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.28.0",
+  "version": "3.28.1",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",
@@ -12,21 +12,15 @@
     "node",
     "javascript"
   ],
-  "main": "./dist/cli.mjs",
-  "files": [
-    "dist/**"
-  ],
+  "main": "src/cli.js",
   "bin": {
-    "storyblok": "./dist/cli.mjs"
+    "storyblok": "src/cli.js"
   },
-  "type": "module",
   "scripts": {
-    "build": "unbuild",
-    "dev": "npm run build && ./dist/cli.mjs",
     "lint": "eslint src/",
     "lint:fix": "eslint src/ --fix",
-    "test:unit": "node --experimental-vm-modules ./node_modules/.bin/jest --silent",
-    "test:coverage": "node --experimental-vm-modules ./node_modules/.bin/jest --coverage"
+    "test:unit": "jest --silent",
+    "test:coverage": "jest --coverage"
   },
   "author": "Dominik Angerer <dominikangerer1@gmail.com>, Alexander Feiglstorfer <delooks@gmail.com>",
   "license": "MIT",
@@ -42,7 +36,6 @@
     "fs-extra": "^9.0.1",
     "git-clone": "^0.1.0",
     "inquirer": "^7.3.2",
-    "json-schema-to-typescript": "^13.1.2",
     "lodash": "^4.17.21",
     "netrc": "0.1.4",
     "on-change": "^2.0.1",
@@ -50,7 +43,7 @@
     "p-series": "^2.1.0",
     "path": "^0.12.7",
     "simple-uuid": "^0.0.1",
-    "storyblok-js-client": "^6.7.1",
+    "storyblok-js-client": "^5.14.0",
     "update-notifier": "^5.1.0",
     "xml-js": "^1.6.11"
   },
@@ -66,16 +59,11 @@
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-promise": "^4.2.1",
     "eslint-plugin-standard": "^4.0.1",
-    "jest": "^29.7.0",
-    "typescript": "^5.3.3",
-    "unbuild": "^2.0.0"
+    "jest": "^26.1.0"
   },
   "release": {
     "branches": [
       "master"
     ]
-  },
-  "prettier": {
-    "printWidth": 120
   }
 }

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