storyblok-backup 0.1.2 → 0.3.0

package/.env.example

@@ -1,3 +1,3 @@
-STORYBLOK_OAUTH_TOKEN=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6
-STORYBLOK_SPACE_ID=123456
+STORYBLOK_OAUTH_TOKEN=a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7r8s9t0u1v2w3x4y5z6
+STORYBLOK_SPACE_ID=123456
 STORYBLOK_REGION=eu

package/README.md

@@ -34,7 +34,6 @@ The backup script will fetch the following resources of a Storyblok space using
 The restore script is able to individually restore the resources from the backup files (via update or create) with the following exceptions:
 
 - Assets: Only updating asset-resource-data is supported. Creating assets and updating asset-files is not supported.
-- Tasks: Currently not supported due to missing fields returned from management API.
 - Field types: Currently not supported
 - Workflow stage changes: No update possible.
 - Access Tokens: Creating access tokens from backup makes no sense, since it will result in a new token-string.
@@ -81,6 +80,29 @@ Call `npx storyblok-backup` with the following options:
                     - 'ca': Canada
                     - 'cn': China
                     Alternatively, you can set the STORYBLOK_REGION environment variable.
+--types <types>     Comma separated list of resource-types to backup. Defaults to all.
+                    Possible values are:
+                    - 'stories'
+                    - 'collaborators'
+                    - 'components'
+                    - 'component-groups'
+                    - 'assets'
+                    - 'asset-folders'
+                    - 'internal-tags'
+                    - 'datasources'
+                    - 'space'
+                    - 'space-roles'
+                    - 'tasks'
+                    - 'activities'
+                    - 'presets'
+                    - 'field-types'
+                    - 'webhooks'
+                    - 'workflow-stages'
+                    - 'workflow-stage-changes'
+                    - 'workflows'
+                    - 'releases'
+                    - 'pipeline-branches'
+                    - 'access-tokens'
 --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!)
@@ -108,7 +130,8 @@ This will create the folder `./.output/backup` and fetch all resources sorted in
 npx storyblok-backup \
     --token 1234567890abcdef \
     --space 12345 \
-    --region ap \\
+    --region ap \
+    --types "stories,components" \
     --with-asset-files \
     --output-dir ./my-dir \
     --force \
@@ -170,6 +193,8 @@ jobs:
         with:
           name: weekly-backup
           path: .output
+          include-hidden-files: true
+          if-no-files-found: error
 ```
 
 Make sure, to set the secrets `STORYBLOK_OAUTH_TOKEN` and `STORYBLOK_SPACE_ID` in your repository settings.
@@ -214,17 +239,22 @@ Call `npx storyblok-restore` with the following options:
                     - 'datasource-entries'
                     - 'space'
                     - 'space-role'
+                    - 'task'
                     - 'preset'
                     - 'webhook'
                     - 'workflow'
                     - 'workflow-stage'
                     - 'release'
                     - 'pipeline-branch'
-                    - 'access-token
+                    - 'access-token'
 --file <file>       (required) File of resource to restore.
 --publish           Perform a publish after restore of a story (default=false).
 --create            Create a new resource instead of updating (default=false).
                     Not supported for assets.
+--propagate         Propagate new story UUID to referencing stories (default=false).
+                    Usable with create and stories. A create results in a new ID and UUID.
+                    This option will update all stories referencing the old
+                    UUID (as stated in the backup-json) with the new one.
 --id <file>         (required if type=datasource-entries and create is set)
                     ID of datasource the entries belong to.
 --verbose           Will show detailed result of the restore process.
@@ -250,6 +280,7 @@ npx storyblok-restore \
   --file ./.output/backup/123456789.json \
   --publish \
   --create \
+  --propagate \
   --verbose
 ```
 

package/bin/storyblok-backup.mjs

@@ -13,6 +13,30 @@ const startTime = performance.now()
 
 dotenvx.config({ quiet: true })
 
+let resourceTypes = [
+	'stories',
+	'collaborators',
+	'components',
+	'component-groups',
+	'assets',
+	'asset-folders',
+	'internal-tags',
+	'datasources',
+	'space',
+	'space-roles',
+	'tasks',
+	'activities',
+	'presets',
+	'field-types',
+	'webhooks',
+	'workflow-stages',
+	'workflow-stage-changes',
+	'workflows',
+	'releases',
+	'pipeline-branches',
+	'access-tokens',
+]
+
 const args = minimist(process.argv.slice(2))
 
 if ('help' in args) {
@@ -33,12 +57,15 @@ OPTIONS
                       - 'ca': Canada
                       - 'cn': China
                       Alternatively, you can set the STORYBLOK_REGION environment variable.
-  --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
+  --types <types>     Comma separated list of resource-types to backup (default=all).
+                      Possible values are:
+                      - '${resourceTypes.join("'\n                      - '")}'
+  --with-asset-files  Downloads all files (assets) of the space (default=false).
+  --output-dir <dir>  Directory to write the backup to (default=./.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'.
+  --create-zip        Create a zip file of the backup (default=false).
+  --zip-prefix <dir>  Prefix for the zip file. (default='backup').
                       (The suffix will automatically be the current date.)
   --verbose           Will show detailed output for every file written.
   --help              Show this help
@@ -51,6 +78,7 @@ MAXIMAL EXAMPLE
       --token 1234567890abcdef \\
       --space 12345 \\
       --region ap \\
+      --types "stories,components" \\
       --with-asset-files \\
       --output-dir ./my-dir \\
       --force \\
@@ -87,6 +115,19 @@ if ('region' in args || process.env.STORYBLOK_REGION) {
 	}
 }
 
+if ('types' in args) {
+	const typesToBackup = args.types.split(',')
+	for (const type of typesToBackup) {
+		if (!resourceTypes.includes(type)) {
+			console.log(
+				`Error: Invalid type parameter stated. "${type}" is not a valid resource type. Use --help to find out more.`
+			)
+			process.exit(1)
+		}
+	}
+	resourceTypes = typesToBackup
+}
+
 const verbose = 'verbose' in args
 
 const outputDir = args['output-dir'] || './.output'
@@ -132,51 +173,30 @@ if (fs.existsSync(outputDir)) {
 	fs.rmSync(outputDir, { recursive: true, force: true })
 }
 
-// Create output directories
+// Create output directories (except for space, since this json will be saved in the root)
 fs.mkdirSync(backupDir, { recursive: true })
-
-const resources = [
-	'stories',
-	'collaborators',
-	'components',
-	'component-groups',
-	'assets',
-	'asset-folders',
-	'internal-tags',
-	'datasources',
-	'space-roles',
-	'tasks',
-	'activities',
-	'presets',
-	'field-types',
-	'webhooks',
-	'workflow-stages',
-	'workflow-stage-changes',
-	'workflows',
-	'releases',
-	'pipeline-branches',
-	'access-tokens',
-]
-resources.forEach((resource) => fs.mkdirSync(`${backupDir}/${resource}`))
+resourceTypes.forEach(
+	(resource) => resource === 'space' || fs.mkdirSync(`${backupDir}/${resource}`)
+)
 
 // Function to perform a default fetch
-const defaultFetch = async (type, folder, fileField, fileFieldObject) => {
-	await StoryblokMAPI.getAll(`spaces/${spaceId}/${type}`)
-		.then((items) => {
-			if (type === 'datasources') {
-				console.log(items)
-			}
-			items.forEach((item) =>
-				writeJson(
-					folder,
-					fileFieldObject ? item[fileFieldObject][fileField] : item[fileField],
-					item
+const defaultFetch = async (endpoint, type, fileField, fileFieldObject) => {
+	if (resourceTypes.includes(type)) {
+		console.log(`Fetching ${type}`)
+		await StoryblokMAPI.getAll(`spaces/${spaceId}/${endpoint}`)
+			.then((items) => {
+				items.forEach((item) =>
+					writeJson(
+						type,
+						fileFieldObject ? item[fileFieldObject][fileField] : item[fileField],
+						item
+					)
 				)
-			)
-		})
-		.catch((error) => {
-			throw error
-		})
+			})
+			.catch((error) => {
+				throw error
+			})
+	}
 }
 
 // Function to write a file
@@ -204,138 +224,129 @@ const downloadFile = async (type, name, url) => {
 }
 
 // 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
-	})
+if (resourceTypes.includes('space')) {
+	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) => {
-					delete response.data.story.preview_token
-					writeJson('stories', story.id, response.data.story)
-				})
-				.catch((error) => {
-					throw error
-				})
-		}
-	})
-	.catch((error) => {
-		throw error
-	})
+if (resourceTypes.includes('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) => {
+						delete response.data.story.preview_token
+						writeJson('stories', story.id, response.data.story)
+					})
+					.catch((error) => {
+						throw error
+					})
+			}
+		})
+		.catch((error) => {
+			throw error
+		})
+}
 
 // Fetch all collaborators
-console.log(`Fetching collaborators`)
 await defaultFetch('collaborators', 'collaborators', 'user_id')
 
 // 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)
+if (resourceTypes.includes('assets')) {
+	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
-	})
+		})
+		.catch((error) => {
+			throw error
+		})
+}
 
 // Fetch all asset-folders
-console.log(`Fetching asset-folders`)
 await defaultFetch('asset_folders', 'asset-folders', 'id')
 
 // Fetch all internal-tags
-console.log(`Fetching internal-tags`)
 await defaultFetch('internal_tags', 'internal-tags', '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
+if (resourceTypes.includes('datasources')) {
+	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,
 				})
-		}
-	})
-	.catch((error) => {
-		throw error
-	})
+					.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', 'activity')
 
 // 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 webhooks
-console.log(`Fetching webhooks`)
 await defaultFetch('webhook_endpoints', 'webhooks', 'id')
 
 // 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')
 
 // Fetch all pipeline branches
-console.log(`Fetching pipeline branches`)
 await defaultFetch('branches', 'pipeline-branches', 'id')
 
 // Fetch all access tokens
-console.log(`Fetching access tokens`)
 await defaultFetch('api_keys', 'access-tokens', 'id')
 
 // Create zip file

package/bin/storyblok-restore.mjs

@@ -22,7 +22,7 @@ const resourceTypes = [
 	'datasource-entries',
 	'space',
 	'space-role',
-	//'task',  // Currently not supported due to missing fields returned from management API
+	'task',
 	'preset',
 	// 'field-type',
 	'webhook',
@@ -54,11 +54,15 @@ OPTIONS
                       - 'cn': China
                       Alternatively, you can set the STORYBLOK_REGION environment variable.
   --type <type>       (required) Type of resource to restore. Possible values are:
-                      - '${resourceTypes.join("'\n                      - '")}
+                      - '${resourceTypes.join("'\n                      - '")}'
   --file <file>       (required) File of resource to restore.
   --publish           Perform a publish after restore of a story (default=false).
   --create            Create a new resource instead of updating (default=false).
                       Not supported for assets.
+  --propagate         Propagate new story UUID to referencing stories (default=false).
+                      Usable with create and stories. A create results in a new ID and UUID.
+                      This option will update all stories referencing the old
+                      UUID (as stated in the backup-json) with the new one.
   --id <file>         (required if type=datasource-entries and create is set)
                       ID of datasource the entries belong to.
   --verbose           Will show detailed result of the restore process.
@@ -76,6 +80,7 @@ MAXIMAL EXAMPLE
       --file ./.output/backup/123456789.json \\
       --publish \\
       --create \\
+      --propagate \\
       --verbose
 `)
 	process.exit(0)
@@ -137,6 +142,18 @@ const publish = 'publish' in args
 
 const create = 'create' in args
 
+const propagate = 'propagate' in args
+if (propagate && !create) {
+	console.log('Error: Propagate is only usable with create. Use --help to find out more.')
+	process.exit(1)
+}
+if (propagate && args.type !== 'story') {
+	console.log(
+		'Error: Propagate is only usable with story resources. Use --help to find out more.'
+	)
+	process.exit(1)
+}
+
 // Init Management API
 const StoryblokMAPI = new StoryblokClient({
 	oauthToken: oauthToken,
@@ -144,7 +161,7 @@ const StoryblokMAPI = new StoryblokClient({
 })
 
 // Function to perform a default single resource restore
-const defaultSingleRestore = async (type, id, params) => {
+const defaultSingleRestore = async (type, id, params, forceUpdate) => {
 	if (publish) {
 		params.publish = 1
 	}
@@ -158,14 +175,15 @@ const defaultSingleRestore = async (type, id, params) => {
 		url = `${url}/${type}`
 	}
 
-	if (create) {
-		await StoryblokMAPI.post(url, params)
+	if (create && !forceUpdate) {
+		return await StoryblokMAPI.post(url, params)
 			.then((response) => {
 				console.log(`Created "${type}" resource.`)
 				if (verbose) {
 					console.log('Result:')
 					console.log(response.data)
 				}
+				return response.data
 			})
 			.catch((error) => {
 				throw error
@@ -174,13 +192,14 @@ const defaultSingleRestore = async (type, id, params) => {
 		if (id) {
 			url = `${url}/${id}`
 		}
-		await StoryblokMAPI.put(url, params)
+		return await StoryblokMAPI.put(url, params)
 			.then((response) => {
 				console.log(`Updated "${type}" resource with id "${id}".`)
 				if (verbose) {
 					console.log('Result:')
 					console.log(response.data)
 				}
+				return response.data
 			})
 			.catch((error) => {
 				throw error
@@ -193,7 +212,35 @@ const resource = JSON.parse(fs.readFileSync(args.file, 'utf8'))
 switch (args.type) {
 	case 'story':
 		delete resource.updated_at
-		await defaultSingleRestore('stories', resource.id, { story: resource })
+		const result = await defaultSingleRestore('stories', resource.id, { story: resource })
+		if (create && propagate) {
+			const oldUuid = resource.uuid
+			const newUuid = result.story.uuid
+			const newId = result.story.id
+			console.log(`Propagating UUID change from "${oldUuid}" to "${newUuid}":`)
+			const referencingStories = await StoryblokMAPI.getAll(`spaces/${spaceId}/stories`, {
+				reference_search: oldUuid,
+				excluding_ids: [newId],
+			})
+			for (const referencingStory of referencingStories) {
+				const fullReferencingStoryResult = await StoryblokMAPI.get(
+					`spaces/${spaceId}/stories/${referencingStory.id}`
+				)
+				await defaultSingleRestore(
+					'stories',
+					referencingStory.id,
+					{
+						story: JSON.parse(
+							JSON.stringify(fullReferencingStoryResult.data.story).replaceAll(
+								oldUuid,
+								newUuid
+							)
+						),
+					},
+					true
+				)
+			}
+		}
 		break
 	case 'collaborator':
 		await defaultSingleRestore(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "storyblok-backup",
-	"version": "0.1.2",
+	"version": "0.3.0",
 	"description": "npx CLI tool to create a full backup of a Storyblok space and restore single resources from it.",
 	"scripts": {
 		"upgrade": "npx npm-check-updates -i -u && pnpm install",