storyblok 3.33.3 → 3.35.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Storyblok GmbH
+
+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

@@ -98,6 +98,8 @@ Download your space's components schema as json. By default this command will do
 
 It's highly recommended to use also the `--prefix-presets-names` or `-ppn` parameter if you use `--separate-files` because it will prefix the names of the individual files with the name of the component. This feature solves the issue of multiple presets from different components but with the same name, being written in the same file. In a future major version this will become the default behavior.
 
+If you want to resolve datasources for single/multiple option field from your Storyblok components, you can use `--resolve-datasources` or `--rd`, it will fill up the options fields with the datasource's options.
+
 ```sh
 $ storyblok pull-components --space <SPACE_ID> # Will save files like components-1234.json
 ```
@@ -106,6 +108,10 @@ $ storyblok pull-components --space <SPACE_ID> # Will save files like components
 $ storyblok pull-components --space <SPACE_ID> --separate-files --prefix-presets-names --file-name production # Will save files like feature-production.json grid-production.json
 ```
 
+```sh
+$ storyblok pull-components --space <SPACE_ID> --resolve-datasources # Will resolve datasources for single/multiple option field
+```
+
 #### Options
 
 * `space`: your space id

package/dist/cli.mjs

@@ -707,6 +707,10 @@ const api = {
     const client = this.getClient();
     return client.get(this.getPath("datasources")).then((data) => data.data.datasources || []).catch((err) => Promise.reject(err));
   },
+  getDatasourceEntries(id) {
+    const client = this.getClient();
+    return client.get(this.getPath(`datasource_entries?datasource_id=${id}`)).then((data) => data.data.datasource_entries || []).catch((err) => Promise.reject(err));
+  },
   deleteDatasource(id) {
     const client = this.getClient();
     return client.delete(this.getPath(`datasources/${id}`)).catch((err) => Promise.reject(err));
@@ -1857,12 +1861,34 @@ const getNameFromComponentGroups = (groups, uuid) => {
   }
   return "";
 };
+const resolveDatasourceOptions = async (api, components) => {
+  const datasources = await api.getDatasources();
+  for (const datasource of datasources) {
+    const datasourceEntries = await api.getDatasourceEntries(datasource.id);
+    datasource.entries = datasourceEntries;
+  }
+  return components.map((component) => {
+    const schema = component.schema;
+    for (const field in schema) {
+      if (schema[field].source === "internal" && schema[field].datasource_slug) {
+        const datasource = datasources.find((ds) => ds.slug === schema[field].datasource_slug);
+        if (datasource) {
+          schema[field].options = datasource.entries.map((entry) => ({ value: entry.value, name: entry.name }));
+        }
+      }
+    }
+    return component;
+  });
+};
 const pullComponents = async (api, options) => {
-  const { fileName, separateFiles, path, prefixPresetsNames } = options;
+  const { fileName, separateFiles, path, prefixPresetsNames, resolveDatasources } = options;
   try {
     const componentGroups = await api.getComponentGroups();
-    const components = await api.getComponents();
+    let components = await api.getComponents();
     const presets = await api.getPresets();
+    if (resolveDatasources) {
+      components = await resolveDatasourceOptions(api, components);
+    }
     components.forEach((component) => {
       const groupUuid = component.component_group_uuid;
       if (groupUuid) {
@@ -2827,27 +2853,65 @@ const getAssetJSONSchema = (title) => ({
   $id: "#/asset",
   title,
   type: "object",
-  required: ["id", "filename", "name"],
+  required: ["id", "fieldtype", "filename", "name", "title", "focus", "alt"],
   properties: {
     alt: {
-      type: "string"
+      type: ["string", "null"]
     },
     copyright: {
-      type: "string"
+      type: ["string", "null"]
+    },
+    fieldtype: {
+      type: "string",
+      enum: ["asset"]
     },
     id: {
       type: "number"
     },
     filename: {
-      type: "string"
+      type: ["string", "null"]
     },
     name: {
       type: "string"
     },
     title: {
-      type: "string"
+      type: ["string", "null"]
     },
     focus: {
+      type: ["string", "null"]
+    },
+    meta_data: {
+      type: "object"
+    },
+    source: {
+      type: ["string", "null"]
+    },
+    is_external_url: {
+      type: "boolean"
+    },
+    is_private: {
+      type: "boolean"
+    },
+    src: {
+      type: "string"
+    },
+    updated_at: {
+      type: "string"
+    },
+    // Cloudinary integration keys
+    width: {
+      type: ["number", "null"]
+    },
+    height: {
+      type: ["number", "null"]
+    },
+    aspect_ratio: {
+      type: ["number", "null"]
+    },
+    public_id: {
+      type: ["string", "null"]
+    },
+    content_type: {
       type: "string"
     }
   }
@@ -2858,53 +2922,105 @@ const getMultiassetJSONSchema = (title) => ({
   type: "array",
   items: {
     type: "object",
-    required: ["id", "filename", "name"],
+    required: ["id", "fieldtype", "filename", "name", "title", "focus", "alt"],
     properties: {
       alt: {
-        type: "string"
+        type: ["string", "null"]
       },
       copyright: {
-        type: "string"
+        type: ["string", "null"]
+      },
+      fieldtype: {
+        type: "string",
+        enum: ["asset"]
       },
       id: {
         type: "number"
       },
       filename: {
-        type: "string"
+        type: ["string", "null"]
       },
       name: {
         type: "string"
       },
       title: {
+        type: ["string", "null"]
+      },
+      focus: {
+        type: ["string", "null"]
+      },
+      meta_data: {
+        type: "object"
+      },
+      source: {
+        type: ["string", "null"]
+      },
+      is_external_url: {
+        type: "boolean"
+      },
+      is_private: {
+        type: "boolean"
+      },
+      src: {
+        type: "string"
+      },
+      updated_at: {
+        type: "string"
+      },
+      // Cloudinary integration keys
+      width: {
+        type: ["number", "null"]
+      },
+      height: {
+        type: ["number", "null"]
+      },
+      aspect_ratio: {
+        type: ["number", "null"]
+      },
+      public_id: {
+        type: ["string", "null"]
+      },
+      content_type: {
         type: "string"
       }
     }
   }
 });
+const multilinkSharedRequiredProps = ["fieldtype", "id", "url", "cached_url", "linktype"];
 const getMultilinkJSONSchema = (title) => ({
   $id: "#/multilink",
   title,
   oneOf: [
     {
       type: "object",
+      required: multilinkSharedRequiredProps,
       properties: {
-        id: {
+        // Shared props
+        fieldtype: {
+          type: "string",
+          enum: ["multilink"]
+        },
+        id: { type: "string" },
+        url: { type: "string" },
+        cached_url: { type: "string" },
+        target: { type: "string", enum: ["_blank", "_self"] },
+        // Custom props
+        anchor: {
           type: "string"
         },
-        cached_url: {
+        rel: {
           type: "string"
         },
-        anchor: {
+        title: {
+          type: "string"
+        },
+        prep: {
           type: "string"
         },
         linktype: {
           type: "string",
           enum: ["story"]
         },
-        target: {
-          type: "string",
-          enum: ["_self", "_blank"]
-        },
         story: {
           type: "object",
           required: ["name", "id", "uuid", "slug", "full_slug"],
@@ -2990,39 +3106,70 @@ const getMultilinkJSONSchema = (title) => ({
     },
     {
       type: "object",
+      required: multilinkSharedRequiredProps,
       properties: {
-        url: {
-          type: "string"
-        },
-        cached_url: {
-          type: "string"
-        },
-        anchor: {
-          type: "string"
+        // Shared props
+        fieldtype: {
+          type: "string",
+          enum: ["multilink"]
         },
+        id: { type: "string" },
+        url: { type: "string" },
+        cached_url: { type: "string" },
+        target: { type: "string", enum: ["_blank", "_self"] },
+        // Custom props
         linktype: {
           type: "string",
-          enum: ["asset", "url"]
+          enum: ["url"]
         },
-        target: {
-          type: "string",
-          enum: ["_self", "_blank"]
+        rel: {
+          type: "string"
+        },
+        title: {
+          type: "string"
         }
       }
     },
     {
       type: "object",
+      required: multilinkSharedRequiredProps,
       properties: {
+        // Shared props
+        fieldtype: {
+          type: "string",
+          enum: ["multilink"]
+        },
+        id: { type: "string" },
+        url: { type: "string" },
+        cached_url: { type: "string" },
+        target: { type: "string", enum: ["_blank", "_self"] },
+        // Custom props
         email: {
           type: "string"
         },
         linktype: {
           type: "string",
           enum: ["email"]
+        }
+      }
+    },
+    {
+      type: "object",
+      required: multilinkSharedRequiredProps,
+      properties: {
+        // Shared props
+        fieldtype: {
+          type: "string",
+          enum: ["multilink"]
         },
-        target: {
+        id: { type: "string" },
+        url: { type: "string" },
+        cached_url: { type: "string" },
+        target: { type: "string", enum: ["_blank", "_self"] },
+        // Custom props
+        linktype: {
           type: "string",
-          enum: ["_self", "_blank"]
+          enum: ["asset"]
         }
       }
     }
@@ -3678,10 +3825,10 @@ program.command("pull-languages").description("Download your space's languages s
     process.exit(1);
   }
 });
-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").option("-ppn, --prefix-presets-names", "Prefixes the names of presets with the name of the components").description("Download your space's components schema as json").action(async (options) => {
+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").option("-ppn, --prefix-presets-names", "Prefixes the names of presets with the name of the components").option("--rd, --resolve-datasources", "Fill options for single/multiple option field with the linked datasource").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: path2, prefixPresetsNames } = options;
+  const { separateFiles, path: path2, prefixPresetsNames, resolveDatasources } = options;
   if (!space) {
     console.log(chalk.red("X") + " Please provide the space as argument --space YOUR_SPACE_ID.");
     process.exit(0);
@@ -3692,7 +3839,7 @@ program.command(COMMANDS.PULL_COMPONENTS).option("--sf, --separate-files [value]
       await api.processLogin();
     }
     api.setSpaceId(space);
-    await tasks.pullComponents(api, { fileName, separateFiles, path: path2, prefixPresetsNames });
+    await tasks.pullComponents(api, { fileName, separateFiles, path: path2, prefixPresetsNames, resolveDatasources });
   } catch (e) {
     errorHandler(e, COMMANDS.PULL_COMPONENTS);
   }

package/package.json

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