@strapi/cloud-cli 0.0.0-next.ac2b9fdba5ef59eb22c4e387ac1c5a13dd219f29 → 0.0.0-next.ac654f8b8646bf964ebd39d4313c4afab0917a24

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 (45) hide show
  1. package/dist/bin.js +1 -0
  2. package/dist/bin.js.map +1 -1
  3. package/dist/index.js +440 -106
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +438 -105
  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 +2 -2
  10. package/dist/src/create-project/action.d.ts.map +1 -1
  11. package/dist/src/create-project/command.d.ts.map +1 -1
  12. package/dist/src/deploy-project/action.d.ts +5 -1
  13. package/dist/src/deploy-project/action.d.ts.map +1 -1
  14. package/dist/src/deploy-project/command.d.ts.map +1 -1
  15. package/dist/src/environment/command.d.ts +3 -0
  16. package/dist/src/environment/command.d.ts.map +1 -0
  17. package/dist/src/environment/link/action.d.ts +4 -0
  18. package/dist/src/environment/link/action.d.ts.map +1 -0
  19. package/dist/src/environment/link/command.d.ts +4 -0
  20. package/dist/src/environment/link/command.d.ts.map +1 -0
  21. package/dist/src/environment/link/index.d.ts +7 -0
  22. package/dist/src/environment/link/index.d.ts.map +1 -0
  23. package/dist/src/environment/list/action.d.ts +4 -0
  24. package/dist/src/environment/list/action.d.ts.map +1 -0
  25. package/dist/src/environment/list/command.d.ts +4 -0
  26. package/dist/src/environment/list/command.d.ts.map +1 -0
  27. package/dist/src/environment/list/index.d.ts +7 -0
  28. package/dist/src/environment/list/index.d.ts.map +1 -0
  29. package/dist/src/index.d.ts +2 -0
  30. package/dist/src/index.d.ts.map +1 -1
  31. package/dist/src/link/action.d.ts.map +1 -1
  32. package/dist/src/login/command.d.ts.map +1 -1
  33. package/dist/src/logout/command.d.ts.map +1 -1
  34. package/dist/src/services/cli-api.d.ts +30 -3
  35. package/dist/src/services/cli-api.d.ts.map +1 -1
  36. package/dist/src/services/strapi-info-save.d.ts +15 -2
  37. package/dist/src/services/strapi-info-save.d.ts.map +1 -1
  38. package/dist/src/types.d.ts +7 -1
  39. package/dist/src/types.d.ts.map +1 -1
  40. package/dist/src/utils/get-local-config.d.ts +6 -0
  41. package/dist/src/utils/get-local-config.d.ts.map +1 -0
  42. package/dist/src/utils/pkg.d.ts.map +1 -1
  43. package/dist/src/utils/tests/compress-files.test.d.ts +2 -0
  44. package/dist/src/utils/tests/compress-files.test.d.ts.map +1 -0
  45. package/package.json +9 -8
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";
@@ -21,6 +23,7 @@ import * as cliProgress from "cli-progress";
21
23
  import pkgUp from "pkg-up";
22
24
  import * as yup from "yup";
23
25
  import EventSource from "eventsource";
26
+ import { createCommand } from "commander";
24
27
  const apiConfig = {
25
28
  apiBaseUrl: env("STRAPI_CLI_CLOUD_API", "https://cloud-cli-api.strapi.io"),
26
29
  dashboardBaseUrl: env("STRAPI_CLI_CLOUD_DASHBOARD", "https://cloud.strapi.io")
@@ -117,7 +120,7 @@ async function getConfigPath() {
117
120
  }
118
121
  return configPath;
119
122
  }
120
- async function getLocalConfig() {
123
+ async function getLocalConfig$1() {
121
124
  const configPath = await getConfigPath();
122
125
  const configFilePath = path__default.join(configPath, CONFIG_FILENAME);
123
126
  await fse__default.ensureFile(configFilePath);
@@ -133,7 +136,7 @@ async function saveLocalConfig(data) {
133
136
  await fse__default.writeJson(configFilePath, data, { encoding: "utf8", spaces: 2, mode: 384 });
134
137
  }
135
138
  const name = "@strapi/cloud-cli";
136
- const version = "4.25.11";
139
+ const version = "5.4.0";
137
140
  const description = "Commands to interact with the Strapi Cloud";
138
141
  const keywords = [
139
142
  "strapi",
@@ -178,14 +181,15 @@ const scripts = {
178
181
  watch: "pack-up watch"
179
182
  };
180
183
  const dependencies = {
181
- "@strapi/utils": "4.25.11",
184
+ "@strapi/utils": "5.4.0",
182
185
  axios: "1.7.4",
186
+ boxen: "5.1.2",
183
187
  chalk: "4.1.2",
184
188
  "cli-progress": "3.12.0",
185
189
  commander: "8.3.0",
186
190
  eventsource: "2.0.2",
187
191
  "fast-safe-stringify": "2.1.1",
188
- "fs-extra": "10.0.0",
192
+ "fs-extra": "11.2.0",
189
193
  inquirer: "8.2.5",
190
194
  jsonwebtoken: "9.0.0",
191
195
  "jwks-rsa": "3.1.0",
@@ -194,7 +198,7 @@ const dependencies = {
194
198
  open: "8.4.0",
195
199
  ora: "5.4.1",
196
200
  "pkg-up": "3.1.0",
197
- tar: "6.1.13",
201
+ tar: "6.2.1",
198
202
  "xdg-app-paths": "8.3.0",
199
203
  yup: "0.32.9"
200
204
  };
@@ -203,13 +207,14 @@ const devDependencies = {
203
207
  "@types/cli-progress": "3.11.5",
204
208
  "@types/eventsource": "1.1.15",
205
209
  "@types/lodash": "^4.14.191",
206
- "eslint-config-custom": "4.25.11",
207
- tsconfig: "4.25.11"
210
+ "eslint-config-custom": "5.4.0",
211
+ tsconfig: "5.4.0"
208
212
  };
209
213
  const engines = {
210
- node: ">=18.0.0 <=20.x.x",
214
+ node: ">=18.0.0 <=22.x.x",
211
215
  npm: ">=6.0.0"
212
216
  };
217
+ const gitHead = "7d785703f52464577d077c4618cbe68b44f8a9cd";
213
218
  const packageJson = {
214
219
  name,
215
220
  version,
@@ -230,11 +235,12 @@ const packageJson = {
230
235
  scripts,
231
236
  dependencies,
232
237
  devDependencies,
233
- engines
238
+ engines,
239
+ gitHead
234
240
  };
235
241
  const VERSION = "v1";
236
242
  async function cloudApiFactory({ logger }, token) {
237
- const localConfig = await getLocalConfig();
243
+ const localConfig = await getLocalConfig$1();
238
244
  const customHeaders = {
239
245
  "x-device-id": localConfig.deviceId,
240
246
  "x-app-version": packageJson.version,
@@ -257,7 +263,7 @@ async function cloudApiFactory({ logger }, token) {
257
263
  deploy({ filePath, project }, { onUploadProgress }) {
258
264
  return axiosCloudAPI.post(
259
265
  `/deploy/${project.name}`,
260
- { file: fse__default.createReadStream(filePath) },
266
+ { file: fse__default.createReadStream(filePath), targetEnvironment: project.targetEnvironment },
261
267
  {
262
268
  headers: {
263
269
  "Content-Type": "multipart/form-data"
@@ -328,6 +334,34 @@ async function cloudApiFactory({ logger }, token) {
328
334
  throw error;
329
335
  }
330
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
+ },
331
365
  async getProject({ name: name2 }) {
332
366
  try {
333
367
  const response = await axiosCloudAPI.get(`/projects/${name2}`);
@@ -351,26 +385,43 @@ async function cloudApiFactory({ logger }, token) {
351
385
  };
352
386
  }
353
387
  const LOCAL_SAVE_FILENAME = ".strapi-cloud.json";
388
+ const getFilePath = (directoryPath) => path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
354
389
  async function save(data, { directoryPath } = {}) {
355
- const alreadyInFileData = await retrieve({ directoryPath });
356
- const storedData = { ...alreadyInFileData, ...data };
357
- const pathToFile = path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
390
+ const pathToFile = getFilePath(directoryPath);
358
391
  await fse__default.ensureDir(path__default.dirname(pathToFile));
359
- await fse__default.writeJson(pathToFile, storedData, { encoding: "utf8" });
392
+ await fse__default.writeJson(pathToFile, data, { encoding: "utf8" });
360
393
  }
361
394
  async function retrieve({
362
395
  directoryPath
363
396
  } = {}) {
364
- const pathToFile = path__default.join(directoryPath || process.cwd(), LOCAL_SAVE_FILENAME);
397
+ const pathToFile = getFilePath(directoryPath);
365
398
  const pathExists = await fse__default.pathExists(pathToFile);
366
399
  if (!pathExists) {
367
400
  return {};
368
401
  }
369
402
  return fse__default.readJSON(pathToFile, { encoding: "utf8" });
370
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
+ }
371
420
  const strapiInfoSave = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
372
421
  __proto__: null,
373
422
  LOCAL_SAVE_FILENAME,
423
+ deleteConfig,
424
+ patch,
374
425
  retrieve,
375
426
  save
376
427
  }, Symbol.toStringTag, { value: "Module" }));
@@ -378,7 +429,7 @@ let cliConfig;
378
429
  async function tokenServiceFactory({ logger }) {
379
430
  const cloudApiService = await cloudApiFactory({ logger });
380
431
  async function saveToken(str) {
381
- const appConfig = await getLocalConfig();
432
+ const appConfig = await getLocalConfig$1();
382
433
  if (!appConfig) {
383
434
  logger.error("There was a problem saving your token. Please try again.");
384
435
  return;
@@ -392,7 +443,7 @@ async function tokenServiceFactory({ logger }) {
392
443
  }
393
444
  }
394
445
  async function retrieveToken() {
395
- const appConfig = await getLocalConfig();
446
+ const appConfig = await getLocalConfig$1();
396
447
  if (appConfig.token) {
397
448
  if (await isTokenValid(appConfig.token)) {
398
449
  return appConfig.token;
@@ -454,7 +505,7 @@ async function tokenServiceFactory({ logger }) {
454
505
  }
455
506
  }
456
507
  async function eraseToken() {
457
- const appConfig = await getLocalConfig();
508
+ const appConfig = await getLocalConfig$1();
458
509
  if (!appConfig) {
459
510
  return;
460
511
  }
@@ -615,21 +666,24 @@ yup.object({
615
666
  name: yup.string().required(),
616
667
  exports: yup.lazy(
617
668
  (value) => yup.object(
618
- typeof value === "object" ? Object.entries(value).reduce((acc, [key, value2]) => {
619
- if (typeof value2 === "object") {
620
- acc[key] = yup.object({
621
- types: yup.string().optional(),
622
- source: yup.string().required(),
623
- module: yup.string().optional(),
624
- import: yup.string().required(),
625
- require: yup.string().required(),
626
- default: yup.string().required()
627
- }).noUnknown(true);
628
- } else {
629
- acc[key] = yup.string().matches(/^\.\/.*\.json$/).required();
630
- }
631
- return acc;
632
- }, {}) : 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
633
687
  ).optional()
634
688
  )
635
689
  });
@@ -897,7 +951,7 @@ async function createProject$1(ctx, cloudApi, projectInput) {
897
951
  throw e;
898
952
  }
899
953
  }
900
- const action$4 = async (ctx) => {
954
+ const action$6 = async (ctx) => {
901
955
  const { logger } = ctx;
902
956
  const { getValidToken, eraseToken } = await tokenServiceFactory(ctx);
903
957
  const token = await getValidToken(ctx, promptLogin);
@@ -1026,6 +1080,29 @@ const buildLogsServiceFactory = ({ logger }) => {
1026
1080
  });
1027
1081
  };
1028
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
+ }
1029
1106
  async function upload(ctx, project, token, maxProjectFileSize) {
1030
1107
  const cloudApi = await cloudApiFactory(ctx, token);
1031
1108
  try {
@@ -1108,7 +1185,7 @@ async function getProject(ctx) {
1108
1185
  const { project } = await retrieve();
1109
1186
  if (!project) {
1110
1187
  try {
1111
- return await action$4(ctx);
1188
+ return await action$6(ctx);
1112
1189
  } catch (e) {
1113
1190
  ctx.logger.error("An error occurred while deploying the project. Please try again later.");
1114
1191
  ctx.logger.debug(e);
@@ -1129,19 +1206,61 @@ async function getConfig({
1129
1206
  return null;
1130
1207
  }
1131
1208
  }
1132
- function assertProjectSuspension(ctx, projectSuspendedAt, projectPageURL) {
1133
- if (projectSuspendedAt) {
1134
- ctx.logger.log(
1135
- "\n Oops! This project has been suspended. \n\n Please reactivate it from the dashboard to continue deploying: "
1136
- );
1137
- ctx.logger.log(chalk.underline(projectPageURL));
1138
- throw new Error("Project is suspended");
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;
1139
1222
  }
1223
+ if (environments.length > 1) {
1224
+ return promptForEnvironment(environments);
1225
+ }
1226
+ return environments[0];
1140
1227
  }
1141
- async function getProjectData({ ctx, cloudApiService }, projectInternalName) {
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) => {
1236
+ const { getValidToken } = await tokenServiceFactory(ctx);
1237
+ const token = await getValidToken(ctx, promptLogin);
1238
+ if (!token) {
1239
+ return;
1240
+ }
1241
+ const project = await getProject(ctx);
1242
+ if (!project) {
1243
+ return;
1244
+ }
1245
+ const cloudApiService = await cloudApiFactory(ctx, token);
1246
+ let projectData;
1247
+ let environments;
1248
+ let environmentsDetails;
1142
1249
  try {
1143
- const { data } = await cloudApiService.getProject({ name: projectInternalName });
1144
- return data;
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
+ }
1145
1264
  } catch (e) {
1146
1265
  if (e instanceof AxiosError && e.response?.data) {
1147
1266
  if (e.response.status === 404) {
@@ -1160,28 +1279,6 @@ Please link your local project to an existing Strapi Cloud project using the ${c
1160
1279
  );
1161
1280
  }
1162
1281
  ctx.logger.debug(e);
1163
- return null;
1164
- }
1165
- }
1166
- const action$3 = async (ctx) => {
1167
- const { getValidToken } = await tokenServiceFactory(ctx);
1168
- const token = await getValidToken(ctx, promptLogin);
1169
- if (!token) {
1170
- return;
1171
- }
1172
- const project = await getProject(ctx);
1173
- if (!project) {
1174
- return;
1175
- }
1176
- const cloudApiService = await cloudApiFactory(ctx, token);
1177
- const projectResponse = await getProjectData({ ctx, cloudApiService }, project.name);
1178
- if (!projectResponse) {
1179
- return;
1180
- }
1181
- const { data: projectData, metadata: projectMetadata } = projectResponse;
1182
- try {
1183
- assertProjectSuspension(ctx, projectData.suspendedAt, projectMetadata.dashboardUrls.project);
1184
- } catch (e) {
1185
1282
  return;
1186
1283
  }
1187
1284
  await trackEvent(ctx, cloudApiService, "willDeployWithCLI", {
@@ -1203,17 +1300,42 @@ const action$3 = async (ctx) => {
1203
1300
  );
1204
1301
  maxSize = 1e8;
1205
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
+ }
1206
1323
  const buildId = await upload(ctx, project, token, maxSize);
1207
1324
  if (!buildId) {
1208
1325
  return;
1209
1326
  }
1210
1327
  try {
1328
+ ctx.logger.log(
1329
+ `🚀 Deploying project to ${chalk.cyan(project.targetEnvironment ?? `production`)} environment...`
1330
+ );
1211
1331
  notificationService(`${apiConfig.apiBaseUrl}/notifications`, token, cliConfig2);
1212
1332
  await buildLogsService(`${apiConfig.apiBaseUrl}/v1/logs/${buildId}`, token, cliConfig2);
1213
1333
  ctx.logger.log(
1214
1334
  "Visit the following URL for deployment logs. Your deployment will be available here shortly."
1215
1335
  );
1216
- ctx.logger.log(chalk.underline(projectMetadata.dashboardUrls.deployments));
1336
+ ctx.logger.log(
1337
+ chalk.underline(`${apiConfig.dashboardBaseUrl}/projects/${project.name}/deployments`)
1338
+ );
1217
1339
  } catch (e) {
1218
1340
  ctx.logger.debug(e);
1219
1341
  if (e instanceof Error) {
@@ -1250,17 +1372,16 @@ const runAction = (name2, action2) => (...args) => {
1250
1372
  process.exit(1);
1251
1373
  });
1252
1374
  };
1253
- const command$5 = ({ command: command2, ctx }) => {
1254
- 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));
1255
1377
  };
1256
1378
  const deployProject = {
1257
1379
  name: "deploy-project",
1258
1380
  description: "Deploy a Strapi Cloud project",
1259
- action: action$3,
1260
- command: command$5
1381
+ action: action$5,
1382
+ command: command$7
1261
1383
  };
1262
- const QUIT_OPTION = "Quit";
1263
- async function getExistingConfig(ctx) {
1384
+ async function getLocalConfig(ctx) {
1264
1385
  try {
1265
1386
  return await retrieve();
1266
1387
  } catch (e) {
@@ -1269,6 +1390,21 @@ async function getExistingConfig(ctx) {
1269
1390
  return null;
1270
1391
  }
1271
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";
1272
1408
  async function promptForRelink(ctx, cloudApiService, existingConfig) {
1273
1409
  if (existingConfig && existingConfig.project) {
1274
1410
  const { shouldRelink } = await inquirer.prompt([
@@ -1298,7 +1434,7 @@ async function getProjectsList(ctx, cloudApiService, existingConfig) {
1298
1434
  } = await cloudApiService.listLinkProjects();
1299
1435
  spinner.succeed();
1300
1436
  if (!Array.isArray(projectList)) {
1301
- 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.");
1302
1438
  return null;
1303
1439
  }
1304
1440
  const projects = projectList.filter(
@@ -1310,7 +1446,7 @@ async function getProjectsList(ctx, cloudApiService, existingConfig) {
1310
1446
  };
1311
1447
  });
1312
1448
  if (projects.length === 0) {
1313
- 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.");
1314
1450
  return null;
1315
1451
  }
1316
1452
  return projects;
@@ -1328,7 +1464,7 @@ async function getUserSelection(ctx, projects) {
1328
1464
  type: "list",
1329
1465
  name: "linkProject",
1330
1466
  message: "Which project do you want to link?",
1331
- choices: [...projects, { name: chalk.grey(`(${QUIT_OPTION})`), value: null }]
1467
+ choices: [...projects, { name: chalk.grey(`(${QUIT_OPTION$1})`), value: null }]
1332
1468
  }
1333
1469
  ]);
1334
1470
  if (!answer.linkProject) {
@@ -1341,7 +1477,7 @@ async function getUserSelection(ctx, projects) {
1341
1477
  return null;
1342
1478
  }
1343
1479
  }
1344
- const action$2 = async (ctx) => {
1480
+ const action$4 = async (ctx) => {
1345
1481
  const { getValidToken } = await tokenServiceFactory(ctx);
1346
1482
  const token = await getValidToken(ctx, promptLogin);
1347
1483
  const { logger } = ctx;
@@ -1349,7 +1485,7 @@ const action$2 = async (ctx) => {
1349
1485
  return;
1350
1486
  }
1351
1487
  const cloudApiService = await cloudApiFactory(ctx, token);
1352
- const existingConfig = await getExistingConfig(ctx);
1488
+ const existingConfig = await getLocalConfig(ctx);
1353
1489
  const shouldRelink = await promptForRelink(ctx, cloudApiService, existingConfig);
1354
1490
  if (!shouldRelink) {
1355
1491
  return;
@@ -1384,7 +1520,9 @@ const action$2 = async (ctx) => {
1384
1520
  return;
1385
1521
  }
1386
1522
  await save({ project: answer.linkProject });
1387
- 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
+ );
1388
1526
  await trackEvent(ctx, cloudApiService, "didLinkProject", {
1389
1527
  projectInternalName: answer.linkProject
1390
1528
  });
@@ -1396,17 +1534,17 @@ const action$2 = async (ctx) => {
1396
1534
  });
1397
1535
  }
1398
1536
  };
1399
- const command$4 = ({ command: command2, ctx }) => {
1400
- 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));
1401
1539
  };
1402
1540
  const link = {
1403
1541
  name: "link-project",
1404
1542
  description: "Link a local directory to a Strapi Cloud project",
1405
- action: action$2,
1406
- command: command$4
1543
+ action: action$4,
1544
+ command: command$6
1407
1545
  };
1408
- const command$3 = ({ command: command2, ctx }) => {
1409
- 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(
1410
1548
  "after",
1411
1549
  "\nAfter running this command, you will be prompted to enter your authentication information."
1412
1550
  ).option("-d, --debug", "Enable debugging mode with verbose logs").option("-s, --silent", "Don't log anything").action(() => runAction("login", loginAction)(ctx));
@@ -1415,10 +1553,10 @@ const login = {
1415
1553
  name: "login",
1416
1554
  description: "Strapi Cloud Login",
1417
1555
  action: loginAction,
1418
- command: command$3
1556
+ command: command$5
1419
1557
  };
1420
1558
  const openModule = import("open");
1421
- const action$1 = async (ctx) => {
1559
+ const action$3 = async (ctx) => {
1422
1560
  const { logger } = ctx;
1423
1561
  const { retrieveToken, eraseToken } = await tokenServiceFactory(ctx);
1424
1562
  const token = await retrieveToken();
@@ -1450,25 +1588,25 @@ const action$1 = async (ctx) => {
1450
1588
  }
1451
1589
  await trackEvent(ctx, cloudApiService, "didLogout", { loginMethod: "cli" });
1452
1590
  };
1453
- const command$2 = ({ command: command2, ctx }) => {
1454
- 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));
1455
1593
  };
1456
1594
  const logout = {
1457
1595
  name: "logout",
1458
1596
  description: "Strapi Cloud Logout",
1459
- action: action$1,
1460
- command: command$2
1597
+ action: action$3,
1598
+ command: command$4
1461
1599
  };
1462
- const command$1 = ({ command: command2, ctx }) => {
1463
- 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));
1464
1602
  };
1465
1603
  const createProject = {
1466
1604
  name: "create-project",
1467
1605
  description: "Create a new project",
1468
- action: action$4,
1469
- command: command$1
1606
+ action: action$6,
1607
+ command: command$3
1470
1608
  };
1471
- const action = async (ctx) => {
1609
+ const action$2 = async (ctx) => {
1472
1610
  const { getValidToken } = await tokenServiceFactory(ctx);
1473
1611
  const token = await getValidToken(ctx, promptLogin);
1474
1612
  const { logger } = ctx;
@@ -1488,12 +1626,194 @@ const action = async (ctx) => {
1488
1626
  spinner.fail("An error occurred while fetching your projects from Strapi Cloud.");
1489
1627
  }
1490
1628
  };
1491
- const command = ({ command: command2, ctx }) => {
1492
- 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));
1493
1631
  };
1494
1632
  const listProjects = {
1495
1633
  name: "list-projects",
1496
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",
1497
1817
  action,
1498
1818
  command
1499
1819
  };
@@ -1503,11 +1823,21 @@ const cli = {
1503
1823
  login,
1504
1824
  logout,
1505
1825
  createProject,
1506
- listProjects
1826
+ linkEnvironment,
1827
+ listProjects,
1828
+ listEnvironments
1507
1829
  };
1508
- 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
+ ];
1509
1839
  async function initCloudCLIConfig() {
1510
- const localConfig = await getLocalConfig();
1840
+ const localConfig = await getLocalConfig$1();
1511
1841
  if (!localConfig.deviceId) {
1512
1842
  localConfig.deviceId = crypto$1.randomUUID();
1513
1843
  }
@@ -1521,7 +1851,10 @@ async function buildStrapiCloudCommands({
1521
1851
  await initCloudCLIConfig();
1522
1852
  for (const cloudCommand of cloudCommands) {
1523
1853
  try {
1524
- 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
+ }
1525
1858
  } catch (e) {
1526
1859
  console.error(`Failed to load command ${cloudCommand.name}`, e);
1527
1860
  }