@league-of-foundry-developers/foundry-vtt-types 9.255.2 → 9.268.1

package/src/foundry/foundry.js/pixi/transforms/synchronizedTransform.d.ts

@@ -1,38 +0,0 @@
-/**
- * An extension of PIXI.Transform.
- * This uses a different DisplayObject than the current parent as the reference for the worldTransform.
- */
-declare class SynchronizedTransform extends PIXI.Transform {
-  constructor(transform: PIXI.Transform);
-
-  /**
-   * A list of attributes from the transform reference which should be synchronized
-   * @defaultValue
-   * ```javascript
-   * [
-   *   "localTransform", "position", "scale", "pivot", "skew", "_rotation",
-   *   "_cx", "_sx", "_cy", "_sy", "_localID", "_currentLocalID"
-   * ];
-   * ```
-   */
-  static synchronizedAttributes: string[];
-
-  /**
-   * A Transform instance which defines the reference point for the worldTransform
-   */
-  get reference(): PIXI.Transform;
-
-  set reference(value: PIXI.Transform);
-
-  /** @internal */
-  protected _reference: PIXI.Transform;
-
-  /** @internal */
-  protected _syncLocalID: number;
-
-  /** @override */
-  updateTransform(parentTransform: PIXI.Transform): void;
-
-  /** @override */
-  updateLocalTransform(): void;
-}

package/src/foundry/foundry.js/pointSources/index.d.ts

@@ -1,3 +0,0 @@
-import './lightSource';
-import './soundSource';
-import './visionSource';

package/src/foundry/foundry.js/polygonEdge.d.ts

@@ -1,26 +0,0 @@
-import type { ConfiguredObjectClassForName } from '../../types/helperTypes';
-
-declare global {
-  /**
-   * An internal data structure for polygon edges
-   * @internal
-   */
-  class PolygonEdge {
-    constructor(a: Point, b: Point, type: foundry.CONST.WALL_SENSE_TYPES, wall: Wall);
-
-    /**
-     * Is this edge limited in type?
-     */
-    get isLimited(): boolean;
-
-    /**
-     * Construct a PolygonEdge instance from a Wall placeable object.
-     * @param wall - The Wall from which to construct an edge
-     * @param type - The type of polygon being constructed
-     */
-    static fromWall(
-      wall: ConfiguredObjectClassForName<'Wall'> | WallDocument,
-      type: foundry.CONST.WALL_RESTRICTION_TYPES
-    ): PolygonEdge;
-  }
-}

package/src/foundry/foundry.js/polygonVertex.d.ts

@@ -1,89 +0,0 @@
-/**
- * An internal data structure for polygon vertices
- * @internal
- */
-declare class PolygonVertex {
-  constructor(x: number, y: number, { distance, index }?: PolygonVertexOptions);
-
-  x: number;
-
-  y: number;
-
-  key: number;
-
-  protected _distance: number | undefined;
-
-  protected _d2: undefined;
-
-  protected _index: number | undefined;
-
-  /** @defaultValue `false` */
-  protected _inLimitedAngle: boolean;
-
-  /**
-   * The set of edges which connect to this vertex.
-   * This set is initially empty and populated later after vertices are de-duplicated.
-   * @defaultValue `new Set()`
-   */
-  edges: EdgeSet;
-
-  /**
-   * The subset of edges which continue clockwise from this vertex.
-   * @defaultValue `new Set()`
-   */
-  cwEdges: EdgeSet;
-
-  /**
-   * The subset of edges which continue counter-clockwise from this vertex.
-   * @defaultValue `new Set()`
-   */
-  ccwEdges: EdgeSet;
-
-  /**
-   * The maximum restriction type of this vertex
-   * @defaultValue `null`
-   */
-  type: number | null;
-
-  /**
-   * Associate an edge with this vertex.
-   * @param edge        - The edge being attached
-   * @param orientation - The orientation of the edge with respect to the origin
-   */
-  attachEdge(edge: PolygonEdge, orientation: number): void;
-
-  /**
-   * Is this vertex limited in type?
-   */
-  get isLimited(): boolean;
-
-  /**
-   * Is this vertex terminal (at the maximum radius)
-   */
-  get isTerminal(): boolean;
-
-  /**
-   * Does this vertex have a limited edge connected to it?
-   */
-  get hasLimitedEdge(): boolean;
-
-  /**
-   * Is this vertex the same point as some other vertex?
-   * @param other - Some other vertex
-   * @returns Are they the same point?
-   */
-  equals(other: PolygonVertex): boolean;
-
-  /**
-   * Construct a PolygonVertex instance from some other Point structure.
-   * @param point   - The point
-   * @param options - Additional options that apply to this vertex
-   * @returns The constructed vertex
-   */
-  static fromPoint(point: Point, options?: PolygonVertexOptions): PolygonVertex;
-}
-
-interface PolygonVertexOptions {
-  distance: PolygonVertex['_distance'];
-  index: PolygonVertex['_index'];
-}

package/src/foundry/foundry.js/quadtreeCulling.d.ts

@@ -1,11 +0,0 @@
-/**
- * An experimental approach to culling using the quadtree mapping rather than the screen rectangle.
- * @internal
- */
-declare class QuadtreeCulling {
-  constructor();
-
-  cull(screen: Rectangle): void;
-
-  protected _getRect(screen: Rectangle): NormalizedRectangle;
-}

package/src/foundry/foundry.js/rays/index.d.ts

@@ -1 +0,0 @@
-import './sightRay';

package/src/foundry/foundry.js/rays/sightRay.d.ts

@@ -1,34 +0,0 @@
-/**
- * A subclass of Ray that is used specifically for computing source polygons
- *
- * This was used for the RadialSweepPolygon but can now be deleted once that is
- * @deprecated since v9d2
- */
-declare class SightRay extends Ray {
-  /**
-   * The array of sorted collision points which apply for this Ray.
-   */
-  collisions: WallEndpoint[];
-
-  /**
-   * The target endpoint at which this Ray was fired
-   */
-  endpoint: WallEndpoint | null;
-
-  /**
-   * The result objects which records the outcome of this Ray
-   */
-  result: {
-    collisions: unknown[];
-    continuation: unknown | undefined;
-    limitation: number;
-    superfluous: boolean;
-    stopped: boolean;
-    activeWalls: unknown | undefined;
-  };
-
-  /**
-   * The final collision point that this SightRay encountered.
-   */
-  get lastCollision(): WallEndpoint | null;
-}

package/src/foundry/foundry.js/specialEffects/index.d.ts

@@ -1,3 +0,0 @@
-import './autumnLeavesWeatherEffect';
-import './rainWeatherEffect';
-import './snowWeatherEffect';

package/src/foundry/foundry.js/templateUtils.d.ts

@@ -1,39 +0,0 @@
-/**
- * Global template cache
- */
-declare let _templateCache: Record<string, Handlebars.TemplateDelegate>;
-
-/* -------------------------------------------- */
-/*  HTML Template Loading                       */
-/* -------------------------------------------- */
-
-/**
- * Get a template from the server by fetch request and caching the retrieved result
- * @param path - The web-accessible HTML template URL
- * @returns A Promise which resolves to the compiled Handlebars template
- */
-declare function getTemplate(path: string): Promise<Handlebars.TemplateDelegate>;
-
-/* -------------------------------------------- */
-
-/**
- * Load and cache a set of templates by providing an Array of paths
- * @param paths - An array of template file paths to load
- */
-declare function loadTemplates(paths: string[]): Promise<Handlebars.TemplateDelegate[]>;
-
-/* -------------------------------------------- */
-
-/**
- * Get and render a template using provided data and handle the returned HTML
- * Support asynchronous file template file loading with a client-side caching layer
- *
- * Allow resolution of prototype methods and properties since this all occurs within the safety of the client.
- * @see {@link https://handlebarsjs.com/api-reference/runtime-options.html#options-to-control-prototype-access}
- *
- * @param path - The file path to the target HTML template
- * @param data - A data object against which to compile the template
- *
- * @returns Returns the rendered HTML
- */
-declare function renderTemplate(path: string, data: object): Promise<string>;

package/src/foundry/foundry.js/textEditor.d.ts

@@ -1,286 +0,0 @@
-/**
- * A collection of helper functions and utility methods related to the rich text editor
- */
-declare class TextEditor {
-  /**
-   * Create a Rich Text Editor. The current implementation uses TinyMCE
-   * @param options - Configuration options provided to the Editor init
-   * @param content - Initial HTML or text content to populate the editor with
-   *                  (default: `""`)
-   * @returns The editor instance.
-   */
-  static create(options: TextEditor.Options, content: string): Promise<tinyMCE.Editor>;
-
-  /**
-   * Safely decode an HTML string, removing invalid tags and converting entities back to unicode characters.
-   * @param html - The original encoded HTML string
-   * @returns The decoded unicode string
-   */
-  static decodeHTML(html: string): string;
-
-  /**
-   * Enrich HTML content by replacing or augmenting components of it
-   * @param content  - The original HTML content (as a string)
-   * @param options  - Additional options which configure how HTML is enriched
-   *                   (default: `{}`)
-   * @returns The enriched HTML content
-   */
-  static enrichHTML(content: string, options?: Partial<TextEditor.EnrichOptions>): string;
-
-  /**
-   * Preview an HTML fragment by constructing a substring of a given length from its inner text.
-   * @param content - The raw HTML to preview
-   * @param length  - The desired length
-   *                  (default: `250`)
-   * @returns The previewed HTML
-   */
-  static previewHTML(content: string, length?: number): string;
-
-  /**
-   * Truncate an HTML fragment to a maximum number of text content characters, removing any unused elements.
-   * @param html       - The root HTML element.
-   * @param maxLength  - The maximum allowed length of the text content.
-   *                     (default: `50`)
-   * @param splitWords - Whether to truncate by splitting on white space (if true) or breaking words.
-   *                     (default: `true`)
-   * @param suffix     - A suffix string to append to denote that the text was truncated.
-   *                     (default: `'…'`)
-   */
-  static truncateHTML(
-    html: HTMLElement,
-    { maxLength, splitWords, suffix }: { maxLength?: number; splitWords?: boolean; suffix?: string }
-  ): HTMLElement;
-
-  /**
-   * Truncate a fragment of text to a maximum number of characters.
-   * @param text       - The original text fragment that should be truncated to a maximum length
-   * @param maxLength  - The maximum allowed length of the truncated string.
-   *                     (default: `50`)
-   * @param splitWords - Whether to truncate by splitting on white space (if true) or breaking words.
-   *                     (default: `true`)
-   * @param suffix     - A suffix string to append to denote that the text was truncated.
-   *                     (default: `'…'`)
-   */
-  static truncateText(
-    text: string,
-    { maxLength, splitWords, suffix }?: { maxLength?: number; splitWords?: boolean; suffix?: string }
-  ): string;
-
-  /**
-   * Recursively identify the text nodes within a parent HTML node for potential content replacement.
-   * @param parent - The parent HTML Element
-   * @returns An array of contained Text nodes
-   * @internal
-   */
-  protected static _getTextNodes(parent: HTMLElement): Text[];
-
-  /**
-   * Facilitate the replacement of text node content using a matching regex rule and a provided replacement function.
-   * @internal
-   */
-  protected static _replaceTextContent(
-    text: Text[],
-    rgx: RegExp,
-    func: (...match: RegExpMatchArray[]) => Node
-  ): boolean;
-
-  /**
-   * Replace a matched portion of a Text node with a replacement Node
-   * @internal
-   */
-  protected static _replaceTextNode(text: Text, match: RegExpMatchArray, replacement: Node): void;
-
-  /**
-   * Create a dynamic entity link from a regular expression match
-   * @param match  - The full matched string
-   * @param type   - The matched entity type or "Compendium"
-   * @param target - The requested match target (_id or name)
-   * @param name   - A customized or over-ridden display name for the link
-   * @returns An HTML element for the entity link
-   * @internal
-   */
-  protected static _createContentLink(match: string, type: string, target: string, name: string): HTMLAnchorElement;
-
-  /**
-   * Replace a hyperlink-like string with an actual HTML <a> tag
-   * @param match - The full matched string
-   * @returns An HTML element for the entity link
-   * @internal
-   */
-  protected static _createHyperlink(match: string): HTMLAnchorElement;
-
-  /**
-   * Replace an inline roll formula with a rollable <a> element or an eagerly evaluated roll result
-   * @param match   - The matched string
-   * @param command - An optional command
-   * @param formula - The matched formula
-   * @param closing - The closing brackets for the inline roll
-   * @param label   - An optional label which configures the button text
-   * @returns The replaced match
-   * @internal
-   */
-  protected static _createInlineRoll(
-    match: string,
-    command: string,
-    formula: string,
-    closing: string,
-    label?: string,
-    ...args: object[]
-  ): HTMLAnchorElement | null;
-
-  static activateListeners(): void;
-
-  /**
-   * Handle click events on Entity Links
-   * @internal
-   */
-  protected static _onClickContentLink(event: JQuery.ClickEvent): void;
-
-  /**
-   * Handle left-mouse clicks on an inline roll, dispatching the formula or displaying the tooltip
-   * @param event - The initiating click event
-   * @internal
-   */
-  protected static _onClickInlineRoll(event: JQuery.ClickEvent): void;
-
-  /**
-   * Begin a Drag+Drop workflow for a dynamic content link
-   * @param event - The originating drag event
-   * @internal
-   */
-  protected static _onDragEntityLink(event: JQuery.DragStartEvent): void;
-
-  /**
-   * Begin a a data transfer drag event with default handling
-   * @internal
-   */
-  protected _onDragStart(event: DragEvent): void;
-
-  /**
-   * Handle dropping of transferred data onto the active rich text editor
-   * @param event  - The originating drop event which triggered the data transfer
-   * @param editor - The TinyMCE editor instance being dropped on
-   */
-  protected static _onDropEditorData(event: DragEvent, editor: tinyMCE.Editor): void;
-
-  /**
-   * Singleton decoder area
-   * @internal
-   */
-  protected static _decoder: HTMLTextAreaElement;
-}
-
-declare namespace TextEditor {
-  interface Options {
-    /**
-     * @defaultValue `false`
-     */
-    branding?: boolean;
-
-    /**
-     * @defaultValue `['/css/mce.css']`
-     */
-    content_css?: string[];
-
-    /**
-     * @defaultValue `false`
-     */
-    menubar?: boolean;
-
-    /**
-     * @defaultValue `'lists image table hr code save link'`
-     */
-    plugins?: string;
-
-    /**
-     * @defaultValue `true`
-     */
-    save_enablewhendirty?: boolean;
-
-    /**
-     * @defaultValue `false`
-     */
-    statusbar?: boolean;
-
-    style_formats?: [
-      {
-        items?: [
-          {
-            /**
-             * @defaultValue `'section'`
-             */
-            block?: string;
-
-            /**
-             * @defaultValue `'secrect'`
-             */
-            classes?: string;
-
-            /**
-             * @defaultValue `'Secret'`
-             */
-            title?: string;
-
-            /**
-             * @defaultValue `true`
-             */
-            wrapper?: boolean;
-          }
-        ];
-
-        /**
-         * @defaultValue `'Custom'`
-         */
-        title?: string;
-      }
-    ];
-
-    /**
-     * @defaultValue `true`
-     */
-    style_formats_merge?: boolean;
-
-    /**
-     * @defaultValue `{}`
-     */
-    table_default_styles?: object;
-
-    target: HTMLElement;
-
-    /**
-     * @defaultValue `'styleselect bullist numlist image table hr link removeformat code save'`
-     */
-    toolbar?: string;
-  }
-
-  interface EnrichOptions {
-    /**
-     * Include secret tags in the final HTML? If false secret blocks will be removed.
-     * @defaultValue `false`
-     */
-    secrets: boolean;
-
-    /**
-     * Replace dynamic entity links?
-     * @defaultValue `true`
-     */
-    entities: boolean;
-
-    /**
-     * Replace hyperlink content?
-     * @defaultValue `true`
-     */
-    links: boolean;
-
-    /**
-     * Replace inline dice rolls?
-     * @defaultValue `true`
-     */
-    rolls: boolean;
-
-    /**
-     * The data object providing context for inline rolls
-     */
-    rollData: object | (() => object);
-  }
-}

package/src/foundry/foundry.js/textureUtils.d.ts

@@ -1,25 +0,0 @@
-/**
- * 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?
- */
-declare function srcExists(src: string): Promise<boolean>;
-
-/**
- * Get a single texture from the cache
- */
-declare 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
- * @param fallback - A fallback texture to use if the requested source is unavailable or invalid
- */
-declare function loadTexture(
-  src: string,
-  options?: {
-    /** A fallback texture to use if the requested source is unavailable or invalid */
-    fallback?: string | undefined;
-  }
-): Promise<PIXI.Texture | null>;