storyblok 3.30.0 → 3.31.0

package/README.md

@@ -254,6 +254,7 @@ $ storyblok sync --type <COMMAND> --source <SPACE_ID> --target <SPACE_ID>
 * `filter`: sync stories based on the given filter. Required Options: Required options: `--keys`, `--operations`, `--values`
 * `keys`: Multiple keys should be separated by comma. Example: `--keys key1,key2`, `--keys key1`
 * `operations`: Operations to be used for filtering. Can be: `is`, `in`, `not_in`, `like`, `not_like`, `any_in_array`, `all_in_array`, `gt_date`, `lt_date`, `gt_int`, `lt_int`, `gt_float`, `lt_float`. Multiple operations should be separated by comma.
+* `components-full-sync`: If used, the CLI will override the full component object when synching across spaces.
 
 #### Examples
 

package/dist/cli.mjs

@@ -1039,6 +1039,7 @@ class SyncComponents {
     this.client = api.getClient();
     this.presetsLib = new PresetsLib({ oauthToken: options.oauthToken, targetSpaceId: this.targetSpaceId });
     this.componentsGroups = options.componentsGroups;
+    this.componentsFullSync = options.componentsFullSync;
   }
   async sync() {
     const syncComponentGroupsInstance = new SyncComponentGroups({
@@ -1171,7 +1172,10 @@ class SyncComponents {
     return this.client.put(`spaces/${spaceId}/components/${componentId}`, payload);
   }
   mergeComponents(sourceComponent, targetComponent = {}) {
-    const data = {
+    const data = this.componentsFullSync ? {
+      // This should be the default behavior in a major future version
+      ...sourceComponent
+    } : {
       ...sourceComponent,
       ...targetComponent
     };
@@ -1490,6 +1494,7 @@ const SyncSpaces = {
     this.targetSpaceId = options.target;
     this.oauthToken = options.token;
     this.componentsGroups = options._componentsGroups;
+    this.componentsFullSync = options._componentsFullSync;
     this.startsWith = options.startsWith;
     this.filterQuery = options.filterQuery;
   },
@@ -1670,7 +1675,8 @@ const SyncSpaces = {
       sourceSpaceId: this.sourceSpaceId,
       targetSpaceId: this.targetSpaceId,
       oauthToken: this.oauthToken,
-      componentsGroups: this.componentsGroups
+      componentsGroups: this.componentsGroups,
+      componentsFullSync: this.componentsFullSync
     });
     try {
       await syncComponentsInstance.sync();
@@ -3677,7 +3683,7 @@ program.command(COMMANDS.SELECT).description("Usage to kickstart a boilerplate,
 program.command(COMMANDS.SYNC).description("Sync schemas, roles, folders and stories between spaces").requiredOption(
   "--type <TYPE>",
   "Define what will be sync. Can be components, folders, stories, datasources or roles"
-).requiredOption("--source <SPACE_ID>", "Source space id").requiredOption("--target <SPACE_ID>", "Target space id").option("--starts-with <STARTS_WITH>", "Sync only stories that starts with the given string").option("--filter", "Enable filter options to sync only stories that match the given filter. Required options: --keys; --operations; --values").option("--keys <KEYS>", "Field names in your story object which should be used for filtering. Multiple keys should separated by comma.").option("--operations <OPERATIONS>", "Operations to be used for filtering. Can be: is, in, not_in, like, not_like, any_in_array, all_in_array, gt_date, lt_date, gt_int, lt_int, gt_float, lt_float. Multiple operations should be separated by comma.").option("--values <VALUES>", "Values to be used for filtering. Any string or number. If you want to use multiple values, separate them with a comma. Multiple values should be separated by comma.").option("--components-groups <UUIDs>", "Synchronize components based on their group UUIDs separated by commas").action(async (options) => {
+).requiredOption("--source <SPACE_ID>", "Source space id").requiredOption("--target <SPACE_ID>", "Target space id").option("--starts-with <STARTS_WITH>", "Sync only stories that starts with the given string").option("--filter", "Enable filter options to sync only stories that match the given filter. Required options: --keys; --operations; --values").option("--keys <KEYS>", "Field names in your story object which should be used for filtering. Multiple keys should separated by comma.").option("--operations <OPERATIONS>", "Operations to be used for filtering. Can be: is, in, not_in, like, not_like, any_in_array, all_in_array, gt_date, lt_date, gt_int, lt_int, gt_float, lt_float. Multiple operations should be separated by comma.").option("--values <VALUES>", "Values to be used for filtering. Any string or number. If you want to use multiple values, separate them with a comma. Multiple values should be separated by comma.").option("--components-groups <UUIDs>", "Synchronize components based on their group UUIDs separated by commas").option("--components-full-sync", "Synchronize components by overriding any property from source to target").action(async (options) => {
   console.log(`${chalk.blue("-")} Sync data between spaces
 `);
   try {
@@ -3693,9 +3699,11 @@ program.command(COMMANDS.SYNC).description("Sync schemas, roles, folders and sto
       keys,
       operations,
       values,
-      componentsGroups
+      componentsGroups,
+      componentsFullSync
     } = options;
     const _componentsGroups = componentsGroups ? componentsGroups.split(",") : null;
+    const _componentsFullSync = !!componentsFullSync;
     const filterQuery = filter ? buildFilterQuery(keys, operations, values) : void 0;
     const token = creds.get().token || null;
     const _types = type.split(",") || [];
@@ -3711,7 +3719,8 @@ program.command(COMMANDS.SYNC).description("Sync schemas, roles, folders and sto
       source,
       startsWith,
       filterQuery,
-      _componentsGroups
+      _componentsGroups,
+      _componentsFullSync
     });
     console.log("\n" + chalk.green("\u2713") + " Sync data between spaces successfully completed");
   } catch (e) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "storyblok",
-  "version": "3.30.0",
+  "version": "3.31.0",
   "description": "A simple CLI to start Storyblok from your command line.",
   "repository": {
     "type": "git",