storyblok 4.0.0-beta.2 → 4.0.0-beta.4

package/dist/index.mjs

@@ -107,7 +107,11 @@ async function customFetch(url, options = {}) {
           data
         });
       }
-      return data;
+      return {
+        ...data,
+        perPage: Number(response.headers.get("Per-Page")),
+        total: Number(response.headers.get("Total"))
+      };
     } catch (error) {
       if (error instanceof FetchError) {
         throw error;
@@ -315,6 +319,22 @@ class FileSystemError extends Error {
   }
 }
 
+function handleVerboseError(error) {
+  if (error instanceof CommandError || error instanceof APIError || error instanceof FileSystemError) {
+    const errorDetails = "getInfo" in error ? error.getInfo() : {};
+    if (error instanceof CommandError) {
+      konsola.error(`Command Error: ${error.getInfo().message}`, errorDetails);
+    } else if (error instanceof APIError) {
+      konsola.error(`API Error: ${error.getInfo().cause}`, errorDetails);
+    } else if (error instanceof FileSystemError) {
+      konsola.error(`File System Error: ${error.getInfo().cause}`, errorDetails);
+    } else {
+      konsola.error(`Unexpected Error: ${error}`, errorDetails);
+    }
+  } else {
+    konsola.error(`Unexpected Error`, error);
+  }
+}
 function handleError(error, verbose = false) {
   if (error instanceof APIError || error instanceof FileSystemError) {
     const messageStack = error.messageStack;
@@ -329,17 +349,8 @@ function handleError(error, verbose = false) {
       header: true
     });
   }
-  if (verbose && (error instanceof CommandError || error instanceof APIError || error instanceof FileSystemError)) {
-    const errorDetails = "getInfo" in error ? error.getInfo() : {};
-    if (error instanceof CommandError) {
-      konsola.error(`Command Error: ${error.getInfo().message}`, errorDetails);
-    } else if (error instanceof APIError) {
-      konsola.error(`API Error: ${error.getInfo().cause}`, errorDetails);
-    } else if (error instanceof FileSystemError) {
-      konsola.error(`File System Error: ${error.getInfo().cause}`, errorDetails);
-    } else {
-      konsola.error(`Unexpected Error: ${error}`, errorDetails);
-    }
+  if (verbose) {
+    handleVerboseError(error);
   } else {
     konsola.br();
     konsola.info("For more information about the error, run the command with the `--verbose` flag");
@@ -353,7 +364,10 @@ const toPascalCase = (str) => {
   return str.replace(/(?:^|_)(\w)/g, (_, char) => char.toUpperCase());
 };
 const toCamelCase = (str) => {
-  return str.replace(/(?:^|_)(\w)/g, (_, char) => char.toUpperCase()).replace(/_/g, "").replace(/^[A-Z]/, (char) => char.toLowerCase());
+  return str.replace(/_([a-z])/g, (_, letter) => letter.toUpperCase()).replace(/_/g, "").replace(/-([a-z])/g, (_, letter) => letter.toUpperCase()).replace(/[^a-z0-9]([a-z])/gi, (_, letter) => letter.toUpperCase()).replace(/[^a-z0-9]/gi, "");
+};
+const capitalize = (str) => {
+  return str.charAt(0).toUpperCase() + str.slice(1);
 };
 function maskToken(token) {
   if (token.length <= 4) {
@@ -563,14 +577,18 @@ const getCredentials = async (filePath = join(getStoryblokGlobalPath(), "credent
   try {
     await access(filePath);
     const content = await readFile(filePath);
-    return JSON.parse(content);
+    const parsedContent = JSON.parse(content);
+    if (Object.keys(parsedContent).length === 0) {
+      return null;
+    }
+    return parsedContent;
   } catch (error) {
     if (error.code === "ENOENT") {
       await saveToFile(filePath, JSON.stringify({}, null, 2), { mode: 384 });
-      return {};
+      return null;
     }
     handleFileSystemError("read", error);
-    return {};
+    return null;
   }
 };
 const addCredentials = async ({
@@ -604,7 +622,7 @@ function createSession() {
   const state = {
     isLoggedIn: false
   };
-  async function initializeSession(region = "eu") {
+  async function initializeSession() {
     const envCredentials = getEnvCredentials();
     if (envCredentials) {
       state.isLoggedIn = true;
@@ -614,9 +632,9 @@ function createSession() {
       state.envLogin = true;
       return;
     }
-    const machines = await getCredentials();
-    const creds = machines[regionsDomain[region] || "api.storyblok.com"];
-    if (creds) {
+    const credentials = await getCredentials();
+    if (credentials) {
+      const creds = Object.values(credentials)[0];
       state.isLoggedIn = true;
       state.login = creds.login;
       state.password = creds.password;
@@ -1191,16 +1209,18 @@ async function readJsonFile(filePath) {
   }
 }
 const readComponentsFiles = async (options) => {
-  const { from, path, separateFiles = false, suffix } = options;
+  const { from, path, separateFiles = false, suffix, space } = options;
   const resolvedPath = resolvePath(path, `components/${from}`);
   try {
     await readdir(resolvedPath);
   } catch (error) {
-    const message = `No directory found for space "${from}". Please make sure you have pulled the components first by running:
+    const message = `No local components found for space ${chalk.bold(from)}. To push components, you need to pull them first:
 
-  storyblok components pull --space ${from} 
+1. Pull the components from your source space:
+   ${chalk.cyan(`storyblok components pull --space ${from}`)}
 
-`;
+2. Then try pushing again:
+   ${chalk.cyan(`storyblok components push --space ${space} --from ${from}`)}`;
     throw new FileSystemError(
       "file_not_found",
       "read",
@@ -1380,7 +1400,7 @@ componentsCommand.command("pull [componentName]").option("-f, --filename <filena
   }
 });
 
-function findRelatedResources(components, spaceData) {
+function findRelatedResources(components, spaceData, visitedComponents = /* @__PURE__ */ new Set()) {
   const componentIds = new Set(components.map((c) => c.id));
   const whitelistedComponentNames = /* @__PURE__ */ new Set();
   const componentGroupUuids = /* @__PURE__ */ new Set();
@@ -1465,7 +1485,11 @@ function findRelatedResources(components, spaceData) {
     whitelistedComponents: []
   };
   if (whitelistedComponents.length > 0) {
-    additionalResources = findRelatedResources(whitelistedComponents, spaceData);
+    const newComponents = whitelistedComponents.filter((component) => !visitedComponents.has(component.name));
+    if (newComponents.length > 0) {
+      components.forEach((component) => visitedComponents.add(component.name));
+      additionalResources = findRelatedResources(newComponents, spaceData, visitedComponents);
+    }
   }
   const result = {
     groups: Array.from(/* @__PURE__ */ new Set([...Array.from(relatedGroups), ...additionalResources.groups])),
@@ -1759,11 +1783,6 @@ async function handleWhitelists(space, password, region, spaceData) {
         return;
       }
       if (visited.has(componentName)) {
-        failedComponents.add(componentName);
-        results.failed.push({
-          name: componentName,
-          error: new Error(`Circular dependency detected for component ${componentName}`)
-        });
         return;
       }
       visited.add(componentName);
@@ -2022,11 +2041,14 @@ componentsCommand.command("push [componentName]").description(`Push your space's
   if (!from) {
     options.from = space;
   }
+  konsola.info(`Attempting to push components ${chalk.bold("from")} space ${chalk.hex(colorPalette.COMPONENTS)(options.from)} ${chalk.bold("to")} ${chalk.hex(colorPalette.COMPONENTS)(space)}`);
+  konsola.br();
   const { password, region } = state;
   try {
     let spaceData = await readComponentsFiles({
       ...options,
-      path
+      path,
+      space
     });
     if (componentName) {
       spaceData = filterSpaceDataByComponent(spaceData, componentName);
@@ -2241,16 +2263,28 @@ migrationsCommand.command("generate [componentName]").description("Generate a mi
 const fetchStories = async (space, token, region, params) => {
   try {
     const url = getStoryblokUrl(region);
-    const { filter_query, ...restParams } = params || {};
-    const regularParams = new URLSearchParams(objectToStringParams(restParams)).toString();
-    const queryString = filter_query ? `${regularParams ? `${regularParams}&` : ""}${filter_query}` : regularParams;
-    const endpoint = `${url}/spaces/${space}/stories${queryString ? `?${queryString}` : ""}`;
-    const response = await customFetch(endpoint, {
-      headers: {
-        Authorization: token
-      }
-    });
-    return response.stories;
+    const allStories = [];
+    let currentPage = 1;
+    let hasMorePages = true;
+    while (hasMorePages) {
+      const { filter_query, ...restParams } = params || {};
+      const regularParams = new URLSearchParams({
+        ...objectToStringParams({ ...restParams, per_page: 100 }),
+        ...currentPage > 1 && { page: currentPage.toString() }
+      }).toString();
+      const queryString = filter_query ? `${regularParams ? `${regularParams}&` : ""}${filter_query}` : regularParams;
+      const endpoint = `${url}/spaces/${space}/stories${queryString ? `?${queryString}` : ""}`;
+      const response = await customFetch(endpoint, {
+        headers: {
+          Authorization: token
+        }
+      });
+      allStories.push(...response.stories);
+      const totalPages = Math.ceil(response.total / response.perPage);
+      hasMorePages = currentPage < totalPages;
+      currentPage++;
+    }
+    return allStories;
   } catch (error) {
     handleAPIError("pull_stories", error);
   }
@@ -3223,18 +3257,67 @@ const storyblokSchemas = /* @__PURE__ */ new Map([
   ["richtext", getRichtextJSONSchema]
 ]);
 
+const STORY_TYPE = "ISbStoryData";
 const DEFAULT_TYPEDEFS_HEADER = [
   "// This file was generated by the storyblok CLI.",
   "// DO NOT MODIFY THIS FILE BY HAND."
 ];
-const getPropertyTypeAnnotation = (property) => {
+const getPropertyTypeAnnotation = (property, prefix) => {
   if (Array.from(storyblokSchemas.keys()).includes(property.type)) {
     return { type: property.type };
   }
+  let type = "unknown";
   const options = property.options && property.options.length > 0 ? property.options.map((item) => item.value) : [];
   if (options.length > 0 && property.exclude_empty_option !== true) {
     options.unshift("");
   }
+  if (property.source === "internal_stories") {
+    if (property.filter_content_type) {
+      if (typeof property.filter_content_type === "string") {
+        return {
+          tsType: `(${getStoryType(property.filter_content_type, prefix)} | string )${property.type === "options" ? "[]" : ""}`
+        };
+      }
+      return {
+        tsType: `(${property.filter_content_type.map((type2) => getStoryType(type2, prefix)).join(" | ")} | string )${property.type === "options" ? "[]" : ""}`
+      };
+    }
+  }
+  if (
+    // If there is no `source` and there are options, the data source is the component itself
+    // TODO: check if this is an old behaviour (shouldn't this be handled as an "internal" source?)
+    options.length > 0 && !property.source || property.source === "internal_languages" || property.source === "external"
+  ) {
+    type = "string";
+  }
+  if (property.source === "internal") {
+    type = ["number", "string"];
+  }
+  if (property.type === "option") {
+    if (options.length > 0) {
+      return {
+        type,
+        enum: options
+      };
+    }
+    return {
+      type
+    };
+  }
+  if (property.type === "options") {
+    if (options.length > 0) {
+      return {
+        type: "array",
+        items: {
+          enum: options
+        }
+      };
+    }
+    return {
+      type: "array",
+      items: { type }
+    };
+  }
   switch (property.type) {
     case "bloks":
       return { type: "array" };
@@ -3251,6 +3334,9 @@ const getPropertyTypeAnnotation = (property) => {
       return { type: "any" };
   }
 };
+function getStoryType(property, prefix) {
+  return `${STORY_TYPE}<${prefix ?? ""}${capitalize(toCamelCase(property))}>`;
+}
 const getComponentType = (componentName, options) => {
   const prefix = options.typePrefix ?? "";
   const sanitizedName = componentName.replace(/[^a-z0-9]/gi, "_").replace(/_+/g, "_").replace(/^_+|_+$/g, "");
@@ -3266,7 +3352,7 @@ const getComponentPropertiesTypeAnnotations = async (component, options, spaceDa
     }
     const propertyType = value.type;
     const propertyTypeAnnotation = {
-      [key]: getPropertyTypeAnnotation(value)
+      [key]: getPropertyTypeAnnotation(value, options.typePrefix)
     };
     if (propertyType === "custom" && customFieldsParser) {
       const customField = typeof customFieldsParser === "function" ? customFieldsParser(key, value) : {};
@@ -3354,7 +3440,7 @@ const generateTypes = async (spaceData, options = {
     const schemas = await Promise.all(spaceData.components.map(async (component) => {
       const type = getComponentType(component.name, options);
       const componentPropertiesTypeAnnotations = await getComponentPropertiesTypeAnnotations(component, options, spaceData, customFieldsParser);
-      const requiredFields = Object.entries(component.schema).reduce(
+      const requiredFields = Object.entries(component?.schema || {}).reduce(
         (acc, [key, value]) => {
           if (value.required) {
             return [...acc, key];
@@ -3424,45 +3510,13 @@ const saveTypesToFile = async (space, typedefString, options) => {
 const generateStoryblokTypes = async (options = {}) => {
   const { filename = "storyblok", path } = options;
   try {
-    const storyblokTypesPath = resolve(process.cwd(), "src", "types", "storyblok.ts");
+    const storyblokTypesPath = resolve(__dirname, "./index.d.ts");
     const storyblokTypesContent = readFileSync(storyblokTypesPath, "utf-8");
-    const lines = storyblokTypesContent.split("\n");
-    const typeDefinitions = [];
-    let isCollecting = false;
-    let bracketCount = 0;
-    let currentType = "";
-    for (let i = 0; i < lines.length; i++) {
-      const line = lines[i];
-      if (line.includes("export type StoryblokPropertyType") || line.includes("export interface Storyblok")) {
-        if (isCollecting) {
-          typeDefinitions.push("");
-        }
-        isCollecting = true;
-        typeDefinitions.push(line);
-        currentType = line.includes("type") ? "type" : "interface";
-        bracketCount += (line.match(/\{/g) || []).length;
-        bracketCount -= (line.match(/\}/g) || []).length;
-        if (currentType === "type") {
-          isCollecting = false;
-          continue;
-        }
-        let j = i + 1;
-        while (j < lines.length && bracketCount > 0) {
-          const nextLine = lines[j];
-          bracketCount += (nextLine.match(/\{/g) || []).length;
-          bracketCount -= (nextLine.match(/\}/g) || []).length;
-          typeDefinitions.push(nextLine);
-          j++;
-        }
-        i = j - 1;
-        isCollecting = false;
-      }
-    }
     const typeDefs = [
-      "// This file was generated by the storyblok CLI.",
+      "// This file was generated by the Storyblok CLI.",
       "// DO NOT MODIFY THIS FILE BY HAND.",
-      "",
-      ...typeDefinitions
+      `import type { ${STORY_TYPE} } from '@storyblok/js';`,
+      storyblokTypesContent
     ].join("\n");
     const resolvedPath = path ? resolve(process.cwd(), path, "types") : resolvePath(path, "types");
     await saveToFile(join(resolvedPath, `${filename}.d.ts`), typeDefs);
@@ -3516,7 +3570,7 @@ typesCommand.command("generate").description("Generate types d.ts for your compo
   }
 });
 
-const version = "4.0.0-beta.2";
+const version = "4.0.0-beta.4";
 const pkg = {
 	version: version};
 
@@ -3533,6 +3587,19 @@ program.on("command:*", () => {
   konsola.br();
   program.help();
 });
+program.command("test").description("Test the CLI").action(async () => {
+  const { state, initializeSession } = session();
+  await initializeSession();
+  const { password, region } = state;
+  try {
+    const result = await fetchStories("85047", password, region, {
+      per_page: 100
+    });
+    console.log(result?.length);
+  } catch (error) {
+    console.error(error);
+  }
+});
 try {
   program.parse(process.argv);
 } catch (error) {