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

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

@@ -1,7 +1,8 @@
-import type { AnyObject } 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 * as documents from "./_module.mts";
+import type { DataField, SchemaField } from "../data/fields.d.mts";
+import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
 /**
  * The Playlist Document.
@@ -10,145 +11,354 @@ import type * as documents from "./_module.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 BasePlaylist extends Document<"Playlist", BasePlaylist.Schema, any> {
+declare abstract class BasePlaylist extends Document<"Playlist", BasePlaylist.Schema, any> {
   /**
-   * @param data    - Initial data from which to construct the Playlist
+   * @param data    - Initial data from which to construct the `BasePlaylist`
    * @param context - Construction context options
+   *
+   * @deprecated Constructing `BasePlaylist` 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 Playlist.implementation | `new Playlist.implementation(...)`} instead which will give you
+   * a system specific implementation of `Playlist`.
    */
-  // TODO(LukeAbby): This constructor is a symptom of a circular error.
-  // constructor(data: BasePlaylist.ConstructorData, context?: Document.ConstructionContext<BasePlaylist.Parent>);
-
-  override parent: BasePlaylist.Parent;
+  constructor(...args: Playlist.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Playlist",
+   *   collection: "playlists",
+   *   indexed: true,
+   *   compendiumIndexFields: ["_id", "name", "description", "sort", "folder"],
+   *   embedded: {PlaylistSound: "sounds"},
+   *   label: "DOCUMENT.Playlist",
+   *   labelPlural: "DOCUMENT.Playlists",
+   *   permissions: {
+   *     create: "PLAYLIST_CREATE"
+   *   },
+   *   schemaVersion: "12.324"
+   * }
+   * ```
+   */
   static override metadata: BasePlaylist.Metadata;
 
   static override defineSchema(): BasePlaylist.Schema;
 
-  static override migrateData(source: AnyObject): AnyObject;
-
-  static override shimData(
-    data: AnyObject,
-    options?: {
-      /**
-       * Apply shims to embedded models?
-       * @defaultValue `true`
-       */
-      embedded?: boolean;
-    },
-  ): AnyObject;
+  /**
+   * @remarks
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
+   */
+  static override migrateData(source: AnyMutableObject): AnyMutableObject;
+
+  /*
+   * 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": "Playlist";
+
+  // Same as Document for now
+  protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
+
+  override readonly parentCollection: Playlist.ParentCollectionName | null;
+
+  override readonly pack: string | null;
+
+  static override get implementation(): Playlist.ImplementationClass;
+
+  static override get baseDocument(): typeof BasePlaylist;
+
+  static override get collectionName(): Playlist.ParentCollectionName;
+
+  static override get documentName(): Playlist.Name;
+
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+
+  static override get hasTypeData(): undefined;
+
+  static override get hierarchy(): Playlist.Hierarchy;
+
+  override parent: Playlist.Parent;
+
+  static override createDocuments<Temporary extends boolean | undefined = false>(
+    data: Array<Playlist.Implementation | Playlist.CreateData> | undefined,
+    operation?: Document.Database.CreateOperation<Playlist.Database.Create<Temporary>>,
+  ): Promise<Array<Document.TemporaryIf<Playlist.Implementation, Temporary>>>;
+
+  static override updateDocuments(
+    updates: Playlist.UpdateData[] | undefined,
+    operation?: Document.Database.UpdateDocumentsOperation<Playlist.Database.Update>,
+  ): Promise<Playlist.Implementation[]>;
+
+  static override deleteDocuments(
+    ids: readonly string[] | undefined,
+    operation?: Document.Database.DeleteDocumentsOperation<Playlist.Database.Delete>,
+  ): Promise<Playlist.Implementation[]>;
+
+  static override create<Temporary extends boolean | undefined = false>(
+    data: Playlist.CreateData | Playlist.CreateData[],
+    operation?: Playlist.Database.CreateOperation<Temporary>,
+  ): Promise<Document.TemporaryIf<Playlist.Implementation, Temporary> | undefined>;
+
+  override update(
+    data: Playlist.UpdateData | undefined,
+    operation?: Playlist.Database.UpdateOperation,
+  ): Promise<this | undefined>;
+
+  override delete(operation?: Playlist.Database.DeleteOperation): Promise<this | undefined>;
+
+  static override get(documentId: string, options?: Playlist.Database.GetOptions): Playlist.Implementation | null;
+
+  static override getCollectionName<CollectionName extends Playlist.Embedded.Name>(
+    name: CollectionName,
+  ): Playlist.Embedded.CollectionNameOf<CollectionName> | null;
+
+  override getEmbeddedCollection<EmbeddedName extends Playlist.Embedded.CollectionName>(
+    embeddedName: EmbeddedName,
+  ): Playlist.Embedded.CollectionFor<EmbeddedName>;
+
+  override getEmbeddedDocument<EmbeddedName extends Playlist.Embedded.CollectionName>(
+    embeddedName: EmbeddedName,
+    id: string,
+    options: Document.GetEmbeddedDocumentOptions,
+  ): Playlist.Embedded.DocumentFor<EmbeddedName> | undefined;
+
+  override createEmbeddedDocuments<EmbeddedName extends Playlist.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    data: Document.CreateDataForName<EmbeddedName>[] | undefined,
+    // TODO(LukeAbby): The correct signature would be:
+    // operation?: Document.Database.CreateOperation<Document.Database.CreateForName<EmbeddedName>>,
+    // However this causes a number of errors.
+    operation?: object,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+
+  override updateEmbeddedDocuments<EmbeddedName extends Playlist.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    updates: Document.UpdateDataForName<EmbeddedName>[] | undefined,
+    operation?: Document.Database.UpdateOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>> | undefined>;
+
+  override deleteEmbeddedDocuments<EmbeddedName extends Playlist.Embedded.Name>(
+    embeddedName: EmbeddedName,
+    ids: Array<string>,
+    operation?: Document.Database.DeleteOperationForName<EmbeddedName>,
+  ): Promise<Array<Document.Stored<Document.ImplementationFor<EmbeddedName>>>>;
+
+  // Same as Document for now
+  override traverseEmbeddedDocuments(_parentPath?: string): Generator<[string, Document.AnyChild<this>]>;
+
+  override getFlag<Scope extends Playlist.Flags.Scope, Key extends Playlist.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Document.GetFlag<Playlist.Name, Scope, Key>;
+
+  override setFlag<
+    Scope extends Playlist.Flags.Scope,
+    Key extends Playlist.Flags.Key<Scope>,
+    Value extends Document.GetFlag<Playlist.Name, Scope, Key>,
+  >(scope: Scope, key: Key, value: Value): Promise<this>;
+
+  override unsetFlag<Scope extends Playlist.Flags.Scope, Key extends Playlist.Flags.Key<Scope>>(
+    scope: Scope,
+    key: Key,
+  ): Promise<this>;
+
+  protected override _preCreate(
+    data: Playlist.CreateData,
+    options: Playlist.Database.PreCreateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onCreate(
+    data: Playlist.CreateData,
+    options: Playlist.Database.OnCreateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preCreateOperation(
+    documents: Playlist.Implementation[],
+    operation: Document.Database.PreCreateOperationStatic<Playlist.Database.Create>,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onCreateOperation(
+    documents: Playlist.Implementation[],
+    operation: Playlist.Database.Create,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preUpdate(
+    changed: Playlist.UpdateData,
+    options: Playlist.Database.PreUpdateOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onUpdate(
+    changed: Playlist.UpdateData,
+    options: Playlist.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
+
+  protected static override _preUpdateOperation(
+    documents: Playlist.Implementation[],
+    operation: Playlist.Database.Update,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onUpdateOperation(
+    documents: Playlist.Implementation[],
+    operation: Playlist.Database.Update,
+    user: User.Implementation,
+  ): Promise<void>;
+
+  protected override _preDelete(
+    options: Playlist.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected override _onDelete(options: Playlist.Database.OnDeleteOperation, userId: string): void;
+
+  protected static override _preDeleteOperation(
+    documents: Playlist.Implementation[],
+    operation: Playlist.Database.Delete,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
+
+  protected static override _onDeleteOperation(
+    documents: Playlist.Implementation[],
+    operation: Playlist.Database.Delete,
+    user: User.Implementation,
+  ): Promise<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;
+
+  /**
+   * @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: Playlist.Implementation[],
+    context: Document.ModificationContext<Playlist.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: Playlist.Implementation[],
+    context: Document.ModificationContext<Playlist.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: Playlist.Implementation[],
+    context: Document.ModificationContext<Playlist.Parent>,
+  ): Promise<void>;
+
+  /* DataModel overrides */
+
+  protected static override _schema: SchemaField<Playlist.Schema>;
+
+  static override get schema(): SchemaField<Playlist.Schema>;
+
+  static override validateJoint(data: Playlist.Source): void;
+
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(
+    source: Playlist.CreateData,
+    context?: DataModel.FromSourceOptions,
+  ): Playlist.Implementation;
+
+  static override fromJSON(json: string): Playlist.Implementation;
 }
 
 export default BasePlaylist;
 
 declare namespace BasePlaylist {
-  type Parent = null;
-
-  type Metadata = Document.MetadataFor<BasePlaylist>;
-
-  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 Playlist document
-     * @defaultValue `null`
-     */
-    _id: fields.DocumentIdField;
-
-    /**
-     * The name of this playlist
-     */
-    name: fields.StringField<{ required: true; blank: false; textSearch: true }>;
-
-    /**
-     * The description of this playlist
-     * @defaultValue `""`
-     */
-    description: fields.StringField<{ textSearch: true }>;
-
-    /**
-     * A Collection of PlaylistSounds embedded documents which belong to this playlist
-     * @defaultValue `[]`
-     */
-    sounds: fields.EmbeddedCollectionField<typeof documents.BasePlaylistSound, Playlist.ConfiguredInstance>;
-
-    /**
-     * A channel in CONST.AUDIO_CHANNELS where all sounds in this playlist are played
-     * @defaultValue `"music"`
-     */
-    channel: fields.StringField<{ choices: typeof foundry.CONST.AUDIO_CHANNELS; initial: string; blank: false }>;
-
-    /**
-     * The playback mode for sounds in this playlist
-     * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
-     */
-    mode: fields.NumberField<{
-      required: true;
-      choices: foundry.CONST.PLAYLIST_MODES[];
-      initial: typeof CONST.PLAYLIST_MODES.SEQUENTIAL;
-      validationError: "must be a value in CONST.PLAYLIST_MODES";
-    }>;
-
-    /**
-     * Is this playlist currently playing?
-     * @defaultValue `false`
-     */
-    playing: fields.BooleanField;
-
-    /**
-     * A duration in milliseconds to fade volume transition
-     * @defaultValue `null`
-     */
-    fade: fields.NumberField<{ positive: true }>;
-
-    /**
-     * The _id of a Folder which contains this playlist
-     * @defaultValue `null`
-     */
-    folder: fields.ForeignDocumentField<typeof documents.BaseFolder>;
-
-    /**
-     * The sorting mode used for this playlist.
-     * @defaultValue `CONST.PLAYLIST_SORT_MODES.ALPHABETICAL`
-     */
-    sorting: fields.StringField<{
-      required: true;
-      choices: foundry.CONST.PLAYLIST_SORT_MODES[];
-      initial: typeof CONST.PLAYLIST_SORT_MODES.ALPHABETICAL;
-      validationError: "must be a value in CONST.PLAYLIST_SORTING_MODES";
-    }>;
-
-    /**
-     * A seed used for playlist randomization to guarantee that all clients generate the same random order.
-     * @defaultValue `null`
-     */
-    seed: fields.NumberField<{ integer: true; min: 0 }>;
-
-    /**
-     * The numeric sort value which orders this playlist relative to its siblings
-     * @defaultValue `0`
-     */
-    sort: fields.IntegerSortField;
-
-    /**
-     * An object which configures ownership of this Playlist
-     * @defaultValue see {@link fields.DocumentOwnershipField}
-     */
-    ownership: fields.DocumentOwnershipField;
-
-    /**
-     * An object of optional key/value flags
-     * @defaultValue `{}`
-     */
-    flags: fields.ObjectField.FlagsField<"Playlist">;
-
-    /**
-     * An object of creation and access information
-     * @defaultValue see {@link fields.DocumentStatsField}
-     */
-    _stats: fields.DocumentStatsField;
-  }
+  export import Name = Playlist.Name;
+  export import ConstructorArgs = Playlist.ConstructorArgs;
+  export import Hierarchy = Playlist.Hierarchy;
+  export import Metadata = Playlist.Metadata;
+  export import Parent = Playlist.Parent;
+  export import Descendant = Playlist.Descendant;
+  export import DescendantClass = Playlist.DescendantClass;
+  export import Pack = Playlist.Pack;
+  export import Embedded = Playlist.Embedded;
+  export import ParentCollectionName = Playlist.ParentCollectionName;
+  export import CollectionClass = Playlist.CollectionClass;
+  export import Collection = Playlist.Collection;
+  export import Invalid = Playlist.Invalid;
+  export import Stored = Playlist.Stored;
+  export import Source = Playlist.Source;
+  export import PersistedData = Playlist.Source;
+  export import CreateData = Playlist.CreateData;
+  export import InitializedData = Playlist.InitializedData;
+  export import UpdateData = Playlist.UpdateData;
+  export import Schema = Playlist.Schema;
+  export import DatabaseOperation = Playlist.Database;
+  export import Flags = Playlist.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<BasePlaylist.Schema>`}
+   */
+  type SchemaField = foundry.data.fields.SchemaField<Schema>;
+
+  /**
+   * @deprecated {@link BasePlaylist.CreateData | `BasePlaylist.CreateData`}
+   */
+  type ConstructorData = BasePlaylist.CreateData;
 }