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

package/src/foundry/client/applications/apps/compendium-art-config.d.mts

@@ -0,0 +1,73 @@
+import type { InterfaceToObject, ConformRecord, MustConform, DeepPartial, Identity } from "#utils";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type CompendiumArt from "../../helpers/media/compendium-art.d.mts";
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      CompendiumArtConfig: CompendiumArtConfig.Any;
+    }
+  }
+}
+
+type CompendiumArtConfigParts = ConformRecord<
+  CompendiumArtConfig.Parts,
+  HandlebarsApplicationMixin.HandlebarsTemplatePart
+>;
+
+/**
+ * An application for configuring compendium art priorities.
+ */
+declare class CompendiumArtConfig<
+  RenderContext extends CompendiumArtConfig.RenderContext = CompendiumArtConfig.RenderContext,
+  Configuration extends CompendiumArtConfig.Configuration = CompendiumArtConfig.Configuration,
+  RenderOptions extends CompendiumArtConfig.RenderOptions = CompendiumArtConfig.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {
+  // placeholder private member to help subclassing
+  #compendiumArtConfig: true;
+
+  static override DEFAULT_OPTIONS: Partial<CompendiumArtConfig.Configuration>;
+  static override PARTS: CompendiumArtConfigParts;
+
+  /* -------------------------------------------- */
+  /*  Rendering                                   */
+  /* -------------------------------------------- */
+
+  override _prepareContext(_options: DeepPartial<CompendiumArtConfig.RenderOptions>): Promise<RenderContext>;
+}
+
+declare namespace CompendiumArtConfig {
+  interface Any extends AnyCompendiumArtConfig {}
+  interface AnyConstructor extends Identity<typeof AnyCompendiumArtConfig> {}
+
+  /**
+   * @remarks Foundry's override of `_prepareContext` does not call `super`. Therefore it does not
+   * inherit context from its parent class.
+   */
+  interface RenderContext {
+    config: CompendiumArt.Descriptor[];
+    buttons: ApplicationV2.FormFooterButton[];
+  }
+
+  interface Configuration extends HandlebarsApplicationMixin.Configuration, ApplicationV2.Configuration {}
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+
+  interface Parts {
+    priorities: HandlebarsApplicationMixin.HandlebarsTemplatePart;
+    footer: HandlebarsApplicationMixin.HandlebarsTemplatePart;
+  }
+}
+
+declare abstract class AnyCompendiumArtConfig extends CompendiumArtConfig<
+  CompendiumArtConfig.RenderContext,
+  CompendiumArtConfig.Configuration,
+  CompendiumArtConfig.RenderOptions
+> {}
+
+type _PartsMustBeValid = MustConform<
+  InterfaceToObject<CompendiumArtConfig.Parts>,
+  Record<string, HandlebarsApplicationMixin.HandlebarsTemplatePart>
+>;
+
+export default CompendiumArtConfig;

package/src/foundry/client/applications/apps/document-ownership.d.mts

@@ -0,0 +1,51 @@
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type { Identity } from "#utils";
+
+import Document = foundry.abstract.Document;
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      DocumentOwnershipConfig: DocumentOwnershipConfig.Any;
+    }
+  }
+}
+
+/**
+ * A generic application for configuring permissions for various Document types.
+ * @remarks TODO: Stub
+ */
+declare class DocumentOwnershipConfig<
+  Document extends Document.Any = Document.Any,
+  RenderContext extends object = DocumentOwnershipConfig.RenderContext<Document>,
+  Configuration extends
+    DocumentOwnershipConfig.Configuration<Document> = DocumentOwnershipConfig.Configuration<Document>,
+  RenderOptions extends DocumentOwnershipConfig.RenderOptions = DocumentOwnershipConfig.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<Document, RenderContext, Configuration, RenderOptions> {}
+
+declare namespace DocumentOwnershipConfig {
+  interface Any extends AnyDocumentOwnershipConfig {}
+  interface AnyConstructor extends Identity<typeof AnyDocumentOwnershipConfig> {}
+
+  interface RenderContext<Document extends Document.Any = Document.Any>
+    extends HandlebarsApplicationMixin.RenderContext,
+      DocumentSheetV2.RenderContext<Document> {}
+
+  interface Configuration<Document extends Document.Any = Document.Any>
+    extends HandlebarsApplicationMixin.Configuration,
+      DocumentSheetV2.Configuration<Document> {}
+
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, DocumentSheetV2.RenderOptions {}
+}
+
+declare abstract class AnyDocumentOwnershipConfig extends DocumentOwnershipConfig<
+  Document.Any,
+  object,
+  DocumentOwnershipConfig.Configuration<Document.Any>,
+  DocumentOwnershipConfig.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default DocumentOwnershipConfig;

package/src/foundry/client/applications/apps/document-sheet-config.d.mts

@@ -0,0 +1,109 @@
+import type { Identity } from "#utils";
+import type DocumentSheet from "#client/appv1/api/document-sheet-v1.mjs";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+import Document = foundry.abstract.Document;
+
+declare module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      DocumentSheetConfig: DocumentSheetConfig.Any;
+    }
+  }
+}
+
+/**
+ * An Application for configuring Document sheet settings.
+ * @remarks TODO: Stub
+ */
+declare class DocumentSheetConfig<
+  Document extends Document.Any = Document.Any,
+  RenderContext extends DocumentSheetConfig.RenderContext<Document> = DocumentSheetConfig.RenderContext<Document>,
+  Configuration extends DocumentSheetConfig.Configuration<Document> = DocumentSheetConfig.Configuration<Document>,
+  RenderOptions extends DocumentSheetConfig.RenderOptions = DocumentSheetConfig.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<Document, RenderContext, Configuration, RenderOptions> {
+  static registerSheet(
+    documentClass: Document.AnyConstructor,
+    scope: string,
+    sheetClass: DocumentSheet.AnyConstructor | DocumentSheetV2.AnyConstructor,
+    options?: DocumentSheetConfig.SheetRegistrationOptions,
+  ): void;
+
+  static unregisterSheet(
+    documentClass: Document.AnyConstructor,
+    scope: string,
+    sheetClass: DocumentSheet.AnyConstructor | DocumentSheetV2.AnyConstructor,
+    options?: DocumentSheetConfig.UnregisterSheetOptions,
+  ): void;
+}
+
+declare namespace DocumentSheetConfig {
+  interface Any extends AnyDocumentSheetConfig {}
+  interface AnyConstructor extends Identity<typeof AnyDocumentSheetConfig> {}
+
+  interface RenderContext<Document extends Document.Any>
+    extends HandlebarsApplicationMixin.RenderContext,
+      DocumentSheetV2.RenderContext<Document> {}
+
+  interface Configuration<Document extends Document.Any>
+    extends HandlebarsApplicationMixin.Configuration,
+      DocumentSheetV2.Configuration<Document> {}
+
+  interface RenderOptions extends HandlebarsApplicationMixin.RenderOptions, DocumentSheetV2.RenderOptions {}
+  interface SheetRegistrationOptions {
+    /**
+     * A human-readable label for the sheet name, or a function that returns one. Will be localized.
+     */
+    label?: string | (() => string) | undefined;
+
+    /**
+     * An array of Document sub-types to register the sheet for.
+     */
+    types?: string[] | undefined;
+
+    /**
+     * An object of theme keys to labels that the sheet supports. If this
+     * option is not supplied, the sheet is assumed to support both light
+     * and dark themes. If null is supplied, it indicates that the sheet
+     * does not support theming.
+     */
+    themes?: Record<string, string> | null | undefined;
+
+    /**
+     * Whether to make this sheet the default for the provided sub-types.
+     * @defaultValue `false`
+     */
+    makeDefault?: boolean | undefined;
+
+    /**
+     * Whether this sheet is available to be selected as a default sheet for all Documents of that type.
+     * @defaultValue `true`
+     */
+    canBeDefault?: boolean | undefined;
+
+    /**
+     * Whether this sheet appears in the sheet configuration UI for users.
+     * @defaultValue `true`
+     */
+    canConfigure?: boolean | undefined;
+  }
+
+  interface UnregisterSheetOptions {
+    types?: string[] | undefined;
+  }
+
+  /** @deprecated Renamed to SheetRegistrationOptions to match core */
+  interface RegisterSheetOptions extends SheetRegistrationOptions {}
+}
+
+declare abstract class AnyDocumentSheetConfig extends DocumentSheetConfig<
+  Document.Any,
+  DocumentSheetConfig.RenderContext<Document.Any>,
+  DocumentSheetConfig.Configuration<Document.Any>,
+  DocumentSheetConfig.RenderOptions
+> {
+  constructor(...args: never);
+}
+
+export default DocumentSheetConfig;

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

@@ -0,0 +1,453 @@
+import type { EmptyObject, AnyObject, DeepPartial, Identity } from "#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 module "#configuration" {
+  namespace Hooks {
+    interface ApplicationV2Config {
+      FilePicker: FilePicker.Any;
+    }
+  }
+}
+
+/**
+ * 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 FilePicker.RenderOptions = FilePicker.RenderOptions,
+> 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
+   */
+  static upload(
+    source: string,
+    path: string,
+    file: File,
+    body?: FilePicker.UploadBody,
+    options?: FilePicker.UploadOptions,
+  ): Promise<FilePicker.UploadReturn>;
+
+  /**
+   * 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.UploadReturn>;
+
+  /**
+   * 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;
+
+  /**
+   * Retrieve the configured FilePicker implementation.
+   * @privateRemarks TODO: Config.ux handling
+   */
+  static get implementation(): typeof FilePicker;
+}
+
+declare namespace FilePicker {
+  interface Any extends AnyFilePicker {}
+  interface AnyConstructor extends Identity<typeof AnyFilePicker> {}
+
+  /**
+   * @remarks {@linkcode FilePicker.upload} (and {@linkcode FilePicker.uploadPersistent}, which returns a call to the former)
+   * claims to return 'the response object', but actually returns the {@linkcode Response#json}, if any of the various early
+   * returns aren't hit:
+   * - If the response includes a `.error`, returns `false`
+   * - If the response does not include an error but does return an empty `path`, returns void
+   * - If the response is a success with a truthy `path`, returns {@linkcode SuccessResponse}
+   * - If any of the above processes *throw* an error:
+   *   - If it's a {@linkcode foundry.utils.HttpError}, returns void
+   *   - Any other type of error, returns an empty object
+   *
+   */
+  type UploadReturn = false | void | SuccessResponse | EmptyObject;
+
+  interface SuccessResponse {
+    status: "success";
+    path: string;
+    message: string;
+  }
+
+  interface RenderContext extends HandlebarsApplicationMixin.RenderContext, 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 HandlebarsApplicationMixin.Configuration, 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 RenderOptions extends HandlebarsApplicationMixin.RenderOptions, ApplicationV2.RenderOptions {}
+
+  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 {}
+
+  /**
+   * @deprecated Old name for the construction options for FilePicker
+   */
+  interface Options extends Configuration {}
+}
+
+declare abstract class AnyFilePicker extends FilePicker<
+  FilePicker.RenderContext,
+  FilePicker.Configuration,
+  FilePicker.RenderOptions
+> {}
+
+export default FilePicker;