@strapi/strapi 4.2.0-alpha.O → 4.2.0-beta.2

package/README.md

@@ -114,8 +114,7 @@ For general help using Strapi, please refer to [the official Strapi documentatio
 - [Discord](https://discord.strapi.io) (For live discussion with the Community and Strapi team)
 - [GitHub](https://github.com/strapi/strapi) (Bug reports, Contributions)
 - [Community Forum](https://forum.strapi.io) (Questions and Discussions)
-- [Academy](https://academy.strapi.io) (Learn the fundamentals of Strapi)
-- [ProductBoard](https://portal.productboard.com/strapi/tabs/2-under-consideration) (Roadmap, Feature requests)
+- [Roadmap & Feature Requests](https://feedback.strapi.io/)
 - [Twitter](https://twitter.com/strapijs) (Get the news fast)
 - [Facebook](https://www.facebook.com/Strapi-616063331867161)
 - [YouTube Channel](https://www.youtube.com/strapi) (Learn from Video Tutorials)
@@ -126,7 +125,7 @@ Follow our [migration guides](https://docs.strapi.io/developer-docs/latest/updat
 
 ## Roadmap
 
-Check out our [roadmap](https://portal.productboard.com/strapi) to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature.
+Check out our [roadmap](https://feedback.strapi.io/) to get informed of the latest features released and the upcoming ones. You may also give us insights and vote for a specific feature.
 
 ## Documentation
 

package/bin/strapi.js

@@ -95,12 +95,13 @@ program
   .option('--dbssl <dbssl>', 'Database SSL')
   .option('--dbfile <dbfile>', 'Database file path for sqlite')
   .option('--dbforce', 'Allow overwriting existing database content')
+  .option('-ts, --typescript', 'Create a typescript project')
   .description('Create a new application')
   .action(require('../lib/commands/new'));
 
 // `$ strapi start`
 program
-  .command('start')
+  .command('start [dir]')
   .description('Start your Strapi application')
   .action(getLocalScript('start'));
 
@@ -174,6 +175,16 @@ program
   .action(getLocalScript('configurationRestore'));
 
 // Admin
+program
+  .command('admin:create-user')
+  .alias('admin:create')
+  .description('Create a new admin')
+  .option('-e, --email <email>', 'Email of the new admin')
+  .option('-p, --password <password>', 'Password of the new admin')
+  .option('-f, --firstname <first name>', 'First name of the new admin')
+  .option('-l, --lastname <last name>', 'Last name of the new admin')
+  .action(getLocalScript('admin-create'));
+
 program
   .command('admin:reset-user-password')
   .alias('admin:reset-password')
@@ -217,4 +228,10 @@ program
   .description('List all the application controllers')
   .action(getLocalScript('controllers/list'));
 
+//    `$ strapi opt-out-telemetry`
+program
+  .command('telemetry:disable')
+  .description('Stop Strapi from sending anonymous telemetry and metadata')
+  .action(getLocalScript('opt-out-telemetry'));
+
 program.parseAsync(process.argv);

package/lib/Strapi.js

@@ -1,5 +1,6 @@
 'use strict';
 
+const path = require('path');
 const _ = require('lodash');
 const { isFunction } = require('lodash/fp');
 const { createLogger } = require('@strapi/logger');
@@ -47,12 +48,39 @@ const LIFECYCLES = {
   DESTROY: 'destroy',
 };
 
+/**
+ * Resolve the working directories based on the instance options.
+ *
+ * Behavior:
+ * - `appDir` is the directory where Strapi will write every file (schemas, generated APIs, controllers or services)
+ * - `distDir` is the directory where Strapi will read configurations, schemas and any compiled code
+ *
+ * Default values:
+ * - If `appDir` is `undefined`, it'll be set to `process.cwd()`
+ * - If `distDir` is `undefined`, it'll be set to `appDir`
+ */
+const resolveWorkingDirectories = opts => {
+  const cwd = process.cwd();
+
+  const appDir = opts.appDir ? path.resolve(cwd, opts.appDir) : cwd;
+  const distDir = opts.distDir ? path.resolve(cwd, opts.distDir) : appDir;
+
+  return { app: appDir, dist: distDir };
+};
+
 class Strapi {
   constructor(opts = {}) {
     destroyOnSignal(this);
-    this.dirs = utils.getDirs(opts.dir || process.cwd());
-    const appConfig = loadConfiguration(this.dirs.root, opts);
+
+    const rootDirs = resolveWorkingDirectories(opts);
+
+    // Load the app configuration from the dist directory
+    const appConfig = loadConfiguration({ appDir: rootDirs.app, distDir: rootDirs.dist }, opts);
+
+    // Instanciate the Strapi container
     this.container = createContainer(this);
+
+    // Register every Strapi registry in the container
     this.container.register('config', createConfigProvider(appConfig));
     this.container.register('content-types', contentTypesRegistry(this));
     this.container.register('services', servicesRegistry(this));
@@ -65,10 +93,17 @@ class Strapi {
     this.container.register('apis', apisRegistry(this));
     this.container.register('auth', createAuth(this));
 
+    // Create a mapping of every useful directory (for the app, dist and static directories)
+    this.dirs = utils.getDirs(rootDirs, { strapi: this });
+
+    // Strapi state management variables
     this.isLoaded = false;
     this.reload = this.reload();
+
+    // Instanciate the Koa app & the HTTP server
     this.server = createServer(this);
 
+    // Strapi utils instanciation
     this.fs = createStrapiFs(this);
     this.eventHub = createEventHub();
     this.startupLogger = createStartupLogger(this);
@@ -84,7 +119,7 @@ class Strapi {
   }
 
   get EE() {
-    return ee({ dir: this.dirs.root, logger: this.log });
+    return ee({ dir: this.dirs.dist.root, logger: this.log });
   }
 
   get services() {
@@ -211,7 +246,6 @@ class Strapi {
       } catch (e) {
         this.telemetry.send('didNotOpenTab');
       }
-     ;
     }
   }
 

package/lib/commands/admin-create.js

@@ -0,0 +1,122 @@
+'use strict';
+
+const path = require('path');
+const { yup } = require('@strapi/utils');
+const _ = require('lodash');
+const inquirer = require('inquirer');
+const tsUtils = require('@strapi/typescript-utils');
+const strapi = require('../index');
+
+const emailValidator = yup
+  .string()
+  .email('Invalid email address')
+  .lowercase();
+
+const passwordValidator = yup
+  .string()
+  .min(8, 'Password must be at least 8 characters long')
+  .matches(/[a-z]/, 'Password must contain at least one lowercase character')
+  .matches(/[A-Z]/, 'Password must contain at least one uppercase character')
+  .matches(/\d/, 'Password must contain at least one number');
+
+const adminCreateSchema = yup.object().shape({
+  email: emailValidator,
+  password: passwordValidator,
+  firstname: yup.string().required('First name is required'),
+  lastname: yup.string(),
+});
+
+const promptQuestions = [
+  {
+    type: 'input',
+    name: 'email',
+    message: 'Admin email?',
+    async validate(value) {
+      const validEmail = await emailValidator.validate(value);
+      return validEmail === value || validEmail;
+    },
+  },
+  {
+    type: 'password',
+    name: 'password',
+    message: 'Admin password?',
+    async validate(value) {
+      const validPassword = await passwordValidator.validate(value);
+      return validPassword === value || validPassword;
+    },
+  },
+  { type: 'input', name: 'firstname', message: 'First name?' },
+  { type: 'input', name: 'lastname', message: 'Last name?' },
+  {
+    type: 'confirm',
+    name: 'confirm',
+    message: 'Do you really want to create a new admin?',
+  },
+];
+
+/**
+ * Create new admin user
+ * @param {Object} cmdOptions - command options
+ * @param {string} cmdOptions.email - new admin's email
+ * @param {string} [cmdOptions.password] - new admin's password
+ * @param {string} cmdOptions.firstname - new admin's first name
+ * @param {string} [cmdOptions.lastname] - new admin's last name
+ */
+module.exports = async function(cmdOptions = {}) {
+  let { email, password, firstname, lastname } = cmdOptions;
+
+  if (
+    _.isEmpty(email) &&
+    _.isEmpty(password) &&
+    _.isEmpty(firstname) &&
+    _.isEmpty(lastname) &&
+    process.stdin.isTTY
+  ) {
+    const inquiry = await inquirer.prompt(promptQuestions);
+
+    if (!inquiry.confirm) {
+      process.exit(0);
+    }
+
+    ({ email, password, firstname, lastname } = inquiry);
+  }
+
+  try {
+    await adminCreateSchema.validate({ email, password, firstname, lastname });
+  } catch (err) {
+    console.error(err.errors[0]);
+    process.exit(1);
+  }
+
+  return createAdmin({ email, password, firstname, lastname });
+};
+
+async function createAdmin({ email, password, firstname, lastname }) {
+  const appDir = process.cwd();
+
+  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
+  const distDir = isTSProject ? path.join(appDir, 'dist') : appDir;
+
+  const app = await strapi({ appDir, distDir }).load();
+
+  const user = await app.admin.services.user.exists({ email });
+
+  if (user) {
+    console.error(`User with email "${email}" already exists`);
+    process.exit(1);
+  }
+
+  const superAdminRole = await app.admin.services.role.getSuperAdmin();
+
+  await app.admin.services.user.create({
+    email,
+    firstname,
+    lastname,
+    isActive: true,
+    roles: [superAdminRole.id],
+    ...(password && { password, registrationToken: null }),
+  });
+
+  console.log(`Successfully created new admin`);
+  process.exit(0);
+}

package/lib/commands/admin-reset.js

@@ -1,7 +1,9 @@
 'use strict';
 
+const path = require('path');
 const _ = require('lodash');
 const inquirer = require('inquirer');
+const tsUtils = require('@strapi/typescript-utils');
 const strapi = require('../index');
 
 const promptQuestions = [
@@ -42,7 +44,12 @@ module.exports = async function(cmdOptions = {}) {
 };
 
 async function changePassword({ email, password }) {
-  const app = await strapi().load();
+  const appDir = process.cwd();
+
+  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
+  const distDir = isTSProject ? path.join(appDir, 'dist') : appDir;
+
+  const app = await strapi({ appDir, distDir }).load();
 
   await app.admin.services.user.resetPasswordByEmail(email, password);
 

package/lib/commands/build.js

@@ -1,56 +1,30 @@
 'use strict';
-const { green } = require('chalk');
+const path = require('path');
 
-const strapiAdmin = require('@strapi/admin');
-const { getConfigUrls } = require('@strapi/utils');
-
-const ee = require('../utils/ee');
-const addSlash = require('../utils/addSlash');
-const strapi = require('../index');
-const getEnabledPlugins = require('../core/loaders/plugins/get-enabled-plugins');
+const tsUtils = require('@strapi/typescript-utils');
+const { buildAdmin, buildTypeScript } = require('./builders');
 
 /**
  * `$ strapi build`
  */
 module.exports = async ({ optimization, forceBuild = true }) => {
-  const dir = process.cwd();
-
-  const strapiInstance = strapi({
-    dir,
-    autoReload: true,
-    serveAdminPanel: false,
-  });
+  let buildDestDir = process.cwd();
+  const srcDir = process.cwd();
 
-  const plugins = await getEnabledPlugins(strapiInstance);
+  const useTypeScriptServer = await tsUtils.isUsingTypeScript(srcDir);
 
-  const env = strapiInstance.config.get('environment');
-  const { serverUrl, adminPath } = getConfigUrls(strapiInstance.config, true);
+  // Typescript
+  if (useTypeScriptServer) {
+    await buildTypeScript({ srcDir, watch: false });
 
-  console.log(`Building your admin UI with ${green(env)} configuration ...`);
+    // Update the dir path for the next steps
+    buildDestDir = path.join(srcDir, 'dist');
+  }
 
-  // Always remove the .cache and build folders
-  await strapiAdmin.clean({ dir });
-
-  ee({ dir });
-
-  return strapiAdmin
-    .build({
-      forceBuild,
-      dir,
-      plugins,
-      // front end build env is always production for now
-      env: 'production',
-      optimize: optimization,
-      options: {
-        backend: serverUrl,
-        adminPath: addSlash(adminPath),
-      },
-    })
-    .then(() => {
-      console.log('Admin UI built successfully');
-    })
-    .catch(err => {
-      console.error(err);
-      process.exit(1);
-    });
+  await buildAdmin({
+    buildDestDir,
+    forceBuild,
+    optimization,
+    srcDir,
+  });
 };

package/lib/commands/builders/admin.js

@@ -0,0 +1,59 @@
+'use strict';
+
+const { green } = require('chalk');
+
+const strapiAdmin = require('@strapi/admin');
+const { getConfigUrls } = require('@strapi/utils');
+
+const ee = require('../../utils/ee');
+const addSlash = require('../../utils/addSlash');
+const strapi = require('../../index');
+const getEnabledPlugins = require('../../core/loaders/plugins/get-enabled-plugins');
+
+module.exports = async ({ buildDestDir, forceBuild = true, optimization, srcDir }) => {
+  const strapiInstance = strapi({
+    // Directories
+    appDir: srcDir,
+    distDir: buildDestDir,
+    // Options
+    autoReload: true,
+    serveAdminPanel: false,
+  });
+
+  const plugins = await getEnabledPlugins(strapiInstance);
+
+  const env = strapiInstance.config.get('environment');
+  const { serverUrl, adminPath } = getConfigUrls(strapiInstance.config, true);
+
+  console.log(`Building your admin UI with ${green(env)} configuration...`);
+
+  // Always remove the .cache and build folders
+  // FIXME the BE should remove the build dir and the admin should only
+  // be responsible of removing the .cache dir.
+  await strapiAdmin.clean({ appDir: srcDir, buildDestDir });
+
+  // @convly shouldn't we use the app dir here?
+  ee({ dir: buildDestDir });
+
+  return strapiAdmin
+    .build({
+      appDir: srcDir,
+      buildDestDir,
+      // front end build env is always production for now
+      env: 'production',
+      forceBuild,
+      plugins,
+      optimize: optimization,
+      options: {
+        backend: serverUrl,
+        adminPath: addSlash(adminPath),
+      },
+    })
+    .then(() => {
+      console.log('Admin UI built successfully');
+    })
+    .catch(err => {
+      console.error(err);
+      process.exit(1);
+    });
+};

package/lib/commands/builders/index.js

@@ -0,0 +1,9 @@
+'use strict';
+
+const buildAdmin = require('./admin');
+const buildTypeScript = require('./typescript');
+
+module.exports = {
+  buildAdmin,
+  buildTypeScript,
+};

package/lib/commands/builders/typescript.js

@@ -0,0 +1,32 @@
+'use strict';
+
+const path = require('path');
+const fs = require('fs-extra');
+const tsUtils = require('@strapi/typescript-utils');
+
+const cleanupDistDirectory = async distDir => {
+  if (!(await fs.pathExists(distDir))) {
+    return;
+  }
+
+  const dirContent = await fs.readdir(distDir);
+  const validFilenames = dirContent
+    // Ignore the admin build folder
+    .filter(filename => filename !== 'build');
+
+  for (const filename of validFilenames) {
+    await fs.remove(path.resolve(distDir, filename));
+  }
+};
+
+module.exports = async ({ srcDir, distDir, watch = false }) => {
+  const isTSProject = await tsUtils.isUsingTypeScript(srcDir);
+
+  if (!isTSProject) {
+    throw new Error(`tsconfig file not found in ${srcDir}`);
+  }
+
+  await cleanupDistDirectory(distDir);
+
+  return tsUtils.compile(srcDir, { watch });
+};

package/lib/commands/configurationDump.js

@@ -1,6 +1,8 @@
 'use strict';
 
 const fs = require('fs');
+const path = require('path');
+const tsUtils = require('@strapi/typescript-utils');
 const strapi = require('../index');
 
 const CHUNK_SIZE = 100;
@@ -12,7 +14,12 @@ const CHUNK_SIZE = 100;
 module.exports = async function({ file: filePath, pretty }) {
   const output = filePath ? fs.createWriteStream(filePath) : process.stdout;
 
-  const app = await strapi().load();
+  const appDir = process.cwd();
+
+  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
+  const distDir = isTSProject ? path.join(appDir, 'dist') : appDir;
+
+  const app = await strapi({ appDir, distDir }).load();
 
   const count = await app.query('strapi::core-store').count();
 

package/lib/commands/configurationRestore.js

@@ -1,7 +1,10 @@
 'use strict';
 
 const fs = require('fs');
+const path = require('path');
 const _ = require('lodash');
+const tsUtils = require('@strapi/typescript-utils');
+
 const strapi = require('../index');
 
 /**
@@ -12,7 +15,12 @@ const strapi = require('../index');
 module.exports = async function({ file: filePath, strategy = 'replace' }) {
   const input = filePath ? fs.readFileSync(filePath) : await readStdin(process.stdin);
 
-  const app = await strapi().load();
+  const appDir = process.cwd();
+
+  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
+  const distDir = isTSProject ? path.join(appDir, 'dist') : appDir;
+
+  const app = await strapi({ appDir, distDir }).load();
 
   let dataToImport;
   try {

package/lib/commands/console.js

@@ -1,14 +1,22 @@
 'use strict';
 
 const REPL = require('repl');
+const path = require('path');
+const tsUtils = require('@strapi/typescript-utils');
+
 const strapi = require('../index');
 
 /**
  * `$ strapi console`
  */
-module.exports = () => {
+module.exports = async () => {
   // Now load up the Strapi framework for real.
-  const app = strapi();
+  const appDir = process.cwd();
+
+  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
+  const distDir = isTSProject ? path.join(appDir, 'dist') : appDir;
+
+  const app = await strapi({ appDir, distDir }).load();
 
   app.start().then(() => {
     const repl = REPL.start(app.config.info.name + ' > ' || 'strapi > '); // eslint-disable-line prefer-template