@league-of-foundry-developers/foundry-vtt-types 0.8.9-4 → 0.8.9-8

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 +41 -13
  2. package/index-lenient.d.ts +10 -0
  3. package/package.json +10 -1
  4. package/src/foundry/common/abstract/backend.mjs.d.ts +14 -15
  5. package/src/foundry/common/abstract/document.mjs.d.ts +6 -2
  6. package/src/foundry/common/data/data.mjs/drawingData.d.ts +8 -3
  7. package/src/foundry/common/data/data.mjs/index.d.ts +2 -0
  8. package/src/foundry/common/data/data.mjs/playlistData.d.ts +171 -0
  9. package/src/foundry/common/data/data.mjs/playlistSoundData.d.ts +143 -0
  10. package/src/foundry/common/data/fields.mjs.d.ts +2 -2
  11. package/src/foundry/common/documents.mjs/basePlaylist.d.ts +11 -1
  12. package/src/foundry/common/documents.mjs/basePlaylistSound.d.ts +21 -2
  13. package/src/foundry/common/types.mjs.d.ts +5 -0
  14. package/src/foundry/foundry.js/application.d.ts +2 -5
  15. package/src/foundry/foundry.js/applications/cameraViews.d.ts +36 -31
  16. package/src/foundry/foundry.js/applications/compendium.d.ts +5 -2
  17. package/src/foundry/foundry.js/applications/filePicker.d.ts +114 -114
  18. package/src/foundry/foundry.js/applications/formApplication.d.ts +3 -11
  19. package/src/foundry/foundry.js/applications/formApplications/combatTrackerConfig.d.ts +20 -27
  20. package/src/foundry/foundry.js/applications/formApplications/defaultTokenConfig.d.ts +66 -0
  21. package/src/foundry/foundry.js/applications/formApplications/documentSheet.d.ts +1 -1
  22. package/src/foundry/foundry.js/applications/formApplications/documentSheets/activeEffectConfig.d.ts +2 -2
  23. package/src/foundry/foundry.js/applications/formApplications/documentSheets/actorSheet.d.ts +5 -2
  24. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientSoundConfig.d.ts +57 -0
  25. package/src/foundry/foundry.js/applications/formApplications/{folderConfig.d.ts → documentSheets/folderConfig.d.ts} +2 -2
  26. package/src/foundry/foundry.js/applications/formApplications/documentSheets/index.d.ts +7 -0
  27. package/src/foundry/foundry.js/applications/formApplications/documentSheets/lightConfig.d.ts +84 -0
  28. package/src/foundry/foundry.js/applications/formApplications/documentSheets/measuredTemplateConfig.d.ts +60 -0
  29. package/src/foundry/foundry.js/applications/formApplications/documentSheets/noteConfig.d.ts +72 -0
  30. package/src/foundry/foundry.js/applications/formApplications/documentSheets/permissionControl.d.ts +54 -60
  31. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistConfig.d.ts +41 -28
  32. package/src/foundry/foundry.js/applications/formApplications/documentSheets/playlistSoundConfig.d.ts +75 -0
  33. package/src/foundry/foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts +190 -148
  34. package/src/foundry/foundry.js/applications/formApplications/documentSheets/sceneConfig.d.ts +133 -110
  35. package/src/foundry/foundry.js/applications/formApplications/documentSheets/tileConfig.d.ts +66 -0
  36. package/src/foundry/foundry.js/applications/formApplications/drawingConfig.d.ts +93 -95
  37. package/src/foundry/foundry.js/applications/formApplications/entitySheetConfig.d.ts +163 -147
  38. package/src/foundry/foundry.js/applications/formApplications/index.d.ts +1 -7
  39. package/src/foundry/foundry.js/applications/formApplications/moduleManagement.d.ts +41 -23
  40. package/src/foundry/foundry.js/applications/formApplications/settingsConfig.d.ts +95 -86
  41. package/src/foundry/foundry.js/applications/formApplications/tokenConfig.d.ts +146 -158
  42. package/src/foundry/foundry.js/applications/formApplications/wallConfig.d.ts +60 -70
  43. package/src/foundry/foundry.js/applications/formApplications/worldConfig.d.ts +25 -17
  44. package/src/foundry/foundry.js/applications/headsUpDisplay.d.ts +11 -5
  45. package/src/foundry/foundry.js/applications/hotbar.d.ts +5 -4
  46. package/src/foundry/foundry.js/applications/sceneControls.d.ts +13 -3
  47. package/src/foundry/foundry.js/applications/sceneNavigation.d.ts +90 -71
  48. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/actorDirectory.d.ts +13 -56
  49. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/itemDirectory.d.ts +7 -30
  50. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/journalDirectory.d.ts +14 -34
  51. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/macroDirectory.d.ts +6 -52
  52. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts +249 -139
  53. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/sceneDirectory.d.ts +6 -23
  54. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts +3 -5
  55. package/src/foundry/foundry.js/cameraPopoutAppWrapper.d.ts +12 -7
  56. package/src/foundry/foundry.js/canvas.d.ts +2 -1
  57. package/src/foundry/foundry.js/clientDatabaseBackend.d.ts +210 -0
  58. package/src/foundry/foundry.js/clientDocumentMixin.d.ts +1 -1
  59. package/src/foundry/foundry.js/clientDocuments/canvasDocuments/index.d.ts +8 -0
  60. package/src/foundry/foundry.js/clientDocuments/canvasDocuments/tokenDocument.d.ts +1 -1
  61. package/src/foundry/foundry.js/clientDocuments/index.d.ts +19 -0
  62. package/src/foundry/foundry.js/clientDocuments/playlist.d.ts +195 -6
  63. package/src/foundry/foundry.js/clientDocuments/playlistSound.d.ts +113 -0
  64. package/src/foundry/foundry.js/clientDocuments/prototypeToken.d.ts +15 -0
  65. package/src/foundry/foundry.js/clientSettings.d.ts +14 -1
  66. package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts +44 -8
  67. package/src/foundry/foundry.js/config.d.ts +85 -71
  68. package/src/foundry/foundry.js/dragDrop.d.ts +17 -14
  69. package/src/foundry/foundry.js/globalVariables.d.ts +7 -4
  70. package/src/foundry/foundry.js/mouseInteractionManager.d.ts +78 -34
  71. package/src/foundry/foundry.js/pixi/containers/canvasLayer.d.ts +2 -1
  72. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayer.d.ts +10 -19
  73. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/backgroundLayer.d.ts +6 -2
  74. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/mapLayers/foregroundLayer.d.ts +2 -2
  75. package/src/foundry/foundry.js/pixi/containers/canvasLayers/placeablesLayers/wallsLayer.d.ts +1 -1
  76. package/src/foundry/foundry.js/pixi/containers/doorControl.d.ts +53 -35
  77. package/src/foundry/foundry.js/pixi/containers/placeableObject.d.ts +6 -2
  78. package/src/foundry/foundry.js/pixi/containers/placeableObjects/ambientLight.d.ts +38 -40
  79. package/src/foundry/foundry.js/pixi/containers/placeableObjects/ambientSound.d.ts +56 -56
  80. package/src/foundry/foundry.js/pixi/containers/placeableObjects/note.d.ts +9 -50
  81. package/src/foundry/foundry.js/pixi/containers/placeableObjects/tile.d.ts +166 -47
  82. package/src/foundry/foundry.js/pixi/containers/placeableObjects/wall.d.ts +1 -1
  83. package/src/foundry/foundry.js/pixi/containers/ruler.d.ts +11 -7
  84. package/src/foundry/foundry.js/pixi/graphics/gridHighlight.d.ts +4 -9
  85. package/src/foundry/foundry.js/pointSource.d.ts +173 -85
  86. package/src/foundry/foundry.js/textEditor.d.ts +39 -8
  87. package/src/foundry/index.d.ts +2 -25
  88. package/src/foundry/foundry.js/applications/formApplications/ambientSoundConfig.d.ts +0 -68
  89. package/src/foundry/foundry.js/applications/formApplications/lightConfig.d.ts +0 -98
  90. package/src/foundry/foundry.js/applications/formApplications/measuredTemplateConfig.d.ts +0 -61
  91. package/src/foundry/foundry.js/applications/formApplications/noteConfig.d.ts +0 -77
  92. package/src/foundry/foundry.js/applications/formApplications/playlistSoundConfig.d.ts +0 -70
  93. package/src/foundry/foundry.js/applications/formApplications/tileConfig.d.ts +0 -73
@@ -1,98 +0,0 @@
1
- /**
2
- * Light Source Configuration Sheet
3
- * @typeParam P - the type of the options object
4
- */
5
- declare class LightConfig<P extends FormApplication.Options = FormApplication.Options> extends FormApplication<
6
- P,
7
- LightConfig.Data,
8
- AmbientLight
9
- > {
10
- /**
11
- * @param light - The AmbientLight object for which settings are being configured
12
- * @param options - LightConfig ui options (see Application)
13
- */
14
- constructor(light: AmbientLight, options?: Partial<P>);
15
-
16
- /**
17
- * @override
18
- * @defaultValue
19
- * ```typescript
20
- * mergeObject(super.defaultOptions, {
21
- * classes: ["sheet", "light-sheet"],
22
- * title: "LIGHT.ConfigTitle",
23
- * template: "templates/scene/light-config.html",
24
- * width: 480
25
- * });
26
- * ```
27
- */
28
- static get defaultOptions(): typeof FormApplication['defaultOptions'];
29
-
30
- /**
31
- * @param options - (unused)
32
- * @override
33
- */
34
- getData(options?: Partial<P>): LightConfig.Data;
35
-
36
- /** @override */
37
- activateListeners(html: JQuery): void;
38
-
39
- /** @override */
40
- close(options?: Application.CloseOptions): Promise<void>;
41
-
42
- /**
43
- * Preview the change caused by a change on the form by refreshing the display of the light source
44
- */
45
- protected _onPreviewChange(event: JQuery.ChangeEvent): void;
46
-
47
- /** @override */
48
- protected _getSubmitData(
49
- updateData?: LightConfig.FormData
50
- ): ReturnType<FormApplication['_getSubmitData']> & { tintAlpha: number };
51
-
52
- /**
53
- * @param event - (unused)
54
- * @override
55
- */
56
- protected _updateObject(event: Event, formData: LightConfig.FormData): Promise<AmbientLight>;
57
-
58
- /**
59
- * Reset the state of the previewed light source object to its original data
60
- * @param refresh - (default: `true`)
61
- */
62
- protected _resetObject(refresh?: boolean): void;
63
- }
64
-
65
- declare namespace LightConfig {
66
- interface Data {
67
- object: foundry.utils.Duplicated<LightConfig['object']['data']>;
68
- options: LightConfig['options'];
69
- submitText: string;
70
- lightTypes: LightTypes;
71
- lightAnimations: LightAnimations;
72
- colorIntensity: number;
73
- }
74
-
75
- interface FormData {
76
- angle: AmbientLight.Data['angle'] | null;
77
- bright: AmbientLight.Data['bright'] | null;
78
- darknessThreshold: AmbientLight.Data['darknessThreshold'];
79
- dim: AmbientLight.Data['dim'] | null;
80
- 'lightAnimation.intensity': AmbientLight.Data['lightAnimation']['intensity'];
81
- 'lightAnimation.speed': AmbientLight.Data['lightAnimation']['speed'];
82
- 'lightAnimation.type': AmbientLight.Data['lightAnimation']['type'];
83
- rotation: AmbientLight.Data['rotation'];
84
- t: AmbientLight.Data['t'];
85
- tintAlpha: AmbientLight.Data['tintAlpha'];
86
- tintColor: string;
87
- x: AmbientLight.Data['x'] | null;
88
- y: AmbientLight.Data['y'] | null;
89
- }
90
-
91
- type LightAnimations = {
92
- [Key in keyof typeof CONFIG['Canvas']['lightAnimations']]: string;
93
- } & { '': 'None' };
94
-
95
- type LightTypes = {
96
- [Key in keyof typeof foundry.CONST['SOURCE_TYPES'] as typeof foundry.CONST['SOURCE_TYPES'][Key]]: `LIGHT.Type${Titlecase<Key>}`;
97
- };
98
- }
@@ -1,61 +0,0 @@
1
- // TODO: Remove when updating this class!!!
2
- // eslint-disable-next-line
3
- // @ts-nocheck
4
-
5
- /**
6
- * A configuration Form Application for modifying the properties of a MeasuredTemplate object.
7
- * @see {@link MeasuredTemplate}
8
- */
9
- declare class MeasuredTemplateConfig extends FormApplication<
10
- FormApplication.Options,
11
- MeasuredTemplateConfig.Data,
12
- MeasuredTemplate
13
- > {
14
- /**
15
- * @override
16
- * @defaultValue
17
- * ```typescript
18
- * mergeObject(super.defaultOptions, {
19
- * id: "template-config",
20
- * classes: ["sheet", "template-sheet"],
21
- * title: "Measurement Template Configuration",
22
- * template: "templates/scene/template-config.html",
23
- * width: 400
24
- * });
25
- * ```
26
- */
27
- static get defaultOptions(): typeof FormApplication['defaultOptions'];
28
-
29
- /**
30
- * @override
31
- */
32
- getData(): MeasuredTemplateConfig.Data;
33
-
34
- /**
35
- * @override
36
- */
37
- protected _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<MeasuredTemplate | null>;
38
- }
39
-
40
- declare namespace MeasuredTemplateConfig {
41
- interface Data {
42
- object: foundry.utils.Duplicated<MeasuredTemplateConfig['object']['data']>;
43
- options: MeasuredTemplateConfig['options'];
44
- templateTypes: typeof CONFIG['MeasuredTemplate']['types'];
45
- gridUnits: Scene['data']['gridUnits'];
46
- submitText: string;
47
- }
48
-
49
- type FormData = {
50
- angle: MeasuredTemplate.Data['angle'];
51
- borderColor: MeasuredTemplate.Data['borderColor'];
52
- direction: MeasuredTemplate.Data['direction'] | null;
53
- distance: MeasuredTemplate.Data['distance'] | null;
54
- fillColor: MeasuredTemplate.Data['fillColor'];
55
- t: MeasuredTemplate.Data['t'];
56
- texture: MeasuredTemplate.Data['texture'];
57
- width: MeasuredTemplate.Data['width'];
58
- x: MeasuredTemplate.Data['x'] | null;
59
- y: MeasuredTemplate.Data['y'] | null;
60
- };
61
- }
@@ -1,77 +0,0 @@
1
- // TODO: Remove when updating this class!!!
2
- // eslint-disable-next-line
3
- // @ts-nocheck
4
-
5
- /**
6
- * Placeable Note configuration sheet
7
- * @typeParam P - the type of the options object
8
- */
9
- declare class NoteConfig<P extends FormApplication.Options = FormApplication.Options> extends FormApplication<
10
- P,
11
- NoteConfig.Data,
12
- Note
13
- > {
14
- /**
15
- * @param note - The Note object for which settings are being configured
16
- * @param options - Additional Application options
17
- */
18
- constructor(note: Note, options?: Partial<P>);
19
-
20
- /**
21
- * @override
22
- * @defaultValue
23
- * ```typescript
24
- * mergeObject(super.defaultOptions, {
25
- * id: "note-config",
26
- * title: game.i18n.localize("NOTE.ConfigTitle"),
27
- * template: "templates/scene/note-config.html",
28
- * width: 400
29
- * });
30
- * ```
31
- */
32
- static get defaultOptions(): typeof FormApplication['defaultOptions'];
33
-
34
- /**
35
- * @param options - (unused)
36
- * @override
37
- */
38
- getData(options?: Partial<P>): NoteConfig.Data;
39
-
40
- /**
41
- * @param event - (unused)
42
- * @override
43
- */
44
- protected _updateObject(event: Event, formData: NoteConfig.FormData): Promise<Note>;
45
-
46
- /**
47
- * @override
48
- */
49
- close(options?: Application.CloseOptions): Promise<void>;
50
- }
51
-
52
- declare namespace NoteConfig {
53
- interface Data {
54
- entryIcons: typeof CONFIG.JournalEntry['noteIcons'];
55
- entryId: JournalEntry['_id'] | undefined;
56
- entryName: JournalEntry['name'] | undefined;
57
- entries: Journal['entities'];
58
- fontFamilies: Partial<Record<string, string>>;
59
- object: foundry.utils.Duplicated<NoteConfig['object']['data']>;
60
- options: NoteConfig['options'];
61
- textAnchors: Record<foundry.CONST.TextAnchorPoint, string>;
62
- }
63
-
64
- interface FormData {
65
- entryId: Note.Data['entryId'];
66
- fontFamily: Note.Data['fontFamily'];
67
- fontSize: Note.Data['fontSize'] | null;
68
- icon: Note.Data['icon'];
69
- iconSize: Note.Data['iconSize'] | null;
70
- iconTint: Note.Data['iconTint'];
71
- text: Note.Data['text'];
72
- textAnchor: Note.Data['textAnchor'];
73
- textColor: Note.Data['textColor'];
74
- x: Note.Data['x'] | null;
75
- y: Note.Data['y'] | null;
76
- }
77
- }
@@ -1,70 +0,0 @@
1
- // TODO: Remove when updating this class!!!
2
- // eslint-disable-next-line
3
- // @ts-nocheck
4
-
5
- /**
6
- * Playlist Sound Configuration Sheet
7
- * @typeParam P - the type of the options object
8
- */
9
- declare class PlaylistSoundConfig<P extends FormApplication.Options = FormApplication.Options> extends FormApplication<
10
- P,
11
- PlaylistSoundConfig.Data,
12
- Playlist.Sound
13
- > {
14
- /**
15
- * @param playlist - The Playlist entity within which the Sound is configured
16
- * @param sound - An Object for the Playlist Sound data
17
- * @param options - Additional application rendering options
18
- */
19
- constructor(playlist: PlaylistSoundConfig['playlist'], sound: Playlist.Sound, options: Partial<P>);
20
-
21
- playlist: Playlist;
22
-
23
- /**
24
- * @override
25
- * @defaultValue
26
- * ```typescript
27
- * mergeObject(super.defaultOptions, {
28
- * id: "track-config",
29
- * template: "templates/playlist/edit-track.html",
30
- * width: 360
31
- * });
32
- * ```
33
- */
34
- static get defaultOptions(): typeof FormApplication['defaultOptions'];
35
-
36
- /**
37
- * @override
38
- */
39
- get title(): string;
40
-
41
- /**
42
- * @param options - (unused)
43
- * @override
44
- */
45
- getData(options?: Partial<P>): PlaylistSoundConfig.Data;
46
-
47
- /**
48
- * @param event - (unused)
49
- * @override
50
- */
51
- protected _updateObject(event: Event, formData: PlaylistSoundConfig.FormData): Promise<Playlist>;
52
-
53
- /**
54
- * @override
55
- */
56
- activateListeners(html: JQuery): void;
57
-
58
- /**
59
- * Auto-populate the track name using the provided filename, if a name is not already set
60
- */
61
- protected _onSourceChange(event: JQuery.ChangeEvent): void;
62
- }
63
-
64
- declare namespace PlaylistSoundConfig {
65
- interface Data extends foundry.utils.Duplicated<PlaylistSoundConfig['object']> {
66
- lvolume: number;
67
- }
68
-
69
- type FormData = Pick<Data, 'lvolume'> & Pick<Playlist.Sound, 'name' | 'path' | 'repeat' | 'streaming'>;
70
- }
@@ -1,73 +0,0 @@
1
- /**
2
- * Tile Config Sheet
3
- * @typeParam P - the type of the options object
4
- */
5
- declare class TileConfig<P extends TileConfig.Options = TileConfig.Options> extends FormApplication<
6
- P,
7
- TileConfig.Data,
8
- Tile
9
- > {
10
- /**
11
- * @param tile - The Tile object being configured
12
- * @param options - Additional application rendering options
13
- */
14
- constructor(tile: Tile, options?: Partial<P>);
15
-
16
- /**
17
- * @override
18
- * @defaultValue
19
- * ```typescript
20
- * mergeObject(super.defaultOptions, {
21
- * id: "tile-config",
22
- * classes: ["sheet", "tile-sheet"],
23
- * title: "Tile Configuration",
24
- * template: "templates/scene/tile-config.html",
25
- * width: 400,
26
- * submitOnChange: true
27
- * });
28
- * ```
29
- */
30
- static get defaultOptions(): TileConfig.Options;
31
-
32
- /**
33
- * @param options - (unused)
34
- * @override
35
- */
36
- getData(options?: Partial<P>): TileConfig.Data;
37
-
38
- /** @override */
39
- protected _onChangeInput(event: JQuery.ChangeEvent): void;
40
-
41
- /**
42
- * @param event - (unused)
43
- * @override
44
- */
45
- protected _updateObject(event: Event, formData: TileConfig.FormData): Promise<Tile>;
46
-
47
- /** @override */
48
- close(options: Application.CloseOptions): Promise<void>;
49
- }
50
-
51
- declare namespace TileConfig {
52
- interface Data {
53
- object: foundry.utils.Duplicated<TileConfig['object']['data']>;
54
- options: TileConfig['options'];
55
- submitText: 'Create' | 'Update';
56
- }
57
-
58
- interface FormData {
59
- height: Tile.Data['height'] | null;
60
- img: Tile.Data['img'];
61
- rotation: Tile.Data['rotation'] | null;
62
- width: Tile.Data['width'] | null;
63
- x: Tile.Data['x'] | null;
64
- y: Tile.Data['y'] | null;
65
- }
66
-
67
- interface Options extends FormApplication.Options {
68
- /**
69
- * Configure a preview version of a tile which is not yet saved
70
- */
71
- preview?: boolean;
72
- }
73
- }