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

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 (377) hide show
  1. package/package.json +18 -1
  2. package/src/configuration/configuration.d.mts +1 -1
  3. package/src/foundry/client/apps/app.d.mts +1 -1
  4. package/src/foundry/client/apps/av/av-config.d.mts +1 -1
  5. package/src/foundry/client/apps/av/cameras.d.mts +1 -1
  6. package/src/foundry/client/apps/dice/dice-config.d.mts +1 -1
  7. package/src/foundry/client/apps/form.d.mts +1 -1
  8. package/src/foundry/client/apps/forms/actor.d.mts +1 -1
  9. package/src/foundry/client/apps/forms/adventure-exporter.d.mts +1 -1
  10. package/src/foundry/client/apps/forms/adventure-importer.d.mts +1 -1
  11. package/src/foundry/client/apps/forms/base-sheet.d.mts +1 -1
  12. package/src/foundry/client/apps/forms/card-config.d.mts +1 -1
  13. package/src/foundry/client/apps/forms/cards-config.d.mts +1 -1
  14. package/src/foundry/client/apps/forms/combat-config.d.mts +1 -1
  15. package/src/foundry/client/apps/forms/effect-config.d.mts +1 -1
  16. package/src/foundry/client/apps/forms/folder-config.d.mts +7 -2
  17. package/src/foundry/client/apps/forms/fonts.d.mts +1 -1
  18. package/src/foundry/client/apps/forms/grid-config.d.mts +1 -1
  19. package/src/foundry/client/apps/forms/image-popout.d.mts +1 -1
  20. package/src/foundry/client/apps/forms/item.d.mts +1 -1
  21. package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +1 -1
  22. package/src/foundry/client/apps/forms/journal-sheet.d.mts +1 -1
  23. package/src/foundry/client/apps/forms/macro-config.d.mts +1 -1
  24. package/src/foundry/client/apps/forms/measure-template.d.mts +1 -1
  25. package/src/foundry/client/apps/forms/ownership.d.mts +1 -1
  26. package/src/foundry/client/apps/forms/playlist-config.d.mts +1 -1
  27. package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +1 -1
  28. package/src/foundry/client/apps/forms/roll-table-config.d.mts +1 -1
  29. package/src/foundry/client/apps/forms/scene-config.d.mts +1 -1
  30. package/src/foundry/client/apps/forms/sheet-config.d.mts +1 -1
  31. package/src/foundry/client/apps/forms/user-config.d.mts +1 -1
  32. package/src/foundry/client/apps/hud/chatbubble.d.mts +1 -1
  33. package/src/foundry/client/apps/hud/container.d.mts +1 -1
  34. package/src/foundry/client/apps/hud/controls.d.mts +1 -1
  35. package/src/foundry/client/apps/hud/hotbar.d.mts +1 -1
  36. package/src/foundry/client/apps/hud/hud.d.mts +1 -1
  37. package/src/foundry/client/apps/hud/menu.d.mts +1 -1
  38. package/src/foundry/client/apps/hud/navigation.d.mts +1 -1
  39. package/src/foundry/client/apps/hud/pause.d.mts +1 -1
  40. package/src/foundry/client/apps/hud/players.d.mts +1 -1
  41. package/src/foundry/client/apps/placeables/drawing-config.d.mts +1 -1
  42. package/src/foundry/client/apps/placeables/drawing-hud.d.mts +1 -1
  43. package/src/foundry/client/apps/placeables/note-config.d.mts +1 -1
  44. package/src/foundry/client/apps/placeables/tile-config.d.mts +1 -1
  45. package/src/foundry/client/apps/placeables/tile-hud.d.mts +1 -1
  46. package/src/foundry/client/apps/placeables/token-config.d.mts +1 -1
  47. package/src/foundry/client/apps/placeables/token-hud.d.mts +1 -1
  48. package/src/foundry/client/apps/placeables/wall-config.d.mts +1 -1
  49. package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +1 -1
  50. package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +1 -1
  51. package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +1 -1
  52. package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +1 -1
  53. package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +1 -1
  54. package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +1 -1
  55. package/src/foundry/client/apps/sidebar/package-configuration.d.mts +1 -1
  56. package/src/foundry/client/apps/sidebar/sidebar.d.mts +1 -1
  57. package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +1 -1
  58. package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +1 -1
  59. package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +1 -1
  60. package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +1 -1
  61. package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +1 -1
  62. package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +1 -1
  63. package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +1 -1
  64. package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +1 -1
  65. package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +1 -1
  66. package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +1 -1
  67. package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +1 -1
  68. package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +1 -1
  69. package/src/foundry/client/av/client.d.mts +1 -1
  70. package/src/foundry/client/av/clients/simplepeer.d.mts +1 -1
  71. package/src/foundry/client/av/master.d.mts +1 -1
  72. package/src/foundry/client/av/settings.d.mts +1 -1
  73. package/src/foundry/client/config.d.mts +1 -1
  74. package/src/foundry/client/core/hooks.d.mts +1 -1
  75. package/src/foundry/client/core/image.d.mts +1 -1
  76. package/src/foundry/client/core/keybindings.d.mts +1 -1
  77. package/src/foundry/client/core/packages.d.mts +4 -2
  78. package/src/foundry/client/core/settings.d.mts +1 -1
  79. package/src/foundry/client/core/socket.d.mts +1 -1
  80. package/src/foundry/client/core/tooltip.d.mts +1 -1
  81. package/src/foundry/client/core/tour.d.mts +1 -1
  82. package/src/foundry/client/core/utils.d.mts +1 -1
  83. package/src/foundry/client/core/workers.d.mts +1 -1
  84. package/src/foundry/client/data/abstract/canvas-document.d.mts +9 -20
  85. package/src/foundry/client/data/abstract/client-document.d.mts +133 -71
  86. package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +2 -2
  87. package/src/foundry/client/data/abstract/document-collection.d.mts +1 -1
  88. package/src/foundry/client/data/abstract/world-collection.d.mts +8 -1
  89. package/src/foundry/client/data/collections/actors.d.mts +1 -1
  90. package/src/foundry/client/data/collections/cards.d.mts +1 -1
  91. package/src/foundry/client/data/collections/combats.d.mts +1 -1
  92. package/src/foundry/client/data/collections/compendium-collection.d.mts +5 -4
  93. package/src/foundry/client/data/collections/fog.d.mts +1 -1
  94. package/src/foundry/client/data/collections/folder.d.mts +1 -1
  95. package/src/foundry/client/data/collections/items.d.mts +1 -1
  96. package/src/foundry/client/data/collections/journal.d.mts +1 -1
  97. package/src/foundry/client/data/collections/macros.d.mts +1 -1
  98. package/src/foundry/client/data/collections/messages.d.mts +1 -1
  99. package/src/foundry/client/data/collections/playlists.d.mts +1 -1
  100. package/src/foundry/client/data/collections/scenes.d.mts +1 -1
  101. package/src/foundry/client/data/collections/settings.d.mts +1 -1
  102. package/src/foundry/client/data/collections/tables.d.mts +1 -1
  103. package/src/foundry/client/data/collections/users.d.mts +4 -4
  104. package/src/foundry/client/data/documents/active-effect.d.mts +124 -48
  105. package/src/foundry/client/data/documents/actor-delta.d.mts +53 -22
  106. package/src/foundry/client/data/documents/actor.d.mts +147 -93
  107. package/src/foundry/client/data/documents/adventure.d.mts +74 -45
  108. package/src/foundry/client/data/documents/ambient-light.d.mts +13 -10
  109. package/src/foundry/client/data/documents/ambient-sound.d.mts +12 -7
  110. package/src/foundry/client/data/documents/card.d.mts +57 -34
  111. package/src/foundry/client/data/documents/cards.d.mts +171 -135
  112. package/src/foundry/client/data/documents/chat-message.d.mts +131 -72
  113. package/src/foundry/client/data/documents/combat.d.mts +80 -60
  114. package/src/foundry/client/data/documents/combatant.d.mts +53 -20
  115. package/src/foundry/client/data/documents/drawing.d.mts +12 -7
  116. package/src/foundry/client/data/documents/fog-exploration.d.mts +57 -17
  117. package/src/foundry/client/data/documents/folder.d.mts +114 -31
  118. package/src/foundry/client/data/documents/item.d.mts +31 -21
  119. package/src/foundry/client/data/documents/journal-entry-page.d.mts +90 -57
  120. package/src/foundry/client/data/documents/journal-entry.d.mts +29 -34
  121. package/src/foundry/client/data/documents/macro.d.mts +60 -34
  122. package/src/foundry/client/data/documents/measured-template.d.mts +13 -8
  123. package/src/foundry/client/data/documents/note.d.mts +14 -7
  124. package/src/foundry/client/data/documents/playlist-sound.d.mts +29 -33
  125. package/src/foundry/client/data/documents/playlist.d.mts +74 -54
  126. package/src/foundry/client/data/documents/region-behavior.d.mts +16 -7
  127. package/src/foundry/client/data/documents/region.d.mts +53 -48
  128. package/src/foundry/client/data/documents/scene.d.mts +310 -89
  129. package/src/foundry/client/data/documents/setting.d.mts +24 -23
  130. package/src/foundry/client/data/documents/table-result.d.mts +20 -8
  131. package/src/foundry/client/data/documents/table.d.mts +19 -13
  132. package/src/foundry/client/data/documents/tile.d.mts +13 -7
  133. package/src/foundry/client/data/documents/token.d.mts +148 -117
  134. package/src/foundry/client/data/documents/user.d.mts +141 -53
  135. package/src/foundry/client/data/documents/wall.d.mts +17 -10
  136. package/src/foundry/client/game.d.mts +1 -1
  137. package/src/foundry/client/head.d.mts +1 -1
  138. package/src/foundry/client/hooks.d.mts +9 -18
  139. package/src/foundry/client/pixi/board.d.mts +3 -2
  140. package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +1 -1
  141. package/src/foundry/client/pixi/core/containers/cached-container.d.mts +1 -1
  142. package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +1 -1
  143. package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +1 -1
  144. package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +1 -1
  145. package/src/foundry/client/pixi/core/containers/quadtree.d.mts +1 -1
  146. package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +1 -1
  147. package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +1 -1
  148. package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +1 -1
  149. package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +1 -1
  150. package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +1 -1
  151. package/src/foundry/client/pixi/core/interaction/ping.d.mts +1 -1
  152. package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +1 -1
  153. package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +1 -8
  154. package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +1 -1
  155. package/src/foundry/client/pixi/core/interaction/targets.d.mts +1 -1
  156. package/src/foundry/client/pixi/core/loader.d.mts +1 -1
  157. package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +1 -1
  158. package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +1 -1
  159. package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +1 -1
  160. package/src/foundry/client/pixi/core/shapes/ray.d.mts +1 -1
  161. package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +1 -1
  162. package/src/foundry/client/pixi/extensions/circle.d.mts +1 -1
  163. package/src/foundry/client/pixi/extensions/observable-transform.d.mts +1 -1
  164. package/src/foundry/client/pixi/extensions/polygon.d.mts +1 -1
  165. package/src/foundry/client/pixi/extensions/rectangle.d.mts +1 -1
  166. package/src/foundry/client/pixi/groups/effects.d.mts +1 -1
  167. package/src/foundry/client/pixi/groups/environment.d.mts +1 -1
  168. package/src/foundry/client/pixi/groups/hidden.d.mts +1 -1
  169. package/src/foundry/client/pixi/groups/interface.d.mts +1 -1
  170. package/src/foundry/client/pixi/groups/overlay.d.mts +1 -1
  171. package/src/foundry/client/pixi/groups/primary.d.mts +1 -1
  172. package/src/foundry/client/pixi/groups/rendered.d.mts +1 -1
  173. package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +1 -1
  174. package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +1 -1
  175. package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +1 -1
  176. package/src/foundry/client/pixi/layers/controls/cursor.d.mts +1 -1
  177. package/src/foundry/client/pixi/layers/controls/door.d.mts +1 -1
  178. package/src/foundry/client/pixi/layers/controls/layer.d.mts +1 -1
  179. package/src/foundry/client/pixi/layers/controls/ruler.d.mts +1 -1
  180. package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +1 -1
  181. package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +1 -1
  182. package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +1 -1
  183. package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +1 -1
  184. package/src/foundry/client/pixi/layers/effects/visibility.d.mts +1 -1
  185. package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +1 -1
  186. package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +1 -1
  187. package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +1 -1
  188. package/src/foundry/client/pixi/layers/grid/highlight.d.mts +1 -1
  189. package/src/foundry/client/pixi/layers/grid/layer.d.mts +1 -1
  190. package/src/foundry/client/pixi/layers/grid/mesh.d.mts +1 -1
  191. package/src/foundry/client/pixi/layers/masks/depth.d.mts +1 -1
  192. package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +1 -1
  193. package/src/foundry/client/pixi/layers/masks/vision.d.mts +1 -1
  194. package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +1 -1
  195. package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +1 -1
  196. package/src/foundry/client/pixi/layers/placeables/notes.d.mts +1 -1
  197. package/src/foundry/client/pixi/layers/placeables/regions.d.mts +1 -1
  198. package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +1 -1
  199. package/src/foundry/client/pixi/layers/placeables/templates.d.mts +1 -1
  200. package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +1 -1
  201. package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +1 -1
  202. package/src/foundry/client/pixi/layers/placeables/walls.d.mts +1 -1
  203. package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +1 -1
  204. package/src/foundry/client/pixi/perception/detection-mode.d.mts +1 -1
  205. package/src/foundry/client/pixi/perception/fog.d.mts +1 -1
  206. package/src/foundry/client/pixi/perception/perception-manager.d.mts +1 -1
  207. package/src/foundry/client/pixi/perception/vision-mode.d.mts +1 -1
  208. package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +1 -1
  209. package/src/foundry/client/pixi/placeable.d.mts +2 -1
  210. package/src/foundry/client/pixi/placeables/drawing.d.mts +1 -1
  211. package/src/foundry/client/pixi/placeables/light.d.mts +1 -7
  212. package/src/foundry/client/pixi/placeables/note.d.mts +1 -1
  213. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +1 -1
  214. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +1 -1
  215. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +1 -1
  216. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +1 -1
  217. package/src/foundry/client/pixi/placeables/region.d.mts +1 -1
  218. package/src/foundry/client/pixi/placeables/sound.d.mts +1 -1
  219. package/src/foundry/client/pixi/placeables/template.d.mts +1 -1
  220. package/src/foundry/client/pixi/placeables/tile.d.mts +1 -1
  221. package/src/foundry/client/pixi/placeables/token.d.mts +1 -1
  222. package/src/foundry/client/pixi/placeables/wall.d.mts +1 -1
  223. package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +1 -1
  224. package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +1 -1
  225. package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +1 -1
  226. package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +1 -1
  227. package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +1 -1
  228. package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +1 -1
  229. package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +1 -1
  230. package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +1 -1
  231. package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +1 -1
  232. package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +1 -1
  233. package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +1 -1
  234. package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +1 -1
  235. package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +1 -1
  236. package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +1 -1
  237. package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +1 -1
  238. package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +1 -1
  239. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +1 -1
  240. package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +1 -1
  241. package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +1 -1
  242. package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +1 -1
  243. package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +1 -1
  244. package/src/foundry/client/pixi/workers/texture-worker.d.mts +1 -1
  245. package/src/foundry/client/ui/context.d.mts +1 -1
  246. package/src/foundry/client/ui/dialog.d.mts +1 -1
  247. package/src/foundry/client/ui/dragdrop.d.mts +1 -1
  248. package/src/foundry/client/ui/editor.d.mts +1 -1
  249. package/src/foundry/client/ui/filepicker.d.mts +1 -1
  250. package/src/foundry/client/ui/filter.d.mts +1 -1
  251. package/src/foundry/client-esm/applications/api/application.d.mts +1 -9
  252. package/src/foundry/client-esm/applications/api/dialog.d.mts +1 -1
  253. package/src/foundry/client-esm/applications/api/document-sheet.d.mts +1 -1
  254. package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +1 -1
  255. package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +1 -1
  256. package/src/foundry/client-esm/applications/apps/permission-config.d.mts +1 -1
  257. package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +1 -1
  258. package/src/foundry/client-esm/applications/forms/fields.d.mts +1 -1
  259. package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +1 -1
  260. package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +1 -1
  261. package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +1 -1
  262. package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +1 -1
  263. package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +1 -1
  264. package/src/foundry/client-esm/applications/sheets/region-config.d.mts +1 -1
  265. package/src/foundry/client-esm/applications/sheets/user-config.d.mts +1 -1
  266. package/src/foundry/client-esm/applications/ui/region-legend.d.mts +1 -1
  267. package/src/foundry/client-esm/audio/biquad.d.mts +1 -1
  268. package/src/foundry/client-esm/audio/convolver.d.mts +1 -1
  269. package/src/foundry/client-esm/audio/helper.d.mts +1 -1
  270. package/src/foundry/client-esm/audio/sound.d.mts +2 -2
  271. package/src/foundry/client-esm/canvas/edges/collision.d.mts +1 -1
  272. package/src/foundry/client-esm/canvas/edges/edge.d.mts +1 -1
  273. package/src/foundry/client-esm/canvas/edges/vertex.d.mts +1 -1
  274. package/src/foundry/client-esm/canvas/scene-manager.d.mts +1 -1
  275. package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +1 -1
  276. package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +1 -1
  277. package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +1 -1
  278. package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +1 -1
  279. package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +1 -1
  280. package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +1 -1
  281. package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +1 -1
  282. package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +1 -1
  283. package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +1 -1
  284. package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +1 -1
  285. package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +3 -2
  286. package/src/foundry/client-esm/canvas/tokens/ring.d.mts +1 -1
  287. package/src/foundry/client-esm/data/client-backend.d.mts +1 -1
  288. package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +4 -5
  289. package/src/foundry/client-esm/data/region-behaviors/base.d.mts +1 -1
  290. package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +1 -1
  291. package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +4 -4
  292. package/src/foundry/client-esm/dice/roll.d.mts +5 -8
  293. package/src/foundry/client-esm/dice/terms/coin.d.mts +1 -1
  294. package/src/foundry/client-esm/dice/terms/dice.d.mts +1 -1
  295. package/src/foundry/client-esm/dice/terms/die.d.mts +1 -1
  296. package/src/foundry/client-esm/dice/terms/fate.d.mts +1 -1
  297. package/src/foundry/client-esm/dice/terms/function.d.mts +1 -1
  298. package/src/foundry/client-esm/dice/terms/numeric.d.mts +1 -1
  299. package/src/foundry/client-esm/dice/terms/operator.d.mts +1 -1
  300. package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +1 -1
  301. package/src/foundry/client-esm/dice/terms/pool.d.mts +1 -1
  302. package/src/foundry/client-esm/dice/terms/string.d.mts +1 -1
  303. package/src/foundry/client-esm/dice/terms/term.d.mts +1 -1
  304. package/src/foundry/common/abstract/backend.d.mts +1 -1
  305. package/src/foundry/common/abstract/data.d.mts +197 -146
  306. package/src/foundry/common/abstract/document.d.mts +198 -81
  307. package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
  308. package/src/foundry/common/abstract/embedded-collection.d.mts +1 -1
  309. package/src/foundry/common/abstract/socket.d.mts +1 -1
  310. package/src/foundry/common/abstract/type-data.d.mts +4 -1
  311. package/src/foundry/common/config.d.mts +7 -1
  312. package/src/foundry/common/constants.d.mts +1 -1
  313. package/src/foundry/common/data/data.d.mts +42 -12
  314. package/src/foundry/common/data/fields.d.mts +656 -252
  315. package/src/foundry/common/documents/_types.d.mts +0 -6
  316. package/src/foundry/common/documents/active-effect.d.mts +116 -53
  317. package/src/foundry/common/documents/actor-delta.d.mts +139 -58
  318. package/src/foundry/common/documents/actor.d.mts +105 -51
  319. package/src/foundry/common/documents/adventure.d.mts +84 -39
  320. package/src/foundry/common/documents/ambient-light.d.mts +66 -38
  321. package/src/foundry/common/documents/ambient-sound.d.mts +66 -38
  322. package/src/foundry/common/documents/card.d.mts +100 -59
  323. package/src/foundry/common/documents/cards.d.mts +97 -42
  324. package/src/foundry/common/documents/chat-message.d.mts +105 -52
  325. package/src/foundry/common/documents/combat.d.mts +101 -48
  326. package/src/foundry/common/documents/combatant.d.mts +94 -50
  327. package/src/foundry/common/documents/drawing.d.mts +87 -46
  328. package/src/foundry/common/documents/fog-exploration.d.mts +87 -41
  329. package/src/foundry/common/documents/folder.d.mts +100 -46
  330. package/src/foundry/common/documents/item.d.mts +116 -45
  331. package/src/foundry/common/documents/journal-entry-page.d.mts +90 -40
  332. package/src/foundry/common/documents/journal-entry.d.mts +90 -39
  333. package/src/foundry/common/documents/macro.d.mts +116 -52
  334. package/src/foundry/common/documents/measured-template.d.mts +80 -44
  335. package/src/foundry/common/documents/note.d.mts +75 -39
  336. package/src/foundry/common/documents/playlist-sound.d.mts +88 -47
  337. package/src/foundry/common/documents/playlist.d.mts +101 -50
  338. package/src/foundry/common/documents/region-behavior.d.mts +71 -40
  339. package/src/foundry/common/documents/region.d.mts +68 -40
  340. package/src/foundry/common/documents/roll-table.d.mts +43 -9
  341. package/src/foundry/common/documents/scene.d.mts +190 -43
  342. package/src/foundry/common/documents/setting.d.mts +98 -42
  343. package/src/foundry/common/documents/table-result.d.mts +98 -48
  344. package/src/foundry/common/documents/tile.d.mts +77 -43
  345. package/src/foundry/common/documents/token.d.mts +95 -52
  346. package/src/foundry/common/documents/user.d.mts +100 -89
  347. package/src/foundry/common/documents/wall.d.mts +47 -17
  348. package/src/foundry/common/grid/base.d.mts +1 -1
  349. package/src/foundry/common/grid/gridless.d.mts +1 -1
  350. package/src/foundry/common/grid/hexagonal.d.mts +1 -1
  351. package/src/foundry/common/grid/square.d.mts +1 -1
  352. package/src/foundry/common/packages/base-package.d.mts +37 -14
  353. package/src/foundry/common/packages/base-system.d.mts +39 -0
  354. package/src/foundry/common/packages/base-world.d.mts +8 -1
  355. package/src/foundry/common/packages/sub-types.d.mts +3 -5
  356. package/src/foundry/common/primitives/array.d.mts +1 -1
  357. package/src/foundry/common/primitives/string.d.mts +1 -1
  358. package/src/foundry/common/prosemirror/dirty-plugin.d.mts +1 -1
  359. package/src/foundry/common/prosemirror/dom-parser.d.mts +1 -1
  360. package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +1 -1
  361. package/src/foundry/common/prosemirror/image-plugin.d.mts +1 -1
  362. package/src/foundry/common/prosemirror/paste-transformer.d.mts +1 -1
  363. package/src/foundry/common/prosemirror/plugin.d.mts +1 -1
  364. package/src/foundry/common/types.d.mts +1 -1
  365. package/src/foundry/common/utils/bitmask.d.mts +1 -1
  366. package/src/foundry/common/utils/collection.d.mts +1 -1
  367. package/src/foundry/common/utils/event-emitter.d.mts +1 -1
  368. package/src/foundry/common/utils/helpers.d.mts +1 -1
  369. package/src/foundry/public/scripts/clipper/clipper.d.mts +1 -1
  370. package/src/types/augments/particles.d.mts +1 -1
  371. package/src/types/augments/pixi.d.mts +1 -1
  372. package/src/types/augments/smooth.d.mts +1 -1
  373. package/src/types/augments/tinyMCE.d.mts +1 -1
  374. package/src/types/config.d.mts +2 -5
  375. package/src/types/documentConfiguration.d.mts +1 -1
  376. package/src/types/lib.d.mts +1 -1
  377. package/src/types/workers/image-compressor.d.mts +1 -1
@@ -1,5 +1,5 @@
1
1
  import type { ConfiguredDocumentClass } from "../../../../types/documentConfiguration.d.mts";
2
- import type { AnyObject, FixedInstanceType, InexactPartial, Merge, NullishProps } from "fvtt-types/utils";
2
+ import type { AnyObject, FixedInstanceType, InexactPartial, IntentionalPartial, Merge, NullishProps } from "#utils";
3
3
  import type Document from "../../../common/abstract/document.d.mts";
4
4
  import type { DataSchema } from "../../../common/data/fields.d.mts";
5
5
  import type { fields } from "../../../common/data/module.d.mts";
@@ -113,7 +113,7 @@ declare global {
113
113
  type Collection = Users.Configured;
114
114
 
115
115
  /**
116
- * An instance of `User` that comes from the database but failed validation meaining that
116
+ * An instance of `User` that comes from the database but failed validation meaning that
117
117
  * its `system` and `_source` could theoretically be anything.
118
118
  */
119
119
  interface Invalid extends Document.Invalid<User.Implementation> {}
@@ -184,12 +184,14 @@ declare global {
184
184
  /**
185
185
  * The user's name.
186
186
  */
187
+ // FIXME: This field is `required` with no `initial`, so actually required for construction; Currently an AssignmentType override is required to enforce this
187
188
  name: fields.StringField<{ required: true; blank: false; textSearch: true }, string>;
188
189
 
189
190
  /**
190
191
  * The user's role, see CONST.USER_ROLES.
191
192
  * @defaultValue `CONST.USER_ROLES.PLAYER`
192
193
  */
194
+ // FIXME: Overrides required to enforce the branded type
193
195
  role: fields.NumberField<
194
196
  {
195
197
  required: true;
@@ -210,15 +212,16 @@ declare global {
210
212
 
211
213
  /**
212
214
  * The user's password salt. Available only on the Server side for security.
213
- * @defaultValue `""`
215
+ * @defaultValue `undefined`
214
216
  */
215
217
  passwordSalt: fields.StringField;
216
218
 
217
219
  /**
218
220
  * The user's avatar image.
219
221
  * @defaultValue `null`
222
+ * @remarks Initialized to `this.avatar || this.character?.img || CONST.DEFAULT_TOKEN` in {@link User.prepareDerivedData | `User#prepareDerivedData`}
220
223
  */
221
- avatar: fields.FilePathField<{ categories: "IMAGE"[] }>;
224
+ avatar: fields.FilePathField<{ categories: ["IMAGE"] }>;
222
225
 
223
226
  /**
224
227
  * A linked Actor document that is this user's impersonated character.
@@ -228,12 +231,13 @@ declare global {
228
231
 
229
232
  /**
230
233
  * A color to represent this user.
231
- * @defaultValue a randomly chosen color string
234
+ * @defaultValue A CSS hex code representing an HSV color, with random hue, 0.8 saturation, and 0.8 value
232
235
  */
233
236
  color: fields.ColorField<{ required: true; nullable: false; initial: () => string }>;
234
237
 
235
238
  /**
236
- *
239
+ * @remarks Omitted from the `UserData` typedef as of 13.342, so no official description; Fairly self-explanatory though.
240
+ * @defaultValue `""`
237
241
  */
238
242
  pronouns: fields.StringField<{ required: true }>;
239
243
 
@@ -262,9 +266,9 @@ declare global {
262
266
  validate: (perms: AnyObject) => boolean;
263
267
  validationError: "must be a mapping of permission names to booleans";
264
268
  },
265
- InexactPartial<Permissions> | null | undefined,
266
- InexactPartial<Permissions>,
267
- InexactPartial<Permissions>
269
+ Record<string, boolean> | null | undefined,
270
+ Record<string, boolean>,
271
+ Record<string, boolean>
268
272
  >;
269
273
 
270
274
  /**
@@ -427,14 +431,14 @@ declare global {
427
431
  /**
428
432
  * The ping style, see CONFIG.Canvas.pings.
429
433
  * @defaultValue `"pulse"`
430
- * @remarks Overriden with `"arrow"` if the position of the ping is outside the viewport
434
+ * @remarks Overridden with `"arrow"` if the position of the ping is outside the viewport
431
435
  *
432
436
  * Overridden with `CONFIG.Canvas.pings.types.PULL` (`"chevron"` by default) if photosensitive mode is enabled and the ping is within the viewport
433
437
  */
434
438
  style: Ping.ConfiguredStyles;
435
439
  }>;
436
440
 
437
- /** @privateRemarks Only consumed by {@link ControlsLayer#handlePing} */
441
+ /** @privateRemarks Only consumed by {@link ControlsLayer.handlePing | `ControlsLayer#handlePing`} */
438
442
  interface PingData extends _PingData {
439
443
  /**
440
444
  * The ID of the scene that was pinged.
@@ -442,37 +446,107 @@ declare global {
442
446
  scene: string;
443
447
  }
444
448
 
445
- interface ActivityData {
446
- /** The ID of the scene that the user is viewing. */
449
+ /**
450
+ * @internal
451
+ * No core {@link User.broadcastActivity | `User#broadcastActivity`} call provides all keys, most only provide one,
452
+ * this is essentially bundling a bunch of unrelated update types into one socket handler, but the socket drops
453
+ * explicit `undefined` keys, so `IntentionalPartial` and `| null` as appropriate it is.
454
+ */
455
+ type _ActivityData = IntentionalPartial<{
456
+ /**
457
+ * The ID of the scene that the user is viewing.
458
+ * @remarks Foundry types this as possibly being `null`, but no code path in core seems to be able to produce such a broadcast,
459
+ * and it appears to be ignored if explicitly sent as `null`. Can't be explicit `undefined` as the socket drops such keys.
460
+ */
447
461
  sceneId: string | null;
448
462
 
449
- /** The position of the user's cursor. */
463
+ /**
464
+ * The position of the user's cursor.
465
+ * @remarks Can't be explicit `undefined` as the socket drops such keys, and {@link ControlsLayer.updateCursor | `ControlsLayer#updateCursor`}
466
+ * has an `=== null` check.
467
+ */
450
468
  cursor: { x: number; y: number } | null;
451
469
 
452
- /** The state of the user's ruler, if they are currently using one. */
470
+ /**
471
+ * The state of the user's ruler, if they are currently using one.
472
+ * @remarks Can't be explicit `undefined` as the socket drops such keys.
473
+ */
453
474
  ruler: Ruler.MeasurementData | null;
454
475
 
455
- /** The IDs of the tokens the user has targeted in the currently viewed */
476
+ /**
477
+ * The IDs of the tokens the user has targeted in the currently viewed
478
+ * @remarks Can't be explicit `undefined` as the socket drops such keys, and can't be `null` as its passed to {@link User.updateTokenTargets | `User#updateTokenTargets`},
479
+ * where it only has a parameter default.
480
+ */
456
481
  targets: string[];
457
482
 
458
- /** Whether the user has an open WS connection to the server or not. */
483
+ /**
484
+ * Whether the user has an open WS connection to the server or not.
485
+ * @defaultValue `true`
486
+ * @remarks Can't be nullish as, if provided, gets directly assigned to {@link User.active | `User#active`},
487
+ * and the default is applied only on a negative `in` check.
488
+ */
459
489
  active: boolean;
460
490
 
461
- /** Is the user emitting a ping at the cursor coordinates? */
462
- ping: PingData;
491
+ /**
492
+ * Is the user emitting a ping at the cursor coordinates?
493
+ * @remarks Can't be explicit `undefined` as the socket drops such keys, and can't be `null` as its passed to {@link ControlsLayer.handlePing | `CanvasLayer#handlePing`}'s third argument,
494
+ * where it is destructured and only has a parameter default.
495
+ */
496
+ ping: User.PingData;
463
497
 
464
- /** The state of the user's AV settings. */
498
+ /**
499
+ * The state of the user's AV settings.
500
+ * @remarks Can't be nullish, as it's passed to {@link AVSettings._handleUserActivity | `game.webrtc.settings._handleUserActivity`}'s second argument,
501
+ * which has no default and has `in` checks applied.
502
+ */
465
503
  av: AVSettings.Data;
466
- }
504
+ }>;
505
+
506
+ interface ActivityData extends _ActivityData {}
507
+
508
+ /** @internal */
509
+ type _BroadcastActivityOptions = NullishProps<{
510
+ /**
511
+ * If undefined, volatile is inferred from the activity data.
512
+ * @remarks The update is assumed volatile if it has `av`, `targets`, or `ping` data,
513
+ * lacks a `sceneId`, or has `ruler` data of exactly `null`
514
+ */
515
+ volatile: boolean;
516
+ }>;
517
+
518
+ interface BroadcastActivityOptions extends _BroadcastActivityOptions {}
467
519
 
468
- interface HasRoleOptions {
520
+ /** @internal */
521
+ type _HasRoleOptions = NullishProps<{
469
522
  /**
470
523
  * Require the role match to be exact
471
524
  * @defaultValue `false`
472
525
  */
473
- exact?: boolean | undefined;
526
+ exact: boolean;
527
+ }>;
528
+
529
+ interface HasRoleOptions extends _HasRoleOptions {}
530
+
531
+ /** @internal */
532
+ type _AssignHotbarMacroOptions = NullishProps<{
533
+ /**
534
+ * An optional origin slot from which the Macro is being shifted
535
+ * @remarks No default value, and non-numeric values are ignored
536
+ */
537
+ fromSlot: number;
538
+ }>;
539
+
540
+ interface AssignHotbarMacroOptions extends _AssignHotbarMacroOptions {}
541
+
542
+ /** The data {@link User.getHotbarMacros | `User#getHotbarMacros`} returns for each of the 10 entries in its returned array */
543
+ interface GetHotbarMacrosData {
544
+ slot: number;
545
+ macro: Macro.Implementation | null;
474
546
  }
475
547
 
548
+ type ActionPermission = keyof typeof CONST.USER_PERMISSIONS | CONST.USER_ROLE_NAMES | CONST.USER_ROLES;
549
+
476
550
  /**
477
551
  * @deprecated {@link User.Database | `User.DatabaseOperation`}
478
552
  */
@@ -538,18 +612,34 @@ declare global {
538
612
 
539
613
  override prepareDerivedData(): void;
540
614
 
615
+ /**
616
+ * @remarks Doesn't exist prior to data prep, set in {@link User.prepareDerivedData | `User#prepareDerivedData`}
617
+ * @defaultValue `this.color.multiply(2)`
618
+ */
619
+ border?: Color;
620
+
541
621
  /**
542
622
  * Assign a Macro to a numbered hotbar slot between 1 and 50
543
623
  * @param macro - The Macro document to assign
544
624
  * @param slot - A specific numbered hotbar slot to fill
545
- * @param fromSlot - An optional origin slot from which the Macro is being shifted
546
625
  * @returns A Promise which resolves once the User update is complete
626
+ * @remarks
627
+ * Passing `null` for `macro` requires passing a `slot` to clear.
628
+ *
629
+ * `slot` defaults to the first unused slot if not provided. Slots are `1`-indexed.
630
+ * @throws If `slot` is provided and either less than `1` or more than `50`, or not provided when there's no open slots
547
631
  */
632
+ // options: not null (destructured)
633
+ assignHotbarMacro(
634
+ macro: Macro.Implementation,
635
+ slot?: `${number}` | number,
636
+ options?: User.AssignHotbarMacroOptions,
637
+ ): Promise<this | undefined>;
548
638
  assignHotbarMacro(
549
- macro: Macro.Implementation | null,
550
- slot: string | number,
551
- { fromSlot }?: InexactPartial<{ fromSlot: number }>,
552
- ): Promise<this>;
639
+ macro: null,
640
+ slot: `${number}` | number,
641
+ options?: User.AssignHotbarMacroOptions,
642
+ ): Promise<this | undefined>;
553
643
 
554
644
  /**
555
645
  * Assign a specific boolean permission to this user.
@@ -557,44 +647,37 @@ declare global {
557
647
  *
558
648
  * @param permission - The permission name from USER_PERMISSIONS
559
649
  * @param allowed - Whether to allow or restrict the permission
650
+ * @remarks
651
+ * @throws If the calling user is not at least an Assistant GM
560
652
  */
561
- assignPermission(permission: keyof typeof CONST.USER_PERMISSIONS, allowed: boolean): Promise<this>;
653
+ assignPermission(permission: keyof typeof CONST.USER_PERMISSIONS, allowed: boolean): Promise<this | undefined>;
562
654
 
563
655
  /**
564
656
  * Submit User activity data to the server for broadcast to other players.
565
657
  * This type of data is transient, persisting only for the duration of the session and not saved to any database.
566
658
  * Activity data uses a volatile event to prevent unnecessary buffering if the client temporarily loses connection.
567
- * @param activityData - An object of User activity data to submit to the server for broadcast.
568
- * (default: `{}`)
659
+ * @param activityData - An object of User activity data to submit to the server for broadcast. (default: `{}`)
569
660
  */
570
- broadcastActivity(
571
- activityData?: InexactPartial<User.ActivityData>,
572
- options?: InexactPartial<{
573
- /**
574
- * If undefined, volatile is inferred from the activity data
575
- */
576
- volatile: boolean;
577
- }>,
578
- ): void;
661
+ // activityData: not null (parameter default only), options: not null (destructured)
662
+ broadcastActivity(activityData?: User.ActivityData, options?: User.BroadcastActivityOptions): void;
579
663
 
580
664
  /**
581
665
  * Get an Array of Macro Documents on this User's Hotbar by page
582
- * @param page - The hotbar page number
583
- * (default: `1`)
666
+ * @param page - The hotbar page number (default: `1`)
667
+ * @remarks Core's implementation hardcodes returning 10 results at a time (single page of the hotbar)
584
668
  */
585
- getHotbarMacros(page?: number): Array<{ slot: number; macro: Macro.Implementation | null }>;
669
+ // page: not null (would produce negative hotbar indices)
670
+ getHotbarMacros(page?: number): User.GetHotbarMacrosData[];
586
671
 
587
672
  /**
588
673
  * Update the set of Token targets for the user given an array of provided Token ids.
589
- * @param targetIds - An array of Token ids which represents the new target set
590
- * (default: `[]`)
674
+ * @param targetIds - An array of Token ids which represents the new target set (default: `[]`)
591
675
  */
676
+ // targetIds: not null (parameter default only)
592
677
  updateTokenTargets(targetIds?: string[]): void;
593
678
 
594
- /**
595
- * @privateRemarks _onUpdate and _onDelete are overridden but with no signature changes.
596
- * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
597
- */
679
+ // _onUpdate and _onDelete are overridden but with no signature changes.
680
+ // For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
598
681
 
599
682
  /*
600
683
  * After this point these are not really overridden methods.
@@ -610,23 +693,28 @@ declare global {
610
693
 
611
694
  // Descendant Document operations have been left out because User does not have any descendant documents.
612
695
 
613
- static override defaultName(context?: Document.DefaultNameContext<string, User.Parent>): string;
696
+ // context: not null (destructured)
697
+ static override defaultName(context?: Document.DefaultNameContext<"User", User.Parent>): string;
614
698
 
699
+ // data: not null (parameter default only), context: not null (destructured)
615
700
  static override createDialog(
616
701
  data?: Document.CreateDialogData<User.CreateData>,
617
- context?: Document.CreateDialogContext<string, User.Parent>,
702
+ context?: Document.CreateDialogContext<"User", User.Parent>,
618
703
  ): Promise<User.Stored | null | undefined>;
619
704
 
705
+ // options: not null (parameter default only)
620
706
  static override fromDropData(
621
707
  data: Document.DropData<User.Implementation>,
622
- options?: Document.FromDropDataOptions,
708
+ options?: AnyObject,
623
709
  ): Promise<User.Implementation | undefined>;
624
710
 
625
711
  static override fromImport(
626
712
  source: User.Source,
627
- context?: Document.FromImportContext<User.Parent>,
713
+ context?: Document.FromImportContext<User.Parent> | null,
628
714
  ): Promise<User.Implementation>;
629
715
 
716
+ override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
717
+
630
718
  // Embedded document operations have been left out because User does not have any embedded documents.
631
719
  }
632
720
  }
@@ -1,4 +1,4 @@
1
- import type { Merge } from "../../../../utils/index.d.mts";
1
+ import type { AnyObject, Merge } from "#utils";
2
2
  import type Document from "../../../common/abstract/document.d.mts";
3
3
  import type { DataSchema } from "../../../common/data/fields.d.mts";
4
4
  import type { fields } from "../../../common/data/module.d.mts";
@@ -109,7 +109,7 @@ declare global {
109
109
  type Collection = never;
110
110
 
111
111
  /**
112
- * An instance of `WallDocument` that comes from the database but failed validation meaining that
112
+ * An instance of `WallDocument` that comes from the database but failed validation meaning that
113
113
  * its `system` and `_source` could theoretically be anything.
114
114
  */
115
115
  interface Invalid extends Document.Invalid<WallDocument.Implementation> {}
@@ -296,7 +296,7 @@ declare global {
296
296
 
297
297
  /**
298
298
  * The direction of effect imposed by this wall
299
- * @defaultValue `CONST.WALL_DIRECTIONS.BOTH` (`0`)
299
+ * @defaultValue `CONST.WALL_DIRECTIONS.BOTH`
300
300
  */
301
301
  dir: fields.NumberField<
302
302
  {
@@ -313,7 +313,7 @@ declare global {
313
313
 
314
314
  /**
315
315
  * The type of door which this wall contains, if any
316
- * @defaultValue `CONST.WALL_DOOR_TYPES.NONE` (`0`)
316
+ * @defaultValue `CONST.WALL_DOOR_TYPES.NONE`
317
317
  */
318
318
  door: fields.NumberField<
319
319
  {
@@ -330,7 +330,7 @@ declare global {
330
330
 
331
331
  /**
332
332
  * The state of the door this wall contains, if any
333
- * @defaultValue `CONST.WALL_DOOR_STATES.CLOSED` (`0`)
333
+ * @defaultValue `CONST.WALL_DOOR_STATES.CLOSED`
334
334
  */
335
335
  ds: fields.NumberField<
336
336
  {
@@ -542,23 +542,30 @@ declare global {
542
542
 
543
543
  // Descendant Document operations have been left out because Wall does not have any descendant documents.
544
544
 
545
- static override defaultName(context: Document.DefaultNameContext<"base", NonNullable<WallDocument.Parent>>): string;
545
+ // context: not null (destructured)
546
+ static override defaultName(
547
+ context?: Document.DefaultNameContext<"Wall", NonNullable<WallDocument.Parent>>,
548
+ ): string;
546
549
 
550
+ /** @remarks `context.parent` is required as creation requires one */
547
551
  static override createDialog(
548
- data: Document.CreateDialogData<WallDocument.CreateData>,
549
- context: Document.CreateDialogContext<string, NonNullable<WallDocument.Parent>>,
552
+ data: Document.CreateDialogData<WallDocument.CreateData> | undefined,
553
+ context: Document.CreateDialogContext<"Wall", NonNullable<WallDocument.Parent>>,
550
554
  ): Promise<WallDocument.Stored | null | undefined>;
551
555
 
556
+ // options: not null (parameter default only)
552
557
  static override fromDropData(
553
558
  data: Document.DropData<WallDocument.Implementation>,
554
- options?: Document.FromDropDataOptions,
559
+ options?: AnyObject,
555
560
  ): Promise<WallDocument.Implementation | undefined>;
556
561
 
557
562
  static override fromImport(
558
563
  source: WallDocument.Source,
559
- context?: Document.FromImportContext<WallDocument.Parent>,
564
+ context?: Document.FromImportContext<WallDocument.Parent> | null,
560
565
  ): Promise<WallDocument.Implementation>;
561
566
 
567
+ override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
568
+
562
569
  // Embedded document operations have been left out because Wall does not have any embedded documents.
563
570
  }
564
571
  }
@@ -7,7 +7,7 @@ import type {
7
7
  FixedInstanceType,
8
8
  InitializationHook,
9
9
  InitializedOn,
10
- } from "fvtt-types/utils";
10
+ } from "#utils";
11
11
  import type BasePackage from "../common/packages/base-package.d.mts";
12
12
  import type { Document } from "../common/abstract/module.d.mts";
13
13
 
@@ -1,4 +1,4 @@
1
- import type { EarlierHook, FixedInstanceType, InitializationHook } from "fvtt-types/utils";
1
+ import type { EarlierHook, FixedInstanceType, InitializationHook } from "#utils";
2
2
 
3
3
  type ValidRanHooks = Extract<keyof AssumeHookRan, InitializationHook>;
4
4
 
@@ -1,5 +1,5 @@
1
1
  import type { EditorState, Plugin } from "prosemirror-state";
2
- import type { DeepPartial, EmptyObject, ValueOf } from "fvtt-types/utils";
2
+ import type { DeepPartial, EmptyObject, ValueOf } from "#utils";
3
3
  import type Document from "../common/abstract/document.d.mts";
4
4
  import type { ProseMirrorDropDown } from "../common/prosemirror/menu.d.mts";
5
5
  import type ProseMirrorMenu from "../common/prosemirror/menu.d.mts";
@@ -397,7 +397,7 @@ declare global {
397
397
  passCards: (
398
398
  origin: Cards.Implementation,
399
399
  destination: Cards.Implementation,
400
- context: Cards.DealContext,
400
+ context: Cards.PassContext,
401
401
  ) => boolean | void;
402
402
 
403
403
  /**
@@ -520,7 +520,7 @@ declare global {
520
520
  */
521
521
  preImportAdventure: (
522
522
  adventure: Adventure.Implementation,
523
- formData: object, // TODO: Improve this. Also relevant to `AdventureImporter#_updateObject`
523
+ formData: Adventure.ImportOptions,
524
524
  toCreate: Adventure.ImportData["toCreate"],
525
525
  toUpdate: Adventure.ImportData["toUpdate"],
526
526
  ) => boolean | void;
@@ -536,9 +536,9 @@ declare global {
536
536
  */
537
537
  importAdventure: (
538
538
  adventure: Adventure.Implementation,
539
- formData: object, // TODO: Improve this. Also relevant to `AdventureImporter#_updateObject`
540
- toCreate: Adventure.ImportData["toCreate"],
541
- toUpdate: Adventure.ImportData["toUpdate"],
539
+ formData: Adventure.ImportOptions,
540
+ created: Adventure.ImportResult["created"],
541
+ updated: Adventure.ImportResult["updated"],
542
542
  ) => void;
543
543
 
544
544
  /** Socket */
@@ -708,23 +708,14 @@ declare global {
708
708
  * @param message - The ChatMessage document being rendered
709
709
  * @param html - The pending HTML as a jQuery object
710
710
  * @param messageData - The input data provided for template rendering
711
- * @remarks This is called by {@link Hooks.call | `Hooks.call`}.
711
+ * @remarks This is called by {@link Hooks.call | `Hooks.call`}, but its return is not checked;
712
+ * returning `false` only prevents later hooks running
712
713
  * @see {@link ChatMessage.render | `ChatMessage#render`}
713
714
  */
714
715
  renderChatMessage: (
715
716
  message: ChatMessage.Implementation,
716
717
  html: JQuery,
717
- messageData: {
718
- message: ChatMessage.Source;
719
- user: Game["user"];
720
- author: User.Implementation | null;
721
- alias: string;
722
- cssClass: string;
723
- isWhisper: boolean;
724
- canDelete: boolean;
725
- whisperTo: string;
726
- borderColor?: string;
727
- },
718
+ messageData: ChatMessage.MessageData,
728
719
  ) => boolean | void;
729
720
 
730
721
  /** Audio-Video */
@@ -1,4 +1,4 @@
1
- import type { InexactPartial, NullishProps, FixedInstanceType } from "fvtt-types/utils";
1
+ import type { InexactPartial, NullishProps, FixedInstanceType } from "#utils";
2
2
  import type { CANVAS_PERFORMANCE_MODES } from "../../common/constants.d.mts";
3
3
 
4
4
  type InternalCanvas = new (...args: never) => {
@@ -390,8 +390,9 @@ declare global {
390
390
  * Draw the game canvas.
391
391
  * @param scene - A specific Scene document to render on the Canvas
392
392
  * @returns A Promise which resolves once the Canvas is fully drawn
393
+ * @privateRemarks Foundry calls this with `null` in `Scene#_onDelete` and `Scene#_onActivate`
393
394
  */
394
- draw(scene?: Scene.Implementation): Promise<this>;
395
+ draw(scene?: Scene.Implementation | null): Promise<this>;
395
396
 
396
397
  /**
397
398
  * When re-drawing the canvas, first tear down or discontinue some existing processes
@@ -1,4 +1,4 @@
1
- import type { FixedInstanceType, HandleEmptyObject, PrettifyType, RemoveIndexSignatures } from "fvtt-types/utils";
1
+ import type { FixedInstanceType, HandleEmptyObject, PrettifyType, RemoveIndexSignatures } from "#utils";
2
2
 
3
3
  declare const DynamicClass: new <_Computed extends object>(...args: never) => _Computed;
4
4
 
@@ -1,4 +1,4 @@
1
- import type { Identity, NullishProps } from "fvtt-types/utils";
1
+ import type { Identity, NullishProps } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { FixedInstanceType, Mixin } from "fvtt-types/utils";
1
+ import type { FixedInstanceType, Mixin } from "#utils";
2
2
 
3
3
  declare class FullCanvasObject {
4
4
  /** @privateRemarks All mixin classses should accept anything for its constructor. */
@@ -1,4 +1,4 @@
1
- import type { Identity } from "fvtt-types/utils";
1
+ import type { Identity } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { Identity } from "fvtt-types/utils";
1
+ import type { Identity } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { Brand, Identity, InexactPartial, NullishProps } from "fvtt-types/utils";
1
+ import type { Brand, Identity, InexactPartial, NullishProps } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /** @deprecated {@link Quadtree.Object | `Quadtree.Object`} */
@@ -1,4 +1,4 @@
1
- import type { Identity } from "fvtt-types/utils";
1
+ import type { Identity } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { Identity } from "fvtt-types/utils";
1
+ import type { Identity } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { PropertiesOfType, Brand, NullishProps, AnyObject, Identity } from "fvtt-types/utils";
1
+ import type { PropertiesOfType, Brand, NullishProps, AnyObject, Identity } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { Identity, InexactPartial } from "fvtt-types/utils";
1
+ import type { Identity, InexactPartial } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { AnyArray, Brand, Identity, NullishProps } from "fvtt-types/utils";
1
+ import type { AnyArray, Brand, Identity, NullishProps } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { Identity, IntentionalPartial, RemoveIndexSignatures } from "fvtt-types/utils";
1
+ import type { Identity, IntentionalPartial, RemoveIndexSignatures } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,4 +1,4 @@
1
- import type { Identity, InexactPartial, NullishProps } from "fvtt-types/utils";
1
+ import type { Identity, InexactPartial, NullishProps } from "#utils";
2
2
 
3
3
  declare global {
4
4
  /**
@@ -1,11 +1,4 @@
1
- import type {
2
- AnyConstructor,
3
- ConcreteKeys,
4
- FixedInstanceType,
5
- InexactPartial,
6
- MakeConform,
7
- Mixin,
8
- } from "fvtt-types/utils";
1
+ import type { AnyConstructor, ConcreteKeys, FixedInstanceType, InexactPartial, MakeConform, Mixin } from "#utils";
9
2
  import type { LogCompatibilityWarningOptions } from "../../../../common/utils/logging.d.mts";
10
3
 
11
4
  declare class RenderFlagObject {
@@ -1,4 +1,4 @@
1
- import type { Identity, NullishProps } from "fvtt-types/utils";
1
+ import type { Identity, NullishProps } from "#utils";
2
2
 
3
3
  declare global {
4
4
  class ResizeHandle extends PIXI.Graphics {
@@ -1,4 +1,4 @@
1
- import type { Identity } from "fvtt-types/utils";
1
+ import type { Identity } from "#utils";
2
2
 
3
3
  // This class exists make it as sound as possible to override these parts of the class and make them
4
4
  // completely unrelated. It's done this way specifically to avoid situations with broken inheritance.
@@ -1,4 +1,4 @@
1
- import type { Identity, InexactPartial, NullishProps } from "fvtt-types/utils";
1
+ import type { Identity, InexactPartial, NullishProps } from "#utils";
2
2
  import type { TranscoderWorker } from "@pixi/basis";
3
3
 
4
4
  declare global {