@strapi/utils 4.4.0-beta.1 → 4.4.0-beta.2

package/lib/hooks.js

@@ -2,8 +2,17 @@
 
 const { eq, remove, cloneDeep } = require('lodash/fp');
 
+/**
+ * @typedef Hook
+ * @property {Array<Function>} _handlers - A registry of handler used by the hook
+ * @property {function(Function):Hook} register - Register a new handler into the hook's registry
+ * @property {function(Function):Hook} delete- Delete the given handler from the hook's registry
+ * @property {Function} call - Not implemented by default, can be replaced by any implementation.
+ */
+
 /**
  * Create a default Strapi hook
+ * @return {Hook}
  */
 const createHook = () => {
   const state = {
@@ -36,6 +45,7 @@ const createHook = () => {
 /**
  * Create an async series hook.
  * Upon execution, it will execute every handler in order with the same context
+ * @return {Hook}
  */
 const createAsyncSeriesHook = () => ({
   ...createHook(),
@@ -50,6 +60,7 @@ const createAsyncSeriesHook = () => ({
 /**
  * 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
+ * @return {Hook}
  */
 const createAsyncSeriesWaterfallHook = () => ({
   ...createHook(),
@@ -68,6 +79,7 @@ const createAsyncSeriesWaterfallHook = () => ({
 /**
  * Create an async parallel hook.
  * Upon execution, it will execute every registered handler in band.
+ * @return {Hook}
  */
 const createAsyncParallelHook = () => ({
   ...createHook(),
@@ -79,24 +91,6 @@ const createAsyncParallelHook = () => ({
   },
 });
 
-/**
- * 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: {
@@ -106,5 +100,4 @@ module.exports = {
   createAsyncSeriesHook,
   createAsyncSeriesWaterfallHook,
   createAsyncParallelHook,
-  createAsyncBailHook,
 };

package/lib/provider-factory.js

@@ -25,9 +25,25 @@ const createProviderHooksMap = () => ({
 });
 
 /**
- * A Provider factory
+ * A customizable item provider enhanced with register/delete hooks
+ * @typedef {Object} Provider
+ * @property hooks
+ * @property register
+ * @property delete
+ * @property get
+ * @property getWhere
+ * @property values
+ * @property keys
+ * @property has
+ * @property size
+ * @property clear
+ */
+
+/**
+ * A {@link Provider} factory
  * @param {Object} [options] - The factory options
  * @param {boolean = true} options.throwOnDuplicates - Specify the wanted behaviour when encountering a duplicate key on register
+ * @return {Provider}
  */
 const providerFactory = (options = {}) => {
   const { throwOnDuplicates = true } = options;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@strapi/utils",
-  "version": "4.4.0-beta.1",
+  "version": "4.4.0-beta.2",
   "description": "Shared utilities for the Strapi packages",
   "keywords": [
     "strapi",
@@ -45,5 +45,5 @@
     "node": ">=14.19.1 <=18.x.x",
     "npm": ">=6.0.0"
   },
-  "gitHead": "cae16f7f259fa4473a55e8fea57839cda98f34ae"
+  "gitHead": "baad89e67844d972ef53a6f1b0839a361bf968c0"
 }