@league-of-foundry-developers/foundry-vtt-types 9.280.0 → 12.331.1-beta

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

@@ -1,174 +0,0 @@
-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

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

package/src/foundry/client/apps/form.d.ts

@@ -1,384 +0,0 @@
-import { ToObjectFalseType } from '../../../types/helperTypes';
-
-declare global {
-  interface FormApplicationOptions extends ApplicationOptions {
-    /**
-     * Whether to automatically close the application when it's contained
-     * form is submitted.
-     * @defaultValue `true`
-     */
-    closeOnSubmit: boolean;
-
-    /**
-     * Whether to automatically submit the contained HTML form when an input
-     * or select element is changed.
-     * @defaultValue `false`
-     */
-    submitOnChange: boolean;
-
-    /**
-     * Whether to automatically submit the contained HTML form when the
-     * application window is manually closed.
-     * @defaultValue `false`
-     */
-    submitOnClose: boolean;
-
-    /**
-     * Whether the application form is editable - if true, it's fields will
-     * be unlocked and the form can be submitted. If false, all form fields
-     * will be disabled and the form cannot be submitted.
-     * @defaultValue `true`
-     */
-    editable: boolean;
-
-    /**
-     * Support configuration of the sheet type used for this application.
-     * @defaultValue `false`
-     */
-    sheetConfig: boolean;
-  }
-
-  /**
-   * An abstract pattern for defining an Application responsible for updating some object using an HTML form
-   *
-   * A few critical assumptions:
-   * 1) This application is used to only edit one object at a time
-   * 2) The template used contains one (and only one) HTML form as it's outer-most element
-   * 3) This abstract layer has no knowledge of what is being updated, so the implementation must define _updateObject
-   *
-   * @typeParam Options        - the type of the options object
-   * @typeParam Data           - The data structure used to render the handlebars template.
-   * @typeParam ConcreteObject - the type of the object or {@link foundry.abstract.Document} which is modified by this form
-   */
-  abstract class FormApplication<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends object = FormApplication.Data<{}, Options>,
-    ConcreteObject = Data extends FormApplication.Data<infer T, Options> ? T : {}
-  > extends Application<Options> {
-    /**
-     * @param object  - Some object or entity which is the target to be updated.
-     * @param options - Additional options which modify the rendering of the sheet.
-     *                  (default: `{}`)
-     * @remarks Foundry allows passing no value to the constructor at all.
-     */
-    constructor(object: ConcreteObject, options?: Partial<Options>);
-    constructor(
-      ...args: ConcreteObject extends undefined
-        ? [ConcreteObject?, Partial<Options>?]
-        : [ConcreteObject, Partial<Options>?]
-    );
-
-    /**
-     * The object target which we are using this form to modify
-     */
-    object: ConcreteObject;
-
-    /**
-     * A convenience reference to the form HTLMElement
-     * @defaultValue `null`
-     */
-    form: HTMLElement | null;
-
-    /**
-     * Keep track of any FilePicker instances which are associated with this form
-     * The values of this Array are inner-objects with references to the FilePicker instances and other metadata
-     * @defaultValue `[]`
-     */
-    filepickers: FilePicker[];
-
-    /**
-     * Keep track of any mce editors which may be active as part of this form
-     * The values of this Array are inner-objects with references to the MCE editor and other metadata
-     * @defaultValue `{}`
-     */
-    editors: Record<string, FormApplication.FormApplicationEditor>;
-
-    /**
-     * Assign the default options which are supported by the entity edit sheet.
-     * @returns The default options for this FormApplication class
-     * @see {@link Application.defaultOptions}
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["form"],
-     *   closeOnSubmit: true,
-     *   editable: true,
-     *   sheetConfig: false,
-     *   submitOnChange: false,
-     *   submitOnClose: false
-     * });
-     * ```
-     */
-    static override get defaultOptions(): FormApplicationOptions;
-
-    /**
-     * Is the Form Application currently editable?
-     */
-    get isEditable(): boolean;
-
-    /**
-     * @param options - (default: `{}`)
-     */
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    protected override _renderInner(data: Data): Promise<JQuery>;
-
-    protected override _activateCoreListeners(html: JQuery): void;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * If the form is not editable, disable its input fields
-     * @param form - The form HTML
-     */
-    protected _disableFields(form: HTMLElement): void;
-
-    /**
-     * Handle standard form submission steps
-     * @param event         - The submit event which triggered this handler
-     * @param updateData    - Additional specific data keys/values which override or extend the contents of
-     *                        the parsed form. This can be used to update other flags or data fields at the
-     *                        same time as processing a form submission to avoid multiple database operations.
-     *                        (default: `null`)
-     * @param preventClose  - Override the standard behavior of whether to close the form on submit
-     *                        (default: `false`)
-     * @param preventRender - Prevent the application from re-rendering as a result of form submission
-     *                        (default: `false`)
-     * @returns A promise which resolves to the validated update data
-     */
-    protected _onSubmit(
-      event: Event,
-      { updateData, preventClose, preventRender }?: FormApplication.OnSubmitOptions
-    ): Promise<Partial<Record<string, unknown>>>;
-
-    /**
-     * Get an object of update data used to update the form's target object
-     * @param updateData - Additional data that should be merged with the form data
-     *                     (default: `{}`)
-     * @returns The prepared update data
-     */
-    // TODO: Maybe we can calculate how the flattened `updateData` looks like, then it would be Partial<Record<string, unknown>> & Flattened<T>
-    protected _getSubmitData(updateData?: object | null): Record<string, unknown>;
-
-    /**
-     * Handle changes to an input element, submitting the form if options.submitOnChange is true.
-     * Do not preventDefault in this handler as other interactions on the form may also be occurring.
-     * @param event - The initial change event
-     */
-    protected _onChangeInput(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle the change of a color picker input which enters it's chosen value into a related input field
-     */
-    protected _onChangeColorPicker(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle changes to a range type input by propagating those changes to the sibling range-value element
-     * @param event - The initial change event
-     */
-    protected _onChangeRange(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Additional handling which should trigger when a FilePicker contained within this FormApplication is submitted.
-     * @param selection  - The target path which was selected
-     * @param filePicker - The FilePicker instance which was submitted
-     */
-    protected _onSelectFile(selection: string, filePicker: FilePicker): void;
-
-    /**
-     * This method is called upon form submission after form data is validated
-     * @param event    - The initial triggering submission event
-     * @param formData - The object of validated form data with which to update the object
-     * @returns A Promise which resolves once the update operation has completed
-     */
-    protected abstract _updateObject(event: Event, formData?: object): Promise<unknown>;
-
-    /**
-     * Activate a named TinyMCE text editor
-     * @param name           - The named data field which the editor modifies.
-     * @param options        - TinyMCE initialization options passed to TextEditor.create
-     *                         (default: `{}`)
-     * @param initialContent - Initial text content for the editor area.
-     *                         (default: `""`)
-     */
-    activateEditor(name: string, options?: TextEditor.Options, initialContent?: string): void;
-
-    /**
-     * Handle saving the content of a specific editor by name
-     * @param name   - The named editor to save
-     * @param remove - Remove the editor after saving its content
-     *                 (default: `true`)
-     */
-    saveEditor(name: string, { remove }?: { remove?: boolean }): Promise<void>;
-
-    /**
-     * Activate a TinyMCE editor instance present within the form
-     */
-    protected _activateEditor(div: HTMLElement): void;
-
-    /**
-     * Activate a FilePicker instance present within the form
-     * @param event - The mouse click event on a file picker activation button
-     */
-    protected _activateFilePicker(event: PointerEvent): void;
-
-    /**
-     * Determine the configuration options used to initialize a FilePicker instance within this FormApplication.
-     * Subclasses can extend this method to customize the behavior of pickers within their form.
-     * @param event - The initiating mouse click event which opens the picker
-     * @returns Options passed to the FilePicker constructor
-     */
-    protected _getFilePickerOptions(event: PointerEvent): FilePickerOptions;
-
-    /**
-     * @param options - (default: `{}`)
-     */
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    /**
-     * Submit the contents of a Form Application, processing its content as defined by the Application
-     * @param options - Options passed to the _onSubmit event handler
-     *                  (default: `{}`)
-     * @returns Return a self-reference for convenient method chaining
-     */
-    submit(options?: FormApplication.OnSubmitOptions): Promise<this> | void;
-  }
-
-  namespace FormApplication {
-    interface CloseOptions extends Application.CloseOptions {
-      submit?: boolean;
-    }
-
-    /**
-     * @typeParam ConcreteObject - the type of the object
-     * @typeParam Options        - the type of the options object
-     */
-    interface Data<ConcreteObject, Options extends FormApplicationOptions = FormApplicationOptions> {
-      object: ConcreteObject;
-      options: Options;
-      title: string;
-    }
-
-    interface FormApplicationEditor {
-      target: string;
-      button: HTMLElement;
-      hasButton: boolean;
-      mce: tinyMCE.Editor | null;
-      active: boolean;
-      changed: boolean;
-      options: TextEditor.Options;
-      initial: string;
-    }
-
-    interface OnSubmitOptions {
-      /**
-       * Additional specific data keys/values which override or extend the contents of
-       * the parsed form. This can be used to update other flags or data fields at the
-       * same time as processing a form submission to avoid multiple database operations.
-       * @defaultValue `null`
-       */
-      updateData?: object;
-
-      /**
-       * Override the standard behavior of whether to close the form on submit
-       * @defaultValue `false`
-       */
-      preventClose?: boolean;
-
-      /**
-       * Prevent the application from re-rendering as a result of form submission
-       * @defaultValue `false`
-       */
-      preventRender?: boolean;
-    }
-  }
-
-  interface DocumentSheetOptions extends FormApplicationOptions {
-    /**
-     * The default permissions required to view this Document sheet.
-     * @defaultValue {@link CONST.DOCUMENT_PERMISSION_LEVELS.LIMITED}
-     */
-    viewPermission: foundry.CONST.DOCUMENT_PERMISSION_LEVELS;
-  }
-
-  /**
-   * Extend the FormApplication pattern to incorporate specific logic for viewing or editing Document instances.
-   * See the FormApplication documentation for more complete description of this interface.
-   * @param object  - A Document instance which should be managed by this form.
-   * @param options - Optional configuration parameters for how the form behaves.
-   *                  (default: `{}`)
-   *
-   * @typeParam Options          - the type of the options object
-   * @typeParam Data             - The data structure used to render the handlebars template.
-   * @typeParam ConcreteDocument - the type of the Document which should be managed by this form sheet
-   */
-  abstract class DocumentSheet<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = DocumentSheet.Data,
-    ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheet.Data<infer T>
-      ? T
-      : foundry.abstract.Document<any, any>
-  > extends FormApplication<Options, Data, ConcreteDocument> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet"],
-     *   template: `templates/sheets/${this.name.toLowerCase()}.html`,
-     *   viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.LIMITED,
-     *   sheetConfig: true
-     * });
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions;
-
-    /**
-     * A semantic convenience reference to the Document instance which is the target object for this form.
-     */
-    get document(): ConcreteDocument;
-
-    override get id(): string;
-
-    override get isEditable(): boolean;
-
-    override get title(): string;
-
-    override close(options?: FormApplication.CloseOptions): Promise<void>;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    /**
-     * Handle requests to configure the default sheet used by this Document
-     * @internal
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
-
-    protected override _updateObject(event: Event, formData: object): Promise<unknown>;
-  }
-
-  namespace DocumentSheet {
-    /**
-     * @typeParam ConcreteDocument - the type of the {@link foundry.abstract.Document} which should be managed by this form sheet
-     * @typeParam Options          - the type of the options object
-     */
-    interface Data<
-      ConcreteDocument extends foundry.abstract.Document<any, any> = foundry.abstract.Document<any, any>,
-      Options extends DocumentSheetOptions = DocumentSheetOptions
-    > {
-      cssClass: string;
-      editable: boolean;
-      document: ConcreteDocument;
-      data: ToObjectFalseType<ConcreteDocument>;
-      limited: boolean;
-      options: Options;
-      owner: boolean;
-      title: string;
-    }
-  }
-}