feat(cli): cloud cli commands (v4)

packages/cli/cloud/.eslintignore

@@ -0,0 +1,4 @@
+node_modules/
+.eslintrc.js
+dist/
+bin/

packages/cli/cloud/.eslintrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  root: true,
+  extends: ['custom/back/typescript'],
+};

packages/cli/cloud/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015-present Strapi Solutions SAS
+
+Portions of the Strapi software are licensed as follows:
+
+* All software that resides under an "ee/" directory (the “EE Software”), if that directory exists, is licensed under the license defined in "ee/LICENSE".
+
+* All software outside of the above-mentioned directories or restrictions above is available under the "MIT Expat" license as set forth below.
+
+MIT Expat License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

packages/cli/cloud/README.md

@@ -0,0 +1,3 @@
+# Cloud CLI
+
+This package includes the `cloud` CLI to manage Strapi projects on the cloud.

packages/cli/cloud/bin/index.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const { runStrapiCloudCommand } = require('../dist/bin');
+
+runStrapiCloudCommand(process.argv);

packages/cli/cloud/package.json

@@ -0,0 +1,78 @@
+{
+  "name": "@strapi/cloud-cli",
+  "version": "4.24.3",
+  "description": "Commands to interact with the Strapi Cloud",
+  "keywords": [
+    "strapi",
+    "cloud",
+    "cli"
+  ],
+  "homepage": "https://strapi.io",
+  "bugs": {
+    "url": "https://github.com/strapi/strapi/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/strapi/strapi.git"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "author": {
+    "name": "Strapi Solutions SAS",
+    "email": "hi@strapi.io",
+    "url": "https://strapi.io"
+  },
+  "maintainers": [
+    {
+      "name": "Strapi Solutions SAS",
+      "email": "hi@strapi.io",
+      "url": "https://strapi.io"
+    }
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
+  "bin": "./bin/index.js",
+  "files": [
+    "./dist",
+    "./bin"
+  ],
+  "scripts": {
+    "build": "pack-up build",
+    "clean": "run -T rimraf ./dist",
+    "lint": "run -T eslint .",
+    "watch": "pack-up watch"
+  },
+  "dependencies": {
+    "@strapi/utils": "4.24.3",
+    "axios": "1.6.0",
+    "chalk": "4.1.2",
+    "cli-progress": "3.12.0",
+    "commander": "8.3.0",
+    "eventsource": "2.0.2",
+    "fast-safe-stringify": "2.1.1",
+    "inquirer": "8.2.5",
+    "jsonwebtoken": "9.0.0",
+    "jwks-rsa": "3.1.0",
+    "lodash": "4.17.21",
+    "minimatch": "9.0.3",
+    "open": "8.4.0",
+    "ora": "5.4.1",
+    "pkg-up": "3.1.0",
+    "tar": "6.1.13",
+    "xdg-app-paths": "8.3.0",
+    "yup": "0.32.9"
+  },
+  "devDependencies": {
+    "@strapi/pack-up": "4.23.0",
+    "@types/cli-progress": "3.11.5",
+    "@types/eventsource": "1.1.15",
+    "@types/lodash": "^4.14.191",
+    "eslint-config-custom": "4.24.3",
+    "tsconfig": "4.24.3"
+  },
+  "engines": {
+    "node": ">=18.0.0 <=20.x.x",
+    "npm": ">=6.0.0"
+  }
+}

packages/cli/cloud/packup.config.ts

@@ -0,0 +1,20 @@
+// eslint-disable-next-line import/no-extraneous-dependencies
+import { defineConfig } from '@strapi/pack-up';
+
+export default defineConfig({
+  bundles: [
+    {
+      source: './src/index.ts',
+      import: './dist/index.js',
+      require: './dist/index.js',
+      types: './dist/index.d.ts',
+      runtime: 'node',
+    },
+    {
+      source: './src/bin.ts',
+      require: './dist/bin.js',
+      runtime: 'node',
+    },
+  ],
+  dist: './dist',
+});

packages/cli/cloud/src/bin.ts

@@ -0,0 +1,34 @@
+import { Command } from 'commander';
+import { createLogger } from './services';
+import { CLIContext } from './types';
+import { buildStrapiCloudCommands } from './index';
+
+function loadStrapiCloudCommand(argv = process.argv, command = new Command()) {
+  // Initial program setup
+  command.storeOptionsAsProperties(false).allowUnknownOption(true);
+
+  // Help command
+  command.helpOption('-h, --help', 'Display help for command');
+  command.addHelpCommand('help [command]', 'Display help for command');
+
+  const cwd = process.cwd();
+
+  const hasDebug = argv.includes('--debug');
+  const hasSilent = argv.includes('--silent');
+
+  const logger = createLogger({ debug: hasDebug, silent: hasSilent, timestamp: false });
+
+  const ctx = {
+    cwd,
+    logger,
+  } satisfies CLIContext;
+
+  buildStrapiCloudCommands({ command, ctx, argv });
+}
+
+function runStrapiCloudCommand(argv = process.argv, command = new Command()) {
+  loadStrapiCloudCommand(argv, command);
+  command.parse(argv);
+}
+
+export { runStrapiCloudCommand };

packages/cli/cloud/src/config/api.ts

@@ -0,0 +1,5 @@
+import { env } from '@strapi/utils';
+
+export const apiConfig = {
+  apiBaseUrl: env('STRAPI_CLI_CLOUD_API', 'https://cli.cloud.strapi.io'),
+};

packages/cli/cloud/src/config/local.ts

@@ -0,0 +1,60 @@
+import path from 'path';
+import os from 'os';
+import fs from 'fs';
+import XDGAppPaths from 'xdg-app-paths';
+
+const APP_FOLDER_NAME = 'com.strapi.cli';
+
+export const CONFIG_FILENAME = 'config.json';
+
+export type LocalConfig = {
+  token?: string;
+  deviceId?: string;
+};
+
+function checkDirectoryExists(directoryPath: string) {
+  try {
+    return fs.lstatSync(directoryPath).isDirectory();
+  } catch (e) {
+    return false;
+  }
+}
+
+// Determine storage path based on the operating system
+export function getTmpStoragePath() {
+  const storagePath = path.join(os.tmpdir(), APP_FOLDER_NAME);
+  if (!checkDirectoryExists(storagePath)) {
+    fs.mkdirSync(storagePath, { recursive: true });
+  }
+  return storagePath;
+}
+
+function getConfigPath() {
+  const configDirs = XDGAppPaths(APP_FOLDER_NAME).configDirs();
+  const configPath = configDirs.find(checkDirectoryExists);
+
+  if (!configPath) {
+    fs.mkdirSync(configDirs[0], { recursive: true });
+    return configDirs[0];
+  }
+  return configPath;
+}
+
+export function getLocalConfig(): LocalConfig {
+  const configPath = getConfigPath();
+  const configFilePath = path.join(configPath, CONFIG_FILENAME);
+  if (!fs.existsSync(configFilePath)) {
+    return {};
+  }
+  try {
+    return JSON.parse(fs.readFileSync(configFilePath, 'utf8'));
+  } catch (e) {
+    return {};
+  }
+}
+
+export function saveLocalConfig(data: LocalConfig) {
+  const configPath = getConfigPath();
+  const configFilePath = path.join(configPath, CONFIG_FILENAME);
+  fs.writeFileSync(configFilePath, JSON.stringify(data), { encoding: 'utf8', mode: 0o600 });
+}

packages/cli/cloud/src/create-project/action.ts

@@ -0,0 +1,63 @@
+import inquirer from 'inquirer';
+import { AxiosError } from 'axios';
+import { defaults } from 'lodash/fp';
+import type { CLIContext, ProjectAnswers, ProjectInput } from '../types';
+import { tokenServiceFactory, cloudApiFactory, local } from '../services';
+
+function handleError(ctx: CLIContext, error: Error) {
+  const tokenService = tokenServiceFactory(ctx);
+  const { logger } = ctx;
+
+  logger.debug(error);
+  if (error instanceof AxiosError) {
+    switch (error.response?.status) {
+      case 401:
+        logger.error('Your session has expired. Please log in again.');
+        tokenService.eraseToken();
+        return;
+      case 403:
+        logger.error(
+          error.response.data ||
+            'You do not have permission to create a project. Please contact support for assistance.'
+        );
+        return;
+      case 400:
+        logger.error('Invalid input. Please check your inputs and try again.');
+        return;
+      default:
+        break;
+    }
+  }
+  logger.error(
+    'We encountered an issue while creating your project. Please try again in a moment. If the problem persists, contact support for assistance.'
+  );
+}
+
+export default async (ctx: CLIContext) => {
+  const { logger } = ctx;
+  const { getValidToken } = tokenServiceFactory(ctx);
+
+  const token = await getValidToken();
+  if (!token) {
+    return;
+  }
+  const cloudApi = cloudApiFactory(token);
+  const { data: config } = await cloudApi.config();
+  const { questions, defaults: defaultValues } = config.projectCreation;
+
+  const projectAnswersDefaulted = defaults(defaultValues);
+  const projectAnswers = await inquirer.prompt<ProjectAnswers>(questions);
+
+  const projectInput: ProjectInput = projectAnswersDefaulted(projectAnswers);
+
+  const spinner = logger.spinner('Setting up your project...').start();
+  try {
+    const { data } = await cloudApi.createProject(projectInput);
+    local.save({ project: data });
+    spinner.succeed('Project created successfully!');
+    return data;
+  } catch (e: Error | unknown) {
+    spinner.fail('Failed to create project on Strapi Cloud.');
+    handleError(ctx, e as Error);
+  }
+};

packages/cli/cloud/src/create-project/command.ts

@@ -0,0 +1,17 @@
+import { type StrapiCloudCommand } from '../types';
+import { runAction } from '../utils/helpers';
+import action from './action';
+
+/**
+ * `$ create project in Strapi cloud`
+ */
+const command: StrapiCloudCommand = ({ command, ctx }) => {
+  return command
+    .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)(ctx));
+};
+
+export default command;

packages/cli/cloud/src/create-project/index.ts

@@ -0,0 +1,12 @@
+import action from './action';
+import command from './command';
+import type { StrapiCloudCommandInfo } from '../types';
+
+export { action, command };
+
+export default {
+  name: 'create-project',
+  description: 'Create a new project',
+  action,
+  command,
+} as StrapiCloudCommandInfo;