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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.255.1",
+  "version": "9.255.2",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {

package/src/foundry/common/types.mjs.d.ts

@@ -95,7 +95,10 @@ interface SettingSubmenuConfig {
   icon?: string | undefined;
 
   /** The FormApplication to render */
-  type: ConstructorOf<FormApplication<FormApplicationOptions, object, undefined>>;
+  // TODO: Find a better way to type this. Ideally, we would find a way to conditionally make the first parameter of FormApplication optional...
+  type:
+    | (new () => FormApplication<any, any, any>)
+    | ConstructorOf<FormApplication<FormApplicationOptions, object, undefined>>;
 
   /** If true, only a GM can edit this Setting */
   restricted?: boolean | undefined;
@@ -119,10 +122,10 @@ interface KeybindingActionConfig {
   editable?: KeybindingActionBinding[];
 
   /** A function to execute when a key down event occurs. If True is returned, the event is consumed and no further keybinds execute. */
-  onDown?: () => boolean | void;
+  onDown?: (ctx: KeyboardEventContext) => boolean | void;
 
   /** A function to execute when a key up event occurs. If True is returned, the event is consumed and no further keybinds execute. */
-  onUp?: () => boolean | void;
+  onUp?: (ctx: KeyboardEventContext) => boolean | void;
 
   /** If True, allows Repeat events to execute the Action's onDown. Defaults to false. */
   repeat?: boolean;

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

@@ -1,3 +1,13 @@
+interface DialogOptions extends ApplicationOptions {
+  /**
+   * Whether to provide jQuery objects to callback functions (if true) or plain
+   * HTMLElement instances (if false). This is currently true by default but in the
+   * future will become false by default.
+   * @defaultValue `true`
+   */
+  jQuery: boolean;
+}
+
 /**
  * Create a modal dialog window displaying a title, a message, and a set of buttons which trigger callback functions.
  *
@@ -26,7 +36,7 @@
  * ```
  * @typeParam Options - the type of the options object
  */
-declare class Dialog<Options extends Dialog.Options = Dialog.Options> extends Application<Options> {
+declare class Dialog<Options extends DialogOptions = DialogOptions> extends Application<Options> {
   /**
    * @param data    - An object of dialog data which configures how the modal window is rendered
    * @param options - Dialog rendering options, see {@link Application}
@@ -47,7 +57,7 @@ declare class Dialog<Options extends Dialog.Options = Dialog.Options> extends Ap
    * })
    * ```
    */
-  static get defaultOptions(): Dialog.Options;
+  static get defaultOptions(): DialogOptions;
 
   /**
    * @override
@@ -192,31 +202,6 @@ declare namespace Dialog {
      */
     default: string;
   }
-
-  interface Options extends ApplicationOptions {
-    /**
-     * @defaultValue `400`
-     */
-    width: number;
-
-    /**
-     * @defaultValue `['dialog']`
-     */
-    classes: string[];
-
-    /**
-     * @defaultValue `'templates/hud/dialog.html'`
-     */
-    template: string;
-
-    /**
-     * Whether to provide jQuery objects to callback functions (if true) or plain
-     * HTMLElement instances (if false). This is currently true by default but in the
-     * future will become false by default.
-     * @defaultValue `true`
-     */
-    jQuery: boolean;
-  }
 }
 
 /**
@@ -266,7 +251,7 @@ interface ConfirmConfig<Yes, No, JQueryOrHtml> {
    * Additional rendering options passed to the Dialog
    * @defaultValue `{}`
    */
-  options?: Partial<Dialog.Options>;
+  options?: Partial<DialogOptions>;
 }
 
 /**
@@ -310,5 +295,5 @@ interface PromptConfig<Value, JQueryOrHtml> {
    * Additional rendering options
    * @defaultValue `{}`
    */
-  options?: Partial<Dialog.Options>;
+  options?: Partial<DialogOptions>;
 }

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

@@ -1,12 +1,24 @@
 /**
  * Audio/Video Conferencing Configuration Sheet
+ *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data, AVMaster> {
+declare class AVConfig<
+  Options extends FormApplicationOptions = FormApplicationOptions,
+  Data extends object = AVConfig.Data
+> extends FormApplication<Options, Data, AVMaster> {
+  /**
+   * @param object  - The {@link AVMaster} instance being configured.
+   * @param options - Application configuration options.
+   */
+  constructor(object?: AVMaster | undefined, options?: Partial<Options> | undefined);
+
   /** @override */
-  static get defaultOptions(): AVConfig.Options;
+  static get defaultOptions(): FormApplicationOptions;
 
   /** @override */
-  getData(options: Partial<AVConfig.Options>): Promise<AVConfig.Data>;
+  getData(options: Partial<Options>): Promise<Data>;
 
   /** @override */
   activateListeners(html: JQuery): void;
@@ -16,6 +28,7 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
    * @param selector - Selector for the section to enable or disable
    * @param enabled  - Whether to enable or disable this section
    *                   (default: true)
+   * @internal
    */
   protected _setConfigSectionEnabled(selector: string, enabled?: boolean): void;
 
@@ -24,75 +37,23 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
    * unavailable since the last time it was set.
    * @param sources - The available devices
    * @param source  - The selected device
+   * @internal
    */
   protected _isSourceUnavailable(sources: Record<string, string>, source: string): boolean;
 
-  /**
-   * Callback when the server type changes
-   * Will enable or disable the server section based on whether the user selected a custom server or not
-   * @param event - The event that triggered the server type change
-   */
-  protected _onServerTypeChanged(event: JQuery.ChangeEvent): void;
-
   /**
    * Callback when the turn server type changes
    * Will enable or disable the turn section based on whether the user selected a custom turn or not
    * @param event - The event that triggered the turn server type change
+   * @internal
    */
   protected _onTurnTypeChanged(event: JQuery.ChangeEvent): void;
 
-  /**
-   * Handle the assignment of a push-to-talk/push-to-mute key
-   */
-  protected _onPTTKeyDown(event: JQuery.KeyDownEvent): void;
-
-  /**
-   * Handle the assignment of a push-to-talk/push-to-mute mouse key
-   */
-  protected _onPTTMouseDown(event: JQuery.MouseDownEvent): void;
-
   /** @override */
   protected _updateObject(event: Event, formData?: object): Promise<void>;
 }
 
 declare namespace AVConfig {
-  interface Options extends FormApplicationOptions {
-    /**
-     * @defaultValue `game.i18n.localize('WEBRTC.Title')`
-     */
-    title: string;
-
-    /**
-     * @defaultValue `'av-config'`
-     */
-    id: string;
-
-    /**
-     * @defaultValue `'templates/sidebar/apps/av-config.html'`
-     */
-    template: string;
-
-    /**
-     * @defaultValue `true`
-     */
-    popOut: boolean;
-
-    /**
-     * @defaultValue `480`
-     */
-    width: number;
-
-    /**
-     * @defaultValue `'auto'`
-     */
-    height: number | 'auto';
-
-    /**
-     * @defaultValue `[{navSelector: '.tabs', contentSelector: 'form', initial: 'general'}]`
-     */
-    tabs: (TabsConfiguration & { contentSelector: string; initial: string })[];
-  }
-
   interface Data {
     user: Game['user'];
     modes: {

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/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/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.

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

@@ -224,7 +224,7 @@ declare global {
     resetDialog(): Promise<InstanceType<ConfiguredDocumentClassForName<'Cards'>> | false | null>;
 
     /** @override */
-    deleteDialog(options?: Partial<Dialog.Options> | undefined): Promise<this | false | null | undefined>;
+    deleteDialog(options?: Partial<DialogOptions> | undefined): Promise<this | false | null | undefined>;
 
     // TODO: It's a bit weird that we have to do it in this generic way but otherwise there is an error overriding this. Investigate later.
     /** @override */
@@ -236,7 +236,7 @@ declare global {
             | (ConstructorDataType<foundry.data.CardsData> & 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>;
   }
 

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

@@ -97,7 +97,7 @@ declare global {
      *                  (default: `{}`)
      * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
      */
-    exportDialog(pack: string, options?: Dialog.Options): Promise<void>;
+    exportDialog(pack: string, options?: DialogOptions): Promise<void>;
 
     /**
      * Get the Folder documents which are sub-folders of the current folder, either direct children or recursively.

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

@@ -22,13 +22,6 @@ declare global {
       context?: ConstructorParameters<typeof foundry.documents.BasePlaylist>[1]
     );
 
-    /**
-     * Each sound which is played within the Playlist has a created Sound instance.
-     * The keys of this object are the sound IDs and the values are the Sound instances.
-     * @remarks This seems to be unused and will always be the empty object, see https://gitlab.com/foundrynet/foundryvtt/-/issues/5970
-     */
-    audio: {};
-
     /**
      * Playlists may have a playback order which defines the sequence of Playlist Sounds
      * @defaultValue `undefined`
@@ -57,7 +50,7 @@ declare global {
 
     /**
      * Begin simultaneous playback for all sounds in the Playlist.
-     * @returns The updated Playlist entity
+     * @returns The updated Playlist document
      */
     playAll(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
 
@@ -94,7 +87,7 @@ declare global {
 
     /**
      * End playback for any/all currently playing sounds within the Playlist.
-     * @returns The updated Playlist entity
+     * @returns The updated Playlist document
      */
     stopAll(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
 
@@ -187,10 +180,10 @@ declare global {
     _onSoundStart(sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>): Promise<void>;
 
     /** @override */
-    toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-      foundry.data.PlaylistData['_source'],
-      '_id' | 'folder' | 'permission'
-    > & {
+    toCompendium(
+      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
+    ): Omit<foundry.data.PlaylistData['_source'], '_id' | 'folder' | 'permission'> & {
       permission?: foundry.data.PlaylistData['_source']['permission'];
     };
   }

package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts

@@ -169,7 +169,7 @@ declare global {
      *          null if the dialog was closed without making a choice.
      */
     importDialog(
-      options?: Dialog.Options | undefined
+      options?: DialogOptions | undefined
     ): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[] | null | false>;
 
     /**

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

@@ -7,6 +7,23 @@ declare class HandlebarsHelpers {
    */
   static checked(value: unknown): string;
 
+  /**
+   * For use in form inputs. If the supplied value is truthy, add the "disabled" property, otherwise add nothing.
+   */
+  static disabled(value: unknown): string;
+
+  /**
+   * Concatenate a number of string terms into a single string.
+   * This is useful for passing arguments with variable names.
+   * @param values - The values to concatenate
+   *
+   * @example <caption>Concatenate several string parts to create a dynamic variable</caption>
+   * ```handlebars
+   * {{filePicker target=(concat "faces." i ".img") type="image"}}
+   * ```
+   */
+  static concat(...values: string[]): Handlebars.SafeString;
+
   /**
    * Render a pair of inputs for selecting a color.
    * @param options - Helper options
@@ -31,12 +48,15 @@ declare class HandlebarsHelpers {
    * @example <caption>Translate a provided localization string, optionally including formatting parameters</caption>
    * ```handlebars
    * <label>{{localize "ACTOR.Create"}}</label> <!-- "Create Actor" -->
-   * <label>{{localize "CHAT.InvalidCommand", command=foo}}</label> <!-- "foo is not a valid chat message command." -->
+   * <label>{{localize "CHAT.InvalidCommand" command=foo}}</label> <!-- "foo is not a valid chat message command." -->
    * ```
    */
   static localize(value: string, options: HandlebarsHelpers.LocalizeOptions): string;
 
   /**
+   * @param value   - A numeric value to format
+   * @param options - Additional options which customize the resulting format
+   * @returns The formatted string to be included in a template
    * A string formatting helper to display a number with a certain fixed number of decimals and an explicit sign.
    */
   static numberFormat(value: string, options: HandlebarsHelpers.NumberFormatOptions): string;
@@ -78,7 +98,7 @@ declare class HandlebarsHelpers {
   ): Handlebars.SafeString;
 
   /**
-   * Render a pair of inputs for selecting a color.
+   * Render a pair of inputs for selecting a value in a range.
    * @param options - Helper options
    */
   static rangePicker(options: HandlebarsHelpers.RangePickerOptions): Handlebars.SafeString;
@@ -206,10 +226,10 @@ declare namespace HandlebarsHelpers {
       editable?: boolean;
 
       /**
-       * Replace dynamic entity links?
+       * Replace dynamic document links?
        * @defaultValue `true`
        */
-      entities?: boolean;
+      documents?: boolean;
 
       /**
        * The data object providing context for inline rolls
@@ -245,11 +265,13 @@ declare namespace HandlebarsHelpers {
   interface NumberFormatOptions extends Handlebars.HelperOptions {
     hash: {
       /**
+       * The number of decimal places to include in the resulting string
        * @defaultValue `0`
        */
       decimals?: number;
 
       /**
+       * Whether to include an explicit "+" sign for positive numbers
        * @defaultValue `false`
        */
       sign?: boolean;

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

@@ -96,7 +96,7 @@ declare class MouseInteractionManager<Object extends PIXI.Container = PIXI.Conta
 
   /**
    * The throttling time below which a mouse move event will not be handled
-   * @defaultValue `Math.ceil(1000 / canvas.app.ticker.maxFPS)`
+   * @defaultValue `Math.ceil(1000 / (canvas.app.ticker.maxFPS || 60));`
    * @internal
    */
   protected _dragThrottleMS: number;

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

@@ -92,7 +92,7 @@ declare namespace PerceptionManager {
     sight: {
       initialize: boolean;
       refresh: boolean;
-      noUpdateFog: boolean;
+      skipUpdateFog: boolean;
       forceUpdateFog: boolean;
     };
     sounds: {

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

@@ -11,7 +11,7 @@ declare global {
     /**
      * A reference to the PointSource object which defines this light source area of effect
      */
-    source: PointSource;
+    source: LightSource;
 
     /**
      * A reference to the ControlIcon used to configure this light
@@ -25,6 +25,11 @@ declare global {
     /** @override */
     get bounds(): NormalizedRectangle;
 
+    /**
+     * A convenience accessor to the LightData configuration object
+     */
+    get config(): foundry.data.LightData;
+
     /**
      * Test whether a specific AmbientLight source provides global illumination
      */
@@ -53,6 +58,9 @@ declare global {
     /** @override */
     draw(): Promise<this>;
 
+    /** @override */
+    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+
     /**
      * Draw the ControlIcon for the AmbientLight
      * @internal
@@ -74,12 +82,9 @@ declare global {
 
     /**
      * Update the source object associated with this light
-     * @param defer   - Defer refreshing the LightingLayer to manually call that refresh later.
-     *                  (default: `false`)
-     * @param deleted - Indicate that this light source has been deleted.
-     *                  (default: `false`)
+     * @param options - (default: `{}}`)
      */
-    updateSource({ defer, deleted }?: { defer?: boolean; deleted?: boolean }): null | void;
+    updateSource(options?: AmbientLight.UpdateSourceOptions | undefined): void;
 
     /** @override */
     protected _onCreate(
@@ -116,4 +121,20 @@ declare global {
     /** @override */
     protected _onDragLeftCancel(event: MouseEvent): void;
   }
+
+  namespace AmbientLight {
+    interface UpdateSourceOptions {
+      /**
+       * Defer refreshing the LightingLayer to manually call that refresh later.
+       * @defaultValue `false`
+       */
+      defer?: boolean | undefined;
+
+      /**
+       * Indicate that this light source has been deleted.
+       * @defaultValue `false`
+       */
+      deleted?: boolean | undefined;
+    }
+  }
 }

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

@@ -13,6 +13,11 @@ declare global {
      */
     sound: Sound | null;
 
+    /**
+     * A SoundSource object which manages the area of effect for this ambient sound
+     */
+    source: SoundSource;
+
     /** @override */
     static embeddedName: 'AmbientSound';
 
@@ -31,9 +36,9 @@ declare global {
     get bounds(): Rectangle;
 
     /**
-     * A convenience accessor for the sound type
+     * The named identified for the source object associated with this ambient sound
      */
-    get type(): 'l' | 'g';
+    get sourceId(): string;
 
     /**
      * A convenience accessor for the sound radius in pixels
@@ -54,6 +59,9 @@ declare global {
     /** @override */
     draw(): Promise<this>;
 
+    /** @override */
+    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+
     /**
      * Draw the graphical preview of the audio source area of effect
      * @internal
@@ -76,9 +84,9 @@ declare global {
 
     /**
      * Compute the field-of-vision for an object, determining its effective line-of-sight and field-of-vision polygons
-     * @returns An object containing the rays, LOS polygon, and FOV polygon for the light
+     * @param options - (default: `{}`)
      */
-    updateSource(): { rays: null; los: null; fov: PIXI.Circle } | ReturnType<WallsLayer['computePolygon']>;
+    updateSource(options?: AmbientSound.UpdateSourceOptions | undefined): void;
 
     /** @override */
     protected _onCreate(
@@ -118,5 +126,19 @@ declare global {
        */
       fade: number;
     }
+
+    interface UpdateSourceOptions {
+      /**
+       * Defer refreshing the SoundsLayer to manually call that refresh later.
+       * @defaultValue `false`
+       */
+      defer?: boolean | undefined;
+
+      /**
+       * Indicate that this SoundSource has been deleted.
+       * @defaultValue `false`
+       */
+      deleted?: boolean | undefined;
+    }
   }
 }

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

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
+import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../../../common/abstract/document.mjs';
 
 declare global {
@@ -40,18 +40,25 @@ declare global {
     /**
      * Internal timestamp for the previous freehand draw time, to limit sampling
      * @defaultValue `0`
+     * @internal
      */
     protected _drawTime: number;
+
+    /**
+     * @defaultValue `0`
+     * @internal
+     */
     protected _sampleTime: number;
 
     /**
      * Internal flag for the permanent points of the polygon
      * @defaultValue `foundry.utils.deepClone(this.data.points || [])`
+     * @internal
      */
     protected _fixedPoints: Array<[x: number, y: number]>;
 
     /** @override */
-    static get embeddedName(): 'Drawing';
+    static embeddedName: 'Drawing';
 
     /**
      * The rate at which points are sampled (in milliseconds) during a freehand drawing workflow
@@ -77,6 +84,7 @@ declare global {
 
     /**
      * Clean the drawing data to constrain its allowed position
+     * @internal
      */
     protected _cleanData(): void;
 
@@ -87,11 +95,13 @@ declare global {
 
     /**
      * Create elements for the foreground text
+     * @internal
      */
     protected _createText(): PreciseText;
 
     /**
      * Create elements for the Drawing border and handles
+     * @internal
      */
     protected _createFrame(): void;
 
@@ -100,21 +110,25 @@ declare global {
 
     /**
      * Draw rectangular shapes
+     * @internal
      */
     protected _drawRectangle(): void;
 
     /**
      * Draw ellipsoid shapes
+     * @internal
      */
     protected _drawEllipse(): void;
 
     /**
      * Draw polygonal shapes
+     * @internal
      */
     protected _drawPolygon(): void;
 
     /**
      * Draw freehand shapes with bezier spline smoothing
+     * @internal
      */
     protected _drawFreehand(): void;
 
@@ -125,6 +139,7 @@ declare global {
      * @param previous - The prior point
      * @param point    - The current point
      * @param next     - The next point
+     * @internal
      */
     protected _getBezierControlPoints(
       factor: number,
@@ -144,17 +159,20 @@ declare global {
 
     /**
      * Refresh the boundary frame which outlines the Drawing shape
+     * @internal
      */
     protected _refreshFrame({ x, y, width, height }: Rectangle): void;
 
     /**
      * Add a new polygon point to the drawing, ensuring it differs from the last one
      * @param temporary - (default: `true`)
+     * @internal
      */
     protected _addPoint(position: Point, temporary?: boolean): void;
 
     /**
      * Remove the last fixed point from the polygon
+     * @internal
      */
     protected _removePoint(): void;
 
@@ -169,13 +187,9 @@ declare global {
 
     /**
      * Handle text entry in an active text tool
+     * @internal
      */
-    protected _onDrawingTextKeydown(
-      event: KeyboardEvent
-    ):
-      | ReturnType<InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>['update']>
-      | ReturnType<InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>['delete']>
-      | void;
+    protected _onDrawingTextKeydown(event: KeyboardEvent): void;
 
     /** @override */
     protected _onUpdate(data: DeepPartial<foundry.data.DrawingData['_source']>): void;
@@ -184,20 +198,21 @@ declare global {
      * @override
      * @param event - unused
      */
-    protected _canControl(user: User, event?: any): boolean;
+    protected _canControl(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
     /**
      * @override
      * @param user  - unused
      * @param event - unused
      */
-    protected _canConfigure(user: User, event?: any): boolean;
+    protected _canConfigure(user: InstanceType<ConfiguredDocumentClassForName<'User'>>, event?: any): boolean;
 
     /** @override */
     activateListeners(): void;
 
     /**
      * Handle mouse movement which modifies the dimensions of the drawn shape
+     * @internal
      */
     protected _onMouseDraw(event: PIXI.InteractionEvent): void;
 
@@ -216,35 +231,41 @@ declare global {
     /**
      * Handle mouse-over event on a control handle
      * @param event - The mouseover event
+     * @internal
      */
     protected _onHandleHoverIn(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle mouse-out event on a control handle
      * @param event - The mouseout event
+     * @internal
      */
     protected _onHandleHoverOut(event: PIXI.InteractionEvent): void;
 
     /**
      * When we start a drag event - create a preview copy of the Tile for re-positioning
      * @param event - The mousedown event
+     * @internal
      */
     protected _onHandleMouseDown(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle the beginning of a drag event on a resize handle
+     * @internal
      */
     protected _onHandleDragStart(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle mousemove while dragging a tile scale handler
      * @param event - The mousemove event
+     * @internal
      */
     protected _onHandleDragMove(event: PIXI.InteractionEvent): void;
 
     /**
      * Handle mouseup after dragging a tile scale handler
      * @param event - The mouseup event
+     * @internal
      */
     protected _onHandleDragDrop(
       event: PIXI.InteractionEvent
@@ -252,6 +273,7 @@ declare global {
 
     /**
      * Handle cancellation of a drag event for one of the resizing handles
+     * @internal
      */
     protected _onHandleDragCancel(event: PIXI.InteractionEvent): void;
 
@@ -260,6 +282,7 @@ declare global {
      * @param original - The original drawing data
      * @param dx       - The pixel distance dragged in the horizontal direction
      * @param dy       - The pixel distance dragged in the vertical direction
+     * @internal
      */
     protected _rescaleDimensions(
       original: Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'points' | 'width' | 'height'>,
@@ -272,19 +295,10 @@ declare global {
      * @param data - The Drawing data pending update
      * @returns The adjusted data
      * @remarks This is intentionally public because it is called by the DrawingsLayer
+     * @internal
      */
     static normalizeShape(
       data: Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'width' | 'height' | 'points'>
     ): Pick<foundry.data.DrawingData['_source'], 'x' | 'y' | 'width' | 'height' | 'points'>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get author(): InstanceType<ConfiguredDocumentClass<typeof User>>;
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get owner(): boolean;
   }
 }

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

@@ -4,11 +4,11 @@ import { HoverInOptions } from '../placeableObject';
 declare global {
   /**
    * A Note is an implementation of PlaceableObject which represents an annotated location within the Scene.
-   * Each Note links to a JournalEntry entity and represents it's location on the map.
+   * Each Note links to a JournalEntry document and represents its location on the map.
    */
   class Note extends PlaceableObject<InstanceType<ConfiguredDocumentClass<typeof NoteDocument>>> {
     /** @override */
-    static get embeddedName(): 'Note';
+    static embeddedName: 'Note';
 
     /** @override */
     get bounds(): Rectangle;
@@ -28,6 +28,13 @@ declare global {
      */
     get size(): number;
 
+    /**
+     * Determine whether the Note is visible to the current user based on their perspective of the Scene.
+     * Visibility depends on permission to the underlying journal entry, as well as the perspective of controlled Tokens.
+     * If Token Vision is required, the user must have a token with vision over the note to see it.
+     */
+    get isVisible(): boolean;
+
     /** @override */
     draw(): Promise<this>;
 

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

@@ -36,6 +36,12 @@ declare global {
      */
     tile: PIXI.Sprite | undefined;
 
+    /**
+     * The occlusion image sprite
+     * @defaultValue `undefined`
+     */
+    occlusionTile: PIXI.Sprite | undefined;
+
     /**
      * A Tile background which is displayed if no valid image texture is present
      * @defaultValue `undefined`
@@ -94,7 +100,12 @@ declare global {
     draw(): Promise<this>;
 
     /** @override */
-    refresh(): this;
+    destroy(options?: Parameters<PlaceableObject['destroy']>[0]): void;
+
+    /**
+     * @param options - (default: `{}`)
+     * @override */
+    refresh(options?: Tile.RefreshOptions | undefined): this;
 
     /**
      * Refresh the display of the Tile border
@@ -114,7 +125,14 @@ declare global {
      * @param options - Additional options for modifying video playback
      *                  (default: `{}`)
      */
-    play(playing: boolean, options?: Partial<Tile.PlayOptions>): void;
+    play(playing: boolean, options?: Tile.PlayOptions | undefined): void;
+
+    /**
+     * Unlink the playback of this video tile from the playback of other tokens which are using the same base texture.
+     * @param source - The video element source
+     * @internal
+     */
+    protected _unlinkVideoPlayback(source: HTMLVideoElement): Promise<void>;
 
     /**
      * Update the occlusion rendering for this overhead Tile for a given controlled Token.
@@ -131,7 +149,7 @@ declare global {
      */
     testOcclusion(
       token: InstanceType<ConfiguredObjectClassForName<'Token'>>,
-      options?: Partial<Tile.OcclusionOptions>
+      options?: Tile.OcclusionOptions | undefined
     ): boolean;
 
     /**
@@ -157,7 +175,7 @@ declare global {
      * @param options - Options which customize the return value
      * @internal
      */
-    protected _createAlphaMap(options: Partial<Tile.AlphaMapOptions>): Exclude<Tile['_alphaMap'], undefined>;
+    protected _createAlphaMap(options: Tile.AlphaMapOptions): Exclude<Tile['_alphaMap'], undefined>;
 
     /**
      * Compute the alpha-based bounding box for the tile, including an angle of rotation.
@@ -242,7 +260,7 @@ declare global {
      * Get resized Tile dimensions
      * @internal
      */
-    protected _getResizedDimensions(event: MouseEvent, origin: Point, destination: Point): NormalizedRectangle;
+    protected _getResizedDimensions(event: MouseEvent, origin: Point, destination: Point): Rectangle;
 
     /**
      * Handle cancellation of a drag event for one of the resizing handles
@@ -251,18 +269,27 @@ declare global {
 
     /**
      * Create a preview tile with a background texture instead of an image
+     * @param data - Initial data with which to create the preview Tile
      */
-    static createPreview(data: TileDataConstructorData): Tile;
+    static createPreview(data: TileDataConstructorData): InstanceType<ConfiguredObjectClassForName<'Tile'>>;
   }
 
   namespace Tile {
+    interface RefreshOptions {
+      /**
+       * Also refresh the perception layer.
+       * @defaultValue `false`
+       */
+      refreshPerception?: boolean | undefined;
+    }
+
     interface PlayOptions {
       /** Should the video loop? */
-      loop: boolean;
+      loop?: boolean | undefined;
       /** A specific timestamp between 0 and the video duration to begin playback */
-      offset: number;
+      offset?: number | undefined;
       /** Desired volume level of the video's audio channel (if any) */
-      volume: number;
+      volume?: number | undefined;
     }
 
     interface OcclusionOptions {
@@ -270,7 +297,7 @@ declare global {
        * Test corners of the hit-box in addition to the token center?
        * @defaultValue `true`
        */
-      corners: boolean;
+      corners?: boolean | undefined;
     }
 
     interface AlphaMapOptions {
@@ -278,13 +305,13 @@ declare global {
        * Keep the Uint8Array of pixel alphas?
        * @defaultValue `false`
        */
-      keepPixels: boolean;
+      keepPixels?: boolean | undefined;
 
       /**
        * Keep the pure white RenderTexture?
        * @defaultValue `false`
        */
-      keepTexture: boolean;
+      keepTexture?: boolean | undefined;
     }
   }
 }