storyblok 3.29.0 → 3.30.0

package/README.md

@@ -250,6 +250,10 @@ $ storyblok sync --type <COMMAND> --source <SPACE_ID> --target <SPACE_ID>
 * `type`: describe the command type to execute. Can be: `folders`, `components`, `stories`, `datasources` or `roles`. It's possible pass multiple types separated by comma (`,`).
 * `source`: the source space to use to sync
 * `target`: the target space to use to sync
+* `starts-with`: sync only stories that starts with the given string
+* `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.
 
 #### Examples
 
@@ -260,6 +264,15 @@ $ storyblok sync --type components --source 00001 --target 00002
 # Sync components and stories from `00001` space to `00002` space
 $ storyblok sync --type components,stories --source 00001 --target 00002
 
+# Sync only stories that starts with `myStartsWithString` from `00001` space to `00002` space
+$ storyblok sync --type stories --source 00001 --target 00002 --starts-with myStartsWithString
+
+# Sync only stories with a category field like `reference` from `00001` space to `00002` space
+$ storyblok sync --type stories --source 00001 --target 00002 --filter --keys category --operations like --values reference
+
+# Sync only stories with a category field like `reference` and a name field not like `demo` from `00001` space to `00002` space
+$ storyblok sync --type stories --source 00001 --target 00002 --filter --keys category,name --operations like,not_like --values reference,demo
+
 ```
 
 ### quickstart

package/dist/cli.mjs

@@ -23,6 +23,8 @@ import fs$1 from 'fs-extra';
 import csvReader from 'fast-csv';
 import xmlConverter from 'xml-js';
 import { compile } from 'json-schema-to-typescript';
+import { dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
 
 const getOptions = (subCommand, argv = {}, api = {}) => {
   let email = "";
@@ -782,6 +784,28 @@ const saveFileFactory = async (fileName, content, path = "./") => {
   });
 };
 
+const buildFilterQuery = (keys, operations, values) => {
+  const operators = ["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"];
+  if (!keys || !operations || !values) {
+    throw new Error("Filter options are required: --keys; --operations; --values");
+  }
+  const _keys = keys.split(",");
+  const _operations = operations.split(",");
+  const _values = values.split(",");
+  if (_keys.length !== _operations.length || _keys.length !== _values.length) {
+    throw new Error("The number of keys, operations and values must be the same");
+  }
+  const invalidOperators = _operations.filter((o) => !operators.includes(o));
+  if (invalidOperators.length) {
+    throw new Error("Invalid operator(s) applied for filter: " + invalidOperators.join(" "));
+  }
+  const filterQuery = {};
+  _keys.forEach((key, index) => {
+    filterQuery[key] = { [_operations[index]]: _values[index] };
+  });
+  return filterQuery;
+};
+
 class SyncComponentGroups {
   /**
    * @param {{ sourceSpaceId: string, targetSpaceId: string, oauthToken: string }} options
@@ -1461,11 +1485,13 @@ const SyncSpaces = {
   init(options) {
     const { api } = options;
     console.log(chalk.green("\u2713") + " Loading options");
+    this.client = api.getClient();
     this.sourceSpaceId = options.source;
     this.targetSpaceId = options.target;
     this.oauthToken = options.token;
-    this.client = api.getClient();
     this.componentsGroups = options._componentsGroups;
+    this.startsWith = options.startsWith;
+    this.filterQuery = options.filterQuery;
   },
   async getStoryWithTranslatedSlugs(sourceStory, targetStory) {
     const storyForPayload = { ...sourceStory };
@@ -1490,64 +1516,78 @@ const SyncSpaces = {
     }
     return storyForPayload;
   },
-  async syncStories() {
-    console.log(chalk.green("\u2713") + " Syncing stories...");
+  async getTargetFolders() {
     const targetFolders = await this.client.getAll(`spaces/${this.targetSpaceId}/stories`, {
       folder_only: 1,
       sort_by: "slug:asc"
     });
     const folderMapping = {};
-    for (let i = 0; i < targetFolders.length; i++) {
-      var folder = targetFolders[i];
+    for (const folder of targetFolders) {
       folderMapping[folder.full_slug] = folder.id;
     }
-    const all = await this.client.getAll(`spaces/${this.sourceSpaceId}/stories`, {
-      story_only: 1
+    return folderMapping;
+  },
+  async updateStoriesAndFolders(data, targetContent = null, sourceContent = null, isFolder = false) {
+    let createdStory = null;
+    const contentName = sourceContent.name;
+    const contentTypeName = isFolder ? "Folder" : "Story";
+    const payload = {
+      story: data,
+      force_update: "1",
+      ...!isFolder && sourceContent.published ? { publish: 1 } : {}
+    };
+    if (targetContent) {
+      console.log(`${chalk.yellow("-")} ${contentTypeName} ${contentName} already exists`);
+      createdStory = await this.client.put(`spaces/${this.targetSpaceId}/stories/${targetContent.id}`, payload);
+      console.log(`${chalk.green("\u2713")} ${contentTypeName} ${targetContent.full_slug} updated`);
+    } else {
+      createdStory = await this.client.post(`spaces/${this.targetSpaceId}/stories`, payload);
+      console.log(`${chalk.green("\u2713")} ${contentTypeName} ${sourceContent.full_slug} created`);
+    }
+    createdStory = createdStory.data.story;
+    if (createdStory.uuid !== sourceContent.uuid) {
+      await this.client.put(`spaces/${this.targetSpaceId}/stories/${createdStory.id}/update_uuid`, { uuid: sourceContent.uuid });
+    }
+    return createdStory;
+  },
+  async syncStories() {
+    console.log(chalk.green("\u2713") + " Syncing stories...");
+    const folderMapping = { ...await this.getTargetFolders() };
+    const allStories = await this.client.getAll(`spaces/${this.sourceSpaceId}/stories`, {
+      story_only: 1,
+      ...this.startsWith ? { starts_with: this.startsWith } : {},
+      ...this.filterQuery ? { filter_query: this.filterQuery } : {}
     });
-    for (let i = 0; i < all.length; i++) {
-      console.log(chalk.green("\u2713") + " Starting update " + all[i].full_slug);
-      const { data } = await this.client.get("spaces/" + this.sourceSpaceId + "/stories/" + all[i].id);
+    for (const story of allStories) {
+      console.log(chalk.green("\u2713") + " Starting update " + story.full_slug);
+      const { data } = await this.client.get(`spaces/${this.sourceSpaceId}/stories/${story.id}`);
       const sourceStory = data.story;
       const slugs = sourceStory.full_slug.split("/");
       let folderId = 0;
       if (slugs.length > 1) {
         slugs.pop();
-        var folderSlug = slugs.join("/");
+        const folderSlug = slugs.join("/");
         if (folderMapping[folderSlug]) {
           folderId = folderMapping[folderSlug];
         } else {
-          console.error(chalk.red("X") + "The folder does not exist " + folderSlug);
+          console.error(`${chalk.red("X")} The folder does not exist ${folderSlug}`);
           continue;
         }
       }
       sourceStory.parent_id = folderId;
       try {
-        const existingStory = await this.client.get("spaces/" + this.targetSpaceId + "/stories", { with_slug: all[i].full_slug });
-        const storyData = await this.getStoryWithTranslatedSlugs(sourceStory, existingStory.data.stories ? existingStory.data.stories[0] : null);
-        const payload = {
-          story: storyData,
-          force_update: "1",
-          ...sourceStory.published ? { publish: 1 } : {}
-        };
-        let createdStory = null;
-        if (existingStory.data.stories.length === 1) {
-          createdStory = await this.client.put("spaces/" + this.targetSpaceId + "/stories/" + existingStory.data.stories[0].id, payload);
-          console.log(chalk.green("\u2713") + " Updated " + existingStory.data.stories[0].full_slug);
-        } else {
-          createdStory = await this.client.post("spaces/" + this.targetSpaceId + "/stories", payload);
-          console.log(chalk.green("\u2713") + " Created " + sourceStory.full_slug);
-        }
-        if (createdStory.data.story.uuid !== sourceStory.uuid) {
-          await this.client.put("spaces/" + this.targetSpaceId + "/stories/" + createdStory.data.story.id + "/update_uuid", { uuid: sourceStory.uuid });
-        }
+        const { data: data2 } = await this.client.get("spaces/" + this.targetSpaceId + "/stories", { with_slug: story.full_slug });
+        const existingStory = data2.stories[0];
+        const storyData = await this.getStoryWithTranslatedSlugs(sourceStory, existingStory ? existingStory[0] : null);
+        await this.updateStoriesAndFolders(storyData, existingStory, sourceStory);
       } catch (e) {
         console.error(
-          chalk.red("X") + ` Story ${all[i].name} Sync failed: ${e.message}`
+          chalk.red("X") + ` Story ${story.name} Sync failed: ${e.message}`
         );
         console.log(e);
       }
     }
-    return Promise.resolve(all);
+    return Promise.resolve(allStories);
   },
   async syncFolders() {
     console.log(chalk.green("\u2713") + " Syncing folders...");
@@ -1556,13 +1596,12 @@ const SyncSpaces = {
       sort_by: "slug:asc"
     });
     const syncedFolders = {};
-    for (var i = 0; i < sourceFolders.length; i++) {
-      const folder = sourceFolders[i];
+    for (const folder of sourceFolders) {
       try {
-        const folderResult = await this.client.get("spaces/" + this.sourceSpaceId + "/stories/" + folder.id);
-        const sourceFolder = folderResult.data.story;
-        const existingFolder = await this.client.get("spaces/" + this.targetSpaceId + "/stories", { with_slug: folder.full_slug });
-        const folderData = await this.getStoryWithTranslatedSlugs(sourceFolder, existingFolder.data.stories ? existingFolder.data.stories[0] : null);
+        const folderResult = await this.client.get(`spaces/${this.sourceSpaceId}/stories/${folder.id}`);
+        const { data } = await this.client.get(`spaces/${this.targetSpaceId}/stories`, { with_slug: folder.full_slug });
+        const existingFolder = data.stories[0] || null;
+        const folderData = await this.getStoryWithTranslatedSlugs(folderResult.data.story, existingFolder);
         delete folderData.id;
         delete folderData.created_at;
         if (folder.parent_id) {
@@ -1581,23 +1620,7 @@ const SyncSpaces = {
             folderData.parent_id = syncedFolders[folder.id];
           }
         }
-        const payload = {
-          story: folderData,
-          force_update: "1"
-        };
-        let createdFolder = null;
-        if (existingFolder.data.stories.length === 1) {
-          console.log(`Folder ${folder.name} already exists`);
-          createdFolder = await this.client.put("spaces/" + this.targetSpaceId + "/stories/" + existingFolder.data.stories[0].id, payload);
-          console.log(chalk.green("\u2713") + ` Folder ${folder.name} updated`);
-        } else {
-          createdFolder = await this.client.post("spaces/" + this.targetSpaceId + "/stories", payload);
-          console.log(chalk.green("\u2713") + ` Folder ${folder.name} created`);
-        }
-        if (createdFolder.data.story.uuid !== folder.uuid) {
-          await this.client.put("spaces/" + this.targetSpaceId + "/stories/" + createdFolder.data.story.id + "/update_uuid", { uuid: folder.uuid });
-        }
-        syncedFolders[folder.id] = createdFolder.data.story.id;
+        await this.updateStoriesAndFolders(folderData, existingFolder, folder, true);
       } catch (e) {
         console.error(
           chalk.red("X") + ` Folder ${folder.name} Sync failed: ${e.message}`
@@ -3461,7 +3484,8 @@ const tasks = {
   generateTypescriptTypedefs
 };
 
-const rawPkg = fs.readFileSync("./package.json");
+const __dirname = dirname(fileURLToPath(import.meta.url));
+const rawPkg = fs.readFileSync(path.join(__dirname, "../package.json"));
 const pkg = JSON.parse(rawPkg);
 const program = new commander.Command();
 const allRegionsText = ALL_REGIONS.join(", ");
@@ -3547,7 +3571,7 @@ program.command("pull-languages").description("Download your space's languages s
 program.command(COMMANDS.PULL_COMPONENTS).option("--sf, --separate-files [value]", "Argument to create a single file for each component").option("-p, --path <path>", "Path to save the component files").option("-f, --file-name <fileName>", "custom name to be used in file(s) name instead of space id").description("Download your space's components schema as json").action(async (options) => {
   console.log(`${chalk.blue("-")} Executing pull-components task`);
   const space = program.space;
-  const { separateFiles, path } = options;
+  const { separateFiles, path: path2 } = options;
   if (!space) {
     console.log(chalk.red("X") + " Please provide the space as argument --space YOUR_SPACE_ID.");
     process.exit(0);
@@ -3558,7 +3582,7 @@ program.command(COMMANDS.PULL_COMPONENTS).option("--sf, --separate-files [value]
       await api.processLogin();
     }
     api.setSpaceId(space);
-    await tasks.pullComponents(api, { fileName, separateFiles, path });
+    await tasks.pullComponents(api, { fileName, separateFiles, path: path2 });
   } catch (e) {
     errorHandler(e, COMMANDS.PULL_COMPONENTS);
   }
@@ -3653,15 +3677,26 @@ 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("--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").action(async (options) => {
   console.log(`${chalk.blue("-")} Sync data between spaces
 `);
   try {
     if (!api.isAuthorized()) {
       await api.processLogin();
     }
-    const { type, target, source, componentsGroups } = options;
+    const {
+      type,
+      target,
+      source,
+      startsWith,
+      filter,
+      keys,
+      operations,
+      values,
+      componentsGroups
+    } = options;
     const _componentsGroups = componentsGroups ? componentsGroups.split(",") : null;
+    const filterQuery = filter ? buildFilterQuery(keys, operations, values) : void 0;
     const token = creds.get().token || null;
     const _types = type.split(",") || [];
     _types.forEach((_type) => {
@@ -3674,6 +3709,8 @@ program.command(COMMANDS.SYNC).description("Sync schemas, roles, folders and sto
       token,
       target,
       source,
+      startsWith,
+      filterQuery,
       _componentsGroups
     });
     console.log("\n" + chalk.green("\u2713") + " Sync data between spaces successfully completed");

package/package.json

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