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

package/src/foundry/common/documents/wall.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";
@@ -61,23 +61,23 @@ declare class BaseWall extends Document<WallDocument.Name, BaseWall.Schema, any>
   // Same as Document for now
   protected static override _initializationOrder(): Generator<[string, DataField.Any]>;
 
-  readonly parentCollection: WallDocument.ParentCollectionName | null;
+  override readonly parentCollection: WallDocument.ParentCollectionName | null;
 
-  readonly pack: string | null;
+  override readonly pack: string | null;
 
   static override get implementation(): WallDocument.ImplementationClass;
 
-  static get baseDocument(): typeof BaseWall;
+  static override get baseDocument(): typeof BaseWall;
 
-  static get collectionName(): WallDocument.ParentCollectionName;
+  static override get collectionName(): WallDocument.ParentCollectionName;
 
-  static get documentName(): WallDocument.Name;
+  static override get documentName(): WallDocument.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(): WallDocument.Hierarchy;
+  static override get hierarchy(): WallDocument.Hierarchy;
 
   override parent: WallDocument.Parent;
 
@@ -201,35 +201,62 @@ declare class BaseWall extends Document<WallDocument.Name, BaseWall.Schema, any>
     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;
 
+  /**
+   * @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: WallDocument.Implementation[],
     context: WallDocument.Database.OnCreateDocumentsContext,
   ): Promise<void>;
 
+  /**
+   * @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: WallDocument.Implementation[],
     context: WallDocument.Database.OnUpdateDocumentsContext,
   ): Promise<void>;
 
+  /**
+   * @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: WallDocument.Implementation[],
     context: WallDocument.Database.OnDeleteDocumentsContext,
@@ -243,12 +270,15 @@ declare class BaseWall extends Document<WallDocument.Name, BaseWall.Schema, any>
 
   static override validateJoint(data: WallDocument.Source): void;
 
+  // options: not null (parameter default only, destructured in super)
   static override fromSource(
     source: WallDocument.CreateData,
-    { strict, ...context }?: DataModel.FromSourceOptions,
+    context?: DataModel.FromSourceOptions,
   ): WallDocument.Implementation;
 
   static override fromJSON(json: string): WallDocument.Implementation;
+
+  static #BaseWall: true;
 }
 
 export default BaseWall;

package/src/foundry/common/grid/base.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, EmptyObject, InexactPartial, Identity } from "fvtt-types/utils";
+import type { AnyObject, EmptyObject, InexactPartial, Identity } from "#utils";
 
 /**
  * The base grid class.

package/src/foundry/common/grid/gridless.d.mts

@@ -1,6 +1,6 @@
 import type BaseGrid from "./base.d.mts";
 
-import type { InexactPartial } from "fvtt-types/utils";
+import type { InexactPartial } from "#utils";
 
 declare class Gridless extends BaseGrid {
   override type: typeof CONST.GRID_TYPES.GRIDLESS;

package/src/foundry/common/grid/hexagonal.d.mts

@@ -1,6 +1,6 @@
 import type BaseGrid from "./base.d.mts";
 
-import type { InexactPartial } from "fvtt-types/utils";
+import type { InexactPartial } from "#utils";
 
 declare class HexagonalGrid extends BaseGrid {
   /**

package/src/foundry/common/grid/square.d.mts

@@ -1,6 +1,6 @@
 import type BaseGrid from "./base.d.mts";
 
-import type { InexactPartial } from "fvtt-types/utils";
+import type { InexactPartial } from "#utils";
 
 declare class SquareGrid extends BaseGrid {
   /**

package/src/foundry/common/packages/base-package.d.mts

@@ -1,4 +1,4 @@
-import type { GetKey, AnyObject, InexactPartial, AnyMutableObject, Identity, AnyArray } from "fvtt-types/utils";
+import type { GetKey, AnyObject, InexactPartial, AnyMutableObject, Identity, AnyArray, NullishProps } from "#utils";
 import type DataModel from "../abstract/data.d.mts";
 import type { ReleaseData } from "../config.d.mts";
 import type * as fields from "../data/fields.d.mts";
@@ -381,9 +381,22 @@ declare namespace BasePackage {
     hasStorage: boolean;
   }
 
-  interface LogOptions extends InexactPartial<LogCompatibilityWarningOptions> {
+  /** @internal */
+  type _Installed = NullishProps<{
     /** Is the package installed? */
-    installed?: unknown;
+    installed: boolean;
+  }>;
+
+  interface LogOptions extends _Installed, InexactPartial<LogCompatibilityWarningOptions> {}
+
+  interface MigrateDataOptions extends _Installed {}
+
+  interface CleanDataOptions extends fields.DataField.CleanOptions {
+    /**
+     * Is the package installed?
+     * @remarks Only used to pass on to {@link BasePackage._logWarning | `BasePackage#_logWarning`}
+     */
+    installed?: boolean | null | undefined;
   }
 }
 
@@ -401,7 +414,7 @@ export class PackageRelationships extends fields.SchemaField<BasePackage.Package
   constructor(options: fields.SchemaField.Options<BasePackage.PackageRelationshipsSchema>);
 }
 
-// ommitted private class PackageRelationshipField
+// omitted private class PackageRelationshipField
 
 /**
  * A custom SchemaField for defining a related Package.
@@ -454,9 +467,10 @@ export class CompendiumOwnershipField extends fields.ObjectField<
     validationError: string;
   };
 
+  /** @remarks `options` is unused in `CompendiumOwnershipField` */
   protected override _validateType(
     value: Record<keyof typeof foundry.CONST.USER_ROLES, keyof typeof foundry.CONST.DOCUMENT_OWNERSHIP_LEVELS>,
-    options?: any,
+    options?: fields.DataField.ValidateOptions<this> | null,
   ): boolean | void;
 }
 
@@ -471,23 +485,25 @@ export class PackageCompendiumPacks<
     options?: fields.DataField.CleanOptions,
   ): Set<fields.ArrayField.InitializedElementType<ElementFieldType>>;
 
+  // options: not null (parameter default only)
   override initialize(
     value: fields.ArrayField.PersistedElementType<ElementFieldType>[],
     // In Foundry itself, this field is only used in `BasePackage`, however it should be able to accept any model.
     // NOTE(LukeAbby): This also has been seen in a circularity `Type of property 'packs' circularly references itself in mapped type ...`.
     model: DataModel.Any,
+    options?: fields.DataField.InitializeOptions,
   ):
     | Set<fields.ArrayField.InitializedElementType<ElementFieldType>>
     | (() => Set<fields.ArrayField.InitializedElementType<ElementFieldType>> | null);
 
   protected override _validateElements(
     value: AnyArray,
-    options?: fields.DataField.ValidationOptions<fields.DataField.Any>,
+    options?: fields.DataField.ValidateOptions<fields.DataField.Any>,
   ): void | DataModelValidationFailure;
 
   protected override _validateElement(
     value: unknown,
-    options: fields.DataField.ValidationOptions<fields.DataField.Any>,
+    options: fields.DataField.ValidateOptions<fields.DataField.Any>,
   ): void | DataModelValidationFailure;
 }
 
@@ -605,7 +621,7 @@ declare class BasePackage<
    */
   static testDependencyCompatibility(compatibility: PackageCompatibility, dependency: BasePackage): boolean;
 
-  static cleanData(source?: AnyObject, options?: fields.DataField.CleanOptions): AnyObject;
+  static cleanData(source?: AnyObject, options?: BasePackage.CleanDataOptions): AnyMutableObject;
 
   /**
    * Validate that a Package ID is allowed.
@@ -627,12 +643,19 @@ declare class BasePackage<
    */
   static migratedKeys: Set<string>;
 
-  static migrateData(
-    data: AnyMutableObject,
-    logOptions?: InexactPartial<{
-      installed: boolean;
-    }>,
-  ): AnyMutableObject;
+  /**
+   * @remarks
+   * Migrations:
+   * - `name` to `id`, both at root and for any `dependencies` (since v10 until v13)
+   * - `dependencies` to `relationships` (structural change) (since v10 until v13)
+   * - `minimumCoreVersion` and `compatibleCoreVersion` to `compatibility.minimum` and `.verified`, respectively (since v10 until v13)
+   * - Inside `media` entries, `link` to `url` (since v11 until v13)
+   * - Inside `packs` entries:
+   *   - `private` to an `ownership` object with `{PLAYER: "LIMITED", ASSISTANT: "OWNER"}` (since v11 until v13)
+   *   - Slugifies the `name` if not already a valid slug (since v12, until v14)
+   *   - `entity` to `type` (since v9, no specified end)
+   */
+  static override migrateData(data: AnyMutableObject, options?: BasePackage.MigrateDataOptions): AnyMutableObject;
 
   protected static _migrateNameToId(data: AnyObject, logOptions: BasePackage.LogOptions): void;
 

package/src/foundry/common/packages/base-system.d.mts

@@ -1,3 +1,5 @@
+import type { AnyMutableObject } from "../../../utils/index.d.mts";
+import type DataModel from "../abstract/data.d.mts";
 import type BasePackage from "./base-package.d.mts";
 
 declare namespace BaseSystem {
@@ -28,6 +30,43 @@ declare class BaseSystem extends BasePackage<BaseSystem.Schema> {
    * Does the system template request strict type checking of data compared to template.json inferred types.
    */
   strictDataCleaning: boolean;
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `BaseSystem#gridDistance` which has been migrated to {@link BaseSystem.grid | `BaseSystem#grid`}`#distance`"
+   */
+  get gridDistance(): number;
+
+  set gridDistance(number);
+
+  /**
+   * @deprecated since v12, until v14
+   * @remarks "You are accessing `BaseSystem#gridUnits` which has been migrated to {@link BaseSystem.grid | `BaseSystem#grid`}`#units`"
+   */
+  get gridUnits(): number;
+
+  set gridUnits(number);
+
+  /** @remarks Adds `gridDistance` and `gridUnits` to super's */
+  static override migratedKeys: Set<string>;
+
+  /**
+   * @remarks
+   * Migrations:
+   * - {@link BasePackage.migrateData | `BasePackage`}'s
+   * - `gridDistance` to `grid.distance` (since v12, until v14)
+   * - `gridUnits` to `grid.units` (since v12, until v14)
+   */
+  static override migrateData(data: AnyMutableObject, options?: BasePackage.MigrateDataOptions): AnyMutableObject;
+
+  /**
+   * @remarks
+   * Shims:
+   * - `gridDistance` to `grid.distance` (since v12, until v14)
+   * - `gridUnits` to `grid.units` (since v12, until v14)
+   */
+  // options: not null (destructured)
+  static override shimData(data: AnyMutableObject, options?: DataModel.ShimDataOptions): AnyMutableObject;
 }
 
 export default BaseSystem;

package/src/foundry/common/packages/base-world.d.mts

@@ -1,5 +1,5 @@
 import type BasePackage from "./base-package.d.mts";
-import type { AnyMutableObject, InexactPartial } from "fvtt-types/utils";
+import type { AnyMutableObject, InexactPartial } from "#utils";
 import type { ReleaseData } from "../config.d.mts";
 
 declare namespace BaseWorld {
@@ -27,6 +27,13 @@ declare class BaseWorld extends BasePackage<BaseWorld.Schema> {
    */
   static icon: string;
 
+  /**
+   * @remarks
+   * Migrations:
+   * - Enforces `compatibility` being an object
+   * - `compatibility.maximum === "1.0.0"` to `undefined`
+   * - If `coreVersion` but no `compatibility.verified`, sets both `compatibility.verified` and `.minimum` to `coreVersion`
+   */
   static migrateData(data: AnyMutableObject): AnyMutableObject;
 
   static testAvailability(

package/src/foundry/common/packages/sub-types.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, Merge } from "fvtt-types/utils";
+import type { AnyObject, Merge } from "#utils";
 import type Document from "../abstract/document.d.mts";
 import type { DataField, ObjectField } from "../data/fields.d.mts";
 
@@ -18,9 +18,10 @@ declare class AdditionalTypesField<
 > {
   static get _defaults(): AdditionalTypesField.DefaultOptions;
 
+  // options: not null (parameter default only, despite being unused)
   protected _validateType(
     value: ObjectField.InitializedType<Options>,
-    options?: DataField.ValidationOptions<DataField.Any>,
+    options?: DataField.ValidateOptions<AdditionalTypesField>,
   ): boolean | void;
 }
 
@@ -30,9 +31,6 @@ declare namespace AdditionalTypesField {
   type DefaultOptions = Merge<
     ObjectField.DefaultOptions,
     {
-      // Required is set as false BUT this doesn't work correctly in v11
-      // TODO: Re-enable in v12
-      // required: false;
       readonly: true;
       validationError: "is not a valid sub-types configuration";
     }

package/src/foundry/common/primitives/array.d.mts

@@ -1,4 +1,4 @@
-import type { OverlapsWith } from "fvtt-types/utils";
+import type { OverlapsWith } from "#utils";
 
 declare global {
   namespace Array {

package/src/foundry/common/primitives/string.d.mts

@@ -1,4 +1,4 @@
-import type { Titlecase } from "fvtt-types/utils";
+import type { Titlecase } from "#utils";
 
 declare global {
   interface String {

package/src/foundry/common/prosemirror/dirty-plugin.d.mts

@@ -1,7 +1,7 @@
 import type { Schema } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
 import type ProseMirrorPlugin from "./plugin.d.mts";
-import type { EmptyObject } from "fvtt-types/utils";
+import type { EmptyObject } from "#utils";
 
 export default ProseMirrorDirtyPlugin;
 

package/src/foundry/common/prosemirror/dom-parser.d.mts

@@ -1,5 +1,5 @@
 import { DOMParser as BaseDOMParser, Node, ParseOptions, Schema } from "prosemirror-model";
-import type { FixedInstanceType } from "fvtt-types/utils";
+import type { FixedInstanceType } from "#utils";
 
 export default DOMParser;
 

package/src/foundry/common/prosemirror/highlight-matches-plugin.d.mts

@@ -3,7 +3,7 @@ import type ProseMirrorPlugin from "./plugin.d.mts";
 import type { ProseMirrorMenu } from "./menu.d.mts";
 import { EditorState, Plugin } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
-import type { EmptyObject, InexactPartial } from "fvtt-types/utils";
+import type { EmptyObject, InexactPartial } from "#utils";
 
 declare namespace ProseMirrorHighlightMatchesPlugin {
   /**

package/src/foundry/common/prosemirror/image-plugin.d.mts

@@ -2,7 +2,7 @@ import type { Schema, Slice } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
 import type { EditorView } from "prosemirror-view";
 import type ProseMirrorPlugin from "./plugin.d.mts";
-import type { EmptyObject } from "fvtt-types/utils";
+import type { EmptyObject } from "#utils";
 
 export default ProseMirrorImagePlugin;
 /**

package/src/foundry/common/prosemirror/paste-transformer.d.mts

@@ -2,7 +2,7 @@ import type { Schema, Slice } from "prosemirror-model";
 import type ProseMirrorPlugin from "./plugin.d.mts";
 import type { Plugin } from "prosemirror-state";
 import type { EditorView } from "prosemirror-view";
-import type { EmptyObject } from "fvtt-types/utils";
+import type { EmptyObject } from "#utils";
 
 export default ProseMirrorPasteTransformer;
 

package/src/foundry/common/prosemirror/plugin.d.mts

@@ -1,6 +1,6 @@
 import type { Schema } from "prosemirror-model";
 import type { Plugin } from "prosemirror-state";
-import type { AnyObject } from "fvtt-types/utils";
+import type { AnyObject } from "#utils";
 
 export default ProseMirrorPlugin;
 declare abstract class ProseMirrorPlugin {

package/src/foundry/common/types.d.mts

@@ -1,4 +1,4 @@
-import type { AnyConcreteConstructor, AnyConstructor, AnyFunction } from "fvtt-types/utils";
+import type { AnyConcreteConstructor, AnyConstructor, AnyFunction } from "#utils";
 import type { Document } from "./abstract/module.d.mts";
 
 // After seeing that none of these types add anything or are even exported a

package/src/foundry/common/utils/bitmask.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 
 declare class InternalBitMask<T extends Record<string, boolean>> extends Number {
   /**

package/src/foundry/common/utils/collection.d.mts

@@ -1,6 +1,6 @@
 // This class exists make it as sound as possible to override these parts of the class and make them
 
-import type { AnyArray, Identity } from "fvtt-types/utils";
+import type { AnyArray, Identity } from "#utils";
 
 // completely unrelated. It's done this way specifically to avoid situations with broken inheritance.
 declare class Map<K, V> extends globalThis.Map<K, V> {

package/src/foundry/common/utils/event-emitter.d.mts

@@ -1,4 +1,4 @@
-import type { AnyConstructor, FixedInstanceType, Mixin, NullishProps } from "fvtt-types/utils";
+import type { AnyConstructor, FixedInstanceType, Mixin, NullishProps } from "#utils";
 
 /**
  * A mixin class which implements the behavior of EventTarget.

package/src/foundry/common/utils/helpers.d.mts

@@ -1,4 +1,4 @@
-import type { AnyConstructor, AnyFunction, DeepPartial, InexactPartial, NonNullish } from "fvtt-types/utils";
+import type { AnyConstructor, AnyFunction, DeepPartial, InexactPartial, NonNullish } from "#utils";
 import type Document from "../abstract/document.d.mts";
 
 /**

package/src/foundry/public/scripts/clipper/clipper.d.mts

@@ -1,4 +1,4 @@
-import type { Brand } from "fvtt-types/utils";
+import type { Brand } from "#utils";
 
 declare global {
   namespace ClipperLib {

package/src/types/augments/particles.d.mts

@@ -1,6 +1,6 @@
 /* eslint-disable import-x/export */
 
-import type { Brand } from "fvtt-types/utils";
+import type { Brand } from "#utils";
 
 export namespace behaviors {
   type BehaviorOrder = Brand<number, "PIXI.particles.behaviors.BehaviorOrder">;

package/src/types/augments/pixi.d.mts

@@ -1,4 +1,4 @@
-import type { Brand, Identity } from "fvtt-types/utils";
+import type { Brand, Identity } from "#utils";
 import * as _PIXI from "pixi.js";
 
 // Note(LukeAbby): The `smooth.d.mts` and `smooth.d.mts` files exist to make it DRY to selectively tweak PIXI sub-namespaces.

package/src/types/augments/smooth.d.mts

@@ -1,4 +1,4 @@
-import type { Brand } from "fvtt-types/utils";
+import type { Brand } from "#utils";
 
 type JOINT_TYPE = Brand<number, "PIXI.smooth.JOINT_TYPE">;
 declare const JOINT_TYPE: {

package/src/types/augments/tinyMCE.d.mts

@@ -1,6 +1,6 @@
 import _tinymce from "tinymce";
 import type * as _tinymceTypes from "tinymce";
-import type { AnyObject } from "fvtt-types/utils";
+import type { AnyObject } from "#utils";
 
 declare global {
   let tinyMCE: typeof _tinymce;

package/src/types/config.d.mts

@@ -1,11 +1,8 @@
 // This is an issue only on Windows. It's worked around in this weird way to avoid ESLint
 // whining about an unused disable.
-/* eslint import-x/no-unresolved: [2, { ignore: ["fvtt-types/configuration"] }] */
 
-import type { InterfaceToObject, MustConform } from "fvtt-types/utils";
-
-// eslint-disable-next-line import-x/extensions
-import * as configuration from "fvtt-types/configuration";
+import type { InterfaceToObject, MustConform } from "#utils";
+import * as configuration from "#configuration";
 
 declare global {
   interface AssumeHookRan extends configuration.AssumeHookRan {}

package/src/types/documentConfiguration.d.mts

@@ -3,7 +3,7 @@
 
 import type { documents } from "../foundry/client-esm/client.d.mts";
 import type { Document } from "../foundry/common/abstract/module.d.mts";
-import type { InterfaceToObject, MakeConform, MustConform, FixedInstanceType } from "fvtt-types/utils";
+import type { InterfaceToObject, MakeConform, MustConform, FixedInstanceType } from "#utils";
 
 type DocumentConform<T> = MakeConform<T, Document.AnyConstructor>;
 

package/src/types/lib.d.mts

@@ -1,4 +1,4 @@
-import type { Identity } from "fvtt-types/utils";
+import type { Identity } from "#utils";
 
 declare global {
   namespace AudioNode {

package/src/types/workers/image-compressor.d.mts

@@ -1,4 +1,4 @@
-import type { EmptyObject, InexactPartial } from "fvtt-types/utils";
+import type { EmptyObject, InexactPartial } from "#utils";
 
 export declare const FORMATS: {
   RED: typeof PIXI.FORMATS.RED;