v1.12.7.0: Enforce options.chain==true for type!=OVERRIDE

CHANGELOG.md

@@ -1,3 +1,7 @@
+# 1.12.7.0 (2022-06-21)
+
+- Enforce `options.chain == true` when registering non-OVERRIDE wrappers.
+
 # 1.12.6.0 (2022-06-15)
 
 - Add support for reading core compatibility versions for packages using the new Foundry VTT v10 manifest format.

README.md

@@ -351,6 +351,7 @@ To register a wrapper function, you should call the method `libWrapper.register(
  * @param {Object} options [Optional] Additional options to libWrapper.
  *
  * @param {boolean} options.chain [Optional] If 'true', the first parameter to 'fn' will be a function object that can be called to continue the chain.
+ *   This parameter must be 'true' when registering non-OVERRIDE wrappers.
  *   Default is 'false' if type=='OVERRIDE', otherwise 'true'.
  *   First introduced in v1.3.6.0.
  *

module.json

@@ -2,7 +2,7 @@
 	"name": "lib-wrapper",
 	"title": "libWrapper",
 	"description": "Library for wrapping core Foundry VTT methods, meant to improve compatibility between packages that wrap the same methods.",
-	"version": "1.12.6.0",
+	"version": "1.12.7.0",
 	"author": "Rui Pinheiro",
 	"esmodules": ["src/index.js"],
 	"styles": ["dist/lib-wrapper.css"],

src/lib/api.js

@@ -426,6 +426,7 @@ export class libWrapper {
 	 * @param {Object} options [Optional] Additional options to libWrapper.
 	 *
 	 * @param {boolean} options.chain [Optional] If 'true', the first parameter to 'fn' will be a function object that can be called to continue the chain.
+	 *   This parameter must be 'true' when registering non-OVERRIDE wrappers.
 	 *   Default is 'false' if type=='OVERRIDE', otherwise 'true'.
 	 *   First introduced in v1.3.6.0.
 	 *
@@ -487,6 +488,8 @@ export class libWrapper {
 		const chain = options?.chain ?? (type.value < WRAPPER_TYPES.OVERRIDE.value);
 		if(typeof chain !== 'boolean')
 			throw new ERRORS.package(`Parameter 'options.chain' must be a boolean.`, package_info);
+		if(!chain && type.value < WRAPPER_TYPES.OVERRIDE.value)
+			throw new ERRORS.package(`Parameter 'options.chain' must be 'true' for non-OVERRIDE wrappers.`, package_info);
 
 		if(IS_UNITTEST && FORCE_FAST_MODE)
 			options.perf_mode = 'FAST';