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

package/src/foundry/foundry.js/pixi/containers/placeableObject.d.ts

@@ -4,7 +4,7 @@ import { Document } from '../../../common/abstract/module.mjs';
 
 declare global {
   /**
-   * An Abstract Base Class which defines a Placeable Object which represents an Entity placed on the Canvas
+   * An Abstract Base Class which defines a Placeable Object which represents a Document placed on the Canvas
    */
   abstract class PlaceableObject<
     D extends Document<any, InstanceType<ConfiguredDocumentClass<typeof Scene>>> = Document<
@@ -68,8 +68,8 @@ declare global {
     protected _hover: boolean;
 
     /**
-     * Identify the official EmbeddedEntity name for this PlaceableObject class
-     * @remarks This getter is abstract in {@link PlaceableObject}.
+     * Identify the official Document name for this PlaceableObject class
+     * @remarks This is abstract in {@link PlaceableObject}.
      */
     static embeddedName: string;
 
@@ -77,7 +77,7 @@ declare global {
      * The bounding box for this PlaceableObject.
      * This is required if the layer uses a Quadtree, otherwise it is optional
      */
-    get bounds(): Rectangle;
+    abstract get bounds(): Rectangle;
 
     /**
      * The central coordinate pair of the placeable object based on it's own width and height
@@ -106,8 +106,8 @@ declare global {
     get los(): this['vision']['los'];
 
     /**
-     * A Form Application which is used to configure the properties of this Placeable Object or the EmbeddedEntity
-     * it represents.
+     * A Form Application which is used to configure the properties of this Placeable Object or the Document it
+     * represents.
      */
     get sheet(): 'sheet' extends keyof D ? D['sheet'] : FormApplication | null;
 
@@ -151,7 +151,7 @@ declare global {
     protected _canView(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to create the underlying Embedded Entity?
+     * Does the User have permission to create the underlying Document?
      * @param event - (unused)
      */
     protected _canCreate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
@@ -169,13 +169,13 @@ declare global {
     protected _canHover(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to update the underlying Embedded Entity?
+     * Does the User have permission to update the underlying Document?
      * @param event - (unused)
      */
     protected _canUpdate(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
 
     /**
-     * Does the User have permission to delete the underlying Embedded Entity?
+     * Does the User have permission to delete the underlying Document?
      * @param event - (unused)
      */
     protected _canDelete(user: InstanceType<ConfiguredDocumentClass<typeof User>>, event?: any): boolean;
@@ -378,52 +378,6 @@ declare global {
      * @param event - The triggering mouse click event
      */
     protected _onDragLeftCancel(event: MouseEvent): void;
-
-    /**
-     * @deprecated since 0.8.0
-     * @param options - (default: `{}`)
-     */
-    static create(
-      data:
-        | Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1]
-        | Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1][],
-      options?: Parameters<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>[1]
-    ): ReturnType<InstanceType<ConfiguredDocumentClass<typeof Scene>>['createEmbeddedDocuments']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    update(data: Parameters<D['update']>[0], options: Parameters<D['update']>[1]): ReturnType<D['update']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    delete(options: Parameters<D['delete']>[0]): ReturnType<D['delete']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    getFlag(scope: string, key: string): ReturnType<D['getFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    setFlag(scope: string, key: string, value: unknown): ReturnType<D['setFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    unsetFlag(scope: string, key: string): ReturnType<D['unsetFlag']>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get uuid(): string;
-
-    /**
-     * @deprecated since 0.8.2
-     */
-    static get layer(): PlaceablesLayer<any>;
   }
 
   namespace PlaceableObject {

package/src/foundry/foundry.js/pixi/containers/placeableObjects/ambientSound.d.ts

@@ -27,6 +27,9 @@ declare global {
      */
     get isAudible(): boolean;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A convenience accessor for the sound type
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/drawing.d.ts

@@ -59,6 +59,9 @@ declare global {
      */
     static FREEHAND_SAMPLE_RATE: number;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A Boolean flag for whether or not the Drawing utilizes a tiled texture background
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/measuredTemplate.d.ts

@@ -33,6 +33,9 @@ declare global {
     /** @override */
     static embeddedName: 'MeasuredTemplate';
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * A convenience accessor for the border color as a numeric hex code
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/note.d.ts

@@ -10,6 +10,9 @@ declare global {
     /** @override */
     static get embeddedName(): 'Note';
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * The associated JournalEntry which is described by this note
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/tile.d.ts

@@ -72,6 +72,9 @@ declare global {
      */
     get aspectRatio(): number;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * The HTML source element for the primary Tile texture
      */

package/src/foundry/foundry.js/pixi/containers/placeableObjects/token.d.ts

@@ -77,6 +77,9 @@ declare global {
      */
     readonly name: string;
 
+    /** @override */
+    get bounds(): Rectangle;
+
     /**
      * Translate the token's grid width into a pixel width based on the canvas size
      */

package/src/foundry/index.d.ts

@@ -20,12 +20,9 @@ import './foundry.js/clientSettings';
 import './foundry.js/collections';
 import './foundry.js/collisionResult';
 import './foundry.js/config';
-import './foundry.js/constants';
 import './foundry.js/contextMenu';
 import './foundry.js/dragDrop';
 import './foundry.js/draggable';
-import './foundry.js/features';
-import './foundry.js/fonts';
 import './foundry.js/formDataExtended';
 import './foundry.js/game';
 import './foundry.js/gameTime';
@@ -74,7 +71,6 @@ import './foundry.js/templateUtils';
 import './foundry.js/textEditor';
 import './foundry.js/textureLoader';
 import './foundry.js/textureUtils';
-import './foundry.js/types';
 import './foundry.js/userTargets';
 import './foundry.js/utils';
 import './foundry.js/videoHelper';

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

@@ -1,392 +0,0 @@
-/**
- * An AVClient implementation that uses WebRTC and the EasyRTC library.
- * This client is deprecated and will be removed entirely in 0.9.x.
- *
- * If you wish to continue using it, you will need to manually enable it by:
- * 1. Include the easyrtc.js library which is no longer served
- * 2. Set CONFIG.WebRTC.clientClass = EasyRTCClient
- *
- * @deprecated since 0.8.7 */
-declare class EasyRTCClient extends AVClient {
-  /**
-   * @param master   - The master orchestration instance
-   * @param settings - The audio/video settings being used
-   */
-  constructor(master: AVMaster, settings: AVSettings);
-
-  /**
-   * Store the name of the joined EasyRTC room
-   * @defaultValue `null`
-   */
-  protected _room: string | null;
-
-  /**
-   * A mapping of easyRtcId peer ids to Foundry User ids
-   * @defaultValue `{}`
-   */
-  protected _usernameCache: Record<string, string>;
-
-  /**
-   * An array of easyRtcId peers that rejected our call. Avoid continually trying to call the same peer.
-   * @defaultValue `[]`
-   */
-  protected _callRejections: string[];
-
-  /** @override */
-  initialize(): Promise<void>;
-
-  /** @override */
-  connect(): Promise<true>;
-
-  /** @override */
-  disconnect(): Promise<true>;
-
-  /**
-   * Connect to the WebRTC server and configure ICE/TURN servers
-   * @returns Was the server connected?
-   */
-  protected _connectServer({
-    type,
-    room,
-    url,
-    username,
-    password
-  }: {
-    type?: 'FVTT' | 'custom';
-    room?: string;
-    url: string;
-    username: string;
-    password: string;
-  }): Promise<boolean>;
-
-  /**
-   * Setup the custom TURN relay to be used in subsequent calls if there is one configured
-   * If configured, setup custom TURN configuration for future calls. Turn credentials are mandatory in WebRTC.
-   */
-  protected _setupCustomTURN(): void;
-
-  /**
-   * Initialize a local media stream
-   * Capture the local audio and video and returns the stream associated with them.
-   *
-   * If `temporary` is false (default), then this will initialize the master stream, not the actual
-   * streams being sent to individual users. However, if a master stream was already created, it
-   * will automatically get closed and every individual streams derived from it that are being sent
-   * to connected users will be removed from the calls.
-   * Each established or subsequent calls will receive a copy of the created stream (A/V depending on user permissions)
-   *
-   * If `temporary` is true then this only applies to a temporary stream and does not affect
-   * the master stream or any streams in existing calls.
-   * Note that this assumes only one temporary stream can be created at a time.
-   *
-   * @param audioSrc  - ID of the audio source to capture from or null to disable Audio
-   *                    (default: `undefined`)
-   * @param videoSrc  - ID of the video source to capture from or null to disable Video
-   *                    (default: `undefined`)
-   * @param temporary - Whether to create a temporary stream or the master stream
-   *                    (default: `false`)
-   * @returns Returns the local stream or `null` if none could be created
-   */
-  protected _initializeLocal({
-    audioSrc,
-    videoSrc,
-    temporary
-  }?: {
-    audioSrc?: string | null;
-    videoSrc?: string | null;
-    temporary?: boolean;
-  }): Promise<MediaStream>;
-
-  /**
-   * Create an open a local stream when initially connecting to the server.
-   * This local stream becomes the "master" stream which tracks your own device inputs.
-   * The master stream is cloned to provide a stream to every connected peer.
-   */
-  protected _openLocalStream(
-    audioSrc: string | undefined | null,
-    videoSrc: string | undefined | null,
-    temporary?: boolean
-  ): Promise<MediaStream | null>;
-
-  /**
-   * Close the local stream
-   */
-  protected _closeLocalStream(temporary?: boolean): void;
-
-  /**
-   * Define media constraints to control the resolution and devices used.
-   * We need to set our own constraints so we can specify a min/max range of resolutions.
-   */
-  protected _getStreamMediaConstraints(
-    videoSrc: string | undefined | null,
-    audioSrc: string | undefined | null
-  ): EasyRTCClient.StreamMediaConstraints;
-
-  /**
-   * Call a peer and establish a connection with them
-   * @param easyRtcId - The peer ID to call
-   * @returns Returns false if no call was made or true if the call is successful.
-   * @throws raises an Exception in case of failure to establish the call.
-   */
-  protected _performCall(easyRtcId: string): Promise<boolean>;
-
-  /**
-   * Create a MediaStream to be sent to a specific peer.
-   * This stream should control whether outbound video and audio is transmitted.
-   * Create the stream as a clone of the current master stream for configuration on a peer-to-peer basis.
-   */
-  protected _createStreamForPeer(peer: string): MediaStream | null;
-
-  /** @override */
-  getAudioSinks(): Promise<Record<string, string>>;
-
-  /** @override */
-  getAudioSources(): Promise<Record<string, string>>;
-
-  /** @override */
-  getVideoSources(): Promise<Record<string, string>>;
-
-  /**
-   * Transform the device info array from easyrtc into an object with `{id: label}` keys
-   * @param list - The list of devices
-   */
-  protected _deviceInfoToObject(list: EasyRTCClient.DeviceSource[]): Record<string, string>;
-
-  /**
-   * Obtain the EasyRTC user ID of a user based on their Foundry VTT user ID
-   * @param userId - The ID of the user
-   * @returns The EasyRtcId of the peer
-   */
-  protected _userIdToEasyRtcId(userId: string): string | null;
-
-  /** @override */
-  getConnectedUsers(): string[];
-
-  /**
-   * Get MediaStream instances for every connected peer in the room.
-   * @returns - An array of stream information for each peer
-   */
-  getConnectedStreams(): EasyRTCClient.StreamInfo;
-
-  /** @override */
-  getMediaStreamForUser(userId: string): MediaStream;
-
-  /** @override */
-  isAudioEnabled(): boolean;
-
-  /** @override */
-  isVideoEnabled(): boolean;
-
-  /**
-   * Handle a request to enable or disable the outbound audio feed for the current game user.
-   * @param enable - Whether the outbound audio track should be enabled (true) or disabled (false)
-   */
-  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?
-   */
-  toggleBroadcast(broadcast: boolean): void;
-
-  /**
-   * Handle a request to enable or disable the outbound video feed for the current game user.
-   * @param enable - Whether the outbound video track should be enabled (true) or disabled (false)
-   */
-  toggleVideo(enable: boolean): void;
-
-  /** @override */
-  setUserVideo(userId: string, videoElement: HTMLVideoElement): Promise<void>;
-
-  /**
-   * Enable or disable the audio tracks in a stream
-   *
-   * Disabling a track represents what a typical user would consider muting it.
-   * We use the term 'enable' here instead of 'mute' to match the MediaStreamTrack
-   * field name and to avoid confusion with the 'muted' read-only field of the MediaStreamTrack
-   * as well as the video element's `muted` field which only stops playing the audio.
-   * Muting by definition stops rendering any of the data, while a disabled track in this case
-   * is still rendering its data, but is simply generating disabled content (silence and black frames)
-   * See https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/enabled
-   *
-   * @param stream - The stream to modify
-   * @param enable - (optional) Whether to enable or disable the tracks
-   *                 (default: `true`)
-   */
-  enableStreamAudio(stream: MediaStream, enable?: boolean): void;
-
-  /**
-   * Enable or disable the video tracks in a stream
-   *
-   * Disabling a track represents what a typical user would consider muting it. We use the term 'enable' here instead
-   * of 'mute' to match the MediaStreamTrack field name and to avoid confusion with the 'muted' read-only field of the
-   * MediaStreamTrack as well as the video element's `muted` field which only stops playing the audio.
-   *
-   * Muting by definition stops rendering any of the data, while a disabled track in this case is still rendering its
-   * data, but is simply generating disabled content (silence and black frames).
-   *
-   * See https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/enabled
-   *
-   * @param stream - The stream to modify
-   * @param enable - (optional) Whether to enable or disable the tracks
-   *                 (default: `true`)
-   */
-  enableStreamVideo(stream: MediaStream, enable?: boolean): void;
-
-  /**
-   * Enables or disables media tracks
-   * See https://developer.mozilla.org/en-US/docs/Web/API/MediaStreamTrack/enabled
-   * @param tracks - The tracks to enable/disable
-   * @param enable - Whether to enable or disable the tracks
-   */
-  protected _enableMediaTracks(tracks: MediaStreamTrack[], enable: boolean): void;
-
-  /**
-   * Callback used to check if an incoming call should be accepted or not
-   * @param easyRtcId - The peer ID of the caller
-   * @param acceptor  - Function to call with whether or not to accept the call and the media streams to use
-   */
-  protected _answerIncomingCall(
-    easyRtcId: string,
-    acceptor: (accept: boolean, streamNames: string[] | null) => unknown
-  ): void;
-
-  /**
-   * Called when the connection to the signaling server is lost (unintentionally).
-   * This handles the case of when connectivity is interrupted non-deliberately.
-   */
-  protected _onConnectionLost(): void;
-
-  /**
-   * Called when an error occurs
-   */
-  protected _onError({ errorCode, errorText }: { errorCode: string; errorText: string }): void;
-
-  /**
-   * Called whenever there is a change in the list of occupants in a room.
-   * It can also be called if a peer's state changes, such as when a call is established or ended.
-   * For each other peer in the room, record their user ID and establish a call with them.
-   * Record the username associated with each peer.
-   *
-   * Important: We need to make sure that only user initiates a call, instead of both trying to call each other.
-   * Resolve this by having the alphabetically greater ID call the other peer.
-   *
-   * @param roomName    - The room name where occupants have changed
-   * @param otherPeople - An array of other peers in the room
-   * @param myInfo      - My own connection info
-   */
-  protected _onRoomOccupantsChange(
-    roomName: string,
-    otherPeople: Record<string, any>,
-    myInfo: { easyrtcid: string; [key: string]: any }
-  ): Promise<void>;
-
-  /**
-   * Called when the connection with a peer has been established
-   */
-  protected onPeerOpen(easyRtcId: string): void;
-
-  /**
-   * Called when the connection with a peer has been lost and the ICE machine was unable to re-establish it.
-   * In case of irrecoverable connection loss with the peer, hanging up the call will cause a roomOccupantListener
-   * signal to be sent and we will automatically try to reconnect to the user.
-   * First make sure that they are still in the room so we don't try to hangup with an easyRtcId that is invalid.
-   */
-  protected _onPeerClosed(easyRtcId: string): void;
-
-  /**
-   * Called when a remote stream is added to an existing call
-   */
-  protected _onPeerConnect(easyRtcId: string, stream: MediaStream): void;
-
-  /**
-   * Called when a remote stream is removed from an existing call
-   */
-  protected _onPeerDisconnect(easyRtcId: string, stream: MediaStream, streamName: string): void;
-
-  /**
-   * @deprecated Use `getMediaStreamForUser` instead
-   */
-  getStreamForUser(userId: string): MediaStream;
-}
-
-declare namespace EasyRTCClient {
-  interface StreamMediaConstraints {
-    video:
-      | {
-          /**
-           * @defaultValue `4/3`
-           */
-          aspectRatio: number;
-
-          width: {
-            /**
-             * @defaultValue `32=`
-             */
-            ideal: number;
-
-            /**
-             * @defaultValue `640`
-             */
-            max: number;
-
-            /**
-             * @defaultValue `160`
-             */
-            min: number;
-          };
-
-          height: {
-            /**
-             * @defaultValue `240`
-             */
-            ideal: number;
-
-            /**
-             * @defaultValue `480`
-             */
-            max: number;
-
-            /**
-             * @defaultValue `120`
-             */
-            min: number;
-          };
-
-          frameRate: {
-            /**
-             * @defaultValue `15`
-             */
-            ideal: number;
-
-            /**
-             * @defaultValue `30`
-             */
-            max: number;
-          };
-
-          deviceId: string | undefined | null;
-        }
-      | false;
-    audio:
-      | {
-          deviceId: string | undefined | null;
-        }
-      | false;
-  }
-
-  interface DeviceSource {
-    deviceId: string;
-    groupId: string;
-    label: string;
-    kind: 'audio' | 'video';
-  }
-
-  interface StreamInfo {
-    id: string;
-    connection: RTCPeerConnection;
-    local: MediaStream | null;
-    remote: MediaStream | null;
-  }
-}

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

@@ -1,24 +0,0 @@
-/**
- * A configuration of font families which are initialized when the page loads
- */
-declare const FONTS: {
-  FontAwesome: {
-    custom: {
-      families: ['FontAwesome'];
-      urls: ['fonts/fontawesome/css/all.min.css'];
-    };
-  };
-  Signika: {
-    custom: {
-      families: ['Signika'];
-      urls: ['fonts/signika/signika.css'];
-    };
-  };
-  _loaded: [];
-};
-
-/**
- * Load font, and perform a callback once the font has been rendered
- * @deprecated since 0.6.4, to be removed in 0.8.x
- */
-declare function loadFont(fontName: string, callback: () => void): void;