@strapi/strapi 4.2.0 → 4.3.0-beta.1

package/bin/strapi.js

@@ -95,6 +95,7 @@ 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'));
 

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');
@@ -23,6 +24,7 @@ const createTelemetry = require('./services/metrics');
 const createAuth = require('./services/auth');
 const createUpdateNotifier = require('./utils/update-notifier');
 const createStartupLogger = require('./utils/startup-logger');
+const { LIFECYCLES } = require('./utils/lifecycles');
 const ee = require('./utils/ee');
 const contentTypesRegistry = require('./core/registries/content-types');
 const servicesRegistry = require('./core/registries/services');
@@ -42,18 +44,40 @@ const sanitizersRegistry = require('./core/registries/sanitizers');
 // TODO: move somewhere else
 const draftAndPublishSync = require('./migrations/draft-publish');
 
-const LIFECYCLES = {
-  REGISTER: 'register',
-  BOOTSTRAP: 'bootstrap',
-  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 };
 };
 
+/** @implements {import('@strapi/strapi').Strapi} */
 class Strapi {
   constructor(opts = {}) {
     destroyOnSignal(this);
-    const rootDir = opts.dir || process.cwd();
-    const appConfig = loadConfiguration(rootDir, 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));
@@ -67,12 +91,17 @@ class Strapi {
     this.container.register('auth', createAuth(this));
     this.container.register('sanitizers', sanitizersRegistry(this));
 
-    this.dirs = utils.getDirs(rootDir, { strapi: 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);
@@ -88,7 +117,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() {

package/lib/commands/admin-create.js

@@ -90,7 +90,8 @@ module.exports = async function(cmdOptions = {}) {
 };
 
 async function createAdmin({ email, password, firstname, lastname }) {
-  const app = await strapi().load();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).load();
 
   const user = await app.admin.services.user.exists({ email });
 

package/lib/commands/admin-reset.js

@@ -42,7 +42,8 @@ module.exports = async function(cmdOptions = {}) {
 };
 
 async function changePassword({ email, password }) {
-  const app = await strapi().load();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).load();
 
   await app.admin.services.user.resetPasswordByEmail(email, password);
 

package/lib/commands/build.js

@@ -1,56 +1,18 @@
 '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');
+const strapi = require('../');
+const { buildAdmin } = require('./builders');
 
 /**
  * `$ strapi build`
  */
 module.exports = async ({ optimization, forceBuild = true }) => {
-  const dir = process.cwd();
+  const { appDir, distDir } = await strapi.compile();
 
-  const strapiInstance = strapi({
-    dir,
-    autoReload: true,
-    serveAdminPanel: false,
+  await buildAdmin({
+    forceBuild,
+    optimization,
+    buildDestDir: distDir,
+    srcDir: appDir,
   });
-
-  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
-  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);
-    });
 };

package/lib/commands/builders/admin.js

@@ -0,0 +1,56 @@
+'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
+  await strapiAdmin.clean({ appDir: srcDir, buildDestDir });
+
+  ee({ dir: srcDir });
+
+  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

@@ -12,7 +12,8 @@ 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 appContext = await strapi.compile();
+  const app = await strapi(appContext).load();
 
   const count = await app.query('strapi::core-store').count();
 

package/lib/commands/configurationRestore.js

@@ -2,6 +2,7 @@
 
 const fs = require('fs');
 const _ = require('lodash');
+
 const strapi = require('../index');
 
 /**
@@ -12,7 +13,8 @@ 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 appContext = await strapi.compile();
+  const app = await strapi(appContext).load();
 
   let dataToImport;
   try {

package/lib/commands/console.js

@@ -1,14 +1,15 @@
 'use strict';
 
 const REPL = require('repl');
+
 const strapi = require('../index');
 
 /**
  * `$ strapi console`
  */
-module.exports = () => {
-  // Now load up the Strapi framework for real.
-  const app = strapi();
+module.exports = async () => {
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).load();
 
   app.start().then(() => {
     const repl = REPL.start(app.config.info.name + ' > ' || 'strapi > '); // eslint-disable-line prefer-template

package/lib/commands/content-types/list.js

@@ -6,7 +6,8 @@ const chalk = require('chalk');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().register();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
 
   const list = app.container.get('content-types').keys();
 

package/lib/commands/controllers/list.js

@@ -6,7 +6,8 @@ const chalk = require('chalk');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().register();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
 
   const list = app.container.get('controllers').keys();
 

package/lib/commands/develop.js

@@ -6,115 +6,150 @@ const fs = require('fs-extra');
 const chokidar = require('chokidar');
 const execa = require('execa');
 const { getOr } = require('lodash/fp');
-
-const { createLogger } = require('@strapi/logger');
 const { joinBy } = require('@strapi/utils');
+const tsUtils = require('@strapi/typescript-utils');
+
 const loadConfiguration = require('../core/app-configuration');
 const strapi = require('../index');
-const buildAdmin = require('./build');
+const { buildTypeScript, buildAdmin } = require('./builders');
 
 /**
  * `$ strapi develop`
  *
  */
+
 module.exports = async function({ build, watchAdmin, polling, browser }) {
-  const dir = process.cwd();
-  const config = loadConfiguration(dir);
-  const logger = createLogger(config.logger, {});
+  const appDir = process.cwd();
+
+  const isTSProject = await tsUtils.isUsingTypeScript(appDir);
+  const outDir = await tsUtils.resolveOutDir(appDir);
+  const distDir = isTSProject ? outDir : appDir;
 
   try {
     if (cluster.isMaster || cluster.isPrimary) {
-      const serveAdminPanel = getOr(true, 'admin.serveAdminPanel')(config);
-
-      const buildExists = fs.existsSync(path.join(dir, 'build'));
-      // Don't run the build process if the admin is in watch mode
-      if (build && !watchAdmin && serveAdminPanel && !buildExists) {
-        try {
-          await buildAdmin({ optimization: false, forceBuild: false });
-        } catch (err) {
-          process.exit(1);
-        }
-      }
-
-      if (watchAdmin) {
-        try {
-          execa('npm', ['run', '-s', 'strapi', 'watch-admin', '--', '--browser', browser], {
-            stdio: 'inherit',
-          });
-        } catch (err) {
-          process.exit(1);
-        }
-      }
-
-      cluster.on('message', (worker, message) => {
-        switch (message) {
-          case 'reload':
-            logger.info('The server is restarting\n');
-            worker.send('kill');
-            break;
-          case 'killed':
-            cluster.fork();
-            break;
-          case 'stop':
-            process.exit(1);
-          default:
-            return;
-        }
+      return primaryProcess({
+        distDir,
+        appDir,
+        build,
+        browser,
+        isTSProject,
+        watchAdmin,
       });
-
-      cluster.fork();
     }
 
     if (cluster.isWorker) {
-      const strapiInstance = strapi({
-        dir,
-        autoReload: true,
-        serveAdminPanel: watchAdmin ? false : true,
+      return workerProcess({ appDir, distDir, watchAdmin, polling, isTSProject });
+    }
+  } catch (e) {
+    console.error(e);
+    process.exit(1);
+  }
+};
+
+const primaryProcess = async ({ distDir, appDir, build, isTSProject, watchAdmin, browser }) => {
+  if (isTSProject) {
+    await buildTypeScript({ srcDir: appDir, distDir, watch: false });
+  }
+
+  const config = loadConfiguration({ appDir, distDir });
+  const serveAdminPanel = getOr(true, 'admin.serveAdminPanel')(config);
+
+  const buildExists = fs.existsSync(path.join(distDir, 'build'));
+
+  // Don't run the build process if the admin is in watch mode
+  if (build && !watchAdmin && serveAdminPanel && !buildExists) {
+    try {
+      await buildAdmin({
+        buildDestDir: distDir,
+        forceBuild: false,
+        optimization: false,
+        srcDir: appDir,
       });
+    } catch (err) {
+      process.exit(1);
+    }
+  }
 
-      const adminWatchIgnoreFiles = getOr([], 'admin.watchIgnoreFiles')(config);
-      watchFileChanges({
-        dir,
-        strapiInstance,
-        watchIgnoreFiles: adminWatchIgnoreFiles,
-        polling,
+  if (watchAdmin) {
+    try {
+      execa('npm', ['run', '-s', 'strapi', 'watch-admin', '--', '--browser', browser], {
+        stdio: 'inherit',
       });
+    } catch (err) {
+      process.exit(1);
+    }
+  }
 
-      process.on('message', async message => {
-        switch (message) {
-          case 'kill':
-            await strapiInstance.destroy();
-            process.send('killed');
-            process.exit();
-          default:
-          // Do nothing.
+  cluster.on('message', async (worker, message) => {
+    switch (message) {
+      case 'reload':
+        if (isTSProject) {
+          await buildTypeScript({ srcDir: appDir, distDir, watch: false });
         }
-      });
 
-      return strapiInstance.start();
+        console.info('The server is restarting\n');
+
+        worker.send('kill');
+        break;
+      case 'killed':
+        cluster.fork();
+        break;
+      case 'stop':
+        process.exit(1);
+      default:
+        return;
     }
-  } catch (e) {
-    logger.error(e);
-    process.exit(1);
-  }
+  });
+
+  cluster.fork();
+};
+
+const workerProcess = ({ appDir, distDir, watchAdmin, polling, isTSProject }) => {
+  const strapiInstance = strapi({
+    distDir,
+    autoReload: true,
+    serveAdminPanel: watchAdmin ? false : true,
+  });
+
+  const adminWatchIgnoreFiles = strapiInstance.config.get('admin.watchIgnoreFiles', []);
+  watchFileChanges({
+    appDir,
+    strapiInstance,
+    watchIgnoreFiles: adminWatchIgnoreFiles,
+    polling,
+    isTSProject,
+  });
+
+  process.on('message', async message => {
+    switch (message) {
+      case 'kill':
+        await strapiInstance.destroy();
+        process.send('killed');
+        process.exit();
+      default:
+      // Do nothing.
+    }
+  });
+
+  return strapiInstance.start();
 };
 
 /**
  * Init file watching to auto restart strapi app
  * @param {Object} options - Options object
- * @param {string} options.dir - This is the path where the app is located, the watcher will watch the files under this folder
+ * @param {string} options.appDir - This is the path where the app is located, the watcher will watch the files under this folder
  * @param {Strapi} options.strapi - Strapi instance
  * @param {array} options.watchIgnoreFiles - Array of custom file paths that should not be watched
  */
-function watchFileChanges({ dir, strapiInstance, watchIgnoreFiles, polling }) {
-  const restart = () => {
+function watchFileChanges({ appDir, strapiInstance, watchIgnoreFiles, polling }) {
+  const restart = async () => {
     if (strapiInstance.reload.isWatching && !strapiInstance.reload.isReloading) {
       strapiInstance.reload.isReloading = true;
       strapiInstance.reload();
     }
   };
 
-  const watcher = chokidar.watch(dir, {
+  const watcher = chokidar.watch(appDir, {
     ignoreInitial: true,
     usePolling: polling,
     ignored: [
@@ -122,6 +157,7 @@ function watchFileChanges({ dir, strapiInstance, watchIgnoreFiles, polling }) {
       /tmp/,
       '**/src/admin/**',
       '**/src/plugins/**/admin/**',
+      '**/dist/src/plugins/test/admin/**',
       '**/documentation',
       '**/documentation/**',
       '**/node_modules',
@@ -132,10 +168,11 @@ function watchFileChanges({ dir, strapiInstance, watchIgnoreFiles, polling }) {
       '**/index.html',
       '**/public',
       '**/public/**',
-      strapiInstance.dirs.public,
-      joinBy('/', strapiInstance.dirs.public, '**'),
+      strapiInstance.dirs.static.public,
+      joinBy('/', strapiInstance.dirs.static.public, '**'),
       '**/*.db*',
       '**/exports/**',
+      '**/dist/**',
       ...watchIgnoreFiles,
     ],
   });

package/lib/commands/hooks/list.js

@@ -6,7 +6,8 @@ const chalk = require('chalk');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().register();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
 
   const list = app.container.get('hooks').keys();
 

package/lib/commands/middlewares/list.js

@@ -6,7 +6,8 @@ const chalk = require('chalk');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().register();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
 
   const list = app.container.get('middlewares').keys();
 

package/lib/commands/policies/list.js

@@ -6,7 +6,8 @@ const chalk = require('chalk');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().register();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
 
   const list = app.container.get('policies').keys();
 

package/lib/commands/routes/list.js

@@ -7,7 +7,8 @@ const { toUpper } = require('lodash/fp');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().load();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).load();
 
   const list = app.server.listRoutes();
 

package/lib/commands/services/list.js

@@ -6,7 +6,8 @@ const chalk = require('chalk');
 const strapi = require('../../index');
 
 module.exports = async function() {
-  const app = await strapi().register();
+  const appContext = await strapi.compile();
+  const app = await strapi(appContext).register();
 
   const list = app.container.get('services').keys();