@league-of-foundry-developers/foundry-vtt-types 13.340.1 → 13.345.1-beta.20250704.94554

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

@@ -1,10 +1,9 @@
 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 {
   export import Source = World.Source;
-  export import PersistedData = World.Source;
   export import CreateData = World.CreateData;
   export import InitializedData = World.InitializedData;
   export import UpdateData = World.UpdateData;
@@ -27,6 +26,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(
@@ -37,18 +43,21 @@ declare class BaseWorld extends BasePackage<BaseWorld.Schema> {
        * Tests against the current release by default.
        */
       release: ReleaseData;
+
       /**
        * A specific collection of modules to test availability
        * against. Tests against the currently installed modules by
        * default.
        */
-      modules: Collection<Module>;
+      modules: Collection<foundry.packages.Module>;
+
       /**
        * A specific collection of modules to test availability
        * against. Tests against the currently installed modules by
        * default.
        */
-      systems: Collection<System>;
+      systems: Collection<foundry.packages.System>;
+
       /**
        * Ignore the world's own core software compatibility and
        * instead defer entirely to the system's core software

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

@@ -1,26 +1,27 @@
-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";
 
 export type DocumentTypesConfiguration = Record<string, Record<string, AnyObject>>;
 
 /**
- * A special {@link ObjectField | `ObjectField`} available to packages which configures any additional Document subtypes
+ * A special {@linkcode ObjectField} available to packages which configures any additional Document subtypes
  * provided by the package.
  */
 declare class AdditionalTypesField<
-  Options extends AdditionalTypesField.DefaultOptions = AdditionalTypesField.DefaultOptions,
+  Options extends DataField.Options<AnyObject> = AdditionalTypesField.DefaultOptions,
 > extends ObjectField<
   Options,
-  AdditionalTypesField.ServerTypeDeclarations,
+  // Note(LukeAbby): `{}` is a valid initial so `| null | undefined` is added. Needs to respect overriden `initial` in the future.
+  AdditionalTypesField.ServerTypeDeclarations | null | undefined,
   AdditionalTypesField.ServerTypeDeclarations,
   AdditionalTypesField.ServerTypeDeclarations
 > {
   static get _defaults(): AdditionalTypesField.DefaultOptions;
 
   protected _validateType(
-    value: ObjectField.InitializedType<Options>,
-    options?: DataField.ValidationOptions<DataField.Any>,
+    value: AdditionalTypesField.ServerTypeDeclarations,
+    options?: DataField.ValidateOptions<this>,
   ): 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/math.d.mts

@@ -103,7 +103,9 @@ declare global {
       maxVal: number,
       t: number,
       p?: number,
-      /** @immediate */ func?: (radians: number) => number,
+
+      /** @immediate */
+      func?: (radians: number) => number,
     ): number;
   }
 }

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

@@ -86,6 +86,6 @@ declare global {
      * @param n - The value to convert; typically a string, but may already be a number.
      * @returns The number that the string represents, or NaN if no number could be determined.
      */
-    fromString(str: string | number): Number;
+    fromString(n: string | number): Number;
   }
 }

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/_module.d.mts

@@ -1,51 +1,63 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
 import { EditorState, AllSelection, TextSelection, Plugin, PluginKey } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
 import { Schema, DOMSerializer } from "prosemirror-model";
+import ProseMirrorInputRules from "./input-rules.mjs";
 import { keymap } from "prosemirror-keymap";
-import "./extensions.d.mts";
+// this is used in defaultPlugins, below, as `baseKeyMap: keymap(baseKeymap)`, but is irrelevant to the types
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+import { baseKeymap } from "prosemirror-commands";
+import { dropCursor } from "prosemirror-dropcursor";
+import { gapCursor } from "prosemirror-gapcursor";
+import { history } from "prosemirror-history";
+import ProseMirrorKeyMaps from "./keymaps.mjs";
+import ProseMirrorMenu from "./menu.mjs";
+import ProseMirrorDropDown from "./dropdown.mjs";
+import "./extensions.mjs";
 import * as collab from "prosemirror-collab";
-import type { parseHTMLString, serializeHTMLString } from "./util.d.mts";
-
+import { Step } from "prosemirror-transform";
+import { parseHTMLString, serializeHTMLString } from "./util.mjs";
 // A const is being imported here. It can't be `import type`.
-/* eslint-disable import-x/extensions */
 import { schema as defaultSchema } from "./schema.mjs";
-
-// and these are classes that are available as properties of ProseMirror
 import ProseMirrorPlugin from "./plugin.mjs";
 import ProseMirrorImagePlugin from "./image-plugin.mjs";
 import ProseMirrorDirtyPlugin from "./dirty-plugin.mjs";
 import ProseMirrorContentLinkPlugin from "./content-link-plugin.mjs";
 import ProseMirrorHighlightMatchesPlugin from "./highlight-matches-plugin.mjs";
 import ProseMirrorClickHandler from "./click-handler.mjs";
+import { columnResizing, tableEditing } from "prosemirror-tables";
 import DOMParser from "./dom-parser.mjs";
-import ProseMirrorInputRules from "./input-rules.mjs";
-import ProseMirrorKeyMaps from "./keymaps.mjs";
-import ProseMirrorMenu from "./menu.mjs";
-import { Step } from "prosemirror-transform";
-/* eslint-enable */
+import ProseMirrorPasteTransformer from "./paste-transformer.mjs";
 
-declare const dom: {
+declare const dom: Dom;
+
+interface Dom {
   parser: DOMParser;
   serializer: DOMSerializer;
   parseString: typeof parseHTMLString;
   serializeString: typeof serializeHTMLString;
-};
+}
 
-declare const defaultPlugins: Record<
-  | "inputRules"
-  | "keyMaps"
-  | "menu"
-  | "isDirty"
-  | "clickHandler"
-  | "pasteTransformer"
-  | "baseKeyMap"
-  | "dropCursor"
-  | "gapCursor"
-  | "history"
-  | "columnResizing"
-  | "tables",
-  Plugin
->;
+declare const defaultPlugins: DefaultPlugins;
+
+interface DefaultPlugins {
+  inputRules: ReturnType<typeof ProseMirrorInputRules.build>;
+  keyMaps: ReturnType<typeof ProseMirrorKeyMaps.build>;
+  menu: ReturnType<typeof ProseMirrorMenu.build>;
+  isDirty: ReturnType<typeof ProseMirrorDirtyPlugin.build>;
+  clickHandler: ReturnType<typeof ProseMirrorClickHandler.build>;
+  pasteTransformer: ReturnType<typeof ProseMirrorPasteTransformer.build>;
+  baseKeyMap: ReturnType<typeof keymap>;
+  dropCursor: ReturnType<typeof dropCursor>;
+  gapCursor: ReturnType<typeof gapCursor>;
+  history: ReturnType<typeof history>;
+  columnResizing: ReturnType<typeof columnResizing>;
+  tables: ReturnType<typeof tableEditing>;
+}
 
 export * as commands from "prosemirror-commands";
 export * as transform from "prosemirror-transform";
@@ -54,6 +66,8 @@ export * as tables from "prosemirror-tables";
 export * as input from "prosemirror-inputrules";
 export * as state from "prosemirror-state";
 
+export * as types from "./_types.mjs";
+
 export {
   AllSelection,
   TextSelection,
@@ -71,9 +85,11 @@ export {
   ProseMirrorDirtyPlugin,
   ProseMirrorImagePlugin,
   ProseMirrorClickHandler,
+  ProseMirrorPasteTransformer,
   ProseMirrorInputRules,
   ProseMirrorKeyMaps,
   ProseMirrorMenu,
+  ProseMirrorDropDown,
   collab,
   defaultPlugins,
   defaultSchema,

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

@@ -1,3 +1,9 @@
+import type { transformSlice } from "./util.d.mts";
+import type StringSerializer from "./string-serializer.d.mts";
+import type ProseMirrorDropDown from "./dropdown.d.mts";
+import type ProseMirrorMenu from "./menu.d.mts";
+import type ProseMirrorKeyMaps from "./keymaps.d.mts";
+import type ProseMirrorContentLinkPlugin from "./content-link-plugin.d.mts";
 /* eslint-disable @typescript-eslint/no-unused-vars */
 
 // After seeing that none of these types add anything or are even exported a
@@ -7,25 +13,24 @@
 // them here because it has poor discoverability. The names Foundry has chosen
 // also overlaps with other existing names, such as SettingConfig vs. ClientSetting.SettingConfig
 
-// TODO: Stubs
 export {};
 
-type ProseMirrorContentLinkOptions = unknown;
+type ProseMirrorContentLinkOptions = ProseMirrorContentLinkPlugin.ConstructionOptions;
 
-type ProseMirrorMenuOptions = unknown;
+type ProseMirrorMenuOptions = ProseMirrorMenu.ConstructionOptions;
 
-type ProseMirrorMenuItem = unknown;
+type ProseMirrorMenuItem = ProseMirrorMenu.Item;
 
-type ProseMirrorDropDownEntry = unknown;
+type ProseMirrorDropDownEntry = ProseMirrorDropDown.Entry;
 
-type ProseMirrorDropDownConfig = unknown;
+type ProseMirrorDropDownConfig = ProseMirrorDropDown.Config;
 
-type ProseMirrorCommand = unknown;
+type ProseMirrorCommand = ProseMirrorKeyMaps.Command;
 
-type MenuToggleBlockWrapCommand = unknown;
+type MenuToggleBlockWrapCommand = ProseMirrorMenu.ToggleBlockWrapCommand;
 
-type ProseMirrorNodeOutput = unknown;
+type ProseMirrorNodeOutput = StringSerializer.NodeOutput;
 
-type ProseMirrorMarkOutput = unknown;
+type ProseMirrorMarkOutput = StringSerializer.MarkOutput;
 
-type ProseMirrorSliceTransformer = unknown;
+type ProseMirrorSliceTransformer = transformSlice.SliceTransformer;

package/src/foundry/common/prosemirror/click-handler.d.mts

@@ -1,14 +1,17 @@
 import type { EditorView } from "prosemirror-view";
 import type { Plugin } from "prosemirror-state";
 import type ProseMirrorPlugin from "./plugin.d.mts";
-import type { Node, Schema } from "prosemirror-model";
+import type { Schema } from "prosemirror-model";
+import type { AnyObject } from "#utils";
 
 export default ProseMirrorClickHandler;
+
 /**
  * A class responsible for managing click events inside a ProseMirror editor.
  */
 declare class ProseMirrorClickHandler extends ProseMirrorPlugin {
-  static override build(schema: Schema, options?: Record<string, unknown>): Plugin;
+  /** @remarks `options` is unused */
+  static override build(schema: Schema, options?: AnyObject): Plugin;
 
   /* -------------------------------------------- */
 
@@ -21,14 +24,14 @@ declare class ProseMirrorClickHandler extends ProseMirrorPlugin {
    * @param event   - The click event.
    * @param direct  - Whether this Node is the one that was directly clicked on.
    * @returns A return value of true indicates the event has been handled, it will not propagate to
-   *          other plugins, and ProseMirror will call preventDefault on it.
+   * other plugins, and ProseMirror will call preventDefault on it.
    */
   protected _onClick(
     view: EditorView,
     pos: number,
-    node: Node,
+    node: globalThis.Node,
     nodePos: number,
-    event: JQuery.ClickEvent,
+    event: PointerEvent,
     direct: boolean,
   ): boolean | void;
 }

package/src/foundry/common/prosemirror/content-link-plugin.d.mts

@@ -2,6 +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 Document from "#common/abstract/document.mjs";
 
 /**
  * A class responsible for handling the dropping of Documents onto the editor and creating content links for them.
@@ -11,19 +12,21 @@ declare class ProseMirrorContentLinkPlugin extends ProseMirrorPlugin {
    * @param schema  - The ProseMirror schema.
    * @param options - Additional options to configure the plugin's behaviour.
    */
-  constructor(schema: Schema, options?: ProseMirrorContentLinkPlugin.ProseMirrorContentLinkOptions);
+  constructor(schema: Schema, options?: ProseMirrorContentLinkPlugin.ConstructionOptions);
 
   /**
    * The parent document housing this editor.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
-  readonly document: foundry.abstract.Document.Any;
+  readonly document: Document.Any | undefined;
 
   /**
    * Whether to generate links relative to the parent document.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
   readonly relativeLinks: boolean;
 
-  static override build(schema: Schema, options?: ProseMirrorContentLinkPlugin.ProseMirrorContentLinkOptions): Plugin;
+  static override build(schema: Schema, options?: ProseMirrorContentLinkPlugin.ConstructionOptions): Plugin;
 
   /**
    * Handle a drop onto the editor.
@@ -32,16 +35,33 @@ declare class ProseMirrorContentLinkPlugin extends ProseMirrorPlugin {
    * @param slice - A slice of editor content.
    * @param moved - Whether the slice has been moved from a different part of the editor.
    */
-  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): void | true;
+  protected _onDrop(view: EditorView, event: DragEvent, slice: Slice, moved: boolean): boolean | void;
 }
 
 declare namespace ProseMirrorContentLinkPlugin {
-  interface ProseMirrorContentLinkOptions {
+  interface ConstructionOptionsNoRelative {
     /** The parent document housing this editor. */
-    document?: foundry.abstract.Document.Any | undefined;
-    /** @defaultValue `false` */
-    relativeLinks?: boolean | undefined;
+    document?: Document.Any | undefined;
+
+    /**
+     * @defaultValue `false`
+     * @remarks If `relativeLinks` is `true`, a valid `document` must be passed or construction will throw
+     */
+    relativeLinks?: false | undefined;
+  }
+
+  interface ConstructionOptionsRelative {
+    /** The parent document housing this editor. */
+    document: Document.Any;
+
+    /**
+     * @defaultValue `false`
+     * @remarks If `relativeLinks` is `true`, a valid `document` must be passed or construction will throw
+     */
+    relativeLinks: true;
   }
+
+  type ConstructionOptions = ConstructionOptionsRelative | ConstructionOptionsNoRelative;
 }
 
 export default ProseMirrorContentLinkPlugin;

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 { AnyObject } from "#utils";
 
 export default ProseMirrorDirtyPlugin;
 
@@ -9,5 +9,5 @@ export default ProseMirrorDirtyPlugin;
  * A simple plugin that records the dirty state of the editor.
  */
 declare class ProseMirrorDirtyPlugin extends ProseMirrorPlugin {
-  static override build(schema: Schema, options?: EmptyObject): Plugin;
+  static override build(schema: Schema, options?: AnyObject): Plugin;
 }

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

@@ -1,10 +1,10 @@
-import { DOMParser as BaseDOMParser, Node, ParseOptions, Schema } from "prosemirror-model";
-import type { FixedInstanceType } from "fvtt-types/utils";
-
-export default DOMParser;
+import type { DOMParser as BaseDOMParser, Node, ParseOptions, Schema } from "prosemirror-model";
+import type { FixedInstanceType } from "#utils";
 
 declare class DOMParser extends BaseDOMParser {
   override parse(dom: FixedInstanceType<typeof window.Node>, options?: ParseOptions): Node;
 
   static override fromSchema(schema: Schema): BaseDOMParser;
 }
+
+export default DOMParser;

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

@@ -1,35 +1,25 @@
-import type { ProseMirrorDropDown as ProseMirrorDropDownMenu } from "./menu.d.mts";
-
-interface Options {
-  /** The menu CSS class name. Required if providing an action. */
-  cssClass?: string;
-  /** Use an icon for the dropdown rather than a text label. */
-  icon?: string;
-  /** A callback to fire when a menu item is clicked. */
-  onAction?: (event: MouseEvent) => void;
-}
+import type { InexactPartial } from "#utils";
+import type ProseMirrorMenu from "./menu.d.mts";
 
-export default ProseMirrorDropDown;
 declare class ProseMirrorDropDown {
   /**
    * A class responsible for rendering a menu drop-down.
    * @param title - The default title.
    * @param items - The configured menu items.
    */
-  constructor(title: string, items: ProseMirrorDropDownMenu.Entry[], options?: Options);
-
-  // placeholder private attribute to limit what can count as a subtype at compile time
-  #proseMirrorDropDown: true;
+  constructor(title: string, items: ProseMirrorDropDown.Entry[], options?: ProseMirrorDropDown.ConstructionOptions);
 
   /**
    * The default title for this drop-down.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
   readonly title: string;
 
   /**
    * The items configured for this drop-down.
+   * @remarks `defineProperty`'d in construction, explicitly `writable: false`
    */
-  readonly items: ProseMirrorDropDownMenu.Entry[];
+  readonly items: ProseMirrorDropDown.Entry[];
 
   /**
    * Attach event listeners.
@@ -47,19 +37,61 @@ declare class ProseMirrorDropDown {
    * Recurse through the menu structure and apply a function to each item in it.
    * @param fn - The function to call on each item. Return false to prevent iterating over any further items.
    */
-  forEachItem(/** @immediate */ fn: (entry: ProseMirrorDropDownMenu.Entry) => boolean): void;
+  forEachItem(/** @immediate */ fn: (entry: ProseMirrorDropDown.Entry) => boolean): void;
 
   /**
    * Render a list of drop-down menu items.
    * @param entries - The menu items.
    * @returns HTML contents as a string.
    */
-  protected static _renderMenu(entries: ProseMirrorDropDownMenu.Entry[]): string;
+  protected static _renderMenu(entries: ProseMirrorDropDown.Entry[]): string;
 
   /**
    * Render an individual drop-down menu item.
    * @param item - The menu item.
    * @returns HTML contents as a string.
    */
-  protected static _renderMenuItem(item: ProseMirrorDropDownMenu.Entry): string;
+  protected static _renderMenuItem(item: ProseMirrorDropDown.Entry): string;
+
+  #ProseMirrorDropDown: true;
+}
+
+declare namespace ProseMirrorDropDown {
+  /** @internal */
+  type _ConstructionOptions = InexactPartial<{
+    /** The menu CSS class name. Required if providing an action. */
+    cssClass: string;
+
+    /** Use an icon for the dropdown rather than a text label. */
+    icon: string;
+
+    /** A callback to fire when a menu item is clicked. */
+    onAction: (event: MouseEvent) => void;
+  }>;
+
+  interface ConstructionOptions extends _ConstructionOptions {}
+
+  interface Entry extends ProseMirrorMenu.Item {
+    /** Any child entries. */
+    children?: Entry[] | undefined;
+  }
+
+  interface Config {
+    /** The default title of the drop-down. */
+    title: string;
+
+    /** The menu CSS class. */
+    cssClass: string;
+
+    /**
+     * An optional icon to use instead of a text label.
+     * @remarks Takes the form of an HTML string, e.g `'<i class="fa-solid fa-table fa-fw"></i>'`
+     */
+    icon?: string | undefined;
+
+    /** The drop-down entries. */
+    entries: Entry[];
+  }
 }
+
+export default ProseMirrorDropDown;

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

@@ -1,4 +1,4 @@
-import type { NodeType } from "prosemirror-model";
+import type { Attrs, NodeType } from "prosemirror-model";
 
 declare module "prosemirror-model" {
   interface ResolvedPos {
@@ -6,7 +6,10 @@ declare module "prosemirror-model" {
      * Determine whether a given position has an ancestor node of the given type.
      * @param other - The other node type.
      * @param attrs - An object of attributes that must also match, if provided.
+     * @privateRemarks {@linkcode foundry.prosemirror.ProseMirrorMenu._toggleBlock | ProseMirrorMenu#_toggleBlock} and
+     * {@linkcode foundry.prosemirror.ProseMirrorMenu._toggleTextBlock | #_toggleTextBlock} call this with an `attrs`
+     * parameter that has a default of `null`
      */
-    hasAncestor(other: NodeType, attrs?: ReturnType<ResolvedPos["node"]>["attrs"]): boolean;
+    hasAncestor(other: NodeType, attrs?: Attrs | null): boolean;
   }
 }