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

package/src/foundry/client/data/documents/region.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial, Merge } from "fvtt-types/utils";
+import type { AnyObject, Merge, NullishProps } from "#utils";
 import type { BaseShapeData, fields } from "../../../common/data/module.d.mts";
 import type Document from "../../../common/abstract/document.d.mts";
 import type { DataSchema } from "../../../common/data/fields.d.mts";
@@ -164,7 +164,7 @@ declare global {
     type Collection = never;
 
     /**
-     * An instance of `Region` that comes from the database but failed validation meaining that
+     * An instance of `Region` that comes from the database but failed validation meaning that
      * its `system` and `_source` could theoretically be anything.
      */
     interface Invalid extends Document.Invalid<RegionDocument.Implementation> {}
@@ -303,7 +303,7 @@ declare global {
         { label: "REGION.FIELDS.behaviors.label"; hint: "REGION.FIELDS.behaviors.hint" }
       >;
 
-      /** @defaultValue `CONST.REGION_VISIBILITY.LAYER` (`0`) */
+      /** @defaultValue `CONST.REGION_VISIBILITY.LAYER` */
       visibility: fields.NumberField<
         {
           required: true;
@@ -522,7 +522,8 @@ declare global {
       eventDataUuids: string[];
     }
 
-    interface UpdateTokenOptions {
+    /** @internal */
+    type _UpdateTokensOptions = NullishProps<{
       /**
        * Are the Region documents deleted?
        * @defaultValue `false`
@@ -534,7 +535,9 @@ declare global {
        * @defaultValue `true`
        */
       reset: boolean;
-    }
+    }>;
+
+    interface UpdateTokensOptions extends _UpdateTokensOptions {}
 
     type EventData =
       | {
@@ -598,28 +601,48 @@ declare global {
 
     /**
      * Activate the Socket event listeners.
-     * @param socket    - The active game socket
+     * @param socket - The active game socket
      * @internal
      */
     protected static _activateSocketListeners(socket: WebSocket): void;
 
     /**
      * Update the tokens of the given regions.
-     * @param regions   - The regions to update the tokens for
-     * @remarks
-     *  If called during Region/Scene create/update/delete workflows, the Token documents are always reset and
-     *  so never in an animated state, which means the reset option may be false. It is important that the
-     *  containment test is not done in an animated state.
+     *
+     * If called during Region/Scene create/update/delete workflows, the Token documents are always reset and
+     * so never in an animated state, which means the reset option may be false. It is important that the
+     * containment test is not done in an animated state.
+     * @param regions - The regions to update the tokens for
      * @internal
      */
+    // options: not null (destructured)
     protected static _updateTokens(
       regions: RegionDocument.Implementation[],
-      options?: InexactPartial<RegionDocument.UpdateTokenOptions>,
+      options?: RegionDocument.UpdateTokensOptions,
     ): Promise<void>;
 
+    // _onCreateOperation, _onUpdateOperation, and _onDeleteOperation are overridden from BaseRegion without signature changes.
+
+    /** The tokens inside this region. */
+    tokens: Set<TokenDocument.Implementation>;
+
+    /**
+     * Trigger the Region event.
+     * @param eventName - The event name
+     * @param eventData - The event data
+     * @internal
+     */
+    protected _triggerEvent(eventName: string, eventData: RegionDocument.EventData): Promise<void>;
+
+    /**
+     * Handle the Region event.
+     * @param event - The Region event
+     * @internal
+     */
+    protected _handleEvent(event: RegionDocument.RegionEvent): Promise<void>;
     /**
      * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
-     * this method must be overriden like so:
+     * this method must be overridden like so:
      * ```typescript
      * class GurpsRegionDocument extends RegionDocument {
      *   protected override _onCreateDescendantDocuments(...args: RegionDocument.OnCreateDescendantDocumentsArgs) {
@@ -637,7 +660,7 @@ declare global {
 
     /**
      * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
-     * this method must be overriden like so:
+     * this method must be overridden like so:
      * ```typescript
      * class Ptr2eRegionDocument extends RegionDocument {
      *   protected override _onUpdateDescendantDocuments(...args: RegionDocument.OnUpdateDescendantDocumentsArgs) {
@@ -655,7 +678,7 @@ declare global {
 
     /**
      * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
-     * this method must be overriden like so:
+     * this method must be overridden like so:
      * ```typescript
      * class BladesRegionDocument extends RegionDocument {
      *   protected override _onDeleteDescendantDocuments(...args: RegionDocument.OnUpdateDescendantDocuments) {
@@ -671,31 +694,6 @@ declare global {
      */
     protected override _onDeleteDescendantDocuments(...args: RegionDocument.OnDeleteDescendantDocumentsArgs): void;
 
-    /** The tokens inside this region. */
-    tokens: Set<TokenDocument.Implementation>;
-
-    /**
-     * Trigger the Region event.
-     * @param eventName     - The event name
-     * @param eventData     - The event data
-     * @internal
-     */
-    protected _triggerEvent(eventName: string, eventData: RegionDocument.EventData): Promise<void>;
-
-    /**
-     * Handle the Region event.
-     * @param event     - The Region event
-     * @internal
-     */
-    protected _handleEvent(event: RegionDocument.RegionEvent): Promise<void>;
-
-    /**
-     * @privateRemarks _onCreate, _preUpdate, _onUpdate, _onDelete, preCreateOperation, _preUpdateOperation, _onCreateOperation,
-     * _onUpdateOperation, _onDeleteOperation, are overridden from BaseRegion without signature changes.
-     */
-
-    #regionDocument: true;
-
     /*
      * After this point these are not really overridden methods.
      * They are here because Foundry's documents are complex and have lots of edge cases.
@@ -710,7 +708,7 @@ declare global {
 
     /**
      * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
-     * this method must be overriden like so:
+     * this method must be overridden like so:
      * ```typescript
      * class SwadeRegionDocument extends RegionDocument {
      *   protected override _preCreateDescendantDocuments(...args: RegionDocument.PreCreateDescendantDocumentsArgs) {
@@ -728,7 +726,7 @@ declare global {
 
     /**
      * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
-     * this method must be overriden like so:
+     * this method must be overridden like so:
      * ```typescript
      * class LancerRegionDocument extends RegionDocument {
      *   protected override _preUpdateDescendantDocuments(...args: RegionDocument.OnUpdateDescendantDocuments) {
@@ -746,7 +744,7 @@ declare global {
 
     /**
      * @remarks To make it possible for narrowing one parameter to jointly narrow other parameters
-     * this method must be overriden like so:
+     * this method must be overridden like so:
      * ```typescript
      * class KultRegionDocument extends RegionDocument {
      *   protected override _preDeleteDescendantDocuments(...args: RegionDocument.PreDeleteDescendantDocumentsArgs) {
@@ -762,23 +760,30 @@ declare global {
      */
     protected override _preDeleteDescendantDocuments(...args: RegionDocument.PreDeleteDescendantDocumentsArgs): void;
 
+    // context: not null (destructured)
     static override defaultName(
-      context: Document.DefaultNameContext<"base", NonNullable<RegionDocument.Parent>>,
+      context?: Document.DefaultNameContext<"Region", NonNullable<RegionDocument.Parent>>,
     ): string;
 
+    /** @remarks `context.parent` is required as creation requires one */
     static override createDialog(
-      data: Document.CreateDialogData<RegionDocument.CreateData>,
-      context: Document.CreateDialogContext<string, NonNullable<RegionDocument.Parent>>,
+      data: Document.CreateDialogData<RegionDocument.CreateData> | undefined,
+      context: Document.CreateDialogContext<"Region", NonNullable<RegionDocument.Parent>>,
     ): Promise<RegionDocument.Stored | null | undefined>;
 
+    // options: not null (parameter default only)
     static override fromDropData(
       data: Document.DropData<RegionDocument.Implementation>,
-      options?: Document.FromDropDataOptions,
+      options?: AnyObject,
     ): Promise<RegionDocument.Implementation | undefined>;
 
     static override fromImport(
       source: RegionDocument.Source,
-      context?: Document.FromImportContext<RegionDocument.Parent>,
+      context?: Document.FromImportContext<RegionDocument.Parent> | null,
     ): Promise<RegionDocument.Implementation>;
+
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
+
+    static #RegionDocument: true;
   }
 }