@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250718083253 → 13.346.0-beta.20250719181625

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 (41) hide show
  1. package/package.json +1 -1
  2. package/src/foundry/client/canvas/containers/advanced/cached-container.d.mts +15 -15
  3. package/src/foundry/client/canvas/containers/advanced/full-canvas-mixin.d.mts +2 -2
  4. package/src/foundry/client/canvas/containers/elements/control-icon.d.mts +12 -32
  5. package/src/foundry/client/canvas/containers/elements/cursor.d.mts +14 -1
  6. package/src/foundry/client/canvas/containers/elements/door-control.d.mts +2 -2
  7. package/src/foundry/client/canvas/containers/elements/door-mesh.d.mts +215 -3
  8. package/src/foundry/client/canvas/containers/elements/grid-highlight.d.mts +3 -3
  9. package/src/foundry/client/canvas/containers/elements/grid-mesh.d.mts +4 -4
  10. package/src/foundry/client/canvas/containers/elements/particles/leaves.d.mts +7 -6
  11. package/src/foundry/client/canvas/containers/elements/particles/particle-effect.d.mts +4 -5
  12. package/src/foundry/client/canvas/containers/elements/point-source-mesh.d.mts +18 -23
  13. package/src/foundry/client/canvas/containers/elements/precise-text.d.mts +9 -10
  14. package/src/foundry/client/canvas/containers/elements/quad-mesh.d.mts +1 -2
  15. package/src/foundry/client/canvas/containers/elements/resize-handle.d.mts +37 -11
  16. package/src/foundry/client/canvas/containers/elements/sprite-mesh.d.mts +34 -26
  17. package/src/foundry/client/canvas/layers/masks/depth.d.mts +1 -1
  18. package/src/foundry/client/canvas/layers/masks/occlusion.d.mts +1 -1
  19. package/src/foundry/client/canvas/primary/primary-canvas-container.d.mts +32 -0
  20. package/src/foundry/client/canvas/primary/primary-canvas-object.d.mts +39 -38
  21. package/src/foundry/client/canvas/primary/primary-graphics.d.mts +22 -18
  22. package/src/foundry/client/canvas/primary/primary-occludable-object.d.mts +59 -29
  23. package/src/foundry/client/canvas/primary/primary-particle-effect.d.mts +51 -0
  24. package/src/foundry/client/canvas/primary/primary-sprite-mesh.d.mts +72 -66
  25. package/src/foundry/client/config.d.mts +444 -311
  26. package/src/foundry/client/documents/collections/actors.d.mts +2 -2
  27. package/src/foundry/client/documents/collections/card-stacks.d.mts +2 -2
  28. package/src/foundry/client/documents/collections/chat-messages.d.mts +2 -2
  29. package/src/foundry/client/documents/collections/combat-encounters.d.mts +2 -2
  30. package/src/foundry/client/documents/collections/fog-explorations.d.mts +2 -2
  31. package/src/foundry/client/documents/collections/folders.d.mts +2 -2
  32. package/src/foundry/client/documents/collections/items.d.mts +2 -2
  33. package/src/foundry/client/documents/collections/journal.d.mts +2 -2
  34. package/src/foundry/client/documents/collections/macros.d.mts +2 -2
  35. package/src/foundry/client/documents/collections/playlists.d.mts +2 -2
  36. package/src/foundry/client/documents/collections/roll-tables.d.mts +2 -2
  37. package/src/foundry/client/documents/collections/scenes.d.mts +2 -2
  38. package/src/foundry/client/documents/collections/users.d.mts +2 -2
  39. package/src/foundry/client/documents/collections/world-settings.d.mts +2 -2
  40. package/src/foundry/client/documents/wall.d.mts +13 -2
  41. package/src/foundry/common/abstract/document.d.mts +22 -12
@@ -32,8 +32,8 @@ declare namespace Actors {
32
32
  interface Any extends AnyActors {}
33
33
  interface AnyConstructor extends Identity<typeof AnyActors> {}
34
34
 
35
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Actor"> {}
36
- interface Implementation extends Document.ConfiguredCollection<"Actor"> {}
35
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Actor"> {}
36
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Actor"> {}
37
37
 
38
38
  interface FromCompendiumOptions extends foundry.documents.abstract.WorldCollection.FromCompendiumOptions {
39
39
  /**
@@ -14,8 +14,8 @@ declare namespace CardStacks {
14
14
  interface Any extends AnyCardStacks {}
15
15
  interface AnyConstructor extends Identity<typeof AnyCardStacks> {}
16
16
 
17
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Cards"> {}
18
- interface Implementation extends Document.ConfiguredCollection<"Cards"> {}
17
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Cards"> {}
18
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Cards"> {}
19
19
 
20
20
  /**
21
21
  * @deprecated Replaced by {@linkcode CardStacks.ImplementationClass}.
@@ -37,8 +37,8 @@ declare namespace ChatMessages {
37
37
  interface Any extends AnyMessages {}
38
38
  interface AnyConstructor extends Identity<typeof AnyMessages> {}
39
39
 
40
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"ChatMessage"> {}
41
- interface Implementation extends Document.ConfiguredCollection<"ChatMessage"> {}
40
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"ChatMessage"> {}
41
+ interface Implementation extends Document.Internal.ConfiguredCollection<"ChatMessage"> {}
42
42
 
43
43
  /**
44
44
  * @deprecated Replaced by {@linkcode ChatMessages.ImplementationClass}.
@@ -45,8 +45,8 @@ declare namespace CombatEncounters {
45
45
  interface Any extends AnyCombatEncounters {}
46
46
  interface AnyConstructor extends Identity<typeof AnyCombatEncounters> {}
47
47
 
48
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Combat"> {}
49
- interface Implementation extends Document.ConfiguredCollection<"Combat"> {}
48
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Combat"> {}
49
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Combat"> {}
50
50
 
51
51
  /**
52
52
  * @deprecated Replaced by {@linkcode CombatEncounters.ImplementationClass}.
@@ -21,8 +21,8 @@ declare namespace FogExplorations {
21
21
  interface Any extends AnyFogExplorations {}
22
22
  interface AnyConstructor extends Identity<typeof AnyFogExplorations> {}
23
23
 
24
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"FogExploration"> {}
25
- interface Implementation extends Document.ConfiguredCollection<"FogExploration"> {}
24
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"FogExploration"> {}
25
+ interface Implementation extends Document.Internal.ConfiguredCollection<"FogExploration"> {}
26
26
 
27
27
  /**
28
28
  * @deprecated Replaced by {@linkcode FogExplorations.ImplementationClass}.
@@ -38,8 +38,8 @@ declare namespace Folders {
38
38
  interface Any extends AnyFolders {}
39
39
  interface AnyConstructor extends Identity<typeof AnyFolders> {}
40
40
 
41
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Folder"> {}
42
- interface Implementation extends Document.ConfiguredCollection<"Folder"> {}
41
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Folder"> {}
42
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Folder"> {}
43
43
 
44
44
  /**
45
45
  * @deprecated Replaced by {@linkcode Folders.ImplementationClass}.
@@ -16,8 +16,8 @@ declare namespace Items {
16
16
  interface Any extends AnyItems {}
17
17
  interface AnyConstructor extends Identity<typeof AnyItems> {}
18
18
 
19
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Item"> {}
20
- interface Implementation extends Document.ConfiguredCollection<"Item"> {}
19
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Item"> {}
20
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Item"> {}
21
21
 
22
22
  /**
23
23
  * @deprecated Replaced by {@linkcode Items.ImplementationClass}.
@@ -67,8 +67,8 @@ declare namespace Journal {
67
67
  interface Any extends AnyJournal {}
68
68
  interface AnyConstructor extends Identity<typeof AnyJournal> {}
69
69
 
70
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"JournalEntry"> {}
71
- interface Implementation extends Document.ConfiguredCollection<"JournalEntry"> {}
70
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"JournalEntry"> {}
71
+ interface Implementation extends Document.Internal.ConfiguredCollection<"JournalEntry"> {}
72
72
 
73
73
  /**
74
74
  * @deprecated Replaced by {@linkcode Journal.ImplementationClass}.
@@ -23,8 +23,8 @@ declare namespace Macros {
23
23
  interface Any extends AnyMacros {}
24
24
  interface AnyConstructor extends Identity<typeof AnyMacros> {}
25
25
 
26
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Macro"> {}
27
- interface Implementation extends Document.ConfiguredCollection<"Macro"> {}
26
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Macro"> {}
27
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Macro"> {}
28
28
 
29
29
  /**
30
30
  * @deprecated Replaced by {@linkcode Macros.ImplementationClass}.
@@ -34,8 +34,8 @@ declare namespace Playlists {
34
34
  interface Any extends AnyPlaylists {}
35
35
  interface AnyConstructor extends Identity<typeof AnyPlaylists> {}
36
36
 
37
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Playlist"> {}
38
- interface Implementation extends Document.ConfiguredCollection<"Playlist"> {}
37
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Playlist"> {}
38
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Playlist"> {}
39
39
 
40
40
  /**
41
41
  * @deprecated Replaced by {@linkcode Playlists.ImplementationClass}.
@@ -23,8 +23,8 @@ declare namespace RollTables {
23
23
  interface Any extends AnyRollTables {}
24
24
  interface AnyConstructor extends Identity<typeof AnyRollTables> {}
25
25
 
26
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"RollTable"> {}
27
- interface Implementation extends Document.ConfiguredCollection<"RollTable"> {}
26
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"RollTable"> {}
27
+ interface Implementation extends Document.Internal.ConfiguredCollection<"RollTable"> {}
28
28
 
29
29
  /**
30
30
  * @deprecated Replaced by {@linkcode RollTables.ImplementationClass}.
@@ -52,8 +52,8 @@ declare namespace Scenes {
52
52
  interface Any extends AnyScenes {}
53
53
  interface AnyConstructor extends Identity<typeof AnyScenes> {}
54
54
 
55
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Scene"> {}
56
- interface Implementation extends Document.ConfiguredCollection<"Scene"> {}
55
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Scene"> {}
56
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Scene"> {}
57
57
 
58
58
  /**
59
59
  * @deprecated Replaced by {@linkcode Scenes.ImplementationClass}.
@@ -61,8 +61,8 @@ declare namespace Users {
61
61
  interface Any extends AnyUsers {}
62
62
  interface AnyConstructor extends Identity<typeof AnyUsers> {}
63
63
 
64
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"User"> {}
65
- interface Implementation extends Document.ConfiguredCollection<"User"> {}
64
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"User"> {}
65
+ interface Implementation extends Document.Internal.ConfiguredCollection<"User"> {}
66
66
 
67
67
  /**
68
68
  * @deprecated Replaced by {@linkcode Users.ImplementationClass}.
@@ -33,8 +33,8 @@ declare namespace WorldSettings {
33
33
  interface Any extends AnyWorldSettings {}
34
34
  interface AnyConstructor extends Identity<typeof AnyWorldSettings> {}
35
35
 
36
- interface ImplementationClass extends Document.ConfiguredCollectionClass<"Setting"> {}
37
- interface Implementation extends Document.ConfiguredCollection<"Setting"> {}
36
+ interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Setting"> {}
37
+ interface Implementation extends Document.Internal.ConfiguredCollection<"Setting"> {}
38
38
 
39
39
  /**
40
40
  * @deprecated Replaced by {@linkcode GlobalLightSource.ImplementationClass}.
@@ -1,4 +1,4 @@
1
- import type { InexactPartial, Merge } from "#utils";
1
+ import type { InexactPartial, InterfaceToObject, Merge } from "#utils";
2
2
  import type Document from "#common/abstract/document.d.mts";
3
3
  import type { DataSchema } from "#common/data/fields.d.mts";
4
4
  import type BaseWall from "#common/documents/wall.mjs";
@@ -211,6 +211,7 @@ declare namespace WallDocument {
211
211
  type: fields.StringField<{ initial: "swing"; blank: true }>;
212
212
  }
213
213
 
214
+ /** @remarks See {@linkcode foundry.canvas.containers.DoorMesh.AnimationConfiguration} */
214
215
  interface AnimationData extends fields.SchemaField.InitializedData<AnimationSchema> {}
215
216
 
216
217
  /**
@@ -388,7 +389,17 @@ declare namespace WallDocument {
388
389
  * An object of optional key/value flags
389
390
  * @defaultValue `{}`
390
391
  */
391
- flags: fields.DocumentFlagsField<Name>;
392
+ flags: fields.DocumentFlagsField<Name, InterfaceToObject<CoreFlags>>;
393
+ }
394
+
395
+ interface CoreFlags {
396
+ core?: {
397
+ /** @remarks Checked in `DoorMesh##getClosedPosition` */
398
+ textureGridSize?: number;
399
+
400
+ /** @remarks Checked in `DoorMesh##getClosedPosition` */
401
+ elevation?: number;
402
+ };
392
403
  }
393
404
 
394
405
  namespace Database {
@@ -1092,18 +1092,6 @@ declare namespace Document {
1092
1092
 
1093
1093
  type WorldCollectionFor<Name extends Document.WorldType> = _WorldCollectionMap[Name];
1094
1094
 
1095
- // Note(LukeAbby): Will be updated with the CONFIG revamp.
1096
- type ConfiguredCollectionClass<Name extends Document.Type> = CONFIG extends {
1097
- readonly [K in Name]: {
1098
- readonly documentClass?: infer DocumentClass;
1099
- };
1100
- }
1101
- ? DocumentClass
1102
- : never;
1103
-
1104
- // Note(LukeAbby): Will be updated with the CONFIG revamp.
1105
- type ConfiguredCollection<Name extends Document.Type> = FixedInstanceType<ConfiguredCollectionClass<Name>>;
1106
-
1107
1095
  type IsParentOf<
1108
1096
  ParentDocument extends Document.Internal.Instance.Any,
1109
1097
  ChildDocument extends Document.Internal.Instance.Any,
@@ -1341,6 +1329,18 @@ declare namespace Document {
1341
1329
  // The type `{}` is useful here because in an intersection it reduces down to nothing unlike `EmptyObject`.
1342
1330
  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
1343
1331
  type ConfiguredFlagsForName<Name extends Type> = GetKey<FlagConfig, Name, {}>;
1332
+
1333
+ // Note(LukeAbby): Will be updated with the CONFIG revamp.
1334
+ type ConfiguredCollectionClass<Name extends Document.Type> = CONFIG extends {
1335
+ readonly [K in Name]: {
1336
+ readonly documentClass?: infer DocumentClass;
1337
+ };
1338
+ }
1339
+ ? DocumentClass
1340
+ : never;
1341
+
1342
+ // Note(LukeAbby): Will be updated with the CONFIG revamp.
1343
+ type ConfiguredCollection<Name extends Document.Type> = FixedInstanceType<ConfiguredCollectionClass<Name>>;
1344
1344
  }
1345
1345
 
1346
1346
  /** Any Document, that is a child of the given parent Document. */
@@ -2739,4 +2739,14 @@ declare namespace Document {
2739
2739
  ? D
2740
2740
  : // eslint-disable-next-line @typescript-eslint/no-deprecated
2741
2741
  Stored<D>;
2742
+
2743
+ /**
2744
+ * @deprecated This has been removed without replacement. If you have a need for it please let us know.
2745
+ */
2746
+ type ConfiguredCollectionClass<Name extends Document.Type> = Document.Internal.ConfiguredCollectionClass<Name>;
2747
+
2748
+ /**
2749
+ * @deprecated This has been removed without replacement. If you have a need for it please let us know.
2750
+ */
2751
+ type ConfiguredCollection<Name extends Document.Type> = Document.Internal.ConfiguredCollection<Name>;
2742
2752
  }