@strapi/cloud-cli 0.0.0-next.d7fa025a4eacdc27490fb1629b0efb93e3cb58b9 → 0.0.0-next.ea6e3b80ab37f554da4f8bde08dbfe9b57400d31

package/dist/index.mjs

@@ -1,6 +1,7 @@
 import crypto$1 from "crypto";
 import * as fse from "fs-extra";
 import fse__default from "fs-extra";
+import inquirer from "inquirer";
 import * as path from "path";
 import path__default from "path";
 import chalk from "chalk";
@@ -9,7 +10,6 @@ import * as crypto from "node:crypto";
 import { env } from "@strapi/utils";
 import * as tar from "tar";
 import { minimatch } from "minimatch";
-import inquirer from "inquirer";
 import { defaults, has } from "lodash/fp";
 import os from "os";
 import XDGAppPaths from "xdg-app-paths";
@@ -21,6 +21,7 @@ import * as cliProgress from "cli-progress";
 import pkgUp from "pkg-up";
 import * as yup from "yup";
 import EventSource from "eventsource";
+import { createCommand } from "commander";
 const apiConfig = {
   apiBaseUrl: env("STRAPI_CLI_CLOUD_API", "https://cloud-cli-api.strapi.io"),
   dashboardBaseUrl: env("STRAPI_CLI_CLOUD_DASHBOARD", "https://cloud.strapi.io")
@@ -133,7 +134,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.7";
+const version = "5.3.0";
 const description = "Commands to interact with the Strapi Cloud";
 const keywords = [
   "strapi",
@@ -178,14 +179,14 @@ const scripts = {
   watch: "pack-up watch"
 };
 const dependencies = {
-  "@strapi/utils": "4.25.7",
-  axios: "1.6.0",
+  "@strapi/utils": "workspace:*",
+  axios: "1.7.4",
   chalk: "4.1.2",
   "cli-progress": "3.12.0",
   commander: "8.3.0",
   eventsource: "2.0.2",
   "fast-safe-stringify": "2.1.1",
-  "fs-extra": "10.0.0",
+  "fs-extra": "11.2.0",
   inquirer: "8.2.5",
   jsonwebtoken: "9.0.0",
   "jwks-rsa": "3.1.0",
@@ -194,7 +195,7 @@ const dependencies = {
   open: "8.4.0",
   ora: "5.4.1",
   "pkg-up": "3.1.0",
-  tar: "6.1.13",
+  tar: "6.2.1",
   "xdg-app-paths": "8.3.0",
   yup: "0.32.9"
 };
@@ -203,11 +204,11 @@ const devDependencies = {
   "@types/cli-progress": "3.11.5",
   "@types/eventsource": "1.1.15",
   "@types/lodash": "^4.14.191",
-  "eslint-config-custom": "4.25.7",
-  tsconfig: "4.25.7"
+  "eslint-config-custom": "workspace:*",
+  tsconfig: "workspace:*"
 };
 const engines = {
-  node: ">=18.0.0 <=20.x.x",
+  node: ">=18.0.0 <=22.x.x",
   npm: ">=6.0.0"
 };
 const packageJson = {
@@ -257,7 +258,7 @@ async function cloudApiFactory({ logger }, token) {
     deploy({ filePath, project }, { onUploadProgress }) {
       return axiosCloudAPI.post(
         `/deploy/${project.name}`,
-        { file: fse__default.createReadStream(filePath) },
+        { file: fse__default.createReadStream(filePath), targetEnvironment: project.targetEnvironment },
         {
           headers: {
             "Content-Type": "multipart/form-data"
@@ -316,7 +317,7 @@ async function cloudApiFactory({ logger }, token) {
     },
     async listLinkProjects() {
       try {
-        const response = await axiosCloudAPI.get("/projects/linkable");
+        const response = await axiosCloudAPI.get("/projects-linkable");
         if (response.status !== 200) {
           throw new Error("Error fetching cloud projects from the server.");
         }
@@ -328,6 +329,34 @@ async function cloudApiFactory({ logger }, token) {
         throw error;
       }
     },
+    async listEnvironments({ name: name2 }) {
+      try {
+        const response = await axiosCloudAPI.get(`/projects/${name2}/environments`);
+        if (response.status !== 200) {
+          throw new Error("Error fetching cloud environments from the server.");
+        }
+        return response;
+      } catch (error) {
+        logger.debug(
+          "🥲 Oops! Couldn't retrieve your project's environments 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,
@@ -601,21 +630,24 @@ yup.object({
   name: yup.string().required(),
   exports: yup.lazy(
     (value) => yup.object(
-      typeof value === "object" ? Object.entries(value).reduce((acc, [key, value2]) => {
-        if (typeof value2 === "object") {
-          acc[key] = yup.object({
-            types: yup.string().optional(),
-            source: yup.string().required(),
-            module: yup.string().optional(),
-            import: yup.string().required(),
-            require: yup.string().required(),
-            default: yup.string().required()
-          }).noUnknown(true);
-        } else {
-          acc[key] = yup.string().matches(/^\.\/.*\.json$/).required();
-        }
-        return acc;
-      }, {}) : void 0
+      typeof value === "object" ? Object.entries(value).reduce(
+        (acc, [key, value2]) => {
+          if (typeof value2 === "object") {
+            acc[key] = yup.object({
+              types: yup.string().optional(),
+              source: yup.string().required(),
+              module: yup.string().optional(),
+              import: yup.string().required(),
+              require: yup.string().required(),
+              default: yup.string().required()
+            }).noUnknown(true);
+          } else {
+            acc[key] = yup.string().matches(/^\.\/.*\.json$/).required();
+          }
+          return acc;
+        },
+        {}
+      ) : void 0
     ).optional()
   )
 });
@@ -883,7 +915,7 @@ async function createProject$1(ctx, cloudApi, projectInput) {
     throw e;
   }
 }
-const action$4 = async (ctx) => {
+const action$5 = async (ctx) => {
   const { logger } = ctx;
   const { getValidToken, eraseToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
@@ -1012,6 +1044,32 @@ const buildLogsServiceFactory = ({ logger }) => {
     });
   };
 };
+const QUIT_OPTION$1 = "Quit";
+async function promptForEnvironment(environments) {
+  const choices = environments.map((env2) => ({ name: env2, value: env2 }));
+  const { selectedEnvironment } = await inquirer.prompt([
+    {
+      type: "list",
+      name: "selectedEnvironment",
+      message: "Select the environment to deploy:",
+      choices: [...choices, { name: chalk.grey(`(${QUIT_OPTION$1})`), value: null }]
+    }
+  ]);
+  if (selectedEnvironment === null) {
+    process.exit(1);
+  }
+  const { confirm } = await inquirer.prompt([
+    {
+      type: "confirm",
+      name: "confirm",
+      message: `Do you want to proceed with deployment to ${chalk.cyan(selectedEnvironment)}?`
+    }
+  ]);
+  if (!confirm) {
+    process.exit(1);
+  }
+  return selectedEnvironment;
+}
 async function upload(ctx, project, token, maxProjectFileSize) {
   const cloudApi = await cloudApiFactory(ctx, token);
   try {
@@ -1078,17 +1136,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.warn(
-            `The project does not exist. Please link your local project to a Strapi Cloud project using the link command.`
-          );
-        } 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);
@@ -1100,11 +1148,11 @@ async function upload(ctx, project, token, maxProjectFileSize) {
     process.exit(1);
   }
 }
-async function getProject(ctx) {
+async function getProject$1(ctx) {
   const { project } = await retrieve();
   if (!project) {
     try {
-      return await action$4(ctx);
+      return await action$5(ctx);
     } catch (e) {
       ctx.logger.error("An error occurred while deploying the project. Please try again later.");
       ctx.logger.debug(e);
@@ -1125,17 +1173,51 @@ async function getConfig({
     return null;
   }
 }
-const action$3 = async (ctx) => {
+const action$4 = async (ctx, opts) => {
   const { getValidToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
   if (!token) {
     return;
   }
-  const project = await getProject(ctx);
+  const project = await getProject$1(ctx);
   if (!project) {
     return;
   }
-  const cloudApiService = await cloudApiFactory(ctx);
+  const cloudApiService = await cloudApiFactory(ctx, token);
+  let environments;
+  try {
+    const {
+      data: { data: projectData, metadata }
+    } = await cloudApiService.getProject({ name: project.name });
+    const isProjectSuspended = projectData.suspendedAt;
+    environments = projectData.environments;
+    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) {
+    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
   });
@@ -1144,7 +1226,7 @@ const action$3 = async (ctx) => {
   const cliConfig2 = await getConfig({ ctx, cloudApiService });
   if (!cliConfig2) {
     ctx.logger.error(
-      "An error occurred while retrieving data from Strapi Cloud. Please try check your network or again later."
+      "An error occurred while retrieving data from Strapi Cloud. Please check your network or try again later."
     );
     return;
   }
@@ -1155,6 +1237,17 @@ const action$3 = async (ctx) => {
     );
     maxSize = 1e8;
   }
+  let targetEnvironment;
+  if (opts.environment) {
+    if (!environments.includes(opts.environment)) {
+      ctx.logger.error(`Environment ${opts.environment} does not exist.`);
+      return;
+    }
+    targetEnvironment = opts.environment;
+  } else {
+    targetEnvironment = environments.length > 1 ? await promptForEnvironment(environments) : environments[0];
+  }
+  project.targetEnvironment = targetEnvironment;
   const buildId = await upload(ctx, project, token, maxSize);
   if (!buildId) {
     return;
@@ -1204,14 +1297,14 @@ const runAction = (name2, action2) => (...args) => {
     process.exit(1);
   });
 };
-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 command$6 = ({ ctx }) => {
+  return createCommand("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").option("-e, --environment <name>", "Specify the environment to deploy").action((opts) => runAction("deploy", action$4)(ctx, opts));
 };
 const deployProject = {
   name: "deploy-project",
   description: "Deploy a Strapi Cloud project",
-  action: action$3,
-  command: command$5
+  action: action$4,
+  command: command$6
 };
 const QUIT_OPTION = "Quit";
 async function getExistingConfig(ctx) {
@@ -1295,7 +1388,7 @@ async function getUserSelection(ctx, projects) {
     return null;
   }
 }
-const action$2 = async (ctx) => {
+const action$3 = async (ctx) => {
   const { getValidToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
   const { logger } = ctx;
@@ -1350,17 +1443,17 @@ const action$2 = async (ctx) => {
     });
   }
 };
-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 command$5 = ({ 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$3)(ctx));
 };
 const link = {
   name: "link-project",
   description: "Link a local directory to a Strapi Cloud project",
-  action: action$2,
-  command: command$4
+  action: action$3,
+  command: command$5
 };
-const command$3 = ({ command: command2, ctx }) => {
-  command2.command("cloud:login").alias("login").description("Strapi Cloud Login").addHelpText(
+const command$4 = ({ ctx }) => {
+  return createCommand("cloud:login").alias("login").description("Strapi Cloud Login").addHelpText(
     "after",
     "\nAfter running this command, you will be prompted to enter your authentication information."
   ).option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("login", loginAction)(ctx));
@@ -1369,10 +1462,10 @@ const login = {
   name: "login",
   description: "Strapi Cloud Login",
   action: loginAction,
-  command: command$3
+  command: command$4
 };
 const openModule = import("open");
-const action$1 = async (ctx) => {
+const action$2 = async (ctx) => {
   const { logger } = ctx;
   const { retrieveToken, eraseToken } = await tokenServiceFactory(ctx);
   const token = await retrieveToken();
@@ -1404,25 +1497,25 @@ const action$1 = async (ctx) => {
   }
   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));
+const command$3 = ({ ctx }) => {
+  return createCommand("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$2)(ctx));
 };
 const logout = {
   name: "logout",
   description: "Strapi Cloud Logout",
-  action: action$1,
-  command: command$2
+  action: action$2,
+  command: command$3
 };
-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$4)(ctx));
+const command$2 = ({ ctx }) => {
+  return createCommand("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$5)(ctx));
 };
 const createProject = {
   name: "create-project",
   description: "Create a new project",
-  action: action$4,
-  command: command$1
+  action: action$5,
+  command: command$2
 };
-const action = async (ctx) => {
+const action$1 = async (ctx) => {
   const { getValidToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
   const { logger } = ctx;
@@ -1442,12 +1535,94 @@ const action = async (ctx) => {
     spinner.fail("An error occurred while fetching your projects from Strapi Cloud.");
   }
 };
-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("projects", action)(ctx));
+const command$1 = ({ 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("projects", action$1)(ctx));
 };
 const listProjects = {
   name: "list-projects",
   description: "List Strapi Cloud projects",
+  action: action$1,
+  command: command$1
+};
+async function getProject(ctx) {
+  const { project } = await retrieve();
+  if (!project) {
+    ctx.logger.warn(
+      `
+We couldn't find a valid local project config.
+Please link your local project to an existing Strapi Cloud project using the ${chalk.cyan(
+        "link"
+      )} command`
+    );
+    process.exit(1);
+  }
+  return project;
+}
+const action = async (ctx) => {
+  const { getValidToken } = await tokenServiceFactory(ctx);
+  const token = await getValidToken(ctx, promptLogin);
+  const { logger } = ctx;
+  if (!token) {
+    return;
+  }
+  const project = await getProject(ctx);
+  if (!project) {
+    ctx.logger.debug(`No valid local project configuration was found.`);
+    return;
+  }
+  const cloudApiService = await cloudApiFactory(ctx, token);
+  const spinner = logger.spinner("Fetching environments...").start();
+  await trackEvent(ctx, cloudApiService, "willListEnvironment", {
+    projectInternalName: project.name
+  });
+  try {
+    const {
+      data: { data: environmentsList }
+    } = await cloudApiService.listEnvironments({ name: project.name });
+    spinner.succeed();
+    logger.log(environmentsList);
+    await trackEvent(ctx, cloudApiService, "didListEnvironment", {
+      projectInternalName: project.name
+    });
+  } catch (e) {
+    if (e.response && e.response.status === 404) {
+      spinner.succeed();
+      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`
+      );
+    } else {
+      spinner.fail("An error occurred while fetching environments data from Strapi Cloud.");
+      logger.debug("Failed to list environments", e);
+    }
+    await trackEvent(ctx, cloudApiService, "didNotListEnvironment", {
+      projectInternalName: project.name
+    });
+  }
+};
+function defineCloudNamespace(command2, ctx) {
+  const cloud = command2.command("cloud").description("Manage Strapi Cloud projects");
+  cloud.command("environments").description("Alias for cloud environment list").action(() => runAction("list", action)(ctx));
+  return cloud;
+}
+let environmentCmd = null;
+const initializeEnvironmentCommand = (command2, ctx) => {
+  if (!environmentCmd) {
+    const cloud = defineCloudNamespace(command2, ctx);
+    environmentCmd = cloud.command("environment").description("Manage environments");
+  }
+  return environmentCmd;
+};
+const command = ({ command: command2, ctx }) => {
+  const environmentCmd2 = initializeEnvironmentCommand(command2, ctx);
+  environmentCmd2.command("list").description("List Strapi Cloud project environments").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("list", action)(ctx));
+};
+const listEnvironments = {
+  name: "list-environments",
+  description: "List Strapi Cloud environments",
   action,
   command
 };
@@ -1457,9 +1632,10 @@ const cli = {
   login,
   logout,
   createProject,
-  listProjects
+  listProjects,
+  listEnvironments
 };
-const cloudCommands = [deployProject, link, login, logout, listProjects];
+const cloudCommands = [deployProject, link, login, logout, listProjects, listEnvironments];
 async function initCloudCLIConfig() {
   const localConfig = await getLocalConfig();
   if (!localConfig.deviceId) {
@@ -1475,7 +1651,10 @@ async function buildStrapiCloudCommands({
   await initCloudCLIConfig();
   for (const cloudCommand of cloudCommands) {
     try {
-      await cloudCommand.command({ command: command2, ctx, argv });
+      const subCommand = await cloudCommand.command({ command: command2, ctx, argv });
+      if (subCommand) {
+        command2.addCommand(subCommand);
+      }
     } catch (e) {
       console.error(`Failed to load command ${cloudCommand.name}`, e);
     }