@league-of-foundry-developers/foundry-vtt-types 0.8.9-7 → 9.238.1

package/src/foundry/foundry.js/rollTerms/stringTerm.d.ts

@@ -16,7 +16,10 @@ declare global {
 
     get total(): string;
 
-    evaluate(options?: Partial<RollTerm.EvaluationOptions>): never;
+    /** @override */
+    get isDeterministic(): boolean;
+
+    evaluate(options?: InexactPartial<RollTerm.EvaluationOptions>): never;
   }
 }
 

package/src/foundry/foundry.js/searchFilter.d.ts

@@ -84,7 +84,7 @@ declare namespace SearchFilter {
 
     /**
      * The initial value of the search query.
-     * @defaultValue `''`
+     * @defaultValue `""`
      */
     initial?: SearchFilter['query'];
 

package/src/foundry/foundry.js/textEditor.d.ts

@@ -6,7 +6,7 @@ declare class TextEditor {
    * Create a Rich Text Editor. The current implementation uses TinyMCE
    * @param options - Configuration options provided to the Editor init
    * @param content - Initial HTML or text content to populate the editor with
-   *                  (default: `''`)
+   *                  (default: `""`)
    * @returns The editor instance.
    */
   static create(options: TextEditor.Options, content: string): Promise<tinyMCE.Editor>;
@@ -34,7 +34,22 @@ declare class TextEditor {
    *                  (default: `250`)
    * @returns The previewed HTML
    */
-  static previewHTML(content: string, length: number): string;
+  static previewHTML(content: string, length?: number): string;
+
+  /**
+   * Truncate an HTML fragment to a maximum number of text content characters, removing any unused elements.
+   * @param html       - The root HTML element.
+   * @param maxLength  - The maximum allowed length of the text content.
+   *                     (default: `50`)
+   * @param splitWords - Whether to truncate by splitting on white space (if true) or breaking words.
+   *                     (default: `true`)
+   * @param suffix     - A suffix string to append to denote that the text was truncated.
+   *                     (default: `'…'`)
+   */
+  static truncateHTML(
+    html: HTMLElement,
+    { maxLength, splitWords, suffix }: { maxLength?: number; splitWords?: boolean; suffix?: string }
+  ): HTMLElement;
 
   /**
    * Truncate a fragment of text to a maximum number of characters.
@@ -55,11 +70,13 @@ declare class TextEditor {
    * Recursively identify the text nodes within a parent HTML node for potential content replacement.
    * @param parent - The parent HTML Element
    * @returns An array of contained Text nodes
+   * @internal
    */
   protected static _getTextNodes(parent: HTMLElement): Text[];
 
   /**
    * Facilitate the replacement of text node content using a matching regex rule and a provided replacement function.
+   * @internal
    */
   protected static _replaceTextContent(
     text: Text[],
@@ -69,6 +86,7 @@ declare class TextEditor {
 
   /**
    * Replace a matched portion of a Text node with a replacement Node
+   * @internal
    */
   protected static _replaceTextNode(text: Text, match: RegExpMatchArray, replacement: Node): void;
 
@@ -79,13 +97,15 @@ declare class TextEditor {
    * @param target - The requested match target (_id or name)
    * @param name   - A customized or over-ridden display name for the link
    * @returns An HTML element for the entity link
+   * @internal
    */
-  protected static _createEntityLink(match: string, type: string, target: string, name: string): HTMLAnchorElement;
+  protected static _createContentLink(match: string, type: string, target: string, name: string): HTMLAnchorElement;
 
   /**
    * Replace a hyperlink-like string with an actual HTML <a> tag
    * @param match - The full matched string
    * @returns An HTML element for the entity link
+   * @internal
    */
   protected static _createHyperlink(match: string): HTMLAnchorElement;
 
@@ -95,47 +115,58 @@ declare class TextEditor {
    * @param command - An optional command
    * @param formula - The matched formula
    * @param closing - The closing brackets for the inline roll
+   * @param label   - An optional label which configures the button text
    * @returns The replaced match
+   * @internal
    */
   protected static _createInlineRoll(
     match: string,
     command: string,
     formula: string,
     closing: string,
+    label?: string,
     ...args: object[]
-  ): string;
+  ): HTMLAnchorElement | null;
 
   static activateListeners(): void;
 
   /**
    * Handle click events on Entity Links
+   * @internal
    */
-  protected static _onClickEntityLink(event: Event): Promise<void>;
+  protected static _onClickContentLink(event: JQuery.ClickEvent): void;
 
   /**
    * Handle left-mouse clicks on an inline roll, dispatching the formula or displaying the tooltip
    * @param event - The initiating click event
+   * @internal
    */
-  protected static _onClickInlineRoll(event: MouseEvent): Promise<void | Promise<void> | Promise<ChatMessage> | object>;
+  protected static _onClickInlineRoll(event: JQuery.ClickEvent): void;
 
   /**
    * Begin a Drag+Drop workflow for a dynamic content link
    * @param event - The originating drag event
+   * @internal
    */
-  protected static _onDragEntityLink(event: Event): void;
+  protected static _onDragEntityLink(event: JQuery.DragStartEvent): void;
 
   /**
    * Begin a a data transfer drag event with default handling
+   * @internal
    */
-  protected _onDragStart(event: Event): void;
+  protected _onDragStart(event: DragEvent): void;
 
   /**
    * Handle dropping of transferred data onto the active rich text editor
    * @param event  - The originating drop event which triggered the data transfer
    * @param editor - The TinyMCE editor instance being dropped on
    */
-  protected static _onDropEditorData(event: Event, editor: tinyMCE.Editor): Promise<void>;
+  protected static _onDropEditorData(event: DragEvent, editor: tinyMCE.Editor): void;
 
+  /**
+   * Singleton decoder area
+   * @internal
+   */
   protected static _decoder: HTMLTextAreaElement;
 }
 

package/src/foundry/index.d.ts

@@ -11,8 +11,10 @@ import './foundry.js/canvas';
 import './foundry.js/canvasAnimation';
 import './foundry.js/canvasDocumentMixin';
 import './foundry.js/chatBubbles';
+import './foundry.js/clientDatabaseBackend';
 import './foundry.js/clientDocuments';
 import './foundry.js/clientDocumentMixin';
+import './foundry.js/clientKeybindings';
 import './foundry.js/clientSettings';
 import './foundry.js/config';
 import './foundry.js/constants';
@@ -23,6 +25,7 @@ import './foundry.js/features';
 import './foundry.js/fonts';
 import './foundry.js/formDataExtended';
 import './foundry.js/game';
+import './foundry.js/gamepadManager';
 import './foundry.js/gameTime';
 import './foundry.js/globalVariables';
 import './foundry.js/handlebarsHelpers';
@@ -32,6 +35,8 @@ import './foundry.js/keyboardManager';
 import './foundry.js/localization';
 import './foundry.js/mersenneTwister';
 import './foundry.js/mouseInteractionManager';
+import './foundry.js/mouseManager';
+import './foundry.js/newUserExperience';
 import './foundry.js/perceptionManager';
 import './foundry.js/pointSource';
 import './foundry.js/quadtree';

package/src/types/utils.d.ts

@@ -2,10 +2,18 @@
  * Recursively sets keys of an object to optional. Used primarily for update methods
  * @internal
  */
-declare type DeepPartial<T> = {
+type DeepPartial<T> = {
   [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
 };
 
+/**
+ * Make all properties in T optional and explicitly allow `undefined`
+ * @internal
+ */
+type InexactPartial<T> = {
+  [P in keyof T]?: T[P] | undefined;
+};
+
 /**
  * References the constructor of type `T`
  * @internal
@@ -75,7 +83,7 @@ type Expanded<O> = O extends Record<string, unknown>
  * Union type of the types of the values in `T`
  * @internal
  */
-type ValueOf<T> = T extends Array<unknown> ? T[number] : T[keyof T];
+type ValueOf<T> = T extends Array<unknown> | ReadonlyArray<unknown> ? T[number] : T[keyof T];
 
 /**
  * Transforms a string to lowercase and the first character to uppercase.
@@ -96,7 +104,7 @@ type Titlecase<S extends string> = S extends `${infer A} ${infer B}`
  * @typeParam U - The type that will be merged into `T`.
  */
 type Merge<T, U> = T extends object
-  ? U extends Array<any>
+  ? U extends Array<any> | ReadonlyArray<any>
     ? U
     : U extends object
     ? {

package/src/foundry/foundry.js/applications/formApplications/measuredTemplateConfig.d.ts

@@ -1,61 +0,0 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * A configuration Form Application for modifying the properties of a MeasuredTemplate object.
- * @see {@link MeasuredTemplate}
- */
-declare class MeasuredTemplateConfig extends FormApplication<
-  FormApplication.Options,
-  MeasuredTemplateConfig.Data,
-  MeasuredTemplate
-> {
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   id: "template-config",
-   *   classes: ["sheet", "template-sheet"],
-   *   title: "Measurement Template Configuration",
-   *   template: "templates/scene/template-config.html",
-   *   width: 400
-   * });
-   * ```
-   */
-  static get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-  /**
-   * @override
-   */
-  getData(): MeasuredTemplateConfig.Data;
-
-  /**
-   * @override
-   */
-  protected _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<MeasuredTemplate | null>;
-}
-
-declare namespace MeasuredTemplateConfig {
-  interface Data {
-    object: foundry.utils.Duplicated<MeasuredTemplateConfig['object']['data']>;
-    options: MeasuredTemplateConfig['options'];
-    templateTypes: typeof CONFIG['MeasuredTemplate']['types'];
-    gridUnits: Scene['data']['gridUnits'];
-    submitText: string;
-  }
-
-  type FormData = {
-    angle: MeasuredTemplate.Data['angle'];
-    borderColor: MeasuredTemplate.Data['borderColor'];
-    direction: MeasuredTemplate.Data['direction'] | null;
-    distance: MeasuredTemplate.Data['distance'] | null;
-    fillColor: MeasuredTemplate.Data['fillColor'];
-    t: MeasuredTemplate.Data['t'];
-    texture: MeasuredTemplate.Data['texture'];
-    width: MeasuredTemplate.Data['width'];
-    x: MeasuredTemplate.Data['x'] | null;
-    y: MeasuredTemplate.Data['y'] | null;
-  };
-}

package/src/foundry/foundry.js/applications/formApplications/noteConfig.d.ts

@@ -1,77 +0,0 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * Placeable Note configuration sheet
- * @typeParam P - the type of the options object
- */
-declare class NoteConfig<P extends FormApplication.Options = FormApplication.Options> extends FormApplication<
-  P,
-  NoteConfig.Data,
-  Note
-> {
-  /**
-   * @param note    - The Note object for which settings are being configured
-   * @param options - Additional Application options
-   */
-  constructor(note: Note, options?: Partial<P>);
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   id: "note-config",
-   *   title: game.i18n.localize("NOTE.ConfigTitle"),
-   *   template: "templates/scene/note-config.html",
-   *   width: 400
-   * });
-   * ```
-   */
-  static get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<P>): NoteConfig.Data;
-
-  /**
-   * @param event - (unused)
-   * @override
-   */
-  protected _updateObject(event: Event, formData: NoteConfig.FormData): Promise<Note>;
-
-  /**
-   * @override
-   */
-  close(options?: Application.CloseOptions): Promise<void>;
-}
-
-declare namespace NoteConfig {
-  interface Data {
-    entryIcons: typeof CONFIG.JournalEntry['noteIcons'];
-    entryId: JournalEntry['_id'] | undefined;
-    entryName: JournalEntry['name'] | undefined;
-    entries: Journal['entities'];
-    fontFamilies: Partial<Record<string, string>>;
-    object: foundry.utils.Duplicated<NoteConfig['object']['data']>;
-    options: NoteConfig['options'];
-    textAnchors: Record<foundry.CONST.TextAnchorPoint, string>;
-  }
-
-  interface FormData {
-    entryId: Note.Data['entryId'];
-    fontFamily: Note.Data['fontFamily'];
-    fontSize: Note.Data['fontSize'] | null;
-    icon: Note.Data['icon'];
-    iconSize: Note.Data['iconSize'] | null;
-    iconTint: Note.Data['iconTint'];
-    text: Note.Data['text'];
-    textAnchor: Note.Data['textAnchor'];
-    textColor: Note.Data['textColor'];
-    x: Note.Data['x'] | null;
-    y: Note.Data['y'] | null;
-  }
-}