@league-of-foundry-developers/foundry-vtt-types 9.242.0 → 9.249.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. package/package.json +1 -1
  2. package/src/foundry/common/abstract/document.mjs.d.ts +13 -6
  3. package/src/foundry/common/config.mjs/releaseData.d.ts +3 -1
  4. package/src/foundry/common/data/data.mjs/activeEffectData.d.ts +3 -1
  5. package/src/foundry/common/data/data.mjs/actorData.d.ts +1 -1
  6. package/src/foundry/common/data/data.mjs/adventureData.d.ts +14 -12
  7. package/src/foundry/common/data/data.mjs/ambientLightData.d.ts +5 -3
  8. package/src/foundry/common/data/data.mjs/ambientSoundData.d.ts +62 -16
  9. package/src/foundry/common/data/data.mjs/animationData.d.ts +13 -5
  10. package/src/foundry/common/data/data.mjs/cardData.d.ts +4 -4
  11. package/src/foundry/common/data/data.mjs/cardFaceData.d.ts +5 -3
  12. package/src/foundry/common/data/data.mjs/cardsData.d.ts +3 -3
  13. package/src/foundry/common/data/data.mjs/chatMessageData.d.ts +3 -1
  14. package/src/foundry/common/data/data.mjs/chatSpeakerData.d.ts +3 -1
  15. package/src/foundry/common/data/data.mjs/combatData.d.ts +3 -1
  16. package/src/foundry/common/data/data.mjs/combatantData.d.ts +3 -1
  17. package/src/foundry/common/data/data.mjs/darknessActivation.d.ts +3 -1
  18. package/src/foundry/common/data/data.mjs/drawingData.d.ts +3 -1
  19. package/src/foundry/common/data/data.mjs/effectChangeData.d.ts +3 -1
  20. package/src/foundry/common/data/data.mjs/effectDurationData.d.ts +3 -1
  21. package/src/foundry/common/data/data.mjs/fogExplorationData.d.ts +3 -1
  22. package/src/foundry/common/data/data.mjs/folderData.d.ts +3 -1
  23. package/src/foundry/common/data/data.mjs/journalEntryData.d.ts +3 -1
  24. package/src/foundry/common/data/data.mjs/lightData.d.ts +7 -5
  25. package/src/foundry/common/data/data.mjs/macroData.d.ts +3 -1
  26. package/src/foundry/common/data/data.mjs/measuredTemplateData.d.ts +3 -1
  27. package/src/foundry/common/data/data.mjs/noteData.d.ts +3 -1
  28. package/src/foundry/common/data/data.mjs/playlistData.d.ts +3 -1
  29. package/src/foundry/common/data/data.mjs/playlistSoundData.d.ts +3 -1
  30. package/src/foundry/common/data/data.mjs/prototypeTokenData.d.ts +6 -4
  31. package/src/foundry/common/data/data.mjs/rollTableData.d.ts +3 -1
  32. package/src/foundry/common/data/data.mjs/sceneData.d.ts +3 -1
  33. package/src/foundry/common/data/data.mjs/settingData.d.ts +3 -1
  34. package/src/foundry/common/data/data.mjs/tableResultData.d.ts +3 -1
  35. package/src/foundry/common/data/data.mjs/tileData.d.ts +4 -2
  36. package/src/foundry/common/data/data.mjs/tileOcclusion.d.ts +4 -2
  37. package/src/foundry/common/data/data.mjs/tokenBarData.d.ts +4 -2
  38. package/src/foundry/common/data/data.mjs/tokenData.d.ts +5 -3
  39. package/src/foundry/common/data/data.mjs/userData.d.ts +3 -1
  40. package/src/foundry/common/data/data.mjs/videoData.d.ts +4 -2
  41. package/src/foundry/common/data/data.mjs/wallData.d.ts +4 -2
  42. package/src/foundry/common/documents.mjs/baseActiveEffect.d.ts +15 -12
  43. package/src/foundry/common/documents.mjs/baseActor.d.ts +24 -21
  44. package/src/foundry/common/documents.mjs/baseAdventure.d.ts +14 -12
  45. package/src/foundry/common/documents.mjs/baseAmbientLight.d.ts +14 -11
  46. package/src/foundry/common/documents.mjs/baseAmbientSound.d.ts +14 -11
  47. package/src/foundry/common/documents.mjs/baseCard.d.ts +27 -28
  48. package/src/foundry/common/documents.mjs/baseCards.d.ts +18 -16
  49. package/src/foundry/common/documents.mjs/baseChatMessage.d.ts +24 -17
  50. package/src/foundry/common/documents.mjs/baseCombat.d.ts +21 -20
  51. package/src/foundry/common/documents.mjs/baseCombatant.d.ts +25 -18
  52. package/src/foundry/common/documents.mjs/baseDrawing.d.ts +26 -23
  53. package/src/foundry/common/documents.mjs/baseFogExploration.d.ts +19 -17
  54. package/src/foundry/common/documents.mjs/baseFolder.d.ts +14 -12
  55. package/src/foundry/common/documents.mjs/baseItem.d.ts +25 -19
  56. package/src/foundry/common/documents.mjs/baseJournalEntry.d.ts +16 -14
  57. package/src/foundry/common/documents.mjs/baseMacro.d.ts +21 -18
  58. package/src/foundry/common/documents.mjs/baseMeasuredTemplate.d.ts +34 -18
  59. package/src/foundry/common/documents.mjs/baseNote.d.ts +20 -14
  60. package/src/foundry/common/documents.mjs/basePlaylist.d.ts +16 -14
  61. package/src/foundry/common/documents.mjs/basePlaylistSound.d.ts +14 -11
  62. package/src/foundry/common/documents.mjs/baseRollTable.d.ts +16 -14
  63. package/src/foundry/common/documents.mjs/baseScene.d.ts +23 -21
  64. package/src/foundry/common/documents.mjs/baseSetting.d.ts +18 -16
  65. package/src/foundry/common/documents.mjs/baseTableResult.d.ts +27 -19
  66. package/src/foundry/common/documents.mjs/baseTile.d.ts +17 -11
  67. package/src/foundry/common/documents.mjs/baseToken.d.ts +20 -16
  68. package/src/foundry/common/documents.mjs/baseUser.d.ts +45 -11
  69. package/src/foundry/common/documents.mjs/baseWall.d.ts +17 -15
  70. package/src/foundry/common/packages.mjs/packageAuthorData.d.ts +3 -1
  71. package/src/foundry/common/packages.mjs/packageCompendiumData.d.ts +4 -2
  72. package/src/foundry/common/packages.mjs/packageData.d.ts +3 -4
  73. package/src/foundry/common/packages.mjs/packageDependencyData.d.ts +3 -1
  74. package/src/foundry/common/packages.mjs/packageLanguageData.d.ts +3 -1
  75. package/src/foundry/common/utils/primitives.mjs.d.ts +8 -1
  76. package/src/foundry/foundry.js/application.d.ts +139 -111
  77. package/src/foundry/foundry.js/applications/basePlaceableHUD.d.ts +2 -2
  78. package/src/foundry/foundry.js/applications/basePlaceableHUDs/drawingHUD.d.ts +2 -2
  79. package/src/foundry/foundry.js/applications/basePlaceableHUDs/tileHUD.d.ts +2 -2
  80. package/src/foundry/foundry.js/applications/basePlaceableHUDs/tokenHUD.d.ts +3 -3
  81. package/src/foundry/foundry.js/applications/cameraViews.d.ts +2 -2
  82. package/src/foundry/foundry.js/applications/chatPopout.d.ts +3 -3
  83. package/src/foundry/foundry.js/applications/compendium.d.ts +2 -2
  84. package/src/foundry/foundry.js/applications/dialog.d.ts +1 -1
  85. package/src/foundry/foundry.js/applications/filePicker.d.ts +1 -1
  86. package/src/foundry/foundry.js/applications/formApplication.d.ts +45 -14
  87. package/src/foundry/foundry.js/applications/formApplications/avConfig.d.ts +1 -1
  88. package/src/foundry/foundry.js/applications/formApplications/combatTrackerConfig.d.ts +2 -2
  89. package/src/foundry/foundry.js/applications/formApplications/defaultTokenConfig.d.ts +1 -1
  90. package/src/foundry/foundry.js/applications/formApplications/documentSheet.d.ts +20 -31
  91. package/src/foundry/foundry.js/applications/formApplications/documentSheets/activeEffectConfig.d.ts +2 -2
  92. package/src/foundry/foundry.js/applications/formApplications/documentSheets/actorSheet.d.ts +1 -1
  93. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientLightConfig.d.ts +5 -5
  94. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientSoundConfig.d.ts +4 -4
  95. package/src/foundry/foundry.js/applications/formApplications/documentSheets/combatantConfig.d.ts +3 -3
  96. package/src/foundry/foundry.js/applications/formApplications/documentSheets/folderConfig.d.ts +2 -2
  97. package/src/foundry/foundry.js/applications/formApplications/documentSheets/itemSheet.d.ts +1 -1
  98. package/src/foundry/foundry.js/applications/formApplications/documentSheets/journalSheet.d.ts +1 -1
  99. package/src/foundry/foundry.js/applications/formApplications/documentSheets/macroConfig.d.ts +3 -3
  100. package/src/foundry/foundry.js/applications/formApplications/documentSheets/measuredTemplateConfig.d.ts +3 -3
  101. package/src/foundry/foundry.js/applications/formApplications/documentSheets/noteConfig.d.ts +3 -3
  102. package/src/foundry/foundry.js/applications/formApplications/documentSheets/permissionControl.d.ts +2 -2
  103. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistConfig.d.ts +3 -3
  104. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistSoundConfig.d.ts +3 -3
  105. package/src/foundry/foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts +3 -3
  106. package/src/foundry/foundry.js/applications/formApplications/documentSheets/sceneConfig.d.ts +4 -4
  107. package/src/foundry/foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts +2 -2
  108. package/src/foundry/foundry.js/applications/formApplications/documentSheets/userConfig.d.ts +7 -7
  109. package/src/foundry/foundry.js/applications/formApplications/drawingConfig.d.ts +1 -1
  110. package/src/foundry/foundry.js/applications/formApplications/entitySheetConfig.d.ts +5 -5
  111. package/src/foundry/foundry.js/applications/formApplications/gridConfig.d.ts +1 -1
  112. package/src/foundry/foundry.js/applications/formApplications/imagePopout.d.ts +1 -1
  113. package/src/foundry/foundry.js/applications/formApplications/keybindingsConfig.d.ts +2 -2
  114. package/src/foundry/foundry.js/applications/formApplications/moduleManagement.d.ts +2 -2
  115. package/src/foundry/foundry.js/applications/formApplications/permissionConfig.d.ts +2 -2
  116. package/src/foundry/foundry.js/applications/formApplications/settingsConfig.d.ts +1 -1
  117. package/src/foundry/foundry.js/applications/formApplications/tokenConfig.d.ts +4 -4
  118. package/src/foundry/foundry.js/applications/formApplications/wallConfig.d.ts +3 -3
  119. package/src/foundry/foundry.js/applications/formApplications/worldConfig.d.ts +1 -1
  120. package/src/foundry/foundry.js/applications/frameViewer.d.ts +1 -1
  121. package/src/foundry/foundry.js/applications/headsUpDisplay.d.ts +2 -2
  122. package/src/foundry/foundry.js/applications/hotbar.d.ts +2 -2
  123. package/src/foundry/foundry.js/applications/mainMenu.d.ts +2 -2
  124. package/src/foundry/foundry.js/applications/notifications.d.ts +7 -4
  125. package/src/foundry/foundry.js/applications/pause.d.ts +2 -2
  126. package/src/foundry/foundry.js/applications/playerList.d.ts +2 -2
  127. package/src/foundry/foundry.js/applications/sceneControls.d.ts +2 -2
  128. package/src/foundry/foundry.js/applications/sceneNavigation.d.ts +3 -3
  129. package/src/foundry/foundry.js/applications/sidebar.d.ts +2 -2
  130. package/src/foundry/foundry.js/applications/sidebarTab.d.ts +4 -7
  131. package/src/foundry/foundry.js/applications/sidebarTabs/chatLog.d.ts +2 -2
  132. package/src/foundry/foundry.js/applications/sidebarTabs/combatTracker.d.ts +26 -28
  133. package/src/foundry/foundry.js/applications/sidebarTabs/compendiumDirectory.d.ts +2 -2
  134. package/src/foundry/foundry.js/applications/sidebarTabs/settings.d.ts +2 -2
  135. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts +2 -2
  136. package/src/foundry/foundry.js/avSettings.d.ts +11 -0
  137. package/src/foundry/foundry.js/canvas.d.ts +5 -0
  138. package/src/foundry/foundry.js/clientDocumentMixin.d.ts +38 -35
  139. package/src/foundry/foundry.js/clientDocuments/activeEffect.d.ts +1 -1
  140. package/src/foundry/foundry.js/clientDocuments/actor.d.ts +1 -1
  141. package/src/foundry/foundry.js/clientDocuments/card.d.ts +2 -1
  142. package/src/foundry/foundry.js/clientDocuments/cards.d.ts +1 -6
  143. package/src/foundry/foundry.js/clientDocuments/chatMessage.d.ts +1 -1
  144. package/src/foundry/foundry.js/clientDocuments/combat.d.ts +5 -5
  145. package/src/foundry/foundry.js/clientDocuments/folder.d.ts +15 -9
  146. package/src/foundry/foundry.js/clientDocuments/item.d.ts +2 -2
  147. package/src/foundry/foundry.js/clientDocuments/playlist.d.ts +1 -1
  148. package/src/foundry/foundry.js/clientDocuments/scene.d.ts +39 -38
  149. package/src/foundry/foundry.js/clientDocuments/user.d.ts +27 -35
  150. package/src/foundry/foundry.js/clientSettings.d.ts +1 -1
  151. package/src/foundry/foundry.js/collections/documentCollection.d.ts +66 -12
  152. package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts +78 -67
  153. package/src/foundry/foundry.js/collections/documentCollections/worldCollection.d.ts +73 -32
  154. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/actors.d.ts +3 -37
  155. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/combatEncounters.d.ts +5 -2
  156. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/fogExplorations.d.ts +0 -2
  157. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/folders.d.ts +2 -2
  158. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/items.d.ts +1 -22
  159. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/journal.d.ts +1 -1
  160. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/macros.d.ts +3 -8
  161. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/messages.d.ts +7 -2
  162. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/playlists.d.ts +5 -5
  163. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/rollTables.d.ts +1 -1
  164. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/scenes.d.ts +3 -2
  165. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/users.d.ts +7 -4
  166. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/worldSettings.d.ts +2 -2
  167. package/src/foundry/foundry.js/config.d.ts +5 -2
  168. package/src/foundry/foundry.js/dragDrop.d.ts +27 -34
  169. package/src/foundry/foundry.js/hooks.d.ts +3 -3
  170. package/src/foundry/foundry.js/pixi/containers/ruler.d.ts +18 -7
  171. package/src/foundry/foundry.js/pixi/index.d.ts +2 -0
  172. package/src/foundry/foundry.js/pixi/meshes/index.d.ts +1 -0
  173. package/src/foundry/foundry.js/pixi/meshes/samplerMesh.d.ts +22 -0
  174. package/src/foundry/foundry.js/pixi/points/wallEndpoint.d.ts +1 -1
  175. package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/clockwiseSweepPolygon.d.ts +9 -1
  176. package/src/foundry/foundry.js/pixi/rectangles/normalizedRectangle.d.ts +7 -0
  177. package/src/foundry/foundry.js/pixi/shaders/abstractBaseShader.d.ts +1 -1
  178. package/src/foundry/foundry.js/pixi/transforms/index.d.ts +1 -0
  179. package/src/foundry/foundry.js/pixi/transforms/synchronizedTransform.d.ts +38 -0
  180. package/src/foundry/foundry.js/pointSources/lightSource.d.ts +1 -1
  181. package/src/foundry/foundry.js/pointSources/soundSource.d.ts +1 -1
  182. package/src/foundry/foundry.js/pointSources/visionSource.d.ts +1 -1
  183. package/src/foundry/foundry.js/polygonEdge.d.ts +1 -1
  184. package/src/foundry/foundry.js/quadtree.d.ts +2 -2
  185. package/src/foundry/foundry.js/ray.d.ts +1 -1
  186. package/src/foundry/foundry.js/roll.d.ts +13 -11
  187. package/src/foundry/foundry.js/searchFilter.d.ts +37 -33
  188. package/src/foundry/foundry.js/textureLoader.d.ts +28 -18
  189. package/src/foundry/foundry.js/textureUtils.d.ts +5 -8
  190. package/src/foundry/foundry.js/videoHelper.d.ts +2 -1
  191. package/src/types/helperTypes.d.ts +31 -13
@@ -1,3 +1,40 @@
1
+ interface FormApplicationOptions extends ApplicationOptions {
2
+ /**
3
+ * Whether to automatically close the application when it's contained
4
+ * form is submitted.
5
+ * @defaultValue `true`
6
+ */
7
+ closeOnSubmit: boolean;
8
+
9
+ /**
10
+ * Whether to automatically submit the contained HTML form when an input
11
+ * or select element is changed.
12
+ * @defaultValue `false`
13
+ */
14
+ submitOnChange: boolean;
15
+
16
+ /**
17
+ * Whether to automatically submit the contained HTML form when the
18
+ * application window is manually closed.
19
+ * @defaultValue `false`
20
+ */
21
+ submitOnClose: boolean;
22
+
23
+ /**
24
+ * Whether the application form is editable - if true, it's fields will
25
+ * be unlocked and the form can be submitted. If false, all form fields
26
+ * will be disabled and the form cannot be submitted.
27
+ * @defaultValue `true`
28
+ */
29
+ editable: boolean;
30
+
31
+ /**
32
+ * Support configuration of the sheet type used for this application.
33
+ * @defaultValue `false`
34
+ */
35
+ sheetConfig: boolean;
36
+ }
37
+
1
38
  /**
2
39
  * An abstract pattern for defining an Application responsible for updating some object using an HTML form
3
40
  *
@@ -11,7 +48,7 @@
11
48
  * @typeParam ConcreteObject - the type of the object or {@link foundry.abstract.Document} which is modified by this form
12
49
  */
13
50
  declare abstract class FormApplication<
14
- Options extends FormApplication.Options = FormApplication.Options,
51
+ Options extends FormApplicationOptions = FormApplicationOptions,
15
52
  Data extends object = FormApplication.Data<{}, Options>,
16
53
  ConcreteObject = Data extends FormApplication.Data<infer T, Options> ? T : {}
17
54
  > extends Application<Options> {
@@ -46,7 +83,7 @@ declare abstract class FormApplication<
46
83
  * The values of this Array are inner-objects with references to the MCE editor and other metadata
47
84
  * @defaultValue `{}`
48
85
  */
49
- editors: Partial<Record<string, FormApplication.FormApplicationEditor>>;
86
+ editors: Record<string, FormApplication.FormApplicationEditor>;
50
87
 
51
88
  /**
52
89
  * Assign the default options which are supported by the entity edit sheet.
@@ -56,15 +93,16 @@ declare abstract class FormApplication<
56
93
  * @defaultValue
57
94
  * ```typescript
58
95
  * foundry.utils.mergeObject(super.defaultOptions, {
59
- * classes: ['form'],
96
+ * classes: ["form"],
60
97
  * closeOnSubmit: true,
98
+ * editable: true,
99
+ * sheetConfig: false,
61
100
  * submitOnChange: false,
62
- * submitOnClose: false,
63
- * editable: true
101
+ * submitOnClose: false
64
102
  * });
65
103
  * ```
66
104
  */
67
- static get defaultOptions(): FormApplication.Options;
105
+ static get defaultOptions(): FormApplicationOptions;
68
106
 
69
107
  /**
70
108
  * Is the Form Application currently editable?
@@ -257,7 +295,7 @@ declare namespace FormApplication {
257
295
  * @typeParam ConcreteObject - the type of the object
258
296
  * @typeParam Options - the type of the options object
259
297
  */
260
- interface Data<ConcreteObject, Options extends FormApplication.Options = FormApplication.Options> {
298
+ interface Data<ConcreteObject, Options extends FormApplicationOptions = FormApplicationOptions> {
261
299
  object: ConcreteObject;
262
300
  options: Options;
263
301
  title: string;
@@ -295,11 +333,4 @@ declare namespace FormApplication {
295
333
  */
296
334
  preventRender?: boolean;
297
335
  }
298
-
299
- interface Options extends Application.Options, ApplicationOptions {
300
- /**
301
- * @defaultValue `['form']`
302
- */
303
- classes: string[];
304
- }
305
336
  }
@@ -56,7 +56,7 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
56
56
  }
57
57
 
58
58
  declare namespace AVConfig {
59
- interface Options extends FormApplication.Options {
59
+ interface Options extends FormApplicationOptions {
60
60
  /**
61
61
  * @defaultValue `game.i18n.localize('WEBRTC.Title')`
62
62
  */
@@ -4,7 +4,7 @@
4
4
  * @typeParam Data - The data structure used to render the handlebars template.
5
5
  */
6
6
  declare class CombatTrackerConfig<
7
- Options extends FormApplication.Options = FormApplication.Options,
7
+ Options extends FormApplicationOptions = FormApplicationOptions,
8
8
  Data extends object = CombatTrackerConfig.Data
9
9
  > extends FormApplication<Options, Data, undefined> {
10
10
  /**
@@ -19,7 +19,7 @@ declare class CombatTrackerConfig<
19
19
  * })
20
20
  * ```
21
21
  */
22
- static get defaultOptions(): FormApplication.Options;
22
+ static get defaultOptions(): FormApplicationOptions;
23
23
 
24
24
  /** @override */
25
25
  getData(options?: Partial<Options>): Data | Promise<Data>;
@@ -3,7 +3,7 @@ declare global {
3
3
  * A sheet that alters the values of the default Token configuration used when new Token documents are created.
4
4
  */
5
5
  class DefaultTokenConfig<
6
- Options extends FormApplication.Options = FormApplication.Options,
6
+ Options extends FormApplicationOptions = FormApplicationOptions,
7
7
  Data extends DefaultTokenConfig.Data = DefaultTokenConfig.Data
8
8
  > extends FormApplication<Options, Data, foundry.data.TokenData['_source']> {
9
9
  constructor(object: unknown, options: Options);
@@ -1,6 +1,14 @@
1
1
  import { ToObjectFalseType } from '../../../../types/helperTypes';
2
2
 
3
3
  declare global {
4
+ interface DocumentSheetOptions extends FormApplicationOptions {
5
+ /**
6
+ * The default permissions required to view this Document sheet.
7
+ * @defaultValue {@link CONST.DOCUMENT_PERMISSION_LEVELS.LIMITED}
8
+ */
9
+ viewPermission: foundry.CONST.DOCUMENT_PERMISSION_LEVELS;
10
+ }
11
+
4
12
  /**
5
13
  * Extend the FormApplication pattern to incorporate specific logic for viewing or editing Document instances.
6
14
  * See the FormApplication documentation for more complete description of this interface.
@@ -13,7 +21,7 @@ declare global {
13
21
  * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
14
22
  */
15
23
  abstract class DocumentSheet<
16
- Options extends DocumentSheet.Options = DocumentSheet.Options,
24
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
17
25
  Data extends object = DocumentSheet.Data,
18
26
  ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheet.Data<infer T>
19
27
  ? T
@@ -23,13 +31,14 @@ declare global {
23
31
  * @defaultValue
24
32
  * ```typescript
25
33
  * foundry.utils.mergeObject(super.defaultOptions, {
26
- * classes: ['sheet'],
34
+ * classes: ["sheet"],
27
35
  * template: `templates/sheets/${this.name.toLowerCase()}.html`,
28
- * viewPermission: CONST.ENTITY_PERMISSIONS.LIMITED
36
+ * viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.LIMITED,
37
+ * sheetConfig: true
29
38
  * });
30
39
  * ```
31
40
  */
32
- static get defaultOptions(): DocumentSheet.Options;
41
+ static get defaultOptions(): DocumentSheetOptions;
33
42
 
34
43
  /**
35
44
  * A semantic convenience reference to the Document instance which is the target object for this form.
@@ -72,15 +81,16 @@ declare global {
72
81
  protected _getHeaderButtons(): Application.HeaderButton[];
73
82
 
74
83
  /**
75
- * @param event - (unused)
76
- * @override
84
+ * Handle requests to configure the default sheet used by this Document
85
+ * @internal
77
86
  */
78
- protected _updateObject(event: Event, formData: object): Promise<unknown>;
87
+ protected _onConfigureSheet(event: JQuery.ClickEvent): void;
79
88
 
80
89
  /**
81
- * @deprecated since 0.8.0
90
+ * @param event - (unused)
91
+ * @override
82
92
  */
83
- get entity(): ConcreteDocument;
93
+ protected _updateObject(event: Event, formData: object): Promise<unknown>;
84
94
  }
85
95
 
86
96
  namespace DocumentSheet {
@@ -90,7 +100,7 @@ declare global {
90
100
  */
91
101
  interface Data<
92
102
  ConcreteDocument extends foundry.abstract.Document<any, any> = foundry.abstract.Document<any, any>,
93
- Options extends DocumentSheet.Options = DocumentSheet.Options
103
+ Options extends DocumentSheetOptions = DocumentSheetOptions
94
104
  > {
95
105
  cssClass: string;
96
106
  editable: boolean;
@@ -100,27 +110,6 @@ declare global {
100
110
  options: Options;
101
111
  owner: boolean;
102
112
  title: string;
103
- readonly entity: this['data'];
104
- }
105
-
106
- interface Options extends FormApplication.Options {
107
- /**
108
- * @defaultValue `['sheet']`
109
- */
110
- classes: string[];
111
-
112
- /**
113
- * @defaultValue
114
- * ```javascript
115
- * `templates/sheets/${this.name.toLowerCase()}.html`
116
- * ```
117
- */
118
- template: string;
119
-
120
- /**
121
- * @defaultValue {@link ENTITY_PERMISSIONS.LIMITED}
122
- */
123
- viewPermission: foundry.CONST.DOCUMENT_PERMISSION_LEVELS;
124
113
  }
125
114
  }
126
115
  }
@@ -8,7 +8,7 @@ declare global {
8
8
  * @typeParam Data - The data structure used to render the handlebars template.
9
9
  */
10
10
  class ActiveEffectConfig<
11
- Options extends DocumentSheet.Options = ActiveEffectConfig.Options,
11
+ Options extends DocumentSheetOptions = ActiveEffectConfig.Options,
12
12
  Data extends object = ActiveEffectConfig.Data
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof ActiveEffect>>> {
14
14
  /**
@@ -70,6 +70,6 @@ declare global {
70
70
  modes: Record<foundry.CONST.ACTIVE_EFFECT_MODES, string>;
71
71
  }
72
72
 
73
- type Options = DocumentSheet.Options;
73
+ type Options = DocumentSheetOptions;
74
74
  }
75
75
  }
@@ -199,7 +199,7 @@ declare global {
199
199
  }
200
200
  }
201
201
 
202
- interface Options extends DocumentSheet.Options {
202
+ interface Options extends DocumentSheetOptions {
203
203
  token?: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null;
204
204
  }
205
205
  }
@@ -1,8 +1,8 @@
1
1
  import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
2
2
  import type { AmbientLightDataConstructorData } from '../../../../common/data/data.mjs/ambientLightData';
3
3
  import type { AnimationDataConstructorData } from '../../../../common/data/data.mjs/animationData';
4
- import type { DarknessActivationConstructorData } from '../../../../common/data/data.mjs/darknessActivation.js';
5
- import type { LightDataConstructorData } from '../../../../common/data/data.mjs/lightData.js';
4
+ import type { DarknessActivationConstructorData } from '../../../../common/data/data.mjs/darknessActivation';
5
+ import type { LightDataConstructorData } from '../../../../common/data/data.mjs/lightData';
6
6
 
7
7
  declare global {
8
8
  /**
@@ -11,7 +11,7 @@ declare global {
11
11
  * @typeParam Data - The data structure used to render the handlebars template.
12
12
  */
13
13
  class AmbientLightConfig<
14
- Options extends DocumentSheet.Options = DocumentSheet.Options,
14
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
15
15
  Data extends object = AmbientLightConfig.Data<Options>
16
16
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>> {
17
17
  /**
@@ -29,7 +29,7 @@ declare global {
29
29
  * });
30
30
  * ```
31
31
  */
32
- static get defaultOptions(): DocumentSheet.Options;
32
+ static get defaultOptions(): DocumentSheetOptions;
33
33
 
34
34
  /**
35
35
  * @param options - (unused)
@@ -71,7 +71,7 @@ declare global {
71
71
  }
72
72
 
73
73
  namespace AmbientLightConfig {
74
- interface Data<Options extends DocumentSheet.Options>
74
+ interface Data<Options extends DocumentSheetOptions>
75
75
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>>, Options> {
76
76
  isAdvanced: boolean;
77
77
  colorationTechniques: typeof AdaptiveLightingShader.COLORATION_TECHNIQUES;
@@ -8,7 +8,7 @@ declare global {
8
8
  * @typeParam Data - The data structure used to render the handlebars template.
9
9
  */
10
10
  class AmbientSoundConfig<
11
- Options extends DocumentSheet.Options = AmbientSoundConfig.Options,
11
+ Options extends DocumentSheetOptions = AmbientSoundConfig.Options,
12
12
  Data extends object = AmbientSoundConfig.Data<Options>
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>> {
14
14
  /**
@@ -22,7 +22,7 @@ declare global {
22
22
  * });
23
23
  * ```
24
24
  */
25
- static get defaultOptions(): DocumentSheet.Options;
25
+ static get defaultOptions(): DocumentSheetOptions;
26
26
 
27
27
  /** @override */
28
28
  get title(): string;
@@ -44,7 +44,7 @@ declare global {
44
44
  }
45
45
 
46
46
  namespace AmbientSoundConfig {
47
- interface Data<Options extends DocumentSheet.Options>
47
+ interface Data<Options extends DocumentSheetOptions>
48
48
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>, Options> {
49
49
  submitText: string;
50
50
  }
@@ -52,6 +52,6 @@ declare global {
52
52
  type FormData = Pick<foundry.data.AmbientSoundData, 'easing' | 'path' | 'volume'> &
53
53
  Pick<AmbientSoundDataConstructorData, 'radius' | 'x' | 'y'>;
54
54
 
55
- type Options = DocumentSheet.Options;
55
+ type Options = DocumentSheetOptions;
56
56
  }
57
57
  }
@@ -8,7 +8,7 @@ declare global {
8
8
  * @typeParam Data - The data structure used to render the handlebars template.
9
9
  */
10
10
  class CombatantConfig<
11
- Options extends DocumentSheet.Options = CombatantConfig.Options,
11
+ Options extends DocumentSheetOptions = CombatantConfig.Options,
12
12
  Data extends CombatantConfig.Data<Options> = CombatantConfig.Data<Options>
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Combatant>>> {
14
14
  /**
@@ -39,7 +39,7 @@ declare global {
39
39
  }
40
40
 
41
41
  namespace CombatantConfig {
42
- interface Options extends DocumentSheet.Options {
42
+ interface Options extends DocumentSheetOptions {
43
43
  id: 'combatant-config';
44
44
  title: string;
45
45
  classes: string[];
@@ -47,7 +47,7 @@ declare global {
47
47
  width: number;
48
48
  }
49
49
 
50
- type Data<Options extends DocumentSheet.Options> = DocumentSheet.Data<
50
+ type Data<Options extends DocumentSheetOptions> = DocumentSheet.Data<
51
51
  InstanceType<ConfiguredDocumentClass<typeof Combatant>>,
52
52
  Options
53
53
  >;
@@ -6,7 +6,7 @@ declare global {
6
6
  * The Application responsible for configuring a single Folder document.
7
7
  */
8
8
  class FolderConfig extends DocumentSheet<
9
- DocumentSheet.Options,
9
+ DocumentSheetOptions,
10
10
  FolderConfig.Data,
11
11
  InstanceType<ConfiguredDocumentClass<typeof Folder>>
12
12
  > {
@@ -33,7 +33,7 @@ declare global {
33
33
  * @param options - (unused)
34
34
  * @override
35
35
  */
36
- getData(options?: Partial<FormApplication.Options>): Promise<FolderConfig.Data>;
36
+ getData(options?: Partial<FormApplicationOptions>): Promise<FolderConfig.Data>;
37
37
 
38
38
  /**
39
39
  * @param event - (unused)
@@ -83,6 +83,6 @@ declare global {
83
83
  item: this['document'];
84
84
  }
85
85
 
86
- type Options = DocumentSheet.Options;
86
+ type Options = DocumentSheetOptions;
87
87
  }
88
88
  }
@@ -96,7 +96,7 @@ declare global {
96
96
  }
97
97
 
98
98
  namespace JournalSheet {
99
- interface Options extends DocumentSheet.Options {
99
+ interface Options extends DocumentSheetOptions {
100
100
  sheetMode?: SheetMode | null;
101
101
  }
102
102
 
@@ -9,7 +9,7 @@ declare global {
9
9
  * @typeParam Data - The data structure used to render the handlebars template.
10
10
  */
11
11
  class MacroConfig<
12
- Options extends DocumentSheet.Options = MacroConfig.Options,
12
+ Options extends DocumentSheetOptions = MacroConfig.Options,
13
13
  Data extends object = MacroConfig.Data<Options>
14
14
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Macro>>> {
15
15
  /**
@@ -57,12 +57,12 @@ declare global {
57
57
  }
58
58
 
59
59
  namespace MacroConfig {
60
- type Options = DocumentSheet.Options;
60
+ type Options = DocumentSheetOptions;
61
61
 
62
62
  /**
63
63
  * @typeParam Options - the type of the options object
64
64
  */
65
- interface Data<Options extends DocumentSheet.Options>
65
+ interface Data<Options extends DocumentSheetOptions>
66
66
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof Macro>>, Options> {
67
67
  macroTypes: Array<ValueOf<typeof CONST.MACRO_TYPES>>;
68
68
  macroScopes: typeof foundry.CONST['MACRO_SCOPES'];
@@ -8,7 +8,7 @@ declare global {
8
8
  * @typeParam Data - The data structure used to render the handlebars template.
9
9
  */
10
10
  class MeasuredTemplateConfig<
11
- Options extends DocumentSheet.Options = DocumentSheet.Options,
11
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
12
12
  Data extends object = MeasuredTemplateConfig.Data
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>>> {
14
14
  /**
@@ -24,7 +24,7 @@ declare global {
24
24
  * })
25
25
  * ```
26
26
  */
27
- static get defaultOptions(): DocumentSheet.Options;
27
+ static get defaultOptions(): DocumentSheetOptions;
28
28
 
29
29
  /** @override */
30
30
  getData(): Data | Promise<Data>;
@@ -37,7 +37,7 @@ declare global {
37
37
  }
38
38
 
39
39
  namespace MeasuredTemplateConfig {
40
- interface Data<Options extends DocumentSheet.Options = DocumentSheet.Options>
40
+ interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
41
41
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>>, Options> {
42
42
  templateTypes: typeof CONFIG.MeasuredTemplate.types;
43
43
  gridUnits: string;
@@ -7,7 +7,7 @@ declare global {
7
7
  * @typeParam Data - The data structure used to render the handlebars template.
8
8
  */
9
9
  class NoteConfig<
10
- Options extends DocumentSheet.Options = DocumentSheet.Options,
10
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
11
11
  Data extends object = NoteConfig.Data<Options>
12
12
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Note'>>> {
13
13
  /**
@@ -21,7 +21,7 @@ declare global {
21
21
  * })
22
22
  * ```
23
23
  */
24
- static get defaultOptions(): DocumentSheet.Options;
24
+ static get defaultOptions(): DocumentSheetOptions;
25
25
 
26
26
  /**
27
27
  * @param options - (unused)
@@ -45,7 +45,7 @@ declare global {
45
45
  }
46
46
 
47
47
  namespace NoteConfig {
48
- interface Data<Options extends DocumentSheet.Options>
48
+ interface Data<Options extends DocumentSheetOptions>
49
49
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Note'>>, Options> {
50
50
  entry: ConfiguredDocumentClassForName<'JournalEntry'> | {};
51
51
  entries: Journal['contents'];
@@ -8,7 +8,7 @@ declare global {
8
8
  * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
9
9
  */
10
10
  class PermissionControl<
11
- Options extends DocumentSheet.Options = DocumentSheet.Options,
11
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
12
12
  Data extends object = DocumentSheet.Data,
13
13
  ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheet.Data<infer T>
14
14
  ? T
@@ -25,7 +25,7 @@ declare global {
25
25
  * });
26
26
  * ```
27
27
  */
28
- static get defaultOptions(): DocumentSheet.Options;
28
+ static get defaultOptions(): DocumentSheetOptions;
29
29
 
30
30
  /** @override */
31
31
  get title(): string;
@@ -7,7 +7,7 @@ declare global {
7
7
  * @typeParam Data - The data structure used to render the handlebars template.
8
8
  */
9
9
  class PlaylistConfig<
10
- Options extends DocumentSheet.Options = DocumentSheet.Options,
10
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
11
11
  Data extends object = PlaylistConfig.Data<Options>
12
12
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Playlist>>> {
13
13
  /**
@@ -19,7 +19,7 @@ declare global {
19
19
  * options.width = 360;
20
20
  * ```
21
21
  */
22
- static get defaultOptions(): DocumentSheet.Options;
22
+ static get defaultOptions(): DocumentSheetOptions;
23
23
 
24
24
  /** @override */
25
25
  get title(): string;
@@ -41,7 +41,7 @@ declare global {
41
41
  }
42
42
 
43
43
  namespace PlaylistConfig {
44
- interface Data<Options extends DocumentSheet.Options = DocumentSheet.Options>
44
+ interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
45
45
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof Playlist>>, Options> {
46
46
  modes: Record<foundry.CONST.PLAYLIST_MODES, string>;
47
47
  }
@@ -10,7 +10,7 @@ declare global {
10
10
  * @typeParam Data - The data structure used to render the handlebars template.
11
11
  */
12
12
  class PlaylistSoundConfig<
13
- Options extends DocumentSheet.Options = DocumentSheet.Options,
13
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
14
14
  Data extends object = PlaylistSoundConfig.Data<Options>
15
15
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>> {
16
16
  /**
@@ -24,7 +24,7 @@ declare global {
24
24
  * });
25
25
  * ```
26
26
  */
27
- static get defaultOptions(): DocumentSheet.Options;
27
+ static get defaultOptions(): DocumentSheetOptions;
28
28
 
29
29
  /** @override */
30
30
  get title(): string;
@@ -58,7 +58,7 @@ declare global {
58
58
  /**
59
59
  * @typeParam Options - the type of the options object
60
60
  */
61
- interface Data<Options extends DocumentSheet.Options = DocumentSheet.Options>
61
+ interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
62
62
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>, Options> {
63
63
  lvolume: number;
64
64
  }
@@ -1,5 +1,5 @@
1
1
  import type { ConfiguredDocumentClassForName, ToObjectFalseType } from '../../../../../types/helperTypes';
2
- import type { TableResultDataConstructorData } from '../../../../common/data/data.mjs/tableResultData.js';
2
+ import type { TableResultDataConstructorData } from '../../../../common/data/data.mjs/tableResultData';
3
3
 
4
4
  declare global {
5
5
  /**
@@ -8,7 +8,7 @@ declare global {
8
8
  * @typeParam Data - The data structure used to render the handlebars template.
9
9
  */
10
10
  class RollTableConfig<
11
- Options extends DocumentSheet.Options = DocumentSheet.Options,
11
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
12
12
  Data extends object = RollTableConfig.Data
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'RollTable'>>> {
14
14
  /**
@@ -26,7 +26,7 @@ declare global {
26
26
  * })
27
27
  * ```
28
28
  */
29
- static get defaultOptions(): DocumentSheet.Options;
29
+ static get defaultOptions(): DocumentSheetOptions;
30
30
 
31
31
  /**
32
32
  * @override
@@ -9,7 +9,7 @@ declare global {
9
9
  * @typeParam Data - The data structure used to render the handlebars template.
10
10
  */
11
11
  class SceneConfig<
12
- Options extends DocumentSheet.Options = DocumentSheet.Options,
12
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
13
13
  Data extends object = SceneConfig.Data<Options>
14
14
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Scene'>>> {
15
15
  /**
@@ -25,7 +25,7 @@ declare global {
25
25
  * });
26
26
  * ```
27
27
  */
28
- static get defaultOptions(): DocumentSheet.Options;
28
+ static get defaultOptions(): DocumentSheetOptions;
29
29
 
30
30
  /**
31
31
  * @override
@@ -44,7 +44,7 @@ declare global {
44
44
  * @param options - (unused)
45
45
  * @override
46
46
  */
47
- getData(options?: Partial<DocumentSheet.Options>): Data | Promise<Data>;
47
+ getData(options?: Partial<DocumentSheetOptions>): Data | Promise<Data>;
48
48
 
49
49
  /**
50
50
  * Get an enumeration of the available grid types which can be applied to this Scene
@@ -100,7 +100,7 @@ declare global {
100
100
  }
101
101
 
102
102
  namespace SceneConfig {
103
- interface Data<Options extends DocumentSheet.Options = DocumentSheet.Options>
103
+ interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
104
104
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Scene'>>, Options> {
105
105
  gridTypes: ReturnType<typeof SceneConfig['_getGridTypes']>;
106
106
  weatherTypes: ReturnType<SceneConfig['_getWeatherTypes']>;
@@ -48,7 +48,7 @@ declare global {
48
48
  }
49
49
 
50
50
  namespace TileConfig {
51
- interface Data<Options extends DocumentSheet.Options>
51
+ interface Data<Options extends DocumentSheetOptions>
52
52
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Tile'>>, Options> {
53
53
  submitText: string;
54
54
  occlusionModes: Record<foundry.CONST.TILE_OCCLUSION_MODES, string>;
@@ -56,7 +56,7 @@ declare global {
56
56
 
57
57
  type FormData = Pick<TileDataConstructorData, 'height' | 'img' | 'rotation' | 'width' | 'x' | 'y'>;
58
58
 
59
- interface Options extends DocumentSheet.Options {
59
+ interface Options extends DocumentSheetOptions {
60
60
  /**
61
61
  * Configure a preview version of a tile which is not yet saved
62
62
  */