@strapi/cloud-cli 4.25.2 → 4.25.4

package/dist/index.mjs

@@ -1,12 +1,12 @@
 import crypto$1 from "crypto";
-import fse from "fs-extra";
+import * as fse from "fs-extra";
+import fse__default from "fs-extra";
 import * as path from "path";
 import path__default from "path";
 import chalk from "chalk";
 import axios, { AxiosError } from "axios";
 import * as crypto from "node:crypto";
 import { env } from "@strapi/utils";
-import * as fs from "fs";
 import * as tar from "tar";
 import { minimatch } from "minimatch";
 import inquirer from "inquirer";
@@ -18,10 +18,10 @@ import jwt from "jsonwebtoken";
 import stringify from "fast-safe-stringify";
 import ora from "ora";
 import * as cliProgress from "cli-progress";
-import EventSource from "eventsource";
-import fs$1 from "fs/promises";
 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"),
   dashboardBaseUrl: env("STRAPI_CLI_CLOUD_DASHBOARD", "https://cloud.strapi.io")
@@ -40,23 +40,6 @@ const IGNORED_PATTERNS = [
   "**/.idea/**",
   "**/.vscode/**"
 ];
-const getFiles = (dirPath, ignorePatterns = [], arrayOfFiles = [], subfolder = "") => {
-  const entries = fs.readdirSync(path.join(dirPath, subfolder));
-  entries.forEach((entry) => {
-    const entryPathFromRoot = path.join(subfolder, entry);
-    const entryPath = path.relative(dirPath, entryPathFromRoot);
-    const isIgnored = isIgnoredFile(dirPath, entryPathFromRoot, ignorePatterns);
-    if (isIgnored) {
-      return;
-    }
-    if (fs.statSync(entryPath).isDirectory()) {
-      getFiles(dirPath, ignorePatterns, arrayOfFiles, entryPathFromRoot);
-    } else {
-      arrayOfFiles.push(entryPath);
-    }
-  });
-  return arrayOfFiles;
-};
 const isIgnoredFile = (folderPath, file, ignorePatterns) => {
   ignorePatterns.push(...IGNORED_PATTERNS);
   const relativeFilePath = path.join(folderPath, file);
@@ -74,16 +57,35 @@ const isIgnoredFile = (folderPath, file, ignorePatterns) => {
   }
   return isIgnored;
 };
-const readGitignore = (folderPath) => {
+const getFiles = async (dirPath, ignorePatterns = [], subfolder = "") => {
+  const arrayOfFiles = [];
+  const entries = await fse.readdir(path.join(dirPath, subfolder));
+  for (const entry of entries) {
+    const entryPathFromRoot = path.join(subfolder, entry);
+    const entryPath = path.relative(dirPath, entryPathFromRoot);
+    const isIgnored = isIgnoredFile(dirPath, entryPathFromRoot, ignorePatterns);
+    if (!isIgnored) {
+      if (fse.statSync(entryPath).isDirectory()) {
+        const subFiles = await getFiles(dirPath, ignorePatterns, entryPathFromRoot);
+        arrayOfFiles.push(...subFiles);
+      } else {
+        arrayOfFiles.push(entryPath);
+      }
+    }
+  }
+  return arrayOfFiles;
+};
+const readGitignore = async (folderPath) => {
   const gitignorePath = path.resolve(folderPath, ".gitignore");
-  if (!fs.existsSync(gitignorePath))
+  const pathExist = await fse.pathExists(gitignorePath);
+  if (!pathExist)
     return [];
-  const gitignoreContent = fs.readFileSync(gitignorePath, "utf8");
+  const gitignoreContent = await fse.readFile(gitignorePath, "utf8");
   return gitignoreContent.split(/\r?\n/).filter((line) => Boolean(line.trim()) && !line.startsWith("#"));
 };
 const compressFilesToTar = async (storagePath, folderToCompress, filename) => {
-  const ignorePatterns = readGitignore(folderToCompress);
-  const filesToCompress = getFiles(folderToCompress, ignorePatterns);
+  const ignorePatterns = await readGitignore(folderToCompress);
+  const filesToCompress = await getFiles(folderToCompress, ignorePatterns);
   return tar.c(
     {
       gzip: true,
@@ -96,7 +98,7 @@ const APP_FOLDER_NAME = "com.strapi.cli";
 const CONFIG_FILENAME = "config.json";
 async function checkDirectoryExists(directoryPath) {
   try {
-    const fsStat = await fse.lstat(directoryPath);
+    const fsStat = await fse__default.lstat(directoryPath);
     return fsStat.isDirectory();
   } catch (e) {
     return false;
@@ -104,14 +106,14 @@ async function checkDirectoryExists(directoryPath) {
 }
 async function getTmpStoragePath() {
   const storagePath = path__default.join(os.tmpdir(), APP_FOLDER_NAME);
-  await fse.ensureDir(storagePath);
+  await fse__default.ensureDir(storagePath);
   return storagePath;
 }
 async function getConfigPath() {
   const configDirs = XDGAppPaths(APP_FOLDER_NAME).configDirs();
   const configPath = configDirs.find(checkDirectoryExists);
   if (!configPath) {
-    await fse.ensureDir(configDirs[0]);
+    await fse__default.ensureDir(configDirs[0]);
     return configDirs[0];
   }
   return configPath;
@@ -119,9 +121,9 @@ async function getConfigPath() {
 async function getLocalConfig() {
   const configPath = await getConfigPath();
   const configFilePath = path__default.join(configPath, CONFIG_FILENAME);
-  await fse.ensureFile(configFilePath);
+  await fse__default.ensureFile(configFilePath);
   try {
-    return await fse.readJSON(configFilePath, { encoding: "utf8", throws: true });
+    return await fse__default.readJSON(configFilePath, { encoding: "utf8", throws: true });
   } catch (e) {
     return {};
   }
@@ -129,10 +131,10 @@ async function getLocalConfig() {
 async function saveLocalConfig(data) {
   const configPath = await getConfigPath();
   const configFilePath = path__default.join(configPath, CONFIG_FILENAME);
-  await fse.writeJson(configFilePath, data, { encoding: "utf8", spaces: 2, mode: 384 });
+  await fse__default.writeJson(configFilePath, data, { encoding: "utf8", spaces: 2, mode: 384 });
 }
 const name = "@strapi/cloud-cli";
-const version = "4.25.1";
+const version = "4.25.3";
 const description = "Commands to interact with the Strapi Cloud";
 const keywords = [
   "strapi",
@@ -173,10 +175,11 @@ const scripts = {
   build: "pack-up build",
   clean: "run -T rimraf ./dist",
   lint: "run -T eslint .",
+  "test:unit": "run -T jest",
   watch: "pack-up watch"
 };
 const dependencies = {
-  "@strapi/utils": "4.25.1",
+  "@strapi/utils": "4.25.3",
   axios: "1.6.0",
   chalk: "4.1.2",
   "cli-progress": "3.12.0",
@@ -201,8 +204,8 @@ const devDependencies = {
   "@types/cli-progress": "3.11.5",
   "@types/eventsource": "1.1.15",
   "@types/lodash": "^4.14.191",
-  "eslint-config-custom": "4.25.1",
-  tsconfig: "4.25.1"
+  "eslint-config-custom": "4.25.3",
+  tsconfig: "4.25.3"
 };
 const engines = {
   node: ">=18.0.0 <=20.x.x",
@@ -255,7 +258,7 @@ async function cloudApiFactory({ logger }, token) {
     deploy({ filePath, project }, { onUploadProgress }) {
       return axiosCloudAPI.post(
         `/deploy/${project.name}`,
-        { file: fse.createReadStream(filePath) },
+        { file: fse__default.createReadStream(filePath) },
         {
           headers: {
             "Content-Type": "multipart/form-data"
@@ -298,8 +301,19 @@ async function cloudApiFactory({ logger }, token) {
         throw error;
       }
     },
-    listProjects() {
-      return axiosCloudAPI.get("/projects");
+    async listProjects() {
+      try {
+        const response = await axiosCloudAPI.get("/projects");
+        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;
+      }
     },
     track(event, payload = {}) {
       return axiosCloudAPI.post("/track", {
@@ -314,18 +328,18 @@ async function save(data, { directoryPath } = {}) {
   const alreadyInFileData = await retrieve({ directoryPath });
   const storedData = { ...alreadyInFileData, ...data };
   const pathToFile = path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
-  await fse.ensureDir(path__default.dirname(pathToFile));
-  await fse.writeJson(pathToFile, storedData, { encoding: "utf8" });
+  await fse__default.ensureDir(path__default.dirname(pathToFile));
+  await fse__default.writeJson(pathToFile, storedData, { encoding: "utf8" });
 }
 async function retrieve({
   directoryPath
 } = {}) {
   const pathToFile = path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
-  const pathExists = await fse.pathExists(pathToFile);
+  const pathExists = await fse__default.pathExists(pathToFile);
   if (!pathExists) {
     return {};
   }
-  return fse.readJSON(pathToFile, { encoding: "utf8" });
+  return fse__default.readJSON(pathToFile, { encoding: "utf8" });
 }
 const strapiInfoSave = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null,
@@ -570,6 +584,58 @@ const index = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.definePropert
   local: strapiInfoSave,
   tokenServiceFactory
 }, Symbol.toStringTag, { value: "Module" }));
+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
+    ).optional()
+  )
+});
+const loadPkg = async ({ cwd, logger }) => {
+  const pkgPath = await pkgUp({ cwd });
+  if (!pkgPath) {
+    throw new Error("Could not find a package.json in the current directory");
+  }
+  const buffer = await fse.readFile(pkgPath);
+  const pkg = JSON.parse(buffer.toString());
+  logger.debug("Loaded package.json:", os.EOL, pkg);
+  return pkg;
+};
+async function getProjectNameFromPackageJson(ctx) {
+  try {
+    const packageJson2 = await loadPkg(ctx);
+    return packageJson2.name || "my-strapi-project";
+  } catch (e) {
+    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 openModule$1 = import("open");
 async function promptLogin(ctx) {
   const response = await inquirer.prompt([
@@ -785,7 +851,7 @@ async function createProject$1(ctx, cloudApi, projectInput) {
     throw e;
   }
 }
-const action$2 = async (ctx) => {
+const action$3 = async (ctx) => {
   const { logger } = ctx;
   const { getValidToken, eraseToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
@@ -794,7 +860,11 @@ const action$2 = async (ctx) => {
   }
   const cloudApi = await cloudApiFactory(ctx, token);
   const { data: config } = await cloudApi.config();
-  const { questions, defaults: defaultValues } = config.projectCreation;
+  const { newQuestions: questions, newDefaultValues: defaultValues } = applyDefaultName(
+    await getProjectNameFromPackageJson(ctx),
+    config.projectCreation.questions,
+    config.projectCreation.defaults
+  );
   const projectAnswersDefaulted = defaults(defaultValues);
   const projectAnswers = await inquirer.prompt(questions);
   const projectInput = projectAnswersDefaulted(projectAnswers);
@@ -843,38 +913,6 @@ function notificationServiceFactory({ logger }) {
     };
   };
 }
-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
-    ).optional()
-  )
-});
-const loadPkg = async ({ cwd, logger }) => {
-  const pkgPath = await pkgUp({ cwd });
-  if (!pkgPath) {
-    throw new Error("Could not find a package.json in the current directory");
-  }
-  const buffer = await fs$1.readFile(pkgPath);
-  const pkg = JSON.parse(buffer.toString());
-  logger.debug("Loaded package.json:", os.EOL, pkg);
-  return pkg;
-};
 const buildLogsServiceFactory = ({ logger }) => {
   return async (url, token, cliConfig2) => {
     const CONN_TIMEOUT = Number(cliConfig2.buildLogsConnectionTimeout);
@@ -970,13 +1008,13 @@ async function upload(ctx, project, token, maxProjectFileSize) {
       process.exit(1);
     }
     const tarFilePath = path__default.resolve(storagePath, compressedFilename);
-    const fileStats = await fse.stat(tarFilePath);
+    const fileStats = await fse__default.stat(tarFilePath);
     if (fileStats.size > maxProjectFileSize) {
       ctx.logger.log(
         "Unable to proceed: Your project is too big to be transferred, please use a git repo instead."
       );
       try {
-        await fse.remove(tarFilePath);
+        await fse__default.remove(tarFilePath);
       } catch (e) {
         ctx.logger.log("Unable to remove file: ", tarFilePath);
         ctx.logger.debug(e);
@@ -1015,7 +1053,7 @@ async function upload(ctx, project, token, maxProjectFileSize) {
       }
       ctx.logger.debug(e);
     } finally {
-      await fse.remove(tarFilePath);
+      await fse__default.remove(tarFilePath);
     }
     process.exit(0);
   } catch (e) {
@@ -1028,7 +1066,7 @@ async function getProject(ctx) {
   const { project } = await retrieve();
   if (!project) {
     try {
-      return await action$2(ctx);
+      return await action$3(ctx);
     } catch (e) {
       ctx.logger.error("An error occurred while deploying the project. Please try again later.");
       ctx.logger.debug(e);
@@ -1037,7 +1075,7 @@ async function getProject(ctx) {
   }
   return project;
 }
-const action$1 = async (ctx) => {
+const action$2 = async (ctx) => {
   const { getValidToken } = await tokenServiceFactory(ctx);
   const token = await getValidToken(ctx, promptLogin);
   if (!token) {
@@ -1111,16 +1149,16 @@ const runAction = (name2, action2) => (...args) => {
     process.exit(1);
   });
 };
-const command$3 = ({ 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$1)(ctx));
+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 deployProject = {
   name: "deploy-project",
   description: "Deploy a Strapi Cloud project",
-  action: action$1,
-  command: command$3
+  action: action$2,
+  command: command$4
 };
-const command$2 = ({ command: command2, ctx }) => {
+const command$3 = ({ command: command2, ctx }) => {
   command2.command("cloud:login").alias("login").description("Strapi Cloud Login").addHelpText(
     "after",
     "\nAfter running this command, you will be prompted to enter your authentication information."
@@ -1130,10 +1168,10 @@ const login = {
   name: "login",
   description: "Strapi Cloud Login",
   action: loginAction,
-  command: command$2
+  command: command$3
 };
 const openModule = import("open");
-const action = async (ctx) => {
+const action$1 = async (ctx) => {
   const { logger } = ctx;
   const { retrieveToken, eraseToken } = await tokenServiceFactory(ctx);
   const token = await retrieveToken();
@@ -1169,31 +1207,61 @@ const action = async (ctx) => {
     logger.debug("Failed to track logout event", e);
   }
 };
-const command$1 = ({ 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)(ctx));
+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 logout = {
   name: "logout",
   description: "Strapi Cloud Logout",
-  action,
-  command: command$1
+  action: action$1,
+  command: command$2
 };
-const command = ({ 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$2)(ctx));
+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));
 };
 const createProject = {
   name: "create-project",
   description: "Create a new project",
-  action: action$2,
+  action: action$3,
+  command: command$1
+};
+const action = 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 spinner = logger.spinner("Fetching your projects...").start();
+  try {
+    const {
+      data: { data: projectList }
+    } = await cloudApiService.listProjects();
+    spinner.succeed();
+    logger.log(projectList);
+  } catch (e) {
+    ctx.logger.debug("Failed to list projects", e);
+    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("listProjects", action)(ctx));
+};
+const listProjects = {
+  name: "list-projects",
+  description: "List Strapi Cloud projects",
+  action,
   command
 };
 const cli = {
   deployProject,
   login,
   logout,
-  createProject
+  createProject,
+  listProjects
 };
-const cloudCommands = [deployProject, login, logout];
+const cloudCommands = [deployProject, login, logout, listProjects];
 async function initCloudCLIConfig() {
   const localConfig = await getLocalConfig();
   if (!localConfig.deviceId) {