@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

package/src/foundry/client/apps/sidebar/tabs/chat-log.d.ts

@@ -1,351 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import type { ChatMessageDataConstructorData } from '../../../../common/data/data.mjs/chatMessageData';
-
-declare global {
-  interface ChatLogOptions extends ApplicationOptions {
-    /**
-     * Is this chat log being rendered as part of the stream view?
-     * @defaultValue `false`
-     */
-    stream: boolean;
-  }
-
-  /**
-   * The sidebar directory which organizes and displays world-level ChatMessage documents.
-   * @see {@link Sidebar}
-   */
-  class ChatLog extends SidebarTab<ChatLogOptions> {
-    constructor(options?: Partial<ChatLogOptions>);
-
-    /**
-     * Track any pending text which the user has submitted in the chat log textarea
-     * @internal
-     */
-    protected _pendingText: string;
-
-    /**
-     * Track the history of the past 5 sent messages which can be accessed using the arrow keys
-     * @defaultValue `[]`
-     * @internal
-     */
-    protected _sentMessages: string[];
-
-    /**
-     * Track which remembered message is being currently displayed to cycle properly
-     * @defaultValue `-1`
-     * @internal
-     */
-    protected _sentMessageIndex: number;
-
-    /**
-     * Track the time when the last message was sent to avoid flooding notifications
-     * @defaultValue `0`
-     * @internal
-     */
-    protected _lastMessageTime: number;
-
-    /**
-     * Track the id of the last message displayed in the log
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _lastId: string | null;
-
-    /**
-     * Track the last received message which included the user as a whisper recipient.
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _lastWhisper: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>> | null;
-
-    /**
-     * A reference to the chat text entry bound key method
-     * @defaultValue `null`
-     * @internal
-     */
-    _onChatKeyDownBinding: ((event: JQuery.KeyDownEvent) => void) | null;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "chat",
-     *   template: "templates/sidebar/chat-log.html",
-     *   title: game.i18n.localize("CHAT.Title"),
-     *   stream: false
-     * })
-     * ```
-     */
-    static override get defaultOptions(): ChatLogOptions;
-
-    /**
-     * A reference to the Messages collection that the chat log displays
-     */
-    get collection(): Messages;
-
-    override getData(options?: Partial<ChatLogOptions>): ChatLog.Data;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<ChatLogOptions>): Promise<void>;
-
-    protected override _renderInner(data: ChatLog.Data): Promise<JQuery>;
-
-    /**
-     * Render a batch of additional messages, prepending them to the top of the log
-     * @param html - The rendered jQuery HTML object
-     * @param size - The batch size to include
-     *
-     * @internal
-     */
-    protected _renderBatch(html: JQuery, size: number): Promise<void>;
-
-    /**
-     * Delete a single message from the chat log
-     * @param messageId - The ChatMessage entity to remove from the log
-     * @param deleteAll - Is this part of a flush operation to delete all messages?
-     *                    (default: `false`)
-     */
-    deleteMessage(messageId: string, { deleteAll }?: { deleteAll?: boolean }): void;
-
-    /**
-     * Trigger a notification that alerts the user visually and audibly that a new chat log message has been posted
-     */
-    notify(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>): void;
-
-    /**
-     * Parse a chat string to identify the chat command (if any) which was used
-     * @param message - The message to match
-     * @returns The identified command and regex match
-     * @remarks The returned RegExpMatchArray or string Array has the entire match as its first value, then the match for
-     *          the slash command (or an empty string) and as last element the flavor or message text. The whisper match
-     *          is an exception: Its third value is the target user name (optionally in brackets) and the fourth value is
-     *          the message text.
-     */
-    static parse<S extends string>(message: S): [ChatLog.Command, RegExpMatchArray] | ['none', [S, '', S]];
-
-    /**
-     * Post a single chat message to the log
-     * @param message - A ChatMessage document instance to post to the log
-     * @param notify  - Trigger a notification which shows the log as having a new unread message
-     *                  (default: `false`)
-     * @param options - Additional options for how the message is posted to the log
-     *                  (default: `{}`)
-     * @returns A Promise which resolves once the message is posted
-     */
-    postOne(
-      message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>,
-      notify?: boolean | undefined,
-      options?: ChatLog.PostOneOptions | undefined
-    ): Promise<void>;
-
-    /**
-     * Scroll the chat log to the bottom
-     * @param options - (default: `{}`)
-     */
-    protected scrollBottom(options?: ChatLog.ScrollBottomOptions): void;
-
-    /**
-     * Update the content of a previously posted message after its data has been replaced
-     * @param message - The ChatMessage instance to update
-     * @param notify  - Trigger a notification which shows the log as having a new unread message
-     *                  (default: `false`)
-     */
-    updateMessage(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>, notify?: boolean): void;
-
-    /**
-     * Update the displayed timestamps for every displayed message in the chat log.
-     * Timestamps are displayed in a humanized "timesince" format.
-     */
-    updateTimestamps(): void;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle dropping of transferred data onto the chat editor
-     * @param event - The originating drop event which triggered the data transfer
-     * @internal
-     */
-    protected static _onDropTextAreaData(event: DragEvent): void;
-
-    /**
-     * Prepare the data object of chat message data depending on the type of message being posted
-     * @param message - The original string of the message content
-     * @returns A Promise resolving to the prepared chat data object, or void if we were executing
-     *          a macro instead.
-     */
-    protected processMessage(
-      message: string
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof ChatMessage>> | undefined | void>;
-
-    /**
-     * Process messages which are posted using a dice-roll command
-     * @param command       - The chat command type
-     * @param match         - The matched RegExp expressions
-     * @param chatData      - The initial chat data
-     * @param createOptions - Options used to create the message
-     * @internal
-     */
-    protected _processDiceCommand(
-      command: string,
-      match: RegExpMatchArray,
-      chatData: ChatMessageDataConstructorData,
-      createOptions: DocumentModificationContext
-    ): void;
-
-    /**
-     * Process messages which are posted using a chat whisper command
-     * @param command       - The chat command type
-     * @param match         - The matched RegExp expressions
-     * @param chatData      - The initial chat data
-     * @param createOptions - Options used to create the message
-     * @throws If the user does not have the permission to whisper to other players
-     * @internal
-     */
-    protected _processWhisperCommand(
-      command: string,
-      match: RegExpMatchArray,
-      chatData: ChatMessageDataConstructorData,
-      createOptions: DocumentModificationContext
-    ): void;
-
-    /**
-     * Process messages which are posted using a chat whisper command
-     * @param command       - The chat command type
-     * @param match         - The matched RegExp expressions
-     * @param chatData      - The initial chat data
-     * @param createOptions - Options used to create the message
-     * @internal
-     */
-    protected _processChatCommand(
-      command: string,
-      match: RegExpMatchArray,
-      chatData: ChatMessageDataConstructorData,
-      createOptions: DocumentModificationContext
-    ): void;
-
-    /**
-     * Process messages which execute a macro.
-     * @param command - The chat command typed.
-     * @param match   - The RegExp matches.
-     * @internal
-     */
-    protected _processMacroCommand(command: string, match: RegExpMatchArray): void;
-
-    /**
-     * Add a sent message to an array of remembered messages to be re-sent if the user pages up with the up arrow key
-     * @param message - The message text being remembered
-     * @internal
-     */
-    protected _remember(message: string): void;
-
-    /**
-     * Recall a previously sent message by incrementing up (1) or down (-1) through the sent messages array
-     * @param direction - The direction to recall, positive for older, negative for more recent
-     * @returns The recalled message, or an empty string
-     * @internal
-     */
-    protected _recall(direction: number): string;
-
-    protected override _contextMenu(html: JQuery): void;
-
-    /**
-     * Get the ChatLog entry context options
-     * @returns The ChatLog entry context options
-     * @internal
-     */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
-
-    /**
-     * Handle keydown events in the chat entry textarea
-     * @internal
-     */
-    protected _onChatKeyDown(event: JQuery.KeyDownEvent): void;
-
-    /**
-     * Handle setting the preferred roll mode
-     * @internal
-     */
-    protected _onChangeRollMode(event: JQuery.ChangeEvent): void;
-
-    /**
-     * Handle single message deletion workflow
-     * @internal
-     */
-    protected _onDeleteMessage(
-      event: JQuery.ClickEvent
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof ChatMessage>> | undefined>;
-
-    /**
-     * Handle clicking of dice tooltip buttons
-     * @internal
-     */
-    protected _onDiceRollClick(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle click events to export the chat log
-     * @internal
-     */
-    protected _onExportLog(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle click events to flush the chat log
-     * @internal
-     */
-    protected _onFlushLog(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle scroll events within the chat log container
-     * @param event - The initial scroll event
-     * @internal
-     */
-    protected _onScrollLog(event: JQuery.ScrollEvent): void;
-
-    /**
-     * Update roll mode select dropdowns when the setting is changed
-     * @param mode - The new roll mode setting
-     * @internal
-     */
-    protected static _setRollMode(mode: keyof CONFIG.Dice.RollModes): void;
-  }
-
-  namespace ChatLog {
-    type Command =
-      | 'roll'
-      | 'gmroll'
-      | 'blindroll'
-      | 'selfroll'
-      | 'publicroll'
-      | 'ic'
-      | 'ooc'
-      | 'emote'
-      | 'whisper'
-      | 'reply'
-      | 'gm'
-      | 'players'
-      | 'macro'
-      | 'invalid'
-      | 'none';
-
-    interface Data {
-      user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      rollMode: keyof CONFIG.Dice.RollModes;
-      rollModes: typeof CONFIG['Dice']['rollModes'];
-      isStream: boolean;
-    }
-
-    interface ScrollBottomOptions {
-      /**
-       * If a popout exists, scroll it too
-       * @defaultValue `undefined`
-       */
-      popout?: boolean;
-    }
-
-    interface PostOneOptions {
-      /**
-       * An existing message ID to append the message before, by default the new message is
-       * appended to the end of the log.
-       */
-      before?: string | undefined;
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/tabs/combat-tracker.d.ts

@@ -1,205 +0,0 @@
-import { ConfiguredDocumentClass, ConfiguredObjectClassForName } from '../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The sidebar directory which organizes and displays world-level Combat documents.
-   */
-  class CombatTracker<Options extends ApplicationOptions = ApplicationOptions> extends SidebarTab<Options> {
-    constructor(options?: Partial<Options>);
-
-    /**
-     * Record a reference to the currently highlighted Token
-     * @defaultValue `null`
-     * @internal
-     */
-    protected _highlighted: ConfiguredObjectClassForName<'Token'> | null;
-
-    /**
-     * Record the currently tracked Combat encounter
-     * @defaultValue `null`
-     */
-    viewed: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>> | null;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "combat",
-     *   template: "templates/sidebar/combat-tracker.html",
-     *   title: "COMBAT.SidebarTitle",
-     *   scrollY: [".directory-list"]
-     * })
-     * ```
-     */
-    static get defaultOptions(): ApplicationOptions;
-
-    /**
-     * Return an array of Combat encounters which occur within the current Scene.
-     */
-    get combats(): StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>>[];
-
-    override createPopout(): this;
-
-    /**
-     * Initialize the combat tracker to display a specific combat encounter.
-     * If no encounter is provided, the tracker will be initialized with the first encounter in the viewed scene.
-     * @param combat - The combat encounter to initialize
-     *                 (default: `null`)
-     * @param render - Whether to re-render the sidebar after initialization
-     *                 (default: `true`)
-     */
-    initialize({ combat, render }?: { combat?: Combat | null; render?: boolean }): void;
-
-    /**
-     * Scroll the combat log container to ensure the current Combatant turn is centered vertically
-     */
-    scrollToTurn(): void;
-
-    override getData(options?: Partial<Options>): Promise<CombatTracker.Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Handle new Combat creation request
-     * @internal
-     */
-    protected _onCombatCreate(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle a Combat deletion request
-     * @internal
-     * @remarks This is never called
-     */
-    protected _onCombatDelete(event: Event): Promise<void>;
-
-    /**
-     * Handle a Combat cycle request
-     * @internal
-     */
-    protected _onCombatCycle(event: Event): Promise<void>;
-
-    /**
-     * Handle click events on Combat control buttons
-     * @param event - The originating mousedown event
-     * @internal
-     */
-    protected _onCombatControl(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle a Combatant control toggle
-     * @param event - The originating mousedown event
-     * @internal
-     */
-    protected _onCombatantControl(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle toggling the defeated status effect on a combatant Token
-     * @param combatant - The combatant data being modified
-     * @returns A Promise that resolves after all operations are complete
-     * @internal
-     */
-    protected _onToggleDefeatedStatus(
-      combatant: InstanceType<ConfiguredDocumentClass<typeof Combatant>>
-    ): Promise<void>;
-
-    /**
-     * Handle mouse-down event on a combatant name in the tracker
-     * @param event - The originating mousedown event
-     * @returns A Promise that resolves once the pan is complete
-     * @internal
-     */
-    protected _onCombatantMouseDown(event: JQuery.ClickEvent): Promise<boolean | void>;
-
-    /**
-     * Handle mouse-hover events on a combatant in the tracker
-     * @internal
-     */
-    protected _onCombatantHoverIn(event: JQuery.MouseEnterEvent): void;
-
-    /**
-     * Handle mouse-unhover events for a combatant in the tracker
-     * @internal
-     */
-    protected _onCombatantHoverOut(event: JQuery.MouseLeaveEvent): void;
-
-    /**
-     * Highlight a hovered combatant in the tracker.
-     * @param combatant - The Combatant
-     * @param hover     - Whether they are being hovered in or out.
-     */
-    hoverCombatant(combatant: InstanceType<ConfiguredDocumentClass<typeof Combatant>>, hover: boolean): void;
-    /**
-     * Attach context menu options to elements in the tracker
-     * @param html - The HTML element to which context options are attached
-     * @internal
-     */
-    protected _contextMenu(html: JQuery): void;
-
-    /**
-     * Get the Combatant entry context options
-     * @returns The Combatant entry context options
-     * @internal
-     */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
-
-    /**
-     * Display a dialog which prompts the user to enter a new initiative value for a Combatant
-     * @internal
-     */
-    protected _onConfigureCombatant(li: JQuery): void;
-  }
-
-  namespace CombatTracker {
-    type Data =
-      | {
-          user: Game['user'];
-          combats: CombatTracker['combats'];
-          combatCount: number;
-          started: boolean;
-          settings: ClientSettings.Values[`core.${typeof Combat.CONFIG_SETTING}`];
-          linked: boolean;
-          labels: { scoped: string };
-          currentIndex: -1;
-          hasCombat: false;
-          combat: null;
-          turns: [];
-          previousId: null;
-          nextId: null;
-          control: false;
-        }
-      | {
-          user: Game['user'];
-          combats: CombatTracker['combats'];
-          combatCount: number;
-          started: boolean;
-          settings: ClientSettings.Values[`core.${typeof Combat.CONFIG_SETTING}`];
-          linked: boolean;
-          labels: { scoped: string };
-          currentIndex: number;
-          hasCombat: true;
-          combat: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Combat>>>;
-          turns: Turn[];
-          previousId: string | null;
-          nextId: string | null;
-          control: boolean;
-          round: number;
-          turn: number;
-        };
-
-    type Turn = {
-      id: string;
-      name: string;
-      img: string;
-      active: boolean;
-      owner: boolean;
-      defeated: boolean;
-      hidden: boolean;
-      initiative: number | null;
-      hasRolled: boolean;
-      hasResource: boolean;
-      ressource: `${number}` | number | boolean | null;
-      css: string;
-      effects: Set<string>;
-    };
-  }
-}

package/src/foundry/client/apps/sidebar/tabs/compendium-directory.d.ts

@@ -1,77 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A compendium of knowledge arcane and mystical!
-   * @typeParam Options - The type of the options object
-   * @typeParam Data    - The data structure used to render the handlebars template.
-   */
-  class CompendiumDirectory<
-    Options extends ApplicationOptions = ApplicationOptions,
-    Data extends object = CompendiumDirectory.Data
-  > extends SidebarTab<Options> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "compendium",
-     *   template: "templates/sidebar/compendium-directory.html",
-     *   title: "COMPENDIUM.SidebarTitle"
-     * });
-     * ```
-     */
-    static override get defaultOptions(): ApplicationOptions;
-
-    override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Compendium sidebar Context Menu creation
-     * @param html - The HTML being rendered for the compendium directory
-     */
-    protected _contextMenu(html: JQuery): void;
-
-    /**
-     * Get the sidebar directory entry context options
-     * @returns The sidebar entry context options
-     * @internal
-     */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
-
-    /**
-     * Handle a Compendium Pack creation request
-     * @param event - The originating click event
-     * @internal
-     */
-    protected _onCreateCompendium(event: JQuery.ClickEvent): Promise<void>;
-
-    /**
-     * Handle a Compendium Pack deletion request
-     * @param pack - The pack object requested for deletion
-     * @internal
-     */
-    protected _onDeleteCompendium(
-      pack: CompendiumCollection<CompendiumCollection.Metadata>
-    ): Promise<CompendiumCollection<CompendiumCollection.Metadata> | void>;
-
-    /**
-     * Toggle the compendium entry open/closed state in the sidebar.
-     * @param pack - The name of the compendium pack.
-     * @internal
-     */
-    protected _toggleOpenState(pack: string): void;
-  }
-
-  namespace CompendiumDirectory {
-    interface Data {
-      user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      packs: { [DocumentName in foundry.CONST.COMPENDIUM_DOCUMENT_TYPES]?: PackData<DocumentName> };
-    }
-
-    interface PackData<DocumentName extends foundry.CONST.COMPENDIUM_DOCUMENT_TYPES> {
-      label: DocumentName;
-      packs: CompendiumCollection<CompendiumCollection.Metadata & { entity: DocumentName }>[];
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/tabs/index.d.ts

@@ -1,12 +0,0 @@
-import './actors-directory';
-import './cards-directory';
-import './chat-log';
-import './combat-tracker';
-import './compendium-directory';
-import './items-directory';
-import './journal-directory';
-import './macros-directory';
-import './playlists-directory';
-import './roll-table-directory';
-import './scenes-directory';
-import './settings';

package/src/foundry/client/apps/sidebar/tabs/items-directory.d.ts

@@ -1,10 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level Item documents.
- */
-declare class ItemDirectory extends SidebarDirectory<'Item'> {
-  static override documentName: 'Item';
-
-  protected override _canDragDrop(selector: string): boolean;
-
-  protected override _getEntryContextOptions(): ContextMenuEntry[];
-}

package/src/foundry/client/apps/sidebar/tabs/journal-directory.d.ts

@@ -1,11 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level JournalEntry documents.
- * @typeParam Options - The type of the options object
- */
-declare class JournalDirectory<
-  Options extends SidebarDirectory.Options = SidebarDirectory.Options
-> extends SidebarDirectory<'JournalEntry', Options> {
-  static override documentName: 'JournalEntry';
-
-  protected override _getEntryContextOptions(): ContextMenuEntry[];
-}

package/src/foundry/client/apps/sidebar/tabs/macros-directory.d.ts

@@ -1,12 +0,0 @@
-/**
- * The directory, not displayed in the sidebar, which organizes and displays world-level Macro documents.
- *
- * @see {@link Macros}        The WorldCollection of Macro Documents
- * @see {@link Macro}         The Macro Document
- * @see {@link MacroConfig}   The Macro Configuration Sheet
- */
-declare class MacroDirectory extends SidebarDirectory<'Macro'> {
-  constructor(options?: Partial<SidebarDirectory.Options>);
-
-  static override documentName: 'Macro';
-}