storyblok 4.6.13 → 4.7.0

package/dist/index.mjs

@@ -4041,6 +4041,7 @@ const DEFAULT_TYPEDEFS_HEADER = [
   "// This file was generated by the storyblok CLI.",
   "// DO NOT MODIFY THIS FILE BY HAND."
 ];
+const getDatasourceTypeTitle = (slug) => `${toPascalCase(slug)}DataSource`;
 const getPropertyTypeAnnotation = (property, prefix, suffix) => {
   if (Array.from(storyblokSchemas.keys()).includes(property.type)) {
     return { type: property.type };
@@ -4149,6 +4150,13 @@ const getComponentPropertiesTypeAnnotations = async (component, options, spaceDa
       const componentType = toPascalCase(propertyType);
       propertyTypeAnnotation[key].tsType = `Storyblok${componentType}`;
     }
+    if (spaceData.datasources.length > 0 && schema.source === "internal" && schema?.datasource_slug) {
+      const datasourceExists = spaceData.datasources.some((ds) => ds.slug === schema.datasource_slug);
+      if (datasourceExists) {
+        const type = getDatasourceTypeTitle(schema.datasource_slug);
+        propertyTypeAnnotation[key].tsType = propertyType === "options" ? `${type}[]` : type;
+      }
+    }
     if (propertyType === "multilink") {
       const excludedLinktypes = [
         ...!schema.email_link_type ? ['{ linktype?: "email" }'] : [],
@@ -4222,6 +4230,7 @@ const generateTypes = async (spaceData, options = {
   try {
     const typeDefs = [...DEFAULT_TYPEDEFS_HEADER];
     const storyblokPropertyTypes = /* @__PURE__ */ new Set();
+    const contentTypeBloks = /* @__PURE__ */ new Set();
     let customFieldsParser;
     let compilerOptions;
     if (options.customFieldsParser) {
@@ -4230,8 +4239,11 @@ const generateTypes = async (spaceData, options = {
     if (options.compilerOptions) {
       compilerOptions = await loadCompilerOptions(options.compilerOptions);
     }
-    const schemas = await Promise.all(spaceData.components.map(async (component) => {
+    const componentsSchema = spaceData.components.map(async (component) => {
       const type = getComponentType(component.name, options);
+      if (component.is_root) {
+        contentTypeBloks.add(type);
+      }
       const componentPropertiesTypeAnnotations = await getComponentPropertiesTypeAnnotations(component, options, spaceData, customFieldsParser);
       const requiredFields = Object.entries(component?.schema || {}).reduce(
         (acc, [key, value]) => {
@@ -4270,7 +4282,35 @@ const generateTypes = async (spaceData, options = {
         }
       };
       return componentSchema;
-    }));
+    });
+    const resolvedComponentsSchema = await Promise.all(componentsSchema);
+    const datasourcesSchema = spaceData.datasources.map(async (datasource) => {
+      const allComponentTypes = resolvedComponentsSchema.map((schema) => schema.title);
+      const enumValues = datasource.entries?.filter((d) => d.value).map((d) => d.value);
+      const type = getDatasourceTypeTitle(datasource.slug);
+      if (allComponentTypes.includes(type)) {
+        console.warn(`Warning: Datasource type "${type}" conflicts with existing component type`);
+      }
+      const datasourceSchema = {
+        $id: `#/${datasource.slug}`,
+        title: type,
+        type: "string",
+        enum: enumValues
+      };
+      return datasourceSchema;
+    });
+    const resolvedDatasourcesSchema = await Promise.all(datasourcesSchema);
+    const contentTypeSchema = {
+      $id: `#/ContentType`,
+      title: "ContentType",
+      type: "string",
+      tsType: contentTypeBloks.size > 0 ? `${Array.from(contentTypeBloks).join(" | ")}` : "never"
+    };
+    const schemas = [
+      ...resolvedComponentsSchema,
+      ...resolvedDatasourcesSchema,
+      contentTypeSchema
+    ];
     const result = await Promise.all(schemas.map(async (schema) => {
       return await compile(schema, schema.title || schema.$id.replace("#/", ""), {
         additionalProperties: !options.strict,
@@ -4328,6 +4368,160 @@ const generateStoryblokTypes = async (options = {}) => {
   }
 };
 
+const pushDatasource = async (spaceId, datasource) => {
+  try {
+    const client = mapiClient();
+    const { data } = await client.datasources.create({
+      path: {
+        space_id: spaceId
+      },
+      body: { datasource },
+      throwOnError: true
+    });
+    return data.datasource;
+  } catch (error) {
+    handleAPIError("push_datasource", error, `Failed to push datasource ${datasource.name}`);
+  }
+};
+const updateDatasource = async (spaceId, datasourceId, datasource) => {
+  try {
+    const client = mapiClient();
+    const { data } = await client.datasources.update({
+      path: {
+        space_id: spaceId,
+        datasource_id: datasourceId
+      },
+      body: {
+        datasource
+      },
+      throwOnError: true
+    });
+    return data.datasource;
+  } catch (error) {
+    handleAPIError("update_datasource", error, `Failed to update datasource ${datasource.name}`);
+  }
+};
+const upsertDatasource = async (space, datasource, existingId) => {
+  if (existingId) {
+    return await updateDatasource(space, existingId, datasource);
+  } else {
+    return await pushDatasource(space, datasource);
+  }
+};
+const pushDatasourceEntry = async (spaceId, datasourceId, entry) => {
+  try {
+    const client = mapiClient();
+    const { data } = await client.datasourceEntries.create({
+      path: {
+        space_id: spaceId
+      },
+      body: {
+        datasource_entry: {
+          ...entry,
+          datasource_id: datasourceId
+        }
+      },
+      throwOnError: true
+    });
+    return data.datasource_entry;
+  } catch (error) {
+    handleAPIError("push_datasource", error, `Failed to push datasource entry ${entry.name}`);
+  }
+};
+const updateDatasourceEntry = async (spaceId, entryId, entry) => {
+  try {
+    const client = mapiClient();
+    await client.datasourceEntries.updateDatasourceEntry({
+      path: {
+        space_id: spaceId,
+        datasource_entry_id: entryId
+      },
+      body: {
+        datasource_entry: entry
+      },
+      throwOnError: true
+    });
+  } catch (error) {
+    handleAPIError("update_datasource", error, `Failed to update datasource entry ${entry.name}`);
+  }
+};
+const upsertDatasourceEntry = async (space, datasourceId, entry, existingId) => {
+  if (existingId) {
+    await updateDatasourceEntry(space, existingId, entry);
+    return void 0;
+  } else {
+    return await pushDatasourceEntry(space, datasourceId, entry);
+  }
+};
+const readDatasourcesFiles = async (options) => {
+  const { from, path, separateFiles = false, suffix, space } = options;
+  const resolvedPath = resolvePath(path, `datasources/${from}`);
+  try {
+    await readdir(resolvedPath);
+  } catch (error) {
+    const message = `No local datasources found for space ${chalk.bold(from)}. To push datasources, you need to pull them first:
+
+1. Pull the datasources from your source space:
+   ${chalk.cyan(`storyblok datasources pull --space ${from}`)}
+
+2. Then try pushing again:
+   ${chalk.cyan(`storyblok datasources push --space ${space} --from ${from}`)}`;
+    throw new FileSystemError(
+      "file_not_found",
+      "read",
+      error,
+      message
+    );
+  }
+  if (separateFiles) {
+    return await readSeparateFiles(resolvedPath, suffix);
+  }
+  return await readConsolidatedFiles(resolvedPath, suffix);
+};
+async function readSeparateFiles(resolvedPath, suffix) {
+  const files = await readdir(resolvedPath);
+  const datasources = [];
+  const filteredFiles = files.filter((file) => {
+    if (suffix) {
+      return file.endsWith(`.${suffix}.json`);
+    } else {
+      return !/\.\w+\.json$/.test(file);
+    }
+  });
+  for (const file of filteredFiles) {
+    const filePath = join(resolvedPath, file);
+    if (file.endsWith(".json") || file.endsWith(`${suffix}.json`)) {
+      if (file === "datasources.json" || /^datasources\.\w+\.json$/.test(file)) {
+        continue;
+      }
+      const result = await readJsonFile(filePath);
+      if (result.error) {
+        handleFileSystemError("read", result.error);
+        continue;
+      }
+      datasources.push(...result.data);
+    }
+  }
+  return {
+    datasources
+  };
+}
+async function readConsolidatedFiles(resolvedPath, suffix) {
+  const datasourcesPath = join(resolvedPath, suffix ? `datasources.${suffix}.json` : "datasources.json");
+  const datasourcesResult = await readJsonFile(datasourcesPath);
+  if (datasourcesResult.error || !datasourcesResult.data.length) {
+    throw new FileSystemError(
+      "file_not_found",
+      "read",
+      datasourcesResult.error || new Error("Datasources file is empty"),
+      `No datasources found in ${datasourcesPath}. Please make sure you have pulled the datasources first.`
+    );
+  }
+  return {
+    datasources: datasourcesResult.data
+  };
+}
+
 const program$5 = getProgram();
 typesCommand.command("generate").description("Generate types d.ts for your component schemas").option("--sf, --separate-files", "Generate one .d.ts file per component instead of a single combined file").option(
   "--filename <name>",
@@ -4341,19 +4535,33 @@ typesCommand.command("generate").description("Generate types d.ts for your compo
   });
   try {
     spinner.start(`Generating types...`);
-    const spaceData = await readComponentsFiles({
+    const componentsData = await readComponentsFiles({
       ...options,
       from: space,
       path
     });
+    let dataSourceData;
+    try {
+      dataSourceData = await readDatasourcesFiles({
+        ...options,
+        from: space,
+        path
+      });
+    } catch (error) {
+      if (error instanceof FileSystemError && error.errorId === "file_not_found") {
+        dataSourceData = { datasources: [] };
+      } else {
+        throw error;
+      }
+    }
     await generateStoryblokTypes({
       path
     });
-    const spaceDataWithDatasources = {
-      ...spaceData,
-      datasources: []
+    const spaceDataWithComponentsAndDatasources = {
+      ...componentsData,
+      ...dataSourceData
     };
-    const typedefString = await generateTypes(spaceDataWithDatasources, {
+    const typedefString = await generateTypes(spaceDataWithComponentsAndDatasources, {
       ...options,
       path
     });
@@ -4376,19 +4584,36 @@ typesCommand.command("generate").description("Generate types d.ts for your compo
 const program$4 = getProgram();
 const datasourcesCommand = program$4.command(commands.DATASOURCES).alias("ds").description(`Manage your space's datasources`).option("-s, --space <space>", "space ID").option("-p, --path <path>", "path to save the file. Default is .storyblok/datasources");
 
+async function fetchAllPages(fetchFunction, extractDataFunction, page = 1, collectedItems = []) {
+  const { data, response } = await fetchFunction(page);
+  const totalHeader = response.headers.get("total");
+  const total = Number(totalHeader);
+  const fetchedItems = extractDataFunction(data);
+  const allItems = [...collectedItems, ...fetchedItems];
+  if (!totalHeader || Number.isNaN(total)) {
+    return allItems;
+  }
+  if (allItems.length < total && fetchedItems.length > 0) {
+    return fetchAllPages(fetchFunction, extractDataFunction, page + 1, allItems);
+  }
+  return allItems;
+}
 const fetchDatasourceEntries = async (spaceId, datasourceId) => {
   try {
     const client = mapiClient();
-    const { data } = await client.datasourceEntries.list({
-      path: {
-        space_id: spaceId
-      },
-      query: {
-        datasource_id: datasourceId
-      },
-      throwOnError: true
-    });
-    return data?.datasource_entries;
+    return await fetchAllPages(
+      (page) => client.datasourceEntries.list({
+        path: {
+          space_id: spaceId
+        },
+        query: {
+          datasource_id: datasourceId,
+          page
+        },
+        throwOnError: true
+      }),
+      (data) => data?.datasource_entries || []
+    );
   } catch (error) {
     handleAPIError("pull_datasources", error);
   }
@@ -4396,21 +4621,26 @@ const fetchDatasourceEntries = async (spaceId, datasourceId) => {
 const fetchDatasources = async (spaceId) => {
   try {
     const client = mapiClient();
-    const { data } = await client.datasources.list({
-      path: {
-        space_id: spaceId
-      },
-      throwOnError: true
-    });
-    const datasources = data?.datasources;
+    const datasources = await fetchAllPages(
+      (page) => client.datasources.list({
+        path: {
+          space_id: spaceId
+        },
+        query: {
+          page
+        },
+        throwOnError: true
+      }),
+      (data) => data?.datasources || []
+    );
     const datasourcesWithEntries = await Promise.all(
-      datasources?.map(async (ds) => {
+      datasources.map(async (ds) => {
         if (!ds.id) {
           return { ...ds, entries: [] };
         }
         const entries = await fetchDatasourceEntries(spaceId, ds.id);
         return { ...ds, entries };
-      }) || []
+      })
     );
     return datasourcesWithEntries;
   } catch (error) {
@@ -4530,160 +4760,6 @@ datasourcesCommand.command("pull [datasourceName]").option("-f, --filename <file
   }
 });
 
-const pushDatasource = async (spaceId, datasource) => {
-  try {
-    const client = mapiClient();
-    const { data } = await client.datasources.create({
-      path: {
-        space_id: spaceId
-      },
-      body: { datasource },
-      throwOnError: true
-    });
-    return data.datasource;
-  } catch (error) {
-    handleAPIError("push_datasource", error, `Failed to push datasource ${datasource.name}`);
-  }
-};
-const updateDatasource = async (spaceId, datasourceId, datasource) => {
-  try {
-    const client = mapiClient();
-    const { data } = await client.datasources.update({
-      path: {
-        space_id: spaceId,
-        datasource_id: datasourceId
-      },
-      body: {
-        datasource
-      },
-      throwOnError: true
-    });
-    return data.datasource;
-  } catch (error) {
-    handleAPIError("update_datasource", error, `Failed to update datasource ${datasource.name}`);
-  }
-};
-const upsertDatasource = async (space, datasource, existingId) => {
-  if (existingId) {
-    return await updateDatasource(space, existingId, datasource);
-  } else {
-    return await pushDatasource(space, datasource);
-  }
-};
-const pushDatasourceEntry = async (spaceId, datasourceId, entry) => {
-  try {
-    const client = mapiClient();
-    const { data } = await client.datasourceEntries.create({
-      path: {
-        space_id: spaceId
-      },
-      body: {
-        datasource_entry: {
-          ...entry,
-          datasource_id: datasourceId
-        }
-      },
-      throwOnError: true
-    });
-    return data.datasource_entry;
-  } catch (error) {
-    handleAPIError("push_datasource", error, `Failed to push datasource entry ${entry.name}`);
-  }
-};
-const updateDatasourceEntry = async (spaceId, entryId, entry) => {
-  try {
-    const client = mapiClient();
-    await client.datasourceEntries.updateDatasourceEntry({
-      path: {
-        space_id: spaceId,
-        datasource_entry_id: entryId
-      },
-      body: {
-        datasource_entry: entry
-      },
-      throwOnError: true
-    });
-  } catch (error) {
-    handleAPIError("update_datasource", error, `Failed to update datasource entry ${entry.name}`);
-  }
-};
-const upsertDatasourceEntry = async (space, datasourceId, entry, existingId) => {
-  if (existingId) {
-    await updateDatasourceEntry(space, existingId, entry);
-    return void 0;
-  } else {
-    return await pushDatasourceEntry(space, datasourceId, entry);
-  }
-};
-const readDatasourcesFiles = async (options) => {
-  const { from, path, separateFiles = false, suffix, space } = options;
-  const resolvedPath = resolvePath(path, `datasources/${from}`);
-  try {
-    await readdir(resolvedPath);
-  } catch (error) {
-    const message = `No local datasources found for space ${chalk.bold(from)}. To push datasources, you need to pull them first:
-
-1. Pull the datasources from your source space:
-   ${chalk.cyan(`storyblok datasources pull --space ${from}`)}
-
-2. Then try pushing again:
-   ${chalk.cyan(`storyblok datasources push --space ${space} --from ${from}`)}`;
-    throw new FileSystemError(
-      "file_not_found",
-      "read",
-      error,
-      message
-    );
-  }
-  if (separateFiles) {
-    return await readSeparateFiles(resolvedPath, suffix);
-  }
-  return await readConsolidatedFiles(resolvedPath, suffix);
-};
-async function readSeparateFiles(resolvedPath, suffix) {
-  const files = await readdir(resolvedPath);
-  const datasources = [];
-  const filteredFiles = files.filter((file) => {
-    if (suffix) {
-      return file.endsWith(`.${suffix}.json`);
-    } else {
-      return !/\.\w+\.json$/.test(file);
-    }
-  });
-  for (const file of filteredFiles) {
-    const filePath = join(resolvedPath, file);
-    if (file.endsWith(".json") || file.endsWith(`${suffix}.json`)) {
-      if (file === "datasources.json" || /^datasources\.\w+\.json$/.test(file)) {
-        continue;
-      }
-      const result = await readJsonFile(filePath);
-      if (result.error) {
-        handleFileSystemError("read", result.error);
-        continue;
-      }
-      datasources.push(...result.data);
-    }
-  }
-  return {
-    datasources
-  };
-}
-async function readConsolidatedFiles(resolvedPath, suffix) {
-  const datasourcesPath = join(resolvedPath, suffix ? `datasources.${suffix}.json` : "datasources.json");
-  const datasourcesResult = await readJsonFile(datasourcesPath);
-  if (datasourcesResult.error || !datasourcesResult.data.length) {
-    throw new FileSystemError(
-      "file_not_found",
-      "read",
-      datasourcesResult.error || new Error("Datasources file is empty"),
-      `No datasources found in ${datasourcesPath}. Please make sure you have pulled the datasources first.`
-    );
-  }
-  return {
-    datasources: datasourcesResult.data
-  };
-}
-
 const program$2 = getProgram();
 datasourcesCommand.command("push [datasourceName]").description(`Push your space's datasources schema as json`).option("-f, --from <from>", "source space id").option("--fi, --filter <filter>", "glob filter to apply to the datasources before pushing").option("--sf, --separate-files", "Read from separate files instead of consolidated files").option("--su, --suffix <suffix>", "Suffix to add to the datasource name").action(async (datasourceName, options) => {
   konsola.title(`${commands.DATASOURCES}`, colorPalette.DATASOURCES, datasourceName ? `Pushing datasource ${datasourceName}...` : "Pushing datasources...");
@@ -5195,7 +5271,7 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
   konsola.br();
 });
 
-const version = "4.6.13";
+const version = "4.7.0";
 const pkg = {
 	version: version};