@strapi/utils 4.4.0-rc.0 → 4.5.0-alpha.0

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;
 
@@ -389,6 +401,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 +483,5 @@ module.exports = {
   convertFiltersQueryParams,
   convertFieldsQueryParams,
   convertPublicationStateParams,
+  transformParamsToQuery,
 };

package/lib/hooks.js

@@ -2,8 +2,17 @@
 
 const { eq, remove, cloneDeep } = require('lodash/fp');
 
+/**
+ * @typedef Hook
+ * @property {Array<Function>} _handlers - A registry of handler used by the hook
+ * @property {function(Function):Hook} register - Register a new handler into the hook's registry
+ * @property {function(Function):Hook} delete- Delete the given handler from the hook's registry
+ * @property {Function} call - Not implemented by default, can be replaced by any implementation.
+ */
+
 /**
  * Create a default Strapi hook
+ * @return {Hook}
  */
 const createHook = () => {
   const state = {
@@ -36,6 +45,7 @@ const createHook = () => {
 /**
  * Create an async series hook.
  * Upon execution, it will execute every handler in order with the same context
+ * @return {Hook}
  */
 const createAsyncSeriesHook = () => ({
   ...createHook(),
@@ -50,6 +60,7 @@ const createAsyncSeriesHook = () => ({
 /**
  * Create an async series waterfall hook.
  * Upon execution, it will execute every handler in order and pass the return value of the last handler to the next one
+ * @return {Hook}
  */
 const createAsyncSeriesWaterfallHook = () => ({
   ...createHook(),
@@ -68,6 +79,7 @@ const createAsyncSeriesWaterfallHook = () => ({
 /**
  * Create an async parallel hook.
  * Upon execution, it will execute every registered handler in band.
+ * @return {Hook}
  */
 const createAsyncParallelHook = () => ({
   ...createHook(),
@@ -79,24 +91,6 @@ const createAsyncParallelHook = () => ({
   },
 });
 
-/**
- * Create an async parallel hook.
- * Upon execution, it will execute every registered handler in serie and return the first result found.
- */
-const createAsyncBailHook = () => ({
-  ...createHook(),
-
-  async call(context) {
-    for (const handler of this.getHandlers()) {
-      const result = await handler(context);
-
-      if (result !== undefined) {
-        return result;
-      }
-    }
-  },
-});
-
 module.exports = {
   // Internal utils
   internals: {
@@ -106,5 +100,4 @@ module.exports = {
   createAsyncSeriesHook,
   createAsyncSeriesWaterfallHook,
   createAsyncParallelHook,
-  createAsyncBailHook,
 };

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/provider-factory.js

@@ -25,9 +25,25 @@ const createProviderHooksMap = () => ({
 });
 
 /**
- * A Provider factory
+ * A customizable item provider enhanced with register/delete hooks
+ * @typedef {Object} Provider
+ * @property hooks
+ * @property register
+ * @property delete
+ * @property get
+ * @property getWhere
+ * @property values
+ * @property keys
+ * @property has
+ * @property size
+ * @property clear
+ */
+
+/**
+ * A {@link Provider} factory
  * @param {Object} [options] - The factory options
  * @param {boolean = true} options.throwOnDuplicates - Specify the wanted behaviour when encountering a duplicate key on register
+ * @return {Provider}
  */
 const providerFactory = (options = {}) => {
   const { throwOnDuplicates = true } = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/utils",
-  "version": "4.4.0-rc.0",
+  "version": "4.5.0-alpha.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": "57635b60c9a7815830734d85fe76df3ce8ed5898"
+  "gitHead": "c9a98c4dbcf3c4f2a449f8d96e7cbe4cd9b1e0f5"
 }