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

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

@@ -1,4 +1,4 @@
-import type { AnyObject, AnyMutableObject } from "fvtt-types/utils";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
@@ -25,23 +25,35 @@ declare abstract class BasePlaylist extends Document<"Playlist", BasePlaylist.Sc
    */
   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;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - `flags.core.sourceId` to `_stats.compendiumSource` (since v12, no specified end)
+   */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
-  static override shimData(
-    data: AnyObject,
-    options?: {
-      /**
-       * Apply shims to embedded models?
-       * @defaultValue `true`
-       */
-      embedded?: boolean;
-    },
-  ): AnyObject;
-
   /*
    * After this point these are not really overridden methods.
    * They are here because Foundry's documents are complex and have lots of edge cases.
@@ -59,37 +71,37 @@ declare abstract class BasePlaylist extends Document<"Playlist", BasePlaylist.Sc
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: Playlist.ParentCollectionName | null;
+  override readonly parentCollection: Playlist.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): Playlist.ImplementationClass;
+  static override get implementation(): Playlist.ImplementationClass;
 
-  static get baseDocument(): typeof BasePlaylist;
+  static override get baseDocument(): typeof BasePlaylist;
 
-  static get collectionName(): Playlist.ParentCollectionName;
+  static override get collectionName(): Playlist.ParentCollectionName;
 
-  static get documentName(): Playlist.Name;
+  static override get documentName(): Playlist.Name;
 
-  static get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
+  static override get TYPES(): CONST.BASE_DOCUMENT_TYPE[];
 
-  static get hasTypeData(): undefined;
+  static override get hasTypeData(): undefined;
 
-  static get hierarchy(): Playlist.Hierarchy;
+  static override get hierarchy(): Playlist.Hierarchy;
 
   override parent: Playlist.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  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 updateDocuments(
+  static override updateDocuments(
     updates: Playlist.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Playlist.Database.Update>,
   ): Promise<Playlist.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Playlist.Database.Delete>,
   ): Promise<Playlist.Implementation[]>;
@@ -162,107 +174,146 @@ declare abstract class BasePlaylist extends Document<"Playlist", BasePlaylist.Sc
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Playlist.CreateData,
     options: Playlist.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Playlist.CreateData, options: Playlist.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(
+    data: Playlist.CreateData,
+    options: Playlist.Database.OnCreateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Playlist.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Playlist.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Playlist.Implementation[],
     operation: Playlist.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Playlist.UpdateData,
     options: Playlist.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: Playlist.UpdateData, options: Playlist.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: Playlist.UpdateData,
+    options: Playlist.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Playlist.Implementation[],
     operation: Playlist.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Playlist.Implementation[],
     operation: Playlist.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Playlist.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Playlist.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Playlist.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Playlist.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Playlist.Implementation[],
     operation: Playlist.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Playlist.Implementation[],
     operation: Playlist.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): undefined;
+  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.
-  protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
 
-  protected static _addDataFieldMigration(
-    data: AnyObject,
+  // 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: AnyObject) => unknown,
-  ): unknown;
+    apply?: ((data: AnyMutableObject) => unknown) | null,
+  ): boolean;
 
-  protected static _logDataFieldMigration(
+  // options: not null (destructured where forwarded)
+  protected static override _logDataFieldMigration(
     oldKey: string,
     newKey: string,
     options?: LogCompatibilityWarningOptions,
   ): void;
 
-  protected static _onCreateDocuments(
+  /**
+   * @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>;
 
-  protected static _onUpdateDocuments(
+  /**
+   * @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>;
 
-  protected static _onDeleteDocuments(
+  /**
+   * @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 _schema: SchemaField<Playlist.Schema>;
+  protected static override _schema: SchemaField<Playlist.Schema>;
 
-  static get schema(): SchemaField<Playlist.Schema>;
+  static override get schema(): SchemaField<Playlist.Schema>;
 
-  static validateJoint(data: Playlist.Source): void;
+  static override validateJoint(data: Playlist.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: Playlist.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): Playlist.Implementation;
 
   static override fromJSON(json: string): Playlist.Implementation;

package/src/foundry/common/documents/region-behavior.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject } from "../../../utils/index.d.mts";
+import type { AnyMutableObject } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type Document from "../abstract/document.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
@@ -58,7 +58,8 @@ declare abstract class BaseRegionBehavior<
 
   static override defineSchema(): BaseRegionBehavior.Schema;
 
-  static override canUserCreate(user: User.Internal.Implementation): boolean;
+  /** @remarks Returns `user.isGM` */
+  static override canUserCreate(user: User.Implementation): boolean;
 
   /*
    * After this point these are not really overridden methods.
@@ -77,39 +78,39 @@ declare abstract class BaseRegionBehavior<
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: RegionBehavior.ParentCollectionName | null;
+  override readonly parentCollection: RegionBehavior.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): RegionBehavior.ImplementationClass;
+  static override get implementation(): RegionBehavior.ImplementationClass;
 
-  static get baseDocument(): typeof BaseRegionBehavior;
+  static override get baseDocument(): typeof BaseRegionBehavior;
 
-  static get collectionName(): RegionBehavior.ParentCollectionName;
+  static override get collectionName(): RegionBehavior.ParentCollectionName;
 
-  static get documentName(): RegionBehavior.Name;
+  static override get documentName(): RegionBehavior.Name;
 
-  static get TYPES(): BaseRegionBehavior.SubType[];
+  static override get TYPES(): BaseRegionBehavior.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): RegionBehavior.Hierarchy;
+  static override get hierarchy(): RegionBehavior.Hierarchy;
 
   override system: RegionBehavior.SystemOfType<SubType>;
 
   override parent: BaseRegionBehavior.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<RegionBehavior.Implementation | RegionBehavior.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<RegionBehavior.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<RegionBehavior.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: RegionBehavior.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<RegionBehavior.Database.Update>,
   ): Promise<RegionBehavior.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<RegionBehavior.Database.Delete>,
   ): Promise<RegionBehavior.Implementation[]>;
@@ -152,121 +153,151 @@ declare abstract class BaseRegionBehavior<
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: RegionBehavior.CreateData,
     options: RegionBehavior.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: RegionBehavior.CreateData,
     options: RegionBehavior.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: RegionBehavior.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<RegionBehavior.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: RegionBehavior.Implementation[],
     operation: RegionBehavior.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: RegionBehavior.UpdateData,
     options: RegionBehavior.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: RegionBehavior.UpdateData,
     options: RegionBehavior.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: RegionBehavior.Implementation[],
     operation: RegionBehavior.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: RegionBehavior.Implementation[],
     operation: RegionBehavior.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: RegionBehavior.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: RegionBehavior.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: RegionBehavior.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: RegionBehavior.Implementation[],
     operation: RegionBehavior.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: RegionBehavior.Implementation[],
     operation: RegionBehavior.Database.Delete,
     user: User.Implementation,
   ): Promise<void>;
 
-  static get hasSystemData(): true;
+  static override get hasSystemData(): true;
 
   // 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.
-  protected static _addDataFieldShims(data: AnyObject, shims: AnyObject, options?: Document.DataFieldShimOptions): void;
 
-  protected static _addDataFieldMigration(
-    data: AnyObject,
+  // 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,
-    apply?: (data: AnyObject) => unknown,
-  ): unknown;
+    options?: Document.DataFieldShimOptions,
+  ): void;
 
-  protected static _logDataFieldMigration(
+  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 _onCreateDocuments(
+  /**
+   * @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: RegionBehavior.Implementation[],
     context: Document.ModificationContext<RegionBehavior.Parent>,
   ): Promise<void>;
 
-  protected static _onUpdateDocuments(
+  /**
+   * @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: RegionBehavior.Implementation[],
     context: Document.ModificationContext<RegionBehavior.Parent>,
   ): Promise<void>;
 
-  protected static _onDeleteDocuments(
+  /**
+   * @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: RegionBehavior.Implementation[],
     context: Document.ModificationContext<RegionBehavior.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<RegionBehavior.Schema>;
+  protected static override _schema: SchemaField<RegionBehavior.Schema>;
 
-  static get schema(): SchemaField<RegionBehavior.Schema>;
+  static override get schema(): SchemaField<RegionBehavior.Schema>;
 
-  static validateJoint(data: RegionBehavior.Source): void;
+  static override validateJoint(data: RegionBehavior.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: RegionBehavior.UpdateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): RegionBehavior.Implementation;
 
   static override fromJSON(json: string): RegionBehavior.Implementation;
+
+  static #BaseRegionBehavior: true;
 }
 
 export default BaseRegionBehavior;