@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1-beta.20250704.94554

package/src/foundry/client/av/client.d.mts

@@ -1,162 +1,165 @@
-import type { DeepPartial } from "fvtt-types/utils";
-
-declare global {
-  /**
-   * An interface for an Audio/Video client which is extended to provide broadcasting functionality.
-   */
-  abstract class AVClient {
-    /**
-     * @param master   - The master orchestration instance
-     * @param settings - The audio/video settings being used
-     */
-    constructor(master: AVMaster, settings: AVSettings);
-
-    /**
-     * The master orchestration instance
-     */
-    master: AVMaster;
-
-    /**
-     * The active audio/video settings being used
-     */
-    settings: AVSettings;
-
-    /**
-     * Is audio broadcasting push-to-talk enabled?
-     */
-    get isVoicePTT(): boolean;
-
-    /**
-     * Is audio broadcasting always enabled?
-     */
-    get isVoiceAlways(): boolean;
-
-    /**
-     * Is audio broadcasting voice-activation enabled?
-     */
-    get isVoiceActivated(): boolean;
-
-    /**
-     * Is the current user muted?
-     */
-    get isMuted(): boolean;
-
-    /**
-     * One-time initialization actions that should be performed for this client implementation.
-     * This will be called only once when the Game object is first set-up.
-     */
-    abstract initialize(): Promise<void>;
-
-    /**
-     * Connect to any servers or services needed in order to provide audio/video functionality.
-     * Any parameters needed in order to establish the connection should be drawn from the settings object.
-     * This function should return a boolean for whether the connection attempt was successful.
-     * @returns Was the connection attempt successful?
-     */
-    abstract connect(): Promise<boolean>;
-
-    /**
-     * Disconnect from any servers or services which are used to provide audio/video functionality.
-     * This function should return a boolean for whether a valid disconnection occurred.
-     * @returns Did a disconnection occur?
-     */
-    abstract disconnect(): Promise<boolean>;
-
-    /**
-     * Provide an Object of available audio sources which can be used by this implementation.
-     * Each object key should be a device id and the key should be a human-readable label.
-     */
-    getAudioSinks(): Promise<Record<string, string>>;
-
-    /**
-     * Provide an Object of available audio sources which can be used by this implementation.
-     * Each object key should be a device id and the key should be a human-readable label.
-     */
-    getAudioSources(): Promise<Record<string, string>>;
-
-    /**
-     * Provide an Object of available video sources which can be used by this implementation.
-     * Each object key should be a device id and the key should be a human-readable label.
-     */
-    getVideoSources(): Promise<Record<string, string>>;
-
-    /**
-     * Obtain a mapping of available device sources for a given type.
-     * @param kind - The type of device source being requested
-     * @internal
-     */
-    protected _getSourcesOfType(kind: MediaDeviceKind): Promise<Record<string, string>>;
-
-    /**
-     * Return an array of Foundry User IDs which are currently connected to A/V.
-     * The current user should also be included as a connected user in addition to all peers.
-     * @returns The connected User IDs
-     */
-    abstract getConnectedUsers(): string[];
-
-    /**
-     * Provide a MediaStream instance for a given user ID
-     * @param userId - The User id
-     * @returns The MediaStream for the user, or null if the user does not have one
-     */
-    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?
-     */
-    abstract isAudioEnabled(): boolean;
-
-    /**
-     * Is outbound video enabled for the current user?
-     */
-    abstract isVideoEnabled(): boolean;
-
-    /**
-     * Set whether the outbound audio feed for the current game user is enabled.
-     * This method should be used when the user marks themselves as muted or if the gamemaster globally mutes them.
-     * @param enable - Whether the outbound audio track should be enabled (true) or disabled (false)
-     */
-    abstract toggleAudio(enable: boolean): void;
-
-    /**
-     * Set whether the outbound audio feed for the current game user is actively broadcasting.
-     * This can only be true if audio is enabled, but may be false if using push-to-talk or voice activation modes.
-     * @param broadcast - Whether outbound audio should be sent to connected peers or not?
-     */
-    abstract toggleBroadcast(broadcast: boolean): void;
-
-    /**
-     * Set whether the outbound video feed for the current game user is enabled.
-     * This method should be used when the user marks themselves as hidden or if the gamemaster globally hides them.
-     * @param enable - Whether the outbound audio track should be enabled (true) or disabled (false)
-     */
-    abstract toggleVideo(enable: boolean): void;
-
-    /**
-     * Set the Video Track for a given User ID to a provided VideoElement
-     * @param userId       - The User ID to set to the element
-     * @param videoElement - The HTMLVideoElement to which the video should be set
-     */
-    abstract setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
-
-    /**
-     * Handle changes to A/V configuration settings.
-     * @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>;
-  }
+import type { DeepPartial } from "#utils";
+
+import AVMaster = foundry.av.AVMaster;
+import AVSettings = foundry.av.AVSettings;
+
+/**
+ * An interface for an Audio/Video client which is extended to provide broadcasting functionality.
+ */
+declare abstract class AVClient {
+  /**
+   * @param master   - The master orchestration instance
+   * @param settings - The audio/video settings being used
+   */
+  constructor(master: AVMaster, settings: AVSettings);
+
+  /**
+   * The master orchestration instance
+   */
+  master: AVMaster;
+
+  /**
+   * The active audio/video settings being used
+   */
+  settings: AVSettings;
+
+  /**
+   * Is audio broadcasting push-to-talk enabled?
+   */
+  get isVoicePTT(): boolean;
+
+  /**
+   * Is audio broadcasting always enabled?
+   */
+  get isVoiceAlways(): boolean;
+
+  /**
+   * Is audio broadcasting voice-activation enabled?
+   */
+  get isVoiceActivated(): boolean;
+
+  /**
+   * Is the current user muted?
+   */
+  get isMuted(): boolean;
+
+  /**
+   * One-time initialization actions that should be performed for this client implementation.
+   * This will be called only once when the Game object is first set-up.
+   */
+  abstract initialize(): Promise<void>;
+
+  /**
+   * Connect to any servers or services needed in order to provide audio/video functionality.
+   * Any parameters needed in order to establish the connection should be drawn from the settings object.
+   * This function should return a boolean for whether the connection attempt was successful.
+   * @returns Was the connection attempt successful?
+   */
+  abstract connect(): Promise<boolean>;
+
+  /**
+   * Disconnect from any servers or services which are used to provide audio/video functionality.
+   * This function should return a boolean for whether a valid disconnection occurred.
+   * @returns Did a disconnection occur?
+   */
+  abstract disconnect(): Promise<boolean>;
+
+  /**
+   * Provide an Object of available audio sources which can be used by this implementation.
+   * Each object key should be a device id and the key should be a human-readable label.
+   */
+  getAudioSinks(): Promise<Record<string, string>>;
+
+  /**
+   * Provide an Object of available audio sources which can be used by this implementation.
+   * Each object key should be a device id and the key should be a human-readable label.
+   */
+  getAudioSources(): Promise<Record<string, string>>;
+
+  /**
+   * Provide an Object of available video sources which can be used by this implementation.
+   * Each object key should be a device id and the key should be a human-readable label.
+   */
+  getVideoSources(): Promise<Record<string, string>>;
+
+  /**
+   * Obtain a mapping of available device sources for a given type.
+   * @param kind - The type of device source being requested
+   * @internal
+   */
+  protected _getSourcesOfType(kind: MediaDeviceKind): Promise<Record<string, string>>;
+
+  /**
+   * Return an array of Foundry User IDs which are currently connected to A/V.
+   * The current user should also be included as a connected user in addition to all peers.
+   * @returns The connected User IDs
+   */
+  abstract getConnectedUsers(): string[];
+
+  /**
+   * Provide a MediaStream instance for a given user ID
+   * @param userId - The User id
+   * @returns The MediaStream for the user, or null if the user does not have one
+   */
+  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?
+   */
+  abstract isAudioEnabled(): boolean;
+
+  /**
+   * Is outbound video enabled for the current user?
+   */
+  abstract isVideoEnabled(): boolean;
+
+  /**
+   * Set whether the outbound audio feed for the current game user is enabled.
+   * This method should be used when the user marks themselves as muted or if the gamemaster globally mutes them.
+   * @param enable - Whether the outbound audio track should be enabled (true) or disabled (false)
+   */
+  abstract toggleAudio(enable: boolean): void;
+
+  /**
+   * Set whether the outbound audio feed for the current game user is actively broadcasting.
+   * This can only be true if audio is enabled, but may be false if using push-to-talk or voice activation modes.
+   * @param broadcast - Whether outbound audio should be sent to connected peers or not?
+   */
+  abstract toggleBroadcast(broadcast: boolean): void;
+
+  /**
+   * Set whether the outbound video feed for the current game user is enabled.
+   * This method should be used when the user marks themselves as hidden or if the gamemaster globally hides them.
+   * @param enable - Whether the outbound audio track should be enabled (true) or disabled (false)
+   */
+  abstract toggleVideo(enable: boolean): void;
+
+  /**
+   * Set the Video Track for a given User ID to a provided VideoElement
+   * @param userId       - The User ID to set to the element
+   * @param videoElement - The HTMLVideoElement to which the video should be set
+   */
+  abstract setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
+
+  /**
+   * Handle changes to A/V configuration settings.
+   * @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>;
 }
+
+export default AVClient;

package/src/foundry/client/av/clients/simplepeer.d.mts

@@ -1,165 +1,168 @@
-import type { DeepPartial, Identity } from "fvtt-types/utils";
+import type { DeepPartial, Identity } from "#utils";
+
+import AVClient = foundry.av.AVClient;
+import AVSettings = foundry.av.AVSettings;
+
+/**
+ * An implementation of the AVClient which uses the simple-peer library and the Foundry socket server for signaling.
+ * Credit to bekit#4213 for identifying simple-peer as a viable technology and providing a POC implementation.
+ */
+declare class SimplePeerAVClient extends AVClient {
+  /**
+   * The local Stream which captures input video and audio
+   * @defaultValue `null`
+   */
+  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
+   */
+  peers: Map<string, SimplePeer.Instance>;
+
+  /**
+   * A mapping of connected remote streams
+   */
+  remoteStreams: Map<string, MediaStream>;
+
+  /**
+   * Has the client been successfully initialized?
+   * @defaultValue `false`
+   * @internal
+   */
+  protected _initialized: boolean;
+
+  /**
+   * Is outbound broadcast of local audio enabled?
+   * @defaultValue `false`
+   */
+  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>;
+
+  override initialize(): Promise<void>;
+
+  override getConnectedUsers(): string[];
+
+  override getMediaStreamForUser(userId: string): MediaStream | null | undefined;
+
+  override getLevelsStreamForUser(userId: string): MediaStream | null | undefined;
+
+  override isAudioEnabled(): boolean;
+
+  override isVideoEnabled(): boolean;
+
+  override toggleAudio(enable: boolean): void;
+
+  override toggleBroadcast(broadcast: boolean): void;
+
+  override toggleVideo(enable: boolean): void;
+
+  override setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
+
+  /**
+   * Initialize a local media stream for the current user
+   */
+  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
+   */
+  activateSocketListeners(): void;
+
+  /**
+   * Initialize a stream connection with a new peer
+   * @param userId - The Foundry user ID for which the peer stream should be established
+   * @returns A Promise which resolves once the peer stream is initialized
+   */
+  initializePeerStream(userId: string): Promise<SimplePeer.Instance>;
+
+  /**
+   * Receive a request to establish a peer signal with some other User id
+   * @param userId - The Foundry user ID who is requesting to establish a connection
+   * @param data   - The connection details provided by SimplePeer
+   */
+  receiveSignal(userId: string, data: SimplePeer.SignalData): void;
 
-declare global {
   /**
-   * An implementation of the AVClient which uses the simple-peer library and the Foundry socket server for signaling.
-   * Credit to bekit#4213 for identifying simple-peer as a viable technology and providing a POC implementation.
+   * Connect to a peer directly, either as the initiator or as the receiver
+   * @param userId      - The Foundry user ID with whom we are connecting
+   * @param isInitiator - Is the current user initiating the connection, or responding to it?
+   *                      (default: `false`)
+   * @returns The constructed and configured SimplePeer instance
    */
-  class SimplePeerAVClient extends AVClient {
-    /**
-     * The local Stream which captures input video and audio
-     * @defaultValue `null`
-     */
-    localStream: MediaStream | null;
+  connectPeer(userId: string, isInitiator?: boolean): SimplePeer.Instance;
 
-    /**
-     * The dedicated audio stream used to measure volume levels for voice activity detection.
-     * @defaultValue `null`
-     */
-    levelsStream: MediaStream | null;
-
-    /**
-     * A mapping of connected peers
-     */
-    peers: Map<string, SimplePeer.Instance>;
-
-    /**
-     * A mapping of connected remote streams
-     */
-    remoteStreams: Map<string, MediaStream>;
-
-    /**
-     * Has the client been successfully initialized?
-     * @defaultValue `false`
-     * @internal
-     */
-    protected _initialized: boolean;
-
-    /**
-     * Is outbound broadcast of local audio enabled?
-     * @defaultValue `false`
-     */
-    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>;
-
-    override initialize(): Promise<void>;
-
-    override getConnectedUsers(): string[];
-
-    override getMediaStreamForUser(userId: string): MediaStream | null | undefined;
-
-    override getLevelsStreamForUser(userId: string): MediaStream | null | undefined;
-
-    override isAudioEnabled(): boolean;
-
-    override isVideoEnabled(): boolean;
-
-    override toggleAudio(enable: boolean): void;
-
-    override toggleBroadcast(broadcast: boolean): void;
-
-    override toggleVideo(enable: boolean): void;
-
-    override setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
-
-    /**
-     * Initialize a local media stream for the current user
-     */
-    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
-     */
-    activateSocketListeners(): void;
-
-    /**
-     * Initialize a stream connection with a new peer
-     * @param userId - The Foundry user ID for which the peer stream should be established
-     * @returns A Promise which resolves once the peer stream is initialized
-     */
-    initializePeerStream(userId: string): Promise<SimplePeer.Instance>;
-
-    /**
-     * Receive a request to establish a peer signal with some other User id
-     * @param userId - The Foundry user ID who is requesting to establish a connection
-     * @param data   - The connection details provided by SimplePeer
-     */
-    receiveSignal(userId: string, data: SimplePeer.SignalData): void;
-
-    /**
-     * Connect to a peer directly, either as the initiator or as the receiver
-     * @param userId      - The Foundry user ID with whom we are connecting
-     * @param isInitiator - Is the current user initiating the connection, or responding to it?
-     *                      (default: `false`)
-     * @returns The constructed and configured SimplePeer instance
-     */
-    connectPeer(userId: string, isInitiator?: boolean): SimplePeer.Instance;
-
-    /**
-     * Create the SimplePeer instance for the desired peer connection.
-     * Modules may implement more advanced connection strategies by overriding this method.
-     * @param userId      - The Foundry user ID with whom we are connecting
-     * @param isInitiator - Is the current user initiating the connection, or responding to it?
-     * @internal
-     */
-    _createPeerConnection(userId: string, isInitiator: boolean): SimplePeer.Instance;
-
-    /**
-     * Setup the custom TURN relay to be used in subsequent calls if there is one configured.
-     * TURN credentials are mandatory in WebRTC.
-     * @param options - The SimplePeer configuration object.
-     * @internal
-     */
-    _setupCustomTURN(options: SimplePeer.Options): void;
-
-    /**
-     * Disconnect from a peer by stopping current stream tracks and destroying the SimplePeer instance
-     * @param userId - The Foundry user ID from whom we are disconnecting
-     * @returns A Promise which resolves once the disconnection is complete
-     */
-    disconnectPeer(userId: string): Promise<void>;
-
-    /**
-     * Disconnect from all current peer streams
-     * @returns A Promise which resolves once all peers have been disconnected
-     */
-    disconnectAll(): Promise<Array<void>>;
-
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    override onSettingsChanged(changed: DeepPartial<AVSettings.Settings>): Promise<void>;
-
-    override updateLocalStream(): Promise<void>;
-  }
-
-  namespace SimplePeerAVClient {
-    interface Any extends AnySimplePeerAVClient {}
-    interface AnyConstructor extends Identity<typeof AnySimplePeerAVClient> {}
-  }
+  /**
+   * Create the SimplePeer instance for the desired peer connection.
+   * Modules may implement more advanced connection strategies by overriding this method.
+   * @param userId      - The Foundry user ID with whom we are connecting
+   * @param isInitiator - Is the current user initiating the connection, or responding to it?
+   * @internal
+   */
+  _createPeerConnection(userId: string, isInitiator: boolean): SimplePeer.Instance;
+
+  /**
+   * Setup the custom TURN relay to be used in subsequent calls if there is one configured.
+   * TURN credentials are mandatory in WebRTC.
+   * @param options - The SimplePeer configuration object.
+   * @internal
+   */
+  _setupCustomTURN(options: SimplePeer.Options): void;
+
+  /**
+   * Disconnect from a peer by stopping current stream tracks and destroying the SimplePeer instance
+   * @param userId - The Foundry user ID from whom we are disconnecting
+   * @returns A Promise which resolves once the disconnection is complete
+   */
+  disconnectPeer(userId: string): Promise<void>;
+
+  /**
+   * Disconnect from all current peer streams
+   * @returns A Promise which resolves once all peers have been disconnected
+   */
+  disconnectAll(): Promise<Array<void>>;
+
+  // eslint-disable-next-line @typescript-eslint/no-misused-promises
+  override onSettingsChanged(changed: DeepPartial<AVSettings.Settings>): Promise<void>;
+
+  override updateLocalStream(): Promise<void>;
+}
+
+declare namespace SimplePeerAVClient {
+  interface Any extends AnySimplePeerAVClient {}
+  interface AnyConstructor extends Identity<typeof AnySimplePeerAVClient> {}
 }
 
 declare abstract class AnySimplePeerAVClient extends SimplePeerAVClient {
   constructor(...args: never);
 }
+
+export default SimplePeerAVClient;