@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.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.
- package/README.md +8 -6
- package/package.json +34 -40
- package/src/configuration/configuration.d.mts +52 -18
- package/src/configuration/documents.d.mts +35 -14
- package/src/configuration/globals.d.mts +70 -115
- package/src/configuration/hooks.d.mts +96 -0
- package/src/configuration/index.d.mts +1 -0
- package/src/foundry/client/_types.d.mts +98 -0
- package/src/foundry/client/applications/_module.d.mts +30 -0
- package/src/foundry/client/applications/api/application.d.mts +966 -0
- package/src/foundry/client/applications/api/category-browser.d.mts +130 -0
- package/src/foundry/client/applications/api/dialog.d.mts +641 -0
- package/src/foundry/client/applications/api/document-sheet.d.mts +207 -0
- package/src/foundry/client/applications/api/handlebars-application.d.mts +240 -0
- package/src/foundry/client/applications/apps/av/camera-popout.d.mts +44 -0
- package/src/foundry/client/applications/apps/av/cameras.d.mts +118 -0
- package/src/foundry/client/applications/apps/combat-tracker-config.d.mts +45 -0
- package/src/foundry/client/applications/apps/compendium-art-config.d.mts +73 -0
- package/src/foundry/client/applications/apps/document-ownership.d.mts +51 -0
- package/src/foundry/client/applications/apps/document-sheet-config.d.mts +109 -0
- package/src/foundry/client/applications/apps/file-picker.d.mts +453 -0
- package/src/foundry/client/applications/apps/grid-config.d.mts +51 -0
- package/src/foundry/client/applications/apps/image-popout.d.mts +111 -0
- package/src/foundry/client/applications/apps/permission-config.d.mts +79 -0
- package/src/foundry/client/applications/dice/roll-resolver.d.mts +125 -0
- package/src/foundry/client/applications/elements/document-tags.d.mts +93 -0
- package/src/foundry/client/applications/elements/file-picker.d.mts +63 -0
- package/src/foundry/client/applications/elements/form-element.d.mts +108 -0
- package/src/foundry/client/applications/elements/multi-select.d.mts +107 -0
- package/src/foundry/client/applications/elements/prosemirror-editor.d.mts +54 -0
- package/src/foundry/client/applications/forms/fields.d.mts +271 -0
- package/src/foundry/client/applications/handlebars.d.mts +475 -0
- package/src/foundry/client/applications/hud/container.d.mts +50 -0
- package/src/foundry/client/applications/hud/drawing-hud.d.mts +47 -0
- package/src/foundry/client/applications/hud/placeable-hud.d.mts +66 -0
- package/src/foundry/client/applications/hud/tile-hud.d.mts +43 -0
- package/src/foundry/client/applications/hud/token-hud.d.mts +48 -0
- package/src/foundry/client/applications/quickstart.d.mts +45 -0
- package/src/foundry/client/applications/settings/_module.d.mts +8 -0
- package/src/foundry/client/applications/settings/config.d.mts +63 -0
- package/src/foundry/client/applications/settings/dependency-resolution.d.mts +40 -0
- package/src/foundry/client/applications/settings/menus/av-config.d.mts +50 -0
- package/src/foundry/client/applications/settings/menus/default-sheets-config.d.mts +49 -0
- package/src/foundry/client/applications/settings/menus/dice-config.d.mts +38 -0
- package/src/foundry/client/applications/settings/menus/font-config.d.mts +66 -0
- package/src/foundry/client/applications/settings/menus/prototype-overrides.d.mts +47 -0
- package/src/foundry/client/applications/settings/menus/ui-config.d.mts +49 -0
- package/src/foundry/client/applications/sheets/_module.d.mts +39 -0
- package/src/foundry/client/applications/sheets/active-effect-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/actor-sheet.d.mts +56 -0
- package/src/foundry/client/applications/sheets/adventure-exporter.d.mts +51 -0
- package/src/foundry/client/applications/sheets/adventure-importer.d.mts +49 -0
- package/src/foundry/client/applications/sheets/ambient-light-config.d.mts +115 -0
- package/src/foundry/client/applications/sheets/ambient-sound-config.d.mts +77 -0
- package/src/foundry/client/applications/sheets/base-sheet.d.mts +53 -0
- package/src/foundry/client/applications/sheets/card-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/cards-config.d.mts +135 -0
- package/src/foundry/client/applications/sheets/combatant-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/drawing-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/folder-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/item-sheet.d.mts +48 -0
- package/src/foundry/client/applications/sheets/journal/dialog-show.d.mts +42 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-category-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-hbs-sheet.d.mts +41 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-image-sheet.d.mts +38 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-markdown-sheet.d.mts +38 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-pdf-sheet.d.mts +38 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-prose-mirror-sheet.d.mts +38 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-sheet.d.mts +50 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-text-sheet.d.mts +38 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-page-video-sheet.d.mts +40 -0
- package/src/foundry/client/applications/sheets/journal/journal-entry-sheet.d.mts +69 -0
- package/src/foundry/client/applications/sheets/macro-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/note-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/playlist-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/playlist-sound-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/region-behavior-config.d.mts +68 -0
- package/src/foundry/client/applications/sheets/region-config.d.mts +76 -0
- package/src/foundry/client/applications/sheets/roll-table-sheet.d.mts +51 -0
- package/src/foundry/client/applications/sheets/scene-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/table-result-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/template-config.d.mts +50 -0
- package/src/foundry/client/applications/sheets/tile-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/token/mixin.d.mts +47 -0
- package/src/foundry/client/applications/sheets/token/prototype-config.d.mts +41 -0
- package/src/foundry/client/applications/sheets/token/token-config.d.mts +51 -0
- package/src/foundry/client/applications/sheets/user-config.d.mts +65 -0
- package/src/foundry/client/applications/sheets/wall-config.d.mts +51 -0
- package/src/foundry/client/applications/sidebar/apps/chat-popout.d.mts +44 -0
- package/src/foundry/client/applications/sidebar/apps/compendium.d.mts +44 -0
- package/src/foundry/client/applications/sidebar/apps/controls-config.d.mts +49 -0
- package/src/foundry/client/applications/sidebar/apps/folder-export.d.mts +40 -0
- package/src/foundry/client/applications/sidebar/apps/frame-viewer.d.mts +44 -0
- package/src/foundry/client/applications/sidebar/apps/invitation-links.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/apps/module-management.d.mts +42 -0
- package/src/foundry/client/applications/sidebar/apps/support-details.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/apps/tours-management.d.mts +61 -0
- package/src/foundry/client/applications/sidebar/apps/world-config.d.mts +40 -0
- package/src/foundry/client/applications/sidebar/document-directory.d.mts +55 -0
- package/src/foundry/client/applications/sidebar/sidebar-tab.d.mts +106 -0
- package/src/foundry/client/applications/sidebar/sidebar.d.mts +129 -0
- package/src/foundry/client/applications/sidebar/tabs/actor-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/cards-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/chat.d.mts +36 -0
- package/src/foundry/client/applications/sidebar/tabs/combat-tracker.d.mts +283 -0
- package/src/foundry/client/applications/sidebar/tabs/compendium-directory.d.mts +40 -0
- package/src/foundry/client/applications/sidebar/tabs/item-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/journal-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/macro-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/playlist-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/roll-table-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/scene-directory.d.mts +39 -0
- package/src/foundry/client/applications/sidebar/tabs/settings.d.mts +39 -0
- package/src/foundry/client/applications/ui/game-pause.d.mts +49 -0
- package/src/foundry/client/applications/ui/hotbar.d.mts +52 -0
- package/src/foundry/client/applications/ui/main-menu.d.mts +50 -0
- package/src/foundry/client/applications/ui/players.d.mts +56 -0
- package/src/foundry/client/applications/ui/region-legend.d.mts +97 -0
- package/src/foundry/client/applications/ui/scene-controls.d.mts +117 -0
- package/src/foundry/client/applications/ui/scene-navigation.d.mts +55 -0
- package/src/foundry/client/applications/ux/context-menu.d.mts +327 -0
- package/src/foundry/client/applications/ux/drag-drop.d.mts +167 -0
- package/src/foundry/client/applications/ux/draggable.d.mts +156 -0
- package/src/foundry/client/applications/ux/form-data-extended.d.mts +89 -0
- package/src/foundry/client/applications/ux/html-secret.d.mts +75 -0
- package/src/foundry/client/applications/ux/prosemirror-editor.d.mts +199 -0
- package/src/foundry/client/applications/ux/search-filter.d.mts +148 -0
- package/src/foundry/client/applications/ux/tabs.d.mts +121 -0
- package/src/foundry/client/applications/ux/text-editor.d.mts +478 -0
- package/src/foundry/client/appv1/api/application-v1.d.mts +608 -0
- package/src/foundry/client/appv1/api/dialog-v1.d.mts +344 -0
- package/src/foundry/client/appv1/api/document-sheet-v1.d.mts +166 -0
- package/src/foundry/client/appv1/api/form-application-v1.d.mts +361 -0
- package/src/foundry/client/appv1/sheets/actor-sheet.d.mts +194 -0
- package/src/foundry/client/appv1/sheets/adventure-importer.d.mts +101 -0
- package/src/foundry/client/appv1/sheets/item-sheet.d.mts +68 -0
- package/src/foundry/client/appv1/sheets/journal-page-sheet.d.mts +179 -0
- package/src/foundry/client/appv1/sheets/journal-sheet.d.mts +325 -0
- package/src/foundry/client/audio/_types.d.mts +18 -0
- package/src/foundry/client/audio/biquad.d.mts +102 -0
- package/src/foundry/client/audio/cache.d.mts +79 -0
- package/src/foundry/client/audio/convolver.d.mts +94 -0
- package/src/foundry/client/audio/helper.d.mts +372 -0
- package/src/foundry/client/audio/sound.d.mts +509 -0
- package/src/foundry/client/audio/timeout.d.mts +101 -0
- package/src/foundry/client/av/client.d.mts +164 -161
- package/src/foundry/client/av/clients/simplepeer.d.mts +159 -156
- package/src/foundry/client/av/master.d.mts +194 -190
- package/src/foundry/client/av/settings.d.mts +323 -233
- package/src/foundry/client/canvas/_module.d.mts +23 -0
- package/src/foundry/client/canvas/animation/_module.d.mts +8 -0
- package/src/foundry/client/canvas/animation/_types.d.mts +20 -0
- package/src/foundry/client/canvas/animation/canvas-animation.d.mts +236 -0
- package/src/foundry/client/canvas/animation/chat-bubbles.d.mts +31 -0
- package/src/foundry/client/canvas/animation/smooth-noise.d.mts +80 -0
- package/src/foundry/client/canvas/board.d.mts +878 -0
- package/src/foundry/client/canvas/containers/_module.d.mts +25 -0
- package/src/foundry/client/canvas/containers/_types.d.mts +14 -0
- package/src/foundry/client/canvas/containers/advanced/cached-container.d.mts +138 -0
- package/src/foundry/client/canvas/containers/advanced/full-canvas-mixin.d.mts +28 -0
- package/src/foundry/client/canvas/containers/advanced/unbound-container.d.mts +21 -0
- package/src/foundry/client/canvas/containers/elements/control-icon.d.mts +129 -0
- package/src/foundry/client/canvas/containers/elements/cursor.d.mts +42 -0
- package/src/foundry/client/canvas/containers/elements/door-control.d.mts +90 -0
- package/src/foundry/client/canvas/containers/elements/door-mesh.d.mts +16 -0
- package/src/foundry/client/canvas/containers/elements/grid-highlight.d.mts +43 -0
- package/src/foundry/client/canvas/containers/elements/grid-mesh.d.mts +103 -0
- package/src/foundry/client/canvas/containers/elements/particles/leaves.d.mts +51 -0
- package/src/foundry/client/canvas/containers/elements/particles/particle-effect.d.mts +57 -0
- package/src/foundry/client/canvas/containers/elements/point-source-mesh.d.mts +73 -0
- package/src/foundry/client/canvas/containers/elements/precise-text.d.mts +46 -0
- package/src/foundry/client/canvas/containers/elements/quad-mesh.d.mts +54 -0
- package/src/foundry/client/canvas/containers/elements/resize-handle.d.mts +83 -0
- package/src/foundry/client/canvas/containers/elements/sprite-mesh.d.mts +370 -0
- package/src/foundry/client/canvas/extensions/_module.d.mts +9 -0
- package/src/foundry/client/canvas/extensions/circle-extension.d.mts +150 -0
- package/src/foundry/client/canvas/extensions/graphics-extension.d.mts +45 -0
- package/src/foundry/client/canvas/extensions/polygon-extension.d.mts +175 -0
- package/src/foundry/client/canvas/extensions/rectangle-extension.d.mts +287 -0
- package/src/foundry/client/canvas/framebuffer-snapshot.d.mts +33 -0
- package/src/foundry/client/canvas/geometry/_module.d.mts +17 -0
- package/src/foundry/client/canvas/geometry/_types.d.mts +34 -0
- package/src/foundry/client/canvas/geometry/clockwise-sweep.d.mts +281 -0
- package/src/foundry/client/canvas/geometry/edges/collision.d.mts +131 -0
- package/src/foundry/client/canvas/geometry/edges/edge.d.mts +258 -0
- package/src/foundry/client/canvas/geometry/edges/edges.d.mts +70 -0
- package/src/foundry/client/canvas/geometry/edges/vertex.d.mts +198 -0
- package/src/foundry/client/canvas/geometry/observable-transform.d.mts +39 -0
- package/src/foundry/client/canvas/geometry/quad-tree.d.mts +324 -0
- package/src/foundry/client/canvas/geometry/shapes/limited-angle-polygon.d.mts +143 -0
- package/src/foundry/client/canvas/geometry/shapes/polygon-mesher.d.mts +141 -0
- package/src/foundry/client/canvas/geometry/shapes/ray.d.mts +177 -0
- package/src/foundry/client/canvas/geometry/shapes/source-polygon.d.mts +368 -0
- package/src/foundry/client/canvas/geometry/unbound-transform.d.mts +22 -0
- package/src/foundry/client/canvas/geometry/weiler-atherton-clipping.d.mts +203 -0
- package/src/foundry/client/canvas/groups/_module.d.mts +14 -0
- package/src/foundry/client/canvas/groups/canvas-group-mixin.d.mts +178 -0
- package/src/foundry/client/canvas/groups/effects.d.mts +248 -0
- package/src/foundry/client/canvas/groups/environment.d.mts +137 -0
- package/src/foundry/client/canvas/groups/hidden.d.mts +65 -0
- package/src/foundry/client/canvas/groups/interface.d.mts +110 -0
- package/src/foundry/client/canvas/groups/overlay.d.mts +40 -0
- package/src/foundry/client/canvas/groups/primary.d.mts +237 -0
- package/src/foundry/client/canvas/groups/rendered.d.mts +39 -0
- package/src/foundry/client/canvas/groups/visibility.d.mts +263 -0
- package/src/foundry/client/canvas/interaction/_module.d.mts +24 -0
- package/src/foundry/client/canvas/interaction/_types.d.mts +18 -0
- package/src/foundry/client/canvas/interaction/mouse-handler.d.mts +362 -0
- package/src/foundry/client/canvas/interaction/ping/alert.d.mts +38 -0
- package/src/foundry/client/canvas/interaction/ping/arrow.d.mts +41 -0
- package/src/foundry/client/canvas/interaction/ping/chevron.d.mts +98 -0
- package/src/foundry/client/canvas/interaction/ping/ping.d.mts +86 -0
- package/src/foundry/client/canvas/interaction/ping/pulse.d.mts +104 -0
- package/src/foundry/client/canvas/interaction/render-flags.d.mts +182 -0
- package/src/foundry/client/canvas/interaction/ruler/base-ruler.d.mts +17 -0
- package/src/foundry/client/canvas/interaction/ruler/ruler.d.mts +498 -0
- package/src/foundry/client/canvas/layers/_module.d.mts +36 -0
- package/src/foundry/client/canvas/layers/_types.d.mts +26 -0
- package/src/foundry/client/canvas/layers/base/canvas-layer.d.mts +91 -0
- package/src/foundry/client/canvas/layers/base/interaction-layer.d.mts +165 -0
- package/src/foundry/client/canvas/layers/base/placeables-layer.d.mts +714 -0
- package/src/foundry/client/canvas/layers/controls.d.mts +288 -0
- package/src/foundry/client/canvas/layers/drawings.d.mts +123 -0
- package/src/foundry/client/canvas/layers/effects/background-effects.d.mts +56 -0
- package/src/foundry/client/canvas/layers/effects/coloration-effects.d.mts +51 -0
- package/src/foundry/client/canvas/layers/effects/darkness-effects.d.mts +42 -0
- package/src/foundry/client/canvas/layers/effects/illumination-effects.d.mts +162 -0
- package/src/foundry/client/canvas/layers/effects/weather-effects.d.mts +316 -0
- package/src/foundry/client/canvas/layers/grid.d.mts +284 -0
- package/src/foundry/client/canvas/layers/lighting.d.mts +92 -0
- package/src/foundry/client/canvas/layers/masks/depth.d.mts +68 -0
- package/src/foundry/client/canvas/layers/masks/occlusion.d.mts +101 -0
- package/src/foundry/client/canvas/layers/masks/vision.d.mts +206 -0
- package/src/foundry/client/canvas/layers/notes.d.mts +138 -0
- package/src/foundry/client/canvas/layers/regions.d.mts +123 -0
- package/src/foundry/client/canvas/layers/sounds.d.mts +345 -0
- package/src/foundry/client/canvas/layers/templates.d.mts +79 -0
- package/src/foundry/client/canvas/layers/tiles.d.mts +136 -0
- package/src/foundry/client/canvas/layers/tokens.d.mts +218 -0
- package/src/foundry/client/canvas/layers/walls.d.mts +218 -0
- package/src/foundry/client/canvas/loader.d.mts +319 -0
- package/src/foundry/client/canvas/perception/_module.d.mts +19 -0
- package/src/foundry/client/canvas/perception/_types.d.mts +12 -0
- package/src/foundry/client/canvas/perception/detection-mode.d.mts +173 -0
- package/src/foundry/client/canvas/perception/detection-modes/darkvision.d.mts +26 -0
- package/src/foundry/client/canvas/perception/detection-modes/invisibility-perception.d.mts +29 -0
- package/src/foundry/client/canvas/perception/detection-modes/light-perception.d.mts +33 -0
- package/src/foundry/client/canvas/perception/detection-modes/super-perception.d.mts +27 -0
- package/src/foundry/client/canvas/perception/detection-modes/tremor-perception.d.mts +26 -0
- package/src/foundry/client/canvas/perception/fog.d.mts +157 -0
- package/src/foundry/client/canvas/perception/perception-manager.d.mts +163 -0
- package/src/foundry/client/canvas/perception/vision-mode.d.mts +249 -0
- package/src/foundry/client/canvas/placeables/_module.d.mts +20 -0
- package/src/foundry/client/canvas/placeables/_types.d.mts +16 -0
- package/src/foundry/client/canvas/placeables/drawing.d.mts +412 -0
- package/src/foundry/client/canvas/placeables/light.d.mts +266 -0
- package/src/foundry/client/canvas/placeables/note.d.mts +203 -0
- package/src/foundry/client/canvas/placeables/placeable-object.d.mts +772 -0
- package/src/foundry/client/canvas/placeables/region.d.mts +275 -0
- package/src/foundry/client/canvas/placeables/regions/_module.d.mts +7 -0
- package/src/foundry/client/canvas/placeables/regions/geometry.d.mts +40 -0
- package/src/foundry/client/canvas/placeables/regions/mesh.d.mts +75 -0
- package/src/foundry/client/canvas/placeables/sound.d.mts +271 -0
- package/src/foundry/client/canvas/placeables/template.d.mts +290 -0
- package/src/foundry/client/canvas/placeables/tile.d.mts +349 -0
- package/src/foundry/client/canvas/placeables/token.d.mts +1295 -0
- package/src/foundry/client/canvas/placeables/tokens/_module.d.mts +13 -0
- package/src/foundry/client/canvas/placeables/tokens/base-ruler.d.mts +77 -0
- package/src/foundry/client/canvas/placeables/tokens/ring-config.d.mts +255 -0
- package/src/foundry/client/canvas/placeables/tokens/ring-data.d.mts +149 -0
- package/src/foundry/client/canvas/placeables/tokens/ring.d.mts +290 -0
- package/src/foundry/client/canvas/placeables/tokens/ruler.d.mts +219 -0
- package/src/foundry/client/canvas/placeables/tokens/targets.d.mts +50 -0
- package/src/foundry/client/canvas/placeables/tokens/turn-marker-data.d.mts +17 -0
- package/src/foundry/client/canvas/placeables/tokens/turn-marker.d.mts +16 -0
- package/src/foundry/client/canvas/placeables/wall.d.mts +393 -0
- package/src/foundry/client/canvas/primary/_module.d.mts +12 -0
- package/src/foundry/client/canvas/primary/primary-canvas-container.d.mts +17 -0
- package/src/foundry/client/canvas/primary/primary-canvas-object.d.mts +201 -0
- package/src/foundry/client/canvas/primary/primary-graphics.d.mts +62 -0
- package/src/foundry/client/canvas/primary/primary-occludable-object.d.mts +205 -0
- package/src/foundry/client/canvas/primary/primary-particle-effect.d.mts +17 -0
- package/src/foundry/client/canvas/primary/primary-sprite-mesh.d.mts +203 -0
- package/src/foundry/client/canvas/rendering/_module.d.mts +10 -0
- package/src/foundry/client/canvas/rendering/batching/_module.d.mts +7 -0
- package/src/foundry/client/canvas/rendering/batching/batch-renderer.d.mts +136 -0
- package/src/foundry/client/canvas/rendering/batching/batch-shader-generator.d.mts +30 -0
- package/src/foundry/client/canvas/rendering/blend-modes.d.mts +49 -0
- package/src/foundry/client/canvas/rendering/filters/_module.d.mts +23 -0
- package/src/foundry/client/canvas/rendering/filters/_types.d.mts +4 -0
- package/src/foundry/client/canvas/rendering/filters/base-filter.d.mts +47 -0
- package/src/foundry/client/canvas/rendering/filters/base-mask-filter.d.mts +32 -0
- package/src/foundry/client/canvas/rendering/filters/blur.d.mts +194 -0
- package/src/foundry/client/canvas/rendering/filters/effects-masking.d.mts +144 -0
- package/src/foundry/client/canvas/rendering/filters/environment.d.mts +43 -0
- package/src/foundry/client/canvas/rendering/filters/glow-overlay.d.mts +78 -0
- package/src/foundry/client/canvas/rendering/filters/invisibility.d.mts +32 -0
- package/src/foundry/client/canvas/rendering/filters/outline-overlay.d.mts +87 -0
- package/src/foundry/client/canvas/rendering/filters/smaa/_types.d.mts +13 -0
- package/src/foundry/client/canvas/rendering/filters/smaa/blend.d.mts +19 -0
- package/src/foundry/client/canvas/rendering/filters/smaa/edges.d.mts +22 -0
- package/src/foundry/client/canvas/rendering/filters/smaa/smaa.d.mts +165 -0
- package/src/foundry/client/canvas/rendering/filters/smaa/weights.d.mts +22 -0
- package/src/foundry/client/canvas/rendering/filters/transition.d.mts +130 -0
- package/src/foundry/client/canvas/rendering/filters/visibility.d.mts +82 -0
- package/src/foundry/client/canvas/rendering/filters/vision-mask-filter.d.mts +38 -0
- package/src/foundry/client/canvas/rendering/filters/void.d.mts +20 -0
- package/src/foundry/client/canvas/rendering/filters/weather-occlusion-mask.d.mts +59 -0
- package/src/foundry/client/canvas/rendering/mixins/_module.d.mts +7 -0
- package/src/foundry/client/canvas/rendering/mixins/base-shader-mixin.d.mts +134 -0
- package/src/foundry/client/canvas/rendering/mixins/fragment-channel-mixin.d.mts +66 -0
- package/src/foundry/client/canvas/rendering/shaders/_module.d.mts +93 -0
- package/src/foundry/client/canvas/rendering/shaders/_types.d.mts +16 -0
- package/src/foundry/client/canvas/rendering/shaders/base-shader.d.mts +109 -0
- package/src/foundry/client/canvas/rendering/shaders/graphics/dash-line.d.mts +48 -0
- package/src/foundry/client/canvas/rendering/shaders/grid/grid.d.mts +122 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/background-lighting.d.mts +69 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/base-lighting.d.mts +179 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/coloration-lighting.d.mts +76 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/darkness-lighting.d.mts +76 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/bewitching-wave.d.mts +37 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/black-hole.d.mts +20 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/chroma.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/dense-smoke.d.mts +20 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/emanation.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/energy-field.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/fairy-light.d.mts +42 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/flame.d.mts +60 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/fog.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/force-grid.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/ghost-light.d.mts +37 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/hexa-dome.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/light-dome.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/magical-gloom.d.mts +20 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/pulse.d.mts +49 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/radial-rainbow.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/revolving-light.d.mts +39 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/roiling-mass.d.mts +20 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/siren-light.d.mts +66 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/smoke-patch.d.mts +37 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/star-light.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/sunburst.d.mts +37 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/swirling-rainbow.d.mts +25 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/torch.d.mts +50 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/vortex.d.mts +42 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/effects/wave.d.mts +37 -0
- package/src/foundry/client/canvas/rendering/shaders/lighting/illumination-lighting.d.mts +79 -0
- package/src/foundry/client/canvas/rendering/shaders/region/adjust-darkness-level.d.mts +137 -0
- package/src/foundry/client/canvas/rendering/shaders/region/base.d.mts +80 -0
- package/src/foundry/client/canvas/rendering/shaders/region/highlight.d.mts +97 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/amplification.d.mts +58 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/base-sampler.d.mts +223 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/baseline-illumination.d.mts +40 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/color-adjustments.d.mts +65 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/colorize-brightness.d.mts +40 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/fog-of-war.d.mts +27 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/primary/depth.d.mts +111 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/primary/occlusion.d.mts +109 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/primary/primary.d.mts +38 -0
- package/src/foundry/client/canvas/rendering/shaders/samplers/primary/token-ring.d.mts +79 -0
- package/src/foundry/client/canvas/rendering/shaders/vision/background-vision.d.mts +67 -0
- package/src/foundry/client/canvas/rendering/shaders/vision/base-vision.d.mts +35 -0
- package/src/foundry/client/canvas/rendering/shaders/vision/coloration-vision.d.mts +67 -0
- package/src/foundry/client/canvas/rendering/shaders/vision/effects/amplification.d.mts +34 -0
- package/src/foundry/client/canvas/rendering/shaders/vision/effects/wave.d.mts +62 -0
- package/src/foundry/client/canvas/rendering/shaders/vision/illumination-vision.d.mts +67 -0
- package/src/foundry/client/canvas/rendering/shaders/weather/base-weather.d.mts +120 -0
- package/src/foundry/client/canvas/rendering/shaders/weather/effect.d.mts +57 -0
- package/src/foundry/client/canvas/rendering/shaders/weather/fog.d.mts +52 -0
- package/src/foundry/client/canvas/rendering/shaders/weather/rain.d.mts +44 -0
- package/src/foundry/client/canvas/rendering/shaders/weather/snow.d.mts +36 -0
- package/src/foundry/client/canvas/scene-manager.d.mts +106 -0
- package/src/foundry/client/canvas/sources/base-effect-source.d.mts +297 -0
- package/src/foundry/client/canvas/sources/base-light-source.d.mts +306 -0
- package/src/foundry/client/canvas/sources/global-light-source.d.mts +141 -0
- package/src/foundry/client/canvas/sources/point-darkness-source.d.mts +160 -0
- package/src/foundry/client/canvas/sources/point-effect-source.d.mts +190 -0
- package/src/foundry/client/canvas/sources/point-light-source.d.mts +131 -0
- package/src/foundry/client/canvas/sources/point-movement-source.d.mts +65 -0
- package/src/foundry/client/canvas/sources/point-sound-source.d.mts +92 -0
- package/src/foundry/client/canvas/sources/point-vision-source.d.mts +357 -0
- package/src/foundry/client/canvas/sources/rendered-effect-source.d.mts +471 -0
- package/src/foundry/client/canvas/texture-extractor.d.mts +171 -0
- package/src/foundry/client/canvas/workers/_module.d.mts +6 -0
- package/src/foundry/client/canvas/workers/texture-worker.d.mts +147 -0
- package/src/foundry/client/client.d.mts +2489 -0
- package/src/foundry/client/config.d.mts +684 -238
- package/src/foundry/client/data/_module.d.mts +13 -0
- package/src/foundry/client/data/calendar.d.mts +341 -0
- package/src/foundry/client/data/client-backend.d.mts +52 -0
- package/src/foundry/client/data/region-behaviors/adjust-darkness-level.d.mts +56 -0
- package/src/foundry/client/data/region-behaviors/base.d.mts +60 -0
- package/src/foundry/client/data/region-behaviors/display-scrolling-text.d.mts +64 -0
- package/src/foundry/client/data/region-behaviors/teleport-token.d.mts +31 -0
- package/src/foundry/client/data/region-behaviors/toggle-behavior.d.mts +31 -0
- package/src/foundry/client/data/region-shapes/_module.d.mts +7 -0
- package/src/foundry/client/data/region-shapes/polygon-tree.d.mts +132 -0
- package/src/foundry/client/data/region-shapes/shape.d.mts +129 -0
- package/src/foundry/client/dice/_types.d.mts +65 -0
- package/src/foundry/client/dice/parser.d.mts +192 -0
- package/src/foundry/client/dice/roll.d.mts +663 -0
- package/src/foundry/client/dice/terms/coin.d.mts +71 -0
- package/src/foundry/client/dice/terms/dice.d.mts +424 -0
- package/src/foundry/client/dice/terms/die.d.mts +248 -0
- package/src/foundry/client/dice/terms/fate.d.mts +57 -0
- package/src/foundry/client/dice/terms/function.d.mts +106 -0
- package/src/foundry/client/dice/terms/numeric.d.mts +54 -0
- package/src/foundry/client/dice/terms/operator.d.mts +55 -0
- package/src/foundry/client/dice/terms/parenthetical.d.mts +104 -0
- package/src/foundry/client/dice/terms/pool.d.mts +272 -0
- package/src/foundry/client/dice/terms/string.d.mts +34 -0
- package/src/foundry/client/dice/terms/term.d.mts +178 -0
- package/src/foundry/client/documents/_module.d.mts +51 -0
- package/src/foundry/client/documents/_types.d.mts +134 -0
- package/src/foundry/client/documents/abstract/_module.d.mts +10 -0
- package/src/foundry/client/documents/abstract/canvas-document.d.mts +67 -0
- package/src/foundry/client/documents/abstract/client-document.d.mts +659 -0
- package/src/foundry/client/documents/abstract/directory-collection-mixin.d.mts +132 -0
- package/src/foundry/client/documents/abstract/document-collection.d.mts +243 -0
- package/src/foundry/client/documents/abstract/world-collection.d.mts +192 -0
- package/src/foundry/client/documents/active-effect.d.mts +977 -0
- package/src/foundry/client/documents/actor-delta.d.mts +769 -0
- package/src/foundry/client/documents/actor.d.mts +1036 -0
- package/src/foundry/client/documents/adventure.d.mts +569 -0
- package/src/foundry/client/documents/ambient-light.d.mts +457 -0
- package/src/foundry/client/documents/ambient-sound.d.mts +511 -0
- package/src/foundry/client/documents/card.d.mts +679 -0
- package/src/foundry/client/documents/cards.d.mts +1017 -0
- package/src/foundry/client/documents/chat-message.d.mts +831 -0
- package/src/foundry/client/documents/collections/_module.d.mts +23 -0
- package/src/foundry/client/documents/collections/actors.d.mts +51 -0
- package/src/foundry/client/documents/collections/card-stacks.d.mts +25 -0
- package/src/foundry/client/documents/collections/chat-messages.d.mts +48 -0
- package/src/foundry/client/documents/collections/combat-encounters.d.mts +56 -0
- package/src/foundry/client/documents/collections/compendium-collection.d.mts +491 -0
- package/src/foundry/client/documents/collections/compendium-folders.d.mts +30 -0
- package/src/foundry/client/documents/collections/compendium-packs.d.mts +30 -0
- package/src/foundry/client/documents/collections/fog-explorations.d.mts +32 -0
- package/src/foundry/client/documents/collections/folders.d.mts +49 -0
- package/src/foundry/client/documents/collections/items.d.mts +27 -0
- package/src/foundry/client/documents/collections/journal.d.mts +78 -0
- package/src/foundry/client/documents/collections/macros.d.mts +34 -0
- package/src/foundry/client/documents/collections/playlists.d.mts +45 -0
- package/src/foundry/client/documents/collections/roll-tables.d.mts +34 -0
- package/src/foundry/client/documents/collections/scenes.d.mts +63 -0
- package/src/foundry/client/documents/collections/users.d.mts +72 -0
- package/src/foundry/client/documents/collections/world-settings.d.mts +44 -0
- package/src/foundry/client/documents/combat.d.mts +1056 -0
- package/src/foundry/client/documents/combatant-group.d.mts +509 -0
- package/src/foundry/client/documents/combatant.d.mts +609 -0
- package/src/foundry/client/documents/drawing.d.mts +580 -0
- package/src/foundry/client/documents/fog-exploration.d.mts +495 -0
- package/src/foundry/client/documents/folder.d.mts +659 -0
- package/src/foundry/client/documents/item.d.mts +736 -0
- package/src/foundry/client/documents/journal-entry-category.d.mts +413 -0
- package/src/foundry/client/documents/journal-entry-page.d.mts +839 -0
- package/src/foundry/client/documents/journal-entry.d.mts +694 -0
- package/src/foundry/client/documents/macro.d.mts +610 -0
- package/src/foundry/client/documents/measured-template.d.mts +509 -0
- package/src/foundry/client/documents/note.d.mts +526 -0
- package/src/foundry/client/documents/playlist-sound.d.mts +558 -0
- package/src/foundry/client/documents/playlist.d.mts +830 -0
- package/src/foundry/client/documents/region-behavior.d.mts +524 -0
- package/src/foundry/client/documents/region.d.mts +898 -0
- package/src/foundry/client/documents/roll-table.d.mts +916 -0
- package/src/foundry/client/documents/scene.d.mts +1441 -0
- package/src/foundry/client/documents/setting.d.mts +449 -0
- package/src/foundry/client/documents/table-result.d.mts +526 -0
- package/src/foundry/client/documents/tile.d.mts +524 -0
- package/src/foundry/client/documents/token.d.mts +2168 -0
- package/src/foundry/client/documents/user.d.mts +785 -0
- package/src/foundry/client/documents/wall.d.mts +599 -0
- package/src/foundry/client/game.d.mts +210 -149
- package/src/foundry/client/head.d.mts +13 -11
- package/src/foundry/client/helpers/_module.d.mts +16 -0
- package/src/foundry/client/helpers/_types.d.mts +17 -0
- package/src/foundry/client/helpers/client-issues.d.mts +125 -0
- package/src/foundry/client/helpers/client-settings.d.mts +480 -0
- package/src/foundry/client/helpers/document-index.d.mts +173 -0
- package/src/foundry/client/helpers/hooks.d.mts +171 -0
- package/src/foundry/client/helpers/interaction/_module.d.mts +11 -0
- package/src/foundry/client/helpers/interaction/client-keybindings.d.mts +433 -0
- package/src/foundry/client/helpers/interaction/clipboard-helper.d.mts +20 -0
- package/src/foundry/client/helpers/interaction/gamepad-manager.d.mts +61 -0
- package/src/foundry/client/helpers/interaction/keyboard-manager.d.mts +331 -0
- package/src/foundry/client/helpers/interaction/mouse-manager.d.mts +42 -0
- package/src/foundry/client/helpers/interaction/tooltip-manager.d.mts +268 -0
- package/src/foundry/client/helpers/localization.d.mts +240 -0
- package/src/foundry/client/helpers/media/_module.d.mts +8 -0
- package/src/foundry/client/helpers/media/compendium-art.d.mts +107 -0
- package/src/foundry/client/helpers/media/image-helper.d.mts +235 -0
- package/src/foundry/client/helpers/media/video-helper.d.mts +161 -0
- package/src/foundry/client/helpers/socket-interface.d.mts +74 -0
- package/src/foundry/client/helpers/time.d.mts +87 -0
- package/src/foundry/client/helpers/workers.d.mts +145 -0
- package/src/foundry/client/hooks.d.mts +1156 -948
- package/src/foundry/client/index.d.mts +0 -7
- package/src/foundry/client/nue/tour.d.mts +280 -0
- package/src/foundry/client/nue/tours/canvas-tour.d.mts +15 -0
- package/src/foundry/client/nue/tours/setup-tour.d.mts +31 -0
- package/src/foundry/client/nue/tours/sidebar-tour.d.mts +13 -0
- package/src/foundry/client/packages/_module.d.mts +22 -0
- package/src/foundry/client/packages/client-package.d.mts +154 -0
- package/src/foundry/client/packages/module.d.mts +87 -0
- package/src/foundry/client/packages/system.d.mts +151 -0
- package/src/foundry/client/packages/world.d.mts +155 -0
- package/src/foundry/client/utils/_module.d.mts +25 -0
- package/src/foundry/client/utils/_types.d.mts +3 -0
- package/src/foundry/client/utils/helpers.d.mts +213 -0
- package/src/foundry/common/_types.d.mts +17 -6
- package/src/foundry/common/abstract/_types.d.mts +14 -14
- package/src/foundry/common/abstract/backend.d.mts +13 -7
- package/src/foundry/common/abstract/data.d.mts +227 -160
- package/src/foundry/common/abstract/document.d.mts +688 -531
- package/src/foundry/common/abstract/embedded-collection-delta.d.mts +1 -1
- package/src/foundry/common/abstract/embedded-collection.d.mts +9 -4
- package/src/foundry/common/abstract/singleton-collection.d.mts +1 -1
- package/src/foundry/common/abstract/socket.d.mts +1 -1
- package/src/foundry/common/abstract/type-data.d.mts +106 -87
- package/src/foundry/common/config.d.mts +7 -1
- package/src/foundry/common/constants.d.mts +607 -138
- package/src/foundry/common/data/_module.d.mts +1 -0
- package/src/foundry/common/data/_types.d.mts +14 -13
- package/src/foundry/common/data/data.d.mts +73 -34
- package/src/foundry/common/data/fields.d.mts +2004 -1092
- package/src/foundry/common/data/validation-failure.d.mts +31 -21
- package/src/foundry/common/data/validators.d.mts +2 -2
- package/src/foundry/common/documents/_module.d.mts +2 -0
- package/src/foundry/common/documents/_types.d.mts +89 -97
- package/src/foundry/common/documents/active-effect.d.mts +115 -94
- package/src/foundry/common/documents/actor-delta.d.mts +168 -95
- package/src/foundry/common/documents/actor.d.mts +140 -94
- package/src/foundry/common/documents/adventure.d.mts +103 -65
- package/src/foundry/common/documents/ambient-light.d.mts +84 -65
- package/src/foundry/common/documents/ambient-sound.d.mts +84 -65
- package/src/foundry/common/documents/card.d.mts +115 -93
- package/src/foundry/common/documents/cards.d.mts +129 -74
- package/src/foundry/common/documents/chat-message.d.mts +116 -83
- package/src/foundry/common/documents/combat.d.mts +130 -84
- package/src/foundry/common/documents/combatant-group.d.mts +328 -0
- package/src/foundry/common/documents/combatant.d.mts +113 -79
- package/src/foundry/common/documents/drawing.d.mts +107 -77
- package/src/foundry/common/documents/fog-exploration.d.mts +106 -70
- package/src/foundry/common/documents/folder.d.mts +117 -74
- package/src/foundry/common/documents/item.d.mts +129 -83
- package/src/foundry/common/documents/journal-entry-category.d.mts +316 -0
- package/src/foundry/common/documents/journal-entry-page.d.mts +104 -72
- package/src/foundry/common/documents/journal-entry.d.mts +117 -67
- package/src/foundry/common/documents/macro.d.mts +135 -86
- package/src/foundry/common/documents/measured-template.d.mts +95 -75
- package/src/foundry/common/documents/note.d.mts +91 -70
- package/src/foundry/common/documents/playlist-sound.d.mts +104 -75
- package/src/foundry/common/documents/playlist.d.mts +127 -77
- package/src/foundry/common/documents/region-behavior.d.mts +94 -73
- package/src/foundry/common/documents/region.d.mts +87 -69
- package/src/foundry/common/documents/roll-table.d.mts +90 -41
- package/src/foundry/common/documents/scene.d.mts +222 -71
- package/src/foundry/common/documents/setting.d.mts +113 -67
- package/src/foundry/common/documents/table-result.d.mts +127 -79
- package/src/foundry/common/documents/tile.d.mts +97 -68
- package/src/foundry/common/documents/token.d.mts +214 -88
- package/src/foundry/common/documents/user.d.mts +116 -114
- package/src/foundry/common/documents/wall.d.mts +64 -44
- package/src/foundry/common/grid/_types.d.mts +20 -17
- package/src/foundry/common/grid/base.d.mts +110 -21
- package/src/foundry/common/grid/grid-hex.d.mts +1 -0
- package/src/foundry/common/grid/gridless.d.mts +4 -3
- package/src/foundry/common/grid/hexagonal.d.mts +32 -6
- package/src/foundry/common/grid/square.d.mts +5 -4
- package/src/foundry/common/packages/base-module.d.mts +0 -1
- package/src/foundry/common/packages/base-package.d.mts +42 -17
- package/src/foundry/common/packages/base-system.d.mts +39 -1
- package/src/foundry/common/packages/base-world.d.mts +13 -4
- package/src/foundry/common/packages/sub-types.d.mts +7 -9
- package/src/foundry/common/primitives/array.d.mts +1 -1
- package/src/foundry/common/primitives/math.d.mts +3 -1
- package/src/foundry/common/primitives/number.d.mts +1 -1
- package/src/foundry/common/primitives/string.d.mts +1 -1
- package/src/foundry/common/prosemirror/_module.d.mts +44 -28
- package/src/foundry/common/prosemirror/_types.d.mts +16 -11
- package/src/foundry/common/prosemirror/click-handler.d.mts +8 -5
- package/src/foundry/common/prosemirror/content-link-plugin.d.mts +28 -8
- package/src/foundry/common/prosemirror/dirty-plugin.d.mts +2 -2
- package/src/foundry/common/prosemirror/dom-parser.d.mts +4 -4
- package/src/foundry/common/prosemirror/dropdown.d.mts +51 -19
- package/src/foundry/common/prosemirror/extensions.d.mts +5 -2
- package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts +43 -56
- package/src/foundry/common/prosemirror/image-plugin.d.mts +23 -18
- package/src/foundry/common/prosemirror/input-rules.d.mts +20 -15
- package/src/foundry/common/prosemirror/keymaps.d.mts +24 -21
- package/src/foundry/common/prosemirror/menu.d.mts +124 -85
- package/src/foundry/common/prosemirror/paste-transformer.d.mts +7 -13
- package/src/foundry/common/prosemirror/plugin.d.mts +11 -7
- package/src/foundry/common/prosemirror/schema/_types.d.mts +16 -0
- package/src/foundry/common/prosemirror/schema/attribute-capture.d.mts +20 -19
- package/src/foundry/common/prosemirror/schema/core.d.mts +7 -45
- package/src/foundry/common/prosemirror/schema/image-link-node.d.mts +15 -9
- package/src/foundry/common/prosemirror/schema/image-node.d.mts +11 -7
- package/src/foundry/common/prosemirror/schema/link-mark.d.mts +16 -11
- package/src/foundry/common/prosemirror/schema/lists.d.mts +5 -27
- package/src/foundry/common/prosemirror/schema/marks.d.mts +19 -44
- package/src/foundry/common/prosemirror/schema/other.d.mts +43 -149
- package/src/foundry/common/prosemirror/schema/schema-definition.d.mts +30 -9
- package/src/foundry/common/prosemirror/schema/secret-node.d.mts +8 -8
- package/src/foundry/common/prosemirror/schema/tables.d.mts +18 -90
- package/src/foundry/common/prosemirror/schema/utils.d.mts +3 -1
- package/src/foundry/common/prosemirror/schema.d.mts +51 -16
- package/src/foundry/common/prosemirror/string-serializer.d.mts +59 -40
- package/src/foundry/common/prosemirror/util.d.mts +38 -18
- package/src/foundry/common/utils/_module.d.mts +5 -2
- package/src/foundry/common/utils/_types.d.mts +27 -0
- package/src/foundry/common/utils/bitmask.d.mts +8 -7
- package/src/foundry/common/utils/collection.d.mts +7 -7
- package/src/foundry/common/utils/color.d.mts +11 -2
- package/src/foundry/common/utils/event-emitter.d.mts +12 -17
- package/src/foundry/common/utils/geometry.d.mts +13 -10
- package/src/foundry/common/utils/helpers.d.mts +320 -264
- package/src/foundry/common/utils/http.d.mts +36 -28
- package/src/foundry/common/utils/iterable-weak-map.d.mts +43 -30
- package/src/foundry/common/utils/iterable-weak-set.d.mts +21 -8
- package/src/foundry/common/utils/logging.d.mts +16 -9
- package/src/foundry/common/utils/semaphore.d.mts +19 -29
- package/src/foundry/common/utils/string-tree.d.mts +35 -32
- package/src/foundry/common/utils/word-tree.d.mts +53 -16
- package/src/foundry/index.d.mts +0 -2
- package/src/foundry/public/scripts/clipper/clipper.d.mts +3 -2
- package/src/foundry/public/scripts/index.d.mts +1 -0
- package/src/foundry/public/scripts/ktx2/basis_transcoder.d.mts +5 -0
- package/src/foundry/public/scripts/ktx2/index.d.mts +2 -0
- package/src/foundry/public/scripts/ktx2/pixi-ktx2.min.d.mts +5 -0
- package/src/foundry/public/scripts/workers/image-compressor.d.mts +12 -4
- package/src/types/augments/particles.d.mts +1 -1
- package/src/types/augments/pixi.d.mts +20 -11
- package/src/types/augments/smooth.d.mts +1 -1
- package/src/types/augments/socket.io-client.d.mts +0 -1
- package/src/types/augments/tinyMCE.d.mts +1 -1
- package/src/types/config.d.mts +3 -6
- package/src/types/documentConfiguration.d.mts +22 -21
- package/src/types/lib.d.mts +1 -1
- package/src/types/workers/image-compressor.d.mts +102 -67
- package/src/utils/index.d.mts +240 -117
- package/tsconfig.base.json +24 -0
- package/tsconfig.json +7 -24
- package/src/foundry/client/apps/app.d.mts +0 -609
- package/src/foundry/client/apps/av/av-config.d.mts +0 -98
- package/src/foundry/client/apps/av/camera-popout.d.mts +0 -49
- package/src/foundry/client/apps/av/cameras.d.mts +0 -194
- package/src/foundry/client/apps/av/index.d.mts +0 -3
- package/src/foundry/client/apps/dialogs/folder-export.d.mts +0 -16
- package/src/foundry/client/apps/dialogs/index.d.mts +0 -1
- package/src/foundry/client/apps/dice/dice-config.d.mts +0 -59
- package/src/foundry/client/apps/dice/index.d.mts +0 -1
- package/src/foundry/client/apps/form.d.mts +0 -511
- package/src/foundry/client/apps/forms/actor.d.mts +0 -186
- package/src/foundry/client/apps/forms/adventure-exporter.d.mts +0 -137
- package/src/foundry/client/apps/forms/adventure-importer.d.mts +0 -93
- package/src/foundry/client/apps/forms/base-sheet.d.mts +0 -53
- package/src/foundry/client/apps/forms/card-config.d.mts +0 -56
- package/src/foundry/client/apps/forms/cards-config.d.mts +0 -141
- package/src/foundry/client/apps/forms/combat-config.d.mts +0 -51
- package/src/foundry/client/apps/forms/combatant-config.d.mts +0 -45
- package/src/foundry/client/apps/forms/default-sheets-config.d.mts +0 -46
- package/src/foundry/client/apps/forms/effect-config.d.mts +0 -77
- package/src/foundry/client/apps/forms/folder-config.d.mts +0 -60
- package/src/foundry/client/apps/forms/fonts.d.mts +0 -175
- package/src/foundry/client/apps/forms/grid-config.d.mts +0 -139
- package/src/foundry/client/apps/forms/image-popout.d.mts +0 -185
- package/src/foundry/client/apps/forms/index.d.mts +0 -26
- package/src/foundry/client/apps/forms/item.d.mts +0 -58
- package/src/foundry/client/apps/forms/journal-page-sheet.d.mts +0 -315
- package/src/foundry/client/apps/forms/journal-sheet.d.mts +0 -322
- package/src/foundry/client/apps/forms/macro-config.d.mts +0 -59
- package/src/foundry/client/apps/forms/measure-template.d.mts +0 -57
- package/src/foundry/client/apps/forms/ownership.d.mts +0 -66
- package/src/foundry/client/apps/forms/playlist-config.d.mts +0 -44
- package/src/foundry/client/apps/forms/playlist-sound-config.d.mts +0 -63
- package/src/foundry/client/apps/forms/roll-table-config.d.mts +0 -161
- package/src/foundry/client/apps/forms/scene-config.d.mts +0 -156
- package/src/foundry/client/apps/forms/sheet-config.d.mts +0 -191
- package/src/foundry/client/apps/forms/user-config.d.mts +0 -72
- package/src/foundry/client/apps/hud/chatbubble.d.mts +0 -125
- package/src/foundry/client/apps/hud/container.d.mts +0 -54
- package/src/foundry/client/apps/hud/controls.d.mts +0 -211
- package/src/foundry/client/apps/hud/hotbar.d.mts +0 -174
- package/src/foundry/client/apps/hud/hud.d.mts +0 -87
- package/src/foundry/client/apps/hud/index.d.mts +0 -9
- package/src/foundry/client/apps/hud/menu.d.mts +0 -84
- package/src/foundry/client/apps/hud/navigation.d.mts +0 -121
- package/src/foundry/client/apps/hud/pause.d.mts +0 -37
- package/src/foundry/client/apps/hud/players.d.mts +0 -87
- package/src/foundry/client/apps/i18n.d.mts +0 -225
- package/src/foundry/client/apps/index.d.mts +0 -11
- package/src/foundry/client/apps/placeables/drawing-config.d.mts +0 -88
- package/src/foundry/client/apps/placeables/drawing-hud.d.mts +0 -31
- package/src/foundry/client/apps/placeables/index.d.mts +0 -8
- package/src/foundry/client/apps/placeables/note-config.d.mts +0 -75
- package/src/foundry/client/apps/placeables/tile-config.d.mts +0 -67
- package/src/foundry/client/apps/placeables/tile-hud.d.mts +0 -42
- package/src/foundry/client/apps/placeables/token-config.d.mts +0 -277
- package/src/foundry/client/apps/placeables/token-hud.d.mts +0 -139
- package/src/foundry/client/apps/placeables/wall-config.d.mts +0 -67
- package/src/foundry/client/apps/sidebar/apps/chat-popout.d.mts +0 -39
- package/src/foundry/client/apps/sidebar/apps/client-settings.d.mts +0 -98
- package/src/foundry/client/apps/sidebar/apps/compendium.d.mts +0 -95
- package/src/foundry/client/apps/sidebar/apps/index.d.mts +0 -10
- package/src/foundry/client/apps/sidebar/apps/invitation-links.d.mts +0 -32
- package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.mts +0 -181
- package/src/foundry/client/apps/sidebar/apps/module-management.d.mts +0 -135
- package/src/foundry/client/apps/sidebar/apps/permission-config.d.mts +0 -72
- package/src/foundry/client/apps/sidebar/apps/support-details.d.mts +0 -126
- package/src/foundry/client/apps/sidebar/apps/tours-management.d.mts +0 -54
- package/src/foundry/client/apps/sidebar/apps/world-config.d.mts +0 -60
- package/src/foundry/client/apps/sidebar/directory-tab-mixin.d.mts +0 -291
- package/src/foundry/client/apps/sidebar/document-directory.d.mts +0 -177
- package/src/foundry/client/apps/sidebar/index.d.mts +0 -7
- package/src/foundry/client/apps/sidebar/package-configuration.d.mts +0 -86
- package/src/foundry/client/apps/sidebar/sidebar-tab.d.mts +0 -80
- package/src/foundry/client/apps/sidebar/sidebar.d.mts +0 -100
- package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.mts +0 -29
- package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.mts +0 -21
- package/src/foundry/client/apps/sidebar/tabs/chat-log.d.mts +0 -376
- package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.mts +0 -165
- package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.mts +0 -120
- package/src/foundry/client/apps/sidebar/tabs/index.d.mts +0 -12
- package/src/foundry/client/apps/sidebar/tabs/items-directory.d.mts +0 -23
- package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.mts +0 -22
- package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.mts +0 -25
- package/src/foundry/client/apps/sidebar/tabs/playlists-directory.d.mts +0 -283
- package/src/foundry/client/apps/sidebar/tabs/roll-table-directory.d.mts +0 -22
- package/src/foundry/client/apps/sidebar/tabs/scenes-directory.d.mts +0 -43
- package/src/foundry/client/apps/sidebar/tabs/settings.d.mts +0 -90
- package/src/foundry/client/apps/templates.d.mts +0 -486
- package/src/foundry/client/av/clients/index.d.mts +0 -1
- package/src/foundry/client/av/index.d.mts +0 -4
- package/src/foundry/client/core/clipboard.d.mts +0 -20
- package/src/foundry/client/core/document-index.d.mts +0 -126
- package/src/foundry/client/core/gamepad.d.mts +0 -76
- package/src/foundry/client/core/hooks.d.mts +0 -130
- package/src/foundry/client/core/image.d.mts +0 -240
- package/src/foundry/client/core/index.d.mts +0 -21
- package/src/foundry/client/core/issues.d.mts +0 -107
- package/src/foundry/client/core/keybindings.d.mts +0 -413
- package/src/foundry/client/core/keyboard.d.mts +0 -271
- package/src/foundry/client/core/mouse.d.mts +0 -28
- package/src/foundry/client/core/nue.d.mts +0 -38
- package/src/foundry/client/core/packages.d.mts +0 -538
- package/src/foundry/client/core/settings.d.mts +0 -386
- package/src/foundry/client/core/socket.d.mts +0 -62
- package/src/foundry/client/core/sorting.d.mts +0 -76
- package/src/foundry/client/core/time.d.mts +0 -76
- package/src/foundry/client/core/tooltip.d.mts +0 -198
- package/src/foundry/client/core/tour.d.mts +0 -288
- package/src/foundry/client/core/tours.d.mts +0 -22
- package/src/foundry/client/core/utils.d.mts +0 -94
- package/src/foundry/client/core/video.d.mts +0 -161
- package/src/foundry/client/core/workers.d.mts +0 -135
- package/src/foundry/client/data/abstract/canvas-document.d.mts +0 -74
- package/src/foundry/client/data/abstract/client-document.d.mts +0 -687
- package/src/foundry/client/data/abstract/directory-collection-mixin.d.mts +0 -119
- package/src/foundry/client/data/abstract/document-collection.d.mts +0 -242
- package/src/foundry/client/data/abstract/index.d.mts +0 -5
- package/src/foundry/client/data/abstract/world-collection.d.mts +0 -157
- package/src/foundry/client/data/collections/actors.d.mts +0 -51
- package/src/foundry/client/data/collections/cards.d.mts +0 -25
- package/src/foundry/client/data/collections/combats.d.mts +0 -56
- package/src/foundry/client/data/collections/compendium-collection.d.mts +0 -474
- package/src/foundry/client/data/collections/compendium-folders.d.mts +0 -27
- package/src/foundry/client/data/collections/compendium-packs.d.mts +0 -27
- package/src/foundry/client/data/collections/fog.d.mts +0 -30
- package/src/foundry/client/data/collections/folder.d.mts +0 -47
- package/src/foundry/client/data/collections/index.d.mts +0 -17
- package/src/foundry/client/data/collections/items.d.mts +0 -27
- package/src/foundry/client/data/collections/journal.d.mts +0 -79
- package/src/foundry/client/data/collections/macros.d.mts +0 -34
- package/src/foundry/client/data/collections/messages.d.mts +0 -48
- package/src/foundry/client/data/collections/playlists.d.mts +0 -44
- package/src/foundry/client/data/collections/scenes.d.mts +0 -65
- package/src/foundry/client/data/collections/settings.d.mts +0 -42
- package/src/foundry/client/data/collections/tables.d.mts +0 -34
- package/src/foundry/client/data/collections/users.d.mts +0 -62
- package/src/foundry/client/data/documents/active-effect.d.mts +0 -953
- package/src/foundry/client/data/documents/actor-delta.d.mts +0 -743
- package/src/foundry/client/data/documents/actor.d.mts +0 -980
- package/src/foundry/client/data/documents/adventure.d.mts +0 -539
- package/src/foundry/client/data/documents/ambient-light.d.mts +0 -449
- package/src/foundry/client/data/documents/ambient-sound.d.mts +0 -490
- package/src/foundry/client/data/documents/card.d.mts +0 -659
- package/src/foundry/client/data/documents/cards.d.mts +0 -1013
- package/src/foundry/client/data/documents/chat-message.d.mts +0 -764
- package/src/foundry/client/data/documents/combat.d.mts +0 -959
- package/src/foundry/client/data/documents/combatant.d.mts +0 -597
- package/src/foundry/client/data/documents/drawing.d.mts +0 -563
- package/src/foundry/client/data/documents/fog-exploration.d.mts +0 -458
- package/src/foundry/client/data/documents/folder.d.mts +0 -574
- package/src/foundry/client/data/documents/index.d.mts +0 -32
- package/src/foundry/client/data/documents/item.d.mts +0 -725
- package/src/foundry/client/data/documents/journal-entry-page.d.mts +0 -798
- package/src/foundry/client/data/documents/journal-entry.d.mts +0 -683
- package/src/foundry/client/data/documents/macro.d.mts +0 -591
- package/src/foundry/client/data/documents/measured-template.d.mts +0 -505
- package/src/foundry/client/data/documents/note.d.mts +0 -524
- package/src/foundry/client/data/documents/playlist-sound.d.mts +0 -530
- package/src/foundry/client/data/documents/playlist.d.mts +0 -798
- package/src/foundry/client/data/documents/region-behavior.d.mts +0 -508
- package/src/foundry/client/data/documents/region.d.mts +0 -786
- package/src/foundry/client/data/documents/scene.d.mts +0 -1101
- package/src/foundry/client/data/documents/setting.d.mts +0 -437
- package/src/foundry/client/data/documents/table-result.d.mts +0 -504
- package/src/foundry/client/data/documents/table.d.mts +0 -905
- package/src/foundry/client/data/documents/tile.d.mts +0 -519
- package/src/foundry/client/data/documents/token.d.mts +0 -1371
- package/src/foundry/client/data/documents/user.d.mts +0 -633
- package/src/foundry/client/data/documents/wall.d.mts +0 -566
- package/src/foundry/client/data/index.d.mts +0 -3
- package/src/foundry/client/pixi/board.d.mts +0 -827
- package/src/foundry/client/pixi/core/containers/base-canvas-group.d.mts +0 -155
- package/src/foundry/client/pixi/core/containers/cached-container.d.mts +0 -136
- package/src/foundry/client/pixi/core/containers/full-canvas-container.d.mts +0 -34
- package/src/foundry/client/pixi/core/containers/index.d.mts +0 -8
- package/src/foundry/client/pixi/core/containers/point-source-mesh.d.mts +0 -72
- package/src/foundry/client/pixi/core/containers/quad-mesh.d.mts +0 -53
- package/src/foundry/client/pixi/core/containers/quadtree.d.mts +0 -258
- package/src/foundry/client/pixi/core/containers/sprite-mesh.d.mts +0 -369
- package/src/foundry/client/pixi/core/containers/unbound-container.d.mts +0 -39
- package/src/foundry/client/pixi/core/index.d.mts +0 -4
- package/src/foundry/client/pixi/core/interaction/canvas-animation.d.mts +0 -242
- package/src/foundry/client/pixi/core/interaction/control-icon.d.mts +0 -128
- package/src/foundry/client/pixi/core/interaction/index.d.mts +0 -8
- package/src/foundry/client/pixi/core/interaction/mouse-handler.d.mts +0 -358
- package/src/foundry/client/pixi/core/interaction/ping.d.mts +0 -89
- package/src/foundry/client/pixi/core/interaction/pings/chevron.d.mts +0 -86
- package/src/foundry/client/pixi/core/interaction/pings/index.d.mts +0 -2
- package/src/foundry/client/pixi/core/interaction/pings/pulse.d.mts +0 -172
- package/src/foundry/client/pixi/core/interaction/render-flags.d.mts +0 -180
- package/src/foundry/client/pixi/core/interaction/resize-handle.d.mts +0 -82
- package/src/foundry/client/pixi/core/interaction/targets.d.mts +0 -48
- package/src/foundry/client/pixi/core/loader.d.mts +0 -256
- package/src/foundry/client/pixi/core/shapes/index.d.mts +0 -5
- package/src/foundry/client/pixi/core/shapes/limited-angle-polygon.d.mts +0 -144
- package/src/foundry/client/pixi/core/shapes/polygon-mesher.d.mts +0 -138
- package/src/foundry/client/pixi/core/shapes/precise-text.d.mts +0 -45
- package/src/foundry/client/pixi/core/shapes/ray.d.mts +0 -189
- package/src/foundry/client/pixi/core/shapes/source-polygon.d.mts +0 -344
- package/src/foundry/client/pixi/extensions/circle.d.mts +0 -143
- package/src/foundry/client/pixi/extensions/graphics.d.mts +0 -45
- package/src/foundry/client/pixi/extensions/index.d.mts +0 -5
- package/src/foundry/client/pixi/extensions/observable-transform.d.mts +0 -38
- package/src/foundry/client/pixi/extensions/polygon.d.mts +0 -163
- package/src/foundry/client/pixi/extensions/rectangle.d.mts +0 -274
- package/src/foundry/client/pixi/groups/effects.d.mts +0 -237
- package/src/foundry/client/pixi/groups/environment.d.mts +0 -129
- package/src/foundry/client/pixi/groups/hidden.d.mts +0 -56
- package/src/foundry/client/pixi/groups/index.d.mts +0 -7
- package/src/foundry/client/pixi/groups/interface.d.mts +0 -98
- package/src/foundry/client/pixi/groups/overlay.d.mts +0 -30
- package/src/foundry/client/pixi/groups/primary.d.mts +0 -222
- package/src/foundry/client/pixi/groups/rendered.d.mts +0 -30
- package/src/foundry/client/pixi/index.d.mts +0 -10
- package/src/foundry/client/pixi/layers/base/canvas-layer.d.mts +0 -91
- package/src/foundry/client/pixi/layers/base/index.d.mts +0 -3
- package/src/foundry/client/pixi/layers/base/interaction-layer.d.mts +0 -163
- package/src/foundry/client/pixi/layers/base/placeables-layer.d.mts +0 -677
- package/src/foundry/client/pixi/layers/controls/cursor.d.mts +0 -42
- package/src/foundry/client/pixi/layers/controls/door.d.mts +0 -89
- package/src/foundry/client/pixi/layers/controls/index.d.mts +0 -4
- package/src/foundry/client/pixi/layers/controls/layer.d.mts +0 -274
- package/src/foundry/client/pixi/layers/controls/ruler.d.mts +0 -500
- package/src/foundry/client/pixi/layers/effects/background-effects.d.mts +0 -47
- package/src/foundry/client/pixi/layers/effects/coloration-effects.d.mts +0 -41
- package/src/foundry/client/pixi/layers/effects/darkness-effects.d.mts +0 -33
- package/src/foundry/client/pixi/layers/effects/illumination-effects.d.mts +0 -151
- package/src/foundry/client/pixi/layers/effects/index.d.mts +0 -7
- package/src/foundry/client/pixi/layers/effects/visibility.d.mts +0 -245
- package/src/foundry/client/pixi/layers/effects/weather/particles/effect.d.mts +0 -56
- package/src/foundry/client/pixi/layers/effects/weather/particles/index.d.mts +0 -2
- package/src/foundry/client/pixi/layers/effects/weather/particles/leaves.d.mts +0 -49
- package/src/foundry/client/pixi/layers/effects/weather-effects.d.mts +0 -299
- package/src/foundry/client/pixi/layers/grid/highlight.d.mts +0 -43
- package/src/foundry/client/pixi/layers/grid/index.d.mts +0 -3
- package/src/foundry/client/pixi/layers/grid/layer.d.mts +0 -269
- package/src/foundry/client/pixi/layers/grid/mesh.d.mts +0 -94
- package/src/foundry/client/pixi/layers/index.d.mts +0 -6
- package/src/foundry/client/pixi/layers/masks/depth.d.mts +0 -67
- package/src/foundry/client/pixi/layers/masks/index.d.mts +0 -3
- package/src/foundry/client/pixi/layers/masks/occlusion.d.mts +0 -98
- package/src/foundry/client/pixi/layers/masks/vision.d.mts +0 -202
- package/src/foundry/client/pixi/layers/placeables/drawings.d.mts +0 -112
- package/src/foundry/client/pixi/layers/placeables/index.d.mts +0 -9
- package/src/foundry/client/pixi/layers/placeables/lighting.d.mts +0 -81
- package/src/foundry/client/pixi/layers/placeables/notes.d.mts +0 -127
- package/src/foundry/client/pixi/layers/placeables/regions.d.mts +0 -113
- package/src/foundry/client/pixi/layers/placeables/sounds.d.mts +0 -334
- package/src/foundry/client/pixi/layers/placeables/templates.d.mts +0 -68
- package/src/foundry/client/pixi/layers/placeables/tiles.d.mts +0 -125
- package/src/foundry/client/pixi/layers/placeables/tokens.d.mts +0 -210
- package/src/foundry/client/pixi/layers/placeables/walls.d.mts +0 -206
- package/src/foundry/client/pixi/perception/clockwise-sweep.d.mts +0 -192
- package/src/foundry/client/pixi/perception/detection-mode.d.mts +0 -286
- package/src/foundry/client/pixi/perception/fog.d.mts +0 -154
- package/src/foundry/client/pixi/perception/index.d.mts +0 -6
- package/src/foundry/client/pixi/perception/perception-manager.d.mts +0 -167
- package/src/foundry/client/pixi/perception/vision-mode.d.mts +0 -245
- package/src/foundry/client/pixi/perception/weiler-atherton-clipping.d.mts +0 -190
- package/src/foundry/client/pixi/placeable.d.mts +0 -734
- package/src/foundry/client/pixi/placeables/drawing.d.mts +0 -419
- package/src/foundry/client/pixi/placeables/index.d.mts +0 -10
- package/src/foundry/client/pixi/placeables/light.d.mts +0 -280
- package/src/foundry/client/pixi/placeables/note.d.mts +0 -210
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/index.d.mts +0 -4
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-canvas-object.d.mts +0 -199
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-graphics.d.mts +0 -60
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-occludable-object.d.mts +0 -202
- package/src/foundry/client/pixi/placeables/primary-canvas-objects/primary-sprite-mesh.d.mts +0 -194
- package/src/foundry/client/pixi/placeables/region.d.mts +0 -286
- package/src/foundry/client/pixi/placeables/sound.d.mts +0 -278
- package/src/foundry/client/pixi/placeables/template.d.mts +0 -298
- package/src/foundry/client/pixi/placeables/tile.d.mts +0 -355
- package/src/foundry/client/pixi/placeables/token.d.mts +0 -1293
- package/src/foundry/client/pixi/placeables/wall.d.mts +0 -400
- package/src/foundry/client/pixi/webgl/extensions/batch-renderer.d.mts +0 -134
- package/src/foundry/client/pixi/webgl/extensions/batch-shader-generator.d.mts +0 -31
- package/src/foundry/client/pixi/webgl/extensions/blend-modes.d.mts +0 -53
- package/src/foundry/client/pixi/webgl/extensions/index.d.mts +0 -3
- package/src/foundry/client/pixi/webgl/helpers/framebuffer-snapshot.d.mts +0 -31
- package/src/foundry/client/pixi/webgl/helpers/index.d.mts +0 -3
- package/src/foundry/client/pixi/webgl/helpers/smooth-noise.d.mts +0 -80
- package/src/foundry/client/pixi/webgl/helpers/texture-extractor.d.mts +0 -119
- package/src/foundry/client/pixi/webgl/index.d.mts +0 -3
- package/src/foundry/client/pixi/webgl/shaders/base-shader-mixin.d.mts +0 -119
- package/src/foundry/client/pixi/webgl/shaders/base-shader.d.mts +0 -111
- package/src/foundry/client/pixi/webgl/shaders/filters/base-filter.d.mts +0 -48
- package/src/foundry/client/pixi/webgl/shaders/filters/base-mask-filter.d.mts +0 -31
- package/src/foundry/client/pixi/webgl/shaders/filters/blur.d.mts +0 -187
- package/src/foundry/client/pixi/webgl/shaders/filters/effects-masking.d.mts +0 -125
- package/src/foundry/client/pixi/webgl/shaders/filters/environment.d.mts +0 -41
- package/src/foundry/client/pixi/webgl/shaders/filters/glow-overlay.d.mts +0 -76
- package/src/foundry/client/pixi/webgl/shaders/filters/index.d.mts +0 -13
- package/src/foundry/client/pixi/webgl/shaders/filters/invisibility.d.mts +0 -30
- package/src/foundry/client/pixi/webgl/shaders/filters/outline-overlay.d.mts +0 -87
- package/src/foundry/client/pixi/webgl/shaders/filters/transition.d.mts +0 -126
- package/src/foundry/client/pixi/webgl/shaders/filters/visibility.d.mts +0 -77
- package/src/foundry/client/pixi/webgl/shaders/filters/vision-mask-filter.d.mts +0 -36
- package/src/foundry/client/pixi/webgl/shaders/filters/void.d.mts +0 -19
- package/src/foundry/client/pixi/webgl/shaders/filters/weather-occlusion-masks.d.mts +0 -57
- package/src/foundry/client/pixi/webgl/shaders/fragment-channel-mixin.d.mts +0 -60
- package/src/foundry/client/pixi/webgl/shaders/grid/grid.d.mts +0 -113
- package/src/foundry/client/pixi/webgl/shaders/grid/index.d.mts +0 -1
- package/src/foundry/client/pixi/webgl/shaders/index.d.mts +0 -10
- package/src/foundry/client/pixi/webgl/shaders/lighting/background-lighting.d.mts +0 -66
- package/src/foundry/client/pixi/webgl/shaders/lighting/base-lighting.d.mts +0 -178
- package/src/foundry/client/pixi/webgl/shaders/lighting/coloration-lighting.d.mts +0 -74
- package/src/foundry/client/pixi/webgl/shaders/lighting/darkness-lighting.d.mts +0 -74
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/bewitching-wave.d.mts +0 -35
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/black-hole.d.mts +0 -19
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/chroma.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/emanation.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/energy-field.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fairy-light.d.mts +0 -40
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/flame.d.mts +0 -57
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/fog.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/force-grid.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/ghost-light.d.mts +0 -35
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/hexa-dome.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/index.d.mts +0 -25
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/light-dome.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/magical-gloom.d.mts +0 -19
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/pulse.d.mts +0 -46
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/radial-rainbow.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/revolving-light.d.mts +0 -37
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/roiling-mass.d.mts +0 -19
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/siren-light.d.mts +0 -63
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/smoke-patch.d.mts +0 -35
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/star-light.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/sunburst.d.mts +0 -35
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/swirling-rainbow.d.mts +0 -24
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/torch.d.mts +0 -47
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/vortex.d.mts +0 -40
- package/src/foundry/client/pixi/webgl/shaders/lighting/effects/wave.d.mts +0 -35
- package/src/foundry/client/pixi/webgl/shaders/lighting/illumination-lighting.d.mts +0 -80
- package/src/foundry/client/pixi/webgl/shaders/lighting/index.d.mts +0 -6
- package/src/foundry/client/pixi/webgl/shaders/region/adjust-darkness-level.d.mts +0 -135
- package/src/foundry/client/pixi/webgl/shaders/region/base.d.mts +0 -79
- package/src/foundry/client/pixi/webgl/shaders/region/highlight.d.mts +0 -95
- package/src/foundry/client/pixi/webgl/shaders/region/index.d.mts +0 -3
- package/src/foundry/client/pixi/webgl/shaders/samplers/base-sampler.d.mts +0 -205
- package/src/foundry/client/pixi/webgl/shaders/samplers/baseline-illumination.d.mts +0 -39
- package/src/foundry/client/pixi/webgl/shaders/samplers/color-adjustment.d.mts +0 -118
- package/src/foundry/client/pixi/webgl/shaders/samplers/depth.d.mts +0 -107
- package/src/foundry/client/pixi/webgl/shaders/samplers/fog-of-war.d.mts +0 -25
- package/src/foundry/client/pixi/webgl/shaders/samplers/index.d.mts +0 -8
- package/src/foundry/client/pixi/webgl/shaders/samplers/occlusion.d.mts +0 -106
- package/src/foundry/client/pixi/webgl/shaders/samplers/primary.d.mts +0 -35
- package/src/foundry/client/pixi/webgl/shaders/samplers/token-ring.d.mts +0 -73
- package/src/foundry/client/pixi/webgl/shaders/vision/background-vision.d.mts +0 -43
- package/src/foundry/client/pixi/webgl/shaders/vision/base-vision.d.mts +0 -33
- package/src/foundry/client/pixi/webgl/shaders/vision/coloration-vision.d.mts +0 -42
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/amplification.d.mts +0 -33
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/index.d.mts +0 -2
- package/src/foundry/client/pixi/webgl/shaders/vision/effects/wave.d.mts +0 -61
- package/src/foundry/client/pixi/webgl/shaders/vision/illumination-vision.d.mts +0 -37
- package/src/foundry/client/pixi/webgl/shaders/vision/index.d.mts +0 -5
- package/src/foundry/client/pixi/webgl/shaders/weather/base-weather.d.mts +0 -110
- package/src/foundry/client/pixi/webgl/shaders/weather/effect.d.mts +0 -56
- package/src/foundry/client/pixi/webgl/shaders/weather/fog.d.mts +0 -51
- package/src/foundry/client/pixi/webgl/shaders/weather/index.d.mts +0 -5
- package/src/foundry/client/pixi/webgl/shaders/weather/rain.d.mts +0 -43
- package/src/foundry/client/pixi/webgl/shaders/weather/snow.d.mts +0 -35
- package/src/foundry/client/pixi/workers/index.d.mts +0 -1
- package/src/foundry/client/pixi/workers/texture-worker.d.mts +0 -105
- package/src/foundry/client/tours/canvas-tour.d.mts +0 -9
- package/src/foundry/client/tours/index.d.mts +0 -3
- package/src/foundry/client/tours/setup-tour.d.mts +0 -31
- package/src/foundry/client/tours/sidebar-tour.d.mts +0 -9
- package/src/foundry/client/ui/dialog.d.mts +0 -337
- package/src/foundry/client/ui/drag.d.mts +0 -128
- package/src/foundry/client/ui/dragdrop.d.mts +0 -130
- package/src/foundry/client/ui/editor.d.mts +0 -554
- package/src/foundry/client/ui/filepicker.d.mts +0 -482
- package/src/foundry/client/ui/filter.d.mts +0 -160
- package/src/foundry/client/ui/forms.d.mts +0 -85
- package/src/foundry/client/ui/index.d.mts +0 -10
- package/src/foundry/client/ui/prosemirror.d.mts +0 -179
- package/src/foundry/client/ui/secrets.d.mts +0 -90
- package/src/foundry/client/ui/tabs.d.mts +0 -124
- package/src/foundry/client-esm/_types.d.mts +0 -9
- package/src/foundry/client-esm/applications/_module.d.mts +0 -30
- package/src/foundry/client-esm/applications/api/application.d.mts +0 -939
- package/src/foundry/client-esm/applications/api/category-browser.d.mts +0 -40
- package/src/foundry/client-esm/applications/api/dialog.d.mts +0 -346
- package/src/foundry/client-esm/applications/api/document-sheet.d.mts +0 -193
- package/src/foundry/client-esm/applications/api/handlebars-application.d.mts +0 -210
- package/src/foundry/client-esm/applications/apps/av/camera-popout.d.mts +0 -23
- package/src/foundry/client-esm/applications/apps/av/cameras.d.mts +0 -95
- package/src/foundry/client-esm/applications/apps/combat-tracker-config.d.mts +0 -21
- package/src/foundry/client-esm/applications/apps/compendium-art-config.d.mts +0 -53
- package/src/foundry/client-esm/applications/apps/document-ownership.d.mts +0 -21
- package/src/foundry/client-esm/applications/apps/document-sheet-config.d.mts +0 -24
- package/src/foundry/client-esm/applications/apps/file-picker.d.mts +0 -410
- package/src/foundry/client-esm/applications/apps/grid-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/apps/image-popout.d.mts +0 -56
- package/src/foundry/client-esm/applications/apps/permission-config.d.mts +0 -60
- package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts +0 -110
- package/src/foundry/client-esm/applications/elements/document-tags.d.mts +0 -92
- package/src/foundry/client-esm/applications/elements/file-picker.d.mts +0 -62
- package/src/foundry/client-esm/applications/elements/form-element.d.mts +0 -106
- package/src/foundry/client-esm/applications/elements/multi-select.d.mts +0 -105
- package/src/foundry/client-esm/applications/elements/prosemirror-editor.d.mts +0 -53
- package/src/foundry/client-esm/applications/forms/fields.d.mts +0 -270
- package/src/foundry/client-esm/applications/handlebars.d.mts +0 -3
- package/src/foundry/client-esm/applications/hud/container.d.mts +0 -15
- package/src/foundry/client-esm/applications/hud/drawing-hud.d.mts +0 -19
- package/src/foundry/client-esm/applications/hud/placeable-hud.d.mts +0 -41
- package/src/foundry/client-esm/applications/hud/tile-hud.d.mts +0 -19
- package/src/foundry/client-esm/applications/hud/token-hud.d.mts +0 -20
- package/src/foundry/client-esm/applications/quickstart.d.mts +0 -20
- package/src/foundry/client-esm/applications/settings/_module.d.mts +0 -7
- package/src/foundry/client-esm/applications/settings/config.d.mts +0 -21
- package/src/foundry/client-esm/applications/settings/dependency-resolution.d.mts +0 -19
- package/src/foundry/client-esm/applications/settings/menus/av-config.d.mts +0 -27
- package/src/foundry/client-esm/applications/settings/menus/default-sheets-config.d.mts +0 -19
- package/src/foundry/client-esm/applications/settings/menus/dice-config.d.mts +0 -18
- package/src/foundry/client-esm/applications/settings/menus/font-config.d.mts +0 -43
- package/src/foundry/client-esm/applications/settings/menus/prototype-overrides.d.mts +0 -21
- package/src/foundry/client-esm/applications/settings/menus/ui-config.d.mts +0 -26
- package/src/foundry/client-esm/applications/sheets/_module.d.mts +0 -37
- package/src/foundry/client-esm/applications/sheets/active-effect-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts +0 -31
- package/src/foundry/client-esm/applications/sheets/adventure-exporter.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/adventure-importer.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts +0 -80
- package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts +0 -52
- package/src/foundry/client-esm/applications/sheets/base-sheet.d.mts +0 -23
- package/src/foundry/client-esm/applications/sheets/card-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/cards-config.d.mts +0 -49
- package/src/foundry/client-esm/applications/sheets/combatant-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/drawing-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/folder-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts +0 -22
- package/src/foundry/client-esm/applications/sheets/journal/dialog-show.d.mts +0 -19
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-category-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-hbs-sheet.d.mts +0 -19
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-image-sheet.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-markdown-sheet.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-pdf-sheet.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-prose-mirror-sheet.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-sheet.d.mts +0 -28
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-text-sheet.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-page-video-sheet.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/journal/journal-entry-sheet.d.mts +0 -35
- package/src/foundry/client-esm/applications/sheets/macro-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/note-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/playlist-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/playlist-sound-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts +0 -37
- package/src/foundry/client-esm/applications/sheets/region-config.d.mts +0 -43
- package/src/foundry/client-esm/applications/sheets/roll-table-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/roll-table-sheet.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/scene-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/table-result-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/template-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/tile-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/token/mixin.d.mts +0 -28
- package/src/foundry/client-esm/applications/sheets/token/prototype-config.d.mts +0 -18
- package/src/foundry/client-esm/applications/sheets/token/token-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sheets/user-config.d.mts +0 -44
- package/src/foundry/client-esm/applications/sheets/wall-config.d.mts +0 -25
- package/src/foundry/client-esm/applications/sidebar/apps/chat-popout.d.mts +0 -22
- package/src/foundry/client-esm/applications/sidebar/apps/compendium.d.mts +0 -21
- package/src/foundry/client-esm/applications/sidebar/apps/controls-config.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/apps/folder-export.d.mts +0 -18
- package/src/foundry/client-esm/applications/sidebar/apps/frame-viewer.d.mts +0 -22
- package/src/foundry/client-esm/applications/sidebar/apps/invitation-links.d.mts +0 -17
- package/src/foundry/client-esm/applications/sidebar/apps/module-management.d.mts +0 -21
- package/src/foundry/client-esm/applications/sidebar/apps/support-details.d.mts +0 -17
- package/src/foundry/client-esm/applications/sidebar/apps/tours-management.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/apps/world-config.d.mts +0 -19
- package/src/foundry/client-esm/applications/sidebar/document-directory.d.mts +0 -30
- package/src/foundry/client-esm/applications/sidebar/sidebar-tab.d.mts +0 -86
- package/src/foundry/client-esm/applications/sidebar/sidebar.d.mts +0 -18
- package/src/foundry/client-esm/applications/sidebar/tabs/actor-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/cards-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/chat.d.mts +0 -19
- package/src/foundry/client-esm/applications/sidebar/tabs/combat-tracker.d.mts +0 -260
- package/src/foundry/client-esm/applications/sidebar/tabs/compendium-directory.d.mts +0 -19
- package/src/foundry/client-esm/applications/sidebar/tabs/item-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/journal-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/macro-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/playlist-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/roll-table-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/scene-directory.d.mts +0 -20
- package/src/foundry/client-esm/applications/sidebar/tabs/settings.d.mts +0 -18
- package/src/foundry/client-esm/applications/ui/game-pause.d.mts +0 -22
- package/src/foundry/client-esm/applications/ui/hotbar.d.mts +0 -29
- package/src/foundry/client-esm/applications/ui/main-menu.d.mts +0 -27
- package/src/foundry/client-esm/applications/ui/players.d.mts +0 -26
- package/src/foundry/client-esm/applications/ui/region-legend.d.mts +0 -57
- package/src/foundry/client-esm/applications/ui/scene-controls.d.mts +0 -20
- package/src/foundry/client-esm/applications/ui/scene-navigation.d.mts +0 -28
- package/src/foundry/client-esm/applications/ux/context-menu.d.mts +0 -379
- package/src/foundry/client-esm/applications/ux/drag-drop.d.mts +0 -21
- package/src/foundry/client-esm/applications/ux/draggable.d.mts +0 -9
- package/src/foundry/client-esm/applications/ux/form-data-extended.d.mts +0 -17
- package/src/foundry/client-esm/applications/ux/html-secret.d.mts +0 -21
- package/src/foundry/client-esm/applications/ux/prosemirror-editor.d.mts +0 -9
- package/src/foundry/client-esm/applications/ux/search-filter.d.mts +0 -9
- package/src/foundry/client-esm/applications/ux/tabs.d.mts +0 -29
- package/src/foundry/client-esm/applications/ux/text-editor.d.mts +0 -9
- package/src/foundry/client-esm/appv1/api/application-v1.d.mts +0 -5
- package/src/foundry/client-esm/appv1/api/dialog-v1.d.mts +0 -5
- package/src/foundry/client-esm/appv1/api/document-sheet-v1.d.mts +0 -5
- package/src/foundry/client-esm/appv1/api/form-application-v1.d.mts +0 -5
- package/src/foundry/client-esm/appv1/sheets/actor-sheet.d.mts +0 -5
- package/src/foundry/client-esm/appv1/sheets/adventure-importer.d.mts +0 -5
- package/src/foundry/client-esm/appv1/sheets/item-sheet.d.mts +0 -5
- package/src/foundry/client-esm/appv1/sheets/journal-page-sheet.d.mts +0 -7
- package/src/foundry/client-esm/appv1/sheets/journal-sheet.d.mts +0 -5
- package/src/foundry/client-esm/audio/_types.d.mts +0 -18
- package/src/foundry/client-esm/audio/biquad.d.mts +0 -101
- package/src/foundry/client-esm/audio/cache.d.mts +0 -79
- package/src/foundry/client-esm/audio/convolver.d.mts +0 -93
- package/src/foundry/client-esm/audio/helper.d.mts +0 -370
- package/src/foundry/client-esm/audio/sound.d.mts +0 -506
- package/src/foundry/client-esm/audio/timeout.d.mts +0 -101
- package/src/foundry/client-esm/av/client.d.mts +0 -18
- package/src/foundry/client-esm/av/clients/simplepeer.d.mts +0 -11
- package/src/foundry/client-esm/av/master.d.mts +0 -12
- package/src/foundry/client-esm/av/settings.d.mts +0 -30
- package/src/foundry/client-esm/canvas/_module.d.mts +0 -11
- package/src/foundry/client-esm/canvas/edges/collision.d.mts +0 -144
- package/src/foundry/client-esm/canvas/edges/edge.d.mts +0 -253
- package/src/foundry/client-esm/canvas/edges/edges.d.mts +0 -33
- package/src/foundry/client-esm/canvas/edges/vertex.d.mts +0 -166
- package/src/foundry/client-esm/canvas/regions/_module.d.mts +0 -9
- package/src/foundry/client-esm/canvas/regions/geometry.d.mts +0 -38
- package/src/foundry/client-esm/canvas/regions/mesh.d.mts +0 -72
- package/src/foundry/client-esm/canvas/regions/polygon-tree.d.mts +0 -132
- package/src/foundry/client-esm/canvas/regions/shape.d.mts +0 -129
- package/src/foundry/client-esm/canvas/scene-manager.d.mts +0 -103
- package/src/foundry/client-esm/canvas/smaa/blend.d.mts +0 -17
- package/src/foundry/client-esm/canvas/smaa/edges.d.mts +0 -28
- package/src/foundry/client-esm/canvas/smaa/smaa.d.mts +0 -154
- package/src/foundry/client-esm/canvas/smaa/weights.d.mts +0 -29
- package/src/foundry/client-esm/canvas/sources/base-effect-source.d.mts +0 -294
- package/src/foundry/client-esm/canvas/sources/base-light-source.d.mts +0 -223
- package/src/foundry/client-esm/canvas/sources/global-light-source.d.mts +0 -121
- package/src/foundry/client-esm/canvas/sources/point-darkness-source.d.mts +0 -118
- package/src/foundry/client-esm/canvas/sources/point-effect-source.d.mts +0 -122
- package/src/foundry/client-esm/canvas/sources/point-light-source.d.mts +0 -84
- package/src/foundry/client-esm/canvas/sources/point-movement-source.d.mts +0 -42
- package/src/foundry/client-esm/canvas/sources/point-sound-source.d.mts +0 -62
- package/src/foundry/client-esm/canvas/sources/point-vision-source.d.mts +0 -258
- package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts +0 -441
- package/src/foundry/client-esm/canvas/tokens/_module.d.mts +0 -8
- package/src/foundry/client-esm/canvas/tokens/ring-config.d.mts +0 -252
- package/src/foundry/client-esm/canvas/tokens/ring-data.d.mts +0 -147
- package/src/foundry/client-esm/canvas/tokens/ring.d.mts +0 -287
- package/src/foundry/client-esm/client.d.mts +0 -279
- package/src/foundry/client-esm/config.d.mts +0 -1
- package/src/foundry/client-esm/data/_module.d.mts +0 -13
- package/src/foundry/client-esm/data/calendar.d.mts +0 -200
- package/src/foundry/client-esm/data/client-backend.d.mts +0 -51
- package/src/foundry/client-esm/data/region-behaviors/adjust-darkness-level.d.mts +0 -57
- package/src/foundry/client-esm/data/region-behaviors/base.d.mts +0 -59
- package/src/foundry/client-esm/data/region-behaviors/display-scrolling-text.d.mts +0 -64
- package/src/foundry/client-esm/data/region-behaviors/teleport-token.d.mts +0 -32
- package/src/foundry/client-esm/data/region-behaviors/toggle-behavior.d.mts +0 -31
- package/src/foundry/client-esm/dice/_types.d.mts +0 -61
- package/src/foundry/client-esm/dice/parser.d.mts +0 -191
- package/src/foundry/client-esm/dice/roll.d.mts +0 -662
- package/src/foundry/client-esm/dice/terms/coin.d.mts +0 -71
- package/src/foundry/client-esm/dice/terms/dice.d.mts +0 -411
- package/src/foundry/client-esm/dice/terms/die.d.mts +0 -248
- package/src/foundry/client-esm/dice/terms/fate.d.mts +0 -57
- package/src/foundry/client-esm/dice/terms/function.d.mts +0 -103
- package/src/foundry/client-esm/dice/terms/numeric.d.mts +0 -54
- package/src/foundry/client-esm/dice/terms/operator.d.mts +0 -55
- package/src/foundry/client-esm/dice/terms/parenthetical.d.mts +0 -104
- package/src/foundry/client-esm/dice/terms/pool.d.mts +0 -272
- package/src/foundry/client-esm/dice/terms/string.d.mts +0 -34
- package/src/foundry/client-esm/dice/terms/term.d.mts +0 -174
- package/src/foundry/client-esm/documents/_module.d.mts +0 -11
- package/src/foundry/client-esm/documents/_types.d.mts +0 -8
- package/src/foundry/client-esm/documents/abstract/_module.d.mts +0 -6
- package/src/foundry/client-esm/documents/collections/_module.d.mts +0 -6
- package/src/foundry/client-esm/game.d.mts +0 -7
- package/src/foundry/client-esm/helpers/_module.d.mts +0 -8
- package/src/foundry/client-esm/helpers/_types.d.mts +0 -17
- package/src/foundry/client-esm/helpers/compendium-art.d.mts +0 -100
- package/src/foundry/client-esm/hooks.d.mts +0 -1
- package/src/foundry/client-esm/nue/tour.d.mts +0 -9
- package/src/foundry/client-esm/nue/tours/canvas-tour.d.mts +0 -12
- package/src/foundry/client-esm/nue/tours/setup-tour.d.mts +0 -11
- package/src/foundry/client-esm/nue/tours/sidebar-tour.d.mts +0 -11
- package/src/foundry/client-esm/packages/_module.d.mts +0 -22
- package/src/foundry/client-esm/packages/client-package.d.mts +0 -11
- package/src/foundry/client-esm/packages/module.d.mts +0 -8
- package/src/foundry/client-esm/packages/system.d.mts +0 -8
- package/src/foundry/client-esm/packages/world.d.mts +0 -8
- package/src/foundry/client-esm/ui.d.mts +0 -1
- package/src/foundry/client-esm/utils/_module.d.mts +0 -7
- package/src/foundry/client-esm/utils/_types.d.mts +0 -3
- package/src/foundry/client-esm/utils/helpers.d.mts +0 -6
- package/src/foundry/common/prosemirror/index.d.mts +0 -22
- package/src/foundry/common/prosemirror/schema/index.d.mts +0 -11
- package/src/tsconfig.json +0 -15
- package/tsconfig.main.json +0 -8
- package/tsconfig.miscellaneous.json +0 -16
- /package/src/foundry/{client-esm → client}/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/_types.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/api/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/apps/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/apps/av/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/dice/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/codemirror/element.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/codemirror/extensions.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/codemirror/view.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/color-picker.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/document-embed.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/enriched-content.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/hue-slider.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/range-picker.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/secret-block.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/elements/string-tags.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/hud/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/settings/menus/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/sheets/journal/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/sheets/token/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/sidebar/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/sidebar/apps/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/sidebar/tabs/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/ui/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/ui/notifications.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/applications/ux/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/appv1/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/appv1/api/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/appv1/sheets/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/audio/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/av/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/av/clients/_module.d.mts +0 -0
- /package/src/foundry/{client-esm/canvas → client/canvas/geometry}/edges/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/canvas/sources/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/_types.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/combat-config.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/region-behaviors/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/region-behaviors/execute-macro.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/region-behaviors/execute-script.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/region-behaviors/pause-game.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/region-behaviors/suppress-weather.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/data/terrain-data.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/dice/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/dice/terms/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/dice/twister.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/nue/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/nue/nue-manager.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/nue/tours/_module.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/nue/tours-collection.d.mts +0 -0
- /package/src/foundry/{client-esm → client}/packages/_types.d.mts +0 -0
@@ -1,9 +1,7 @@
|
|
1
1
|
import type {
|
2
|
-
ConfigurationFailure,
|
3
2
|
ConfiguredDocumentClass,
|
4
3
|
ConfiguredDocumentInstance,
|
5
4
|
ConfiguredMetadata,
|
6
|
-
CreateData,
|
7
5
|
} from "../../../types/documentConfiguration.d.mts";
|
8
6
|
import type {
|
9
7
|
GetKey,
|
@@ -17,15 +15,17 @@ import type {
|
|
17
15
|
RemoveIndexSignatures,
|
18
16
|
FixedInstanceType,
|
19
17
|
NullishProps,
|
20
|
-
AllKeysOf,
|
21
18
|
DiscriminatedUnion,
|
22
|
-
SimpleMerge,
|
23
19
|
PickValue,
|
24
20
|
Identity,
|
25
21
|
Brand,
|
26
|
-
|
22
|
+
AnyMutableObject,
|
23
|
+
MaybePromise,
|
24
|
+
Override,
|
25
|
+
} from "#utils";
|
27
26
|
import type * as CONST from "../constants.mts";
|
28
27
|
import type {
|
28
|
+
DataSchema,
|
29
29
|
DataField,
|
30
30
|
DocumentStatsField,
|
31
31
|
EmbeddedCollectionField,
|
@@ -33,12 +33,12 @@ import type {
|
|
33
33
|
SchemaField,
|
34
34
|
TypeDataField,
|
35
35
|
} from "../data/fields.d.mts";
|
36
|
-
import type { fields } from "../data/_module.d.mts";
|
37
36
|
import type { LogCompatibilityWarningOptions } from "../utils/logging.mts";
|
38
37
|
import type {
|
39
38
|
DatabaseAction,
|
40
39
|
DatabaseCreateOperation,
|
41
40
|
DatabaseDeleteOperation,
|
41
|
+
DatabaseGetOperation,
|
42
42
|
DatabaseUpdateOperation,
|
43
43
|
DocumentSocketRequest,
|
44
44
|
} from "./_types.d.mts";
|
@@ -46,10 +46,14 @@ import type DataModel from "./data.mts";
|
|
46
46
|
import type DocumentSocketResponse from "./socket.d.mts";
|
47
47
|
import type EmbeddedCollection from "./embedded-collection.d.mts";
|
48
48
|
|
49
|
-
type DataSchema = foundry.data.fields.DataSchema;
|
50
|
-
|
51
49
|
export default Document;
|
52
50
|
|
51
|
+
type InexactPartialExcept<T extends object, RequiredKey> = {
|
52
|
+
[K in keyof T as Extract<K, RequiredKey>]: T[K];
|
53
|
+
} & {
|
54
|
+
[K in keyof T as Exclude<K, RequiredKey>]?: T[K] | undefined;
|
55
|
+
};
|
56
|
+
|
53
57
|
type _ClassMustBeAssignableToInternal = MustConform<typeof Document, Document.Internal.Constructor>;
|
54
58
|
type _InstanceMustBeAssignableToInternal = MustConform<Document.Any, Document.Internal.Instance.Any>;
|
55
59
|
|
@@ -57,7 +61,8 @@ type _InstanceMustBeAssignableToInternal = MustConform<Document.Any, Document.In
|
|
57
61
|
// `name?: string` etc. were to be put in `Document` directly they'd actually override the schema.
|
58
62
|
// Therefore this workaround is used to force `DataModel` to override the properties.
|
59
63
|
declare const _InternalDocument: (new (...args: any[]) => {
|
60
|
-
|
64
|
+
// TODO: removing undefined breaks everything, but should be valid to do, investigate
|
65
|
+
name?: string | null | undefined;
|
61
66
|
|
62
67
|
// `{}` is used so that `{}` and the actual shape of `system` are merged.
|
63
68
|
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
@@ -90,10 +95,8 @@ declare abstract class Document<
|
|
90
95
|
|
91
96
|
override parent: Parent;
|
92
97
|
|
93
|
-
|
94
|
-
|
95
|
-
parentCollection?: string | null | undefined;
|
96
|
-
}): void;
|
98
|
+
// options: not null (destructured)
|
99
|
+
protected override _configure(options?: Document.ConfigureOptions): void;
|
97
100
|
|
98
101
|
/**
|
99
102
|
* An immutable reverse-reference to the name of the collection that this Document exists in on its parent, if any.
|
@@ -113,16 +116,9 @@ declare abstract class Document<
|
|
113
116
|
/**
|
114
117
|
* Ensure that all Document classes share the same schema of their base declaration.
|
115
118
|
*/
|
116
|
-
static get schema():
|
119
|
+
static get schema(): SchemaField.Any;
|
117
120
|
|
118
|
-
protected
|
119
|
-
|
120
|
-
/**
|
121
|
-
* A mapping of singleton embedded Documents which exist in this model.
|
122
|
-
*/
|
123
|
-
readonly singletons: Record<string, Document.AnyChild<this>>;
|
124
|
-
|
125
|
-
protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
|
121
|
+
protected static override _initializationOrder(): Generator<[string, DataField.Any], void, undefined>;
|
126
122
|
|
127
123
|
/**
|
128
124
|
* Default metadata which applies to each instance of this Document type.
|
@@ -130,24 +126,31 @@ declare abstract class Document<
|
|
130
126
|
* ```typescript
|
131
127
|
* {
|
132
128
|
* name: "Document",
|
129
|
+
* label: "DOCUMENT.Document"
|
130
|
+
* coreTypes: [BASE_DOCUMENT_TYPE],
|
133
131
|
* collection: "documents",
|
132
|
+
* embedded: {},
|
133
|
+
* hasTypeData: false,
|
134
134
|
* indexed: false,
|
135
135
|
* compendiumIndexFields: [],
|
136
|
-
* label: "DOCUMENT.Document",
|
137
|
-
* coreTypes: [],
|
138
|
-
* embedded: {},
|
139
136
|
* permissions: {
|
140
|
-
*
|
141
|
-
*
|
142
|
-
*
|
137
|
+
* view: "LIMITED" // At least limited permission is required to view the Document
|
138
|
+
* create: "ASSISTANT", // Assistants or Gamemasters can create Documents
|
139
|
+
* update: "ASSISTANT", // Document owners can update Documents (this includes GM users)
|
140
|
+
* delete: "ASSISTANT" // Assistants or Gamemasters can create Documents
|
143
141
|
* },
|
144
|
-
* preserveOnImport: ["_id", "sort", "ownership"],
|
142
|
+
* preserveOnImport: ["_id", "sort", "ownership", folder],
|
145
143
|
* schemaVersion: undefined
|
146
144
|
* }
|
147
145
|
* ```
|
148
146
|
*/
|
149
147
|
static metadata: Document.Metadata.Any;
|
150
148
|
|
149
|
+
/**
|
150
|
+
* @defaultValue `["DOCUMENT"]`
|
151
|
+
*/
|
152
|
+
static override LOCALIZATION_PREFIXES: string[];
|
153
|
+
|
151
154
|
/**
|
152
155
|
* The database backend used to execute operations and handle results
|
153
156
|
*/
|
@@ -156,7 +159,7 @@ declare abstract class Document<
|
|
156
159
|
/**
|
157
160
|
* Return a reference to the implemented subclass of this base document type.
|
158
161
|
*/
|
159
|
-
static get implementation(): Document.
|
162
|
+
static get implementation(): Document.Internal.Constructor;
|
160
163
|
|
161
164
|
/**
|
162
165
|
* The base document definition that this document class extends from.
|
@@ -176,7 +179,7 @@ declare abstract class Document<
|
|
176
179
|
/**
|
177
180
|
* The canonical name of this Document type, for example "Actor".
|
178
181
|
*/
|
179
|
-
static get documentName():
|
182
|
+
static get documentName(): Document.Type;
|
180
183
|
|
181
184
|
/**
|
182
185
|
* The canonical name of this Document type, for example "Actor".
|
@@ -201,9 +204,14 @@ declare abstract class Document<
|
|
201
204
|
/**
|
202
205
|
* Identify the collection in a parent Document that this Document exists belongs to, if any.
|
203
206
|
* @param parentCollection - An explicitly provided parent collection name.
|
207
|
+
* @remarks If passed a value for `parentCollection`, simply returns that value
|
208
|
+
*
|
209
|
+
* Foundry marked `@internal`
|
204
210
|
*/
|
205
211
|
_getParentCollection(parentCollection?: string): string | null;
|
206
212
|
|
213
|
+
_id: string | null;
|
214
|
+
|
207
215
|
/**
|
208
216
|
* The canonical identifier for this Document
|
209
217
|
*/
|
@@ -214,27 +222,43 @@ declare abstract class Document<
|
|
214
222
|
*/
|
215
223
|
get isEmbedded(): boolean;
|
216
224
|
|
225
|
+
/**
|
226
|
+
* Is this document in a compendium?
|
227
|
+
*/
|
228
|
+
get inCompendium(): boolean;
|
229
|
+
|
217
230
|
/**
|
218
231
|
* A Universally Unique Identifier (uuid) for this Document instance.
|
219
232
|
*/
|
220
233
|
get uuid(): string;
|
221
234
|
|
222
235
|
/**
|
223
|
-
* Test whether a given User has
|
236
|
+
* Test whether a given User has sufficient permissions to create Documents of this type in general. This does not
|
237
|
+
* guarantee that the User is able to create all Documents of this type, as certain document-specific requirements
|
238
|
+
* may also be present.
|
239
|
+
*
|
240
|
+
* Generally speaking, this method is used to verify whether a User should be presented with the option to create
|
241
|
+
* Documents of this type in the UI.
|
224
242
|
* @param user - The User being tested
|
225
243
|
* @returns Does the User have a sufficient role to create?
|
226
244
|
*/
|
227
|
-
static canUserCreate(user: User.
|
245
|
+
static canUserCreate(user: User.Implementation): boolean;
|
228
246
|
|
229
247
|
/**
|
230
|
-
* Get the explicit permission level that a
|
231
|
-
*
|
248
|
+
* Get the explicit permission level that a User has over this Document, a value in {@link CONST.DOCUMENT_OWNERSHIP_LEVELS | `CONST.DOCUMENT_OWNERSHIP_LEVELS`}.
|
249
|
+
* Compendium content ignores the ownership field in favor of User role-based ownership. Otherwise, Documents use
|
250
|
+
* granular per-User ownership definitions and Embedded Documents defer to their parent ownership.
|
251
|
+
*
|
252
|
+
* This method returns the value recorded in Document ownership, regardless of the User's role, for example a
|
253
|
+
* GAMEMASTER user might still return a result of NONE if they are not explicitly denoted as having a level.
|
254
|
+
*
|
232
255
|
* To test whether a user has a certain capability over the document, testUserPermission should be used.
|
233
|
-
* @param user - The User being tested
|
234
|
-
* (default: `game.user`)
|
256
|
+
* @param user - The User being tested (default: `game.user`)
|
235
257
|
* @returns A numeric permission level from CONST.DOCUMENT_OWNERSHIP_LEVELS or null
|
258
|
+
*
|
259
|
+
* @privateRemarks Making this just `User.Implementation` causes circularities
|
236
260
|
*/
|
237
|
-
getUserLevel(user?: User.Internal.Implementation): CONST.DOCUMENT_OWNERSHIP_LEVELS | null;
|
261
|
+
getUserLevel(user?: User.Internal.Implementation | null): CONST.DOCUMENT_OWNERSHIP_LEVELS | null;
|
238
262
|
|
239
263
|
/**
|
240
264
|
* Test whether a certain User has a requested permission level (or greater) over the Document
|
@@ -242,11 +266,13 @@ declare abstract class Document<
|
|
242
266
|
* @param permission - The permission level from DOCUMENT_PERMISSION_LEVELS to test
|
243
267
|
* @param options - Additional options involved in the permission test
|
244
268
|
* @returns Does the user have this permission level over the Document?
|
269
|
+
*
|
270
|
+
* @privateRemarks Making this just `User.Implementation` causes circularities
|
245
271
|
*/
|
246
272
|
// options: not null (destructured)
|
247
273
|
testUserPermission(
|
248
274
|
user: User.Internal.Implementation,
|
249
|
-
permission: Document.
|
275
|
+
permission: Document.ActionPermission,
|
250
276
|
options?: Document.TestUserPermissionOptions,
|
251
277
|
): boolean;
|
252
278
|
|
@@ -254,10 +280,12 @@ declare abstract class Document<
|
|
254
280
|
* Test whether a given User has permission to perform some action on this Document
|
255
281
|
* @param user - The User attempting modification
|
256
282
|
* @param action - The attempted action
|
257
|
-
* @param data - Data involved in the attempted action
|
258
|
-
* (default: `{}`)
|
283
|
+
* @param data - Data involved in the attempted action (default: `{}`)
|
259
284
|
* @returns Does the User have permission?
|
285
|
+
*
|
286
|
+
* @privateRemarks Making this just `User.Implementation` causes circularities
|
260
287
|
*/
|
288
|
+
// data: not null (parameter default only)
|
261
289
|
canUserModify<Action extends "create" | "update" | "delete">(
|
262
290
|
user: User.Internal.Implementation,
|
263
291
|
action: Action,
|
@@ -271,21 +299,22 @@ declare abstract class Document<
|
|
271
299
|
* @param context - Additional context options passed to the create method
|
272
300
|
* @returns The cloned Document instance
|
273
301
|
*/
|
274
|
-
|
275
|
-
|
276
|
-
|
277
|
-
|
302
|
+
// data: not null (property access), context: not null (destructured)
|
303
|
+
override clone<Save extends boolean | null | undefined = undefined>(
|
304
|
+
data?: SchemaField.UpdateData<Schema>,
|
305
|
+
context?: Document.CloneContext<Save>,
|
306
|
+
): Document.Clone<this, Save>;
|
278
307
|
|
279
308
|
/**
|
280
309
|
* For Documents which include game system data, migrate the system data object to conform to its latest data model.
|
281
310
|
* The data model is defined by the template.json specification included by the game system.
|
282
311
|
* @returns The migrated system data object
|
312
|
+
* @throws If this document type either doesn't have subtypes or it does but the one on this document is a DataModel
|
283
313
|
*/
|
284
314
|
migrateSystemData(): object;
|
285
315
|
|
286
|
-
|
287
|
-
|
288
|
-
): Source extends false ? SchemaField.SourceData<Schema> : Readonly<SchemaField.SourceData<Schema>>;
|
316
|
+
/** @remarks `Document#toObject` calls `this.constructor.shimData()` on the data before returning */
|
317
|
+
override toObject(source?: boolean | null): SchemaField.SourceData<Schema>;
|
289
318
|
|
290
319
|
/**
|
291
320
|
* Create multiple Documents using provided input data.
|
@@ -414,7 +443,7 @@ declare abstract class Document<
|
|
414
443
|
|
415
444
|
/**
|
416
445
|
* Create a new Document using provided input data, saving it to the database.
|
417
|
-
* @see {@
|
446
|
+
* @see {@linkcode Document.createDocuments}
|
418
447
|
* @param data - Initial data used to create this Document, or a Document instance to persist.
|
419
448
|
* @param operation - Parameters of the creation operation
|
420
449
|
* (default: `{}`)
|
@@ -443,11 +472,12 @@ declare abstract class Document<
|
|
443
472
|
* returned.
|
444
473
|
*/
|
445
474
|
// Note: This uses `never` because it's unsound to try to call `Document.create` directly.
|
475
|
+
// TODO: This can take an array of data and return an array of documents, in addition to its current typing
|
446
476
|
static create(data: never, operation?: never): Promise<Document.Any | undefined>;
|
447
477
|
|
448
478
|
/**
|
449
479
|
* Update this Document using incremental data, saving it to the database.
|
450
|
-
* @see {@
|
480
|
+
* @see {@linkcode Document.updateDocuments}
|
451
481
|
* @param data - Differential update data which modifies the existing values of this document data
|
452
482
|
* (default: `{}`)
|
453
483
|
* @param operation - Parameters of the update operation
|
@@ -462,7 +492,7 @@ declare abstract class Document<
|
|
462
492
|
|
463
493
|
/**
|
464
494
|
* Delete this Document, removing it from the database.
|
465
|
-
* @see {@
|
495
|
+
* @see {@linkcode Document.deleteDocuments}
|
466
496
|
* @param operation - Parameters of the deletion operation
|
467
497
|
* (default: `{}`)
|
468
498
|
* @returns The deleted Document instance
|
@@ -478,8 +508,16 @@ declare abstract class Document<
|
|
478
508
|
* @param documentId - The Document ID
|
479
509
|
* @param operation - Additional options which customize the request
|
480
510
|
* @returns The retrieved Document, or null
|
511
|
+
*
|
512
|
+
* @remarks If the Document is in a compendium (i.e `operation.pack` is provided), returns the index
|
513
|
+
* entry (or `null`), instead of the Document.
|
514
|
+
*
|
515
|
+
* {@link FogExploration.get | `FogExploration.get`} can possibly forward args and return to/from
|
516
|
+
* {@link FogExploration.load | `FogExploration.load`}, which accounts for the `Promise<>` part
|
517
|
+
* of the return; All other documents return `SomeDoc.Implementation | null`
|
481
518
|
*/
|
482
|
-
|
519
|
+
// TODO: Type for possible index entry return
|
520
|
+
static get(documentId: string, operation?: Document.Database.GetOptions): MaybePromise<Document.Any | null>;
|
483
521
|
|
484
522
|
/**
|
485
523
|
* A compatibility method that returns the appropriate name of an embedded collection within this Document.
|
@@ -526,7 +564,7 @@ declare abstract class Document<
|
|
526
564
|
|
527
565
|
/**
|
528
566
|
* Create multiple embedded Document instances within this parent Document using provided input data.
|
529
|
-
* @see {@
|
567
|
+
* @see {@linkcode Document.createDocuments}
|
530
568
|
* @param embeddedName - The name of the embedded Document type
|
531
569
|
* @param data - An array of data objects used to create multiple documents
|
532
570
|
* (default: `[]`)
|
@@ -545,7 +583,7 @@ declare abstract class Document<
|
|
545
583
|
|
546
584
|
/**
|
547
585
|
* Update multiple embedded Document instances within a parent Document using provided differential data.
|
548
|
-
* @see {@
|
586
|
+
* @see {@linkcode Document.updateDocuments}
|
549
587
|
* @param embeddedName - The name of the embedded Document type
|
550
588
|
* @param updates - An array of differential data objects, each used to update a single Document
|
551
589
|
* (default: `[]`)
|
@@ -564,7 +602,7 @@ declare abstract class Document<
|
|
564
602
|
|
565
603
|
/**
|
566
604
|
* Delete multiple embedded Document instances within a parent Document using provided string ids.
|
567
|
-
* @see {@
|
605
|
+
* @see {@linkcode Document.deleteDocuments}
|
568
606
|
* @param embeddedName - The name of the embedded Document type
|
569
607
|
* @param ids - An array of string ids for each Document to be deleted
|
570
608
|
* @param operation - Parameters of the database deletion workflow
|
@@ -580,7 +618,7 @@ declare abstract class Document<
|
|
580
618
|
* @param _parentPath - A parent field path already traversed
|
581
619
|
* @remarks Not called within Foundry's client-side code, likely exists for server documents
|
582
620
|
*/
|
583
|
-
traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
|
621
|
+
traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>], void, undefined>;
|
584
622
|
|
585
623
|
/**
|
586
624
|
* Get the value of a "flag" for this document
|
@@ -638,7 +676,7 @@ declare abstract class Document<
|
|
638
676
|
* @param options - Additional options which modify the creation request
|
639
677
|
* @param userId - The id of the User requesting the document update
|
640
678
|
*/
|
641
|
-
protected _onCreate(data: never, options: never, userId: string): void
|
679
|
+
protected _onCreate(data: never, options: never, userId: string): MaybePromise<void>;
|
642
680
|
|
643
681
|
/**
|
644
682
|
* Pre-process a creation operation, potentially altering its instructions or input data. Pre-operation events only
|
@@ -695,7 +733,7 @@ declare abstract class Document<
|
|
695
733
|
* @param options - Additional options which modify the update request
|
696
734
|
* @param userId - The id of the User requesting the document update
|
697
735
|
*/
|
698
|
-
protected _onUpdate(changed: never, options: never, userId: string): void
|
736
|
+
protected _onUpdate(changed: never, options: never, userId: string): MaybePromise<void>;
|
699
737
|
|
700
738
|
/**
|
701
739
|
* Pre-process an update operation, potentially altering its instructions or input data. Pre-operation events only
|
@@ -751,7 +789,7 @@ declare abstract class Document<
|
|
751
789
|
* @param options - Additional options which modify the deletion request
|
752
790
|
* @param userId - The id of the User requesting the document update
|
753
791
|
*/
|
754
|
-
protected _onDelete(options: never, userId: string): void
|
792
|
+
protected _onDelete(options: never, userId: string): MaybePromise<void>;
|
755
793
|
|
756
794
|
/**
|
757
795
|
* Pre-process a deletion operation, potentially altering its instructions or input data. Pre-operation events only
|
@@ -793,27 +831,22 @@ declare abstract class Document<
|
|
793
831
|
user: User.Internal.Implementation,
|
794
832
|
): Promise<unknown>;
|
795
833
|
|
796
|
-
/**
|
797
|
-
* Configure whether V10 Document Model migration warnings should be logged for this class.
|
798
|
-
*/
|
799
|
-
static LOG_V10_COMPATIBILITY_WARNINGS: boolean;
|
800
|
-
|
801
|
-
/**
|
802
|
-
* @deprecated since v11, will be removed in v13
|
803
|
-
* @remarks "You are accessing `Document.hasSystemData` which is deprecated. Please use `Document.hasTypeData` instead."
|
804
|
-
*/
|
805
|
-
static get hasSystemData(): undefined | true;
|
806
|
-
|
807
834
|
/**
|
808
835
|
* A reusable helper for adding migration shims.
|
809
836
|
*/
|
810
|
-
|
837
|
+
// options: not null (parameter default only in _addDataFieldShim)
|
838
|
+
protected static _addDataFieldShims(
|
839
|
+
data: AnyMutableObject,
|
840
|
+
shims: Record<string, string>,
|
841
|
+
options?: Document.DataFieldShimOptions,
|
842
|
+
): void;
|
811
843
|
|
812
844
|
/**
|
813
845
|
* A reusable helper for adding a migration shim
|
814
846
|
*/
|
847
|
+
// options: not null (parameter default only)
|
815
848
|
protected static _addDataFieldShim(
|
816
|
-
data:
|
849
|
+
data: AnyMutableObject,
|
817
850
|
oldKey: string,
|
818
851
|
newKey: string,
|
819
852
|
options?: Document.DataFieldShimOptions,
|
@@ -826,15 +859,16 @@ declare abstract class Document<
|
|
826
859
|
* @param oldKey - The old field name
|
827
860
|
* @param newKey - The new field name
|
828
861
|
* @param apply - An application function, otherwise the old value is applied
|
829
|
-
* @internal
|
862
|
+
* @remarks Foundry marked `@internal`
|
830
863
|
*/
|
831
864
|
protected static _addDataFieldMigration(
|
832
|
-
data:
|
865
|
+
data: AnyMutableObject,
|
833
866
|
oldKey: string,
|
834
867
|
newKey: string,
|
835
|
-
apply?: (data:
|
868
|
+
apply?: (data: AnyMutableObject) => unknown,
|
836
869
|
): unknown;
|
837
870
|
|
871
|
+
// options: not null (destructured where forwarded)
|
838
872
|
protected static _logDataFieldMigration(
|
839
873
|
oldKey: string,
|
840
874
|
newKey: string,
|
@@ -843,7 +877,7 @@ declare abstract class Document<
|
|
843
877
|
|
844
878
|
/**
|
845
879
|
* @deprecated since v12, will be removed in v14
|
846
|
-
* @remarks
|
880
|
+
* @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
|
847
881
|
*/
|
848
882
|
// Note: This uses `never` because it's unsound to try to do `Document._onCreateDocuments` directly.
|
849
883
|
protected static _onCreateDocuments(
|
@@ -853,7 +887,7 @@ declare abstract class Document<
|
|
853
887
|
|
854
888
|
/**
|
855
889
|
* @deprecated since v12, will be removed in v14
|
856
|
-
* @remarks
|
890
|
+
* @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
|
857
891
|
*/
|
858
892
|
// Note: This uses `never` because it's unsound to try to do `Document._onUpdateDocuments` directly.
|
859
893
|
protected static _onUpdateDocuments(
|
@@ -863,7 +897,7 @@ declare abstract class Document<
|
|
863
897
|
|
864
898
|
/**
|
865
899
|
* @deprecated since v12, will be removed in v14
|
866
|
-
* @remarks
|
900
|
+
* @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
|
867
901
|
*/
|
868
902
|
// Note: This uses `never` because it's unsound to try to do `Document._onDeleteDocuments` directly.
|
869
903
|
protected static _onDeleteDocuments(
|
@@ -871,8 +905,6 @@ declare abstract class Document<
|
|
871
905
|
context: Document.ModificationContext<Document.Any | null>,
|
872
906
|
): Promise<unknown>;
|
873
907
|
|
874
|
-
static " fvtt_types_internal_document_name_static": Document.Type;
|
875
|
-
|
876
908
|
" fvtt_types_internal_document_name": DocumentName;
|
877
909
|
" fvtt_types_internal_document_schema": Schema;
|
878
910
|
" fvtt_types_internal_document_parent": Parent;
|
@@ -890,8 +922,12 @@ declare abstract class AnyDocument extends Document<Document.Type, {}, Document.
|
|
890
922
|
|
891
923
|
declare namespace Document {
|
892
924
|
interface Any extends AnyDocument {}
|
893
|
-
interface AnyStored extends Stored<Any> {}
|
894
|
-
interface AnyValid extends AnyDocument {
|
925
|
+
interface AnyStored extends Document.Internal.Stored<Any> {}
|
926
|
+
interface AnyValid extends AnyDocument {
|
927
|
+
get invalid(): false;
|
928
|
+
}
|
929
|
+
interface AnyInvalid extends Document.Internal.Invalid<AnyValid> {}
|
930
|
+
|
895
931
|
interface AnyConstructor extends Identity<typeof AnyDocument> {}
|
896
932
|
|
897
933
|
type Type = CONST.ALL_DOCUMENT_TYPES;
|
@@ -923,35 +959,29 @@ declare namespace Document {
|
|
923
959
|
| "ChatMessage"
|
924
960
|
| "Combat"
|
925
961
|
| "Combatant"
|
962
|
+
| "CombatantGroup"
|
926
963
|
| "Item"
|
927
964
|
| "JournalEntryPage"
|
928
965
|
| "RegionBehavior";
|
929
966
|
|
930
|
-
// The `data` parameter has a default of `{}`. This means it's optional in that scenario.
|
931
|
-
// Note(LukeAbby): Update when `ParameterWithDefaults` is added.
|
932
|
-
// `CreateData` also should be updated to allow `undefined` directly.
|
933
|
-
type ConstructorParameters<CreateData extends object | undefined, Parent extends Document.Any | null> = [
|
934
|
-
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
935
|
-
{},
|
936
|
-
] extends [CreateData]
|
937
|
-
? [data?: CreateData, context?: Document.ConstructionContext<Parent>]
|
938
|
-
: [data: CreateData, context?: Document.ConstructionContext<Parent>];
|
939
|
-
|
940
967
|
type CoreTypesForName<Name extends Type> = string &
|
941
968
|
GetKey<Document.MetadataFor<Name>, "coreTypes", [CONST.BASE_DOCUMENT_TYPE]>[number];
|
942
969
|
|
943
970
|
type ConfiguredSubTypesOf<Name extends Type> = Name extends "ActorDelta"
|
944
971
|
? ConfiguredSubTypesOf<"Actor">
|
945
|
-
:
|
972
|
+
: // ESLint doesn't know that `DataModelConfig` and `SourceConfig` are meant to be declaration merged into.
|
973
|
+
// Therefore it hastily thinks the results are always `never`.
|
974
|
+
// eslint-disable-next-line @typescript-eslint/no-redundant-type-constituents, @typescript-eslint/no-duplicate-type-constituents
|
975
|
+
string & (keyof GetKey<DataModelConfig, Name, unknown> | keyof GetKey<SourceConfig, Name, unknown>);
|
946
976
|
|
947
977
|
type SubTypesOf<Name extends Type> = Name extends "ActorDelta"
|
948
978
|
? SubTypesOf<"Actor">
|
949
979
|
:
|
950
980
|
| Document.CoreTypesForName<Name>
|
951
981
|
| ConfiguredSubTypesOf<Name>
|
952
|
-
| (Document.MetadataFor<Name> extends { readonly hasTypeData: true } ? Document.
|
982
|
+
| (Document.MetadataFor<Name> extends { readonly hasTypeData: true } ? Document.ModuleSubType : never);
|
953
983
|
|
954
|
-
type
|
984
|
+
type ModuleSubType = Brand<`${string}.${string}`, "Document.ModuleSubtype">;
|
955
985
|
|
956
986
|
type OfType<Name extends WithSubTypes, SubType extends SubTypesOf<Name>> =
|
957
987
|
| (Name extends "ActiveEffect" ? ActiveEffect.OfType<SubType & ActiveEffect.SubType> : never)
|
@@ -962,6 +992,7 @@ declare namespace Document {
|
|
962
992
|
| (Name extends "ChatMessage" ? ChatMessage.OfType<SubType & ChatMessage.SubType> : never)
|
963
993
|
| (Name extends "Combat" ? Combat.OfType<SubType & Combat.SubType> : never)
|
964
994
|
| (Name extends "Combatant" ? Combatant.OfType<SubType & Combatant.SubType> : never)
|
995
|
+
| (Name extends "CombatantGroup" ? CombatantGroup.OfType<SubType & CombatantGroup.SubType> : never)
|
965
996
|
| (Name extends "Folder" ? Folder.OfType<SubType & Folder.SubType> : never)
|
966
997
|
| (Name extends "Item" ? Item.OfType<SubType & Item.SubType> : never)
|
967
998
|
| (Name extends "JournalEntryPage" ? JournalEntryPage.OfType<SubType & JournalEntryPage.SubType> : never)
|
@@ -975,10 +1006,10 @@ declare namespace Document {
|
|
975
1006
|
* strong indicator.
|
976
1007
|
*
|
977
1008
|
* `UnknownSourceData` covers the case where it's configured without a data model.
|
978
|
-
* See {@
|
1009
|
+
* See {@linkcode UnknownSystem} for other possibilities.
|
979
1010
|
*/
|
980
1011
|
interface UnknownSourceData extends AnyObject {
|
981
|
-
type:
|
1012
|
+
type: ModuleSubType;
|
982
1013
|
}
|
983
1014
|
|
984
1015
|
/**
|
@@ -995,6 +1026,7 @@ declare namespace Document {
|
|
995
1026
|
| "ChatMessage"
|
996
1027
|
| "Combat"
|
997
1028
|
| "Combatant"
|
1029
|
+
| "CombatantGroup"
|
998
1030
|
| "Item"
|
999
1031
|
| "JournalEntryPage"
|
1000
1032
|
| "RegionBehavior";
|
@@ -1025,20 +1057,20 @@ declare namespace Document {
|
|
1025
1057
|
* @internal
|
1026
1058
|
*/
|
1027
1059
|
interface _WorldCollectionMap {
|
1028
|
-
Actor: Actors.Configured;
|
1029
|
-
Cards: CardStacks;
|
1030
|
-
Combat: CombatEncounters;
|
1031
|
-
FogExploration: FogExplorations;
|
1032
|
-
Folder: Folders;
|
1033
|
-
Item: Items;
|
1034
|
-
JournalEntry: Journal;
|
1035
|
-
Macro: Macros;
|
1036
|
-
ChatMessage:
|
1037
|
-
Playlist: Playlists;
|
1038
|
-
Scene: Scenes;
|
1039
|
-
Setting: WorldSettings;
|
1040
|
-
RollTable: RollTables;
|
1041
|
-
User: Users;
|
1060
|
+
Actor: foundry.documents.collections.Actors.Configured;
|
1061
|
+
Cards: foundry.documents.collections.CardStacks;
|
1062
|
+
Combat: foundry.documents.collections.CombatEncounters;
|
1063
|
+
FogExploration: foundry.documents.collections.FogExplorations;
|
1064
|
+
Folder: foundry.documents.collections.Folders;
|
1065
|
+
Item: foundry.documents.collections.Items;
|
1066
|
+
JournalEntry: foundry.documents.collections.Journal;
|
1067
|
+
Macro: foundry.documents.collections.Macros;
|
1068
|
+
ChatMessage: foundry.documents.collections.ChatMessages;
|
1069
|
+
Playlist: foundry.documents.collections.Playlists;
|
1070
|
+
Scene: foundry.documents.collections.Scenes;
|
1071
|
+
Setting: foundry.documents.collections.WorldSettings;
|
1072
|
+
RollTable: foundry.documents.collections.RollTables;
|
1073
|
+
User: foundry.documents.collections.Users;
|
1042
1074
|
}
|
1043
1075
|
|
1044
1076
|
type WorldCollectionFor<Name extends Document.WorldType> = _WorldCollectionMap[Name];
|
@@ -1066,7 +1098,7 @@ declare namespace Document {
|
|
1066
1098
|
// Documented at https://gist.github.com/LukeAbby/c7420b053d881db4a4d4496b95995c98
|
1067
1099
|
namespace Internal {
|
1068
1100
|
type Constructor = (abstract new (...args: never) => Instance.Any) & {
|
1069
|
-
|
1101
|
+
documentName: Document.Type;
|
1070
1102
|
};
|
1071
1103
|
|
1072
1104
|
interface Instance<
|
@@ -1092,11 +1124,13 @@ declare namespace Document {
|
|
1092
1124
|
type Complete<T extends Any> = T extends Document.Any ? T : never;
|
1093
1125
|
}
|
1094
1126
|
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1098
|
-
|
1099
|
-
|
1127
|
+
// Note(LukeAbby): `Configured` is not checked for validity. This means that it's easy to
|
1128
|
+
// accidently misconfigure without warning. However it helps stymy some circularities this way.
|
1129
|
+
// This is also why `LazyDocument` takes a callback.
|
1130
|
+
// See: https://gist.github.com/LukeAbby/a7892327633587ba89e760b599572322
|
1131
|
+
type OfType<Configured, LazyDocument extends () => unknown> = "document" extends keyof Configured
|
1132
|
+
? Configured["document"]
|
1133
|
+
: ReturnType<LazyDocument>;
|
1100
1134
|
|
1101
1135
|
type SystemMap<Name extends Document.WithSystem> = _SystemMap<
|
1102
1136
|
Name,
|
@@ -1113,7 +1147,7 @@ declare namespace Document {
|
|
1113
1147
|
[K in SubType]: infer Source;
|
1114
1148
|
}
|
1115
1149
|
? Source
|
1116
|
-
: SubType extends Document.
|
1150
|
+
: SubType extends Document.ModuleSubType
|
1117
1151
|
? // eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
1118
1152
|
{}
|
1119
1153
|
: UnknownSystem;
|
@@ -1121,7 +1155,42 @@ declare namespace Document {
|
|
1121
1155
|
|
1122
1156
|
type SystemOfType<SystemMap extends Record<SubType, object>, SubType extends string> =
|
1123
1157
|
| DiscriminatedUnion<SystemMap[SubType]>
|
1124
|
-
| (SubType extends
|
1158
|
+
| (SubType extends ModuleSubType | "base" ? UnknownSystem : never);
|
1159
|
+
|
1160
|
+
// TODO(LukeAbby): Improve the type display with a helper here.
|
1161
|
+
type Stored<D extends Document.Any> = Override<
|
1162
|
+
D,
|
1163
|
+
{
|
1164
|
+
id: string;
|
1165
|
+
_id: string;
|
1166
|
+
_source: Override<D["_source"], { _id: string }>;
|
1167
|
+
}
|
1168
|
+
>;
|
1169
|
+
|
1170
|
+
// @ts-expect-error - This pattern is inherently an error.
|
1171
|
+
interface Invalid<D extends Document.Any> extends _Invalid, D {}
|
1172
|
+
|
1173
|
+
/** @internal */
|
1174
|
+
interface _Invalid {
|
1175
|
+
_source: object;
|
1176
|
+
system?: object | undefined;
|
1177
|
+
get invalid(): true;
|
1178
|
+
}
|
1179
|
+
|
1180
|
+
interface DropData<DocumentType extends Document.Type> {
|
1181
|
+
/**
|
1182
|
+
* The data used to create a new document.
|
1183
|
+
* At least one of `data` and `uuid` must be set.
|
1184
|
+
*/
|
1185
|
+
data?: Document.CreateDataForName<DocumentType>;
|
1186
|
+
|
1187
|
+
/**
|
1188
|
+
* The uuid of an existing document.
|
1189
|
+
* At least one of `data` and `uuid` must be set.
|
1190
|
+
*/
|
1191
|
+
// TODO: Handle as part of the UUID update.
|
1192
|
+
uuid?: string;
|
1193
|
+
}
|
1125
1194
|
}
|
1126
1195
|
|
1127
1196
|
/** Any Document, that is a child of the given parent Document. */
|
@@ -1129,24 +1198,6 @@ declare namespace Document {
|
|
1129
1198
|
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
1130
1199
|
type AnyChild<Parent extends Any | null> = Document<Document.Type, {}, Parent>;
|
1131
1200
|
|
1132
|
-
/**
|
1133
|
-
* @deprecated {@link Document.CreateDataFor | `Document.CreateDataFor`}
|
1134
|
-
*/
|
1135
|
-
type ConstructorDataFor<T extends Document.Internal.Constructor> = SchemaField.CreateData<
|
1136
|
-
T extends { defineSchema: () => infer R extends DataSchema } ? R : never
|
1137
|
-
>;
|
1138
|
-
|
1139
|
-
/**
|
1140
|
-
* Returns the type of the constructor data for the given {@link foundry.abstract.Document | `foundry.abstract.Document`}.
|
1141
|
-
*/
|
1142
|
-
type CreateDataFor<T extends Document.Internal.Constructor> = SchemaField.CreateData<
|
1143
|
-
T extends { defineSchema: () => infer R extends DataSchema } ? R : never
|
1144
|
-
>;
|
1145
|
-
|
1146
|
-
type UpdateDataFor<T extends Document.Internal.Constructor> = SchemaField.UpdateData<
|
1147
|
-
T extends { defineSchema: () => infer R extends DataSchema } ? R : never
|
1148
|
-
>;
|
1149
|
-
|
1150
1201
|
// These helper types exist to help break a loop
|
1151
1202
|
|
1152
1203
|
type CreateDataForName<DocumentType extends Document.Type> =
|
@@ -1159,9 +1210,11 @@ declare namespace Document {
|
|
1159
1210
|
| (DocumentType extends "ChatMessage" ? ChatMessage.CreateData : never)
|
1160
1211
|
| (DocumentType extends "Combat" ? Combat.CreateData : never)
|
1161
1212
|
| (DocumentType extends "Combatant" ? Combatant.CreateData : never)
|
1213
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.CreateData : never)
|
1162
1214
|
| (DocumentType extends "FogExploration" ? FogExploration.CreateData : never)
|
1163
1215
|
| (DocumentType extends "Folder" ? Folder.CreateData : never)
|
1164
1216
|
| (DocumentType extends "Item" ? Item.CreateData : never)
|
1217
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.CreateData : never)
|
1165
1218
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.CreateData : never)
|
1166
1219
|
| (DocumentType extends "JournalEntry" ? JournalEntry.CreateData : never)
|
1167
1220
|
| (DocumentType extends "Macro" ? Macro.CreateData : never)
|
@@ -1193,9 +1246,11 @@ declare namespace Document {
|
|
1193
1246
|
| (DocumentType extends "ChatMessage" ? ChatMessage.UpdateData : never)
|
1194
1247
|
| (DocumentType extends "Combat" ? Combat.UpdateData : never)
|
1195
1248
|
| (DocumentType extends "Combatant" ? Combatant.UpdateData : never)
|
1249
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.UpdateData : never)
|
1196
1250
|
| (DocumentType extends "FogExploration" ? FogExploration.UpdateData : never)
|
1197
1251
|
| (DocumentType extends "Folder" ? Folder.UpdateData : never)
|
1198
1252
|
| (DocumentType extends "Item" ? Item.UpdateData : never)
|
1253
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.UpdateData : never)
|
1199
1254
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.UpdateData : never)
|
1200
1255
|
| (DocumentType extends "JournalEntry" ? JournalEntry.UpdateData : never)
|
1201
1256
|
| (DocumentType extends "Macro" ? Macro.UpdateData : never)
|
@@ -1217,10 +1272,41 @@ declare namespace Document {
|
|
1217
1272
|
| (DocumentType extends "Token" ? TokenDocument.UpdateData : never)
|
1218
1273
|
| (DocumentType extends "Wall" ? WallDocument.UpdateData : never);
|
1219
1274
|
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1275
|
+
type SourceForName<DocumentType extends Document.Type> =
|
1276
|
+
| (DocumentType extends "ActiveEffect" ? ActiveEffect.Source : never)
|
1277
|
+
| (DocumentType extends "ActorDelta" ? ActorDelta.Source : never)
|
1278
|
+
| (DocumentType extends "Actor" ? Actor.Source : never)
|
1279
|
+
| (DocumentType extends "Adventure" ? Adventure.Source : never)
|
1280
|
+
| (DocumentType extends "Card" ? Card.Source : never)
|
1281
|
+
| (DocumentType extends "Cards" ? Cards.Source : never)
|
1282
|
+
| (DocumentType extends "ChatMessage" ? ChatMessage.Source : never)
|
1283
|
+
| (DocumentType extends "Combat" ? Combat.Source : never)
|
1284
|
+
| (DocumentType extends "Combatant" ? Combatant.Source : never)
|
1285
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Source : never)
|
1286
|
+
| (DocumentType extends "FogExploration" ? FogExploration.Source : never)
|
1287
|
+
| (DocumentType extends "Folder" ? Folder.Source : never)
|
1288
|
+
| (DocumentType extends "Item" ? Item.Source : never)
|
1289
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Source : never)
|
1290
|
+
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Source : never)
|
1291
|
+
| (DocumentType extends "JournalEntry" ? JournalEntry.Source : never)
|
1292
|
+
| (DocumentType extends "Macro" ? Macro.Source : never)
|
1293
|
+
| (DocumentType extends "PlaylistSound" ? PlaylistSound.Source : never)
|
1294
|
+
| (DocumentType extends "Playlist" ? Playlist.Source : never)
|
1295
|
+
| (DocumentType extends "RegionBehavior" ? RegionBehavior.Source : never)
|
1296
|
+
| (DocumentType extends "RollTable" ? RollTable.Source : never)
|
1297
|
+
| (DocumentType extends "Scene" ? Scene.Source : never)
|
1298
|
+
| (DocumentType extends "Setting" ? Setting.Source : never)
|
1299
|
+
| (DocumentType extends "TableResult" ? TableResult.Source : never)
|
1300
|
+
| (DocumentType extends "User" ? User.Source : never)
|
1301
|
+
| (DocumentType extends "AmbientLight" ? AmbientLightDocument.Source : never)
|
1302
|
+
| (DocumentType extends "AmbientSound" ? AmbientSoundDocument.Source : never)
|
1303
|
+
| (DocumentType extends "Drawing" ? DrawingDocument.Source : never)
|
1304
|
+
| (DocumentType extends "MeasuredTemplate" ? MeasuredTemplateDocument.Source : never)
|
1305
|
+
| (DocumentType extends "Note" ? NoteDocument.Source : never)
|
1306
|
+
| (DocumentType extends "Region" ? NoteDocument.Source : never)
|
1307
|
+
| (DocumentType extends "Tile" ? TileDocument.Source : never)
|
1308
|
+
| (DocumentType extends "Token" ? TokenDocument.Source : never)
|
1309
|
+
| (DocumentType extends "Wall" ? WallDocument.Source : never);
|
1224
1310
|
|
1225
1311
|
type SystemConstructor = AnyConstructor & {
|
1226
1312
|
metadata: { name: SystemType };
|
@@ -1230,48 +1316,88 @@ declare namespace Document {
|
|
1230
1316
|
NameFor<ConcreteDocument>
|
1231
1317
|
>;
|
1232
1318
|
|
1233
|
-
type ToConfiguredInstance<ConcreteDocument extends Document.Internal.Constructor> =
|
1234
|
-
|
1235
|
-
Document.Any
|
1236
|
-
// TODO(LukeAbby): Look into if there's a way to do this without causing circular loops.
|
1237
|
-
// FixedInstanceType<ConfigurationFailure[Name]>
|
1238
|
-
>;
|
1239
|
-
|
1240
|
-
type ToConfiguredStored<D extends Document.AnyConstructor> = Stored<ToConfiguredInstance<D>>;
|
1241
|
-
|
1242
|
-
type Stored<D extends Document.Any> = D & {
|
1243
|
-
id: string;
|
1244
|
-
_id: string;
|
1245
|
-
_source: GetKey<D, "_source"> & { _id: string };
|
1246
|
-
};
|
1247
|
-
|
1248
|
-
type Invalid<D extends Document.Any> = SimpleMerge<
|
1249
|
-
D,
|
1250
|
-
{
|
1251
|
-
id: string;
|
1252
|
-
_id: string;
|
1253
|
-
_source: object;
|
1254
|
-
system: object;
|
1255
|
-
}
|
1319
|
+
type ToConfiguredInstance<ConcreteDocument extends Document.Internal.Constructor> = ImplementationFor<
|
1320
|
+
NameFor<ConcreteDocument>
|
1256
1321
|
>;
|
1257
1322
|
|
1258
|
-
type ToStored<D extends Document.AnyConstructor> = Stored<FixedInstanceType<D>>;
|
1259
|
-
|
1260
|
-
type ToStoredIf<D extends Document.AnyConstructor, Temporary extends boolean | undefined> = Temporary extends true
|
1261
|
-
? FixedInstanceType<D>
|
1262
|
-
: ToConfiguredStored<D>;
|
1263
|
-
|
1264
|
-
/** @deprecated {@link Document.TemporaryIf | `Document.TemporaryIf`} */
|
1265
|
-
type StoredIf<D extends Document.Any, Temporary extends boolean | undefined> = TemporaryIf<D, Temporary>;
|
1266
|
-
|
1267
1323
|
type TemporaryIf<D extends Document.Any, Temporary extends boolean | undefined> = Temporary extends true
|
1268
1324
|
? D
|
1269
|
-
:
|
1270
|
-
|
1271
|
-
|
1272
|
-
|
1273
|
-
|
1274
|
-
|
1325
|
+
: // eslint-disable-next-line @typescript-eslint/no-deprecated
|
1326
|
+
Stored<D>;
|
1327
|
+
|
1328
|
+
type StoredForName<DocumentType extends Document.Type> =
|
1329
|
+
| (DocumentType extends "ActiveEffect" ? ActiveEffect.Stored : never)
|
1330
|
+
| (DocumentType extends "ActorDelta" ? ActorDelta.Stored : never)
|
1331
|
+
| (DocumentType extends "Actor" ? Actor.Stored : never)
|
1332
|
+
| (DocumentType extends "Adventure" ? Adventure.Stored : never)
|
1333
|
+
| (DocumentType extends "Card" ? Card.Stored : never)
|
1334
|
+
| (DocumentType extends "Cards" ? Cards.Stored : never)
|
1335
|
+
| (DocumentType extends "ChatMessage" ? ChatMessage.Stored : never)
|
1336
|
+
| (DocumentType extends "Combat" ? Combat.Stored : never)
|
1337
|
+
| (DocumentType extends "Combatant" ? Combatant.Stored : never)
|
1338
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Stored : never)
|
1339
|
+
| (DocumentType extends "FogExploration" ? FogExploration.Stored : never)
|
1340
|
+
| (DocumentType extends "Folder" ? Folder.Stored : never)
|
1341
|
+
| (DocumentType extends "Item" ? Item.Stored : never)
|
1342
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Stored : never)
|
1343
|
+
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Stored : never)
|
1344
|
+
| (DocumentType extends "JournalEntry" ? JournalEntry.Stored : never)
|
1345
|
+
| (DocumentType extends "Macro" ? Macro.Stored : never)
|
1346
|
+
| (DocumentType extends "PlaylistSound" ? PlaylistSound.Stored : never)
|
1347
|
+
| (DocumentType extends "Playlist" ? Playlist.Stored : never)
|
1348
|
+
| (DocumentType extends "RegionBehavior" ? RegionBehavior.Stored : never)
|
1349
|
+
| (DocumentType extends "RollTable" ? RollTable.Stored : never)
|
1350
|
+
| (DocumentType extends "Scene" ? Scene.Stored : never)
|
1351
|
+
| (DocumentType extends "Setting" ? Setting.Stored : never)
|
1352
|
+
| (DocumentType extends "TableResult" ? TableResult.Stored : never)
|
1353
|
+
| (DocumentType extends "User" ? User.Stored : never)
|
1354
|
+
| (DocumentType extends "AmbientLight" ? AmbientLightDocument.Stored : never)
|
1355
|
+
| (DocumentType extends "AmbientSound" ? AmbientSoundDocument.Stored : never)
|
1356
|
+
| (DocumentType extends "Drawing" ? DrawingDocument.Stored : never)
|
1357
|
+
| (DocumentType extends "MeasuredTemplate" ? MeasuredTemplateDocument.Stored : never)
|
1358
|
+
| (DocumentType extends "Note" ? NoteDocument.Stored : never)
|
1359
|
+
| (DocumentType extends "Region" ? NoteDocument.Stored : never)
|
1360
|
+
| (DocumentType extends "Tile" ? TileDocument.Stored : never)
|
1361
|
+
| (DocumentType extends "Token" ? TokenDocument.Stored : never)
|
1362
|
+
| (DocumentType extends "Wall" ? WallDocument.Stored : never);
|
1363
|
+
|
1364
|
+
type InvalidForName<DocumentType extends Document.Type> =
|
1365
|
+
| (DocumentType extends "ActiveEffect" ? ActiveEffect.Invalid : never)
|
1366
|
+
| (DocumentType extends "ActorDelta" ? ActorDelta.Invalid : never)
|
1367
|
+
| (DocumentType extends "Actor" ? Actor.Invalid : never)
|
1368
|
+
| (DocumentType extends "Adventure" ? Adventure.Invalid : never)
|
1369
|
+
| (DocumentType extends "Card" ? Card.Invalid : never)
|
1370
|
+
| (DocumentType extends "Cards" ? Cards.Invalid : never)
|
1371
|
+
| (DocumentType extends "ChatMessage" ? ChatMessage.Invalid : never)
|
1372
|
+
| (DocumentType extends "Combat" ? Combat.Invalid : never)
|
1373
|
+
| (DocumentType extends "Combatant" ? Combatant.Invalid : never)
|
1374
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Invalid : never)
|
1375
|
+
| (DocumentType extends "FogExploration" ? FogExploration.Invalid : never)
|
1376
|
+
| (DocumentType extends "Folder" ? Folder.Invalid : never)
|
1377
|
+
| (DocumentType extends "Item" ? Item.Invalid : never)
|
1378
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Invalid : never)
|
1379
|
+
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Invalid : never)
|
1380
|
+
| (DocumentType extends "JournalEntry" ? JournalEntry.Invalid : never)
|
1381
|
+
| (DocumentType extends "Macro" ? Macro.Invalid : never)
|
1382
|
+
| (DocumentType extends "PlaylistSound" ? PlaylistSound.Invalid : never)
|
1383
|
+
| (DocumentType extends "Playlist" ? Playlist.Invalid : never)
|
1384
|
+
| (DocumentType extends "RegionBehavior" ? RegionBehavior.Invalid : never)
|
1385
|
+
| (DocumentType extends "RollTable" ? RollTable.Invalid : never)
|
1386
|
+
| (DocumentType extends "Scene" ? Scene.Invalid : never)
|
1387
|
+
| (DocumentType extends "Setting" ? Setting.Invalid : never)
|
1388
|
+
| (DocumentType extends "TableResult" ? TableResult.Invalid : never)
|
1389
|
+
| (DocumentType extends "User" ? User.Invalid : never)
|
1390
|
+
| (DocumentType extends "AmbientLight" ? AmbientLightDocument.Invalid : never)
|
1391
|
+
| (DocumentType extends "AmbientSound" ? AmbientSoundDocument.Invalid : never)
|
1392
|
+
| (DocumentType extends "Drawing" ? DrawingDocument.Invalid : never)
|
1393
|
+
| (DocumentType extends "MeasuredTemplate" ? MeasuredTemplateDocument.Invalid : never)
|
1394
|
+
| (DocumentType extends "Note" ? NoteDocument.Invalid : never)
|
1395
|
+
| (DocumentType extends "Region" ? NoteDocument.Invalid : never)
|
1396
|
+
| (DocumentType extends "Tile" ? TileDocument.Invalid : never)
|
1397
|
+
| (DocumentType extends "Token" ? TokenDocument.Invalid : never)
|
1398
|
+
| (DocumentType extends "Wall" ? WallDocument.Invalid : never);
|
1399
|
+
|
1400
|
+
type NameFor<ConcreteDocument extends Document.Internal.Constructor> = ConcreteDocument["documentName"];
|
1275
1401
|
|
1276
1402
|
type ImplementationFor<Name extends Type> = ConfiguredDocumentInstance[Name];
|
1277
1403
|
type ImplementationClassFor<Name extends Type> = ConfiguredDocumentClass[Name];
|
@@ -1279,16 +1405,6 @@ declare namespace Document {
|
|
1279
1405
|
type ObjectClassFor<Name extends PlaceableType> = CONFIG[Name]["objectClass"];
|
1280
1406
|
type ObjectFor<Name extends PlaceableType> = FixedInstanceType<CONFIG[Name]["objectClass"]>;
|
1281
1407
|
|
1282
|
-
/**
|
1283
|
-
* @deprecated {@link ObjectClassFor | `ObjectClassFor`}
|
1284
|
-
*/
|
1285
|
-
type ConfiguredObjectClassForName<Name extends PlaceableType> = ObjectClassFor<Name>;
|
1286
|
-
|
1287
|
-
/**
|
1288
|
-
* @deprecated {@link ObjectFor | `ObjectFor`}
|
1289
|
-
*/
|
1290
|
-
type ConfiguredObjectInstanceForName<Name extends PlaceableType> = ObjectFor<Name>;
|
1291
|
-
|
1292
1408
|
type ConfiguredDataForName<Name extends Type> = GetKey<DataConfig, Name, EmptyObject>;
|
1293
1409
|
|
1294
1410
|
type ConfiguredSourceForName<Name extends Type> = GetKey<SourceConfig, Name, EmptyObject>;
|
@@ -1303,7 +1419,7 @@ declare namespace Document {
|
|
1303
1419
|
type MetadataFor<Name extends Document.Type> = ConfiguredMetadata[Name];
|
1304
1420
|
|
1305
1421
|
type CollectionRecord<Schema extends DataSchema> = {
|
1306
|
-
[Key in keyof Schema]: Schema[Key] extends
|
1422
|
+
[Key in keyof Schema]: Schema[Key] extends EmbeddedCollectionField.Any ? Schema[Key] : never;
|
1307
1423
|
};
|
1308
1424
|
|
1309
1425
|
type Flags<ConcreteDocument extends Internal.Instance.Any> = OptionsForSchema<SchemaFor<ConcreteDocument>>;
|
@@ -1351,30 +1467,59 @@ declare namespace Document {
|
|
1351
1467
|
};
|
1352
1468
|
}
|
1353
1469
|
|
1354
|
-
|
1470
|
+
/** @internal */
|
1471
|
+
type _ConstructionContext<Parent extends Document.Any | null> = NullishProps<{
|
1355
1472
|
/**
|
1356
1473
|
* The parent Document of this one, if this one is embedded
|
1357
1474
|
* @defaultValue `null`
|
1358
1475
|
*/
|
1359
|
-
parent
|
1476
|
+
parent: Parent;
|
1360
1477
|
|
1361
1478
|
/**
|
1362
1479
|
* The compendium collection ID which contains this Document, if any
|
1363
1480
|
* @defaultValue `null`
|
1364
1481
|
*/
|
1365
|
-
pack
|
1482
|
+
pack: string;
|
1366
1483
|
|
1367
1484
|
/**
|
1368
1485
|
* Whether to validate initial data strictly?
|
1369
1486
|
* @defaultValue `true`
|
1370
1487
|
*/
|
1371
|
-
strict
|
1488
|
+
strict: boolean;
|
1372
1489
|
|
1373
1490
|
/**
|
1374
|
-
* An immutable reverse-reference to the name of the collection that
|
1491
|
+
* An immutable reverse-reference to the name of the collection that this Document exists in on its parent, if any.
|
1492
|
+
* @privateRemarks Omitted from the typedef, inferred from usage in {@link Document._configure | `Document#_configure`}
|
1493
|
+
* (and included in the construction context rather than `ConfigureOptions` due to being passed to construction in
|
1494
|
+
* {@link foundry.abstract.EmbeddedCollection.createDocument | `EmbeddedCollection#createDocument`})
|
1375
1495
|
*/
|
1376
|
-
parentCollection
|
1377
|
-
}
|
1496
|
+
parentCollection: string;
|
1497
|
+
}>;
|
1498
|
+
|
1499
|
+
/**
|
1500
|
+
* Foundry does not include the properties from the DataModel construction context in `DocumentConstructionContext`,
|
1501
|
+
* but they're all still valid.
|
1502
|
+
*
|
1503
|
+
* `strict` is omitted from the DataModel interface so the Document interface's property
|
1504
|
+
* description takes precedence.
|
1505
|
+
*/
|
1506
|
+
interface ConstructionContext<Parent extends Document.Any | null = Document.Any | null>
|
1507
|
+
extends Omit<DataModel._ConstructionContext, "strict">,
|
1508
|
+
_ConstructionContext<Parent> {}
|
1509
|
+
|
1510
|
+
/** `DataModel#constructor` pulls `parent` and `strict` out of the passed context before forwarding to `#_configure` */
|
1511
|
+
interface ConfigureOptions extends Omit<ConstructionContext, "parent" | "strict"> {}
|
1512
|
+
|
1513
|
+
/** `DataModel#constructor` pulls `parent` out of the passed context before forwarding to `#_initializeSource` */
|
1514
|
+
interface InitializeOptions extends Omit<ConstructionContext, "parent"> {}
|
1515
|
+
|
1516
|
+
/**
|
1517
|
+
* `DataModel#constructor` pulls `parent` out of the passed context before forwarding to `#_initializeSource`
|
1518
|
+
* @privateRemarks `Document` doesn't override `_initializeSource`, but at least one specific document does (Actor only, as of v12);
|
1519
|
+
* Without an override, this is handled by the `& ExtraConstructorOptions` in the `DataModel` signature, but with one,
|
1520
|
+
* a manually combined interface is needed.
|
1521
|
+
*/
|
1522
|
+
interface InitializeSourceOptions extends DataModel.InitializeSourceOptions, Omit<ConstructionContext, "parent"> {}
|
1378
1523
|
|
1379
1524
|
interface ModificationContext<Parent extends Document.Any | null> {
|
1380
1525
|
/**
|
@@ -1460,92 +1605,57 @@ declare namespace Document {
|
|
1460
1605
|
deleteAll?: boolean | undefined;
|
1461
1606
|
}
|
1462
1607
|
|
1463
|
-
|
1608
|
+
/** @internal */
|
1609
|
+
type _CloneContext<Save extends boolean | null | undefined = boolean | null | undefined> = NullishProps<{
|
1464
1610
|
/**
|
1465
1611
|
* Save the clone to the World database?
|
1466
1612
|
* @defaultValue `false`
|
1467
1613
|
*/
|
1468
|
-
save
|
1614
|
+
save: Save;
|
1469
1615
|
|
1470
1616
|
/**
|
1471
1617
|
* Keep the same ID of the original document
|
1472
1618
|
* @defaultValue `false`
|
1473
1619
|
*/
|
1474
|
-
keepId
|
1620
|
+
keepId: boolean;
|
1475
1621
|
|
1476
1622
|
/**
|
1477
1623
|
* Track the clone source
|
1478
1624
|
* @defaultValue `false`
|
1479
1625
|
*/
|
1480
|
-
addSource
|
1481
|
-
}
|
1482
|
-
|
1483
|
-
type ModificationOptions = Omit<Document.ModificationContext<Document.Any | null>, "parent" | "pack">;
|
1484
|
-
|
1485
|
-
/* eslint-disable @typescript-eslint/no-deprecated */
|
1486
|
-
/** @deprecated Use {@link Database.PreCreateOptions | `Database.PreCreateOptions`} */
|
1487
|
-
type PreCreateOptions<Name extends Type> = Omit<
|
1488
|
-
Document.Database.OperationOf<Name, "create">,
|
1489
|
-
"data" | "noHook" | "pack" | "parent"
|
1490
|
-
>;
|
1491
|
-
|
1492
|
-
/** @deprecated Use {@link Database.CreateOptions | `Database.CreateOptions`} */
|
1493
|
-
type OnCreateOptions<Name extends Type> = Omit<
|
1494
|
-
Document.Database.OperationOf<Name, "create">,
|
1495
|
-
"pack" | "parentUuid" | "syntheticActorUpdate"
|
1496
|
-
>;
|
1497
|
-
|
1498
|
-
/** @deprecated Use {@link Database.PreUpdateOptions | `Database.PreUpdateOperation`} */
|
1499
|
-
type PreUpdateOptions<Name extends Type> = Omit<
|
1500
|
-
Document.Database.OperationOf<Name, "update">,
|
1501
|
-
"updates" | "restoreDelta" | "noHook" | "parent" | "pack"
|
1502
|
-
>;
|
1503
|
-
|
1504
|
-
/** @deprecated Use {@link Database.UpdateOptions | `Database.OnUpdateOperation`} */
|
1505
|
-
type OnUpdateOptions<Name extends Type> = Omit<
|
1506
|
-
Document.Database.OperationOf<Name, "update">,
|
1507
|
-
"pack" | "parentUuid" | "syntheticActorUpdate"
|
1508
|
-
>;
|
1509
|
-
|
1510
|
-
/** @deprecated Use {@link Database.PreDeleteOperationInstance | `Database.PreDeleteOperationInstance`} */
|
1511
|
-
type PreDeleteOptions<Name extends Type> = Omit<
|
1512
|
-
Document.Database.OperationOf<Name, "delete">,
|
1513
|
-
"ids" | "deleteAll" | "noHook" | "pack" | "parent"
|
1514
|
-
>;
|
1515
|
-
|
1516
|
-
/** @deprecated Use {@link Database.DeleteOptions | `Database.OnDeleteOptions`} */
|
1517
|
-
type OnDeleteOptions<Name extends Type> = Omit<
|
1518
|
-
Document.Database.OperationOf<Name, "delete">,
|
1519
|
-
"deleteAll" | "pack" | "parentUuid" | "syntheticActorUpdate"
|
1520
|
-
>;
|
1626
|
+
addSource: boolean;
|
1627
|
+
}>;
|
1521
1628
|
|
1522
|
-
/**
|
1523
|
-
|
1629
|
+
/**
|
1630
|
+
* @privateRemarks Since we've lost the ExtraConstructorOptions type param, we have to extend
|
1631
|
+
* the (parentless) construction context
|
1632
|
+
*/
|
1633
|
+
interface CloneContext<Save extends boolean | null | undefined = boolean | null | undefined>
|
1634
|
+
extends _CloneContext<Save>,
|
1635
|
+
Omit<Document.ConstructionContext, "parent"> {}
|
1524
1636
|
|
1525
|
-
|
1526
|
-
type OnUpsertOptions<Name extends Type> = OnCreateOptions<Name> | OnUpdateOptions<Name>;
|
1527
|
-
/* eslint-enable @typescript-eslint/no-deprecated */
|
1637
|
+
type ModificationOptions = Omit<Document.ModificationContext<Document.Any | null>, "parent" | "pack">;
|
1528
1638
|
|
1529
1639
|
interface Metadata<out ThisType extends Document.Any> {
|
1530
1640
|
readonly name: ThisType["documentName"];
|
1531
|
-
readonly collection: string;
|
1532
|
-
readonly indexed: boolean;
|
1533
|
-
readonly compendiumIndexFields: readonly string[];
|
1534
1641
|
readonly label: string;
|
1535
1642
|
readonly coreTypes: readonly string[];
|
1643
|
+
readonly collection: string;
|
1536
1644
|
readonly embedded: {
|
1537
1645
|
[DocumentType in Document.Type]?: string;
|
1538
1646
|
};
|
1539
1647
|
readonly permissions: {
|
1648
|
+
view: string | ToMethod<(user: User.Internal.Implementation, doc: ThisType, data: AnyObject) => boolean>;
|
1540
1649
|
create: string | ToMethod<(user: User.Internal.Implementation, doc: ThisType, data: AnyObject) => boolean>;
|
1541
1650
|
update: string | ToMethod<(user: User.Internal.Implementation, doc: ThisType, data: AnyObject) => boolean>;
|
1542
1651
|
delete: string | ToMethod<(user: User.Internal.Implementation, doc: ThisType, data: EmptyObject) => boolean>;
|
1543
1652
|
};
|
1653
|
+
readonly hasTypeData?: boolean;
|
1654
|
+
readonly indexed: boolean;
|
1655
|
+
readonly compendiumIndexFields: readonly string[];
|
1544
1656
|
readonly preserveOnImport: readonly string[];
|
1545
1657
|
readonly schemaVersion?: string | undefined;
|
1546
1658
|
readonly labelPlural?: string; // This is not set for the Document class but every class that implements Document actually provides it.
|
1547
|
-
readonly types?: readonly string[];
|
1548
|
-
readonly hasSystemData?: boolean;
|
1549
1659
|
}
|
1550
1660
|
|
1551
1661
|
namespace Metadata {
|
@@ -1553,69 +1663,54 @@ declare namespace Document {
|
|
1553
1663
|
|
1554
1664
|
interface Default {
|
1555
1665
|
readonly name: "Document";
|
1556
|
-
readonly collection: "documents";
|
1557
|
-
readonly indexed: false;
|
1558
|
-
readonly compendiumIndexFields: [];
|
1559
1666
|
readonly label: "DOCUMENT.Document";
|
1560
1667
|
readonly coreTypes: [CONST.BASE_DOCUMENT_TYPE];
|
1668
|
+
readonly collection: "documents";
|
1561
1669
|
readonly embedded: EmptyObject;
|
1670
|
+
readonly hasTypeData: false;
|
1671
|
+
readonly indexed: false;
|
1672
|
+
readonly compendiumIndexFields: [];
|
1562
1673
|
readonly permissions: {
|
1674
|
+
view: "LIMITED";
|
1563
1675
|
create: "ASSISTANT";
|
1564
|
-
update: "
|
1676
|
+
update: "OWNER";
|
1565
1677
|
delete: "ASSISTANT";
|
1566
1678
|
};
|
1567
|
-
readonly preserveOnImport: ["_id", "sort", "ownership"];
|
1679
|
+
readonly preserveOnImport: ["_id", "sort", "ownership", "folder"];
|
1568
1680
|
}
|
1569
1681
|
|
1570
1682
|
interface Embedded extends Identity<{ [K in Document.Type]?: string }> {}
|
1571
1683
|
}
|
1572
1684
|
|
1573
|
-
type
|
1685
|
+
type SheetClassFor<Name extends Document.Type> = MakeConform<
|
1574
1686
|
GetKey<GetKey<CONFIG, Name>, "sheetClass">,
|
1575
1687
|
AnyConstructor
|
1576
1688
|
>;
|
1577
1689
|
|
1578
|
-
type
|
1579
|
-
|
1580
|
-
type ConfiguredLayerClassFor<Name extends Document.Type> = GetKey<GetKey<CONFIG, Name>, "layerClass">;
|
1581
|
-
|
1582
|
-
type DropData<T extends Document.Any> = T extends { id: string | undefined }
|
1583
|
-
? DropData.Data<T> & DropData.UUID
|
1584
|
-
: DropData.Data<T>;
|
1585
|
-
|
1586
|
-
namespace DropData {
|
1587
|
-
type Any = DropData<any>;
|
1588
|
-
|
1589
|
-
interface Data<T extends Document.Any> {
|
1590
|
-
type: T["documentName"];
|
1591
|
-
data: T["_source"];
|
1592
|
-
}
|
1593
|
-
|
1594
|
-
interface UUID {
|
1595
|
-
uuid: string;
|
1596
|
-
}
|
1597
|
-
}
|
1690
|
+
type LayerClassFor<Name extends Document.Type> = GetKey<GetKey<CONFIG, Name>, "layerClass">;
|
1598
1691
|
|
1599
1692
|
namespace Database {
|
1600
1693
|
type Operation = "create" | "update" | "delete";
|
1601
1694
|
|
1602
|
-
|
1603
|
-
|
1604
|
-
|
1695
|
+
/**
|
1696
|
+
* @privateRemarks Foundry types {@link Document.get | `Document.get`} as taking a {@link DatabaseGetOperation | `DatabaseGetOperation`}
|
1697
|
+
* but it only ever looks for `pack`
|
1698
|
+
*/
|
1699
|
+
interface GetOptions extends Pick<DatabaseGetOperation, "pack"> {}
|
1605
1700
|
|
1606
|
-
/** Used for {@
|
1701
|
+
/** Used for {@linkcode Document.createDocuments} */
|
1607
1702
|
type CreateOperation<Op extends DatabaseCreateOperation> = NullishProps<Omit<Op, "data" | "modifiedTime">>;
|
1608
1703
|
|
1609
|
-
/** Used for {@
|
1704
|
+
/** Used for {@linkcode Document.update} */
|
1610
1705
|
type UpdateOperation<Op extends DatabaseUpdateOperation> = InexactPartial<Omit<Op, "updates">>;
|
1611
1706
|
|
1612
|
-
/** Used for {@
|
1707
|
+
/** Used for {@linkcode Document.delete} */
|
1613
1708
|
type DeleteOperation<Op extends DatabaseDeleteOperation> = InexactPartial<Omit<Op, "ids">>;
|
1614
1709
|
|
1615
|
-
/** Used for {@
|
1616
|
-
type PreCreateOperationStatic<Op extends DatabaseCreateOperation> =
|
1710
|
+
/** Used for {@linkcode Document._preCreateOperation} */
|
1711
|
+
type PreCreateOperationStatic<Op extends DatabaseCreateOperation> = InexactPartialExcept<
|
1617
1712
|
Op,
|
1618
|
-
|
1713
|
+
"modifiedTime" | "render" | "renderSheet" | "data" | "noHook" | "pack" | "parent"
|
1619
1714
|
>;
|
1620
1715
|
|
1621
1716
|
/** Used for {@link Document._preCreate | `Document#_preCreate`} */
|
@@ -1630,7 +1725,7 @@ declare namespace Document {
|
|
1630
1725
|
"data" | "pack" | "parentUuid" | "syntheticActorUpdate"
|
1631
1726
|
>;
|
1632
1727
|
|
1633
|
-
/** Used for {@
|
1728
|
+
/** Used for {@linkcode Document.updateDocuments} */
|
1634
1729
|
type UpdateDocumentsOperation<Op extends DatabaseUpdateOperation> = NullishProps<
|
1635
1730
|
Omit<Op, "updates" | "modifiedTime">
|
1636
1731
|
>;
|
@@ -1640,13 +1735,10 @@ declare namespace Document {
|
|
1640
1735
|
Omit<Op, "updates" | "parent" | "pack">
|
1641
1736
|
>;
|
1642
1737
|
|
1643
|
-
/** Used for {@
|
1644
|
-
type PreUpdateOperationStatic<Op extends DatabaseUpdateOperation> =
|
1738
|
+
/** Used for {@linkcode Document._preUpdateOperation} */
|
1739
|
+
type PreUpdateOperationStatic<Op extends DatabaseUpdateOperation> = InexactPartialExcept<
|
1645
1740
|
Op,
|
1646
|
-
|
1647
|
-
AllKeysOf<Op>,
|
1648
|
-
"modifiedTime" | "diff" | "recursive" | "render" | "updates" | "restoreDelta" | "noHook" | "pack" | "parent"
|
1649
|
-
>
|
1741
|
+
"modifiedTime" | "diff" | "recursive" | "render" | "updates" | "restoreDelta" | "noHook" | "pack" | "parent"
|
1650
1742
|
>;
|
1651
1743
|
|
1652
1744
|
/** Used for {@link Document._preUpdate | `Document#_preUpdate`} */
|
@@ -1661,23 +1753,23 @@ declare namespace Document {
|
|
1661
1753
|
"updates" | "pack" | "parentUuid" | "syntheticActorUpdate"
|
1662
1754
|
>;
|
1663
1755
|
|
1664
|
-
/** Used for {@
|
1756
|
+
/** Used for {@linkcode Document.deleteDocuments} */
|
1665
1757
|
type DeleteDocumentsOperation<Op extends DatabaseDeleteOperation> = NullishProps<Omit<Op, "ids" | "modifiedTime">>;
|
1666
1758
|
|
1667
|
-
/** Used for {@
|
1759
|
+
/** Used for {@linkcode Document.delete} */
|
1668
1760
|
type DeleteOperationInstance<Op extends DatabaseDeleteOperation> = InexactPartial<
|
1669
1761
|
Omit<Op, "ids" | "parent" | "pack">
|
1670
1762
|
>;
|
1671
1763
|
|
1672
|
-
/** Used for {@
|
1673
|
-
type PreDeleteOperationStatic<Op extends DatabaseDeleteOperation> =
|
1764
|
+
/** Used for {@linkcode Document._preDeleteOperation} */
|
1765
|
+
type PreDeleteOperationStatic<Op extends DatabaseDeleteOperation> = InexactPartialExcept<
|
1674
1766
|
Op,
|
1675
|
-
|
1767
|
+
"modifiedTime" | "render" | "ids" | "deleteAll" | "noHook" | "pack" | "parent"
|
1676
1768
|
>;
|
1677
1769
|
|
1678
1770
|
/** Used for {@link Document._preDelete | `Document#_preDelete`} */
|
1679
1771
|
type PreDeleteOperationInstance<Op extends DatabaseDeleteOperation> = Omit<
|
1680
|
-
|
1772
|
+
InexactPartialExcept<Op, "modifiedTime" | "render">,
|
1681
1773
|
"ids" | "deleteAll" | "noHook" | "pack" | "parent"
|
1682
1774
|
>;
|
1683
1775
|
|
@@ -1687,31 +1779,6 @@ declare namespace Document {
|
|
1687
1779
|
"ids" | "deleteAll" | "pack" | "parentUuid" | "syntheticActorUpdate"
|
1688
1780
|
>;
|
1689
1781
|
|
1690
|
-
/**
|
1691
|
-
* This is a helper type that gets the right DatabaseOperation (including the
|
1692
|
-
* proper options) for a particular Document type.
|
1693
|
-
*
|
1694
|
-
* @deprecated This is no longer used internally inside fvtt-types. If you have use for it please file an issue.
|
1695
|
-
*/
|
1696
|
-
type OperationOf<T extends Document.Type, Operation extends Database.Operation> =
|
1697
|
-
| (Operation extends "create" ? DatabaseOperationCreateMap[T] : never)
|
1698
|
-
| (Operation extends "update" ? DatabaseOperationUpdateMap[T] : never)
|
1699
|
-
| (Operation extends "delete" ? DatabaseOperationDeleteMap[T] : never);
|
1700
|
-
|
1701
|
-
/**
|
1702
|
-
* @deprecated See individual document's namespaces.
|
1703
|
-
*/
|
1704
|
-
interface Operations<
|
1705
|
-
_T extends Document.Internal.Instance.Any = Document.Internal.Instance.Any,
|
1706
|
-
_ExtraCreateOptions extends AnyObject = any,
|
1707
|
-
_ExtraUpdateOptions extends AnyObject = any,
|
1708
|
-
_ExtraDeleteOptions extends AnyObject = any,
|
1709
|
-
> {
|
1710
|
-
create: AnyObject;
|
1711
|
-
update: AnyObject;
|
1712
|
-
delete: AnyObject;
|
1713
|
-
}
|
1714
|
-
|
1715
1782
|
type CreateForName<DocumentType extends Document.Type> =
|
1716
1783
|
| (DocumentType extends "ActiveEffect" ? ActiveEffect.Database.Create : never)
|
1717
1784
|
| (DocumentType extends "ActorDelta" ? ActorDelta.Database.Create : never)
|
@@ -1722,9 +1789,11 @@ declare namespace Document {
|
|
1722
1789
|
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.Create : never)
|
1723
1790
|
| (DocumentType extends "Combat" ? Combat.Database.Create : never)
|
1724
1791
|
| (DocumentType extends "Combatant" ? Combatant.Database.Create : never)
|
1792
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Database.Create : never)
|
1725
1793
|
| (DocumentType extends "FogExploration" ? FogExploration.Database.Create : never)
|
1726
1794
|
| (DocumentType extends "Folder" ? Folder.Database.Create : never)
|
1727
1795
|
| (DocumentType extends "Item" ? Item.Database.Create : never)
|
1796
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.Create : never)
|
1728
1797
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.Create : never)
|
1729
1798
|
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.Create : never)
|
1730
1799
|
| (DocumentType extends "Macro" ? Macro.Database.Create : never)
|
@@ -1746,6 +1815,45 @@ declare namespace Document {
|
|
1746
1815
|
| (DocumentType extends "Token" ? TokenDocument.Database.Create : never)
|
1747
1816
|
| (DocumentType extends "Wall" ? WallDocument.Database.Create : never);
|
1748
1817
|
|
1818
|
+
type CreateOperationForName<
|
1819
|
+
DocumentType extends Document.Type,
|
1820
|
+
Temporary extends boolean | undefined = undefined,
|
1821
|
+
> =
|
1822
|
+
| (DocumentType extends "ActiveEffect" ? ActiveEffect.Database.CreateOperation<Temporary> : never)
|
1823
|
+
| (DocumentType extends "ActorDelta" ? ActorDelta.Database.CreateOperation<Temporary> : never)
|
1824
|
+
| (DocumentType extends "Actor" ? Actor.Database.CreateOperation<Temporary> : never)
|
1825
|
+
| (DocumentType extends "Adventure" ? Adventure.Database.CreateOperation<Temporary> : never)
|
1826
|
+
| (DocumentType extends "Card" ? Card.Database.CreateOperation<Temporary> : never)
|
1827
|
+
| (DocumentType extends "Cards" ? Cards.Database.CreateOperation<Temporary> : never)
|
1828
|
+
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.CreateOperation<Temporary> : never)
|
1829
|
+
| (DocumentType extends "Combat" ? Combat.Database.CreateOperation<Temporary> : never)
|
1830
|
+
| (DocumentType extends "Combatant" ? Combatant.Database.CreateOperation<Temporary> : never)
|
1831
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Database.CreateOperation<Temporary> : never)
|
1832
|
+
| (DocumentType extends "FogExploration" ? FogExploration.Database.CreateOperation<Temporary> : never)
|
1833
|
+
| (DocumentType extends "Folder" ? Folder.Database.CreateOperation<Temporary> : never)
|
1834
|
+
| (DocumentType extends "Item" ? Item.Database.CreateOperation<Temporary> : never)
|
1835
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.CreateOperation<Temporary> : never)
|
1836
|
+
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.CreateOperation<Temporary> : never)
|
1837
|
+
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.CreateOperation<Temporary> : never)
|
1838
|
+
| (DocumentType extends "Macro" ? Macro.Database.CreateOperation<Temporary> : never)
|
1839
|
+
| (DocumentType extends "PlaylistSound" ? PlaylistSound.Database.CreateOperation<Temporary> : never)
|
1840
|
+
| (DocumentType extends "Playlist" ? Playlist.Database.CreateOperation<Temporary> : never)
|
1841
|
+
| (DocumentType extends "RegionBehavior" ? RegionBehavior.Database.CreateOperation<Temporary> : never)
|
1842
|
+
| (DocumentType extends "RollTable" ? RollTable.Database.CreateOperation<Temporary> : never)
|
1843
|
+
| (DocumentType extends "Scene" ? Scene.Database.CreateOperation<Temporary> : never)
|
1844
|
+
| (DocumentType extends "Setting" ? Setting.Database.CreateOperation<Temporary> : never)
|
1845
|
+
| (DocumentType extends "TableResult" ? TableResult.Database.CreateOperation<Temporary> : never)
|
1846
|
+
| (DocumentType extends "User" ? User.Database.CreateOperation<Temporary> : never)
|
1847
|
+
| (DocumentType extends "AmbientLight" ? AmbientLightDocument.Database.CreateOperation<Temporary> : never)
|
1848
|
+
| (DocumentType extends "AmbientSound" ? AmbientSoundDocument.Database.CreateOperation<Temporary> : never)
|
1849
|
+
| (DocumentType extends "Drawing" ? DrawingDocument.Database.CreateOperation<Temporary> : never)
|
1850
|
+
| (DocumentType extends "MeasuredTemplate" ? MeasuredTemplateDocument.Database.CreateOperation<Temporary> : never)
|
1851
|
+
| (DocumentType extends "Note" ? NoteDocument.Database.CreateOperation<Temporary> : never)
|
1852
|
+
| (DocumentType extends "Region" ? RegionDocument.Database.CreateOperation<Temporary> : never)
|
1853
|
+
| (DocumentType extends "Tile" ? TileDocument.Database.CreateOperation<Temporary> : never)
|
1854
|
+
| (DocumentType extends "Token" ? TokenDocument.Database.CreateOperation<Temporary> : never)
|
1855
|
+
| (DocumentType extends "Wall" ? WallDocument.Database.CreateOperation<Temporary> : never);
|
1856
|
+
|
1749
1857
|
type UpdateOperationForName<DocumentType extends Document.Type> =
|
1750
1858
|
| (DocumentType extends "ActiveEffect" ? ActiveEffect.Database.UpdateOperation : never)
|
1751
1859
|
| (DocumentType extends "ActorDelta" ? ActorDelta.Database.UpdateOperation : never)
|
@@ -1756,9 +1864,11 @@ declare namespace Document {
|
|
1756
1864
|
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.UpdateOperation : never)
|
1757
1865
|
| (DocumentType extends "Combat" ? Combat.Database.UpdateOperation : never)
|
1758
1866
|
| (DocumentType extends "Combatant" ? Combatant.Database.UpdateOperation : never)
|
1867
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Database.UpdateOperation : never)
|
1759
1868
|
| (DocumentType extends "FogExploration" ? FogExploration.Database.UpdateOperation : never)
|
1760
1869
|
| (DocumentType extends "Folder" ? Folder.Database.UpdateOperation : never)
|
1761
1870
|
| (DocumentType extends "Item" ? Item.Database.UpdateOperation : never)
|
1871
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.UpdateOperation : never)
|
1762
1872
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.UpdateOperation : never)
|
1763
1873
|
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.UpdateOperation : never)
|
1764
1874
|
| (DocumentType extends "Macro" ? Macro.Database.UpdateOperation : never)
|
@@ -1790,9 +1900,11 @@ declare namespace Document {
|
|
1790
1900
|
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.DeleteOperation : never)
|
1791
1901
|
| (DocumentType extends "Combat" ? Combat.Database.DeleteOperation : never)
|
1792
1902
|
| (DocumentType extends "Combatant" ? Combatant.Database.DeleteOperation : never)
|
1903
|
+
| (DocumentType extends "CombatantGround" ? CombatantGroup.Database.DeleteOperation : never)
|
1793
1904
|
| (DocumentType extends "FogExploration" ? FogExploration.Database.DeleteOperation : never)
|
1794
1905
|
| (DocumentType extends "Folder" ? Folder.Database.DeleteOperation : never)
|
1795
1906
|
| (DocumentType extends "Item" ? Item.Database.DeleteOperation : never)
|
1907
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.DeleteOperation : never)
|
1796
1908
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.DeleteOperation : never)
|
1797
1909
|
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.DeleteOperation : never)
|
1798
1910
|
| (DocumentType extends "Macro" ? Macro.Database.DeleteOperation : never)
|
@@ -1824,9 +1936,11 @@ declare namespace Document {
|
|
1824
1936
|
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.CreateOptions : never)
|
1825
1937
|
| (DocumentType extends "Combat" ? Combat.Database.CreateOptions : never)
|
1826
1938
|
| (DocumentType extends "Combatant" ? Combatant.Database.CreateOptions : never)
|
1939
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Database.CreateOptions : never)
|
1827
1940
|
| (DocumentType extends "FogExploration" ? FogExploration.Database.CreateOptions : never)
|
1828
1941
|
| (DocumentType extends "Folder" ? Folder.Database.CreateOptions : never)
|
1829
1942
|
| (DocumentType extends "Item" ? Item.Database.CreateOptions : never)
|
1943
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.CreateOptions : never)
|
1830
1944
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.CreateOptions : never)
|
1831
1945
|
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.CreateOptions : never)
|
1832
1946
|
| (DocumentType extends "Macro" ? Macro.Database.CreateOptions : never)
|
@@ -1858,9 +1972,11 @@ declare namespace Document {
|
|
1858
1972
|
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.UpdateOptions : never)
|
1859
1973
|
| (DocumentType extends "Combat" ? Combat.Database.UpdateOptions : never)
|
1860
1974
|
| (DocumentType extends "Combatant" ? Combatant.Database.UpdateOptions : never)
|
1975
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Database.UpdateOptions : never)
|
1861
1976
|
| (DocumentType extends "FogExploration" ? FogExploration.Database.UpdateOptions : never)
|
1862
1977
|
| (DocumentType extends "Folder" ? Folder.Database.UpdateOptions : never)
|
1863
1978
|
| (DocumentType extends "Item" ? Item.Database.UpdateOptions : never)
|
1979
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.UpdateOptions : never)
|
1864
1980
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.UpdateOptions : never)
|
1865
1981
|
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.UpdateOptions : never)
|
1866
1982
|
| (DocumentType extends "Macro" ? Macro.Database.UpdateOptions : never)
|
@@ -1892,9 +2008,11 @@ declare namespace Document {
|
|
1892
2008
|
| (DocumentType extends "ChatMessage" ? ChatMessage.Database.DeleteOptions : never)
|
1893
2009
|
| (DocumentType extends "Combat" ? Combat.Database.DeleteOptions : never)
|
1894
2010
|
| (DocumentType extends "Combatant" ? Combatant.Database.DeleteOptions : never)
|
2011
|
+
| (DocumentType extends "CombatantGroup" ? CombatantGroup.Database.DeleteOptions : never)
|
1895
2012
|
| (DocumentType extends "FogExploration" ? FogExploration.Database.DeleteOptions : never)
|
1896
2013
|
| (DocumentType extends "Folder" ? Folder.Database.DeleteOptions : never)
|
1897
2014
|
| (DocumentType extends "Item" ? Item.Database.DeleteOptions : never)
|
2015
|
+
| (DocumentType extends "JournalEntryCategory" ? JournalEntryCategory.Database.DeleteOptions : never)
|
1898
2016
|
| (DocumentType extends "JournalEntryPage" ? JournalEntryPage.Database.DeleteOptions : never)
|
1899
2017
|
| (DocumentType extends "JournalEntry" ? JournalEntry.Database.DeleteOptions : never)
|
1900
2018
|
| (DocumentType extends "Macro" ? Macro.Database.DeleteOptions : never)
|
@@ -1919,7 +2037,7 @@ declare namespace Document {
|
|
1919
2037
|
|
1920
2038
|
interface DataFieldShimOptions {
|
1921
2039
|
/**
|
1922
|
-
*
|
2040
|
+
* A string to log as a compatibility warning on accessing the `oldKey`
|
1923
2041
|
*/
|
1924
2042
|
warning?: string | null | undefined;
|
1925
2043
|
|
@@ -1929,6 +2047,11 @@ declare namespace Document {
|
|
1929
2047
|
value?: unknown;
|
1930
2048
|
}
|
1931
2049
|
|
2050
|
+
/**
|
2051
|
+
* If a `parent` is required for a given Document's creation, its template must pass `NonNullable<X.Parent>` to `CreateDialogContext`
|
2052
|
+
*
|
2053
|
+
* @internal
|
2054
|
+
*/
|
1932
2055
|
type ParentContext<Parent extends Document.Any | null> = Parent extends null
|
1933
2056
|
? {
|
1934
2057
|
/** A parent document within which the created Document should belong */
|
@@ -1939,45 +2062,103 @@ declare namespace Document {
|
|
1939
2062
|
parent: Parent;
|
1940
2063
|
};
|
1941
2064
|
|
1942
|
-
|
1943
|
-
|
1944
|
-
|
1945
|
-
|
1946
|
-
|
1947
|
-
|
1948
|
-
|
2065
|
+
/** @internal */
|
2066
|
+
type _PossibleSubtypeContext<DocumentName extends Document.Type> =
|
2067
|
+
GetKey<Document.MetadataFor<DocumentName>, "hasTypeData"> extends true
|
2068
|
+
? NullishProps<{
|
2069
|
+
/**
|
2070
|
+
* The sub-type of the document
|
2071
|
+
* @remarks Pulls from `CONFIG[documentName].typeLabels?.[type]` if provided. Ignored if falsey.
|
2072
|
+
*/
|
2073
|
+
type: Document.SubTypesOf<DocumentName>;
|
2074
|
+
}>
|
2075
|
+
: {
|
2076
|
+
/** @deprecated This Document type does not support subtypes */
|
2077
|
+
type?: never;
|
2078
|
+
};
|
2079
|
+
|
2080
|
+
type DefaultNameContext<DocumentName extends Document.Type, Parent extends Document.Any | null> = InexactPartial<{
|
2081
|
+
/**
|
2082
|
+
* A compendium pack within which the Document should be created
|
2083
|
+
* @remarks Only used to generate the list of existing names to check against when incrementing the index for the `(number)` suffix.
|
2084
|
+
* Ignored if falsey, or if `parent` is provided and truthy.
|
2085
|
+
*/
|
2086
|
+
pack: string | null;
|
1949
2087
|
|
1950
|
-
interface FromDropDataOptions {
|
1951
2088
|
/**
|
1952
|
-
*
|
1953
|
-
* @
|
2089
|
+
* A parent document within which the created Document should belong
|
2090
|
+
* @remarks Only used to generate the list of existing names to check against when incrementing the index for the `(number)` suffix.
|
2091
|
+
* Ignored if falsey.
|
1954
2092
|
*/
|
1955
|
-
|
1956
|
-
}
|
2093
|
+
parent: Parent | null;
|
2094
|
+
}> &
|
2095
|
+
_PossibleSubtypeContext<DocumentName>;
|
1957
2096
|
|
1958
|
-
|
1959
|
-
|
1960
|
-
Extract<
|
1961
|
-
|
2097
|
+
// TODO(LukeAbby): Inline into each document.
|
2098
|
+
type CreateDialogData<CreateData extends object> = InexactPartial<{
|
2099
|
+
[K in keyof CreateData as Extract<K, "name" | "type" | "folder">]: CreateData[K];
|
2100
|
+
}> &
|
2101
|
+
Omit<CreateData, "name" | "type" | "folder">;
|
1962
2102
|
|
2103
|
+
/** @internal */
|
2104
|
+
type _PossibleSubtypesContext<DocumentName extends Document.Type> =
|
2105
|
+
GetKey<Document.MetadataFor<DocumentName>, "hasTypeData"> extends true
|
2106
|
+
? {
|
2107
|
+
/** @deprecated This Document type does not support subtypes */
|
2108
|
+
types?: never;
|
2109
|
+
}
|
2110
|
+
: NullishProps<{
|
2111
|
+
/**
|
2112
|
+
* A restriction the selectable sub-types of the Dialog.
|
2113
|
+
* @remarks Only checked if the document has `static TYPES` of length \> 1 (i.e it both `hasTypeData` and has
|
2114
|
+
* at least one non-`"base"` type registered). The computed list will always exclude {@link CONST.BASE_DOCUMENT_TYPE | `CONST.BASE_DOCUMENT_TYPE`},
|
2115
|
+
* so it is disallowed in this whitelist.
|
2116
|
+
*/
|
2117
|
+
types: Exclude<Document.SubTypesOf<DocumentName>, "base">[];
|
2118
|
+
}>;
|
2119
|
+
|
2120
|
+
/** @deprecated in favor of {@linkcode CreateDialogOptions} */
|
1963
2121
|
type CreateDialogContext<
|
1964
|
-
|
2122
|
+
DocumentName extends Document.Type,
|
1965
2123
|
Parent extends Document.Any | null,
|
1966
|
-
> = InexactPartial<Dialog.Options> &
|
2124
|
+
> = InexactPartial<foundry.appv1.api.Dialog.Options> &
|
2125
|
+
NullishProps<{
|
2126
|
+
/**
|
2127
|
+
* A compendium pack within which the Document should be created
|
2128
|
+
* @remarks Only checked if `parent` is falsey, and only used to generate the list of folders for the dialog
|
2129
|
+
*/
|
2130
|
+
pack: string;
|
2131
|
+
}> &
|
2132
|
+
_PossibleSubtypesContext<DocumentName> &
|
2133
|
+
ParentContext<Parent>;
|
2134
|
+
|
2135
|
+
type CreateDialogOptions<DocumentName extends Document.Type> =
|
2136
|
+
InexactPartial<foundry.applications.api.DialogV2.PromptConfig> &
|
2137
|
+
NullishProps<{
|
2138
|
+
/**
|
2139
|
+
* A template to use for the dialog contents instead of the default.
|
2140
|
+
*/
|
2141
|
+
template: string;
|
2142
|
+
|
2143
|
+
/**
|
2144
|
+
* Additional render context to provide to the template.
|
2145
|
+
*/
|
2146
|
+
context: AnyObject;
|
2147
|
+
}> &
|
2148
|
+
_PossibleSubtypesContext<DocumentName>;
|
2149
|
+
|
2150
|
+
interface FromImportContext<Parent extends Document.Any | null> extends Omit<ConstructionContext<Parent>, "strict"> {
|
1967
2151
|
/**
|
1968
|
-
*
|
2152
|
+
* Strict validation is enabled by default.
|
2153
|
+
* @defaultValue `true`
|
2154
|
+
* @remarks Not allowed to be `undefined` as that would produce `false`, not the expected default of `true`, due to being spread
|
2155
|
+
* into an object with `strict: true`, then passed to {@link Document.fromSource | `Document.fromSource`}, where the parameter
|
2156
|
+
* default is `false`
|
1969
2157
|
*/
|
1970
|
-
|
1971
|
-
|
1972
|
-
/** A restriction the selectable sub-types of the Dialog. */
|
1973
|
-
types?: SubType[] | null | undefined;
|
1974
|
-
} & ParentContext<Parent>;
|
1975
|
-
|
1976
|
-
interface FromImportContext<Parent extends Document.Any | null>
|
1977
|
-
extends ConstructionContext<Parent>,
|
1978
|
-
DataModel.DataValidationOptions<Parent> {}
|
2158
|
+
strict?: boolean | null;
|
2159
|
+
}
|
1979
2160
|
|
1980
|
-
type
|
2161
|
+
type ActionPermission = keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS;
|
1981
2162
|
|
1982
2163
|
/** @internal */
|
1983
2164
|
type _TestUserPermissionsOptions = NullishProps<{
|
@@ -1990,39 +2171,6 @@ declare namespace Document {
|
|
1990
2171
|
|
1991
2172
|
interface TestUserPermissionOptions extends _TestUserPermissionsOptions {}
|
1992
2173
|
|
1993
|
-
/**
|
1994
|
-
* @deprecated {@link ImplementationFor | `ImplementationFor`}
|
1995
|
-
*/
|
1996
|
-
type ConfiguredInstanceForName<Name extends Type> = ImplementationFor<Name>;
|
1997
|
-
|
1998
|
-
/**
|
1999
|
-
* @deprecated {@link ImplementationClassFor | `ImplementationClassFor`}
|
2000
|
-
*/
|
2001
|
-
type ConfiguredClassForName<Name extends Type> = ImplementationClassFor<Name>;
|
2002
|
-
|
2003
|
-
/**
|
2004
|
-
* @deprecated {@link SchemaField.SourceData | `SchemaField.SourceData<Schema>`}
|
2005
|
-
*/
|
2006
|
-
type ToObjectFalseType<T extends Document.Internal.Instance.Any> = T extends {
|
2007
|
-
toObject: (source: false) => infer U;
|
2008
|
-
}
|
2009
|
-
? U
|
2010
|
-
: T;
|
2011
|
-
|
2012
|
-
/**
|
2013
|
-
* @deprecated {@link Document.Database.OperationOf | `Document.Database.OperationOf`}
|
2014
|
-
*/
|
2015
|
-
type DatabaseOperationsFor<
|
2016
|
-
Name extends Document.Type,
|
2017
|
-
ConcreteOperation extends Document.Database.Operation,
|
2018
|
-
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
2019
|
-
> = Document.Database.OperationOf<Name, ConcreteOperation>;
|
2020
|
-
|
2021
|
-
/**
|
2022
|
-
* @deprecated {@link CreateDataForName | `CreateDataForName`}
|
2023
|
-
*/
|
2024
|
-
type ConstructorDataForName<T extends Document.Type> = CreateData[T];
|
2025
|
-
|
2026
2174
|
type CanUserModifyData<Schema extends DataSchema, Action extends "create" | "update" | "delete"> =
|
2027
2175
|
| (Action extends "create" ? SchemaField.CreateData<Schema> : never)
|
2028
2176
|
| (Action extends "update" ? SchemaField.UpdateData<Schema> : never)
|
@@ -2142,152 +2290,161 @@ declare namespace Document {
|
|
2142
2290
|
userId: string,
|
2143
2291
|
]
|
2144
2292
|
: never;
|
2145
|
-
}
|
2146
2293
|
|
2147
|
-
|
2148
|
-
|
2294
|
+
type Clone<This extends Document.Any, Save extends boolean | null | undefined> = Save extends true
|
2295
|
+
? Promise<This>
|
2296
|
+
: This;
|
2149
2297
|
|
2150
|
-
|
2151
|
-
|
2152
|
-
|
2153
|
-
|
2154
|
-
|
2155
|
-
|
2156
|
-
|
2157
|
-
|
2158
|
-
|
2159
|
-
|
2160
|
-
|
2161
|
-
|
2162
|
-
|
2163
|
-
|
2164
|
-
|
2165
|
-
|
2166
|
-
|
2167
|
-
|
2168
|
-
|
2169
|
-
|
2170
|
-
|
2171
|
-
|
2172
|
-
|
2173
|
-
|
2174
|
-
|
2175
|
-
|
2176
|
-
|
2177
|
-
|
2178
|
-
|
2179
|
-
|
2180
|
-
|
2181
|
-
|
2182
|
-
|
2183
|
-
|
2184
|
-
|
2185
|
-
|
2186
|
-
|
2187
|
-
|
2188
|
-
|
2189
|
-
|
2190
|
-
|
2191
|
-
|
2192
|
-
|
2193
|
-
|
2194
|
-
|
2195
|
-
|
2196
|
-
|
2197
|
-
|
2198
|
-
Cards: Cards.Database.Create;
|
2199
|
-
ChatMessage: ChatMessage.Database.Create;
|
2200
|
-
Combat: Combat.Database.Create;
|
2201
|
-
Combatant: Combatant.Database.Create;
|
2202
|
-
Drawing: DrawingDocument.Database.Create;
|
2203
|
-
FogExploration: FogExploration.Database.Create;
|
2204
|
-
Folder: Folder.Database.Create;
|
2205
|
-
Item: Item.Database.Create;
|
2206
|
-
JournalEntry: JournalEntry.Database.Create;
|
2207
|
-
JournalEntryPage: JournalEntryPage.Database.Create;
|
2208
|
-
Macro: Macro.Database.Create;
|
2209
|
-
MeasuredTemplate: MeasuredTemplateDocument.Database.Create;
|
2210
|
-
Note: NoteDocument.Database.Create;
|
2211
|
-
Playlist: Playlist.Database.Create;
|
2212
|
-
PlaylistSound: PlaylistSound.Database.Create;
|
2213
|
-
Region: RegionDocument.Database.Create;
|
2214
|
-
RegionBehavior: RegionBehavior.Database.Create;
|
2215
|
-
RollTable: RollTable.Database.Create;
|
2216
|
-
Scene: Scene.Database.Create;
|
2217
|
-
Setting: Setting.Database.Create;
|
2218
|
-
TableResult: TableResult.Database.Create;
|
2219
|
-
Tile: TileDocument.Database.Create;
|
2220
|
-
Token: TokenDocument.Database.Create;
|
2221
|
-
User: User.Database.Create;
|
2222
|
-
Wall: WallDocument.Database.Create;
|
2223
|
-
}
|
2298
|
+
/**
|
2299
|
+
* The options for `fromDropData`. Foundry never uses these so the interface is currently empty.
|
2300
|
+
*/
|
2301
|
+
// eslint-disable-next-line @typescript-eslint/no-empty-object-type
|
2302
|
+
interface DropDataOptions {}
|
2303
|
+
|
2304
|
+
type DropDataFor<Name extends Document.Type> = {
|
2305
|
+
ActiveEffect: ActiveEffect.DropData;
|
2306
|
+
ActorDelta: ActorDelta.DropData;
|
2307
|
+
Actor: Actor.DropData;
|
2308
|
+
Adventure: Adventure.DropData;
|
2309
|
+
Card: Card.DropData;
|
2310
|
+
Cards: Cards.DropData;
|
2311
|
+
ChatMessage: ChatMessage.DropData;
|
2312
|
+
Combat: Combat.DropData;
|
2313
|
+
Combatant: Combatant.DropData;
|
2314
|
+
CombatantGroup: CombatantGroup.DropData;
|
2315
|
+
FogExploration: FogExploration.DropData;
|
2316
|
+
Folder: Folder.DropData;
|
2317
|
+
Item: Item.DropData;
|
2318
|
+
JournalEntryCategory: JournalEntryCategory.DropData;
|
2319
|
+
JournalEntryPage: JournalEntryPage.DropData;
|
2320
|
+
JournalEntry: JournalEntry.DropData;
|
2321
|
+
Macro: Macro.DropData;
|
2322
|
+
PlaylistSound: PlaylistSound.DropData;
|
2323
|
+
Playlist: Playlist.DropData;
|
2324
|
+
RegionBehavior: RegionBehavior.DropData;
|
2325
|
+
RollTable: RollTable.DropData;
|
2326
|
+
Scene: Scene.DropData;
|
2327
|
+
Setting: Setting.DropData;
|
2328
|
+
TableResult: TableResult.DropData;
|
2329
|
+
User: User.DropData;
|
2330
|
+
AmbientLight: AmbientLightDocument.DropData;
|
2331
|
+
AmbientSound: AmbientSoundDocument.DropData;
|
2332
|
+
Drawing: DrawingDocument.DropData;
|
2333
|
+
MeasuredTemplate: MeasuredTemplateDocument.DropData;
|
2334
|
+
Note: NoteDocument.DropData;
|
2335
|
+
Region: RegionDocument.DropData;
|
2336
|
+
Tile: TileDocument.DropData;
|
2337
|
+
Token: TokenDocument.DropData;
|
2338
|
+
Wall: WallDocument.DropData;
|
2339
|
+
}[Name];
|
2340
|
+
|
2341
|
+
/**
|
2342
|
+
* @deprecated This type should not be used directly. Use `StoredForName` as this type does not account for anything declaration merged into `Stored`.
|
2343
|
+
*/
|
2344
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
2345
|
+
type ToConfiguredStored<D extends Document.AnyConstructor> = Stored<ToConfiguredInstance<D>>;
|
2224
2346
|
|
2225
|
-
|
2226
|
-
|
2227
|
-
|
2228
|
-
|
2229
|
-
|
2230
|
-
|
2231
|
-
|
2232
|
-
|
2233
|
-
|
2234
|
-
|
2235
|
-
|
2236
|
-
|
2237
|
-
|
2238
|
-
|
2239
|
-
|
2240
|
-
|
2241
|
-
|
2242
|
-
|
2243
|
-
|
2244
|
-
|
2245
|
-
|
2246
|
-
|
2247
|
-
|
2248
|
-
|
2249
|
-
|
2250
|
-
|
2251
|
-
|
2252
|
-
|
2253
|
-
|
2254
|
-
|
2255
|
-
|
2256
|
-
|
2257
|
-
|
2258
|
-
}
|
2347
|
+
/**
|
2348
|
+
* @deprecated This type should not be used directly. Use `StoredForName` as this type does not account for anything declaration merged into `Stored`.
|
2349
|
+
*/
|
2350
|
+
type Stored<D extends Document.Any> = Document.Internal.Stored<D>;
|
2351
|
+
|
2352
|
+
/**
|
2353
|
+
* @deprecated This type should not be used directly. Use `InvalidForName` as this type does not account for anything declaration merged into `Invalid`.
|
2354
|
+
*/
|
2355
|
+
type Invalid<D extends Document.Any> = Document.Internal.Invalid<D>;
|
2356
|
+
|
2357
|
+
/**
|
2358
|
+
* @deprecated This type should not be used directly. Use `StoredForName` as this type does not account for anything declaration merged into `Stored`.
|
2359
|
+
*/
|
2360
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
2361
|
+
type ToStored<D extends Document.AnyConstructor> = Stored<FixedInstanceType<D>>;
|
2362
|
+
|
2363
|
+
/**
|
2364
|
+
* @deprecated This type should not be used directly. Use `StoredForName` as this type does not account for anything declaration merged into `Stored`.
|
2365
|
+
*/
|
2366
|
+
type ToStoredIf<D extends Document.AnyConstructor, Temporary extends boolean | undefined> = Temporary extends true
|
2367
|
+
? FixedInstanceType<D>
|
2368
|
+
: // eslint-disable-next-line @typescript-eslint/no-deprecated
|
2369
|
+
ToConfiguredStored<D>;
|
2370
|
+
|
2371
|
+
/** @deprecated This type currently does not have a replacement as it was deemed too niche. If you have a use case for it let us know. */
|
2372
|
+
type Temporary<D extends Document.Any> = D extends Internal.Stored<infer U> ? U : D;
|
2373
|
+
|
2374
|
+
/**
|
2375
|
+
* @deprecated Replaced with {@linkcode Document.SheetClassFor}
|
2376
|
+
*/
|
2377
|
+
export import ConfiguredSheetClassFor = Document.SheetClassFor;
|
2378
|
+
|
2379
|
+
/**
|
2380
|
+
* @deprecated Replaced with {@linkcode Document.ObjectClassFor}
|
2381
|
+
*/
|
2382
|
+
export import ConfiguredObjectClassFor = Document.ObjectClassFor;
|
2383
|
+
|
2384
|
+
/**
|
2385
|
+
* @deprecated Replaced with {@linkcode Document.LayerClassFor}
|
2386
|
+
*/
|
2387
|
+
export import ConfiguredLayerClassFor = Document.LayerClassFor;
|
2388
|
+
|
2389
|
+
/**
|
2390
|
+
* Returns the type of the constructor data for the given {@linkcode foundry.abstract.Document}.
|
2391
|
+
* @deprecated Replaced with {@linkcode CreateDataForName}
|
2392
|
+
*/
|
2393
|
+
type CreateDataFor<T extends Document.Internal.Constructor> = SchemaField.CreateData<
|
2394
|
+
T extends { defineSchema: () => infer R extends DataSchema } ? R : never
|
2395
|
+
>;
|
2396
|
+
|
2397
|
+
/**
|
2398
|
+
* @deprecated Replaced with {@linkcode UpdateDataForName}
|
2399
|
+
*/
|
2400
|
+
type UpdateDataFor<T extends Document.Internal.Constructor> = SchemaField.UpdateData<
|
2401
|
+
T extends { defineSchema: () => infer R extends DataSchema } ? R : never
|
2402
|
+
>;
|
2403
|
+
|
2404
|
+
/**
|
2405
|
+
* @deprecated Use `[Document].DropData` instead.
|
2406
|
+
*/
|
2407
|
+
type DropData<T extends Document.Any> = T extends { id: string | undefined }
|
2408
|
+
? // eslint-disable-next-line @typescript-eslint/no-deprecated
|
2409
|
+
DropData.Data<T> & DropData.UUID
|
2410
|
+
: // eslint-disable-next-line @typescript-eslint/no-deprecated
|
2411
|
+
DropData.Data<T>;
|
2412
|
+
|
2413
|
+
namespace DropData {
|
2414
|
+
/**
|
2415
|
+
* @deprecated - This type is likely too broad to be useful. Deprecated without replacement.
|
2416
|
+
*/
|
2417
|
+
// eslint-disable-next-line @typescript-eslint/no-deprecated
|
2418
|
+
type Any = DropData<any>;
|
2419
|
+
|
2420
|
+
/**
|
2421
|
+
* @deprecated - This type is a part of the drop data which is now gotten through
|
2422
|
+
* `[Document].DropData`. Use that instead.
|
2423
|
+
*/
|
2424
|
+
interface Data<T extends Document.Any> {
|
2425
|
+
type: T["documentName"];
|
2426
|
+
data: T["_source"];
|
2427
|
+
}
|
2259
2428
|
|
2260
|
-
|
2261
|
-
|
2262
|
-
|
2263
|
-
|
2264
|
-
|
2265
|
-
|
2266
|
-
|
2267
|
-
|
2268
|
-
|
2269
|
-
|
2270
|
-
|
2271
|
-
|
2272
|
-
|
2273
|
-
|
2274
|
-
|
2275
|
-
|
2276
|
-
|
2277
|
-
|
2278
|
-
|
2279
|
-
|
2280
|
-
|
2281
|
-
Playlist: Playlist.Database.Delete;
|
2282
|
-
PlaylistSound: PlaylistSound.Database.Delete;
|
2283
|
-
Region: RegionDocument.Database.Delete;
|
2284
|
-
RegionBehavior: RegionBehavior.Database.Delete;
|
2285
|
-
RollTable: RollTable.Database.Delete;
|
2286
|
-
Scene: Scene.Database.Delete;
|
2287
|
-
Setting: Setting.Database.Delete;
|
2288
|
-
TableResult: TableResult.Database.Delete;
|
2289
|
-
Tile: TileDocument.Database.Delete;
|
2290
|
-
Token: TokenDocument.Database.Delete;
|
2291
|
-
User: User.Database.Delete;
|
2292
|
-
Wall: WallDocument.Database.Delete;
|
2429
|
+
/**
|
2430
|
+
* @deprecated - This type is a part of the drop data which is now gotten through
|
2431
|
+
* `[Document].DropData`. Use that instead.
|
2432
|
+
*/
|
2433
|
+
interface UUID {
|
2434
|
+
uuid: string;
|
2435
|
+
}
|
2436
|
+
}
|
2437
|
+
|
2438
|
+
/**
|
2439
|
+
* @deprecated This type has been deprecated because of the inconsistent casing of "Subtype" instead of "SubType". Use {@linkcode Document.ModuleSubType} instead.
|
2440
|
+
*/
|
2441
|
+
type ModuleSubtype = ModuleSubType;
|
2442
|
+
|
2443
|
+
/**
|
2444
|
+
* @deprecated This type was used to simplify the logic behind `ConstructorArgs` but that's now being deprecated.
|
2445
|
+
*/
|
2446
|
+
type ConstructorParameters<CreateData extends object | undefined, Parent extends Document.Any | null> = [
|
2447
|
+
data?: CreateData,
|
2448
|
+
context?: Document.ConstructionContext<Parent>,
|
2449
|
+
];
|
2293
2450
|
}
|