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

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

@@ -1,4 +1,4 @@
-import type { Merge } from "../../../../utils/index.d.mts";
+import type { AnyObject, Merge } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 import type { DataSchema } from "../../../common/data/fields.d.mts";
 import type { fields } from "../../../common/data/module.d.mts";
@@ -111,7 +111,7 @@ declare global {
     type Collection = WorldSettings.Configured;
 
     /**
-     * An instance of `Setting` that comes from the database but failed validation meaining that
+     * An instance of `Setting` that comes from the database but failed validation meaning that
      * its `system` and `_source` could theoretically be anything.
      */
     interface Invalid extends Document.Invalid<Setting.Implementation> {}
@@ -183,6 +183,7 @@ declare global {
        * The setting key, a composite of \{scope\}.\{name\}
        * @defaultValue `""`
        */
+      // TODO: enforce `${string}.${string}`? Not worth it since nobody touches directly?
       key: fields.StringField<{
         required: true;
         nullable: false;
@@ -193,7 +194,7 @@ declare global {
 
       /**
        * The setting value, which is serialized to JSON
-       * @defaultValue `undefined`
+       * @defaultValue `null`
        */
       value: fields.JSONField<{
         required: true;
@@ -311,7 +312,7 @@ declare global {
     /**
      * @deprecated `Settings` does not have any flags.
      *
-     * This permenantly deprecated type helps to alleviate confusion as a user might expect it to exist.
+     * This permanently deprecated type helps to alleviate confusion as a user might expect it to exist.
      */
     type Flags = never;
 
@@ -319,21 +320,21 @@ declare global {
       /**
        * @deprecated `Settings` does not have any flags.
        *
-       * This permenantly deprecated type helps to alleviate confusion as a user might expect it to exist.
+       * This permanently deprecated type helps to alleviate confusion as a user might expect it to exist.
        */
       type Scope = never;
 
       /**
        * @deprecated `Settings` does not have any flags.
        *
-       * This permenantly deprecated type helps to alleviate confusion as a user might expect it to exist.
+       * This permanently deprecated type helps to alleviate confusion as a user might expect it to exist.
        */
       type Key<_Scope> = never;
 
       /**
        * @deprecated `Settings` does not have any flags.
        *
-       * This permenantly deprecated type helps to alleviate confusion as a user might expect it to exist.
+       * This permanently deprecated type helps to alleviate confusion as a user might expect it to exist.
        */
       type Get<_Scope, _Key> = never;
     }
@@ -372,30 +373,23 @@ declare global {
      */
     constructor(...args: Setting.ConstructorArgs);
 
-    /**
-     * @privateRemarks This exists to let ts know that this class has a private property
-     */
-    static #PRIMITIVE_TYPES: any;
-
     /**
      * The setting configuration for this setting document.
      */
     get config(): SettingsConfig | undefined;
 
-    // TODO: This is the same as `DataModel._initialize`
-    protected _initialize(options?: any): void;
+    // options: not null (parameter default only)
+    protected override _initialize(options?: Document.InitializeOptions): void;
 
-    /**
-     * @privateRemarks _onCreate and _preUpdate are overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
+    // _onCreate and _preUpdate are overridden but with no signature changes.
+    // For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
 
     /**
      * Cast the value of the Setting into its defined type.
      * @returns The initialized type of the Setting document.
      */
     // TODO: This could probably be derived
-    protected _castType(): any;
+    protected _castType(): unknown;
 
     /*
      * After this point these are not really overridden methods.
@@ -411,26 +405,33 @@ declare global {
 
     // Descendant Document operations have been left out because Setting does not have any descendant documents.
 
-    static override defaultName(context?: Document.DefaultNameContext<string, Setting.Parent>): string;
+    // context: not null (destructured)
+    static override defaultName(context?: Document.DefaultNameContext<"Setting", Setting.Parent>): string;
 
     /**
      * @throws Foundry tries to figure out the folders for the world collection and errors out
      */
+    // data: not null (parameter default only), context: not null (destructured)
     static override createDialog(
       data?: Setting.CreateData,
-      context?: Document.CreateDialogContext<string, Setting.Parent>,
+      context?: Document.CreateDialogContext<"Setting", Setting.Parent>,
     ): never;
 
+    // options: not null (parameter default only)
     static override fromDropData(
       data: Document.DropData<Setting.Implementation>,
-      options?: Document.FromDropDataOptions,
+      options?: AnyObject,
     ): Promise<Setting.Implementation | undefined>;
 
     static override fromImport(
       source: Setting.Source,
-      context?: Document.FromImportContext<Setting.Parent>,
+      context?: Document.FromImportContext<Setting.Parent> | null,
     ): Promise<Setting.Implementation>;
 
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
+
     // Embedded document operations have been left out because Setting does not have any embedded documents.
+
+    static #Setting: true;
   }
 }

package/src/foundry/client/data/documents/table-result.d.mts

@@ -1,5 +1,5 @@
 import type { ConfiguredTableResult } from "../../../../configuration/index.d.mts";
-import type { Merge } from "../../../../utils/index.d.mts";
+import type { AnyObject, Merge } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 import type { DataSchema } from "../../../common/data/fields.d.mts";
 import type { fields } from "../../../common/data/module.d.mts";
@@ -146,7 +146,7 @@ declare global {
     type Collection = never;
 
     /**
-     * An instance of `TableResult` that comes from the database but failed validation meaining that
+     * An instance of `TableResult` that comes from the database but failed validation meaning that
      * its `system` and `_source` could theoretically be anything.
      */
     interface Invalid<out SubType extends TableResult.SubType = TableResult.SubType>
@@ -241,7 +241,8 @@ declare global {
 
       /**
        * A named collection from which this result is drawn
-       * @defaultValue `""`
+       * @defaultValue `undefined`
+       * @remarks If this is a `compendium` type result, will be the pack ID; If `document`, the DocumentName
        */
       documentCollection: fields.StringField;
 
@@ -456,9 +457,13 @@ declare global {
 
     /**
      * A path reference to the icon image used to represent this result
+     * @remarks Returns {@linkcode CONFIG.RollTable.resultIcon} if `this.img` is falsey
      */
     get icon(): string;
 
+    /** @remarks Overrides `this.img` with the `img` of the associated Document, if this result is a `document` or `compendium` type */
+    override prepareBaseData(): void;
+
     /**
      * Prepare a string representation for the result which (if possible) will be a dynamic link or otherwise plain text
      * @returns The text to display
@@ -479,25 +484,32 @@ declare global {
 
     // Descendant Document operations have been left out because TableResult does not have any descendant documents.
 
+    // context: not null (destructured)
     static override defaultName(
-      context: Document.DefaultNameContext<TableResult.SubType, NonNullable<TableResult.Parent>>,
+      context?: Document.DefaultNameContext<"TableResult", NonNullable<TableResult.Parent>>,
     ): string;
 
+    /** @remarks `context.parent` is required as creation requires one */
     static override createDialog(
-      data: Document.CreateDialogData<TableResult.CreateData>,
-      context: Document.CreateDialogContext<TableResult.SubType, NonNullable<TableResult.Parent>>,
+      data: Document.CreateDialogData<TableResult.CreateData> | undefined,
+      context: Document.CreateDialogContext<"TableResult", NonNullable<TableResult.Parent>>,
     ): Promise<TableResult.Stored | null | undefined>;
 
+    // options: not null (parameter default only)
     static override fromDropData(
       data: Document.DropData<TableResult.Implementation>,
-      options?: Document.FromDropDataOptions,
+      options?: AnyObject,
     ): Promise<TableResult.Implementation | undefined>;
 
     static override fromImport(
       source: TableResult.Source,
-      context?: Document.FromImportContext<TableResult.Parent>,
+      context?: Document.FromImportContext<TableResult.Parent> | null,
     ): Promise<TableResult.Implementation>;
 
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
+
     // Embedded document operations have been left out because TableResult does not have any embedded documents.
+
+    static #TableResult: true;
   }
 }

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

@@ -1,4 +1,4 @@
-import type { InexactPartial, Merge } from "fvtt-types/utils";
+import type { AnyObject, InexactPartial, Merge } from "#utils";
 import type { documents } from "../../../client-esm/client.d.mts";
 import type Document from "../../../common/abstract/document.d.mts";
 import type { DataSchema } from "../../../common/data/fields.d.mts";
@@ -166,7 +166,7 @@ declare global {
     type Collection = RollTables.Configured;
 
     /**
-     * An instance of `RollTable` that comes from the database but failed validation meaining that
+     * An instance of `RollTable` that comes from the database but failed validation meaning that
      * its `system` and `_source` could theoretically be anything.
      */
     interface Invalid extends Document.Invalid<RollTable.Implementation> {}
@@ -746,7 +746,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 GurpsRollTable extends RollTable {
      *   protected override _onCreateDescendantDocuments(...args: RollTable.OnCreateDescendantDocumentsArgs) {
@@ -764,7 +764,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 BladesRollTable extends RollTable {
      *   protected override _onDeleteDescendantDocuments(...args: RollTable.OnUpdateDescendantDocuments) {
@@ -780,7 +780,8 @@ declare global {
      */
     protected override _onDeleteDescendantDocuments(...args: RollTable.OnDeleteDescendantDocumentsArgs): void;
 
-    toCompendium<Options extends ClientDocument.ToCompendiumOptions>(
+    // options: not null (parameter default only, destructured in super)
+    override toCompendium<Options extends ClientDocument.ToCompendiumOptions | undefined = undefined>(
       pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
       options?: Options,
     ): ClientDocument.ToCompendiumReturnType<foundry.documents.BaseRollTable, Options>;
@@ -809,7 +810,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 SwadeRollTable extends RollTable {
      *   protected override _preCreateDescendantDocuments(...args: RollTable.PreCreateDescendantDocumentsArgs) {
@@ -827,7 +828,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 LancerRollTable extends RollTable {
      *   protected override _preUpdateDescendantDocuments(...args: RollTable.OnUpdateDescendantDocuments) {
@@ -845,7 +846,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 Ptr2eRollTable extends RollTable {
      *   protected override _onUpdateDescendantDocuments(...args: RollTable.OnUpdateDescendantDocumentsArgs) {
@@ -863,7 +864,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 KultRollTable extends RollTable {
      *   protected override _preDeleteDescendantDocuments(...args: RollTable.PreDeleteDescendantDocumentsArgs) {
@@ -879,22 +880,27 @@ declare global {
      */
     protected override _preDeleteDescendantDocuments(...args: RollTable.PreDeleteDescendantDocumentsArgs): void;
 
-    static override defaultName(context?: Document.DefaultNameContext<string, RollTable.Parent>): string;
+    // context: not null (destructured)
+    static override defaultName(context?: Document.DefaultNameContext<"RollTable", RollTable.Parent>): string;
 
+    // data: not null (parameter default only), context: not null (destructured)
     static override createDialog(
       data?: Document.CreateDialogData<RollTable.CreateData>,
-      context?: Document.CreateDialogContext<string, RollTable.Parent>,
+      context?: Document.CreateDialogContext<"RollTable", RollTable.Parent>,
     ): Promise<RollTable.Stored | null | undefined>;
 
+    // options: not null (parameter default only)
     static override fromDropData(
       data: Document.DropData<RollTable.Implementation>,
-      options?: Document.FromDropDataOptions,
+      options?: AnyObject,
     ): Promise<RollTable.Implementation | undefined>;
 
     static override fromImport(
       source: RollTable.Source,
-      context?: Document.FromImportContext<RollTable.Parent>,
+      context?: Document.FromImportContext<RollTable.Parent> | null,
     ): Promise<RollTable.Implementation>;
+
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
   }
 
   /**

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

@@ -1,4 +1,4 @@
-import type { InterfaceToObject, Merge } from "../../../../utils/index.d.mts";
+import type { AnyObject, InterfaceToObject, Merge } from "#utils";
 import type Document from "../../../common/abstract/document.d.mts";
 import type { DataSchema } from "../../../common/data/fields.d.mts";
 import type { fields, TextureData } from "../../../common/data/module.d.mts";
@@ -100,7 +100,7 @@ declare global {
     type Collection = never;
 
     /**
-     * An instance of `TileDocument` that comes from the database but failed validation meaining that
+     * An instance of `TileDocument` that comes from the database but failed validation meaning that
      * its `system` and `_source` could theoretically be anything.
      */
     interface Invalid extends Document.Invalid<TileDocument.Implementation> {}
@@ -495,23 +495,29 @@ declare global {
 
     // Descendant Document operations have been left out because Tile does not have any descendant documents.
 
-    static override defaultName(context: Document.DefaultNameContext<"base", NonNullable<TileDocument.Parent>>): string;
+    static override defaultName(
+      context?: Document.DefaultNameContext<"Tile", NonNullable<TileDocument.Parent>>,
+    ): string;
 
+    /** @remarks `context.parent` is required as creation requires one */
     static override createDialog(
-      data: Document.CreateDialogData<TileDocument.CreateData>,
-      context: Document.CreateDialogContext<string, NonNullable<TileDocument.Parent>>,
+      data: Document.CreateDialogData<TileDocument.CreateData> | undefined,
+      context: Document.CreateDialogContext<"Tile", NonNullable<TileDocument.Parent>>,
     ): Promise<TileDocument.Stored | null | undefined>;
 
+    // options: not null (parameter default only)
     static override fromDropData(
       data: Document.DropData<TileDocument.Implementation>,
-      options?: Document.FromDropDataOptions,
+      options?: AnyObject,
     ): Promise<TileDocument.Implementation | undefined>;
 
     static override fromImport(
       source: TileDocument.Source,
-      context?: Document.FromImportContext<TileDocument.Parent>,
+      context?: Document.FromImportContext<TileDocument.Parent> | null,
     ): Promise<TileDocument.Implementation>;
 
+    override _onClickDocumentLink(event: MouseEvent): ClientDocument.OnClickDocumentLinkReturn;
+
     // Embedded document operations have been left out because Tile does not have any embedded documents.
   }
 }