@league-of-foundry-developers/foundry-vtt-types 9.255.3 → 9.268.0

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 (93) hide show
  1. package/README.md +5 -4
  2. package/package.json +3 -2
  3. package/src/foundry/common/data/data.mjs/index.d.ts +0 -1
  4. package/src/foundry/common/utils/helpers.mjs.d.ts +1 -0
  5. package/src/foundry/foundry.js/application.d.ts +0 -1
  6. package/src/foundry/foundry.js/applications/chatPopout.d.ts +1 -1
  7. package/src/foundry/foundry.js/applications/compendium.d.ts +20 -11
  8. package/src/foundry/foundry.js/applications/controlsReference.d.ts +17 -2
  9. package/src/foundry/foundry.js/applications/filePicker.d.ts +67 -75
  10. package/src/foundry/foundry.js/applications/formApplication.d.ts +2 -2
  11. package/src/foundry/foundry.js/applications/formApplications/avConfig.d.ts +1 -1
  12. package/src/foundry/foundry.js/applications/formApplications/combatTrackerConfig.d.ts +2 -4
  13. package/src/foundry/foundry.js/applications/formApplications/{entitySheetConfig.d.ts → documentSheetConfig.d.ts} +36 -19
  14. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientLightConfig.d.ts +1 -4
  15. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientSoundConfig.d.ts +2 -4
  16. package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardConfig.d.ts +51 -0
  17. package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfig.d.ts +88 -0
  18. package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/cardsHand.d.ts +20 -0
  19. package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/cardsPile.d.ts +20 -0
  20. package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/index.d.ts +2 -0
  21. package/src/foundry/foundry.js/applications/formApplications/documentSheets/combatantConfig.d.ts +2 -4
  22. package/src/foundry/foundry.js/applications/formApplications/documentSheets/folderConfig.d.ts +17 -11
  23. package/src/foundry/foundry.js/applications/formApplications/documentSheets/index.d.ts +3 -0
  24. package/src/foundry/foundry.js/applications/formApplications/documentSheets/itemSheet.d.ts +3 -9
  25. package/src/foundry/foundry.js/applications/formApplications/documentSheets/journalSheet.d.ts +10 -12
  26. package/src/foundry/foundry.js/applications/formApplications/documentSheets/macroConfig.d.ts +4 -5
  27. package/src/foundry/foundry.js/applications/formApplications/documentSheets/measuredTemplateConfig.d.ts +2 -6
  28. package/src/foundry/foundry.js/applications/formApplications/documentSheets/noteConfig.d.ts +1 -4
  29. package/src/foundry/foundry.js/applications/formApplications/documentSheets/permissionControl.d.ts +8 -12
  30. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistConfig.d.ts +2 -1
  31. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistSoundConfig.d.ts +1 -4
  32. package/src/foundry/foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts +10 -11
  33. package/src/foundry/foundry.js/applications/formApplications/documentSheets/sceneConfig.d.ts +28 -15
  34. package/src/foundry/foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts +3 -6
  35. package/src/foundry/foundry.js/applications/formApplications/documentSheets/userConfig.d.ts +1 -4
  36. package/src/foundry/foundry.js/applications/formApplications/drawingConfig.d.ts +17 -21
  37. package/src/foundry/foundry.js/applications/formApplications/gridConfig.d.ts +3 -3
  38. package/src/foundry/foundry.js/applications/formApplications/imagePopout.d.ts +40 -7
  39. package/src/foundry/foundry.js/applications/formApplications/index.d.ts +2 -2
  40. package/src/foundry/foundry.js/applications/formApplications/moduleManagement.d.ts +10 -24
  41. package/src/foundry/foundry.js/applications/formApplications/permissionConfig.d.ts +1 -1
  42. package/src/foundry/foundry.js/applications/formApplications/settingsConfig.d.ts +15 -3
  43. package/src/foundry/foundry.js/applications/formApplications/tokenConfig.d.ts +23 -16
  44. package/src/foundry/foundry.js/applications/formApplications/{defaultTokenConfig.d.ts → tokenConfigs/defaultTokenConfig.d.ts} +29 -16
  45. package/src/foundry/foundry.js/applications/formApplications/tokenConfigs/index.d.ts +1 -0
  46. package/src/foundry/foundry.js/applications/formApplications/wallConfig.d.ts +22 -15
  47. package/src/foundry/foundry.js/applications/index.d.ts +1 -0
  48. package/src/foundry/foundry.js/applications/invitationLinks.d.ts +25 -10
  49. package/src/foundry/foundry.js/applications/sidebarTabs/chatLog.d.ts +65 -38
  50. package/src/foundry/foundry.js/applications/sidebarTabs/compendiumDirectory.d.ts +17 -3
  51. package/src/foundry/foundry.js/applications/sidebarTabs/settings.d.ts +19 -16
  52. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/actorDirectory.d.ts +0 -3
  53. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/journalDirectory.d.ts +4 -18
  54. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/macroDirectory.d.ts +2 -8
  55. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts +38 -5
  56. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/sceneDirectory.d.ts +6 -0
  57. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts +3 -1
  58. package/src/foundry/foundry.js/applications/supportDetails.d.ts +78 -0
  59. package/src/foundry/foundry.js/clientDocuments/cards.d.ts +8 -0
  60. package/src/foundry/foundry.js/clientDocuments/chatMessage.d.ts +87 -49
  61. package/src/foundry/foundry.js/clientDocuments/folder.d.ts +2 -6
  62. package/src/foundry/foundry.js/clientDocuments/playlistSound.d.ts +6 -0
  63. package/src/foundry/foundry.js/collections/documentCollections/worldCollection.d.ts +2 -2
  64. package/src/foundry/foundry.js/config.d.ts +21 -21
  65. package/src/foundry/foundry.js/contextMenu.d.ts +37 -28
  66. package/src/foundry/foundry.js/game.d.ts +2 -2
  67. package/src/foundry/foundry.js/pixi/containers/canvasLayer.d.ts +2 -1
  68. package/src/foundry/foundry.js/pixi/containers/canvasLayers/controlsLayer.d.ts +49 -48
  69. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayer.d.ts +51 -40
  70. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/lightingLayer.d.ts +63 -20
  71. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayer.d.ts +0 -3
  72. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/backgroundLayer.d.ts +4 -4
  73. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/foregroundLayer.d.ts +21 -0
  74. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/notesLayer.d.ts +1 -1
  75. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/soundsLayer.d.ts +10 -2
  76. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/tokenLayer.d.ts +41 -20
  77. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/wallsLayer.d.ts +50 -121
  78. package/src/foundry/foundry.js/pixi/containers/canvasLayers/sightLayer.d.ts +125 -107
  79. package/src/foundry/foundry.js/pixi/containers/controlIcon.d.ts +3 -0
  80. package/src/foundry/foundry.js/pixi/containers/placeableObjects/tile.d.ts +11 -0
  81. package/src/foundry/foundry.js/pixi/containers/placeableObjects/token.d.ts +34 -27
  82. package/src/foundry/foundry.js/pixi/filters/abstractFilter.d.ts +42 -0
  83. package/src/foundry/foundry.js/pixi/filters/abstractFilters/fogColorFilter.d.ts +16 -0
  84. package/src/foundry/foundry.js/pixi/filters/abstractFilters/forceColorFilter.d.ts +17 -0
  85. package/src/foundry/foundry.js/pixi/filters/abstractFilters/glowFilter.d.ts +31 -0
  86. package/src/foundry/foundry.js/pixi/filters/abstractFilters/index.d.ts +4 -0
  87. package/src/foundry/foundry.js/pixi/filters/abstractFilters/roofMaskFilter.d.ts +20 -0
  88. package/src/foundry/foundry.js/pixi/filters/index.d.ts +2 -0
  89. package/src/foundry/foundry.js/roll.d.ts +2 -2
  90. package/src/foundry/foundry.js/rollTerms/poolTerm.d.ts +5 -0
  91. package/src/types/augments/index.d.ts +2 -0
  92. package/src/types/augments/pixiGraphicsSmooth.d.ts +7 -0
  93. package/src/types/augments/pixiLegacyGraphics.d.ts +7 -0
@@ -58,10 +58,7 @@ declare global {
58
58
  * @param event - (unused)
59
59
  * @override
60
60
  */
61
- protected _updateObject(
62
- event: Event,
63
- formData: AmbientLightConfig.FormData
64
- ): Promise<InstanceType<ConfiguredDocumentClassForName<'AmbientLight'>> | undefined>;
61
+ protected _updateObject(event: Event, formData: AmbientLightConfig.FormData): Promise<unknown>;
65
62
 
66
63
  /**
67
64
  * Refresh the display of the AmbientLight object
@@ -34,10 +34,7 @@ declare global {
34
34
  * @param event - (unused)
35
35
  * @override
36
36
  */
37
- protected _updateObject(
38
- event: Event,
39
- formData: AmbientSoundConfig.FormData
40
- ): Promise<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>>;
37
+ protected _updateObject(event: Event, formData: AmbientSoundConfig.FormData): Promise<unknown>;
41
38
 
42
39
  /** @override */
43
40
  close(options?: Application.CloseOptions): Promise<void>;
@@ -47,6 +44,7 @@ declare global {
47
44
  interface Data<Options extends DocumentSheetOptions>
48
45
  extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'AmbientSound'>>, Options> {
49
46
  submitText: string;
47
+ gridUnits: string;
50
48
  }
51
49
 
52
50
  type FormData = Pick<foundry.data.AmbientSoundData, 'easing' | 'path' | 'volume'> &
@@ -0,0 +1,51 @@
1
+ import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../../types/helperTypes.js';
2
+ import type { CardFaceData } from '../../../../common/data/module.mjs.js';
3
+
4
+ declare global {
5
+ /**
6
+ * A DocumentSheet application responsible for displaying and editing a single embedded Card document.
7
+ *
8
+ * @typeParam Options - The type of the options object
9
+ * @typeParam Data - The data structure used to render the handlebars template.
10
+ */
11
+ class CardConfig<
12
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
13
+ Data extends CardConfig.Data<Options> = CardConfig.Data<Options>
14
+ > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Card'>>> {
15
+ /**
16
+ * @defaultValue
17
+ * ```typescript
18
+ * foundry.utils.mergeObject(super.defaultOptions, {
19
+ * classes: ["sheet", "card-config"],
20
+ * template: "templates/cards/card-config.html",
21
+ * width: 480,
22
+ * height: "auto",
23
+ * tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "details"}]
24
+ * })
25
+ * ```
26
+ */
27
+ static override get defaultOptions(): DocumentSheetOptions;
28
+
29
+ override getData(options?: Partial<Options>): Data | Promise<Data>;
30
+
31
+ override activateListeners(html: JQuery): void;
32
+
33
+ protected override _getSubmitData(
34
+ updateData?: object | null
35
+ ): Record<string, unknown> & { faces: ConstructorDataType<CardFaceData>[] };
36
+
37
+ /**
38
+ * Handle card face control actions which modify single cards on the sheet.
39
+ * @param event - The originating click event
40
+ * @returns A Promise which resolves once the handler has completed
41
+ */
42
+ protected _onFaceControl(event: JQuery.ClickEvent): Promise<void>;
43
+ }
44
+
45
+ namespace CardConfig {
46
+ interface Data<Options extends DocumentSheetOptions>
47
+ extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Card'>>, Options> {
48
+ types: Record<string, string>;
49
+ }
50
+ }
51
+ }
@@ -0,0 +1,88 @@
1
+ import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes.js';
2
+
3
+ declare global {
4
+ /**
5
+ * A DocumentSheet application responsible for displaying and editing a single Cards stack.
6
+ *
7
+ * @typeParam Options - The type of the options object
8
+ * @typeParam Data - The data structure used to render the handlebars template.
9
+ */
10
+ class CardsConfig<
11
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
12
+ Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
13
+ > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Cards'>>> {
14
+ constructor(object: ConfiguredDocumentClassForName<'Cards'>, options: Options);
15
+
16
+ /**
17
+ * The sorting mode used to display the sheet, "standard" if true, otherwise "shuffled"
18
+ * @internal
19
+ * @defaultValue `false`
20
+ */
21
+ protected _sortStandard: boolean;
22
+
23
+ /**
24
+ * @defaultValue
25
+ * ```typescript
26
+ * foundry.utils.mergeObject(super.defaultOptions, {
27
+ * classes: ["sheet", "cards-config"],
28
+ * template: "templates/cards/cards-deck.html",
29
+ * width: 620,
30
+ * height: "auto",
31
+ * closeOnSubmit: false,
32
+ * viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.OBSERVER,
33
+ * dragDrop: [{dragSelector: "ol.cards li.card", dropSelector: "ol.cards"}],
34
+ * tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "cards"}],
35
+ * scrollY: ["ol.cards"]
36
+ * })
37
+ * ```
38
+ */
39
+ static override get defaultOptions(): DocumentSheetOptions;
40
+
41
+ override getData(options?: Partial<Options>): Data | Promise<Data>;
42
+
43
+ override activateListeners(html: JQuery): void;
44
+
45
+ /**
46
+ * Handle card control actions which modify single cards on the sheet.
47
+ * @param event - The originating click event
48
+ * @returns A Promise which resolves once the handler has completed
49
+ */
50
+ protected _onCardControl(event: JQuery.ClickEvent): Promise<void>;
51
+
52
+ /**
53
+ * Handle lazy-loading card face images.
54
+ * See {@link SidebarTab#_onLazyLoadImage}
55
+ */
56
+ protected _onLazyLoadImage(entries: IntersectionObserverEntry[], observer: IntersectionObserver): void;
57
+
58
+ /** @param selector - (unused) */
59
+ protected override _canDragStart(selector: string): boolean;
60
+
61
+ protected override _onDragStart(event: DragEvent): void;
62
+
63
+ /** @param selector - (unused) */
64
+ protected override _canDragDrop(selector: string): boolean;
65
+
66
+ protected override _onDrop(event: DragEvent): void;
67
+
68
+ /**
69
+ * Handle sorting a Card relative to other siblings within this document
70
+ * @param event - The drag drop event
71
+ * @param card - The card being dragged
72
+ * @internal
73
+ */
74
+ protected _onSortCard(
75
+ event: DragEvent,
76
+ card: InstanceType<ConfiguredDocumentClassForName<'Card'>>
77
+ ): ReturnType<InstanceType<ConfiguredDocumentClassForName<'Cards'>>['updateEmbeddedDocuments']>;
78
+ }
79
+
80
+ namespace CardsConfig {
81
+ interface Data<Options extends DocumentSheetOptions>
82
+ extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Cards'>>, Options> {
83
+ cards: InstanceType<ConfiguredDocumentClassForName<'Card'>>[];
84
+ types: Record<string, string>;
85
+ inCompendium: boolean;
86
+ }
87
+ }
88
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "hand" type.
3
+ *
4
+ * @typeParam Options - The type of the options object
5
+ * @typeParam Data - The data structure used to render the handlebars template.
6
+ */
7
+ declare class CardsHand<
8
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
9
+ Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
10
+ > extends CardsConfig<Options, Data> {
11
+ /**
12
+ * @defaultValue
13
+ * ```typescript
14
+ * foundry.utils.mergeObject(super.defaultOptions, {
15
+ * template: "templates/cards/cards-hand.html"
16
+ * })
17
+ * ```
18
+ */
19
+ static override get defaultOptions(): DocumentSheetOptions;
20
+ }
@@ -0,0 +1,20 @@
1
+ /**
2
+ * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "pile" type.
3
+ *
4
+ * @typeParam Options - The type of the options object
5
+ * @typeParam Data - The data structure used to render the handlebars template.
6
+ */
7
+ declare class CardsPile<
8
+ Options extends DocumentSheetOptions = DocumentSheetOptions,
9
+ Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
10
+ > extends CardsConfig<Options, Data> {
11
+ /**
12
+ * @defaultValue
13
+ * ```typescript
14
+ * foundry.utils.mergeObject(super.defaultOptions, {
15
+ * template: "templates/cards/cards-pile.html"
16
+ * })
17
+ * ```
18
+ */
19
+ static override get defaultOptions(): DocumentSheetOptions;
20
+ }
@@ -0,0 +1,2 @@
1
+ import './cardsHand';
2
+ import './cardsPile';
@@ -12,6 +12,7 @@ declare global {
12
12
  Data extends CombatantConfig.Data<Options> = CombatantConfig.Data<Options>
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Combatant>>> {
14
14
  /**
15
+ * @override
15
16
  * @defaultValue
16
17
  * ```typescript
17
18
  * foundry.utils.mergeObject(super.defaultOptions, {
@@ -32,10 +33,7 @@ declare global {
32
33
  * @param event - (unused)
33
34
  * @override
34
35
  */
35
- protected _updateObject(
36
- event: Event,
37
- formData: CombatantConfig.FormData
38
- ): Promise<InstanceType<ConfiguredDocumentClass<typeof Combatant>> | undefined>;
36
+ protected _updateObject(event: Event, formData: CombatantConfig.FormData): Promise<unknown>;
39
37
  }
40
38
 
41
39
  namespace CombatantConfig {
@@ -4,12 +4,14 @@ import type { SortingModes } from '../../../../common/data/data.mjs/folderData';
4
4
  declare global {
5
5
  /**
6
6
  * The Application responsible for configuring a single Folder document.
7
+ *
8
+ * @typeParam Options - the type of the options object
9
+ * @typeParam Data - The data structure used to render the handlebars template.
7
10
  */
8
- class FolderConfig extends DocumentSheet<
9
- DocumentSheetOptions,
10
- FolderConfig.Data,
11
- InstanceType<ConfiguredDocumentClass<typeof Folder>>
12
- > {
11
+ class FolderConfig<
12
+ Options extends FolderConfig.Options = FolderConfig.Options,
13
+ Data extends object = FolderConfig.Data
14
+ > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Folder>>> {
13
15
  /**
14
16
  * @override
15
17
  * @defaultValue
@@ -21,7 +23,7 @@ declare global {
21
23
  * })
22
24
  * ```
23
25
  */
24
- static get defaultOptions(): typeof DocumentSheet['defaultOptions'];
26
+ static get defaultOptions(): DocumentSheetOptions;
25
27
 
26
28
  /** @override */
27
29
  get id(): string;
@@ -29,24 +31,28 @@ declare global {
29
31
  /** @override */
30
32
  get title(): string;
31
33
 
34
+ /** @override */
35
+ close(options?: Application.CloseOptions | undefined): Promise<void>;
36
+
32
37
  /**
33
38
  * @param options - (unused)
34
39
  * @override
35
40
  */
36
- getData(options?: Partial<FormApplicationOptions>): Promise<FolderConfig.Data>;
41
+ getData(options?: Partial<Options>): Promise<Data>;
37
42
 
38
43
  /**
39
44
  * @param event - (unused)
40
45
  * @override
41
46
  * @internal
42
47
  */
43
- protected _updateObject(
44
- event: Event,
45
- formData: FolderConfig.FormData
46
- ): Promise<InstanceType<ConfiguredDocumentClass<typeof Folder>> | undefined>;
48
+ protected _updateObject(event: Event, formData: FolderConfig.FormData): Promise<unknown>;
47
49
  }
48
50
 
49
51
  namespace FolderConfig {
52
+ interface Options extends DocumentSheetOptions {
53
+ resolve?: (doc: InstanceType<ConfiguredDocumentClass<typeof Folder>>) => void;
54
+ }
55
+
50
56
  interface Data {
51
57
  name: string;
52
58
  newName: string;
@@ -2,6 +2,9 @@ import './activeEffectConfig';
2
2
  import './actorSheet';
3
3
  import './ambientLightConfig';
4
4
  import './ambientSoundConfig';
5
+ import './cardConfig';
6
+ import './cardsConfig';
7
+ import './cardsConfigs';
5
8
  import './combatantConfig';
6
9
  import './folderConfig';
7
10
  import './itemSheet';
@@ -26,6 +26,7 @@ declare global {
26
26
  * resizable: true,
27
27
  * baseApplication: "ItemSheet",
28
28
  * id: "item"
29
+ * })
29
30
  * ```
30
31
  */
31
32
  static get defaultOptions(): ItemSheet.Options;
@@ -37,7 +38,7 @@ declare global {
37
38
  get title(): string;
38
39
 
39
40
  /**
40
- * A convenience reference to the Item entity
41
+ * A convenience reference to the Item document
41
42
  */
42
43
  get item(): this['object'];
43
44
 
@@ -57,19 +58,12 @@ declare global {
57
58
  */
58
59
  getData(options?: Partial<Options>): Data | Promise<Data>;
59
60
 
60
- /** @override */
61
- protected _getHeaderButtons(): Application.HeaderButton[];
62
-
63
61
  /** @override */
64
62
  activateListeners(html: JQuery): void;
65
63
 
66
- /**
67
- * Handle requests to configure the default sheet used by this Item
68
- */
69
- protected _onConfigureSheet(event: JQuery.ClickEvent): void;
70
-
71
64
  /**
72
65
  * Handle changing the item image
66
+ * @internal
73
67
  */
74
68
  protected _onEditImage(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
75
69
  }
@@ -1,13 +1,18 @@
1
1
  import type { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
2
2
 
3
3
  declare global {
4
+ interface JournalSheetOptions extends DocumentSheetOptions {
5
+ /** The current display mode of the journal. Either 'text' or 'image'. */
6
+ sheetMode?: JournalSheet.SheetMode | null;
7
+ }
8
+
4
9
  /**
5
10
  * The Application responsible for displaying and editing a single JournalEntry document.
6
11
  * @typeParam Options - the type of the options object
7
12
  * @typeParam Data - The data structure used to render the handlebars template.
8
13
  */
9
14
  class JournalSheet<
10
- Options extends JournalSheet.Options = JournalSheet.Options,
15
+ Options extends JournalSheetOptions = JournalSheetOptions,
11
16
  Data extends object = JournalSheet.Data<Options>
12
17
  > extends DocumentSheet<Options, Data> {
13
18
  /**
@@ -41,11 +46,11 @@ declare global {
41
46
  * resizable: true,
42
47
  * closeOnSubmit: false,
43
48
  * submitOnClose: true,
44
- * viewPermission: CONST.ENTITY_PERMISSIONS.NONE
49
+ * viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.NONE
45
50
  * })
46
51
  * ```
47
52
  */
48
- static get defaultOptions(): JournalSheet.Options;
53
+ static get defaultOptions(): JournalSheetOptions;
49
54
 
50
55
  /** @override */
51
56
  get template(): string;
@@ -72,10 +77,7 @@ declare global {
72
77
  getData(options?: Partial<Options>): Promise<Data> | Data;
73
78
 
74
79
  /** @override */
75
- protected _updateObject(
76
- event: Event,
77
- formData: JournalSheet.FormData
78
- ): ReturnType<DocumentSheet<Options, Data>['_updateObject']>;
80
+ protected _updateObject(event: Event, formData: JournalSheet.FormData): Promise<unknown>;
79
81
 
80
82
  /**
81
83
  * Handle requests to switch the rendered mode of the Journal Entry sheet
@@ -96,11 +98,7 @@ declare global {
96
98
  }
97
99
 
98
100
  namespace JournalSheet {
99
- interface Options extends DocumentSheetOptions {
100
- sheetMode?: SheetMode | null;
101
- }
102
-
103
- interface Data<Options extends JournalSheet.Options = JournalSheet.Options>
101
+ interface Data<Options extends JournalSheetOptions = JournalSheetOptions>
104
102
  extends DocumentSheet.Data<ConcreteJournalEntry, Options> {
105
103
  image: string;
106
104
  folders: ReturnType<NonNullable<Game['folders']>['filter']>;
@@ -4,7 +4,6 @@ declare global {
4
4
  /**
5
5
  * A Macro configuration sheet
6
6
  *
7
- * @see {@link Macro} The Macro Entity which is being configured
8
7
  * @typeParam Options - the type of the options object
9
8
  * @typeParam Data - The data structure used to render the handlebars template.
10
9
  */
@@ -36,6 +35,9 @@ declare global {
36
35
  /** @override */
37
36
  activateListeners(html: JQuery): void;
38
37
 
38
+ /** @override */
39
+ protected _disableFields(form: HTMLElement): void;
40
+
39
41
  /**
40
42
  * Handle changing the actor profile image by opening a FilePicker
41
43
  * @internal
@@ -50,10 +52,7 @@ declare global {
50
52
  protected _onExecute(event: JQuery.ClickEvent): Promise<void>;
51
53
 
52
54
  /** @override */
53
- protected _updateObject(
54
- event: Event,
55
- formData: MacroConfig.FormData
56
- ): Promise<InstanceType<ConfiguredDocumentClass<typeof Macro>> | undefined>;
55
+ protected _updateObject(event: Event, formData: MacroConfig.FormData): Promise<unknown>;
57
56
  }
58
57
 
59
58
  namespace MacroConfig {
@@ -3,7 +3,6 @@ import type { ConfiguredDocumentClassForName } from '../../../../../types/helper
3
3
  declare global {
4
4
  /**
5
5
  * The Application responsible for configuring a single MeasuredTemplate document within a parent Scene.
6
- * @see {@link MeasuredTemplate}
7
6
  * @typeParam Options - the type of the options object
8
7
  * @typeParam Data - The data structure used to render the handlebars template.
9
8
  */
@@ -18,7 +17,7 @@ declare global {
18
17
  * foundry.utils.mergeObject(super.defaultOptions, {
19
18
  * id: "template-config",
20
19
  * classes: ["sheet", "template-sheet"],
21
- * title: "Measurement Template Configuration",
20
+ * title: "TEMPLATE.MeasuredConfig",
22
21
  * template: "templates/scene/template-config.html",
23
22
  * width: 400,
24
23
  * })
@@ -30,10 +29,7 @@ declare global {
30
29
  getData(): Data | Promise<Data>;
31
30
 
32
31
  /** @override */
33
- protected _updateObject(
34
- event: Event,
35
- formData: MeasuredTemplateConfig.FormData
36
- ): Promise<InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>> | undefined>;
32
+ protected _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<unknown>;
37
33
  }
38
34
 
39
35
  namespace MeasuredTemplateConfig {
@@ -33,10 +33,7 @@ declare global {
33
33
  * @param event - (unused)
34
34
  * @override
35
35
  */
36
- protected _updateObject(
37
- event: Event,
38
- formData: NoteConfig.FormData
39
- ): Promise<ConfiguredDocumentClassForName<'Note'> | undefined>;
36
+ protected _updateObject(event: Event, formData: NoteConfig.FormData): Promise<unknown>;
40
37
 
41
38
  /**
42
39
  * @override
@@ -2,27 +2,27 @@ import type { ConfiguredDocumentClassForName } from '../../../../../types/helper
2
2
 
3
3
  declare global {
4
4
  /**
5
- * A generic application for configuring permissions for various Entity types
5
+ * A generic application for configuring permissions for various Document types
6
6
  * @typeParam Options - the type of the options object
7
7
  * @typeParam Data - The data structure used to render the handlebars template.
8
8
  * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
9
9
  */
10
10
  class PermissionControl<
11
11
  Options extends DocumentSheetOptions = DocumentSheetOptions,
12
- Data extends object = DocumentSheet.Data,
12
+ Data extends object = PermissionControl.Data,
13
13
  ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheet.Data<infer T>
14
14
  ? T
15
15
  : foundry.abstract.Document<any, any>
16
- > extends DocumentSheet<Options, PermissionControl.Data<ConcreteDocument>, ConcreteDocument> {
16
+ > extends DocumentSheet<Options, PermissionControl.Data, ConcreteDocument> {
17
17
  /**
18
18
  * @override
19
19
  * @defaultValue
20
20
  * ```typescript
21
- * mergeObject(super.defaultOptions, {
21
+ * foundry.utils.mergeObject(super.defaultOptions, {
22
22
  * id: "permission",
23
23
  * template: "templates/apps/permission.html",
24
24
  * width: 400
25
- * });
25
+ * })
26
26
  * ```
27
27
  */
28
28
  static get defaultOptions(): DocumentSheetOptions;
@@ -30,19 +30,15 @@ declare global {
30
30
  /** @override */
31
31
  get title(): string;
32
32
 
33
- /**
34
- * @override
35
- * @param options - (unused)
36
- */
37
- getData(options?: Partial<Options>): PermissionControl.Data<ConcreteDocument>;
33
+ /** @override */
34
+ getData(options?: Partial<Options> | undefined): PermissionControl.Data | Promise<PermissionControl.Data>;
38
35
 
39
36
  /** @override */
40
37
  protected _updateObject(event: Event, formData: PermissionControl.FormData): Promise<unknown>;
41
38
  }
42
39
 
43
40
  namespace PermissionControl {
44
- interface Data<ConcreteDocument extends foundry.abstract.Document<any, any>> extends DocumentSheet.Data {
45
- entity: ConcreteDocument;
41
+ interface Data {
46
42
  currentDefault: foundry.CONST.DOCUMENT_PERMISSION_LEVELS | '-1';
47
43
  instructions: string;
48
44
  defaultLevels: Record<foundry.CONST.DOCUMENT_PERMISSION_LEVELS, string> & { '-1'?: string };
@@ -31,7 +31,7 @@ declare global {
31
31
  getData(options?: Partial<Options>): Data | Promise<Data>;
32
32
 
33
33
  /** @override */
34
- protected _getFilePickerOptions(event: PointerEvent): FilePicker.Options;
34
+ protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
35
35
 
36
36
  /**
37
37
  * @override
@@ -44,6 +44,7 @@ declare global {
44
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
+ sorting: Record<foundry.CONST.PLAYLIST_SORT_MODES, string>;
47
48
  }
48
49
  }
49
50
  }
@@ -48,10 +48,7 @@ declare global {
48
48
  * @override
49
49
  * @param event - (unused)
50
50
  */
51
- protected _updateObject(
52
- event: Event,
53
- formData: PlaylistSoundConfig.FormData
54
- ): Promise<InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>> | undefined>;
51
+ protected _updateObject(event: Event, formData: PlaylistSoundConfig.FormData): Promise<unknown>;
55
52
  }
56
53
 
57
54
  namespace PlaylistSoundConfig {
@@ -9,9 +9,10 @@ declare global {
9
9
  */
10
10
  class RollTableConfig<
11
11
  Options extends DocumentSheetOptions = DocumentSheetOptions,
12
- Data extends object = RollTableConfig.Data
12
+ Data extends object = RollTableConfig.Data<Options>
13
13
  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'RollTable'>>> {
14
14
  /**
15
+ * @override
15
16
  * @defaultValue
16
17
  * ```typescript
17
18
  * foundry.utils.mergeObject(super.defaultOptions, {
@@ -20,7 +21,7 @@ declare global {
20
21
  * width: 720,
21
22
  * height: "auto",
22
23
  * closeOnSubmit: false,
23
- * viewPermission: CONST.ENTITY_PERMISSIONS.OBSERVER,
24
+ * viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.OBSERVER,
24
25
  * scrollY: ["ol.table-results"],
25
26
  * dragDrop: [{ dragSelector: null, dropSelector: null }],
26
27
  * })
@@ -45,7 +46,7 @@ declare global {
45
46
  activateListeners(html: JQuery): void;
46
47
 
47
48
  /**
48
- * Handle creating a TableResult in the RollTable entity
49
+ * Handle creating a TableResult in the RollTable document
49
50
  * @param event - The originating mouse event
50
51
  * @param resultData - An optional object of result data to use
51
52
  * @internal
@@ -62,7 +63,7 @@ declare global {
62
63
  protected _onChangeResultType(event: JQuery.ChangeEvent): void;
63
64
 
64
65
  /**
65
- * Handle deleting a TableResult from the RollTable entity
66
+ * Handle deleting a TableResult from the RollTable document
66
67
  * @param event - The originating click event
67
68
  * @returns The deleted TableResult document
68
69
  * @internal
@@ -114,10 +115,7 @@ declare global {
114
115
  * @param formData - The validated FormData translated into an Object for submission
115
116
  * @internal
116
117
  */
117
- protected _updateObject(
118
- event: Event,
119
- formData: RollTableConfig.FormData
120
- ): Promise<InstanceType<ConfiguredDocumentClassForName<'RollTable'>> | undefined>;
118
+ protected _updateObject(event: Event, formData: RollTableConfig.FormData): Promise<unknown>;
121
119
 
122
120
  /**
123
121
  * Display a roulette style animation when a Roll Table result is drawn from the sheet
@@ -146,10 +144,11 @@ declare global {
146
144
  }
147
145
 
148
146
  namespace RollTableConfig {
149
- interface Data extends DocumentSheet.Data<RollTable> {
147
+ interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
148
+ extends DocumentSheet.Data<RollTable, Options> {
150
149
  results: ToObjectFalseType<foundry.data.TableResultData> & {
151
150
  isText: boolean;
152
- isEntity: boolean;
151
+ isDocument: boolean;
153
152
  isCompendium: boolean;
154
153
  img: string;
155
154
  text: string;
@@ -157,7 +156,7 @@ declare global {
157
156
  resultTypes: {
158
157
  [Key in keyof typeof foundry.CONST.TABLE_RESULT_TYPES as typeof foundry.CONST.TABLE_RESULT_TYPES[Key]]: Titlecase<Key>;
159
158
  };
160
- entityTypes: typeof foundry.CONST.COMPENDIUM_ENTITY_TYPES;
159
+ documentTypes: typeof foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
161
160
  compendiumPacks: string[];
162
161
  }
163
162