@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1

package/src/foundry/common/data/_module.d.mts

@@ -7,3 +7,4 @@ export * as validators from "./validators.mjs";
 export * as validation from "./validation-failure.mjs";
 export * as fields from "./fields.mjs";
 export * from "./data.mjs";
+export { ActorDeltaField } from "../documents/token.mjs";

package/src/foundry/common/data/_types.d.mts

@@ -1,4 +1,5 @@
 /* eslint-disable @typescript-eslint/no-unused-vars */
+import type { fields } from "./_module.d.mts";
 
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?
@@ -10,11 +11,11 @@
 // TODO: Stubs
 export {};
 
-type DataFieldValidator = unknown;
+type DataFieldValidator = fields.DataField.Validator<fields.DataField.Any, unknown>;
 
-type DataFieldOptions = unknown;
+type DataFieldOptions = fields.DataField.Options.Any;
 
-type DataFieldContext = unknown;
+type DataFieldContext = fields.DataField.ConstructionContext;
 
 type FormGroupConfig = unknown;
 
@@ -26,24 +27,24 @@ type CodeMirrorLanguage = unknown;
 
 type CodeMirrorInputConfig = unknown;
 
-type LightAnimationData = unknown;
+type LightAnimationData = foundry.data.LightData.AnimationData;
 
-type NumberFieldOptions = unknown;
+type NumberFieldOptions = fields.NumberField.Options;
 
-type StringFieldOptions = unknown;
+type StringFieldOptions = fields.StringField.Options;
 
 type ChoiceInputConfig = unknown;
 
-type ArrayFieldOptions = unknown;
+type ArrayFieldOptions = fields.ArrayField.Options<unknown>;
 
-type DocumentUUIDFieldOptions = unknown;
+type DocumentUUIDFieldOptions = fields.DocumentUUIDField.Options;
 
-type FilePathFieldOptions = unknown;
+type FilePathFieldOptions = fields.FilePathField;
 
-type DocumentFlags = unknown;
+type DocumentFlags = Record<string, Record<string, unknown>>;
 
-type DocumentStats = unknown;
+type DocumentStats = fields.DocumentStatsField.Data;
 
-type JavaScriptFieldOptions = unknown;
+type JavaScriptFieldOptions = fields.JavaScriptField.Options;
 
-type ElementValidationFailure = unknown;
+type ElementValidationFailure = foundry.data.validation.DataModelValidationFailure.ElementValidationFailure;

package/src/foundry/common/data/data.d.mts

@@ -7,16 +7,20 @@ import type {
   RemoveIndexSignatures,
   ToMethod,
   ValueOf,
-} from "fvtt-types/utils";
+} from "#utils";
+import type { SchemaField } from "./fields.d.mts";
 
 import fields = foundry.data.fields;
 import documents = foundry.documents;
+import Document = foundry.abstract.Document;
 
 type DataSchema = foundry.data.fields.DataSchema;
 
 declare namespace LightData {
   type Parent = TokenDocument.Implementation | AmbientLightDocument.Implementation;
 
+  interface AnimationData extends fields.SchemaField.InitializedData<LightAnimationDataSchema> {}
+
   interface LightAnimationDataSchema extends DataSchema {
     /**
      * The animation type which is applied
@@ -112,7 +116,7 @@ declare namespace LightData {
     /**
      * The coloration technique applied in the shader
      * @defaultValue `1`
-     * @remarks This should match the `id` of the desired property of {@link AdaptiveLightingShader.SHADER_TECHNIQUES | `AdaptiveLightingShader.SHADER_TECHNIQUES`}
+     * @remarks This should match the `id` of the desired property of {@linkcode AdaptiveLightingShader.SHADER_TECHNIQUES}
      */
     coloration: fields.NumberField<{ required: true; integer: true; initial: 1 }>;
 
@@ -182,6 +186,11 @@ declare class LightData extends DataModel<LightData.Schema, LightData.Parent> {
   /** @defaultValue `["LIGHT"]` */
   static override LOCALIZATION_PREFIXES: string[];
 
+  /**
+   * @remarks
+   * Migrations:
+   * - negative `luminosity`s to `1 - luminosity` and setting `negative` true
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 }
 
@@ -239,6 +248,11 @@ declare class ShapeData extends DataModel<ShapeData.Schema> {
 }
 
 declare namespace BaseShapeData {
+  interface Source extends fields.SchemaField.SourceData<Schema> {}
+  interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+  interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
+  interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
   interface Schema<ShapeType extends ShapeTypes = ShapeTypes> extends DataSchema {
     /**
      * The type of shape, a value in BaseShapeData.TYPES.
@@ -444,10 +458,11 @@ declare namespace TextureData {
   }
 
   /**
-   * @internal
-   * The `initial` property of the `srcOptions` parameter of the {@link TextureData | `TextureData`} constructor
+   * The `initial` property of the `srcOptions` parameter of the {@linkcode TextureData} constructor
    * is not the `initial` for any one field, but instead is an object that gets parcelled out by key to the
    * fields of the schema
+   *
+   * @internal
    */
   type _SrcOptionsInitial<T> = {
     [K in keyof T]: fields.DataField.Options.InitialType<T[K]>;
@@ -464,7 +479,7 @@ declare namespace TextureData {
      * The URL of the texture source.
      * @defaultValue `initial.src ?? null`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     src: fields.FilePathField<{
       categories: NullishCoalesce<Options["categories"], DefaultOptions["categories"]>;
@@ -477,7 +492,7 @@ declare namespace TextureData {
      * The X coordinate of the texture anchor.
      * @defaultValue `initial.anchorX ?? 0`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     anchorX: fields.NumberField<{
       nullable: false;
@@ -488,7 +503,7 @@ declare namespace TextureData {
      * The Y coordinate of the texture anchor.
      * @defaultValue `initial.anchorY ?? 0`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     anchorY: fields.NumberField<{
       nullable: false;
@@ -499,7 +514,7 @@ declare namespace TextureData {
      * The X offset of the texture with (0,0) in the top left.
      * @defaultValue `initial.offsetX ?? 0`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     offsetX: fields.NumberField<{
       nullable: false;
@@ -511,7 +526,7 @@ declare namespace TextureData {
      * The Y offset of the texture with (0,0) in the top left.
      * @defaultValue `initial.offsetY ?? 0`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     offsetY: fields.NumberField<{
       nullable: false;
@@ -522,7 +537,7 @@ declare namespace TextureData {
     /**
      * @defaultValue `initial.fit ?? "fill"`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     fit: fields.StringField<
       {
@@ -538,7 +553,7 @@ declare namespace TextureData {
      * The scale of the texture in the X dimension.
      * @defaultValue `initial.scaleX ?? 1`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     scaleX: fields.NumberField<{
       nullable: false;
@@ -549,7 +564,7 @@ declare namespace TextureData {
      * The scale of the texture in the Y dimension.
      * @defaultValue `initial.scaleY ?? 1`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     scaleY: fields.NumberField<{
       nullable: false;
@@ -560,7 +575,7 @@ declare namespace TextureData {
      * An angle of rotation by which this texture is rotated around its center.
      * @defaultValue `initial.rotation ?? 0`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     rotation: fields.AngleField<{
       initial: NullishCoalesce<GetKey<Options["initial"], "rotation", 0>, 0>;
@@ -570,18 +585,19 @@ declare namespace TextureData {
      * The tint applied to the texture.
      * @defaultValue `initial.tint ?? "#ffffff"`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     tint: fields.ColorField<{
       nullable: false;
       initial: NullishCoalesce<GetKey<Options["initial"], "tint", "#ffffff">, "#ffffff">;
     }>;
+
     /**
      * Only pixels with an alpha value at or above this value are consider solid
      * w.r.t. to occlusion testing and light/weather blocking.
      * @defaultValue `initial.alphaThreshold ?? 0`
      * @remarks The `initial` in the above default value is the property from the `srcOptions`
-     * parameter of the {@link TextureData | `TextureData`} constructor
+     * parameter of the {@linkcode TextureData} constructor
      */
     alphaThreshold: fields.AlphaField<{
       nullable: false;
@@ -591,7 +607,7 @@ declare namespace TextureData {
 }
 
 /**
- * A {@link fields.SchemaField | `fields.SchemaField`} subclass used to represent texture data.
+ * A {@linkcode fields.SchemaField} subclass used to represent texture data.
  */
 declare class TextureData<
   SrcOptions extends TextureData.SrcOptions = TextureData.DefaultOptions,
@@ -608,8 +624,9 @@ declare namespace PrototypeToken {
   type Parent = documents.BaseActor;
 
   /**
-   * @internal
    * The fields foundry omits from the BaseToken schema. Not used, left as reference
+   *
+   * @internal
    */
   type ExcludedProperties =
     | "_id"
@@ -627,7 +644,7 @@ declare namespace PrototypeToken {
    * @remarks This has `PrototypeToken.#applyDefaultTokenSettings` run on it before actually being returned, so `initial`
    * values may not be exactly accurate as typed
    * @privateRemarks Since the {@link TokenDocument.Schema | `TokenDocument` schema} also extends `SharedProtoSchema`,
-   * overrides & extensions specific to {@link PrototypeToken | `PrototypeToken`} must go here
+   * overrides & extensions specific to {@linkcode PrototypeToken} must go here
    */
   interface Schema extends TokenDocument.SharedProtoSchema {
     /**
@@ -646,11 +663,17 @@ declare namespace PrototypeToken {
   }
 
   /**
-   * {@link PrototypeToken.CreateData | `PrototypeToken.CreateData`}
+   * @deprecated Replace with {@linkcode PrototypeToken.CreateData}.
    */
   type ConstructorData = CreateData;
 
   interface CreateData extends fields.SchemaField.CreateData<Schema> {}
+
+  interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
+
+  interface Source extends fields.SchemaField.SourceData<Schema> {}
+
+  export import Flags = TokenDocument.Flags;
 }
 
 /**
@@ -658,16 +681,13 @@ declare namespace PrototypeToken {
  */
 declare class PrototypeToken extends DataModel<PrototypeToken.Schema, PrototypeToken.Parent> {
   // options: not null (destructured when passed to super)
-  constructor(
-    data?: PrototypeToken.ConstructorData | null,
-    options?: DataModel.DataValidationOptions<PrototypeToken.Parent>,
-  );
+  constructor(data?: PrototypeToken.Source | null, options?: DataModel.ConstructionContext<PrototypeToken.Parent>);
 
   /**
    * @defaultValue `{}`
    * @remarks Created via `defineProperty` in constructor
    */
-  apps: Record<string, Application.Any | foundry.applications.api.ApplicationV2.Any>;
+  apps: Record<string, foundry.appv1.api.Application.Any | foundry.applications.api.ApplicationV2.Any>;
 
   static override defineSchema(): PrototypeToken.Schema;
 
@@ -681,8 +701,9 @@ declare class PrototypeToken extends DataModel<PrototypeToken.Schema, PrototypeT
    */
   get actor(): this["parent"];
 
-  override toObject(source: true): this["_source"] & { actorId: string | undefined };
-  override toObject(source?: boolean): ReturnType<this["schema"]["toObject"]> & { actorId: string | undefined };
+  override toObject(
+    source?: boolean | null,
+  ): SchemaField.SourceData<PrototypeToken.Schema> & { actorId: string | undefined };
 
   static get database(): CONFIG["DatabaseBackend"];
 
@@ -694,32 +715,50 @@ declare class PrototypeToken extends DataModel<PrototypeToken.Schema, PrototypeT
 
   /**
    * @see {@link foundry.abstract.Document.update | `foundry.abstract.Document#update`}
+   * @remarks Despite the above `@see`, forwards to {@link Actor.update | `this.actor.update`} after wrapping `data`
+   * in `{prototypeToken: data}`
    */
-  update(data: unknown, options: unknown): unknown;
+  update(
+    data: PrototypeToken.UpdateData | undefined,
+    operation?: Actor.Database.UpdateOperation,
+  ): Promise<Actor.Implementation | undefined>;
 
   /**
    * @see {@link foundry.abstract.Document.getFlag | `foundry.abstract.Document#getFlag`}
    */
-  getFlag(args: unknown): unknown;
+  getFlag<Scope extends TokenDocument.Flags.Scope, Key extends TokenDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<TokenDocument.Name, Scope, Key>;
 
   /**
    * @see {@link foundry.abstract.Document.setFlag | `foundry.abstract.Document#setFlag`}
    */
-  setFlag(args: unknown): unknown;
+  setFlag<
+    Scope extends TokenDocument.Flags.Scope,
+    Key extends TokenDocument.Flags.Key<Scope>,
+    Value extends Document.GetFlag<TokenDocument.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
 
   /**
    * @see {@link foundry.abstract.Document.unsetFlag | `foundry.abstract.Document#unsetFlag`}
    */
-  unsetFlag(args: unknown): Promise<unknown>;
+  unsetFlag<Scope extends TokenDocument.Flags.Scope, Key extends TokenDocument.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
 
   /**
-   * @see {@link foundry.abstract.Document.testUserPermission | `foundry.abstract.Document#testUserPermission`}
+   * @see {@link Document.testUserPermission | `Document#testUserPermission`}
+   * @remarks Forwards to {@link Actor.testUserPermission | `this.actor.testUserPermission`}. Core's `Actor` implementation
+   * doesn't override this method, so without further extension, that's equivalent to `Document#testUserPermission`
    */
+  // options: not null (destructured)
   testUserPermission(
     user: User.Implementation,
-    permission: unknown,
-    { exact }: { exact: boolean },
-  ): ReturnType<this["actor"]["testUserPermission"]>;
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
+  ): boolean;
 
   /**
    * @see {@link foundry.abstract.Document.isOwner | `foundry.abstract.Document#isOwner`}