@strapi/cloud-cli 0.0.0-next.ae38a9dcdeddea4b4c0978686fb024413e5c54f5 → 0.0.0-next.aff9d09e4edf4d38b8a0de5abf83d79bedb28313

package/dist/index.mjs

@@ -20,7 +20,6 @@ import ora from "ora";
 import * as cliProgress from "cli-progress";
 import pkgUp from "pkg-up";
 import * as yup from "yup";
-import _ from "lodash";
 import EventSource from "eventsource";
 const apiConfig = {
   apiBaseUrl: env("STRAPI_CLI_CLOUD_API", "https://cloud-cli-api.strapi.io"),
@@ -134,7 +133,7 @@ async function saveLocalConfig(data) {
   await fse__default.writeJson(configFilePath, data, { encoding: "utf8", spaces: 2, mode: 384 });
 }
 const name = "@strapi/cloud-cli";
-const version = "4.25.4";
+const version = "4.25.8";
 const description = "Commands to interact with the Strapi Cloud";
 const keywords = [
   "strapi",
@@ -179,7 +178,7 @@ const scripts = {
   watch: "pack-up watch"
 };
 const dependencies = {
-  "@strapi/utils": "4.25.4",
+  "@strapi/utils": "4.25.8",
   axios: "1.6.0",
   chalk: "4.1.2",
   "cli-progress": "3.12.0",
@@ -204,8 +203,8 @@ const devDependencies = {
   "@types/cli-progress": "3.11.5",
   "@types/eventsource": "1.1.15",
   "@types/lodash": "^4.14.191",
-  "eslint-config-custom": "4.25.4",
-  tsconfig: "4.25.4"
+  "eslint-config-custom": "4.25.8",
+  tsconfig: "4.25.8"
 };
 const engines = {
   node: ">=18.0.0 <=20.x.x",
@@ -315,6 +314,34 @@ async function cloudApiFactory({ logger }, token) {
         throw error;
       }
     },
+    async listLinkProjects() {
+      try {
+        const response = await axiosCloudAPI.get("/projects/linkable");
+        if (response.status !== 200) {
+          throw new Error("Error fetching cloud projects from the server.");
+        }
+        return response;
+      } catch (error) {
+        logger.debug(
+          "🥲 Oops! Couldn't retrieve your project's list from the server. Please try again."
+        );
+        throw error;
+      }
+    },
+    async getProject({ name: name2 }) {
+      try {
+        const response = await axiosCloudAPI.get(`/projects/${name2}`);
+        if (response.status !== 200) {
+          throw new Error("Error fetching project's details.");
+        }
+        return response;
+      } catch (error) {
+        logger.debug(
+          "🥲 Oops! There was a problem retrieving your project's details. Please try again."
+        );
+        throw error;
+      }
+    },
     track(event, payload = {}) {
       return axiosCloudAPI.post("/track", {
         event,
@@ -624,18 +651,13 @@ async function getProjectNameFromPackageJson(ctx) {
     return "my-strapi-project";
   }
 }
-function applyDefaultName(newDefaultName, questions, defaultValues) {
-  const newDefaultValues = _.cloneDeep(defaultValues);
-  newDefaultValues.name = newDefaultName;
-  const newQuestions = questions.map((question) => {
-    const questionCopy = _.cloneDeep(question);
-    if (questionCopy.name === "name") {
-      questionCopy.default = newDefaultName;
-    }
-    return questionCopy;
-  });
-  return { newQuestions, newDefaultValues };
-}
+const trackEvent = async (ctx, cloudApiService, eventName, eventData) => {
+  try {
+    await cloudApiService.track(eventName, eventData);
+  } catch (e) {
+    ctx.logger.debug(`Failed to track ${eventName}`, e);
+  }
+};
 const openModule$1 = import("open");
 async function promptLogin(ctx) {
   const response = await inquirer.prompt([
@@ -656,13 +678,6 @@ async function loginAction(ctx) {
   const tokenService = await tokenServiceFactory(ctx);
   const existingToken = await tokenService.retrieveToken();
   const cloudApiService = await cloudApiFactory(ctx, existingToken || void 0);
-  const trackFailedLogin = async () => {
-    try {
-      await cloudApiService.track("didNotLogin", { loginMethod: "cli" });
-    } catch (e) {
-      logger.debug("Failed to track failed login", e);
-    }
-  };
   if (existingToken) {
     const isTokenValid = await tokenService.isTokenValid(existingToken);
     if (isTokenValid) {
@@ -694,11 +709,7 @@ async function loginAction(ctx) {
     logger.debug(e);
     return false;
   }
-  try {
-    await cloudApiService.track("willLoginAttempt", {});
-  } catch (e) {
-    logger.debug("Failed to track login attempt", e);
-  }
+  await trackEvent(ctx, cloudApiService, "willLoginAttempt", {});
   logger.debug("🔐 Creating device authentication request...", {
     client_id: cliConfig2.clientId,
     scope: cliConfig2.scope,
@@ -778,13 +789,13 @@ async function loginAction(ctx) {
             "There seems to be a problem with your login information. Please try logging in again."
           );
           spinnerFail();
-          await trackFailedLogin();
+          await trackEvent(ctx, cloudApiService, "didNotLogin", { loginMethod: "cli" });
           return false;
         }
         if (e.response?.data.error && !["authorization_pending", "slow_down"].includes(e.response.data.error)) {
           logger.debug(e);
           spinnerFail();
-          await trackFailedLogin();
+          await trackEvent(ctx, cloudApiService, "didNotLogin", { loginMethod: "cli" });
           return false;
         }
         await new Promise((resolve) => {
@@ -798,15 +809,50 @@ async function loginAction(ctx) {
       "To access your dashboard, please copy and paste the following URL into your web browser:"
     );
     logger.log(chalk.underline(`${apiConfig.dashboardBaseUrl}/projects`));
-    try {
-      await cloudApiService.track("didLogin", { loginMethod: "cli" });
-    } catch (e) {
-      logger.debug("Failed to track login", e);
-    }
+    await trackEvent(ctx, cloudApiService, "didLogin", { loginMethod: "cli" });
   };
   await authenticate();
   return isAuthenticated;
 }
+function questionDefaultValuesMapper(questionsMap) {
+  return (questions) => {
+    return questions.map((question) => {
+      const questionName = question.name;
+      if (questionName in questionsMap) {
+        const questionDefault = questionsMap[questionName];
+        if (typeof questionDefault === "function") {
+          return {
+            ...question,
+            default: questionDefault(question)
+          };
+        }
+        return {
+          ...question,
+          default: questionDefault
+        };
+      }
+      return question;
+    });
+  };
+}
+function getDefaultsFromQuestions(questions) {
+  return questions.reduce((acc, question) => {
+    if (question.default && question.name) {
+      return { ...acc, [question.name]: question.default };
+    }
+    return acc;
+  }, {});
+}
+function getProjectNodeVersionDefault(question) {
+  const currentNodeVersion = process.versions.node.split(".")[0];
+  if (question.type === "list" && Array.isArray(question.choices)) {
+    const choice = question.choices.find((choice2) => choice2.value === currentNodeVersion);
+    if (choice) {
+      return choice.value;
+    }
+  }
+  return question.default;
+}
 async function handleError(ctx, error) {
   const { logger } = ctx;
   logger.debug(error);
@@ -851,7 +897,7 @@ async function createProject$1(ctx, cloudApi, projectInput) {
     throw e;
   }
 }
-const action$3 = async (ctx) => {
+const action$4 = async (ctx) => {
   const { logger } = ctx;
   const { getValidToken, eraseToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
@@ -860,11 +906,16 @@ const action$3 = async (ctx) => {
   }
   const cloudApi = await cloudApiFactory(ctx, token);
   const { data: config } = await cloudApi.config();
-  const { newQuestions: questions, newDefaultValues: defaultValues } = applyDefaultName(
-    await getProjectNameFromPackageJson(ctx),
-    config.projectCreation.questions,
-    config.projectCreation.defaults
-  );
+  const projectName = await getProjectNameFromPackageJson(ctx);
+  const defaultAnswersMapper = questionDefaultValuesMapper({
+    name: projectName,
+    nodeVersion: getProjectNodeVersionDefault
+  });
+  const questions = defaultAnswersMapper(config.projectCreation.questions);
+  const defaultValues = {
+    ...config.projectCreation.defaults,
+    ...getDefaultsFromQuestions(questions)
+  };
   const projectAnswersDefaulted = defaults(defaultValues);
   const projectAnswers = await inquirer.prompt(questions);
   const projectInput = projectAnswersDefaulted(projectAnswers);
@@ -966,6 +1017,7 @@ const buildLogsServiceFactory = ({ logger }) => {
           if (retries > MAX_RETRIES) {
             spinner.fail("We were unable to connect to the server to get build logs at this time.");
             es.close();
+            clearExistingTimeout();
             reject(new Error("Max retries reached"));
           }
         };
@@ -1040,17 +1092,7 @@ async function upload(ctx, project, token, maxProjectFileSize) {
       return data.build_id;
     } catch (e) {
       progressBar.stop();
-      if (e instanceof AxiosError && e.response?.data) {
-        if (e.response.status === 404) {
-          ctx.logger.error(
-            `The project does not exist. Remove the ${LOCAL_SAVE_FILENAME} file and try again.`
-          );
-        } else {
-          ctx.logger.error(e.response.data);
-        }
-      } else {
-        ctx.logger.error("An error occurred while deploying the project. Please try again later.");
-      }
+      ctx.logger.error("An error occurred while deploying the project. Please try again later.");
       ctx.logger.debug(e);
     } finally {
       await fse__default.remove(tarFilePath);
@@ -1066,7 +1108,7 @@ async function getProject(ctx) {
   const { project } = await retrieve();
   if (!project) {
     try {
-      return await action$3(ctx);
+      return await action$4(ctx);
     } catch (e) {
       ctx.logger.error("An error occurred while deploying the project. Please try again later.");
       ctx.logger.debug(e);
@@ -1075,7 +1117,19 @@ async function getProject(ctx) {
   }
   return project;
 }
-const action$2 = async (ctx) => {
+async function getConfig({
+  ctx,
+  cloudApiService
+}) {
+  try {
+    const { data: cliConfig2 } = await cloudApiService.config();
+    return cliConfig2;
+  } catch (e) {
+    ctx.logger.debug("Failed to get cli config", e);
+    return null;
+  }
+}
+const action$3 = async (ctx) => {
   const { getValidToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
   if (!token) {
@@ -1085,15 +1139,51 @@ const action$2 = async (ctx) => {
   if (!project) {
     return;
   }
-  const cloudApiService = await cloudApiFactory(ctx);
+  const cloudApiService = await cloudApiFactory(ctx, token);
   try {
-    await cloudApiService.track("willDeployWithCLI", { projectInternalName: project.name });
+    const {
+      data: { data: projectData, metadata }
+    } = await cloudApiService.getProject({ name: project.name });
+    const isProjectSuspended = projectData.suspendedAt;
+    if (isProjectSuspended) {
+      ctx.logger.log(
+        "\n Oops! This project has been suspended. \n\n Please reactivate it from the dashboard to continue deploying: "
+      );
+      ctx.logger.log(chalk.underline(`${metadata.dashboardUrls.project}`));
+      return;
+    }
   } catch (e) {
-    ctx.logger.debug("Failed to track willDeploy", e);
+    if (e instanceof AxiosError && e.response?.data) {
+      if (e.response.status === 404) {
+        ctx.logger.warn(
+          `The project associated with this folder does not exist in Strapi Cloud. 
+Please link your local project to an existing Strapi Cloud project using the ${chalk.cyan(
+            "link"
+          )} command before deploying.`
+        );
+      } else {
+        ctx.logger.error(e.response.data);
+      }
+    } else {
+      ctx.logger.error(
+        "An error occurred while retrieving the project's information. Please try again later."
+      );
+    }
+    ctx.logger.debug(e);
+    return;
   }
+  await trackEvent(ctx, cloudApiService, "willDeployWithCLI", {
+    projectInternalName: project.name
+  });
   const notificationService = notificationServiceFactory(ctx);
   const buildLogsService = buildLogsServiceFactory(ctx);
-  const { data: cliConfig2 } = await cloudApiService.config();
+  const cliConfig2 = await getConfig({ ctx, cloudApiService });
+  if (!cliConfig2) {
+    ctx.logger.error(
+      "An error occurred while retrieving data from Strapi Cloud. Please check your network or try again later."
+    );
+    return;
+  }
   let maxSize = parseInt(cliConfig2.maxProjectFileSize, 10);
   if (Number.isNaN(maxSize)) {
     ctx.logger.debug(
@@ -1115,10 +1205,11 @@ const action$2 = async (ctx) => {
       chalk.underline(`${apiConfig.dashboardBaseUrl}/projects/${project.name}/deployments`)
     );
   } catch (e) {
+    ctx.logger.debug(e);
     if (e instanceof Error) {
       ctx.logger.error(e.message);
     } else {
-      throw e;
+      ctx.logger.error("An error occurred while deploying the project. Please try again later.");
     }
   }
 };
@@ -1149,12 +1240,158 @@ const runAction = (name2, action2) => (...args) => {
     process.exit(1);
   });
 };
-const command$4 = ({ command: command2, ctx }) => {
-  command2.command("cloud:deploy").alias("deploy").description("Deploy a Strapi Cloud project").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("deploy", action$2)(ctx));
+const command$5 = ({ command: command2, ctx }) => {
+  command2.command("cloud:deploy").alias("deploy").description("Deploy a Strapi Cloud project").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("deploy", action$3)(ctx));
 };
 const deployProject = {
   name: "deploy-project",
   description: "Deploy a Strapi Cloud project",
+  action: action$3,
+  command: command$5
+};
+const QUIT_OPTION = "Quit";
+async function getExistingConfig(ctx) {
+  try {
+    return await retrieve();
+  } catch (e) {
+    ctx.logger.debug("Failed to get project config", e);
+    ctx.logger.error("An error occurred while retrieving config data from your local project.");
+    return null;
+  }
+}
+async function promptForRelink(ctx, cloudApiService, existingConfig) {
+  if (existingConfig && existingConfig.project) {
+    const { shouldRelink } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "shouldRelink",
+        message: `A project named ${chalk.cyan(
+          existingConfig.project.displayName ? existingConfig.project.displayName : existingConfig.project.name
+        )} is already linked to this local folder. Do you want to update the link?`,
+        default: false
+      }
+    ]);
+    if (!shouldRelink) {
+      await trackEvent(ctx, cloudApiService, "didNotLinkProject", {
+        currentProjectName: existingConfig.project?.name
+      });
+      return false;
+    }
+  }
+  return true;
+}
+async function getProjectsList(ctx, cloudApiService, existingConfig) {
+  const spinner = ctx.logger.spinner("Fetching your projects...\n").start();
+  try {
+    const {
+      data: { data: projectList }
+    } = await cloudApiService.listLinkProjects();
+    spinner.succeed();
+    if (!Array.isArray(projectList)) {
+      ctx.logger.log("We couldn't find any projects available for linking in Strapi Cloud");
+      return null;
+    }
+    const projects = projectList.filter(
+      (project) => !(project.isMaintainer || project.name === existingConfig?.project?.name)
+    ).map((project) => {
+      return {
+        name: project.displayName,
+        value: { name: project.name, displayName: project.displayName }
+      };
+    });
+    if (projects.length === 0) {
+      ctx.logger.log("We couldn't find any projects available for linking in Strapi Cloud");
+      return null;
+    }
+    return projects;
+  } catch (e) {
+    spinner.fail("An error occurred while fetching your projects from Strapi Cloud.");
+    ctx.logger.debug("Failed to list projects", e);
+    return null;
+  }
+}
+async function getUserSelection(ctx, projects) {
+  const { logger } = ctx;
+  try {
+    const answer = await inquirer.prompt([
+      {
+        type: "list",
+        name: "linkProject",
+        message: "Which project do you want to link?",
+        choices: [...projects, { name: chalk.grey(`(${QUIT_OPTION})`), value: null }]
+      }
+    ]);
+    if (!answer.linkProject) {
+      return null;
+    }
+    return answer;
+  } catch (e) {
+    logger.debug("Failed to get user input", e);
+    logger.error("An error occurred while trying to get your input.");
+    return null;
+  }
+}
+const action$2 = async (ctx) => {
+  const { getValidToken } = await tokenServiceFactory(ctx);
+  const token = await getValidToken(ctx, promptLogin);
+  const { logger } = ctx;
+  if (!token) {
+    return;
+  }
+  const cloudApiService = await cloudApiFactory(ctx, token);
+  const existingConfig = await getExistingConfig(ctx);
+  const shouldRelink = await promptForRelink(ctx, cloudApiService, existingConfig);
+  if (!shouldRelink) {
+    return;
+  }
+  await trackEvent(ctx, cloudApiService, "willLinkProject", {});
+  const projects = await getProjectsList(
+    ctx,
+    cloudApiService,
+    existingConfig
+  );
+  if (!projects) {
+    return;
+  }
+  const answer = await getUserSelection(ctx, projects);
+  if (!answer) {
+    return;
+  }
+  try {
+    const { confirmAction } = await inquirer.prompt([
+      {
+        type: "confirm",
+        name: "confirmAction",
+        message: "Warning: Once linked, deploying from CLI will replace the existing project and its data. Confirm to proceed:",
+        default: false
+      }
+    ]);
+    if (!confirmAction) {
+      await trackEvent(ctx, cloudApiService, "didNotLinkProject", {
+        cancelledProjectName: answer.linkProject.name,
+        currentProjectName: existingConfig ? existingConfig.project?.name : null
+      });
+      return;
+    }
+    await save({ project: answer.linkProject });
+    logger.log(`Project ${chalk.cyan(answer.linkProject.displayName)} linked successfully.`);
+    await trackEvent(ctx, cloudApiService, "didLinkProject", {
+      projectInternalName: answer.linkProject
+    });
+  } catch (e) {
+    logger.debug("Failed to link project", e);
+    logger.error("An error occurred while linking the project.");
+    await trackEvent(ctx, cloudApiService, "didNotLinkProject", {
+      projectInternalName: answer.linkProject
+    });
+  }
+};
+const command$4 = ({ command: command2, ctx }) => {
+  command2.command("cloud:link").alias("link").description("Link a local directory to a Strapi Cloud project").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("link", action$2)(ctx));
+};
+const link = {
+  name: "link-project",
+  description: "Link a local directory to a Strapi Cloud project",
   action: action$2,
   command: command$4
 };
@@ -1201,11 +1438,7 @@ const action$1 = async (ctx) => {
     logger.error("🥲 Oops! Something went wrong while logging you out. Please try again.");
     logger.debug(e);
   }
-  try {
-    await cloudApiService.track("didLogout", { loginMethod: "cli" });
-  } catch (e) {
-    logger.debug("Failed to track logout event", e);
-  }
+  await trackEvent(ctx, cloudApiService, "didLogout", { loginMethod: "cli" });
 };
 const command$2 = ({ command: command2, ctx }) => {
   command2.command("cloud:logout").alias("logout").description("Strapi Cloud Logout").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("logout", action$1)(ctx));
@@ -1217,12 +1450,12 @@ const logout = {
   command: command$2
 };
 const command$1 = ({ command: command2, ctx }) => {
-  command2.command("cloud:create-project").description("Create a Strapi Cloud project").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("cloud:create-project", action$3)(ctx));
+  command2.command("cloud:create-project").description("Create a Strapi Cloud project").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("cloud:create-project", action$4)(ctx));
 };
 const createProject = {
   name: "create-project",
   description: "Create a new project",
-  action: action$3,
+  action: action$4,
   command: command$1
 };
 const action = async (ctx) => {
@@ -1246,7 +1479,7 @@ const action = async (ctx) => {
   }
 };
 const command = ({ command: command2, ctx }) => {
-  command2.command("cloud:projects").alias("projects").description("List Strapi Cloud projects").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("listProjects", action)(ctx));
+  command2.command("cloud:projects").alias("projects").description("List Strapi Cloud projects").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("projects", action)(ctx));
 };
 const listProjects = {
   name: "list-projects",
@@ -1256,12 +1489,13 @@ const listProjects = {
 };
 const cli = {
   deployProject,
+  link,
   login,
   logout,
   createProject,
   listProjects
 };
-const cloudCommands = [deployProject, login, logout, listProjects];
+const cloudCommands = [deployProject, link, login, logout, listProjects];
 async function initCloudCLIConfig() {
   const localConfig = await getLocalConfig();
   if (!localConfig.deviceId) {