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

package/src/foundry/client/ui/filepicker.d.mts

@@ -1,477 +0,0 @@
-import type { EmptyObject, MaybePromise, ValueOf } from "fvtt-types/utils";
-
-declare global {
-  interface FilePickerOptions extends ApplicationOptions {
-    /** A type of file to target */
-    type?: FilePicker.Type | undefined;
-
-    /** The current file path being modified, if any */
-    current?: string | undefined;
-
-    /** A current file source in "data", "public", or "s3" */
-    activeSource?: FilePicker.SourceType | undefined;
-
-    /** A callback function to trigger once a file has been selected */
-    callback?: FilePicker.Callback | undefined;
-
-    /** A flag which permits explicitly disallowing upload, true by default */
-    allowUpload?: boolean | undefined;
-
-    /** An HTML form field that the result of this selection is applied to */
-    field?: HTMLElement | undefined;
-
-    /** An HTML button element which triggers the display of this picker */
-    button?: HTMLElement | undefined;
-
-    /** The picker display mode in FilePicker.DISPLAY_MODES */
-    favorites?: Record<string, FilePicker.FavoriteFolder>;
-
-    /** The picker display mode in FilePicker.DISPLAY_MODES */
-    displayMode?: FilePicker.DisplayMode | undefined;
-
-    /** Display the tile size configuration. */
-    tileSize?: boolean | undefined;
-
-    /** Redirect to the root directory rather than starting in the source directory of one of these files. */
-    redirectToRoot?: string[];
-  }
-
-  /**
-   * The FilePicker application renders contents of the server-side public directory.
-   * This app allows for navigating and uploading files to the public path.
-   * @typeParam Options - the type of the options object
-   */
-  class FilePicker<Options extends FilePickerOptions = FilePickerOptions> extends Application<Options> {
-    /**
-     * @param options - Options that configure the behavior of the FilePicker
-     */
-    constructor(options?: Partial<Options>);
-
-    // placeholder private member
-    #filePicker: true;
-
-    /**
-     * The full requested path given by the user
-     */
-    request: string | undefined;
-
-    /**
-     * The file sources which are available for browsing
-     */
-    sources: FilePicker.Sources;
-
-    /**
-     * Track the active source tab which is being browsed
-     * @defaultValue `"data"`
-     */
-    activeSource: FilePicker.SourceType;
-
-    /**
-     * A callback function to trigger once a file has been selected
-     */
-    callback: FilePicker.Callback | undefined;
-
-    /**
-     * The latest set of results browsed from the server
-     * @remarks This is never set.
-     */
-    results: EmptyObject;
-
-    /**
-     * The general file type which controls the set of extensions which will be accepted
-     */
-    type: FilePicker.Type;
-
-    /**
-     * The target HTML element this file picker is bound to
-     */
-    field: HTMLElement | undefined;
-
-    /**
-     * A button which controls the display of the picker UI
-     */
-    button: HTMLElement | undefined;
-
-    /**
-     * The display mode of the FilePicker UI
-     * @defaultValue `FilePicker.LAST_DISPLAY_MODE`
-     */
-    displayMode: FilePicker.DisplayMode;
-
-    /**
-     * The current set of file extensions which are being filtered upon
-     */
-    extensions: string[] | undefined;
-
-    protected _loaded: boolean;
-
-    /**
-     * The allowed values for the type of this FilePicker instance.
-     */
-    static FILE_TYPES: string[];
-
-    /**
-     * Record the last-browsed directory path so that re-opening a different FilePicker instance uses the same target
-     * @defaultValue `""`
-     */
-    static LAST_BROWSED_DIRECTORY: string;
-
-    /**
-     * Record the last-configured tile size which can automatically be applied to new FilePicker instances
-     * @defaultValue `null`
-     */
-    static LAST_TILE_SIZE: number | null;
-
-    /**
-     * 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
-     */
-    static DISPLAY_MODES: ["list", "thumbs", "tiles", "images"];
-
-    /**
-     * Cache the names of S3 buckets which can be used
-     * @defaultValue `null`
-     */
-    static S3_BUCKETS: string[] | null;
-
-    /**
-     * Get favorite folders for quick access
-     */
-    static get favorites(): Record<string, FilePicker.FavoriteFolder>;
-
-    /**
-     * Set favorite folders for quick access
-     */
-    static set favorites(favorites: Record<string, FilePicker.FavoriteFolder>);
-
-    /**
-     * Add the given path for the source to the favorites
-     * @param source - The source of the folder (e.g. "data", "public")
-     * @param path   - The path to a folder
-     */
-    static setFavorite(source: string, path: string): Promise<void>;
-
-    /**
-     * Remove the given path from to the favorites
-     * @param source - The source of the folder (e.g. "data", "public")
-     * @param path   - The path to a folder
-     */
-    static removeFavorite(source: string, path: string): Promise<void>;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   template: "templates/apps/filepicker.html",
-     *   classes: ["filepicker"],
-     *   width: 520,
-     *   tabs: [{navSelector: ".tabs"}],
-     *   dragDrop: [{dragSelector: ".file", dropSelector: ".filepicker-body"}],
-     *   tileSize: false,
-     *   filters: [{inputSelector: 'input[name="filter"]', contentSelector: ".filepicker-body"}]
-     * })
-     * ```
-     */
-    static override get defaultOptions(): FilePickerOptions;
-
-    /**
-     * Given a current file path, determine the directory it belongs to
-     * @param target - The currently requested target path
-     * @returns An array of the inferred source and target directory path
-     * @internal
-     */
-    protected _inferCurrentDirectory(target: string): [string, string];
-
-    /**
-     * 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;
-
-    override get title(): string;
-
-    /**
-     * Return the source object for the currently active source
-     */
-    get source(): FilePicker.Source;
-
-    /**
-     * 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;
-
-    /**
-     * Return the upload URL to which the FilePicker should post uploaded files
-     */
-    static get uploadURL(): string;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>;
-
-    override setPosition(
-      position?: Partial<Omit<Application.Position, "zIndex">>,
-    ): void | (Application.Position & { height: number });
-
-    /**
-     * Browse to a specific location for this FilePicker instance
-     * @param target - The target within the currently active source location.
-     * @param options - Browsing options (default: `{}`)
-     */
-    browse(target?: string, options?: FilePicker.BrowseOptions): Promise<FilePicker.BrowseResult>;
-
-    /**
-     * 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 (default: `""`)
-     * @param options - Optional arguments (default: `{}`)
-     *
-     * @returns A Promise which resolves to the directories and files contained in the location
-     */
-    static browse(
-      source: FilePicker.SourceType,
-      target: string,
-      options?: FilePicker.BrowseOptions,
-    ): Promise<FilePicker.BrowseResult>;
-
-    /**
-     * 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 which modify the request (default: `{}`)
-     */
-    static configurePath(
-      source: FilePicker.SourceType,
-      target: string,
-      options?: FilePicker.ConfigurePathOptions,
-    ): Promise<FilePicker.ConfigurePathResult>;
-
-    /**
-     * 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: `{}`)
-     */
-    static createDirectory(
-      source: FilePicker.SourceType,
-      target: string,
-      options?: FilePicker.CreateDirectoryOptions,
-    ): 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
-     */
-    static upload(
-      source: FilePicker.SourceType,
-      path: string,
-      file: File,
-      body?: FilePicker.UploadBody,
-      options?: FilePicker.UploadOptions,
-    ): Promise<FilePicker.UploadResult | false | void | EmptyObject>;
-
-    /**
-     * 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
-     */
-    static uploadPersistent(
-      packageId: string,
-      path: string,
-      file: File,
-      body?: FilePicker.UploadBody,
-      options?: FilePicker.UploadOptions,
-    ): Promise<FilePicker.UploadResult | false | void | EmptyObject>;
-
-    /**
-     * Additional actions performed when the file-picker UI is rendered
-     */
-    override render(force?: boolean, options?: Application.RenderOptions<Options>): this;
-
-    override activateListeners(html: JQuery): void;
-
-    protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: this["activeSource"]): void;
-
-    protected override _canDragStart(selector: string | null): boolean;
-
-    protected override _canDragDrop(selector: string | null): boolean;
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    /**
-     * @internal
-     */
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Handle changes to the tile size.
-     * @param event - The triggering event.
-     */
-    _onChangeTileSize(event: Event): void;
-
-    protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-
-    protected _onSubmit(ev: Event): void;
-
-    /**
-     * Bind the file picker to a new target field.
-     * Assumes the user will provide a <button> HTMLElement 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;
-  }
-
-  namespace FilePicker {
-    interface BrowseResult {
-      target: string;
-      private: boolean;
-      dirs: string[];
-      privateDirs: string[];
-      files: string[];
-      gridSize: number | null;
-      extensions: [];
-    }
-
-    interface BrowseOptions {
-      /**
-       * A bucket within which to search, if using the S3 source
-       */
-      bucket?: string | undefined;
-
-      /**
-       * An Array of file extensions to filter on
-       * @defaultValue `[]` (do not filter on extension)
-       */
-      extensions?: string[] | undefined;
-
-      /**
-       * The requested dir represents a wildcard path
-       * @defaultValue false
-       */
-      wildcard?: boolean | undefined;
-    }
-
-    type Callback = (path: string) => void;
-
-    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;
-    }
-
-    interface ConfigurePathOptions {
-      bucket?: string | undefined | null;
-
-      private?: boolean | undefined;
-
-      gridSize?: number | undefined;
-    }
-
-    interface ConfigurePathResult {
-      private?: boolean;
-      gridSize?: number;
-    }
-
-    interface CreateDirectoryOptions {
-      /**
-       * @defaultValue `""`
-       */
-      bucket?: string | null | undefined;
-    }
-
-    type SourceType = "data" | "public" | "s3";
-
-    interface Dir {
-      name: string;
-      path: string;
-      private: boolean;
-    }
-
-    type DisplayMode = ValueOf<(typeof FilePicker)["DISPLAY_MODES"]>;
-
-    interface ManageFilesDataBase {
-      source: string;
-      target: string;
-    }
-
-    interface BrowseFilesData extends ManageFilesDataBase {
-      action: "browseFiles";
-    }
-
-    interface ConfigurePathData extends ManageFilesDataBase {
-      action: "configurePath";
-    }
-
-    interface CreateDirectoryData extends ManageFilesDataBase {
-      action: "createDirectory";
-    }
-
-    interface Source {
-      target: string;
-      label: string;
-      icon: string;
-    }
-
-    interface Sources {
-      data: Source;
-      public: Source;
-      s3?: Source & {
-        buckets: string[];
-        bucket: string;
-      };
-    }
-
-    type Type = "image" | "audio" | "video" | "text" | "imagevideo" | "font" | "folder" | "any";
-
-    interface UploadBody {
-      /**
-       * A bucket to upload to, if using the S3 source
-       * @defaultValue `""`
-       */
-      bucket?: string | null | undefined;
-    }
-
-    interface UploadOptions {
-      /**
-       * Display a UI notification when the upload is processed
-       * @defaultValue `true`
-       */
-      notify?: boolean | undefined;
-    }
-
-    interface UploadResult {
-      message: string;
-      path: string;
-      status: "success";
-    }
-  }
-}

package/src/foundry/client/ui/filter.d.mts

@@ -1,148 +0,0 @@
-import type { ValueOf } from "fvtt-types/utils";
-
-declare global {
-  /** Options which customize the behavior of the filter */
-  interface SearchFilterConfiguration {
-    /**
-     * The CSS selector used to target the text input element.
-     */
-    inputSelector: string;
-
-    /**
-     * The CSS selector used to target the content container for these tabs.
-     */
-    contentSelector: string;
-
-    /**
-     * A callback function which executes when the filter changes.
-     */
-    callback?: SearchFilter["callback"];
-
-    /**
-     * The initial value of the search query.
-     * @defaultValue `""`
-     */
-    initial?: SearchFilter["query"] | undefined;
-
-    /**
-     * The number of milliseconds to wait for text input before processing.
-     * @defaultValue `100`
-     */
-    delay?: number;
-  }
-
-  interface FieldFilter {
-    /** The dot-delimited path to the field being filtered */
-    field: string;
-
-    /**
-     * The search operator, from CONST.OPERATORS
-     * @defaultValue `SearchFilter.OPERATORS.EQUALS`
-     */
-    operator: ValueOf<typeof SearchFilter.OPERATORS>;
-
-    /** Negate the filter, returning results which do NOT match the filter criteria */
-    negate: boolean;
-
-    /** The value against which to test */
-    value: any;
-  }
-
-  /**
-   * A controller class for managing a text input widget that filters the contents of some other UI element
-   * @see {@link Application}
-   */
-  class SearchFilter {
-    static readonly OPERATORS: {
-      EQUALS: "equals";
-      CONTAINS: "contains";
-      STARTS_WITH: "starts_with";
-      ENDS_WITH: "ends_with";
-      LESS_THAN: "lt";
-      LESS_THAN_EQUAL: "lte";
-      GREATER_THAN: "gt";
-      GREATER_THAN_EQUAL: "gte";
-      BETWEEN: "between";
-      IS_EMPTY: "is_empty";
-    };
-
-    /**
-     * @param options - Options which customize the behavior of the filter
-     */
-    constructor(options: SearchFilterConfiguration);
-
-    /**
-     * The value of the current query string
-     */
-    query: string;
-
-    /**
-     * A callback function to trigger when the tab is changed
-     */
-    callback: (event: KeyboardEvent, query: string, rgx: RegExp, content: HTMLElement | null) => void;
-
-    /**
-     * The regular expression corresponding to the query that should be matched against
-     * @defaultValue `undefined`
-     */
-    rgx: RegExp | undefined;
-
-    /**
-     * The CSS selector used to target the tab navigation element
-     * @internal
-     */
-    protected _inputSelector: string;
-
-    /**
-     * A reference to the HTML navigation element the tab controller is bound to
-     * @internal
-     */
-    protected _input: HTMLElement | null;
-
-    /**
-     * The CSS selector used to target the tab content element
-     * @internal
-     */
-    protected _contentSelector: string;
-
-    /**
-     * A reference to the HTML container element of the tab content
-     * @internal
-     */
-    protected _content: HTMLElement | null;
-
-    /**
-     * A debounced function which applies the search filtering
-     * @internal
-     */
-    protected _filter: (...args: Parameters<this["callback"]>) => void;
-
-    /**
-     * Test whether a given object matches a provided filter
-     * @param obj    - An object to test against
-     * @param filter - The filter to test
-     * @returns Whether the object matches the filter
-     */
-    static evaluateFilter(obj: Record<string, any>, filter: FieldFilter): boolean;
-
-    /**
-     * Bind the SearchFilter controller to an HTML application
-     */
-    bind(html: HTMLElement): void;
-
-    /**
-     * Perform a filtering of the content by invoking the callback function
-     * @param event - The triggering keyboard event
-     * @param query - The input search string
-     */
-    filter(event: KeyboardEvent, query: string): void;
-
-    /**
-     * Clean a query term to standardize it for matching.
-     * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/normalize
-     * @param query - An input string which may contain leading/trailing spaces or diacritics
-     * @returns A cleaned string of ASCII characters for comparison
-     */
-    static cleanQuery(query: string): string;
-  }
-}

package/src/foundry/client/ui/forms.d.mts

@@ -1,85 +0,0 @@
-export {};
-
-declare global {
-  /**
-   * An extension of the native FormData implementation.
-   *
-   * This class functions the same way that the default FormData does, but it is more opinionated about how
-   * input fields of certain types should be evaluated and handled.
-   *
-   * It also adds support for certain Foundry VTT specific concepts including:
-   *  Support for defined data types and type conversion
-   *  Support for TinyMCE editors
-   *  Support for editable HTML elements
-   */
-  class FormDataExtended extends FormData {
-    /**
-     * @param form    - The form being processed
-     * @param options - Options which configure form processing
-     */
-    constructor(form: HTMLFormElement, options?: FormDataExtended.Options);
-
-    /**
-     * A mapping of data types requested for each form field.
-     * @defaultValue `{}`
-     */
-    dtypes: Partial<Record<string, string>>;
-
-    /**
-     * A record of TinyMCE editors which are linked to this form.
-     * @defaultValue `{}`
-     */
-    editors: Partial<Record<string, FormApplication.FormApplicationEditor>>;
-
-    /**
-     * The object representation of the form data, available once processed.
-     */
-    get object(): Record<string, string | number>;
-
-    /**
-     * Process the HTML form element to populate the FormData instance.
-     * @param form    - The HTML form being processed
-     * @param options - Options forwarded from the constructor
-     */
-    process(form: HTMLFormElement, options: FormDataExtended.Options): void;
-
-    /**
-     * Assign a value to the FormData instance which always contains JSON strings.
-     * Also assign the cast value in its preferred data type to the parsed object representation of the form data.
-     * @param name - The field name
-     * @param value - The raw extracted value from the field
-     */
-    override set(name: string, value: any): void;
-
-    /**
-     * Append values to the form data, adding them to an array.
-     * @param name - The field name to append to the form
-     * @param value - The value to append to the form data
-     */
-    override append(name: string, value: any): void;
-  }
-}
-
-declare namespace FormDataExtended {
-  interface Options {
-    /**
-     * A record of TinyMCE editor metadata objects, indexed by their update key
-     * (default: `{}`)
-     */
-    editors?: FormDataExtended["editors"];
-    /**
-     * A mapping of data types for form fields
-     * (default: `{}`)
-     */
-    dtypes?: FormDataExtended["dtypes"];
-    /**
-     * Include disabled fields?
-     * (default: `false`)
-     */
-    disabled?: boolean;
-    /** Include readonly fields?
-     * (default: `true`)
-     */
-    readonly?: boolean;
-  }
-}