@league-of-foundry-developers/foundry-vtt-types 12.331.2-beta → 13.340.0

package/src/foundry/common/data/{module.d.mts → _module.d.mts}

@@ -1,7 +1,7 @@
 // In Foundry itself this file contains re-exports of these other modules.
 // Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
-// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
-/* eslint-disable import/extensions */
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
 
 export * as validators from "./validators.mjs";
 export * as validation from "./validation-failure.mjs";

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

@@ -0,0 +1,47 @@
+// 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?
+//
+// Well this is the file in which Foundry defines these types. We don't house
+// them here because it has poor discoverability. The names Foundry has chosen
+// also overlaps with other existing names, such as SettingConfig vs. ClientSetting.SettingConfig
+
+// TODO: Stubs
+export {};
+
+type DataFieldValidator = unknown;
+
+type DataFieldOptions = unknown;
+
+type DataFieldContext = unknown;
+
+type FormGroupConfig = unknown;
+
+type FormInputConfig = unknown;
+
+type StringFieldInputConfig = unknown;
+
+type CodeMirrorLanguage = unknown;
+
+type CodeMirrorInputConfig = unknown;
+
+type LightAnimationData = unknown;
+
+type NumberFieldOptions = unknown;
+
+type StringFieldOptions = unknown;
+
+type ChoiceInputConfig = unknown;
+
+type ArrayFieldOptions = unknown;
+
+type DocumentUUIDFieldOptions = unknown;
+
+type FilePathFieldOptions = unknown;
+
+type DocumentFlags = unknown;
+
+type DocumentStats = unknown;
+
+type JavaScriptFieldOptions = unknown;
+
+type ElementValidationFailure = unknown;

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

@@ -1,8 +1,11 @@
-import type { DatabaseBackend } from "../abstract/module.d.mts";
+import type { DatabaseBackend } from "../abstract/_module.d.mts";
 import type { DataModel } from "../abstract/data.d.mts";
-import type { fields } from "./module.d.mts";
+import type { fields } from "./_module.d.mts";
 import type * as documents from "../documents/_module.d.mts";
-import type { AnyObject, EmptyObject, ValueOf } from "../../../types/utils.d.mts";
+import type { AnyMutableObject, EmptyObject, ToMethod, ValueOf } from "fvtt-types/utils";
+import type { FilePathField } from "./fields.d.mts";
+
+type DataSchema = foundry.data.fields.DataSchema;
 
 // TODO: Implement all of the necessary options
 
@@ -11,7 +14,9 @@ declare global {
 }
 
 declare namespace LightData {
-  export interface LightAnimationDataSchema extends DataSchema {
+  type Parent = TokenDocument | AmbientLightDocument;
+
+  interface LightAnimationDataSchema extends DataSchema {
     /**
      * The animation type which is applied
      * @defaultValue `null`
@@ -53,7 +58,7 @@ declare namespace LightData {
     reverse: fields.BooleanField;
   }
 
-  export interface DarknessSchema extends DataSchema {
+  interface DarknessSchema extends DataSchema {
     /**
      * @defaultValue `0`
      */
@@ -167,7 +172,7 @@ declare namespace LightData {
  * A reusable document structure for the internal data used to render the appearance of a light source.
  * This is re-used by both the AmbientLightData and TokenData classes.
  */
-declare class LightData extends DataModel<LightData.Schema> {
+declare class LightData extends DataModel<LightData.Schema, LightData.Parent> {
   static override defineSchema(): LightData.Schema;
 
   /**
@@ -175,7 +180,7 @@ declare class LightData extends DataModel<LightData.Schema> {
    */
   static override LOCALIZATION_PREFIXES: string[];
 
-  static migrateData(source: AnyObject): AnyObject;
+  static migrateData(source: AnyMutableObject): AnyMutableObject;
 }
 
 declare namespace ShapeData {
@@ -252,11 +257,11 @@ declare namespace BaseShapeData {
     hole: fields.BooleanField;
   }
 
-  interface Types {
-    rectangle: RectangleShapeData;
-    circle: CircleShapeData;
-    ellipse: EllipseShapeData;
-    polygon: PolygonShapeData;
+  interface Types extends foundry.data.fields.TypedSchemaField.Types {
+    rectangle: typeof RectangleShapeData;
+    circle: typeof CircleShapeData;
+    ellipse: typeof EllipseShapeData;
+    polygon: typeof PolygonShapeData;
   }
 }
 
@@ -439,7 +444,7 @@ declare namespace TextureData {
     label: "";
   }
 
-  interface Schema<SrcOptions extends FilePathFieldOptions> extends DataSchema {
+  interface Schema<SrcOptions extends FilePathField.Options> extends DataSchema {
     /**
      * The URL of the texture source.
      * @defaultValue `initial.src ?? null`
@@ -512,7 +517,7 @@ declare namespace TextureData {
  * A {@link fields.SchemaField} subclass used to represent texture data.
  */
 declare class TextureData<
-  SrcOptions extends FilePathFieldOptions = TextureData.DefaultOptions,
+  SrcOptions extends FilePathField.Options = TextureData.DefaultOptions,
   SchemaOptions extends fields.SchemaField.Options<TextureData.Schema<SrcOptions>> = EmptyObject,
 > extends fields.SchemaField<TextureData.Schema<SrcOptions>, SchemaOptions> {
   /**
@@ -555,12 +560,12 @@ declare namespace PrototypeToken {
  * Extend the base TokenData to define a PrototypeToken which exists within a parent Actor.
  */
 declare class PrototypeToken extends DataModel<PrototypeToken.Schema, any> {
-  constructor(data?: PrototypeToken.ConstructorData, options?: DataModel.ConstructorOptions<PrototypeToken.Parent>);
+  constructor(data?: PrototypeToken.ConstructorData, options?: DataModel.DataValidationOptions<PrototypeToken.Parent>);
 
   declare parent: PrototypeToken.Parent;
 
   /** @defaultValue `{}` */
-  apps: Record<string, Application>;
+  apps: Record<string, Application.Any>;
 
   static override defineSchema(): PrototypeToken.Schema;
 
@@ -609,7 +614,7 @@ declare class PrototypeToken extends DataModel<PrototypeToken.Schema, any> {
    * @see foundry.abstract.Document#testUserPermission
    */
   testUserPermission(
-    user: documents.BaseUser,
+    user: User,
     permission: unknown,
     { exact }: { exact: boolean },
   ): ReturnType<this["actor"]["testUserPermission"]>;
@@ -619,11 +624,12 @@ declare class PrototypeToken extends DataModel<PrototypeToken.Schema, any> {
    */
   get isOwner(): boolean;
 
-  // Monkey patched in from `token.js`, put here due to issues with the merge process
   /**
    * @see TokenDocument#getBarAttribute
+   *
+   * @remarks This is monkey patched in from `token.js`, put here due to issues with the merge process
    */
-  getBarAttribute: TokenDocument["getBarAttribute"];
+  getBarAttribute: ToMethod<TokenDocument["getBarAttribute"]>;
 }
 
 declare namespace TombstoneData {