@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.4-beta

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (559) hide show
  1. package/README.md +17 -18
  2. package/package.json +74 -32
  3. package/src/configuration/configuration.d.mts +316 -0
  4. package/src/configuration/documents.d.mts +295 -0
  5. package/src/configuration/globals.d.mts +357 -0
  6. package/src/configuration/index.d.mts +5 -0
  7. package/src/foundry/client/apps/app.d.mts +129 -122
  8. package/src/foundry/client/apps/av/av-config.d.mts +12 -7
  9. package/src/foundry/client/apps/av/cameras.d.mts +12 -7
  10. package/src/foundry/client/apps/dice/dice-config.d.mts +59 -0
  11. package/src/foundry/client/apps/dice/index.d.mts +1 -0
  12. package/src/foundry/client/apps/form.d.mts +114 -86
  13. package/src/foundry/client/apps/forms/actor.d.mts +21 -11
  14. package/src/foundry/client/apps/forms/adventure-exporter.d.mts +12 -7
  15. package/src/foundry/client/apps/forms/adventure-importer.d.mts +14 -6
  16. package/src/foundry/client/apps/forms/base-sheet.d.mts +16 -8
  17. package/src/foundry/client/apps/forms/card-config.d.mts +16 -8
  18. package/src/foundry/client/apps/forms/cards-config.d.mts +15 -14
  19. package/src/foundry/client/apps/forms/combat-config.d.mts +7 -7
  20. package/src/foundry/client/apps/forms/combatant-config.d.mts +3 -3
  21. package/src/foundry/client/apps/forms/default-sheets-config.d.mts +1 -1
  22. package/src/foundry/client/apps/forms/effect-config.d.mts +7 -7
  23. package/src/foundry/client/apps/forms/folder-config.d.mts +5 -5
  24. package/src/foundry/client/apps/forms/fonts.d.mts +42 -35
  25. package/src/foundry/client/apps/forms/grid-config.d.mts +12 -13
  26. package/src/foundry/client/apps/forms/image-popout.d.mts +29 -23
  27. package/src/foundry/client/apps/forms/item.d.mts +9 -9
  28. package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +16 -14
  29. package/src/foundry/client/apps/forms/journal-sheet.d.mts +48 -38
  30. package/src/foundry/client/apps/forms/macro-config.d.mts +7 -7
  31. package/src/foundry/client/apps/forms/measure-template.d.mts +10 -12
  32. package/src/foundry/client/apps/forms/ownership.d.mts +5 -5
  33. package/src/foundry/client/apps/forms/playlist-config.d.mts +8 -10
  34. package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +7 -7
  35. package/src/foundry/client/apps/forms/roll-table-config.d.mts +11 -10
  36. package/src/foundry/client/apps/forms/scene-config.d.mts +40 -41
  37. package/src/foundry/client/apps/forms/sheet-config.d.mts +9 -21
  38. package/src/foundry/client/apps/forms/user-config.d.mts +13 -12
  39. package/src/foundry/client/apps/hud/chatbubble.d.mts +18 -6
  40. package/src/foundry/client/apps/hud/container.d.mts +4 -4
  41. package/src/foundry/client/apps/hud/controls.d.mts +126 -81
  42. package/src/foundry/client/apps/hud/hotbar.d.mts +17 -12
  43. package/src/foundry/client/apps/hud/hud.d.mts +5 -5
  44. package/src/foundry/client/apps/hud/menu.d.mts +10 -3
  45. package/src/foundry/client/apps/hud/navigation.d.mts +14 -9
  46. package/src/foundry/client/apps/hud/pause.d.mts +9 -4
  47. package/src/foundry/client/apps/hud/players.d.mts +14 -9
  48. package/src/foundry/client/apps/i18n.d.mts +31 -27
  49. package/src/foundry/client/apps/index.d.mts +1 -0
  50. package/src/foundry/client/apps/placeables/drawing-config.d.mts +41 -33
  51. package/src/foundry/client/apps/placeables/drawing-hud.d.mts +5 -5
  52. package/src/foundry/client/apps/placeables/index.d.mts +0 -2
  53. package/src/foundry/client/apps/placeables/note-config.d.mts +28 -18
  54. package/src/foundry/client/apps/placeables/tile-config.d.mts +23 -10
  55. package/src/foundry/client/apps/placeables/tile-hud.d.mts +10 -5
  56. package/src/foundry/client/apps/placeables/token-config.d.mts +91 -58
  57. package/src/foundry/client/apps/placeables/token-hud.d.mts +12 -7
  58. package/src/foundry/client/apps/placeables/wall-config.d.mts +21 -17
  59. package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +5 -5
  60. package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +3 -3
  61. package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +15 -13
  62. package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +3 -3
  63. package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +3 -2
  64. package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +6 -6
  65. package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts +6 -6
  66. package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +34 -29
  67. package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +2 -2
  68. package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +13 -10
  69. package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +50 -35
  70. package/src/foundry/client/apps/sidebar/document-directory.d.mts +52 -38
  71. package/src/foundry/client/apps/sidebar/package-configuration.d.mts +4 -4
  72. package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +3 -3
  73. package/src/foundry/client/apps/sidebar/sidebar.d.mts +9 -4
  74. package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +11 -2
  75. package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +11 -2
  76. package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +39 -27
  77. package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +21 -12
  78. package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +30 -15
  79. package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +11 -2
  80. package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +11 -2
  81. package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +14 -5
  82. package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +30 -22
  83. package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +11 -2
  84. package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +14 -5
  85. package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +23 -5
  86. package/src/foundry/client/apps/templates.d.mts +1 -1
  87. package/src/foundry/client/av/client.d.mts +1 -1
  88. package/src/foundry/client/av/clients/simplepeer.d.mts +11 -1
  89. package/src/foundry/client/av/master.d.mts +2 -2
  90. package/src/foundry/client/av/settings.d.mts +17 -15
  91. package/src/foundry/client/config.d.mts +444 -312
  92. package/src/foundry/client/core/document-index.d.mts +11 -3
  93. package/src/foundry/client/core/hooks.d.mts +2 -4
  94. package/src/foundry/client/core/image.d.mts +14 -13
  95. package/src/foundry/client/core/issues.d.mts +9 -4
  96. package/src/foundry/client/core/keybindings.d.mts +5 -5
  97. package/src/foundry/client/core/nue.d.mts +1 -1
  98. package/src/foundry/client/core/packages.d.mts +397 -61
  99. package/src/foundry/client/core/settings.d.mts +62 -38
  100. package/src/foundry/client/core/socket.d.mts +2 -2
  101. package/src/foundry/client/core/sorting.d.mts +6 -6
  102. package/src/foundry/client/core/time.d.mts +6 -3
  103. package/src/foundry/client/core/tooltip.d.mts +2 -2
  104. package/src/foundry/client/core/tour.d.mts +59 -50
  105. package/src/foundry/client/core/tours.d.mts +1 -1
  106. package/src/foundry/client/core/utils.d.mts +33 -10
  107. package/src/foundry/client/core/video.d.mts +1 -1
  108. package/src/foundry/client/core/workers.d.mts +24 -17
  109. package/src/foundry/client/data/abstract/canvas-document.d.mts +21 -16
  110. package/src/foundry/client/data/abstract/client-document.d.mts +153 -183
  111. package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +23 -39
  112. package/src/foundry/client/data/abstract/document-collection.d.mts +96 -68
  113. package/src/foundry/client/data/abstract/world-collection.d.mts +47 -55
  114. package/src/foundry/client/data/collections/actors.d.mts +30 -28
  115. package/src/foundry/client/data/collections/cards.d.mts +16 -3
  116. package/src/foundry/client/data/collections/combats.d.mts +18 -5
  117. package/src/foundry/client/data/collections/compendium-collection.d.mts +81 -99
  118. package/src/foundry/client/data/collections/compendium-folders.d.mts +6 -6
  119. package/src/foundry/client/data/collections/compendium-packs.d.mts +5 -5
  120. package/src/foundry/client/data/collections/fog.d.mts +16 -3
  121. package/src/foundry/client/data/collections/folder.d.mts +20 -6
  122. package/src/foundry/client/data/collections/items.d.mts +17 -4
  123. package/src/foundry/client/data/collections/journal.d.mts +22 -7
  124. package/src/foundry/client/data/collections/macros.d.mts +21 -19
  125. package/src/foundry/client/data/collections/messages.d.mts +19 -6
  126. package/src/foundry/client/data/collections/playlists.d.mts +17 -5
  127. package/src/foundry/client/data/collections/scenes.d.mts +24 -27
  128. package/src/foundry/client/data/collections/settings.d.mts +16 -3
  129. package/src/foundry/client/data/collections/tables.d.mts +18 -5
  130. package/src/foundry/client/data/collections/users.d.mts +19 -7
  131. package/src/foundry/client/data/documents/active-effect.d.mts +677 -85
  132. package/src/foundry/client/data/documents/actor-delta.d.mts +670 -27
  133. package/src/foundry/client/data/documents/actor.d.mts +718 -64
  134. package/src/foundry/client/data/documents/adventure.d.mts +480 -46
  135. package/src/foundry/client/data/documents/ambient-light.d.mts +423 -19
  136. package/src/foundry/client/data/documents/ambient-sound.d.mts +473 -14
  137. package/src/foundry/client/data/documents/card.d.mts +567 -36
  138. package/src/foundry/client/data/documents/cards.d.mts +744 -87
  139. package/src/foundry/client/data/documents/chat-message.d.mts +574 -42
  140. package/src/foundry/client/data/documents/combat.d.mts +699 -69
  141. package/src/foundry/client/data/documents/combatant.d.mts +504 -24
  142. package/src/foundry/client/data/documents/drawing.d.mts +540 -14
  143. package/src/foundry/client/data/documents/fog-exploration.d.mts +416 -21
  144. package/src/foundry/client/data/documents/folder.d.mts +468 -35
  145. package/src/foundry/client/data/documents/index.d.mts +2 -0
  146. package/src/foundry/client/data/documents/item.d.mts +677 -20
  147. package/src/foundry/client/data/documents/journal-entry-page.d.mts +585 -19
  148. package/src/foundry/client/data/documents/journal-entry.d.mts +619 -18
  149. package/src/foundry/client/data/documents/macro.d.mts +528 -25
  150. package/src/foundry/client/data/documents/measured-template.d.mts +478 -14
  151. package/src/foundry/client/data/documents/note.d.mts +491 -15
  152. package/src/foundry/client/data/documents/playlist-sound.d.mts +426 -24
  153. package/src/foundry/client/data/documents/playlist.d.mts +665 -74
  154. package/src/foundry/client/data/documents/region-behavior.d.mts +507 -0
  155. package/src/foundry/client/data/documents/region.d.mts +784 -0
  156. package/src/foundry/client/data/documents/scene.d.mts +983 -147
  157. package/src/foundry/client/data/documents/setting.d.mts +395 -13
  158. package/src/foundry/client/data/documents/table-result.d.mts +476 -14
  159. package/src/foundry/client/data/documents/table.d.mts +661 -78
  160. package/src/foundry/client/data/documents/tile.d.mts +499 -14
  161. package/src/foundry/client/data/documents/token.d.mts +1111 -94
  162. package/src/foundry/client/data/documents/user.d.mts +493 -25
  163. package/src/foundry/client/data/documents/wall.d.mts +548 -14
  164. package/src/foundry/client/game.d.mts +60 -92
  165. package/src/foundry/client/head.d.mts +9 -9
  166. package/src/foundry/client/hooks.d.mts +257 -237
  167. package/src/foundry/client/pixi/board.d.mts +106 -94
  168. package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +97 -25
  169. package/src/foundry/client/pixi/core/containers/cached-container.d.mts +37 -19
  170. package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +7 -10
  171. package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +25 -15
  172. package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +16 -6
  173. package/src/foundry/client/pixi/core/containers/quadtree.d.mts +113 -54
  174. package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +69 -26
  175. package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +20 -2
  176. package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +164 -99
  177. package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +61 -22
  178. package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +120 -53
  179. package/src/foundry/client/pixi/core/interaction/ping.d.mts +62 -31
  180. package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +23 -10
  181. package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +91 -34
  182. package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +76 -30
  183. package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +35 -5
  184. package/src/foundry/client/pixi/core/interaction/targets.d.mts +21 -18
  185. package/src/foundry/client/pixi/core/loader.d.mts +86 -76
  186. package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +42 -17
  187. package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +92 -64
  188. package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +28 -10
  189. package/src/foundry/client/pixi/core/shapes/ray.d.mts +47 -23
  190. package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +170 -75
  191. package/src/foundry/client/pixi/extensions/circle.d.mts +128 -125
  192. package/src/foundry/client/pixi/extensions/graphics.d.mts +3 -1
  193. package/src/foundry/client/pixi/extensions/observable-transform.d.mts +5 -4
  194. package/src/foundry/client/pixi/extensions/polygon.d.mts +154 -134
  195. package/src/foundry/client/pixi/extensions/rectangle.d.mts +242 -259
  196. package/src/foundry/client/pixi/groups/effects.d.mts +75 -24
  197. package/src/foundry/client/pixi/groups/environment.d.mts +68 -19
  198. package/src/foundry/client/pixi/groups/hidden.d.mts +27 -11
  199. package/src/foundry/client/pixi/groups/interface.d.mts +62 -38
  200. package/src/foundry/client/pixi/groups/overlay.d.mts +19 -7
  201. package/src/foundry/client/pixi/groups/primary.d.mts +66 -44
  202. package/src/foundry/client/pixi/groups/rendered.d.mts +19 -7
  203. package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +11 -15
  204. package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +29 -28
  205. package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +306 -272
  206. package/src/foundry/client/pixi/layers/controls/cursor.d.mts +18 -9
  207. package/src/foundry/client/pixi/layers/controls/door.d.mts +32 -11
  208. package/src/foundry/client/pixi/layers/controls/layer.d.mts +89 -77
  209. package/src/foundry/client/pixi/layers/controls/ruler.d.mts +121 -96
  210. package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +9 -12
  211. package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +9 -10
  212. package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +8 -8
  213. package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +22 -22
  214. package/src/foundry/client/pixi/layers/effects/visibility.d.mts +106 -86
  215. package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +14 -5
  216. package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +31 -2
  217. package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +137 -65
  218. package/src/foundry/client/pixi/layers/grid/highlight.d.mts +14 -4
  219. package/src/foundry/client/pixi/layers/grid/layer.d.mts +92 -92
  220. package/src/foundry/client/pixi/layers/grid/mesh.d.mts +37 -16
  221. package/src/foundry/client/pixi/layers/masks/depth.d.mts +12 -7
  222. package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +19 -12
  223. package/src/foundry/client/pixi/layers/masks/vision.d.mts +104 -18
  224. package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +16 -15
  225. package/src/foundry/client/pixi/layers/placeables/index.d.mts +1 -0
  226. package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +12 -14
  227. package/src/foundry/client/pixi/layers/placeables/notes.d.mts +49 -32
  228. package/src/foundry/client/pixi/layers/placeables/regions.d.mts +113 -0
  229. package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +81 -67
  230. package/src/foundry/client/pixi/layers/placeables/templates.d.mts +11 -15
  231. package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +30 -21
  232. package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +66 -52
  233. package/src/foundry/client/pixi/layers/placeables/walls.d.mts +54 -57
  234. package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +62 -27
  235. package/src/foundry/client/pixi/perception/detection-mode.d.mts +121 -47
  236. package/src/foundry/client/pixi/perception/fog.d.mts +38 -15
  237. package/src/foundry/client/pixi/perception/perception-manager.d.mts +136 -136
  238. package/src/foundry/client/pixi/perception/vision-mode.d.mts +91 -64
  239. package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +44 -16
  240. package/src/foundry/client/pixi/placeable.d.mts +238 -137
  241. package/src/foundry/client/pixi/placeables/drawing.d.mts +255 -133
  242. package/src/foundry/client/pixi/placeables/index.d.mts +1 -0
  243. package/src/foundry/client/pixi/placeables/light.d.mts +199 -64
  244. package/src/foundry/client/pixi/placeables/note.d.mts +145 -54
  245. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +30 -8
  246. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +41 -11
  247. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +59 -18
  248. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +120 -37
  249. package/src/foundry/client/pixi/placeables/region.d.mts +280 -0
  250. package/src/foundry/client/pixi/placeables/sound.d.mts +205 -66
  251. package/src/foundry/client/pixi/placeables/template.d.mts +181 -100
  252. package/src/foundry/client/pixi/placeables/tile.d.mts +206 -140
  253. package/src/foundry/client/pixi/placeables/token.d.mts +916 -449
  254. package/src/foundry/client/pixi/placeables/wall.d.mts +249 -129
  255. package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +72 -33
  256. package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +10 -9
  257. package/src/foundry/client/pixi/webgl/helpers/{framebugger-snapshot.d.mts → framebuffer-snapshot.d.mts} +10 -9
  258. package/src/foundry/client/pixi/webgl/helpers/index.d.mts +1 -1
  259. package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +38 -23
  260. package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +82 -53
  261. package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +12 -12
  262. package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +45 -28
  263. package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +12 -11
  264. package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +12 -10
  265. package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +22 -20
  266. package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +36 -32
  267. package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +10 -9
  268. package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +12 -11
  269. package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +10 -9
  270. package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +12 -11
  271. package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +67 -60
  272. package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +24 -17
  273. package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +13 -10
  274. package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +10 -9
  275. package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +11 -10
  276. package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +20 -14
  277. package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +12 -11
  278. package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +10 -9
  279. package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +33 -33
  280. package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +10 -9
  281. package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +10 -9
  282. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +19 -17
  283. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +10 -9
  284. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +10 -9
  285. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +10 -9
  286. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +10 -9
  287. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +19 -17
  288. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +19 -17
  289. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +10 -9
  290. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +10 -8
  291. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +19 -17
  292. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +10 -9
  293. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +10 -9
  294. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +10 -9
  295. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +19 -17
  296. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +10 -9
  297. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +10 -9
  298. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +10 -9
  299. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +19 -17
  300. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +20 -17
  301. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +10 -9
  302. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +19 -17
  303. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +10 -9
  304. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +19 -17
  305. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +19 -17
  306. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +19 -17
  307. package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +10 -9
  308. package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +71 -29
  309. package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +54 -10
  310. package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +69 -9
  311. package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +24 -25
  312. package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +10 -9
  313. package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +38 -29
  314. package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +21 -17
  315. package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +10 -9
  316. package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +20 -18
  317. package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +11 -2
  318. package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +28 -2
  319. package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +10 -9
  320. package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +11 -9
  321. package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +10 -9
  322. package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +10 -9
  323. package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +19 -17
  324. package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +10 -9
  325. package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +40 -36
  326. package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +27 -33
  327. package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +17 -16
  328. package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +19 -18
  329. package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +15 -14
  330. package/src/foundry/client/pixi/workers/texture-worker.d.mts +33 -53
  331. package/src/foundry/client/tours/setup-tour.d.mts +15 -10
  332. package/src/foundry/client/ui/context.d.mts +48 -40
  333. package/src/foundry/client/ui/dialog.d.mts +137 -126
  334. package/src/foundry/client/ui/drag.d.mts +1 -1
  335. package/src/foundry/client/ui/dragdrop.d.mts +34 -28
  336. package/src/foundry/client/ui/editor.d.mts +29 -21
  337. package/src/foundry/client/ui/filepicker.d.mts +43 -38
  338. package/src/foundry/client/ui/filter.d.mts +62 -50
  339. package/src/foundry/client/ui/forms.d.mts +22 -22
  340. package/src/foundry/client/ui/notifications.d.mts +10 -3
  341. package/src/foundry/client/ui/prosemirror.d.mts +15 -7
  342. package/src/foundry/client/ui/secrets.d.mts +42 -27
  343. package/src/foundry/client/ui/tabs.d.mts +40 -33
  344. package/src/foundry/client-esm/applications/_module.d.mts +3 -3
  345. package/src/foundry/client-esm/applications/_types.d.mts +0 -2
  346. package/src/foundry/client-esm/applications/api/_module.d.mts +2 -2
  347. package/src/foundry/client-esm/applications/api/application.d.mts +36 -19
  348. package/src/foundry/client-esm/applications/api/dialog.d.mts +20 -22
  349. package/src/foundry/client-esm/applications/api/document-sheet.d.mts +26 -12
  350. package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +142 -126
  351. package/src/foundry/client-esm/applications/apps/_module.d.mts +2 -2
  352. package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +10 -10
  353. package/src/foundry/client-esm/applications/apps/permission-config.d.mts +3 -3
  354. package/src/foundry/client-esm/applications/dice/_module.d.mts +2 -2
  355. package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +14 -2
  356. package/src/foundry/client-esm/applications/elements/_module.d.mts +2 -2
  357. package/src/foundry/client-esm/applications/elements/document-tags.d.mts +2 -0
  358. package/src/foundry/client-esm/applications/elements/file-picker.d.mts +1 -1
  359. package/src/foundry/client-esm/applications/elements/multi-select.d.mts +15 -5
  360. package/src/foundry/client-esm/applications/elements/string-tags.d.mts +1 -1
  361. package/src/foundry/client-esm/applications/forms/fields.d.mts +1 -1
  362. package/src/foundry/client-esm/applications/sheets/_module.d.mts +2 -2
  363. package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +3 -3
  364. package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +10 -8
  365. package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +9 -7
  366. package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +3 -3
  367. package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +30 -5
  368. package/src/foundry/client-esm/applications/sheets/region-config.d.mts +36 -5
  369. package/src/foundry/client-esm/applications/sheets/user-config.d.mts +8 -7
  370. package/src/foundry/client-esm/applications/ui/_module.d.mts +2 -2
  371. package/src/foundry/client-esm/applications/ui/region-legend.d.mts +45 -3
  372. package/src/foundry/client-esm/audio/_module.d.mts +2 -3
  373. package/src/foundry/client-esm/audio/_types.d.mts +2 -0
  374. package/src/foundry/client-esm/audio/biquad.d.mts +76 -26
  375. package/src/foundry/client-esm/audio/cache.d.mts +31 -20
  376. package/src/foundry/client-esm/audio/convolver.d.mts +47 -25
  377. package/src/foundry/client-esm/audio/helper.d.mts +124 -80
  378. package/src/foundry/client-esm/audio/sound.d.mts +230 -126
  379. package/src/foundry/client-esm/audio/timeout.d.mts +28 -12
  380. package/src/foundry/client-esm/canvas/_module.d.mts +2 -2
  381. package/src/foundry/client-esm/canvas/edges/_module.d.mts +2 -2
  382. package/src/foundry/client-esm/canvas/edges/collision.d.mts +69 -18
  383. package/src/foundry/client-esm/canvas/edges/edge.d.mts +110 -41
  384. package/src/foundry/client-esm/canvas/edges/edges.d.mts +10 -0
  385. package/src/foundry/client-esm/canvas/edges/vertex.d.mts +56 -26
  386. package/src/foundry/client-esm/canvas/regions/_module.d.mts +6 -11
  387. package/src/foundry/client-esm/canvas/regions/geometry.d.mts +38 -0
  388. package/src/foundry/client-esm/canvas/regions/mesh.d.mts +72 -0
  389. package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +130 -0
  390. package/src/foundry/client-esm/canvas/regions/shape.d.mts +129 -0
  391. package/src/foundry/client-esm/canvas/scene-manager.d.mts +13 -3
  392. package/src/foundry/client-esm/canvas/smaa/blend.d.mts +14 -3
  393. package/src/foundry/client-esm/canvas/smaa/edges.d.mts +25 -3
  394. package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +121 -23
  395. package/src/foundry/client-esm/canvas/smaa/weights.d.mts +26 -3
  396. package/src/foundry/client-esm/canvas/sources/_module.d.mts +2 -2
  397. package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +84 -40
  398. package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +103 -39
  399. package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +89 -15
  400. package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +71 -27
  401. package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +49 -20
  402. package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +57 -16
  403. package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +31 -4
  404. package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +45 -12
  405. package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +98 -52
  406. package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +180 -69
  407. package/src/foundry/client-esm/canvas/tokens/_module.d.mts +2 -3
  408. package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +175 -2
  409. package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +141 -2
  410. package/src/foundry/client-esm/canvas/tokens/ring.d.mts +284 -2
  411. package/src/foundry/client-esm/client.d.mts +47 -54
  412. package/src/foundry/client-esm/data/_module.d.mts +2 -2
  413. package/src/foundry/client-esm/data/client-backend.d.mts +22 -23
  414. package/src/foundry/client-esm/data/region-behaviors/_module.d.mts +11 -14
  415. package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +57 -0
  416. package/src/foundry/client-esm/data/region-behaviors/base.d.mts +59 -0
  417. package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +64 -0
  418. package/src/foundry/client-esm/data/region-behaviors/execute-macro.d.mts +27 -0
  419. package/src/foundry/client-esm/data/region-behaviors/execute-script.d.mts +23 -0
  420. package/src/foundry/client-esm/data/region-behaviors/pause-game.d.mts +23 -0
  421. package/src/foundry/client-esm/data/region-behaviors/suppress-weather.d.mts +17 -0
  422. package/src/foundry/client-esm/data/region-behaviors/teleport-token.d.mts +32 -0
  423. package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +31 -0
  424. package/src/foundry/client-esm/dice/_module.d.mts +2 -3
  425. package/src/foundry/client-esm/dice/parser.d.mts +11 -25
  426. package/src/foundry/client-esm/dice/roll.d.mts +115 -89
  427. package/src/foundry/client-esm/dice/terms/_module.d.mts +2 -3
  428. package/src/foundry/client-esm/dice/terms/coin.d.mts +8 -5
  429. package/src/foundry/client-esm/dice/terms/dice.d.mts +93 -63
  430. package/src/foundry/client-esm/dice/terms/die.d.mts +11 -4
  431. package/src/foundry/client-esm/dice/terms/fate.d.mts +9 -2
  432. package/src/foundry/client-esm/dice/terms/function.d.mts +18 -18
  433. package/src/foundry/client-esm/dice/terms/numeric.d.mts +3 -5
  434. package/src/foundry/client-esm/dice/terms/operator.d.mts +2 -2
  435. package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +9 -10
  436. package/src/foundry/client-esm/dice/terms/pool.d.mts +25 -31
  437. package/src/foundry/client-esm/dice/terms/string.d.mts +4 -4
  438. package/src/foundry/client-esm/dice/terms/term.d.mts +18 -4
  439. package/src/foundry/client-esm/dice/twister.d.mts +3 -3
  440. package/src/foundry/client-esm/helpers/_module.d.mts +2 -2
  441. package/src/foundry/client-esm/helpers/_types.d.mts +12 -46
  442. package/src/foundry/client-esm/helpers/compendium-art.d.mts +56 -4
  443. package/src/foundry/common/abstract/_types.d.mts +60 -54
  444. package/src/foundry/common/abstract/backend.d.mts +51 -45
  445. package/src/foundry/common/abstract/data.d.mts +132 -154
  446. package/src/foundry/common/abstract/document.d.mts +1306 -438
  447. package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
  448. package/src/foundry/common/abstract/embedded-collection.d.mts +37 -7
  449. package/src/foundry/common/abstract/module.d.mts +3 -2
  450. package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
  451. package/src/foundry/common/abstract/socket.d.mts +1 -1
  452. package/src/foundry/common/abstract/type-data.d.mts +58 -55
  453. package/src/foundry/common/config.d.mts +5 -3
  454. package/src/foundry/common/constants.d.mts +261 -231
  455. package/src/foundry/common/data/data.d.mts +200 -94
  456. package/src/foundry/common/data/fields.d.mts +700 -644
  457. package/src/foundry/common/data/module.d.mts +2 -2
  458. package/src/foundry/common/data/validation-failure.d.mts +12 -9
  459. package/src/foundry/common/documents/_module.d.mts +4 -2
  460. package/src/foundry/common/documents/_types.d.mts +22 -50
  461. package/src/foundry/common/documents/active-effect.d.mts +280 -179
  462. package/src/foundry/common/documents/actor-delta.d.mts +318 -69
  463. package/src/foundry/common/documents/actor.d.mts +305 -117
  464. package/src/foundry/common/documents/adventure.d.mts +266 -141
  465. package/src/foundry/common/documents/ambient-light.d.mts +268 -75
  466. package/src/foundry/common/documents/ambient-sound.d.mts +268 -109
  467. package/src/foundry/common/documents/card.d.mts +267 -174
  468. package/src/foundry/common/documents/cards.d.mts +299 -126
  469. package/src/foundry/common/documents/chat-message.d.mts +276 -158
  470. package/src/foundry/common/documents/combat.d.mts +300 -89
  471. package/src/foundry/common/documents/combatant.d.mts +275 -88
  472. package/src/foundry/common/documents/drawing.d.mts +286 -206
  473. package/src/foundry/common/documents/fog-exploration.d.mts +258 -70
  474. package/src/foundry/common/documents/folder.d.mts +252 -81
  475. package/src/foundry/common/documents/item.d.mts +305 -99
  476. package/src/foundry/common/documents/journal-entry-page.d.mts +279 -189
  477. package/src/foundry/common/documents/journal-entry.d.mts +294 -68
  478. package/src/foundry/common/documents/macro.d.mts +254 -132
  479. package/src/foundry/common/documents/measured-template.d.mts +293 -139
  480. package/src/foundry/common/documents/note.d.mts +274 -149
  481. package/src/foundry/common/documents/playlist-sound.d.mts +260 -94
  482. package/src/foundry/common/documents/playlist.d.mts +279 -120
  483. package/src/foundry/common/documents/region-behavior.d.mts +329 -0
  484. package/src/foundry/common/documents/region.d.mts +327 -0
  485. package/src/foundry/common/documents/roll-table.d.mts +286 -102
  486. package/src/foundry/common/documents/scene.d.mts +276 -336
  487. package/src/foundry/common/documents/setting.d.mts +229 -54
  488. package/src/foundry/common/documents/table-result.d.mts +267 -94
  489. package/src/foundry/common/documents/tile.d.mts +301 -170
  490. package/src/foundry/common/documents/token.d.mts +351 -445
  491. package/src/foundry/common/documents/user.d.mts +256 -144
  492. package/src/foundry/common/documents/wall.d.mts +273 -156
  493. package/src/foundry/common/grid/_module.d.mts +3 -3
  494. package/src/foundry/common/grid/base.d.mts +66 -49
  495. package/src/foundry/common/grid/gridless.d.mts +2 -2
  496. package/src/foundry/common/grid/hexagonal.d.mts +35 -28
  497. package/src/foundry/common/grid/square.d.mts +3 -3
  498. package/src/foundry/common/packages/base-module.d.mts +6 -24
  499. package/src/foundry/common/packages/base-package.d.mts +23 -21
  500. package/src/foundry/common/packages/base-system.d.mts +6 -63
  501. package/src/foundry/common/packages/base-world.d.mts +8 -61
  502. package/src/foundry/common/packages/module.d.mts +7 -7
  503. package/src/foundry/common/packages/sub-types.d.mts +2 -2
  504. package/src/foundry/common/primitives/array.d.mts +4 -4
  505. package/src/foundry/common/primitives/math.d.mts +7 -1
  506. package/src/foundry/common/primitives/number.d.mts +2 -2
  507. package/src/foundry/common/primitives/set.d.mts +17 -14
  508. package/src/foundry/common/primitives/string.d.mts +1 -1
  509. package/src/foundry/common/prosemirror/_module.d.mts +15 -15
  510. package/src/foundry/common/prosemirror/dirty-plugin.d.mts +1 -1
  511. package/src/foundry/common/prosemirror/dom-parser.d.mts +2 -1
  512. package/src/foundry/common/prosemirror/dropdown.d.mts +1 -1
  513. package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +2 -2
  514. package/src/foundry/common/prosemirror/image-plugin.d.mts +1 -1
  515. package/src/foundry/common/prosemirror/menu.d.mts +3 -3
  516. package/src/foundry/common/prosemirror/paste-transformer.d.mts +1 -1
  517. package/src/foundry/common/prosemirror/plugin.d.mts +2 -2
  518. package/src/foundry/common/prosemirror/schema/index.d.mts +0 -1
  519. package/src/foundry/common/prosemirror/schema/lists.d.mts +2 -0
  520. package/src/foundry/common/prosemirror/util.d.mts +1 -1
  521. package/src/foundry/common/types.d.mts +3 -3
  522. package/src/foundry/common/utils/bitmask.d.mts +23 -11
  523. package/src/foundry/common/utils/collection.d.mts +61 -38
  524. package/src/foundry/common/utils/color.d.mts +20 -2
  525. package/src/foundry/common/utils/event-emitter.d.mts +32 -17
  526. package/src/foundry/common/utils/helpers.d.mts +36 -26
  527. package/src/foundry/common/utils/http.d.mts +2 -2
  528. package/src/foundry/common/utils/module.d.mts +2 -2
  529. package/src/foundry/common/utils/string-tree.d.mts +45 -39
  530. package/src/foundry/common/utils/word-tree.d.mts +10 -23
  531. package/src/foundry/index.d.mts +0 -1
  532. package/src/foundry/{clipper → public/scripts/clipper}/clipper.d.mts +58 -16
  533. package/src/foundry/public/scripts/index.d.mts +1 -0
  534. package/src/foundry/public/scripts/workers/image-compressor.d.mts +23 -0
  535. package/src/foundry/public/scripts/workers/index.d.mts +1 -0
  536. package/{index-lenient.d.mts → src/index-lenient.d.mts} +2 -0
  537. package/src/index.d.mts +6 -0
  538. package/src/tsconfig.json +15 -0
  539. package/src/types/augments/particles.d.mts +29 -0
  540. package/src/types/augments/pixi.d.mts +1024 -21
  541. package/src/types/augments/smooth.d.mts +31 -0
  542. package/src/types/augments/tinyMCE.d.mts +1 -1
  543. package/src/types/config.d.mts +20 -312
  544. package/src/types/documentConfiguration.d.mts +286 -542
  545. package/src/types/index.d.mts +1 -1
  546. package/src/types/lib.d.mts +12 -0
  547. package/src/types/workers/image-compressor.d.mts +176 -0
  548. package/src/utils/index.d.mts +1279 -0
  549. package/tsconfig.json +29 -0
  550. package/tsconfig.main.json +8 -0
  551. package/tsconfig.miscellaneous.json +16 -0
  552. package/index.d.mts +0 -5
  553. package/src/foundry/client/apps/placeables/light-config.d.mts +0 -100
  554. package/src/foundry/client/apps/placeables/sound-config.d.mts +0 -43
  555. package/src/foundry/common/documents/module.d.mts +0 -35
  556. package/src/foundry/common/primitives/regex.d.mts +0 -12
  557. package/src/types/helperTypes.d.mts +0 -583
  558. package/src/types/utils.d.mts +0 -539
  559. /package/src/foundry/{clipper → public/scripts/clipper}/index.d.mts +0 -0
@@ -23,7 +23,7 @@ export declare function serializeHTMLString(
23
23
  options?: {
24
24
  /** The ProseMirror schema to use instead of the default one. */
25
25
  schema?: Schema;
26
- /** The number of spaces to use for indentation. See {@link StringNode#toString} for details. */
26
+ /** The number of spaces to use for indentation. See {@link StringNode.toString | `StringNode#toString`} for details. */
27
27
  spaces?: string | number;
28
28
  },
29
29
  ): string;
@@ -1,4 +1,4 @@
1
- import type { AnyConcreteConstructor, AnyConstructor, AnyFunction } from "../../types/utils.d.mts";
1
+ import type { AnyConcreteConstructor, AnyConstructor, AnyFunction } from "fvtt-types/utils";
2
2
  import type { Document } from "./abstract/module.d.mts";
3
3
 
4
4
  // After seeing that none of these types add anything or are even exported a
@@ -39,13 +39,13 @@ type DeepReadonly<T> = Readonly<{
39
39
  /**
40
40
  * A class constructor.
41
41
  * Used for functions with generic class constructor parameters.
42
- * @privateRemarks We have better tools like {@link AnyConcreteConstructor} and {@link AnyConstructor}
42
+ * @privateRemarks We have better tools like {@link AnyConcreteConstructor | `AnyConcreteConstructor`} and {@link AnyConstructor | `AnyConstructor`}
43
43
  */
44
44
  type Constructor = new (...args: any[]) => any;
45
45
 
46
46
  type Point = Canvas.Point;
47
47
 
48
- type PointArray = Canvas.PointArray;
48
+ type PointArray = Canvas.PointTuple;
49
49
 
50
50
  type Rectangle = Canvas.Rectangle;
51
51
 
@@ -1,9 +1,11 @@
1
- export default class BitMask extends Number {
1
+ import type { Identity } from "fvtt-types/utils";
2
+
3
+ declare class InternalBitMask<T extends Record<string, boolean>> extends Number {
2
4
  /**
3
5
  * Create a new BitMask instance.
4
6
  * @param states - An object containing valid states and their corresponding initial boolean values (default is null).
5
7
  */
6
- constructor(states?: Record<string, boolean> | null);
8
+ constructor(states?: T | null);
7
9
 
8
10
  // a placeholder private method to help subclassing
9
11
  #bitmask: true;
@@ -12,7 +14,7 @@ export default class BitMask extends Number {
12
14
  * The enum associated with this structure.
13
15
  * @readonly
14
16
  */
15
- states: Record<string, string>;
17
+ states: Readonly<{ [K in keyof T]: K }>;
16
18
 
17
19
  /**
18
20
  * True if this bitmask is empty (no active states).
@@ -24,33 +26,33 @@ export default class BitMask extends Number {
24
26
  * @param state - The state to check.
25
27
  * @returns True if the state is active, false otherwise.
26
28
  */
27
- hasState(state: string): boolean;
29
+ hasState(state: keyof T): boolean;
28
30
 
29
31
  /**
30
32
  * Add a state to the bitmask.
31
33
  * @param state - The state to add. Throws an error if the provided state is not valid.
32
34
  */
33
- addState(state: string): void;
35
+ addState(state: keyof T): void;
34
36
 
35
37
  /**
36
38
  * Remove a state from the bitmask.
37
39
  * @param state - The state to remove. Throws an error if the provided state is not valid.
38
40
  */
39
- removeState(state: string): void;
41
+ removeState(state: keyof T): void;
40
42
 
41
43
  /**
42
44
  * Toggle the state of a specific state in the bitmask.
43
45
  * @param state - The state to toggle. Throws an error if the provided state is not valid.
44
46
  * @param enabled - Toggle on (true) or off (false)? If undefined, the state is switched automatically.
45
47
  */
46
- toggleState(state: string, enabled: boolean): void;
48
+ toggleState(state: keyof T, enabled: boolean): void;
47
49
 
48
50
  /**
49
51
  * Toggle the state of a specific state in the bitmask.
50
52
  * @param state - The state to toggle.
51
53
  * @returns The updated bitmask. Throws an error if the provided state is not valid.
52
54
  */
53
- toggleState(state: string): number;
55
+ toggleState(state: keyof T): number;
54
56
 
55
57
  /**
56
58
  * Clear the bitmask, setting all states to inactive.
@@ -74,7 +76,7 @@ export default class BitMask extends Number {
74
76
  * @param otherBitMask - The bitmask structure to compare with.
75
77
  * @returns True if the two bitmasks have the same structure, false otherwise.
76
78
  */
77
- isCompatible(otherBitMask: BitMask): boolean;
79
+ isCompatible(otherBitMask: BitMask.Any): boolean;
78
80
 
79
81
  /**
80
82
  * Serializes the bitmask to a JSON string.
@@ -87,7 +89,7 @@ export default class BitMask extends Number {
87
89
  * @param jsonString - The JSON string representing the bitmask.
88
90
  * @returns A new BitMask instance created from the JSON string.
89
91
  */
90
- static fromJSON(jsonString: string): BitMask;
92
+ static fromJSON(jsonString: string): BitMask.Any;
91
93
 
92
94
  /**
93
95
  * Convert value of this BitMask to object representation according to structure.
@@ -99,7 +101,7 @@ export default class BitMask extends Number {
99
101
  * Creates a clone of this BitMask instance.
100
102
  * @returns A new BitMask instance with the same value and valid states as this instance.
101
103
  */
102
- clone(): BitMask;
104
+ clone(): this;
103
105
 
104
106
  /**
105
107
  * Generates shader constants based on the provided states.
@@ -108,3 +110,13 @@ export default class BitMask extends Number {
108
110
  */
109
111
  static generateShaderBitMaskConstants(states: string[]): string;
110
112
  }
113
+
114
+ declare namespace BitMask {
115
+ interface Any extends InternalBitMask<Record<string, boolean>> {}
116
+ interface AnyConstructor extends Identity<typeof BitMask> {}
117
+ }
118
+
119
+ declare const BitMask: typeof InternalBitMask & (new (...args: any) => number);
120
+ type BitMask = BitMask.Any & number;
121
+
122
+ export default BitMask;
@@ -1,31 +1,21 @@
1
- interface MapReplacementMembers<K, V> {
2
- set(key: K, value: V): this;
3
- }
4
-
5
- type PatchedMap<K, V> = Omit<Map<K, V>, "forEach" | typeof Symbol.iterator | "get" | "set"> &
6
- MapReplacementMembers<K, V>;
1
+ // This class exists make it as sound as possible to override these parts of the class and make them
7
2
 
8
- declare namespace PatchedMap {
9
- type Any = PatchedMap<any, any>;
10
- }
3
+ import type { AnyArray, Identity } from "fvtt-types/utils";
11
4
 
12
- interface PatchedMapConstructor {
13
- new (): PatchedMap.Any;
14
- new <K, V>(entries?: readonly (readonly [K, V])[] | null): PatchedMap<K, V>;
15
- new <K, V>(iterable: Iterable<readonly [K, V]>): PatchedMap<K, V>;
16
- readonly [Symbol.species]: PatchedMapConstructor;
17
- readonly prototype: PatchedMap.Any;
5
+ // completely unrelated. It's done this way specifically to avoid situations with broken inheritance.
6
+ declare class Map<K, V> extends globalThis.Map<K, V> {
7
+ [Symbol.iterator](): any;
8
+ forEach(...args: AnyArray): any;
9
+ get(...args: AnyArray): any;
18
10
  }
19
11
 
20
- declare const Map: PatchedMapConstructor;
21
-
22
12
  /**
23
13
  * A reusable storage concept which blends the functionality of an Array with the efficient key-based lookup of a Map.
24
14
  * This concept is reused throughout Foundry VTT where a collection of uniquely identified elements is required.
25
15
  * @typeParam T - The type of the objects contained in the Collection
26
16
  */
27
- declare class Collection<V> extends Map<string, V> {
28
- constructor(entries?: readonly (readonly [string, V])[] | null);
17
+ declare class Collection<V, Methods extends Collection.Methods.Any = Collection.Methods<V>> extends Map<string, V> {
18
+ constructor(entries?: Iterable<readonly [string, V]> | null);
29
19
 
30
20
  /**
31
21
  * When iterating over a Collection, we should iterate over its values instead of over its entries
@@ -39,7 +29,7 @@ declare class Collection<V> extends Map<string, V> {
39
29
 
40
30
  /**
41
31
  * Find an entry in the Map using an functional condition.
42
- * @see {@link Array#find}
32
+ * @see {@link Array.find | `Array#find`}
43
33
  *
44
34
  * @param condition - The functional condition to test. Positional arguments are the value, the index of
45
35
  * iteration, and the collection being searched.
@@ -51,12 +41,14 @@ declare class Collection<V> extends Map<string, V> {
51
41
  * c.get("a") === c.find(entry => entry === "A"); // true
52
42
  * ```
53
43
  */
54
- find<S extends V>(condition: (e: V, index: number, collection: Collection<V>) => e is S): S | undefined;
55
- find(condition: (e: V, index: number, collection: Collection<V>) => boolean): V | undefined;
44
+ find<S extends V>(
45
+ /** @immediate */ condition: (e: V, index: number, collection: Collection<V>) => e is S,
46
+ ): S | undefined;
47
+ find(/** @immediate */ condition: (e: V, index: number, collection: Collection<V>) => boolean): V | undefined;
56
48
 
57
49
  /**
58
50
  * Filter the Collection, returning an Array of entries which match a functional condition.
59
- * @see {@link Array#filter}
51
+ * @see {@link Array.filter | `Array#filter`}
60
52
  *
61
53
  * @param condition - The functional condition to test. Positional arguments are the value, the
62
54
  * index of iteration, and the collection being filtered.
@@ -68,12 +60,12 @@ declare class Collection<V> extends Map<string, V> {
68
60
  * let hasA = c.filters(entry => entry.slice(0) === "A");
69
61
  * ```
70
62
  */
71
- filter<S extends V>(condition: (e: V, index: number, collection: Collection<V>) => e is S): S[];
72
- filter(condition: (e: V, index: number, collection: Collection<V>) => boolean): V[];
63
+ filter<S extends V>(/** @immediate */ condition: (e: V, index: number, collection: Collection<V>) => e is S): S[];
64
+ filter(/** @immediate */ condition: (e: V, index: number, collection: Collection<V>) => boolean): V[];
73
65
 
74
66
  /**
75
67
  * Apply a function to each element of the collection
76
- * @see Array#forEach
68
+ * @see {@link Array.forEach | `Array#forEach`}
77
69
  * @param fn - The function to apply to each element
78
70
  *
79
71
  * @example Apply a function to each value in the collection
@@ -82,7 +74,7 @@ declare class Collection<V> extends Map<string, V> {
82
74
  * c.forEach(e => e.active = true);
83
75
  * ```
84
76
  */
85
- forEach(fn: (e: V) => void): void;
77
+ forEach(/** @immediate */ fn: (e: V) => void): void;
86
78
 
87
79
  /**
88
80
  * Get an element from the Collection by its key.
@@ -99,8 +91,7 @@ declare class Collection<V> extends Map<string, V> {
99
91
  * c.get("d", {strict: true}); // throws Error
100
92
  * ```
101
93
  */
102
- get(key: string, { strict }: { strict: true }): V;
103
- get(key: string, { strict }?: { strict?: false }): V | undefined;
94
+ get: Methods["get"];
104
95
 
105
96
  /**
106
97
  * Get an entry from the Collection by name.
@@ -128,11 +119,11 @@ declare class Collection<V> extends Map<string, V> {
128
119
  * @typeParam M - The type of the mapped values
129
120
  * @returns An Array of transformed values
130
121
  */
131
- map<M>(transformer: (entity: V, index: number, collection: Collection<V>) => M): M[];
122
+ map<M>(/** @immediate */ transformer: (entity: V, index: number, collection: Collection<V>) => M): M[];
132
123
 
133
124
  /**
134
125
  * Reduce the Collection by applying an evaluator function and accumulating entries
135
- * @see {@link Array#reduce}
126
+ * @see {@link Array.reduce | `Array#reduce`}
136
127
  * @param reducer - A reducer function applied to each entry value. Positional arguments are the accumulator, the
137
128
  * value, the index of iteration, and the collection being reduced.
138
129
  * @param initial - An initial value which accumulates with each iteration
@@ -147,30 +138,62 @@ declare class Collection<V> extends Map<string, V> {
147
138
  * }, ""); // "ABC"
148
139
  * ```
149
140
  */
150
- reduce<A>(evaluator: (accumulator: A, entity: V, index: number, collection: Collection<V>) => A, initial: A): A;
141
+ reduce<A>(
142
+ /** @immediate */ evaluator: (accumulator: A, entity: V, index: number, collection: Collection<V>) => A,
143
+ initial: A,
144
+ ): A;
151
145
 
152
146
  /**
153
147
  * Test whether a condition is met by some entry in the Collection.
154
- * @see Array#some
148
+ * @see {@link Array.some | `Array#some`}
155
149
  * @param condition - The functional condition to test. Positional arguments are the value, the index of iteration,
156
150
  * and the collection being tested.
157
151
  * @returns Was the test condition passed by at least one entry?
158
152
  */
159
- some(condition: (e: V, index: number, collection: Collection<V>) => boolean): boolean;
153
+ some(/** @immediate */ condition: (e: V, index: number, collection: Collection<V>) => boolean): boolean;
160
154
 
161
155
  /**
162
156
  * Convert the Collection to a primitive array of its contents.
163
157
  * @returns An array of contained values
164
158
  */
165
- toJSON(): Array<V extends { toJSON: (...args: any[]) => infer U } ? U : V>;
159
+ toJSON(): Array<V extends { toJSON: (...args: infer _1) => infer U } ? U : V>;
166
160
  }
167
161
 
168
162
  declare namespace Collection {
169
- type AnyConstructor = typeof AnyCollection;
163
+ interface Any extends AnyCollection {}
164
+ interface AnyConstructor extends Identity<typeof AnyCollection> {}
165
+
166
+ interface GetOptions {
167
+ /**
168
+ * Throw an Error if the requested Embedded Document does not exist.
169
+ * @defaultValue `false`
170
+ */
171
+ strict?: boolean | undefined;
172
+ }
173
+
174
+ interface Methods<V> {
175
+ get<Options extends DocumentCollection.GetOptions>(
176
+ key: string,
177
+ { strict }?: Options,
178
+ ): Collection.GetReturnType<V, Options>;
179
+ }
180
+
181
+ namespace Methods {
182
+ interface Any {
183
+ get(key: string, options?: never): unknown;
184
+ }
185
+ }
186
+
187
+ type GetReturnType<T, Options extends GetOptions> = _ApplyStrict<T, Options["strict"]>;
188
+
189
+ /** @internal */
190
+ type _ApplyStrict<ConcreteDocument, Strict extends boolean | undefined> =
191
+ | (Strict extends false | undefined ? undefined : never)
192
+ | ConcreteDocument;
170
193
  }
171
194
 
172
- declare abstract class AnyCollection extends Collection<any> {
173
- constructor(arg0: never, ...args: never[]);
195
+ declare abstract class AnyCollection extends Collection<unknown, Collection.Methods.Any> {
196
+ constructor(...args: never);
174
197
  }
175
198
 
176
199
  export default Collection;
@@ -1,10 +1,15 @@
1
1
  export default Color;
2
+
3
+ // `Color#fromString` breaks inheritance
4
+ declare class PatchedNumber extends Number {
5
+ static fromString(color: string): any;
6
+ }
7
+
2
8
  /**
3
9
  * A representation of a color in hexadecimal format.
4
10
  * This class provides methods for transformations and manipulations of colors.
5
11
  */
6
- // @ts-expect-error 2417: Override of Color.fromString does not match Number.fromString
7
- declare class Color extends Number {
12
+ declare class InternalColor extends PatchedNumber {
8
13
  /**
9
14
  * Is this a valid color?
10
15
  */
@@ -263,6 +268,15 @@ declare class Color extends Number {
263
268
  */
264
269
  static fromRGB(rgb: Color.RGBColorVector): Color;
265
270
 
271
+ /**
272
+ * Create a Color instance from an RGB normalized values.
273
+ * @param r - The red value
274
+ * @param g - The green value
275
+ * @param b - The blue value
276
+ * @returns The hex color instance
277
+ */
278
+ static fromRGBvalues(r: number, g: number, b: number): Color;
279
+
266
280
  /**
267
281
  * Create a Color instance from an HSV array.
268
282
  * Conversion formula adapted from {@link http://en.wikipedia.org/wiki/HSV_color_space}.
@@ -290,8 +304,12 @@ declare class Color extends Number {
290
304
  static fromLinearRGB(linear: Color.RGBColorVector): Color;
291
305
  }
292
306
 
307
+ declare const Color: typeof InternalColor & (new (...args: any) => number);
308
+ type Color = InternalColor & number;
309
+
293
310
  declare namespace Color {
294
311
  type RGBColorVector = [r: number, g: number, b: number];
312
+ type RGBAColorVector = [r: number, g: number, b: number, a: number];
295
313
  type HSVColorVector = [h: number, s: number, v: number];
296
314
  type HSLColorVector = [h: number, s: number, l: number];
297
315
 
@@ -1,12 +1,14 @@
1
- import type { InexactPartial, Mixin } from "../../../types/utils.d.mts";
1
+ import type { AnyConstructor, FixedInstanceType, Mixin, NullishProps } from "fvtt-types/utils";
2
2
 
3
3
  /**
4
4
  * A mixin class which implements the behavior of EventTarget.
5
5
  * This is useful in cases where a class wants EventTarget-like behavior but needs to extend some other class.
6
- * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget
6
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget}
7
7
  */
8
+ // ESLint doesn't like this class "only being used as a type"
9
+ // eslint-disable-next-line @typescript-eslint/no-unused-vars
8
10
  declare class EventEmitter {
9
- /** @privateRemarks All mixin classses should accept anything for its constructor. */
11
+ /** @privateRemarks All mixin classes should accept anything for its constructor. */
10
12
  constructor(...args: any[]);
11
13
 
12
14
  /**
@@ -16,21 +18,16 @@ declare class EventEmitter {
16
18
 
17
19
  /**
18
20
  * Add a new event listener for a certain type of event.
19
- * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener
21
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/addEventListener}
20
22
  * @param type - The type of event being registered for
21
23
  * @param listener - The listener function called when the event occurs
22
24
  * @param options - Options which configure the event listener
23
25
  */
26
+ // options: not null (destructured)
24
27
  addEventListener(
25
28
  type: string,
26
- listener: EventEmitter.EmittedEventListener,
27
- options?: InexactPartial<{
28
- /**
29
- * Should the event only be responded to once and then removed
30
- * @defaultValue `false`
31
- */
32
- once: boolean;
33
- }>,
29
+ listener: EventEmitterMixin.EventListener,
30
+ options?: EventEmitterMixin.AddListenerOptions,
34
31
  ): void;
35
32
 
36
33
  /**
@@ -38,25 +35,43 @@ declare class EventEmitter {
38
35
  * @param type - The type of event being removed
39
36
  * @param listener - The listener function being removed
40
37
  */
41
- removeEventListener(type: string, listener: EventEmitter.EmittedEventListener): void;
38
+ removeEventListener(type: string, listener: EventEmitterMixin.EventListener): void;
42
39
 
43
40
  /**
44
41
  * Dispatch an event on this target.
45
- * @see https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent
42
+ * @see {@link https://developer.mozilla.org/en-US/docs/Web/API/EventTarget/dispatchEvent}
46
43
  * @param event - The Event to dispatch
47
44
  * @returns Was default behavior for the event prevented?
48
45
  */
49
46
  dispatchEvent(event: Event): boolean;
50
47
  }
51
48
 
52
- declare namespace EventEmitter {
53
- type EmittedEventListener = (event: Event) => void;
49
+ declare namespace EventEmitterMixin {
50
+ interface AnyMixedConstructor extends ReturnType<typeof EventEmitterMixin<BaseClass>> {}
51
+ interface AnyMixed extends FixedInstanceType<AnyMixedConstructor> {}
52
+
53
+ type BaseClass = AnyConstructor;
54
+
55
+ /** @internal */
56
+ type _AddListenerOptions = NullishProps<{
57
+ /**
58
+ * Should the event only be responded to once and then removed
59
+ * @defaultValue `false`
60
+ */
61
+ once: boolean;
62
+ }>;
63
+
64
+ interface AddListenerOptions extends _AddListenerOptions {}
65
+
66
+ type EventListener = (event: Event) => void;
54
67
  }
55
68
 
56
69
  /**
57
70
  * Augment a base class with EventEmitter behavior.
58
71
  * @param BaseClass - Some base class augmented with event emitter functionality
59
72
  */
60
- export default function EventEmitterMixin<ExtendedClass extends abstract new (...args: any[]) => any>(
73
+ declare function EventEmitterMixin<ExtendedClass extends EventEmitterMixin.BaseClass>(
61
74
  BaseClass: ExtendedClass,
62
75
  ): Mixin<typeof EventEmitter, ExtendedClass>;
76
+
77
+ export default EventEmitterMixin;
@@ -1,4 +1,4 @@
1
- import type { AnyConstructor, AnyFunction, DeepPartial, InexactPartial } from "../../../types/utils.d.mts";
1
+ import type { AnyConstructor, AnyFunction, DeepPartial, InexactPartial, NonNullish } from "fvtt-types/utils";
2
2
  import type Document from "../abstract/document.d.mts";
3
3
 
4
4
  /**
@@ -48,7 +48,7 @@ export interface DeepCloneOptions {
48
48
  strict?: boolean;
49
49
  /**
50
50
  * An internal depth tracker
51
- * @defaultValue 0
51
+ * @defaultValue `0`
52
52
  */
53
53
  _d?: number;
54
54
  }
@@ -80,7 +80,7 @@ export type DiffObjectOptions = InexactPartial<{
80
80
 
81
81
  /**
82
82
  * An internal depth tracker
83
- * @defaultValue 0
83
+ * @defaultValue `0`
84
84
  */
85
85
  _d?: number;
86
86
  }>;
@@ -113,7 +113,7 @@ export function objectsEqual<B extends object>(a: object, b: B): a is B;
113
113
  export function duplicate<T>(original: T): Duplicated<T>;
114
114
 
115
115
  /**
116
- * The resulting type when using {@link duplicate} on some data of type `T`.
116
+ * The resulting type when using {@link duplicate | `duplicate`} on some data of type `T`.
117
117
  *
118
118
  * @typeParam T - Original type.
119
119
  * @internal
@@ -273,8 +273,15 @@ export function getProperty(object: object, key: string): any;
273
273
  */
274
274
  export function setProperty(object: object, key: string, value: any): boolean;
275
275
 
276
- export type InvertableObject = Record<string | number | symbol, string | number | symbol>;
277
- export type InvertObject<in out T extends InvertableObject> = { [Key in keyof T as T[Key]]: Key };
276
+ // Merging into this would be antithetical to its purpose.
277
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
278
+ export type InvertableObject = {
279
+ readonly [K: PropertyKey]: PropertyKey;
280
+ };
281
+
282
+ export type InvertObject<in out T extends InvertableObject> = {
283
+ [K in keyof T as T[K]]: K;
284
+ };
278
285
 
279
286
  /**
280
287
  * Invert an object by assigning its values as keys and its keys as values.
@@ -297,7 +304,10 @@ export function isNewerVersion(v1: number | string, v0: number | string): boolea
297
304
  * @param value - The value to test
298
305
  * @returns Is the value empty-like?
299
306
  */
300
- export function isEmpty(value: undefined | null | unknown[] | object | Set<unknown> | Map<unknown, unknown>): boolean;
307
+
308
+ export function isEmpty(
309
+ value: undefined | null | unknown[] | object | Set<unknown> | Map<unknown, unknown> | NonNullish,
310
+ ): boolean;
301
311
 
302
312
  export type MergeObject<T, U, M extends MergeObjectOptions> = UpdateInsert<
303
313
  DeleteByObjectKeys<T, U, M>,
@@ -406,7 +416,7 @@ export interface MergeObjectOptions {
406
416
  * Control whether to perform deletions on the original object if deletion keys are present in the other object.
407
417
  * @defaultValue `false`
408
418
  */
409
- performDeletions?: boolean | undefined; //TODO: implement this in the mergeObject return type
419
+ performDeletions?: boolean | undefined; // TODO: implement this in the mergeObject return type
410
420
  }
411
421
 
412
422
  /**
@@ -415,7 +425,7 @@ export interface MergeObjectOptions {
415
425
  */
416
426
  declare function _mergeInsert(
417
427
  original: object,
418
- k: string | number | symbol,
428
+ k: PropertyKey,
419
429
  v: any,
420
430
  options?: Pick<MergeObjectOptions, "insertKeys" | "insertValues" | "performDeletions">,
421
431
  _d?: number,
@@ -463,7 +473,7 @@ export function timeSince(timeStamp: Date | string): string;
463
473
  * @param options - Additional options. (default: `{}`)
464
474
  * @returns
465
475
  */
466
- export function formatFileSize(size: number, options: FormatFileSizeOptions): string;
476
+ export function formatFileSize(size: number, options?: FormatFileSizeOptions): string;
467
477
 
468
478
  interface FormatFileSizeOptions {
469
479
  /**
@@ -488,7 +498,7 @@ interface ResolvedUUID {
488
498
  /**
489
499
  * The type of Document referenced. Legacy compendium UUIDs will not populate this field if the compendium is not active in the World.
490
500
  */
491
- type?: Document.Type;
501
+ type?: Document.Type | undefined;
492
502
 
493
503
  /**
494
504
  * The ID of the Document referenced.
@@ -498,17 +508,17 @@ interface ResolvedUUID {
498
508
  /**
499
509
  * The primary Document type of this UUID. Only present if the Document is embedded.
500
510
  */
501
- primaryType?: foundry.CONST.PRIMARY_DOCUMENT_TYPES;
511
+ primaryType?: foundry.CONST.PRIMARY_DOCUMENT_TYPES | undefined;
502
512
 
503
513
  /**
504
514
  * The primary Document ID of this UUID. Only present if the Document is embedded.
505
515
  */
506
- primaryId?: string;
516
+ primaryId?: string | undefined;
507
517
 
508
518
  /**
509
519
  * The collection that the primary Document belongs to.
510
520
  */
511
- collection?: DocumentCollection.Any;
521
+ collection?: DocumentCollection.Any | undefined;
512
522
 
513
523
  /**
514
524
  * Additional Embedded Document parts.
@@ -518,17 +528,17 @@ interface ResolvedUUID {
518
528
  /**
519
529
  * An already-resolved parent Document.
520
530
  */
521
- doc?: Document.Any;
531
+ doc?: Document.Any | undefined;
522
532
 
523
533
  /**
524
534
  * Either the document type or the parent type. Retained for backwards compatibility.
525
535
  */
526
- documentType?: DocumentType;
536
+ documentType?: Document.Type | undefined;
527
537
 
528
538
  /**
529
539
  * Either the document id or the parent id. Retained for backwards compatibility.
530
540
  */
531
- documentId?: string;
541
+ documentId?: string | undefined;
532
542
  }
533
543
 
534
544
  interface ParseUUIDOptions {
@@ -570,7 +580,7 @@ declare function _resolveRelativeUuid(uuid: string, relative: Document.Any): Res
570
580
  * @param g - The green color value
571
581
  * @param b - The blue color value
572
582
  * @returns The HSV representation
573
- * @deprecated since v10 until v12, rgbToHsv is deprecated in favor of {@link foundry.utils.Color#hsv}
583
+ * @deprecated since v10 until v12, rgbToHsv is deprecated in favor of {@link foundry.utils.Color.hsv | `foundry.utils.Color#hsv`}
574
584
  */
575
585
  export function rgbToHsv(r: number, g: number, b: number): [h: number, s: number, v: number];
576
586
 
@@ -581,7 +591,7 @@ export function rgbToHsv(r: number, g: number, b: number): [h: number, s: number
581
591
  * @param s - The saturation
582
592
  * @param v - The value
583
593
  * @returns The RGB representation
584
- * @deprecated since v10 until v12, hsvToRgb is deprecated in favor of {@link foundry.utils.Color.fromHSV}
594
+ * @deprecated since v10 until v12, hsvToRgb is deprecated in favor of {@link foundry.utils.Color.fromHSV | `foundry.utils.Color.fromHSV`}
585
595
  */
586
596
  export function hsvToRgb(h: number, s: number, v: number): [r: number, g: number, b: number];
587
597
 
@@ -589,7 +599,7 @@ export function hsvToRgb(h: number, s: number, v: number): [r: number, g: number
589
599
  * Converts a color as an [R, G, B] array of normalized floats to a hexadecimal number.
590
600
  * @param rgb - Array of numbers where all values are normalized floats from 0.0 to 1.0.
591
601
  * @returns The numeric color as hexadecimal
592
- * @deprecated since v10 until v12, rgbToHex is deprecated in favor of {@link foundry.utils.Color.fromRGB}
602
+ * @deprecated since v10 until v12, rgbToHex is deprecated in favor of {@link foundry.utils.Color.fromRGB | `foundry.utils.Color.fromRGB`}
593
603
  */
594
604
  export function rgbToHex(rgb: [r: number, g: number, b: number]): number;
595
605
 
@@ -597,7 +607,7 @@ export function rgbToHex(rgb: [r: number, g: number, b: number]): number;
597
607
  * Convert a hex color code to an RGB array
598
608
  * @param hex - A hex color number
599
609
  * @returns An array of [r,g,b] colors normalized on the range of [0,1]
600
- * @deprecated since v10 until v12, hexToRGB is deprecated in favor of {@link foundry.utils.Color#rgb}
610
+ * @deprecated since v10 until v12, hexToRGB is deprecated in favor of {@link foundry.utils.Color.rgb | `foundry.utils.Color#rgb`}
601
611
  */
602
612
  export function hexToRGB(hex: number): [r: number, g: number, b: number];
603
613
 
@@ -607,7 +617,7 @@ export function hexToRGB(hex: number): [r: number, g: number, b: number];
607
617
  * @param alpha - An optional level of transparency
608
618
  * (default: `1.0`)
609
619
  * @returns An rgba style string
610
- * @deprecated since v10 until v12, hexToRGBAString is deprecated in favor of {@link foundry.utils.Color#toRGBA}
620
+ * @deprecated since v10 until v12, hexToRGBAString is deprecated in favor of {@link foundry.utils.Color.toRGBA | `foundry.utils.Color#toRGBA`}
611
621
  */
612
622
  export function hexToRGBAString(hex: number, alpha?: number): `rgba(${number}, ${number}, ${number})`;
613
623
 
@@ -615,19 +625,19 @@ export function hexToRGBAString(hex: number, alpha?: number): `rgba(${number}, $
615
625
  * Convert a string color to a hex integer
616
626
  * @param color - The string color
617
627
  * @returns The hexadecimal color code
618
- * @deprecated since v10 until v12, colorStringToHex is deprecated in favor of {@link foundry.utils.Color.from}
628
+ * @deprecated since v10 until v12, colorStringToHex is deprecated in favor of {@link foundry.utils.Color.from | `foundry.utils.Color.from`}
619
629
  */
620
630
  export function colorStringToHex(color: string): number | null;
621
631
 
622
632
  /**
623
- * Internal Helper for {@link Duplicated}. A union type of all types that do not have a JSON representation.
633
+ * Internal Helper for {@link Duplicated | `Duplicated`}. A union type of all types that do not have a JSON representation.
624
634
  *
625
635
  * @internal
626
636
  */
627
637
  type NonStringifiable = undefined | AnyFunction | AnyConstructor | symbol;
628
638
 
629
639
  /**
630
- * Internal helper for {@link InnerDuplicated}. Maps the properties of `T` to their duplicated types.
640
+ * Internal helper for {@link InnerDuplicated | `InnerDuplicated`}. Maps the properties of `T` to their duplicated types.
631
641
  *
632
642
  * @typeParam T - The object type that should have its properties mapped.
633
643
  * @internal
@@ -644,7 +654,7 @@ type MapToInnerDuplicated<T extends object> = { [k in keyof T]: InnerDuplicated<
644
654
  type OmitOfType<T extends object, U> = { [k in keyof T as T[k] extends U ? never : k]: T[k] };
645
655
 
646
656
  /**
647
- * Internal helper type for {@link Duplicated}. It is the main part of the implementation, which does the recursion.
657
+ * Internal helper type for {@link Duplicated | `Duplicated`}. It is the main part of the implementation, which does the recursion.
648
658
  *
649
659
  * @typeParam T - Type currently being converted.
650
660
  * @internal