@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250717163058 → 13.346.0-beta.20250718082453

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "$schema": "https://json.schemastore.org/package.json",
3
3
  "name": "@league-of-foundry-developers/foundry-vtt-types",
4
- "version": "13.346.0-beta.20250717163058",
4
+ "version": "13.346.0-beta.20250718082453",
5
5
  "description": "TypeScript type definitions for Foundry VTT",
6
6
  "type": "module",
7
7
  "types": "./src/index.d.mts",
@@ -217,7 +217,8 @@ declare namespace SceneControls {
217
217
 
218
218
  type EmittedEvents = [...ApplicationV2.EmittedEvents, "activate"];
219
219
 
220
- interface ActivateOptions extends Pick<SceneControls.RenderOptions, "event" | "control" | "tool" | "toggles"> {}
220
+ interface ActivateOptions
221
+ extends Pick<DeepPartial<SceneControls.RenderOptions>, "event" | "control" | "tool" | "toggles"> {}
221
222
  }
222
223
 
223
224
  declare abstract class AnySceneControls extends SceneControls<
@@ -64,7 +64,7 @@ declare abstract class DocumentSheet<
64
64
 
65
65
  override getData(
66
66
  options?: Partial<Options>,
67
- ): MaybePromise<GetDataReturnType<DocumentSheet.DocumentSheetData<Options, ConcreteDocument>>>;
67
+ ): MaybePromise<GetDataReturnType<DocumentSheet.Data<Options, ConcreteDocument>>>;
68
68
 
69
69
  protected override _activateCoreListeners(html: JQuery<HTMLElement>): void;
70
70
 
@@ -130,7 +130,7 @@ declare namespace DocumentSheet {
130
130
  interface Any extends AnyDocumentSheet {}
131
131
  interface AnyConstructor extends Identity<typeof AnyDocumentSheet> {}
132
132
 
133
- interface DocumentSheetData<
133
+ interface Data<
134
134
  Options extends DocumentSheet.Options<ConcreteDocument>,
135
135
  ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
136
136
  > extends FormApplication.FormApplicationData {
@@ -154,6 +154,14 @@ declare namespace DocumentSheet {
154
154
  /** An array of {@linkcode HTMLSecret} configuration objects. */
155
155
  secrets: HTMLSecret.Configuration<ConcreteDocument>[];
156
156
  }
157
+
158
+ /**
159
+ * @deprecated Replaced with {@linkcode JournalPageSheet.Data}.
160
+ */
161
+ type DocumentSheetData<
162
+ Options extends DocumentSheet.Options<ConcreteDocument>,
163
+ ConcreteDocument extends foundry.abstract.Document.Any = foundry.abstract.Document.Any,
164
+ > = Data<Options, ConcreteDocument>;
157
165
  }
158
166
 
159
167
  declare abstract class AnyDocumentSheet extends DocumentSheet<
@@ -54,7 +54,7 @@ declare class ActorSheet<Options extends ActorSheet.Options = ActorSheet.Options
54
54
 
55
55
  override close(options?: FormApplication.CloseOptions): Promise<void>;
56
56
 
57
- override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<ActorSheet.ActorSheetData>>;
57
+ override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<ActorSheet.Data>>;
58
58
 
59
59
  protected override _getHeaderButtons(): Application.HeaderButton[];
60
60
 
@@ -179,12 +179,17 @@ declare namespace ActorSheet {
179
179
  token?: TokenDocument.Implementation | null;
180
180
  }
181
181
 
182
- interface ActorSheetData<Options extends ActorSheet.Options = ActorSheet.Options>
183
- extends DocumentSheet.DocumentSheetData<Options, Actor.Implementation> {
182
+ interface Data<Options extends ActorSheet.Options = ActorSheet.Options>
183
+ extends DocumentSheet.Data<Options, Actor.Implementation> {
184
184
  actor: ActorSheet["actor"];
185
185
  items: this["data"]["items"];
186
186
  effects: this["data"]["effects"];
187
187
  }
188
+
189
+ /**
190
+ * @deprecated Replaced with {@linkcode ActorSheet.Data}.
191
+ */
192
+ type ActorSheetData = Data;
188
193
  }
189
194
 
190
195
  declare abstract class AnyActorSheet extends ActorSheet<ActorSheet.Options> {
@@ -38,7 +38,7 @@ declare class AdventureImporter<
38
38
  */
39
39
  static override get defaultOptions(): AdventureImporter.Options;
40
40
 
41
- override getData(options?: Partial<Options>): Promise<GetDataReturnType<AdventureImporter.AdventureImporterData>>;
41
+ override getData(options?: Partial<Options>): Promise<GetDataReturnType<AdventureImporter.Data>>;
42
42
 
43
43
  override activateListeners(html: JQuery<HTMLElement>): void;
44
44
 
@@ -85,13 +85,18 @@ declare namespace AdventureImporter {
85
85
 
86
86
  interface Options extends DocumentSheet.Options<Adventure.Implementation> {}
87
87
 
88
- interface AdventureImporterData {
88
+ interface Data {
89
89
  adventure: Adventure.Implementation;
90
90
 
91
91
  contents: ReturnType<AdventureImporter["_getContentList"]>;
92
92
 
93
93
  imported: boolean;
94
94
  }
95
+
96
+ /**
97
+ * @deprecated Replaced with {@linkcode AdventureImporter.Data}.
98
+ */
99
+ type AdventureImporterData = Data;
95
100
  }
96
101
 
97
102
  declare abstract class AnyAdventureImporter extends AdventureImporter<AdventureImporter.Options> {
@@ -52,7 +52,7 @@ declare class ItemSheet<Options extends ItemSheet.Options = ItemSheet.Options> e
52
52
  */
53
53
  get actor(): this["item"]["actor"];
54
54
 
55
- override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<ItemSheet.ItemSheetData>>;
55
+ override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<ItemSheet.Data>>;
56
56
  }
57
57
 
58
58
  declare namespace ItemSheet {
@@ -60,9 +60,14 @@ declare namespace ItemSheet {
60
60
 
61
61
  interface Options extends DocumentSheet.Options<Item.Implementation> {}
62
62
 
63
- interface ItemSheetData<Options extends ItemSheet.Options = ItemSheet.Options>
64
- extends DocumentSheet.DocumentSheetData<Options, Item.Implementation> {
63
+ interface Data<Options extends ItemSheet.Options = ItemSheet.Options>
64
+ extends DocumentSheet.Data<Options, Item.Implementation> {
65
65
  item: this["document"];
66
66
  }
67
+
68
+ /**
69
+ * @deprecated Replaced with {@linkcode ItemSheet.Data}.
70
+ */
71
+ type ItemSheetData = Data;
67
72
  }
68
73
  export default ItemSheet;
@@ -44,7 +44,7 @@ declare class JournalPageSheet<
44
44
 
45
45
  toc: Record<string, JournalEntryPage.JournalEntryPageHeading>;
46
46
 
47
- override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<JournalPageSheet.JournalPageSheetData>>;
47
+ override getData(options?: Partial<Options>): MaybePromise<GetDataReturnType<JournalPageSheet.Data>>;
48
48
 
49
49
  protected override _renderInner(data: ReturnType<this["getData"]>): Promise<JQuery<HTMLElement>>;
50
50
 
@@ -79,9 +79,14 @@ declare namespace JournalPageSheet {
79
79
 
80
80
  interface Options extends DocumentSheet.Options<JournalEntryPage.Implementation> {}
81
81
 
82
- interface JournalPageSheetData extends DocumentSheet.DocumentSheetData<Options, JournalEntryPage.Implementation> {
82
+ interface Data extends DocumentSheet.Data<Options, JournalEntryPage.Implementation> {
83
83
  headingLevels: Record<number, string>;
84
84
  }
85
+
86
+ /**
87
+ * @deprecated Replaced with {@linkcode JournalPageSheet.Data}.
88
+ */
89
+ type JournalPageSheetData = Data;
85
90
  }
86
91
 
87
92
  /**
@@ -136,7 +141,7 @@ declare class JournalTextPageSheet extends JournalPageSheet {
136
141
  }
137
142
 
138
143
  declare namespace JournalTextPageSheet {
139
- interface TextData extends JournalPageSheet.JournalPageSheetData {
144
+ interface TextData extends JournalPageSheet.Data {
140
145
  editor: {
141
146
  engine: string;
142
147
  collaborate: boolean;
@@ -151,7 +156,7 @@ declare namespace JournalTextPageSheet {
151
156
  declare class JournalTextTinyMCESheet extends JournalTextPageSheet {
152
157
  override getData(
153
158
  options?: Partial<JournalPageSheet.Options>,
154
- ): Promise<GetDataReturnType<JournalTextTinyMCESheet.MCEData>>;
159
+ ): Promise<GetDataReturnType<JournalTextTinyMCESheet.Data>>;
155
160
 
156
161
  override close(options?: FormApplication.CloseOptions): Promise<void>;
157
162
 
@@ -165,7 +170,12 @@ declare namespace JournalTextTinyMCESheet {
165
170
  interface Any extends AnyJournalTextTinyMCESheet {}
166
171
  interface AnyConstructor extends Identity<typeof AnyJournalTextTinyMCESheet> {}
167
172
 
168
- interface MCEData extends JournalTextPageSheet.TextData {}
173
+ interface Data extends JournalTextPageSheet.TextData {}
174
+
175
+ /**
176
+ * @deprecated Replaced with {@linkcode JournalTextTinyMCESheet.Data}.
177
+ */
178
+ type MCEData = Data;
169
179
  }
170
180
 
171
181
  declare abstract class AnyJournalPageSheet extends JournalPageSheet<JournalPageSheet.Options> {