@league-of-foundry-developers/foundry-vtt-types 0.8.9-8 → 9.242.0

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

@@ -0,0 +1,257 @@
+/**
+ * Allows for viewing and editing of Keybinding Actions
+ */
+declare class KeybindingsConfig<
+  Options extends FormApplication.Options = FormApplication.Options,
+  Data extends KeybindingsConfig.Data = KeybindingsConfig.Data
+> extends FormApplication<Options, Data> {
+  /**
+   * A cached copy of the Categories
+   */
+  protected _cachedData: KeybindingsConfig.CategoryData | null;
+
+  /**
+   * The category being filtered for
+   */
+  protected _category: string;
+
+  /**
+   * A Map of pending Edits. The Keys are bindingIds
+   * @internal
+   */
+  protected _pendingEdits: Map<string, KeybindingsConfig.PendingBinding[]>;
+
+  /**
+   * @override
+   * @defaultValue
+   * ```typescript
+   * foundry.utils.mergeObject(super.defaultOptions, {
+   *   title: game.i18n.localize("SETTINGS.Keybindings"),
+   *   id: "keybindings",
+   *   template: "templates/sidebar/apps/keybindings-config.html",
+   *   width: 750,
+   *   height: 600,
+   *   resizable: true,
+   *   scrollY: [".filters", ".category-list"],
+   *   filters: [{inputSelector: 'input[name="filter"]', contentSelector: ".category-list"}]
+   * })
+   * ```
+   */
+  static get defaultOptions(): FormApplication.Options;
+
+  /**
+   * @param options - (unused)
+   * @override
+   */
+  getData(options?: Partial<Options>): Data;
+
+  /**
+   * Builds the set of Bindings into a form usable for display and configuration
+   * @internal
+   */
+  protected _getCategoryData(): KeybindingsConfig.CategoryData;
+
+  /**
+   * Add faux-keybind actions that represent the possible Mouse Controls
+   * @param categories - The current Map of Categories to add to
+   * @returns The number of Actions added
+   * @internal
+   */
+  protected _addMouseControlsReference(categories: Map<string, KeybindingsConfig.Category>): number;
+
+  /**
+   * Given an Binding and its parent Action, detects other Actions that might conflict with that binding
+   * @param actionId - The namespaced Action ID the Binding belongs to
+   * @param action   - The Action config
+   * @param binding  - The Binding
+   * @internal
+   */
+  protected _detectConflictingActions(
+    actionId: string,
+    action: KeybindingActionConfig,
+    binding: KeybindingActionBinding
+  ): KeybindingAction[];
+
+  /**
+   * Transforms a Binding into a human readable string representation
+   * @param binding - The Binding
+   * @returns A human readable string
+   * @internal
+   */
+  protected static _humanizeBinding(binding: KeybindingActionBinding): string;
+
+  /**
+   * Compares two Category Filters for rendering
+   * This method ignores cases of equality because we know our categories are unique
+   * @param a - The first Category
+   * @param b - The second Category
+   * @returns A number for usage in the Sort method
+   * @internal
+   */
+  protected static _sortCategories(a: KeybindingsConfig.Category, b: KeybindingsConfig.Category): number;
+
+  /**
+   * Classify what Category an Action belongs to
+   * @param action - The Action to classify
+   * @returns The category the Action belongs to
+   * @internal
+   */
+  protected _categorizeAction(action: KeybindingsConfig): KeybindingsConfig.BaseCategory;
+
+  /** @override */
+  activateListeners(html: JQuery): void;
+
+  /**
+   * Handle left-click events to filter to a certain category
+   * @internal
+   */
+  protected _onClickCategoryFilter(event: MouseEvent): void;
+
+  /**
+   * Handle left-click events to show / hide a certain category
+   * @internal
+   */
+  protected _onClickCategoryCollapse(event: MouseEvent): void;
+
+  /**
+   * Handle left-click events to reset all Actions to Default
+   * @internal
+   */
+  protected _onClickResetActions(event: MouseEvent): Promise<void>;
+
+  /**
+   * Handle Control clicks
+   * @internal
+   */
+  protected _onClickBindingControl(event: MouseEvent): void;
+
+  /**
+   * Handle left-click events to show / hide a certain category
+   * @internal
+   */
+  protected _onClickAdd(event: MouseEvent): Promise<void>;
+
+  /**
+   * Handle left-click events to show / hide a certain category
+   * @internal
+   */
+  protected _onClickDelete(event: MouseEvent): Promise<void>;
+
+  /**
+   * Inserts a Binding into the Pending Edits object, creating a new Map entry as needed
+   * @internal
+   */
+  protected _addPendingEdit(
+    namespace: string,
+    action: string,
+    bindingIndex: number,
+    binding: KeybindingsConfig.PendingBinding
+  ): void;
+
+  /**
+   * Toggle visibility of the Edit / Save UI
+   * @internal
+   */
+  protected _onClickEditableBinding(event: MouseEvent): void;
+
+  /**
+   * Toggle visibility of the Edit UI
+   * @internal
+   */
+  protected _onDoubleClickKey(event: MouseEvent): void;
+
+  /**
+   * Save the new Binding value and update the display of the UI
+   * @internal
+   */
+  protected _onClickSaveBinding(event: MouseEvent): Promise<void>;
+
+  /**
+   * Given a clicked Action element, finds the parent Action
+   * @internal
+   */
+  protected _getParentAction(event: KeyboardEvent | MouseEvent): {
+    namespace: string;
+    action: string;
+    actionHtml: HTMLElement;
+  };
+
+  /**
+   * Given a Clicked binding control element, finds the parent Binding
+   * @internal
+   */
+  protected _getParentBinding(event: KeyboardEvent | MouseEvent): { bindingHtml: HTMLElement; bindingId: string };
+
+  /**
+   * Iterates over all Pending edits, merging them in with unedited Bindings and then saving and resetting the UI
+   * @internal
+   */
+  protected _savePendingEdits(): Promise<void>;
+
+  /**
+   * Processes input from the keyboard to form a list of pending Binding edits
+   * @param event - The keyboard event
+   * @internal
+   */
+  protected _onKeydownBindingInput(event: KeyboardEvent): void;
+
+  /**
+   * @param event - (unused)
+   * @override
+   */
+  protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+
+  /** @remarks KeybindingsConfig does not implement this method. */
+  protected _updateObject(event?: unknown, formData?: unknown): Promise<never>;
+}
+
+declare namespace KeybindingsConfig {
+  interface Data extends CategoryData {
+    categories: DataCategory[];
+    allActive: boolean;
+  }
+
+  interface DataCategory extends Category {
+    active: boolean;
+    hidden: boolean;
+  }
+
+  interface CategoryData {
+    categories: Category[];
+    totalActions: number;
+  }
+
+  interface BaseCategory {
+    id: string;
+    title: string;
+  }
+
+  interface Category extends BaseCategory {
+    actions: ActionData[];
+    count: number;
+  }
+
+  interface ActionData extends KeybindingActionConfig {
+    category: string;
+    bindings: DisplayBinding[];
+    id: string;
+    name: string;
+    hint?: string;
+    cssClass?: string;
+    notes: string;
+  }
+
+  interface DisplayBinding extends Partial<KeybindingActionBinding> {
+    id: string;
+    display: string;
+    cssClasses: string;
+    isEditable: boolean;
+    isFirst: boolean;
+    conflicts: string;
+    hasConflicts: boolean;
+  }
+
+  interface PendingBinding extends KeybindingActionBinding {
+    index: number;
+  }
+}

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

@@ -1,4 +1,5 @@
-import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../types/helperTypes';
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
+import type { TokenDataConstructorData } from '../../../common/data/data.mjs/tokenData.js';
 
 declare global {
   /**
@@ -70,9 +71,7 @@ declare global {
     activateListeners(html: JQuery): void;
 
     /** @override */
-    protected _getSubmitData(
-      updateData?: ConstructorDataType<foundry.data.TokenData>
-    ): Record<string, unknown> & { lightAlpha: number };
+    protected _getSubmitData(updateData?: TokenDataConstructorData): Record<string, unknown> & { lightAlpha: number };
 
     /** @override */
     protected _updateObject(
@@ -115,9 +114,9 @@ declare global {
       barAttributes: Record<string, string[]>;
       bar1: ReturnType<TokenDocument['getBarAttribute']>;
       bar2: ReturnType<TokenDocument['getBarAttribute']>;
-      displayModes: Record<foundry.CONST.TokenDisplayMode, string>;
+      displayModes: Record<foundry.CONST.TOKEN_DISPLAY_MODES, string>;
       actors: { _id: string; name: string }[];
-      dispositions: Record<foundry.CONST.TokenDisposition, string>;
+      dispositions: Record<foundry.CONST.TOKEN_DISPOSITIONS, string>;
       lightAnimations: { [Key in keyof typeof CONFIG.Canvas.lightAnimations]: string } & { '': string };
       lightAlpha: number;
       isGM: boolean;
@@ -134,9 +133,9 @@ declare global {
       brightSight: number | null;
       dimLight: number | null;
       dimSight: number | null;
-      displayBars: foundry.CONST.TokenDisplayMode;
-      displayName: foundry.CONST.TokenDisplayMode;
-      disposition: foundry.CONST.TokenDisposition;
+      displayBars: foundry.CONST.TOKEN_DISPLAY_MODES;
+      displayName: foundry.CONST.TOKEN_DISPLAY_MODES;
+      disposition: foundry.CONST.TOKEN_DISPOSITIONS;
       elevation: number | null;
       height: number | null;
       img: string;

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

@@ -61,12 +61,12 @@ declare global {
     }
 
     interface FormData {
-      dir: foundry.CONST.WallDirection;
-      door: foundry.CONST.WallDoorType;
-      ds?: foundry.CONST.WallDoorState;
-      move: foundry.CONST.WallMovementType;
-      sense: foundry.CONST.WallSenseType;
-      sound: foundry.CONST.WallSenseType;
+      dir: foundry.CONST.WALL_DIRECTIONS;
+      door: foundry.CONST.WALL_DOOR_TYPES;
+      ds?: foundry.CONST.WALL_DOOR_STATES;
+      move: foundry.CONST.WALL_MOVEMENT_TYPES;
+      sense: foundry.CONST.WALL_SENSE_TYPES;
+      sound: foundry.CONST.WALL_SENSE_TYPES;
     }
   }
 }

package/src/foundry/foundry.js/applications/sidebarTab.d.ts

@@ -8,7 +8,7 @@ declare abstract class SidebarTab<
   constructor(...args: ConstructorParameters<typeof Application>);
   /**
    * The base name of this sidebar tab
-   * @defaultValue `''`
+   * @defaultValue `""`
    */
   tabName: string;
 

package/src/foundry/foundry.js/applications/sidebarTabs/chatLog.d.ts

@@ -1,4 +1,5 @@
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
+import type { ChatMessageDataConstructorData } from '../../../common/data/data.mjs/chatMessageData.js';
 
 declare global {
   /**
@@ -162,7 +163,7 @@ declare global {
     protected _processDiceCommand(
       command: string,
       match: RegExpMatchArray,
-      chatData: ConstructorDataType<foundry.data.ChatMessageData>,
+      chatData: ChatMessageDataConstructorData,
       createOptions: DocumentModificationContext
     ): void;
 
@@ -178,7 +179,7 @@ declare global {
     protected _processWhisperCommand(
       command: string,
       match: RegExpMatchArray,
-      chatData: ConstructorDataType<foundry.data.ChatMessageData>,
+      chatData: ChatMessageDataConstructorData,
       createOptions: DocumentModificationContext
     ): void;
 
@@ -193,7 +194,7 @@ declare global {
     protected _processChatCommand(
       command: string,
       match: RegExpMatchArray,
-      chatData: ConstructorDataType<foundry.data.ChatMessageData>,
+      chatData: ChatMessageDataConstructorData,
       createOptions: DocumentModificationContext
     ): void;
 
@@ -275,7 +276,7 @@ declare global {
      * @param mode - The new roll mode setting
      * @internal
      */
-    protected static _setRollMode(mode: foundry.CONST.DiceRollMode): void;
+    protected static _setRollMode(mode: keyof CONFIG.Dice.RollModes): void;
   }
 
   namespace ChatLog {
@@ -296,7 +297,7 @@ declare global {
 
     interface Data {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      rollMode: foundry.CONST.DiceRollMode;
+      rollMode: keyof CONFIG.Dice.RollModes;
       rollModes: typeof CONFIG['Dice']['rollModes'];
       isStream: boolean;
     }

package/src/foundry/foundry.js/applications/sidebarTabs/compendiumDirectory.d.ts

@@ -60,10 +60,10 @@ declare global {
   namespace CompendiumDirectory {
     interface Data {
       user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      packs: { [DocumentName in foundry.CONST.CompendiumEntityType]?: PackData<DocumentName> };
+      packs: { [DocumentName in foundry.CONST.COMPENDIUM_DOCUMENT_TYPES]?: PackData<DocumentName> };
     }
 
-    interface PackData<DocumentName extends foundry.CONST.CompendiumEntityType> {
+    interface PackData<DocumentName extends foundry.CONST.COMPENDIUM_DOCUMENT_TYPES> {
       label: DocumentName;
       packs: CompendiumCollection<CompendiumCollection.Metadata & { entity: DocumentName }>[];
     }

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/cardsDirectory.d.ts

@@ -0,0 +1,7 @@
+/**
+ * The sidebar directory which organizes and displays world-level Cards documents.
+ */
+declare class CardsDirectory extends SidebarDirectory<'Cards'> {
+  /** @override */
+  static documentName: 'Cards';
+}

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/index.d.ts

@@ -1,4 +1,5 @@
 import './actorDirectory';
+import './cardsDirectory';
 import './itemDirectory';
 import './journalDirectory';
 import './macroDirectory';

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectories/playlistDirectory.d.ts

@@ -114,13 +114,13 @@ declare global {
      * Given a constant playback mode, provide the FontAwesome icon used to display it
      * @internal
      */
-    protected _getModeIcon(mode: foundry.CONST.PlaylistMode): string;
+    protected _getModeIcon(mode: foundry.CONST.PLAYLIST_MODES): string;
 
     /**
      * Given a constant playback mode, provide the string tooltip used to describe it
      * @internal
      */
-    protected _getModeTooltip(mode: foundry.CONST.PlaylistMode): string;
+    protected _getModeTooltip(mode: foundry.CONST.PLAYLIST_MODES): string;
 
     /** @override */
     activateListeners(html: JQuery): void;

package/src/foundry/foundry.js/applications/sidebarTabs/sidebarDirectory.d.ts

@@ -8,7 +8,7 @@ declare global {
    * @typeParam Options - The type of the options object
    */
   abstract class SidebarDirectory<
-    Name extends foundry.CONST.EntityType | 'FogExploration',
+    Name extends foundry.CONST.DOCUMENT_TYPES | 'FogExploration',
     Options extends SidebarDirectory.Options = SidebarDirectory.Options
   > extends SidebarTab<Options> {
     constructor(options?: Partial<SidebarDirectory.Options>);
@@ -54,7 +54,7 @@ declare global {
      * The WorldCollection instance which this Sidebar Directory displays.
      */
     static get collection(): WorldCollection<
-      ConfiguredDocumentClassForName<foundry.CONST.EntityType | 'FogExploration'>,
+      ConfiguredDocumentClassForName<foundry.CONST.DOCUMENT_TYPES | 'FogExploration'>,
       string
     >;
 

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

@@ -2,7 +2,6 @@
  * An AudioSourceNode container which handles the strategy of node type to use for playback.
  * Used by the Sound interface which controls playback.
  * This class is for internal use only and should not be used by external callers.
- * @internal
  */
 declare class AudioContainer {
   constructor(src: string);
@@ -31,16 +30,11 @@ declare class AudioContainer {
   isBuffer: boolean;
 
   /**
-   * Has the source for this audio container been loaded to a point that playback can begin?
-   * @defaultValue `false`
-   */
-  loaded: boolean;
-
-  /**
-   * Did the audio source fail to load (a 404 or some other reason).
-   * @defaultValue `false`
+   * Whether we have attempted to load the audio node or not, and whether it failed.
+   * @see {@link LOAD_STATES}
+   * @defaultValue `AudioContainer.LOAD_STATES.NONE`
    */
-  failed: boolean;
+  loadState: AudioContainer.LOAD_STATES;
 
   /**
    * Is the audio source currently playing?
@@ -65,6 +59,26 @@ declare class AudioContainer {
    */
   static MAX_BUFFER_DURATION: number;
 
+  /**
+   * The sequence of container loading states.
+   */
+  static LOAD_STATES: {
+    FAILED: -1;
+    NONE: 0;
+    LOADING: 1;
+    LOADED: 2;
+  };
+
+  /**
+   * Has the audio file been loaded either fully or for streaming.
+   */
+  get loaded(): boolean;
+
+  /**
+   * Did the audio file fail to load.
+   */
+  get failed(): boolean;
+
   /**
    * A reference to the AudioBuffer if the sourceNode is a AudioBufferSourceNode.
    */
@@ -155,3 +169,7 @@ declare class AudioContainer {
    */
   protected _unloadMediaNode(): void;
 }
+
+declare namespace AudioContainer {
+  type LOAD_STATES = ValueOf<typeof AudioContainer['LOAD_STATES']>;
+}

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

@@ -116,22 +116,22 @@ declare class AVSettings {
       type: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       url: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       room: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       username: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       password: string;
     };
@@ -143,17 +143,17 @@ declare class AVSettings {
       type: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       url: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       username: string;
 
       /**
-       * @defaultValue `''`
+       * @defaultValue `""`
        */
       password: string;
     };