@league-of-foundry-developers/foundry-vtt-types 13.346.0-beta.20250705112003 → 13.346.0-beta.20250705133313

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 (84) hide show
  1. package/package.json +5 -3
  2. package/src/configuration/hooks.d.mts +1 -1
  3. package/src/foundry/client/applications/api/document-sheet.d.mts +8 -1
  4. package/src/foundry/client/applications/api/handlebars-application.d.mts +2 -2
  5. package/src/foundry/client/applications/sheets/ambient-light-config.d.mts +2 -2
  6. package/src/foundry/client/applications/sheets/region-behavior-config.d.mts +1 -1
  7. package/src/foundry/client/documents/abstract/document-collection.d.mts +6 -4
  8. package/src/foundry/client/documents/active-effect.d.mts +12 -5
  9. package/src/foundry/client/documents/actor-delta.d.mts +12 -5
  10. package/src/foundry/client/documents/actor.d.mts +12 -5
  11. package/src/foundry/client/documents/adventure.d.mts +12 -5
  12. package/src/foundry/client/documents/ambient-light.d.mts +12 -5
  13. package/src/foundry/client/documents/ambient-sound.d.mts +12 -5
  14. package/src/foundry/client/documents/card.d.mts +11 -6
  15. package/src/foundry/client/documents/cards.d.mts +13 -6
  16. package/src/foundry/client/documents/chat-message.d.mts +15 -8
  17. package/src/foundry/client/documents/collections/compendium-collection.d.mts +2 -0
  18. package/src/foundry/client/documents/combat.d.mts +12 -5
  19. package/src/foundry/client/documents/combatant-group.d.mts +12 -5
  20. package/src/foundry/client/documents/combatant.d.mts +12 -5
  21. package/src/foundry/client/documents/drawing.d.mts +12 -5
  22. package/src/foundry/client/documents/fog-exploration.d.mts +12 -5
  23. package/src/foundry/client/documents/folder.d.mts +13 -6
  24. package/src/foundry/client/documents/item.d.mts +10 -5
  25. package/src/foundry/client/documents/journal-entry-category.d.mts +12 -5
  26. package/src/foundry/client/documents/journal-entry-page.d.mts +12 -5
  27. package/src/foundry/client/documents/journal-entry.d.mts +12 -5
  28. package/src/foundry/client/documents/macro.d.mts +12 -5
  29. package/src/foundry/client/documents/measured-template.d.mts +12 -5
  30. package/src/foundry/client/documents/note.d.mts +12 -5
  31. package/src/foundry/client/documents/playlist-sound.d.mts +12 -5
  32. package/src/foundry/client/documents/playlist.d.mts +12 -5
  33. package/src/foundry/client/documents/region-behavior.d.mts +12 -5
  34. package/src/foundry/client/documents/region.d.mts +12 -5
  35. package/src/foundry/client/documents/roll-table.d.mts +13 -6
  36. package/src/foundry/client/documents/scene.d.mts +12 -5
  37. package/src/foundry/client/documents/setting.d.mts +8 -1
  38. package/src/foundry/client/documents/table-result.d.mts +12 -5
  39. package/src/foundry/client/documents/tile.d.mts +12 -5
  40. package/src/foundry/client/documents/token.d.mts +15 -12
  41. package/src/foundry/client/documents/user.d.mts +10 -5
  42. package/src/foundry/client/documents/wall.d.mts +12 -5
  43. package/src/foundry/client/helpers/client-settings.d.mts +7 -3
  44. package/src/foundry/common/abstract/document.d.mts +98 -50
  45. package/src/foundry/common/abstract/type-data.d.mts +35 -10
  46. package/src/foundry/common/data/data.d.mts +2 -2
  47. package/src/foundry/common/data/fields.d.mts +71 -59
  48. package/src/foundry/common/documents/active-effect.d.mts +6 -5
  49. package/src/foundry/common/documents/actor-delta.d.mts +6 -5
  50. package/src/foundry/common/documents/actor.d.mts +6 -5
  51. package/src/foundry/common/documents/adventure.d.mts +6 -5
  52. package/src/foundry/common/documents/ambient-light.d.mts +6 -5
  53. package/src/foundry/common/documents/ambient-sound.d.mts +6 -5
  54. package/src/foundry/common/documents/card.d.mts +6 -5
  55. package/src/foundry/common/documents/cards.d.mts +6 -5
  56. package/src/foundry/common/documents/chat-message.d.mts +6 -5
  57. package/src/foundry/common/documents/combat.d.mts +6 -5
  58. package/src/foundry/common/documents/combatant-group.d.mts +6 -5
  59. package/src/foundry/common/documents/combatant.d.mts +6 -5
  60. package/src/foundry/common/documents/drawing.d.mts +6 -5
  61. package/src/foundry/common/documents/fog-exploration.d.mts +6 -5
  62. package/src/foundry/common/documents/folder.d.mts +6 -5
  63. package/src/foundry/common/documents/item.d.mts +6 -5
  64. package/src/foundry/common/documents/journal-entry-category.d.mts +6 -5
  65. package/src/foundry/common/documents/journal-entry-page.d.mts +6 -5
  66. package/src/foundry/common/documents/journal-entry.d.mts +6 -5
  67. package/src/foundry/common/documents/macro.d.mts +6 -5
  68. package/src/foundry/common/documents/measured-template.d.mts +6 -5
  69. package/src/foundry/common/documents/note.d.mts +6 -5
  70. package/src/foundry/common/documents/playlist-sound.d.mts +6 -5
  71. package/src/foundry/common/documents/playlist.d.mts +6 -5
  72. package/src/foundry/common/documents/region-behavior.d.mts +6 -5
  73. package/src/foundry/common/documents/region.d.mts +6 -5
  74. package/src/foundry/common/documents/roll-table.d.mts +6 -5
  75. package/src/foundry/common/documents/scene.d.mts +6 -5
  76. package/src/foundry/common/documents/setting.d.mts +4 -3
  77. package/src/foundry/common/documents/table-result.d.mts +6 -5
  78. package/src/foundry/common/documents/tile.d.mts +6 -5
  79. package/src/foundry/common/documents/token.d.mts +6 -5
  80. package/src/foundry/common/documents/user.d.mts +6 -5
  81. package/src/foundry/common/documents/wall.d.mts +6 -5
  82. package/src/foundry/common/packages/base-world.d.mts +31 -29
  83. package/src/types/augments/pixi.d.mts +4 -0
  84. package/tsconfig.json +1 -4
@@ -14,6 +14,7 @@ import type {
14
14
  SplitString,
15
15
  ValueOf,
16
16
  AnyMutableObject,
17
+ ConcreteKeys,
17
18
  } from "#utils";
18
19
  import type { DataModel } from "../abstract/data.mts";
19
20
  import type Document from "../abstract/document.mts";
@@ -536,7 +537,7 @@ declare namespace DataField {
536
537
  }
537
538
 
538
539
  /**
539
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
540
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
540
541
  * for more details.
541
542
  */
542
543
  type AssignmentTypeFor<ConcreteDataField extends Any> =
@@ -644,7 +645,7 @@ declare namespace DataField {
644
645
  * @template BaseAssignmentType - the base assignment type of the DataField, without null or undefined
645
646
  * @template Options - the options of the DataField
646
647
  *
647
- * @deprecated - This type is being phased out alongside the entirety of the concept of the
648
+ * @deprecated This type is being phased out alongside the entirety of the concept of the
648
649
  * `Assignment` type.
649
650
  */
650
651
  type DerivedAssignmentType<BaseAssignmentType, Options extends DataField.Options.Any> =
@@ -691,7 +692,7 @@ declare namespace DataField {
691
692
  * A shorthand for the assignment type of a DataField class.
692
693
  * @template Options - the options overriding the defaults
693
694
  *
694
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
695
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
695
696
  * for more details.
696
697
  */
697
698
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -1389,7 +1390,7 @@ declare namespace BooleanField {
1389
1390
  * A shorthand for the assignment type of a BooleanField class.
1390
1391
  * @template Opts - the options that override the default options
1391
1392
  *
1392
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
1393
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
1393
1394
  * for more details.
1394
1395
  */
1395
1396
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -1622,7 +1623,7 @@ declare namespace NumberField {
1622
1623
  * A shorthand for the assignment type of a NumberField class.
1623
1624
  * @template Options - the options that override the default options
1624
1625
  *
1625
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
1626
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
1626
1627
  * for more details.
1627
1628
  */
1628
1629
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -1858,7 +1859,7 @@ declare namespace StringField {
1858
1859
  SimpleMerge<Options, { initial: _InitialForOptions<Options> }>;
1859
1860
 
1860
1861
  /**
1861
- * @deprecated - Foundry no longer directly modifies the options for `initial`, it uses `getInitialValue` for this purpose instead.
1862
+ * @deprecated Foundry no longer directly modifies the options for `initial`, it uses `getInitialValue` for this purpose instead.
1862
1863
  * @internal
1863
1864
  */
1864
1865
  type _InitialForOptions<Options extends StringField.Options<unknown>> = Options["required"] extends false | undefined
@@ -1885,7 +1886,7 @@ declare namespace StringField {
1885
1886
  * A shorthand for the assignment type of a StringField class.
1886
1887
  * @template Options - the options that override the default options
1887
1888
  *
1888
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
1889
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
1889
1890
  * for more details.
1890
1891
  */
1891
1892
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -2017,7 +2018,7 @@ declare namespace ObjectField {
2017
2018
  * A shorthand for the assignment type of a ObjectField class.
2018
2019
  * @template Options - the options that override the default options
2019
2020
  *
2020
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2021
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2021
2022
  * for more details.
2022
2023
  */
2023
2024
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -2154,7 +2155,7 @@ declare namespace TypedObjectField {
2154
2155
  * A shorthand for the assignment type of a ObjectField class.
2155
2156
  * @template Options - the options that override the default options
2156
2157
  *
2157
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2158
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2158
2159
  * for more details.
2159
2160
  */
2160
2161
  type AssignmentType<
@@ -2439,7 +2440,7 @@ declare namespace ArrayField {
2439
2440
  * A type to infer the assignment element type of an ArrayField from its ElementFieldType.
2440
2441
  * @template ElementFieldType - the DataField type of the elements in the ArrayField
2441
2442
  *
2442
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2443
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2443
2444
  * for more details.
2444
2445
  */
2445
2446
  type AssignmentElementType<ElementFieldType extends DataField.Any | Document.AnyConstructor> =
@@ -2476,7 +2477,7 @@ declare namespace ArrayField {
2476
2477
  * @template AssignmentElementType - the assignment type of the elements of the ArrayField
2477
2478
  * @template Opts - the options that override the default options
2478
2479
  *
2479
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2480
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2480
2481
  * for more details.
2481
2482
  */
2482
2483
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -2604,7 +2605,7 @@ declare namespace SetField {
2604
2605
  * The base assignment type for the {@linkcode SetField} class.
2605
2606
  * @template AssignmentElementType - the assignment type of the elements in the array
2606
2607
  *
2607
- * @deprecated - Assignment type is being deprecated.
2608
+ * @deprecated Assignment type is being deprecated.
2608
2609
  */
2609
2610
  type BaseAssignmentType<AssignmentElementType> = ArrayField.BaseAssignmentType<AssignmentElementType>;
2610
2611
 
@@ -2625,7 +2626,7 @@ declare namespace SetField {
2625
2626
  * @template AssignmentElementType - the assignment type of the elements of the SetField
2626
2627
  * @template Opts - the options that override the default options
2627
2628
  *
2628
- * @deprecated - AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2629
+ * @deprecated AssignmentData is being phased out. See {@linkcode SchemaField.AssignmentData}
2629
2630
  * for more details.
2630
2631
  */
2631
2632
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -2759,7 +2760,7 @@ declare namespace EmbeddedDataField {
2759
2760
  * @template ModelType - the DataModel for the embedded data
2760
2761
  * @template Opts - the options that override the default options
2761
2762
  *
2762
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
2763
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
2763
2764
  * for more details.
2764
2765
  */
2765
2766
  type AssignmentType<
@@ -2977,7 +2978,7 @@ declare namespace EmbeddedCollectionField {
2977
2978
  * A type to infer the assignment element type of an EmbeddedCollectionField from its ElementFieldType.
2978
2979
  * @template ElementFieldType - the DataField type of the elements in the EmbeddedCollectionField
2979
2980
  *
2980
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
2981
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
2981
2982
  * for more details.
2982
2983
  */
2983
2984
  // Note(LukeAbby): For some reason checking `extends Document` causes issues where this doesn't.
@@ -3010,7 +3011,7 @@ declare namespace EmbeddedCollectionField {
3010
3011
  * @template AssignmentElementType - the assignment type of the elements of the EmbeddedCollectionField
3011
3012
  * @template Opts - the options that override the default options
3012
3013
  *
3013
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3014
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3014
3015
  * for more details.
3015
3016
  */
3016
3017
  type AssignmentType<
@@ -3145,7 +3146,7 @@ declare namespace EmbeddedCollectionDeltaField {
3145
3146
  * A type to infer the assignment element type of an EmbeddedCollectionDeltaField from its ElementFieldType.
3146
3147
  * @template ElementFieldType - the DataField type of the elements in the EmbeddedCollectionDeltaField
3147
3148
  *
3148
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3149
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3149
3150
  * for more details.
3150
3151
  */
3151
3152
  type AssignmentElementType<ElementFieldType extends Document.AnyConstructor> = ElementFieldType extends abstract new (
@@ -3177,7 +3178,7 @@ declare namespace EmbeddedCollectionDeltaField {
3177
3178
  * @template AssignmentElementType - the assignment type of the elements of the EmbeddedCollectionDeltaField
3178
3179
  * @template Opts - the options that override the default options
3179
3180
  *
3180
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3181
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3181
3182
  * for more details.
3182
3183
  */
3183
3184
  type AssignmentType<
@@ -3303,7 +3304,7 @@ declare namespace EmbeddedDocumentField {
3303
3304
  * @template DocumentType - the type of the embedded Document
3304
3305
  * @template Opts - the options that override the default options
3305
3306
  *
3306
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3307
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3307
3308
  * for more details.
3308
3309
  */
3309
3310
  type AssignmentType<
@@ -3414,7 +3415,7 @@ declare namespace DocumentIdField {
3414
3415
  * A shorthand for the assignment type of a StringField class.
3415
3416
  * @template Options - the options that override the default options
3416
3417
  *
3417
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3418
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3418
3419
  * for more details.
3419
3420
  */
3420
3421
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -3621,14 +3622,18 @@ declare namespace ForeignDocumentField {
3621
3622
  * A shorthand for the assignment type of a ForeignDocumentField class.
3622
3623
  * @template Opts - the options that override the default options
3623
3624
  *
3624
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3625
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3625
3626
  * for more details.
3626
3627
  */
3627
3628
  type AssignmentType<
3628
3629
  ConcreteDocument extends Document.AnyConstructor,
3629
3630
  Opts extends Options,
3630
3631
  // eslint-disable-next-line @typescript-eslint/no-deprecated
3631
- > = DataField.DerivedAssignmentType<string | Document.ToConfiguredInstance<ConcreteDocument>, MergedOptions<Opts>>;
3632
+ > = DataField.DerivedAssignmentType<
3633
+ // TODO(LukeAbby): This should require a document uuid.
3634
+ string | Document.StoredForName<ConcreteDocument["documentName"]>,
3635
+ MergedOptions<Opts>
3636
+ >;
3632
3637
 
3633
3638
  /**
3634
3639
  * A shorthand for the initialized type of a ForeignDocumentField class.
@@ -3638,7 +3643,7 @@ declare namespace ForeignDocumentField {
3638
3643
  ConcreteDocument extends Document.AnyConstructor,
3639
3644
  Opts extends Options,
3640
3645
  > = DataField.DerivedInitializedType<
3641
- Opts["idOnly"] extends true ? string : Document.ToConfiguredInstance<ConcreteDocument>,
3646
+ Opts["idOnly"] extends true ? string : Document.StoredForName<ConcreteDocument["documentName"]>,
3642
3647
  MergedOptions<Opts>
3643
3648
  >;
3644
3649
 
@@ -3727,7 +3732,7 @@ declare namespace ColorField {
3727
3732
  * A shorthand for the assignment type of a ColorField class.
3728
3733
  * @template Options - the options that override the default options
3729
3734
  *
3730
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3735
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3731
3736
  * for more details.
3732
3737
  */
3733
3738
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -3870,7 +3875,7 @@ declare namespace FilePathField {
3870
3875
  * A shorthand for the assignment type of a FilePathField class.
3871
3876
  * @template Options - the options that override the default options
3872
3877
  *
3873
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3878
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3874
3879
  * for more details.
3875
3880
  */
3876
3881
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -3984,7 +3989,7 @@ declare namespace AngleField {
3984
3989
  * A shorthand for the assignment type of a AngleField class.
3985
3990
  * @template Options - the options that override the default options
3986
3991
  *
3987
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3992
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
3988
3993
  * for more details.
3989
3994
  */
3990
3995
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4068,7 +4073,7 @@ declare namespace AlphaField {
4068
4073
  * A shorthand for the assignment type of a AlphaField class.
4069
4074
  * @template Options - the options that override the default options
4070
4075
  *
4071
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4076
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4072
4077
  * for more details.
4073
4078
  */
4074
4079
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4133,17 +4138,14 @@ declare class DocumentAuthorField<
4133
4138
  InitializedType = ForeignDocumentField.InitializedType<DocumentType, Options>,
4134
4139
  PersistedType extends string | null | undefined = ForeignDocumentField.PersistedType<Options>,
4135
4140
  > extends ForeignDocumentField<DocumentType, Options, AssignmentType, InitializedType, PersistedType> {
4136
- /** @defaultValue `false` */
4137
- override nullable: boolean;
4138
-
4139
4141
  /** @defaultValue `true` */
4140
- override gmOnly: boolean;
4142
+ override nullable: boolean;
4141
4143
 
4142
- /** @defaultValue `"Author"` */
4143
- override label: string;
4144
+ /** @defaultValue `false` */
4145
+ override readonly: boolean;
4144
4146
 
4145
- /** @defaultValue `() => game.user?.id` */
4146
- override initial: DataField.Options.InitialType<InitializedType>;
4147
+ /** @defaultValue `false` */
4148
+ override idOnly: boolean;
4147
4149
 
4148
4150
  static override get _defaults(): DocumentAuthorField.Options;
4149
4151
  }
@@ -4155,10 +4157,9 @@ declare namespace DocumentAuthorField {
4155
4157
  type DefaultOptions = SimpleMerge<
4156
4158
  ForeignDocumentField.DefaultOptions,
4157
4159
  {
4158
- nullable: false;
4159
- gmOnly: true;
4160
- label: "Author";
4161
- initial: () => string | undefined;
4160
+ nullable: true;
4161
+ readonly: false;
4162
+ idOnly: false;
4162
4163
  }
4163
4164
  >;
4164
4165
  }
@@ -4228,7 +4229,7 @@ declare namespace DocumentOwnershipField {
4228
4229
  * A shorthand for the assignment type of a ObjectField class.
4229
4230
  * @template Opts - the options that override the default options
4230
4231
  *
4231
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4232
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4232
4233
  * for more details.
4233
4234
  */
4234
4235
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4351,7 +4352,7 @@ declare namespace JSONField {
4351
4352
  * A shorthand for the assignment type of a JSONField class.
4352
4353
  * @template Options - the options that override the default options
4353
4354
  *
4354
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4355
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4355
4356
  * for more details.
4356
4357
  */
4357
4358
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4481,7 +4482,7 @@ declare namespace HTMLField {
4481
4482
  * A shorthand for the assignment type of a HTMLField class.
4482
4483
  * @template Options - the options that override the default options
4483
4484
  *
4484
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4485
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4485
4486
  * for more details.
4486
4487
  */
4487
4488
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4562,7 +4563,7 @@ declare namespace IntegerSortField {
4562
4563
  * A shorthand for the assignment type of a IntegerSortField class.
4563
4564
  * @template Options - the options that override the default options
4564
4565
  *
4565
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4566
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4566
4567
  * for more details.
4567
4568
  */
4568
4569
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4623,7 +4624,7 @@ declare namespace DocumentFlagsField {
4623
4624
  * @template ExtensionFlags - additional flags besides the ones configured for the class
4624
4625
  * @template Options - the options that override the default options
4625
4626
  *
4626
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4627
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4627
4628
  * for more details.
4628
4629
  */
4629
4630
  type AssignmentType<
@@ -4632,7 +4633,10 @@ declare namespace DocumentFlagsField {
4632
4633
  Options extends DocumentFlagsField.Options,
4633
4634
  // eslint-disable-next-line @typescript-eslint/no-deprecated
4634
4635
  > = DataField.DerivedAssignmentType<
4635
- _TwoLevelPartial<Document.ConfiguredFlagsForName<Name> & ExtensionFlags & InterfaceToObject<Document.CoreFlags>>,
4636
+ // Note(LukeAbby): This needs to actually get the real flags in `[Document].Flags`. Should be something like `Document.FlagsForName<Name>`
4637
+ _TwoLevelPartial<
4638
+ Document.Internal.ConfiguredFlagsForName<Name> & ExtensionFlags & InterfaceToObject<Document.CoreFlags>
4639
+ >,
4636
4640
  MergedOptions<Options>
4637
4641
  >;
4638
4642
 
@@ -4647,7 +4651,10 @@ declare namespace DocumentFlagsField {
4647
4651
  ExtensionFlags extends AnyObject,
4648
4652
  Options extends DocumentFlagsField.Options,
4649
4653
  > = DataField.DerivedInitializedType<
4650
- _TwoLevelPartial<Document.ConfiguredFlagsForName<Name> & ExtensionFlags & InterfaceToObject<Document.CoreFlags>>,
4654
+ // Note(LukeAbby): This needs to actually get the real flags in `[Document].Flags`. Should be something like `Document.FlagsForName<Name>`
4655
+ _TwoLevelPartial<
4656
+ Document.Internal.ConfiguredFlagsForName<Name> & ExtensionFlags & InterfaceToObject<Document.CoreFlags>
4657
+ >,
4651
4658
  MergedOptions<Options>
4652
4659
  >;
4653
4660
 
@@ -4784,7 +4791,7 @@ declare namespace DocumentStatsField {
4784
4791
  * A shorthand for the assignment type of a DocumentStatsField class.
4785
4792
  * @template Opts - the options that override the default options
4786
4793
  *
4787
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4794
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4788
4795
  * for more details.
4789
4796
  */
4790
4797
  // eslint-disable-next-line @typescript-eslint/no-deprecated
@@ -4960,7 +4967,7 @@ declare namespace DocumentTypeField {
4960
4967
  >;
4961
4968
 
4962
4969
  /**
4963
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4970
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
4964
4971
  * for more details.
4965
4972
  */
4966
4973
  type AssignmentType<
@@ -5130,7 +5137,7 @@ declare namespace TypeDataField {
5130
5137
  * @template DocumentType - the type of the embedded Document
5131
5138
  * @template Options - the options that override the default options
5132
5139
  *
5133
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
5140
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
5134
5141
  * for more details.
5135
5142
  */
5136
5143
  type AssignmentType<
@@ -5345,13 +5352,18 @@ declare namespace TypedSchemaField {
5345
5352
  /**
5346
5353
  * @internal
5347
5354
  */
5348
- type _AssignmentType<Types extends ConfiguredTypes> = {
5355
+ type _AssignmentType<Types extends ConfiguredTypes> = ValueOf<{
5349
5356
  // eslint-disable-next-line @typescript-eslint/no-deprecated
5350
- [K in keyof Types]: DataField.AssignmentTypeFor<Types[K]> & { type: K };
5351
- }[keyof Types];
5357
+ [K in ConcreteKeys<Types>]: _AddType<DataField.AssignmentTypeFor<Types[K]>, K>;
5358
+ }>;
5352
5359
 
5353
5360
  /**
5354
- * @deprecated - AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
5361
+ * @internal
5362
+ */
5363
+ type _AddType<T, Type extends PropertyKey> = T extends object ? T & { type: Type } : T;
5364
+
5365
+ /**
5366
+ * @deprecated AssignmentType is being deprecated. See {@linkcode SchemaField.AssignmentData}
5355
5367
  * for more details.
5356
5368
  */
5357
5369
  type AssignmentType<
@@ -5363,9 +5375,9 @@ declare namespace TypedSchemaField {
5363
5375
  /**
5364
5376
  * @internal
5365
5377
  */
5366
- type _InitializedType<Types extends ConfiguredTypes> = {
5367
- [K in keyof Types]: DataField.InitializedTypeFor<Types[K]> & { type: K };
5368
- }[keyof Types];
5378
+ type _InitializedType<Types extends ConfiguredTypes> = ValueOf<{
5379
+ [K in ConcreteKeys<Types>]: _AddType<DataField.InitializedTypeFor<Types[K]>, K>;
5380
+ }>;
5369
5381
 
5370
5382
  type InitializedType<
5371
5383
  Types extends TypedSchemaField.Types,
@@ -5375,9 +5387,9 @@ declare namespace TypedSchemaField {
5375
5387
  /**
5376
5388
  * @internal
5377
5389
  */
5378
- type _PersistedType<Types extends ConfiguredTypes> = {
5379
- [K in keyof Types]: DataField.PersistedTypeFor<Types[K]> & { type: K };
5380
- }[keyof Types];
5390
+ type _PersistedType<Types extends ConfiguredTypes> = ValueOf<{
5391
+ [K in ConcreteKeys<Types>]: _AddType<DataField.PersistedTypeFor<Types[K]>, K>;
5392
+ }>;
5381
5393
 
5382
5394
  type PersistedType<
5383
5395
  Types extends TypedSchemaField.Types,
@@ -121,7 +121,7 @@ declare abstract class BaseActiveEffect<
121
121
  static override createDocuments<Temporary extends boolean | undefined = undefined>(
122
122
  data: Array<ActiveEffect.Implementation | ActiveEffect.CreateData> | undefined,
123
123
  operation?: Document.Database.CreateOperation<ActiveEffect.Database.Create<Temporary>>,
124
- ): Promise<Array<Document.TemporaryIf<ActiveEffect.Implementation, Temporary>>>;
124
+ ): Promise<Array<ActiveEffect.TemporaryIf<Temporary>>>;
125
125
 
126
126
  static override updateDocuments(
127
127
  updates: ActiveEffect.UpdateData[] | undefined,
@@ -136,7 +136,7 @@ declare abstract class BaseActiveEffect<
136
136
  static override create<Temporary extends boolean | undefined = false>(
137
137
  data: ActiveEffect.CreateData | ActiveEffect.CreateData[],
138
138
  operation?: ActiveEffect.Database.CreateOperation<Temporary>,
139
- ): Promise<Document.TemporaryIf<ActiveEffect.Implementation, Temporary> | undefined>;
139
+ ): Promise<ActiveEffect.TemporaryIf<Temporary> | undefined>;
140
140
 
141
141
  override update(
142
142
  data: ActiveEffect.UpdateData | undefined,
@@ -160,12 +160,12 @@ declare abstract class BaseActiveEffect<
160
160
  override getFlag<Scope extends ActiveEffect.Flags.Scope, Key extends ActiveEffect.Flags.Key<Scope>>(
161
161
  scope: Scope,
162
162
  key: Key,
163
- ): Document.GetFlag<ActiveEffect.Name, Scope, Key>;
163
+ ): ActiveEffect.Flags.Get<Scope, Key>;
164
164
 
165
165
  override setFlag<
166
166
  Scope extends ActiveEffect.Flags.Scope,
167
167
  Key extends ActiveEffect.Flags.Key<Scope>,
168
- Value extends Document.GetFlag<ActiveEffect.Name, Scope, Key>,
168
+ Value extends ActiveEffect.Flags.Get<Scope, Key>,
169
169
  >(scope: Scope, key: Key, value: Value): Promise<this>;
170
170
 
171
171
  override unsetFlag<Scope extends ActiveEffect.Flags.Scope, Key extends ActiveEffect.Flags.Key<Scope>>(
@@ -338,7 +338,8 @@ declare namespace BaseActiveEffect {
338
338
  export import InitializedData = ActiveEffect.InitializedData;
339
339
  export import UpdateData = ActiveEffect.UpdateData;
340
340
  export import Schema = ActiveEffect.Schema;
341
- export import DatabaseOperation = ActiveEffect.Database;
341
+ export import Database = ActiveEffect.Database;
342
+ export import TemporaryIf = ActiveEffect.TemporaryIf;
342
343
  export import Flags = ActiveEffect.Flags;
343
344
  export import CoreFlags = ActiveEffect.CoreFlags;
344
345
  export import DurationData = ActiveEffect.DurationData;
@@ -148,7 +148,7 @@ declare abstract class BaseActorDelta<
148
148
  static override createDocuments<Temporary extends boolean | undefined = undefined>(
149
149
  data: Array<ActorDelta.Implementation | ActorDelta.CreateData> | undefined,
150
150
  operation?: Document.Database.CreateOperation<ActorDelta.Database.Create<Temporary>>,
151
- ): Promise<Array<Document.TemporaryIf<ActorDelta.Implementation, Temporary>>>;
151
+ ): Promise<Array<ActorDelta.TemporaryIf<Temporary>>>;
152
152
 
153
153
  static override updateDocuments(
154
154
  updates: ActorDelta.UpdateData[] | undefined,
@@ -163,7 +163,7 @@ declare abstract class BaseActorDelta<
163
163
  static override create<Temporary extends boolean | undefined = undefined>(
164
164
  data: ActorDelta.CreateData | ActorDelta.CreateData[],
165
165
  operation?: ActorDelta.Database.CreateOperation<Temporary>,
166
- ): Promise<Document.TemporaryIf<ActorDelta.Implementation, Temporary> | undefined>;
166
+ ): Promise<ActorDelta.TemporaryIf<Temporary> | undefined>;
167
167
 
168
168
  override update(
169
169
  data: ActorDelta.UpdateData | undefined,
@@ -217,12 +217,12 @@ declare abstract class BaseActorDelta<
217
217
  override getFlag<Scope extends ActorDelta.Flags.Scope, Key extends ActorDelta.Flags.Key<Scope>>(
218
218
  scope: Scope,
219
219
  key: Key,
220
- ): Document.GetFlag<ActorDelta.Name, Scope, Key>;
220
+ ): ActorDelta.Flags.Get<Scope, Key>;
221
221
 
222
222
  override setFlag<
223
223
  Scope extends ActorDelta.Flags.Scope,
224
224
  Key extends ActorDelta.Flags.Key<Scope>,
225
- Value extends Document.GetFlag<ActorDelta.Name, Scope, Key>,
225
+ Value extends ActorDelta.Flags.Get<Scope, Key>,
226
226
  >(scope: Scope, key: Key, value: Value): Promise<this>;
227
227
 
228
228
  override unsetFlag<Scope extends ActorDelta.Flags.Scope, Key extends ActorDelta.Flags.Key<Scope>>(
@@ -406,7 +406,8 @@ declare namespace BaseActorDelta {
406
406
  export import InitializedData = ActorDelta.InitializedData;
407
407
  export import UpdateData = ActorDelta.UpdateData;
408
408
  export import Schema = ActorDelta.Schema;
409
- export import DatabaseOperation = ActorDelta.Database;
409
+ export import Database = ActorDelta.Database;
410
+ export import TemporaryIf = ActorDelta.TemporaryIf;
410
411
  export import Flags = ActorDelta.Flags;
411
412
 
412
413
  /**
@@ -142,7 +142,7 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
142
142
  static override createDocuments<Temporary extends boolean | undefined = undefined>(
143
143
  data: Array<Actor.Implementation | Actor.CreateData> | undefined,
144
144
  operation?: Document.Database.CreateOperation<Actor.Database.Create<Temporary>>,
145
- ): Promise<Array<Document.TemporaryIf<Actor.Implementation, Temporary>>>;
145
+ ): Promise<Array<Actor.TemporaryIf<Temporary>>>;
146
146
 
147
147
  static override updateDocuments(
148
148
  updates: Actor.UpdateData[] | undefined,
@@ -157,7 +157,7 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
157
157
  static override create<Temporary extends boolean | undefined = undefined>(
158
158
  data: Actor.CreateData | Actor.CreateData[],
159
159
  operation?: Actor.Database.CreateOperation<Temporary>,
160
- ): Promise<Document.TemporaryIf<Actor.Implementation, Temporary> | undefined>;
160
+ ): Promise<Actor.TemporaryIf<Temporary> | undefined>;
161
161
 
162
162
  override update(
163
163
  data: Actor.UpdateData | undefined,
@@ -211,12 +211,12 @@ declare abstract class BaseActor<out SubType extends Actor.SubType = Actor.SubTy
211
211
  override getFlag<Scope extends Actor.Flags.Scope, Key extends Actor.Flags.Key<Scope>>(
212
212
  scope: Scope,
213
213
  key: Key,
214
- ): Document.GetFlag<Actor.Name, Scope, Key>;
214
+ ): Actor.Flags.Get<Scope, Key>;
215
215
 
216
216
  override setFlag<
217
217
  Scope extends Actor.Flags.Scope,
218
218
  Key extends Actor.Flags.Key<Scope>,
219
- Value extends Document.GetFlag<Actor.Name, Scope, Key>,
219
+ Value extends Actor.Flags.Get<Scope, Key>,
220
220
  >(scope: Scope, key: Key, value: Value): Promise<this>;
221
221
 
222
222
  override unsetFlag<Scope extends Actor.Flags.Scope, Key extends Actor.Flags.Key<Scope>>(
@@ -376,7 +376,8 @@ declare namespace BaseActor {
376
376
  export import InitializedData = Actor.InitializedData;
377
377
  export import UpdateData = Actor.UpdateData;
378
378
  export import Schema = Actor.Schema;
379
- export import DatabaseOperation = Actor.Database;
379
+ export import Database = Actor.Database;
380
+ export import TemporaryIf = Actor.TemporaryIf;
380
381
  export import Flags = Actor.Flags;
381
382
  export import GetDefaultArtworkReturn = Actor.GetDefaultArtworkReturn;
382
383
  export import GetDefaultArtworkTextureReturn = Actor.GetDefaultArtworkTextureReturn;
@@ -94,7 +94,7 @@ declare abstract class BaseAdventure extends Document<"Adventure", BaseAdventure
94
94
  static override createDocuments<Temporary extends boolean | undefined = undefined>(
95
95
  data: Array<Adventure.Implementation | Adventure.CreateData> | undefined,
96
96
  operation?: Document.Database.CreateOperation<Adventure.Database.Create<Temporary>>,
97
- ): Promise<Array<Document.TemporaryIf<Adventure.Implementation, Temporary>>>;
97
+ ): Promise<Array<Adventure.TemporaryIf<Temporary>>>;
98
98
 
99
99
  static override updateDocuments(
100
100
  updates: Adventure.UpdateData[] | undefined,
@@ -109,7 +109,7 @@ declare abstract class BaseAdventure extends Document<"Adventure", BaseAdventure
109
109
  static override create<Temporary extends boolean | undefined = undefined>(
110
110
  data: Adventure.CreateData | Adventure.CreateData[],
111
111
  operation?: Adventure.Database.CreateOperation<Temporary>,
112
- ): Promise<Document.TemporaryIf<Adventure.Implementation, Temporary> | undefined>;
112
+ ): Promise<Adventure.TemporaryIf<Temporary> | undefined>;
113
113
 
114
114
  override update(
115
115
  data: Adventure.UpdateData | undefined,
@@ -130,12 +130,12 @@ declare abstract class BaseAdventure extends Document<"Adventure", BaseAdventure
130
130
  override getFlag<Scope extends Adventure.Flags.Scope, Key extends Adventure.Flags.Key<Scope>>(
131
131
  scope: Scope,
132
132
  key: Key,
133
- ): Document.GetFlag<Adventure.Name, Scope, Key>;
133
+ ): Adventure.Flags.Get<Scope, Key>;
134
134
 
135
135
  override setFlag<
136
136
  Scope extends Adventure.Flags.Scope,
137
137
  Key extends Adventure.Flags.Key<Scope>,
138
- Value extends Document.GetFlag<Adventure.Name, Scope, Key>,
138
+ Value extends Adventure.Flags.Get<Scope, Key>,
139
139
  >(scope: Scope, key: Key, value: Value): Promise<this>;
140
140
 
141
141
  override unsetFlag<Scope extends Adventure.Flags.Scope, Key extends Adventure.Flags.Key<Scope>>(
@@ -309,7 +309,8 @@ declare namespace BaseAdventure {
309
309
  export import InitializedData = Adventure.InitializedData;
310
310
  export import UpdateData = Adventure.UpdateData;
311
311
  export import Schema = Adventure.Schema;
312
- export import DatabaseOperation = Adventure.Database;
312
+ export import Database = Adventure.Database;
313
+ export import TemporaryIf = Adventure.TemporaryIf;
313
314
  export import Flags = Adventure.Flags;
314
315
 
315
316
  namespace Internal {
@@ -77,7 +77,7 @@ declare abstract class BaseAmbientLight extends Document<"AmbientLight", BaseAmb
77
77
  static override createDocuments<Temporary extends boolean | undefined = undefined>(
78
78
  data: Array<AmbientLightDocument.Implementation | AmbientLightDocument.CreateData> | undefined,
79
79
  operation?: Document.Database.CreateOperation<AmbientLightDocument.Database.Create<Temporary>>,
80
- ): Promise<Array<Document.TemporaryIf<AmbientLightDocument.Implementation, Temporary>>>;
80
+ ): Promise<Array<AmbientLightDocument.TemporaryIf<Temporary>>>;
81
81
 
82
82
  static override updateDocuments(
83
83
  updates: AmbientLightDocument.UpdateData[] | undefined,
@@ -92,7 +92,7 @@ declare abstract class BaseAmbientLight extends Document<"AmbientLight", BaseAmb
92
92
  static override create<Temporary extends boolean | undefined = undefined>(
93
93
  data: AmbientLightDocument.CreateData | AmbientLightDocument.CreateData[],
94
94
  operation?: AmbientLightDocument.Database.CreateOperation<Temporary>,
95
- ): Promise<Document.TemporaryIf<AmbientLightDocument.Implementation, Temporary> | undefined>;
95
+ ): Promise<AmbientLightDocument.TemporaryIf<Temporary> | undefined>;
96
96
 
97
97
  override update(
98
98
  data: AmbientLightDocument.UpdateData | undefined,
@@ -116,12 +116,12 @@ declare abstract class BaseAmbientLight extends Document<"AmbientLight", BaseAmb
116
116
  override getFlag<Scope extends AmbientLightDocument.Flags.Scope, Key extends AmbientLightDocument.Flags.Key<Scope>>(
117
117
  scope: Scope,
118
118
  key: Key,
119
- ): Document.GetFlag<AmbientLightDocument.Name, Scope, Key>;
119
+ ): AmbientLightDocument.Flags.Get<Scope, Key>;
120
120
 
121
121
  override setFlag<
122
122
  Scope extends AmbientLightDocument.Flags.Scope,
123
123
  Key extends AmbientLightDocument.Flags.Key<Scope>,
124
- Value extends Document.GetFlag<AmbientLightDocument.Name, Scope, Key>,
124
+ Value extends AmbientLightDocument.Flags.Get<Scope, Key>,
125
125
  >(scope: Scope, key: Key, value: Value): Promise<this>;
126
126
 
127
127
  override unsetFlag<Scope extends AmbientLightDocument.Flags.Scope, Key extends AmbientLightDocument.Flags.Key<Scope>>(
@@ -295,7 +295,8 @@ declare namespace BaseAmbientLight {
295
295
  export import InitializedData = AmbientLightDocument.InitializedData;
296
296
  export import UpdateData = AmbientLightDocument.UpdateData;
297
297
  export import Schema = AmbientLightDocument.Schema;
298
- export import DatabaseOperation = AmbientLightDocument.Database;
298
+ export import Database = AmbientLightDocument.Database;
299
+ export import TemporaryIf = AmbientLightDocument.TemporaryIf;
299
300
  export import Flags = AmbientLightDocument.Flags;
300
301
  export import CoreFlags = AmbientLightDocument.CoreFlags;
301
302