storyblok 4.0.0-beta.1 → 4.0.0-beta.3

package/dist/index.mjs

@@ -1,17 +1,17 @@
 #!/usr/bin/env node
 import dotenv from 'dotenv';
 import { fileURLToPath } from 'node:url';
-import { dirname, resolve } from 'pathe';
+import { dirname } from 'pathe';
 import chalk from 'chalk';
 import { Command } from 'commander';
-import * as fs from 'node:fs';
-import { readFileSync } from 'node:fs';
+import { readPackageUp } from 'read-package-up';
 import { Spinner } from '@topcli/spinner';
 import { select, password, input } from '@inquirer/prompts';
 import { mkdir, writeFile, readFile as readFile$1, access, readdir } from 'node:fs/promises';
-import { join, parse, resolve as resolve$1 } from 'node:path';
+import { join, parse, resolve } from 'node:path';
 import { hash } from 'ohash';
 import { compile } from 'json-schema-to-typescript';
+import { readFileSync } from 'node:fs';
 
 const commands = {
   LOGIN: "login",
@@ -353,7 +353,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) {
@@ -425,7 +428,7 @@ const konsola = {
       const warnHeader = chalk.bgYellow.bold.black(` Warning `);
       console.warn(formatHeader(warnHeader));
     }
-    console.warn(message ? `${chalk.yellow("\u26A0\uFE0F")} ${message}` : "");
+    console.warn(message ? `${chalk.yellow("\u26A0\uFE0F ")} ${message}` : "");
   },
   error: (message, info, options) => {
     if (options?.header) {
@@ -447,13 +450,25 @@ function isRegion(value) {
 }
 const isVitest = process.env.VITEST === "true";
 
-const packageJsonPath = resolve(__dirname, process.env.VITEST || process.env.STUB ? "../../package.json" : "../package.json");
-const packageJson = JSON.parse(fs.readFileSync(packageJsonPath, "utf-8"));
+let packageJson;
+const result = await readPackageUp({
+  cwd: __dirname
+});
+if (!result) {
+  console.debug("Metadata not found");
+  packageJson = {
+    name: "storyblok",
+    description: "Storyblok CLI",
+    version: "0.0.0"
+  };
+} else {
+  packageJson = result.packageJson;
+}
 let programInstance = null;
 function getProgram() {
   if (!programInstance) {
     programInstance = new Command();
-    programInstance.name(packageJson.name).description(packageJson.description).version(packageJson.version);
+    programInstance.name(packageJson.name).description(packageJson.description || "").version(packageJson.version);
     programInstance.configureOutput({
       writeErr: (str) => handleError(new Error(str))
     });
@@ -539,9 +554,9 @@ const readFile = async (filePath) => {
 };
 const resolvePath = (path, folder) => {
   if (path) {
-    return resolve$1(process.cwd(), path, folder);
+    return resolve(process.cwd(), path, folder);
   }
-  return resolve$1(resolve$1(process.cwd(), ".storyblok"), folder);
+  return resolve(resolve(process.cwd(), ".storyblok"), folder);
 };
 const getComponentNameFromFilename = (filename) => {
   return filename.replace(/\.js$/, "");
@@ -551,14 +566,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 ({
@@ -592,7 +611,7 @@ function createSession() {
   const state = {
     isLoggedIn: false
   };
-  async function initializeSession(region = "eu") {
+  async function initializeSession() {
     const envCredentials = getEnvCredentials();
     if (envCredentials) {
       state.isLoggedIn = true;
@@ -602,9 +621,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;
@@ -688,31 +707,43 @@ const loginStrategy = {
 };
 program$d.command(commands.LOGIN).description("Login to the Storyblok CLI").option("-t, --token <token>", "Token to login directly without questions, like for CI environments").option(
   "-r, --region <region>",
-  `The region you would like to work in. Please keep in mind that the region must match the region of your space. This region flag will be used for the other cli's commands. You can use the values: ${allRegionsText}.`,
-  regions.EU
+  `The region you would like to work in. Please keep in mind that the region must match the region of your space. This region flag will be used for the other cli's commands. You can use the values: ${allRegionsText}.`
 ).action(async (options) => {
   konsola.title(` ${commands.LOGIN} `, colorPalette.LOGIN);
   const verbose = program$d.opts().verbose;
   const { token, region } = options;
-  if (!isRegion(region)) {
-    handleError(new CommandError(`The provided region: ${region} is not valid. Please use one of the following values: ${Object.values(regions).join(" | ")}`));
-  }
   const { state, updateSession, persistCredentials, initializeSession } = session();
   await initializeSession();
   if (state.isLoggedIn && !state.envLogin) {
     konsola.ok(`You are already logged in. If you want to login with a different account, please logout first.`);
     return;
   }
+  if (region && !isRegion(region)) {
+    handleError(new CommandError(`The provided region: ${region} is not valid. Please use one of the following values: ${Object.values(regions).join(" | ")}`));
+    return;
+  }
   if (token) {
     const spinner = new Spinner({
       verbose: !isVitest
-    }).start(`Logging in with token`);
+    });
     try {
-      const { user } = await loginWithToken(token, region);
-      updateSession(user.email, token, region);
-      await persistCredentials(region);
+      let userRegion = region;
+      if (!userRegion) {
+        userRegion = await select({
+          message: "Please select the region you would like to work in:",
+          choices: Object.values(regions).map((region2) => ({
+            name: regionNames[region2],
+            value: region2
+          })),
+          default: regions.EU
+        });
+      }
+      spinner.start(`Logging in with token`);
+      const { user } = await loginWithToken(token, userRegion);
+      updateSession(user.email, token, userRegion);
+      await persistCredentials(userRegion);
       spinner.succeed();
-      konsola.ok(`Successfully logged in. Welcome ${chalk.hex(colorPalette.PRIMARY)(user.friendly_name)}.`, true);
+      konsola.ok(`Successfully logged in to region ${chalk.hex(colorPalette.PRIMARY)(`${regionNames[userRegion]} (${userRegion})`)}. Welcome ${chalk.hex(colorPalette.PRIMARY)(user.friendly_name)}.`, true);
     } catch (error) {
       spinner.failed();
       konsola.br();
@@ -736,7 +767,7 @@ program$d.command(commands.LOGIN).description("Login to the Storyblok CLI").opti
         spinner.succeed();
         updateSession(user.email, userToken, region);
         await persistCredentials(region);
-        konsola.ok(`Successfully logged in. Welcome ${chalk.hex(colorPalette.PRIMARY)(user.friendly_name)}.`, true);
+        konsola.ok(`Successfully logged in to region ${chalk.hex(colorPalette.PRIMARY)(`${regionNames[region]} (${region})`)}. Welcome ${chalk.hex(colorPalette.PRIMARY)(user.friendly_name)}.`, true);
       } else {
         const userEmail = await input({
           message: "Please enter your email address:",
@@ -749,14 +780,17 @@ program$d.command(commands.LOGIN).description("Login to the Storyblok CLI").opti
         const userPassword = await password({
           message: "Please enter your password:"
         });
-        const userRegion = await select({
-          message: "Please select the region you would like to work in:",
-          choices: Object.values(regions).map((region2) => ({
-            name: regionNames[region2],
-            value: region2
-          })),
-          default: regions.EU
-        });
+        let userRegion = region;
+        if (!userRegion) {
+          userRegion = await select({
+            message: "Please select the region you would like to work in:",
+            choices: Object.values(regions).map((region2) => ({
+              name: regionNames[region2],
+              value: region2
+            })),
+            default: regions.EU
+          });
+        }
         spinner.start(`Logging in with email`);
         spinner.succeed();
         const response = await loginWithEmailAndPassword(userEmail, userPassword, userRegion);
@@ -773,7 +807,7 @@ program$d.command(commands.LOGIN).description("Login to the Storyblok CLI").opti
           updateSession(userEmail, response.access_token, userRegion);
         }
         await persistCredentials(region);
-        konsola.ok(`Successfully logged in. Welcome ${chalk.hex(colorPalette.PRIMARY)(userEmail)}.`, true);
+        konsola.ok(`Successfully logged in to region ${chalk.hex(colorPalette.PRIMARY)(`${regionNames[userRegion]} (${userRegion})`)}. Welcome ${chalk.hex(colorPalette.PRIMARY)(userEmail)}.`, true);
       }
     } catch (error) {
       spinner.failed();
@@ -880,7 +914,7 @@ const fetchComponent = async (space, componentName, token, region) => {
         Authorization: token
       }
     });
-    return response.components?.[0];
+    return response.components?.find((c) => c.name === componentName);
   } catch (error) {
     handleAPIError("pull_components", error, `Failed to fetch component ${componentName}`);
   }
@@ -927,7 +961,7 @@ const fetchComponentInternalTags = async (space, token, region) => {
 const saveComponentsToFiles = async (space, spaceData, options) => {
   const { components = [], groups = [], presets = [], internalTags = [] } = spaceData;
   const { filename = "components", suffix, path, separateFiles } = options;
-  const resolvedPath = path ? resolve$1(process.cwd(), path, "components", space) : resolvePath(path, `components/${space}`);
+  const resolvedPath = path ? resolve(process.cwd(), path, "components", space) : resolvePath(path, `components/${space}`);
   try {
     if (separateFiles) {
       for (const component of components) {
@@ -1095,7 +1129,7 @@ const upsertComponentPreset = async (space, preset, token, region) => {
       const responseData = error.response?.data;
       if (responseData?.name?.[0] === "has already been taken") {
         const existingPresets = await fetchComponentPresets(space, token, region);
-        const existingPreset = existingPresets?.find((p) => p.name === preset.name);
+        const existingPreset = existingPresets?.find((p) => p.name === preset.name && p.component_id === preset.component_id);
         if (existingPreset) {
           return await updateComponentPreset(space, existingPreset.id, { preset }, token, region);
         }
@@ -1421,7 +1455,7 @@ function findRelatedResources(components, spaceData) {
     let currentGroup = groupsMap.get(groupUuid);
     while (currentGroup) {
       relatedGroups.add(currentGroup);
-      if (currentGroup.parent_uuid && currentGroup.parent_uuid.length > 0) {
+      if (currentGroup.parent_uuid && currentGroup.parent_uuid.length > 0 && currentGroup.parent_uuid !== currentGroup.uuid) {
         currentGroup = groupsMap.get(currentGroup.parent_uuid);
       } else {
         currentGroup = void 0;
@@ -1521,7 +1555,7 @@ async function handleComponentGroups(space, password, region, spaceData, skipUui
     // Maps old IDs to new IDs
   };
   const groupsToProcess = skipUuids ? spaceData.filter((group) => !skipUuids.has(group.uuid)) : spaceData;
-  const rootGroups = groupsToProcess.filter((group) => !group.parent_uuid && !group.parent_id);
+  const rootGroups = groupsToProcess.filter((group) => (!group.parent_uuid || group.parent_uuid === group.uuid) && !group.parent_id);
   for (const group of rootGroups) {
     const spinner = new Spinner({
       verbose: !isVitest
@@ -1648,7 +1682,7 @@ function updateSchemaWhitelists(schema, groupsUuidMap, tagsIdMap, componentNameM
 function getGroupHierarchy(group, allGroups) {
   const hierarchy = [group];
   let currentGroup = group;
-  while (currentGroup.parent_uuid && currentGroup.parent_uuid.length > 0) {
+  while (currentGroup.parent_uuid && currentGroup.parent_uuid.length > 0 && currentGroup.parent_uuid !== currentGroup.uuid) {
     const parentGroup = allGroups.find((g) => g.uuid === currentGroup.parent_uuid);
     if (parentGroup) {
       hierarchy.unshift(parentGroup);
@@ -2119,7 +2153,9 @@ languagesCommand.command("pull").description(`Download your space's languages sc
     spinner.start(`Fetching ${chalk.hex(colorPalette.LANGUAGES)("languages")}`);
     const internationalization = await fetchLanguages(space, state.password, state.region);
     if (!internationalization || internationalization.languages?.length === 0) {
-      konsola.warn(`No languages found in the space ${space}`);
+      spinner.failed();
+      konsola.warn(`No languages found in the space ${space}`, true);
+      konsola.br();
       return;
     }
     await saveLanguagesToFile(space, internationalization, {
@@ -2157,7 +2193,7 @@ const getMigrationTemplate = () => {
 `;
 };
 const generateMigration = async (space, path, component, suffix) => {
-  const resolvedPath = path ? resolve$1(process.cwd(), path, "migrations", space) : resolvePath(path, `migrations/${space}`);
+  const resolvedPath = path ? resolve(process.cwd(), path, "migrations", space) : resolvePath(path, `migrations/${space}`);
   const fileName = suffix ? `${component.name}.${suffix}.js` : `${component.name}.js`;
   const migrationPath = join(resolvedPath, fileName);
   try {
@@ -3194,18 +3230,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" };
@@ -3222,6 +3307,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, "");
@@ -3237,7 +3325,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) : {};
@@ -3294,7 +3382,7 @@ const getComponentPropertiesTypeAnnotations = async (component, options, spaceDa
 };
 const loadCustomFieldsParser = async (path) => {
   try {
-    const customFieldsParser = await import(resolve$1(path));
+    const customFieldsParser = await import(resolve(path));
     return customFieldsParser.default;
   } catch (error) {
     handleError(error);
@@ -3303,7 +3391,7 @@ const loadCustomFieldsParser = async (path) => {
 };
 async function loadCompilerOptions(path) {
   if (path) {
-    const compilerOptions = await import(resolve$1(path));
+    const compilerOptions = await import(resolve(path));
     return compilerOptions.default;
   }
   return {};
@@ -3325,7 +3413,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];
@@ -3385,7 +3473,7 @@ const generateTypes = async (spaceData, options = {
 };
 const saveTypesToFile = async (space, typedefString, options) => {
   const { filename = "storyblok-components", path } = options;
-  const resolvedPath = path ? resolve$1(process.cwd(), path, "types", space) : resolvePath(path, `types/${space}`);
+  const resolvedPath = path ? resolve(process.cwd(), path, "types", space) : resolvePath(path, `types/${space}`);
   try {
     await saveToFile(join(resolvedPath, `${filename}.d.ts`), typedefString);
   } catch (error) {
@@ -3395,47 +3483,14 @@ const saveTypesToFile = async (space, typedefString, options) => {
 const generateStoryblokTypes = async (options = {}) => {
   const { filename = "storyblok", path } = options;
   try {
-    const storyblokTypesPath = resolve$1(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
+      storyblokTypesContent
     ].join("\n");
-    const resolvedPath = path ? resolve$1(process.cwd(), path, "types") : resolvePath(path, "types");
+    const resolvedPath = path ? resolve(process.cwd(), path, "types") : resolvePath(path, "types");
     await saveToFile(join(resolvedPath, `${filename}.d.ts`), typeDefs);
     return true;
   } catch (error) {
@@ -3487,7 +3542,7 @@ typesCommand.command("generate").description("Generate types d.ts for your compo
   }
 });
 
-const version = "4.0.0-beta.1";
+const version = "4.0.0-beta.3";
 const pkg = {
 	version: version};
 
@@ -3509,3 +3564,4 @@ try {
 } catch (error) {
   handleError(error);
 }
+//# sourceMappingURL=index.mjs.map