@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.340.1

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 (543) hide show
  1. package/README.md +6 -3
  2. package/package.json +40 -18
  3. package/src/configuration/configuration.d.mts +24 -23
  4. package/src/configuration/documents.d.mts +295 -0
  5. package/src/configuration/globals.d.mts +8 -2
  6. package/src/configuration/index.d.mts +1 -0
  7. package/src/foundry/client/apps/app.d.mts +121 -119
  8. package/src/foundry/client/apps/av/av-config.d.mts +13 -8
  9. package/src/foundry/client/apps/av/cameras.d.mts +11 -11
  10. package/src/foundry/client/apps/dice/dice-config.d.mts +22 -8
  11. package/src/foundry/client/apps/form.d.mts +112 -94
  12. package/src/foundry/client/apps/forms/actor.d.mts +22 -12
  13. package/src/foundry/client/apps/forms/adventure-exporter.d.mts +13 -8
  14. package/src/foundry/client/apps/forms/adventure-importer.d.mts +15 -7
  15. package/src/foundry/client/apps/forms/base-sheet.d.mts +14 -7
  16. package/src/foundry/client/apps/forms/card-config.d.mts +17 -9
  17. package/src/foundry/client/apps/forms/cards-config.d.mts +13 -14
  18. package/src/foundry/client/apps/forms/combat-config.d.mts +7 -7
  19. package/src/foundry/client/apps/forms/combatant-config.d.mts +4 -4
  20. package/src/foundry/client/apps/forms/default-sheets-config.d.mts +1 -1
  21. package/src/foundry/client/apps/forms/effect-config.d.mts +6 -6
  22. package/src/foundry/client/apps/forms/folder-config.d.mts +5 -5
  23. package/src/foundry/client/apps/forms/fonts.d.mts +42 -35
  24. package/src/foundry/client/apps/forms/grid-config.d.mts +11 -11
  25. package/src/foundry/client/apps/forms/image-popout.d.mts +28 -22
  26. package/src/foundry/client/apps/forms/item.d.mts +6 -6
  27. package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +17 -15
  28. package/src/foundry/client/apps/forms/journal-sheet.d.mts +46 -37
  29. package/src/foundry/client/apps/forms/macro-config.d.mts +6 -6
  30. package/src/foundry/client/apps/forms/measure-template.d.mts +8 -8
  31. package/src/foundry/client/apps/forms/ownership.d.mts +5 -5
  32. package/src/foundry/client/apps/forms/playlist-config.d.mts +7 -9
  33. package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +6 -6
  34. package/src/foundry/client/apps/forms/roll-table-config.d.mts +9 -10
  35. package/src/foundry/client/apps/forms/scene-config.d.mts +39 -39
  36. package/src/foundry/client/apps/forms/sheet-config.d.mts +8 -8
  37. package/src/foundry/client/apps/forms/user-config.d.mts +11 -11
  38. package/src/foundry/client/apps/hud/chatbubble.d.mts +14 -9
  39. package/src/foundry/client/apps/hud/container.d.mts +3 -3
  40. package/src/foundry/client/apps/hud/controls.d.mts +124 -84
  41. package/src/foundry/client/apps/hud/hotbar.d.mts +12 -12
  42. package/src/foundry/client/apps/hud/hud.d.mts +4 -4
  43. package/src/foundry/client/apps/hud/menu.d.mts +6 -6
  44. package/src/foundry/client/apps/hud/navigation.d.mts +11 -11
  45. package/src/foundry/client/apps/hud/pause.d.mts +7 -7
  46. package/src/foundry/client/apps/hud/players.d.mts +11 -11
  47. package/src/foundry/client/apps/i18n.d.mts +31 -27
  48. package/src/foundry/client/apps/placeables/drawing-config.d.mts +41 -33
  49. package/src/foundry/client/apps/placeables/drawing-hud.d.mts +4 -4
  50. package/src/foundry/client/apps/placeables/index.d.mts +0 -2
  51. package/src/foundry/client/apps/placeables/note-config.d.mts +27 -17
  52. package/src/foundry/client/apps/placeables/tile-config.d.mts +23 -10
  53. package/src/foundry/client/apps/placeables/tile-hud.d.mts +8 -8
  54. package/src/foundry/client/apps/placeables/token-config.d.mts +84 -63
  55. package/src/foundry/client/apps/placeables/token-hud.d.mts +10 -10
  56. package/src/foundry/client/apps/placeables/wall-config.d.mts +19 -16
  57. package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +5 -5
  58. package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +2 -2
  59. package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +13 -10
  60. package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +3 -3
  61. package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +1 -1
  62. package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +6 -6
  63. package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts +6 -6
  64. package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +33 -28
  65. package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +1 -1
  66. package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +12 -9
  67. package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +40 -32
  68. package/src/foundry/client/apps/sidebar/document-directory.d.mts +44 -37
  69. package/src/foundry/client/apps/sidebar/package-configuration.d.mts +3 -3
  70. package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +3 -3
  71. package/src/foundry/client/apps/sidebar/sidebar.d.mts +7 -7
  72. package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +4 -4
  73. package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +4 -4
  74. package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +34 -29
  75. package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +15 -15
  76. package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +21 -12
  77. package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +4 -4
  78. package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +4 -4
  79. package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +8 -8
  80. package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +21 -21
  81. package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +4 -4
  82. package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +6 -6
  83. package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +12 -12
  84. package/src/foundry/client/apps/templates.d.mts +2 -2
  85. package/src/foundry/client/av/clients/simplepeer.d.mts +4 -4
  86. package/src/foundry/client/av/settings.d.mts +16 -13
  87. package/src/foundry/client/config.d.mts +1982 -1823
  88. package/src/foundry/client/core/document-index.d.mts +12 -4
  89. package/src/foundry/client/core/hooks.d.mts +0 -2
  90. package/src/foundry/client/core/image.d.mts +13 -11
  91. package/src/foundry/client/core/issues.d.mts +11 -6
  92. package/src/foundry/client/core/keybindings.d.mts +3 -3
  93. package/src/foundry/client/core/nue.d.mts +1 -1
  94. package/src/foundry/client/core/packages.d.mts +393 -63
  95. package/src/foundry/client/core/settings.d.mts +34 -12
  96. package/src/foundry/client/core/socket.d.mts +2 -2
  97. package/src/foundry/client/core/sorting.d.mts +6 -6
  98. package/src/foundry/client/core/time.d.mts +6 -3
  99. package/src/foundry/client/core/tooltip.d.mts +1 -1
  100. package/src/foundry/client/core/tour.d.mts +58 -49
  101. package/src/foundry/client/core/tours.d.mts +1 -1
  102. package/src/foundry/client/core/utils.d.mts +3 -3
  103. package/src/foundry/client/core/workers.d.mts +24 -17
  104. package/src/foundry/client/data/abstract/canvas-document.d.mts +9 -15
  105. package/src/foundry/client/data/abstract/client-document.d.mts +133 -172
  106. package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +14 -36
  107. package/src/foundry/client/data/abstract/document-collection.d.mts +89 -65
  108. package/src/foundry/client/data/abstract/world-collection.d.mts +47 -53
  109. package/src/foundry/client/data/collections/actors.d.mts +24 -31
  110. package/src/foundry/client/data/collections/cards.d.mts +10 -6
  111. package/src/foundry/client/data/collections/combats.d.mts +12 -8
  112. package/src/foundry/client/data/collections/compendium-collection.d.mts +79 -66
  113. package/src/foundry/client/data/collections/compendium-folders.d.mts +6 -6
  114. package/src/foundry/client/data/collections/compendium-packs.d.mts +4 -4
  115. package/src/foundry/client/data/collections/fog.d.mts +10 -6
  116. package/src/foundry/client/data/collections/folder.d.mts +15 -10
  117. package/src/foundry/client/data/collections/items.d.mts +11 -7
  118. package/src/foundry/client/data/collections/journal.d.mts +16 -10
  119. package/src/foundry/client/data/collections/macros.d.mts +15 -22
  120. package/src/foundry/client/data/collections/messages.d.mts +14 -10
  121. package/src/foundry/client/data/collections/playlists.d.mts +12 -9
  122. package/src/foundry/client/data/collections/scenes.d.mts +19 -31
  123. package/src/foundry/client/data/collections/settings.d.mts +10 -6
  124. package/src/foundry/client/data/collections/tables.d.mts +11 -7
  125. package/src/foundry/client/data/collections/users.d.mts +14 -11
  126. package/src/foundry/client/data/documents/active-effect.d.mts +652 -88
  127. package/src/foundry/client/data/documents/actor-delta.d.mts +672 -28
  128. package/src/foundry/client/data/documents/actor.d.mts +722 -60
  129. package/src/foundry/client/data/documents/adventure.d.mts +482 -49
  130. package/src/foundry/client/data/documents/ambient-light.d.mts +426 -21
  131. package/src/foundry/client/data/documents/ambient-sound.d.mts +474 -15
  132. package/src/foundry/client/data/documents/card.d.mts +570 -39
  133. package/src/foundry/client/data/documents/cards.d.mts +742 -78
  134. package/src/foundry/client/data/documents/chat-message.d.mts +578 -45
  135. package/src/foundry/client/data/documents/combat.d.mts +701 -71
  136. package/src/foundry/client/data/documents/combatant.d.mts +510 -28
  137. package/src/foundry/client/data/documents/drawing.d.mts +543 -16
  138. package/src/foundry/client/data/documents/fog-exploration.d.mts +413 -27
  139. package/src/foundry/client/data/documents/folder.d.mts +461 -40
  140. package/src/foundry/client/data/documents/item.d.mts +679 -25
  141. package/src/foundry/client/data/documents/journal-entry-page.d.mts +587 -21
  142. package/src/foundry/client/data/documents/journal-entry.d.mts +621 -20
  143. package/src/foundry/client/data/documents/macro.d.mts +530 -25
  144. package/src/foundry/client/data/documents/measured-template.d.mts +480 -16
  145. package/src/foundry/client/data/documents/note.d.mts +495 -18
  146. package/src/foundry/client/data/documents/playlist-sound.d.mts +429 -27
  147. package/src/foundry/client/data/documents/playlist.d.mts +666 -75
  148. package/src/foundry/client/data/documents/region-behavior.d.mts +468 -38
  149. package/src/foundry/client/data/documents/region.d.mts +661 -35
  150. package/src/foundry/client/data/documents/scene.d.mts +986 -149
  151. package/src/foundry/client/data/documents/setting.d.mts +397 -15
  152. package/src/foundry/client/data/documents/table-result.d.mts +479 -17
  153. package/src/foundry/client/data/documents/table.d.mts +663 -80
  154. package/src/foundry/client/data/documents/tile.d.mts +502 -16
  155. package/src/foundry/client/data/documents/token.d.mts +1114 -90
  156. package/src/foundry/client/data/documents/user.d.mts +495 -27
  157. package/src/foundry/client/data/documents/wall.d.mts +550 -15
  158. package/src/foundry/client/game.d.mts +58 -92
  159. package/src/foundry/client/head.d.mts +5 -6
  160. package/src/foundry/client/hooks.d.mts +237 -221
  161. package/src/foundry/client/pixi/board.d.mts +95 -89
  162. package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +6 -5
  163. package/src/foundry/client/pixi/core/containers/cached-container.d.mts +5 -5
  164. package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +2 -2
  165. package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +3 -3
  166. package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +3 -3
  167. package/src/foundry/client/pixi/core/containers/quadtree.d.mts +23 -21
  168. package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +5 -5
  169. package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +5 -5
  170. package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +57 -51
  171. package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +3 -3
  172. package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +7 -7
  173. package/src/foundry/client/pixi/core/interaction/ping.d.mts +19 -11
  174. package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +7 -2
  175. package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +29 -23
  176. package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +83 -38
  177. package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +3 -3
  178. package/src/foundry/client/pixi/core/interaction/targets.d.mts +9 -9
  179. package/src/foundry/client/pixi/core/loader.d.mts +8 -8
  180. package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +9 -4
  181. package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +3 -3
  182. package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +3 -3
  183. package/src/foundry/client/pixi/core/shapes/ray.d.mts +23 -17
  184. package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +19 -14
  185. package/src/foundry/client/pixi/extensions/circle.d.mts +1 -1
  186. package/src/foundry/client/pixi/extensions/observable-transform.d.mts +3 -3
  187. package/src/foundry/client/pixi/groups/effects.d.mts +4 -4
  188. package/src/foundry/client/pixi/groups/environment.d.mts +5 -5
  189. package/src/foundry/client/pixi/groups/hidden.d.mts +3 -3
  190. package/src/foundry/client/pixi/groups/interface.d.mts +6 -6
  191. package/src/foundry/client/pixi/groups/overlay.d.mts +3 -3
  192. package/src/foundry/client/pixi/groups/primary.d.mts +11 -11
  193. package/src/foundry/client/pixi/groups/rendered.d.mts +3 -3
  194. package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +3 -3
  195. package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +13 -13
  196. package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +279 -233
  197. package/src/foundry/client/pixi/layers/controls/cursor.d.mts +17 -8
  198. package/src/foundry/client/pixi/layers/controls/door.d.mts +26 -14
  199. package/src/foundry/client/pixi/layers/controls/layer.d.mts +89 -79
  200. package/src/foundry/client/pixi/layers/controls/ruler.d.mts +121 -96
  201. package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +4 -5
  202. package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +6 -4
  203. package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +7 -4
  204. package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +19 -16
  205. package/src/foundry/client/pixi/layers/effects/visibility.d.mts +101 -84
  206. package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +13 -4
  207. package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +31 -2
  208. package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +134 -59
  209. package/src/foundry/client/pixi/layers/grid/highlight.d.mts +13 -3
  210. package/src/foundry/client/pixi/layers/grid/layer.d.mts +89 -87
  211. package/src/foundry/client/pixi/layers/grid/mesh.d.mts +36 -15
  212. package/src/foundry/client/pixi/layers/masks/depth.d.mts +3 -3
  213. package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +4 -4
  214. package/src/foundry/client/pixi/layers/masks/vision.d.mts +6 -6
  215. package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +15 -11
  216. package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +11 -10
  217. package/src/foundry/client/pixi/layers/placeables/notes.d.mts +47 -28
  218. package/src/foundry/client/pixi/layers/placeables/regions.d.mts +25 -12
  219. package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +81 -63
  220. package/src/foundry/client/pixi/layers/placeables/templates.d.mts +10 -11
  221. package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +28 -17
  222. package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +67 -46
  223. package/src/foundry/client/pixi/layers/placeables/walls.d.mts +50 -51
  224. package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +22 -16
  225. package/src/foundry/client/pixi/perception/detection-mode.d.mts +123 -51
  226. package/src/foundry/client/pixi/perception/fog.d.mts +34 -19
  227. package/src/foundry/client/pixi/perception/perception-manager.d.mts +137 -137
  228. package/src/foundry/client/pixi/perception/vision-mode.d.mts +92 -67
  229. package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +3 -3
  230. package/src/foundry/client/pixi/placeable.d.mts +241 -146
  231. package/src/foundry/client/pixi/placeables/drawing.d.mts +260 -134
  232. package/src/foundry/client/pixi/placeables/light.d.mts +204 -66
  233. package/src/foundry/client/pixi/placeables/note.d.mts +150 -55
  234. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +7 -6
  235. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +3 -3
  236. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +2 -2
  237. package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +4 -4
  238. package/src/foundry/client/pixi/placeables/region.d.mts +219 -110
  239. package/src/foundry/client/pixi/placeables/sound.d.mts +211 -68
  240. package/src/foundry/client/pixi/placeables/template.d.mts +186 -100
  241. package/src/foundry/client/pixi/placeables/tile.d.mts +211 -142
  242. package/src/foundry/client/pixi/placeables/token.d.mts +911 -568
  243. package/src/foundry/client/pixi/placeables/wall.d.mts +253 -130
  244. package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +27 -5
  245. package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +3 -3
  246. package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +3 -3
  247. package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +13 -5
  248. package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +6 -6
  249. package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +2 -2
  250. package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +5 -5
  251. package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +4 -4
  252. package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +3 -3
  253. package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +5 -5
  254. package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +6 -3
  255. package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +3 -3
  256. package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +4 -4
  257. package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +3 -3
  258. package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +4 -4
  259. package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +6 -6
  260. package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +8 -5
  261. package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +3 -3
  262. package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +3 -3
  263. package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +4 -4
  264. package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +1 -1
  265. package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +4 -4
  266. package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +3 -3
  267. package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +3 -3
  268. package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +3 -3
  269. package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +3 -3
  270. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +5 -5
  271. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +3 -3
  272. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +3 -3
  273. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +3 -3
  274. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +3 -3
  275. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +6 -6
  276. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +5 -5
  277. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +3 -3
  278. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +3 -3
  279. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +5 -5
  280. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +3 -3
  281. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +3 -3
  282. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +3 -3
  283. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +5 -5
  284. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +3 -3
  285. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +3 -3
  286. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +3 -3
  287. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +5 -5
  288. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +6 -5
  289. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +3 -3
  290. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +5 -5
  291. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +4 -3
  292. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +5 -5
  293. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +5 -5
  294. package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +5 -5
  295. package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +3 -3
  296. package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +7 -7
  297. package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +4 -4
  298. package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +3 -3
  299. package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +4 -4
  300. package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +3 -3
  301. package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +5 -5
  302. package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +3 -3
  303. package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +3 -3
  304. package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +3 -3
  305. package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +4 -4
  306. package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +4 -6
  307. package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +3 -3
  308. package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +3 -3
  309. package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +3 -3
  310. package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +3 -3
  311. package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +5 -5
  312. package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +3 -3
  313. package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +14 -15
  314. package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +20 -27
  315. package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +5 -5
  316. package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +5 -5
  317. package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +5 -5
  318. package/src/foundry/client/pixi/workers/texture-worker.d.mts +5 -5
  319. package/src/foundry/client/tours/setup-tour.d.mts +15 -10
  320. package/src/foundry/client/ui/dialog.d.mts +3 -3
  321. package/src/foundry/client/ui/dragdrop.d.mts +33 -27
  322. package/src/foundry/client/ui/editor.d.mts +29 -21
  323. package/src/foundry/client/ui/filepicker.d.mts +42 -37
  324. package/src/foundry/client/ui/filter.d.mts +60 -48
  325. package/src/foundry/client/ui/forms.d.mts +22 -22
  326. package/src/foundry/client/ui/prosemirror.d.mts +15 -7
  327. package/src/foundry/client/ui/secrets.d.mts +43 -28
  328. package/src/foundry/client/ui/tabs.d.mts +40 -33
  329. package/src/foundry/client-esm/_module.d.mts +5 -5
  330. package/src/foundry/client-esm/_types.d.mts +2 -1
  331. package/src/foundry/client-esm/applications/api/application.d.mts +93 -31
  332. package/src/foundry/client-esm/applications/api/dialog.d.mts +23 -23
  333. package/src/foundry/client-esm/applications/api/document-sheet.d.mts +85 -32
  334. package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +1 -1
  335. package/src/foundry/client-esm/applications/apps/av/camera-popout.d.mts +1 -1
  336. package/src/foundry/client-esm/applications/apps/av/cameras.d.mts +2 -2
  337. package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +4 -5
  338. package/src/foundry/client-esm/applications/apps/file-picker.d.mts +2 -2
  339. package/src/foundry/client-esm/applications/apps/grid-config.d.mts +3 -3
  340. package/src/foundry/client-esm/applications/apps/image-popout.d.mts +1 -1
  341. package/src/foundry/client-esm/applications/apps/permission-config.d.mts +1 -1
  342. package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +4 -4
  343. package/src/foundry/client-esm/applications/elements/file-picker.d.mts +1 -1
  344. package/src/foundry/client-esm/applications/elements/prosemirror-editor.d.mts +1 -1
  345. package/src/foundry/client-esm/applications/hud/drawing-hud.d.mts +1 -1
  346. package/src/foundry/client-esm/applications/hud/tile-hud.d.mts +1 -1
  347. package/src/foundry/client-esm/applications/hud/token-hud.d.mts +1 -1
  348. package/src/foundry/client-esm/applications/sheets/active-effect-config.d.mts +3 -3
  349. package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +2 -2
  350. package/src/foundry/client-esm/applications/sheets/adventure-exporter.d.mts +3 -3
  351. package/src/foundry/client-esm/applications/sheets/adventure-importer.d.mts +3 -3
  352. package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +5 -5
  353. package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +4 -4
  354. package/src/foundry/client-esm/applications/sheets/card-config.d.mts +3 -3
  355. package/src/foundry/client-esm/applications/sheets/cards-config.d.mts +2 -2
  356. package/src/foundry/client-esm/applications/sheets/combatant-config.d.mts +3 -3
  357. package/src/foundry/client-esm/applications/sheets/drawing-config.d.mts +3 -3
  358. package/src/foundry/client-esm/applications/sheets/folder-config.d.mts +3 -3
  359. package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +2 -2
  360. package/src/foundry/client-esm/applications/sheets/journal/journal-entry-category-config.d.mts +3 -3
  361. package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-sheet.d.mts +3 -3
  362. package/src/foundry/client-esm/applications/sheets/journal/journal-entry-sheet.d.mts +3 -3
  363. package/src/foundry/client-esm/applications/sheets/macro-config.d.mts +3 -3
  364. package/src/foundry/client-esm/applications/sheets/note-config.d.mts +3 -3
  365. package/src/foundry/client-esm/applications/sheets/playlist-config.d.mts +3 -3
  366. package/src/foundry/client-esm/applications/sheets/playlist-sound-config.d.mts +3 -3
  367. package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +3 -3
  368. package/src/foundry/client-esm/applications/sheets/region-config.d.mts +3 -3
  369. package/src/foundry/client-esm/applications/sheets/roll-table-config.d.mts +3 -3
  370. package/src/foundry/client-esm/applications/sheets/roll-table-sheet.d.mts +3 -3
  371. package/src/foundry/client-esm/applications/sheets/scene-config.d.mts +3 -3
  372. package/src/foundry/client-esm/applications/sheets/table-result-config.d.mts +3 -3
  373. package/src/foundry/client-esm/applications/sheets/template-config.d.mts +3 -3
  374. package/src/foundry/client-esm/applications/sheets/tile-config.d.mts +3 -3
  375. package/src/foundry/client-esm/applications/sheets/token/mixin.d.mts +1 -0
  376. package/src/foundry/client-esm/applications/sheets/token/token-config.d.mts +3 -3
  377. package/src/foundry/client-esm/applications/sheets/user-config.d.mts +4 -4
  378. package/src/foundry/client-esm/applications/sheets/wall-config.d.mts +3 -3
  379. package/src/foundry/client-esm/applications/sidebar/apps/chat-popout.d.mts +1 -1
  380. package/src/foundry/client-esm/applications/sidebar/sidebar-tab.d.mts +2 -2
  381. package/src/foundry/client-esm/applications/sidebar/tabs/actor-directory.d.mts +1 -1
  382. package/src/foundry/client-esm/applications/sidebar/tabs/cards-directory.d.mts +1 -1
  383. package/src/foundry/client-esm/applications/sidebar/tabs/combat-tracker.d.mts +242 -1
  384. package/src/foundry/client-esm/applications/sidebar/tabs/item-directory.d.mts +1 -1
  385. package/src/foundry/client-esm/applications/sidebar/tabs/journal-directory.d.mts +1 -1
  386. package/src/foundry/client-esm/applications/sidebar/tabs/macro-directory.d.mts +1 -1
  387. package/src/foundry/client-esm/applications/sidebar/tabs/playlist-directory.d.mts +1 -1
  388. package/src/foundry/client-esm/applications/sidebar/tabs/roll-table-directory.d.mts +1 -1
  389. package/src/foundry/client-esm/applications/sidebar/tabs/scene-directory.d.mts +1 -1
  390. package/src/foundry/client-esm/applications/ui/region-legend.d.mts +2 -2
  391. package/src/foundry/client-esm/applications/ux/context-menu.d.mts +56 -36
  392. package/src/foundry/client-esm/audio/_types.d.mts +2 -0
  393. package/src/foundry/client-esm/audio/biquad.d.mts +76 -26
  394. package/src/foundry/client-esm/audio/cache.d.mts +31 -20
  395. package/src/foundry/client-esm/audio/convolver.d.mts +47 -25
  396. package/src/foundry/client-esm/audio/helper.d.mts +124 -80
  397. package/src/foundry/client-esm/audio/sound.d.mts +202 -97
  398. package/src/foundry/client-esm/audio/timeout.d.mts +28 -12
  399. package/src/foundry/client-esm/canvas/edges/collision.d.mts +12 -4
  400. package/src/foundry/client-esm/canvas/edges/edge.d.mts +13 -8
  401. package/src/foundry/client-esm/canvas/edges/edges.d.mts +3 -2
  402. package/src/foundry/client-esm/canvas/edges/vertex.d.mts +12 -10
  403. package/src/foundry/client-esm/canvas/regions/geometry.d.mts +14 -7
  404. package/src/foundry/client-esm/canvas/regions/mesh.d.mts +25 -14
  405. package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +50 -19
  406. package/src/foundry/client-esm/canvas/regions/shape.d.mts +45 -34
  407. package/src/foundry/client-esm/canvas/scene-manager.d.mts +7 -6
  408. package/src/foundry/client-esm/canvas/smaa/blend.d.mts +14 -3
  409. package/src/foundry/client-esm/canvas/smaa/edges.d.mts +25 -3
  410. package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +119 -20
  411. package/src/foundry/client-esm/canvas/smaa/weights.d.mts +26 -3
  412. package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +69 -39
  413. package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +66 -40
  414. package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +78 -19
  415. package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +37 -20
  416. package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +39 -20
  417. package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +41 -12
  418. package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +15 -4
  419. package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +29 -14
  420. package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +84 -39
  421. package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +115 -41
  422. package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +83 -21
  423. package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +66 -93
  424. package/src/foundry/client-esm/canvas/tokens/ring.d.mts +146 -51
  425. package/src/foundry/client-esm/client.d.mts +16 -16
  426. package/src/foundry/client-esm/data/_module.d.mts +1 -1
  427. package/src/foundry/client-esm/data/calendar.d.mts +26 -39
  428. package/src/foundry/client-esm/data/client-backend.d.mts +6 -6
  429. package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +1 -1
  430. package/src/foundry/client-esm/data/region-behaviors/base.d.mts +5 -5
  431. package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +2 -2
  432. package/src/foundry/client-esm/data/terrain-data.d.mts +1 -1
  433. package/src/foundry/client-esm/dice/parser.d.mts +5 -27
  434. package/src/foundry/client-esm/dice/roll.d.mts +63 -80
  435. package/src/foundry/client-esm/dice/terms/coin.d.mts +4 -8
  436. package/src/foundry/client-esm/dice/terms/dice.d.mts +85 -64
  437. package/src/foundry/client-esm/dice/terms/die.d.mts +7 -7
  438. package/src/foundry/client-esm/dice/terms/fate.d.mts +5 -5
  439. package/src/foundry/client-esm/dice/terms/function.d.mts +13 -16
  440. package/src/foundry/client-esm/dice/terms/numeric.d.mts +2 -4
  441. package/src/foundry/client-esm/dice/terms/operator.d.mts +1 -1
  442. package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +8 -9
  443. package/src/foundry/client-esm/dice/terms/pool.d.mts +13 -28
  444. package/src/foundry/client-esm/dice/terms/string.d.mts +3 -3
  445. package/src/foundry/client-esm/dice/terms/term.d.mts +10 -5
  446. package/src/foundry/client-esm/dice/twister.d.mts +3 -3
  447. package/src/foundry/client-esm/documents/_module.d.mts +1 -1
  448. package/src/foundry/client-esm/helpers/_types.d.mts +12 -46
  449. package/src/foundry/client-esm/helpers/compendium-art.d.mts +57 -4
  450. package/src/foundry/client-esm/packages/_module.d.mts +1 -1
  451. package/src/foundry/client-esm/packages/_types.d.mts +2 -0
  452. package/src/foundry/client-esm/utils/_module.d.mts +1 -1
  453. package/src/foundry/client-esm/utils/_types.d.mts +2 -1
  454. package/src/foundry/common/_types.d.mts +1 -1
  455. package/src/foundry/common/abstract/_module.d.mts +1 -0
  456. package/src/foundry/common/abstract/_types.d.mts +60 -54
  457. package/src/foundry/common/abstract/backend.d.mts +28 -16
  458. package/src/foundry/common/abstract/data.d.mts +133 -116
  459. package/src/foundry/common/abstract/document.d.mts +1233 -440
  460. package/src/foundry/common/abstract/embedded-collection.d.mts +2 -2
  461. package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
  462. package/src/foundry/common/abstract/type-data.d.mts +35 -43
  463. package/src/foundry/common/config.d.mts +3 -3
  464. package/src/foundry/common/constants.d.mts +27 -26
  465. package/src/foundry/common/data/_types.d.mts +2 -0
  466. package/src/foundry/common/data/data.d.mts +189 -87
  467. package/src/foundry/common/data/fields.d.mts +579 -258
  468. package/src/foundry/common/data/validation-failure.d.mts +9 -4
  469. package/src/foundry/common/documents/_types.d.mts +16 -9
  470. package/src/foundry/common/documents/active-effect.d.mts +280 -180
  471. package/src/foundry/common/documents/actor-delta.d.mts +317 -70
  472. package/src/foundry/common/documents/actor.d.mts +304 -103
  473. package/src/foundry/common/documents/adventure.d.mts +254 -140
  474. package/src/foundry/common/documents/ambient-light.d.mts +267 -76
  475. package/src/foundry/common/documents/ambient-sound.d.mts +267 -110
  476. package/src/foundry/common/documents/card.d.mts +267 -176
  477. package/src/foundry/common/documents/cards.d.mts +299 -128
  478. package/src/foundry/common/documents/chat-message.d.mts +276 -160
  479. package/src/foundry/common/documents/combat.d.mts +300 -91
  480. package/src/foundry/common/documents/combatant.d.mts +283 -88
  481. package/src/foundry/common/documents/drawing.d.mts +286 -207
  482. package/src/foundry/common/documents/fog-exploration.d.mts +258 -72
  483. package/src/foundry/common/documents/folder.d.mts +248 -85
  484. package/src/foundry/common/documents/item.d.mts +305 -101
  485. package/src/foundry/common/documents/journal-entry-page.d.mts +279 -190
  486. package/src/foundry/common/documents/journal-entry.d.mts +294 -70
  487. package/src/foundry/common/documents/macro.d.mts +254 -134
  488. package/src/foundry/common/documents/measured-template.d.mts +293 -137
  489. package/src/foundry/common/documents/note.d.mts +274 -151
  490. package/src/foundry/common/documents/playlist-sound.d.mts +260 -96
  491. package/src/foundry/common/documents/playlist.d.mts +279 -122
  492. package/src/foundry/common/documents/region-behavior.d.mts +305 -64
  493. package/src/foundry/common/documents/region.d.mts +309 -90
  494. package/src/foundry/common/documents/roll-table.d.mts +286 -104
  495. package/src/foundry/common/documents/scene.d.mts +276 -344
  496. package/src/foundry/common/documents/setting.d.mts +229 -55
  497. package/src/foundry/common/documents/table-result.d.mts +267 -96
  498. package/src/foundry/common/documents/tile.d.mts +301 -172
  499. package/src/foundry/common/documents/token.d.mts +350 -452
  500. package/src/foundry/common/documents/user.d.mts +256 -146
  501. package/src/foundry/common/documents/wall.d.mts +272 -157
  502. package/src/foundry/common/grid/_types.d.mts +2 -0
  503. package/src/foundry/common/grid/base.d.mts +58 -37
  504. package/src/foundry/common/grid/hexagonal.d.mts +19 -19
  505. package/src/foundry/common/grid/square.d.mts +1 -1
  506. package/src/foundry/common/packages/_module.d.mts +5 -5
  507. package/src/foundry/common/packages/_types.d.mts +2 -0
  508. package/src/foundry/common/packages/base-module.d.mts +6 -24
  509. package/src/foundry/common/packages/base-package.d.mts +18 -16
  510. package/src/foundry/common/packages/base-system.d.mts +6 -78
  511. package/src/foundry/common/packages/base-world.d.mts +7 -60
  512. package/src/foundry/common/packages/sub-types.d.mts +1 -1
  513. package/src/foundry/common/primitives/array.d.mts +3 -3
  514. package/src/foundry/common/primitives/math.d.mts +7 -1
  515. package/src/foundry/common/primitives/number.d.mts +1 -1
  516. package/src/foundry/common/primitives/set.d.mts +17 -14
  517. package/src/foundry/common/prosemirror/_types.d.mts +2 -0
  518. package/src/foundry/common/prosemirror/dropdown.d.mts +1 -1
  519. package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +1 -1
  520. package/src/foundry/common/prosemirror/menu.d.mts +3 -3
  521. package/src/foundry/common/prosemirror/plugin.d.mts +1 -1
  522. package/src/foundry/common/prosemirror/schema/index.d.mts +0 -1
  523. package/src/foundry/common/prosemirror/util.d.mts +1 -1
  524. package/src/foundry/common/utils/bitmask.d.mts +4 -1
  525. package/src/foundry/common/utils/collection.d.mts +59 -24
  526. package/src/foundry/common/utils/event-emitter.d.mts +46 -19
  527. package/src/foundry/common/utils/helpers.d.mts +13 -13
  528. package/src/foundry/common/utils/http.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/tsconfig.json +1 -5
  532. package/src/types/augments/pixi.d.mts +28 -28
  533. package/src/types/config.d.mts +12 -12
  534. package/src/types/documentConfiguration.d.mts +282 -597
  535. package/src/types/lib.d.mts +4 -4
  536. package/src/types/workers/image-compressor.d.mts +1 -1
  537. package/src/utils/index.d.mts +255 -60
  538. package/tsconfig.json +29 -0
  539. package/tsconfig.main.json +8 -0
  540. package/tsconfig.miscellaneous.json +16 -0
  541. package/src/foundry/client/apps/placeables/light-config.d.mts +0 -100
  542. package/src/foundry/client/apps/placeables/sound-config.d.mts +0 -44
  543. package/src/foundry/common/documents/module.d.mts +0 -35
@@ -1,56 +1,34 @@
1
1
  import type { DeepPartial, EmptyObject, InexactPartial } from "fvtt-types/utils";
2
- import type Document from "../../../common/abstract/document.d.mts";
3
- import type { DirectoryCollectionMixin_DocumentCollection_Interface } from "../abstract/directory-collection-mixin.d.mts";
4
-
5
- declare const DirectoryCollectionMixin_DocumentCollection: DirectoryCollectionMixin_DocumentCollection_Interface;
2
+ import type Document from "#common/abstract/document.d.mts";
3
+ import type { DatabaseCreateOperation } from "#common/abstract/_types.d.mts";
6
4
 
7
5
  declare global {
8
- interface ManageCompendiumRequest extends SocketInterface.SocketRequest {
9
- /**
10
- * The request action.
11
- */
12
- action: string;
13
-
14
- /**
15
- * The compendium creation data, or the ID of the compendium to delete.
16
- */
17
- data: PackageCompendiumData | string;
18
-
19
- /**
20
- * Additional options.
21
- */
22
- options?: Record<string, unknown>;
23
- }
24
-
25
- // @ts-expect-error Bad inheritance
26
- interface ManageCompendiumResponse extends SocketInterface.SocketResponse {
27
- /**
28
- * The original request.
29
- */
30
- request: ManageCompendiumRequest;
6
+ /**
7
+ * @deprecated {@link CompendiumCollection.ManageCompendiumRequest | `CompendiumCollection.ManageCompendiumRequest`}
8
+ */
9
+ type ManageCompendiumRequest = CompendiumCollection.ManageCompendiumRequest;
31
10
 
32
- /**
33
- * The compendium creation data, or the collection name of the deleted compendium.
34
- */
35
- result: PackageCompendiumData | string;
36
- }
11
+ /**
12
+ * @deprecated {@link CompendiumCollection.ManageCompendiumResponse | `CompendiumCollection.ManageCompendiumResponse`}
13
+ */
14
+ type ManageCompendiumResponse = CompendiumCollection.ManageCompendiumResponse;
37
15
 
38
16
  /**
39
17
  * A collection of Document objects contained within a specific compendium pack.
40
18
  * Each Compendium pack has its own associated instance of the CompendiumCollection class which contains its contents.
41
19
  *
42
- * @see {@link Game#packs}
20
+ * @see {@link Game.packs | `Game#packs`}
43
21
  */
44
- class CompendiumCollection<
45
- T extends CompendiumCollection.Metadata,
46
- > extends DirectoryCollectionMixin_DocumentCollection<Document.ConfiguredClassForName<T["type"]>, T["name"]> {
22
+ class CompendiumCollection<T extends CompendiumCollection.Metadata> extends DirectoryCollectionMixin(
23
+ DocumentCollection,
24
+ )<Document.ImplementationClassFor<T["type"]>, T["name"]> {
47
25
  /** @param metadata - The compendium metadata, an object provided by game.data */
48
26
  constructor(metadata: CompendiumCollection.ConstructorMetadata<T>);
49
27
 
50
28
  /** The compendium metadata which defines the compendium content and location */
51
29
  metadata: T;
52
30
 
53
- /** A subsidiary collection which contains the more minimal index of the pack */
31
+ /** A subsidiary collection which contains the more minimal index of the pack */
54
32
  index: IndexTypeForMetadata<T>;
55
33
 
56
34
  /**
@@ -97,14 +75,14 @@ declare global {
97
75
  /**
98
76
  * Get the Folder that this Compendium is displayed within
99
77
  */
100
- get folder(): (Folder.ConfiguredInstance & { type: "Compendium" }) | null;
78
+ get folder(): (Folder.Implementation & { type: "Compendium" }) | null;
101
79
 
102
80
  /**
103
81
  * Assign this CompendiumCollection to be organized within a specific Folder.
104
82
  * @param folder - The desired Folder within the World or null to clear the folder
105
83
  * @returns A promise which resolves once the transaction is complete
106
84
  */
107
- setFolder(folder: Folder | string | null): Promise<void>;
85
+ setFolder(folder: Folder.Implementation | string | null): Promise<void>;
108
86
 
109
87
  /**
110
88
  * Get the sort order for this Compendium
@@ -113,7 +91,10 @@ declare global {
113
91
 
114
92
  // Note(LukeAbby): The override for `_getVisibleTreeContents` become unreasonably long and don't add any changes and so has been omitted.
115
93
 
116
- static _sortStandard(a: number, b: number): number;
94
+ static _sortStandard(
95
+ a: DirectoryCollectionMixin.StandardSortEntry,
96
+ b: DirectoryCollectionMixin.StandardSortEntry,
97
+ ): number;
117
98
 
118
99
  /** Access the compendium configuration data for this pack */
119
100
  get config(): CompendiumCollection.Configuration | EmptyObject;
@@ -150,7 +131,7 @@ declare global {
150
131
 
151
132
  // NOTE(LukeAbby): This override was disabled for the time being because it's erroring.
152
133
  // Thankfully it doesn't actually change its parent class's signature.
153
- // set(id: string, document: Document.Stored<Document.ConfiguredInstanceForName<T["type"]>>): this;
134
+ // set(id: string, document: Document.Stored<Document.ImplementationFor<T["type"]>>): this;
154
135
 
155
136
  delete: (id: string) => boolean;
156
137
 
@@ -168,7 +149,7 @@ declare global {
168
149
  * @param id - The requested Document id
169
150
  * @returns The retrieved Document instance
170
151
  */
171
- getDocument(id: string): Promise<Document.Stored<Document.ConfiguredInstanceForName<T["type"]>> | undefined | null>;
152
+ getDocument(id: string): Promise<Document.Stored<Document.ImplementationFor<T["type"]>> | undefined | null>;
172
153
 
173
154
  /**
174
155
  * Load multiple documents from the Compendium pack using a provided query object.
@@ -191,16 +172,14 @@ declare global {
191
172
  * await pack.getDocuments({ type__in: ["weapon", "armor"] });
192
173
  * ```
193
174
  */
194
- getDocuments(
195
- query?: Record<string, unknown>,
196
- ): Promise<Document.Stored<Document.ConfiguredInstanceForName<T["type"]>>[]>;
175
+ getDocuments(query?: Record<string, unknown>): Promise<Document.Stored<Document.ImplementationFor<T["type"]>>[]>;
197
176
 
198
177
  /**
199
178
  * Get the ownership level that a User has for this Compendium pack.
200
179
  * @param user - The user being tested
201
180
  * @returns The ownership level in CONST.DOCUMENT_OWNERSHIP_LEVELS
202
181
  */
203
- getUserLevel(user?: User): foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
182
+ getUserLevel(user?: User.Implementation): foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
204
183
 
205
184
  /**
206
185
  * Test whether a certain User has a requested permission level (or greater) over the Compendium pack
@@ -210,7 +189,7 @@ declare global {
210
189
  * @returns Does the user have this permission level over the Compendium pack?
211
190
  */
212
191
  testUserPermission(
213
- user: User,
192
+ user: User.Implementation,
214
193
  permission: string | number,
215
194
  options?: InexactPartial<{
216
195
  /**
@@ -224,14 +203,14 @@ declare global {
224
203
  /**
225
204
  * Import a Document into this Compendium Collection.
226
205
  * @param document - The existing Document you wish to import
227
- * @param options - Additional options which modify how the data is imported. See {@link ClientDocument#toCompendium}
206
+ * @param options - Additional options which modify how the data is imported. See {@link ClientDocument.toCompendium | `ClientDocument#toCompendium`}
228
207
  * (default: `{}`)
229
208
  * @returns The imported Document instance
230
209
  */
231
210
  importDocument(
232
- document: Document.ConfiguredInstanceForName<T["type"]>,
233
- options?: InexactPartial<ClientDocument.CompendiumExportOptions>,
234
- ): Promise<Document.Stored<Document.ConfiguredInstanceForName<T["type"]>> | undefined>;
211
+ document: Document.ImplementationFor<T["type"]>,
212
+ options?: InexactPartial<ClientDocument.ToCompendiumOptions>,
213
+ ): Promise<Document.Stored<Document.ImplementationFor<T["type"]>> | undefined>;
235
214
 
236
215
  /**
237
216
  * Import a Folder into this Compendium Collection.
@@ -239,7 +218,7 @@ declare global {
239
218
  * @param options - Additional options which modify how the data is imported.
240
219
  */
241
220
  importFolder(
242
- folder: Folder,
221
+ folder: Folder.Implementation,
243
222
  options?: InexactPartial<{
244
223
  /**
245
224
  * Import any parent folders which are not already present in the Compendium
@@ -255,7 +234,7 @@ declare global {
255
234
  * @param options - Additional options which modify how the data is imported.
256
235
  */
257
236
  importFolders(
258
- folders: Folder[],
237
+ folders: Folder.Implementation[],
259
238
  options?: InexactPartial<{
260
239
  /**
261
240
  * Import any parent folders which are not already present in the Compendium
@@ -268,7 +247,7 @@ declare global {
268
247
  /**
269
248
  * Fully import the contents of a Compendium pack into a World folder.
270
249
  * @param options - Options which modify the import operation. Additional options are forwarded to
271
- * {@link WorldCollection#fromCompendium} and {@link Document.createDocuments}
250
+ * {@link WorldCollection.fromCompendium | `WorldCollection#fromCompendium`} and {@link Document.createDocuments | `Document.createDocuments`}
272
251
  * (default: `{}`)
273
252
  * @returns The imported Documents, now existing within the World
274
253
  */
@@ -285,10 +264,10 @@ declare global {
285
264
  * @defaultValue `""`
286
265
  * */
287
266
  folderName: string;
288
- } & Document.OnCreateOptions<this["metadata"]["type"]> &
267
+ } & Document.Database.CreateOperation<DatabaseCreateOperation> &
289
268
  WorldCollection.FromCompendiumOptions
290
269
  >,
291
- ): Promise<Document.Stored<Document.ConfiguredInstanceForName<T["type"]>>[]>;
270
+ ): Promise<Document.Stored<Document.ImplementationFor<T["type"]>>[]>;
292
271
 
293
272
  /**
294
273
  * Provide a dialog form that prompts the user to import the full contents of a Compendium pack into the World.
@@ -300,13 +279,13 @@ declare global {
300
279
  */
301
280
  importDialog(
302
281
  options?: Dialog.Options,
303
- ): Promise<Document.Stored<Document.ConfiguredInstanceForName<T["type"]>>[] | null | false>;
282
+ ): Promise<Document.Stored<Document.ImplementationFor<T["type"]>>[] | null | false>;
304
283
 
305
284
  /**
306
285
  * Add a Document to the index, capturing it's relevant index attributes
307
286
  * @param document -The document to index
308
287
  */
309
- indexDocument(document: Document.Stored<Document.ConfiguredInstanceForName<T["type"]>>): void;
288
+ indexDocument(document: Document.Stored<Document.ImplementationFor<T["type"]>>): void;
310
289
 
311
290
  /**
312
291
  * Prompt the gamemaster with a dialog to configure ownership of this Compendium pack.
@@ -325,12 +304,12 @@ declare global {
325
304
  * Create a new Compendium Collection using provided metadata.
326
305
  * @param metadata - The compendium metadata used to create the new pack
327
306
  * @param options - Additional options which modify the Compendium creation request
328
- * default `{}`
307
+ * (default: `{}`)
329
308
  */
330
309
  static createCompendium<T extends CompendiumCollection.Metadata>(
331
- this: abstract new (arg0: never, ...args: never[]) => CompendiumCollection<T>,
310
+ this: abstract new (...args: never) => CompendiumCollection<T>,
332
311
  metadata: CompendiumCollection.CreateCompendiumMetadata<NoInfer<T>>,
333
- options?: Document.OnCreateOptions<T["type"]>,
312
+ options?: unknown,
334
313
  ): Promise<CompendiumCollection<T>>;
335
314
 
336
315
  /**
@@ -385,7 +364,7 @@ declare global {
385
364
  }
386
365
 
387
366
  namespace CompendiumCollection {
388
- type Any = CompendiumCollection<any>;
367
+ interface Any extends CompendiumCollection<any> {}
389
368
 
390
369
  interface Configuration {
391
370
  ownership: InexactPartial<foundry.packages.BasePackage.OwnershipRecord>;
@@ -402,7 +381,7 @@ declare global {
402
381
  // The type that's passed to `new CompendiumCollection(...)`
403
382
  type ConstructorMetadata<T extends CompendiumCollection.Metadata> = T & {
404
383
  index: IndexTypeForMetadata<T>;
405
- folders: Folder[];
384
+ folders: Folder.Implementation[];
406
385
  };
407
386
 
408
387
  // The type that appears in `compendium.metadata` after initialization.
@@ -428,13 +407,47 @@ declare global {
428
407
  * An array of fields to return as part of the index
429
408
  * @defaultValue `[]`
430
409
  */
431
- fields?: (keyof Document.ConfiguredInstanceForName<T["type"]>["_source"])[];
410
+ fields?: (keyof Document.ImplementationFor<T["type"]>["_source"])[];
432
411
  }
433
412
 
434
413
  // TODO: Improve automatic index properties based on document type
435
414
  type IndexEntry<T extends CompendiumCollection.Metadata> = { _id: string; uuid: string } & DeepPartial<
436
- Document.ConfiguredInstanceForName<T["type"]>["_source"]
415
+ Document.ImplementationFor<T["type"]>["_source"]
437
416
  >;
417
+
418
+ type ForDocument<Name extends Document.Type> = Name extends unknown
419
+ ? CompendiumCollection<Metadata & { type: Name }>
420
+ : never;
421
+
422
+ interface ManageCompendiumRequest extends SocketInterface.SocketRequest {
423
+ /**
424
+ * The request action.
425
+ */
426
+ action: string;
427
+
428
+ /**
429
+ * The compendium creation data, or the ID of the compendium to delete.
430
+ */
431
+ data: PackageCompendiumData | string;
432
+
433
+ /**
434
+ * Additional options.
435
+ */
436
+ options?: Record<string, unknown>;
437
+ }
438
+
439
+ // @ts-expect-error Bad inheritance
440
+ interface ManageCompendiumResponse extends SocketInterface.SocketResponse {
441
+ /**
442
+ * The original request.
443
+ */
444
+ request: ManageCompendiumRequest;
445
+
446
+ /**
447
+ * The compendium creation data, or the collection name of the deleted compendium.
448
+ */
449
+ result: PackageCompendiumData | string;
450
+ }
438
451
  }
439
452
  }
440
453
 
@@ -450,7 +463,7 @@ interface ImportAllOptions {
450
463
  * */
451
464
  folderName?: string | undefined;
452
465
  /**
453
- * Additional options forwarded to {@link WorldCollection#fromCompendium} and {@link Document.createDocuments}
466
+ * Additional options forwarded to {@link WorldCollection.fromCompendium | `WorldCollection#fromCompendium`} and {@link Document.createDocuments | `Document.createDocuments`}
454
467
  * @defaultValue `{}`
455
468
  */
456
469
  options?: (Document.ModificationContext<Document.Any | null> & WorldCollection.FromCompendiumOptions) | undefined;
@@ -4,14 +4,14 @@ declare global {
4
4
  /**
5
5
  * A Collection of Folder documents within a Compendium pack.
6
6
  */
7
- class CompendiumFolderCollection extends DocumentCollection<typeof Folder, "Folders"> {
8
- constructor(pack: CompendiumPacks, data: Folder["_source"][]);
7
+ class CompendiumFolderCollection extends DocumentCollection<Folder.ImplementationClass, "Folders"> {
8
+ constructor(pack: CompendiumPacks, data: Folder.Source[]);
9
9
 
10
10
  pack: CompendiumPacks;
11
11
 
12
12
  get documentName(): "Folder";
13
13
 
14
- override render(force?: boolean, options?: ApplicationOptions): void;
14
+ override render(force?: boolean, options?: Application.Options): void;
15
15
 
16
16
  /**
17
17
  * @privateRemarks Possible this causes depth issues, this is just a small extension in the code with no meaningful transformations
@@ -19,9 +19,9 @@ declare global {
19
19
  // updateAll(
20
20
  // transformation:
21
21
  // | DeepPartial<Folder["_source"]>
22
- // | ((doc: foundry.abstract.Document.Stored<Folder>) => DeepPartial<Folder["_source"]>),
23
- // condition?: ((obj: foundry.abstract.Document.Stored<Folder>) => boolean) | null,
22
+ // | ((doc: foundry.abstract.Folder.Stored) => DeepPartial<Folder["_source"]>),
23
+ // condition?: ((obj: foundry.abstract.Folder.Stored) => boolean) | null,
24
24
  // options?: foundry.abstract.Document.OnUpdateOptions<"Folder">,
25
- // ): Promise<Folder.ConfiguredInstance[]>;
25
+ // ): Promise<Folder.Implementation[]>;
26
26
  }
27
27
  }
@@ -1,9 +1,9 @@
1
- import type { DirectoryCollectionMixin_Collection_Interface } from "../abstract/directory-collection-mixin.d.mts";
2
-
3
- declare const DirectoryCollectionMixin_Collection: DirectoryCollectionMixin_Collection_Interface;
1
+ export {};
4
2
 
5
3
  declare global {
6
- class CompendiumPacks extends DirectoryCollectionMixin_Collection {
4
+ class CompendiumPacks extends DirectoryCollectionMixin(Collection)<
5
+ CompendiumCollection<CompendiumCollection.Metadata>
6
+ > {
7
7
  /**
8
8
  * Get a Collection of Folders which contain Compendium Packs
9
9
  */
@@ -1,11 +1,12 @@
1
- export {};
1
+ import type { Identity } from "fvtt-types/utils";
2
+ import type Document from "#common/abstract/document.d.mts";
2
3
 
3
4
  declare global {
4
5
  /**
5
6
  * The singleton collection of FogExploration documents which exist within the active World.
6
- * @see {@link FogExploration} The FogExploration document
7
+ * @see {@link FogExploration | `FogExploration`} The FogExploration document
7
8
  */
8
- class FogExplorations extends WorldCollection<typeof foundry.documents.BaseFogExploration, "FogExplorations"> {
9
+ class FogExplorations extends WorldCollection<FogExploration.ImplementationClass, "FogExplorations"> {
9
10
  static documentName: "FogExploration";
10
11
 
11
12
  /**
@@ -16,11 +17,14 @@ declare global {
16
17
  }
17
18
 
18
19
  namespace FogExplorations {
19
- type Any = AnyFogExplorations;
20
- type AnyConstructor = typeof AnyFogExplorations;
20
+ interface Any extends AnyFogExplorations {}
21
+ interface AnyConstructor extends Identity<typeof AnyFogExplorations> {}
22
+
23
+ interface ConfiguredClass extends Document.ConfiguredCollectionClass<"FogExploration"> {}
24
+ interface Configured extends Document.ConfiguredCollection<"FogExploration"> {}
21
25
  }
22
26
  }
23
27
 
24
28
  declare abstract class AnyFogExplorations extends FogExplorations {
25
- constructor(arg0: never, ...args: never[]);
29
+ constructor(...args: never);
26
30
  }
@@ -1,13 +1,15 @@
1
- import type { DatabaseAction, DatabaseOperationMap } from "../../../common/abstract/_types.d.mts";
1
+ import type { Identity } from "fvtt-types/utils";
2
+ import type { DatabaseAction, DatabaseOperationMap } from "#common/abstract/_types.d.mts";
3
+ import type Document from "#common/abstract/document.d.mts";
2
4
 
3
5
  declare global {
4
6
  /**
5
7
  * The singleton collection of Folder documents which exist within the active World.
6
8
  * This Collection is accessible within the Game object as game.fog.
7
9
  *
8
- * @see {@link Folder} The Folder document
10
+ * @see {@link Folder | `Folder`} The Folder document
9
11
  */
10
- class Folders extends WorldCollection<typeof foundry.documents.BaseFolder, "Folders"> {
12
+ class Folders extends WorldCollection<Folder.ImplementationClass, "Folders"> {
11
13
  static documentName: "Folder";
12
14
 
13
15
  /**
@@ -17,10 +19,10 @@ declare global {
17
19
 
18
20
  _onModifyContents<A extends DatabaseAction>(
19
21
  action: A,
20
- documents: Folder.ConfiguredInstance[],
21
- result: foundry.documents.BaseFolder.UpdateData[] | readonly string[],
22
+ documents: readonly Folder.Implementation[],
23
+ result: readonly foundry.documents.BaseFolder.UpdateData[] | readonly string[],
22
24
  operation: DatabaseOperationMap[A],
23
- user: User.ConfiguredInstance,
25
+ user: User.Implementation,
24
26
  ): void;
25
27
 
26
28
  /**
@@ -28,15 +30,18 @@ declare global {
28
30
  */
29
31
  protected _refreshJournalEntrySheets(): void;
30
32
 
31
- render(force?: boolean, context?: ApplicationOptions): void;
33
+ render(force?: boolean, context?: Application.Options): void;
32
34
  }
33
35
 
34
36
  namespace Folders {
35
- type Any = AnyFolders;
36
- type AnyConstructor = typeof AnyFolders;
37
+ interface Any extends AnyFolders {}
38
+ interface AnyConstructor extends Identity<typeof AnyFolders> {}
39
+
40
+ interface ConfiguredClass extends Document.ConfiguredCollectionClass<"Folder"> {}
41
+ interface Configured extends Document.ConfiguredCollection<"Folder"> {}
37
42
  }
38
43
  }
39
44
 
40
45
  declare abstract class AnyFolders extends Folders {
41
- constructor(arg0: never, ...args: never[]);
46
+ constructor(...args: never);
42
47
  }
@@ -1,23 +1,27 @@
1
- export {};
1
+ import type { Identity } from "fvtt-types/utils";
2
+ import type Document from "#common/abstract/document.d.mts";
2
3
 
3
4
  declare global {
4
5
  /**
5
6
  * The singleton collection of Item documents which exist within the active World.
6
7
  * This Collection is accessible within the Game object as game.items.
7
8
  *
8
- * @see {@link Item} The Item document
9
- * @see {@link ItemDirectory} The ItemDirectory sidebar directory
9
+ * @see {@link Item | `Item`} The Item document
10
+ * @see {@link ItemDirectory | `ItemDirectory`} The ItemDirectory sidebar directory
10
11
  */
11
- class Items extends WorldCollection<typeof foundry.documents.BaseItem, "Items"> {
12
+ class Items extends WorldCollection<Item.ImplementationClass, "Items"> {
12
13
  static documentName: "Item";
13
14
  }
14
15
 
15
16
  namespace Items {
16
- type Any = AnyItems;
17
- type AnyConstructor = typeof AnyItems;
17
+ interface Any extends AnyItems {}
18
+ interface AnyConstructor extends Identity<typeof AnyItems> {}
19
+
20
+ interface ConfiguredClass extends Document.ConfiguredCollectionClass<"Item"> {}
21
+ interface Configured extends Document.ConfiguredCollection<"Item"> {}
18
22
  }
19
23
  }
20
24
 
21
25
  declare abstract class AnyItems extends Items {
22
- constructor(arg0: never, ...args: never[]);
26
+ constructor(...args: never);
23
27
  }
@@ -1,21 +1,24 @@
1
- import type { InexactPartial } from "fvtt-types/utils";
1
+ import type { InexactPartial, Identity } from "fvtt-types/utils";
2
+ import type Document from "#common/abstract/document.d.mts";
2
3
 
3
4
  declare global {
4
5
  /**
5
6
  * The singleton collection of JournalEntry documents which exist within the active World.
6
7
  * This Collection is accessible within the Game object as game.journal.
7
8
  *
8
- * @see {@link JournalEntry} The JournalEntry document
9
- * @see {@link JournalDirectory} The JournalDirectory sidebar directory
9
+ * @see {@link JournalEntry | `JournalEntry`} The JournalEntry document
10
+ * @see {@link JournalDirectory | `JournalDirectory`} The JournalDirectory sidebar directory
10
11
  */
11
- class Journal extends WorldCollection<typeof foundry.documents.BaseJournalEntry, "Journal"> {
12
+ class Journal extends WorldCollection<JournalEntry.ImplementationClass, "Journal"> {
12
13
  static documentName: "JournalEntry";
13
14
 
14
15
  /**
15
16
  * Display a dialog which prompts the user to show a JournalEntry or JournalEntryPage to other players.
16
17
  * @param doc - The JournalEntry or JournalEntryPage to show.
17
18
  */
18
- static showDialog<T extends JournalEntry | JournalEntryPage>(doc: T): Promise<T | void>;
19
+ static showDialog<T extends JournalEntry.Implementation | JournalEntryPage.Implementation>(
20
+ doc: T,
21
+ ): Promise<T | void>;
19
22
 
20
23
  /**
21
24
  * Show the JournalEntry or JournalEntryPage to connected players.
@@ -26,7 +29,7 @@ declare global {
26
29
  * @returns A Promise that resolves back to the shown document once the request is processed.
27
30
  * @throws If the user does not own the document they are trying to show.
28
31
  */
29
- static show<T extends JournalEntry | JournalEntryPage>(
32
+ static show<T extends JournalEntry.Implementation | JournalEntryPage.Implementation>(
30
33
  doc: T,
31
34
  options?: InexactPartial<{
32
35
  /**
@@ -49,7 +52,7 @@ declare global {
49
52
 
50
53
  /**
51
54
  * Open Socket listeners which transact JournalEntry data
52
- * @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners}
55
+ * @remarks This is not marked as protected because it is used in {@link Game.activateSocketListeners | `Game#activateSocketListeners`}
53
56
  */
54
57
  protected static _activateSocketListeners(socket: io.Socket): void;
55
58
 
@@ -63,11 +66,14 @@ declare global {
63
66
  }
64
67
 
65
68
  namespace Journal {
66
- type Any = AnyJournal;
67
- type AnyConstructor = typeof AnyJournal;
69
+ interface Any extends AnyJournal {}
70
+ interface AnyConstructor extends Identity<typeof AnyJournal> {}
71
+
72
+ interface ConfiguredClass extends Document.ConfiguredCollectionClass<"JournalEntry"> {}
73
+ interface Configured extends Document.ConfiguredCollection<"JournalEntry"> {}
68
74
  }
69
75
  }
70
76
 
71
77
  declare abstract class AnyJournal extends Journal {
72
- constructor(arg0: never, ...args: never[]);
78
+ constructor(...args: never);
73
79
  }
@@ -1,41 +1,34 @@
1
- import type { InexactPartial } from "fvtt-types/utils";
1
+ import type { Identity } from "fvtt-types/utils";
2
+ import type Document from "#common/abstract/document.d.mts";
2
3
 
3
4
  declare global {
4
5
  /**
5
6
  * The singleton collection of Macro documents which exist within the active World.
6
7
  * This Collection is accessible within the Game object as game.macros.
7
8
  *
8
- * @see {@link Macro} The Macro document
9
- * @see {@link MacroDirectory} The MacroDirectory sidebar directory
9
+ * @see {@link Macro | `Macro`} The Macro document
10
+ * @see {@link MacroDirectory | `MacroDirectory`} The MacroDirectory sidebar directory
10
11
  */
11
- class Macros extends WorldCollection<typeof foundry.documents.BaseMacro, "Macros"> {
12
+ class Macros extends WorldCollection<Macro.ImplementationClass, "Macros"> {
12
13
  static documentName: "Macro";
13
14
 
14
15
  override get directory(): typeof ui.macros;
15
16
 
16
- override fromCompendium<
17
- FolderOpt extends boolean = false,
18
- SortOpt extends boolean = true,
19
- OwnershipOpt extends boolean = false,
20
- IdOpt extends boolean = false,
21
- >(
22
- document: Macro.ConfiguredInstance | foundry.documents.BaseMacro.ConstructorData,
23
- options?: InexactPartial<WorldCollection.FromCompendiumOptions<FolderOpt, SortOpt, OwnershipOpt, IdOpt>>,
24
- ): Omit<
25
- Macro["_source"],
26
- | ClientDocument.OmitProperty<FolderOpt, "folder">
27
- | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
28
- | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
29
- | (IdOpt extends false ? "_id" : never)
30
- >;
17
+ override fromCompendium<Options extends WorldCollection.FromCompendiumOptions | undefined>(
18
+ document: Macro.Implementation | Macro.CreateData,
19
+ options?: Options,
20
+ ): WorldCollection.FromCompendiumReturnType<Macro.ImplementationClass, Options>;
31
21
  }
32
22
 
33
23
  namespace Macros {
34
- type Any = AnyMacros;
35
- type AnyConstructor = typeof AnyMacros;
24
+ interface Any extends AnyMacros {}
25
+ interface AnyConstructor extends Identity<typeof AnyMacros> {}
26
+
27
+ interface ConfiguredClass extends Document.ConfiguredCollectionClass<"Macro"> {}
28
+ interface Configured extends Document.ConfiguredCollection<"Macro"> {}
36
29
  }
37
30
  }
38
31
 
39
32
  declare abstract class AnyMacros extends Macros {
40
- constructor(arg0: never, ...args: never[]);
33
+ constructor(...args: never);
41
34
  }
@@ -1,14 +1,15 @@
1
- import type Document from "../../../common/abstract/document.d.mts";
1
+ import type { Identity } from "fvtt-types/utils";
2
+ import type Document from "#common/abstract/document.d.mts";
2
3
 
3
4
  declare global {
4
5
  /**
5
6
  * The singleton collection of ChatMessage documents which exist within the active World.
6
7
  * This Collection is accessible within the Game object as game.messages.
7
8
  *
8
- * @see {@link ChatMessage} The ChatMessage document
9
- * @see {@link ChatLog} The ChatLog sidebar directory
9
+ * @see {@link ChatMessage | `ChatMessage`} The ChatMessage document
10
+ * @see {@link ChatLog | `ChatLog`} The ChatLog sidebar directory
10
11
  */
11
- class Messages extends WorldCollection<typeof foundry.documents.BaseChatMessage, "Messages"> {
12
+ class Messages extends WorldCollection<ChatMessage.ImplementationClass, "Messages"> {
12
13
  static documentName: "ChatMessage";
13
14
 
14
15
  override get directory(): typeof ui.chat;
@@ -19,7 +20,7 @@ declare global {
19
20
  * If requested, dispatch a Chat Bubble UI for the newly created message
20
21
  * @param message - The ChatMessage document to say
21
22
  */
22
- sayBubble(message: ChatMessage.ConfiguredInstance): void;
23
+ sayBubble(message: ChatMessage.Implementation): void;
23
24
 
24
25
  /**
25
26
  * Handle export of the chat log to a text file
@@ -28,17 +29,20 @@ declare global {
28
29
 
29
30
  /**
30
31
  * Allow for bulk deletion of all chat messages, confirm first with a yes/no dialog.
31
- * @see {@link Dialog.confirm}
32
+ * @see {@link Dialog.confirm | `Dialog.confirm`}
32
33
  */
33
- flush(): Promise<Promise<Document.Stored<ChatMessage.ConfiguredInstance>[]> | false | null>;
34
+ flush(): Promise<Promise<ChatMessage.Stored[]> | false | null>;
34
35
  }
35
36
 
36
37
  namespace Messages {
37
- type Any = AnyMessages;
38
- type AnyConstructor = typeof AnyMessages;
38
+ interface Any extends AnyMessages {}
39
+ interface AnyConstructor extends Identity<typeof AnyMessages> {}
40
+
41
+ interface ConfiguredClass extends Document.ConfiguredCollectionClass<"ChatMessage"> {}
42
+ interface Configured extends Document.ConfiguredCollection<"ChatMessage"> {}
39
43
  }
40
44
  }
41
45
 
42
46
  declare abstract class AnyMessages extends Messages {
43
- constructor(arg0: never, ...args: never[]);
47
+ constructor(...args: never);
44
48
  }