@strapi/utils 4.4.3 → 4.5.0-beta.0

package/lib/content-types.js

@@ -106,9 +106,10 @@ const isPrivateAttribute = (model = {}, attributeName) => {
 const isScalarAttribute = (attribute) => {
   return !['media', 'component', 'relation', 'dynamiczone'].includes(attribute.type);
 };
-const isMediaAttribute = (attribute) => attribute.type === 'media';
-const isRelationalAttribute = (attribute) => attribute.type === 'relation';
-const isComponentAttribute = (attribute) => ['component', 'dynamiczone'].includes(attribute.type);
+const isMediaAttribute = (attribute) => attribute && attribute.type === 'media';
+const isRelationalAttribute = (attribute) => attribute && attribute.type === 'relation';
+const isComponentAttribute = (attribute) =>
+  attribute && ['component', 'dynamiczone'].includes(attribute.type);
 
 const getComponentAttributes = (schema) => {
   return _.reduce(

package/lib/convert-query-params.js

@@ -6,10 +6,22 @@
  * Converts the standard Strapi REST query params to a more usable format for querying
  * You can read more here: https://docs.strapi.io/developer-docs/latest/developer-resources/database-apis-reference/rest-api.html#filters
  */
-const { has, isEmpty, isObject, isPlainObject, cloneDeep, get, mergeAll } = require('lodash/fp');
+const {
+  has,
+  isEmpty,
+  isObject,
+  isPlainObject,
+  cloneDeep,
+  get,
+  mergeAll,
+  isNil,
+  toNumber,
+  isInteger,
+} = require('lodash/fp');
 const _ = require('lodash');
 const parseType = require('./parse-type');
 const contentTypesUtils = require('./content-types');
+const { PaginationError } = require('./errors');
 
 const { PUBLISHED_AT_ATTRIBUTE } = contentTypesUtils.constants;
 
@@ -37,6 +49,10 @@ const convertCountQueryParams = (countQuery) => {
   return parseType({ type: 'boolean', value: countQuery });
 };
 
+const convertOrderingQueryParams = (ordering) => {
+  return ordering;
+};
+
 /**
  * Sort query parser
  * @param {string} sortQuery - ex: id:asc,price:desc
@@ -236,7 +252,7 @@ const convertNestedPopulate = (subPopulate, schema) => {
   }
 
   // TODO: We will need to consider a way to add limitation / pagination
-  const { sort, filters, fields, populate, count } = subPopulate;
+  const { sort, filters, fields, populate, count, ordering } = subPopulate;
 
   const query = {};
 
@@ -260,6 +276,10 @@ const convertNestedPopulate = (subPopulate, schema) => {
     query.count = convertCountQueryParams(count);
   }
 
+  if (ordering) {
+    query.ordering = convertOrderingQueryParams(ordering);
+  }
+
   return query;
 };
 
@@ -389,6 +409,80 @@ const convertPublicationStateParams = (type, params = {}, query = {}) => {
   }
 };
 
+const transformParamsToQuery = (uid, params) => {
+  // NOTE: can be a CT, a Compo or nothing in the case of polymorphism (DZ & morph relations)
+  const schema = strapi.getModel(uid);
+
+  const query = {};
+
+  const { _q, sort, filters, fields, populate, page, pageSize, start, limit } = params;
+
+  if (!isNil(_q)) {
+    query._q = _q;
+  }
+
+  if (!isNil(sort)) {
+    query.orderBy = convertSortQueryParams(sort);
+  }
+
+  if (!isNil(filters)) {
+    query.where = convertFiltersQueryParams(filters, schema);
+  }
+
+  if (!isNil(fields)) {
+    query.select = convertFieldsQueryParams(fields);
+  }
+
+  if (!isNil(populate)) {
+    query.populate = convertPopulateQueryParams(populate, schema);
+  }
+
+  const isPagePagination = !isNil(page) || !isNil(pageSize);
+  const isOffsetPagination = !isNil(start) || !isNil(limit);
+
+  if (isPagePagination && isOffsetPagination) {
+    throw new PaginationError(
+      'Invalid pagination attributes. You cannot use page and offset pagination in the same query'
+    );
+  }
+
+  if (!isNil(page)) {
+    const pageVal = toNumber(page);
+
+    if (!isInteger(pageVal) || pageVal <= 0) {
+      throw new PaginationError(
+        `Invalid 'page' parameter. Expected an integer > 0, received: ${page}`
+      );
+    }
+
+    query.page = pageVal;
+  }
+
+  if (!isNil(pageSize)) {
+    const pageSizeVal = toNumber(pageSize);
+
+    if (!isInteger(pageSizeVal) || pageSizeVal <= 0) {
+      throw new PaginationError(
+        `Invalid 'pageSize' parameter. Expected an integer > 0, received: ${page}`
+      );
+    }
+
+    query.pageSize = pageSizeVal;
+  }
+
+  if (!isNil(start)) {
+    query.offset = convertStartQueryParams(start);
+  }
+
+  if (!isNil(limit)) {
+    query.limit = convertLimitQueryParams(limit);
+  }
+
+  convertPublicationStateParams(schema, params, query);
+
+  return query;
+};
+
 module.exports = {
   convertSortQueryParams,
   convertStartQueryParams,
@@ -397,4 +491,5 @@ module.exports = {
   convertFiltersQueryParams,
   convertFieldsQueryParams,
   convertPublicationStateParams,
+  transformParamsToQuery,
 };

package/lib/index.js

@@ -38,6 +38,7 @@ const pagination = require('./pagination');
 const sanitize = require('./sanitize');
 const traverseEntity = require('./traverse-entity');
 const pipeAsync = require('./pipe-async');
+const convertQueryParams = require('./convert-query-params');
 
 module.exports = {
   yup,
@@ -79,4 +80,5 @@ module.exports = {
   errors,
   validateYupSchema,
   validateYupSchemaSync,
+  convertQueryParams,
 };

package/lib/relations.js

@@ -1,5 +1,7 @@
 'use strict';
 
+const { isRelationalAttribute } = require('./content-types');
+
 const MANY_RELATIONS = ['oneToMany', 'manyToMany'];
 
 const getRelationalFields = (contentType) => {
@@ -8,8 +10,21 @@ const getRelationalFields = (contentType) => {
   });
 };
 
+const isOneToAny = (attribute) =>
+  isRelationalAttribute(attribute) && ['oneToOne', 'oneToMany'].includes(attribute.relation);
+const isManyToAny = (attribute) =>
+  isRelationalAttribute(attribute) && ['manyToMany', 'manyToOne'].includes(attribute.relation);
+const isAnyToOne = (attribute) =>
+  isRelationalAttribute(attribute) && ['oneToOne', 'manyToOne'].includes(attribute.relation);
+const isAnyToMany = (attribute) =>
+  isRelationalAttribute(attribute) && ['oneToMany', 'manyToMany'].includes(attribute.relation);
+
 module.exports = {
   getRelationalFields,
+  isOneToAny,
+  isManyToAny,
+  isAnyToOne,
+  isAnyToMany,
   constants: {
     MANY_RELATIONS,
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/utils",
-  "version": "4.4.3",
+  "version": "4.5.0-beta.0",
   "description": "Shared utilities for the Strapi packages",
   "keywords": [
     "strapi",
@@ -45,5 +45,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "f99314ead7f0fdf82b921b9d8f0282a91e952ca8"
+  "gitHead": "ee98b9a9cbb6e0e07e781ff9e87eb170c72e50df"
 }