import Intro from '/docs/snippets/breaking-change-page-intro.md'
import MigrationIntro from '/docs/snippets/breaking-change-page-migration-intro.md'

strapi-utils refactored#

In Strapi 5, the strapi-utils package is refactored with utilities reorganized into arrays, dates, strings, objects, and async namespaces, and some utilities moved, replaced with service methods, or removed.

In Strapi 5, the strapi-utils core package has been refactored. This page lists the additions, removals, and other updates.

List of changes#

Additional Notes#

• templateConfiguration: This was used when loading the old v3 configuration files in JSON to allow for templates. Plugin developers still using the function should replace its usage by a real template library if they really need to.

• arrays utils: To use these new utils:

  1. Import them in your code with import { arrays, dates, strings, objects } from '@strapi/utils';.
  2. Use them, for instance as arrays.includesString or strings.isEqual.

• convertQueryParams is replaced:

  ⧉

  // Strapi v4
  import { convertQueryParams } from '@strapi/utils';
  
  convertQueryParams.convertSortQueryParams(...); // now private function to simplify the api
  convertQueryParams.convertStartQueryParams(...); // now private function to simplify the api
  convertQueryParams.convertLimitQueryParams(...); // now private function to simplify the api
  convertQueryParams.convertPopulateQueryParams(...); // now private function to simplify the api
  convertQueryParams.convertFiltersQueryParams(...); // now private function to simplify the api
  convertQueryParams.convertFieldsQueryParams(...); // now private function to simplify the api
  convertQueryParams.convertPublicationStateParams(...); // now private function to simplify the api
  
  convertQueryParams.transformParamsToQuery(...); // becomes the example below
  
  // Strapi 5 
  // Those utils required the strapi app context, so we decided to expose a strapi service for it
  strapi.get('query-params').transform();
  

• validate and sanitize are now part of the strapi.contentAPI functions:

  ⧉

  // Strapi v4
  import { validate, sanitize } from '@strapi/utils';
  
  validate.contentAPI.xxx();
  sanitize.contentAPI.xxx();
  
  // Strapi 5
  // Those methods require the strapi app context
  strapi.contentAPI.sanitize.xxx();
  strapi.contentAPI.validate.xxx();
  

For the complete reference of all available utilities, see the strapi-utils documentation.