@strapi/utils 4.11.3 → 4.12.0-beta.0

package/lib/errors.js

@@ -1,113 +0,0 @@
-/* eslint-disable max-classes-per-file */
-
-'use strict';
-
-const { HttpError } = require('http-errors');
-const { formatYupErrors } = require('./format-yup-error');
-
-/* ApplicationError */
-class ApplicationError extends Error {
-  constructor(message, details = {}) {
-    super();
-    this.name = 'ApplicationError';
-    this.message = message || 'An application error occured';
-    this.details = details;
-  }
-}
-
-class ValidationError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'ValidationError';
-  }
-}
-
-class YupValidationError extends ValidationError {
-  constructor(yupError, message) {
-    super();
-    const { errors, message: yupMessage } = formatYupErrors(yupError);
-    this.message = message || yupMessage;
-    this.details = { errors };
-  }
-}
-
-class PaginationError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'PaginationError';
-    this.message = message || 'Invalid pagination';
-  }
-}
-
-class NotFoundError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'NotFoundError';
-    this.message = message || 'Entity not found';
-  }
-}
-
-class ForbiddenError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'ForbiddenError';
-    this.message = message || 'Forbidden access';
-  }
-}
-
-class UnauthorizedError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'UnauthorizedError';
-    this.message = message || 'Unauthorized';
-  }
-}
-
-class RateLimitError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'RateLimitError';
-    this.message = message || 'Too many requests, please try again later.';
-    this.details = details || {};
-  }
-}
-
-class PayloadTooLargeError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'PayloadTooLargeError';
-    this.message = message || 'Entity too large';
-  }
-}
-
-class PolicyError extends ForbiddenError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'PolicyError';
-    this.message = message || 'Policy Failed';
-    this.details = details || {};
-  }
-}
-
-class NotImplementedError extends ApplicationError {
-  constructor(message, details) {
-    super(message, details);
-    this.name = 'NotImplementedError';
-    this.message = message || 'This feature is not implemented yet';
-  }
-}
-
-module.exports = {
-  HttpError,
-  ApplicationError,
-  ValidationError,
-  YupValidationError,
-  PaginationError,
-  NotFoundError,
-  ForbiddenError,
-  UnauthorizedError,
-  RateLimitError,
-  PayloadTooLargeError,
-  PolicyError,
-  NotImplementedError,
-};

package/lib/file.js

@@ -1,60 +0,0 @@
-'use strict';
-
-/**
- * Utils file containing file treatment utils
- */
-const { Writable } = require('stream');
-
-const kbytesToBytes = (kbytes) => kbytes * 1000;
-const bytesToKbytes = (bytes) => Math.round((bytes / 1000) * 100) / 100;
-const bytesToHumanReadable = (bytes) => {
-  const sizes = ['Bytes', 'KB', 'MB', 'GB', 'TB', 'PB'];
-  if (bytes === 0) return '0 Bytes';
-  const i = parseInt(Math.floor(Math.log(bytes) / Math.log(1000)), 10);
-  return `${Math.round(bytes / 1000 ** i, 2)} ${sizes[i]}`;
-};
-
-const streamToBuffer = (stream) =>
-  new Promise((resolve, reject) => {
-    const chunks = [];
-    stream.on('data', (chunk) => {
-      chunks.push(chunk);
-    });
-    stream.on('end', () => {
-      resolve(Buffer.concat(chunks));
-    });
-    stream.on('error', reject);
-  });
-
-const getStreamSize = (stream) =>
-  new Promise((resolve, reject) => {
-    let size = 0;
-    stream.on('data', (chunk) => {
-      size += Buffer.byteLength(chunk);
-    });
-    stream.on('close', () => resolve(size));
-    stream.on('error', reject);
-    stream.resume();
-  });
-
-/**
- * Create a writeable Node.js stream that discards received data.
- * Useful for testing, draining a stream of data, etc.
- */
-function writableDiscardStream(options) {
-  return new Writable({
-    ...options,
-    write(chunk, encding, callback) {
-      setImmediate(callback);
-    },
-  });
-}
-
-module.exports = {
-  streamToBuffer,
-  bytesToHumanReadable,
-  bytesToKbytes,
-  kbytesToBytes,
-  getStreamSize,
-  writableDiscardStream,
-};

package/lib/format-yup-error.js

@@ -1,20 +0,0 @@
-'use strict';
-
-const { isEmpty, toPath } = require('lodash/fp');
-
-const formatYupInnerError = (yupError) => ({
-  path: toPath(yupError.path),
-  message: yupError.message,
-  name: yupError.name,
-});
-
-const formatYupErrors = (yupError) => ({
-  errors: isEmpty(yupError.inner)
-    ? [formatYupInnerError(yupError)]
-    : yupError.inner.map(formatYupInnerError),
-  message: yupError.message,
-});
-
-module.exports = {
-  formatYupErrors,
-};

package/lib/hooks.js

@@ -1,110 +0,0 @@
-'use strict';
-
-const { eq, remove, cloneDeep } = require('lodash/fp');
-
-/**
- * Create a default Strapi hook
- */
-const createHook = () => {
-  const state = {
-    handlers: [],
-  };
-
-  return {
-    getHandlers() {
-      return state.handlers;
-    },
-
-    register(handler) {
-      state.handlers.push(handler);
-
-      return this;
-    },
-
-    delete(handler) {
-      state.handlers = remove(eq(handler), state.handlers);
-
-      return this;
-    },
-
-    call() {
-      throw new Error('Method not implemented');
-    },
-  };
-};
-
-/**
- * Create an async series hook.
- * Upon execution, it will execute every handler in order with the same context
- */
-const createAsyncSeriesHook = () => ({
-  ...createHook(),
-
-  async call(context) {
-    for (const handler of this.getHandlers()) {
-      await handler(context);
-    }
-  },
-});
-
-/**
- * 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
- */
-const createAsyncSeriesWaterfallHook = () => ({
-  ...createHook(),
-
-  async call(param) {
-    let res = param;
-
-    for (const handler of this.getHandlers()) {
-      res = await handler(res);
-    }
-
-    return res;
-  },
-});
-
-/**
- * Create an async parallel hook.
- * Upon execution, it will execute every registered handler in band.
- */
-const createAsyncParallelHook = () => ({
-  ...createHook(),
-
-  async call(context) {
-    const promises = this.getHandlers().map((handler) => handler(cloneDeep(context)));
-
-    return Promise.all(promises);
-  },
-});
-
-/**
- * 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: {
-    createHook,
-  },
-  // Hooks
-  createAsyncSeriesHook,
-  createAsyncSeriesWaterfallHook,
-  createAsyncParallelHook,
-  createAsyncBailHook,
-};

package/lib/import-default.js

@@ -1,10 +0,0 @@
-'use strict';
-
-const importDefault =
-  (this && this.importDefault) ||
-  function (modName) {
-    const mod = require(modName);
-    return mod && mod.__esModule ? mod.default : mod;
-  };
-
-module.exports = importDefault;

package/lib/index.js

@@ -1,99 +0,0 @@
-'use strict';
-
-/**
- * Export shared utilities
- */
-const { buildQuery, hasDeepFilters } = require('./build-query');
-const parseMultipartData = require('./parse-multipart');
-const parseType = require('./parse-type');
-const policy = require('./policy');
-const templateConfiguration = require('./template-configuration');
-const { yup, handleYupError, validateYupSchema, validateYupSchemaSync } = require('./validators');
-const errors = require('./errors');
-const {
-  nameToSlug,
-  nameToCollectionName,
-  getCommonBeginning,
-  escapeQuery,
-  stringIncludes,
-  stringEquals,
-  isKebabCase,
-  isCamelCase,
-  toRegressedEnumValue,
-  startsWithANumber,
-  joinBy,
-  toKebabCase,
-} = require('./string-formatting');
-const { removeUndefined, keysDeep } = require('./object-formatting');
-const { getConfigUrls, getAbsoluteAdminUrl, getAbsoluteServerUrl } = require('./config');
-const { generateTimestampCode } = require('./code-generator');
-const contentTypes = require('./content-types');
-const env = require('./env-helper');
-const webhook = require('./webhook');
-const relations = require('./relations');
-const setCreatorFields = require('./set-creator-fields');
-const hooks = require('./hooks');
-const providerFactory = require('./provider-factory');
-const pagination = require('./pagination');
-const sanitize = require('./sanitize');
-const traverseEntity = require('./traverse-entity');
-const { pipeAsync, mapAsync, reduceAsync, forEachAsync } = require('./async');
-const convertQueryParams = require('./convert-query-params');
-const importDefault = require('./import-default');
-const template = require('./template');
-const file = require('./file');
-const traverse = require('./traverse');
-const { isOperator, isOperatorOfType } = require('./operators');
-
-module.exports = {
-  yup,
-  handleYupError,
-  policy,
-  templateConfiguration,
-  buildQuery,
-  hasDeepFilters,
-  parseMultipartData,
-  sanitize,
-  traverseEntity,
-  parseType,
-  nameToSlug,
-  toRegressedEnumValue,
-  startsWithANumber,
-  joinBy,
-  nameToCollectionName,
-  getCommonBeginning,
-  getConfigUrls,
-  escapeQuery,
-  removeUndefined,
-  keysDeep,
-  getAbsoluteAdminUrl,
-  getAbsoluteServerUrl,
-  generateTimestampCode,
-  stringIncludes,
-  stringEquals,
-  template,
-  isKebabCase,
-  isCamelCase,
-  toKebabCase,
-  webhook,
-  contentTypes,
-  env,
-  relations,
-  setCreatorFields,
-  hooks,
-  providerFactory,
-  pagination,
-  pipeAsync,
-  mapAsync,
-  reduceAsync,
-  forEachAsync,
-  errors,
-  validateYupSchema,
-  validateYupSchemaSync,
-  convertQueryParams,
-  importDefault,
-  file,
-  traverse,
-  isOperator,
-  isOperatorOfType,
-};

package/lib/object-formatting.js

@@ -1,15 +0,0 @@
-'use strict';
-
-const _ = require('lodash');
-
-const removeUndefined = (obj) => _.pickBy(obj, (value) => typeof value !== 'undefined');
-
-const keysDeep = (obj, path = []) =>
-  !_.isObject(obj)
-    ? path.join('.')
-    : _.reduce(obj, (acc, next, key) => _.concat(acc, keysDeep(next, [...path, key])), []);
-
-module.exports = {
-  removeUndefined,
-  keysDeep,
-};

package/lib/operators.js

@@ -1,74 +0,0 @@
-'use strict';
-
-const GROUP_OPERATORS = ['$and', '$or'];
-
-const WHERE_OPERATORS = [
-  '$not',
-  '$in',
-  '$notIn',
-  '$eq',
-  '$eqi',
-  '$ne',
-  '$gt',
-  '$gte',
-  '$lt',
-  '$lte',
-  '$null',
-  '$notNull',
-  '$between',
-  '$startsWith',
-  '$endsWith',
-  '$startsWithi',
-  '$endsWithi',
-  '$contains',
-  '$notContains',
-  '$containsi',
-  '$notContainsi',
-];
-
-const CAST_OPERATORS = [
-  '$not',
-  '$in',
-  '$notIn',
-  '$eq',
-  '$ne',
-  '$gt',
-  '$gte',
-  '$lt',
-  '$lte',
-  '$between',
-];
-
-const ARRAY_OPERATORS = ['$in', '$notIn', '$between'];
-
-const OPERATORS = {
-  where: WHERE_OPERATORS,
-  cast: CAST_OPERATORS,
-  group: GROUP_OPERATORS,
-  array: ARRAY_OPERATORS,
-};
-
-// for performance, cache all operators in lowercase
-const OPERATORS_LOWERCASE = Object.fromEntries(
-  Object.entries(OPERATORS).map(([key, values]) => [
-    key,
-    values.map((value) => value.toLowerCase()),
-  ])
-);
-
-const isOperatorOfType = (type, key, ignoreCase = false) => {
-  if (ignoreCase) {
-    return OPERATORS_LOWERCASE[type]?.includes(key.toLowerCase()) ?? false;
-  }
-  return OPERATORS[type]?.includes(key) ?? false;
-};
-
-const isOperator = (key, ignoreCase = false) => {
-  return Object.keys(OPERATORS).some((type) => isOperatorOfType(type, key, ignoreCase));
-};
-
-module.exports = {
-  isOperator,
-  isOperatorOfType,
-  OPERATORS,
-};

package/lib/pagination.js

@@ -1,99 +0,0 @@
-'use strict';
-
-const { merge, pipe, omit, isNil } = require('lodash/fp');
-const { PaginationError } = require('./errors');
-
-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: limit === -1 ? limit : Math.max(limit, 1),
-});
-
-const ensureMaxValues =
-  (maxLimit = -1) =>
-  ({ start, limit }) => ({
-    start,
-    limit: withMaxLimit(limit, maxLimit),
-  });
-
-// Apply maxLimit as the limit when limit is -1
-const withNoLimit = (pagination, maxLimit = -1) => ({
-  ...pagination,
-  limit: pagination.limit === -1 ? maxLimit : pagination.limit,
-});
-
-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 PaginationError('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,
-      pageSize: Math.max(1, args.pageSize),
-    });
-
-    Object.assign(pagination, {
-      start: (page - 1) * pageSize,
-      limit: pageSize,
-    });
-  }
-
-  // Handle -1 limit
-  Object.assign(pagination, withNoLimit(pagination, maxLimit));
-
-  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/parse-multipart.js

@@ -1,44 +0,0 @@
-'use strict';
-
-const _ = require('lodash');
-
-module.exports = (ctx) => {
-  if (!ctx.is('multipart')) {
-    return { data: ctx.request.body, files: {} };
-  }
-
-  const { body = {}, files = {} } = ctx.request;
-
-  if (!body.data) {
-    return ctx.badRequest(
-      `When using multipart/form-data you need to provide your data in a JSON 'data' field.`
-    );
-  }
-
-  let data;
-  try {
-    data = JSON.parse(body.data);
-  } catch (error) {
-    return ctx.badRequest(`Invalid 'data' field. 'data' should be a valid JSON.`);
-  }
-
-  const filesToUpload = Object.keys(files).reduce((acc, key) => {
-    const fullPath = _.toPath(key);
-
-    if (fullPath.length <= 1 || fullPath[0] !== 'files') {
-      return ctx.badRequest(
-        `When using multipart/form-data you need to provide your files by prefixing them with the 'files'.
-For example, when a media file is named "avatar", make sure the form key name is "files.avatar"`
-      );
-    }
-
-    const path = _.tail(fullPath);
-    acc[path.join('.')] = files[key];
-    return acc;
-  }, {});
-
-  return {
-    data,
-    files: filesToUpload,
-  };
-};