@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1-beta.20250704.94554

package/src/foundry/client-esm/applications/apps/file-picker.d.mts

@@ -1,410 +0,0 @@
-import type { AnyObject, DeepPartial } from "fvtt-types/utils";
-import type ApplicationV2 from "../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-import type { FormSelectOption } from "../forms/fields.d.mts";
-
-declare namespace FilePicker {
-  interface RenderContext extends ApplicationV2.RenderContext {
-    bucket: string | null;
-    buckets: FormSelectOption[] | null;
-    canGoBack: boolean;
-    canUpload: boolean;
-    canSelect: boolean;
-    dirs: FolderContext[];
-    displayMode: DisplayMode;
-    extensions: string[];
-    files: FileContext[];
-    isS3: boolean;
-    noResults: boolean;
-    selected: string;
-    source: SourceInfo | S3SourceInfo;
-    sources: Sources;
-    target: string;
-    tileSize: number | null;
-    user: User.Implementation;
-    favorites: Record<string, FilePicker.FavoriteFolder>;
-    buttons: ApplicationV2.FormFooterButton[];
-  }
-
-  interface FolderContext {
-    name: string;
-    path: string;
-    private: boolean;
-  }
-
-  interface FileContext {
-    name: string;
-    url: string;
-    img: string;
-  }
-
-  interface Configuration extends ApplicationV2.Configuration {
-    /**
-     * A type of file to target.
-     * @defaultValue `"any"`
-     */
-    type?: Type;
-
-    /** The current file path being modified, if any. */
-    current?: string;
-
-    /**
-     * A current file source in "data", "public", or "s3".
-     * @defaultValue `"data"`
-     */
-    activeSource?: SourceType;
-
-    /** A callback function to trigger once a file has been selected. */
-    callback?: Callback;
-
-    /**
-     * A flag which permits explicitly disallowing upload, true by default.
-     * @defaultValue `true`
-     */
-    allowUpload?: boolean;
-
-    /** An HTML form field that the result of this selection is applied to. */
-    field?: HTMLElement;
-
-    /** An HTML button element which triggers the display of this picker. */
-    button?: HTMLButtonElement;
-
-    /** The picker display mode in FilePicker.DISPLAY_MODES. */
-    displayMode?: string;
-
-    /** The picker display mode in FilePicker.DISPLAY_MODES. */
-    favorites?: Record<string, FavoriteFolder>;
-
-    /**
-     * Display the tile size configuration.
-     * @defaultValue `false`
-     */
-    tileSize?: boolean;
-
-    /** Redirect to the root directory rather than starting in the source directory of one of these files. */
-    redirectToRoot?: string[] | null | undefined;
-  }
-
-  interface FavoriteFolder {
-    /** The source of the folder (e.g. "data", "public") */
-    source: string;
-
-    /** The full path to the folder */
-    path: string;
-
-    /** The label for the path */
-    label: string;
-  }
-
-  type Type = "image" | "audio" | "video" | "text" | "imagevideo" | "font" | "folder" | "any";
-
-  type SourceType = keyof Sources;
-
-  interface SourceInfo {
-    target: string;
-  }
-
-  interface S3SourceInfo extends SourceInfo {
-    bucket: string;
-    buckets: string[];
-  }
-
-  interface Sources {
-    data: SourceInfo;
-    public: SourceInfo;
-    s3?: S3SourceInfo;
-  }
-
-  type Callback = (path: string, picker: FilePicker) => void;
-
-  type DisplayMode = "list" | "thumbs" | "tiles" | "images";
-
-  interface BrowseOptions {
-    /** A bucket within which to search if using the S3 source */
-    bucket?: string;
-
-    /** An Array of file extensions to filter on */
-    extensions?: string[];
-
-    /** The requested dir represents a wildcard path */
-    wildcard?: boolean;
-  }
-
-  interface UploadOptions {
-    /**
-     * Display a UI notification when the upload is processed
-     * @defaultValue `true`
-     * @remarks `null` equivalent to `false`
-     */
-    notify?: boolean | undefined | null;
-  }
-
-  // Unknown if these are all possible properties
-  interface BrowseReturn {
-    dirs: string[];
-    extensions: string[];
-    files: string[];
-    gridSize: number | null;
-    private: boolean;
-    privateDirs: string[];
-    target: string;
-  }
-
-  // Unknown if these are all possible properties
-  interface ConfigurePathReturn {
-    private?: boolean;
-  }
-
-  interface UploadBody extends AnyObject {}
-}
-
-/**
- * The FilePicker application renders contents of the server-side public directory.
- * This app allows for navigating and uploading files to the public path.
- */
-declare class FilePicker<
-  RenderContext extends FilePicker.RenderContext = FilePicker.RenderContext,
-  Configuration extends FilePicker.Configuration = FilePicker.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  /**
-   * The full requested path given by the user
-   * @defaultValue `""`
-   */
-  request: string;
-
-  /**
-   * A callback function to trigger once a file has been selected
-   * @defaultValue `null`
-   */
-  callback: FilePicker.Callback | null;
-
-  type: FilePicker.Type;
-
-  /**
-   * The target HTML element this file picker is bound to
-   * @defaultValue `null`
-   */
-  field: HTMLElement | null;
-
-  /**
-   * A button controlling the display of the picker UI
-   * @defaultValue `null`
-   */
-  button: HTMLElement | null;
-
-  /**
-   * The display mode of the FilePicker UI
-   * @defaultValue `FilePicker.LAST_DISPLAY_MODE`
-   */
-  displayMode: string;
-
-  /**
-   * The file sources available for browsing
-   */
-  sources: FilePicker.Sources;
-
-  /**
-   * Track the active source tab which is being browsed
-   */
-  activeSource: FilePicker.SourceType;
-
-  static override PARTS: Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
-
-  static override TABS: Record<string, ApplicationV2.TabsConfiguration>;
-
-  /**
-   * The allowed values for the type of this FilePicker instance.
-   * @defaultValue `["image", "audio", "video", "text", "imagevideo", "font", "folder", "any"]`
-   */
-  static FILE_TYPES: FilePicker.Type[];
-
-  /**
-   * Record the last-browsed directory path so that re-opening a different FilePicker instance uses the same target
-   */
-  static LAST_BROWSED_DIRECTORY: FilePicker.SourceType;
-
-  /**
-   * Record the last-configured display mode so that re-opening a different FilePicker instance uses the same mode.
-   * @defaultValue `"list"`
-   */
-  static LAST_DISPLAY_MODE: FilePicker.DisplayMode;
-
-  /**
-   * Enumerate the allowed FilePicker display modes
-   * @defaultValue `["list", "thumbs", "tiles", "images"]`
-   */
-  static DISPLAY_MODES: FilePicker.DisplayMode[];
-
-  /**
-   * Cache the names of S3 buckets which can be used
-   * @defaultValue `null`
-   */
-  static S3_BUCKETS: string[] | null;
-
-  /**
-   * Return the upload URL to which the FilePicker should post uploaded files
-   */
-  static get uploadURL(): string;
-
-  /**
-   * The latest set of results browsed from the server
-   */
-  results: AnyObject;
-
-  /**
-   * The current set of file extensions which are being filtered upon
-   */
-  extensions: FilePicker.Type[];
-
-  /**
-   * Get favorite folders for quick access
-   */
-  get favorites(): Record<string, FilePicker.FavoriteFolder>;
-
-  override get title(): string;
-
-  /**
-   * Return the source object for the currently active source
-   */
-  get source(): FilePicker.SourceType | FilePicker.S3SourceInfo;
-
-  /**
-   * Return the target directory for the currently active source
-   */
-  get target(): string;
-
-  /**
-   * Return a flag for whether the current user is able to upload file content
-   */
-  get canUpload(): boolean;
-
-  /**
-   * Test a URL to see if it matches a well known s3 key pattern
-   * @param url - An input URL to test
-   * @returns A regular expression match
-   */
-  static matchS3URL(url: string): RegExpMatchArray | null;
-
-  /**
-   * Browse files for a certain directory location
-   * @param source  - The source location in which to browse: see FilePicker#sources for details.
-   * @param target  - The target within the source location
-   * @param options - Optional arguments
-   *                  (default: `{}`)
-   */
-  // not: null
-  static browse(source: string, target: string, options?: FilePicker.BrowseOptions): Promise<FilePicker.BrowseReturn>;
-
-  /**
-   * Configure metadata settings regarding a certain file system path
-   * @param source  - The source location in which to browse: see FilePicker#sources for details.
-   * @param target  - The target within the source location
-   * @param options - Optional arguments modifying the request
-   *                  (default: `{}`)
-   */
-  // not: null
-  static configurePath(
-    source: string,
-    target: string,
-    options?: FilePicker.BrowseOptions,
-  ): Promise<FilePicker.ConfigurePathReturn>;
-
-  /**
-   * Create a subdirectory within a given source. The requested subdirectory path must not already exist.
-   * @param source  - The source location in which to browse: see FilePicker#sources for details.
-   * @param target  - The target within the source location
-   * @param options - Optional arguments which modify the request
-   *                  (default: `{}`)
-   * @returns The full file path of the created directory
-   */
-  // not: null
-  static createDirectory(source: string, target: string, options?: FilePicker.BrowseOptions): Promise<string>;
-
-  /**
-   * Dispatch a POST request to the server containing a directory path and a file to upload
-   * @param source  - The data source to which the file should be uploaded
-   * @param path    - The destination path
-   * @param file    - The File object to upload
-   * @param body    - Additional file upload options sent in the POST body
-   *                  (default: `{}`)
-   * @param options - Additional options to configure how the method behaves
-   *                  (default: `{}`)
-   * @returns The response object
-   */
-  // not: null
-  static upload(
-    source: string,
-    path: string,
-    file: File,
-    body?: FilePicker.UploadBody,
-    options?: FilePicker.UploadOptions,
-  ): Promise<Response>;
-
-  /**
-   * A convenience function that uploads a file to a given package's persistent /storage/ directory
-   * @param packageId - The id of the package to which the file should be uploaded. Only supports Systems and Modules.
-   * @param path      - The relative destination path in the package's storage directory
-   * @param file      - The File object to upload
-   * @param body      - Additional file upload options sent in the POST body
-   *                    (default: `{}`)
-   * @param options   - Additional options to configure how the method behaves
-   *                    (default: `{}`)
-   * @returns The response object
-   */
-  // not: null
-  static uploadPersistent(
-    packageId: string,
-    path: string,
-    file: File,
-    body?: FilePicker.UploadBody,
-    options?: FilePicker.UploadOptions,
-  ): Promise<Response>;
-
-  /**
-   * Browse to a specific location for this FilePicker instance
-   * @param target  - The target within the currently active source location.
-   * @param options - Browsing options
-   *                  (default: `{}`)
-   */
-  // not: null
-  browse(target?: string, options?: FilePicker.BrowseOptions): Promise<this>;
-
-  // Render is overridden for no signature change but omitted here to simplify the deprecation
-
-  protected override _prepareContext(
-    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
-  ): Promise<RenderContext>;
-
-  protected override _prepareTabs(group: string): Record<string, ApplicationV2.Tab>;
-
-  override changeTab(tab: string, group: string, options?: ApplicationV2.ChangeTabOptions): void;
-
-  protected override _onRender(context: DeepPartial<RenderContext>, options: DeepPartial<RenderOptions>): Promise<void>;
-
-  /**
-   * Handle changes to the tile size.
-   * @param event - The triggering event.
-   */
-  protected _onChangeTileSize(event: Event): void;
-
-  /**
-   * Search among shown directories and files.
-   * @param event - The triggering event
-   * @param query - The search input value
-   */
-  protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-
-  /**
-   * Bind the file picker to a new target field.
-   * Assumes the user will provide a HTMLButtonElement which has the data-target and data-type attributes
-   * The data-target attribute should provide the name of the input field which should receive the selected file
-   * The data-type attribute is a string in ["image", "audio"] which sets the file extensions which will be accepted
-   *
-   * @param button - The button element
-   */
-  static fromButton(button: HTMLButtonElement): FilePicker;
-}
-
-export default FilePicker;

package/src/foundry/client-esm/applications/apps/grid-config.d.mts

@@ -1,25 +0,0 @@
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-import type DocumentSheetV2 from "../api/document-sheet.d.mts";
-
-/**
- * A tool for fine-tuning the grid in a Scene
- * @remarks TODO: Stub
- */
-declare class GridConfig<
-  RenderContext extends GridConfig.RenderContext = GridConfig.RenderContext,
-  Configuration extends
-    DocumentSheetV2.Configuration<Scene.Implementation> = DocumentSheetV2.Configuration<Scene.Implementation>,
-  RenderOptions extends
-    HandlebarsApplicationMixin.DocumentSheetV2RenderOptions = HandlebarsApplicationMixin.DocumentSheetV2RenderOptions,
-> extends HandlebarsApplicationMixin(DocumentSheetV2)<
-  Scene.Implementation,
-  RenderContext,
-  Configuration,
-  RenderOptions
-> {}
-
-declare namespace GridConfig {
-  interface RenderContext extends DocumentSheetV2.RenderContext<Scene.Implementation> {}
-}
-
-export default GridConfig;

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

@@ -1,56 +0,0 @@
-import type { DeepPartial } from "fvtt-types/utils";
-import type ApplicationV2 from "../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-
-/**
- * An Image Popout Application which features a single image in a lightbox style frame.
- * Furthermore, this application allows for sharing the display of an image with other connected players.
- *
- * @example Creating an Image Popout
- * ```js
- * // Construct the Application instance
- * const ip = new ImagePopout({
- *   src: "path/to/image.jpg",
- *   uuid: game.actors.getName("My Hero").uuid
- *   window: {title: "My Featured Image"}
- * });
- *
- * // Display the image popout
- * ip.render(true);
- *
- * // Share the image with other connected players
- * ip.shareImage();
- * ```
- * @remarks TODO: Stub
- */
-declare class ImagePopout<
-  RenderContext extends ImagePopout.RenderContext = ImagePopout.RenderContext,
-  Configuration extends ImagePopout.Configuration = ImagePopout.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  constructor(options: DeepPartial<Configuration> & { src: string });
-}
-
-declare namespace ImagePopout {
-  interface RenderContext extends ApplicationV2.RenderContext {}
-
-  interface Configuration extends ApplicationV2.Configuration {
-    /** The URL to the image or video file */
-    src: string;
-
-    /** Caption text to display below the image. */
-    caption: string;
-
-    /**
-     * The UUID of some related {@link foundry.abstract.Document|`Document`}.
-     * @defaultValue `null`
-     */
-    uuid: string | null | undefined;
-
-    /** Force showing or hiding the title */
-    showTitle?: boolean | null | undefined;
-  }
-}
-
-export default ImagePopout;

package/src/foundry/client-esm/applications/apps/permission-config.d.mts

@@ -1,60 +0,0 @@
-import type { ConformRecord, InterfaceToObject, MustConform, DeepPartial } from "fvtt-types/utils";
-import type { UserPermission } from "#common/constants.d.mts";
-import type { CONST } from "../../client.d.mts";
-import type ApplicationV2 from "../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-
-type PermissionConfigRenderContext = InterfaceToObject<PermissionConfig.RenderContext>;
-
-type PermissionConfigParts = ConformRecord<PermissionConfig.Parts, HandlebarsApplicationMixin.HandlebarsTemplatePart>;
-
-/**
- * An application for configuring the permissions which are available to each User role.
- */
-declare class PermissionConfig<
-  RenderContext extends PermissionConfigRenderContext = PermissionConfigRenderContext,
-  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  // placeholder private member to help subclassing
-  #permissionConfig: true;
-
-  static override DEFAULT_OPTIONS: Partial<ApplicationV2.Configuration>;
-  static override PARTS: PermissionConfigParts;
-
-  /* -------------------------------------------- */
-  /*  Rendering                                   */
-  /* -------------------------------------------- */
-
-  override _prepareContext(options: DeepPartial<RenderOptions>): Promise<RenderContext>;
-}
-
-declare namespace PermissionConfig {
-  interface PermissionWithRoles extends UserPermission {
-    id: string;
-    roles: {
-      name: string;
-      value: boolean;
-      readonly: string;
-    }[];
-  }
-
-  interface RenderContext {
-    roles: Record<CONST.USER_ROLES, string>;
-    permissions: PermissionWithRoles[];
-    buttons: ApplicationV2.FormFooterButton[];
-  }
-
-  interface Parts {
-    permissions: HandlebarsApplicationMixin.HandlebarsTemplatePart;
-    footer: HandlebarsApplicationMixin.HandlebarsTemplatePart;
-  }
-}
-
-type _PartsMustBeValid = MustConform<
-  InterfaceToObject<PermissionConfig.Parts>,
-  Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>
->;
-
-export default PermissionConfig;

package/src/foundry/client-esm/applications/dice/roll-resolver.d.mts

@@ -1,110 +0,0 @@
-import type { AnyObject, DeepPartial, EmptyObject, Identity, InexactPartial } from "fvtt-types/utils";
-import type ApplicationV2 from "../api/application.d.mts";
-import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
-
-/**
- * An application responsible for handling unfulfilled dice terms in a roll.
- */
-
-declare class RollResolver<
-  RenderContext extends AnyObject = EmptyObject,
-  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
-  constructor(roll: Roll, options?: DeepPartial<Configuration>);
-
-  // a placeholder private method to help subclassing
-  #rollResolver: true;
-
-  /**
-   * A collection of fulfillable dice terms.
-   */
-  get fulfillable(): Map<string, RollResolver.DiceTermFulfillmentDescriptor>;
-
-  /**
-   * The roll being resolved.
-   */
-  get roll(): Roll;
-  #roll: Roll;
-
-  /**
-   * Identify any terms in this Roll that should be fulfilled externally, and prompt the user to do so.
-   * @returns Returns a Promise that resolves when the first pass of fulfillment is complete.
-   */
-  awaitFulfillment(): Promise<void>;
-
-  /**
-   * Register a fulfilled die roll.
-   * @param method        - The method used for fulfillment.
-   * @param denomination  - The denomination of the fulfilled die.
-   * @param result        - The rolled number.
-   * @returns               Whether the result was consumed.
-   */
-  registerResult(method: string, denomination: string, result: number): boolean;
-
-  /**
-   * Handle prompting for a single extra result from a term.
-   * @param term                - The term.
-   * @param method              - The method used to obtain the result.
-   * @returns
-   */
-  resolveResult(
-    term: foundry.dice.terms.DiceTerm,
-    method: string,
-    options?: InexactPartial<{
-      /** @defaultValue `false` */
-      reroll: boolean;
-      /** @defaultValue `false` */
-      explode: boolean;
-    }>,
-  ): Promise<number | void>;
-
-  /**
-   * Update the Roll instance with the fulfilled results.
-   * @param event     - The originating form submission event.
-   * @param form      - The form element that was submitted.
-   * @param formData  - Processed data for the submitted form.
-   */
-  static _fulfillRoll(event: SubmitEvent, form: HTMLFormElement, formData: FormDataExtended): Promise<void>;
-
-  /**
-   * Add a new term to the resolver.
-   * @param term        - The term.
-   * @returns  A Promise that resolves when the term's results have been externally fulfilled.
-   */
-  addTerm(term: foundry.dice.terms.DiceTerm): Promise<void>;
-
-  /**
-   * Check if all rolls have been fulfilled.
-   */
-  _checkDone(): void;
-
-  /**
-   * Toggle the state of the submit button.
-   * @param enabled  - Whether the button is enabled.
-   */
-  _toggleSubmission(enabled: boolean): void;
-}
-
-declare namespace RollResolver {
-  interface Any extends AnyRollResolver {}
-  interface AnyConstructor extends Identity<typeof AnyRollResolver> {}
-
-  interface DiceTermFulfillmentDescriptor {
-    id: string;
-    term: foundry.dice.terms.DiceTerm;
-    method: string;
-    isNew?: boolean | undefined;
-  }
-}
-
-declare abstract class AnyRollResolver extends RollResolver<
-  AnyObject,
-  ApplicationV2.Configuration,
-  ApplicationV2.RenderOptions
-> {
-  constructor(...args: never);
-}
-
-export default RollResolver;