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

package/index.d.ts

@@ -1,4 +1,4 @@
 import 'pixi.js';
-import './src';
 import 'handlebars';
 import 'jquery';
+import './src';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.268.0",
+  "version": "9.268.1",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {
@@ -71,7 +71,7 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",
     "eslint-plugin-tsdoc": "^0.2.14",
-    "husky": "^7.0.4",
+    "husky": "^8.0.0",
     "lint-staged": "^12.1.2",
     "prettier": "^2.5.1",
     "tsd": "^0.20.0",

package/src/foundry/{foundry.js/application.d.ts → client/apps/app.d.ts}

@@ -379,11 +379,8 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Handle changes to the active tab in a configured Tabs controller
    * @param event  - A left click event
-   *                 (unused)
    * @param tabs   - The Tabs controller
-   *                 (unused)
    * @param active - The new active tab name
-   *                 (unused)
    * @internal
    */
   protected _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
@@ -391,13 +388,9 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Handle changes to search filtering controllers which are bound to the Application
    * @param event - The key-up event from keyboard input
-   *                (unused)
    * @param query - The regular expression to test against
-   *                (unused)
    * @param rgx   - The regular expression to test against
-   *                (unused)
    * @param html  - The HTML element which should be filtered
-   *                (unused)
    * @internal
    */
   protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
@@ -405,7 +398,6 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Define whether a user is able to begin a dragstart workflow for a given drag selector
    * @param selector - The candidate HTML selector for dragging
-   *                   (unused)
    * @returns Can the current user drag this selector?
    * @internal
    */
@@ -414,7 +406,6 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Define whether a user is able to conclude a drag-and-drop workflow for a given drop selector
    * @param selector - The candidate HTML selector for the drop target
-   *                   (unused)
    * @returns Can the current user drop on this selector?
    * @internal
    */
@@ -423,7 +414,6 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Callback actions which occur at the beginning of a drag start workflow.
    * @param event - The originating DragEvent
-   *                (unused)
    * @internal
    */
   protected _onDragStart(event: DragEvent): void;
@@ -431,7 +421,6 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Callback actions which occur when a dragged element is over a drop target.
    * @param event - originating DragEvent
-   *                (unused)
    * @internal
    */
   protected _onDragOver(event: DragEvent): void;
@@ -439,7 +428,6 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
   /**
    * Callback actions which occur when a dragged element is dropped on a target.
    * @param event - The originating DragEvent
-   *                (unused)
    * @internal
    */
   protected _onDrop(event: DragEvent): void;
@@ -495,7 +483,6 @@ declare abstract class Application<Options extends ApplicationOptions = Applicat
 
   /**
    * Additional actions to take when the application window is resized
-   * @param event - (unused)
    */
   protected _onResize(event: Event): void;
 }

package/src/foundry/client/apps/av/av-config.d.ts

@@ -0,0 +1,85 @@
+export {};
+
+declare global {
+  /**
+   * Audio/Video Conferencing Configuration Sheet
+   *
+   * @typeParam Options - The type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
+   */
+  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);
+
+    static override get defaultOptions(): FormApplicationOptions;
+
+    override getData(options: Partial<Options>): Promise<Data>;
+
+    override activateListeners(html: JQuery): void;
+
+    /**
+     * Set a section's input to enabled or disabled
+     * @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;
+
+    /**
+     * Determine whether a given video or audio source, or audio sink has become
+     * 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 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;
+
+    protected override _updateObject(event: Event, formData?: object): Promise<unknown>;
+  }
+
+  namespace AVConfig {
+    interface Data {
+      user: Game['user'];
+      modes: {
+        [Key in ValueOf<typeof AVSettings.AV_MODES>]: string;
+      };
+      voiceModes: {
+        [Key in ValueOf<typeof AVSettings.VOICE_MODES>]: string;
+      };
+      serverTypes: {
+        FVTT: string;
+        custom: string;
+      };
+      turnTypes: {
+        FVTT: string;
+        custom: string;
+      };
+      settings: AVSettings;
+      canSelectMode: boolean;
+      noSSL: boolean;
+      videoSources: Record<string, string>;
+      audioSources: Record<string, string>;
+      audioSinks: Record<string, string> | false;
+      videoSrcUnavailable: boolean;
+      audioSrcUnavailable: boolean;
+      audioSinkUnavailable: boolean;
+      audioDisabled: boolean;
+      videoDisabled: boolean;
+    }
+  }
+}

package/src/foundry/client/apps/av/camera-popout.d.ts

@@ -0,0 +1,49 @@
+export {};
+
+declare global {
+  /**
+   * Abstraction of the Application interface to be used with the Draggable class as a substitute for the app
+   * This class will represent one popout feed window and handle its positioning and draggability
+   */
+  class CameraPopoutAppWrapper {
+    /**
+     * @param view    - The CameraViews application that this popout belongs to
+     * @param userId  - ID of the user this popout belongs to
+     * @param element - The div element of this specific popout window
+     */
+    constructor(view: CameraViews, userId: string, element: JQuery);
+
+    /**
+     * The CameraViews application that this popout belongs to
+     */
+    view: CameraViews;
+
+    /**
+     * The div element of this specific popout window
+     */
+    element: JQuery;
+
+    /**
+     * ID of the user this popout belongs to
+     */
+    userId: string;
+
+    /** @defaultValue `true` */
+    popOut: boolean;
+
+    /** @defaultValue `{}` */
+    options: Record<string, unknown>;
+
+    /**
+     * Get the current position of this popout window
+     */
+    get position(): Application.Position;
+
+    setPosition(options?: Partial<Application.Position>): (Application.Position & { height: number }) | void;
+
+    /** @internal */
+    protected _onResize(event: Event): void;
+
+    bringToTop(): void;
+  }
+}

package/src/foundry/client/apps/av/cameras.d.ts

@@ -0,0 +1,174 @@
+export {};
+
+declare global {
+  /**
+   * The Camera UI View that displays all the camera feeds as individual video elements.
+   * @typeParam Options - the type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
+   */
+  class CameraViews<
+    Options extends ApplicationOptions = ApplicationOptions,
+    Data extends object = CameraViews.Data
+  > extends Application<Options> {
+    /**
+     * @defaultValue
+     * ```typescript
+     * return foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "camera-views",
+     *   template: "templates/hud/camera-views.html",
+     *   popOut: false
+     * })
+     * ```
+     */
+    static override get defaultOptions(): ApplicationOptions;
+
+    /**
+     * A reference to the master AV orchestrator instance
+     */
+    get webrtc(): Game['webrtc'];
+
+    /**
+     * Obtain a reference to the div.camera-view which is used to portray a given Foundry User.
+     * @param userId - The ID of the User document
+     */
+    getUserCameraView(userId: string): HTMLElement | null;
+
+    /**
+     * Obtain a reference to the video.user-camera which displays the video channel for a requested Foundry User.
+     * If the user is not broadcasting video this will return null.
+     * @param userId - The ID of the User document
+     */
+    getUserVideoElement(userId: string): HTMLVideoElement | null;
+
+    /**
+     * Sets whether a user is currently speaking or not
+     *
+     * @param userId   - The ID of the user
+     * @param speaking - Whether the user is speaking
+     */
+    setUserIsSpeaking(userId: string, speaking: boolean): void;
+
+    /**
+     * Extend the render logic to first check whether a render is necessary based on the context
+     * If a specific context was provided, make sure an update to the navigation is necessary before rendering
+     */
+    render(force?: boolean, context?: Application.RenderOptions<Options>): this | void;
+
+    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+
+    override getData(options?: Partial<Options>): Data | Promise<Data>;
+
+    /** @defaultValue `undefined` */
+    maxZ?: number;
+
+    /**
+     * Prepare rendering data for a single user
+     * @internal
+     */
+    protected _getDataForUser(userId: string, settings: AVSettings.UserSettings): CameraViews.Data.User | null;
+
+    /**
+     * A custom sorting function that orders/arranges the user display frames
+     * @internal
+     */
+    protected static _sortUsers(a: CameraViews.Data.User, b: CameraViews.Data.User): number;
+
+    override activateListeners(html: JQuery): void;
+
+    /**
+     * On hover in a camera container, show/hide the controls.
+     * @param event - The original mouseover or mouseout hover event
+     * @internal
+     */
+    protected _onCameraViewHover(event: JQuery.MouseEnterEvent | JQuery.MouseLeaveEvent): void;
+
+    /**
+     * On clicking on a toggle, disable/enable the audio or video stream.
+     * @param event - The originating click event
+     * @internal
+     */
+    protected _onClickControl(event: JQuery.ClickEvent): Promise<void>;
+
+    /**
+     * Change volume control for a stream
+     * @param event - The originating change event from interaction with the range input
+     * @internal
+     */
+    protected _onVolumeChange(event: JQuery.ChangeEvent): void;
+
+    /**
+     * Dynamically refresh the state of a single camera view
+     * @param view - The view container div
+     * @internal
+     */
+    protected _refreshView(view: HTMLElement): void;
+
+    /**
+     * Render changes needed to the PlayerList ui.
+     * Show/Hide players depending on option.
+     * @internal
+     */
+    protected _setPlayerListVisibility(): void;
+
+    /**
+     * Get the icon class that should be used for various action buttons with different toggled states.
+     * The returned icon should represent the visual status of the NEXT state (not the CURRENT state).
+     *
+     * @param action - The named av-control button action
+     * @param state  - The CURRENT action state.
+     * @returns The icon that represents the NEXT action state.
+     * @internal
+     */
+    protected _getToggleIcon(action: string, state: boolean): string | null;
+
+    /**
+     * Get the text title that should be used for various action buttons with different toggled states.
+     * The returned title should represent the tooltip of the NEXT state (not the CURRENT state).
+     *
+     * @param action - The named av-control button action
+     * @param state - The CURRENT action state.
+     * @returns The icon that represents the NEXT action state.
+     * @internal
+     */
+    protected _getToggleTooltip(action: string, state: boolean): string;
+
+    /**
+     * Show or hide UI control elements
+     * This replaces the use of jquery.show/hide as it simply adds a class which has display:none
+     * which allows us to have elements with display:flex which can be hidden then shown without
+     * breaking their display style.
+     * This will show/hide the toggle buttons, volume controls and overlay sidebars
+     * @param container - The container for which to show/hide control elements
+     * @param show      - Whether to show or hide the controls
+     * @param selector  - Override selector to specify which controls to show or hide
+     *                    (default: `'.control-bar'`)
+     * @internal
+     */
+    protected _toggleControlVisibility(container: HTMLElement, show: boolean, selector?: string): void;
+  }
+
+  namespace CameraViews {
+    interface Data {
+      self: Game['user'];
+      users: Data.User[];
+      dockClass: string;
+      muteAll: boolean;
+    }
+
+    namespace Data {
+      interface User {
+        user: StoredDocument<globalThis.User>;
+        id: StoredDocument<globalThis.User>['id'];
+        local: StoredDocument<globalThis.User>['isSelf'];
+        name: StoredDocument<globalThis.User>['name'];
+        color: StoredDocument<globalThis.User>['data']['color'];
+        colorAlpha: `rgba(${number}, ${number}, ${number})`;
+        charname: string;
+        avatar: StoredDocument<globalThis.User>['avatar'];
+        settings: AVSettings.UserSettings;
+        volume: number;
+        cameraViewClass: string;
+      }
+    }
+  }
+}

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

@@ -0,0 +1,3 @@
+import './av-config';
+import './camera-popout';
+import './cameras';