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

package/src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts

@@ -0,0 +1,328 @@
+import type { AnyFunction, InexactPartial } from "../../../../types/utils.d.mts";
+import type BaseEffectSource from "./base-effect-source.d.mts";
+
+// TODO: Remove after shaders are done
+type AdaptiveDarknessShader = unknown;
+
+/**
+ * An abstract class which extends the base PointSource to provide common functionality for rendering.
+ * This class is extended by both the LightSource and VisionSource subclasses.
+ */
+declare class RenderedEffectSource<
+  SourceData extends RenderedEffectSource.RenderedEffectSourceData = RenderedEffectSource.RenderedEffectSourceData,
+  SourceShape extends PIXI.Polygon = PIXI.Polygon,
+  RenderingLayers extends Record<string, RenderedEffectSource.RenderedEffectSourceLayer> = RenderedEffectSource.Layers,
+> extends BaseEffectSource<SourceData, SourceShape> {
+  /**
+   * Keys of the data object which require shaders to be re-initialized.
+   */
+  protected static _initializeShaderKeys: string[];
+
+  /**
+   * Keys of the data object which require uniforms to be refreshed.
+   */
+  protected static _refreshUniformsKeys: string[];
+
+  /**
+   * Layers handled by this rendered source.
+   * @remarks Keys should match the keys of RenderingLayers
+   */
+  protected static get _layers(): Record<string, RenderedEffectSource.RenderedEffectLayerConfig>;
+
+  /**
+   * The offset in pixels applied to create soft edges.
+   * @defaultValue `-8`
+   */
+  static EDGE_OFFSET: number;
+
+  /**
+   * @defaultValue
+   * ```js
+   * {
+   * ...super.defaultData,
+   * animation: {},
+   * seed: null,
+   * preview: false,
+   * color: null
+   * }
+   * ```
+   */
+  static defaultData: RenderedEffectSource.RenderedEffectSourceData;
+
+  /**
+   * The animation configuration applied to this source
+   * @defaultValue `{}`
+   */
+  animation: RenderedEffectSource.RenderedEffectSourceAnimationConfig;
+
+  /**
+   * Track the status of rendering layers
+   */
+  layers: RenderingLayers;
+
+  /**
+   * The color of the source as an RGB vector.
+   */
+  colorRGB: [number, number, number] | null;
+
+  /**
+   * PIXI Geometry generated to draw meshes.
+   */
+  protected _geometry: PIXI.Geometry | null;
+
+  /**
+   * Is the rendered source animated?
+   */
+  get isAnimated(): boolean;
+
+  /**
+   * Has the rendered source at least one active layer?
+   */
+  get hasActiveLayer(): boolean;
+
+  /**
+   * Is this RenderedEffectSource a temporary preview?
+   */
+  get isPreview(): boolean;
+
+  /**
+   * A convenience accessor to the background layer mesh.
+   */
+  get background(): PointSourceMesh;
+
+  /**
+   * A convenience accessor to the coloration layer mesh.
+   */
+  get coloration(): PointSourceMesh;
+
+  /**
+   * A convenience accessor to the illumination layer mesh.
+   */
+  get illumination(): PointSourceMesh;
+
+  _initialize(data: Partial<SourceData>): void;
+
+  /**
+   * Decide whether to render soft edges with a blur.
+   */
+  protected _initializeSoftEdges(): void;
+
+  override _configure(changes: Partial<SourceData>): void;
+
+  /**
+   * Configure which shaders are used for each rendered layer.
+   * @privateRemarks Foundry marks this as private then overrides it in `PointVisionSource`
+   */
+  protected _configureShaders(): {
+    background: AdaptiveLightingShader;
+    coloration: AdaptiveLightingShader;
+    illumination: AdaptiveLightingShader;
+  };
+
+  /**
+   * Specific configuration for a layer.
+   */
+  protected _configureLayer(layer: Record<string, unknown>, layerId: string): void;
+
+  /**
+   * Create the geometry for the source shape that is used in shaders and compute its bounds for culling purpose.
+   * Triangulate the form and create buffers.
+   * @remarks Marked as abstract
+   */
+  protected _updateGeometry(): void;
+
+  /**
+   * Render the containers used to represent this light source within the LightingLayer
+   */
+  drawMeshes(): {
+    background: PIXI.Mesh;
+    coloration: PIXI.Mesh;
+    illumination: PIXI.Mesh;
+  };
+  /**
+   * Create a Mesh for a certain rendered layer of this source.
+   * @param layerId - The layer key in layers to draw
+   * @returns The drawn mesh for this layer, or null if no mesh is required
+   */
+  protected _drawMesh(layerId: string): PIXI.Mesh | null;
+
+  /**
+   * Update shader uniforms used by every rendered layer.
+   */
+  protected _updateCommonUniforms(shader: AbstractBaseShader): void;
+
+  /**
+   * Update shader uniforms used for the background layer.
+   */
+  protected _updateBackgroundUniforms(): void;
+
+  /**
+   * Update shader uniforms used for the coloration layer.
+   */
+  protected _updateColorationUniforms(): void;
+
+  /**
+   * Update shader uniforms used for the illumination layer.
+   */
+  protected _updateIlluminationUniforms(): void;
+
+  /**
+   * Animate the PointSource, if an animation is enabled and if it currently has rendered containers.
+   * @param dt - Delta time.
+   */
+  animate(dt: number): this["animation"]["animation"] extends (...args: any) => infer Return ? Return : void;
+
+  /**
+   * Generic time-based animation used for Rendered Point Sources.
+   * @param dt      - Delta time.
+   * @param options - Options which affect the time animation
+   */
+  animateTime(dt: number, options?: InexactPartial<RenderedEffectSource.AnimationOptions>): void;
+
+  /**
+   * Get corrected level according to level and active vision mode data.
+   * @returns The corrected level.
+   */
+  static getCorrectedLevel(level: foundry.CONST.LIGHTING_LEVELS): number;
+
+  /**
+   * Get corrected color according to level, dim color, bright color and background color.
+   */
+  static getCorrectedColor(
+    level: foundry.CONST.LIGHTING_LEVELS,
+    colorDim: Color,
+    colorBright: Color,
+    colorBackground?: Color,
+  ): Color;
+
+  /**
+   * @deprecated since v11
+   */
+  set preview(preview: boolean);
+
+  /**
+   * @deprecated since v11
+   */
+  get preview(): boolean;
+}
+
+declare namespace RenderedEffectSource {
+  interface RenderedEffectSourceData extends BaseEffectSource.BaseEffectSourceData {
+    /**
+     * An animation configuration for the source
+     */
+    animation: object;
+    /**
+     * A color applied to the rendered effect
+     */
+    color: number | null;
+    /**
+     * An integer seed to synchronize (or de-synchronize) animations
+     */
+    seed: number | null;
+    /**
+     * Is this source a temporary preview?
+     */
+    preview: boolean;
+  }
+
+  interface AnimationOptions {
+    /**
+     * The animation speed, from 0 to 10
+     * @defaultValue `5`
+     */
+    speed?: number;
+
+    /**
+     * The animation intensity, from 1 to 10
+     * @defaultValue `5`
+     */
+    intensity?: number;
+
+    /**
+     * Reverse the animation direction
+     * @defaultValue `false`
+     */
+    reverse?: boolean;
+  }
+
+  interface RenderedEffectSourceAnimationConfig {
+    /**
+     * The human-readable (localized) label for the animation
+     */
+    label?: string | undefined;
+    /**
+     * The animation function that runs every frame
+     * @privateRemarks TODO: Figure out if there's a better way to define the function
+     */
+    animation?: AnyFunction | undefined;
+    /**
+     * A custom illumination shader used by this animation
+     */
+    illuminationShader?: AdaptiveIlluminationShader | undefined;
+    /**
+     * A custom coloration shader used by this animation
+     */
+    colorationShader?: AdaptiveColorationShader | undefined;
+    /**
+     * A custom background shader used by this animation
+     */
+    backgroundShader?: AdaptiveBackgroundShader | undefined;
+    /**
+     * A custom darkness shader used by this animation
+     */
+    darknessShader?: AdaptiveDarknessShader | undefined;
+    /**
+     * The animation seed
+     */
+    seed?: number | undefined;
+    /**
+     * The animation time
+     */
+    time?: number | undefined;
+  }
+
+  interface RenderedEffectSourceLayer {
+    /**
+     * Is this layer actively rendered?
+     */
+    active: boolean;
+    /**
+     * Do uniforms need to be reset?
+     */
+    reset: boolean;
+    /**
+     * Is this layer temporarily suppressed?
+     */
+    suppressed: boolean;
+    /**
+     * The rendered mesh for this layer
+     */
+    mesh: PointSourceMesh;
+    /**
+     * The shader instance used for the layer
+     */
+    shader: AdaptiveLightingShader;
+  }
+
+  interface RenderedEffectLayerConfig {
+    /**
+     * The default shader used by this layer
+     */
+    defaultShader: AdaptiveLightingShader;
+    /**
+     * The blend mode used by this layer
+     */
+    blendMode: PIXI.BLEND_MODES;
+  }
+
+  // Interface causes errors
+  // eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+  type Layers = {
+    background: RenderedEffectSource.RenderedEffectSourceLayer;
+    coloration: RenderedEffectSource.RenderedEffectSourceLayer;
+    illumination: RenderedEffectSource.RenderedEffectSourceLayer;
+  };
+}
+
+export default RenderedEffectSource;

package/src/foundry/client-esm/canvas/tokens/_module.d.mts

@@ -0,0 +1,7 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import/extensions */
+/* eslint-disable import/no-unresolved */ // TODO: Remove when the files are instantiated
+
+export { default as TokenRing } from "./ring.mjs";

package/src/foundry/client-esm/client.d.mts

@@ -0,0 +1,291 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import/extensions */
+
+import "../common/primitives/module.mjs";
+import * as _CONST from "../common/constants.mjs";
+import * as _abstract from "../common/abstract/module.mjs";
+import * as _documents from "../common/documents/_module.mjs";
+import * as _packages from "../common/packages/module.mjs";
+import * as _utils from "../common/utils/module.mjs";
+import * as _config from "../common/config.mjs";
+import * as _prosemirror from "../common/prosemirror/_module.mjs";
+// import * as _grid from "../common/grid/_module.mjs";
+// import * as _types from "../common/types.mjs";
+
+// client
+import * as _applications from "./applications/_module.mjs";
+import * as _audio from "./audio/_module.mjs";
+import * as _canvas from "./canvas/_module.mjs";
+import * as _helpers from "./helpers/_module.mjs";
+import * as _data from "./data/_module.mjs";
+import * as _dice from "./dice/_module.mjs";
+import type { AnyObject } from "../../types/utils.d.mts";
+
+/**
+ * Constant definitions used throughout the Foundry Virtual Tabletop framework.
+ */
+export * as CONST from "../common/constants.mjs";
+
+/**
+ * Abstract class definitions for fundamental concepts used throughout the Foundry Virtual Tabletop framework.
+ */
+export * as abstract from "../common/abstract/module.mjs";
+
+/**
+ * Application configuration options
+ */
+export * as config from "../common/config.mjs";
+
+/**
+ * Document definitions used throughout the Foundry Virtual Tabletop framework.
+ */
+export * as documents from "../common/documents/_module.mjs";
+
+/**
+ * Package data definitions, validations, and schema.
+ */
+export * as packages from "../common/packages/module.mjs";
+
+/**
+ * Utility functions providing helpful functionality.
+ */
+export * as utils from "../common/utils/module.mjs";
+
+/**
+ * A library for providing rich text editing using ProseMirror within the Foundry Virtual Tabletop game client.
+ */
+// export * as prosemirror from "../common/prosemirror/_module.mjs";
+
+/**
+ * Grid classes.
+ */
+// export * as grid from "../common/grid/_module.mjs";
+
+/**
+ * A library for rendering and managing HTML user interface elements within the Foundry Virtual Tabletop game client.
+ */
+export * as applications from "./applications/_module.mjs";
+
+/**
+ * A library for controlling audio playback within the Foundry Virtual Tabletop game client.
+ */
+export * as audio from "./audio/_module.mjs";
+
+/**
+ * A submodule defining concepts related to canvas rendering.
+ */
+export * as canvas from "./canvas/_module.mjs";
+
+/**
+ * A submodule containing core helper classes.
+ */
+export * as helpers from "./helpers/_module.mjs";
+
+/**
+ * A module which defines data architecture components.
+ */
+export * as data from "./data/_module.mjs";
+
+/**
+ * A module for parsing and executing dice roll syntax.
+ */
+export * as dice from "./dice/_module.mjs";
+
+/**
+ * Shared importable types.
+ */
+export * as types from "../common/types.mjs";
+
+declare global {
+  namespace foundry {
+    /**
+     * Constant definitions used throughout the Foundry Virtual Tabletop framework.
+     */
+    export import CONST = _CONST;
+
+    /**
+     * Abstract class definitions for fundamental concepts used throughout the Foundry Virtual Tabletop framework.
+     */
+    export import abstract = _abstract;
+
+    /**
+     * Application configuration options
+     */
+    export import config = _config;
+
+    /**
+     * Document definitions used throughout the Foundry Virtual Tabletop framework.
+     */
+    export import documents = _documents;
+
+    /**
+     * Package data definitions, validations, and schema.
+     */
+    export import packages = _packages;
+
+    /**
+     * Utility functions providing helpful functionality.
+     */
+    export import utils = _utils;
+
+    /**
+     * A library for providing rich text editing using ProseMirror within the Foundry Virtual Tabletop game client.
+     */
+    export import prosemirror = _prosemirror;
+
+    /**
+     * Grid classes.
+     */
+    // export import grid = _grid;
+
+    /**
+     * A library for rendering and managing HTML user interface elements within the Foundry Virtual Tabletop game client.
+     */
+    export import applications = _applications;
+
+    /**
+     * A library for controlling audio playback within the Foundry Virtual Tabletop game client.
+     */
+    export import audio = _audio;
+
+    /**
+     * A submodule defining concepts related to canvas rendering.
+     */
+    export import canvas = _canvas;
+
+    /**
+     * A submodule containing core helper classes.
+     */
+    export import helpers = _helpers;
+
+    /**
+     * A module which defines data architecture components.
+     */
+    export import data = _data;
+
+    /**
+     * A module for parsing and executing dice roll syntax.
+     */
+    export import dice = _dice;
+
+    /**
+     * Shared importable types.
+     */
+    // export import types = _types;
+  }
+  /**
+   * Constant definitions used throughout the Foundry Virtual Tabletop framework.
+   */
+  const CONST: typeof _CONST;
+
+  // Color is currently handled in src/foundry/client/head.d.mts
+
+  type Collection<T> = _utils.Collection<T>;
+  var Collection: typeof _utils.Collection; // eslint-disable-line no-var
+
+  type Roll<D extends Record<string, unknown> = AnyObject> = _dice.Roll<D>;
+  var Roll: typeof _dice.Roll; // eslint-disable-line no-var
+
+  // Deprecated global namespace dump; done programmatically by fvtt
+  type Semaphore = _utils.Semaphore;
+  /** @deprecated since v12 will be removed in v14 */
+  var Semaphore: typeof _utils.Semaphore; // eslint-disable-line no-var
+
+  type IterableWeakMap<K extends WeakKey, V> = _utils.IterableWeakMap<K, V>;
+  /** @deprecated since v12 will be removed in v14 */
+  var IterableWeakMap: typeof _utils.IterableWeakMap; // eslint-disable-line no-var
+
+  type IterableWeakSet<T extends WeakKey> = _utils.IterableWeakSet<T>;
+  /** @deprecated since v12 will be removed in v14 */
+  var IterableWeakSet: typeof _utils.IterableWeakSet; // eslint-disable-line no-var
+
+  /* eslint-disable no-var */
+  /* --- geometry --- */
+  /** @deprecated since v12 will be removed in v14 */
+  var orient2dFast: typeof _utils.orient2dFast;
+  /** @deprecated since v12 will be removed in v14 */
+  var lineSegmentIntersects: typeof _utils.lineSegmentIntersects;
+  /** @deprecated since v12 will be removed in v14 */
+  var lineLineIntersection: typeof _utils.lineLineIntersection;
+  /** @deprecated since v12 will be removed in v14 */
+  var lineSegmentIntersection: typeof _utils.lineSegmentIntersection;
+  /** @deprecated since v12 will be removed in v14 */
+  var lineCircleIntersection: typeof _utils.lineCircleIntersection;
+  /** @deprecated since v12 will be removed in v14 */
+  var closestPointToSegment: typeof _utils.closestPointToSegment;
+  /** @deprecated since v12 will be removed in v14 */
+  var quadraticIntersection: typeof _utils.quadraticIntersection;
+
+  /* --- helpers --- */
+  /** @deprecated since v12 will be removed in v14 */
+  var benchmark: typeof _utils.benchmark;
+  /** @deprecated since v12 will be removed in v14 */
+  var threadLock: typeof _utils.threadLock;
+  /** @deprecated since v12 will be removed in v14 */
+  var debounce: typeof _utils.debounce;
+  /** @deprecated since v12 will be removed in v14 */
+  var debouncedReload: typeof _utils.debouncedReload;
+  /** @deprecated since v12 will be removed in v14 */
+  var deepClone: typeof _utils.deepClone;
+  /** @deprecated since v12 will be removed in v14 */
+  var diffObject: typeof _utils.diffObject;
+  /** @deprecated since v12 will be removed in v14 */
+  var objectsEqual: typeof _utils.objectsEqual;
+  /** @deprecated since v12 will be removed in v14 */
+  var duplicate: typeof _utils.duplicate;
+  /** @deprecated since v12 will be removed in v14 */
+  var isSubclass: typeof _utils.isSubclass;
+  /** @deprecated since v12 will be removed in v14 */
+  var getDefiningClass: typeof _utils.getDefiningClass;
+  /** @deprecated since v12 will be removed in v14 */
+  var encodeURL: typeof _utils.encodeURL;
+  /** @deprecated since v12 will be removed in v14 */
+  var expandObject: typeof _utils.expandObject;
+  /** @deprecated since v12 will be removed in v14 */
+  var filterObject: typeof _utils.filterObject;
+  /** @deprecated since v12 will be removed in v14 */
+  var flattenObject: typeof _utils.flattenObject;
+  /** @deprecated since v12 will be removed in v14 */
+  var getParentClasses: typeof _utils.getParentClasses;
+  /** @deprecated since v12 will be removed in v14 */
+  var getRoute: typeof _utils.getRoute;
+  /** @deprecated since v12 will be removed in v14 */
+  var getType: typeof _utils.getType;
+  /** @deprecated since v12 will be removed in v14 */
+  var hasProperty: typeof _utils.hasProperty;
+  /** @deprecated since v12 will be removed in v14 */
+  var getProperty: typeof _utils.getProperty;
+  /** @deprecated since v12 will be removed in v14 */
+  var setProperty: typeof _utils.setProperty;
+  /** @deprecated since v12 will be removed in v14 */
+  var invertObject: typeof _utils.invertObject;
+  /** @deprecated since v12 will be removed in v14 */
+  var isEmpty: typeof _utils.isEmpty;
+  /** @deprecated since v12 will be removed in v14 */
+  var mergeObject: typeof _utils.mergeObject;
+  /** @deprecated since v12 will be removed in v14 */
+  var parseS3URL: typeof _utils.parseS3URL;
+  /** @deprecated since v12 will be removed in v14 */
+  var randomID: typeof _utils.randomID;
+  /** @deprecated since v12 will be removed in v14 */
+  var timeSince: typeof _utils.timeSince;
+  /** @deprecated since v12 will be removed in v14 */
+  var formatFileSize: typeof _utils.formatFileSize;
+  /** @deprecated since v12 will be removed in v14 */
+  var parseUuid: typeof _utils.parseUuid;
+
+  /* --- http --- */
+
+  /** @deprecated since v12 will be removed in v14 */
+  var fetchWithTimeout: typeof _utils.fetchWithTimeout;
+  /** @deprecated since v12 will be removed in v14 */
+  var fetchJsonWithTimeout: typeof _utils.fetchJsonWithTimeout;
+
+  /* --- logging --- */
+
+  /** @deprecated since v12 will be removed in v14 */
+  var logCompatibilityWarning: typeof _utils.logCompatibilityWarning;
+  /* eslint-enable no-var */
+}

package/src/foundry/client-esm/data/_module.d.mts

@@ -0,0 +1,8 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import/extensions */
+
+export * from "../../common/data/module.mjs";
+export * as regionBehaviors from "./region-behaviors/_module.mjs";
+export { default as ClientDatabaseBackend } from "./client-backend.mjs";

package/src/foundry/client-esm/data/client-backend.d.mts

@@ -0,0 +1,52 @@
+import type { ConstructorOf } from "../../../types/utils.d.mts";
+import type Document from "../../common/abstract/document.d.mts";
+import type {
+  DatabaseGetOperation,
+  DatabaseCreateOperation,
+  DatabaseUpdateOperation,
+  DatabaseDeleteOperation,
+} from "../../common/abstract/_types.d.mts";
+import type { LoggingLevels } from "../../../types/helperTypes.d.mts";
+
+/**
+ * The client-side database backend implementation which handles Document modification operations.
+ */
+declare class ClientDatabaseBackend extends foundry.abstract.DatabaseBackend {
+  protected override _getDocuments<T extends Document.Any>(
+    documentClass: ConstructorOf<T>,
+    request: DatabaseGetOperation,
+    user: User.ConfiguredInstance,
+  ): Promise<T[]>;
+
+  protected override _createDocuments<T extends Document.Any>(
+    documentClass: ConstructorOf<T>,
+    request: DatabaseCreateOperation<T>,
+    user: User.ConfiguredInstance,
+  ): Promise<T[]>;
+
+  protected override _updateDocuments<T extends Document.Any>(
+    documentClass: ConstructorOf<T>,
+    request: DatabaseUpdateOperation<T>,
+    user: User.ConfiguredInstance,
+  ): Promise<T[]>;
+
+  protected override _deleteDocuments<T extends Document.Any>(
+    documentClass: ConstructorOf<T>,
+    request: DatabaseDeleteOperation,
+    user: User.ConfiguredInstance,
+  ): Promise<T[]>;
+
+  /**
+   * Activate the Socket event listeners used to receive responses from events which modify database documents
+   * @param socket - The active game socket
+   */
+  activateSocketListeners(socket: Game["socket"]): void;
+
+  override getFlagScopes(): string[];
+
+  override getCompendiumScopes(): string[];
+
+  protected override _log(level: LoggingLevels, message: string): void;
+}
+
+export default ClientDatabaseBackend;

package/src/foundry/client-esm/data/region-behaviors/_module.d.mts

@@ -0,0 +1,14 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import/extensions */
+/* eslint-disable import/no-unresolved */ // TODO: Remove when the files are instantiated
+
+export { default as RegionBehaviorType } from "./base.mjs";
+export { default as AdjustDarknessLevelRegionBehaviorType } from "./adjust-darkness-level.mjs";
+export { default as ExecuteMacroRegionBehaviorType } from "./execute-macro.mjs";
+export { default as ExecuteScriptRegionBehaviorType } from "./execute-script.mjs";
+export { default as PauseGameRegionBehaviorType } from "./pause-game.mjs";
+export { default as SuppressWeatherRegionBehaviorType } from "./suppress-weather.mjs";
+export { default as TeleportTokenRegionBehaviorType } from "./teleport-token.mjs";
+export { default as ToggleBehaviorRegionBehaviorType } from "./toggle-behavior.mjs";