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

package/src/foundry/client/pixi/core/interaction/mouse-handler.d.ts

@@ -1,323 +0,0 @@
-/**
- * Handle mouse interaction events for a Canvas object.
- * There are three phases of events: hover, click, and drag
- *
- * Hover Events:
- * _handleMouseOver
- *  action: hoverIn
- * _handleMouseOut
- *  action: hoverOut
- *
- * Left Click and Double-Click
- * _handleMouseDown
- *  action: clickLeft
- *  action: clickLeft2
- *
- * Right Click and Double-Click
- * _handleRightDown
- *  action: clickRight
- *  action: clickRight2
- *
- * Drag and Drop
- * _handleMouseMove
- *  action: dragLeftStart
- *  action: dragLeftMove
- *  action: dragRightStart
- *  action: dragLeftMove
- * _handleMouseUp
- *  action: dragLeftDrop
- *  action: dragRightDrop
- * _handleDragCancel
- *  action: dragLeftCancel
- *  action: dragRightCancel
- *
- * @typeParam Object - The concrete {@link PIXI.Container} object that for which mouse interactions are being managed
- */
-declare class MouseInteractionManager<Object extends PIXI.Container = PIXI.Container> {
-  /**
-   * @param permissions - (default: `{}`)
-   * @param callbacks   - (default: `{}`)
-   * @param options     - (default: `{}`)
-   */
-  constructor(
-    object: Object,
-    layer: MouseInteractionManager['layer'],
-    permissions?: MouseInteractionManager['permissions'],
-    callbacks?: MouseInteractionManager['callbacks'],
-    options?: MouseInteractionManager['options']
-  );
-
-  object: Object;
-
-  layer: PIXI.Container;
-
-  /**
-   * @defaultValue `{}`
-   */
-  permissions: Partial<
-    Record<
-      MouseInteractionManager.PermissionAction,
-      ((user: Game['user'], event: PIXI.InteractionEvent) => boolean) | boolean
-    >
-  >;
-
-  /**
-   * @defaultValue `{}`
-   */
-  callbacks: Partial<Record<MouseInteractionManager.Action, ((event: Event | PIXI.InteractionEvent) => void) | null>>;
-
-  /**
-   * @defaultValue `{}`
-   */
-  options: MouseInteractionManager.Options;
-
-  /**
-   * The current interaction state
-   * @defaultValue `MouseInteractionManager.INTERACTION_STATES.NONE`
-   */
-  state: ValueOf<typeof MouseInteractionManager['INTERACTION_STATES']>;
-
-  /**
-   * Bound handlers which can be added and removed
-   * @defaultValue `{}`
-   */
-  handlers: Partial<
-    Record<
-      'contextmenu' | 'mousedown' | 'mousemove' | 'mouseout' | 'mouseover' | 'mouseup' | 'rightdown',
-      (event: PIXI.InteractionEvent | MouseEvent) => void
-    >
-  >;
-
-  /**
-   * The drag handling time
-   * @defaultValue `0`
-   */
-  dragTime: number;
-
-  /**
-   * The throttling time below which a mouse move event will not be handled
-   * @defaultValue `Math.ceil(1000 / (canvas.app.ticker.maxFPS || 60));`
-   * @internal
-   */
-  protected _dragThrottleMS: number;
-
-  /**
-   * The time of the last left-click event
-   * @defaultValue `0`
-   */
-  lcTime: number;
-
-  /**
-   * The time of the last right-click event
-   * @defaultValue `0`
-   */
-  rcTime: number;
-
-  /**
-   * A flag for whether we are right-click dragging
-   * @defaultValue `false`
-   */
-  protected _dragRight: boolean;
-
-  /**
-   * An optional ControlIcon instance for the object
-   */
-  controlIcon: ControlIcon | undefined;
-
-  /**
-   * Enumerate the states of a mouse interaction workflow.
-   * 0: NONE - the object is inactive
-   * 1: HOVER - the mouse is hovered over the object
-   * 2: CLICKED - the object is clicked
-   * 3: DRAG - the object is being dragged
-   * 4: DROP - the object is being dropped
-   */
-  static INTERACTION_STATES: {
-    NONE: 0;
-    HOVER: 1;
-    CLICKED: 2;
-    DRAG: 3;
-    DROP: 4;
-  };
-
-  /**
-   * Get the target
-   */
-  get target(): PIXI.Container;
-
-  /**
-   * Activate interactivity for the handled object
-   */
-  activate(): this;
-
-  /**
-   * Test whether the current user has permission to perform a step of the workflow
-   * @param action - The action being attempted
-   * @param event  - The event being handled
-   * @returns Can the action be performed?
-   */
-  can(action: MouseInteractionManager.PermissionAction, event: Event | PIXI.InteractionEvent): boolean;
-
-  /**
-   * Execute a callback function associated with a certain action in the workflow
-   * @param action - The action being attempted
-   * @param event  - The event being handled
-   */
-  callback(action: MouseInteractionManager.Action, event: Event | PIXI.InteractionEvent): unknown;
-
-  /**
-   * A reference to the possible interaction states which can be observed
-   */
-  get states(): typeof MouseInteractionManager['INTERACTION_STATES'];
-
-  /**
-   * Activate a set of listeners which handle hover events on the target object
-   * @internal
-   */
-  protected _activateHoverEvents(): void;
-
-  /**
-   * Activate a new set of listeners for click events on the target object
-   * @internal
-   */
-  protected _activateClickEvents(): void;
-
-  /**
-   * Deactivate event listeners for click events on the target object
-   * @internal
-   */
-  protected _deactivateClickEvents(): void;
-
-  /**
-   * Activate events required for handling a drag-and-drop workflow
-   * @internal
-   */
-  protected _activateDragEvents(): void;
-
-  /**
-   * Deactivate events required for handling drag-and-drop workflow.
-   * @internal
-   */
-  protected _deactivateDragEvents(): void;
-
-  /**
-   * Handle mouse-over events which activate downstream listeners and do not stop propagation.
-   * @internal
-   */
-  protected _handleMouseOver(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle mouse-out events which terminate hover workflows and do not stop propagation.
-   * @internal
-   */
-  protected _handleMouseOut(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle mouse-down events which activate downstream listeners.
-   * Stop further propagation only if the event is allowed by either single or double-click.
-   * @internal
-   */
-  protected _handleMouseDown(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle mouse-down which trigger a single left-click workflow.
-   * @internal
-   */
-  protected _handleClickLeft(event: PIXI.InteractionEvent): void;
-
-  /**
-   * Handle mouse-down which trigger a single left-click workflow.
-   * @internal
-   */
-  protected _handleClickLeft2(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle right-click mouse-down events.
-   * Stop further propagation only if the event is allowed by either single or double-click.
-   * @internal
-   */
-  protected _handleRightDown(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle single right-click actions.
-   * @internal
-   */
-  protected _handleClickRight(event: PIXI.InteractionEvent): void;
-
-  /**
-   * Handle double right-click actions.
-   * @internal
-   */
-  protected _handleClickRight2(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle mouse movement during a drag workflow
-   * @internal
-   */
-  protected _handleMouseMove(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle the beginning of a new drag start workflow, moving all controlled objects on the layer
-   * @internal
-   */
-  protected _handleDragStart(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle the continuation of a drag workflow, moving all controlled objects on the layer
-   * @internal
-   */
-  protected _handleDragMove(event: PIXI.InteractionEvent): unknown;
-
-  /**
-   * Handle mouse up events which may optionally conclude a drag workflow
-   * @internal
-   */
-  protected _handleMouseUp(event: PIXI.InteractionEvent): void;
-
-  /**
-   * Handle the conclusion of a drag workflow, placing all dragged objects back on the layer
-   * @internal
-   */
-  protected _handleDragDrop(event: PIXI.InteractionEvent): void;
-
-  /**
-   * Handle the cancellation of a drag workflow, resetting back to the original state
-   * @internal
-   */
-  protected _handleDragCancel(event: MouseEvent): void;
-
-  /**
-   * A public method to cancel a current interaction workflow from this manager.
-   * @param event - The event that initiates the cancellation
-   */
-  cancel(event: Event): void;
-}
-
-declare namespace MouseInteractionManager {
-  type PermissionAction =
-    | 'clickLeft'
-    | 'clickLeft2'
-    | 'clickRight'
-    | 'clickRight2'
-    | 'dragLeftDrop'
-    | 'dragLeftMove'
-    | 'dragLeftStart'
-    | 'dragRightDrop'
-    | 'dragRightMove'
-    | 'dragRightStart'
-    | 'hoverIn'
-    | 'hoverOut';
-
-  type Action = PermissionAction | 'dragLeftCancel' | 'dragRightCancel';
-
-  interface Options {
-    /**
-     * @remarks If set, this must be the name of a property of the object that is a {@link PIXI.Container}.
-     */
-    target?: string | null;
-
-    dragResistance?: number;
-  }
-}
-
-declare const a: PIXI.Container;

package/src/foundry/client/pixi/core/interaction/resize-handle.d.ts

@@ -1,48 +0,0 @@
-declare class ResizeHandle extends PIXI.Graphics {
-  /**
-   * @param handlers - (default: `{}`)
-   */
-  constructor(offset: ResizeHandle['offset'], handlers?: ResizeHandle['handlers']);
-
-  offset: [widthOffset: number, heightOffset: number];
-
-  handlers: { canDrag?: boolean };
-
-  /**
-   * Track whether the handle is being actively used for a drag workflow
-   * @defaultValue `false`
-   */
-  active: boolean;
-
-  refresh(bounds: Rectangle): void;
-
-  /**
-   * @param aspectRatio - (default: `null`)
-   */
-  updateDimensions(
-    current: Rectangle,
-    origin: Rectangle,
-    destination: Rectangle,
-    { aspectRatio }?: { aspectRatio?: number | null }
-  ): Rectangle;
-
-  activateListeners(): void;
-
-  /**
-   * Handle mouse-over event on a control handle
-   * @param event - The mouseover event
-   */
-  protected _onHoverIn(event: PIXI.InteractionEvent): void;
-
-  /**
-   * Handle mouse-out event on a control handle
-   * @param event - The mouseout event
-   */
-  protected _onHoverOut(event: PIXI.InteractionEvent): void;
-
-  /**
-   * When we start a drag event - create a preview copy of the Tile for re-positioning
-   * @param event - The mousedown event
-   */
-  protected _onMouseDown(event: PIXI.InteractionEvent): void;
-}

package/src/foundry/client/pixi/core/interaction/targets.d.ts

@@ -1,51 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../../types/helperTypes';
-import { ObjectClass } from '../../../../../types/helperTypes';
-
-interface SetReplacementMembers<T> {
-  add(value: T): void;
-  delete(value: T): void;
-  clear(): void;
-}
-
-type PatchedSet<T> = Omit<Set<T>, 'add' | 'delete' | 'clear'> & SetReplacementMembers<T>;
-
-interface PatchedSetConstructor {
-  new <T = any>(values?: readonly T[] | null): PatchedSet<T>;
-  readonly prototype: PatchedSet<any>;
-}
-
-declare const Set: PatchedSetConstructor;
-
-declare global {
-  /**
-   * A subclass of Set which manages the Token ids which the User has targeted.
-   * @see User#targets
-   */
-  class UserTargets extends Set<InstanceType<ObjectClass<typeof TokenDocument>>> {
-    constructor(user: UserTargets['user']);
-
-    user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-
-    /**
-     * Return the Token IDs which are user targets
-     */
-    get ids(): string[];
-
-    /**
-     * @remarks Returns void, but Set<T>.add returns boolean
-     */
-    override add(token: InstanceType<ObjectClass<typeof TokenDocument>>): void;
-
-    override clear(): void;
-
-    /**
-     * @remarks Returns void, but Set<T>.delete returns boolean
-     */
-    override delete(token: InstanceType<ObjectClass<typeof TokenDocument>>): void;
-
-    /**
-     * Dispatch the targetToken hook whenever the user's target set changes
-     */
-    protected _hook(token: InstanceType<ObjectClass<typeof TokenDocument>>, targeted: boolean): void;
-  }
-}

package/src/foundry/client/pixi/core/loader.d.ts

@@ -1,157 +0,0 @@
-import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * A Loader class which helps with loading video and image textures.
-   */
-  class TextureLoader {
-    /**
-     * The duration in milliseconds for which a texture will remain cached
-     * @defaultValue `1000 * 60 * 15`
-     */
-    static CACHE_TTL: number;
-
-    /**
-     * Load all the textures which are required for a particular Scene
-     * @param scene   - The Scene to load
-     * @param options - Additional options that configure texture loading
-     *                  (default: `{}`)
-     */
-    static loadSceneTextures(
-      scene: InstanceType<ConfiguredDocumentClassForName<'Scene'>>,
-      options?: Partial<TextureLoader.LoadSceneTextureOptions>
-    ): Promise<void[]>;
-
-    /**
-     * Load an Array of provided source URL paths
-     * @param sources - The source URLs to load
-     * @param options - Additional options which modify loading
-     * @returns A Promise which resolves once all textures are loaded
-     */
-    load(sources: string[], options?: Partial<TextureLoader.LoadOptions>): Promise<PIXI.BaseTexture | void[]>;
-
-    /**
-     * Load a single texture on-demand from a given source URL path
-     * @param src - The source texture path to load
-     * @returns The loaded texture object
-     */
-    loadTexture(src: string): Promise<PIXI.BaseTexture>;
-
-    /**
-     * Load an image texture from a provided source url.
-     * @param src - The source image URL
-     * @returns The loaded BaseTexture
-     */
-    loadImageTexture(src: string): Promise<PIXI.BaseTexture>;
-
-    /**
-     * @param src - The source video URL
-     * @returns The loaded BaseTexture
-     */
-    loadVideoTexture(src: string): Promise<PIXI.BaseTexture>;
-
-    /**
-     * Use the Fetch API to retrieve a resource and return a Blob instance for it.
-     * @param src     -
-     * @param options - Options to configure the loading behaviour.
-     *                  (default: `{}`)
-     * @returns A Blob containing the loaded data
-     */
-    static fetchResource(src: string, options?: TextureLoader.FetchResourceOptions): Promise<Blob>;
-
-    /**
-     * Add an image url to the texture cache
-     * @param src - The source URL
-     * @param tex - The readied texture
-     */
-    setCache(src: string, tex: PIXI.BaseTexture): void;
-
-    /**
-     * Retrieve a texture from the texture cache
-     * @param src - The source URL
-     */
-    getCache(src: string): PIXI.BaseTexture | undefined;
-
-    /**
-     * Expire (and destroy) textures from the cache which have not been used for more than CACHE_TTL milliseconds.
-     */
-    expireCache(): void;
-
-    /**
-     * Return a URL with a cache-busting query parameter appended.
-     * @param  src - The source URL being attempted
-     * @returns The new URL, or false on a failure.
-     */
-    static getCacheBustURL(src: string): string | false;
-
-    /**
-     * A global reference to the singleton texture loader
-     */
-    static loader: TextureLoader;
-  }
-
-  namespace TextureLoader {
-    interface LoadSceneTextureOptions {
-      /**
-       * Destroy other expired textures
-       * @defaultValue `true`
-       */
-      expireCache: boolean;
-    }
-
-    interface LoadOptions {
-      /**
-       * The status message to display in the load bar
-       */
-      message?: string | undefined;
-
-      /**
-       * Expire other cached textures?
-       * @defaultValue `true`
-       */
-      expireCache: boolean;
-    }
-
-    interface Progress {
-      message: string;
-      loaded: number;
-      failed: number;
-      total: number;
-      pct: number;
-    }
-
-    interface FetchResourceOptions {
-      /**
-       * Append a cache-busting query parameter to the request.
-       * @defaultValue `false`
-       */
-      bustCache?: boolean;
-    }
-  }
-
-  /**
-   * Test whether a file source exists by performing a HEAD request against it
-   * @param src - The source URL or path to test
-   * @returns Does the file exist at the provided url?
-   */
-  function srcExists(src: string): Promise<boolean>;
-
-  /**
-   * Get a single texture from the cache
-   */
-  function getTexture(src: string): PIXI.Texture | null;
-
-  /**
-   * Load a single texture and return a Promise which resolves once the texture is ready to use
-   * @param src      - The requested texture source
-   * @param options  - Additional options which modify texture loading
-   * @returns The loaded Texture, or null if loading failed with no fallback
-   */
-  function loadTexture(
-    src: string,
-    options?: {
-      /** A fallback texture URL to use if the requested source is unavailable */
-      fallback?: string | undefined;
-    }
-  ): Promise<PIXI.Texture | null>;
-}

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

@@ -1,5 +0,0 @@
-import './normalized-rectangle';
-import './polygon-helpers';
-import './precise-text';
-import './ray';
-import './source-polygon';

package/src/foundry/client/pixi/core/shapes/normalized-rectangle.d.ts

@@ -1,31 +0,0 @@
-/**
- * A PIXI.Rectangle where the width and height are always positive and the x and y are always the top-left
- */
-declare class NormalizedRectangle extends PIXI.Rectangle {
-  constructor(x: number, y: number, width: number, height: number);
-
-  /**
-   * Determine whether some other Rectangle intersects with this one.
-   * @param other - Some other rectangle against which to compare
-   * @returns Do the rectangles intersect?
-   */
-  intersects(other: PIXI.Rectangle): boolean;
-
-  /**
-   * Generate a new rectangle by rotating this one clockwise about its center by a certain number of radians
-   * @param radians - The angle of rotation
-   * @returns A new rotated rectangle
-   */
-  rotate(radians: number): NormalizedRectangle;
-
-  /**
-   * Create normalized rectangular bounds given a rectangle shape and an angle of central rotation.
-   * @param x       - The top-left x-coordinate of the un-rotated rectangle
-   * @param y       - The top-left y-coordinate of the un-rotated rectangle
-   * @param width   - The width of the un-rotated rectangle
-   * @param height  - The height of the un-rotated rectangle
-   * @param radians - The angle of rotation about the center
-   * @returns The constructed rotated rectangle bounds
-   */
-  static fromRotation(x: number, y: number, width: number, height: number, radians: number): NormalizedRectangle;
-}