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

package/src/foundry/client/data/collections/journal.d.mts

@@ -0,0 +1,64 @@
+import type { InexactPartial } from "../../../../types/utils.d.mts";
+
+declare global {
+  /**
+   * The singleton collection of JournalEntry documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.journal.
+   *
+   * @see {@link JournalEntry} The JournalEntry document
+   * @see {@link JournalDirectory} The JournalDirectory sidebar directory
+   */
+  class Journal extends WorldCollection<typeof foundry.documents.BaseJournalEntry, "Journal"> {
+    static documentName: "JournalEntry";
+
+    /**
+     * Display a dialog which prompts the user to show a JournalEntry or JournalEntryPage to other players.
+     * @param doc - The JournalEntry or JournalEntryPage to show.
+     */
+    static showDialog<T extends JournalEntry | JournalEntryPage>(doc: T): Promise<T | void>;
+
+    /**
+     * Show the JournalEntry or JournalEntryPage to connected players.
+     * By default, the document will only be shown to players who have permission to observe it.
+     * If the force parameter is passed, the document will be shown to all players regardless of normal permission.
+     * @param doc     - The JournalEntry or JournalEntryPage to show.
+     * @param options - Additional options to configure behaviour.
+     * @returns A Promise that resolves back to the shown document once the request is processed.
+     * @throws If the user does not own the document they are trying to show.
+     */
+    static show<T extends JournalEntry | JournalEntryPage>(
+      doc: T,
+      options?: InexactPartial<{
+        /**
+         * Display the entry to all players regardless of normal permissions.
+         */
+        force: boolean;
+        /**
+         * An optional list of user IDs to show the document to. Otherwise it will be shown to all connected clients.
+         */
+        users: string[];
+      }>,
+    ): Promise<T | void>;
+
+    /**
+     * Share an image with connected players.
+     * @param src    - The image URL to share.
+     * @param config - Image sharing configuration.
+     */
+    static showImage(src: string, config?: InexactPartial<ImagePopout.ShareImageConfig>): void;
+
+    /**
+     * Open Socket listeners which transact JournalEntry data
+     * @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners}
+     */
+    protected static _activateSocketListeners(socket: io.Socket): void;
+
+    /**
+     * Handle a received request to show a JournalEntry or JournalEntryPage to the current client
+     * @param uuid - The UUID of the document to display for other players
+     * @param force   - Display the document regardless of normal permissions
+     *                  (default: `true`)
+     */
+    protected static _showEntry(uuid: string, force?: boolean): Promise<void>;
+  }
+}

package/src/foundry/client/data/collections/macros.d.mts

@@ -0,0 +1,32 @@
+import type { InexactPartial } from "../../../../types/utils.d.mts";
+
+declare global {
+  /**
+   * The singleton collection of Macro documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.macros.
+   *
+   * @see {@link Macro} The Macro document
+   * @see {@link MacroDirectory} The MacroDirectory sidebar directory
+   */
+  class Macros extends WorldCollection<typeof foundry.documents.BaseMacro, "Macros"> {
+    static documentName: "Macro";
+
+    override get directory(): typeof ui.macros;
+
+    override fromCompendium<
+      FolderOpt extends boolean = false,
+      SortOpt extends boolean = true,
+      OwnershipOpt extends boolean = false,
+      IdOpt extends boolean = false,
+    >(
+      document: Macro.ConfiguredInstance | foundry.documents.BaseMacro.ConstructorData,
+      options?: InexactPartial<WorldCollection.FromCompendiumOptions<FolderOpt, SortOpt, OwnershipOpt, IdOpt>>,
+    ): Omit<
+      Macro["_source"],
+      | ClientDocument.OmitProperty<FolderOpt, "folder">
+      | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
+      | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
+      | (IdOpt extends false ? "_id" : never)
+    >;
+  }
+}

package/src/foundry/client/data/collections/messages.d.mts

@@ -0,0 +1,35 @@
+import type Document from "../../../common/abstract/document.d.mts";
+
+declare global {
+  /**
+   * The singleton collection of ChatMessage documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.messages.
+   *
+   * @see {@link ChatMessage} The ChatMessage document
+   * @see {@link ChatLog} The ChatLog sidebar directory
+   */
+  class Messages extends WorldCollection<typeof foundry.documents.BaseChatMessage, "Messages"> {
+    static documentName: "ChatMessage";
+
+    override get directory(): typeof ui.chat;
+
+    render(force?: boolean): void;
+
+    /**
+     * If requested, dispatch a Chat Bubble UI for the newly created message
+     * @param message - The ChatMessage document to say
+     */
+    sayBubble(message: ChatMessage.ConfiguredInstance): void;
+
+    /**
+     * Handle export of the chat log to a text file
+     */
+    export(): void;
+
+    /**
+     * Allow for bulk deletion of all chat messages, confirm first with a yes/no dialog.
+     * @see {@link Dialog.confirm}
+     */
+    flush(): Promise<Promise<Document.Stored<ChatMessage.ConfiguredInstance>[]> | false | null>;
+  }
+}

package/src/foundry/client/data/collections/playlists.d.mts

@@ -0,0 +1,32 @@
+import type { DeepPartial } from "../../../../types/utils.d.mts";
+import type Document from "../../../common/abstract/document.d.mts";
+
+declare global {
+  /**
+   * The singleton collection of Playlist documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.playlists.
+   *
+   * @see {@link Playlist} The Playlist document
+   * @see {@link PlaylistDirectory} The PlaylistDirectory sidebar directory
+   */
+  class Playlists extends WorldCollection<typeof foundry.documents.BasePlaylist, "Playlists"> {
+    static documentName: "Playlist";
+
+    /**
+     * Return the subset of Playlist documents which are currently playing
+     */
+    get playing(): ReturnType<this["filter"]>;
+
+    /**
+     * Perform one-time initialization to begin playback of audio.
+     */
+    initialize(): Promise<void>;
+
+    /**
+     * Handle changes to a Scene to determine whether to trigger changes to Playlist documents.
+     * @param scene - The Scene document being updated
+     * @param data  - The incremental update data
+     */
+    protected _onChangeScene(scene: Document.Stored<Scene>, data: DeepPartial<Scene["_source"]>): Promise<void>;
+  }
+}

package/src/foundry/client/data/collections/scenes.d.mts

@@ -0,0 +1,68 @@
+import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type Document from "../../../common/abstract/document.d.mts";
+
+declare global {
+  /**
+   * The singleton collection of Scene documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.scenes.
+   *
+   * @see {@link Scene} The Scene document
+   * @see {@link SceneDirectory} The SceneDirectory sidebar directory
+   */
+  class Scenes extends WorldCollection<typeof foundry.documents.BaseScene, "Scenes"> {
+    static documentName: "Scene";
+
+    /**
+     * Return a reference to the Scene which is currently active
+     */
+    get active(): Document.Stored<Scene.ConfiguredInstance> | undefined;
+
+    /**
+     * Return the current Scene target.
+     * This is the viewed scene if the canvas is active, otherwise it is the currently active scene.
+     */
+    get current(): Document.Stored<Scene.ConfiguredInstance> | undefined;
+
+    /**
+     * Return a reference to the Scene which is currently viewed
+     */
+    get viewed(): Document.Stored<Scene.ConfiguredInstance> | undefined;
+
+    /**
+     * Handle pre-loading the art assets for a Scene
+     *
+     * @param sceneId - The Scene id to begin loading
+     * @param push    - Trigger other connected clients to also pre-load Scene resources
+     *                  (default: `false`)
+     */
+    preload(sceneId: string, push?: boolean): io.Socket | Promise<unknown[]>;
+
+    /** @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners} */
+    static _activateSocketListeners(socket: io.Socket): void;
+
+    /**
+     * Handle requests pulling the current User to a specific Scene
+     */
+    protected static _pullToScene(sceneId: string): void;
+
+    override fromCompendium<
+      FolderOpt extends boolean = false,
+      SortOpt extends boolean = true,
+      OwnershipOpt extends boolean = false,
+      IdOpt extends boolean = false,
+      StateOpt extends boolean = false,
+    >(
+      document: Scene.ConfiguredInstance | foundry.documents.BaseScene.ConstructorData,
+      options?: InexactPartial<
+        WorldCollection.FromCompendiumOptions<FolderOpt, SortOpt, OwnershipOpt, IdOpt, StateOpt>
+      >,
+    ): Omit<
+      Scene["_source"],
+      | ClientDocument.OmitProperty<FolderOpt, "folder">
+      | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
+      | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
+      | (IdOpt extends false ? "_id" : never)
+      | ClientDocument.OmitProperty<StateOpt, "active">
+    >;
+  }
+}

package/src/foundry/client/data/collections/settings.d.mts

@@ -0,0 +1,29 @@
+export {};
+
+declare global {
+  /**
+   * The Collection of Setting documents which exist within the active World.
+   * This collection is accessible as game.settings.storage.get("world")
+   *
+   * @see {@link Setting} The Setting document
+   */
+  class WorldSettings extends WorldCollection<typeof foundry.documents.BaseSetting, "WorldSettings"> {
+    static documentName: "Setting";
+
+    override get directory(): null;
+
+    /**
+     * Return the Setting or Keybind document with the given key.
+     * @param key - The setting key
+     * @returns The Setting.
+     */
+    getSetting(key: string): ReturnType<this["find"]>;
+
+    /**
+     * Return the serialized value of the world setting as a string
+     * @param key - The setting key
+     * @returns The serialized setting string
+     */
+    getItem(key: string): string | null;
+  }
+}

package/src/foundry/client/data/collections/tables.d.mts

@@ -0,0 +1,21 @@
+export {};
+
+declare global {
+  /**
+   * The singleton collection of RollTable documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.tables.
+   *
+   * @see {@link RollTable} The RollTable document
+   * @see {@link RollTableDirectory} The RollTableDirectory sidebar directory
+   */
+  class RollTables extends WorldCollection<typeof foundry.documents.BaseRollTable, "RollTables"> {
+    static documentName: "RollTable";
+
+    override get directory(): (typeof ui)["tables"];
+
+    /**
+     * Register world settings related to RollTable documents
+     */
+    static registerSettings(): void;
+  }
+}

package/src/foundry/client/data/collections/users.d.mts

@@ -0,0 +1,50 @@
+import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type Document from "../../../common/abstract/document.d.mts";
+
+declare global {
+  /**
+   * The singleton collection of User documents which exist within the active World.
+   * This Collection is accessible within the Game object as game.users.
+   *
+   * @see {@link User} The User document
+   */
+  class Users extends WorldCollection<typeof foundry.documents.BaseUser, "Users"> {
+    constructor(data?: User["_source"][]);
+
+    /**
+     * The User document of the currently connected user
+     * @defaultValue `null`
+     */
+    current: Document.Stored<User.ConfiguredInstance> | null;
+
+    /**
+     * Initialize the Map object and all its contained documents
+     * @internal
+     */
+    protected _initialize(): void;
+
+    static documentName: "User";
+
+    /**
+     * Get the users with player roles
+     */
+    get players(): ReturnType<this["filter"]>;
+
+    /**
+     * Get one User who is an active Gamemaster (non-assistant if possible), or null if no active GM is available.
+     * This can be useful for workflows which occur on all clients, but where only one user should take action.
+     */
+    get activeGM(): User.ConfiguredInstance | null;
+
+    /** @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners} */
+    static _activateSocketListeners(socket: io.Socket): void;
+
+    /**
+     * Handle receipt of activity data from another User connected to the Game session
+     * @param userId       - The User id who generated the activity data
+     * @param activityData - The object of activity data
+     *                       (default: `{}`)
+     */
+    protected static _handleUserActivity(userId: string, activityData?: InexactPartial<User.ActivityData>): void;
+  }
+}