@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.2-beta

package/src/foundry/client/core/image.d.ts

@@ -1,129 +0,0 @@
-/**
- * A helper class to provide common functionality for working with Image objects
- */
-// eslint-disable-next-line @typescript-eslint/no-extraneous-class
-declare class ImageHelper {
-  /**
-   * Create thumbnail preview for a provided image path.
-   * @param src     - The string URL or DisplayObject of the texture to render to a thumbnail
-   * @param options - Additional named options passed to the {@link ImageHelper.compositeCanvasTexture} method
-   *                  (default: `{}`)
-   * @returns The parsed and converted thumbnail data
-   */
-  static createThumbnail(
-    src: string | PIXI.DisplayObject,
-    options?: ImageHelper.CompositeOptions & ImageHelper.TextureToImageOptions
-  ): Promise<ImageHelper.ThumbnailReturn>;
-
-  /* -------------------------------------------- */
-
-  /**
-   * Composite a canvas object by rendering it to a single texture
-   * @param object  - The DisplayObject to render to a texture
-   * @param options - Additional named options
-   *                  (default: `{}`)
-   * @returns The composite Texture object
-   */
-  static compositeCanvasTexture(object: PIXI.DisplayObject, options?: ImageHelper.CompositeOptions): PIXI.Texture;
-
-  /* -------------------------------------------- */
-
-  /**
-   * Extract a texture to a base64 PNG string
-   * @param texture - The Texture object to extract
-   * @param options - (default: `{}`)
-   * @returns A base64 png string of the texture
-   */
-  static textureToImage(texture: PIXI.Texture, { format, quality }?: ImageHelper.TextureToImageOptions): string;
-
-  /**
-   * Asynchronously convert a DisplayObject container to base64 using Canvas#toBlob and FileReader
-   * @param target  - A PIXI display object to convert
-   * @param type    - The requested mime type of the output, default is image/png
-   * @param quality - A number between 0 and 1 for image quality if image/jpeg or image/webp
-   * @returns A processed base64 string
-   */
-  static pixiToBase64(target: PIXI.DisplayObject, type: string, quality: number): Promise<string>;
-}
-
-declare namespace ImageHelper {
-  /**
-   * An interface for options for the {@link ImageHelper.createThumbnail} and {@link ImageHelper.compositeCanvasTexture}
-   * methods.
-   */
-  interface CompositeOptions {
-    /**
-     * Center the texture in the rendered frame?
-     * @defaultValue `true`
-     */
-    center?: boolean;
-
-    /**
-     * The desired height of the output texture
-     * @defaultValue The height of the object passed to {@link ImageHelper.compositeCanvasTexture}
-     */
-    height?: number;
-
-    /**
-     * A horizontal translation to apply to the object
-     * @defaultValue `0`
-     */
-    tx?: number;
-
-    /**
-     * A vertical translation to apply to the object
-     * @defaultValue `0`
-     */
-    ty?: number;
-
-    /**
-     * The desired width of the output texture
-     * @defaultValue The width of the object passed to {@link ImageHelper.compositeCanvasTexture}
-     */
-    width?: number;
-  }
-
-  interface TextureToImageOptions {
-    /**
-     * Image format, e.g. "image/jpeg" or "image/webp".
-     * @defaultValue `"image/png"`
-     */
-    format?: string;
-
-    /**
-     * JPEG or WEBP compression from 0 to 1. Default is 0.92.
-     * @defaultValue `0.92`
-     */
-    quality?: number;
-  }
-
-  /**
-   * An interface for return values of the {@link ImageHelper.createThumbnail} method.
-   */
-  interface ThumbnailReturn {
-    /**
-     * The height of the {@link PIXI.Sprite}, created by {@link ImageHelper.createThumbnail}
-     */
-    height: number;
-
-    /**
-     * The originally passed `string` URL or DisplayObject
-     */
-    src: string | PIXI.DisplayObject;
-
-    /**
-     * The Texture, returned from {@link ImageHelper.compositeCanvasTexture}, with `destroy(true)` already called on it.
-     */
-    texture: PIXI.Texture;
-
-    /**
-     * The base64 encoded image data, returned from {@link ImageHelper.textureToImage}
-     */
-    thumb: string;
-
-    /**
-     * The width of the {@link PIXI.Sprite}, created by {@link ImageHelper.createThumbnail}
-     */
-    width: number;
-  }
-}

package/src/foundry/client/core/index.d.ts

@@ -1,13 +0,0 @@
-import './gamepad';
-import './hooks';
-import './image';
-import './keybindings';
-import './keyboard';
-import './mouse';
-import './nue';
-import './settings';
-import './socket';
-import './sorting';
-import './time';
-import './utils';
-import './video';

package/src/foundry/client/core/keybindings.d.ts

@@ -1,298 +0,0 @@
-/**
- * A class responsible for managing defined game keybinding.
- * Each keybinding is a string key/value pair belonging to a certain namespace and a certain store scope.
- *
- * When Foundry Virtual Tabletop is initialized, a singleton instance of this class is constructed within the global
- * Game object as as game.keybindings.
- *
- * @see {@link Game#keybindings}
- * @see {@link SettingKeybindingConfig}
- * @see {@link KeybindingsConfig}
- */
-declare class ClientKeybindings {
-  constructor();
-
-  /** Registered Keybinding actions */
-  actions: Map<string, KeybindingActionConfig>;
-
-  /** A mapping of a string key to possible Actions that might execute off it */
-  activeKeys: Map<string, KeybindingAction[]>;
-
-  /**
-   * A stored cache of Keybind Actions Ids to Bindings
-   * @remarks This is only undefined before the "ready" hook.
-   */
-  bindings: Map<string, KeybindingActionBinding[]> | undefined;
-
-  /**
-   * A count of how many registered keybindings there are
-   * @internal
-   * @defaultValue `0`
-   */
-  protected _registered: number;
-
-  /**
-   * A timestamp which tracks the last time a pan operation was performed
-   * @internal
-   * @defaultValue `0`
-   */
-  protected _moveTime: number;
-
-  static MOVEMENT_DIRECTIONS: ClientKeybindings.MovementDirections;
-
-  static ZOOM_DIRECTIONS: ClientKeybindings.ZoomDirections;
-
-  /**
-   * An alias of the movement key set tracked by the keyboard
-   */
-  get moveKeys(): Set<string>;
-
-  /** Initializes the keybinding values for all registered actions */
-  initialize(): void;
-
-  /**
-   * Register a new keybinding
-   *
-   * @param namespace - The namespace the Keybinding Action belongs to
-   * @param action    - A unique machine-readable id for the Keybinding Action
-   * @param data      - Configuration for keybinding data
-   *
-   * @example <caption>Define a keybinding which shows a notification</caption>
-   * ```typescript
-   * game.keybindings.register("myModule", "showNotification", {
-   *   name: "My Settings Keybinding",
-   *   hint: "A description of what will occur when the Keybinding is executed.",
-   *   uneditable: [
-   *     {
-   *       key: "Digit1",
-   *       modifiers: ["Control"]
-   *     }
-   *   ],
-   *   editable: [
-   *     {
-   *       key: "F1"
-   *     }
-   *   ],
-   *   onDown: () => { ui.notifications.info("Pressed!") },
-   *   onUp: () => {},
-   *   restricted: true,                         // Restrict this Keybinding to gamemaster only?
-   *   reservedModifiers: ["Alt""],              // If the ALT modifier is pressed, the notification is permanent instead of temporary
-   *   precedence: CONST.KEYBINDING_PRECEDENCE.NORMAL
-   * }
-   * ```
-   * @throws if called after `this.bindings` has been initialized.
-   */
-  register(namespace: string, action: string, data: KeybindingActionConfig): void;
-
-  /**
-   * Get the current Bindings of a given namespace's Keybinding Action
-   *
-   * @param namespace - The namespace under which the setting is registered
-   * @param action    - The keybind action to retrieve
-   *
-   * @example <caption>Retrieve the current Keybinding Action Bindings</caption>
-   * ```typescript
-   * game.keybindings.get("myModule", "showNotification");
-   * ```
-   */
-  get(namespace: string, action: string): KeybindingActionBinding[];
-
-  /**
-   * Set the editable Bindings of a Keybinding Action for a certain namespace and Action
-   *
-   * @param namespace - The namespace under which the Keybinding is registered
-   * @param action    - The Keybinding action to set
-   * @param bindings  - The Bindings to assign to the Keybinding
-   *
-   * @example <caption>Update the current value of a keybinding</caption>
-   * ```typescript
-   * game.keybindings.set("myModule", "showNotification", [
-   *     {
-   *       key: "F2",
-   *       modifiers: [ "CONTROL" ]
-   *     }
-   * ]);
-   * ```
-   * @remarks Passing `undefined` or nothing as `bindings` resets to the default.
-   */
-  set(namespace: string, action: string, bindings?: KeybindingActionBinding[] | undefined): Promise<void>;
-
-  /** Reset all client keybindings back to their default configuration. */
-  resetDefaults(): Promise<void>;
-
-  /**
-   * A helper method that, when given a value, ensures that the returned value is a standardized Binding array
-   * @param values - An array of keybinding assignments to be validated
-   * @returns An array of keybinding assignments confirmed as valid
-   * @internal
-   */
-  protected static _validateBindings(values: Array<KeybindingActionBinding>): Array<Required<KeybindingActionBinding>>;
-
-  /**
-   * Validate that assigned modifiers are allowed
-   * @param keys - An array of modifiers which may be valid
-   * @returns An array of modifiers which are confirmed as valid
-   * @internal
-   */
-  protected static _validateModifiers(keys: string[]): string[];
-
-  /**
-   * Compares two Keybinding Actions based on their Order
-   * @param a - The first Keybinding Action
-   * @param b - the second Keybinding Action
-   */
-  protected static _compareActions(a: KeybindingAction, b: KeybindingAction): number;
-
-  /** Register core keybindings */
-  protected _registerCoreKeybindings(): void;
-
-  /**
-   * Handle Select all action
-   * @param event   - The originating keyboard event
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onSelectAllObjects(event?: KeyboardEvent, context?: KeyboardEventContext): boolean;
-
-  /**
-   * Handle Cycle View actions
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onCycleView(context: KeyboardEventContext): boolean;
-
-  /**
-   * Handle Dismiss actions
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onDismiss(context?: KeyboardEventContext): boolean;
-
-  /**
-   * Open Character sheet for current token or controlled actor
-   * @param event   -
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onToggleCharacterSheet(event?: KeyboardEvent, context?: KeyboardEventContext): ActorSheet | null;
-
-  /**
-   * Handle action to target the currently hovered token.
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onTarget(context: KeyboardEventContext): boolean;
-
-  /**
-   * Handle DELETE Keypress Events
-   * @param event   - The originating keyboard event
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onDelete(event: KeyboardEvent, context?: KeyboardEventContext): boolean;
-
-  /**
-   * Handle keyboard movement once a small delay has elapsed to allow for multiple simultaneous key-presses.
-   * @param context - The context data of the event
-   * @param layer   - The Placeables layer
-   * @internal
-   */
-  protected _handleMovement(context: KeyboardEventContext, layer: TokenLayer | BackgroundLayer): void;
-
-  /** Handle panning the canvas using CTRL + directional keys */
-  protected _handleCanvasPan(): ReturnType<Canvas['animatePan']>;
-
-  /**
-   * Handle Measured Ruler Movement Action
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onMeasuredRulerMovement(context?: KeyboardEventContext): boolean | void;
-
-  /**
-   * Handle Pause Action
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onPause(context?: KeyboardEventContext): true;
-
-  /**
-   * Handle Highlight action
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onHighlight(context?: KeyboardEventContext): boolean;
-
-  /**
-   * Handle Pan action
-   * @param context            - The context data of the event
-   * @param movementDirections - The Directions being panned in
-   * @internal
-   */
-  protected _onPan(context: KeyboardEventContext, movementDirections: ClientKeybindings.MovementDirection[]): boolean;
-
-  /**
-   * Handle Macro executions
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onMacroExecute(
-    context: KeyboardEventContext,
-    number: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
-  ): boolean;
-
-  /**
-   * Handle Macro page swaps
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onMacroPageSwap(context: KeyboardEventContext, page: number): true;
-
-  /**
-   * Handle action to copy data to clipboard
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onCopy(context?: KeyboardEventContext): boolean;
-
-  /**
-   * Handle Paste action
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onPaste(context: KeyboardEventContext): boolean;
-
-  /**
-   * Handle Undo action
-   * @param context - The context data of the event
-   * @internal
-   */
-  protected static _onUndo(context?: KeyboardEventContext): boolean;
-
-  /**
-   * Handle presses to keyboard zoom keys
-   * @param context       - The context data of the event
-   * @param zoomDirection - The direction to zoom
-   * @internal
-   */
-  protected static _onZoom(
-    context: KeyboardEventContext | unknown,
-    zoomDirection: ClientKeybindings.ZoomDirection
-  ): boolean;
-}
-
-declare namespace ClientKeybindings {
-  type MovementDirections = {
-    UP: 'up';
-    LEFT: 'left';
-    DOWN: 'down';
-    RIGHT: 'right';
-  };
-  type MovementDirection = ValueOf<MovementDirections>;
-
-  type ZoomDirections = {
-    IN: 'in';
-    OUT: 'out';
-  };
-  type ZoomDirection = ValueOf<ZoomDirections>;
-}

package/src/foundry/client/core/keyboard.d.ts

@@ -1,247 +0,0 @@
-/**
- * A set of helpers and management functions for dealing with user input from keyboard events.
- * {@link https://keycode.info/}
- */
-declare class KeyboardManager {
-  constructor();
-
-  /**
-   * The set of key codes which are currently depressed (down)
-   */
-  downKeys: Set<string>;
-
-  /**
-   * The set of movement keys which were recently pressed
-   */
-  moveKeys: Set<string>;
-
-  /**
-   * Allowed modifier keys
-   */
-  static MODIFIER_KEYS: {
-    CONTROL: 'Control';
-    SHIFT: 'Shift';
-    ALT: 'Alt';
-  };
-
-  /**
-   * Track which KeyboardEvent#code presses associate with each modifier
-   */
-  static MODIFIER_CODES: {
-    Alt: ['AltLeft', 'AltRight'];
-    Control: ['ControlLeft', 'ControlRight', 'MetaLeft', 'MetaRight'];
-    Shift: ['ShiftLeft', 'ShiftRight'];
-  };
-
-  /**
-   * Key codes which are "protected" and should not be used because they are reserved for browser-level actions.
-   */
-  static PROTECTED_KEYS: ['F5', 'F11', 'F12', 'PrintScreen', 'ScrollLock', 'NumLock', 'CapsLock'];
-
-  /** The OS-specific string display for what their Command key is */
-  static CONTROL_KEY_STRING: '⌘' | 'Control';
-
-  /**
-   * An special mapping of how special KeyboardEvent#code values should map to displayed strings or symbols.
-   * Values in this configuration object override any other display formatting rules which may be applied.
-   */
-  static KEYCODE_DISPLAY_MAPPING: {
-    ArrowLeft: '🡸';
-    ArrowRight: '🡺';
-    ArrowUp: '🡹';
-    ArrowDown: '🡻';
-    Backquote: '`';
-    Backslash: '\\';
-    BracketLeft: '[';
-    BracketRight: ']';
-    Comma: ',';
-    Equal: '=';
-    MetaLeft: '⌘' | '⊞';
-    Minus: '-';
-    NumpadAdd: 'Numpad+';
-    NumpadSubtract: 'Numpad-';
-    Period: '.';
-    Quote: "'";
-    Semicolon: ';';
-    Slash: '/';
-  };
-
-  /**
-   * Test whether a Form Element currently has focus
-   */
-  get hasFocus(): boolean;
-
-  /**
-   * Emulates a key being pressed, triggering the Keyboard event workflow.
-   * @param up       - If True, emulates the `keyup` Event. Else, the `keydown` event
-   * @param code     - The KeyboardEvent#code which is being pressed
-   * @param altKey   - Emulate the ALT modifier as pressed
-   *                   (default: `false`)
-   * @param ctrlKey  - Emulate the CONTROL modifier as pressed
-   *                   (default: `false`)
-   * @param shiftKey - Emulate the SHIFT modifier as pressed
-   *                   (default: `false`)
-   * @param repeat   - Emulate this as a repeat event
-   *                   (default: `false`)
-   */
-  static emulateKeypress(
-    up: boolean,
-    key: string,
-    {
-      altKey,
-      ctrlKey,
-      shiftKey,
-      repeat
-    }?: { altKey?: boolean; ctrlKey?: boolean; shiftKey?: boolean; repeat?: boolean }
-  ): KeyboardEventContext;
-
-  /**
-   * Format a KeyboardEvent#code into a displayed string.
-   * @param code - The input code
-   * @returns The displayed string for this code
-   */
-  static getKeycodeDisplayString(code: string): string;
-
-  /**
-   * Get a standardized keyboard context for a given event.
-   * Every individual keypress is uniquely identified using the KeyboardEvent#code property.
-   * A list of possible key codes is documented here: https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values
-   *
-   * @param event - The originating keypress event
-   * @param up    - A flag for whether the key is down or up
-   *                (default: `false`)
-   * @returns The standardized context of the event
-   */
-  static getKeyboardEventContext(event: KeyboardEvent, up: boolean): KeyboardEventContext;
-
-  /**
-   * Report whether a modifier in KeyboardManager.MODIFIER_KEYS is currently actively depressed.
-   * @param modifier - A modifier in MODIFIER_KEYS
-   * @returns Is this modifier key currently down (active)?
-   */
-  isModifierActive(modifier: string): boolean;
-
-  /**
-   * Converts a Keyboard Context event into a string representation, such as "C" or "Control+C"
-   * @param context          - The standardized context of the event
-   * @param includeModifiers - If True, includes modifiers in the string representation
-   *                           (default: `true`)
-   * @internal
-   */
-  protected static _getContextDisplayString(context: KeyboardEventContext, includeModifiers?: boolean): string;
-
-  /**
-   * Given a standardized pressed key, find all matching registered Keybind Actions.
-   * @param context - A standardized keyboard event context
-   * @returns The matched Keybind Actions. May be empty.
-   */
-  protected static _getMatchingActions(context: KeyboardEventContext): KeybindingAction[];
-
-  /**
-   * Test whether a keypress context matches the registration for a keybinding action
-   * @param action  - The keybinding action
-   * @param context - The keyboard event context
-   * @returns Does the context match the action requirements?
-   * @internal
-   */
-  protected static _testContext(action: KeybindingAction, context: KeyboardEventContext): boolean;
-
-  /**
-   * Given a registered Keybinding Action, executes the action with a given event and context
-   *
-   * @param keybind - The registered Keybinding action to execute
-   * @param context - The gathered context of the event
-   * @returns Returns true if the keybind was consumed
-   * @internal
-   */
-  protected static _executeKeybind(keybind: KeybindingAction, context: KeyboardEventContext): boolean;
-
-  /**
-   * Processes a keyboard event context, checking it against registered keybinding actions
-   * @param context - The keyboard event context
-   * @internal
-   */
-  protected _processKeyboardContext(context: KeyboardEventContext): void;
-
-  /**
-   * Reset tracking for which keys are in the down and released states
-   * @internal
-   */
-  protected _reset(): void;
-
-  /**
-   * Handle a key press into the down position
-   * @param event - The originating keyboard event
-   * @param up    - A flag for whether the key is down or up
-   * @internal
-   */
-  protected _handleKeyboardEvent(event: KeyboardEvent, up: boolean): void;
-
-  /**
-   * Input events do not fire with isComposing = false at the end of a composition event in Chrome
-   * See: https://github.com/w3c/uievents/issues/202
-   */
-  protected _onCompositionEnd(event: CompositionEvent): void;
-
-  /** @deprecated since v9, will be removed in v10 */
-  static get MOUSE_WHEEL_RATE_LIMIT(): number;
-
-  /**
-   * @deprecated since V9, will be removed in V10
-   * Return whether the key code is currently in the DOWN state
-   * @param code - The key code to test
-   */
-  isDown(code: string): boolean;
-
-  /** @deprecated since v9, will be removed in v10 */
-  static isControl(event: KeyboardEvent | PIXI.InteractionEvent): boolean;
-
-  /**
-   * @deprecated since v9, will be removed in v10
-   * @see KeyboardManager.isControl
-   */
-  isCtrl(event: Event | PIXI.InteractionEvent): boolean;
-
-  /** @deprecated since v9, will be removed in v10 */
-  get _downKeys(): Set<string>;
-
-  /** @deprecated since v9, will be removed in v10 */
-  static DIGIT_KEYS: ['1', '2', '3', '4', '5', '6', '7', '8', '9', '0'];
-
-  /** @deprecated since v9, will be removed in v10 */
-  static MOVEMENT_KEYS: {
-    W: ['up'];
-    A: ['left'];
-    S: ['down'];
-    D: ['right'];
-    ARROWUP: ['up'];
-    ARROWRIGHT: ['right'];
-    ARROWDOWN: ['down'];
-    ARROWLEFT: ['left'];
-    NUMPAD1: ['down', 'left'];
-    NUMPAD2: ['down'];
-    NUMPAD3: ['down', 'right'];
-    NUMPAD4: ['left'];
-    NUMPAD6: ['right'];
-    NUMPAD7: ['up', 'left'];
-    NUMPAD8: ['up'];
-    NUMPAD9: ['up', 'right'];
-  };
-
-  /** @deprecated since v9, will be removed in v10 */
-  static ZOOM_KEYS: {
-    PAGEUP: 'in';
-    PAGEDOWN: 'out';
-    NUMPADADD: 'in';
-    NUMPADSUBTRACT: 'out';
-  };
-
-  /** @deprecated since v9, will be removed in v10 */
-  static standardizeKey(key: string): string;
-
-  /** @deprecated since v9, will be removed in v10 */
-  get digitKeys(): typeof KeyboardManager.DIGIT_KEYS;
-
-  /** @deprecated since v9, will be removed in v10 */
-  get zoomKeys(): KeybindingActionBinding[];
-}

package/src/foundry/client/core/mouse.d.ts

@@ -1,18 +0,0 @@
-/** Management class for Mouse events */
-declare class MouseManager {
-  constructor();
-
-  /**
-   * Specify a rate limit for mouse wheel to gate repeated scrolling.
-   * This is especially important for continuous scrolling mice which emit hundreds of events per second.
-   * This designates a minimum number of milliseconds which must pass before another wheel event is handled
-   * @defaultValue `50`
-   */
-  static MOUSE_WHEEL_RATE_LIMIT: number;
-
-  /**
-   * Master mouse-wheel event handler
-   * @internal
-   */
-  protected _onWheel(event: MouseEvent): void;
-}