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

package/src/foundry/common/documents/note.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";
@@ -50,9 +50,17 @@ declare abstract class BaseNote extends Document<"Note", BaseNote.Schema, any> {
    */
   static DEFAULT_ICON: string;
 
+  /**
+   * @remarks Returns `true` for GMs regardless of `options.exact`
+   *
+   * If this is an unlinked note (lacks an `entryId`), returns `user.hasPermission("NOTE_CREATE")`. Otherwise,
+   * `this.entry.testUserPermission`, or `false` if `!this.entry`. Core's `JournalEntry` implementation doesn't
+   * override this method, so without further extension that's equivalent to {@link Document.testUserPermission | `Document#testUserPermission`}
+   * */
+  // options: not null (destructured)
   override testUserPermission(
     user: User.Internal.Implementation,
-    permission: Document.TestableOwnershipLevel,
+    permission: Document.ActionPermission,
     options?: Document.TestUserPermissionOptions,
   ): boolean;
 
@@ -73,37 +81,37 @@ declare abstract class BaseNote extends Document<"Note", BaseNote.Schema, any> {
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: NoteDocument.ParentCollectionName | null;
+  override readonly parentCollection: NoteDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): NoteDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseNote;
+  static override get baseDocument(): typeof BaseNote;
 
-  static get collectionName(): NoteDocument.ParentCollectionName;
+  static override get collectionName(): NoteDocument.ParentCollectionName;
 
-  static get documentName(): NoteDocument.Name;
+  static override get documentName(): NoteDocument.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(): NoteDocument.Hierarchy;
+  static override get hierarchy(): NoteDocument.Hierarchy;
 
   override parent: NoteDocument.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<NoteDocument.Implementation | NoteDocument.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<NoteDocument.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<NoteDocument.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: NoteDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<NoteDocument.Database.Update>,
   ): Promise<NoteDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<NoteDocument.Database.Delete>,
   ): Promise<NoteDocument.Implementation[]>;
@@ -146,118 +154,146 @@ declare abstract class BaseNote extends Document<"Note", BaseNote.Schema, any> {
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: NoteDocument.CreateData,
     options: NoteDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: NoteDocument.CreateData,
     options: NoteDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: NoteDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<NoteDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: NoteDocument.Implementation[],
     operation: NoteDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: NoteDocument.UpdateData,
     options: NoteDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: NoteDocument.UpdateData,
     options: NoteDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: NoteDocument.Implementation[],
     operation: NoteDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: NoteDocument.Implementation[],
     operation: NoteDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: NoteDocument.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: NoteDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: NoteDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: NoteDocument.Implementation[],
     operation: NoteDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: NoteDocument.Implementation[],
     operation: NoteDocument.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,
-    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: NoteDocument.Implementation[],
     context: Document.ModificationContext<NoteDocument.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: NoteDocument.Implementation[],
     context: Document.ModificationContext<NoteDocument.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: NoteDocument.Implementation[],
     context: Document.ModificationContext<NoteDocument.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<NoteDocument.Schema>;
+  protected static override _schema: SchemaField<NoteDocument.Schema>;
 
-  static get schema(): SchemaField<NoteDocument.Schema>;
+  static override get schema(): SchemaField<NoteDocument.Schema>;
 
-  static validateJoint(data: NoteDocument.Source): void;
+  static override validateJoint(data: NoteDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: NoteDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): NoteDocument.Implementation;
 
   static override fromJSON(json: string): NoteDocument.Implementation;

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

@@ -1,4 +1,4 @@
-import type { AnyObject, InexactPartial } 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,20 +25,33 @@ declare abstract class BasePlaylistSound extends Document<"PlaylistSound", BaseP
    */
   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: User.Implementation,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
   ): boolean;
 
   /*
@@ -58,37 +71,37 @@ declare abstract class BasePlaylistSound extends Document<"PlaylistSound", BaseP
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: PlaylistSound.ParentCollectionName | null;
+  override readonly parentCollection: PlaylistSound.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): PlaylistSound.ImplementationClass;
+  static override get implementation(): PlaylistSound.ImplementationClass;
 
-  static get baseDocument(): typeof BasePlaylistSound;
+  static override get baseDocument(): typeof BasePlaylistSound;
 
-  static get collectionName(): PlaylistSound.ParentCollectionName;
+  static override get collectionName(): PlaylistSound.ParentCollectionName;
 
-  static get documentName(): PlaylistSound.Name;
+  static override get documentName(): PlaylistSound.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(): PlaylistSound.Hierarchy;
+  static override get hierarchy(): PlaylistSound.Hierarchy;
 
   override parent: PlaylistSound.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  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 updateDocuments(
+  static override updateDocuments(
     updates: PlaylistSound.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<PlaylistSound.Database.Update>,
   ): Promise<PlaylistSound.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<PlaylistSound.Database.Delete>,
   ): Promise<PlaylistSound.Implementation[]>;
@@ -131,118 +144,146 @@ declare abstract class BasePlaylistSound extends Document<"PlaylistSound", BaseP
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: PlaylistSound.CreateData,
     options: PlaylistSound.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: PlaylistSound.CreateData,
     options: PlaylistSound.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: PlaylistSound.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<PlaylistSound.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: PlaylistSound.Implementation[],
     operation: PlaylistSound.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: PlaylistSound.UpdateData,
     options: PlaylistSound.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: PlaylistSound.UpdateData,
     options: PlaylistSound.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: PlaylistSound.Implementation[],
     operation: PlaylistSound.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: PlaylistSound.Implementation[],
     operation: PlaylistSound.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: PlaylistSound.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: PlaylistSound.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: PlaylistSound.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: PlaylistSound.Implementation[],
     operation: PlaylistSound.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | 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,
-    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 _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: PlaylistSound.Implementation[],
     operation: PlaylistSound.Database.Delete,
     user: User.Implementation,
   ): Promise<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: PlaylistSound.Implementation[],
     context: Document.ModificationContext<PlaylistSound.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: PlaylistSound.Implementation[],
     context: Document.ModificationContext<PlaylistSound.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: PlaylistSound.Implementation[],
     context: Document.ModificationContext<PlaylistSound.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<PlaylistSound.Schema>;
+  protected static override _schema: SchemaField<PlaylistSound.Schema>;
 
-  static get schema(): SchemaField<PlaylistSound.Schema>;
+  static override get schema(): SchemaField<PlaylistSound.Schema>;
 
-  static validateJoint(data: PlaylistSound.Source): void;
+  static override validateJoint(data: PlaylistSound.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: PlaylistSound.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): PlaylistSound.Implementation;
 
   static override fromJSON(json: string): PlaylistSound.Implementation;