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

package/src/foundry/client/apps/forms/grid-config.d.ts

@@ -1,151 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A tool for fine tuning the grid in a Scene
-   * @typeParam Options - the type of the options object
-   */
-  class GridConfig<Options extends FormApplicationOptions = FormApplicationOptions> extends FormApplication<
-    Options,
-    GridConfig.Data,
-    InstanceType<ConfiguredDocumentClass<typeof Scene>>
-  > {
-    constructor(
-      scene: InstanceType<ConfiguredDocumentClass<typeof Scene>>,
-      sheet: GridConfig['sheet'],
-      options?: Partial<Options>
-    );
-
-    /**
-     * Track the Scene Configuration sheet reference
-     */
-    sheet: SceneConfig;
-
-    /**
-     * The counter-factual dimensions being evaluated
-     * @defaultValue `{}`
-     * @internal
-     */
-    protected _dimensions: Canvas.Dimensions | {};
-
-    /**
-     * A reference to the bound key handler function so it can be removed
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _keyHandler: ((event: KeyboardEvent) => void) | null;
-
-    /**
-     * A reference to the bound mousewheel handler function so it can be removed
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _wheelHandler: ((event: WheelEvent) => void) | null;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "grid-config",
-     *   template: "templates/scene/grid-config.html",
-     *   title: game.i18n.localize("SCENES.GridConfigTool"),
-     *   width: 480,
-     *   height: "auto",
-     *   closeOnSubmit: true,
-     *   submitOnChange: true
-     * })
-     * ```
-     */
-    static override get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-    override getData(options?: Partial<Options>): GridConfig.Data;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    override activateListeners(html: JQuery): void;
-
-    override close(options?: FormApplication.CloseOptions): ReturnType<FormApplication['close']>;
-
-    /**
-     * Handle keyboard events.
-     * @param event - The original keydown event
-     * @internal
-     */
-    protected _onKeyDown(event: KeyboardEvent): void;
-
-    /**
-     * Handle mousewheel events.
-     * @param event - The original wheel event
-     * @internal
-     */
-    protected _onWheel(event: WheelEvent): void;
-
-    /**
-     * Handle resetting the form and re-drawing back to the original dimensions
-     * @param event - The original click event
-     * @internal
-     */
-    protected _onReset(event: JQuery.ClickEvent): void;
-
-    /**
-     * Scale the background size relative to the grid size
-     * @param delta - The directional change in background size
-     * @internal
-     */
-    protected _scaleBackgroundSize(delta: number): void;
-
-    /**
-     * Scale the grid size relative to the background image.
-     * When scaling the grid size in this way, constrain the allowed values between 50px and 300px.
-     * @param delta - The grid size in pixels
-     * @internal
-     */
-    protected _scaleGridSize(delta: number): void;
-
-    /**
-     * Shift the background image relative to the grid layer
-     * @param deltaX - The number of pixels to shift in the x-direction
-     *                 (default: `0`)
-     * @param deltaY - The number of pixels to shift in the y-direction
-     *                 (default: `0`)
-     * @internal
-     */
-    protected _shiftBackground({
-      deltaX,
-      deltaY
-    }?: {
-      deltaX?: number;
-      deltaY?: number;
-    }): ReturnType<GridConfig['_refresh']>;
-
-    /**
-     * Temporarily refresh the display of the BackgroundLayer and GridLayer for the new pending dimensions
-     * @param background - Refresh the background display?
-     *                     (default: `false`)
-     * @param grid       - Refresh the grid display?
-     *                     (default: `false`)
-     * @internal
-     */
-    protected _refresh({ background, grid }?: { background?: boolean; grid?: boolean }): void;
-
-    protected override _onChangeInput(event: JQuery.ChangeEvent): void;
-
-    protected override _updateObject(event: Event, formData: GridConfig.FormData): Promise<unknown>;
-  }
-
-  namespace GridConfig {
-    interface Data {
-      gridTypes: ReturnType<typeof SceneConfig['_getGridTypes']>;
-      scale: number;
-      scene: foundry.data.SceneData;
-    }
-
-    type FormData = {
-      gridType: foundry.CONST.GRID_TYPES;
-      grid: number | null;
-      scale: number | null;
-      shiftX: number | null;
-      shiftY: number | null;
-    };
-  }
-}

package/src/foundry/client/apps/forms/image-popout.d.ts

@@ -1,166 +0,0 @@
-export {};
-
-declare global {
-  interface ImagePopoutOptions extends FormApplicationOptions {
-    /**
-     * Can this image be shared with connected users?
-     * @defaultValue `false`
-     */
-    shareable: boolean;
-
-    /**
-     * The UUID of some related {@link Document}.
-     * @defaultValue `null`
-     */
-    uuid: string | null;
-  }
-
-  /**
-   * An Image Popout Application which features a single image in a lightbox style frame.
-   * This popout can also be used as a form, allowing the user to edit an image which is being used.
-   * Furthermore, this application allows for sharing the display of an image with other connected players.
-   *
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   *
-   * @example
-   * ```typescript
-   * // Construct the Application instance
-   * const ip = new ImagePopout("path/to/image.jpg", {
-   *   title: "My Featured Image",
-   *   shareable: true,
-   *   uuid: game.actors.getName("My Hero").uuid
-   * });
-   *
-   * // Display the image popout
-   * ip.render(true);
-   *
-   * // Share the image with other connected players
-   * ip.share();
-   * ```
-   */
-  class ImagePopout<
-    Options extends ImagePopoutOptions = ImagePopoutOptions,
-    Data extends object = ImagePopout.Data
-  > extends FormApplication<Options, Data, string> {
-    constructor(src: string, options?: Partial<ImagePopout.Options>);
-
-    /**
-     * @defaultValue `null`
-     */
-    protected _related: foundry.abstract.Document<any, any> | null;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/apps/image-popout.html",
-     *   classes: ["image-popout", "dark"],
-     *   editable: false,
-     *   resizable: true,
-     *   shareable: false,
-     *   uuid: null
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ImagePopoutOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options> | undefined): Promise<Data>;
-
-    /**
-     * Test whether the title of the image popout should be visible to the user
-     */
-    isTitleVisible(): boolean;
-
-    /**
-     * Provide a reference to the Document referenced by this popout, if one exists
-     */
-    getRelatedObject(): Promise<foundry.abstract.Document<any, any> | null>;
-
-    protected override _render(
-      force?: boolean,
-      options?: Application.RenderOptions<Options> | undefined
-    ): Promise<void>;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    /**
-     * Determine the correct position and dimensions for the displayed image
-     * @returns The positioning object which should be used for rendering
-     */
-    protected static getPosition(
-      img: string
-    ): Promise<{ width: number; height: number } | { width: number; height: number; top: number; left: number }>;
-
-    /**
-     * Determine the Image dimensions given a certain path
-     */
-    static getImageSize(path: string): Promise<[width: number, height: number]>;
-
-    /**
-     * Share the displayed image with other connected Users
-     */
-    shareImage(): void;
-
-    /**
-     * Handle a received request to display an image.
-     */
-    protected static _handleShareImage({
-      image,
-      title,
-      uuid
-    }?: {
-      image: string;
-      title: string;
-      uuid: string;
-    }): ImagePopout;
-
-    /**
-     * @remarks Not implemented for ImagePopout
-     */
-    protected override _updateObject(event: Event, formData?: object): never;
-  }
-
-  namespace ImagePopout {
-    interface Options extends FormApplicationOptions {
-      /**
-       * @defaultValue `'templates/apps/image-popout.html'`
-       */
-      template: string;
-
-      /**
-       * @defaultValue `['image-popout', 'dark']`
-       */
-      classes: string[];
-
-      /**
-       * @defaultValue `false`
-       */
-      editable: boolean;
-
-      /**
-       * @defaultValue `true`
-       */
-      resizable: boolean;
-
-      /**
-       * @defaultValue `false`
-       */
-      shareable: boolean;
-
-      /**
-       * @defaultValue `null`
-       */
-      uuid: string | null;
-    }
-
-    interface Data {
-      image: string;
-      options: Options;
-      title: string;
-      showTitle: boolean;
-    }
-  }
-}

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

@@ -1,20 +0,0 @@
-import './actor';
-import './card-config';
-import './cards-config';
-import './combat-config';
-import './combatant-config';
-import './effect-config';
-import './folder-config';
-import './grid-config';
-import './image-popout';
-import './item';
-import './journal-sheet';
-import './macro-config';
-import './measure-template';
-import './permission';
-import './playlist-config';
-import './playlist-sound-config';
-import './roll-table-config';
-import './scene-config';
-import './sheet-config';
-import './user-config';

package/src/foundry/client/apps/forms/item.d.ts

@@ -1,71 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for displaying and editing a single Item document.
-   *
-   * @param item    - The Item instance being displayed within the sheet.
-   * @param options - Additional application configuration options.
-   *
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class ItemSheet<
-    Options extends ItemSheet.Options = ItemSheet.Options,
-    Data extends object = ItemSheet.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Item>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/sheets/item-sheet.html",
-     *   width: 500,
-     *   closeOnSubmit: false,
-     *   submitOnClose: true,
-     *   submitOnChange: true,
-     *   resizable: true,
-     *   baseApplication: "ItemSheet",
-     *   id: "item"
-     * })
-     * ```
-     */
-    static get defaultOptions(): ItemSheet.Options;
-
-    override get id(): string;
-
-    override get title(): string;
-
-    /**
-     * A convenience reference to the Item document
-     */
-    get item(): this['object'];
-
-    /**
-     * The Actor instance which owns this item. This may be null if the item is
-     * unowned.
-     */
-    get actor(): this['item']['actor'];
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle changing the item image
-     * @internal
-     */
-    protected _onEditImage(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
-  }
-
-  namespace ItemSheet {
-    /**
-     * @typeParam Options - the type of the options object
-     */
-    interface Data<Options extends ItemSheet.Options = ItemSheet.Options>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof Item>>, Options> {
-      item: this['document'];
-    }
-
-    type Options = DocumentSheetOptions;
-  }
-}

package/src/foundry/client/apps/forms/journal-sheet.d.ts

@@ -1,107 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  interface JournalSheetOptions extends DocumentSheetOptions {
-    /** The current display mode of the journal. Either 'text' or 'image'. */
-    sheetMode?: JournalSheet.SheetMode | null;
-  }
-
-  /**
-   * The Application responsible for displaying and editing a single JournalEntry document.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class JournalSheet<
-    Options extends JournalSheetOptions = JournalSheetOptions,
-    Data extends object = JournalSheet.Data<Options>
-  > extends DocumentSheet<Options, Data> {
-    /**
-     * @param object  - The JournalEntry instance which is being edited
-     * @param options - Application options
-     */
-    constructor(object: ConcreteJournalEntry, options?: Partial<Options>);
-
-    /**
-     * The current display mode of the journal. Either 'text' or 'image'.
-     * @internal
-     */
-    protected _sheetMode: JournalSheet.SheetMode | null;
-
-    /**
-     * The size of the application when it was in text mode, so we can go back
-     * to it when we switch modes.
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _textPos: Application.Position | null;
-
-    /**
-     * @defaultValue
-     * ```ts
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "journal-sheet"],
-     *   width: 720,
-     *   height: 800,
-     *   resizable: true,
-     *   closeOnSubmit: false,
-     *   submitOnClose: true,
-     *   viewPermission: CONST.DOCUMENT_PERMISSION_LEVELS.NONE
-     * })
-     * ```
-     */
-    static override get defaultOptions(): JournalSheetOptions;
-
-    override get template(): string;
-
-    override get title(): string;
-
-    /**
-     * Guess the default view mode for the sheet based on the player's permissions to the Entry
-     * @internal
-     */
-    protected _inferDefaultMode(): JournalSheet.SheetMode | null;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    protected override _getHeaderButtons(): Application.HeaderButton[];
-
-    override getData(options?: Partial<Options>): Promise<Data> | Data;
-
-    protected override _updateObject(event: Event, formData: JournalSheet.FormData): Promise<unknown>;
-
-    /**
-     * Handle requests to switch the rendered mode of the Journal Entry sheet
-     * Save the form before triggering the show request, in case content has changed
-     * @param event - The triggering click event
-     * @param mode  - The journal mode to display
-     * @internal
-     */
-    protected _onSwapMode(event: Event, mode: JournalSheet.SheetMode): Promise<void>;
-
-    /**
-     * Handle requests to show the referenced Journal Entry to other Users
-     * Save the form before triggering the show request, in case content has changed
-     * @param event - The triggering click event
-     * @internal
-     */
-    protected _onShowPlayers(event: Event): Promise<void>;
-  }
-
-  namespace JournalSheet {
-    interface Data<Options extends JournalSheetOptions = JournalSheetOptions>
-      extends DocumentSheet.Data<ConcreteJournalEntry, Options> {
-      image: string;
-      folders: ReturnType<NonNullable<Game['folders']>['filter']>;
-    }
-
-    type SheetMode = 'text' | 'image';
-
-    interface FormData {
-      content: string;
-      folder: string;
-      name: string;
-    }
-  }
-}
-
-type ConcreteJournalEntry = InstanceType<ConfiguredDocumentClass<typeof JournalEntry>>;

package/src/foundry/client/apps/forms/macro-config.d.ts

@@ -1,71 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A Macro configuration sheet
-   *
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class MacroConfig<
-    Options extends DocumentSheetOptions = MacroConfig.Options,
-    Data extends object = MacroConfig.Data<Options>
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClass<typeof Macro>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   classes: ["sheet", "macro-sheet"],
-     *   template: "templates/sheets/macro-config.html",
-     *   width: 560,
-     *   height: 480,
-     *   resizable: true
-     * });
-     * ```
-     */
-    static override get defaultOptions(): MacroConfig.Options;
-
-    override get id(): string;
-
-    override getData(options?: Partial<Options>): Data;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _disableFields(form: HTMLElement): void;
-
-    /**
-     * Handle changing the actor profile image by opening a FilePicker
-     * @internal
-     */
-    protected _onEditImage(event: JQuery.ClickEvent): ReturnType<FilePicker['browse']>;
-
-    /**
-     * Save and execute the macro using the button on the configuration sheet
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onExecute(event: JQuery.ClickEvent): Promise<void>;
-
-    protected override _updateObject(event: Event, formData: MacroConfig.FormData): Promise<unknown>;
-  }
-
-  namespace MacroConfig {
-    type Options = DocumentSheetOptions;
-
-    /**
-     * @typeParam Options - the type of the options object
-     */
-    interface Data<Options extends DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClass<typeof Macro>>, Options> {
-      macroTypes: Array<ValueOf<typeof CONST.MACRO_TYPES>>;
-      macroScopes: typeof foundry.CONST['MACRO_SCOPES'];
-    }
-
-    type FormData = {
-      command: string;
-      img: string;
-      name: string;
-      type: ValueOf<typeof CONST.MACRO_TYPES>;
-    };
-  }
-}

package/src/foundry/client/apps/forms/measure-template.d.ts

@@ -1,53 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The Application responsible for configuring a single MeasuredTemplate document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class MeasuredTemplateConfig<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = MeasuredTemplateConfig.Data
-  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>>> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "template-config",
-     *   classes: ["sheet", "template-sheet"],
-     *   title: "TEMPLATE.MeasuredConfig",
-     *   template: "templates/scene/template-config.html",
-     *   width: 400,
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override getData(): Data | Promise<Data>;
-
-    protected override _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<unknown>;
-  }
-
-  namespace MeasuredTemplateConfig {
-    interface Data<Options extends DocumentSheetOptions = DocumentSheetOptions>
-      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'MeasuredTemplate'>>, Options> {
-      templateTypes: typeof CONFIG.MeasuredTemplate.types;
-      gridUnits: string;
-      submitText: string;
-    }
-
-    type FormData = {
-      angle: number | null;
-      borderColor: string;
-      direction: number | null;
-      distance: number | null;
-      fillColor: string;
-      t: ValueOf<foundry.CONST.MEASURED_TEMPLATE_TYPES>;
-      texture: string;
-      width: number | null;
-      x: number | null;
-      y: number | null;
-    };
-  }
-}

package/src/foundry/client/apps/forms/permission.d.ts

@@ -1,58 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A generic application for configuring permissions for various Document types
-   * @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
-   */
-  class PermissionControl<
-    Options extends DocumentSheetOptions = DocumentSheetOptions,
-    Data extends object = PermissionControl.Data,
-    ConcreteDocument extends foundry.abstract.Document<any, any> = Data extends DocumentSheet.Data<infer T>
-      ? T
-      : foundry.abstract.Document<any, any>
-  > extends DocumentSheet<Options, PermissionControl.Data, ConcreteDocument> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "permission",
-     *   template: "templates/apps/permission.html",
-     *   width: 400
-     * })
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options> | undefined): PermissionControl.Data | Promise<PermissionControl.Data>;
-
-    protected override _updateObject(event: Event, formData: PermissionControl.FormData): Promise<unknown>;
-  }
-
-  namespace PermissionControl {
-    interface Data {
-      currentDefault: foundry.CONST.DOCUMENT_PERMISSION_LEVELS | '-1';
-      instructions: string;
-      defaultLevels: Record<foundry.CONST.DOCUMENT_PERMISSION_LEVELS, string> & { '-1'?: string };
-      playerLevels: Record<foundry.CONST.DOCUMENT_PERMISSION_LEVELS | '-1', string> & { '-2'?: string };
-      isFolder: boolean;
-      users: {
-        user: InstanceType<ConfiguredDocumentClassForName<'User'>>;
-        level: foundry.CONST.DOCUMENT_PERMISSION_LEVELS | '-1';
-      }[];
-    }
-
-    interface FormData {
-      [userId: string]: FormData.InputPermissionLevel;
-      default: FormData.InputPermissionLevel;
-    }
-
-    namespace FormData {
-      type InputPermissionLevel = foundry.CONST.DOCUMENT_PERMISSION_LEVELS | -1 | -2;
-    }
-  }
-}