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

package/src/foundry/common/documents/ambient-sound.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";
@@ -56,37 +56,37 @@ declare abstract class BaseAmbientSound extends Document<"AmbientSound", BaseAmb
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: AmbientSoundDocument.ParentCollectionName | null;
+  override readonly parentCollection: AmbientSoundDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): AmbientSoundDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseAmbientSound;
+  static override get baseDocument(): typeof BaseAmbientSound;
 
-  static get collectionName(): AmbientSoundDocument.ParentCollectionName;
+  static override get collectionName(): AmbientSoundDocument.ParentCollectionName;
 
-  static get documentName(): AmbientSoundDocument.Name;
+  static override get documentName(): AmbientSoundDocument.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(): AmbientSoundDocument.Hierarchy;
+  static override get hierarchy(): AmbientSoundDocument.Hierarchy;
 
   override parent: BaseAmbientSound.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<AmbientSoundDocument.Implementation | AmbientSoundDocument.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<AmbientSoundDocument.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<AmbientSoundDocument.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: AmbientSoundDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<AmbientSoundDocument.Database.Update>,
   ): Promise<AmbientSoundDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<AmbientSoundDocument.Database.Delete>,
   ): Promise<AmbientSoundDocument.Implementation[]>;
@@ -129,118 +129,146 @@ declare abstract class BaseAmbientSound extends Document<"AmbientSound", BaseAmb
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  override _preCreate(
     data: AmbientSoundDocument.CreateData,
     options: AmbientSoundDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: AmbientSoundDocument.CreateData,
     options: AmbientSoundDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: AmbientSoundDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<AmbientSoundDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: AmbientSoundDocument.Implementation[],
     operation: AmbientSoundDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: AmbientSoundDocument.UpdateData,
     options: AmbientSoundDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: AmbientSoundDocument.UpdateData,
     options: AmbientSoundDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: AmbientSoundDocument.Implementation[],
     operation: AmbientSoundDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: AmbientSoundDocument.Implementation[],
     operation: AmbientSoundDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: AmbientSoundDocument.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: AmbientSoundDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: AmbientSoundDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: AmbientSoundDocument.Implementation[],
     operation: AmbientSoundDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: AmbientSoundDocument.Implementation[],
     operation: AmbientSoundDocument.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: AmbientSoundDocument.Implementation[],
     context: Document.ModificationContext<AmbientSoundDocument.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: AmbientSoundDocument.Implementation[],
     context: Document.ModificationContext<AmbientSoundDocument.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: AmbientSoundDocument.Implementation[],
     context: Document.ModificationContext<AmbientSoundDocument.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<AmbientSoundDocument.Schema>;
+  protected static override _schema: SchemaField<AmbientSoundDocument.Schema>;
 
-  static get schema(): SchemaField<AmbientSoundDocument.Schema>;
+  static override get schema(): SchemaField<AmbientSoundDocument.Schema>;
 
-  static validateJoint(data: AmbientSoundDocument.Source): void;
+  static override validateJoint(data: AmbientSoundDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: AmbientSoundDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): AmbientSoundDocument.Implementation;
 
   static override fromJSON(json: string): AmbientSoundDocument.Implementation;

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

@@ -1,7 +1,6 @@
-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 * as CONST from "../constants.mts";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.d.mts";
 
@@ -30,6 +29,25 @@ declare abstract class BaseCard<out SubType extends BaseCard.SubType = BaseCard.
    */
   constructor(...args: Card.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "Card",
+   *   collection: "cards",
+   *   hasTypeData: true,
+   *   indexed: true,
+   *   label: "DOCUMENT.Card",
+   *   labelPlural: "DOCUMENT.Cards",
+   *   permissions: {
+   *     create: this.#canCreate,
+   *     update: this.#canUpdate
+   *   },
+   *   compendiumIndexFields: ["name", "type", "suit", "sort"],
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseCard.Metadata;
 
   static override defineSchema(): BaseCard.Schema;
@@ -41,25 +59,14 @@ declare abstract class BaseCard<out SubType extends BaseCard.SubType = BaseCard.
   static DEFAULT_ICON: string;
 
   /**
-   * Is a User able to create a new Card within this parent?
-   */
-  static #canCreate(user: User.Implementation, doc: BaseCard, data: BaseCard.CreateData): boolean;
-
-  /**
-   * Is a user able to update an existing Card?
+   * @remarks If `this.isEmbedded`, uses `this.parent.testUserPermission`, otherwise `super`'s. Core's `Cards` implementation
+   * doesn't override this method, so without further extension those are both {@link Document.testUserPermission | `Document#testUserPermission`}
    */
-  static #canUpdate(user: User.Implementation, doc: BaseCard, data: BaseCard.UpdateData): boolean;
-
+  // options: not null (destructured)
   override testUserPermission(
     user: User.Implementation,
-    permission: keyof typeof CONST.DOCUMENT_OWNERSHIP_LEVELS | CONST.DOCUMENT_OWNERSHIP_LEVELS,
-    options?: InexactPartial<{
-      /**
-       * Require the exact permission level requested?
-       * @defaultValue `false`
-       */
-      exact: boolean;
-    }>,
+    permission: Document.ActionPermission,
+    options?: Document.TestUserPermissionOptions,
   ): boolean;
 
   /*
@@ -79,39 +86,39 @@ declare abstract class BaseCard<out SubType extends BaseCard.SubType = BaseCard.
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: Card.ParentCollectionName | null;
+  override readonly parentCollection: Card.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
-  static get implementation(): Card.ImplementationClass;
+  static override get implementation(): Card.ImplementationClass;
 
-  static get baseDocument(): typeof BaseCard;
+  static override get baseDocument(): typeof BaseCard;
 
-  static get collectionName(): Card.ParentCollectionName;
+  static override get collectionName(): Card.ParentCollectionName;
 
-  static get documentName(): Card.Name;
+  static override get documentName(): Card.Name;
 
-  static get TYPES(): BaseCard.SubType[];
+  static override get TYPES(): BaseCard.SubType[];
 
-  static get hasTypeData(): true;
+  static override get hasTypeData(): true;
 
-  static get hierarchy(): Card.Hierarchy;
+  static override get hierarchy(): Card.Hierarchy;
 
   override system: Card.SystemOfType<SubType>;
 
   override parent: BaseCard.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<Card.Implementation | Card.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<Card.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<Card.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: Card.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<Card.Database.Update>,
   ): Promise<Card.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<Card.Database.Delete>,
   ): Promise<Card.Implementation[]>;
@@ -151,110 +158,144 @@ declare abstract class BaseCard<out SubType extends BaseCard.SubType = BaseCard.
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: Card.CreateData,
     options: Card.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(data: Card.CreateData, options: Card.Database.OnCreateOperation, userId: string): void;
+  protected override _onCreate(data: Card.CreateData, options: Card.Database.OnCreateOperation, userId: string): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: Card.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<Card.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: Card.Implementation[],
     operation: Card.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: Card.UpdateData,
     options: Card.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(changed: Card.UpdateData, options: Card.Database.OnUpdateOperation, userId: string): void;
+  protected override _onUpdate(
+    changed: Card.UpdateData,
+    options: Card.Database.OnUpdateOperation,
+    userId: string,
+  ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: Card.Implementation[],
     operation: Card.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: Card.Implementation[],
     operation: Card.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(options: Card.Database.PreDeleteOptions, user: User.Implementation): Promise<boolean | void>;
+  protected override _preDelete(
+    options: Card.Database.PreDeleteOptions,
+    user: User.Implementation,
+  ): Promise<boolean | void>;
 
-  protected _onDelete(options: Card.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: Card.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: Card.Implementation[],
     operation: Card.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: Card.Implementation[],
     operation: Card.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 override _addDataFieldMigration(
+    data: AnyMutableObject,
+    oldKey: string,
+    newKey: string,
+    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: Card.Implementation[],
     context: Document.ModificationContext<Card.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: Card.Implementation[],
     context: Document.ModificationContext<Card.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: Card.Implementation[],
     context: Document.ModificationContext<Card.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<Card.Schema>;
+  protected static override _schema: SchemaField<Card.Schema>;
 
-  static get schema(): SchemaField<Card.Schema>;
+  static override get schema(): SchemaField<Card.Schema>;
 
-  static validateJoint(data: Card.Source): void;
+  static override validateJoint(data: Card.Source): void;
 
-  static override fromSource(
-    source: Card.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
-  ): Card.Implementation;
+  // options: not null (parameter default only, destructured in super)
+  static override fromSource(source: Card.CreateData, context?: DataModel.FromSourceOptions): Card.Implementation;
 
   static override fromJSON(json: string): Card.Implementation;
+
+  static #BaseCard: true;
 }
 
 export default BaseCard;