@league-of-foundry-developers/foundry-vtt-types 9.249.0 → 9.249.4

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 (121) hide show
  1. package/package.json +2 -2
  2. package/src/foundry/common/abstract/data.mjs.d.ts +2 -2
  3. package/src/foundry/common/abstract/document.mjs.d.ts +20 -9
  4. package/src/foundry/common/config.mjs/releaseData.d.ts +3 -1
  5. package/src/foundry/common/data/data.mjs/activeEffectData.d.ts +3 -1
  6. package/src/foundry/common/data/data.mjs/actorData.d.ts +1 -1
  7. package/src/foundry/common/data/data.mjs/adventureData.d.ts +14 -12
  8. package/src/foundry/common/data/data.mjs/ambientLightData.d.ts +5 -3
  9. package/src/foundry/common/data/data.mjs/ambientSoundData.d.ts +62 -16
  10. package/src/foundry/common/data/data.mjs/animationData.d.ts +13 -5
  11. package/src/foundry/common/data/data.mjs/cardData.d.ts +4 -4
  12. package/src/foundry/common/data/data.mjs/cardFaceData.d.ts +5 -3
  13. package/src/foundry/common/data/data.mjs/cardsData.d.ts +3 -3
  14. package/src/foundry/common/data/data.mjs/chatMessageData.d.ts +3 -1
  15. package/src/foundry/common/data/data.mjs/chatSpeakerData.d.ts +3 -1
  16. package/src/foundry/common/data/data.mjs/combatData.d.ts +3 -1
  17. package/src/foundry/common/data/data.mjs/combatantData.d.ts +3 -1
  18. package/src/foundry/common/data/data.mjs/darknessActivation.d.ts +3 -1
  19. package/src/foundry/common/data/data.mjs/drawingData.d.ts +3 -1
  20. package/src/foundry/common/data/data.mjs/effectChangeData.d.ts +3 -1
  21. package/src/foundry/common/data/data.mjs/effectDurationData.d.ts +3 -1
  22. package/src/foundry/common/data/data.mjs/fogExplorationData.d.ts +3 -1
  23. package/src/foundry/common/data/data.mjs/folderData.d.ts +3 -1
  24. package/src/foundry/common/data/data.mjs/journalEntryData.d.ts +3 -1
  25. package/src/foundry/common/data/data.mjs/lightData.d.ts +7 -5
  26. package/src/foundry/common/data/data.mjs/macroData.d.ts +3 -1
  27. package/src/foundry/common/data/data.mjs/measuredTemplateData.d.ts +3 -1
  28. package/src/foundry/common/data/data.mjs/noteData.d.ts +3 -1
  29. package/src/foundry/common/data/data.mjs/playlistData.d.ts +3 -1
  30. package/src/foundry/common/data/data.mjs/playlistSoundData.d.ts +3 -1
  31. package/src/foundry/common/data/data.mjs/prototypeTokenData.d.ts +6 -4
  32. package/src/foundry/common/data/data.mjs/rollTableData.d.ts +3 -1
  33. package/src/foundry/common/data/data.mjs/sceneData.d.ts +3 -1
  34. package/src/foundry/common/data/data.mjs/settingData.d.ts +3 -1
  35. package/src/foundry/common/data/data.mjs/tableResultData.d.ts +3 -1
  36. package/src/foundry/common/data/data.mjs/tileData.d.ts +4 -2
  37. package/src/foundry/common/data/data.mjs/tileOcclusion.d.ts +4 -2
  38. package/src/foundry/common/data/data.mjs/tokenBarData.d.ts +4 -2
  39. package/src/foundry/common/data/data.mjs/tokenData.d.ts +5 -3
  40. package/src/foundry/common/data/data.mjs/userData.d.ts +3 -1
  41. package/src/foundry/common/data/data.mjs/videoData.d.ts +4 -2
  42. package/src/foundry/common/data/data.mjs/wallData.d.ts +4 -2
  43. package/src/foundry/common/documents.mjs/baseActiveEffect.d.ts +15 -12
  44. package/src/foundry/common/documents.mjs/baseActor.d.ts +24 -21
  45. package/src/foundry/common/documents.mjs/baseAdventure.d.ts +14 -12
  46. package/src/foundry/common/documents.mjs/baseAmbientLight.d.ts +14 -11
  47. package/src/foundry/common/documents.mjs/baseAmbientSound.d.ts +14 -11
  48. package/src/foundry/common/documents.mjs/baseCard.d.ts +27 -28
  49. package/src/foundry/common/documents.mjs/baseCards.d.ts +18 -16
  50. package/src/foundry/common/documents.mjs/baseChatMessage.d.ts +24 -17
  51. package/src/foundry/common/documents.mjs/baseCombat.d.ts +21 -20
  52. package/src/foundry/common/documents.mjs/baseCombatant.d.ts +25 -18
  53. package/src/foundry/common/documents.mjs/baseDrawing.d.ts +26 -23
  54. package/src/foundry/common/documents.mjs/baseFogExploration.d.ts +19 -17
  55. package/src/foundry/common/documents.mjs/baseFolder.d.ts +14 -12
  56. package/src/foundry/common/documents.mjs/baseItem.d.ts +25 -19
  57. package/src/foundry/common/documents.mjs/baseJournalEntry.d.ts +16 -14
  58. package/src/foundry/common/documents.mjs/baseMacro.d.ts +21 -18
  59. package/src/foundry/common/documents.mjs/baseMeasuredTemplate.d.ts +34 -18
  60. package/src/foundry/common/documents.mjs/baseNote.d.ts +20 -14
  61. package/src/foundry/common/documents.mjs/basePlaylist.d.ts +16 -14
  62. package/src/foundry/common/documents.mjs/basePlaylistSound.d.ts +14 -11
  63. package/src/foundry/common/documents.mjs/baseRollTable.d.ts +16 -14
  64. package/src/foundry/common/documents.mjs/baseScene.d.ts +23 -21
  65. package/src/foundry/common/documents.mjs/baseSetting.d.ts +18 -16
  66. package/src/foundry/common/documents.mjs/baseTableResult.d.ts +27 -19
  67. package/src/foundry/common/documents.mjs/baseTile.d.ts +17 -11
  68. package/src/foundry/common/documents.mjs/baseToken.d.ts +20 -16
  69. package/src/foundry/common/documents.mjs/baseUser.d.ts +45 -11
  70. package/src/foundry/common/documents.mjs/baseWall.d.ts +17 -15
  71. package/src/foundry/common/packages.mjs/packageAuthorData.d.ts +3 -1
  72. package/src/foundry/common/packages.mjs/packageCompendiumData.d.ts +4 -2
  73. package/src/foundry/common/packages.mjs/packageData.d.ts +3 -4
  74. package/src/foundry/common/packages.mjs/packageDependencyData.d.ts +3 -1
  75. package/src/foundry/common/packages.mjs/packageLanguageData.d.ts +3 -1
  76. package/src/foundry/common/utils/primitives.mjs.d.ts +1 -1
  77. package/src/foundry/foundry.js/application.d.ts +1 -1
  78. package/src/foundry/foundry.js/applications/formApplications/documentSheets/ambientLightConfig.d.ts +2 -2
  79. package/src/foundry/foundry.js/applications/formApplications/documentSheets/itemSheet.d.ts +1 -1
  80. package/src/foundry/foundry.js/applications/formApplications/documentSheets/rollTableConfig.d.ts +1 -1
  81. package/src/foundry/foundry.js/applications/formApplications/entitySheetConfig.d.ts +2 -2
  82. package/src/foundry/foundry.js/applications/formApplications/tokenConfig.d.ts +1 -1
  83. package/src/foundry/foundry.js/applications/sidebarTabs/chatLog.d.ts +1 -1
  84. package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts +1 -1
  85. package/src/foundry/foundry.js/avSettings.d.ts +11 -0
  86. package/src/foundry/foundry.js/clientDocumentMixin.d.ts +36 -34
  87. package/src/foundry/foundry.js/clientDocuments/activeEffect.d.ts +1 -1
  88. package/src/foundry/foundry.js/clientDocuments/actor.d.ts +1 -1
  89. package/src/foundry/foundry.js/clientDocuments/chatMessage.d.ts +1 -1
  90. package/src/foundry/foundry.js/clientDocuments/combat.d.ts +5 -5
  91. package/src/foundry/foundry.js/clientDocuments/item.d.ts +2 -2
  92. package/src/foundry/foundry.js/clientDocuments/playlist.d.ts +1 -1
  93. package/src/foundry/foundry.js/clientDocuments/scene.d.ts +39 -38
  94. package/src/foundry/foundry.js/clientDocuments/user.d.ts +27 -35
  95. package/src/foundry/foundry.js/clientSettings.d.ts +1 -1
  96. package/src/foundry/foundry.js/collections/documentCollection.d.ts +65 -11
  97. package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts +78 -67
  98. package/src/foundry/foundry.js/collections/documentCollections/worldCollection.d.ts +73 -32
  99. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/actors.d.ts +3 -37
  100. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/combatEncounters.d.ts +5 -2
  101. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/fogExplorations.d.ts +0 -2
  102. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/folders.d.ts +1 -1
  103. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/items.d.ts +1 -22
  104. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/journal.d.ts +1 -1
  105. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/macros.d.ts +3 -8
  106. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/messages.d.ts +7 -2
  107. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/playlists.d.ts +5 -5
  108. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/rollTables.d.ts +1 -1
  109. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/scenes.d.ts +3 -2
  110. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/users.d.ts +7 -4
  111. package/src/foundry/foundry.js/collections/documentCollections/worldCollections/worldSettings.d.ts +2 -2
  112. package/src/foundry/foundry.js/hooks.d.ts +3 -3
  113. package/src/foundry/foundry.js/pixi/containers/ruler.d.ts +18 -7
  114. package/src/foundry/foundry.js/pixi/points/wallEndpoint.d.ts +1 -1
  115. package/src/foundry/foundry.js/pixi/polygons/pointSourcePolygons/clockwiseSweepPolygon.d.ts +1 -1
  116. package/src/foundry/foundry.js/pointSources/lightSource.d.ts +1 -1
  117. package/src/foundry/foundry.js/pointSources/soundSource.d.ts +1 -1
  118. package/src/foundry/foundry.js/pointSources/visionSource.d.ts +1 -1
  119. package/src/foundry/foundry.js/polygonEdge.d.ts +1 -1
  120. package/src/foundry/foundry.js/ray.d.ts +1 -1
  121. package/src/types/helperTypes.d.ts +31 -13
@@ -130,13 +130,15 @@ interface FolderDataConstructorData {
130
130
  flags?: ConfiguredFlags<'Folder'> | null | undefined;
131
131
  }
132
132
 
133
+ type FolderDataSource = PropertiesToSource<FolderDataProperties>;
134
+
133
135
  /**
134
136
  * The data schema for a Folder document.
135
137
  */
136
138
  export class FolderData extends DocumentData<
137
139
  FolderDataSchema,
138
140
  FolderDataProperties,
139
- PropertiesToSource<FolderDataProperties>,
141
+ FolderDataSource,
140
142
  FolderDataConstructorData,
141
143
  documents.BaseFolder
142
144
  > {
@@ -110,6 +110,8 @@ interface JournalEntryDataConstructorData {
110
110
  flags?: ConfiguredFlags<'JournalEntry'> | null | undefined;
111
111
  }
112
112
 
113
+ type JournalEntryDataSource = PropertiesToSource<JournalEntryDataProperties>;
114
+
113
115
  /**
114
116
  * The data schema for a JournalEntry document.
115
117
  * @see BaseJournalEntry
@@ -117,7 +119,7 @@ interface JournalEntryDataConstructorData {
117
119
  export class JournalEntryData extends DocumentData<
118
120
  JournalEntryDataSchema,
119
121
  JournalEntryDataProperties,
120
- PropertiesToSource<JournalEntryDataProperties>,
122
+ JournalEntryDataSource,
121
123
  JournalEntryDataConstructorData,
122
124
  documents.BaseJournalEntry
123
125
  > {
@@ -1,9 +1,9 @@
1
- import type { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes.js';
1
+ import type { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
2
2
  import { DocumentData } from '../../abstract/module.mjs';
3
3
  import * as documents from '../../documents.mjs';
4
4
  import * as fields from '../fields.mjs';
5
- import type { AnimationData, AnimationDataConstructorData } from './animationData.js';
6
- import type { DarknessActivation, DarknessActivationConstructorData } from './darknessActivation.js';
5
+ import type { AnimationData, AnimationDataConstructorData } from './animationData';
6
+ import type { DarknessActivation, DarknessActivationConstructorData } from './darknessActivation';
7
7
 
8
8
  interface LightDataSchema extends DocumentSchema {
9
9
  alpha: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
@@ -183,6 +183,8 @@ interface LightDataConstructorData {
183
183
  darkness?: DarknessActivationConstructorData | null | undefined;
184
184
  }
185
185
 
186
+ type LightDataSource = PropertiesToSource<LightDataProperties>;
187
+
186
188
  /**
187
189
  * A reusable document structure for the internal data used to render the appearance of a light source.
188
190
  * This is re-used by both the AmbientLightData and TokenData classes.
@@ -190,7 +192,7 @@ interface LightDataConstructorData {
190
192
  export class LightData extends DocumentData<
191
193
  LightDataSchema,
192
194
  LightDataProperties,
193
- PropertiesToSource<LightDataProperties>,
195
+ LightDataSource,
194
196
  LightDataConstructorData,
195
197
  documents.BaseAmbientLight | documents.BaseToken
196
198
  > {
@@ -203,7 +205,7 @@ export class LightData extends DocumentData<
203
205
  static LIGHT_UNIFORM_FIELD: LightData.LightUniformField;
204
206
 
205
207
  /** @override */
206
- _initializeSource(data: LightDataConstructorData): PropertiesToSource<LightDataProperties>;
208
+ _initializeSource(data: LightDataConstructorData): LightDataSource;
207
209
 
208
210
  /** @override */
209
211
  protected _initialize(): void;
@@ -171,6 +171,8 @@ interface MacroDataConstructorData {
171
171
  flags?: ConfiguredFlags<'Macro'> | null | undefined;
172
172
  }
173
173
 
174
+ type MacroDataSource = PropertiesToSource<MacroDataProperties>;
175
+
174
176
  /**
175
177
  * The data schema for a Macro document.
176
178
  * @see BaseMacro
@@ -178,7 +180,7 @@ interface MacroDataConstructorData {
178
180
  export class MacroData extends DocumentData<
179
181
  MacroDataSchema,
180
182
  MacroDataProperties,
181
- PropertiesToSource<MacroDataProperties>,
183
+ MacroDataSource,
182
184
  MacroDataConstructorData,
183
185
  documents.BaseMacro
184
186
  > {
@@ -180,6 +180,8 @@ interface MeasuredTemplateDataConstructorData {
180
180
  flags?: ConfiguredFlags<'MeasuredTemplate'> | null | undefined;
181
181
  }
182
182
 
183
+ type MeasuredTemplateDataSource = PropertiesToSource<MeasuredTemplateDataProperties>;
184
+
183
185
  /**
184
186
  * The data schema for a MeasuredTemplate embedded document.
185
187
  * @see BaseMeasuredTemplate
@@ -187,7 +189,7 @@ interface MeasuredTemplateDataConstructorData {
187
189
  export class MeasuredTemplateData extends DocumentData<
188
190
  MeasuredTemplateDataSchema,
189
191
  MeasuredTemplateDataProperties,
190
- PropertiesToSource<MeasuredTemplateDataProperties>,
192
+ MeasuredTemplateDataSource,
191
193
  MeasuredTemplateDataConstructorData,
192
194
  documents.BaseMeasuredTemplate
193
195
  > {
@@ -207,6 +207,8 @@ interface NoteDataConstructorData {
207
207
  flags?: ConfiguredFlags<'Note'> | null | undefined;
208
208
  }
209
209
 
210
+ type NoteDataSource = PropertiesToSource<NoteDataProperties>;
211
+
210
212
  /**
211
213
  * The data schema for a Note embedded document.
212
214
  * @see BaseNote
@@ -214,7 +216,7 @@ interface NoteDataConstructorData {
214
216
  export class NoteData extends DocumentData<
215
217
  NoteDataSchema,
216
218
  NoteDataProperties,
217
- PropertiesToSource<NoteDataProperties>,
219
+ NoteDataSource,
218
220
  NoteDataConstructorData,
219
221
  documents.BaseNote
220
222
  > {
@@ -181,6 +181,8 @@ interface PlaylistDataConstructorData {
181
181
  flags?: ConfiguredFlags<'Playlist'> | null | undefined;
182
182
  }
183
183
 
184
+ type PlaylistDataSource = PropertiesToSource<PlaylistDataProperties>;
185
+
184
186
  /**
185
187
  * The data schema for a Playlist document.
186
188
  * @see BasePlaylist
@@ -188,7 +190,7 @@ interface PlaylistDataConstructorData {
188
190
  export class PlaylistData extends DocumentData<
189
191
  PlaylistDataSchema,
190
192
  PlaylistDataProperties,
191
- PropertiesToSource<PlaylistDataProperties>,
193
+ PlaylistDataSource,
192
194
  PlaylistDataConstructorData,
193
195
  documents.BasePlaylist
194
196
  > {
@@ -137,6 +137,8 @@ interface PlaylistSoundDataConstructorData {
137
137
  flags?: ConfiguredFlags<'PlaylistSound'> | null | undefined;
138
138
  }
139
139
 
140
+ type PlaylistSoundDataSource = PropertiesToSource<PlaylistSoundDataProperties>;
141
+
140
142
  /**
141
143
  * The data schema for a PlaylistSound embedded document.
142
144
  * @see BasePlaylistSound
@@ -144,7 +146,7 @@ interface PlaylistSoundDataConstructorData {
144
146
  export class PlaylistSoundData extends DocumentData<
145
147
  PlaylistSoundDataSchema,
146
148
  PlaylistSoundDataProperties,
147
- PropertiesToSource<PlaylistSoundDataProperties>,
149
+ PlaylistSoundDataSource,
148
150
  PlaylistSoundDataConstructorData,
149
151
  documents.BasePlaylistSound
150
152
  > {
@@ -1,8 +1,8 @@
1
- import { FieldReturnType, PropertiesToSource, ToObjectFalseType } from '../../../../types/helperTypes.js';
1
+ import { FieldReturnType, PropertiesToSource, ToObjectFalseType } from '../../../../types/helperTypes';
2
2
  import DocumentData from '../../abstract/data.mjs';
3
- import { documents } from '../../module.mjs.js';
3
+ import { documents } from '../../module.mjs';
4
4
  import * as fields from '../fields.mjs';
5
- import { TokenDataConstructorData, TokenDataProperties, TokenDataSchema } from './tokenData.js';
5
+ import { TokenDataConstructorData, TokenDataProperties, TokenDataSchema } from './tokenData';
6
6
 
7
7
  type FieldExclusions =
8
8
  | '_id'
@@ -52,10 +52,12 @@ interface PrototypeTokenDataConstructorData extends Omit<TokenDataConstructorDat
52
52
  img?: string | null | undefined;
53
53
  }
54
54
 
55
+ type PrototypeTokenDataSource = PropertiesToSource<PrototypeTokenDataProperties>;
56
+
55
57
  export class PrototypeTokenData extends DocumentData<
56
58
  PrototypeTokenDataSchema,
57
59
  PrototypeTokenDataProperties,
58
- PropertiesToSource<PrototypeTokenDataProperties>,
60
+ PrototypeTokenDataSource,
59
61
  PrototypeTokenDataConstructorData,
60
62
  documents.BaseActor
61
63
  > {
@@ -162,6 +162,8 @@ interface RollTableDataConstructorData {
162
162
  flags?: ConfiguredFlags<'RollTable'> | null | undefined;
163
163
  }
164
164
 
165
+ type RollTableDataSource = PropertiesToSource<RollTableDataProperties>;
166
+
165
167
  /**
166
168
  * The data schema for an RollTable document.
167
169
  * @see BaseRollTable
@@ -169,7 +171,7 @@ interface RollTableDataConstructorData {
169
171
  export class RollTableData extends DocumentData<
170
172
  RollTableDataSchema,
171
173
  RollTableDataProperties,
172
- PropertiesToSource<RollTableDataProperties>,
174
+ RollTableDataSource,
173
175
  RollTableDataConstructorData,
174
176
  documents.BaseRollTable
175
177
  > {
@@ -629,6 +629,8 @@ interface SceneDataConstructorData {
629
629
  flags?: ConfiguredFlags<'Scene'> | null | undefined;
630
630
  }
631
631
 
632
+ type SceneDataSource = PropertiesToSource<SceneDataProperties>;
633
+
632
634
  /**
633
635
  * The data schema for a Scene document.
634
636
  * @see BaseScene
@@ -636,7 +638,7 @@ interface SceneDataConstructorData {
636
638
  export class SceneData extends DocumentData<
637
639
  SceneDataSchema,
638
640
  SceneDataProperties,
639
- PropertiesToSource<SceneDataProperties>,
641
+ SceneDataSource,
640
642
  SceneDataConstructorData,
641
643
  documents.BaseScene
642
644
  > {
@@ -52,6 +52,8 @@ interface SettingDataConstructorData {
52
52
  value: string | object;
53
53
  }
54
54
 
55
+ type SettingDataSource = PropertiesToSource<SettingDataProperties>;
56
+
55
57
  /**
56
58
  * The data schema for a Setting document.
57
59
  * @see BaseSetting
@@ -59,7 +61,7 @@ interface SettingDataConstructorData {
59
61
  export class SettingData extends DocumentData<
60
62
  SettingDataSchema,
61
63
  SettingDataProperties,
62
- PropertiesToSource<SettingDataProperties>,
64
+ SettingDataSource,
63
65
  SettingDataConstructorData,
64
66
  documents.BaseSetting
65
67
  > {
@@ -151,10 +151,12 @@ interface TableResultDataConstructorData {
151
151
  flags?: ConfiguredFlags<'TableResult'> | null | undefined;
152
152
  }
153
153
 
154
+ type TableResultDataSource = PropertiesToSource<TableResultDataProperties>;
155
+
154
156
  export class TableResultData extends DocumentData<
155
157
  TableResultDataSchema,
156
158
  TableResultDataProperties,
157
- PropertiesToSource<TableResultDataProperties>,
159
+ TableResultDataSource,
158
160
  TableResultDataConstructorData,
159
161
  BaseTableResult
160
162
  > {
@@ -224,6 +224,8 @@ interface TileDataConstructorData {
224
224
  flags?: ConfiguredFlags<'Tile'> | null | undefined;
225
225
  }
226
226
 
227
+ type TileDataSource = PropertiesToSource<TileDataProperties>;
228
+
227
229
  /**
228
230
  * The data schema for a Tile embedded document.
229
231
  * @see BaseTile
@@ -231,7 +233,7 @@ interface TileDataConstructorData {
231
233
  export class TileData extends DocumentData<
232
234
  TileDataSchema,
233
235
  TileDataProperties,
234
- PropertiesToSource<TileDataProperties>,
236
+ TileDataSource,
235
237
  TileDataConstructorData,
236
238
  documents.BaseTile
237
239
  > {
@@ -239,7 +241,7 @@ export class TileData extends DocumentData<
239
241
  static defineSchema(): TileDataSchema;
240
242
 
241
243
  /** @override */
242
- _initializeSource(data: TileDataConstructorData): PropertiesToSource<TileDataProperties>;
244
+ _initializeSource(data: TileDataConstructorData): TileDataSource;
243
245
  }
244
246
 
245
247
  // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -1,4 +1,4 @@
1
- import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes.js';
1
+ import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
2
2
  import { DocumentData } from '../../abstract/module.mjs';
3
3
  import { documents } from '../../module.mjs';
4
4
  import * as fields from '../fields.mjs';
@@ -43,13 +43,15 @@ interface TileOcclusionConstructorData {
43
43
  alpha?: number | null | undefined;
44
44
  }
45
45
 
46
+ type TileOcclusionSource = PropertiesToSource<TileOcclusionProperties>;
47
+
46
48
  /**
47
49
  * An inner-object which defines the schema for how Tile occlusion settings are defined
48
50
  */
49
51
  export class TileOcclusion extends DocumentData<
50
52
  TileOcclusionSchema,
51
53
  TileOcclusionProperties,
52
- PropertiesToSource<TileOcclusionProperties>,
54
+ TileOcclusionSource,
53
55
  TileOcclusionConstructorData,
54
56
  documents.BaseTile
55
57
  > {
@@ -1,4 +1,4 @@
1
- import { PropertiesToSource } from '../../../../types/helperTypes.js';
1
+ import { PropertiesToSource } from '../../../../types/helperTypes';
2
2
  import { DocumentData } from '../../abstract/module.mjs';
3
3
  import { documents } from '../../module.mjs';
4
4
 
@@ -27,6 +27,8 @@ interface TokenBarDataConstructorData {
27
27
  attribute?: string | null | undefined;
28
28
  }
29
29
 
30
+ type TokenBarDataSource = PropertiesToSource<TokenBarDataProperties>;
31
+
30
32
  /**
31
33
  * An embedded data structure for the contents of a Token attribute bar.
32
34
  * @see TokenData
@@ -34,7 +36,7 @@ interface TokenBarDataConstructorData {
34
36
  export class TokenBarData extends DocumentData<
35
37
  TokenBarDataSchema,
36
38
  TokenBarDataProperties,
37
- PropertiesToSource<TokenBarDataProperties>,
39
+ TokenBarDataSource,
38
40
  TokenBarDataConstructorData,
39
41
  documents.BaseToken
40
42
  > {
@@ -7,7 +7,7 @@ import {
7
7
  import DocumentData from '../../abstract/data.mjs';
8
8
  import { documents } from '../../module.mjs';
9
9
  import * as fields from '../fields.mjs';
10
- import { ActorDataSource } from './actorData.js';
10
+ import { ActorDataSource } from './actorData';
11
11
  import { LightData, LightDataConstructorData } from './lightData';
12
12
  import { TokenBarData, TokenBarDataConstructorData } from './tokenBarData';
13
13
 
@@ -472,13 +472,15 @@ interface TokenDataConstructorData {
472
472
  flags?: ConfiguredFlags<'Token'> | null | undefined;
473
473
  }
474
474
 
475
+ type TokenDataSource = PropertiesToSource<TokenDataProperties>;
476
+
475
477
  /**
476
478
  * The data schema for a Token document.
477
479
  */
478
480
  export class TokenData extends DocumentData<
479
481
  TokenDataSchema,
480
482
  TokenDataProperties,
481
- PropertiesToSource<TokenDataProperties>,
483
+ TokenDataSource,
482
484
  TokenDataConstructorData,
483
485
  documents.BaseToken
484
486
  > {
@@ -496,7 +498,7 @@ export class TokenData extends DocumentData<
496
498
  * This can be safely removed after several major versions have passed. Maybe V12?
497
499
  * @override
498
500
  */
499
- _initializeSource(data: TokenDataConstructorData): PropertiesToSource<TokenDataProperties>;
501
+ _initializeSource(data: TokenDataConstructorData): TokenDataSource;
500
502
 
501
503
  /** @override */
502
504
  protected _initialize(): void;
@@ -144,13 +144,15 @@ interface UserDataConstructorData {
144
144
  flags?: ConfiguredFlags<'User'> | null | undefined;
145
145
  }
146
146
 
147
+ type UserDataSource = PropertiesToSource<UserDataProperties>;
148
+
147
149
  /**
148
150
  * The data schema for a User document
149
151
  */
150
152
  export class UserData extends DocumentData<
151
153
  UserDataSchema,
152
154
  UserDataProperties,
153
- PropertiesToSource<UserDataProperties>,
155
+ UserDataSource,
154
156
  UserDataConstructorData,
155
157
  documents.BaseUser
156
158
  > {
@@ -1,4 +1,4 @@
1
- import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes.js';
1
+ import { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
2
2
  import { DocumentData } from '../../abstract/module.mjs';
3
3
  import { documents } from '../../module.mjs';
4
4
  import * as fields from '../fields.mjs';
@@ -49,13 +49,15 @@ interface VideoDataConstructorData {
49
49
  volume?: number | null | undefined;
50
50
  }
51
51
 
52
+ type VideoDataSource = PropertiesToSource<VideoDataProperties>;
53
+
52
54
  /**
53
55
  * An inner-object which defines the schema for how Tile video backgrounds are managed
54
56
  */
55
57
  export class VideoData extends DocumentData<
56
58
  VideoDataSchema,
57
59
  VideoDataProperties,
58
- PropertiesToSource<VideoDataProperties>,
60
+ VideoDataSource,
59
61
  VideoDataConstructorData,
60
62
  documents.BaseTile
61
63
  > {
@@ -192,6 +192,8 @@ interface WallDataConstructorData {
192
192
  flags?: ConfiguredFlags<'Wall'> | null | undefined;
193
193
  }
194
194
 
195
+ type WallDataSource = PropertiesToSource<WallDataProperties>;
196
+
195
197
  /**
196
198
  * The data schema for a Wall document.
197
199
  * @see BaseWall
@@ -199,7 +201,7 @@ interface WallDataConstructorData {
199
201
  export class WallData extends DocumentData<
200
202
  WallDataSchema,
201
203
  WallDataProperties,
202
- PropertiesToSource<WallDataProperties>,
204
+ WallDataSource,
203
205
  WallDataConstructorData,
204
206
  documents.BaseWall
205
207
  > {
@@ -215,7 +217,7 @@ export class WallData extends DocumentData<
215
217
  constructor(data: WallDataConstructorData, document?: documents.BaseWall | null);
216
218
 
217
219
  /** @override */
218
- _initializeSource(data?: WallDataConstructorData): PropertiesToSource<WallDataProperties>;
220
+ _initializeSource(data?: WallDataConstructorData): WallDataSource;
219
221
  }
220
222
 
221
223
  // eslint-disable-next-line @typescript-eslint/no-empty-interface
@@ -2,32 +2,35 @@ import { ConfiguredDocumentClass } from '../../../types/helperTypes';
2
2
  import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
3
3
  import { Document } from '../abstract/module.mjs';
4
4
  import * as data from '../data/data.mjs';
5
- import type { ActiveEffectDataConstructorData } from '../data/data.mjs/activeEffectData.js';
5
+ import type { ActiveEffectDataConstructorData } from '../data/data.mjs/activeEffectData';
6
6
  import { BaseActor } from './baseActor';
7
7
  import { BaseItem } from './baseItem';
8
8
  import { BaseUser } from './baseUser';
9
9
 
10
+ type ActiveEffectMetadata = Merge<
11
+ DocumentMetadata,
12
+ {
13
+ name: 'ActiveEffect';
14
+ collection: 'effects';
15
+ label: 'DOCUMENT.ActiveEffect';
16
+ labelPlural: 'DOCUMENT.ActiveEffects';
17
+ isEmbedded: true;
18
+ }
19
+ >;
20
+
10
21
  /**
11
22
  * The base ActiveEffect model definition which defines common behavior of an ActiveEffect document between both client and server.
12
23
  */
13
24
  export declare class BaseActiveEffect extends Document<
14
25
  data.ActiveEffectData,
15
- InstanceType<ConfiguredDocumentClass<typeof BaseActor>> | InstanceType<ConfiguredDocumentClass<typeof BaseItem>>
26
+ InstanceType<ConfiguredDocumentClass<typeof BaseActor>> | InstanceType<ConfiguredDocumentClass<typeof BaseItem>>,
27
+ ActiveEffectMetadata
16
28
  > {
17
29
  /** @override */
18
30
  static get schema(): ConstructorOf<data.ActiveEffectData>;
19
31
 
20
32
  /** @override */
21
- static get metadata(): Merge<
22
- DocumentMetadata,
23
- {
24
- name: 'ActiveEffect';
25
- collection: 'effects';
26
- label: 'DOCUMENT.ActiveEffect';
27
- labelPlural: 'DOCUMENT.ActiveEffects';
28
- isEmbedded: true;
29
- }
30
- >;
33
+ static get metadata(): ActiveEffectMetadata;
31
34
 
32
35
  /** @override */
33
36
  protected _preCreate(
@@ -2,42 +2,45 @@ import { ConfiguredDocumentClass } from '../../../types/helperTypes';
2
2
  import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
3
3
  import { Document } from '../abstract/module.mjs';
4
4
  import * as data from '../data/data.mjs';
5
- import type { ActorDataConstructorData } from '../data/data.mjs/actorData.js';
5
+ import type { ActorDataConstructorData } from '../data/data.mjs/actorData';
6
6
  import { BaseActiveEffect } from './baseActiveEffect';
7
7
  import { BaseItem } from './baseItem';
8
8
  import { BaseToken } from './baseToken';
9
9
  import { BaseUser } from './baseUser';
10
10
 
11
+ type ActorMetadata = Merge<
12
+ DocumentMetadata,
13
+ {
14
+ name: 'Actor';
15
+ collection: 'actors';
16
+ label: 'DOCUMENT.Actor';
17
+ labelPlural: 'DOCUMENT.Actors';
18
+ embedded: {
19
+ ActiveEffect: typeof BaseActiveEffect;
20
+ Item: typeof BaseItem;
21
+ };
22
+ isPrimary: true;
23
+ hasSystemData: true;
24
+ permissions: {
25
+ create: 'ACTOR_CREATE';
26
+ };
27
+ types: string[];
28
+ }
29
+ >;
30
+
11
31
  /**
12
32
  * The base Actor model definition which defines common behavior of an Actor document between both client and server.
13
33
  */
14
34
  export declare class BaseActor extends Document<
15
35
  data.ActorData,
16
- InstanceType<ConfiguredDocumentClass<typeof BaseToken>>
36
+ InstanceType<ConfiguredDocumentClass<typeof BaseToken>>,
37
+ ActorMetadata
17
38
  > {
18
39
  /** @override */
19
40
  static get schema(): typeof data.ActorData;
20
41
 
21
42
  /** @override */
22
- static get metadata(): Merge<
23
- DocumentMetadata,
24
- {
25
- name: 'Actor';
26
- collection: 'actors';
27
- label: 'DOCUMENT.Actor';
28
- labelPlural: 'DOCUMENT.Actors';
29
- embedded: {
30
- ActiveEffect: typeof BaseActiveEffect;
31
- Item: typeof BaseItem;
32
- };
33
- isPrimary: true;
34
- hasSystemData: true;
35
- permissions: {
36
- create: 'ACTOR_CREATE';
37
- };
38
- types: string[];
39
- }
40
- >;
43
+ static get metadata(): ActorMetadata;
41
44
  /*
42
45
  * A reference to the Collection of embedded ActiveEffect instances in the Actor document, indexed by _id.
43
46
  */
@@ -2,6 +2,18 @@ import { DocumentMetadata } from '../abstract/document.mjs';
2
2
  import { Document } from '../abstract/module.mjs';
3
3
  import * as data from '../data/data.mjs';
4
4
 
5
+ type AdventureMetadata = Merge<
6
+ DocumentMetadata,
7
+ {
8
+ name: 'Adventure';
9
+ collection: 'adventures';
10
+ label: 'DOCUMENT.Adventure';
11
+ labelPlural: 'DOCUMENT.Adventures';
12
+ isPrimary: false;
13
+ isEmbedded: false;
14
+ }
15
+ >;
16
+
5
17
  /**
6
18
  * The base Adventure model definition which defines common behavior of an Adventure document between both client and server.
7
19
  *
@@ -9,22 +21,12 @@ import * as data from '../data/data.mjs';
9
21
  * Until then it is for internal use only. Use this at your own risk.
10
22
  * @internal
11
23
  */
12
- export class BaseAdventure extends Document<data.AdventureData> {
24
+ export class BaseAdventure extends Document<data.AdventureData, null, AdventureMetadata> {
13
25
  /** @override */
14
26
  static get schema(): typeof data.AdventureData;
15
27
 
16
28
  /** @override */
17
- static get metadata(): Merge<
18
- DocumentMetadata,
19
- {
20
- name: 'Adventure';
21
- collection: 'adventures';
22
- label: 'DOCUMENT.Adventure';
23
- labelPlural: 'DOCUMENT.Adventures';
24
- isPrimary: false;
25
- isEmbedded: false;
26
- }
27
- >;
29
+ static get metadata(): AdventureMetadata;
28
30
 
29
31
  /**
30
32
  * A convenient reference to the file path of the Adventure's profile image.
@@ -4,27 +4,30 @@ import { Document } from '../abstract/module.mjs';
4
4
  import * as data from '../data/data.mjs';
5
5
  import { BaseScene } from './baseScene';
6
6
 
7
+ type AmbientLightMetadata = Merge<
8
+ DocumentMetadata,
9
+ {
10
+ name: 'AmbientLight';
11
+ collection: 'lights';
12
+ label: 'DOCUMENT.AmbientLight';
13
+ labelPlural: 'DOCUMENT.AmbientLights';
14
+ isEmbedded: true;
15
+ }
16
+ >;
17
+
7
18
  /**
8
19
  * The base AmbientLight model definition which defines common behavior of an AmbientLight document between both client and server.
9
20
  */
10
21
  export declare class BaseAmbientLight extends Document<
11
22
  data.AmbientLightData,
12
- InstanceType<ConfiguredDocumentClass<typeof BaseScene>>
23
+ InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
24
+ AmbientLightMetadata
13
25
  > {
14
26
  /** @override */
15
27
  static get schema(): typeof data.AmbientLightData;
16
28
 
17
29
  /** @override */
18
- static get metadata(): Merge<
19
- DocumentMetadata,
20
- {
21
- name: 'AmbientLight';
22
- collection: 'lights';
23
- label: 'DOCUMENT.AmbientLight';
24
- labelPlural: 'DOCUMENT.AmbientLights';
25
- isEmbedded: true;
26
- }
27
- >;
30
+ static get metadata(): AmbientLightMetadata;
28
31
 
29
32
  /** @override */
30
33
  protected _initialize(): void;