@strapi/strapi 4.0.0-next.6 → 4.0.0

package/lib/core/loaders/plugins/get-enabled-plugins.js

@@ -0,0 +1,116 @@
+'use strict';
+
+const { dirname, join, resolve } = require('path');
+const { statSync, existsSync } = require('fs');
+const _ = require('lodash');
+const { get, has, pick, pickBy, defaultsDeep, map, prop, pipe } = require('lodash/fp');
+const { isKebabCase } = require('@strapi/utils');
+const loadConfigFile = require('../../app-configuration/load-config-file');
+
+const isStrapiPlugin = info => get('strapi.kind', info) === 'plugin';
+const INTERNAL_PLUGINS = [
+  '@strapi/plugin-content-manager',
+  '@strapi/plugin-content-type-builder',
+  '@strapi/plugin-email',
+  '@strapi/plugin-upload',
+];
+
+const validatePluginName = pluginName => {
+  if (!isKebabCase(pluginName)) {
+    throw new Error(`Plugin name "${pluginName}" is not in kebab (an-example-of-kebab-case)`);
+  }
+};
+
+const toDetailedDeclaration = declaration => {
+  if (typeof declaration === 'boolean') {
+    return { enabled: declaration };
+  }
+
+  let detailedDeclaration = pick(['enabled'], declaration);
+  if (has('resolve', declaration)) {
+    let pathToPlugin = '';
+    try {
+      pathToPlugin = dirname(require.resolve(declaration.resolve));
+    } catch (e) {
+      pathToPlugin = resolve(strapi.dirs.root, declaration.resolve);
+
+      if (!existsSync(pathToPlugin) || !statSync(pathToPlugin).isDirectory()) {
+        throw new Error(`${declaration.resolve} couldn't be resolved`);
+      }
+    }
+
+    detailedDeclaration.pathToPlugin = pathToPlugin;
+  }
+  return detailedDeclaration;
+};
+
+const getEnabledPlugins = async strapi => {
+  const internalPlugins = {};
+  for (const dep of INTERNAL_PLUGINS) {
+    const packagePath = join(dep, 'package.json');
+    const packageInfo = require(packagePath);
+
+    validatePluginName(packageInfo.strapi.name);
+    internalPlugins[packageInfo.strapi.name] = {
+      ...toDetailedDeclaration({ enabled: true, resolve: packagePath }),
+      info: packageInfo.strapi,
+    };
+  }
+
+  const installedPlugins = {};
+  for (const dep in strapi.config.get('info.dependencies', {})) {
+    const packagePath = join(dep, 'package.json');
+    const packageInfo = require(packagePath);
+
+    if (isStrapiPlugin(packageInfo)) {
+      validatePluginName(packageInfo.strapi.name);
+      installedPlugins[packageInfo.strapi.name] = {
+        ...toDetailedDeclaration({ enabled: true, resolve: packagePath }),
+        info: packageInfo.strapi,
+      };
+    }
+  }
+
+  const declaredPlugins = {};
+  const userPluginConfigPath = join(strapi.dirs.config, 'plugins.js');
+  const userPluginsConfig = existsSync(userPluginConfigPath)
+    ? loadConfigFile(userPluginConfigPath)
+    : {};
+
+  _.forEach(userPluginsConfig, (declaration, pluginName) => {
+    validatePluginName(pluginName);
+
+    declaredPlugins[pluginName] = {
+      ...toDetailedDeclaration(declaration),
+      info: {},
+    };
+
+    const { pathToPlugin } = declaredPlugins[pluginName];
+
+    // for manually resolved plugins
+    if (pathToPlugin) {
+      const packagePath = join(pathToPlugin, 'package.json');
+      const packageInfo = require(packagePath);
+
+      if (isStrapiPlugin(packageInfo)) {
+        declaredPlugins[pluginName].info = packageInfo.strapi || {};
+      }
+    }
+  });
+
+  const declaredPluginsResolves = map(prop('pathToPlugin'), declaredPlugins);
+  const installedPluginsNotAlreadyUsed = pickBy(
+    p => !declaredPluginsResolves.includes(p.pathToPlugin),
+    installedPlugins
+  );
+
+  const enabledPlugins = pipe(
+    defaultsDeep(declaredPlugins),
+    defaultsDeep(installedPluginsNotAlreadyUsed),
+    pickBy(p => p.enabled)
+  )(internalPlugins);
+
+  return enabledPlugins;
+};
+
+module.exports = getEnabledPlugins;

package/lib/core/loaders/plugins/index.js

@@ -0,0 +1,123 @@
+'use strict';
+
+const { join } = require('path');
+const fse = require('fs-extra');
+const { defaultsDeep, getOr, get } = require('lodash/fp');
+const { env } = require('@strapi/utils');
+const loadConfigFile = require('../../app-configuration/load-config-file');
+const loadFiles = require('../../../load/load-files');
+const getEnabledPlugins = require('./get-enabled-plugins');
+
+const defaultPlugin = {
+  bootstrap() {},
+  destroy() {},
+  register() {},
+  config: {
+    default: {},
+    validator() {},
+  },
+  routes: [],
+  controllers: {},
+  services: {},
+  policies: {},
+  middlewares: {},
+  contentTypes: {},
+};
+
+const applyUserExtension = async plugins => {
+  const extensionsDir = strapi.dirs.extensions;
+  if (!(await fse.pathExists(extensionsDir))) {
+    return;
+  }
+
+  const extendedSchemas = await loadFiles(extensionsDir, '**/content-types/**/schema.json');
+  const strapiServers = await loadFiles(extensionsDir, '**/strapi-server.js');
+
+  for (const pluginName in plugins) {
+    const plugin = plugins[pluginName];
+    // first: load json schema
+    for (const ctName in plugin.contentTypes) {
+      const extendedSchema = get([pluginName, 'content-types', ctName, 'schema'], extendedSchemas);
+      if (extendedSchema) {
+        plugin.contentTypes[ctName].schema = Object.assign(
+          {},
+          plugin.contentTypes[ctName].schema,
+          extendedSchema
+        );
+      }
+    }
+    // second: execute strapi-server extension
+    const strapiServer = get([pluginName, 'strapi-server'], strapiServers);
+    if (strapiServer) {
+      plugins[pluginName] = await strapiServer(plugin);
+    }
+  }
+};
+
+const formatContentTypes = plugins => {
+  for (const pluginName in plugins) {
+    const plugin = plugins[pluginName];
+    for (const contentTypeName in plugin.contentTypes) {
+      const ctSchema = plugin.contentTypes[contentTypeName].schema;
+      ctSchema.plugin = pluginName;
+      ctSchema.uid = `plugin::${pluginName}.${ctSchema.singularName}`;
+    }
+  }
+};
+
+const applyUserConfig = async plugins => {
+  const userPluginConfigPath = join(strapi.dirs.config, 'plugins.js');
+  const userPluginsConfig = (await fse.pathExists(userPluginConfigPath))
+    ? loadConfigFile(userPluginConfigPath)
+    : {};
+
+  for (const pluginName in plugins) {
+    const plugin = plugins[pluginName];
+    const userPluginConfig = getOr({}, `${pluginName}.config`, userPluginsConfig);
+    const defaultConfig =
+      typeof plugin.config.default === 'function'
+        ? plugin.config.default({ env })
+        : plugin.config.default;
+
+    const config = defaultsDeep(defaultConfig, userPluginConfig);
+    try {
+      plugin.config.validator(config);
+    } catch (e) {
+      throw new Error(`Error regarding ${pluginName} config: ${e.message}`);
+    }
+    plugin.config = config;
+  }
+};
+
+const loadPlugins = async strapi => {
+  const plugins = {};
+
+  const enabledPlugins = await getEnabledPlugins(strapi);
+
+  strapi.config.set('enabledPlugins', enabledPlugins);
+
+  for (const pluginName in enabledPlugins) {
+    const enabledPlugin = enabledPlugins[pluginName];
+
+    const serverEntrypointPath = join(enabledPlugin.pathToPlugin, 'strapi-server.js');
+
+    // only load plugins with a server entrypoint
+    if (!(await fse.pathExists(serverEntrypointPath))) {
+      continue;
+    }
+
+    const pluginServer = loadConfigFile(serverEntrypointPath);
+    plugins[pluginName] = defaultsDeep(defaultPlugin, pluginServer);
+  }
+
+  // TODO: validate plugin format
+  await applyUserConfig(plugins);
+  await applyUserExtension(plugins);
+  formatContentTypes(plugins);
+
+  for (const pluginName in plugins) {
+    strapi.container.get('plugins').add(pluginName, plugins[pluginName]);
+  }
+};
+
+module.exports = loadPlugins;

package/lib/core/loaders/policies.js

@@ -0,0 +1,28 @@
+'use strict';
+
+const { join, extname, basename } = require('path');
+const fse = require('fs-extra');
+
+// TODO:: allow folders with index.js inside for bigger policies
+module.exports = async function loadPolicies(strapi) {
+  const dir = strapi.dirs.policies;
+
+  if (!(await fse.pathExists(dir))) {
+    return;
+  }
+
+  const policies = {};
+  const paths = await fse.readdir(dir, { withFileTypes: true });
+
+  for (const fd of paths) {
+    const { name } = fd;
+    const fullPath = join(dir, name);
+
+    if (fd.isFile() && extname(name) === '.js') {
+      const key = basename(name, '.js');
+      policies[key] = require(fullPath);
+    }
+  }
+
+  strapi.container.get('policies').add(`global::`, policies);
+};

package/lib/core/loaders/src-index.js

@@ -0,0 +1,39 @@
+'use strict';
+
+const { resolve } = require('path');
+const { statSync, existsSync } = require('fs');
+const { yup } = require('@strapi/utils');
+
+const srcSchema = yup
+  .object()
+  .shape({
+    bootstrap: yup.mixed().isFunction(),
+    register: yup.mixed().isFunction(),
+    destroy: yup.mixed().isFunction(),
+  })
+  .noUnknown();
+
+const validateSrcIndex = srcIndex => {
+  return srcSchema.validateSync(srcIndex, { strict: true, abortEarly: false });
+};
+
+module.exports = strapi => {
+  if (!existsSync(strapi.dirs.src)) {
+    throw new Error('Missing src folder. Please create one at `./src`');
+  }
+
+  const pathToSrcIndex = resolve(strapi.dirs.src, 'index.js');
+  if (!existsSync(pathToSrcIndex) || statSync(pathToSrcIndex).isDirectory()) {
+    return {};
+  }
+
+  const srcIndex = require(pathToSrcIndex);
+
+  try {
+    validateSrcIndex(srcIndex);
+  } catch (e) {
+    strapi.stopWithError({ message: `Invalid file \`./src/index.js\`: ${e.message}` });
+  }
+
+  return srcIndex;
+};

package/lib/core/registries/apis.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const { has } = require('lodash/fp');
+
+const apisRegistry = strapi => {
+  const apis = {};
+
+  return {
+    get(name) {
+      return apis[name];
+    },
+    getAll() {
+      return apis;
+    },
+    add(apiName, apiConfig) {
+      if (has(apiName, apis)) {
+        throw new Error(`API ${apiName} has already been registered.`);
+      }
+
+      const api = strapi.container.get('modules').add(`api::${apiName}`, apiConfig);
+
+      apis[apiName] = api;
+
+      return apis[apiName];
+    },
+  };
+};
+
+module.exports = apisRegistry;

package/lib/core/{app-configuration/config-provider.js → registries/config.js}

@@ -1,28 +1,21 @@
 'use strict';
 
-const assert = require('assert');
 const _ = require('lodash');
 
 module.exports = (initialConfig = {}) => {
-  assert(
-    typeof initialConfig === 'object' && initialConfig !== null,
-    'Initial config must be an object'
-  );
+  const _config = Object.assign({}, initialConfig); // not deep clone because it would break some config
 
-  const _config = initialConfig;
-
-  return Object.assign(_config, {
+  return {
+    ..._config, // TODO: to remove
     get(path, defaultValue) {
       return _.get(_config, path, defaultValue);
     },
-
     set(path, val) {
       _.set(_config, path, val);
       return this;
     },
-
     has(path) {
       return _.has(_config, path);
     },
-  });
+  };
 };

package/lib/core/registries/content-types.js

@@ -0,0 +1,97 @@
+'use strict';
+
+const { pickBy, has } = require('lodash/fp');
+const { createContentType } = require('../domain/content-type');
+const { addNamespace, hasNamespace } = require('../utils');
+
+const validateKeySameToSingularName = contentTypes => {
+  for (const ctName in contentTypes) {
+    const contentType = contentTypes[ctName];
+
+    if (ctName !== contentType.schema.info.singularName) {
+      throw new Error(
+        `The key of the content-type should be the same as its singularName. Found ${ctName} and ${contentType.schema.info.singularName}.`
+      );
+    }
+  }
+};
+
+const contentTypesRegistry = () => {
+  const contentTypes = {};
+
+  return {
+    /**
+     * Returns this list of registered contentTypes uids
+     * @returns {string[]}
+     */
+    keys() {
+      return Object.keys(contentTypes);
+    },
+
+    /**
+     * Returns the instance of a contentType. Instantiate the contentType if not already done
+     * @param {string} uid
+     * @returns
+     */
+    get(uid) {
+      return contentTypes[uid];
+    },
+
+    /**
+     * Returns a map with all the contentTypes in a namespace
+     * @param {string} namespace
+     */
+    getAll(namespace) {
+      return pickBy((_, uid) => hasNamespace(uid, namespace))(contentTypes);
+    },
+
+    /**
+     * Registers a contentType
+     * @param {string} uid
+     * @param {Object} contentType
+     */
+    set(uid, contentType) {
+      contentTypes[uid] = contentType;
+      return this;
+    },
+
+    /**
+     * Registers a map of contentTypes for a specific namespace
+     * @param {string} namespace
+     * @param {{ [key: string]: Object }} newContentTypes
+     */
+    add(namespace, newContentTypes) {
+      validateKeySameToSingularName(newContentTypes);
+
+      for (const rawCtName in newContentTypes) {
+        const uid = addNamespace(rawCtName, namespace);
+
+        if (has(uid, contentTypes)) {
+          throw new Error(`Content-type ${uid} has already been registered.`);
+        }
+
+        contentTypes[uid] = createContentType(uid, newContentTypes[rawCtName]);
+      }
+    },
+
+    /**
+     * Wraps a contentType to extend it
+     * @param {string} uid
+     * @param {(contentType: Object) => Object} extendFn
+     */
+    extend(ctUID, extendFn) {
+      const currentContentType = this.get(ctUID);
+
+      if (!currentContentType) {
+        throw new Error(`Content-Type ${ctUID} doesn't exist`);
+      }
+
+      const newContentType = extendFn(currentContentType);
+      contentTypes[ctUID] = newContentType;
+
+      return this;
+    },
+  };
+};
+
+module.exports = contentTypesRegistry;

package/lib/core/registries/controllers.d.ts

@@ -0,0 +1,7 @@
+import { Strapi } from '../../';
+
+export type Controller = {
+  [key: string]: (...args: any) => any;
+};
+
+export type ControllerFactory = ({ strapi: Strapi }) => Controller;

package/lib/core/registries/controllers.js

@@ -0,0 +1,114 @@
+'use strict';
+
+const { pickBy, has } = require('lodash/fp');
+const { addNamespace, hasNamespace } = require('../utils');
+
+/**
+ * @typedef {import('./controllers').Controller} Controller
+ * @typedef {import('./controllers').ControllerFactory} ControllerFactory
+ */
+
+const controllersRegistry = () => {
+  const controllers = {};
+  const instances = {};
+
+  return {
+    /**
+     * Returns this list of registered controllers uids
+     * @returns {string[]}
+     */
+    keys() {
+      return Object.keys(controllers);
+    },
+
+    /**
+     * Returns the instance of a controller. Instantiate the controller if not already done
+     * @param {string} uid
+     * @returns {Controller}
+     */
+    get(uid) {
+      if (instances[uid]) {
+        return instances[uid];
+      }
+
+      const controller = controllers[uid];
+
+      if (controller) {
+        instances[uid] = typeof controller === 'function' ? controller({ strapi }) : controller;
+        return instances[uid];
+      }
+    },
+
+    /**
+     * Returns a map with all the controller in a namespace
+     * @param {string} namespace
+     * @returns {{ [key: string]: Controller }}
+     */
+    getAll(namespace) {
+      const filteredControllers = pickBy((_, uid) => hasNamespace(uid, namespace))(controllers);
+
+      const map = {};
+      for (const uid in filteredControllers) {
+        Object.defineProperty(map, uid, {
+          enumerable: true,
+          get: () => {
+            return this.get(uid);
+          },
+        });
+      }
+
+      return map;
+    },
+
+    /**
+     * Registers a controller
+     * @param {string} uid
+     * @param {Controller} controller
+     */
+    set(uid, value) {
+      controllers[uid] = value;
+      delete instances[uid];
+      return this;
+    },
+
+    /**
+     * Registers a map of controllers for a specific namespace
+     * @param {string} namespace
+     * @param {{ [key: string]: Controller|ControllerFactory }} newControllers
+     * @returns
+     */
+    add(namespace, newControllers) {
+      for (const controllerName in newControllers) {
+        const controller = newControllers[controllerName];
+        const uid = addNamespace(controllerName, namespace);
+
+        if (has(uid, controllers)) {
+          throw new Error(`Controller ${uid} has already been registered.`);
+        }
+        controllers[uid] = controller;
+      }
+
+      return this;
+    },
+
+    /**
+     * Wraps a controller to extend it
+     * @param {string} uid
+     * @param {(controller: Controller) => Controller} extendFn
+     */
+    extend(controllerUID, extendFn) {
+      const currentController = this.get(controllerUID);
+
+      if (!currentController) {
+        throw new Error(`Controller ${controllerUID} doesn't exist`);
+      }
+
+      const newController = extendFn(currentController);
+      instances[controllerUID] = newController;
+
+      return this;
+    },
+  };
+};
+
+module.exports = controllersRegistry;

package/lib/core/registries/hooks.d.ts

@@ -0,0 +1,20 @@
+
+type Handler = (context: any) => any;
+
+type AsyncHook = {
+  handlers: Handler[];
+  register(handler: Handler): this;
+  delete(handler: Handler): this;
+  call(): Promise<void>;
+};
+
+
+type SyncHook = {
+  get handlers(): Handler[];
+  register(handler: Handler): this;
+  delete(handler: Handler): this;
+  call(): void;
+};
+
+
+export type Hook = AsyncHook|SyncHook

package/lib/core/registries/hooks.js

@@ -0,0 +1,87 @@
+'use strict';
+
+const { pickBy } = require('lodash/fp');
+const { addNamespace, hasNamespace } = require('../utils');
+
+/**
+ * @typedef {import('./hooks').Hook} Hook
+ */
+
+const hooksRegistry = () => {
+  const hooks = {};
+
+  return {
+    /**
+     * Returns this list of registered hooks uids
+     * @returns {string[]}
+     */
+    keys() {
+      return Object.keys(hooks);
+    },
+
+    /**
+     * Returns the instance of a hook.
+     * @param {string} uid
+     * @returns {Hook}
+     */
+    get(uid) {
+      return hooks[uid];
+    },
+
+    /**
+     * Returns a map with all the hooks in a namespace
+     * @param {string} namespace
+     * @returns {{ [key: string]: Hook }}
+     */
+    getAll(namespace) {
+      return pickBy((_, uid) => hasNamespace(uid, namespace))(hooks);
+    },
+
+    /**
+     * Registers a hook
+     * @param {string} uid
+     * @param {Hook} hook
+     */
+    set(uid, hook) {
+      hooks[uid] = hook;
+      return this;
+    },
+
+    /**
+     * Registers a map of hooks for a specific namespace
+     * @param {string} namespace
+     * @param {{ [key: string]: Hook }} newHooks
+     * @returns
+     */
+    add(namespace, hooks) {
+      for (const hookName in hooks) {
+        const hook = hooks[hookName];
+        const uid = addNamespace(hookName, namespace);
+
+        this.set(uid, hook);
+      }
+
+      return this;
+    },
+
+    /**
+     * Wraps a hook to extend it
+     * @param {string} uid
+     * @param {(hook: Hook) => Hook} extendFn
+     */
+    extend(uid, extendFn) {
+      const currentHook = this.get(uid);
+
+      if (!currentHook) {
+        throw new Error(`Hook ${uid} doesn't exist`);
+      }
+
+      const newHook = extendFn(currentHook);
+      hooks[uid] = newHook;
+
+      return this;
+    },
+  };
+};
+
+module.exports = hooksRegistry;

package/lib/core/registries/middlewares.d.ts

@@ -0,0 +1,5 @@
+import { BaseContext, Middleware as KoaMiddleware } from 'koa';
+import { Strapi } from '../../';
+import { MiddlewareFactory } from '../../middlewares';
+
+export type Middleware = KoaMiddleware | MiddlewareFactory;