[WIP] Document the @strapi/utils package

docs/developer-docs/latest/developer-resources/utils/strapi-utils.md

@@ -0,0 +1,38 @@
+---
+title: Core Utilities - Strapi Developer Docs
+description: Various tools and utilities that are used throughout the Strapi codebase and your project.
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/strapi-utils.md
+---
+
+# Core Utilities package: @strapi/utils
+
+<!-- Should we base the functions off what is exported in https://github.com/strapi/strapi/blob/main/packages/core/utils/lib/index.js instead? -->
+
+| Utils function | Description | Is Experimental |
+| --- | --- | --- |
+| `build-query` | Convert Strapi query params to Knex query | false |
+| `code-generator` | Used to generate timestamp codes | true |
+| `config` | Used to construct config and absolute URLs (server/admin) | false |
+| `content-types` | Various tooling around content-type checking | true |
+| `convert-query-params` | Converts the standard Strapi REST query params to a more usable format for querying | false |
+| `env-helper` | Helper for parsing env vars into proper types | false |
+| `errors` | Error classes for sanely handling errors through the Strapi application | false |
+| `format-yup-error` | Addon util for the errors which converts [Yup](https://www.npmjs.com/package/yup) errors into more human readable responses | true |
+| `hooks` | Various functions used for hook management (create series, waterfall, and parallel hooks) | true |
+| `object-formatting` | Used for removing keys who's value is undefined | true |
+| `pagination` | Handles pagination management with limits and conversion | true |
+| `parse-multipart` | Used for parsing `multipart/form-data` requests and extracting files | false |
+| `parse-type` | Used for parsing various type and converting them, mainly for population | true |
+| `pipe-async` | ??? | false |
+| `policy` | Core policy management functions for resolving, creating, and passing the Koa `ctx` | true |
+| `print-value` | Copied function from the [Yup Library](https://github.com/jquense/yup/blob/2778b88bdacd5260d593c6468793da2e77daf21f/src/util/printValue.ts) | true |
+| `provider-factory` | Constructs the provider factory by registering hooks | true |
+| `relations` | Extracts relation fields from a content-type schema | true |
+| `sanitize` | ??? | false |
+| `set-creator-fields` | Sets the default created_by and updated_by attributes for the Strapi Admin | true |
+| `string-formatting` | Various functions used for handling naming conventions throughout the Strapi application | true |
+| `template-configuration` | Allow dynamic config values through the native ES6 template string function | true |
+| `traverse-entity` | Used for deeply traversing Strapi responses, commonly combined with sanitize | false |
+| `validators` | Validators and testing for schemas and key/value checking | true |
+| `webhook` | Provides a list of various webhook event types | true |

docs/developer-docs/latest/developer-resources/utils/strapi-utils/build-query.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/code-generator.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/config.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/content-types.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/convert-query-params.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/env-helper.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/errors.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/format-yup-error.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/hooks.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/object-formatting.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/pagination.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/parse-multipart.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/parse-type.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/pipe-async.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/policy.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/print-value.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/provider-factory.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/relations.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/sanitize.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/set-creator-fields.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/string-formatting.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/template-configuration.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/traverse-entity.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/validators.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+# 

docs/developer-docs/latest/developer-resources/utils/strapi-utils/webhook.md

@@ -0,0 +1,8 @@
+---
+title: Utils/ - Strapi Developer Docs
+description: 
+sidebarDepth: 3
+canonicalUrl: https://docs.strapi.io/developer-docs/latest/developer-resources/utils/
+---
+
+#