@league-of-foundry-developers/foundry-vtt-types 9.255.0 → 9.255.3

package/src/foundry/foundry.js/applications/formApplications/worldConfig.d.ts

@@ -1,13 +1,24 @@
+interface WorldConfigOptions extends FormApplicationOptions {
+  /**
+   * Whether the world is being created or updated.
+   * @defaultValue `false`
+   */
+  create: boolean;
+
+  inWorld?: boolean | undefined;
+}
+
 /**
  * The World Management setup application
  * @typeParam Options - The type of the options object
  * @typeParam Data    - The data structure used to render the handlebars template.
  */
 declare class WorldConfig<
-  Options extends WorldConfig.Options = WorldConfig.Options,
+  Options extends WorldConfigOptions = WorldConfigOptions,
   Data extends object = WorldConfig.Data
 > extends FormApplication<Options, Data, Game.WorldData<foundry.packages.WorldData>> {
   /**
+   * @override
    * @defaultValue
    * ```typescript
    * foundry.utils.mergeObject(super.defaultOptions, {
@@ -19,13 +30,16 @@ declare class WorldConfig<
    * })
    * ```
    */
-  static get defaultOptions(): WorldConfig.Options;
+  static get defaultOptions(): WorldConfigOptions;
 
   static WORLD_KB_URL: 'https://foundryvtt.com/article/game-worlds/';
 
   /** @override */
   get title(): string;
 
+  /** @override */
+  activateListeners(html: JQuery): void;
+
   /** @override */
   getData(options?: Partial<Options>): Data | Promise<Data>;
 
@@ -40,8 +54,14 @@ declare class WorldConfig<
    */
   protected _updateObject(...args: unknown[]): Promise<unknown>;
 
+  /**
+   * Update the world name placeholder when the title is changed.
+   * @internal
+   */
+  protected _onTitleChange(event: JQuery.TriggeredEvent): void;
+
   /** @override **/
-  activateEditor(name: string, options?: TextEditor.Options, initialContent?: string): void;
+  activateEditor(name: string, options?: TextEditor.Options | undefined, initialContent?: string | undefined): void;
 }
 
 declare namespace WorldConfig {
@@ -56,13 +76,4 @@ declare namespace WorldConfig {
     showEditFields: boolean;
     systems?: Game.SystemData<foundry.packages.SystemData>[];
   }
-
-  interface Options extends FormApplicationOptions {
-    /**
-     * @defaultValue `false`
-     */
-    create: boolean;
-
-    inWorld?: boolean;
-  }
 }

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

@@ -94,11 +94,15 @@ declare global {
     /** @override */
     activateListeners(html: JQuery): void;
 
+    /** @override */
+    protected _contextMenu(html: JQuery): void;
+
     /**
-     * Create a Context Menu attached to each Macro button
-     * @param html - The HTML being rendered for the hotbar
+     * Get the Macro entry context options
+     * @returns The Macro entry context options
+     * @internal
      */
-    protected _contextMenu(html: JQuery): void;
+    protected _getEntryContextOptions(): ContextMenuEntry[];
 
     /**
      * Handle left-click events to

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

@@ -91,7 +91,10 @@ declare global {
      */
     protected _onToggleNav(event: JQuery.ClickEvent): void;
 
-    static _onLoadProgress(context: string, pct: number): void;
+    /**
+     * Display progress of some major operation like loading Scene textures.
+     */
+    static displayProgressBar(options: SceneNavigation.DisplayProgressBarOptions): void;
   }
 
   namespace SceneNavigation {
@@ -104,5 +107,17 @@ declare global {
         css: string;
       })[];
     }
+
+    interface DisplayProgressBarOptions {
+      /**
+       * A text label to display
+       */
+      label?: string | undefined;
+
+      /**
+       * A percentage of progress between 0 and 100
+       */
+      pct: number;
+    }
   }
 }

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

@@ -84,6 +84,13 @@ declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> e
    */
   protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
 
+  /**
+   * Handle the special case of left-clicking a tab when the sidebar is collapsed.
+   * @param event - The originating click event
+   * @internal
+   */
+  protected _onLeftClickTab(event: MouseEvent): void;
+
   /**
    * Handle right-click events on tab controls to trigger pop-out containers for each tab
    * @param event - The originating contextmenu event

package/src/foundry/foundry.js/avClient.d.ts

@@ -82,7 +82,7 @@ declare abstract class AVClient {
    * @param kind - The type of device source being requested
    * @internal
    */
-  _getSourcesOfType(kind: MediaDeviceKind): Promise<Record<string, string>>;
+  protected _getSourcesOfType(kind: MediaDeviceKind): Promise<Record<string, string>>;
 
   /**
    * Return an array of Foundry User IDs which are currently connected to A/V.
@@ -98,6 +98,14 @@ declare abstract class AVClient {
    */
   abstract getMediaStreamForUser(userId: string): MediaStream | null | undefined;
 
+  /**
+   * Provide a MediaStream for monitoring a given user's voice volume levels.
+   * @param userId - The User ID.
+   * @returns The MediaStream for the user, or null if the user does not have one.
+   * @remarks The getLevelsStreamForUser() method must be defined by an AVClient subclass and will be strictly required starting in v10
+   */
+  getLevelsStreamForUser(userId: string): MediaStream | null | undefined;
+
   /**
    * Is outbound audio enabled for the current user?
    */
@@ -141,4 +149,10 @@ declare abstract class AVClient {
    * @param changed - The settings which have changed
    */
   onSettingsChanged(changed: DeepPartial<AVSettings.Settings>): void;
+
+  /**
+   * Replace the local stream for each connected peer with a re-generated MediaStream.
+   * @remarks The updateLocalStream() method must be defined by an AVClient subclass.
+   */
+  abstract updateLocalStream(): Promise<void>;
 }

package/src/foundry/foundry.js/avClients/index.d.ts

@@ -1,2 +1 @@
-import './easyRTCClient';
 import './simplePeerAVClient';

package/src/foundry/foundry.js/avClients/simplePeerAVClient.d.ts

@@ -9,6 +9,12 @@ declare class SimplePeerAVClient extends AVClient {
    */
   localStream: MediaStream | null;
 
+  /**
+   * The dedicated audio stream used to measure volume levels for voice activity detection.
+   * @defaultValue `null`
+   */
+  levelsStream: MediaStream | null;
+
   /**
    * A mapping of connected peers
    */
@@ -24,7 +30,7 @@ declare class SimplePeerAVClient extends AVClient {
    * @defaultValue `false`
    * @internal
    */
-  _initialized: boolean;
+  protected _initialized: boolean;
 
   /**
    * Is outbound broadcast of local audio enabled?
@@ -32,9 +38,21 @@ declare class SimplePeerAVClient extends AVClient {
    */
   audioBroadcastEnabled: boolean;
 
+  /**
+   * The polling interval ID for connected users that might have unexpectedly dropped out of our peer network.
+   * @internal
+   */
+  protected _connectionPoll: number | null;
+
   /** @override */
   connect(): Promise<boolean>;
 
+  /**
+   * Try to establish a peer connection with each user connected to the server.
+   * @internal
+   */
+  protected _connect(): Promise<SimplePeer.Instance[]>;
+
   /** @override */
   disconnect(): Promise<boolean>;
 
@@ -47,6 +65,9 @@ declare class SimplePeerAVClient extends AVClient {
   /** @override */
   getMediaStreamForUser(userId: string): MediaStream | null | undefined;
 
+  /** @override */
+  getLevelsStreamForUser(userId: string): MediaStream | null | undefined;
+
   /** @override */
   isAudioEnabled(): boolean;
 
@@ -70,6 +91,14 @@ declare class SimplePeerAVClient extends AVClient {
    */
   initializeLocalStream(): Promise<MediaStream | null>;
 
+  /**
+   * Attempt to create local media streams.
+   * @param params - Parameters for the getUserMedia request.
+   * @returns The created MediaStream or an error.
+   * @internal
+   */
+  protected _createMediaStream(params: MediaStreamConstraints): Promise<MediaStream | Error>;
+
   /**
    * Listen for Audio/Video updates on the av socket to broker connections between peers
    */
@@ -131,8 +160,6 @@ declare class SimplePeerAVClient extends AVClient {
   /** @override */
   onSettingsChanged(changed: DeepPartial<AVSettings.Settings>): Promise<void>;
 
-  /**
-   * Replace the local stream for each connected peer with a re-generated MediaStream
-   */
+  /** @override */
   updateLocalStream(): Promise<void>;
 }

package/src/foundry/foundry.js/avMaster.d.ts

@@ -29,24 +29,26 @@ declare class AVMaster {
   protected _connected: boolean;
 
   /**
-   * A flag to track whether the A/V system is currently in the process of reconnecting.
-   * This occurs if the connection is lost or interrupted.
-   * @defaultValue `false`
+   * The cached connection promise.
+   * This is required to prevent re-triggering a connection while one is already in progress.
+   * @defaultValue `null`
    * @internal
    */
-  protected _reconnecting: boolean;
+  protected _connecting: Promise<boolean> | null;
 
   /**
-   * @defaultValue `{}`
+   * A flag to track whether the A/V system is currently in the process of reconnecting.
+   * This occurs if the connection is lost or interrupted.
+   * @defaultValue `false`
    * @internal
    */
-  protected _speakingData: AVMaster.SpeakingData;
+  protected _reconnecting: boolean;
 
   /**
    * @defaultValue `{}`
    * @internal
    */
-  protected _pttHandlers: AVMaster.PTTHandlers;
+  protected _speakingData: { speaking: boolean; volumeHistories: number[] };
 
   /**
    * @defaultValue `0`
@@ -54,7 +56,7 @@ declare class AVMaster {
    */
   protected _pttMuteTimeout: number;
 
-  get mode(): AVSettings.VoiceMode;
+  get mode(): AVSettings.AV_MODES;
 
   /**
    * Connect to the Audio/Video client.
@@ -111,29 +113,27 @@ declare class AVMaster {
    * @param mode - The currently selected voice broadcasting mode
    * @internal
    */
-  protected _initializeUserVoiceDetection(mode: AVSettings.VoiceMode): void;
+  protected _initializeUserVoiceDetection(mode: AVSettings.VOICE_MODES): void;
 
   /**
    * Activate voice detection tracking for a userId on a provided MediaStream.
    * Currently only a MediaStream is supported because MediaStreamTrack processing is not yet supported cross-browser.
-   * @param userId - The Foundry User ID whose voice is being processed
    * @param stream - The MediaStream which corresponds to that User
    * @param ms     - A number of milliseconds which represents the voice activation volume interval
    *                 (default: `CONFIG.WebRTC.detectPeerVolumeInterval`)
    */
-  activateVoiceDetection(userId: string, stream: MediaStream, ms?: number): void;
+  activateVoiceDetection(stream: MediaStream, ms?: number): void;
 
   /**
    * Actions which the orchestration layer should take when a peer user disconnects from the audio/video service.
-   * @param userId - The id of the disconnecting User
    */
-  deactivateVoiceDetection(userId: string): void;
+  deactivateVoiceDetection(): void;
 
   /**
    * Periodic notification of user audio level
    *
-   * This function uses the audio level (in dB) of each stream it's listening to to determine if a user
-   * is speaking or not and notifies the UI of such changes.
+   * This function uses the audio level (in dB) of the audio stream to determine if the user is speaking or not and
+   * notifies the UI of such changes.
    *
    * The User is considered speaking if they are above the decibel threshold in any of the history values.
    * This marks them as speaking as soon as they have a high enough volume, and marks them as not speaking only after
@@ -142,46 +142,31 @@ declare class AVMaster {
    * There can be more optimal ways to do this and which uses whether the user was already considered speaking before
    * or not, in order to eliminate short bursts of audio (coughing for example).
    *
-   * @param userId  - The user ID of the user whose audio levels are being reported
    * @param dbLevel - The audio level in decibels of the user within the last 50ms
    * @internal
    */
-  protected _onAudioLevel(userId: string, dbLevel: number): void;
-
-  /**
-   * Set up interactivity and handling of push-to-talk broadcasting workflow.
-   * @internal
-   */
-  protected _initializePushToTalk(): void;
+  protected _onAudioLevel(dbLevel: number): void;
 
   /**
    * Resets the speaking history of a user
    * If the user was considered speaking, then mark them as not speaking
-   * @param userId - The ID of the user
    * @internal
    */
-  protected _resetSpeakingHistory(userId: string): void;
+  protected _resetSpeakingHistory(): void;
 
   /**
    * Handle activation of a push-to-talk key or button.
-   * @param event - The original keydown event
+   * @param context - The context data of the event
    * @internal
    */
-  _onPTTStart(event: KeyboardEvent | MouseEvent): void;
+  _onPTTStart(context: KeyboardEventContext): void;
 
   /**
    * Handle deactivation of a push-to-talk key or button.
-   * @param event - The original keyup event
+   * @param context - The context data of the event
    * @internal
    */
-  _onPTTEnd(event: KeyboardEvent | MouseEvent): void;
-
-  /**
-   * Handle matching old and new PTT configurations against the mouse or keyboard event.
-   * @param event - The original event
-   * @internal
-   */
-  _isPTTKey(event: KeyboardEvent | MouseEvent): boolean;
+  _onPTTEnd(context: KeyboardEventContext): void;
 
   render(): void;
 
@@ -200,15 +185,3 @@ declare class AVMaster {
 
   debug(message: string): void;
 }
-
-declare namespace AVMaster {
-  type SpeakingData = Partial<Record<string, { speaking: boolean; volumeHistories: number[] }>>;
-  type PTTHandler = (event: KeyboardEvent | MouseEvent) => void;
-  type PTTHandlers =
-    | {}
-    | { mousedown: PTTHandler; mouseup: PTTHandler }
-    | {
-        keydown: PTTHandler;
-        keyup: PTTHandler;
-      };
-}

package/src/foundry/foundry.js/avSettings.d.ts

@@ -12,9 +12,11 @@ interface AVSettingsData {
 declare class AVSettings {
   constructor();
 
-  protected _set<T>(key: string, value: T): void;
+  /** @internal */
+  protected _set: <T>(key: string, value: T) => void;
 
-  protected _change(): void;
+  /** @internal */
+  protected _change: () => void;
 
   client: AVSettings.ClientSettings;
 
@@ -74,15 +76,7 @@ declare class AVSettings {
       /**
        * @defaultValue `'AVSettings.VOICE_MODES.PTT'`
        */
-      mode: AVSettings.VoiceMode;
-
-      /**
-       * @defaultValue
-       * ```
-       * "`"
-       * ```
-       */
-      pttKey: string;
+      mode: AVSettings.VOICE_MODES;
 
       /**
        * @defaultValue
@@ -92,11 +86,6 @@ declare class AVSettings {
        */
       pttName: string;
 
-      /**
-       * @defaultValue `false`
-       */
-      pttMouse: boolean;
-
       /**
        * @defaultValue `100`
        */
@@ -111,41 +100,14 @@ declare class AVSettings {
     /**
      * @defaultValue `{}`
      */
-    users: Partial<Record<string, AVSettings.StoredUserSettings>>;
+    users: Record<string, AVSettings.StoredUserSettings>;
   };
 
   static DEFAULT_WORLD_SETTINGS: {
     /**
      * @defaultValue `AVSettings.AV_MODES.DISABLED`
      */
-    mode: AVSettings.VoiceMode;
-
-    server: {
-      /**
-       * @defaultValue `'FVTT'`
-       */
-      type: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      url: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      room: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      username: string;
-
-      /**
-       * @defaultValue `""`
-       */
-      password: string;
-    };
+    mode: AVSettings.AV_MODES;
 
     turn: {
       /**
@@ -217,6 +179,11 @@ declare class AVSettings {
     blocked: boolean;
   };
 
+  /**
+   * Stores the transient AV activity data received from other users.
+   */
+  activity: Record<string, AVSettingsData>;
+
   initialize(): void;
 
   changed(): void;
@@ -243,6 +210,11 @@ declare class AVSettings {
    * @internal
    */
   protected _onSettingsChanged(): void;
+
+  /**
+   * Handle another connected user changing their AV settings.
+   */
+  handleUserActivity(userId: string, settings: AVSettingsData): void;
 }
 
 declare namespace AVSettings {
@@ -259,5 +231,6 @@ declare namespace AVSettings {
   // eslint-disable-next-line @typescript-eslint/no-empty-interface
   interface Overrides {}
   type VoiceModes = PropertyTypeOrFallback<AVSettings.Overrides, 'VoiceModes', DefaultVoiceModes>;
-  type VoiceMode = ValueOf<VoiceModes>;
+  type VOICE_MODES = ValueOf<VoiceModes>;
+  type AV_MODES = ValueOf<typeof AVSettings.AV_MODES>;
 }

package/src/foundry/foundry.js/clientDocumentMixin.d.ts

@@ -320,7 +320,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
           | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
         >
       | undefined,
-    context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<Dialog.Options>) | undefined
+    context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<DialogOptions>) | undefined
   ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
 
   /**
@@ -329,7 +329,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    *                  (default: `{}`)
    * @returns A Promise which resolves to the deleted Document
    */
-  deleteDialog(options?: Partial<Dialog.Options> | undefined): Promise<this | false | null | undefined>;
+  deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
 
   /**
    * Export document data to a JSON file which can be saved by the client and later imported into a different session.
@@ -377,8 +377,8 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * @returns A data object of cleaned data suitable for compendium import
    */
   toCompendium(
-    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-    options?: ClientDocumentMixin.CompendiumExportOptions
+    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+    options?: ClientDocumentMixin.CompendiumExportOptions | undefined
   ): Omit<T['data']['_source'], '_id' | 'folder' | 'permission'> & {
     permission?: T['data']['_source']['permission'];
   };

package/src/foundry/foundry.js/clientDocuments/activeEffect.d.ts

@@ -31,6 +31,11 @@ declare global {
      */
     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
      */
@@ -63,12 +68,6 @@ declare global {
      */
     get sourceName(): string;
 
-    /**
-     * An instance of the ActiveEffectConfig sheet to use for this ActiveEffect instance.
-     * The reference to the sheet is cached so the same sheet instance is reused.
-     */
-    get sheet(): FormApplication; // TODO: Actually an ActiveEffectConfig according to foundry but this is a problem with ClientDocumentMixin's sheet, this should actually be inferred from the CONFIG
-
     /**
      * Apply this ActiveEffect to a provided Actor.
      * @param actor  - The Actor to whom this effect should be applied
@@ -138,6 +137,29 @@ declare global {
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;
+
+    /** @override */
+    protected _onCreate(
+      data: foundry.data.ActiveEffectData['_source'],
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    /** @override */
+    protected _onUpdate(
+      data: DeepPartial<foundry.data.ActiveEffectData['_source']>,
+      options: DocumentModificationOptions,
+      userId: string
+    ): void;
+
+    /** @override */
+    protected _onDelete(options: DocumentModificationOptions, userId: string): void;
+
+    /**
+     * Display changes to active effects as scrolling Token status text.
+     * @internal
+     */
+    protected _displayScrollingStatus(enabled: boolean): void;
   }
 }