storyblok 4.3.3 → 4.4.0

package/dist/index.mjs

@@ -62,6 +62,13 @@ const regionsDomain = {
   ca: "api-ca.storyblok.com",
   ap: "api-ap.storyblok.com"
 };
+const managementApiRegions = {
+  eu: "mapi.storyblok.com",
+  us: "api-us.storyblok.com",
+  cn: "app.storyblokchina.cn",
+  ca: "api-ca.storyblok.com",
+  ap: "api-ap.storyblok.com"
+};
 const appDomains = {
   eu: "app.storyblok.com",
   us: "app-us.storyblok.com",
@@ -532,7 +539,7 @@ function getProgram() {
 
 const API_VERSION = "v1";
 const getStoryblokUrl = (region = "eu") => {
-  return `https://${regionsDomain[region]}/${API_VERSION}`;
+  return `https://${managementApiRegions[region]}/${API_VERSION}`;
 };
 
 const loginWithToken = async (token, region) => {
@@ -723,7 +730,7 @@ function createSession() {
   async function persistCredentials(region) {
     if (state.isLoggedIn && state.login && state.password && state.region) {
       await addCredentials({
-        machineName: regionsDomain[region] || "api.storyblok.com",
+        machineName: regionsDomain[region] || "mapi.storyblok.com",
         login: state.login,
         password: state.password,
         region: state.region
@@ -1003,6 +1010,7 @@ const getUser = async (token, region) => {
 const program$f = getProgram();
 program$f.command(commands.USER).description("Get the current user").action(async () => {
   konsola.title(`${commands.USER}`, colorPalette.USER);
+  const verbose = program$f.opts().verbose;
   const { state, initializeSession } = session();
   await initializeSession();
   if (!requireAuthentication(state)) {
@@ -1018,6 +1026,9 @@ program$f.command(commands.USER).description("Get the current user").action(asyn
     }
     const { user } = await getUser(password, region);
     spinner.succeed();
+    if (verbose) {
+      konsola.info(JSON.stringify(user, null, 2));
+    }
     konsola.ok(`Hi ${chalk.bold(user.friendly_name)}, you are currently logged in with ${chalk.hex(colorPalette.PRIMARY)(user.email)} on ${chalk.bold(region)} region`, true);
   } catch (error) {
     spinner.failed();
@@ -2838,18 +2849,21 @@ const fetchStories = async (space, params) => {
     const allStories = [];
     let currentPage = 1;
     let hasMorePages = true;
+    const perPage = 100;
     while (hasMorePages) {
       const { filter_query, ...restParams } = params || {};
       const regularParams = new URLSearchParams({
-        ...objectToStringParams({ ...restParams, per_page: 100 }),
+        ...objectToStringParams({ ...restParams, per_page: perPage }),
         ...currentPage > 1 && { page: currentPage.toString() }
       }).toString();
       const queryString = filter_query ? `${regularParams ? `${regularParams}&` : ""}${filter_query}` : regularParams;
       const endpoint = `spaces/${space}/stories${queryString ? `?${queryString}` : ""}`;
       const { data } = await client.get(endpoint, {});
       allStories.push(...data.stories);
-      const totalPages = Math.ceil(data.total / data.per_page);
-      hasMorePages = currentPage < totalPages;
+      hasMorePages = data.stories.length === perPage && data.stories.length > 0;
+      if (data.stories.length < perPage) {
+        break;
+      }
       currentPage++;
     }
     return allStories;
@@ -4668,7 +4682,12 @@ STORYBLOK_DELIVERY_API_TOKEN=${accessToken}
 };
 const generateSpaceUrl = (spaceId, region) => {
   const domain = appDomains[region];
-  return `https://${domain}/#/me/spaces/${spaceId}/dashboard`;
+  const utmParams = new URLSearchParams({
+    utm_source: "storyblok-cli",
+    utm_medium: "cli",
+    utm_campaign: "create"
+  });
+  return `https://${domain}/#/me/spaces/${spaceId}/dashboard?${utmParams.toString()}`;
 };
 const openSpaceInBrowser = async (spaceId, region) => {
   try {
@@ -4688,7 +4707,7 @@ const extractPortFromTopics = (topics) => {
   }
   return "3000";
 };
-const repositoryToBlueprint = (repo) => {
+const repositoryToTemplate = (repo) => {
   const technology = repo.name.replace("blueprint-core-", "");
   const port = extractPortFromTopics(repo.topics || []);
   return {
@@ -4709,7 +4728,7 @@ const fetchBlueprintRepositories = async () => {
       order: "desc",
       per_page: 100
     });
-    const blueprints = data.items.filter((repo) => repo.name.startsWith("blueprint-core-")).map(repositoryToBlueprint).sort((a, b) => a.name.localeCompare(b.name));
+    const blueprints = data.items.filter((repo) => repo.name.startsWith("blueprint-core-")).map(repositoryToTemplate).sort((a, b) => a.name.localeCompare(b.name));
     return blueprints;
   } catch (error) {
     handleAPIError("fetch_blueprints", error, "Failed to fetch blueprints from GitHub");
@@ -4729,10 +4748,17 @@ const createSpace = async (space) => {
 };
 
 const program$1 = getProgram();
-program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`Scaffold a new project using Storyblok`).option("-b, --blueprint <blueprint>", "technology starter blueprint").option("--skip-space", "skip space creation").action(async (projectPath, options) => {
+program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`Scaffold a new project using Storyblok`).option("-t, --template <template>", "technology starter template").option("-b, --blueprint <blueprint>", "[DEPRECATED] use --template instead").option("--skip-space", "skip space creation").action(async (projectPath, options) => {
   konsola.title(`${commands.CREATE}`, colorPalette.CREATE);
   const verbose = program$1.opts().verbose;
-  const { blueprint } = options;
+  const { template, blueprint } = options;
+  let selectedTemplate = template;
+  if (blueprint && !template) {
+    konsola.warn(`The --blueprint flag is deprecated. Please use --template instead.`);
+    selectedTemplate = blueprint;
+  } else if (blueprint && template) {
+    konsola.warn(`Both --blueprint and --template provided. Using --template and ignoring --blueprint.`);
+  }
   const { state, initializeSession } = session();
   await initializeSession();
   if (!requireAuthentication(state, verbose)) {
@@ -4749,33 +4775,42 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
   const spinnerSpace = new Spinner({
     verbose: !isVitest
   });
+  let userData;
   try {
-    spinnerBlueprints.start("Fetching starter blueprints...");
-    const blueprints = await fetchBlueprintRepositories();
-    spinnerBlueprints.succeed("Starter blueprints fetched successfully");
-    if (!blueprints) {
+    const { user } = await getUser(password, region);
+    userData = user;
+  } catch (error) {
+    konsola.error("Failed to fetch user info. Please login again.", error);
+    konsola.br();
+    return;
+  }
+  try {
+    spinnerBlueprints.start("Fetching starter templates...");
+    const templates = await fetchBlueprintRepositories();
+    spinnerBlueprints.succeed("Starter templates fetched successfully");
+    if (!templates) {
       spinnerBlueprints.failed();
-      konsola.warn("No starter blueprints found. Please contact support@storyblok.com");
+      konsola.warn("No starter templates found. Please contact support@storyblok.com");
       konsola.br();
       return;
     }
-    let technologyBlueprint = blueprint;
-    if (blueprint) {
-      const validBlueprints = blueprints;
-      const isValidBlueprint = validBlueprints.find((bp) => bp.value === blueprint);
-      if (!isValidBlueprint) {
-        const validOptions = validBlueprints.map((bp) => bp.value).join(", ");
-        konsola.warn(`Invalid blueprint "${chalk.hex(colorPalette.CREATE)(blueprint)}". Valid options are: ${chalk.hex(colorPalette.CREATE)(validOptions)}`);
+    let technologyTemplate = selectedTemplate;
+    if (selectedTemplate) {
+      const validTemplates = templates;
+      const isValidTemplate = validTemplates.find((bp) => bp.value === selectedTemplate);
+      if (!isValidTemplate) {
+        const validOptions = validTemplates.map((bp) => bp.value).join(", ");
+        konsola.warn(`Invalid template "${chalk.hex(colorPalette.CREATE)(selectedTemplate)}". Valid options are: ${chalk.hex(colorPalette.CREATE)(validOptions)}`);
         konsola.br();
-        technologyBlueprint = void 0;
+        technologyTemplate = void 0;
       }
     }
-    if (!technologyBlueprint) {
-      technologyBlueprint = await select({
+    if (!technologyTemplate) {
+      technologyTemplate = await select({
         message: "Please select the technology you would like to use:",
-        choices: blueprints.map((blueprint2) => ({
-          name: blueprint2.name,
-          value: blueprint2.value
+        choices: templates.map((template2) => ({
+          name: template2.name,
+          value: template2.value
         }))
       });
     }
@@ -4783,7 +4818,7 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
     if (!projectPath) {
       finalProjectPath = await input({
         message: "What is the path for your project?",
-        default: `./my-${technologyBlueprint}-project`,
+        default: `./my-${technologyTemplate}-project`,
         validate: (value) => {
           if (!value.trim()) {
             return "Project path is required";
@@ -4800,19 +4835,50 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
     const targetDirectory = path.dirname(resolvedPath);
     const projectName = path.basename(resolvedPath);
     konsola.br();
-    konsola.info(`Scaffolding your project using the ${chalk.hex(colorPalette.CREATE)(technologyBlueprint)} blueprint...`);
-    await generateProject(technologyBlueprint, projectName, targetDirectory);
+    konsola.info(`Scaffolding your project using the ${chalk.hex(colorPalette.CREATE)(technologyTemplate)} template...`);
+    await generateProject(technologyTemplate, projectName, targetDirectory);
     konsola.ok(`Project ${chalk.hex(colorPalette.PRIMARY)(projectName)} created successfully in ${chalk.hex(colorPalette.PRIMARY)(finalProjectPath)}`, true);
     let createdSpace;
+    const choices = [
+      { name: "My personal account", value: "personal" }
+    ];
+    if (userData.has_org) {
+      choices.push({ name: `Organization (${userData.org.name})`, value: "org" });
+    }
+    if (userData.has_partner) {
+      choices.push({ name: "Partner Portal", value: "partner" });
+    }
+    let whereToCreateSpace = "personal";
+    if (region === "eu" && (userData.has_partner || userData.has_org)) {
+      whereToCreateSpace = await select({
+        message: `Where would you like to create this space?`,
+        choices
+      });
+    }
+    if (region !== "eu" && userData.has_org) {
+      whereToCreateSpace = "org";
+    }
+    if (region !== "eu" && !userData.has_org) {
+      konsola.warn(`Space creation in this region is limited to Enterprise accounts. If you're part of an organization, please ensure you have the required permissions. For more information about Enterprise access, contact our Sales Team.`);
+      konsola.br();
+      return;
+    }
     if (!options.skipSpace) {
       try {
         spinnerSpace.start(`Creating space "${toHumanReadable(projectName)}"`);
-        const selectedBlueprint = blueprints.find((bp) => bp.value === technologyBlueprint);
+        const selectedBlueprint = templates.find((bp) => bp.value === technologyTemplate);
         const blueprintDomain = selectedBlueprint?.location || "https://localhost:3000/";
-        createdSpace = await createSpace({
+        const spaceToCreate = {
           name: toHumanReadable(projectName),
           domain: blueprintDomain
-        });
+        };
+        if (whereToCreateSpace === "org") {
+          spaceToCreate.org = userData.org;
+          spaceToCreate.in_org = true;
+        } else if (whereToCreateSpace === "partner") {
+          spaceToCreate.assign_partner = true;
+        }
+        createdSpace = await createSpace(spaceToCreate);
         spinnerSpace.succeed(`Space "${chalk.hex(colorPalette.PRIMARY)(toHumanReadable(projectName))}" created successfully`);
       } catch (error) {
         spinnerSpace.failed();
@@ -4841,9 +4907,15 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
       }
     }
     konsola.br();
-    konsola.ok(`Your ${chalk.hex(colorPalette.PRIMARY)(technologyBlueprint)} project is ready \u{1F389} !`);
+    konsola.ok(`Your ${chalk.hex(colorPalette.PRIMARY)(technologyTemplate)} project is ready \u{1F389} !`);
     if (createdSpace?.first_token) {
-      konsola.ok(`Storyblok space created, preview url and .env configured automatically`);
+      if (whereToCreateSpace === "org") {
+        konsola.ok(`Storyblok space created in organization ${chalk.hex(colorPalette.PRIMARY)(userData.org.name)}, preview url and .env configured automatically. You can now open your space in the browser at ${chalk.hex(colorPalette.PRIMARY)(generateSpaceUrl(createdSpace.id, region))}`);
+      } else if (whereToCreateSpace === "partner") {
+        konsola.ok(`Storyblok space created in partner portal, preview url and .env configured automatically. You can now open your space in the browser at ${chalk.hex(colorPalette.PRIMARY)(generateSpaceUrl(createdSpace.id, region))}`);
+      } else {
+        konsola.ok(`Storyblok space created, preview url and .env configured automatically. You can now open your space in the browser at ${chalk.hex(colorPalette.PRIMARY)(generateSpaceUrl(createdSpace.id, region))}`);
+      }
     }
     konsola.br();
     konsola.info(`Next steps:
@@ -4860,7 +4932,7 @@ program$1.command(`${commands.CREATE} [project-path]`).alias("c").description(`S
   konsola.br();
 });
 
-const version = "4.3.3";
+const version = "4.4.0";
 const pkg = {
 	version: version};