@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1

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

@@ -1,530 +0,0 @@
-import type { InexactPartial, Merge } from "fvtt-types/utils";
-import type Sound from "#client-esm/audio/sound.d.mts";
-import type Document from "#common/abstract/document.d.mts";
-import type { DataSchema } from "#common/data/fields.d.mts";
-
-import fields = foundry.data.fields;
-
-declare global {
-  namespace PlaylistSound {
-    /**
-     * The document's name.
-     */
-    type Name = "PlaylistSound";
-
-    /**
-     * The arguments to construct the document.
-     */
-    type ConstructorArgs = Document.ConstructorParameters<CreateData, Parent>;
-
-    /**
-     * The documents embedded within `PlaylistSound`.
-     */
-    type Hierarchy = Readonly<Document.HierarchyOf<Schema>>;
-
-    /**
-     * The implementation of the `PlaylistSound` document instance configured through `CONFIG.PlaylistSound.documentClass` in Foundry and
-     * {@link DocumentClassConfig | `DocumentClassConfig`} or {@link ConfiguredPlaylistSound | `fvtt-types/configuration/ConfiguredPlaylistSound`} in fvtt-types.
-     */
-    type Implementation = Document.ImplementationFor<Name>;
-
-    /**
-     * The implementation of the `PlaylistSound` document configured through `CONFIG.PlaylistSound.documentClass` in Foundry and
-     * {@link DocumentClassConfig | `DocumentClassConfig`} in fvtt-types.
-     */
-    type ImplementationClass = Document.ImplementationClassFor<Name>;
-
-    /**
-     * A document's metadata is special information about the document ranging anywhere from its name,
-     * whether it's indexed, or to the permissions a user has over it.
-     */
-    interface Metadata
-      extends Merge<
-        Document.Metadata.Default,
-        Readonly<{
-          name: "PlaylistSound";
-          collection: "sounds";
-          indexed: true;
-          label: string;
-          labelPlural: string;
-          compendiumIndexFields: ["name", "sort"];
-          schemaVersion: string;
-        }>
-      > {}
-
-    // No need for Metadata namespace
-
-    /**
-     * A document's parent is something that can contain it.
-     * For example an `Item` can be contained by an `Actor` which makes `Actor` one of its possible parents.
-     */
-    type Parent = Playlist.Implementation | null;
-
-    /**
-     * A document's descendants are any child documents, grandchild documents, etc.
-     * This is a union of all instances, or never if the document doesn't have any descendants.
-     */
-    type Descendant = never;
-
-    /**
-     * A document's descendants are any child documents, grandchild documents, etc.
-     * This is a union of all classes, or never if the document doesn't have any descendants.
-     */
-    type DescendantClass = never;
-
-    /**
-     * Types of `CompendiumCollection` this document might be contained in.
-     * Note that `this.pack` will always return a string; this is the type for `game.packs.get(this.pack)`
-     */
-    // Note: Takes any document in the heritage chain (i.e. itself or any parent, transitive or not) that can be contained in a compendium.
-    type Pack = CompendiumCollection.ForDocument<"Playlist">;
-
-    /**
-     * An embedded document is a document contained in another.
-     * For example an `Item` can be contained by an `Actor` which means `Item` can be embedded in `Actor`.
-     *
-     * If this is `never` it is because there are no embeddable documents (or there's a bug!).
-     */
-    type Embedded = never;
-
-    /**
-     * The name of the world or embedded collection this document can find itself in.
-     * For example an `Item` is always going to be inside a collection with a key of `items`.
-     * This is a fixed string per document type and is primarily useful for {@link ClientDocumentMixin | `Descendant Document Events`}.
-     */
-    type ParentCollectionName = Metadata["collection"];
-
-    /**
-     * The world collection that contains this document type. Will be `never` if none exists.
-     */
-    type CollectionClass = never;
-
-    /**
-     * The world collection that contains this document type. Will be `never` if none exists.
-     */
-    type Collection = never;
-
-    /**
-     * An instance of `PlaylistSound` that comes from the database but failed validation meaining that
-     * its `system` and `_source` could theoretically be anything.
-     */
-    interface Invalid extends Document.Invalid<PlaylistSound.Implementation> {}
-
-    /**
-     * An instance of `PlaylistSound` that comes from the database.
-     */
-    interface Stored extends Document.Stored<PlaylistSound.Implementation> {}
-
-    /**
-     * The data put in {@link PlaylistSound._source | `PlaylistSound#_source`}. This data is what was
-     * persisted to the database and therefore it must be valid JSON.
-     *
-     * For example a {@link fields.SetField | `SetField`} is persisted to the database as an array
-     * but initialized as a {@link Set | `Set`}.
-     */
-    interface Source extends fields.SchemaField.SourceData<Schema> {}
-
-    /**
-     * @deprecated {@link PlaylistSound.Source | `PlaylistSound.Source`}
-     */
-    type PersistedData = Source;
-
-    /**
-     * The data necessary to create a document. Used in places like {@link PlaylistSound.create | `PlaylistSound.create`}
-     * and {@link PlaylistSound | `new PlaylistSound(...)`}.
-     *
-     * For example a {@link fields.SetField | `SetField`} can accept any {@link Iterable | `Iterable`}
-     * with the right values. This means you can pass a `Set` instance, an array of values,
-     * a generator, or any other iterable.
-     */
-    interface CreateData extends fields.SchemaField.CreateData<Schema> {}
-
-    /**
-     * The data after a {@link foundry.abstract.Document | `Document`} has been initialized, for example
-     * {@link PlaylistSound.name | `PlaylistSound#name`}.
-     *
-     * This is data transformed from {@link PlaylistSound.Source | `PlaylistSound.Source`} and turned into more
-     * convenient runtime data structures. For example a {@link fields.SetField | `SetField`} is
-     * persisted to the database as an array of values but at runtime it is a `Set` instance.
-     */
-    interface InitializedData extends fields.SchemaField.InitializedData<Schema> {}
-
-    /**
-     * The data used to update a document, for example {@link PlaylistSound.update | `PlaylistSound#update`}.
-     * It is a distinct type from {@link PlaylistSound.CreateData | `DeepPartial<PlaylistSound.CreateData>`} because
-     * it has different rules for `null` and `undefined`.
-     */
-    interface UpdateData extends fields.SchemaField.UpdateData<Schema> {}
-
-    /**
-     * The schema for {@link PlaylistSound | `PlaylistSound`}. This is the source of truth for how an PlaylistSound document
-     * must be structured.
-     *
-     * Foundry uses this schema to validate the structure of the {@link PlaylistSound | `PlaylistSound`}. For example
-     * a {@link fields.StringField | `StringField`} will enforce that the value is a string. More
-     * complex fields like {@link fields.SetField | `SetField`} goes through various conversions
-     * starting as an array in the database, initialized as a set, and allows updates with any
-     * iterable.
-     */
-    interface Schema extends DataSchema {
-      /**
-       * The _id which uniquely identifies this PlaylistSound document
-       * @defaultValue `null`
-       */
-      _id: fields.DocumentIdField;
-
-      /**
-       * The name of this sound
-       */
-      name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
-
-      /**
-       * The description of this sound
-       * @defaultValue `""`
-       */
-      description: fields.StringField;
-
-      /**
-       * The audio file path that is played by this sound
-       * @defaultValue `null`
-       */
-      path: fields.FilePathField<{ categories: ["AUDIO"] }>;
-
-      /**
-       * A channel in CONST.AUDIO_CHANNELS where this sound is are played
-       * @defaultValue `"music"`
-       */
-      channel: fields.StringField<{ choices: typeof foundry.CONST.AUDIO_CHANNELS; initial: string; blank: false }>;
-
-      /**
-       * Is this sound currently playing?
-       * @defaultValue `false`
-       */
-      playing: fields.BooleanField;
-
-      /**
-       * The time in seconds at which playback was paused
-       * @defaultValue `null`
-       */
-      pausedTime: fields.NumberField<{ min: 0 }>;
-
-      /**
-       * Does this sound loop?
-       * @defaultValue `false`
-       */
-      repeat: fields.BooleanField;
-
-      /**
-       * The audio volume of the sound, from 0 to 1
-       * @defaultValue `1`
-       */
-      volume: fields.AlphaField<{ initial: 0.5; step: 0.01 }>;
-
-      /**
-       * A duration in milliseconds to fade volume transition
-       * @defaultValue `null`
-       */
-      fade: fields.NumberField<{ integer: true; min: 0 }>;
-
-      /**
-       * The sort order of the PlaylistSound relative to others in the same collection
-       * @defaultValue `0`
-       */
-      sort: fields.IntegerSortField;
-
-      /**
-       * An object of optional key/value flags
-       * @defaultValue `{}`
-       */
-      flags: fields.ObjectField.FlagsField<Name>;
-    }
-
-    namespace Database {
-      /** Options passed along in Get operations for PlaylistSounds */
-      interface Get extends foundry.abstract.types.DatabaseGetOperation<PlaylistSound.Parent> {}
-
-      /** Options passed along in Create operations for PlaylistSounds */
-      interface Create<Temporary extends boolean | undefined = boolean | undefined>
-        extends foundry.abstract.types.DatabaseCreateOperation<
-          PlaylistSound.CreateData,
-          PlaylistSound.Parent,
-          Temporary
-        > {}
-
-      /** Options passed along in Delete operations for PlaylistSounds */
-      interface Delete extends foundry.abstract.types.DatabaseDeleteOperation<PlaylistSound.Parent> {}
-
-      /** Options passed along in Update operations for PlaylistSounds */
-      interface Update
-        extends foundry.abstract.types.DatabaseUpdateOperation<PlaylistSound.UpdateData, PlaylistSound.Parent> {}
-
-      /** Operation for {@link PlaylistSound.createDocuments | `PlaylistSound.createDocuments`} */
-      interface CreateDocumentsOperation<Temporary extends boolean | undefined>
-        extends Document.Database.CreateOperation<PlaylistSound.Database.Create<Temporary>> {}
-
-      /** Operation for {@link PlaylistSound.updateDocuments | `PlaylistSound.updateDocuments`} */
-      interface UpdateDocumentsOperation
-        extends Document.Database.UpdateDocumentsOperation<PlaylistSound.Database.Update> {}
-
-      /** Operation for {@link PlaylistSound.deleteDocuments | `PlaylistSound.deleteDocuments`} */
-      interface DeleteDocumentsOperation
-        extends Document.Database.DeleteDocumentsOperation<PlaylistSound.Database.Delete> {}
-
-      /** Operation for {@link PlaylistSound.create | `PlaylistSound.create`} */
-      interface CreateOperation<Temporary extends boolean | undefined>
-        extends Document.Database.CreateOperation<PlaylistSound.Database.Create<Temporary>> {}
-
-      /** Operation for {@link PlaylistSound.update | `PlaylistSound#update`} */
-      interface UpdateOperation extends Document.Database.UpdateOperation<Update> {}
-
-      interface DeleteOperation extends Document.Database.DeleteOperation<Delete> {}
-
-      /** Options for {@link PlaylistSound.get | `PlaylistSound.get`} */
-      interface GetOptions extends Document.Database.GetOptions {}
-
-      /** Options for {@link PlaylistSound._preCreate | `PlaylistSound#_preCreate`} */
-      interface PreCreateOptions extends Document.Database.PreCreateOptions<Create> {}
-
-      /** Options for {@link PlaylistSound._onCreate | `PlaylistSound#_onCreate`} */
-      interface OnCreateOptions extends Document.Database.CreateOptions<Create> {}
-
-      /** Operation for {@link PlaylistSound._preCreateOperation | `PlaylistSound._preCreateOperation`} */
-      interface PreCreateOperation extends Document.Database.PreCreateOperationStatic<PlaylistSound.Database.Create> {}
-
-      /** Operation for {@link PlaylistSound._onCreateOperation | `PlaylistSound#_onCreateOperation`} */
-      interface OnCreateOperation extends PlaylistSound.Database.Create {}
-
-      /** Options for {@link PlaylistSound._preUpdate | `PlaylistSound#_preUpdate`} */
-      interface PreUpdateOptions extends Document.Database.PreUpdateOptions<Update> {}
-
-      /** Options for {@link PlaylistSound._onUpdate | `PlaylistSound#_onUpdate`} */
-      interface OnUpdateOptions extends Document.Database.UpdateOptions<Update> {}
-
-      /** Operation for {@link PlaylistSound._preUpdateOperation | `PlaylistSound._preUpdateOperation`} */
-      interface PreUpdateOperation extends PlaylistSound.Database.Update {}
-
-      /** Operation for {@link PlaylistSound._onUpdateOperation | `PlaylistSound._preUpdateOperation`} */
-      interface OnUpdateOperation extends PlaylistSound.Database.Update {}
-
-      /** Options for {@link PlaylistSound._preDelete | `PlaylistSound#_preDelete`} */
-      interface PreDeleteOptions extends Document.Database.PreDeleteOperationInstance<Delete> {}
-
-      /** Options for {@link PlaylistSound._onDelete | `PlaylistSound#_onDelete`} */
-      interface OnDeleteOptions extends Document.Database.DeleteOptions<Delete> {}
-
-      /** Options for {@link PlaylistSound._preDeleteOperation | `PlaylistSound#_preDeleteOperation`} */
-      interface PreDeleteOperation extends PlaylistSound.Database.Delete {}
-
-      /** Options for {@link PlaylistSound._onDeleteOperation | `PlaylistSound#_onDeleteOperation`} */
-      interface OnDeleteOperation extends PlaylistSound.Database.Delete {}
-
-      /** Context for {@link PlaylistSound._onDeleteOperation | `PlaylistSound._onDeleteOperation`} */
-      interface OnDeleteDocumentsContext extends Document.ModificationContext<PlaylistSound.Parent> {}
-
-      /** Context for {@link PlaylistSound._onCreateDocuments | `PlaylistSound._onCreateDocuments`} */
-      interface OnCreateDocumentsContext extends Document.ModificationContext<PlaylistSound.Parent> {}
-
-      /** Context for {@link PlaylistSound._onUpdateDocuments | `PlaylistSound._onUpdateDocuments`} */
-      interface OnUpdateDocumentsContext extends Document.ModificationContext<PlaylistSound.Parent> {}
-
-      /**
-       * Options for {@link PlaylistSound._preCreateDescendantDocuments | `PlaylistSound#_preCreateDescendantDocuments`}
-       * and {@link PlaylistSound._onCreateDescendantDocuments | `PlaylistSound#_onCreateDescendantDocuments`}
-       */
-      interface CreateOptions extends Document.Database.CreateOptions<PlaylistSound.Database.Create> {}
-
-      /**
-       * Options for {@link PlaylistSound._preUpdateDescendantDocuments | `PlaylistSound#_preUpdateDescendantDocuments`}
-       * and {@link PlaylistSound._onUpdateDescendantDocuments | `PlaylistSound#_onUpdateDescendantDocuments`}
-       */
-      interface UpdateOptions extends Document.Database.UpdateOptions<PlaylistSound.Database.Update> {}
-
-      /**
-       * Options for {@link PlaylistSound._preDeleteDescendantDocuments | `PlaylistSound#_preDeleteDescendantDocuments`}
-       * and {@link PlaylistSound._onDeleteDescendantDocuments | `PlaylistSound#_onDeleteDescendantDocuments`}
-       */
-      interface DeleteOptions extends Document.Database.DeleteOptions<PlaylistSound.Database.Delete> {}
-    }
-
-    /**
-     * The flags that are available for this document in the form `{ [scope: string]: { [key: string]: unknown } }`.
-     */
-    interface Flags extends Document.ConfiguredFlagsForName<Name> {}
-
-    namespace Flags {
-      /**
-       * The valid scopes for the flags on this document e.g. `"core"` or `"dnd5e"`.
-       */
-      type Scope = Document.FlagKeyOf<Flags>;
-
-      /**
-       * The valid keys for a certain scope for example if the scope is "core" then a valid key may be `"sheetLock"` or `"viewMode"`.
-       */
-      type Key<Scope extends Flags.Scope> = Document.FlagKeyOf<Document.FlagGetKey<Flags, Scope>>;
-
-      /**
-       * Gets the type of a particular flag given a `Scope` and a `Key`.
-       */
-      type Get<Scope extends Flags.Scope, Key extends Flags.Key<Scope>> = Document.GetFlag<Name, Scope, Key>;
-    }
-
-    /**
-     * @deprecated {@link PlaylistSound.Database | `PlaylistSound.Database`}
-     */
-    // eslint-disable-next-line @typescript-eslint/no-deprecated
-    interface DatabaseOperations extends Document.Database.Operations<PlaylistSound.Implementation> {}
-
-    /**
-     * @deprecated {@link PlaylistSound.CreateData | `PlaylistSound.CreateData`}
-     */
-    interface ConstructorData extends PlaylistSound.CreateData {}
-
-    /**
-     * @deprecated {@link PlaylistSound.implementation | `PlaylistSound.ImplementationClass`}
-     */
-    type ConfiguredClass = ImplementationClass;
-
-    /**
-     * @deprecated {@link PlaylistSound.Implementation | `PlaylistSound.Implementation`}
-     */
-    type ConfiguredInstance = Implementation;
-  }
-
-  /**
-   * The client-side PlaylistSound document which extends the common BasePlaylistSound model.
-   * Each PlaylistSound belongs to the sounds collection of a Playlist document.
-   *
-   * @see {@link Playlist | `Playlist`}                       The Playlist document which contains PlaylistSound embedded documents
-   * @see {@link PlaylistSoundConfig | `PlaylistSoundConfig`}   The PlaylistSound configuration application
-   * @see {@link Sound | `Sound`}                          The Sound API which manages web audio playback
-   *
-   */
-  class PlaylistSound extends ClientDocumentMixin(foundry.documents.BasePlaylistSound) {
-    /**
-     * @param data    - Initial data from which to construct the `PlaylistSound`
-     * @param context - Construction context options
-     */
-    constructor(...args: PlaylistSound.ConstructorArgs);
-
-    /**
-     * The debounce tolerance for processing rapid volume changes into database updates in milliseconds
-     * @defaultValue `100`
-     */
-    static VOLUME_DEBOUNCE_MS: number;
-
-    /**
-     * 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;
-
-    /**
-     * Create a Sound used to play this PlaylistSound document
-     * @internal
-     */
-    protected _createSound(): Sound | null;
-
-    /**
-     * Determine the fade duration for this PlaylistSound based on its own configuration and that of its parent.
-     */
-    get fadeDuration(): number;
-
-    /**
-     * The audio context within which this sound is played.
-     * This will be undefined if the audio context is not yet active.
-     */
-    get context(): AudioContext | undefined;
-
-    /**
-     * Synchronize playback for this particular PlaylistSound instance
-     */
-    sync(): void | Promise<void> | Promise<Sound>;
-
-    /**
-     * Load the audio for this sound for the current client.
-     */
-    load(): Promise<void>;
-
-    toAnchor(
-      options?: InexactPartial<{
-        attrs: Record<string, string>;
-        dataset: Record<string, string>;
-        classes: string[];
-        name: string;
-        icon: string;
-      }>,
-    ): HTMLAnchorElement;
-
-    _onClickDocumentLink(event: MouseEvent): ReturnType<Playlist.Implementation["stopSound" | "playSound"]>;
-
-    /**
-     * @privateRemarks _onCreate, _onUpdate, and _onDelete are all overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-
-    /**
-     * Special handling that occurs when playback of a PlaylistSound is started.
-     * @internal
-     */
-    protected _onStart(): Promise<void>;
-
-    /**
-     * Special handling that occurs when a PlaylistSound reaches the natural conclusion of its playback.
-     * @internal
-     */
-    protected _onEnd(): Promise<void | Playlist.Implementation | undefined>;
-
-    /**
-     * Special handling that occurs when a PlaylistSound is manually stopped before its natural conclusion.
-     * @internal
-     */
-    protected _onStop(): Promise<void>;
-
-    /**
-     * The effective volume at which this playlist sound is played, incorporating the global playlist volume setting.
-     * @deprecated PlaylistSound#effectiveVolume is deprecated in favor of using PlaylistSound#volume directly
-     *
-     */
-    get effectiveVolume(): number;
-
-    /*
-     * After this point these are not really overridden methods.
-     * They are here because Foundry's documents are complex and have lots of edge cases.
-     * There are DRY ways of representing this but this ends up being harder to understand
-     * for end users extending these functions, especially for static methods. There are also a
-     * number of methods that don't make sense to call directly on `Document` like `createDocuments`,
-     * as there is no data that can safely construct every possible document. Finally keeping definitions
-     * separate like this helps against circularities.
-     */
-
-    // ClientDocument overrides
-
-    // Descendant Document operations have been left out because PlaylistSound does not have any descendant documents.
-
-    static override defaultName(
-      context: Document.DefaultNameContext<"base", NonNullable<PlaylistSound.Parent>>,
-    ): string;
-
-    static override createDialog(
-      data: Document.CreateDialogData<PlaylistSound.CreateData>,
-      context: Document.CreateDialogContext<string, NonNullable<PlaylistSound.Parent>>,
-    ): Promise<PlaylistSound.Stored | null | undefined>;
-
-    static override fromDropData(
-      data: Document.DropData<PlaylistSound.Implementation>,
-      options?: Document.FromDropDataOptions,
-    ): Promise<PlaylistSound.Implementation | undefined>;
-
-    static override fromImport(
-      source: PlaylistSound.Source,
-      context?: Document.FromImportContext<PlaylistSound.Parent>,
-    ): Promise<PlaylistSound.Implementation>;
-
-    // Embedded document operations have been left out because PlaylistSound does not have any embedded documents.
-  }
-}