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

package/src/foundry/client/data/documents/active-effect.d.ts

@@ -1,172 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-import type { ActiveEffectDataConstructorData } from '../../../common/data/data.mjs/activeEffectData';
-import { EffectChangeData } from '../../../common/data/data.mjs/effectChangeData';
-
-declare global {
-  /**
-   * The client-side ActiveEffect document which extends the common BaseActiveEffect model.
-   * Each ActiveEffect belongs to the effects collection of its parent Document.
-   * Each ActiveEffect contains a ActiveEffectData object which provides its source data.
-   *
-   * @see {@link data.ActiveEffectData}               The ActiveEffect data schema
-   * @see {@link documents.Actor}                     The Actor document which contains ActiveEffect embedded documents
-   * @see {@link documents.Item}                      The Item document which contains ActiveEffect embedded documents
-   */
-  class ActiveEffect extends ClientDocumentMixin(foundry.documents.BaseActiveEffect) {
-    /**
-     * @param data   - Initial data provided to construct the ActiveEffect document
-     * @param parent - The parent document to which this ActiveEffect belongs
-     */
-    constructor(...args: ConstructorParameters<typeof foundry.documents.BaseActiveEffect>);
-
-    /**
-     * A cached reference to the source name to avoid recurring database lookups
-     * @defaultValue `null`
-     */
-    protected _sourceName: string | null;
-
-    /**
-     * A cached reference to the ActiveEffectConfig instance which configures this effect
-     */
-    protected _sheet: FormApplication | null; // TODO: Actually an ActiveEffectConfig according to foundry but this is a problem with ClientDocumentMixins _sheet, this should actually be inferred from the CONFIG
-
-    /**
-     * Is there some system logic that makes this active effect ineligible for application?
-     */
-    get isSuppressed(): boolean;
-
-    /**
-     * Summarize the active effect duration
-     */
-    get duration(): DurationSummary;
-
-    /**
-     * Format a round+turn combination as a decimal
-     * @param round  - The round number
-     * @param turn   - The turn number
-     * @param nTurns - The maximum number of turns in the encounter
-     * @returns The decimal representation
-     */
-    protected _getCombatTime(round: number, turn: number, nTurns: number): number;
-
-    /**
-     * Format a number of rounds and turns into a human-readable duration label
-     * @param rounds - The number of rounds
-     * @param turns  - The number of turns
-     * @returns The formatted label
-     */
-    protected _getDurationLabel(rounds: number, turns: number): string;
-
-    /**
-     * Describe whether the ActiveEffect has a temporary duration based on combat turns or rounds.
-     */
-    get isTemporary(): boolean;
-
-    /**
-     * A cached property for obtaining the source name
-     */
-    get sourceName(): string;
-
-    /**
-     * Apply this ActiveEffect to a provided Actor.
-     * @param actor  - The Actor to whom this effect should be applied
-     * @param change - The change data being applied
-     * @returns The resulting applied value
-     */
-    apply(actor: ConfiguredActor, change: EffectChangeData): unknown;
-
-    /**
-     * Apply an ActiveEffect that uses an ADD application mode.
-     * The way that effects are added depends on the data type of the current value.
-     *
-     * If the current value is null, the change value is assigned directly.
-     * If the current type is a string, the change value is concatenated.
-     * If the current type is a number, the change value is cast to numeric and added.
-     * If the current type is an array, the change value is appended to the existing array if it matches in type.
-     *
-     * @param actor  - The Actor to whom this effect should be applied
-     * @param change - The change data being applied
-     * @returns The resulting applied value
-     */
-    protected _applyAdd(actor: ConfiguredActor, change: EffectChangeData): unknown;
-
-    /**
-     * Apply an ActiveEffect that uses a MULTIPLY application mode.
-     * Changes which MULTIPLY must be numeric to allow for multiplication.
-     * @param actor  - The Actor to whom this effect should be applied
-     * @param change - The change data being applied
-     * @returns The resulting applied value
-     */
-    protected _applyMultiply(actor: ConfiguredActor, change: EffectChangeData): unknown;
-
-    /**
-     * Apply an ActiveEffect that uses an OVERRIDE application mode.
-     * Numeric data is overridden by numbers, while other data types are overridden by any value
-     * @param actor  - The Actor to whom this effect should be applied
-     * @param change - The change data being applied
-     * @returns The resulting applied value
-     */
-    protected _applyOverride(actor: ConfiguredActor, change: EffectChangeData): unknown;
-
-    /**
-     * Apply an ActiveEffect that uses an UPGRADE, or DOWNGRADE application mode.
-     * Changes which UPGRADE or DOWNGRADE must be numeric to allow for comparison.
-     * @param actor  - The Actor to whom this effect should be applied
-     * @param change - The change data being applied
-     * @returns The resulting applied value
-     */
-    protected _applyUpgrade(actor: ConfiguredActor, change: EffectChangeData): unknown;
-
-    /**
-     * Apply an ActiveEffect that uses a CUSTOM application mode.
-     * Changes which UPGRADE or DOWNGRADE must be numeric to allow for comparison.
-     * @param actor  - The Actor to whom this effect should be applied
-     * @param change - The change data being applied
-     * @returns The resulting applied value
-     */
-    protected _applyCustom(actor: ConfiguredActor, change: EffectChangeData): unknown;
-
-    /**
-     * Get the name of the source of the Active Effect
-     */
-    protected _getSourceName(): Promise<string>;
-
-    protected _preCreate(
-      data: ActiveEffectDataConstructorData,
-      options: DocumentModificationOptions,
-      user: foundry.documents.BaseUser
-    ): Promise<void>;
-
-    protected override _onCreate(
-      data: foundry.data.ActiveEffectData['_source'],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onUpdate(
-      data: DeepPartial<foundry.data.ActiveEffectData['_source']>,
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-
-    /**
-     * Display changes to active effects as scrolling Token status text.
-     * @internal
-     */
-    protected _displayScrollingStatus(enabled: boolean): void;
-  }
-}
-
-interface DurationSummary {
-  type: 'seconds' | 'turns' | 'none';
-  duration: number | null;
-  remaining: number | null;
-  label: string;
-}
-
-type ConfiguredActor = InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>;
-
-export {};

package/src/foundry/client/data/documents/actor.d.ts

@@ -1,231 +0,0 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredObjectClassForName,
-  DocumentConstructor
-} from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-import EmbeddedCollection from '../../../common/abstract/embedded-collection.mjs';
-import type { ActorDataConstructorData } from '../../../common/data/data.mjs/actorData.js';
-
-declare global {
-  /**
-   * The client-side Actor document which extends the common BaseActor model.
-   * Each Actor document contains ActorData which defines its data schema.
-   *
-   * @see {@link data.ActorData}              The Actor data schema
-   * @see {@link documents.Actors}            The world-level collection of Actor documents
-   * @see {@link applications.ActorSheet}     The Actor configuration application
-   *
-   * @example <caption>Create a new Actor</caption>
-   * ```typescript
-   * let actor = await Actor.create({
-   *   name: "New Test Actor",
-   *   type: "character",
-   *   img: "artwork/character-profile.jpg"
-   * });
-   * ```
-   *
-   * @example <caption>Retrieve an existing Actor</caption>
-   * ```typescript
-   * let actor = game.actors.get(actorId);
-   * ```
-   */
-  class Actor extends ClientDocumentMixin(foundry.documents.BaseActor) {
-    /**
-     * @param data    - Initial data provided to construct the Actor document
-     * @param context - The document context, see {@link foundry.abstract.Document}
-     */
-    constructor(
-      data: ConstructorParameters<typeof foundry.documents.BaseActor>[0],
-      context?: ConstructorParameters<typeof foundry.documents.BaseActor>[1]
-    );
-
-    /**
-     * An object that tracks which tracks the changes to the data model which were applied by active effects
-     * @defaultValue `{}`
-     */
-    overrides: Record<string, unknown>;
-
-    /**
-     * A cached array of image paths which can be used for this Actor's token.
-     * Null if the list has not yet been populated.
-     * @defaultValue `null`
-     */
-    protected _tokenImages: string[] | null;
-
-    /**
-     * Cache the last drawn wildcard token to avoid repeat draws
-     * @defaultValue `null`
-     */
-    protected _lastWildcard: string | null;
-
-    /**
-     * A convenient reference to the file path of the Actor's profile image
-     */
-    get img(): this['data']['img'];
-
-    /**
-     * Provide a thumbnail image path used to represent this document.
-     */
-    get thumbnail(): this['data']['img'];
-
-    /**
-     * Provide an object which organizes all embedded Item instances by their type
-     */
-    get itemTypes(): Record<
-      foundry.documents.BaseItem['data']['type'],
-      Array<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseItem>>>
-    >;
-    /**
-     * Test whether an Actor document is a synthetic representation of a Token (if true) or a full Document (if false)
-     */
-    get isToken(): boolean;
-
-    /**
-     * An array of ActiveEffect instances which are present on the Actor which have a limited duration.
-     */
-    get temporaryEffects(): ReturnType<this['effects']['filter']>;
-
-    /**
-     * Return a reference to the TokenDocument which owns this Actor as a synthetic override
-     */
-    get token(): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>> | null;
-
-    override get uuid(): string;
-
-    /**
-     * Apply any transformations to the Actor data which are caused by ActiveEffects.
-     */
-    applyActiveEffects(): void;
-
-    /**
-     * Retrieve an Array of active tokens which represent this Actor in the current canvas Scene.
-     * If the canvas is not currently active, or there are no linked actors, the returned Array will be empty.
-     * If the Actor is a synthetic token actor, only the exact Token which it represents will be returned.
-     *
-     * @param linked   - Limit results to Tokens which are linked to the Actor. Otherwise return all Tokens even those which are not linked. (default: `false`)
-     * @param document - Return the Document instance rather than the PlaceableObject (default: `false`)
-     * @returns An array of Token instances in the current Scene which reference this Actor.
-     */
-    getActiveTokens(
-      linked: boolean,
-      document: true
-    ): InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>[];
-    getActiveTokens(linked?: boolean, document?: false): InstanceType<ConfiguredObjectClassForName<'Token'>>[];
-    getActiveTokens(
-      linked: boolean,
-      document: boolean
-    ):
-      | InstanceType<ConfiguredObjectClassForName<'Token'>>[]
-      | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseToken>>[];
-
-    /**
-     * Prepare a data object which defines the data schema used by dice roll commands against this Actor
-     */
-    getRollData(): object;
-
-    /**
-     * Create a new TokenData object which can be used to create a Token representation of the Actor.
-     * @param data - Additional data, such as x, y, rotation, etc. for the created token data (default: `{}`)
-     * @returns The created TokenData instance
-     */
-    getTokenData(data?: object): Promise<foundry.data.TokenData>;
-
-    /**
-     * Get an Array of Token images which could represent this Actor
-     */
-    getTokenImages(): Promise<string[]>;
-
-    /**
-     * Handle how changes to a Token attribute bar are applied to the Actor.
-     * This allows for game systems to override this behavior and deploy special logic.
-     * @param attribute - The attribute path
-     * @param value     - The target attribute value
-     * @param isDelta   - Whether the number represents a relative change (true) or an absolute change (false) (default: `false`)
-     * @param isBar     - Whether the new value is part of an attribute bar, or just a direct value (default: `true`)
-     * @returns The updated Actor document
-     */
-    modifyTokenAttribute(attribute: string, value: number, isDelta: boolean, isBar: boolean): Promise<this | undefined>;
-
-    override prepareEmbeddedDocuments(): void;
-
-    /**
-     * Roll initiative for all Combatants in the currently active Combat encounter which are associated with this Actor.
-     * If viewing a full Actor document, all Tokens which map to that actor will be targeted for initiative rolls.
-     * If viewing a synthetic Token actor, only that particular Token will be targeted for an initiative roll.
-     *
-     * @param options - Configuration for how initiative for this Actor is rolled.
-     * @returns A promise which resolves to the Combat document once rolls are complete.
-     */
-    rollInitiative(options?: Actor.RollInitiativeOptions): Promise<void>;
-
-    override getEmbeddedCollection(
-      embeddedName: string
-    ): EmbeddedCollection<DocumentConstructor, foundry.data.ActorData>;
-
-    protected override _preCreate(
-      data: ActorDataConstructorData,
-      options: DocumentModificationOptions,
-      user: foundry.documents.BaseUser
-    ): Promise<void>;
-
-    protected override _onUpdate(
-      changed: DeepPartial<foundry.data.ActorData['_source']>,
-      options: DocumentModificationOptions,
-      user: string
-    ): void;
-
-    protected override _onCreateEmbeddedDocuments(
-      embeddedName: string,
-      documents: foundry.abstract.Document<any, any>[],
-      result: Record<string, unknown>[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onUpdateEmbeddedDocuments(
-      embeddedName: string,
-      documents: foundry.abstract.Document<any, any>[],
-      result: Record<string, unknown>[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onDeleteEmbeddedDocuments(
-      embeddedName: string,
-      documents: foundry.abstract.Document<any, any>[],
-      result: string[],
-      options: DocumentModificationContext,
-      userId: string
-    ): void;
-
-    /**
-     * Perform various actions on active tokens if embedded documents were changed.
-     * @param embeddedName - The type of embedded document that was modified.
-     * @internal
-     */
-    protected _onEmbeddedDocumentChange(embeddedName: string): void;
-  }
-  namespace Actor {
-    interface RollInitiativeOptions {
-      /**
-       * Create new Combatant entries for Tokens associated with this actor.
-       * @defaultValue `false`
-       */
-      createCombatants?: boolean;
-
-      /**
-       * Re-roll the initiative for this Actor if it has already been rolled.
-       * @defaultValue `false`
-       */
-      rerollInitiative?: boolean;
-
-      /**
-       * Additional options passed to the Combat#rollInitiative method.
-       * @defaultValue `{}`
-       * TODO: Solve once Combat is more fleshed out. @see Combat#rollInitiative
-       */
-      initiativeOptions?: object;
-    }
-  }
-}

package/src/foundry/client/data/documents/ambient-light.d.ts

@@ -1,18 +0,0 @@
-declare global {
-  /**
-   * The client-side AmbientLight document which extends the common BaseAmbientLight model.
-   * Each AmbientLight document contains AmbientLightData which defines its data schema.
-   *
-   * @see {@link data.AmbientLightData}             The AmbientLight data schema
-   * @see {@link documents.Scene}                   The Scene document type which contains AmbientLight embedded documents
-   * @see {@link applications.LightConfig}          The AmbientLight configuration application
-   */
-  class AmbientLightDocument extends CanvasDocumentMixin(foundry.documents.BaseAmbientLight) {
-    /**
-     * Is this ambient light source global in nature?
-     */
-    get isGlobal(): boolean;
-  }
-}
-
-export {};

package/src/foundry/client/data/documents/ambient-sound.d.ts

@@ -1,9 +0,0 @@
-/**
- * The client-side AmbientSound document which extends the common BaseAmbientSound model.
- * Each AmbientSound document contains AmbientSoundData which defines its data schema.
- *
- * @see {@link data.AmbientSoundData}             The AmbientSound data schema
- * @see {@link documents.Scene}                   The Scene document type which contains AmbientSound embedded documents
- * @see {@link applications.AmbientSoundConfig}   The AmbientSound configuration application
- */
-declare class AmbientSoundDocument extends CanvasDocumentMixin(foundry.documents.BaseAmbientSound) {}

package/src/foundry/client/data/documents/card.d.ts

@@ -1,133 +0,0 @@
-import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The client-side Card document which extends the common BaseCard model.
-   * Each Card document contains CardData which defines its data schema.
-   *
-   * @see {@link data.CardData}                      The Card data schema
-   * @see {@link documents.Cards}                    The Cards document type which contains Card embedded documents
-   */
-  class Card extends ClientDocumentMixin(foundry.documents.BaseCard) {
-    /**
-     * The card back.
-     * This reference is cached and lazily evaluated to retrieve an image and name from the source deck.
-     */
-    get back(): foundry.data.CardFaceData;
-
-    /**
-     * @defaultValue `undefined`
-     * @internal
-     */
-    protected _back?: foundry.data.CardFaceData | undefined;
-
-    /**
-     * The current card face
-     */
-    get face(): foundry.data.CardFaceData | null;
-
-    /**
-     * The image used to depict the back of this card
-     */
-    get backImg(): string;
-
-    /**
-     * The image of the currently displayed card face or back
-     */
-    get img(): string;
-
-    /**
-     * The name of the current card face, or the name of the card itself
-     */
-    get name(): string;
-
-    /**
-     * A reference to the source Cards document which defines this Card.
-     */
-    get source(): InstanceType<ConfiguredDocumentClassForName<'Cards'>> | undefined | null;
-
-    /**
-     * A convenience property for whether or not the Card is within its source Cards stack. Cards in decks are always
-     * considered home.
-     */
-    get isHome(): boolean;
-
-    /**
-     * Whether or not to display the face of this card?
-     */
-    get showFace(): boolean;
-
-    /**
-     * Does this Card have a next face available to flip to?
-     */
-    get hasNextFace(): boolean;
-
-    /**
-     * Does this Card have a previous face available to flip to?
-     */
-    get hasPreviousFace(): boolean;
-
-    override prepareDerivedData(): void;
-
-    /**
-     * Flip this card to some other face. A specific face may be requested, otherwise:
-     * If the card currently displays a face the card is flipped to the back.
-     * If the card currently displays the back it is flipped to the first face.
-     * @param face - A specific face to flip the card to
-     * @returns A reference to this card after the flip operation is complete
-     */
-    flip(face?: number | null | undefined): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
-
-    /**
-     * Pass this Card to some other Cards document.
-     * @param to      - A new Cards document this card should be passed to
-     * @param options - (default: `{}`)
-     * @returns A reference to this card after the it has been passed to another parent document
-     */
-    pass(
-      to: InstanceType<ConfiguredDocumentClassForName<'Cards'>>,
-      options?: Cards.PassOptions | undefined
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
-
-    /**
-     * Play a specific card to some other Cards document.
-     * This method is currently a more semantic alias for Card#pass.
-     * @see Card#pass
-     */
-    play(
-      to: InstanceType<ConfiguredDocumentClassForName<'Cards'>>,
-      options?: Cards.PassOptions | undefined
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
-
-    /**
-     * Discard a specific card to some other Cards document.
-     * This method is currently a more semantic alias for Card#pass.
-     * @see Card#pass
-     */
-    discard(
-      to: InstanceType<ConfiguredDocumentClassForName<'Cards'>>,
-      options?: Cards.PassOptions | undefined
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
-
-    /**
-     * Reset this Card to its original Cards parent.
-     * @param options - Options which modify the reset operation
-     *                  (default: `{}`)
-     * @returns A reference to the reset card belonging to its original parent
-     */
-    reset(options?: Cards.ResetOptions | undefined): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>>>;
-
-    /**
-     * Create a chat message which displays this Card.
-     * @param messageData - Additional data which becomes part of the created ChatMessageData
-     *                      (default: `{}`)
-     * @param options     - Options which modify the message creation operation
-     *                      (default: `{}`)
-     * @returns The created chat message
-     */
-    toMessage(
-      messageData?: ConstructorDataType<foundry.data.ChatMessageData> | undefined,
-      options?: DocumentModificationContext | undefined
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<'ChatMessage'>> | undefined>;
-  }
-}