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

package/src/foundry/client/data/documents/journal-entry.d.ts

@@ -1,71 +0,0 @@
-import { DocumentDataType, DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * The client-side JournalEntry document which extends the common BaseJournalEntry model.
-   * Each JournalEntry document contains JournalEntryData which defines its data schema.
-   *
-   * @see {@link data.JournalEntryData}              The JournalEntry data schema
-   * @see {@link documents.Journal}                  The world-level collection of JournalEntry documents
-   * @see {@link applications.JournalSheet}          The JournalEntry configuration application
-   *
-   * @param data - Initial data provided to construct the JournalEntry document
-   */
-  class JournalEntry extends ClientDocumentMixin(foundry.documents.BaseJournalEntry) {
-    /**
-     * A boolean indicator for whether or not the JournalEntry is visible to the current user in the directory sidebar
-     */
-    get visible(): boolean;
-
-    /**
-     * Return a reference to the Note instance for this Journal Entry in the current Scene, if any.
-     * If multiple notes are placed for this Journal Entry, only the first will be returned.
-     */
-    get sceneNote(): Note | null;
-
-    /**
-     * Show the JournalEntry to connected players.
-     * By default the entry will only be shown to players who have permission to observe it.
-     * If the parameter force is passed, the entry will be shown to all players regardless of normal permission.
-     *
-     * @param mode  - Which JournalEntry mode to display? Default is text.
-     *                (default: `'text'`)
-     * @param force - Display the entry to all players regardless of normal permissions
-     *                (default: `false`)
-     * @returns A Promise that resolves back to the shown entry once the request is processed
-     */
-    show(mode?: 'text' | 'image', force?: boolean): Promise<this>;
-
-    /**
-     * If the JournalEntry has a pinned note on the canvas, this method will animate to that note
-     * The note will also be highlighted as if hovered upon by the mouse
-     * @param options - Options which modify the pan operation
-     * @returns A Promise which resolves once the pan animation has concluded
-     */
-    panToNote(options?: PanToNoteOptions): Promise<void>;
-
-    protected override _onUpdate(
-      data: DeepPartial<DocumentDataType<foundry.documents.BaseJournalEntry>>,
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-  }
-}
-
-interface PanToNoteOptions {
-  /**
-   * The speed of the pan animation in milliseconds
-   * @defaultValue `250`
-   */
-  duration?: number;
-
-  /**
-   * The resulting zoom level
-   * @defaultValue `1.5`
-   */
-  scale?: number;
-}
-
-export {};

package/src/foundry/client/data/documents/macro.d.ts

@@ -1,60 +0,0 @@
-declare global {
-  /**
-   * The client-side Macro document which extends the common BaseMacro model.
-   * Each Macro document contains MacroData which defines its data schema.
-   *
-   * @see {@link data.MacroData}              The Macro data schema
-   * @see {@link documents.Macros}            The world-level collection of Macro documents
-   * @see {@link applications.MacroConfig}    The Macro configuration application
-   *
-   * @param data - Initial data provided to construct the Macro document
-   */
-  class Macro extends ClientDocumentMixin(foundry.documents.BaseMacro) {
-    /**
-     * Is the current User the author of this macro?
-     */
-    get isAuthor(): boolean;
-
-    /**
-     * Test whether the current user is capable of executing a Macro script
-     */
-    get canExecute(): boolean;
-
-    /**
-     * Provide a thumbnail image path used to represent this document.
-     */
-    get thumbnail(): string | null;
-
-    /**
-     * Execute the Macro command.
-     * @param scope - Provide some additional scope configuration for the Macro
-     */
-    execute(scope?: Scope): void;
-
-    /**
-     * Execute the command as a chat macro.
-     * Chat macros simulate the process of the command being entered into the Chat Log input textarea.
-     */
-    protected _executeChat({ actor, token }?: Scope): void;
-
-    /**
-     * Execute the command as a script macro.
-     * Script Macros are wrapped in an async IIFE to allow the use of asynchronous commands and await statements.
-     */
-    protected _executeScript({ actor, token }?: Scope): void;
-  }
-}
-
-interface Scope {
-  /**
-   * An Actor who is the protagonist of the executed action
-   */
-  actor?: Actor;
-
-  /**
-   * A Token which is the protagonist of the executed action
-   */
-  token?: Token;
-}
-
-export {};

package/src/foundry/client/data/documents/measured-template.d.ts

@@ -1,21 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The client-side MeasuredTemplate embedded document which extends the common BaseMeasuredTemplate abstraction.
-   * Each MeasuredTemplate document contains MeasuredTemplateData which defines its data schema.
-   *
-   * @see {@link data.MeasuredTemplateData}              The MeasuredTemplate data schema
-   * @see {@link documents.Scene}               The Scene document type which contains MeasuredTemplate embedded documents
-   * @see {@link applications.MeasuredTemplateConfig}    The MeasuredTemplate configuration application
-   */
-  class MeasuredTemplateDocument extends CanvasDocumentMixin(foundry.documents.BaseMeasuredTemplate) {
-    /**
-     * A reference to the User who created the MeasuredTemplate document.
-     * @remarks Will return undefined if the user has been deleted
-     */
-    get author(): InstanceType<ConfiguredDocumentClass<typeof User>> | undefined;
-  }
-}
-
-export {};

package/src/foundry/client/data/documents/note.d.ts

@@ -1,19 +0,0 @@
-/**
- * The client-side Note document which extends the common BaseNote model.
- * Each Note document contains NoteData which defines its data schema.
- *
- * @see {@link data.NoteData}                 The Note data schema
- * @see {@link documents.Scene}               The Scene document type which contains Note embedded documents
- * @see {@link applications.NoteConfig}       The Note configuration application
- */
-declare class NoteDocument extends CanvasDocumentMixin(foundry.documents.BaseNote) {
-  /**
-   * The associated JournalEntry which is referenced by this Note
-   */
-  get entry(): ReturnType<Journal['get']>;
-
-  /**
-   * The text label used to annotate this Note
-   */
-  get label(): string;
-}

package/src/foundry/client/data/documents/playlist-sound.d.ts

@@ -1,117 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * The client-side PlaylistSound document which extends the common BasePlaylistSound model.
-   * Each PlaylistSound belongs to the sounds collection of a Playlist document.
-   * Each PlaylistSound contains a PlaylistSoundData object which provides its source data.
-   *
-   * @see {@link foundry.data.PlaylistSoundData} The PlaylistSound data schema
-   * @see {@link Playlist}                       The Playlist document which contains PlaylistSound embedded documents
-   * @see {@link Sound}                          The Sound API which manages web audio playback
-   *
-   */
-  class PlaylistSound extends ClientDocumentMixin(foundry.documents.BasePlaylistSound) {
-    /**
-     * @param data   - Initial data provided to construct the PlaylistSound document
-     * @param parent - The parent Playlist document to which this result belongs
-     */
-    constructor(
-      data: ConstructorParameters<typeof foundry.documents.BasePlaylistSound>[0],
-      context?: ConstructorParameters<typeof foundry.documents.BasePlaylistSound>[1]
-    );
-
-    /**
-     * The Sound which manages playback for this playlist sound
-     */
-    sound: Sound | null;
-
-    /**
-     * A debounced function, accepting a single volume parameter to adjust the volume of this sound
-     * @param volume - The desired volume level
-     */
-    debounceVolume: (volume: number) => void;
-
-    /**
-     * The debounce tolerance for processing rapid volume changes into database updates in milliseconds
-     * @defaultValue `100`
-     */
-    static VOLUME_DEBOUNCE_MS: number;
-
-    /**
-     * Create a Sound used to play this PlaylistSound document
-     * @internal
-     */
-    protected _createSound(): Sound | null;
-
-    /**
-     * A convenience reference to the HTTP path to the source audio file
-     */
-    get path(): string | undefined | null;
-
-    /**
-     * A convenience indicator for whether this sound is currently playing.
-     */
-    get playing(): boolean;
-
-    /**
-     * The effective volume at which this PlaylistSound should be playing, including the global playlist volume modifier
-     */
-    get volume(): number;
-
-    /**
-     * Determine the fade duration for this PlaylistSound based on its own configuration and that of its parent.
-     */
-    get fadeDuration(): number;
-
-    /**
-     * Synchronize playback for this particular PlaylistSound instance
-     */
-    sync(): void | Promise<void> | Promise<Sound>;
-
-    override _onCreate(
-      data: foundry.data.PlaylistSoundData['_source'],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onUpdate(
-      changed: DeepPartial<foundry.data.PlaylistSoundData['_source']>,
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-
-    /**
-     * Special handling that occurs when a PlaylistSound reaches the natural conclusion of its playback.
-     * @internal
-     */
-    protected _onEnd(): Promise<void | InstanceType<ConfiguredDocumentClassForName<'Playlist'>> | undefined>;
-
-    /**
-     * Special handling that occurs when playback of a PlaylistSound is started.
-     * @internal
-     */
-    protected _onStart(): Promise<void>;
-
-    /**
-     * Special handling that occurs when a PlaylistSound is manually stopped before its natural conclusion.
-     * @internal
-     */
-    protected _onStop(): Promise<void>;
-
-    /**
-     * Handle fading in the volume for this sound when it begins to play (or loop)
-     * @internal
-     */
-    protected _fadeIn(sound: Sound): void;
-
-    /**
-     * Handle fading out the volume for this sound when it begins to play (or loop)
-     * @internal
-     */
-    protected _fadeOut(sound: Sound): void;
-  }
-}

package/src/foundry/client/data/documents/playlist.d.ts

@@ -1,192 +0,0 @@
-import type { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import type { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-import type { PlaylistDataConstructorData } from '../../../common/data/data.mjs/playlistData';
-
-declare global {
-  /**
-   * The client-side Playlist document which extends the common BasePlaylist model.
-   * Each Playlist document contains PlaylistData which defines its data schema.
-   *
-   * @see {@link data.PlaylistData}               The Playlist data schema
-   * @see {@link documents.Playlists}             The world-level collection of Playlist documents
-   * @see {@link embedded.PlaylistSound}          The PlaylistSound embedded document within a parent Playlist
-   * @see {@link applications.PlaylistConfig}     The Playlist configuration application
-   *
-   */
-  class Playlist extends ClientDocumentMixin(foundry.documents.BasePlaylist) {
-    /**
-     * @param data - Initial data provided to construct the Playlist document
-     */
-    constructor(
-      data: ConstructorParameters<typeof foundry.documents.BasePlaylist>[0],
-      context?: ConstructorParameters<typeof foundry.documents.BasePlaylist>[1]
-    );
-
-    /**
-     * Playlists may have a playback order which defines the sequence of Playlist Sounds
-     * @defaultValue `undefined`
-     * @internal
-     */
-    protected _playbackOrder: string[] | undefined;
-
-    /**
-     * The playback mode for the Playlist instance
-     */
-    get mode(): foundry.CONST.PLAYLIST_MODES;
-
-    /**
-     * The order in which sounds within this playlist will be played (if sequential or shuffled)
-     * Uses a stored seed for randomization to guarantee that all clients generate the same random order.
-     */
-    get playbackOrder(): string[];
-
-    /**
-     * An indicator for whether any Sound within the Playlist is currently playing
-     */
-    get playing(): boolean;
-
-    override get visible(): boolean;
-
-    /**
-     * Begin simultaneous playback for all sounds in the Playlist.
-     * @returns The updated Playlist document
-     */
-    playAll(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
-
-    /**
-     * Play the next Sound within the sequential or shuffled Playlist.
-     * @param soundId - The currently playing sound ID, if known
-     * @param options - Additional options which configure the next track
-     * @returns The updated Playlist document
-     */
-    playNext(
-      soundId?: string,
-      options?: Partial<Playlist.PlayNextOptions>
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined | null>;
-
-    /**
-     * Begin playback of a specific Sound within this Playlist.
-     * Determine which other sounds should remain playing, if any.
-     * @param sound - The desired sound that should play
-     * @returns The updated Playlist
-     */
-    playSound(
-      sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
-
-    /**
-     * Stop playback of a specific Sound within this Playlist.
-     * Determine which other sounds should remain playing, if any.
-     * @param sound - The desired sound that should play
-     * @returns The updated Playlist
-     */
-    stopSound(
-      sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
-
-    /**
-     * End playback for any/all currently playing sounds within the Playlist.
-     * @returns The updated Playlist document
-     */
-    stopAll(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
-
-    /**
-     * Cycle the playlist mode
-     * @returns A promise which resolves to the updated Playlist instance
-     */
-    cycleMode(): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
-
-    /**
-     * Get the next sound in the cached playback order. For internal use.
-     * @internal
-     */
-    protected _getNextSound(soundId: string): InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>> | undefined;
-
-    /**
-     * Get the previous sound in the cached playback order. For internal use.
-     * @internal
-     */
-    protected _getPreviousSound(
-      soundId: string
-    ): InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>> | undefined;
-
-    /**
-     * Define the sorting order for the Sounds within this Playlist. For internal use.
-     * @internal
-     */
-    protected _sortSounds(
-      a: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>,
-      b: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>
-    ): number;
-
-    protected override _preUpdate(
-      changed: DeepPartial<PlaylistDataConstructorData>,
-      options: DocumentModificationOptions,
-      user: foundry.documents.BaseUser
-    ): Promise<void>;
-
-    protected override _onUpdate(
-      changed: DeepPartial<foundry.data.PlaylistData['_source']>,
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onDelete(options: DocumentModificationOptions, userId: string): void;
-
-    protected override _onCreateEmbeddedDocuments(
-      embeddedName: string,
-      documents: foundry.abstract.Document<any, any>[],
-      result: Record<string, unknown>[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected override _onUpdateEmbeddedDocuments(
-      embeddedName: string,
-      documents: foundry.abstract.Document<any, any>[],
-      result: Record<string, unknown>[],
-      options: DocumentModificationContext,
-      userId: string
-    ): void;
-
-    protected override _onDeleteEmbeddedDocuments(
-      embeddedName: string,
-      documents: foundry.abstract.Document<any, any>[],
-      result: string[],
-      options: DocumentModificationContext,
-      userId: string
-    ): void;
-
-    /**
-     * Handle callback logic when an individual sound within the Playlist concludes playback naturally
-     * @internal
-     */
-    _onSoundEnd(
-      sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Playlist>> | undefined>;
-
-    /**
-     * Handle callback logic when playback for an individual sound within the Playlist is started.
-     * Schedule auto-preload of next track
-     * @internal
-     */
-    _onSoundStart(sound: InstanceType<ConfiguredDocumentClass<typeof PlaylistSound>>): Promise<void>;
-
-    override toCompendium(
-      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null | undefined,
-      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
-    ): Omit<foundry.data.PlaylistData['_source'], '_id' | 'folder' | 'permission'> & {
-      permission?: foundry.data.PlaylistData['_source']['permission'];
-    };
-  }
-
-  namespace Playlist {
-    interface PlayNextOptions {
-      /**
-       * Whether to advance forward (if 1) or backwards (if -1)
-       * @defaultValue `1`
-       */
-      direction: 1 | -1;
-    }
-  }
-}