storyblok-backup 0.0.1 → 0.0.3

package/README.md

@@ -27,12 +27,13 @@ The script will fetch the following resources of a Storyblok space using the Man
 ## Installation
 
 ```shell
-# install globally
-$ npm install -g storyblok-backup
 
-# or simply run via npx
+# simply auto-download and run via npx
 $ npx storyblok-backup
 
+# or install globally
+$ npm install -g storyblok-backup
+
 # or install for project using npm
 $ npm install storyblok-backup
 
@@ -45,6 +46,8 @@ $ pnpm add storyblok-backup
 
 ## Usage
 
+Call `npx storyblok-backup` with the following options:
+
 ### Options
 
 ```text
@@ -69,7 +72,7 @@ $ pnpm add storyblok-backup
 npx storyblok-backup --token 1234567890abcdef --space 12345
 ```
 
-This will create the folder `./.output` and fetch all resources sorted into folders.
+This will create the folder `./.output/backup` and fetch all resources sorted into folders.
 
 ### Maximal example
 
@@ -79,12 +82,13 @@ npx storyblok-backup \
     --space 12345 \
     --with-asset-files \
     --output-dir ./my-dir \
+    --force \
     --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.
+This will create the folder `./my-dir/backup`, 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
 
@@ -100,15 +104,17 @@ on:
     - cron: '0 0 * * 0'
 
 jobs:
-  build:
+  backup:
     runs-on: ubuntu-latest
+    permissions:
+      actions: write
 
     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
+        run: npx storyblok-backup --token $STORYBLOK_OAUTH_TOKEN --space $STORYBLOK_SPACE_ID
 
       - name: Delete Old Artifacts
         uses: actions/github-script@v6
@@ -130,18 +136,17 @@ jobs:
                   })
                 })
 
-      - name: Copy Artifact
-        run: mkdir artifact && cp ./.output/*.zip artifact
-
       - name: Upload Artifact
         uses: actions/upload-artifact@v3
         with:
           name: weekly-backup
-          path: artifact
+          path: .output
 ```
 
 Make sure, to set the secrets `STORYBLOK_OAUTH_TOKEN` and `STORYBLOK_SPACE_ID` in your repository settings.
 
+Note that artifact manipulation requires the `actions: write` permission for the workflow. The workflow above has this permission set already.
+
 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)).

package/bin/storyblok-backup.mjs

@@ -38,8 +38,11 @@ MAXIMAL EXAMPLE
   $ npx storyblok-backup \\
       --token 1234567890abcdef \\
       --space 12345 \\
+      --with-asset-files \\
       --output-dir ./backup \\
-      --zip-prefix daily
+      --force \\
+      --create-zip \\
+      --zip-prefix daily \\
       --verbose
 `)
 	process.exit(0)
@@ -61,6 +64,8 @@ const verbose = 'verbose' in args
 
 const outputDir = args['output-dir'] || './.output'
 
+const backupDir = `${outputDir}/backup`
+
 if (fs.existsSync(outputDir) && !('force' in args)) {
 	console.log(
 		`Error: Output directory "${outputDir}" already exists. Use --force to delete and recreate it (POSSIBLY DANGEROUS!).`
@@ -102,7 +107,7 @@ if (fs.existsSync(outputDir)) {
 }
 
 // Create output directories
-fs.mkdirSync(outputDir, { recursive: true })
+fs.mkdirSync(backupDir, { recursive: true })
 
 const resources = [
 	'stories',
@@ -121,13 +126,22 @@ const resources = [
 	'workflows',
 	'releases',
 ]
-resources.forEach((resource) => fs.mkdirSync(`${outputDir}/${resource}`))
+resources.forEach((resource) => fs.mkdirSync(`${backupDir}/${resource}`))
 
 // Function to perform a default fetch
-const defaultFetch = async (type, folder, fileField) => {
+const defaultFetch = async (type, folder, fileField, fileFieldObject) => {
 	await StoryblokMAPI.getAll(`spaces/${spaceId}/${type}`)
 		.then((items) => {
-			items.forEach((item) => writeJson(folder, item[fileField], item))
+			if (type === 'datasources') {
+				console.log(items)
+			}
+			items.forEach((item) =>
+				writeJson(
+					folder,
+					fileFieldObject ? item[fileFieldObject][fileField] : item[fileField],
+					item
+				)
+			)
 		})
 		.catch((error) => {
 			throw error
@@ -136,7 +150,7 @@ const defaultFetch = async (type, folder, fileField) => {
 
 // Function to write a file
 const writeJson = (folder, file, content) => {
-	let outputFile = outputDir
+	let outputFile = backupDir
 	if (folder !== null) {
 		outputFile += `/${folder}`
 	}
@@ -152,7 +166,7 @@ const writeJson = (folder, file, content) => {
 // Function to download a file
 const downloadFile = async (type, name, url) => {
 	const res = await fetch(url)
-	const outputFile = `${outputDir}/${type}/${name}`
+	const outputFile = `${backupDir}/${type}/${name}`
 	const fileStream = fs.createWriteStream(outputFile, { flags: 'wx' })
 	await finished(Readable.fromWeb(res.body).pipe(fileStream))
 	if (verbose) console.log(`Written file ${outputFile}`)
@@ -244,7 +258,7 @@ await defaultFetch('tasks', 'tasks', 'id')
 
 // Fetch all activities
 console.log(`Fetching activities`)
-await defaultFetch('activities', 'activities', 'id')
+await defaultFetch('activities', 'activities', 'id', 'activity')
 
 // Fetch all presets
 console.log(`Fetching presets`)
@@ -274,7 +288,7 @@ await defaultFetch('releases', 'releases', 'id')
 if ('create-zip' in args) {
 	console.log(`Creating zip file`)
 	await zipLib
-		.archiveFolder(outputDir, filePath)
+		.archiveFolder(backupDir, filePath)
 		.then(
 			function () {
 				console.log(`Backup file '${filePath}' successfully created.`)

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "storyblok-backup",
-	"version": "0.0.1",
+	"version": "0.0.3",
 	"description": "npx CLI tool to create a full backup of a Storyblok space",
 	"scripts": {
 		"upgrade": "npx npm-check-updates -i -u && pnpm install",