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

package/src/foundry/client-esm/applications/api/category-browser.d.mts

@@ -1,40 +0,0 @@
-import type ApplicationV2 from "./application.d.mts";
-import type HandlebarsApplicationMixin from "./handlebars-application.d.mts";
-
-/**
- * An abstract class responsible for displaying a 2-pane Application that allows for entries to be grouped and filtered
- * by category.
- * @remarks TODO: Stub
- * @remarks This is not actually *imported* anywhere it can be used, it appears to be for internal FVTT use only.
- */
-declare class CategoryBrowser<
-  RenderContext extends CategoryBrowser.RenderContext = CategoryBrowser.RenderContext,
-  Configuration extends CategoryBrowser.Configuration = CategoryBrowser.Configuration,
-  RenderOptions extends
-    HandlebarsApplicationMixin.ApplicationV2RenderOptions = HandlebarsApplicationMixin.ApplicationV2RenderOptions,
-> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}
-
-declare namespace CategoryBrowser {
-  interface Configuration extends ApplicationV2.Configuration {
-    /** The initial category tab: omitting this will result in an initial active tab that corresponds with the first category by insertion order. */
-    initialCategory: string | null;
-
-    /** Additional Template partials for specific use with this class */
-    subtemplates: Subtemplates;
-  }
-
-  interface Subtemplates {
-    /** The markup used for each category: required to be set by any subclass */
-    category: string;
-
-    /** Optional template for secondary filtering (aside from text search) */
-    filter: string | null;
-
-    /** Optional sidebar footer content */
-    sidebarFooter: string | null;
-  }
-
-  interface RenderContext extends ApplicationV2.RenderContext {}
-}
-
-export default CategoryBrowser;

package/src/foundry/client-esm/applications/api/dialog.d.mts

@@ -1,346 +0,0 @@
-import type { DeepPartial, EmptyObject, InexactPartial, MaybePromise, NullishCoalesce } from "fvtt-types/utils";
-import type ApplicationV2 from "./application.d.mts";
-
-/**
- * A lightweight Application that renders a dialog containing a form with arbitrary content, and some buttons.
- *
- * @example Prompt the user to confirm an action.
- * ```js
- * const proceed = await foundry.applications.api.DialogV2.confirm({
- *   content: "Are you sure?",
- *   rejectClose: false,
- *   modal: true
- * });
- * if ( proceed ) console.log("Proceed.");
- * else console.log("Do not proceed.");
- * ```
- *
- * @example Prompt the user for some input.
- * ```js
- * let guess;
- * try {
- *   guess = await foundry.applications.api.DialogV2.prompt({
- *     window: { title: "Guess a number between 1 and 10" },
- *     content: '<input name="guess" type="number" min="1" max="10" step="1" autofocus>',
- *     ok: {
- *       label: "Submit Guess",
- *       callback: (event, button, dialog) => button.form.elements.guess.valueAsNumber
- *     }
- *   });
- * } catch {
- *   console.log("User did not make a guess.");
- *   return;
- * }
- * const n = Math.ceil(CONFIG.Dice.randomUniform() * 10);
- * if ( n === guess ) console.log("User guessed correctly.");
- * else console.log("User guessed incorrectly.");
- * ```
- *
- * @example A custom dialog.
- * ```js
- * new foundry.applications.api.DialogV2({
- *   window: { title: "Choose an option" },
- *   content: `
- *     <label><input type="radio" name="choice" value="one" checked> Option 1</label>
- *     <label><input type="radio" name="choice" value="two"> Option 2</label>
- *     <label><input type="radio" name="choice" value="three"> Options 3</label>
- *   `,
- *   buttons: [{
- *     action: "choice",
- *     label: "Make Choice",
- *     default: true,
- *     callback: (event, button, dialog) => button.form.elements.choice.value
- *   }, {
- *     action: "all",
- *     label: "Take All"
- *   }],
- *   submit: result => {
- *     if ( result === "all" ) console.log("User picked all options.");
- *     else console.log(`User picked option: ${result}`);
- *   }
- * }).render({ force: true });
- * ```
- */
-declare class DialogV2<
-  RenderContext extends object = EmptyObject,
-  Configuration extends DialogV2.Configuration = DialogV2.Configuration,
-  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
-> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {
-  static override DEFAULT_OPTIONS: DeepPartial<ApplicationV2.Configuration>;
-
-  protected override _initializeApplicationOptions(options: DeepPartial<DialogV2.Configuration>): Configuration;
-
-  protected override _renderHTML(
-    _context: RenderContext,
-    _options: DeepPartial<RenderOptions>,
-  ): Promise<HTMLFormElement>;
-
-  /**
-   * Render configured buttons.
-   */
-  protected _renderButtons(): string;
-
-  /**
-   * Handle submitting the dialog.
-   * @param target - The button that was clicked or the default button.
-   * @param event - The triggering event.
-   */
-  protected _onSubmit(target: HTMLButtonElement, event: PointerEvent | SubmitEvent): Promise<DialogV2>;
-
-  protected override _onFirstRender(_context: RenderContext, _options: DeepPartial<RenderOptions>): Promise<void>;
-
-  protected override _replaceHTML(
-    result: HTMLFormElement,
-    content: HTMLElement,
-    _options: DeepPartial<RenderOptions>,
-  ): void;
-
-  /**
-   * Handle keypresses within the dialog.
-   * @param event - The triggering event.
-   */
-  protected _onKeyDown(event: KeyboardEvent): void;
-
-  /**
-   * @param event - The originating click event.
-   * @param target - The button element that was clicked.
-   */
-  protected static _onClickButton(this: DialogV2, event: PointerEvent, target: HTMLButtonElement): void;
-
-  /**
-   * A utility helper to generate a dialog with yes and no buttons.
-   * @returns Resolves to true if the yes button was pressed, or false if the no button
-   *          was pressed. If additional buttons were provided, the Promise resolves to
-   *          the identifier of the one that was pressed, or the value returned by its
-   *          callback. If the dialog was dismissed, and rejectClose is false, the
-   *          Promise resolves to null.
-   */
-  static confirm<Options extends DialogV2.ConfirmConfig<unknown, unknown>>(
-    config?: Options,
-  ): Promise<DialogV2.ConfirmReturn<Options>>;
-
-  /**
-   * A utility helper to generate a dialog with a single confirmation button.
-   * @returns  - Resolves to the identifier of the button used to submit the dialog,
-   *             or the value returned by that button's callback. If the dialog was
-   *             dismissed, and rejectClose is false, the Promise resolves to null.
-   */
-  static prompt<Options extends DialogV2.PromptConfig<unknown>>(
-    config?: Options,
-  ): Promise<DialogV2.PromptReturn<Options>>;
-
-  /**
-   * Spawn a dialog and wait for it to be dismissed or submitted.
-   * @returns Resolves to the identifier of the button used to submit the
-   *          dialog, or the value returned by that button's callback. If the
-   *          dialog was dismissed, and rejectClose is false, the Promise
-   *          resolves to null.
-   */
-  static wait<Options extends DialogV2.WaitOptions>(config?: Options): Promise<DialogV2.WaitReturn<Options>>;
-
-  /**
-   * Present an asynchronous Dialog query to a specific User for response.
-   * @param user   - A User instance or a User id
-   * @param type   - The type of Dialog to present
-   * @param config - Dialog configuration forwarded on to the Dialog.prompt, Dialog.confirm, or
-   *                 Dialog.wait function depending on the query type. Callback options are not supported.
-   * @returns The query response or null if no response was provided
-   *
-   * @see {@link DialogV2.prompt}
-   * @see {@link DialogV2.confirm}
-   * @see {@link DialogV2.wait}
-   */
-  static query<T extends DialogV2.Type, Options extends DialogV2.QueryConfig<T>>(
-    user: User.Implementation | string,
-    type: T,
-    config?: Options,
-  ): Promise<DialogV2.QueryReturn<T, Options>>;
-
-  /**
-   * The dialog query handler.
-   */
-  static _handleQuery<T extends DialogV2.Type, Options extends DialogV2.QueryConfig<T>>(config: {
-    type: T;
-    config: Options;
-  }): Promise<DialogV2.QueryReturn<T, Options>>;
-}
-
-declare namespace DialogV2 {
-  interface Button<CallbackReturn> extends NoCallbackButton {
-    /**
-     * A function to invoke when the button is clicked. The value returned
-     * from this function will be used as the dialog's submitted value.
-     * Otherwise, the button's identifier is used.
-     */
-    callback?: ButtonCallback<CallbackReturn>;
-  }
-
-  type ButtonCallback<T> = (
-    event: PointerEvent | SubmitEvent,
-    button: HTMLButtonElement,
-    dialog: HTMLDialogElement,
-  ) => MaybePromise<T>;
-
-  interface NoCallbackButton {
-    /**
-     * The button action identifier.
-     */
-    action: string;
-
-    /**
-     * The button label. Will be localized.
-     */
-    label: string;
-
-    /**
-     * FontAwesome icon classes.
-     */
-    icon?: string;
-
-    /**
-     * CSS classes to apply to the button.
-     */
-    class?: string;
-
-    /**
-     * Whether this button represents the default action to take if the user
-     * submits the form without pressing a button, i.e. with an Enter
-     * keypress.
-     */
-    default?: boolean;
-  }
-
-  interface Configuration extends ApplicationV2.Configuration {
-    /**
-     * Modal dialogs prevent interaction with the rest of the UI until they are dismissed or submitted.
-     */
-    modal?: boolean;
-
-    /**
-     * Button configuration.
-     */
-    buttons: Button<unknown>[];
-
-    /**
-     * The dialog content: a HTML string or a <div> element.
-     * If string, the content is cleaned with {@link foundry.utils.cleanHTML}.
-     * Otherwise, the content is not cleaned.
-     * @defaultValue `''`
-     */
-    content: string | HTMLDivElement;
-
-    /**
-     * A function to invoke when the dialog is submitted.
-     * This will not be called if the dialog is dismissed.
-     */
-    submit?: SubmitCallback | null | undefined;
-  }
-
-  type RenderCallback = (event: Event, dialog: HTMLDialogElement) => void;
-
-  type CloseCallback = (event: Event, dialog: DialogV2) => void;
-
-  // This is nominally receiving the results of the button callbacks,
-  // but that just further complicates the conditional types
-  type SubmitCallback = (result: unknown) => Promise<void>;
-
-  interface WaitOptions extends DeepPartial<Configuration> {
-    /**
-     * A synchronous function to invoke whenever the dialog is rendered.
-     */
-    render?: RenderCallback | null | undefined;
-
-    /**
-     * A synchronous function to invoke when the dialog is closed under any circumstances.
-     */
-    close?: CloseCallback | null | undefined;
-
-    /**
-     * Throw a Promise rejection if the dialog is dismissed.
-     * @defaultValue `false`
-     * @remarks `null` equivalent to `false`
-     */
-    rejectClose?: boolean | null | undefined;
-
-    /**
-     * The user that the dialog should be shown to.
-     */
-    user?: User.Implementation;
-  }
-
-  interface ConfirmConfig<YesReturn, NoReturn> extends WaitOptions {
-    /** Options to overwrite the default yes button configuration. */
-    yes?: InexactPartial<Button<YesReturn>> | null | undefined;
-
-    /** Options to overwrite the default no button configuration. */
-    no?: InexactPartial<Button<NoReturn>> | null | undefined;
-  }
-
-  interface PromptConfig<OKReturn> extends WaitOptions {
-    /** Options to overwrite the default confirmation button configuration. */
-    ok?: InexactPartial<Button<OKReturn>> | null | undefined;
-  }
-
-  type Type = "prompt" | "confirm" | "wait";
-
-  /**
-   * @remarks Query gets passed through a socket which means it can't take a callback function on its buttons
-   */
-  type QueryConfig<T extends Type> = Omit<
-    | (T extends "wait" ? WaitOptions : never)
-    | (T extends "prompt" ? PromptConfig<never> : never)
-    | (T extends "confirm" ? ConfirmConfig<never, never> : never),
-    "buttons"
-  > & {
-    /**
-     * Button configuration.
-     */
-    buttons?: NoCallbackButton[];
-  };
-
-  type WaitReturn<Options extends WaitOptions> = Internal.ButtonReturnType<Options> | Internal.DismissType<Options>;
-
-  type ConfirmReturn<Options extends ConfirmConfig<unknown, unknown>> =
-    | Internal.ConfirmReturnType<Options>
-    | WaitReturn<Options>;
-
-  type PromptReturn<Options extends PromptConfig<unknown>> = Internal.PromptReturnType<Options> | WaitReturn<Options>;
-
-  type QueryReturn<T extends Type, Options extends QueryConfig<T>> =
-    | (T extends "confirm" ? boolean : string)
-    | DialogV2.Internal.DismissType<Options>;
-
-  namespace Internal {
-    type DismissType<Options extends { rejectClose?: boolean | null | undefined }> = Options["rejectClose"] extends true
-      ? never
-      : null;
-
-    type ButtonReturnType<Options extends { buttons?: Button<unknown>[] }> =
-      // Two cases - one for where all buttons have a defined callback, the other where they don't
-      Options["buttons"] extends ReadonlyArray<{ callback: ButtonCallback<infer Callback> }>
-        ? Callback extends undefined
-          ? string
-          : Callback
-        : Options["buttons"] extends ReadonlyArray<Button<infer Callback>>
-          ? Callback | string
-          : never;
-
-    type ConfirmReturnType<Options extends ConfirmConfig<unknown, unknown>> =
-      | (Options extends { yes: { readonly callback: ButtonCallback<infer YesReturn> } }
-          ? NullishCoalesce<YesReturn, true>
-          : true)
-      | (Options extends { no: { readonly callback: ButtonCallback<infer NoReturn> } }
-          ? NullishCoalesce<NoReturn, false>
-          : false);
-
-    type PromptReturnType<Options extends PromptConfig<unknown>> = Options extends {
-      ok: {
-        readonly callback: ButtonCallback<infer OKReturn>;
-      };
-    }
-      ? NullishCoalesce<OKReturn, string>
-      : string;
-  }
-}
-
-export default DialogV2;

package/src/foundry/client-esm/applications/api/document-sheet.d.mts

@@ -1,193 +0,0 @@
-import type { DeepPartial, Identity, IntentionalPartial } from "fvtt-types/utils";
-import type ApplicationV2 from "./application.d.mts";
-
-import Document = foundry.abstract.Document;
-
-declare namespace DocumentSheetV2 {
-  interface Any extends AnyDocumentSheetV2 {}
-  interface AnyConstructor extends Identity<typeof AnyDocumentSheetV2> {}
-
-  interface RenderContext<ConcreteDocument extends Document.Any = Document.Any> extends ApplicationV2.RenderContext {
-    document: ConcreteDocument;
-    source: ConcreteDocument["_source"];
-    fields: ConcreteDocument["schema"]["fields"];
-    editable: boolean;
-    rootId: string;
-  }
-
-  interface Configuration<ConcreteDocument extends Document.Any> extends ApplicationV2.Configuration, _Configuration {
-    /**
-     * The Document instance associated with this sheet
-     */
-    document: ConcreteDocument;
-  }
-
-  /** @internal */
-  interface _Configuration {
-    /**
-     * A permission level in CONST.DOCUMENT_OWNERSHIP_LEVELS
-     */
-    viewPermission: typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
-
-    /**
-     * A permission level in CONST.DOCUMENT_OWNERSHIP_LEVELS
-     */
-    editPermission: typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS;
-
-    /**
-     * Can this sheet class be used to create a new Document?
-     */
-    canCreate: boolean;
-
-    /**
-     * Allow sheet configuration as a header button
-     */
-    sheetConfig: boolean;
-  }
-
-  // Note(LukeAbby): This `& object` is so that the `DEFAULT_OPTIONS` can be overridden more easily
-  // Without it then `static override DEFAULT_OPTIONS = { unrelatedProp: 123 }` would error.
-  interface DefaultOptions extends IntentionalPartial<_Configuration>, Identity<object> {
-    /**
-     * @deprecated Setting `document` in `DocumentSheetV2.DEFAULT_OPTIONS` is not supported. If you
-     * have a need for this, please file an issue.
-     */
-    document?: never;
-  }
-
-  interface RenderOptions extends ApplicationV2.RenderOptions {
-    /** A string with the format "\{operation\}\{documentName\}" providing context */
-    renderContext: string;
-
-    /** Data describing the document modification that occurred */
-    renderData: object;
-  }
-
-  interface SubmitOptions {
-    /** Additional data passed in if this form is submitted manually which should be merged with prepared formData. */
-    updateData: object;
-  }
-}
-
-/**
- * The Application class is responsible for rendering an HTMLElement into the Foundry Virtual Tabletop user interface.
- */
-declare class DocumentSheetV2<
-  Document extends Document.Any,
-  RenderContext extends object = DocumentSheetV2.RenderContext<Document>,
-  Configuration extends DocumentSheetV2.Configuration<Document> = DocumentSheetV2.Configuration<Document>,
-  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
-> extends ApplicationV2<RenderContext, Configuration, RenderOptions> {
-  constructor(options?: DeepPartial<Configuration>);
-
-  static DEFAULT_OPTIONS: DocumentSheetV2.DefaultOptions;
-
-  get document(): Document;
-
-  override get title(): string;
-
-  /**
-   * Is this Document sheet visible to the current User?
-   * This is governed by the viewPermission threshold configured for the class.
-   */
-  get isVisible(): boolean;
-
-  /**
-   * Is this Document sheet editable by the current User?
-   * This is governed by the editPermission threshold configured for the class.
-   */
-  get isEditable(): boolean;
-
-  protected _initializeApplicationOptions(options: DeepPartial<Configuration>): Configuration;
-
-  protected override _headerControlsButtons(): Generator<ApplicationV2.HeaderControlsEntry>;
-
-  protected override _configureRenderOptions(options: DeepPartial<RenderOptions>): void;
-
-  protected override _prepareContext(
-    options: DeepPartial<RenderOptions> & { isFirstRender: boolean },
-  ): Promise<RenderContext>;
-
-  protected override _renderFrame(options: DeepPartial<RenderOptions>): Promise<HTMLElement>;
-
-  /**
-   * Disable or reenable all form fields in this application
-   * @param disabled - Should the fields be disabled?
-   */
-  protected _toggleDisabled(disabled: boolean): void;
-
-  protected override _canRender(options: DeepPartial<RenderOptions>): false | void;
-
-  protected override _onFirstRender(
-    context: DeepPartial<RenderContext>,
-    options: DeepPartial<RenderOptions>,
-  ): Promise<void>;
-
-  protected override _onRender(context: DeepPartial<RenderContext>, options: DeepPartial<RenderOptions>): Promise<void>;
-
-  protected override _onClose(options: DeepPartial<RenderOptions>): void;
-
-  protected override _onChangeForm(formConfig: ApplicationV2.FormConfiguration, event: Event): void;
-
-  /**
-   * Handle toggling the revealed state of a secret embedded in some content.
-   */
-  protected _onRevealSecret(event: Event): void;
-
-  /**
-   * Prepare data used to update the Item upon form submission.
-   * This data is cleaned and validated before being returned for further processing.
-   * @param event      - The originating form submission event
-   * @param form       - The form element that was submitted
-   * @param formData   - Processed data for the submitted form
-   * @param updateData - Additional data passed in if this form is submitted manually which should be merged with prepared formData
-   * @returns Prepared submission data as an object
-   * @throws Subclasses may throw validation errors here to prevent form submission
-   * @privateRemarks TODO: Improve typing for updateData & return
-   */
-  protected _prepareSubmitData(
-    event: SubmitEvent,
-    form: HTMLFormElement,
-    formData: FormDataExtended,
-    updateData?: unknown,
-  ): object;
-
-  /**
-   * Customize how form data is extracted into an expanded object.
-   * @param event    - The originating form submission event
-   * @param form     - The form element that was submitted
-   * @param formData - Processed data for the submitted form
-   * @returns An expanded object of processed form data
-   * @throws Subclasses may throw validation errors here to prevent form submission
-   */
-  protected _processFormData(event: SubmitEvent | null, form: HTMLFormElement, formData: FormDataExtended): object;
-
-  /**
-   * Submit a document update or creation request based on the processed form data.
-   * @param event    - The originating form submission event
-   * @param form     - The form element that was submitted
-   * @param formData - Processed and validated form data to be used for a document update
-   * @param options  - Additional options altering the request
-   * @privateRemarks TODO: Improve options to capture the Create and/or Update options available to the Document
-   */
-  protected _processSubmitData(
-    event: SubmitEvent,
-    form: HTMLFormElement,
-    formData: FormDataExtended,
-    options?: unknown,
-  ): Promise<void>;
-
-  /**
-   * Provide a deprecation path for converted V1 document sheets.
-   * @param first - The first parameter received by this class's constructor
-   * @param rest  - Any additional parameters received
-   * @privateRemarks - This *is* possible to type more precisely but the reward/benefit is pretty minor
-   */
-  static _migrateConstructorParams(first: unknown, rest: unknown[]): DocumentSheetV2.Configuration<Document.Any>;
-}
-
-export default DocumentSheetV2;
-
-declare abstract class AnyDocumentSheetV2 extends DocumentSheetV2<any, any, any, any> {
-  constructor(...args: never);
-}