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

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

@@ -0,0 +1,179 @@
+import type { MaybePromise } from "../../../../types/utils.d.mts";
+
+declare global {
+  interface ImagePopoutOptions extends FormApplicationOptions {
+    /**
+     * Caption text to display below the image.
+     * @defaultValue `false`
+     */
+    caption: boolean;
+
+    /**
+     * The UUID of some related {@link Document}.
+     * @defaultValue `null`
+     */
+    uuid: string | null;
+
+    /**
+     * Force showing or hiding the title.
+     */
+    showTitle: boolean;
+  }
+
+  /**
+   * 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
+   *
+   * @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> extends FormApplication<Options, string> {
+    constructor(src: string, options?: Partial<ImagePopout.Options>);
+
+    /**
+     * Whether the application should display video content.
+     */
+    get isVideo(): boolean;
+
+    /**
+     * @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>): MaybePromise<object>;
+
+    /**
+     * 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 | null>;
+
+    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
+
+    override activateListeners(html: JQuery<HTMLElement>): void;
+
+    protected override _getHeaderButtons(): Application.HeaderButton[];
+
+    /**
+     * Determine the correct position and dimensions for the displayed image
+     * @param img - The image URL.
+     * @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
+     * @param path - The image source.
+     */
+    static getImageSize(path: string): Promise<[width: number, height: number]>;
+
+    /**
+     * Determine the dimensions of the given video file.
+     * @param src - The URL to the video.
+     */
+    static getVideoSize(src: string): Promise<[width: number, height: number]>;
+
+    /**
+     * Share the displayed image with other connected Users
+     */
+    shareImage(options: ImagePopout.ShareImageConfig): void;
+
+    /**
+     * Handle a received request to display an image.
+     * @param config - The image configuration data.
+     */
+    protected static _handleShareImage(config: ImagePopout.ShareImageConfig): ImagePopout;
+
+    /**
+     * @remarks Not implemented for ImagePopout
+     */
+    protected override _updateObject(event: Event, formData?: object): never;
+  }
+
+  namespace ImagePopout {
+    type Any = ImagePopout<any>;
+
+    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 ShareImageConfig {
+      /** The image URL to share. */
+      image: string;
+
+      /** The image title. */
+      title: string;
+
+      /** The UUID of a Document related to the image, used to determine permission to see the image title. */
+      uuid?: string;
+
+      /** If this is provided, the permissions of the related Document will be ignored and the title will be shown based on this parameter. */
+      showTitle?: boolean;
+
+      /** A list of user IDs to show the image to. */
+      users?: string[];
+    }
+  }
+}

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

@@ -0,0 +1,26 @@
+import "./actor.d.mts";
+import "./adventure-exporter.d.mts";
+import "./adventure-importer.d.mts";
+import "./base-sheet.d.mts";
+import "./card-config.d.mts";
+import "./cards-config.d.mts";
+import "./combat-config.d.mts";
+import "./combatant-config.d.mts";
+import "./default-sheets-config.d.mts";
+import "./effect-config.d.mts";
+import "./folder-config.d.mts";
+import "./fonts.d.mts";
+import "./grid-config.d.mts";
+import "./image-popout.d.mts";
+import "./item.d.mts";
+import "./journal-page-sheet.d.mts";
+import "./journal-sheet.d.mts";
+import "./macro-config.d.mts";
+import "./measure-template.d.mts";
+import "./ownership.d.mts";
+import "./playlist-config.d.mts";
+import "./playlist-sound-config.d.mts";
+import "./roll-table-config.d.mts";
+import "./scene-config.d.mts";
+import "./sheet-config.d.mts";
+import "./user-config.d.mts";

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

@@ -0,0 +1,58 @@
+import type { GetDataReturnType, MaybePromise } from "../../../../types/utils.d.mts";
+
+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
+   */
+  class ItemSheet<Options extends DocumentSheetOptions<Item> = DocumentSheetOptions<Item>> extends DocumentSheet<
+    Options,
+    Item.ConfiguredInstance
+  > {
+    /**
+     * @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",
+     *   secrets: [{parentSelector: ".editor"}]
+     * })
+     * ```
+     */
+    static get defaultOptions(): DocumentSheetOptions<Item>;
+
+    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>): MaybePromise<GetDataReturnType<ItemSheet.ItemSheetData>>;
+  }
+
+  namespace ItemSheet {
+    type Any = ItemSheet<any>;
+
+    interface ItemSheetData<Options extends DocumentSheetOptions<Item> = DocumentSheetOptions<Item>>
+      extends DocumentSheet.DocumentSheetData<Options, Item.ConfiguredInstance> {
+      item: this["document"];
+    }
+  }
+}

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

@@ -0,0 +1,313 @@
+import type { Editor } from "tinymce";
+import type { EditorView } from "prosemirror-view";
+import type { GetDataReturnType, InexactPartial, MaybePromise } from "../../../../types/utils.d.mts";
+import type Showdown from "showdown";
+
+declare global {
+  /**
+   * The Application responsible for displaying and editing a single JournalEntryPage document.
+   */
+  class JournalPageSheet<Options extends JournalPageSheet.Options = JournalPageSheet.Options> extends DocumentSheet<
+    Options,
+    JournalEntryPage.ConfiguredInstance
+  > {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   classes: ["sheet", "journal-sheet", "journal-entry-page"],
+     *   viewClasses: [],
+     *   width: 600,
+     *   height: 680,
+     *   resizable: true,
+     *   closeOnSubmit: false,
+     *   submitOnClose: true,
+     *   viewPermission: CONST.DOCUMENT_OWNERSHIP_LEVELS.OBSERVER,
+     *   includeTOC: true
+     * });
+     * ```
+     */
+    static override get defaultOptions(): JournalPageSheet.Options;
+
+    override get template(): string;
+
+    override get title(): string;
+
+    toc: Record<string, JournalEntryPage.JournalEntryPageHeading>;
+
+    override getData(
+      options?: Partial<Options>,
+    ): MaybePromise<GetDataReturnType<JournalPageSheet.JournalPageSheetData>>;
+
+    protected override _renderInner(data: ReturnType<this["getData"]>): Promise<JQuery<HTMLElement>>;
+
+    protected override _getSecretContent(secret: HTMLElement): string;
+
+    protected override _updateSecret(secret: HTMLElement, content: string): Promise<void | JournalEntryPage>;
+
+    override activateEditor(
+      name: string,
+      options?: TextEditor.Options,
+      initialContent?: string,
+    ): Promise<Editor | EditorView>;
+
+    /**
+     * Update the parent sheet if it is open when the server autosaves the contents of this editor.
+     * @param html - The updated editor contents.
+     */
+    onAutosave(html: string): void;
+
+    /**
+     * Update the UI appropriately when receiving new steps from another client.
+     */
+    onNewSteps(): void;
+  }
+
+  namespace JournalPageSheet {
+    type Any = JournalPageSheet<any>;
+
+    interface Options extends DocumentSheetOptions<JournalEntryPage.ConfiguredInstance> {}
+
+    interface JournalPageSheetData
+      extends DocumentSheet.DocumentSheetData<Options, JournalEntryPage.ConfiguredInstance> {
+      headingLevels: Record<number, string>;
+    }
+  }
+
+  /**
+   * The Application responsible for displaying and editing a single JournalEntryPage text document.
+   */
+  class JournalTextPageSheet extends JournalPageSheet {
+    /**
+     * Bi-directional HTML \<-\> Markdown converter.
+     */
+    protected static _converter: Showdown.Converter;
+
+    /**
+     * Declare the format that we edit text content in for this sheet so we can perform conversions as necessary.
+     * @defaultValue `CONST.JOURNAL_ENTRY_PAGE_FORMATS.HTML`
+     */
+    static get format(): foundry.CONST.JOURNAL_ENTRY_PAGE_FORMATS;
+
+    /**
+     * @defaultValue
+     * ```typescript
+     * const options = super.defaultOptions;
+     * options.classes.push("text");
+     * options.secrets.push({parentSelector: "section"});
+     * return options;
+     * ```
+     */
+    static override get defaultOptions(): JournalPageSheet.Options;
+
+    override getData(
+      options?: Partial<JournalPageSheet.Options>,
+    ): Promise<GetDataReturnType<JournalTextPageSheet.TextData>>;
+
+    override close(options?: FormApplication.CloseOptions): Promise<void>;
+
+    protected override _render(
+      force?: boolean,
+      options?: Application.RenderOptions<JournalPageSheet.Options>,
+    ): Promise<void>;
+
+    /**
+     * Determine if any editors are dirty.
+     */
+    isEditorDirty(): boolean;
+
+    protected _updateObject(event: Event, formData: object): Promise<unknown>;
+
+    /**
+     * Lazily convert text formats if we detect the document being saved in a different format.
+     * @param renderData - Render data.
+     */
+    protected _convertFormats(renderData: object): void;
+  }
+
+  namespace JournalTextPageSheet {
+    interface TextData extends JournalPageSheet.JournalPageSheetData {
+      editor: {
+        engine: string;
+        collaborate: boolean;
+        content: string;
+      };
+    }
+  }
+
+  /**
+   * The Application responsible for displaying and editing a single JournalEntryPage image document.
+   */
+  class JournalImagePageSheet extends JournalPageSheet {
+    /**
+     * @defaultValue
+     * ```typescript
+     * const options = super.defaultOptions;
+     * options.classes.push("image");
+     * options.height = "auto";
+     * return options;
+     * ```
+     */
+    static override get defaultOptions(): JournalPageSheet.Options;
+  }
+
+  /**
+   * The Application responsible for displaying and editing a single JournalEntryPage video document.
+   */
+  class JournalVideoPageSheet extends JournalPageSheet {
+    /**
+     * const options = super.defaultOptions;
+     * options.classes.push("video");
+     * options.height = "auto";
+     * return options;
+     */
+    static override get defaultOptions(): JournalPageSheet.Options;
+
+    override getData(
+      options?: Partial<JournalPageSheet.Options>,
+    ): MaybePromise<GetDataReturnType<JournalVideoPageSheet.VideoData>>;
+
+    override activateListeners(html: JQuery<HTMLElement>): void;
+
+    /**
+     * Get the YouTube player parameters depending on whether the sheet is being viewed or edited.
+     */
+    _getYouTubeVars(): {
+      playsinline: number;
+      modestbranding: number;
+      controls?: number;
+      autoplay?: number;
+      loop?: number;
+      start?: number;
+    };
+
+    protected override _getSubmitData(updateData?: object | null): Record<string, unknown>;
+
+    /**
+     * Convert time components to a timestamp in seconds.
+     * @param components - The time components
+     * @returns The timestamp, in second
+     */
+    _timeComponentsToTimestamp(components?: InexactPartial<JournalVideoPageSheet.TimeComponents>): number;
+
+    _timestampToTimeComponents(timestamp: number): Partial<JournalVideoPageSheet.TimeComponents>;
+  }
+
+  namespace JournalVideoPageSheet {
+    interface VideoData extends JournalPageSheet.JournalPageSheetData {
+      flexRatio: number;
+      isYouTube: boolean;
+      timestamp: number;
+      yt: {
+        id: string;
+        url: string;
+      };
+    }
+
+    interface TimeComponents {
+      h: number;
+      m: number;
+      s: number;
+    }
+  }
+
+  /**
+   * The Application responsible for displaying and editing a single JournalEntryPage PDF document.
+   */
+  class JournalPDFPageSheet extends JournalPageSheet {
+    static override get defaultOptions(): JournalPageSheet.Options;
+
+    /**
+     * Maintain a cache of PDF sizes to avoid making HEAD requests every render.
+     */
+    static _sizes: Record<string, number>;
+
+    override activateListeners(html: JQuery<HTMLElement>): void;
+
+    override getData(
+      options?: Partial<JournalPageSheet.Options>,
+    ): MaybePromise<GetDataReturnType<JournalPDFPageSheet.PDFData>>;
+
+    protected override _renderInner(data: ReturnType<this["getData"]>): Promise<JQuery<HTMLElement>>;
+
+    /**
+     * Handle a request to load a PDF.
+     * @param event - The triggering event.
+     */
+    protected _onLoadPDF(event: MouseEvent): void;
+
+    /**
+     * Retrieve parameters to pass to the PDF viewer.
+     */
+    protected _getViewerParams(): URLSearchParams;
+  }
+
+  namespace JournalPDFPageSheet {
+    interface PDFData extends JournalPageSheet.JournalPageSheetData {
+      params: URLSearchParams;
+    }
+  }
+
+  /**
+   * A subclass of {@link JournalTextPageSheet} that implements a markdown editor for editing the text content.
+   */
+  class MarkdownJournalPageSheet extends JournalTextPageSheet {
+    /**
+     * Store the dirty flag for this editor.
+     */
+    _isDirty: boolean;
+
+    /**
+     * @defaultValue `CONST.JOURNAL_ENTRY_PAGE_FORMATS.MARKDOWN`
+     */
+    static override get format(): foundry.CONST.JOURNAL_ENTRY_PAGE_FORMATS;
+
+    static override get defaultOptions(): JournalPageSheet.Options;
+
+    override get template(): string;
+
+    override getData(
+      options?: Partial<JournalPageSheet.Options>,
+    ): Promise<GetDataReturnType<MarkdownJournalPageSheet.MarkdownData>>;
+
+    override activateListeners(html: JQuery<HTMLElement>): void;
+
+    override isEditorDirty(): boolean;
+
+    protected override _updateObject(event: Event, formData: object): Promise<unknown>;
+
+    protected override _onDrop(event: DragEvent): void;
+
+    /**
+     * Handle dropping a content link onto the editor.
+     * @param eventData - The parsed event Data
+     */
+    _onDropContentLink(eventData: ReturnType<(typeof TextEditor)["getDragEventData"]>): Promise<void>;
+  }
+
+  namespace MarkdownJournalPageSheet {
+    interface MarkdownData extends JournalTextPageSheet.TextData {
+      markdownFormat: foundry.CONST.JOURNAL_ENTRY_PAGE_FORMATS;
+    }
+  }
+
+  /**
+   * A subclass of {@link JournalTextPageSheet} that implements a TinyMCE editor.
+   */
+  class JournalTextTinyMCESheet extends JournalTextPageSheet {
+    override getData(
+      options?: Partial<JournalPageSheet.Options>,
+    ): Promise<GetDataReturnType<JournalTextTinyMCESheet.MCEData>>;
+
+    override close(options?: FormApplication.CloseOptions): Promise<void>;
+
+    protected override _render(
+      force?: boolean,
+      options?: Application.RenderOptions<JournalPageSheet.Options>,
+    ): Promise<void>;
+  }
+
+  namespace JournalTextTinyMCESheet {
+    interface MCEData extends JournalTextPageSheet.TextData {}
+  }
+}