@strapi/utils 4.6.1 → 4.9.0-alpha.0

package/lib/async.d.ts

@@ -1,4 +1,6 @@
-export type MapAsync<T = any, R = any> = lodash.CurriedFunction3<
+import { CurriedFunction3 } from 'lodash';
+
+export type MapAsync<T = any, R = any> = CurriedFunction3<
   T[],
   (element: T, index: number) => R | Promise<R>,
   { concurrency?: number },
@@ -10,3 +12,10 @@ export type ForEachAsync<T = any, R = any> = (
   func: (element: T, index: number) => R | Promise<R>,
   options?: { concurrency?: number }
 ) => Promise<R[]>;
+
+export type ReduceAsync<T = any, V = T, R = V> = CurriedFunction3<
+  T[],
+  (accumulator: V | R, current: Awaited<T>, index: number) => R | Promise<R>,
+  V,
+  Promise<R>
+>;

package/lib/async.js

@@ -1,7 +1,7 @@
 'use strict';
 
 const pMap = require('p-map');
-const { curry } = require('lodash/fp');
+const { curry, curryN } = require('lodash/fp');
 
 function pipeAsync(...methods) {
   return async (data) => {
@@ -20,6 +20,17 @@ function pipeAsync(...methods) {
  */
 const mapAsync = curry(pMap);
 
+/**
+ * @type { import('./async').ReduceAsync }
+ */
+const reduceAsync = curryN(2, async (mixedArray, iteratee, initialValue) => {
+  let acc = initialValue;
+  for (let i = 0; i < mixedArray.length; i += 1) {
+    acc = await iteratee(acc, await mixedArray[i], i);
+  }
+  return acc;
+});
+
 /**
  * @type { import('./async').ForEachAsync }
  */
@@ -29,6 +40,7 @@ const forEachAsync = curry(async (array, func, options) => {
 
 module.exports = {
   mapAsync,
+  reduceAsync,
   forEachAsync,
   pipeAsync,
 };

package/lib/convert-query-params.js

@@ -139,6 +139,41 @@ const convertLimitQueryParams = (limitQuery) => {
   return limitAsANumber;
 };
 
+const convertPageQueryParams = (page) => {
+  const pageVal = toNumber(page);
+
+  if (!isInteger(pageVal) || pageVal <= 0) {
+    throw new PaginationError(
+      `Invalid 'page' parameter. Expected an integer > 0, received: ${page}`
+    );
+  }
+
+  return pageVal;
+};
+
+const convertPageSizeQueryParams = (pageSize, page) => {
+  const pageSizeVal = toNumber(pageSize);
+
+  if (!isInteger(pageSizeVal) || pageSizeVal <= 0) {
+    throw new PaginationError(
+      `Invalid 'pageSize' parameter. Expected an integer > 0, received: ${page}`
+    );
+  }
+
+  return pageSizeVal;
+};
+
+const validatePaginationParams = (page, pageSize, start, limit) => {
+  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'
+    );
+  }
+};
+
 class InvalidPopulateError extends Error {
   constructor() {
     super();
@@ -280,8 +315,8 @@ const convertNestedPopulate = (subPopulate, schema) => {
     throw new Error(`Invalid nested populate. Expected '*' or an object`);
   }
 
-  // TODO: We will need to consider a way to add limitation / pagination
-  const { sort, filters, fields, populate, count, ordering } = subPopulate;
+  const { sort, filters, fields, populate, count, ordering, page, pageSize, start, limit } =
+    subPopulate;
 
   const query = {};
 
@@ -309,6 +344,26 @@ const convertNestedPopulate = (subPopulate, schema) => {
     query.ordering = convertOrderingQueryParams(ordering);
   }
 
+  validatePaginationParams(page, pageSize, start, limit);
+
+  if (!isNil(page)) {
+    query.page = convertPageQueryParams(page);
+  }
+
+  if (!isNil(pageSize)) {
+    query.pageSize = convertPageSizeQueryParams(pageSize, page);
+  }
+
+  if (!isNil(start)) {
+    query.offset = convertStartQueryParams(start);
+  }
+
+  if (!isNil(limit)) {
+    query.limit = convertLimitQueryParams(limit);
+  }
+
+  convertPublicationStateParams(schema, subPopulate, query);
+
   return query;
 };
 
@@ -466,37 +521,14 @@ const transformParamsToQuery = (uid, params) => {
     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'
-    );
-  }
+  validatePaginationParams(page, pageSize, start, limit);
 
   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;
+    query.page = convertPageQueryParams(page);
   }
 
   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;
+    query.pageSize = convertPageSizeQueryParams(pageSize, page);
   }
 
   if (!isNil(start)) {

package/lib/index.js

@@ -37,7 +37,7 @@ const providerFactory = require('./provider-factory');
 const pagination = require('./pagination');
 const sanitize = require('./sanitize');
 const traverseEntity = require('./traverse-entity');
-const { pipeAsync, mapAsync, forEachAsync } = require('./async');
+const { pipeAsync, mapAsync, reduceAsync, forEachAsync } = require('./async');
 const convertQueryParams = require('./convert-query-params');
 const importDefault = require('./import-default');
 const template = require('./template');
@@ -83,6 +83,7 @@ module.exports = {
   pagination,
   pipeAsync,
   mapAsync,
+  reduceAsync,
   forEachAsync,
   errors,
   validateYupSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/utils",
-  "version": "4.6.1",
+  "version": "4.9.0-alpha.0",
   "description": "Shared utilities for the Strapi packages",
   "keywords": [
     "strapi",
@@ -46,5 +46,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "17a7845e3d453ea2e7911bda6ec25ed196dd5f16"
+  "gitHead": "35f783d0dc07db101e7e62cb4d682f751551f452"
 }