@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5

package/src/foundry/common/documents/playlist-sound.d.mts

@@ -1,6 +1,8 @@
-import type { InexactPartial } from "../../../types/utils.mts";
+import type { AnyMutableObject } from "#utils";
+import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
-import type * as fields from "../data/fields.d.mts";
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The PlaylistSound Document.
@@ -9,119 +11,324 @@ import type * as fields from "../data/fields.d.mts";
 // Note(LukeAbby): You may wonder why documents don't simply pass the `Parent` generic parameter.
 // This pattern evolved from trying to avoid circular loops and even internal tsc errors.
 // See: https://gist.github.com/LukeAbby/0d01b6e20ef19ebc304d7d18cef9cc21
-declare class BasePlaylistSound extends Document<"PlaylistSound", BasePlaylistSound.Schema, any> {
+declare abstract class BasePlaylistSound extends Document<"PlaylistSound", BasePlaylistSound.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the PlaylistSound
+   * @param data    - Initial data from which to construct the `BasePlaylistSound`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BasePlaylistSound` directly is not advised. The base document classes exist in
+   * order to use documents on both the client (i.e. where all your code runs) and behind the scenes
+   * on the server to manage document validation and storage.
+   *
+   * You should use {@link PlaylistSound.implementation | `new PlaylistSound.implementation(...)`} instead which will give you
+   * a system specific implementation of `PlaylistSound`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(
-  //   data: BasePlaylistSound.ConstructorData,
-  //   context?: Document.ConstructionContext<BasePlaylistSound.Parent>,
-  // );
-
-  override parent: BasePlaylistSound.Parent;
+  constructor(...args: PlaylistSound.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "PlaylistSound",
+   *   collection: "sounds",
+   *   indexed: true,
+   *   label: "DOCUMENT.PlaylistSound",
+   *   labelPlural: "DOCUMENT.PlaylistSounds",
+   *   compendiumIndexFields: ["name", "sort"],
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BasePlaylistSound.Metadata;
 
   static override defineSchema(): BasePlaylistSound.Schema;
 
+  /**
+   * @remarks If `this.isEmbedded`, uses `this.parent.testUserPermission`, otherwise `super`'s. Core's `Playlist` implementation
+   * doesn't override this method, so without further extension those are both {@link Document.testUserPermission | `Document#testUserPermission`}
+   */
+  // options: not null (destructured)
   override testUserPermission(
-    user: foundry.documents.BaseUser,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    user: User.Implementation,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
   ): boolean;
+
+  /*
+   * 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.
+   */
+
+  /* Document overrides */
+
+  static " fvtt_types_internal_document_name_static": "PlaylistSound";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: PlaylistSound.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): PlaylistSound.ImplementationClass;
+
+  static override get baseDocument(): typeof BasePlaylistSound;
+
+  static override get collectionName(): PlaylistSound.ParentCollectionName;
+
+  static override get documentName(): PlaylistSound.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): PlaylistSound.Hierarchy;
+
+  override parent: PlaylistSound.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<PlaylistSound.Implementation | PlaylistSound.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<PlaylistSound.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<PlaylistSound.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: PlaylistSound.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<PlaylistSound.Database.Update>,
+  ): Promise<PlaylistSound.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<PlaylistSound.Database.Delete>,
+  ): Promise<PlaylistSound.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: PlaylistSound.CreateData | PlaylistSound.CreateData[],
+    operation?: PlaylistSound.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<PlaylistSound.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: PlaylistSound.UpdateData | undefined,
+    operation?: PlaylistSound.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: PlaylistSound.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(
+    documentId: string,
+    options?: PlaylistSound.Database.GetOptions,
+  ): PlaylistSound.Implementation | null;
+
+  static override getCollectionName(name: string): null;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  override getFlag<Scope extends PlaylistSound.Flags.Scope, Key extends PlaylistSound.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<PlaylistSound.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends PlaylistSound.Flags.Scope,
+    Key extends PlaylistSound.Flags.Key<Scope>,
+    Value extends Document.GetFlag<PlaylistSound.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends PlaylistSound.Flags.Scope, Key extends PlaylistSound.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: PlaylistSound.CreateData,
+    options: PlaylistSound.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: PlaylistSound.CreateData,
+    options: PlaylistSound.Database.OnCreateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: PlaylistSound.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<PlaylistSound.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: PlaylistSound.Implementation[],
+    operation: PlaylistSound.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: PlaylistSound.UpdateData,
+    options: PlaylistSound.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: PlaylistSound.UpdateData,
+    options: PlaylistSound.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: PlaylistSound.Implementation[],
+    operation: PlaylistSound.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: PlaylistSound.Implementation[],
+    operation: PlaylistSound.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: PlaylistSound.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: PlaylistSound.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: PlaylistSound.Implementation[],
+    operation: PlaylistSound.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  static override get hasSystemData(): undefined;
+
+  // These data field things have been ticketed but will probably go into backlog hell for a while.
+  // We'll end up copy and pasting without modification for now I think. It makes it a tiny bit easier to update though.
+
+  // options: not null (parameter default only in _addDataFieldShim)
+  protected static override _addDataFieldShims(
+    data: AnyMutableObject,
+    shims: Record<string, string>,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  // options: not null (parameter default only)
+  protected static override _addDataFieldShim(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    options?: Document.DataFieldShimOptions,
+  ): void;
+
+  protected static override _addDataFieldMigration(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    apply?: ((data: AnyMutableObject) => unknown) | null,
+  ): boolean;
+
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
+    oldKey: string,
+    newKey: string,
+    options?: LogCompatibilityWarningOptions,
+  ): void;
+
+  protected static override _onDeleteOperation(
+    documents: PlaylistSound.Implementation[],
+    operation: PlaylistSound.Database.Delete,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onCreateDocuments` static method is deprecated in favor of {@link Document._onCreateOperation | `Document._onCreateOperation`}"
+   */
+  protected static override _onCreateDocuments(
+    documents: PlaylistSound.Implementation[],
+    context: Document.ModificationContext<PlaylistSound.Parent>,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onUpdateDocuments` static method is deprecated in favor of {@link Document._onUpdateOperation | `Document._onUpdateOperation`}"
+   */
+  protected static override _onUpdateDocuments(
+    documents: PlaylistSound.Implementation[],
+    context: Document.ModificationContext<PlaylistSound.Parent>,
+  ): Promise<void>;
+
+  /**
+   * @deprecated since v12, will be removed in v14
+   * @remarks "The `Document._onDeleteDocuments` static method is deprecated in favor of {@link Document._onDeleteOperation | `Document._onDeleteOperation`}"
+   */
+  protected static override _onDeleteDocuments(
+    documents: PlaylistSound.Implementation[],
+    context: Document.ModificationContext<PlaylistSound.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<PlaylistSound.Schema>;
+
+  static override get schema(): SchemaField<PlaylistSound.Schema>;
+
+  static override validateJoint(data: PlaylistSound.Source): void;
+
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(
+    source: PlaylistSound.CreateData,
+    context?: DataModel.FromSourceOptions,
+  ): PlaylistSound.Implementation;
+
+  static override fromJSON(json: string): PlaylistSound.Implementation;
 }
 
 export default BasePlaylistSound;
 
 declare namespace BasePlaylistSound {
-  type Parent = Playlist.ConfiguredInstance | null;
-
-  type Metadata = Document.MetadataFor<BasePlaylistSound>;
-
-  type SchemaField = fields.SchemaField<Schema>;
-  type ConstructorData = fields.SchemaField.InnerConstructorType<Schema>;
-  type UpdateData = fields.SchemaField.InnerAssignmentType<Schema>;
-  type Properties = fields.SchemaField.InnerInitializedType<Schema>;
-  type Source = fields.SchemaField.InnerPersistedType<Schema>;
-
-  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<"PlaylistSound">;
-  }
+  export import Name = PlaylistSound.Name;
+  export import ConstructorArgs = PlaylistSound.ConstructorArgs;
+  export import Hierarchy = PlaylistSound.Hierarchy;
+  export import Metadata = PlaylistSound.Metadata;
+  export import Parent = PlaylistSound.Parent;
+  export import Descendant = PlaylistSound.Descendant;
+  export import DescendantClass = PlaylistSound.DescendantClass;
+  export import Pack = PlaylistSound.Pack;
+  export import Embedded = PlaylistSound.Embedded;
+  export import ParentCollectionName = PlaylistSound.ParentCollectionName;
+  export import CollectionClass = PlaylistSound.CollectionClass;
+  export import Collection = PlaylistSound.Collection;
+  export import Invalid = PlaylistSound.Invalid;
+  export import Stored = PlaylistSound.Stored;
+  export import Source = PlaylistSound.Source;
+  export import PersistedData = PlaylistSound.Source;
+  export import CreateData = PlaylistSound.CreateData;
+  export import InitializedData = PlaylistSound.InitializedData;
+  export import UpdateData = PlaylistSound.UpdateData;
+  export import Schema = PlaylistSound.Schema;
+  export import DatabaseOperation = PlaylistSound.Database;
+  export import Flags = PlaylistSound.Flags;
+
+  /**
+   * @deprecated This type is used by Foundry too vaguely.
+   * In one context the most correct type is after initialization whereas in another one it should be
+   * before but Foundry uses it interchangeably.
+   */
+  type Properties = SchemaField.InitializedData<Schema>;
+
+  /**
+   * @deprecated {@link foundry.data.fields.SchemaField | `SchemaField<BasePlaylistSound.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BasePlaylistSound.CreateData | `BasePlaylistSound.CreateData`}
+   */
+  type ConstructorData = BasePlaylistSound.CreateData;
 }