fvtt-types/src/foundry/common/_types.d.mts

TypeScript type definitions for Foundry VTT

/* eslint-disable @typescript-eslint/no-unused-vars */

import type { AnyConcreteConstructor, AnyConstructor, AnyFunction } from "#utils";
import type { Canvas } from "#client/canvas/_module.d.mts";
import type { Document } from "./abstract/_module.d.mts";

import ClientSettings = foundry.helpers.ClientSettings;
import ClientKeybindings = foundry.helpers.interaction.ClientKeybindings;
import SocketInterface = foundry.helpers.SocketInterface;

export {};

// After seeing that none of these types add anything or are even exported a
// very reasonable question may be: Why on earth does this file exist?
//
// Well this is the file in which Foundry defines these types. We don't house
// them here because it has poor discoverability. The names Foundry has chosen
// also overlaps with other existing names, such as SettingConfig vs. ClientSetting.SettingConfig

type DocumentConstructionContext = Document.ConstructionContext<Document.Any | null>;

/**
 * Make all properties in T recursively readonly.
 * @privateRemarks We have better tools & this is only used in a private method
 */
type DeepReadonly<T> = Readonly<{
  [K in keyof T]: T[K] extends
    | undefined
    | null
    | boolean
    | number
    | string
    | symbol
    | bigint
    | AnyFunction
    | AnyConstructor
    | AnyConcreteConstructor
    ? T[K]
    : T[K] extends Array<infer V>
      ? ReadonlyArray<DeepReadonly<V>>
      : T[K] extends Map<infer K, infer V>
        ? ReadonlyMap<DeepReadonly<K>, DeepReadonly<V>>
        : T[K] extends Set<infer V>
          ? ReadonlySet<DeepReadonly<V>>
          : DeepReadonly<T[K]>;
}>;

/**
 * A class constructor.
 * Used for functions with generic class constructor parameters.
 * @privateRemarks We have better tools like {@linkcode AnyConcreteConstructor} and {@linkcode AnyConstructor}
 */
type Constructor = new (...args: any[]) => any;

type Point = Canvas.Point;

type PointArray = Canvas.PointTuple;

type ElevatedPoint = Canvas.ElevatedPoint;

type Rectangle = Canvas.Rectangle;

type BuiltinTypes = typeof Number | typeof String | typeof Boolean;

type ColorSource = foundry.utils.Color.Source;

type SettingConfig = ClientSettings.SettingConfig;

type SettingSubmenuConfig = ClientSettings.SettingSubmenuConfig;

type KeyBindingActionConfig = ClientKeybindings.StoredKeybindingActionConfig;

type KeybindingActionBinding = ClientKeybindings.StoredKeybindingActionBinding;

type KeybindingAction = ClientKeybindings.KeybindingAction;

type KeyboardEventContext = foundry.helpers.interaction.KeyboardManager.KeyboardEventContext;

type ConnectedGamepad = foundry.helpers.interaction.GamepadManager.ConnectedGamepad;

type RequestData = SocketInterface.RequestData;

type SocketRequest = SocketInterface.SocketRequest;

type SocketResponse = SocketInterface.SocketResponse;