@league-of-foundry-developers/foundry-vtt-types 9.268.0 → 9.268.1

package/src/foundry/common/documents.mjs/baseToken.d.ts

@@ -28,11 +28,9 @@ export declare class BaseToken extends Document<
   InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>,
   TokenMetadata
 > {
-  /** @override */
-  static get schema(): typeof data.TokenData;
+  static override get schema(): typeof data.TokenData;
 
-  /** @override */
-  static get metadata(): TokenMetadata;
+  static override get metadata(): TokenMetadata;
 
   /**
    * A convenience reference to the name which should be displayed for the Token

package/src/foundry/common/documents.mjs/baseUser.d.ts

@@ -30,11 +30,9 @@ export declare class BaseUser extends Document<data.UserData, null, UserMetadata
    */
   readonly role: ValueOf<typeof CONST.USER_ROLES>;
 
-  /** @override */
-  static get schema(): typeof data.UserData;
+  static override get schema(): typeof data.UserData;
 
-  /** @override */
-  static get metadata(): UserMetadata;
+  static override get metadata(): UserMetadata;
 
   /**
    * Is a user able to create an existing User?
@@ -79,8 +77,7 @@ export declare class BaseUser extends Document<data.UserData, null, UserMetadata
     action: ValueOf<typeof CONST.USER_ROLES> | keyof typeof CONST.USER_ROLES | keyof typeof CONST.USER_PERMISSIONS
   ): boolean;
 
-  /** @override */
-  getUserLevel(
+  override getUserLevel(
     user: BaseUser
   ): typeof CONST.DOCUMENT_PERMISSION_LEVELS.OWNER | typeof CONST.DOCUMENT_PERMISSION_LEVELS.NONE;
 

package/src/foundry/common/documents.mjs/baseWall.d.ts

@@ -32,11 +32,9 @@ export declare class BaseWall extends Document<data.WallData, InstanceType<Confi
     context?: Context<InstanceType<ConfiguredDocumentClass<typeof BaseScene>>>
   );
 
-  /** @override */
-  static get schema(): typeof data.WallData;
+  static override get schema(): typeof data.WallData;
 
-  /** @override */
-  static get metadata(): WallMetadata;
+  static override get metadata(): WallMetadata;
 
   /**
    * Is a user able to update an existing Wall?

package/src/foundry/common/packages.mjs/moduleData.d.ts

@@ -48,8 +48,7 @@ interface ModuleDataConstructorData extends PackageDataConstructorData {
  * Extends the basic PackageData schema with some additional module-specific fields.
  */
 export class ModuleData extends PackageData<ModuleDataSchema, ModuleDataProperties, ModuleDataConstructorData> {
-  /** @override */
-  static defineSchema(): ModuleDataSchema;
+  static override defineSchema(): ModuleDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/packages.mjs/packageAuthorData.d.ts

@@ -51,8 +51,7 @@ export class PackageAuthorData extends DocumentData<
 > {
   constructor(data?: PackageAuthorDataConstructorData, document?: null);
 
-  /** @override */
-  static defineSchema(): PackageAuthorDataSchema;
+  static override defineSchema(): PackageAuthorDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/packages.mjs/packageCompendiumData.d.ts

@@ -79,11 +79,9 @@ export class PackageCompendiumData extends DocumentData<
   PackageCompendiumDataSource,
   PackageCompendiumDataConstructorData
 > {
-  /** @override */
-  static defineSchema(): PackageCompendiumDataSchema;
+  static override defineSchema(): PackageCompendiumDataSchema;
 
-  /** @override */
-  _initializeSource(data: PackageCompendiumDataConstructorData): PackageCompendiumDataSource;
+  override _initializeSource(data: PackageCompendiumDataConstructorData): PackageCompendiumDataSource;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/packages.mjs/packageData.d.ts

@@ -305,11 +305,9 @@ export class PackageData<
   Properties extends Omit<PackageDataProperties, 'system'>,
   ConstructorData extends Omit<PackageDataConstructorData, 'system'>
 > extends DocumentData<Schema, Properties, PropertiesToSource<Properties>, ConstructorData> {
-  /** @override */
-  static defineSchema(): Omit<PackageDataSchema, 'system'>;
+  static override defineSchema(): Omit<PackageDataSchema, 'system'>;
 
-  /** @override */
-  _initializeSource(data: ConstructorData): PropertiesToSource<Properties>;
+  override _initializeSource(data: ConstructorData): PropertiesToSource<Properties>;
 
   /**
    * Determine the availability a package based on the version numbers of its dependencies.

package/src/foundry/common/packages.mjs/packageDependencyData.d.ts

@@ -54,14 +54,15 @@ export class PackageDependencyData extends DocumentData<
   PackageDependencyDataSource,
   PackageDependencyDataConstructorData
 > {
-  /** @override */
-  static defineSchema(): PackageDependencyDataSchema;
+  static override defineSchema(): PackageDependencyDataSchema;
 
-  /** @override */
-  protected _getMissingFieldErrorMessage(name: string, field: DocumentField<unknown>): string;
+  protected override _getMissingFieldErrorMessage(name: string, field: DocumentField<unknown>): string;
 
-  /** @override */
-  protected _getInvalidFieldValueErrorMessage(name: string, field: DocumentField<unknown>, value: unknown): string;
+  protected override _getInvalidFieldValueErrorMessage(
+    name: string,
+    field: DocumentField<unknown>,
+    value: unknown
+  ): string;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/packages.mjs/packageLanguageData.d.ts

@@ -59,11 +59,9 @@ export class PackageLanguageData extends DocumentData<
   PackageLanguageDataSource,
   PackageLanguageDataConstructorData
 > {
-  /** @override */
-  static defineSchema(): PackageLanguageDataSchema;
+  static override defineSchema(): PackageLanguageDataSchema;
 
-  /** @override */
-  protected _initialize(): void;
+  protected override _initialize(): void;
 
   /**
    * Validate that a language code is supported as a canonical locale

package/src/foundry/common/packages.mjs/systemData.d.ts

@@ -51,8 +51,7 @@ interface SystemDataConstructorData extends PackageDataConstructorData {
  * Extends the basic PackageData schema with some additional system-specific fields.
  */
 export class SystemData extends PackageData<SystemDataSchema, SystemDataProperties, SystemDataConstructorData> {
-  /** @override */
-  static defineSchema(): SystemDataSchema;
+  static override defineSchema(): SystemDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/common/packages.mjs/worldData.d.ts

@@ -69,8 +69,7 @@ interface WorldDataConstructorData extends Omit<PackageDataConstructorData, 'sys
  * Extends the basic PackageData schema with some additional world-specific fields.
  */
 export class WorldData extends PackageData<WorldDataSchema, WorldDataProperties, WorldDataConstructorData> {
-  /** @override */
-  static defineSchema(): WorldDataSchema;
+  static override defineSchema(): WorldDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface

package/src/foundry/index.d.ts

@@ -1,76 +1,3 @@
 import './common/module.mjs';
-import './foundry.js/application';
-import './foundry.js/applications';
-import './foundry.js/audioContainer';
-import './foundry.js/audioHelper';
-import './foundry.js/avClient';
-import './foundry.js/avClients';
-import './foundry.js/avMaster';
-import './foundry.js/avSettings';
-import './foundry.js/cameraPopoutAppWrapper';
-import './foundry.js/canvas';
-import './foundry.js/canvasAnimation';
-import './foundry.js/canvasDocumentMixin';
-import './foundry.js/chatBubbles';
-import './foundry.js/clientDatabaseBackend';
-import './foundry.js/clientDocumentMixin';
-import './foundry.js/clientDocuments';
-import './foundry.js/clientKeybindings';
-import './foundry.js/clientSettings';
-import './foundry.js/collections';
-import './foundry.js/collisionResult';
-import './foundry.js/config';
-import './foundry.js/contextMenu';
-import './foundry.js/dragDrop';
-import './foundry.js/draggable';
-import './foundry.js/formDataExtended';
-import './foundry.js/game';
-import './foundry.js/gameTime';
-import './foundry.js/gamepadManager';
-import './foundry.js/globalVariables';
-import './foundry.js/handlebarsHelpers';
-import './foundry.js/hooks';
-import './foundry.js/imageHelper';
-import './foundry.js/keyboardManager';
-import './foundry.js/localization';
-import './foundry.js/mersenneTwister';
-import './foundry.js/mouseInteractionManager';
-import './foundry.js/mouseManager';
-import './foundry.js/newUserExperience';
-import './foundry.js/perceptionManager';
-import './foundry.js/pixi';
-import './foundry.js/pointSource';
-import './foundry.js/pointSources';
-import './foundry.js/polygonEdge';
-import './foundry.js/polygonVertex';
-import './foundry.js/quadtree';
-import './foundry.js/quadtreeCulling';
-import './foundry.js/ray';
-import './foundry.js/rays';
-import './foundry.js/roll';
-import './foundry.js/rollTerm';
-import './foundry.js/rollTerms/diceTerm';
-import './foundry.js/rollTerms/diceTerms/coin';
-import './foundry.js/rollTerms/diceTerms/die';
-import './foundry.js/rollTerms/diceTerms/fateDie';
-import './foundry.js/rollTerms/mathTerm';
-import './foundry.js/rollTerms/numericTerm';
-import './foundry.js/rollTerms/operatorTerm';
-import './foundry.js/rollTerms/parentheticalTerm';
-import './foundry.js/rollTerms/poolTerm';
-import './foundry.js/rollTerms/stringTerm';
-import './foundry.js/screenCulling';
-import './foundry.js/searchFilter';
-import './foundry.js/socketInterface';
-import './foundry.js/sortingHelpers';
-import './foundry.js/sound';
-import './foundry.js/specialEffect';
-import './foundry.js/specialEffects';
-import './foundry.js/tabs';
-import './foundry.js/templateUtils';
-import './foundry.js/textEditor';
-import './foundry.js/textureLoader';
-import './foundry.js/textureUtils';
-import './foundry.js/userTargets';
-import './foundry.js/utils';
-import './foundry.js/videoHelper';
+import './client';
+import './templates';

package/src/foundry/templates/index.d.ts

@@ -0,0 +1 @@
+import './views/layouts/main.hbs';

package/src/foundry/templates/views/layouts/main.hbs.d.ts

@@ -0,0 +1,11 @@
+declare global {
+  const SIGNED_EULA: boolean;
+
+  const ROUTE_PREFIX: string;
+
+  const MESSAGES:
+    | { type: Notifications.Notification['type']; message: string; options: Notifications.Options }[]
+    | null;
+}
+
+export {};

package/src/types/config.d.ts

@@ -0,0 +1,183 @@
+declare global {
+  /**
+   * Some global variables (such as {@link game}) are only initialized after certain events have happened during the
+   * initialization of Foundry VTT. For that reason, the correct types for these variables include the types for the
+   * uninitialized state.
+   *
+   * While this is correct from a type checking perspective, it can be inconvenient to have to type guard these global
+   * variables everywhere. Some users might prefer the convenience over the 100% correctness in type checking.
+   *
+   * For this reason, this interface provides a way for users to configure certain global variables to be typed more
+   * leniently, i.e., as the types of their initialized state. This is done via declaration merging. To configure a
+   * specific global variable to be typed leniently, the user simply needs to merge a property with the name of the
+   * variable into this interface (the type doesn't matter).
+   *
+   * The currently supported variables are:
+   * - {@link game}
+   * - {@link socket}
+   * - {@link ui}
+   * - {@link canvas}
+   *
+   * @example
+   * ```typescript
+   * declare global {
+   *   interface LenientGlobalVariableTypes {
+   *     game: never; // the type doesn't matter
+   *   }
+   * }
+   *
+   * const referenceToGame: Game = game; // ok! :)
+   * ```
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface LenientGlobalVariableTypes {}
+
+  /**
+   * This interface is used to configure the used document classes at a type
+   * level. Module and system authors should use declaration merging to provide
+   * the types of their configured document classes. It is extremely important
+   * that this is kept in sync with the configuration that actually happens at
+   * runtime.
+   *
+   * @example
+   * ```typescript
+   * // myActor.ts
+   * class MyActor extends Actor {}
+   *
+   * // entryPoint.ts
+   * import { MyActor } from './myActor'
+   *
+   * hooks.once('init', () => {
+   *   CONFIG.Actor.documentClass = typeof MyActor;
+   * });
+   *
+   * declare global {
+   *   interface DocumentClassConfig {
+   *     Actor: typeof MyActor
+   *   }
+   * }
+   * ```
+   */
+  //eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface DocumentClassConfig {}
+
+  /**
+   * This interface is used to configure the used object classes at a type
+   * level. Module and system authors should use declaration merging to provide
+   * the types of their configured object classes. It is extremely important
+   * that this is kept in sync with the configuration that actually happens at
+   * runtime.
+   *
+   * @example
+   * ```typescript
+   * // myToken.ts
+   * class MyToken extends Token {}
+   *
+   * // entryPoint.ts
+   * import { MyToken } from './myToken'
+   *
+   * Hooks.once('init', () => {
+   *   CONFIG.Token.objectClass = MyToken;
+   * });
+   *
+   * declare global {
+   *   interface PlaceableObjectClassConfig {
+   *     Token: typeof MyToken;
+   *   }
+   * }
+   * ```
+   */
+  //eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface PlaceableObjectClassConfig {}
+
+  /**
+   * This interface together with {@link SourceConfig} is used to configure the
+   * types of the `data`  and `data._source` properties of the
+   * {@link foundry.documents.BaseActor} and {@link foundry.documents.BaseItem}
+   * classes. System authors should use declaration merging to provide the types
+   * that match their `template.json` file. It is also very important for these
+   * types to stay in sync with the `template.json` file, otherwise unexpected
+   * runtime errors might appear.
+   *
+   * @example
+   * ```typescript
+   * interface ArmorDataSourceData {
+   *   armorValue: number;
+   * }
+   *
+   * interface ArmorDataSource {
+   *   type: 'armor';
+   *   data: ArmorDataSourceData;
+   * }
+   *
+   * interface WeaponDataSourceData {
+   *   damagePerHit: number;
+   *   attackSpeed: number;
+   * }
+   *
+   * interface WeaponDataSource {
+   *   type: 'weapon';
+   *   data: WeaponDataSourceData;
+   * }
+   *
+   * interface ArmorDataPropertiesData extends ArmorDataSourceData {
+   *   weight: number;
+   * }
+   *
+   * interface ArmorDataProperties {
+   *   type: 'armor';
+   *   data: ArmorDataPropertiesData;
+   * }
+   *
+   * interface WeaponDataPropertiesData extends WeaponDataSourceData {
+   *   damage: number;
+   * }
+   *
+   * interface WeaponDataProperties {
+   *   type: 'weapon';
+   *   data: WeaponDataPropertiesData;
+   * }
+   *
+   * type MyItemDataSource = ArmorDataSource | WeaponDataSource;
+   * type MyItemDataProperties = ArmorDataProperties | WeaponDataProperties;
+   *
+   * declare global {
+   *   interface DataConfig {
+   *     Item: MyItemDataProperties;
+   *   }
+   *
+   *   interface SourceConfig {
+   *     Item: MyItemDataSource;
+   *   }
+   * }
+   * const item = await Item.create({
+   *   name: 'Axe',
+   *   type: 'weapon',
+   *   attackSpeed: 1,
+   *   damage: 5
+   * });
+   *
+   * if(item.data.type === 'weapon') {
+   *   const damage: number = item.data.data.damage;
+   * }
+   *
+   * if(item.data._source.type === 'armor') {
+   *   const armorValue = item.data._source.data.armorValue;
+   * }
+   * ```
+   */
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface DataConfig {}
+
+  /** @see {@link DataConfig} */
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface SourceConfig {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface FlagConfig {}
+
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface WebRTCConfig {}
+}
+
+export {};

package/src/types/index.d.ts

@@ -1,2 +1,3 @@
 import './augments';
+import './config';
 import './utils';

package/src/foundry/foundry.js/applications/basePlaceableHUDs/index.d.ts

@@ -1,3 +0,0 @@
-import './drawingHUD';
-import './tileHUD';
-import './tokenHUD';

package/src/foundry/foundry.js/applications/cameraViews.d.ts

@@ -1,177 +0,0 @@
-/**
- * The Camera UI View that displays all the camera feeds as individual video elements.
- * @typeParam Options - the type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class CameraViews<
-  Options extends ApplicationOptions = ApplicationOptions,
-  Data extends object = CameraViews.Data
-> extends Application<Options> {
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * return foundry.utils.mergeObject(super.defaultOptions, {
-   *   id: "camera-views",
-   *   template: "templates/hud/camera-views.html",
-   *   popOut: false
-   * })
-   * ```
-   */
-  static get defaultOptions(): ApplicationOptions;
-
-  /**
-   * A reference to the master AV orchestrator instance
-   */
-  get webrtc(): Game['webrtc'];
-
-  /**
-   * Obtain a reference to the div.camera-view which is used to portray a given Foundry User.
-   * @param userId - The ID of the User document
-   */
-  getUserCameraView(userId: string): HTMLElement | null;
-
-  /**
-   * Obtain a reference to the video.user-camera which displays the video channel for a requested Foundry User.
-   * If the user is not broadcasting video this will return null.
-   * @param userId - The ID of the User document
-   */
-  getUserVideoElement(userId: string): HTMLVideoElement | null;
-
-  /**
-   * Sets whether a user is currently speaking or not
-   *
-   * @param userId   - The ID of the user
-   * @param speaking - Whether the user is speaking
-   */
-  setUserIsSpeaking(userId: string, speaking: boolean): void;
-
-  /**
-   * Extend the render logic to first check whether a render is necessary based on the context
-   * If a specific context was provided, make sure an update to the navigation is necessary before rendering
-   */
-  render(force?: boolean, context?: Application.RenderOptions<Options>): this | void;
-
-  /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<Options>): Data | Promise<Data>;
-
-  /** @defaultValue `undefined` */
-  maxZ?: number;
-
-  /**
-   * Prepare rendering data for a single user
-   * @internal
-   */
-  protected _getDataForUser(userId: string, settings: AVSettings.UserSettings): CameraViews.Data.User | null;
-
-  /**
-   * A custom sorting function that orders/arranges the user display frames
-   * @internal
-   */
-  protected static _sortUsers(a: CameraViews.Data.User, b: CameraViews.Data.User): number;
-
-  /** @override */
-  activateListeners(html: JQuery): void;
-
-  /**
-   * On hover in a camera container, show/hide the controls.
-   * @param event - The original mouseover or mouseout hover event
-   * @internal
-   */
-  protected _onCameraViewHover(event: JQuery.MouseEnterEvent | JQuery.MouseLeaveEvent): void;
-
-  /**
-   * On clicking on a toggle, disable/enable the audio or video stream.
-   * @param event - The originating click event
-   * @internal
-   */
-  protected _onClickControl(event: JQuery.ClickEvent): Promise<void>;
-
-  /**
-   * Change volume control for a stream
-   * @param event - The originating change event from interaction with the range input
-   * @internal
-   */
-  protected _onVolumeChange(event: JQuery.ChangeEvent): void;
-
-  /**
-   * Dynamically refresh the state of a single camera view
-   * @param view - The view container div
-   * @internal
-   */
-  protected _refreshView(view: HTMLElement): void;
-
-  /**
-   * Render changes needed to the PlayerList ui.
-   * Show/Hide players depending on option.
-   * @internal
-   */
-  protected _setPlayerListVisibility(): void;
-
-  /**
-   * Get the icon class that should be used for various action buttons with different toggled states.
-   * The returned icon should represent the visual status of the NEXT state (not the CURRENT state).
-   *
-   * @param action - The named av-control button action
-   * @param state  - The CURRENT action state.
-   * @returns The icon that represents the NEXT action state.
-   * @internal
-   */
-  protected _getToggleIcon(action: string, state: boolean): string | null;
-
-  /**
-   * Get the text title that should be used for various action buttons with different toggled states.
-   * The returned title should represent the tooltip of the NEXT state (not the CURRENT state).
-   *
-   * @param action - The named av-control button action
-   * @param state - The CURRENT action state.
-   * @returns The icon that represents the NEXT action state.
-   * @internal
-   */
-  protected _getToggleTooltip(action: string, state: boolean): string;
-
-  /**
-   * Show or hide UI control elements
-   * This replaces the use of jquery.show/hide as it simply adds a class which has display:none
-   * which allows us to have elements with display:flex which can be hidden then shown without
-   * breaking their display style.
-   * This will show/hide the toggle buttons, volume controls and overlay sidebars
-   * @param container - The container for which to show/hide control elements
-   * @param show      - Whether to show or hide the controls
-   * @param selector  - Override selector to specify which controls to show or hide
-   *                    (default: `'.control-bar'`)
-   * @internal
-   */
-  protected _toggleControlVisibility(container: HTMLElement, show: boolean, selector?: string): void;
-}
-
-declare namespace CameraViews {
-  interface Data {
-    self: Game['user'];
-    users: Data.User[];
-    dockClass: string;
-    muteAll: boolean;
-  }
-
-  namespace Data {
-    interface User {
-      user: StoredDocument<globalThis.User>;
-      id: StoredDocument<globalThis.User>['id'];
-      local: StoredDocument<globalThis.User>['isSelf'];
-      name: StoredDocument<globalThis.User>['name'];
-      color: StoredDocument<globalThis.User>['data']['color'];
-      colorAlpha: `rgba(${number}, ${number}, ${number})`;
-      charname: string;
-      avatar: StoredDocument<globalThis.User>['avatar'];
-      settings: AVSettings.UserSettings;
-      volume: number;
-      cameraViewClass: string;
-    }
-  }
-}