@strapi/strapi 4.13.0-beta.0 → 4.13.0

package/README.md

@@ -1,9 +1,17 @@
 <p align="center">
-  <a href="https://strapi.io/#gh-light-mode-only">
-    <img src="https://strapi.io/assets/strapi-logo-dark.svg" width="318px" alt="Strapi logo" />
-  </a>
-  <a href="https://strapi.io/#gh-dark-mode-only">
-    <img src="https://strapi.io/assets/strapi-logo-light.svg" width="318px" alt="Strapi logo" />
+  <a href="https://strapi.io">
+    <picture>
+      <source
+        srcset="https://strapi.io/assets/strapi-logo-dark.svg"
+        media="(prefers-color-scheme: dark)"
+        width="318px"
+      />
+      <img
+        src="https://strapi.io/assets/strapi-logo-light.svg"
+        alt="Strapi logo"
+        width="318px"
+      />
+    </picture>
   </a>
 </p>
 

package/lib/Strapi.js

@@ -46,6 +46,7 @@ const loaders = require('./core/loaders');
 const { destroyOnSignal } = require('./utils/signals');
 const getNumberOfDynamicZones = require('./services/utils/dynamic-zones');
 const sanitizersRegistry = require('./core/registries/sanitizers');
+const validatorsRegistry = require('./core/registries/validators');
 const convertCustomFieldType = require('./utils/convert-custom-field-type');
 
 // TODO: move somewhere else
@@ -99,6 +100,7 @@ class Strapi {
     this.container.register('auth', createAuth(this));
     this.container.register('content-api', createContentAPI(this));
     this.container.register('sanitizers', sanitizersRegistry(this));
+    this.container.register('validators', validatorsRegistry(this));
 
     // Create a mapping of every useful directory (for the app, dist and static directories)
     this.dirs = utils.getDirs(rootDirs, { strapi: this });
@@ -212,6 +214,10 @@ class Strapi {
     return this.container.get('sanitizers');
   }
 
+  get validators() {
+    return this.container.get('validators');
+  }
+
   async start() {
     try {
       if (!this.isLoaded) {
@@ -370,6 +376,10 @@ class Strapi {
     await loaders.loadSanitizers(this);
   }
 
+  async loadValidators() {
+    await loaders.loadValidators(this);
+  }
+
   registerInternalHooks() {
     this.container.get('hooks').set('strapi::content-types.beforeSync', createAsyncParallelHook());
     this.container.get('hooks').set('strapi::content-types.afterSync', createAsyncParallelHook());
@@ -382,6 +392,7 @@ class Strapi {
     await Promise.all([
       this.loadApp(),
       this.loadSanitizers(),
+      this.loadValidators(),
       this.loadPlugins(),
       this.loadAdmin(),
       this.loadAPIs(),

package/lib/commands/actions/import/action.js

@@ -23,6 +23,7 @@ const {
   getTransferTelemetryPayload,
   setSignalHandler,
   getDiffHandler,
+  parseRestoreFromOptions,
 } = require('../../utils/data-transfer');
 const { exitWith } = require('../../utils/helpers');
 
@@ -71,10 +72,9 @@ module.exports = async (opts) => {
     },
     autoDestroy: false,
     strategy: opts.conflictStrategy || DEFAULT_CONFLICT_STRATEGY,
-    restore: {
-      entities: { exclude: DEFAULT_IGNORED_CONTENT_TYPES },
-    },
+    restore: parseRestoreFromOptions(opts),
   };
+
   const destination = createLocalStrapiDestinationProvider(destinationOptions);
 
   /**
@@ -86,7 +86,7 @@ module.exports = async (opts) => {
     exclude: opts.exclude,
     only: opts.only,
     throttle: opts.throttle,
-    rules: {
+    transforms: {
       links: [
         {
           filter(link) {

package/lib/commands/actions/import/command.js

@@ -89,7 +89,7 @@ module.exports = ({ command }) => {
     .hook(
       'preAction',
       getCommanderConfirmMessage(
-        'The import will delete all assets and data in your database. Are you sure you want to proceed?',
+        'The import will delete your existing data! Are you sure you want to proceed?',
         { failMessage: 'Import process aborted' }
       )
     )

package/lib/commands/actions/transfer/action.js

@@ -25,6 +25,7 @@ const {
   setSignalHandler,
   getDiffHandler,
   getAssetsBackupHandler,
+  parseRestoreFromOptions,
 } = require('../../utils/data-transfer');
 const { exitWith } = require('../../utils/helpers');
 
@@ -88,9 +89,7 @@ module.exports = async (opts) => {
     destination = createLocalStrapiDestinationProvider({
       getStrapi: () => strapi,
       strategy: 'restore',
-      restore: {
-        entities: { exclude: DEFAULT_IGNORED_CONTENT_TYPES },
-      },
+      restore: parseRestoreFromOptions(opts),
     });
   }
   // if URL provided, set up a remote destination provider
@@ -106,9 +105,7 @@ module.exports = async (opts) => {
         token: opts.toToken,
       },
       strategy: 'restore',
-      restore: {
-        entities: { exclude: DEFAULT_IGNORED_CONTENT_TYPES },
-      },
+      restore: parseRestoreFromOptions(opts),
     });
   }
 

package/lib/commands/actions/transfer/command.js

@@ -105,7 +105,7 @@ module.exports = ({ command }) => {
           }
 
           await getCommanderConfirmMessage(
-            'The transfer will delete all the remote Strapi assets and its database. Are you sure you want to proceed?',
+            'The transfer will delete existing data from the remote Strapi! Are you sure you want to proceed?',
             { failMessage: 'Transfer process aborted' }
           )(thisCommand);
         }

package/lib/commands/actions/watch-admin/action.js

@@ -16,7 +16,7 @@ module.exports = async ({ browser }) => {
     serveAdminPanel: false,
   });
 
-  const plugins = await getEnabledPlugins(strapiInstance);
+  const plugins = await getEnabledPlugins(strapiInstance, { client: true });
 
   const { adminPath } = getConfigUrls(strapiInstance.config, true);
 

package/lib/commands/builders/admin.js

@@ -20,7 +20,7 @@ module.exports = async ({ buildDestDir, forceBuild = true, optimization, srcDir
     serveAdminPanel: false,
   });
 
-  const plugins = await getEnabledPlugins(strapiInstance);
+  const plugins = await getEnabledPlugins(strapiInstance, { client: true });
 
   const env = strapiInstance.config.get('environment');
   const { serverUrl, adminPath } = getConfigUrls(strapiInstance.config, true);

package/lib/commands/utils/data-transfer.js

@@ -291,7 +291,8 @@ const getDiffHandler = (engine, { force, action }) => {
         if (
           uid === 'admin::workflow' ||
           uid === 'admin::workflow-stage' ||
-          endPath?.startsWith('strapi_stage')
+          endPath?.startsWith('strapi_stage') ||
+          endPath?.startsWith('strapi_assignee')
         ) {
           workflowsStatus = diff.kind;
         }
@@ -369,6 +370,41 @@ const getAssetsBackupHandler = (engine, { force, action }) => {
   };
 };
 
+const shouldSkipStage = (opts, dataKind) => {
+  if (opts.exclude?.includes(dataKind)) {
+    return true;
+  }
+  if (opts.only) {
+    return !opts.only.includes(dataKind);
+  }
+
+  return false;
+};
+
+// Based on exclude/only from options, create the restore object to match
+const parseRestoreFromOptions = (opts) => {
+  const entitiesOptions = {
+    exclude: DEFAULT_IGNORED_CONTENT_TYPES,
+    include: undefined,
+  };
+
+  // if content is not included, send an empty array for include
+  if ((opts.only && !opts.only.includes('content')) || opts.exclude?.includes('content')) {
+    entitiesOptions.include = [];
+  }
+
+  const restoreConfig = {
+    entities: entitiesOptions,
+    assets: !shouldSkipStage(opts, 'files'),
+    configuration: {
+      webhooks: !shouldSkipStage(opts, 'config'),
+      coreStore: !shouldSkipStage(opts, 'config'),
+    },
+  };
+
+  return restoreConfig;
+};
+
 module.exports = {
   loadersFactory,
   buildTransferTable,
@@ -386,4 +422,6 @@ module.exports = {
   setSignalHandler,
   getDiffHandler,
   getAssetsBackupHandler,
+  shouldSkipStage,
+  parseRestoreFromOptions,
 };

package/lib/core/loaders/index.js

@@ -9,4 +9,5 @@ module.exports = {
   loadPlugins: require('./plugins'),
   loadAdmin: require('./admin'),
   loadSanitizers: require('./sanitizers'),
+  loadValidators: require('./validators'),
 };

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

@@ -3,7 +3,7 @@
 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 { get, pickBy, defaultsDeep, map, prop, pipe } = require('lodash/fp');
 const { isKebabCase } = require('@strapi/utils');
 const getUserPluginsConfig = require('./get-user-plugins-config');
 
@@ -21,31 +21,58 @@ const validatePluginName = (pluginName) => {
   }
 };
 
+/**
+ * @typedef {Object} PluginInstallDeclaration
+ * @property {boolean} enabled
+ * @property {string=} resolve
+ * @property {boolean=} isModule - whether the plugin is a node module or a local plugin
+ */
+
+/**
+ * @typedef {Object} DetailedDeclaration
+ * @property {boolean} enabled
+ * @property {string=} pathToPlugin
+ */
+
+/**
+ * @type {(declaration: PluginInstallDeclaration | boolean) => DetailedDeclaration}
+ */
 const toDetailedDeclaration = (declaration) => {
   if (typeof declaration === 'boolean') {
     return { enabled: declaration };
   }
 
-  const detailedDeclaration = pick(['enabled'], declaration);
-  if (has('resolve', declaration)) {
-    let pathToPlugin = '';
+  const detailedDeclaration = {
+    enabled: declaration.enabled,
+  };
 
-    try {
-      pathToPlugin = dirname(require.resolve(declaration.resolve));
-    } catch (e) {
-      pathToPlugin = resolve(strapi.dirs.app.root, declaration.resolve);
+  if (declaration?.resolve) {
+    let pathToPlugin = '';
 
-      if (!existsSync(pathToPlugin) || !statSync(pathToPlugin).isDirectory()) {
-        throw new Error(`${declaration.resolve} couldn't be resolved`);
+    if (declaration.isModule) {
+      /**
+       * we only want the node_module here, not the package.json
+       */
+      pathToPlugin = join(declaration.resolve, '..');
+    } else {
+      try {
+        pathToPlugin = dirname(require.resolve(declaration.resolve));
+      } catch (e) {
+        pathToPlugin = resolve(strapi.dirs.app.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 getEnabledPlugins = async (strapi, { client } = { client: false }) => {
   const internalPlugins = {};
   for (const dep of INTERNAL_PLUGINS) {
     const packagePath = join(dep, 'package.json');
@@ -53,7 +80,7 @@ const getEnabledPlugins = async (strapi) => {
 
     validatePluginName(packageInfo.strapi.name);
     internalPlugins[packageInfo.strapi.name] = {
-      ...toDetailedDeclaration({ enabled: true, resolve: packagePath }),
+      ...toDetailedDeclaration({ enabled: true, resolve: packagePath, isModule: client }),
       info: packageInfo.strapi,
     };
   }
@@ -73,7 +100,7 @@ const getEnabledPlugins = async (strapi) => {
     if (isStrapiPlugin(packageInfo)) {
       validatePluginName(packageInfo.strapi.name);
       installedPlugins[packageInfo.strapi.name] = {
-        ...toDetailedDeclaration({ enabled: true, resolve: packagePath }),
+        ...toDetailedDeclaration({ enabled: true, resolve: packagePath, isModule: client }),
         info: {
           ...packageInfo.strapi,
           packageName: packageInfo.name,

package/lib/core/loaders/sanitizers.js

@@ -1,5 +1,5 @@
 'use strict';
 
 module.exports = (strapi) => {
-  strapi.container.get('sanitizers').set('content-api', { input: [], output: [] });
+  strapi.container.get('sanitizers').set('content-api', { input: [], output: [], query: [] });
 };

package/lib/core/loaders/validators.js

@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = (strapi) => {
+  strapi.container.get('validators').set('content-api', { input: [], query: [] });
+};

package/lib/core/registries/validators.js

@@ -0,0 +1,26 @@
+'use strict';
+
+const _ = require('lodash');
+
+const validatorsRegistry = () => {
+  const validators = {};
+
+  return {
+    get(path) {
+      return _.get(validators, path, []);
+    },
+    add(path, sanitizer) {
+      this.get(path).push(sanitizer);
+      return this;
+    },
+    set(path, value = []) {
+      _.set(validators, path, value);
+      return this;
+    },
+    has(path) {
+      return _.has(validators, path);
+    },
+  };
+};
+
+module.exports = validatorsRegistry;

package/lib/core-api/controller/collection-type.js

@@ -19,7 +19,9 @@ const createCollectionTypeController = ({ contentType }) => {
      * @return {Object|Array}
      */
     async find(ctx) {
+      await this.validateQuery(ctx);
       const sanitizedQuery = await this.sanitizeQuery(ctx);
+
       const { results, pagination } = await strapi.service(uid).find(sanitizedQuery);
       const sanitizedResults = await this.sanitizeOutput(results, ctx);
       return this.transformResponse(sanitizedResults, { pagination });
@@ -32,9 +34,10 @@ const createCollectionTypeController = ({ contentType }) => {
      */
     async findOne(ctx) {
       const { id } = ctx.params;
-      const { query } = ctx;
+      await this.validateQuery(ctx);
+      const sanitizedQuery = await this.sanitizeQuery(ctx);
 
-      const entity = await strapi.service(uid).findOne(id, query);
+      const entity = await strapi.service(uid).findOne(id, sanitizedQuery);
       const sanitizedEntity = await this.sanitizeOutput(entity, ctx);
 
       return this.transformResponse(sanitizedEntity);
@@ -46,7 +49,8 @@ const createCollectionTypeController = ({ contentType }) => {
      * @return {Object}
      */
     async create(ctx) {
-      const { query } = ctx.request;
+      await this.validateQuery(ctx);
+      const sanitizedQuery = await this.sanitizeQuery(ctx);
 
       const { data, files } = parseBody(ctx);
 
@@ -58,7 +62,7 @@ const createCollectionTypeController = ({ contentType }) => {
 
       const entity = await strapi
         .service(uid)
-        .create({ ...query, data: sanitizedInputData, files });
+        .create({ ...sanitizedQuery, data: sanitizedInputData, files });
       const sanitizedEntity = await this.sanitizeOutput(entity, ctx);
 
       return this.transformResponse(sanitizedEntity);
@@ -71,7 +75,8 @@ const createCollectionTypeController = ({ contentType }) => {
      */
     async update(ctx) {
       const { id } = ctx.params;
-      const { query } = ctx.request;
+      await this.validateQuery(ctx);
+      const sanitizedQuery = await this.sanitizeQuery(ctx);
 
       const { data, files } = parseBody(ctx);
 
@@ -83,7 +88,7 @@ const createCollectionTypeController = ({ contentType }) => {
 
       const entity = await strapi
         .service(uid)
-        .update(id, { ...query, data: sanitizedInputData, files });
+        .update(id, { ...sanitizedQuery, data: sanitizedInputData, files });
       const sanitizedEntity = await this.sanitizeOutput(entity, ctx);
 
       return this.transformResponse(sanitizedEntity);
@@ -96,9 +101,10 @@ const createCollectionTypeController = ({ contentType }) => {
      */
     async delete(ctx) {
       const { id } = ctx.params;
-      const { query } = ctx;
+      await this.validateQuery(ctx);
+      const sanitizedQuery = await this.sanitizeQuery(ctx);
 
-      const entity = await strapi.service(uid).delete(id, query);
+      const entity = await strapi.service(uid).delete(id, sanitizedQuery);
       const sanitizedEntity = await this.sanitizeOutput(entity, ctx);
 
       return this.transformResponse(sanitizedEntity);

package/lib/core-api/controller/index.js

@@ -2,7 +2,7 @@
 
 const { getOr } = require('lodash/fp');
 
-const { contentTypes, sanitize } = require('@strapi/utils');
+const { contentTypes, sanitize, validate } = require('@strapi/utils');
 
 const { transformResponse } = require('./transform');
 const createSingleTypeController = require('./single-type');
@@ -24,17 +24,29 @@ const createController = ({ contentType }) => {
       return sanitize.contentAPI.output(data, contentType, { auth });
     },
 
-    sanitizeInput(data, ctx) {
+    async sanitizeInput(data, ctx) {
       const auth = getAuthFromKoaContext(ctx);
 
       return sanitize.contentAPI.input(data, contentType, { auth });
     },
 
-    sanitizeQuery(ctx) {
+    async sanitizeQuery(ctx) {
       const auth = getAuthFromKoaContext(ctx);
 
       return sanitize.contentAPI.query(ctx.query, contentType, { auth });
     },
+
+    async validateQuery(ctx) {
+      const auth = getAuthFromKoaContext(ctx);
+
+      return validate.contentAPI.query(ctx.query, contentType, { auth });
+    },
+
+    async validateInput(data, ctx) {
+      const auth = getAuthFromKoaContext(ctx);
+
+      return validate.contentAPI.input(data, contentType, { auth });
+    },
   };
 
   let ctrl;

package/lib/core-api/controller/single-type.js

@@ -18,7 +18,9 @@ const createSingleTypeController = ({ contentType }) => {
      * @return {Object|Array}
      */
     async find(ctx) {
+      await this.validateQuery(ctx);
       const sanitizedQuery = await this.sanitizeQuery(ctx);
+
       const entity = await strapi.service(uid).find(sanitizedQuery);
 
       const sanitizedEntity = await this.sanitizeOutput(entity, ctx);

package/lib/factories.d.ts

@@ -1,21 +1,18 @@
-import type { Common, CoreApi, Strapi } from '@strapi/strapi';
-
-type WithStrapiCallback<T> = <S extends { strapi: Strapi }>(params: S) => T;
+import type { Common, CoreApi } from '@strapi/strapi';
 
 export declare function createCoreRouter<T extends Common.UID.ContentType>(
   uid: T,
   cfg?: CoreApi.Router.RouterConfig<T>
 ): () => CoreApi.Router.Router;
 
-export declare function createCoreController<
-  T extends Common.UID.ContentType,
-  S extends Partial<CoreApi.Controller.Extendable<T>>
->(
+// TODO: Find a cleaner way to expose methods for customization
+export declare function createCoreController<T extends Common.UID.ContentType>(
   uid: T,
-  config?: WithStrapiCallback<S> | S
-): () => Required<S & CoreApi.Controller.ContentType<T>>;
+  config?: any
+): () => any;
 
-export declare function createCoreService<
-  T extends Common.UID.ContentType,
-  S extends Partial<CoreApi.Service.Extendable<T>>
->(uid: T, config?: WithStrapiCallback<S> | S): () => Required<S & CoreApi.Service.ContentType<T>>;
+// TODO: Find a cleaner way to expose methods for customization
+export declare function createCoreService<T extends Common.UID.ContentType>(
+  uid: T,
+  config?: any
+): () => any;

package/lib/factories.js

@@ -6,10 +6,20 @@ const { createController } = require('./core-api/controller');
 const { createService } = require('./core-api/service');
 const { createRoutes } = require('./core-api/routes');
 
+// Content type is proxied to allow for dynamic content type updates
+const getContentTypeProxy = (strapi, uid) => {
+  return new Proxy(strapi.contentType(uid), {
+    get(target, prop) {
+      const contentType = strapi.contentType(uid);
+      return contentType[prop];
+    },
+  });
+};
+
 const createCoreController = (uid, cfg = {}) => {
   return ({ strapi }) => {
     const baseController = createController({
-      contentType: strapi.contentType(uid),
+      contentType: getContentTypeProxy(strapi, uid),
     });
 
     const userCtrl = typeof cfg === 'function' ? cfg({ strapi }) : cfg;
@@ -28,7 +38,7 @@ const createCoreController = (uid, cfg = {}) => {
 const createCoreService = (uid, cfg = {}) => {
   return ({ strapi }) => {
     const baseService = createService({
-      contentType: strapi.contentType(uid),
+      contentType: getContentTypeProxy(strapi, uid),
     });
 
     const userService = typeof cfg === 'function' ? cfg({ strapi }) : cfg;

package/lib/services/entity-service/index.d.ts

@@ -1,100 +1 @@
-import type { Database, ID } from '@strapi/database';
-import { Strapi } from '../../';
-
-type EntityServiceAction =
-  | 'findMany'
-  | 'findPage'
-  | 'findWithRelationCountsPage'
-  | 'findWithRelationCounts'
-  | 'findOne'
-  | 'count'
-  | 'create'
-  | 'update'
-  | 'delete';
-
-type PaginationInfo = {
-  page: number;
-  pageSize: number;
-  pageCount: number;
-  total: number;
-};
-
-type Params<T> = {
-  fields?: (keyof T)[];
-  filters?: any;
-  _q?: string;
-  populate?: any;
-  sort?: any;
-  start?: number;
-  limit?: number;
-  page?: number;
-  pageSize?: number;
-  publicationState?: string;
-  data?: any;
-  files?: any;
-};
-
-export interface EntityService {
-  uploadFiles<K extends keyof AllTypes, T extends AllTypes[K]>(uid: K, entity, files);
-  wrapParams<K extends keyof AllTypes, T extends AllTypes[K]>(
-    params: Params<T>,
-    { uid: K, action: EntityServiceAction }
-  );
-
-  findMany<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    params: Params<T>
-  ): Promise<T[]>;
-  findPage<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    params: Params<T>
-  ): Promise<{
-    results: T[];
-    pagination: PaginationInfo;
-  }>;
-
-  findWithRelationCountsPage<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    params: Params<T>
-  ): Promise<{
-    results: T[];
-    pagination: PaginationInfo;
-  }>;
-
-  findWithRelationCounts<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    params: Params<T>
-  ): Promise<T[]>;
-
-  findOne<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    entityId: ID,
-    params: Params<T>
-  ): Promise<T>;
-
-  count<K extends keyof AllTypes, T extends AllTypes[K]>(uid: K, params: Params<T>): Promise<any>;
-  create<K extends keyof AllTypes, T extends AllTypes[K]>(uid: K, params: Params<T>): Promise<any>;
-  update<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    entityId: ID,
-    params: Params<T>
-  ): Promise<any>;
-  delete<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    entityId: ID,
-    params: Params<T>
-  ): Promise<any>;
-  clone<K extends keyof AllTypes, T extends AllTypes[K]>(
-    uid: K,
-    cloneId: ID,
-    params: Params<T>
-  ): Promise<any>;
-}
-
-export default function (opts: {
-  strapi: Strapi;
-  db: Database;
-  // TODO: define types
-  eventHub: any;
-  entityValidator: any;
-}): EntityService;
+export * from './types';

package/lib/services/entity-service/index.js

@@ -172,6 +172,7 @@ const createDefaultImplementation = ({ strapi, db, eventHub, entityValidator })
       data: entityData,
     });
 
+    // TODO: do all of this in a transaction to avoid a race condition where entity is created then deleted before we do findOne again
     // TODO: upload the files then set the links in the entity like with compo to avoid making too many queries
     if (files && Object.keys(files).length > 0) {
       await this.uploadFiles(uid, Object.assign(entityData, entity), files);