@strapi/utils 4.0.0-next.8 → 4.0.2

package/lib/validators.js

@@ -2,7 +2,10 @@
 
 const yup = require('yup');
 const _ = require('lodash');
+const { defaults } = require('lodash/fp');
 const utils = require('./string-formatting');
+const { YupValidationError } = require('./errors');
+const printValue = require('./print-value');
 
 const MixedSchemaType = yup.mixed;
 
@@ -56,27 +59,53 @@ class StrapiIDSchema extends MixedSchemaType {
 
 yup.strapiID = () => new StrapiIDSchema();
 
-/**
- * Returns a formatted error for http responses
- * @param {Object} validationError - a Yup ValidationError
- */
-const formatYupErrors = validationError => {
-  if (!validationError.inner) {
-    throw new Error('invalid.input');
-  }
+const handleYupError = (error, errorMessage) => {
+  throw new YupValidationError(error, errorMessage);
+};
+
+const defaultValidationParam = { strict: true, abortEarly: false };
 
-  if (validationError.inner.length === 0) {
-    if (validationError.path === undefined) return validationError.errors;
-    return { [validationError.path]: validationError.errors };
+const validateYupSchema = (schema, options = {}) => async (body, errorMessage) => {
+  try {
+    const optionsWithDefaults = defaults(defaultValidationParam, options);
+    return await schema.validate(body, optionsWithDefaults);
+  } catch (e) {
+    handleYupError(e, errorMessage);
   }
+};
 
-  return validationError.inner.reduce((acc, err) => {
-    acc[err.path] = err.errors;
-    return acc;
-  }, {});
+const validateYupSchemaSync = (schema, options = {}) => (body, errorMessage) => {
+  try {
+    const optionsWithDefaults = defaults(defaultValidationParam, options);
+    return schema.validateSync(body, optionsWithDefaults);
+  } catch (e) {
+    handleYupError(e, errorMessage);
+  }
 };
 
+// Temporary fix of this issue : https://github.com/jquense/yup/issues/616
+yup.setLocale({
+  mixed: {
+    notType({ path, type, value, originalValue }) {
+      let isCast = originalValue != null && originalValue !== value;
+      let msg =
+        `${path} must be a \`${type}\` type, ` +
+        `but the final value was: \`${printValue(value, true)}\`` +
+        (isCast ? ` (cast from the value \`${printValue(originalValue, true)}\`).` : '.');
+
+      /* Remove comment that is not supposed to be seen by the enduser
+      if (value === null) {
+        msg += `\n If "null" is intended as an empty value be sure to mark the schema as \`.nullable()\``;
+      }
+      */
+      return msg;
+    },
+  },
+});
+
 module.exports = {
   yup,
-  formatYupErrors,
+  handleYupError,
+  validateYupSchema,
+  validateYupSchemaSync,
 };

package/package.json

@@ -1,49 +1,49 @@
 {
   "name": "@strapi/utils",
-  "version": "4.0.0-next.8",
+  "version": "4.0.2",
   "description": "Shared utilities for the Strapi packages",
-  "homepage": "https://strapi.io",
   "keywords": [
     "strapi",
-    "utilities",
-    "utils",
-    "winston"
+    "utils"
   ],
-  "directories": {
-    "lib": "./lib"
+  "homepage": "https://strapi.io",
+  "bugs": {
+    "url": "https://github.com/strapi/strapi/issues"
   },
-  "main": "./lib",
-  "dependencies": {
-    "@sindresorhus/slugify": "1.1.0",
-    "date-fns": "^2.19.0",
-    "lodash": "4.17.21",
-    "pino": "^4.7.1",
-    "pluralize": "^8.0.0",
-    "yup": "^0.32.9"
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/strapi/strapi.git"
   },
+  "license": "SEE LICENSE IN LICENSE",
   "author": {
+    "name": "Strapi Solutions SAS",
     "email": "hi@strapi.io",
-    "name": "Strapi team",
     "url": "https://strapi.io"
   },
   "maintainers": [
     {
-      "name": "Strapi team",
+      "name": "Strapi Solutions SAS",
       "email": "hi@strapi.io",
       "url": "https://strapi.io"
     }
   ],
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/strapi/strapi.git"
+  "main": "./lib",
+  "directories": {
+    "lib": "./lib"
   },
-  "bugs": {
-    "url": "https://github.com/strapi/strapi/issues"
+  "scripts": {
+    "test:unit": "jest --verbose"
+  },
+  "dependencies": {
+    "@sindresorhus/slugify": "1.1.0",
+    "date-fns": "2.24.0",
+    "http-errors": "1.8.0",
+    "lodash": "4.17.21",
+    "yup": "0.32.9"
   },
   "engines": {
     "node": ">=12.x.x <=16.x.x",
     "npm": ">=6.0.0"
   },
-  "license": "SEE LICENSE IN LICENSE",
-  "gitHead": "e3452f6662a45a4ba96e96861e076e313b297666"
+  "gitHead": "fd656a47698e0a33aae42abd4330410c8cba1d08"
 }

package/lib/convert-rest-query-params.js

@@ -1,245 +0,0 @@
-'use strict';
-
-/**
- * Converts the standard Strapi REST query params to a moe usable format for querying
- * You can read more here: https://strapi.io/documentation/developer-docs/latest/developer-resources/content-api/content-api.html#filters
- */
-
-const _ = require('lodash');
-const {
-  constants: { DP_PUB_STATES },
-} = require('./content-types');
-
-const BOOLEAN_OPERATORS = ['or', 'and'];
-const QUERY_OPERATORS = ['_where', '_or', '_and'];
-
-/**
- * Global converter
- * @param {Object} params
- * @param defaults
- */
-const convertRestQueryParams = (params = {}, defaults = {}) => {
-  if (typeof params !== 'object' || params === null) {
-    throw new Error(
-      `convertRestQueryParams expected an object got ${params === null ? 'null' : typeof params}`
-    );
-  }
-
-  let finalParams = Object.assign({ start: 0, limit: 100 }, defaults);
-
-  if (Object.keys(params).length === 0) {
-    return finalParams;
-  }
-
-  if (_.has(params, 'sort')) {
-    finalParams.sort = convertSortQueryParams(params.sort);
-  }
-
-  if (_.has(params, '_start')) {
-    finalParams.start = convertStartQueryParams(params._start);
-  }
-
-  if (_.has(params, '_limit')) {
-    finalParams.limit = convertLimitQueryParams(params._limit);
-  }
-
-  if (_.has(params, '_publicationState')) {
-    Object.assign(finalParams, convertPublicationStateParams(params._publicationState));
-  }
-
-  const whereParams = convertExtraRootParams(
-    _.omit(params, ['sort', '_start', '_limit', '_where', '_publicationState'])
-  );
-
-  const whereClauses = [];
-
-  if (_.keys(whereParams).length > 0) {
-    whereClauses.push(...convertWhereParams(whereParams));
-  }
-
-  if (_.has(params, '_where')) {
-    whereClauses.push(...convertWhereParams(params._where));
-  }
-
-  Object.assign(finalParams, { where: whereClauses });
-
-  return finalParams;
-};
-
-/**
- * Convert params prefixed with _ by removing the prefix after we have handle the internal params
- * NOTE: This is only a temporary patch for v3 to handle extra params coming from plugins
- * @param {object} params
- * @returns {object}
- */
-const convertExtraRootParams = params => {
-  return Object.entries(params).reduce((acc, [key, value]) => {
-    if (_.startsWith(key, '_') && !QUERY_OPERATORS.includes(key)) {
-      acc[key.slice(1)] = value;
-    } else {
-      acc[key] = value;
-    }
-
-    return acc;
-  }, {});
-};
-
-/**
- * Sort query parser
- * @param {string} sortQuery - ex: id:asc,price:desc
- */
-const convertSortQueryParams = sortQuery => {
-  if (Array.isArray(sortQuery)) {
-    return sortQuery.flatMap(sortValue => convertSortQueryParams(sortValue));
-  }
-
-  if (typeof sortQuery !== 'string') {
-    throw new Error(`convertSortQueryParams expected a string, got ${typeof sortQuery}`);
-  }
-
-  const sortKeys = [];
-
-  sortQuery.split(',').forEach(part => {
-    // split field and order param with default order to ascending
-    const [field, order = 'asc'] = part.split(':');
-
-    if (field.length === 0) {
-      throw new Error('Field cannot be empty');
-    }
-
-    if (!['asc', 'desc'].includes(order.toLocaleLowerCase())) {
-      throw new Error('order can only be one of asc|desc|ASC|DESC');
-    }
-
-    sortKeys.push(_.set({}, field, order.toLowerCase()));
-  });
-
-  return sortKeys;
-};
-
-/**
- * Start query parser
- * @param {string} startQuery - ex: id:asc,price:desc
- */
-const convertStartQueryParams = startQuery => {
-  const startAsANumber = _.toNumber(startQuery);
-
-  if (!_.isInteger(startAsANumber) || startAsANumber < 0) {
-    throw new Error(`convertStartQueryParams expected a positive integer got ${startAsANumber}`);
-  }
-
-  return startAsANumber;
-};
-
-/**
- * Limit query parser
- * @param {string} limitQuery - ex: id:asc,price:desc
- */
-const convertLimitQueryParams = limitQuery => {
-  const limitAsANumber = _.toNumber(limitQuery);
-
-  if (!_.isInteger(limitAsANumber) || (limitAsANumber !== -1 && limitAsANumber < 0)) {
-    throw new Error(`convertLimitQueryParams expected a positive integer got ${limitAsANumber}`);
-  }
-
-  return limitAsANumber;
-};
-
-/**
- * publicationState query parser
- * @param {string} publicationState - eg: 'live', 'preview'
- */
-const convertPublicationStateParams = publicationState => {
-  if (!DP_PUB_STATES.includes(publicationState)) {
-    throw new Error(
-      `convertPublicationStateParams expected a value from: ${DP_PUB_STATES.join(
-        ', '
-      )}. Got ${publicationState} instead`
-    );
-  }
-
-  return { publicationState };
-};
-
-// List of all the possible filters
-const VALID_REST_OPERATORS = [
-  'eq',
-  'ne',
-  'in',
-  'nin',
-  'contains',
-  'ncontains',
-  'containss',
-  'ncontainss',
-  'lt',
-  'lte',
-  'gt',
-  'gte',
-  'null',
-];
-
-/**
- * Parse where params
- */
-const convertWhereParams = whereParams => {
-  let finalWhere = [];
-
-  if (Array.isArray(whereParams)) {
-    return whereParams.reduce((acc, whereParam) => {
-      return acc.concat(convertWhereParams(whereParam));
-    }, []);
-  }
-
-  Object.keys(whereParams).forEach(whereClause => {
-    const { field, operator = 'eq', value } = convertWhereClause(
-      whereClause,
-      whereParams[whereClause]
-    );
-
-    finalWhere.push({
-      field,
-      operator,
-      value,
-    });
-  });
-
-  return finalWhere;
-};
-
-/**
- * Parse single where param
- * @param {string} whereClause - Any possible where clause e.g: id_ne text_ncontains
- * @param {string} value - the value of the where clause e.g id_ne=value
- */
-const convertWhereClause = (whereClause, value) => {
-  const separatorIndex = whereClause.lastIndexOf('_');
-
-  // eq operator
-  if (separatorIndex === -1) {
-    return { field: whereClause, value };
-  }
-
-  // split field and operator
-  const field = whereClause.substring(0, separatorIndex);
-  const operator = whereClause.slice(separatorIndex + 1);
-
-  if (BOOLEAN_OPERATORS.includes(operator) && field === '') {
-    return { field: null, operator, value: [].concat(value).map(convertWhereParams) };
-  }
-
-  // the field as underscores
-  if (!VALID_REST_OPERATORS.includes(operator)) {
-    return { field: whereClause, value };
-  }
-
-  return { field, operator, value };
-};
-
-module.exports = {
-  convertRestQueryParams,
-  convertSortQueryParams,
-  convertStartQueryParams,
-  convertLimitQueryParams,
-  VALID_REST_OPERATORS,
-  QUERY_OPERATORS,
-};

package/lib/finder.js

@@ -1,29 +0,0 @@
-'use strict';
-
-/**
- * Module dependencies
- */
-
-const _ = require('lodash');
-
-/**
- * Find controller's location
- */
-
-module.exports = (api, controller) => {
-  if (!_.isObject(api)) {
-    throw new Error('Should be an object');
-  }
-  if (_.isString(controller)) {
-    controller = controller.toLowerCase();
-  } else {
-    throw new Error('Should be an object or a string');
-  }
-
-  const where = _.findKey(api, o => {
-    return _.get(o, `controllers.${controller}`);
-  });
-
-  // Return the API's name where the controller is located
-  return where;
-};

package/lib/sanitize-entity.js

@@ -1,172 +0,0 @@
-'use strict';
-
-const _ = require('lodash');
-const {
-  constants,
-  isPrivateAttribute,
-  getNonWritableAttributes,
-  getNonVisibleAttributes,
-  getWritableAttributes,
-} = require('./content-types');
-
-const { ID_ATTRIBUTE, CREATED_AT_ATTRIBUTE, UPDATED_AT_ATTRIBUTE } = constants;
-
-const sanitizeEntity = (dataSource, options) => {
-  const { model, withPrivate = false, isOutput = true, includeFields = null } = options;
-
-  if (typeof dataSource !== 'object' || _.isNil(dataSource)) {
-    return dataSource;
-  }
-
-  const data = parseOriginalData(dataSource);
-
-  if (typeof data !== 'object' || _.isNil(data)) {
-    return data;
-  }
-
-  if (_.isArray(data)) {
-    return data.map(entity => sanitizeEntity(entity, options));
-  }
-
-  if (_.isNil(model)) {
-    if (isOutput) {
-      return null;
-    } else {
-      return data;
-    }
-  }
-
-  const { attributes } = model;
-  const allowedFields = getAllowedFields({ includeFields, model, isOutput });
-
-  const reducerFn = (acc, value, key) => {
-    const attribute = attributes[key];
-    const allowedFieldsHasKey = allowedFields.includes(key);
-
-    if (shouldRemoveAttribute(model, key, attribute, { withPrivate, isOutput })) {
-      return acc;
-    }
-
-    // Relations
-    const relation = attribute && (attribute.model || attribute.collection || attribute.component);
-    if (relation) {
-      if (_.isNil(value)) {
-        return { ...acc, [key]: value };
-      }
-
-      const [nextFields, isAllowed] = includeFields
-        ? getNextFields(allowedFields, key, { allowedFieldsHasKey })
-        : [null, true];
-
-      if (!isAllowed) {
-        return acc;
-      }
-
-      const baseOptions = {
-        withPrivate,
-        isOutput,
-        includeFields: nextFields,
-      };
-
-      let sanitizeFn;
-      if (relation === '*') {
-        sanitizeFn = entity => {
-          if (_.isNil(entity) || !_.has(entity, '__contentType')) {
-            return entity;
-          }
-
-          return sanitizeEntity(entity, {
-            model: strapi.getModel(entity.__contentType),
-            ...baseOptions,
-          });
-        };
-      } else {
-        sanitizeFn = entity =>
-          sanitizeEntity(entity, {
-            model: strapi.getModel(relation, attribute.plugin),
-            ...baseOptions,
-          });
-      }
-
-      const nextVal = Array.isArray(value) ? value.map(sanitizeFn) : sanitizeFn(value);
-
-      return { ...acc, [key]: nextVal };
-    }
-
-    const isAllowedField = !includeFields || allowedFieldsHasKey;
-
-    // Dynamic zones
-    if (attribute && attribute.type === 'dynamiczone' && value !== null && isAllowedField) {
-      const nextVal = value.map(elem =>
-        sanitizeEntity(elem, {
-          model: strapi.getModel(elem.__component),
-          withPrivate,
-          isOutput,
-        })
-      );
-      return { ...acc, [key]: nextVal };
-    }
-
-    // Other fields
-    if (isAllowedField) {
-      return { ...acc, [key]: value };
-    }
-
-    return acc;
-  };
-
-  return _.reduce(data, reducerFn, {});
-};
-
-const parseOriginalData = data => (_.isFunction(data.toJSON) ? data.toJSON() : data);
-
-const COMPONENT_FIELDS = ['__component'];
-const STATIC_FIELDS = [ID_ATTRIBUTE];
-
-const getAllowedFields = ({ includeFields, model, isOutput }) => {
-  const nonWritableAttributes = getNonWritableAttributes(model);
-  const nonVisibleAttributes = getNonVisibleAttributes(model);
-
-  const writableAttributes = getWritableAttributes(model);
-
-  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])
-  );
-};
-
-const getNextFields = (fields, key, { allowedFieldsHasKey }) => {
-  const searchStr = `${key}.`;
-
-  const transformedFields = (fields || [])
-    .filter(field => field.startsWith(searchStr))
-    .map(field => field.replace(searchStr, ''));
-
-  const isAllowed = allowedFieldsHasKey || transformedFields.length > 0;
-  const nextFields = allowedFieldsHasKey ? null : transformedFields;
-
-  return [nextFields, isAllowed];
-};
-
-const shouldRemoveAttribute = (model, key, attribute = {}, { withPrivate, isOutput }) => {
-  const isPassword = attribute.type === 'password';
-  const isPrivate = isPrivateAttribute(model, key);
-
-  const shouldRemovePassword = isOutput;
-  const shouldRemovePrivate = !withPrivate && isOutput;
-
-  return !!((isPassword && shouldRemovePassword) || (isPrivate && shouldRemovePrivate));
-};
-
-module.exports = sanitizeEntity;