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

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

@@ -1,4 +1,4 @@
-import type { AnyMutableObject, AnyObject } 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";
@@ -46,28 +46,41 @@ declare abstract class BaseDrawing extends Document<"Drawing", BaseDrawing.Schem
 
   static override defineSchema(): BaseDrawing.Schema;
 
-  static override canUserCreate(user: User.Internal.Implementation): boolean;
+  /** @remarks Returns `user.hasPermission("DRAWING_CREATE")` */
+  static override canUserCreate(user: User.Implementation): boolean;
 
+  /**
+   * @remarks Returns `true` if `user` is the `author` of the `Drawing` and `options.exact` is falsey.
+   * Otherwise, forwards to {@link Document.testUserPermission | `Document#testUserPermission`}
+   */
   // options: not null (destructured)
   override testUserPermission(
-    user: User.Internal.Implementation,
-    permission: Document.TestableOwnershipLevel,
+    user: User.Implementation,
+    permission: Document.ActionPermission,
     options?: Document.TestUserPermissionOptions,
   ): boolean;
 
   /**
-   * @remarks Migrates:
-   * - `z` to `elevation`
+   * @remarks
+   * Migrations:
+   * - `z` to `elevation` (since v12, no specified end)
    */
   static override migrateData(source: AnyMutableObject): AnyMutableObject;
 
   /**
-   * @remarks Shims:
-   * - `z` to `elevation` since v12, until v14
+   * @remarks
+   * Shims:
+   * - `z` to `elevation` (since v12, until v14)
    */
   // options: not null (destructured)
   static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 
+  /**
+   * @remarks
+   * @throws If `data` fails `BaseDrawing.#validateVisibleContent` validation (must have some visible text, fill, *or* line)
+   */
+  static override validateJoint(data: DrawingDocument.Source): void;
+
   /**
    * @deprecated since v12, until v14
    * @remarks "You are accessing `z` which has been migrated to `elevation`"
@@ -85,37 +98,37 @@ declare abstract class BaseDrawing extends Document<"Drawing", BaseDrawing.Schem
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: DrawingDocument.ParentCollectionName | null;
+  override readonly parentCollection: DrawingDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): DrawingDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseDrawing;
+  static override get baseDocument(): typeof BaseDrawing;
 
-  static get collectionName(): DrawingDocument.ParentCollectionName;
+  static override get collectionName(): DrawingDocument.ParentCollectionName;
 
-  static get documentName(): DrawingDocument.Name;
+  static override get documentName(): DrawingDocument.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(): DrawingDocument.Hierarchy;
+  static override get hierarchy(): DrawingDocument.Hierarchy;
 
   override parent: DrawingDocument.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<DrawingDocument.Implementation | DrawingDocument.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<DrawingDocument.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<DrawingDocument.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: DrawingDocument.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<DrawingDocument.Database.Update>,
   ): Promise<DrawingDocument.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<DrawingDocument.Database.Delete>,
   ): Promise<DrawingDocument.Implementation[]>;
@@ -158,121 +171,149 @@ declare abstract class BaseDrawing extends Document<"Drawing", BaseDrawing.Schem
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: DrawingDocument.CreateData,
     options: DrawingDocument.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: DrawingDocument.CreateData,
     options: DrawingDocument.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: DrawingDocument.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<DrawingDocument.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: DrawingDocument.Implementation[],
     operation: DrawingDocument.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: DrawingDocument.UpdateData,
     options: DrawingDocument.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: DrawingDocument.UpdateData,
     options: DrawingDocument.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: DrawingDocument.Implementation[],
     operation: DrawingDocument.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: DrawingDocument.Implementation[],
     operation: DrawingDocument.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: DrawingDocument.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: DrawingDocument.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: DrawingDocument.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: DrawingDocument.Implementation[],
     operation: DrawingDocument.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: DrawingDocument.Implementation[],
     operation: DrawingDocument.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: DrawingDocument.Implementation[],
     context: Document.ModificationContext<DrawingDocument.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: DrawingDocument.Implementation[],
     context: Document.ModificationContext<DrawingDocument.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: DrawingDocument.Implementation[],
     context: Document.ModificationContext<DrawingDocument.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<DrawingDocument.Schema>;
+  protected static override _schema: SchemaField<DrawingDocument.Schema>;
 
-  static get schema(): SchemaField<DrawingDocument.Schema>;
-
-  static validateJoint(data: DrawingDocument.Source): void;
+  static override get schema(): SchemaField<DrawingDocument.Schema>;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: DrawingDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): DrawingDocument.Implementation;
 
   static override fromJSON(json: string): DrawingDocument.Implementation;
+
+  static #BaseDrawing: true;
 }
 
 export default BaseDrawing;

package/src/foundry/common/documents/fog-exploration.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";
@@ -25,12 +25,28 @@ declare abstract class BaseFogExploration extends Document<"FogExploration", Bas
    */
   constructor(...args: FogExploration.ConstructorArgs);
 
+  /**
+   * @defaultValue
+   * ```js
+   * mergeObject(super.metadata, {
+   *   name: "FogExploration",
+   *   collection: "fog",
+   *   label: "DOCUMENT.FogExploration",
+   *   labelPlural: "DOCUMENT.FogExplorations",
+   *   isPrimary: true,
+   *   permissions: {
+   *     create: "PLAYER",
+   *     update: this.#canModify,
+   *     delete: this.#canModify
+   *   },
+   *   schemaVersion: "12.324"
+   * })
+   * ```
+   */
   static override metadata: BaseFogExploration.Metadata;
 
   static override defineSchema(): BaseFogExploration.Schema;
 
-  static #canModify(user: User.Implementation, doc: BaseFogExploration);
-
   /*
    * After this point these are not really overridden methods.
    * They are here because Foundry's documents are complex and have lots of edge cases.
@@ -48,37 +64,37 @@ declare abstract class BaseFogExploration extends Document<"FogExploration", Bas
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: FogExploration.ParentCollectionName | null;
+  override readonly parentCollection: FogExploration.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): FogExploration.ImplementationClass;
 
-  static get baseDocument(): typeof BaseFogExploration;
+  static override get baseDocument(): typeof BaseFogExploration;
 
-  static get collectionName(): FogExploration.ParentCollectionName;
+  static override get collectionName(): FogExploration.ParentCollectionName;
 
-  static get documentName(): FogExploration.Name;
+  static override get documentName(): FogExploration.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(): FogExploration.Hierarchy;
+  static override get hierarchy(): FogExploration.Hierarchy;
 
   override parent: FogExploration.Parent;
 
-  static createDocuments<Temporary extends boolean | undefined = false>(
+  static override createDocuments<Temporary extends boolean | undefined = false>(
     data: Array<FogExploration.Implementation | FogExploration.CreateData> | undefined,
     operation?: Document.Database.CreateOperation<FogExploration.Database.Create<Temporary>>,
   ): Promise<Array<Document.TemporaryIf<FogExploration.Implementation, Temporary>>>;
 
-  static updateDocuments(
+  static override updateDocuments(
     updates: FogExploration.UpdateData[] | undefined,
     operation?: Document.Database.UpdateDocumentsOperation<FogExploration.Database.Update>,
   ): Promise<FogExploration.Implementation[]>;
 
-  static deleteDocuments(
+  static override deleteDocuments(
     ids: readonly string[] | undefined,
     operation?: Document.Database.DeleteDocumentsOperation<FogExploration.Database.Delete>,
   ): Promise<FogExploration.Implementation[]>;
@@ -98,7 +114,7 @@ declare abstract class BaseFogExploration extends Document<"FogExploration", Bas
   static override get(
     documentId: string,
     options?: FogExploration.Database.GetOptions,
-  ): FogExploration.Implementation | null;
+  ): Promise<FogExploration.Implementation | null> | FogExploration.Implementation | null;
 
   static override getCollectionName(name: string): null;
 
@@ -121,121 +137,151 @@ declare abstract class BaseFogExploration extends Document<"FogExploration", Bas
     key: Key,
   ): Promise<this>;
 
-  protected _preCreate(
+  protected override _preCreate(
     data: FogExploration.CreateData,
     options: FogExploration.Database.PreCreateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onCreate(
+  protected override _onCreate(
     data: FogExploration.CreateData,
     options: FogExploration.Database.OnCreateOperation,
     userId: string,
   ): void;
 
-  protected static _preCreateOperation(
+  protected static override _preCreateOperation(
     documents: FogExploration.Implementation[],
     operation: Document.Database.PreCreateOperationStatic<FogExploration.Database.Create>,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onCreateOperation(
+  protected static override _onCreateOperation(
     documents: FogExploration.Implementation[],
     operation: FogExploration.Database.Create,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preUpdate(
+  protected override _preUpdate(
     changed: FogExploration.UpdateData,
     options: FogExploration.Database.PreUpdateOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onUpdate(
+  protected override _onUpdate(
     changed: FogExploration.UpdateData,
     options: FogExploration.Database.OnUpdateOperation,
     userId: string,
   ): void;
 
-  protected static _preUpdateOperation(
+  protected static override _preUpdateOperation(
     documents: FogExploration.Implementation[],
     operation: FogExploration.Database.Update,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onUpdateOperation(
+  protected static override _onUpdateOperation(
     documents: FogExploration.Implementation[],
     operation: FogExploration.Database.Update,
     user: User.Implementation,
   ): Promise<void>;
 
-  protected _preDelete(
+  protected override _preDelete(
     options: FogExploration.Database.PreDeleteOptions,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected _onDelete(options: FogExploration.Database.OnDeleteOperation, userId: string): void;
+  protected override _onDelete(options: FogExploration.Database.OnDeleteOperation, userId: string): void;
 
-  protected static _preDeleteOperation(
+  protected static override _preDeleteOperation(
     documents: FogExploration.Implementation[],
     operation: FogExploration.Database.Delete,
     user: User.Implementation,
   ): Promise<boolean | void>;
 
-  protected static _onDeleteOperation(
+  protected static override _onDeleteOperation(
     documents: FogExploration.Implementation[],
     operation: FogExploration.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: FogExploration.Implementation[],
     context: Document.ModificationContext<FogExploration.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: FogExploration.Implementation[],
     context: Document.ModificationContext<FogExploration.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: FogExploration.Implementation[],
     context: Document.ModificationContext<FogExploration.Parent>,
   ): Promise<void>;
 
   /* DataModel overrides */
 
-  protected static _schema: SchemaField<FogExploration.Schema>;
+  protected static override _schema: SchemaField<FogExploration.Schema>;
 
-  static get schema(): SchemaField<FogExploration.Schema>;
+  static override get schema(): SchemaField<FogExploration.Schema>;
 
-  static validateJoint(data: FogExploration.Source): void;
+  static override validateJoint(data: FogExploration.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: FogExploration.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): FogExploration.Implementation;
 
   static override fromJSON(json: string): FogExploration.Implementation;
+
+  static #BaseFogExploration: true;
 }
 
 export default BaseFogExploration;