@strapi/strapi 4.0.0-next.8 → 4.0.2

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

@@ -0,0 +1,71 @@
+'use strict';
+
+const { isSingleType } = require('@strapi/utils').contentTypes;
+
+const createRoutes = ({ contentType }) => {
+  if (isSingleType(contentType)) {
+    return getSingleTypeRoutes(contentType);
+  }
+
+  return getCollectionTypeRoutes(contentType);
+};
+
+const getSingleTypeRoutes = ({ uid, info }) => {
+  return {
+    find: {
+      method: 'GET',
+      path: `/${info.singularName}`,
+      handler: `${uid}.find`,
+      config: {},
+    },
+    update: {
+      method: 'PUT',
+      path: `/${info.singularName}`,
+      handler: `${uid}.update`,
+      config: {},
+    },
+    delete: {
+      method: 'DELETE',
+      path: `/${info.singularName}`,
+      handler: `${uid}.delete`,
+      config: {},
+    },
+  };
+};
+
+const getCollectionTypeRoutes = ({ uid, info }) => {
+  return {
+    find: {
+      method: 'GET',
+      path: `/${info.pluralName}`,
+      handler: `${uid}.find`,
+      config: {},
+    },
+    findOne: {
+      method: 'GET',
+      path: `/${info.pluralName}/:id`,
+      handler: `${uid}.findOne`,
+      config: {},
+    },
+    create: {
+      method: 'POST',
+      path: `/${info.pluralName}`,
+      handler: `${uid}.create`,
+      config: {},
+    },
+    update: {
+      method: 'PUT',
+      path: `/${info.pluralName}/:id`,
+      handler: `${uid}.update`,
+      config: {},
+    },
+    delete: {
+      method: 'DELETE',
+      path: `/${info.pluralName}/:id`,
+      handler: `${uid}.delete`,
+      config: {},
+    },
+  };
+};
+
+module.exports = { createRoutes };

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

@@ -7,6 +7,13 @@ const {
   constants: { PUBLISHED_AT_ATTRIBUTE },
 } = require('@strapi/utils').contentTypes;
 
+const {
+  getPaginationInfo,
+  convertPagedToStartLimit,
+  shouldCount,
+  transformPaginationResponse,
+} = require('./pagination');
+
 const setPublishedAt = data => {
   data[PUBLISHED_AT_ATTRIBUTE] = propOr(new Date(), PUBLISHED_AT_ATTRIBUTE, data);
 };
@@ -15,42 +22,57 @@ const setPublishedAt = data => {
  *
  * Returns a collection type service to handle default core-api actions
  */
-const createCollectionTypeService = ({ model, strapi, utils }) => {
-  const { uid } = model;
-
-  const { sanitizeInput, getFetchParams } = utils;
+const createCollectionTypeService = ({ contentType }) => {
+  const { uid } = contentType;
 
   return {
-    find(opts = {}) {
-      const params = getFetchParams(opts.params);
+    async find(params = {}) {
+      const fetchParams = this.getFetchParams(params);
 
-      return strapi.entityService.findPage(uid, { params });
-    },
+      const paginationInfo = getPaginationInfo(fetchParams);
+
+      const results = await strapi.entityService.findMany(uid, {
+        ...fetchParams,
+        ...convertPagedToStartLimit(paginationInfo),
+      });
 
-    findOne(entityId, opts = {}) {
-      const params = getFetchParams(opts.params);
+      if (shouldCount(fetchParams)) {
+        const count = await strapi.entityService.count(uid, { ...fetchParams, ...paginationInfo });
+
+        return {
+          results,
+          pagination: transformPaginationResponse(paginationInfo, count),
+        };
+      }
+
+      return {
+        results,
+        pagination: paginationInfo,
+      };
+    },
 
-      return strapi.entityService.findOne(uid, entityId, { params });
+    findOne(entityId, params = {}) {
+      return strapi.entityService.findOne(uid, entityId, this.getFetchParams(params));
     },
 
-    create({ params, data, files } = {}) {
-      const sanitizedData = sanitizeInput(data);
+    create(params = {}) {
+      const { data } = params;
 
-      if (hasDraftAndPublish(model)) {
-        setPublishedAt(sanitizedData);
+      if (hasDraftAndPublish(contentType)) {
+        setPublishedAt(data);
       }
 
-      return strapi.entityService.create(uid, { params, data: sanitizedData, files });
+      return strapi.entityService.create(uid, { ...params, data });
     },
 
-    update(entityId, { params, data, files } = {}) {
-      const sanitizedData = sanitizeInput(data);
+    update(entityId, params = {}) {
+      const { data } = params;
 
-      return strapi.entityService.update(uid, entityId, { params, data: sanitizedData, files });
+      return strapi.entityService.update(uid, entityId, { ...params, data });
     },
 
-    delete(entityId, { params } = {}) {
-      return strapi.entityService.delete(uid, entityId, { params });
+    delete(entityId, params = {}) {
+      return strapi.entityService.delete(uid, entityId, params);
     },
   };
 };

package/lib/core-api/service/index.d.ts

@@ -0,0 +1,21 @@
+type Entity = object;
+
+interface BaseService {
+  getFetchParams(params: object): object;
+}
+
+export interface SingleTypeService extends BaseService {
+  find(params: object): Promise<Entity>;
+  createOrUpdate(params: object): Promise<Entity>;
+  delete(params: object): Promise<Entity>;
+}
+
+export interface CollectionTypeService extends BaseService {
+  find(params: object): Promise<Entity[]>;
+  findOne(params: object): Promise<Entity>;
+  create(params: object): Promise<Entity>;
+  update(params: object): Promise<Entity>;
+  delete(params: object): Promise<Entity>;
+}
+
+export type Service = SingleTypeService | CollectionTypeService;

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

@@ -1,10 +1,7 @@
 'use strict';
 
-const _ = require('lodash');
-
 const {
   isSingleType,
-  getNonWritableAttributes,
   constants: { DP_PUB_STATE_LIVE },
 } = require('@strapi/utils').contentTypes;
 
@@ -16,62 +13,18 @@ const createCollectionTypeService = require('./collection-type');
  * @param {{ model: object, strapi: object }} context
  * @returns {object}
  */
-const createService = ({ model, strapi }) => {
-  const utils = createUtils({ model });
-
-  if (isSingleType(model)) {
-    return createSingleTypeService({ model, strapi, utils });
-  }
+const createService = ({ contentType }) => {
+  const proto = { getFetchParams };
 
-  return createCollectionTypeService({ model, strapi, utils });
-};
-
-/**
- * Default limit values from config
- * @return {{maxLimit: number, defaultLimit: number}}
- */
-const getLimitConfigDefaults = () => ({
-  defaultLimit: _.toNumber(strapi.config.get('api.rest.defaultLimit', 100)),
-  maxLimit: _.toNumber(strapi.config.get('api.rest.maxLimit')) || null,
-});
+  let service;
 
-/**
- * if there is max limit set and limit exceeds this number, return configured max limit
- * @param {number} limit - limit you want to cap
- * @param {number?} maxLimit - maxlimit used has capping
- * @returns {number}
- */
-const applyMaxLimit = (limit, maxLimit) => {
-  if (maxLimit && (limit === -1 || limit > maxLimit)) {
-    return maxLimit;
+  if (isSingleType(contentType)) {
+    service = createSingleTypeService({ contentType });
+  } else {
+    service = createCollectionTypeService({ contentType });
   }
 
-  return limit;
-};
-
-const applyDefaultPagination = params => {
-  const { defaultLimit, maxLimit } = getLimitConfigDefaults();
-
-  if (_.isUndefined(params.pagination) || !_.isPlainObject(params.pagination)) {
-    return {
-      limit: defaultLimit,
-    };
-  }
-
-  const { pagination } = params;
-
-  if (!_.isUndefined(pagination.pageSize)) {
-    return {
-      page: pagination.page,
-      pageSize: applyMaxLimit(_.toNumber(pagination.pageSize), maxLimit),
-    };
-  }
-
-  const limit = _.isUndefined(pagination.limit) ? defaultLimit : _.toNumber(pagination.limit);
-  return {
-    start: pagination.start,
-    limit: applyMaxLimit(limit, maxLimit),
-  };
+  return Object.assign(Object.create(proto), service);
 };
 
 /**
@@ -83,18 +36,6 @@ const getFetchParams = (params = {}) => {
   return {
     publicationState: DP_PUB_STATE_LIVE,
     ...params,
-    pagination: applyDefaultPagination(params),
-  };
-};
-
-/**
- * Mixins
- */
-const createUtils = ({ model }) => {
-  return {
-    // make sure to keep the call to getNonWritableAttributes dynamic
-    sanitizeInput: data => _.omit(data, getNonWritableAttributes(model)),
-    getFetchParams,
   };
 };
 

package/lib/core-api/service/pagination.js

@@ -0,0 +1,125 @@
+'use strict';
+
+const { has, toNumber, isUndefined } = require('lodash/fp');
+const { ValidationError } = require('@strapi/utils').errors;
+
+/**
+ * Default limit values from config
+ * @return {{maxLimit: number, defaultLimit: number}}
+ */
+const getLimitConfigDefaults = () => ({
+  defaultLimit: toNumber(strapi.config.get('api.rest.defaultLimit', 25)),
+  maxLimit: toNumber(strapi.config.get('api.rest.maxLimit')) || null,
+});
+
+/**
+ * Should maxLimit be used as the limit or not
+ * @param {number} limit - limit you want to cap
+ * @param {number?} maxLimit - maxlimit used has capping
+ * @returns {boolean}
+ */
+const shouldApplyMaxLimit = (limit, maxLimit = null, { isPagedPagination = false } = {}) =>
+  (!isPagedPagination && limit === -1) || (maxLimit && limit > maxLimit);
+
+const shouldCount = params => {
+  if (has('pagination.withCount', params)) {
+    const { withCount } = params.pagination;
+
+    if (typeof withCount === 'boolean') {
+      return withCount;
+    }
+
+    if (['true', 't', '1', 1].includes(withCount)) {
+      return true;
+    }
+
+    if (['false', 'f', '0', 0].includes(withCount)) {
+      return false;
+    }
+
+    throw new ValidationError(
+      'Invalid withCount parameter. Expected "t","1","true","false","0","f"'
+    );
+  }
+
+  return Boolean(strapi.config.get('api.rest.withCount', true));
+};
+
+const isOffsetPagination = pagination => has('start', pagination) || has('limit', pagination);
+const isPagedPagination = pagination => has('page', pagination) || has('pageSize', pagination);
+
+const getPaginationInfo = params => {
+  const { defaultLimit, maxLimit } = getLimitConfigDefaults();
+
+  const { pagination } = params;
+
+  const isPaged = isPagedPagination(pagination);
+  const isOffset = isOffsetPagination(pagination);
+
+  if (!isPaged && !isOffset) {
+    return {
+      page: 1,
+      pageSize: defaultLimit,
+    };
+  }
+
+  if (isOffset && isPaged) {
+    throw new ValidationError(
+      'Invalid pagination parameters. Expected either start/limit or page/pageSize'
+    );
+  }
+
+  if (isPagedPagination(pagination)) {
+    const pageSize = isUndefined(pagination.pageSize)
+      ? defaultLimit
+      : Math.max(1, toNumber(pagination.pageSize));
+
+    return {
+      page: Math.max(1, toNumber(pagination.page || 1)),
+      pageSize: shouldApplyMaxLimit(pageSize, maxLimit, { isPagedPagination: true })
+        ? maxLimit
+        : Math.max(1, pageSize),
+    };
+  }
+
+  const limit = isUndefined(pagination.limit) ? defaultLimit : toNumber(pagination.limit);
+
+  return {
+    start: Math.max(0, toNumber(pagination.start || 0)),
+    limit: shouldApplyMaxLimit(limit, maxLimit) ? maxLimit || -1 : Math.max(1, limit),
+  };
+};
+
+const convertPagedToStartLimit = pagination => {
+  if (isPagedPagination(pagination)) {
+    const { page, pageSize } = pagination;
+    return {
+      start: (page - 1) * pageSize,
+      limit: pageSize,
+    };
+  }
+
+  return pagination;
+};
+
+const transformPaginationResponse = (paginationInfo, count) => {
+  if (paginationInfo.page) {
+    return {
+      ...paginationInfo,
+      pageCount: Math.ceil(count / paginationInfo.pageSize),
+      total: count,
+    };
+  }
+
+  return {
+    ...paginationInfo,
+    total: count,
+  };
+};
+
+module.exports = {
+  getPaginationInfo,
+  convertPagedToStartLimit,
+  transformPaginationResponse,
+  shouldCount,
+};

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

@@ -1,20 +1,24 @@
 'use strict';
 
+const { ValidationError } = require('@strapi/utils').errors;
+
 /**
  * Returns a single type service to handle default core-api actions
  */
-const createSingleTypeService = ({ model, strapi, utils }) => {
-  const { uid } = model;
-  const { sanitizeInput, getFetchParams } = utils;
+const createSingleTypeService = ({ contentType }) => {
+  const { uid } = contentType;
 
+  /**
+   * @type {import('./').SingleTypeService}
+   */
   return {
     /**
      * Returns singleType content
      *
      * @return {Promise}
      */
-    find({ params } = {}) {
-      return strapi.entityService.find(uid, { params: getFetchParams(params) });
+    find(params = {}) {
+      return strapi.entityService.findMany(uid, this.getFetchParams(params));
     },
 
     /**
@@ -22,25 +26,19 @@ const createSingleTypeService = ({ model, strapi, utils }) => {
      *
      * @return {Promise}
      */
-    async createOrUpdate({ params, data, files } = {}) {
-      const entity = await this.find({ params });
-
-      const sanitizedData = sanitizeInput(data);
+    async createOrUpdate({ data, ...params } = {}) {
+      const entity = await this.find(params);
 
       if (!entity) {
         const count = await strapi.query(uid).count();
         if (count >= 1) {
-          throw strapi.errors.badRequest('singleType.alreadyExists');
+          throw new ValidationError('singleType.alreadyExists');
         }
 
-        return strapi.entityService.create(uid, { params, data: sanitizedData, files });
-      } else {
-        return strapi.entityService.update(uid, entity.id, {
-          params,
-          data: sanitizedData,
-          files,
-        });
+        return strapi.entityService.create(uid, { ...params, data });
       }
+
+      return strapi.entityService.update(uid, entity.id, { ...params, data });
     },
 
     /**
@@ -48,8 +46,8 @@ const createSingleTypeService = ({ model, strapi, utils }) => {
      *
      * @return {Promise}
      */
-    async delete({ params } = {}) {
-      const entity = await this.find({ params });
+    async delete(params = {}) {
+      const entity = await this.find(params);
 
       if (!entity) return;
 

package/lib/factories.d.ts

@@ -0,0 +1,48 @@
+import { Service } from './core-api/service';
+import { Controller } from './core-api/controller';
+import { Middleware } from './middlewares';
+import { Policy } from './core/registries/policies';
+
+type ControllerConfig = Controller;
+
+type ServiceConfig = Service;
+
+type HandlerConfig = {
+  auth: false | { scope: string[] };
+  policies: Array<string | Policy>;
+  middlewares: Array<string | Middleware>;
+};
+
+type SingleTypeRouterConfig = {
+  find: HandlerConfig;
+  update: HandlerConfig;
+  delete: HandlerConfig;
+};
+
+type CollectionTypeRouterConfig = {
+  find: HandlerConfig;
+  findOne: HandlerConfig;
+  create: HandlerConfig;
+  update: HandlerConfig;
+  delete: HandlerConfig;
+};
+
+type RouterConfig = {
+  prefix: string;
+  only: string[];
+  except: string[];
+  config: SingleTypeRouterConfig | CollectionTypeRouterConfig;
+};
+
+interface Route {
+  method: string;
+  path: string;
+}
+interface Router {
+  prefix: string;
+  routes: Route[];
+}
+
+export function createCoreRouter(uid: string, cfg: RouterConfig): () => Router;
+export function createCoreController(uid: string, cfg: ControllerConfig): () => Controller;
+export function createCoreService(uid: string, cfg: ServiceConfig): () => Service;

package/lib/factories.js

@@ -0,0 +1,84 @@
+'use strict';
+
+const { pipe, omit, pick } = require('lodash/fp');
+
+const { createController } = require('./core-api/controller');
+const { createService } = require('./core-api/service');
+const { createRoutes } = require('./core-api/routes');
+
+const createCoreController = (uid, cfg = {}) => {
+  return ({ strapi }) => {
+    const baseController = createController({
+      contentType: strapi.contentType(uid),
+    });
+
+    let userCtrl = typeof cfg === 'function' ? cfg({ strapi }) : cfg;
+
+    for (const methodName of Object.keys(baseController)) {
+      if (userCtrl[methodName] === undefined) {
+        userCtrl[methodName] = baseController[methodName];
+      }
+    }
+
+    Object.setPrototypeOf(userCtrl, baseController);
+    return userCtrl;
+  };
+};
+
+const createCoreService = (uid, cfg = {}) => {
+  return ({ strapi }) => {
+    const baseService = createService({
+      contentType: strapi.contentType(uid),
+    });
+
+    let userService = typeof cfg === 'function' ? cfg({ strapi }) : cfg;
+
+    for (const methodName of Object.keys(baseService)) {
+      if (userService[methodName] === undefined) {
+        userService[methodName] = baseService[methodName];
+      }
+    }
+
+    Object.setPrototypeOf(userService, baseService);
+    return userService;
+  };
+};
+
+const createCoreRouter = (uid, cfg = {}) => {
+  const { prefix, config = {}, only, except } = cfg;
+  let routes;
+
+  return {
+    get prefix() {
+      return prefix;
+    },
+    get routes() {
+      if (!routes) {
+        const contentType = strapi.contentType(uid);
+
+        const defaultRoutes = createRoutes({ contentType });
+
+        Object.keys(defaultRoutes).forEach(routeName => {
+          const defaultRoute = defaultRoutes[routeName];
+
+          Object.assign(defaultRoute.config, config[routeName] || {});
+        });
+
+        const selectedRoutes = pipe(
+          routes => (except ? omit(except, routes) : routes),
+          routes => (only ? pick(only, routes) : routes)
+        )(defaultRoutes);
+
+        routes = Object.values(selectedRoutes);
+      }
+
+      return routes;
+    },
+  };
+};
+
+module.exports = {
+  createCoreController,
+  createCoreService,
+  createCoreRouter,
+};

package/lib/index.d.ts

@@ -1,40 +1,15 @@
 import { Database } from '@strapi/database';
-import { Strapi } from './Strapi';
+import { EntityService } from './services/entity-service';
+import { Strapi as StrapiClass } from './Strapi';
 
-type ID = number | string;
-
-interface Options<T> {
-  params: Params<T>;
-}
-
-interface Params<T> {
-  fields: (keyof T)[];
-}
-
-interface EntityService {
-  uploadFiles<T extends keyof AllTypes>(uid: T);
-  wrapOptions<T extends keyof AllTypes>(uid: T);
-
-  find<T extends keyof AllTypes>(uid: T): Promise<AllTypes[T][]>;
-  findPage<T extends keyof AllTypes>(uid: T): Promise<any>;
-  findWithRelationCounts<T extends keyof AllTypes>(uid: T): Promise<any>;
-  findOne<T extends keyof AllTypes>(
-    uid: T,
-    id: ID,
-    opts: Options<AllTypes[T]>
-  ): Promise<AllTypes[T]>;
-
-  count<T extends keyof AllTypes>(uid: T): Promise<any>;
-  create<T extends keyof AllTypes>(uid: T): Promise<any>;
-  update<T extends keyof AllTypes>(uid: T): Promise<any>;
-  delete<T extends keyof AllTypes>(uid: T): Promise<any>;
-}
-
-interface StrapiInterface extends Strapi {
+export * as factories from './factories';
+interface StrapiInterface extends StrapiClass {
   query: Database['query'];
   entityService: EntityService;
 }
 
+export type Strapi = StrapiInterface;
+
 declare global {
   interface AllTypes {}
 }
@@ -44,5 +19,9 @@ declare global {
     strapi: StrapiInterface;
   }
 
+  export type Strapi = StrapiInterface;
+
   const strapi: StrapiInterface;
 }
+
+export default function(opts): Strapi;

package/lib/index.js

@@ -1,3 +1,7 @@
 'use strict';
 
-module.exports = require('./Strapi');
+const Strapi = require('./Strapi');
+
+Strapi.factories = require('./factories');
+
+module.exports = Strapi;