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

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

@@ -1,115 +0,0 @@
-import { ToObjectFalseType } from '../../../../types/helperTypes';
-
-declare global {
-  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;
-
-    /**
-     * @override
-     */
-    protected _getHeaderButtons(): Application.HeaderButton[];
-
-    /**
-     * Handle requests to configure the default sheet used by this Document
-     * @internal
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
-
-    /**
-     * @param event - (unused)
-     * @override
-     */
-    protected _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;
-    }
-  }
-}

package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/cardsHand.d.ts

@@ -1,20 +0,0 @@
-/**
- * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "hand" type.
- *
- * @typeParam Options - The type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class CardsHand<
-  Options extends DocumentSheetOptions = DocumentSheetOptions,
-  Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
-> extends CardsConfig<Options, Data> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   template: "templates/cards/cards-hand.html"
-   * })
-   * ```
-   */
-  static override get defaultOptions(): DocumentSheetOptions;
-}

package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/cardsPile.d.ts

@@ -1,20 +0,0 @@
-/**
- * A subclass of CardsConfig which provides a sheet representation for Cards documents with the "pile" type.
- *
- * @typeParam Options - The type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class CardsPile<
-  Options extends DocumentSheetOptions = DocumentSheetOptions,
-  Data extends CardsConfig.Data<Options> = CardsConfig.Data<Options>
-> extends CardsConfig<Options, Data> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   template: "templates/cards/cards-pile.html"
-   * })
-   * ```
-   */
-  static override get defaultOptions(): DocumentSheetOptions;
-}

package/src/foundry/foundry.js/applications/formApplications/documentSheets/cardsConfigs/index.d.ts

@@ -1,2 +0,0 @@
-import './cardsHand';
-import './cardsPile';

package/src/foundry/foundry.js/applications/formApplications/documentSheets/index.d.ts

@@ -1,22 +0,0 @@
-import './activeEffectConfig';
-import './actorSheet';
-import './ambientLightConfig';
-import './ambientSoundConfig';
-import './cardConfig';
-import './cardsConfig';
-import './cardsConfigs';
-import './combatantConfig';
-import './folderConfig';
-import './itemSheet';
-import './journalSheet';
-import './lightConfig';
-import './macroConfig';
-import './measuredTemplateConfig';
-import './noteConfig';
-import './permissionControl';
-import './playlistConfig';
-import './playlistSoundConfig';
-import './rollTableConfig';
-import './sceneConfig';
-import './tileConfig';
-import './userConfig';

package/src/foundry/foundry.js/applications/formApplications/documentSheets/lightConfig.d.ts

@@ -1,10 +0,0 @@
-declare global {
-  /**
-   * @deprecated since v9
-   */
-  class LightConfig extends AmbientLightConfig {
-    constructor(...args: ConstructorParameters<typeof AmbientLightConfig>);
-  }
-}
-
-export {};

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

@@ -1,165 +0,0 @@
-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();
- * ```
- */
-declare 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;
-
-  /**
-   * @override
-   * @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 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>;
-
-  /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<Options> | undefined): Promise<void>;
-
-  /** @override */
-  protected _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;
-
-  /**
-   * @override
-   * @remarks Not implemented for ImagePopout
-   */
-  protected _updateObject(event: Event, formData?: object): never;
-}
-
-declare 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/foundry.js/applications/formApplications/index.d.ts

@@ -1,16 +0,0 @@
-import './avConfig';
-import './combatTrackerConfig';
-import './documentSheet';
-import './documentSheetConfig';
-import './documentSheets';
-import './drawingConfig';
-import './gridConfig';
-import './imagePopout';
-import './keybindingsConfig';
-import './moduleManagement';
-import './permissionConfig';
-import './settingsConfig';
-import './tokenConfig';
-import './tokenConfigs';
-import './wallConfig';
-import './worldConfig';

package/src/foundry/foundry.js/applications/formApplications/tokenConfigs/defaultTokenConfig.d.ts

@@ -1,79 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../../types/helperTypes';
-import type { TokenBarData } from '../../../../common/data/data.mjs/tokenBarData';
-
-declare global {
-  /**
-   * A sheet that alters the values of the default Token configuration used when new Token documents are created.
-   */
-  class DefaultTokenConfig<
-    Options extends FormApplicationOptions = FormApplicationOptions,
-    Data extends DefaultTokenConfig.Data = DefaultTokenConfig.Data
-  > extends TokenConfig<Options, Data> {
-    constructor(object: unknown, options?: Partial<Options> | undefined);
-
-    data: foundry.data.TokenData;
-
-    object: InstanceType<ConfiguredDocumentClassForName<'Token'>>;
-
-    token: InstanceType<ConfiguredDocumentClassForName<'Token'>>;
-
-    /**
-     * The named world setting that stores the default Token configuration
-     * @defaultValue `"defaultToken"`
-     */
-    static SETTING: string;
-
-    /**
-     * @override
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/scene/default-token-config.html",
-     *   sheetConfig: false
-     * })
-     * ```
-     */
-    static get defaultOptions(): FormApplicationOptions;
-
-    /** @override */
-    get id(): string;
-
-    /** @override */
-    get title(): string;
-
-    /** @override */
-    getData(options: unknown): Data | Promise<Data>;
-
-    /** @override */
-    _getSubmitData(
-      updateData?: Parameters<TokenConfig['_getSubmitData']>[0]
-    ): ReturnType<TokenConfig['_getSubmitData']>;
-
-    /** @override */
-    _updateObject(event: Event, formData?: object): Promise<unknown>;
-
-    /** @override */
-    activateListeners(html: JQuery): void;
-
-    /**
-     * Reset the form to default values
-     */
-    reset(): void;
-
-    /** @override */
-    protected _onBarChange(): Promise<void>;
-  }
-
-  namespace DefaultTokenConfig {
-    interface Data<Options extends FormApplicationOptions = FormApplicationOptions>
-      extends Omit<TokenConfig.Data<Options>, 'object' | 'bar1' | 'bar2'> {
-      object: foundry.data.TokenData['_source'];
-      isDefault: true;
-      barAttributes: ReturnType<typeof TokenDocument['getTrackedAttributeChoices']>;
-      bar1: TokenBarData;
-      bar2: TokenBarData;
-    }
-  }
-}
-
-export {};

package/src/foundry/foundry.js/applications/formApplications/tokenConfigs/index.d.ts

@@ -1 +0,0 @@
-import './defaultTokenConfig';

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

@@ -1,28 +0,0 @@
-/**
- * A simple window application which shows the built documentation pages within an iframe
- */
-declare class FrameViewer extends Application {
-  url: string;
-
-  /**
-   * @override
-   * @defaultValue
-   * ```
-   * mergeObject(super.defaultOptions, {
-   *   height: window.innerHeight * 0.9,
-   *   width: Math.min(window.innerWidth * 0.9, 1200),
-   *   top: (window.innerHeight - height) / 2,
-   *   left: (window.innerWidth - width) / 2,
-   *   id: "documentation",
-   *   template: "templates/apps/documentation.html",
-   * })
-   * ```
-   */
-  static get defaultOptions(): typeof Application['defaultOptions'];
-
-  /** @override */
-  getData(options?: Partial<ApplicationOptions>): Promise<{ src: string }>;
-
-  /** @override */
-  close(options?: Application.CloseOptions): ReturnType<Application['close']>;
-}

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

@@ -1,24 +0,0 @@
-import './basePlaceableHUD';
-import './basePlaceableHUDs';
-import './cameraViews';
-import './chatPopout';
-import './compendium';
-import './controlsReference';
-import './dialog';
-import './filePicker';
-import './formApplication';
-import './formApplications';
-import './frameViewer';
-import './headsUpDisplay';
-import './hotbar';
-import './invitationLinks';
-import './mainMenu';
-import './notifications';
-import './pause';
-import './playerList';
-import './sceneControls';
-import './sceneNavigation';
-import './sidebar';
-import './sidebarTab';
-import './sidebarTabs';
-import './supportDetails';

package/src/foundry/foundry.js/applications/sidebarTabs/index.d.ts

@@ -1,6 +0,0 @@
-import './chatLog';
-import './combatTracker';
-import './compendiumDirectory';
-import './settings';
-import './sidebarDirectory';
-import './sidebarDirectories';

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/actorDirectory.d.ts

@@ -1,21 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level Actor documents.
- */
-declare class ActorDirectory extends SidebarDirectory<'Actor'> {
-  constructor(...args: ConstructorParameters<typeof SidebarDirectory>);
-
-  /** @override */
-  static documentName: 'Actor';
-
-  /** @override */
-  protected _canDragStart(selector: string): boolean;
-
-  /**  @override */
-  protected _onDragStart(event: DragEvent): void;
-
-  /** @override */
-  protected _canDragDrop(selector: string): boolean;
-
-  /** @override */
-  protected _getEntryContextOptions(): ContextMenuEntry[];
-}

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/index.d.ts

@@ -1,8 +0,0 @@
-import './actorDirectory';
-import './cardsDirectory';
-import './itemDirectory';
-import './journalDirectory';
-import './macroDirectory';
-import './playlistDirectory';
-import './rollTableDirectory';
-import './sceneDirectory';

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/itemDirectory.d.ts

@@ -1,13 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level Item documents.
- */
-declare class ItemDirectory extends SidebarDirectory<'Item'> {
-  /** @override */
-  static documentName: 'Item';
-
-  /** @override */
-  protected _canDragDrop(selector: string): boolean;
-
-  /** @override */
-  protected _getEntryContextOptions(): ContextMenuEntry[];
-}

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/sceneDirectory.d.ts

@@ -1,19 +0,0 @@
-/**
- * A directory listing of active game scenes
- */
-declare class SceneDirectory extends SidebarDirectory<'Scene'> {
-  /** @override */
-  static documentName: 'Scene';
-
-  /**
-   * @override
-   * @defaultValue `"templates/sidebar/scene-partial.html"`
-   */
-  static documentPartial: string;
-
-  /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<SidebarDirectory.Options>): Promise<void>;
-
-  /** @override */
-  protected _getEntryContextOptions(): ContextMenuEntry[];
-}

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

@@ -1 +0,0 @@
-import './simplePeerAVClient';

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

@@ -1,45 +0,0 @@
-/**
- * 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
- */
-declare 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/foundry.js/clientDocuments/canvasDocuments/index.d.ts

@@ -1,8 +0,0 @@
-import './ambientLightDocument';
-import './ambientSoundDocument';
-import './drawingDocument';
-import './measuredTemplateDocument';
-import './noteDocument';
-import './tileDocument';
-import './tokenDocument';
-import './wallDocument';

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

@@ -1,21 +0,0 @@
-import './activeEffect';
-import './actor';
-import './canvasDocuments';
-import './card';
-import './cards';
-import './chatMessage';
-import './combat';
-import './combatant';
-import './fogExploration';
-import './folder';
-import './item';
-import './journalEntry';
-import './macro';
-import './playlist';
-import './playlistSound';
-import './prototypeToken';
-import './rollTable';
-import './scene';
-import './setting';
-import './tableResult';
-import './user';