All user data for FoundryVTT. Includes worlds, systems, modules, and any asset in the "foundryuserdata" directory. Does NOT include the FoundryVTT installation itself.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

542 lines
28 KiB

1 year ago
  1. # 1.12.11.0 (2022-11-15)
  2. - Fix incorrect formatting of error messages when modules have both an 'info' and 'bugs' URL in their package manifest. ([Issue #73](https://github.com/ruipin/fvtt-lib-wrapper/issues/73))
  3. # 1.12.10.0 (2022-09-19)
  4. - Code refactoring/clean-up (no user-facing changes)
  5. - Get rid of another FVTT v10 deprecation warning that occurred only when running the development version of the module.
  6. # 1.12.9.0 (2022-09-11)
  7. - Fix incorrect error messages when calling the libWrapper API before the `libWrapper.Ready` hook. ([Issue #72](https://github.com/ruipin/fvtt-lib-wrapper/issues/72))
  8. - Add unit test to catch this issue in the future.
  9. - Fix accidental 3 consecutive blank lines in error messages when a module has neither an `url` nor a `bugs` entry in its manifest.
  10. - Update NPM dependencies to latest version.
  11. # 1.12.8.0 (2022-09-04)
  12. - Get rid of FVTT v10 deprecation warnings caused by legacy style package 'data' accesses.
  13. - Shim updated to v1.12.2 to also get rid of these warnings when libWrapper is not installed.
  14. - Closes [Issue #71](https://github.com/ruipin/fvtt-lib-wrapper/issues/71). Thanks to wickermoon for the issue report and fix proposal!
  15. # 1.12.7.2 (2022-09-02)
  16. - Add `authors` key to the module manifest to avoid compatibility warnings in FVTT v10.
  17. # 1.12.7.1 (2022-08-08)
  18. - Add `compatibility` and `id` keys to the module manifest to avoid compatibility warnings in FVTT v10.
  19. # 1.12.7.0 (2022-06-21)
  20. - Enforce `options.chain == true` when registering non-OVERRIDE wrappers.
  21. # 1.12.6.0 (2022-06-15)
  22. - Add support for reading core compatibility versions for packages using the new Foundry VTT v10 manifest format.
  23. - Update README with information about the new Foundry VTT v10 manifest format.
  24. # 1.12.5.0 (2022-05-31)
  25. - Fix `options.bind` parameter to `libWrapper.register` for `OVERRIDE` wrappers.
  26. - Declare compatibility with Foundry v10. It is unlikely a future v10 update will break compatibility.
  27. # 1.12.4.0 (2022-02-14)
  28. - Improve package detection. Will no longer fail if an error's stack trace is empty, which could happen sometimes when browser native code causes a JS exception.
  29. - Improve error package info injection to be less noisy when it fails.
  30. - Tweak rollup configuration so that relative sourcemap file paths are now correct.
  31. # 1.12.3.0 (2022-02-01)
  32. - All API functions now accept disambiguation prefixes as part of their `package_id` parameter, i.e. `module:foobar`, `system:foobar`, or `world:foobar`.
  33. # 1.12.2.0 (2022-01-30)
  34. - Allow integer enum values to be passed to `get` as a string, so that the caller does not need to cast explicitly.
  35. - No known issues were caused by this, and this code isn't exposed in the libWrapper API, but the previous behaviour was unintended.
  36. # 1.12.1.0 (2022-01-30)
  37. - Hotfix: Correctly handle malformed log verbosity setting.
  38. - Disable minification of class names, for more readable error messages.
  39. # 1.12.0.0 (2022-01-29)
  40. - Fix `libWrapper.AlreadyOverriddenError` usage.
  41. - Override conflicts were accidentally throwing `libWrapper.PackageError` exceptions instead, which breaks the API.
  42. - Fix module updated check when `compatibleCoreVersion` contains only the compatible FVTT major version.
  43. - Allow arguments to be bound when calling `libWrapper.register` ([Issue #58](https://github.com/ruipin/fvtt-lib-wrapper/issues/58))
  44. - This allows avoiding an extra function call, for example
  45. `libWrapper.register(PACKAGE_ID, "foo", function(wrapped, ...args) { return someFunction.call(this, wrapped, "foo", "bar", ...args) });`
  46. becomes
  47. `libWrapper.register(PACKAGE_ID, "foo", someFunction, "WRAPPER", {bind: ["foo", "bar"]});`.
  48. - Implement a logging verbosity setting ([Issue #62](https://github.com/ruipin/fvtt-lib-wrapper/issues/62))
  49. - By default, libWrapper will only show warnings or errors in the console.
  50. # 1.11.4.0 (2022-01-14)
  51. - Hotfix: Previous update caused significant breakage due to an uninitialised variable not caught by unit tests. Sorry for the inconvenience!
  52. # 1.11.3.0 (2022-01-14)
  53. - Allow JavaScript engine to garbage collect objects that have been wrapped by libWrapper.
  54. # 1.11.2.0 (2022-01-05)
  55. - Improve static dispatch chain caching, speeding up wrappers when calling them on different objects with "High Performance Mode" enabled.
  56. # 1.11.1.0 (2022-01-04)
  57. - Add Japanese localisation, contributed by BrotherSharper. Thank you!
  58. # 1.11.0.1 (2021-12-13)
  59. - Declare compatibility with all Foundry v9 versions, instead of individual ones. It is unlikely a future update will break compatibility.
  60. # 1.11.0.0 (2021-11-25)
  61. - API Improvements to `libWrapper.register` and `libWrapper.unregister` (non-breaking):
  62. - `libWrapper.register` now returns a unique numeric target identifier.
  63. - This unique identifier can be used in further calls to `libWrapper.register` and `libWrapper.unregister`, rather than specifying the target path again.
  64. As a result, even if the object is no longer reachable from global scope or has otherwise been replaced by another module, it is still possible to register/unregister wrappers to it.
  65. - The `libWrapper.Register` and `libWrapper.Unregister` hooks have been updated, and now also supply the unique target identifier as an extra parameter.
  66. - Note: The Shim does not support nor provide these unique identifiers.
  67. - Improvements to 'Active Wrappers' pane in the settings window:
  68. - Add the target identifier to the displayed information.
  69. - Do not merge wrappers with the same path but with different target objects (i.e. different target IDs).
  70. - When a target is known by multiple names, display the additional names when expanded.
  71. - Fixed a few cases where having multiple wrappers sharing the same target path but with different target objects (i.e. different target IDs) could cause issues.
  72. - Fix setter inheritance chain handling for properties when there are no setter-specific wrappers.
  73. - Update test cases to exercise the new target identifier code paths properly.
  74. - Miscellaneous cleanup/refactoring and optimisations.
  75. - Update `compatibleCoreVersion`, now set to v9d2 (`9.231`). Note: This was previously set to a non-existent version (`9.244`) by accident.
  76. # 1.10.8.0 (2021-10-10)
  77. - Fix [Issue #56](https://github.com/ruipin/fvtt-lib-wrapper/issues/56).
  78. - Fix handling of unknown packages.
  79. - Correctly use package ID passed to `libWrapper.register` in specific error messages, when auto-detection does not succeed.
  80. - Ensure all exceptions thrown are an object, in order to fix compatibility issue with Foundry 0.8.x when thrown inside `Application._render`.
  81. - Code cleanup: Refactor error classes usage to avoid a cyclic dependency.
  82. # 1.10.7.0 (2021-10-07)
  83. - Fix incorrect error message when a package that conflicts does not correctly define a `minimumCoreVersion` or `compatibleCoreVersion`.
  84. - Optimise the indexing regex, to remove potential exponential backtracking.
  85. - Tweak README to make it clearer that `libWrapper.Ready` is not implemented by the compatibility shim.
  86. # 1.10.6.0 (2021-09-18)
  87. - Add official support for v9p2 (9.244). Previous versions are still supported.
  88. # 1.10.5.0 (2021-09-06)
  89. - Relax `Hooks._call` patch regex to work even when `foundry.js` has been modified.
  90. # 1.10.4.0 (2021-09-05)
  91. - Fix issue where sometimes the relative file paths to a localisation JSON file would be incorrect.
  92. - Use JSCC pre-processor to improve initialisation
  93. - Strip all unnecessary unit-test code from artifact.
  94. - Bundle version information into artifact, to avoid having to look at the module.json during runtime
  95. - Bundle list of available translations into artifact, to skip requesting a localisation JSON file if it does not exist.
  96. # 1.10.3.0 (2021-09-02)
  97. - Add Spanish localisation, contributed by GoR (GoR#9388). Thank you!
  98. - Tweak how support channels are specified in the localisation JSON files, to avoid having to specify them twice.
  99. # 1.10.2.0 (2021-08-27)
  100. - Tweak localisation polyfill. Messages should now be localised correctly before `game.i18n` initialises.
  101. - Fix Settings UI: `Show ignored conflicts` checkbox clicks sometimes would not register.
  102. - Add pt-BR localisation, contributed by Matheus Clemente (mclemente#5524). Thank you!
  103. - Add pt-PT localisation.
  104. # 1.10.1.1 (2021-08-27)
  105. - Fix build workflow to properly include translation JSON files in the artifact.
  106. - No code changes.
  107. # 1.10.1.0 (2021-08-27)
  108. - Hotfix: Foundry did not load with libWrapper enabled if set to a language for which no libWrapper translation was available.
  109. # 1.10.0.0 (2021-08-26)
  110. - **[BREAKING]** Remove LibWrapperError methods deprecated since v1.6.0.0:
  111. - `LibWrapperInternalError.module`, replaced by `LibWrapperInternalError.package_id`
  112. - `LibWrapperPackageError.module`, replaced by `LibWrapperPackageError.package_id`
  113. - Improve error messages (Implements [#42](https://github.com/ruipin/fvtt-lib-wrapper/issues/42))
  114. - Add support for localization (Implements [#44](https://github.com/ruipin/fvtt-lib-wrapper/issues/44))
  115. - As of now, only includes the english language, but community contributions are welcome.
  116. # 1.9.2.0 (2021-08-25)
  117. - Resolve `ignore_conflicts` API not ignoring all types of conflicts. (Fixes [Issue #49](https://github.com/ruipin/fvtt-lib-wrapper/issues/49))
  118. # 1.9.1.0 (2021-08-25)
  119. - When an unhandled exception is seen by libWrapper, it will detect involved packages (if any) and append this list to the exception message.
  120. # 1.9.0.0 (2021-08-23)
  121. - Support wrapping global methods when they are available in `globalThis` and the associated descriptor has `configurable: true`.
  122. - Include shared library [fvtt-shared-library](https://github.com/ruipin/fvtt-shared-library) statically for `PackageInfo`, polyfills, and Enums.
  123. - Now correctly able to detect package IDs (e.g. in case of compatibility issues) before the `init` hook.
  124. - Can now use enum objects for the `type` and `options.perf_mode` parameters to `libWrapper.register`, e.g. `libWrapper.WRAPPER` or `libWrapper.PERF_FAST`.
  125. - Fix `libWrapper.register` API: The value `NORMAL` for `options.perf_mode` was incorrectly not permitted.
  126. - Miscellaneous code cleanup.
  127. # 1.8.1.0 (2021-08-22)
  128. - Attempt to prevent other modules from breaking the libWrapper initialisation process.
  129. - **[BREAKING]** Prevent use of `Game.toString()` before libWrapper initialises.
  130. - Detect when the libWrapper initialisation process did not run because of another module.
  131. - Prepend `/* WARNING: libWrapper wrappers present! */` to `toString()` calls on methods wrapped by libWrapper.
  132. - Explicitly announce compatibility with Foundry 0.8.9.
  133. # 1.8.0.0 (2021-07-29)
  134. - Allow `libWrapper.register` targets to contain string Array indexes. (Fixes [Issue #46](https://github.com/ruipin/fvtt-lib-wrapper/issues/46))
  135. For example, `CONFIG.Actor.sheetClasses.character["dnd5e.ActorSheet5eCharacter"].cls.prototype._onLongRest` is now a valid wrapper target.
  136. # 1.7.5.0 (2021-07-05)
  137. - Don't fail registering wrappers if `game` is malformed.
  138. # 1.7.4.0 (2021-07-05)
  139. - Handle malformed `game.modules` gracefully. This can happen when Foundry does not initialise properly which by itself can cause issues, but libWrapper was making the situation even worse by aborting the initialisation process.
  140. - Explicitly announce compatibility with Foundry 0.8.8.
  141. # 1.7.3.0 (2021-06-22)
  142. - Update 'About' pane in the settings with more information about reporting issues.
  143. - Update documentation
  144. - Explain differences between the full library and the shim.
  145. - Add information about how to obtain support.
  146. # 1.7.2.0 (2021-06-19)
  147. - Rename `error-listeners.js` to `listeners.js` (see [Issue #42](https://github.com/ruipin/fvtt-lib-wrapper/issues/42)).
  148. - Do not prefix `libWrapper-` to `listeners.js` file in the sourcemap.
  149. - Explicitly announce compatibility with Foundry 0.8.7.
  150. - Add `bugs` attribute to manifest, and enable [Bug Reporter](https://github.com/League-of-Foundry-Developers/bug-reporter) support.
  151. - Miscellaneous code cleanup.
  152. - Update documentation:
  153. - Add section about Systems.
  154. - Add section about Mixins.
  155. - Add section about `super`.
  156. - Update release script to properly handle commas in the manifest file, as well as be easier to maintain.
  157. # 1.7.1.0 (2021-06-14)
  158. - Include Git commit hash in manifest.
  159. - Update release scripts.
  160. - Update version parsing code.
  161. # 1.7.0.0 (2021-06-09)
  162. - **[BREAKING]** Removed `libWrapper.clear_modules` API, `libWrapper.ClearModule` hook, and `LibWrapperModuleError` exception class (all deprecated since v1.6.0.0).
  163. - Implement backend system for ignoring known potential conflicts (part of [Issue #33](https://github.com/ruipin/fvtt-lib-wrapper/issues/33))
  164. - Added `libWrapper.ignore_conflicts` API method to allow package developers to have libWrapper not warn the user about certain conflicts.
  165. - Add a toggle to the 'Conflicts' tab in the settings dialog to display detected conflicts that were ignored. These are hidden by default.
  166. - Hooks `libWrapper.ConflictDetected` and `libWrapper.OverrideLost` now also get passed a list of all unique `target` parameters that have been used to register wrappers for a given method, instead of just the first one ever used. This is important for methods that are reachable through more than one target path.
  167. # 1.6.2.0 (2021-06-04)
  168. - Fix errors seen when wrapping inherited properties.
  169. - These were caused by a terser bug ([terser/terser #1003](https://github.com/terser/terser/issues/1003)).
  170. - Clean up `Wrapper` singleton detection code.
  171. - Explicitly announce compatibility with Foundry 0.8.6.
  172. # 1.6.1.0 (2021-05-26)
  173. - Fix infinite loop leading to a `RangeError: Maximum call stack size exceeded` error when both libWrapper wrappers and manual wrappers are present on a method inherited from a parent class.
  174. - Fixes the incompatibility between "TouchVTT" and "Drag Ruler" when libWrapper was active.
  175. - Fix module ID not displaying correctly in settings dialog for `MANUAL` wrappers.
  176. # 1.6.0.1 (2021-05-24)
  177. - No code changes.
  178. - Explicitly announce compatibility with Foundry 0.8.5.
  179. # 1.6.0.0 (2021-05-10)
  180. - **[BREAKING]** Remove `libWrapperReady` hook (deprecated since v1.5.0.0, `libWrapper.Ready` should be used instead).
  181. - Rename all instances of `module` to `package`, given the library now officially supports systems and worlds.
  182. - Deprecate `libWrapper.clear_module` method (now `libWrapper.unregister_all`) and the `libWrapper.ClearModule` hook (now `libWrapper.UnregisterAll`).
  183. - Deprecate `libWrapper.ModuleError` (now `libWrapper.PackageError`).
  184. - Deprecate all `libWrapper.Error.module` getters (now `libWrapper.Error.package_id`).
  185. - Rewrite module auto-detection functionality to be able to handle systems and worlds correctly.
  186. - Allows modules/systems/worlds to co-exist even when they share the same package ID.
  187. - Make it explicit when a package ID corresponds to a world or system.
  188. - Error and warning messages now display `world` and `system` instead of `module`, when applicable.
  189. - Display `[World]` and `[System]` next to the package IDs in the settings dialog when packages are not modules.
  190. - Miscellaneous code clean-up in preparation for future work.
  191. - Announce compatibility with Foundry 0.8.3.
  192. # 1.5.6.0 (2021-05-05)
  193. - Improve unhandled error detection mechanism.
  194. - Also detect errors that occur inside `Application.prototype.render`.
  195. # 1.5.5.0 (2021-05-05)
  196. - Fix sorting of unprioritized modules in the settings dialog.
  197. # 1.5.4.0 (2021-05-05)
  198. - Improve support for systems and world scripts. ([Issue #19](https://github.com/ruipin/fvtt-lib-wrapper/issues/19))
  199. - World scripts are now supported.
  200. - Shim ID/title auto-detection now supports both world scripts and systems.
  201. - Do not use positive look-behind in regexes. ([Issue #34](https://github.com/ruipin/fvtt-lib-wrapper/issues/34))
  202. - This fixes support for Safari Technical Preview. (Note: Safari is still officially unsupported by both Foundry and libWrapper)
  203. - Corresponding update to the shim, which will be required if modules wish to support Safari.
  204. # 1.5.3.0 (2021-05-04)
  205. - Improve call stack for hooks ([Issue #32](https://github.com/ruipin/fvtt-lib-wrapper/issues/32))
  206. - Changed the `Hooks._call` wrapper to a patched override.
  207. - Delay evaluation of notifications configuration until `ready` hook.
  208. - Announce compatibility with Foundry 0.8.2.
  209. # 1.5.2.0 (2021-04-16)
  210. - Versioning updates
  211. - Split `SUFFIX` field into `SUFFIX` and `META`.
  212. - `SUFFIX` is now always an integer, with `META` containing the string portion.
  213. - `META` is now unnecessary when comparing library versions, as any change to this field will cause one of the other fields to be incremented.
  214. - Updated `version_at_least` to be able to request a minimum `SUFFIX` field.
  215. # 1.5.1.0 (2021-04-13)
  216. - Fix issue detecting module names when using minified releases of libWrapper.
  217. # 1.5.0.0 (2021-04-12)
  218. - Major performance improvements
  219. - Improved performance of the standard performance mode in a tight loop by 60% compared to previous versions.
  220. - Compared to v1.4.3.0:
  221. - 1000 calls to one wrapper: 1.67ms → 0.67ms (~60% improvement)
  222. - One call to 1000 wrappers: 0.87ms → 0.60ms (~25% improvement)
  223. - Added unit test to ensure there are no significant performance regressions in the future.
  224. - The GM can now toggle a 'High-Performance Mode' in the libWrapper module settings. ([Issue #25](https://github.com/ruipin/fvtt-lib-wrapper/issues/25))
  225. - Modules can also request this be used by default (see documentation for usage details).
  226. - This mode forgoes libWrapper's dynamic conflict detection capabilities in exchange for higher performance.
  227. - Compared to the standard mode on v1.5.0.0:
  228. - 1000 calls to one wrapper: 0.67ms → 0.06ms (~90% improvement)
  229. - One call to 1000 wrappers: 0.60ms → 0.08ms (~85% improvement)
  230. - This is within margin of error of non-libWrapper wrapping methods, and useful when wrapping methods in a tight loop such as `WallsLayer.testWalls`.
  231. - Updated rollup/babel/terser configuration and versions.
  232. # 1.4.3.0 (2021-04-11)
  233. - Ignore conflicts when `libWrapper.ConflictDetected` returns `false`.
  234. - Do not treat an `OVERRIDE` wrapper being replaced as a conflict when `libWrapper.OverrideLost` returns `false`.
  235. # 1.4.2.0 (2021-04-11)
  236. - System support:
  237. - Systems can now register wrappers using their ID (Partially implements [Issue #19](https://github.com/ruipin/fvtt-lib-wrapper/issues/19))
  238. - Detected conflicts involving a system no longer show up as `unknown`.
  239. - Improve call stacks further ([Issue #17](https://github.com/ruipin/fvtt-lib-wrapper/issues/17)):
  240. - Decorate all `libWrapper`, `Wrapper` and `LibWrapperNotifications` functions with the `🎁` symbol.
  241. - Bind `call_wrapped` on the last wrapper call, instead of `call_wrapper`. This avoids one extra call.
  242. - Decorate `Hooks._call` wrapper properly.
  243. # 1.4.1.0 (2021-04-11)
  244. - Fix broken `Hooks.once` behaviour. Modules such as Norc's Custom Hotbar now work as expected. Closes [Issue #30](https://github.com/ruipin/fvtt-lib-wrapper/issues/30).
  245. - Detect `Promise` rejections caused by `LibWrapperError` exceptions properly.
  246. # 1.4.0.0 (2021-04-11)
  247. - **[BREAKING]** Remove private code from `libWrapper` scope.
  248. - The `libWrapper` object no longer exposes various private functions. This includes:
  249. - Any function with a `_` prefix
  250. - `load_priorities`
  251. - If your code was relying on any of these undocumented functions, it will need to be updated.
  252. - As always, you should assume any method that is not publicly documented may change or be removed at any moment and without notice.
  253. - Closes [Issue #16](https://github.com/ruipin/fvtt-lib-wrapper/issues/16).
  254. - **[DEPRECATION WARNING]** The hook `libWrapperReady` is now deprecated and will be removed in a future version.
  255. - You should use `libWrapper.Ready` instead.
  256. - Bug-fixes:
  257. - Register modules to the prioritization UI even if they fail to register an `OVERRIDE` wrapper due to another wrapper already existing. Fixes [Issue #21](https://github.com/ruipin/fvtt-lib-wrapper/issues/21).
  258. - Enable statistics collection for non-GM users with 'Modify configuration settings' permission. This means they can now edit the libWrapper priorities. Fixes [Issue #26](https://github.com/ruipin/fvtt-lib-wrapper/issues/26).
  259. - New features / improvements:
  260. - Trigger the `libWrapper.OverrideLost` hook when an `OVERRIDE` wrapper gets replaced. Closes [Issue #23](https://github.com/ruipin/fvtt-lib-wrapper/issues/23).
  261. - Trigger various hooks when certain events occur. See documentation for details.
  262. - Added public API function `version_at_least(major, minor=0, patch=0)` for modules to easily check for a minimum libWrapper version.
  263. - Redirect `toString()` method to the wrapped method. Closes [Issue #18](https://github.com/ruipin/fvtt-lib-wrapper/issues/18)
  264. - Major documentation improvements:
  265. - Documented `version`, `versions`, `is_fallback`.
  266. - Documented all custom exception classes used by libWrapper.
  267. - Documented the Hooks triggered by libWrapper.
  268. - Documented the `{chain: true}` option for `OVERRIDE` wrappers added in v1.3.6.0.
  269. - Documentation now states explicitly that usage of anything undocumented is unsupported, might change, and can easily break.
  270. - Split the contributing section to [CONTRIBUTING.md](CONTRIBUTING.md).
  271. - Added a Table of Contents, as well as section numbers.
  272. - Improve callstack:
  273. - Renamed `src/lib/lib-wrapper.js` to `src/libWrapper-api.js`.
  274. - Renamed `src/lib/wrapper.js` to `src/libWrapper-wrapper.js`.
  275. - Renamed handler function names, so that they are shorter.
  276. - Use Function.displayName in addition to the previous implementation, when giving functions custom names.
  277. - Improve performance by caching handler functions, instead of re-generating them every time.
  278. - Closes [Issue #17](https://github.com/ruipin/fvtt-lib-wrapper/issues/17).
  279. - Improve error handling mechanism:
  280. - Detect unhandled libWrapper errors inside hooks, and warn the user appropriately.
  281. - libWrapper will no longer break if it fails to parse `game.data.user` or `game.data.settings`. This should improve compatibility with future Foundry VTT versions.
  282. - Delay warning and error notifications until the `ready` hook if they occur beforehand, to ensure they are displayed.
  283. - Manifest changes:
  284. - Add `library: true` to manifest.
  285. - Announce compatibility with Foundry 0.8.1.
  286. - Minor code cleanup.
  287. # 1.3.6.0 (2021-04-09)
  288. - Allow OVERRIDE wrappers to continue chain if they pass `{chain: true}` as a fourth parameter to `libWrapper.register`.
  289. # 1.3.5.0 (2021-01-11)
  290. - Bugfix: Refactor usage of the handler objects (used to bootstrap a libWrapper call) so that dispatch is dynamic. Prevents references to wrapped methods from skipping the wrappers.
  291. # 1.3.4.0 (2021-01-08)
  292. - Give custom names to methods in the wrapper call chain for easier debug when something goes wrong (browser support varies).
  293. # 1.3.3.0 (2021-01-08)
  294. - Hotfix crashes introduced by v1.3.2.0 when detecting possible conflicts. Now added to test suite to avoid something similar happening again.
  295. # 1.3.2.0 (2021-01-07)
  296. - Add try-catch inside `onUnhandledError` in order to avoid swallowing the original exception with a second exception if anything goes wrong.
  297. - Handle missing `ui.notifications` gracefully.
  298. # 1.3.1.0 (2021-01-07)
  299. - Remove need for invalidation of outstanding asynchronous wrappers, when wrappers are modified. (Fixes [Issue #7](https://github.com/ruipin/fvtt-lib-wrapper/issues/7))
  300. - Optimize instance assignment.
  301. - Misc. bug fixes.
  302. # 1.3.0.0 (2021-01-06)
  303. - **[BREAKING]** Fix inconsistent wrapping order (see [Issue #13](https://github.com/ruipin/fvtt-lib-wrapper/issues/13)).
  304. - Major test suite improvement. Expand the number of tests, and refactor them for readability (see [Issue #12](https://github.com/ruipin/fvtt-lib-wrapper/issues/12))
  305. - Fix property inheritance. It did not work at all before this update.
  306. - Throw correct exception type when trying to wrap a setter that doesn't exist.
  307. - A few other miscellaneous bug-fixes for corner cases detected by the new tests.
  308. # 1.2.1.0 (2021-01-03)
  309. - Freeze all libWrapper classes after defining them.
  310. - Remove use of '<' and '>' to avoid them being treated as HTML.
  311. - Make error notifications permanent.
  312. # 1.2.0.0 (2021-01-03)
  313. - Refactor source code directory structure.
  314. - **[BREAKING]** Clean-up API parameter validation.
  315. - The `module` and `target` API parameter types are now validated, and these must be strings.
  316. - The `module` API parameter will now undergo more extensive validation - attempts to wrap using a different module name than the caller may fail.
  317. - Library now attempts to forbid wrapping libWrapper code and APIs.
  318. - Refactor error handling.
  319. - All libWrapper errors now extend the `LibWrapperError` class.
  320. - **[BREAKING]** For consistency, the previous libWrapper exception classes have been renamed.
  321. - `AlreadyOverriddenError` and `InvalidWrapperChainError` have been renamed to `LibWrapperAlreadyOverriddenError` and `LibWrapperInvalidWrapperChainError` respectively.
  322. - To aid compatibility, these can still be found in `libWrapper.AlreadyOverriddenError` and `libWrapper.InvalidWrapperChainError` as before, in addition to their new names.
  323. - Add option to visually notify non-GM players of issues, in addition to the GM.
  324. - No longer notifies user if libWrapper exceptions are handled by a given module.
  325. # 1.1.5.0 (2021-01-03)
  326. - Reintroduce changes from v1.1.3.0.
  327. - Fix 'super' usage inside wrapped methods, which was causing multiple modules to malfunction when using libWrapper.
  328. # 1.1.4.0 (2021-01-03)
  329. - Hotfix release. Reverts changes in 1.1.3.0, which broke some things.
  330. # 1.1.3.0 (2021-01-03)
  331. - Fix instance/inherited wrapping when there are more than 2 layers, e.g. C inherits from B which inherits from A. Some corner cases were broken.
  332. # 1.1.2.0 (2021-01-03)
  333. - Prevent wrapping of libWrapper internals
  334. - Update shim. Now supports very basic inherited method wrapping using static dispatch.
  335. # 1.1.1.0 (2021-01-03)
  336. - Fix parameters when instance-specific wrappers chain to class-specific wrappers.
  337. - Notify of conflicts when a module wraps instances directly without using libWrapper, but the class has a libWrapper wrapper.
  338. # 1.1.0.0 (2021-01-02)
  339. - Fix 'WRAPPER'-type wrappers that chain asynchronously. These will no longer be incorrectly unregistered for not chaining. (See [issue #7](https://github.com/ruipin/fvtt-lib-wrapper/issues/7))
  340. - Fix wrappers being called twice when a module wraps an instance member without libWrapper, if libWrapper is used to wrap the class prototype. (See [issue #7](https://github.com/ruipin/fvtt-lib-wrapper/issues/8))
  341. - Notify GM when potential issues/conflicts are detected. This can be disabled in the module settings menu.
  342. - Removed option to disable runtime data collection used for the settings menu. After benchmarking, this being enabled does not seem to impact performance at all.
  343. # 1.0.8.0 (2021-01-01)
  344. - Allow modules to chain wrappers asynchronously ([issue #7](https://github.com/ruipin/fvtt-lib-wrapper/issues/7)).
  345. # 1.0.7.0 (2020-12-30)
  346. - Implement support for multiple chaining. Now, modules can call the next wrapper in the chain more than once.
  347. # 1.0.6.0 (2020-12-30)
  348. - Improved some exception messages to make it clearer which module/wrapper is responsible for them.
  349. - Improved the README, to make more explicit some of the common pitfalls when using this library.
  350. Now explicitly mentions that 'OVERRIDE' wrappers have a different call signature, and that wrappers should not chain more than once.
  351. - Explicitly announce compatibility with Foundry 0.7.9.
  352. # 1.0.5.3 (2020-12-08)
  353. - No code changes.
  354. - Explicitly announce compatibility with Foundry 0.7.8.
  355. # 1.0.5.2 (2020-11-15)
  356. - No code changes (Note: from now on, versions with no code changes will not increment the "minor version", instead using a suffix).
  357. - Explicitly announce compatibility with Foundry 0.7.7.
  358. # 1.0.5 (2020-10-22)
  359. - No code changes.
  360. - Explicitly announce compatibility with Foundry 0.7.5.
  361. # 1.0.4 (2020-09-22)
  362. - Adds official support for instance-specific, as well as inherited-method wrapping. Note that these are not supported by the shim.
  363. - Fixes silent failures and broken behaviour when attempting to override a method on a class which it inherited from a parent class.
  364. - Fixes silent failures and broken behaviour when attempting to override a method on an object instance, rather than a class.
  365. - Throw an explicit failure message when the shim fails to find the method to wrap.
  366. - Fix 'this' parameter when using the shim and calling the original method without using 'call' or 'apply'.
  367. - Update documentation to better explain the shim's limitations.
  368. - Closes [issue #2](https://github.com/ruipin/fvtt-lib-wrapper/issues/2). Thanks to Nordii for the report.
  369. # 1.0.3 (2020-09-17)
  370. - Fix shim when type='OVERRIDE' is used ([issue #1](https://github.com/ruipin/fvtt-lib-wrapper/issues/1)). Thanks to itamarcu for the report.
  371. # 1.0.2 (2020-08-29)
  372. - Fix libWrapper.versions property, which was not showing the correct libWrapper version information.
  373. # 1.0.1 (2020-08-08)
  374. - Fix packaging mistake that would prevent the settings dialog from opening.
  375. # 1.0.0 (2020-08-08)
  376. - Initial release.