@strapi/utils 4.0.0-next.13 → 4.0.0-next.14

package/lib/convert-query-params.js

@@ -6,6 +6,7 @@
  */
 
 const _ = require('lodash');
+const parseType = require('./parse-type');
 
 const QUERY_OPERATORS = ['_where', '_or', '_and'];
 
@@ -29,6 +30,10 @@ const validateOrder = order => {
   }
 };
 
+const convertCountQueryParams = countQuery => {
+  return parseType({ type: 'boolean', value: countQuery });
+};
+
 /**
  * Sort query parser
  * @param {string} sortQuery - ex: id:asc,price:desc
@@ -161,7 +166,7 @@ const convertNestedPopulate = subPopulate => {
   }
 
   // TODO: We will need to consider a way to add limitation / pagination
-  const { sort, filters, fields, populate } = subPopulate;
+  const { sort, filters, fields, populate, count } = subPopulate;
 
   const query = {};
 
@@ -181,6 +186,10 @@ const convertNestedPopulate = subPopulate => {
     query.populate = convertPopulateQueryParams(populate);
   }
 
+  if (count) {
+    query.count = convertCountQueryParams(count);
+  }
+
   return query;
 };
 
@@ -206,23 +215,6 @@ const convertFieldsQueryParams = (fields, depth = 0) => {
 // NOTE: We could validate the parameters are on existing / non private attributes
 const convertFiltersQueryParams = filters => filters;
 
-// TODO: migrate
-const VALID_REST_OPERATORS = [
-  'eq',
-  'ne',
-  'in',
-  'nin',
-  'contains',
-  'ncontains',
-  'containss',
-  'ncontainss',
-  'lt',
-  'lte',
-  'gt',
-  'gte',
-  'null',
-];
-
 module.exports = {
   convertSortQueryParams,
   convertStartQueryParams,
@@ -230,6 +222,5 @@ module.exports = {
   convertPopulateQueryParams,
   convertFiltersQueryParams,
   convertFieldsQueryParams,
-  VALID_REST_OPERATORS,
   QUERY_OPERATORS,
 };

package/lib/index.js

@@ -4,7 +4,7 @@
  * Export shared utilities
  */
 const { buildQuery, hasDeepFilters } = require('./build-query');
-const { VALID_REST_OPERATORS, QUERY_OPERATORS } = require('./convert-query-params');
+const { QUERY_OPERATORS } = require('./convert-query-params');
 const parseMultipartData = require('./parse-multipart');
 const sanitizeEntity = require('./sanitize-entity');
 const parseType = require('./parse-type');
@@ -31,13 +31,13 @@ const relations = require('./relations');
 const setCreatorFields = require('./set-creator-fields');
 const hooks = require('./hooks');
 const providerFactory = require('./provider-factory');
+const pagination = require('./pagination');
 
 module.exports = {
   yup,
   formatYupErrors,
   policy,
   templateConfiguration,
-  VALID_REST_OPERATORS,
   QUERY_OPERATORS,
   buildQuery,
   hasDeepFilters,
@@ -64,4 +64,5 @@ module.exports = {
   setCreatorFields,
   hooks,
   providerFactory,
+  pagination,
 };

package/lib/pagination.js

@@ -0,0 +1,87 @@
+'use strict';
+
+const { merge, pipe, omit, isNil } = require('lodash/fp');
+
+const STRAPI_DEFAULTS = {
+  offset: {
+    start: 0,
+    limit: 10,
+  },
+  page: {
+    page: 1,
+    pageSize: 10,
+  },
+};
+
+const paginationAttributes = ['start', 'limit', 'page', 'pageSize'];
+
+const withMaxLimit = (limit, maxLimit = -1) => {
+  if (maxLimit === -1 || limit < maxLimit) {
+    return limit;
+  }
+
+  return maxLimit;
+};
+
+// Ensure minimum page & pageSize values (page >= 1, pageSize >= 0, start >= 0, limit >= 0)
+const ensureMinValues = ({ start, limit }) => ({
+  start: Math.max(start, 0),
+  limit: Math.max(limit, 1),
+});
+
+const ensureMaxValues = (maxLimit = -1) => ({ start, limit }) => ({
+  start,
+  limit: withMaxLimit(limit, maxLimit),
+});
+
+const withDefaultPagination = (args, { defaults = {}, maxLimit = -1 } = {}) => {
+  const defaultValues = merge(STRAPI_DEFAULTS, defaults);
+
+  const usePagePagination = !isNil(args.page) || !isNil(args.pageSize);
+  const useOffsetPagination = !isNil(args.start) || !isNil(args.limit);
+
+  const ensureValidValues = pipe(
+    ensureMinValues,
+    ensureMaxValues(maxLimit)
+  );
+
+  // If there is no pagination attribute, don't modify the payload
+  if (!usePagePagination && !useOffsetPagination) {
+    return merge(args, ensureValidValues(defaultValues.offset));
+  }
+
+  // If there is page & offset pagination attributes, throw an error
+  if (usePagePagination && useOffsetPagination) {
+    throw new Error('Cannot use both page & offset pagination in the same query');
+  }
+
+  const pagination = {};
+
+  // Start / Limit
+  if (useOffsetPagination) {
+    const { start, limit } = merge(defaultValues.offset, args);
+
+    Object.assign(pagination, { start, limit });
+  }
+
+  // Page / PageSize
+  if (usePagePagination) {
+    const { page, pageSize } = merge(defaultValues.page, args);
+
+    Object.assign(pagination, {
+      start: (page - 1) * pageSize,
+      limit: pageSize,
+    });
+  }
+
+  const replacePaginationAttributes = pipe(
+    // Remove pagination attributes
+    omit(paginationAttributes),
+    // Merge the object with the new pagination + ensure minimum & maximum values
+    merge(ensureValidValues(pagination))
+  );
+
+  return replacePaginationAttributes(args);
+};
+
+module.exports = { withDefaultPagination };

package/lib/sanitize-entity.js

@@ -48,9 +48,9 @@ const sanitizeEntity = (dataSource, options) => {
     }
 
     // Relations
-    const isRelation = attribute && attribute.type === 'relation';
+    const isRelation = attribute && ['relation', 'component'].includes(attribute.type);
     if (isRelation) {
-      const relation = attribute && attribute.target;
+      const relation = attribute && (attribute.target || attribute.component);
 
       if (_.isNil(value)) {
         return { ...acc, [key]: value };
@@ -128,18 +128,20 @@ const getAllowedFields = ({ includeFields, model, isOutput }) => {
 
   const nonVisibleWritableAttributes = _.intersection(writableAttributes, nonVisibleAttributes);
 
-  return _.concat(
-    includeFields || [],
-    ...(isOutput
-      ? [
-          STATIC_FIELDS,
-          CREATED_AT_ATTRIBUTE,
-          UPDATED_AT_ATTRIBUTE,
-          COMPONENT_FIELDS,
-          ...nonWritableAttributes,
-          ...nonVisibleAttributes,
-        ]
-      : [STATIC_FIELDS, COMPONENT_FIELDS, ...nonVisibleWritableAttributes])
+  return _.uniq(
+    _.concat(
+      includeFields || [],
+      ...(isOutput
+        ? [
+            STATIC_FIELDS,
+            CREATED_AT_ATTRIBUTE,
+            UPDATED_AT_ATTRIBUTE,
+            COMPONENT_FIELDS,
+            ...nonWritableAttributes,
+            ...nonVisibleAttributes,
+          ]
+        : [STATIC_FIELDS, COMPONENT_FIELDS, ...nonVisibleWritableAttributes])
+    )
   );
 };
 

package/package.json

@@ -1,13 +1,11 @@
 {
   "name": "@strapi/utils",
-  "version": "4.0.0-next.13",
+  "version": "4.0.0-next.14",
   "description": "Shared utilities for the Strapi packages",
   "homepage": "https://strapi.io",
   "keywords": [
     "strapi",
-    "utilities",
-    "utils",
-    "winston"
+    "utils"
   ],
   "directories": {
     "lib": "./lib"
@@ -15,11 +13,9 @@
   "main": "./lib",
   "dependencies": {
     "@sindresorhus/slugify": "1.1.0",
-    "date-fns": "^2.19.0",
+    "date-fns": "2.24.0",
     "lodash": "4.17.21",
-    "pino": "^4.7.1",
-    "pluralize": "^8.0.0",
-    "yup": "^0.32.9"
+    "yup": "0.32.9"
   },
   "author": {
     "email": "hi@strapi.io",
@@ -45,5 +41,5 @@
     "npm": ">=6.0.0"
   },
   "license": "SEE LICENSE IN LICENSE",
-  "gitHead": "c1369c796034fb1b57471498eb1e0c75ce2d7715"
+  "gitHead": "9b2bc8ed5d39e6b7c3a1b0767b73028b5292467b"
 }