storyblok-backup 0.0.1

package/.editorconfig

@@ -0,0 +1,13 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = tabs
+indent_size = tab
+tab_width = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

package/.eslintrc.cjs

@@ -0,0 +1,11 @@
+module.exports = {
+	root: true,
+	env: {
+		node: true,
+	},
+	parserOptions: {
+		sourceType: 'module',
+		ecmaVersion: 'latest',
+	},
+	extends: ['plugin:prettier/recommended'],
+}

package/.lintignore

@@ -0,0 +1,2 @@
+node_modules
+pnpm-lock.yaml

package/.prettierrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+	semi: false,
+	singleQuote: true,
+	useTabs: true,
+	tabWidth: 4,
+	printWidth: 100,
+	trailingComma: 'es5',
+	overrides: [
+		{
+			files: ['**/*.md', '**/*.yaml', '**/*.yml'],
+			options: {
+				tabWidth: 2,
+			},
+		},
+	],
+}

package/.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+	"recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"]
+}

package/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+	"editor.tabSize": 3,
+	"editor.insertSpaces": true,
+	"editor.detectIndentation": true,
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+	"eslint.enable": true,
+	"editor.quickSuggestions": {
+		"strings": true
+	}
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 webflorist
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,151 @@
+# Storyblok Backup CLI
+
+[![npm version](https://img.shields.io/npm/v/storyblok-backup.svg)](https://www.npmjs.com/package/storyblok-backup)
+[![license](https://img.shields.io/github/license/webflorist/storyblok-backup)](https://github.com/webflorist/storyblok-backup/blob/main/LICENSE)
+
+A npx CLI tool to create a full backup of a space of the [Storyblok CMS](https://www.storyblok.com).
+
+The script will fetch the following resources of a Storyblok space using the Management API and archive them in a zip file:
+
+- Stories
+- Components
+- Component groups
+- Assets (optionally incl. original files)
+- Asset folders
+- Datasources (incl. entries)
+- Space
+- Space Roles
+- Tasks
+- Activities
+- Presets
+- Field types
+- Workflow stages
+- Workflow stage changes
+- Custom workflows
+- Releases
+
+## Installation
+
+```shell
+# install globally
+$ npm install -g storyblok-backup
+
+# or simply run via npx
+$ npx storyblok-backup
+
+# or install for project using npm
+$ npm install storyblok-backup
+
+# or install for project using yarn
+$ yarn add storyblok-backup
+
+# or install for project using pnpm
+$ pnpm add storyblok-backup
+```
+
+## Usage
+
+### Options
+
+```text
+--token <token>     (required) Personal OAuth access token created
+                    in the account settings of a Stoyblok user.
+                    (NOT the Access Token of a Space!)
+--space <space_id>  (required) ID of the space to backup
+--with-asset-files  Downloads all files (assets) of the space. Defaults to false.
+--output-dir <dir>  Directory to write the backup to. Defaults to ./.output
+                    (ATTENTION: Will fail if the directory already exists!)
+--force             Force deletion and recreation of existing output directory.
+--create-zip        Create a zip file of the backup. Defaults to false.
+--zip-prefix <dir>  Prefix for the zip file. Defaults to 'backup'.
+                    (The suffix will automatically be the current date.)
+--verbose           Will show detailed output for every file written.
+--help              Show this help
+```
+
+### Minimal example
+
+```shell
+npx storyblok-backup --token 1234567890abcdef --space 12345
+```
+
+This will create the folder `./.output` and fetch all resources sorted into folders.
+
+### Maximal example
+
+```shell
+npx storyblok-backup \
+    --token 1234567890abcdef \
+    --space 12345 \
+    --with-asset-files \
+    --output-dir ./my-dir \
+    --create-zip \
+    --zip-prefix daily \
+    --verbose
+```
+
+This will create the folder `./my-dir`, fetch all resources (incl. the original file assets) sorted into folders, zip them to `./my-dir/daily-Y-m-d-H-i-s.zip`, and log every written file to console.
+
+## Continuous Integration
+
+You can e.g. use this script to create periodic backups of Storyblok spaces using GitHub Actions and artifacts.
+
+Here would be an example for a weekly backup, that removes the artifacts/backups from previous runs and uploads a new one:
+
+```yaml
+name: Weekly Storyblok Backup
+
+on:
+  schedule:
+    - cron: '0 0 * * 0'
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Perform Backup
+        env:
+          STORYBLOK_OAUTH_TOKEN: ${{ secrets.STORYBLOK_OAUTH_TOKEN }}
+          STORYBLOK_SPACE_ID: ${{ secrets.STORYBLOK_SPACE_ID }}
+        run: npx storyblok-backup --token $STORYBLOK_OAUTH_TOKEN --space $STORYBLOK_SPACE_ID --create-zip
+
+      - name: Delete Old Artifacts
+        uses: actions/github-script@v6
+        id: artifact
+        with:
+          script: |
+            const res = await github.rest.actions.listArtifactsForRepo({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+            })
+
+            res.data.artifacts
+                .filter(({ name }) => name === 'weekly-backup')
+                .forEach(({ id }) => {
+                  github.rest.actions.deleteArtifact({
+                      owner: context.repo.owner,
+                      repo: context.repo.repo,
+                      artifact_id: id,
+                  })
+                })
+
+      - name: Copy Artifact
+        run: mkdir artifact && cp ./.output/*.zip artifact
+
+      - name: Upload Artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: weekly-backup
+          path: artifact
+```
+
+Make sure, to set the secrets `STORYBLOK_OAUTH_TOKEN` and `STORYBLOK_SPACE_ID` in your repository settings.
+
+If you create multiple workflows for daily, weekly and monthly backups, by changing the cron-schedule and the two occurrences of the artifact name `weekly-backup`, you will always have exactly one daily, weekly and monthly backup.
+
+Also keep in mind, that there is a limit on artifact storage and runner minutes ([see GitHub docs](https://docs.github.com/en/billing/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes)).
+
+## License
+
+This package is open-sourced software licensed under the [MIT license](https://github.com/webflorist/storyblok-backup/blob/main/LICENSE.).

package/bin/storyblok-backup.mjs

@@ -0,0 +1,294 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+import fs from 'fs'
+import { Readable } from 'stream'
+import { finished } from 'stream/promises'
+import zipLib from 'zip-lib'
+import minimist from 'minimist'
+import StoryblokClient from 'storyblok-js-client'
+import { performance } from 'perf_hooks'
+
+const startTime = performance.now()
+
+const args = minimist(process.argv.slice(2))
+
+if ('help' in args) {
+	console.log(`USAGE
+  $ npx storyblok-backup
+  
+OPTIONS
+  --token <token>     (required) Personal OAuth access token created
+                      in the account settings of a Stoyblok user.
+                      (NOT the Access Token of a Space!)
+  --space <space_id>  (required) ID of the space to backup
+  --with-asset-files  Downloads all files (assets) of the space. Defaults to false.
+  --output-dir <dir>  Directory to write the backup to. Defaults to ./.output
+                      (ATTENTION: Will fail if the directory already exists!)
+  --force             Force deletion and recreation of existing output directory.
+  --create-zip        Create a zip file of the backup. Defaults to false.
+  --zip-prefix <dir>  Prefix for the zip file. Defaults to 'backup'.
+                      (The suffix will automatically be the current date.)
+  --verbose           Will show detailed output for every file written.
+  --help              Show this help
+
+MINIMAL EXAMPLE
+  $ npx storyblok-backup --token 1234567890abcdef --space 12345
+
+MAXIMAL EXAMPLE
+  $ npx storyblok-backup \\
+      --token 1234567890abcdef \\
+      --space 12345 \\
+      --output-dir ./backup \\
+      --zip-prefix daily
+      --verbose
+`)
+	process.exit(0)
+}
+
+if (!('token' in args)) {
+	console.log(
+		'Error: State your oauth token via the --token argument. Use --help to find out more.'
+	)
+	process.exit(1)
+}
+
+if (!('space' in args)) {
+	console.log('Error: State your space id via the --space argument. Use --help to find out more.')
+	process.exit(1)
+}
+
+const verbose = 'verbose' in args
+
+const outputDir = args['output-dir'] || './.output'
+
+if (fs.existsSync(outputDir) && !('force' in args)) {
+	console.log(
+		`Error: Output directory "${outputDir}" already exists. Use --force to delete and recreate it (POSSIBLY DANGEROUS!).`
+	)
+	process.exit(1)
+}
+
+const spaceId = args.space
+
+const filePrefix = args['zip-prefix'] || 'backup'
+
+const fileName =
+	[
+		filePrefix,
+		new Date().getFullYear(),
+		new Date().getMonth().toString().padStart(2, '0'),
+		new Date().getDay().toString().padStart(2, '0'),
+		new Date().getHours().toString().padStart(2, '0'),
+		new Date().getMinutes().toString().padStart(2, '0'),
+		new Date().getSeconds().toString().padStart(2, '0'),
+	].join('-') + '.zip'
+
+const filePath = `${outputDir}/${fileName}`
+
+console.log(`Creating backup for space ${spaceId}:`)
+console.log(`Output dir: ${outputDir}`)
+if ('create-zip' in args) {
+	console.log(`Output zip: ${filePath}`)
+}
+
+// Init Management API
+const StoryblokMAPI = new StoryblokClient({
+	oauthToken: args.token,
+})
+
+// Remove existing output directory
+if (fs.existsSync(outputDir)) {
+	fs.rmSync(outputDir, { recursive: true, force: true })
+}
+
+// Create output directories
+fs.mkdirSync(outputDir, { recursive: true })
+
+const resources = [
+	'stories',
+	'components',
+	'component-groups',
+	'assets',
+	'asset-folders',
+	'datasources',
+	'space-roles',
+	'tasks',
+	'activities',
+	'presets',
+	'field-types',
+	'workflow-stages',
+	'workflow-stage-changes',
+	'workflows',
+	'releases',
+]
+resources.forEach((resource) => fs.mkdirSync(`${outputDir}/${resource}`))
+
+// Function to perform a default fetch
+const defaultFetch = async (type, folder, fileField) => {
+	await StoryblokMAPI.getAll(`spaces/${spaceId}/${type}`)
+		.then((items) => {
+			items.forEach((item) => writeJson(folder, item[fileField], item))
+		})
+		.catch((error) => {
+			throw error
+		})
+}
+
+// Function to write a file
+const writeJson = (folder, file, content) => {
+	let outputFile = outputDir
+	if (folder !== null) {
+		outputFile += `/${folder}`
+	}
+	outputFile += `/${file}.json`
+	fs.writeFile(outputFile, JSON.stringify(content), (error) => {
+		if (error) {
+			throw error
+		}
+	})
+	if (verbose) console.log(`Written file ${outputFile}`)
+}
+
+// Function to download a file
+const downloadFile = async (type, name, url) => {
+	const res = await fetch(url)
+	const outputFile = `${outputDir}/${type}/${name}`
+	const fileStream = fs.createWriteStream(outputFile, { flags: 'wx' })
+	await finished(Readable.fromWeb(res.body).pipe(fileStream))
+	if (verbose) console.log(`Written file ${outputFile}`)
+}
+
+// Fetch space info
+console.log(`Fetching space`)
+await StoryblokMAPI.get(`spaces/${spaceId}/`)
+	.then((space) => {
+		writeJson(null, `space-${spaceId}`, space.data.space)
+	})
+	.catch((error) => {
+		throw error
+	})
+
+// Fetch all stories
+console.log(`Fetching stories`)
+await StoryblokMAPI.getAll(`spaces/${spaceId}/stories`)
+	.then(async (stories) => {
+		for (const story of stories) {
+			await StoryblokMAPI.get(`spaces/${spaceId}/stories/${story.id}`)
+				.then((response) => writeJson('stories', story.id, response.data.story))
+				.catch((error) => {
+					throw error
+				})
+		}
+	})
+	.catch((error) => {
+		throw error
+	})
+
+// Fetch all components
+console.log(`Fetching components`)
+await defaultFetch('components', 'components', 'name')
+
+// Fetch all component-groups
+console.log(`Fetching component-groups`)
+await defaultFetch('component_groups', 'component-groups', 'id')
+
+// Fetch all assets (including files)
+console.log(`Fetching assets`)
+await StoryblokMAPI.getAll(`spaces/${spaceId}/assets`)
+	.then(async (assets) => {
+		for (const asset of assets) {
+			writeJson('assets', asset.id, asset)
+			if ('with-asset-files' in args) {
+				const fileExtension = asset.filename.split('.').at(-1)
+				const fileName = asset.id + '.' + fileExtension
+				await downloadFile('assets', fileName, asset.filename)
+			}
+		}
+	})
+	.catch((error) => {
+		throw error
+	})
+
+// Fetch all asset-folders
+console.log(`Fetching asset-folders`)
+await defaultFetch('asset_folders', 'asset-folders', 'id')
+
+// Fetch all datasources (including entries)
+console.log(`Fetching datasources`)
+await StoryblokMAPI.getAll(`spaces/${spaceId}/datasources`)
+	.then(async (datasources) => {
+		for (const datasource of datasources) {
+			writeJson('datasources', datasource.id, datasource)
+			await StoryblokMAPI.getAll(`spaces/${spaceId}/datasource_entries`, {
+				datasource_id: datasource.id,
+			})
+				.then((dateSourceEntries) =>
+					writeJson('datasources', datasource.id + '_entries', dateSourceEntries)
+				)
+				.catch((error) => {
+					throw error
+				})
+		}
+	})
+	.catch((error) => {
+		throw error
+	})
+
+// Fetch all space roles
+console.log(`Fetching space roles`)
+await defaultFetch('space_roles', 'space-roles', 'id')
+
+// Fetch all tasks
+console.log(`Fetching tasks`)
+await defaultFetch('tasks', 'tasks', 'id')
+
+// Fetch all activities
+console.log(`Fetching activities`)
+await defaultFetch('activities', 'activities', 'id')
+
+// Fetch all presets
+console.log(`Fetching presets`)
+await defaultFetch('presets', 'presets', 'id')
+
+// Fetch all field-types
+console.log(`Fetching field-types`)
+await defaultFetch('field_types', 'field-types', 'name')
+
+// Fetch all workflow-stages
+console.log(`Fetching workflow-stages`)
+await defaultFetch('workflow_stages', 'workflow-stages', 'id')
+
+// Fetch all workflow-stage-changes
+console.log(`Fetching workflow-stage-changes`)
+await defaultFetch('workflow_stage_changes', 'workflow-stage-changes', 'id')
+
+// Fetch all workflows
+console.log(`Fetching workflows`)
+await defaultFetch('workflows', 'workflows', 'id')
+
+// Fetch all releases
+console.log(`Fetching releases`)
+await defaultFetch('releases', 'releases', 'id')
+
+// Create zip file
+if ('create-zip' in args) {
+	console.log(`Creating zip file`)
+	await zipLib
+		.archiveFolder(outputDir, filePath)
+		.then(
+			function () {
+				console.log(`Backup file '${filePath}' successfully created.`)
+			},
+			function (err) {
+				throw err
+			}
+		)
+		.catch((error) => {
+			throw error
+		})
+}
+
+const endTime = performance.now()
+
+console.log(`Backup successfully created in ${Math.round((endTime - startTime) / 1000)} seconds.`)
+process.exit(0)

package/package.json

@@ -0,0 +1,48 @@
+{
+	"name": "storyblok-backup",
+	"version": "0.0.1",
+	"description": "npx CLI tool to create a full backup of a Storyblok space",
+	"scripts": {
+		"upgrade": "npx npm-check-updates -i -u && pnpm install",
+		"lint:js": "eslint --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --ignore-path .lintignore .",
+		"lintfix:js": "pnpm lint:js --fix",
+		"lint:prettier": "prettier --ignore-path ./.lintignore --check .",
+		"lintfix:prettier": "prettier --ignore-path ./.lintignore --write --list-different .",
+		"lint": "pnpm lint:js && pnpm lint:prettier",
+		"lintfix": "pnpm lintfix:js && pnpm lintfix:prettier"
+	},
+	"bin": {
+		"storyblok-backup": "bin/storyblok-backup.mjs"
+	},
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/webflorist/storyblok-backup.git"
+	},
+	"keywords": [
+		"storyblok",
+		"cms",
+		"backup",
+		"cli",
+		"node",
+		"script",
+		"npx"
+	],
+	"author": "Gerald Buttinger <gerald@code.florist>",
+	"license": "MIT",
+	"bugs": {
+		"url": "https://github.com/webflorist/storyblok-backup/issues"
+	},
+	"homepage": "https://github.com/webflorist/storyblok-backup#readme",
+	"devDependencies": {
+		"eslint": "^8.49.0",
+		"eslint-config-prettier": "^9.0.0",
+		"eslint-plugin-prettier": "^5.0.0",
+		"prettier": "^3.0.3"
+	},
+	"dependencies": {
+		"archiver": "^6.0.1",
+		"minimist": "^1.2.8",
+		"storyblok-js-client": "^6.0.0",
+		"zip-lib": "^0.7.3"
+	}
+}