@league-of-foundry-developers/foundry-vtt-types 0.8.9-7 → 0.8.9-8

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

@@ -2,7 +2,20 @@
  * A helper class used by the Sight Layer to represent a source of vision or illumination.
  */
 declare class PointSource {
-  constructor();
+  /**
+   * @param object - The object responsible for the PointSource
+   */
+  constructor(object: PlaceableObject, sourceType: PointSource.SourceType);
+
+  /**
+   * The object responsible for the PointSource
+   */
+  object: PlaceableObject;
+
+  /**
+   * The type of source
+   */
+  sourceType: PointSource.SourceType;
 
   /**
    * The light or darkness container for this source
@@ -20,11 +33,17 @@ declare class PointSource {
    */
   active: boolean;
 
+  /**
+   * The range of Scene darkness values for which this Source should be active
+   * @defaultValue `{ min: 0, max: 0 }`
+   */
+  darkness: { min: number; max: number };
+
   /**
    * Internal flag for whether this is a darkness source
    * @defaultValue `false`
    */
-  darkness: boolean;
+  isDarkness: boolean;
 
   /**
    * Is the light source limited by an angle of emission?
@@ -41,27 +60,66 @@ declare class PointSource {
   /**
    * Internal flag for animation throttling time
    * @defaultValue `0`
+   * @internal
    */
   protected _animateTime: number;
 
   /**
    * An integer seed which de-synchronizes otherwise similar animations
    * @defaultValue `null`
+   * @internal
    */
   protected _animateSeed: number | null;
 
+  /**
+   * A flag for the lighting channels version that this source is using.
+   * @defaultValue `0`
+   * @internal
+   */
+  protected _lightingVersion: number;
+
   /**
    * A flag for whether to re-initialize illumination shader uniforms the next time the light is rendered.
    * @defaultValue `true`
+   * @internal
    */
   protected _resetIlluminationUniforms: boolean;
 
   /**
    * A flag for whether to re-initialize coloration shader uniforms the next time the light is rendered.
    * @defaultValue `true`
+   *@internal
    */
   protected _resetColorationUniforms: boolean;
 
+  /**
+   * An internal flag for whether to render coloration for this source
+   * @defaultValue `false`
+   * @internal
+   */
+  protected _hasColor: boolean;
+
+  /**
+   * The default Geometry stored in the GPU for all Point Source meshes.
+   */
+  static GEOMETRY: PIXI.Geometry;
+
+  /**
+   * Create the structure of a source Container which can be rendered to the sight layer shadow-map
+   * @returns The constructed light source container
+   * @internal
+   */
+  protected _createContainer(shaderCls: ConstructorOf<AbstractBaseShader>): PIXI.Container;
+
+  /**
+   * Initialize the source with provided object data.
+   *
+   * @param data - Input data which configures the source.
+   *
+   * @returns A reference to the initialized source
+   */
+  initialize(data?: PointSource.Data): PointSource.Initialized<this>;
+
   /**
    * The x-coordinate of the source location
    * @defaultValue `undefined`
@@ -117,13 +175,7 @@ declare class PointSource {
   alpha?: number;
 
   /**
-   * A level of darkness beyond which this light is active
-   * @defaultValue `undefined`
-   */
-  darknessThreshold?: number;
-
-  /**
-   * The source type from {@link SOURCE_TYPES}
+   * The source type from CONST.SOURCE_TYPES
    * @defaultValue `undefined`
    */
   type?: foundry.CONST.SourceType;
@@ -143,7 +195,7 @@ declare class PointSource {
   /**
    * @defaultValue `undefined`
    */
-  colorRGB?: [number, number, number];
+  colorRGB?: [r: number, g: number, b: number];
 
   /**
    * @defaultValue `undefined`
@@ -160,92 +212,25 @@ declare class PointSource {
    */
   los?: PIXI.Polygon;
 
-  /**
-   * Create the structure of a source Container which can be rendered to the sight layer shadow-map
-   * @returns The constructed light source container
-   */
-  protected _createContainer(shaderCls: ConstructorOf<AbstractBaseShader>): PIXI.Container;
-
-  /**
-   * Initialize the source with provided object data.
-   *
-   * @param x                 - The x-coordinate of the source location
-   *                            (default: `0`)
-   * @param y                 - The y-coordinate of the source location
-   *                            (default: `0`)
-   * @param z                 - An optional z-index sorting for the source
-   *                            (default: `null`)
-   * @param dim               - The allowed radius of dim vision or illumination
-   *                            (default: `0`)
-   * @param bright            - The allowed radius of bright vision or illumination
-   *                            (default: `0`)
-   * @param angle             - The angle of emission for this point source
-   *                            (default: `360`)
-   * @param rotation          - The angle of rotation for this point source
-   *                            (default: `0`)
-   * @param color             - A tint color for the emitted light, if any
-   *                            (default: `null`)
-   * @param alpha             - An opacity for the emitted light, if any
-   *                            (default: `0.5`)
-   * @param darknessThreshold - A level of darkness beyond which this light is active
-   *                            (default: `0`)
-   * @param type              - The source type from SOURCE_TYPES
-   *                            (default: `SOURCE_TYPES.LOCAL`)
-   * @param animation         - An animation configuration for the source
-   *                            (default: `{type: null}`)
-   * @param seed              - An integer seed to synchronize (or de-synchronize) animations
-   *                            (default: `undefined`)
-   *
-   * @returns A reference to the initialized source
-   */
-  initialize({
-    x,
-    y,
-    z,
-    dim,
-    bright,
-    angle,
-    rotation,
-    color,
-    alpha,
-    darknessThreshold,
-    type,
-    animation,
-    seed
-  }?: {
-    x?: number;
-    y?: number;
-    z?: number | null;
-    dim?: number;
-    bright?: number;
-    angle?: number;
-    rotation?: number;
-    color?: number | string | null;
-    alpha?: number;
-    darknessThreshold?: number;
-    type?: string;
-    animation?: PointSource.Animation;
-    seed?: number;
-  }): this;
-
   /**
    * Initialize the shaders used for this animation.
    * Reset the current shader values back to defaults.
    * Swap to a different Shader instance if necessary.
+   * @internal
    */
   protected _initializeShaders(): void;
 
   /**
    * Initialize the blend mode and vertical sorting of this source relative to others in the container.
+   * @internal
    */
   protected _initializeBlending(): void;
 
   /**
    * Draw the display of this source for the darkness/light container of the SightLayer.
-   * @param updateChannels - Is this drawing initiated because lighting channels have changed?
    * @returns The rendered light container
    */
-  drawLight({ updateChannels }?: { updateChannels?: boolean }): PIXI.Container;
+  drawLight(): PIXI.Container;
 
   /**
    * Draw and return a container used to depict the visible color tint of the light source on the LightingLayer
@@ -256,6 +241,7 @@ declare class PointSource {
   /**
    * A common helper function for updating the display of a source container.
    * Assign the container position, dimensions, and polygons.
+   * @internal
    */
   protected _drawContainer(c: PIXI.Container): PIXI.Container;
 
@@ -269,25 +255,31 @@ declare class PointSource {
    * A torch animation where the luminosity and coloration decays each frame and is revitalized by flashes
    * @param dt        - Delta time
    * @param speed     - The animation speed, from 1 to 10
+   *                    (default: `5`)
    * @param intensity - The animation intensity, from 1 to 10
+   *                    (default: `5`)
    */
-  animateTorch: PointSource.AnimationFunction;
+  animateTorch(dt: number, { speed, intensity }?: PointSource.AnimationProperties): void;
 
   /**
    * A basic "pulse" animation which expands and contracts.
    * @param dt        - Delta time
    * @param speed     - The animation speed, from 1 to 10
+   *                    (default: `5`)
    * @param intensity - The animation intensity, from 1 to 10
+   *                    (default: `5`)
    */
-  animatePulse: PointSource.AnimationFunction;
+  animatePulse(dt: number, { speed, intensity }?: PointSource.AnimationProperties): void;
 
   /**
    * Emanate waves of light from the source origin point
    * @param dt        - Delta time
    * @param speed     - The animation speed, from 1 to 10
+   *                    (default: `5`)
    * @param intensity - The animation intensity, from 1 to 10
+   *                    (default: `5`)
    */
-  animateTime: PointSource.AnimationFunction;
+  animateTime(dt: number, { speed, intensity }?: PointSource.AnimationProperties): void;
 
   /**
    * Evolve a value using a stochastic AR(1) process
@@ -298,6 +290,7 @@ declare class PointSource {
    * @param max    - The maximum allowed outcome, or null
    * @param min    - The minimum allowed outcome, or null
    * @returns The new value of the process
+   * @internal
    */
   protected _ar1(
     y: number,
@@ -309,11 +302,106 @@ declare class PointSource {
       min
     }: { phi?: number; center?: number; sigma?: number; max?: number | null; min?: number | null }
   ): number;
-
-  static GEOMETRY: PIXI.Geometry;
 }
 
 declare namespace PointSource {
+  type SourceType = 'light' | 'sight';
+
+  interface Data {
+    /**
+     * The x-coordinate of the source location
+     * @defaultValue `0`
+     */
+    x?: number;
+
+    /** The y-coordinate of the source location
+     * @defaultValue `0`
+     */
+    y?: number;
+
+    /** An optional z-index sorting for the source
+     * @defaultValue `null`
+     */
+    z?: number | null;
+
+    /** The allowed radius of dim vision or illumination
+     * @defaultValue `0`
+     */
+    dim?: number;
+
+    /** The allowed radius of bright vision or illumination
+     * @defaultValue `0`
+     */
+    bright?: number;
+
+    /** The angle of emission for this point source
+     * @defaultValue `360`
+     */
+    angle?: number;
+
+    /**
+     * The angle of rotation for this point source
+     * @defaultValue `0`
+     */
+    rotation?: number;
+
+    /**
+     * A tint color for the emitted light, if any
+     * @defaultValue `null`
+     */
+    color?: number | string | null;
+
+    /** An opacity for the emitted light, if any
+     * @defaultValue `0.5`
+     */
+    alpha: number;
+
+    /**
+     * A darkness range (min and max) for which the source should be active
+     * @defaultValue `{ min: 0, max: 1 }`
+     */
+    darkness?: { min: number; max: number };
+
+    /**
+     * The source type from CONST.SOURCE_TYPES
+     * @defaultValue `CONST.SOURCE_TYPES.LOCAL`
+     */
+    type?: foundry.CONST.SourceType;
+
+    /**
+     * An animation configuration for the source
+     * @defaultValue `{ type: null }`
+     */
+    animation?: PointSource.Animation;
+
+    /**
+     * An integer seed to synchronize (or de-synchronize) animations
+     */
+    seed?: number;
+  }
+
+  type Initialized<P extends PointSource> = P &
+    Required<
+      Pick<
+        P,
+        | 'animation'
+        | 'angle'
+        | 'alpha'
+        | 'bright'
+        | 'color'
+        | 'dim'
+        | 'rotation'
+        | 'type'
+        | 'x'
+        | 'y'
+        | 'z'
+        | 'colorRGB'
+        | 'ratio'
+        | 'fov'
+        | 'los'
+      >
+    >;
+
   interface AnimationProperties {
     speed?: number;
     intensity?: number;

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

@@ -34,7 +34,22 @@ declare class TextEditor {
    *                  (default: `250`)
    * @returns The previewed HTML
    */
-  static previewHTML(content: string, length: number): string;
+  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.
@@ -55,11 +70,13 @@ declare class TextEditor {
    * 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[],
@@ -69,6 +86,7 @@ declare class TextEditor {
 
   /**
    * Replace a matched portion of a Text node with a replacement Node
+   * @internal
    */
   protected static _replaceTextNode(text: Text, match: RegExpMatchArray, replacement: Node): void;
 
@@ -79,13 +97,15 @@ declare class TextEditor {
    * @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 _createEntityLink(match: string, type: string, target: string, name: string): HTMLAnchorElement;
+  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;
 
@@ -95,47 +115,58 @@ declare class TextEditor {
    * @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[]
-  ): string;
+  ): HTMLAnchorElement | null;
 
   static activateListeners(): void;
 
   /**
    * Handle click events on Entity Links
+   * @internal
    */
-  protected static _onClickEntityLink(event: Event): Promise<void>;
+  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: MouseEvent): Promise<void | Promise<void> | Promise<ChatMessage> | object>;
+  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: Event): void;
+  protected static _onDragEntityLink(event: JQuery.DragStartEvent): void;
 
   /**
    * Begin a a data transfer drag event with default handling
+   * @internal
    */
-  protected _onDragStart(event: Event): void;
+  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: Event, editor: tinyMCE.Editor): Promise<void>;
+  protected static _onDropEditorData(event: DragEvent, editor: tinyMCE.Editor): void;
 
+  /**
+   * Singleton decoder area
+   * @internal
+   */
   protected static _decoder: HTMLTextAreaElement;
 }
 

package/src/foundry/index.d.ts

@@ -11,6 +11,7 @@ import './foundry.js/canvas';
 import './foundry.js/canvasAnimation';
 import './foundry.js/canvasDocumentMixin';
 import './foundry.js/chatBubbles';
+import './foundry.js/clientDatabaseBackend';
 import './foundry.js/clientDocuments';
 import './foundry.js/clientDocumentMixin';
 import './foundry.js/clientSettings';

package/src/foundry/foundry.js/applications/formApplications/measuredTemplateConfig.d.ts

@@ -1,61 +0,0 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * A configuration Form Application for modifying the properties of a MeasuredTemplate object.
- * @see {@link MeasuredTemplate}
- */
-declare class MeasuredTemplateConfig extends FormApplication<
-  FormApplication.Options,
-  MeasuredTemplateConfig.Data,
-  MeasuredTemplate
-> {
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   id: "template-config",
-   *   classes: ["sheet", "template-sheet"],
-   *   title: "Measurement Template Configuration",
-   *   template: "templates/scene/template-config.html",
-   *   width: 400
-   * });
-   * ```
-   */
-  static get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-  /**
-   * @override
-   */
-  getData(): MeasuredTemplateConfig.Data;
-
-  /**
-   * @override
-   */
-  protected _updateObject(event: Event, formData: MeasuredTemplateConfig.FormData): Promise<MeasuredTemplate | null>;
-}
-
-declare namespace MeasuredTemplateConfig {
-  interface Data {
-    object: foundry.utils.Duplicated<MeasuredTemplateConfig['object']['data']>;
-    options: MeasuredTemplateConfig['options'];
-    templateTypes: typeof CONFIG['MeasuredTemplate']['types'];
-    gridUnits: Scene['data']['gridUnits'];
-    submitText: string;
-  }
-
-  type FormData = {
-    angle: MeasuredTemplate.Data['angle'];
-    borderColor: MeasuredTemplate.Data['borderColor'];
-    direction: MeasuredTemplate.Data['direction'] | null;
-    distance: MeasuredTemplate.Data['distance'] | null;
-    fillColor: MeasuredTemplate.Data['fillColor'];
-    t: MeasuredTemplate.Data['t'];
-    texture: MeasuredTemplate.Data['texture'];
-    width: MeasuredTemplate.Data['width'];
-    x: MeasuredTemplate.Data['x'] | null;
-    y: MeasuredTemplate.Data['y'] | null;
-  };
-}

package/src/foundry/foundry.js/applications/formApplications/noteConfig.d.ts

@@ -1,77 +0,0 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * Placeable Note configuration sheet
- * @typeParam P - the type of the options object
- */
-declare class NoteConfig<P extends FormApplication.Options = FormApplication.Options> extends FormApplication<
-  P,
-  NoteConfig.Data,
-  Note
-> {
-  /**
-   * @param note    - The Note object for which settings are being configured
-   * @param options - Additional Application options
-   */
-  constructor(note: Note, options?: Partial<P>);
-
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   id: "note-config",
-   *   title: game.i18n.localize("NOTE.ConfigTitle"),
-   *   template: "templates/scene/note-config.html",
-   *   width: 400
-   * });
-   * ```
-   */
-  static get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<P>): NoteConfig.Data;
-
-  /**
-   * @param event - (unused)
-   * @override
-   */
-  protected _updateObject(event: Event, formData: NoteConfig.FormData): Promise<Note>;
-
-  /**
-   * @override
-   */
-  close(options?: Application.CloseOptions): Promise<void>;
-}
-
-declare namespace NoteConfig {
-  interface Data {
-    entryIcons: typeof CONFIG.JournalEntry['noteIcons'];
-    entryId: JournalEntry['_id'] | undefined;
-    entryName: JournalEntry['name'] | undefined;
-    entries: Journal['entities'];
-    fontFamilies: Partial<Record<string, string>>;
-    object: foundry.utils.Duplicated<NoteConfig['object']['data']>;
-    options: NoteConfig['options'];
-    textAnchors: Record<foundry.CONST.TextAnchorPoint, string>;
-  }
-
-  interface FormData {
-    entryId: Note.Data['entryId'];
-    fontFamily: Note.Data['fontFamily'];
-    fontSize: Note.Data['fontSize'] | null;
-    icon: Note.Data['icon'];
-    iconSize: Note.Data['iconSize'] | null;
-    iconTint: Note.Data['iconTint'];
-    text: Note.Data['text'];
-    textAnchor: Note.Data['textAnchor'];
-    textColor: Note.Data['textColor'];
-    x: Note.Data['x'] | null;
-    y: Note.Data['y'] | null;
-  }
-}