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

package/src/foundry/{foundry.js/avClients/simplePeerAVClient.d.ts → client/av/clients/simplepeer.d.ts}

@@ -44,8 +44,7 @@ declare class SimplePeerAVClient extends AVClient {
    */
   protected _connectionPoll: number | null;
 
-  /** @override */
-  connect(): Promise<boolean>;
+  override connect(): Promise<boolean>;
 
   /**
    * Try to establish a peer connection with each user connected to the server.
@@ -53,38 +52,27 @@ declare class SimplePeerAVClient extends AVClient {
    */
   protected _connect(): Promise<SimplePeer.Instance[]>;
 
-  /** @override */
-  disconnect(): Promise<boolean>;
+  override disconnect(): Promise<boolean>;
 
-  /** @override */
-  initialize(): Promise<void>;
+  override initialize(): Promise<void>;
 
-  /** @override */
-  getConnectedUsers(): string[];
+  override getConnectedUsers(): string[];
 
-  /** @override */
-  getMediaStreamForUser(userId: string): MediaStream | null | undefined;
+  override getMediaStreamForUser(userId: string): MediaStream | null | undefined;
 
-  /** @override */
-  getLevelsStreamForUser(userId: string): MediaStream | null | undefined;
+  override getLevelsStreamForUser(userId: string): MediaStream | null | undefined;
 
-  /** @override */
-  isAudioEnabled(): boolean;
+  override isAudioEnabled(): boolean;
 
-  /** @override */
-  isVideoEnabled(): boolean;
+  override isVideoEnabled(): boolean;
 
-  /** @override */
-  toggleAudio(enable: boolean): void;
+  override toggleAudio(enable: boolean): void;
 
-  /** @override */
-  toggleBroadcast(broadcast: boolean): void;
+  override toggleBroadcast(broadcast: boolean): void;
 
-  /** @override */
-  toggleVideo(enable: boolean): void;
+  override toggleVideo(enable: boolean): void;
 
-  /** @override */
-  setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
+  override setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
 
   /**
    * Initialize a local media stream for the current user
@@ -157,9 +145,7 @@ declare class SimplePeerAVClient extends AVClient {
    */
   disconnectAll(): Promise<Array<void>>;
 
-  /** @override */
-  onSettingsChanged(changed: DeepPartial<AVSettings.Settings>): Promise<void>;
+  override onSettingsChanged(changed: DeepPartial<AVSettings.Settings>): Promise<void>;
 
-  /** @override */
-  updateLocalStream(): Promise<void>;
+  override updateLocalStream(): Promise<void>;
 }

package/src/foundry/client/av/index.d.ts

@@ -0,0 +1,4 @@
+import './client';
+import './clients';
+import './master';
+import './settings';

package/src/foundry/{foundry.js/avSettings.d.ts → client/av/settings.d.ts}

@@ -221,7 +221,7 @@ declare namespace AVSettings {
   type ClientSettings = typeof AVSettings.DEFAULT_CLIENT_SETTINGS;
   type WorldSettings = typeof AVSettings.DEFAULT_WORLD_SETTINGS;
   type StoredUserSettings = typeof AVSettings.DEFAULT_USER_SETTINGS;
-  type UserSettings = StoredUserSettings & { canBroadCastAudio: boolean; canBroadcastVideo: boolean };
+  type UserSettings = StoredUserSettings & { canBroadcastAudio: boolean; canBroadcastVideo: boolean };
   type Settings = { client: ClientSettings; world: WorldSettings };
   interface DefaultVoiceModes {
     ALWAYS: 'always';

package/src/foundry/{foundry.js → client}/config.d.ts

@@ -1,165 +1,7 @@
 import { DocumentConstructor, PlaceableObjectConstructor } from '../../types/helperTypes';
-
-type ConfiguredDocumentClassOrDefault<Fallback extends DocumentConstructor> =
-  Fallback['metadata']['name'] extends keyof DocumentClassConfig
-    ? DocumentClassConfig[Fallback['metadata']['name']]
-    : Fallback;
-
-type ConfiguredObjectClassOrDefault<Fallback extends PlaceableObjectConstructor> =
-  Fallback['embeddedName'] extends keyof PlaceableObjectClassConfig
-    ? PlaceableObjectClassConfig[Fallback['embeddedName']]
-    : Fallback;
+import type { StatusEffect } from './data/documents/token';
 
 declare global {
-  /**
-   * 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 {}
-
   /**
    * Runtime configuration settings for Foundry VTT which exposes a large number of variables which determine how
    * aspects of the software behaves.
@@ -252,31 +94,24 @@ declare global {
       /** @defaultValue `"fas fa-id-badge"` */
       sidebarIcon: string;
 
-      presets: {
-        /**
-         * @defaultValue
-         * ```javascript
-         * {
-         *   type: "deck",
-         *   label: "CARDS.DeckPresetPokerDark",
-         *   src: "cards/poker-deck-dark.json"
-         * }
-         * ```
-         */
-        pokerDark: CONFIG.Cards.Preset;
-
-        /**
-         * @defaultValue
-         * ```javascript
-         * {
-         *   type: "deck",
-         *   label: "CARDS.DeckPresetPokerLight",
-         *   src: "cards/poker-deck-light.json"
-         * }
-         * ```
-         */
-        pokerLight: CONFIG.Cards.Preset;
-      } & Record<string, CONFIG.Cards.Preset>;
+      /**
+       * @defaultValue
+       * ```typescript
+       * {
+       *    pokerDark: {
+       *      type: "deck",
+       *      label: "CARDS.DeckPresetPokerDark",
+       *      src: "cards/poker-deck-dark.json"
+       *    },
+       *    pokerLight: {
+       *      type: "deck",
+       *      label: "CARDS.DeckPresetPokerLight",
+       *      src: "cards/poker-deck-light.json"
+       *    }
+       * }
+       * ```
+       */
+      presets: Record<string, CONFIG.Cards.Preset>;
     };
 
     /**
@@ -1157,7 +992,7 @@ declare global {
      * ]
      * ```
      */
-    statusEffects: { id: string; label: string; icon: string }[];
+    statusEffects: StatusEffect[];
 
     /**
      * A mapping of core audio effects used which can be replaced by systems or mods
@@ -1565,6 +1400,16 @@ declare global {
   const CONFIG: CONFIG;
 }
 
+type ConfiguredDocumentClassOrDefault<Fallback extends DocumentConstructor> =
+  Fallback['metadata']['name'] extends keyof DocumentClassConfig
+    ? DocumentClassConfig[Fallback['metadata']['name']]
+    : Fallback;
+
+type ConfiguredObjectClassOrDefault<Fallback extends PlaceableObjectConstructor> =
+  Fallback['embeddedName'] extends keyof PlaceableObjectClassConfig
+    ? PlaceableObjectClassConfig[Fallback['embeddedName']]
+    : Fallback;
+
 type PixiContainerConstructor = typeof PIXI.Container;
 interface CanvasGroup extends PIXI.Container {
   sortableChildren: boolean;

package/src/foundry/{foundry.js → client/core}/hooks.d.ts

@@ -4,10 +4,10 @@ import {
   ConfiguredObjectClassForName,
   DocumentConstructor,
   ToObjectFalseType
-} from '../../types/helperTypes';
-import { DocumentModificationOptions } from '../common/abstract/document.mjs';
-import { EffectChangeData } from '../common/data/data.mjs/effectChangeData';
-import { DropData } from './clientDocumentMixin';
+} from '../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { EffectChangeData } from '../../common/data/data.mjs/effectChangeData';
+import { DropData } from '../data/abstract/client-document';
 
 declare global {
   /**

package/src/foundry/client/core/index.d.ts

@@ -0,0 +1,13 @@
+import './gamepad';
+import './hooks';
+import './image';
+import './keybindings';
+import './keyboard';
+import './mouse';
+import './nue';
+import './settings';
+import './socket';
+import './sorting';
+import './time';
+import './utils';
+import './video';

package/src/foundry/{foundry.js/clientKeybindings.d.ts → client/core/keybindings.d.ts}

@@ -149,9 +149,7 @@ declare class ClientKeybindings {
   /**
    * Handle Select all action
    * @param event   - The originating keyboard event
-   *                  (unused)
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onSelectAllObjects(event?: KeyboardEvent, context?: KeyboardEventContext): boolean;
@@ -166,16 +164,14 @@ declare class ClientKeybindings {
   /**
    * Handle Dismiss actions
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onDismiss(context?: KeyboardEventContext): boolean;
 
   /**
    * Open Character sheet for current token or controlled actor
-   * @param event   - (unused)
+   * @param event   -
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onToggleCharacterSheet(event?: KeyboardEvent, context?: KeyboardEventContext): ActorSheet | null;
@@ -191,7 +187,6 @@ declare class ClientKeybindings {
    * Handle DELETE Keypress Events
    * @param event   - The originating keyboard event
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onDelete(event: KeyboardEvent, context?: KeyboardEventContext): boolean;
@@ -210,7 +205,6 @@ declare class ClientKeybindings {
   /**
    * Handle Measured Ruler Movement Action
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onMeasuredRulerMovement(context?: KeyboardEventContext): boolean | void;
@@ -218,7 +212,6 @@ declare class ClientKeybindings {
   /**
    * Handle Pause Action
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onPause(context?: KeyboardEventContext): true;
@@ -226,7 +219,6 @@ declare class ClientKeybindings {
   /**
    * Handle Highlight action
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onHighlight(context?: KeyboardEventContext): boolean;
@@ -259,7 +251,6 @@ declare class ClientKeybindings {
   /**
    * Handle action to copy data to clipboard
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onCopy(context?: KeyboardEventContext): boolean;
@@ -274,7 +265,6 @@ declare class ClientKeybindings {
   /**
    * Handle Undo action
    * @param context - The context data of the event
-   *                  (unused)
    * @internal
    */
   protected static _onUndo(context?: KeyboardEventContext): boolean;
@@ -282,7 +272,6 @@ declare class ClientKeybindings {
   /**
    * Handle presses to keyboard zoom keys
    * @param context       - The context data of the event
-   *                        (unused)
    * @param zoomDirection - The direction to zoom
    * @internal
    */

package/src/foundry/{foundry.js/clientSettings.d.ts → client/core/settings.d.ts}

@@ -1,6 +1,6 @@
-import type { DocumentSubTypes, DocumentType } from '../../types/helperTypes';
+import type { DocumentSubTypes, DocumentType } from '../../../types/helperTypes';
 
-import type { TokenDataSource } from '../common/data/data.mjs/tokenData';
+import type { TokenDataSource } from '../../common/data/data.mjs/tokenData';
 
 declare global {
   /**

package/src/foundry/{foundry.js/canvasDocumentMixin.d.ts → client/data/abstract/canvas-document.d.ts}

@@ -1,6 +1,6 @@
-import { ConstructorDataType } from '../../types/helperTypes';
-import { ContextType, DocumentModificationOptions } from '../common/abstract/document.mjs';
-import { ClientDocumentMixin } from './clientDocumentMixin';
+import { ConstructorDataType } from '../../../../types/helperTypes';
+import { ContextType, DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import { ClientDocumentMixin } from './client-document';
 
 declare global {
   // TODO: Replace ConstructorOf<…> with DocumentConstructor once the problem with circular reference has been solved

package/src/foundry/{foundry.js/clientDatabaseBackend.d.ts → client/data/abstract/client-backend.d.ts}

@@ -1,6 +1,6 @@
-import type { ConfiguredDocumentClassForName } from '../../types/helperTypes';
-import type { Request } from '../common/abstract/backend.mjs';
-import type Document from '../common/abstract/document.mjs';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { Request } from '../../../common/abstract/backend.mjs.js';
+import type Document from '../../../common/abstract/document.mjs.js';
 
 declare global {
   /**
@@ -13,35 +13,31 @@ declare global {
      */
     activateSocketListeners(socket: io.Socket): void;
 
-    /** @override */
-    protected _getDocuments<T extends Document<any, any>>(
+    protected override _getDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       request: Request,
       user: InstanceType<ConfiguredDocumentClassForName<'User'>>
     ): Promise<T[]>;
 
     /**
-     * @override
      * @remarks
      * Get operations for embedded Documents are currently un-supported.
      * The returned promise always rejects.
      */
-    protected _getEmbeddedDocuments<T extends Document<any, any>>(
+    protected override _getEmbeddedDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       parent: T extends Document<any, infer U> ? U : never,
       request: Request,
       user: InstanceType<ConfiguredDocumentClassForName<'User'>>
     ): Promise<never>;
 
-    /** @override */
-    protected _createDocuments<T extends Document<any, any>>(
+    protected override _createDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       request: Request,
       user: InstanceType<ConfiguredDocumentClassForName<'User'>>
     ): Promise<T[]>;
 
-    /** @override */
-    protected _createEmbeddedDocuments<T extends Document<any, any>>(
+    protected override _createEmbeddedDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       parent: T extends Document<any, infer U> ? U : never,
       request: Request,
@@ -93,15 +89,13 @@ declare global {
       { options, userId, parent, pack }: Pick<Request, 'options' | 'parent' | 'pack'> & { userId?: string }
     ): (() => void)[];
 
-    /** @override */
-    protected _updateDocuments<T extends Document<any, any>>(
+    protected override _updateDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       request: Request,
       user: InstanceType<ConfiguredDocumentClassForName<'User'>>
     ): Promise<T[]>;
 
-    /** @override */
-    protected _updateEmbeddedDocuments<T extends Document<any, any>>(
+    protected override _updateEmbeddedDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       parent: T extends Document<any, infer U> ? U : never,
       request: Request,
@@ -150,15 +144,13 @@ declare global {
       { options, userId }: Pick<Request, 'options'> & { userId?: string }
     ): () => void;
 
-    /** @override */
-    protected _deleteDocuments<T extends Document<any, any>>(
+    protected override _deleteDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       request: Request,
       user: InstanceType<ConfiguredDocumentClassForName<'User'>>
     ): Promise<T[]>;
 
-    /** @override */
-    protected _deleteEmbeddedDocuments<T extends Document<any, any>>(
+    protected override _deleteEmbeddedDocuments<T extends Document<any, any>>(
       documentClass: ConstructorOf<T>,
       parent: T extends Document<any, infer U> ? U : never,
       request: Request,
@@ -205,11 +197,9 @@ declare global {
       { options, userId }: Pick<Request, 'options'> & { userId?: string }
     ): (() => void)[];
 
-    /** @override */
-    getFlagScopes(): string[];
+    override getFlagScopes(): string[];
 
-    /** @override */
-    getCompendiumScopes(): string[];
+    override getCompendiumScopes(): string[];
   }
 }
 

package/src/foundry/{foundry.js/clientDocumentMixin.d.ts → client/data/abstract/client-document.d.ts}

@@ -1,6 +1,5 @@
-import { ContextType, DocumentModificationOptions } from '../common/abstract/document.mjs';
-
-import { ConfiguredDocumentClass, ConstructorDataType, DocumentConstructor } from '../../types/helperTypes';
+import { ContextType, DocumentModificationOptions } from '../../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass, ConstructorDataType, DocumentConstructor } from '../../../../types/helperTypes';
 
 declare global {
   // TODO: Replace ConstructorOf<…> with DocumentConstructor once the problem with circular reference has been solved
@@ -371,7 +370,6 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * Remove any features of the data which are world-specific.
    * This function is asynchronous in case any complex operations are required prior to exporting.
    * @param pack    - A specific pack being exported to
-   *                  (unused)
    * @param options - Additional options which modify how the document is converted
    *                  (default: `{}`)
    * @returns A data object of cleaned data suitable for compendium import
@@ -439,5 +437,3 @@ interface FromDropDataOptions {
    */
   importWorld?: boolean;
 }
-
-export {};

package/src/foundry/{foundry.js/collections/documentCollection.d.ts → client/data/abstract/document-collection.d.ts}

@@ -1,5 +1,5 @@
-import { ConfiguredDocumentClass, DocumentConstructor } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import { ConfiguredDocumentClass, DocumentConstructor } from '../../../../types/helperTypes';
+import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
   /**

package/src/foundry/client/data/abstract/index.d.ts

@@ -0,0 +1,5 @@
+import './canvas-document';
+import './client-backend';
+import './client-document';
+import './document-collection';
+import './world-collection';

package/src/foundry/{foundry.js/collections/documentCollections/worldCollection.d.ts → client/data/abstract/world-collection.d.ts}

@@ -1,5 +1,5 @@
 import { ConfiguredDocumentClass, DocumentConstructor } from '../../../../types/helperTypes';
-import type { DOCUMENT_TYPES } from '../../../common/constants.mjs';
+import type { DOCUMENT_TYPES } from '../../../common/constants.mjs.js';
 
 declare global {
   /**
@@ -60,8 +60,7 @@ declare global {
      */
     static get instance(): WorldCollection<DocumentConstructor, any>; // TODO: Find a way to type this more concretely. One option would be to separate the static and non static side of this class, which allows accessing the the static this type to use the `documentName`.
 
-    /** @override */
-    set(id: string, document: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>): this;
+    override set(id: string, document: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>): this;
 
     delete: (id: string) => boolean;
 

package/src/foundry/{foundry.js/collections/documentCollections/worldCollections → client/data/collections}/actors.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
 
 declare global {
   /**
@@ -20,11 +20,9 @@ declare global {
      */
     get tokens(): Partial<Record<string, InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>>>;
 
-    /** @override */
-    static documentName: 'Actor';
+    static override documentName: 'Actor';
 
-    /** @override */
-    fromCompendium(
+    override fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],