@strapi/cloud-cli 0.0.0-next.d54a672641d83234230d3d80d92aaf87f60f8c75 → 0.0.0-next.d65d44102fd32871728c0d74ec4f2519b7cc0a16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (48) hide show
  1. package/dist/bin.js +1 -0
  2. package/dist/bin.js.map +1 -1
  3. package/dist/index.js +518 -108
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +516 -106
  6. package/dist/index.mjs.map +1 -1
  7. package/dist/src/cloud/command.d.ts +3 -0
  8. package/dist/src/cloud/command.d.ts.map +1 -0
  9. package/dist/src/create-project/action.d.ts.map +1 -1
  10. package/dist/src/create-project/command.d.ts.map +1 -1
  11. package/dist/src/create-project/utils/project-questions.utils.d.ts +20 -0
  12. package/dist/src/create-project/utils/project-questions.utils.d.ts.map +1 -0
  13. package/dist/src/deploy-project/action.d.ts +5 -1
  14. package/dist/src/deploy-project/action.d.ts.map +1 -1
  15. package/dist/src/deploy-project/command.d.ts.map +1 -1
  16. package/dist/src/environment/command.d.ts +3 -0
  17. package/dist/src/environment/command.d.ts.map +1 -0
  18. package/dist/src/environment/link/action.d.ts +4 -0
  19. package/dist/src/environment/link/action.d.ts.map +1 -0
  20. package/dist/src/environment/link/command.d.ts +4 -0
  21. package/dist/src/environment/link/command.d.ts.map +1 -0
  22. package/dist/src/environment/link/index.d.ts +7 -0
  23. package/dist/src/environment/link/index.d.ts.map +1 -0
  24. package/dist/src/environment/list/action.d.ts +4 -0
  25. package/dist/src/environment/list/action.d.ts.map +1 -0
  26. package/dist/src/environment/list/command.d.ts +4 -0
  27. package/dist/src/environment/list/command.d.ts.map +1 -0
  28. package/dist/src/environment/list/index.d.ts +7 -0
  29. package/dist/src/environment/list/index.d.ts.map +1 -0
  30. package/dist/src/index.d.ts +2 -0
  31. package/dist/src/index.d.ts.map +1 -1
  32. package/dist/src/link/action.d.ts.map +1 -1
  33. package/dist/src/login/command.d.ts.map +1 -1
  34. package/dist/src/logout/command.d.ts.map +1 -1
  35. package/dist/src/services/cli-api.d.ts +46 -3
  36. package/dist/src/services/cli-api.d.ts.map +1 -1
  37. package/dist/src/services/strapi-info-save.d.ts +15 -2
  38. package/dist/src/services/strapi-info-save.d.ts.map +1 -1
  39. package/dist/src/types.d.ts +7 -1
  40. package/dist/src/types.d.ts.map +1 -1
  41. package/dist/src/utils/get-local-config.d.ts +6 -0
  42. package/dist/src/utils/get-local-config.d.ts.map +1 -0
  43. package/dist/src/utils/pkg.d.ts.map +1 -1
  44. package/dist/src/utils/tests/compress-files.test.d.ts +2 -0
  45. package/dist/src/utils/tests/compress-files.test.d.ts.map +1 -0
  46. package/package.json +10 -9
  47. package/dist/src/create-project/utils/apply-default-name.d.ts +0 -7
  48. package/dist/src/create-project/utils/apply-default-name.d.ts.map +0 -1
package/dist/index.mjs CHANGED
@@ -1,6 +1,8 @@
1
1
  import crypto$1 from "crypto";
2
2
  import * as fse from "fs-extra";
3
3
  import fse__default from "fs-extra";
4
+ import inquirer from "inquirer";
5
+ import boxen from "boxen";
4
6
  import * as path from "path";
5
7
  import path__default from "path";
6
8
  import chalk from "chalk";
@@ -9,10 +11,10 @@ import * as crypto from "node:crypto";
9
11
  import { env } from "@strapi/utils";
10
12
  import * as tar from "tar";
11
13
  import { minimatch } from "minimatch";
12
- import inquirer from "inquirer";
13
14
  import { defaults, has } from "lodash/fp";
14
15
  import os from "os";
15
16
  import XDGAppPaths from "xdg-app-paths";
17
+ import { merge } from "lodash";
16
18
  import jwksClient from "jwks-rsa";
17
19
  import jwt from "jsonwebtoken";
18
20
  import stringify from "fast-safe-stringify";
@@ -20,8 +22,8 @@ import ora from "ora";
20
22
  import * as cliProgress from "cli-progress";
21
23
  import pkgUp from "pkg-up";
22
24
  import * as yup from "yup";
23
- import _ from "lodash";
24
25
  import EventSource from "eventsource";
26
+ import { createCommand } from "commander";
25
27
  const apiConfig = {
26
28
  apiBaseUrl: env("STRAPI_CLI_CLOUD_API", "https://cloud-cli-api.strapi.io"),
27
29
  dashboardBaseUrl: env("STRAPI_CLI_CLOUD_DASHBOARD", "https://cloud.strapi.io")
@@ -118,7 +120,7 @@ async function getConfigPath() {
118
120
  }
119
121
  return configPath;
120
122
  }
121
- async function getLocalConfig() {
123
+ async function getLocalConfig$1() {
122
124
  const configPath = await getConfigPath();
123
125
  const configFilePath = path__default.join(configPath, CONFIG_FILENAME);
124
126
  await fse__default.ensureFile(configFilePath);
@@ -134,7 +136,7 @@ async function saveLocalConfig(data) {
134
136
  await fse__default.writeJson(configFilePath, data, { encoding: "utf8", spaces: 2, mode: 384 });
135
137
  }
136
138
  const name = "@strapi/cloud-cli";
137
- const version = "4.25.5";
139
+ const version = "5.4.1";
138
140
  const description = "Commands to interact with the Strapi Cloud";
139
141
  const keywords = [
140
142
  "strapi",
@@ -179,14 +181,15 @@ const scripts = {
179
181
  watch: "pack-up watch"
180
182
  };
181
183
  const dependencies = {
182
- "@strapi/utils": "4.25.5",
183
- axios: "1.6.0",
184
+ "@strapi/utils": "5.4.1",
185
+ axios: "1.7.4",
186
+ boxen: "5.1.2",
184
187
  chalk: "4.1.2",
185
188
  "cli-progress": "3.12.0",
186
189
  commander: "8.3.0",
187
190
  eventsource: "2.0.2",
188
191
  "fast-safe-stringify": "2.1.1",
189
- "fs-extra": "10.0.0",
192
+ "fs-extra": "11.2.0",
190
193
  inquirer: "8.2.5",
191
194
  jsonwebtoken: "9.0.0",
192
195
  "jwks-rsa": "3.1.0",
@@ -195,7 +198,7 @@ const dependencies = {
195
198
  open: "8.4.0",
196
199
  ora: "5.4.1",
197
200
  "pkg-up": "3.1.0",
198
- tar: "6.1.13",
201
+ tar: "6.2.1",
199
202
  "xdg-app-paths": "8.3.0",
200
203
  yup: "0.32.9"
201
204
  };
@@ -204,13 +207,14 @@ const devDependencies = {
204
207
  "@types/cli-progress": "3.11.5",
205
208
  "@types/eventsource": "1.1.15",
206
209
  "@types/lodash": "^4.14.191",
207
- "eslint-config-custom": "4.25.5",
208
- tsconfig: "4.25.5"
210
+ "eslint-config-custom": "5.4.1",
211
+ tsconfig: "5.4.1"
209
212
  };
210
213
  const engines = {
211
- node: ">=18.0.0 <=20.x.x",
214
+ node: ">=18.0.0 <=22.x.x",
212
215
  npm: ">=6.0.0"
213
216
  };
217
+ const gitHead = "7d785703f52464577d077c4618cbe68b44f8a9cd";
214
218
  const packageJson = {
215
219
  name,
216
220
  version,
@@ -231,11 +235,12 @@ const packageJson = {
231
235
  scripts,
232
236
  dependencies,
233
237
  devDependencies,
234
- engines
238
+ engines,
239
+ gitHead
235
240
  };
236
241
  const VERSION = "v1";
237
242
  async function cloudApiFactory({ logger }, token) {
238
- const localConfig = await getLocalConfig();
243
+ const localConfig = await getLocalConfig$1();
239
244
  const customHeaders = {
240
245
  "x-device-id": localConfig.deviceId,
241
246
  "x-app-version": packageJson.version,
@@ -258,7 +263,7 @@ async function cloudApiFactory({ logger }, token) {
258
263
  deploy({ filePath, project }, { onUploadProgress }) {
259
264
  return axiosCloudAPI.post(
260
265
  `/deploy/${project.name}`,
261
- { file: fse__default.createReadStream(filePath) },
266
+ { file: fse__default.createReadStream(filePath), targetEnvironment: project.targetEnvironment },
262
267
  {
263
268
  headers: {
264
269
  "Content-Type": "multipart/form-data"
@@ -317,7 +322,7 @@ async function cloudApiFactory({ logger }, token) {
317
322
  },
318
323
  async listLinkProjects() {
319
324
  try {
320
- const response = await axiosCloudAPI.get("/projects/linkable");
325
+ const response = await axiosCloudAPI.get("/projects-linkable");
321
326
  if (response.status !== 200) {
322
327
  throw new Error("Error fetching cloud projects from the server.");
323
328
  }
@@ -329,6 +334,48 @@ async function cloudApiFactory({ logger }, token) {
329
334
  throw error;
330
335
  }
331
336
  },
337
+ async listEnvironments({ name: name2 }) {
338
+ try {
339
+ const response = await axiosCloudAPI.get(`/projects/${name2}/environments`);
340
+ if (response.status !== 200) {
341
+ throw new Error("Error fetching cloud environments from the server.");
342
+ }
343
+ return response;
344
+ } catch (error) {
345
+ logger.debug(
346
+ "🥲 Oops! Couldn't retrieve your project's environments from the server. Please try again."
347
+ );
348
+ throw error;
349
+ }
350
+ },
351
+ async listLinkEnvironments({ name: name2 }) {
352
+ try {
353
+ const response = await axiosCloudAPI.get(`/projects/${name2}/environments-linkable`);
354
+ if (response.status !== 200) {
355
+ throw new Error("Error fetching cloud environments from the server.");
356
+ }
357
+ return response;
358
+ } catch (error) {
359
+ logger.debug(
360
+ "🥲 Oops! Couldn't retrieve your project's environments from the server. Please try again."
361
+ );
362
+ throw error;
363
+ }
364
+ },
365
+ async getProject({ name: name2 }) {
366
+ try {
367
+ const response = await axiosCloudAPI.get(`/projects/${name2}`);
368
+ if (response.status !== 200) {
369
+ throw new Error("Error fetching project's details.");
370
+ }
371
+ return response;
372
+ } catch (error) {
373
+ logger.debug(
374
+ "🥲 Oops! There was a problem retrieving your project's details. Please try again."
375
+ );
376
+ throw error;
377
+ }
378
+ },
332
379
  track(event, payload = {}) {
333
380
  return axiosCloudAPI.post("/track", {
334
381
  event,
@@ -338,26 +385,43 @@ async function cloudApiFactory({ logger }, token) {
338
385
  };
339
386
  }
340
387
  const LOCAL_SAVE_FILENAME = ".strapi-cloud.json";
388
+ const getFilePath = (directoryPath) => path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
341
389
  async function save(data, { directoryPath } = {}) {
342
- const alreadyInFileData = await retrieve({ directoryPath });
343
- const storedData = { ...alreadyInFileData, ...data };
344
- const pathToFile = path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
390
+ const pathToFile = getFilePath(directoryPath);
345
391
  await fse__default.ensureDir(path__default.dirname(pathToFile));
346
- await fse__default.writeJson(pathToFile, storedData, { encoding: "utf8" });
392
+ await fse__default.writeJson(pathToFile, data, { encoding: "utf8" });
347
393
  }
348
394
  async function retrieve({
349
395
  directoryPath
350
396
  } = {}) {
351
- const pathToFile = path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
397
+ const pathToFile = getFilePath(directoryPath);
352
398
  const pathExists = await fse__default.pathExists(pathToFile);
353
399
  if (!pathExists) {
354
400
  return {};
355
401
  }
356
402
  return fse__default.readJSON(pathToFile, { encoding: "utf8" });
357
403
  }
404
+ async function patch(patchData, { directoryPath } = {}) {
405
+ const pathToFile = getFilePath(directoryPath);
406
+ const existingData = await retrieve({ directoryPath });
407
+ if (!existingData) {
408
+ throw new Error("No configuration data found to patch.");
409
+ }
410
+ const newData = merge(existingData, patchData);
411
+ await fse__default.writeJson(pathToFile, newData, { encoding: "utf8" });
412
+ }
413
+ async function deleteConfig({ directoryPath } = {}) {
414
+ const pathToFile = getFilePath(directoryPath);
415
+ const pathExists = await fse__default.pathExists(pathToFile);
416
+ if (pathExists) {
417
+ await fse__default.remove(pathToFile);
418
+ }
419
+ }
358
420
  const strapiInfoSave = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
359
421
  __proto__: null,
360
422
  LOCAL_SAVE_FILENAME,
423
+ deleteConfig,
424
+ patch,
361
425
  retrieve,
362
426
  save
363
427
  }, Symbol.toStringTag, { value: "Module" }));
@@ -365,7 +429,7 @@ let cliConfig;
365
429
  async function tokenServiceFactory({ logger }) {
366
430
  const cloudApiService = await cloudApiFactory({ logger });
367
431
  async function saveToken(str) {
368
- const appConfig = await getLocalConfig();
432
+ const appConfig = await getLocalConfig$1();
369
433
  if (!appConfig) {
370
434
  logger.error("There was a problem saving your token. Please try again.");
371
435
  return;
@@ -379,7 +443,7 @@ async function tokenServiceFactory({ logger }) {
379
443
  }
380
444
  }
381
445
  async function retrieveToken() {
382
- const appConfig = await getLocalConfig();
446
+ const appConfig = await getLocalConfig$1();
383
447
  if (appConfig.token) {
384
448
  if (await isTokenValid(appConfig.token)) {
385
449
  return appConfig.token;
@@ -441,7 +505,7 @@ async function tokenServiceFactory({ logger }) {
441
505
  }
442
506
  }
443
507
  async function eraseToken() {
444
- const appConfig = await getLocalConfig();
508
+ const appConfig = await getLocalConfig$1();
445
509
  if (!appConfig) {
446
510
  return;
447
511
  }
@@ -602,21 +666,24 @@ yup.object({
602
666
  name: yup.string().required(),
603
667
  exports: yup.lazy(
604
668
  (value) => yup.object(
605
- typeof value === "object" ? Object.entries(value).reduce((acc, [key, value2]) => {
606
- if (typeof value2 === "object") {
607
- acc[key] = yup.object({
608
- types: yup.string().optional(),
609
- source: yup.string().required(),
610
- module: yup.string().optional(),
611
- import: yup.string().required(),
612
- require: yup.string().required(),
613
- default: yup.string().required()
614
- }).noUnknown(true);
615
- } else {
616
- acc[key] = yup.string().matches(/^\.\/.*\.json$/).required();
617
- }
618
- return acc;
619
- }, {}) : void 0
669
+ typeof value === "object" ? Object.entries(value).reduce(
670
+ (acc, [key, value2]) => {
671
+ if (typeof value2 === "object") {
672
+ acc[key] = yup.object({
673
+ types: yup.string().optional(),
674
+ source: yup.string().required(),
675
+ module: yup.string().optional(),
676
+ import: yup.string().required(),
677
+ require: yup.string().required(),
678
+ default: yup.string().required()
679
+ }).noUnknown(true);
680
+ } else {
681
+ acc[key] = yup.string().matches(/^\.\/.*\.json$/).required();
682
+ }
683
+ return acc;
684
+ },
685
+ {}
686
+ ) : void 0
620
687
  ).optional()
621
688
  )
622
689
  });
@@ -638,18 +705,6 @@ async function getProjectNameFromPackageJson(ctx) {
638
705
  return "my-strapi-project";
639
706
  }
640
707
  }
641
- function applyDefaultName(newDefaultName, questions, defaultValues) {
642
- const newDefaultValues = _.cloneDeep(defaultValues);
643
- newDefaultValues.name = newDefaultName;
644
- const newQuestions = questions.map((question) => {
645
- const questionCopy = _.cloneDeep(question);
646
- if (questionCopy.name === "name") {
647
- questionCopy.default = newDefaultName;
648
- }
649
- return questionCopy;
650
- });
651
- return { newQuestions, newDefaultValues };
652
- }
653
708
  const trackEvent = async (ctx, cloudApiService, eventName, eventData) => {
654
709
  try {
655
710
  await cloudApiService.track(eventName, eventData);
@@ -813,6 +868,45 @@ async function loginAction(ctx) {
813
868
  await authenticate();
814
869
  return isAuthenticated;
815
870
  }
871
+ function questionDefaultValuesMapper(questionsMap) {
872
+ return (questions) => {
873
+ return questions.map((question) => {
874
+ const questionName = question.name;
875
+ if (questionName in questionsMap) {
876
+ const questionDefault = questionsMap[questionName];
877
+ if (typeof questionDefault === "function") {
878
+ return {
879
+ ...question,
880
+ default: questionDefault(question)
881
+ };
882
+ }
883
+ return {
884
+ ...question,
885
+ default: questionDefault
886
+ };
887
+ }
888
+ return question;
889
+ });
890
+ };
891
+ }
892
+ function getDefaultsFromQuestions(questions) {
893
+ return questions.reduce((acc, question) => {
894
+ if (question.default && question.name) {
895
+ return { ...acc, [question.name]: question.default };
896
+ }
897
+ return acc;
898
+ }, {});
899
+ }
900
+ function getProjectNodeVersionDefault(question) {
901
+ const currentNodeVersion = process.versions.node.split(".")[0];
902
+ if (question.type === "list" && Array.isArray(question.choices)) {
903
+ const choice = question.choices.find((choice2) => choice2.value === currentNodeVersion);
904
+ if (choice) {
905
+ return choice.value;
906
+ }
907
+ }
908
+ return question.default;
909
+ }
816
910
  async function handleError(ctx, error) {
817
911
  const { logger } = ctx;
818
912
  logger.debug(error);
@@ -857,7 +951,7 @@ async function createProject$1(ctx, cloudApi, projectInput) {
857
951
  throw e;
858
952
  }
859
953
  }
860
- const action$4 = async (ctx) => {
954
+ const action$6 = async (ctx) => {
861
955
  const { logger } = ctx;
862
956
  const { getValidToken, eraseToken } = await tokenServiceFactory(ctx);
863
957
  const token = await getValidToken(ctx, promptLogin);
@@ -866,11 +960,16 @@ const action$4 = async (ctx) => {
866
960
  }
867
961
  const cloudApi = await cloudApiFactory(ctx, token);
868
962
  const { data: config } = await cloudApi.config();
869
- const { newQuestions: questions, newDefaultValues: defaultValues } = applyDefaultName(
870
- await getProjectNameFromPackageJson(ctx),
871
- config.projectCreation.questions,
872
- config.projectCreation.defaults
873
- );
963
+ const projectName = await getProjectNameFromPackageJson(ctx);
964
+ const defaultAnswersMapper = questionDefaultValuesMapper({
965
+ name: projectName,
966
+ nodeVersion: getProjectNodeVersionDefault
967
+ });
968
+ const questions = defaultAnswersMapper(config.projectCreation.questions);
969
+ const defaultValues = {
970
+ ...config.projectCreation.defaults,
971
+ ...getDefaultsFromQuestions(questions)
972
+ };
874
973
  const projectAnswersDefaulted = defaults(defaultValues);
875
974
  const projectAnswers = await inquirer.prompt(questions);
876
975
  const projectInput = projectAnswersDefaulted(projectAnswers);
@@ -981,6 +1080,29 @@ const buildLogsServiceFactory = ({ logger }) => {
981
1080
  });
982
1081
  };
983
1082
  };
1083
+ const boxenOptions = {
1084
+ padding: 1,
1085
+ margin: 1,
1086
+ align: "center",
1087
+ borderColor: "yellow",
1088
+ borderStyle: "round"
1089
+ };
1090
+ const QUIT_OPTION$2 = "Quit";
1091
+ async function promptForEnvironment(environments) {
1092
+ const choices = environments.map((env2) => ({ name: env2, value: env2 }));
1093
+ const { selectedEnvironment } = await inquirer.prompt([
1094
+ {
1095
+ type: "list",
1096
+ name: "selectedEnvironment",
1097
+ message: "Select the environment to deploy:",
1098
+ choices: [...choices, { name: chalk.grey(`(${QUIT_OPTION$2})`), value: null }]
1099
+ }
1100
+ ]);
1101
+ if (selectedEnvironment === null) {
1102
+ process.exit(1);
1103
+ }
1104
+ return selectedEnvironment;
1105
+ }
984
1106
  async function upload(ctx, project, token, maxProjectFileSize) {
985
1107
  const cloudApi = await cloudApiFactory(ctx, token);
986
1108
  try {
@@ -1047,17 +1169,7 @@ async function upload(ctx, project, token, maxProjectFileSize) {
1047
1169
  return data.build_id;
1048
1170
  } catch (e) {
1049
1171
  progressBar.stop();
1050
- if (e instanceof AxiosError && e.response?.data) {
1051
- if (e.response.status === 404) {
1052
- ctx.logger.error(
1053
- `The project does not exist. Remove the ${LOCAL_SAVE_FILENAME} file and try again.`
1054
- );
1055
- } else {
1056
- ctx.logger.error(e.response.data);
1057
- }
1058
- } else {
1059
- ctx.logger.error("An error occurred while deploying the project. Please try again later.");
1060
- }
1172
+ ctx.logger.error("An error occurred while deploying the project. Please try again later.");
1061
1173
  ctx.logger.debug(e);
1062
1174
  } finally {
1063
1175
  await fse__default.remove(tarFilePath);
@@ -1073,7 +1185,7 @@ async function getProject(ctx) {
1073
1185
  const { project } = await retrieve();
1074
1186
  if (!project) {
1075
1187
  try {
1076
- return await action$4(ctx);
1188
+ return await action$6(ctx);
1077
1189
  } catch (e) {
1078
1190
  ctx.logger.error("An error occurred while deploying the project. Please try again later.");
1079
1191
  ctx.logger.debug(e);
@@ -1094,7 +1206,33 @@ async function getConfig({
1094
1206
  return null;
1095
1207
  }
1096
1208
  }
1097
- const action$3 = async (ctx) => {
1209
+ function validateEnvironment(ctx, environment, environments) {
1210
+ if (!environments.includes(environment)) {
1211
+ ctx.logger.error(`Environment ${environment} does not exist.`);
1212
+ process.exit(1);
1213
+ }
1214
+ }
1215
+ async function getTargetEnvironment(ctx, opts, project, environments) {
1216
+ if (opts.env) {
1217
+ validateEnvironment(ctx, opts.env, environments);
1218
+ return opts.env;
1219
+ }
1220
+ if (project.targetEnvironment) {
1221
+ return project.targetEnvironment;
1222
+ }
1223
+ if (environments.length > 1) {
1224
+ return promptForEnvironment(environments);
1225
+ }
1226
+ return environments[0];
1227
+ }
1228
+ function hasPendingOrLiveDeployment(environments, targetEnvironment) {
1229
+ const environment = environments.find((env2) => env2.name === targetEnvironment);
1230
+ if (!environment) {
1231
+ throw new Error(`Environment details ${targetEnvironment} not found.`);
1232
+ }
1233
+ return environment.hasPendingDeployment || environment.hasLiveDeployment || false;
1234
+ }
1235
+ const action$5 = async (ctx, opts) => {
1098
1236
  const { getValidToken } = await tokenServiceFactory(ctx);
1099
1237
  const token = await getValidToken(ctx, promptLogin);
1100
1238
  if (!token) {
@@ -1104,7 +1242,45 @@ const action$3 = async (ctx) => {
1104
1242
  if (!project) {
1105
1243
  return;
1106
1244
  }
1107
- const cloudApiService = await cloudApiFactory(ctx);
1245
+ const cloudApiService = await cloudApiFactory(ctx, token);
1246
+ let projectData;
1247
+ let environments;
1248
+ let environmentsDetails;
1249
+ try {
1250
+ const {
1251
+ data: { data, metadata }
1252
+ } = await cloudApiService.getProject({ name: project.name });
1253
+ projectData = data;
1254
+ environments = projectData.environments;
1255
+ environmentsDetails = projectData.environmentsDetails;
1256
+ const isProjectSuspended = projectData.suspendedAt;
1257
+ if (isProjectSuspended) {
1258
+ ctx.logger.log(
1259
+ "\n Oops! This project has been suspended. \n\n Please reactivate it from the dashboard to continue deploying: "
1260
+ );
1261
+ ctx.logger.log(chalk.underline(`${metadata.dashboardUrls.project}`));
1262
+ return;
1263
+ }
1264
+ } catch (e) {
1265
+ if (e instanceof AxiosError && e.response?.data) {
1266
+ if (e.response.status === 404) {
1267
+ ctx.logger.warn(
1268
+ `The project associated with this folder does not exist in Strapi Cloud.
1269
+ Please link your local project to an existing Strapi Cloud project using the ${chalk.cyan(
1270
+ "link"
1271
+ )} command before deploying.`
1272
+ );
1273
+ } else {
1274
+ ctx.logger.error(e.response.data);
1275
+ }
1276
+ } else {
1277
+ ctx.logger.error(
1278
+ "An error occurred while retrieving the project's information. Please try again later."
1279
+ );
1280
+ }
1281
+ ctx.logger.debug(e);
1282
+ return;
1283
+ }
1108
1284
  await trackEvent(ctx, cloudApiService, "willDeployWithCLI", {
1109
1285
  projectInternalName: project.name
1110
1286
  });
@@ -1113,7 +1289,7 @@ const action$3 = async (ctx) => {
1113
1289
  const cliConfig2 = await getConfig({ ctx, cloudApiService });
1114
1290
  if (!cliConfig2) {
1115
1291
  ctx.logger.error(
1116
- "An error occurred while retrieving data from Strapi Cloud. Please try check your network or again later."
1292
+ "An error occurred while retrieving data from Strapi Cloud. Please check your network or try again later."
1117
1293
  );
1118
1294
  return;
1119
1295
  }
@@ -1124,11 +1300,34 @@ const action$3 = async (ctx) => {
1124
1300
  );
1125
1301
  maxSize = 1e8;
1126
1302
  }
1303
+ project.targetEnvironment = await getTargetEnvironment(ctx, opts, project, environments);
1304
+ if (!opts.force) {
1305
+ const shouldDisplayWarning = hasPendingOrLiveDeployment(
1306
+ environmentsDetails,
1307
+ project.targetEnvironment
1308
+ );
1309
+ if (shouldDisplayWarning) {
1310
+ ctx.logger.log(boxen(cliConfig2.projectDeployment.confirmationText, boxenOptions));
1311
+ const { confirm } = await inquirer.prompt([
1312
+ {
1313
+ type: "confirm",
1314
+ name: "confirm",
1315
+ message: `Do you want to proceed with deployment to ${chalk.cyan(projectData.displayName)} on ${chalk.cyan(project.targetEnvironment)} environment?`
1316
+ }
1317
+ ]);
1318
+ if (!confirm) {
1319
+ process.exit(1);
1320
+ }
1321
+ }
1322
+ }
1127
1323
  const buildId = await upload(ctx, project, token, maxSize);
1128
1324
  if (!buildId) {
1129
1325
  return;
1130
1326
  }
1131
1327
  try {
1328
+ ctx.logger.log(
1329
+ `🚀 Deploying project to ${chalk.cyan(project.targetEnvironment ?? `production`)} environment...`
1330
+ );
1132
1331
  notificationService(`${apiConfig.apiBaseUrl}/notifications`, token, cliConfig2);
1133
1332
  await buildLogsService(`${apiConfig.apiBaseUrl}/v1/logs/${buildId}`, token, cliConfig2);
1134
1333
  ctx.logger.log(
@@ -1173,17 +1372,16 @@ const runAction = (name2, action2) => (...args) => {
1173
1372
  process.exit(1);
1174
1373
  });
1175
1374
  };
1176
- const command$5 = ({ command: command2, ctx }) => {
1177
- 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));
1375
+ const command$7 = ({ ctx }) => {
1376
+ 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("-f, --force", "Skip confirmation to deploy").option("-e, --env <name>", "Specify the environment to deploy").action((opts) => runAction("deploy", action$5)(ctx, opts));
1178
1377
  };
1179
1378
  const deployProject = {
1180
1379
  name: "deploy-project",
1181
1380
  description: "Deploy a Strapi Cloud project",
1182
- action: action$3,
1183
- command: command$5
1381
+ action: action$5,
1382
+ command: command$7
1184
1383
  };
1185
- const QUIT_OPTION = "Quit";
1186
- async function getExistingConfig(ctx) {
1384
+ async function getLocalConfig(ctx) {
1187
1385
  try {
1188
1386
  return await retrieve();
1189
1387
  } catch (e) {
@@ -1192,6 +1390,21 @@ async function getExistingConfig(ctx) {
1192
1390
  return null;
1193
1391
  }
1194
1392
  }
1393
+ async function getLocalProject(ctx) {
1394
+ const localConfig = await getLocalConfig(ctx);
1395
+ if (!localConfig || !localConfig.project) {
1396
+ ctx.logger.warn(
1397
+ `
1398
+ We couldn't find a valid local project config.
1399
+ Please link your local project to an existing Strapi Cloud project using the ${chalk.cyan(
1400
+ "link"
1401
+ )} command.`
1402
+ );
1403
+ process.exit(1);
1404
+ }
1405
+ return localConfig.project;
1406
+ }
1407
+ const QUIT_OPTION$1 = "Quit";
1195
1408
  async function promptForRelink(ctx, cloudApiService, existingConfig) {
1196
1409
  if (existingConfig && existingConfig.project) {
1197
1410
  const { shouldRelink } = await inquirer.prompt([
@@ -1221,7 +1434,7 @@ async function getProjectsList(ctx, cloudApiService, existingConfig) {
1221
1434
  } = await cloudApiService.listLinkProjects();
1222
1435
  spinner.succeed();
1223
1436
  if (!Array.isArray(projectList)) {
1224
- ctx.logger.log("We couldn't find any projects available for linking in Strapi Cloud");
1437
+ ctx.logger.log("We couldn't find any projects available for linking in Strapi Cloud.");
1225
1438
  return null;
1226
1439
  }
1227
1440
  const projects = projectList.filter(
@@ -1233,7 +1446,7 @@ async function getProjectsList(ctx, cloudApiService, existingConfig) {
1233
1446
  };
1234
1447
  });
1235
1448
  if (projects.length === 0) {
1236
- ctx.logger.log("We couldn't find any projects available for linking in Strapi Cloud");
1449
+ ctx.logger.log("We couldn't find any projects available for linking in Strapi Cloud.");
1237
1450
  return null;
1238
1451
  }
1239
1452
  return projects;
@@ -1251,7 +1464,7 @@ async function getUserSelection(ctx, projects) {
1251
1464
  type: "list",
1252
1465
  name: "linkProject",
1253
1466
  message: "Which project do you want to link?",
1254
- choices: [...projects, { name: chalk.grey(`(${QUIT_OPTION})`), value: null }]
1467
+ choices: [...projects, { name: chalk.grey(`(${QUIT_OPTION$1})`), value: null }]
1255
1468
  }
1256
1469
  ]);
1257
1470
  if (!answer.linkProject) {
@@ -1264,7 +1477,7 @@ async function getUserSelection(ctx, projects) {
1264
1477
  return null;
1265
1478
  }
1266
1479
  }
1267
- const action$2 = async (ctx) => {
1480
+ const action$4 = async (ctx) => {
1268
1481
  const { getValidToken } = await tokenServiceFactory(ctx);
1269
1482
  const token = await getValidToken(ctx, promptLogin);
1270
1483
  const { logger } = ctx;
@@ -1272,7 +1485,7 @@ const action$2 = async (ctx) => {
1272
1485
  return;
1273
1486
  }
1274
1487
  const cloudApiService = await cloudApiFactory(ctx, token);
1275
- const existingConfig = await getExistingConfig(ctx);
1488
+ const existingConfig = await getLocalConfig(ctx);
1276
1489
  const shouldRelink = await promptForRelink(ctx, cloudApiService, existingConfig);
1277
1490
  if (!shouldRelink) {
1278
1491
  return;
@@ -1307,7 +1520,9 @@ const action$2 = async (ctx) => {
1307
1520
  return;
1308
1521
  }
1309
1522
  await save({ project: answer.linkProject });
1310
- logger.log(`Project ${chalk.cyan(answer.linkProject.displayName)} linked successfully.`);
1523
+ logger.log(
1524
+ ` You have successfully linked your project to ${chalk.cyan(answer.linkProject.displayName)}. You are now able to deploy your project.`
1525
+ );
1311
1526
  await trackEvent(ctx, cloudApiService, "didLinkProject", {
1312
1527
  projectInternalName: answer.linkProject
1313
1528
  });
@@ -1319,17 +1534,17 @@ const action$2 = async (ctx) => {
1319
1534
  });
1320
1535
  }
1321
1536
  };
1322
- const command$4 = ({ command: command2, ctx }) => {
1323
- 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));
1537
+ const command$6 = ({ command: command2, ctx }) => {
1538
+ 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$4)(ctx));
1324
1539
  };
1325
1540
  const link = {
1326
1541
  name: "link-project",
1327
1542
  description: "Link a local directory to a Strapi Cloud project",
1328
- action: action$2,
1329
- command: command$4
1543
+ action: action$4,
1544
+ command: command$6
1330
1545
  };
1331
- const command$3 = ({ command: command2, ctx }) => {
1332
- command2.command("cloud:login").alias("login").description("Strapi Cloud Login").addHelpText(
1546
+ const command$5 = ({ ctx }) => {
1547
+ return createCommand("cloud:login").alias("login").description("Strapi Cloud Login").addHelpText(
1333
1548
  "after",
1334
1549
  "\nAfter running this command, you will be prompted to enter your authentication information."
1335
1550
  ).option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("login", loginAction)(ctx));
@@ -1338,10 +1553,10 @@ const login = {
1338
1553
  name: "login",
1339
1554
  description: "Strapi Cloud Login",
1340
1555
  action: loginAction,
1341
- command: command$3
1556
+ command: command$5
1342
1557
  };
1343
1558
  const openModule = import("open");
1344
- const action$1 = async (ctx) => {
1559
+ const action$3 = async (ctx) => {
1345
1560
  const { logger } = ctx;
1346
1561
  const { retrieveToken, eraseToken } = await tokenServiceFactory(ctx);
1347
1562
  const token = await retrieveToken();
@@ -1373,25 +1588,25 @@ const action$1 = async (ctx) => {
1373
1588
  }
1374
1589
  await trackEvent(ctx, cloudApiService, "didLogout", { loginMethod: "cli" });
1375
1590
  };
1376
- const command$2 = ({ command: command2, ctx }) => {
1377
- 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));
1591
+ const command$4 = ({ ctx }) => {
1592
+ 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$3)(ctx));
1378
1593
  };
1379
1594
  const logout = {
1380
1595
  name: "logout",
1381
1596
  description: "Strapi Cloud Logout",
1382
- action: action$1,
1383
- command: command$2
1597
+ action: action$3,
1598
+ command: command$4
1384
1599
  };
1385
- const command$1 = ({ command: command2, ctx }) => {
1386
- 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));
1600
+ const command$3 = ({ ctx }) => {
1601
+ 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$6)(ctx));
1387
1602
  };
1388
1603
  const createProject = {
1389
1604
  name: "create-project",
1390
1605
  description: "Create a new project",
1391
- action: action$4,
1392
- command: command$1
1606
+ action: action$6,
1607
+ command: command$3
1393
1608
  };
1394
- const action = async (ctx) => {
1609
+ const action$2 = async (ctx) => {
1395
1610
  const { getValidToken } = await tokenServiceFactory(ctx);
1396
1611
  const token = await getValidToken(ctx, promptLogin);
1397
1612
  const { logger } = ctx;
@@ -1411,12 +1626,194 @@ const action = async (ctx) => {
1411
1626
  spinner.fail("An error occurred while fetching your projects from Strapi Cloud.");
1412
1627
  }
1413
1628
  };
1414
- const command = ({ command: command2, ctx }) => {
1415
- 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));
1629
+ const command$2 = ({ command: command2, ctx }) => {
1630
+ 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$2)(ctx));
1416
1631
  };
1417
1632
  const listProjects = {
1418
1633
  name: "list-projects",
1419
1634
  description: "List Strapi Cloud projects",
1635
+ action: action$2,
1636
+ command: command$2
1637
+ };
1638
+ const action$1 = async (ctx) => {
1639
+ const { getValidToken } = await tokenServiceFactory(ctx);
1640
+ const token = await getValidToken(ctx, promptLogin);
1641
+ const { logger } = ctx;
1642
+ if (!token) {
1643
+ return;
1644
+ }
1645
+ const project = await getLocalProject(ctx);
1646
+ if (!project) {
1647
+ ctx.logger.debug(`No valid local project configuration was found.`);
1648
+ return;
1649
+ }
1650
+ const cloudApiService = await cloudApiFactory(ctx, token);
1651
+ const spinner = logger.spinner("Fetching environments...").start();
1652
+ await trackEvent(ctx, cloudApiService, "willListEnvironment", {
1653
+ projectInternalName: project.name
1654
+ });
1655
+ try {
1656
+ const {
1657
+ data: { data: environmentsList }
1658
+ } = await cloudApiService.listEnvironments({ name: project.name });
1659
+ spinner.succeed();
1660
+ logger.log(environmentsList);
1661
+ await trackEvent(ctx, cloudApiService, "didListEnvironment", {
1662
+ projectInternalName: project.name
1663
+ });
1664
+ } catch (e) {
1665
+ if (e.response && e.response.status === 404) {
1666
+ spinner.succeed();
1667
+ logger.warn(
1668
+ `
1669
+ The project associated with this folder does not exist in Strapi Cloud.
1670
+ Please link your local project to an existing Strapi Cloud project using the ${chalk.cyan(
1671
+ "link"
1672
+ )} command`
1673
+ );
1674
+ } else {
1675
+ spinner.fail("An error occurred while fetching environments data from Strapi Cloud.");
1676
+ logger.debug("Failed to list environments", e);
1677
+ }
1678
+ await trackEvent(ctx, cloudApiService, "didNotListEnvironment", {
1679
+ projectInternalName: project.name
1680
+ });
1681
+ }
1682
+ };
1683
+ function defineCloudNamespace(command2, ctx) {
1684
+ const cloud = command2.command("cloud").description("Manage Strapi Cloud projects");
1685
+ cloud.command("environments").description("Alias for cloud environment list").action(() => runAction("list", action$1)(ctx));
1686
+ return cloud;
1687
+ }
1688
+ let environmentCmd = null;
1689
+ const initializeEnvironmentCommand = (command2, ctx) => {
1690
+ if (!environmentCmd) {
1691
+ const cloud = defineCloudNamespace(command2, ctx);
1692
+ environmentCmd = cloud.command("environment").description("Manage environments");
1693
+ }
1694
+ return environmentCmd;
1695
+ };
1696
+ const command$1 = ({ command: command2, ctx }) => {
1697
+ const environmentCmd2 = initializeEnvironmentCommand(command2, ctx);
1698
+ 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$1)(ctx));
1699
+ };
1700
+ const listEnvironments = {
1701
+ name: "list-environments",
1702
+ description: "List Strapi Cloud environments",
1703
+ action: action$1,
1704
+ command: command$1
1705
+ };
1706
+ const QUIT_OPTION = "Quit";
1707
+ const action = async (ctx) => {
1708
+ const { getValidToken } = await tokenServiceFactory(ctx);
1709
+ const token = await getValidToken(ctx, promptLogin);
1710
+ const { logger } = ctx;
1711
+ if (!token) {
1712
+ return;
1713
+ }
1714
+ const project = await getLocalProject(ctx);
1715
+ if (!project) {
1716
+ logger.debug(`No valid local project configuration was found.`);
1717
+ return;
1718
+ }
1719
+ const cloudApiService = await cloudApiFactory(ctx, token);
1720
+ const environments = await getEnvironmentsList(ctx, cloudApiService, project);
1721
+ if (!environments) {
1722
+ logger.debug(`Fetching environments failed.`);
1723
+ return;
1724
+ }
1725
+ if (environments.length === 0) {
1726
+ logger.log(
1727
+ `The only available environment is already linked. You can add a new one from your project settings on the Strapi Cloud dashboard.`
1728
+ );
1729
+ return;
1730
+ }
1731
+ const answer = await promptUserForEnvironment(ctx, environments);
1732
+ if (!answer) {
1733
+ return;
1734
+ }
1735
+ await trackEvent(ctx, cloudApiService, "willLinkEnvironment", {
1736
+ projectName: project.name,
1737
+ environmentName: answer.targetEnvironment
1738
+ });
1739
+ try {
1740
+ await patch({ project: { targetEnvironment: answer.targetEnvironment } });
1741
+ } catch (e) {
1742
+ await trackEvent(ctx, cloudApiService, "didNotLinkEnvironment", {
1743
+ projectName: project.name,
1744
+ environmentName: answer.targetEnvironment
1745
+ });
1746
+ logger.debug("Failed to link environment", e);
1747
+ logger.error(
1748
+ "Failed to link the environment. If this issue persists, try re-linking your project or contact support."
1749
+ );
1750
+ process.exit(1);
1751
+ }
1752
+ logger.log(
1753
+ ` You have successfully linked your project to ${chalk.cyan(answer.targetEnvironment)}, on ${chalk.cyan(project.displayName)}. You are now able to deploy your project.`
1754
+ );
1755
+ await trackEvent(ctx, cloudApiService, "didLinkEnvironment", {
1756
+ projectName: project.name,
1757
+ environmentName: answer.targetEnvironment
1758
+ });
1759
+ };
1760
+ async function promptUserForEnvironment(ctx, environments) {
1761
+ const { logger } = ctx;
1762
+ try {
1763
+ const answer = await inquirer.prompt([
1764
+ {
1765
+ type: "list",
1766
+ name: "targetEnvironment",
1767
+ message: "Which environment do you want to link?",
1768
+ choices: [...environments, { name: chalk.grey(`(${QUIT_OPTION})`), value: null }]
1769
+ }
1770
+ ]);
1771
+ if (!answer.targetEnvironment) {
1772
+ return null;
1773
+ }
1774
+ return answer;
1775
+ } catch (e) {
1776
+ logger.debug("Failed to get user input", e);
1777
+ logger.error("An error occurred while trying to get your environment selection.");
1778
+ return null;
1779
+ }
1780
+ }
1781
+ async function getEnvironmentsList(ctx, cloudApiService, project) {
1782
+ const spinner = ctx.logger.spinner("Fetching environments...\n").start();
1783
+ try {
1784
+ const {
1785
+ data: { data: environmentsList }
1786
+ } = await cloudApiService.listLinkEnvironments({ name: project.name });
1787
+ if (!Array.isArray(environmentsList) || environmentsList.length === 0) {
1788
+ throw new Error("Environments not found in server response");
1789
+ }
1790
+ spinner.succeed();
1791
+ return environmentsList.filter(
1792
+ (environment) => environment.name !== project.targetEnvironment
1793
+ );
1794
+ } catch (e) {
1795
+ if (e.response && e.response.status === 404) {
1796
+ spinner.succeed();
1797
+ ctx.logger.warn(
1798
+ `
1799
+ The project associated with this folder does not exist in Strapi Cloud.
1800
+ Please link your local project to an existing Strapi Cloud project using the ${chalk.cyan(
1801
+ "link"
1802
+ )} command.`
1803
+ );
1804
+ } else {
1805
+ spinner.fail("An error occurred while fetching environments data from Strapi Cloud.");
1806
+ ctx.logger.debug("Failed to list environments", e);
1807
+ }
1808
+ }
1809
+ }
1810
+ const command = ({ command: command2, ctx }) => {
1811
+ const environmentCmd2 = initializeEnvironmentCommand(command2, ctx);
1812
+ environmentCmd2.command("link").description("Link project to a specific Strapi Cloud project environment").option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("link", action)(ctx));
1813
+ };
1814
+ const linkEnvironment = {
1815
+ name: "link-environment",
1816
+ description: "Link Strapi Cloud environment to a local project",
1420
1817
  action,
1421
1818
  command
1422
1819
  };
@@ -1426,11 +1823,21 @@ const cli = {
1426
1823
  login,
1427
1824
  logout,
1428
1825
  createProject,
1429
- listProjects
1826
+ linkEnvironment,
1827
+ listProjects,
1828
+ listEnvironments
1430
1829
  };
1431
- const cloudCommands = [deployProject, link, login, logout, listProjects];
1830
+ const cloudCommands = [
1831
+ deployProject,
1832
+ link,
1833
+ login,
1834
+ logout,
1835
+ linkEnvironment,
1836
+ listProjects,
1837
+ listEnvironments
1838
+ ];
1432
1839
  async function initCloudCLIConfig() {
1433
- const localConfig = await getLocalConfig();
1840
+ const localConfig = await getLocalConfig$1();
1434
1841
  if (!localConfig.deviceId) {
1435
1842
  localConfig.deviceId = crypto$1.randomUUID();
1436
1843
  }
@@ -1444,7 +1851,10 @@ async function buildStrapiCloudCommands({
1444
1851
  await initCloudCLIConfig();
1445
1852
  for (const cloudCommand of cloudCommands) {
1446
1853
  try {
1447
- await cloudCommand.command({ command: command2, ctx, argv });
1854
+ const subCommand = await cloudCommand.command({ command: command2, ctx, argv });
1855
+ if (subCommand) {
1856
+ command2.addCommand(subCommand);
1857
+ }
1448
1858
  } catch (e) {
1449
1859
  console.error(`Failed to load command ${cloudCommand.name}`, e);
1450
1860
  }