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

package/src/foundry/client-esm/dice/terms/pool.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial, FixedInstanceType } from "fvtt-types/utils";
+import type { InexactPartial, FixedInstanceType, Identity } from "fvtt-types/utils";
 import type { PoolRollParseNode } from "../_types.d.mts";
 
 import type RollTerm from "./term.d.mts";
@@ -22,27 +22,27 @@ import type Die from "./die.d.mts";
  * ```
  */
 declare class PoolTerm extends RollTerm {
-  constructor({ terms, modifiers, rolls, results, options }?: InexactPartial<PoolTerm.PoolTermConstructorData>);
+  constructor(terms?: PoolTerm.PoolTermConstructorData);
 
   /**
    * The original provided terms to the Dice Pool
    */
-  terms: PoolTerm.TermData["terms"];
+  terms: string[];
 
   /**
    * The string modifiers applied to resolve the pool
    */
-  modifiers: PoolTerm.TermData["modifiers"];
+  modifiers: (keyof PoolTerm.Modifiers)[];
 
   /**
    * Each component term of a dice pool is evaluated as a Roll instance
    */
-  rolls: PoolTerm.TermData["rolls"];
+  rolls: Roll[];
 
   /**
    * The array of dice pool results which have been rolled
    */
-  results: PoolTerm.TermData["results"];
+  results: DiceTerm.Result[];
 
   /**
    * Define the modifiers that can be used for this particular DiceTerm type.
@@ -91,19 +91,13 @@ declare class PoolTerm extends RollTerm {
 
   override get total(): undefined | number;
 
-  /* -------------------------------------------- */
-
   /**
    * Return an array of rolled values which are still active within the PoolTerm
    */
   get values(): number[];
 
-  /* -------------------------------------------- */
-
   override get isDeterministic(): boolean;
 
-  /* -------------------------------------------- */
-
   /**
    * Alter the DiceTerm by adding or multiplying the number of dice which are rolled
    * @param args - Arguments passed to each contained Roll#alter method.
@@ -117,19 +111,15 @@ declare class PoolTerm extends RollTerm {
 
   protected _evaluateSync(options?: InexactPartial<RollTerm.EvaluationOptions>): this;
 
-  /* -------------------------------------------- */
-
   /**
    * Use the same logic as for the DiceTerm to avoid duplication
-   * @see DiceTerm#_evaluateModifiers
+   * @see {@link DiceTerm._evaluateModifiers | `DiceTerm#_evaluateModifiers`}
    */
   protected _evaluateModifiers(): void;
 
-  /* -------------------------------------------- */
-
   /**
    * Use the same logic as for the DiceTerm to avoid duplication
-   * @see DiceTerm#_evaluateModifier
+   * @see {@link DiceTerm._evaluateModifier | `DiceTerm#_evaluateModifier`}
    */
   protected _evaluateModifier(command: string, modifier: string): void;
 
@@ -142,12 +132,8 @@ declare class PoolTerm extends RollTerm {
     data: Record<string, unknown>,
   ): FixedInstanceType<T>;
 
-  /* -------------------------------------------- */
-
   toJSON(): Record<string, unknown>;
 
-  /* -------------------------------------------- */
-
   /**
    * Given a string formula, create and return an evaluated PoolTerm object
    * @param formula - The string formula to parse
@@ -167,8 +153,6 @@ declare class PoolTerm extends RollTerm {
    */
   static fromRolls<T extends PoolTerm.AnyConstructor>(this: T, rolls?: Roll[]): FixedInstanceType<T>;
 
-  /* -------------------------------------------- */
-
   /** Construct a PoolTerm from parser information. */
   static fromParseNode(node: PoolRollParseNode): PoolTerm;
 
@@ -230,12 +214,13 @@ declare class PoolTerm extends RollTerm {
 }
 
 declare namespace PoolTerm {
-  type AnyConstructor = typeof AnyPoolTerm;
+  interface Any extends AnyPoolTerm {}
+  interface AnyConstructor extends Identity<typeof AnyPoolTerm> {}
 
   /**
    * @remarks This interface is not defined by foundry itself. It only exists
    * to allow module and system authors to use it for declaration merging,
-   * enabling them to add additional modifiers for {@link PoolTerm}s.
+   * enabling them to add additional modifiers for {@link PoolTerm | `PoolTerm`}s.
    */
   interface Modifiers {
     k: "keep";
@@ -261,7 +246,7 @@ declare namespace PoolTerm {
     /**
      * @defaultValue `[]`
      */
-    modifiers?: string[] | undefined;
+    modifiers?: Array<keyof Modifiers> | undefined;
 
     /**
      * @defaultValue `[]`
@@ -281,7 +266,7 @@ declare namespace PoolTerm {
 }
 
 declare abstract class AnyPoolTerm extends PoolTerm {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }
 
 export default PoolTerm;

package/src/foundry/client-esm/dice/terms/string.d.mts

@@ -5,9 +5,9 @@ import type RollTerm from "./term.d.mts";
  * A type of RollTerm used to represent strings which have not yet been matched.
  */
 declare class StringTerm extends RollTerm {
-  constructor({ term, options }: StringTerm.ConstructorData);
+  constructor({ term, options }: StringTerm.TermData);
 
-  term: StringTerm.ConstructorData["term"];
+  term: string;
 
   /**
    * @defaultValue `["term"]`
@@ -24,7 +24,7 @@ declare class StringTerm extends RollTerm {
 }
 
 declare namespace StringTerm {
-  interface ConstructorData {
+  interface TermData {
     term: string;
 
     options?: RollTerm.Options | undefined;

package/src/foundry/client-esm/dice/terms/term.d.mts

@@ -1,10 +1,10 @@
-import type { InexactPartial, FixedInstanceType } from "fvtt-types/utils";
+import type { InexactPartial, FixedInstanceType, Identity } from "fvtt-types/utils";
 import type { RollParseNode } from "../_types.mts";
 
 import type RollResolver from "../../applications/dice/roll-resolver.d.mts";
 
 declare abstract class RollTerm {
-  constructor({ options }?: InexactPartial<{ options: RollTerm.Options }>);
+  constructor({ options }?: RollTerm.TermData);
 
   /** An object of additional options which describes and modifies the term. */
   options: RollTerm.Options;
@@ -129,10 +129,11 @@ declare abstract class RollTerm {
 }
 
 declare namespace RollTerm {
-  type AnyConstructor = typeof AnyRollTerm;
+  interface Any extends AnyRollTerm {}
+  interface AnyConstructor extends Identity<typeof AnyRollTerm> {}
 
   interface Options {
-    flavor?: string;
+    flavor?: string | undefined | null;
   }
 
   interface EvaluationOptions {
@@ -160,10 +161,14 @@ declare namespace RollTerm {
     evaluated: boolean;
     options: Options;
   }
+
+  interface TermData {
+    options?: RollTerm.Options | undefined;
+  }
 }
 
 declare abstract class AnyRollTerm extends RollTerm {
-  constructor(arg0: never, ...args: never[]);
+  constructor(...args: never);
 }
 
 export default RollTerm;

package/src/foundry/client-esm/dice/twister.d.mts

@@ -100,7 +100,7 @@ declare class MersenneTwister {
    * Same as .rnd() method - for consistency with Math.random() interface.
    *
    * since: 0.2.0
-   * @see {@link MersenneTwister#rnd}
+   * @see {@link MersenneTwister.rnd | `MersenneTwister#rnd`}
    */
   random(): number;
 
@@ -120,13 +120,13 @@ declare class MersenneTwister {
 
   /**
    * A factory method for generating random uniform rolls
-   * @see {@link MersenneTwister#random}
+   * @see {@link MersenneTwister.random | `MersenneTwister#random`}
    */
   static random(): number;
 
   /**
    * A factory method for generating random normal rolls
-   * @see {@link MersenneTwister#normal}
+   * @see {@link MersenneTwister.normal | `MersenneTwister#normal`}
    */
   static normal(mu: number, sigma: number): number;
 }

package/src/foundry/client-esm/documents/_module.d.mts

@@ -3,7 +3,7 @@
 // While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
 /* eslint-disable import-x/extensions */
 
-export * from "@common/documents/_module.mjs";
+export * from "#common/documents/_module.mjs";
 export * as types from "./_types.mjs";
 
 // Abstract Classes

package/src/foundry/client-esm/helpers/_types.d.mts

@@ -1,51 +1,17 @@
-import type { SchemaField } from "@common/data/fields.d.mts";
-import type { PrototypeToken } from "../data/_module.d.mts";
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type CompendiumArt from "./compendium-art.d.mts";
 
-export interface CompendiumArtInfo {
-  /**
-   * The path to the Actor's portrait image.
-   */
-  actor?: string | undefined;
+export {};
 
-  /**
-   * The path to the token image, or an object to merge into the Actor's prototype token.
-   */
-  token?: string | SchemaField.InnerAssignmentType<PrototypeToken.Schema> | undefined;
+// 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. It's also just nice to
+// have as reference to keep us synced with the latest version of Foundry.
 
-  /**
-   *An optional credit string for use by the game system to apply in an appropriate place.
-   */
-  credit?: string | undefined;
-}
+type CompendiumArtInfo = CompendiumArt.Info;
 
-/**
- * A mapping of compendium pack IDs to Document IDs to art information.
- */
-export type CompendiumArtMapping = Record<string, Record<string, CompendiumArtInfo>>;
+type CompendiumArtMapping = CompendiumArt.Mapping;
 
-export interface CompendiumArtDescriptor {
-  /**
-   * The ID of the package providing the art.
-   */
-  packageId: string;
-
-  /**
-   * The title of the package providing the art.
-   */
-  title: string;
-
-  /**
-   * The path to the art mapping file.
-   */
-  mapping: string;
-
-  /**
-   * An optional credit string for use by the game system to apply in an appropriate place.
-   */
-  credit?: string | undefined;
-
-  /**
-   * The package's user-configured priority.
-   */
-  priority: number;
-}
+type CompendiumArtDescriptor = CompendiumArt.Descriptor;

package/src/foundry/client-esm/helpers/compendium-art.d.mts

@@ -1,9 +1,10 @@
-import type { CompendiumArtDescriptor, CompendiumArtInfo, CompendiumArtMapping } from "./_types.d.mts";
+import type { SchemaField } from "#common/data/fields.d.mts";
+import type { PrototypeToken } from "../data/_module.d.mts";
 
 /**
  * A class responsible for managing package-provided art and applying it to Documents in compendium packs.
  */
-declare class CompendiumArt extends Map<string, CompendiumArtInfo> {
+declare class CompendiumArt extends Map<string, CompendiumArt.Info> {
   /**
    * The key for the package manifest flag used to store the mapping information.
    * @defaultValue `"compendiumArtMappings"`
@@ -26,7 +27,7 @@ declare class CompendiumArt extends Map<string, CompendiumArtInfo> {
   /**
    * Retrieve all active packages that provide art mappings in priority order.
    */
-  getPackages(): CompendiumArtDescriptor[];
+  getPackages(): CompendiumArt.Descriptor[];
 
   /**
    * Collate Document art mappings from active packages.
@@ -41,7 +42,59 @@ declare class CompendiumArt extends Map<string, CompendiumArtInfo> {
    * @param mapping   - The art mapping information provided by the package.
    * @param credit    - An optional credit string for use by the game system to apply in an appropriate place.
    */
-  #parseArtMapping(packageId: string, mapping: CompendiumArtMapping, credit?: string): Promise<void>;
+  #parseArtMapping(packageId: string, mapping: CompendiumArt.Mapping, credit?: string): Promise<void>;
+}
+
+declare namespace CompendiumArt {
+  interface Info {
+    /**
+     * The path to the Actor's portrait image.
+     */
+    actor?: string | undefined;
+
+    /**
+     * The path to the token image, or an object to merge into the Actor's prototype token.
+     */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
+    token?: string | SchemaField.AssignmentData<PrototypeToken.Schema> | undefined;
+
+    /**
+     *An optional credit string for use by the game system to apply in an appropriate place.
+     */
+    credit?: string | undefined;
+  }
+
+  /**
+   * A mapping of compendium pack IDs to Document IDs to art information.
+   */
+  type Mapping = Record<string, Record<string, Info>>;
+
+  interface Descriptor {
+    /**
+     * The ID of the package providing the art.
+     */
+    packageId: string;
+
+    /**
+     * The title of the package providing the art.
+     */
+    title: string;
+
+    /**
+     * The path to the art mapping file.
+     */
+    mapping: string;
+
+    /**
+     * An optional credit string for use by the game system to apply in an appropriate place.
+     */
+    credit?: string | undefined;
+
+    /**
+     * The package's user-configured priority.
+     */
+    priority: number;
+  }
 }
 
 export default CompendiumArt;

package/src/foundry/client-esm/packages/_module.d.mts

@@ -8,7 +8,7 @@ import System from "./system.mjs";
 import World from "./world.mjs";
 
 export * as types from "./_types.mjs";
-// export * from "@common/packages/_module.mjs";
+// export * from "#common/packages/_module.mjs";
 export { default as ClientPackageMixin } from "./client-package.mjs";
 export { Module, System, World };
 

package/src/foundry/client-esm/packages/_types.d.mts

@@ -1,3 +1,5 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
 // 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?
 //

package/src/foundry/client-esm/utils/_module.d.mts

@@ -3,5 +3,5 @@
 // While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
 /* eslint-disable import-x/extensions */
 
-export * from "@common/utils/_module.mjs";
+export * from "#common/utils/_module.mjs";
 export * from "./helpers.mjs";

package/src/foundry/client-esm/utils/_types.d.mts

@@ -1,2 +1,3 @@
 // Only exists to re-export these types
-export * from "@common/utils/_types.mjs";
+// eslint-disable-next-line import-x/export, import-x/extensions
+export * from "#common/utils/_types.mjs";

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

@@ -39,7 +39,7 @@ type DeepReadonly<T> = Readonly<{
 /**
  * A class constructor.
  * Used for functions with generic class constructor parameters.
- * @privateRemarks We have better tools like {@link AnyConcreteConstructor} and {@link AnyConstructor}
+ * @privateRemarks We have better tools like {@link AnyConcreteConstructor | `AnyConcreteConstructor`} and {@link AnyConstructor | `AnyConstructor`}
  */
 type Constructor = new (...args: any[]) => any;
 

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

@@ -3,6 +3,7 @@
 // While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
 /* eslint-disable import-x/extensions */
 
+export * as types from "./_types.mjs";
 export { default as DataModel } from "./data.mjs";
 export { default as TypeDataModel } from "./type-data.mjs";
 export { default as Document } from "./document.mjs";