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

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

@@ -0,0 +1,286 @@
+// 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;
+  }
+  /**
+   * 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";

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

@@ -0,0 +1,13 @@
+// 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 * as types from "./_types.mjs";
+export * as terms from "./terms/_module.mjs";
+
+export { default as Roll } from "./roll.mjs";
+// export { default as RollGrammar } from "./grammar.pegjs"; // TODO: Figure out if there's a good way to statically type the PEGGY grammar
+export { default as RollParser } from "./parser.mjs";
+export { default as MersenneTwister } from "./twister.mjs";

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

@@ -0,0 +1,61 @@
+export interface RollParseNode {
+  /** The class name for this node. */
+  class: string;
+  /** The original matched text for this node. */
+  formula: string;
+}
+
+export interface RollParseTreeNode {
+  /** The binary operator. */
+  operator: string;
+  /** The two operands. */
+  operands: [RollParseNode, RollParseNode];
+}
+
+export interface FlavorRollParseNode extends RollParseNode {
+  options: {
+    /** Flavor text associated with the node. */
+    flavour: string;
+  };
+}
+
+export interface ModifiersRollParseNode extends FlavorRollParseNode {
+  /** The matched modifiers string. */
+  modifiers: string;
+}
+
+export interface NumericRollParseNode extends FlavorRollParseNode {
+  /** The number. */
+  number: number;
+}
+
+export interface FunctionRollParseNode extends FlavorRollParseNode {
+  /** The function name. */
+  fn: string;
+  /** The arguments to the function. */
+  terms: RollParseNode[];
+}
+
+export interface PoolRollParseNode extends ModifiersRollParseNode {
+  /** The pool terms. */
+  terms: RollParseNode[];
+}
+
+export interface ParentheticalRollParseNode extends FlavorRollParseNode {
+  /** The inner parenthetical term. */
+  term: string;
+}
+
+export interface StringParseNode extends FlavorRollParseNode {
+  /** The unclassified string term. */
+  term: string;
+}
+
+export interface DiceRollParseNode extends ModifiersRollParseNode {
+  /** The number of dice. */
+  number: number | ParentheticalRollParseNode;
+  /** The number of faces or a string denomination like "c" or "f" */
+  faces: string | number | ParentheticalRollParseNode;
+}
+
+export type RollParseArg = null | number | string | RollParseNode | RollParseArg[];

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

@@ -0,0 +1,205 @@
+import type {
+  DiceRollParseNode,
+  FunctionRollParseNode,
+  NumericRollParseNode,
+  ParentheticalRollParseNode,
+  PoolRollParseNode,
+  RollParseArg,
+  RollParseNode,
+  StringParseNode,
+} from "./_types.d.mts";
+
+import type RollTerm from "./terms/term.d.mts";
+
+/**
+ * A class for transforming events from the Peggy grammar lexer into various formats.
+ */
+declare class RollParser {
+  /**
+   * @param formula - The full formula
+   */
+  constructor(formula: string);
+
+  /** The full formula */
+  formula: string;
+
+  /* -------------------------------------------- */
+  /*  Parse Events                                */
+  /* -------------------------------------------- */
+
+  /**
+   * Handle a base roll expression.
+   * @param head - The first operand.
+   * @param tail - Zero or more subsequent (operators, operand) tuples.
+   * @param leading - A leading operator.
+   * @param formula - The original matched text.
+   * @param error - The peggy error callback to invoke on a parse error.
+   * @internal
+   */
+  protected _onExpression(
+    head: RollParseNode,
+    tail: [string[], RollParseNode][],
+    leading: string,
+    formula: string,
+    error: (error: string) => void,
+  ): RollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Handle a dice term.
+   * @param number - The number of dice.
+   * @param faces - The number of die faces or a string denomination like "c" or "f".
+   * @param modifiers - The matched modifiers string.
+   * @param flavor - Associated flavor text.
+   * @param formula - The original matched text.
+   * @returns
+   * @internal
+   */
+  protected _onDiceTerm(
+    number: NumericRollParseNode | ParentheticalRollParseNode | null,
+    faces: string | NumericRollParseNode | ParentheticalRollParseNode | null,
+    modifiers: string | null,
+    flavor: string | null,
+    formula: string,
+  ): DiceRollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Handle a numeric term.
+   * @param number - The number.
+   * @param flavor - Associated flavor text.
+   * @internal
+   */
+  protected _onNumericTerm(number: number, flavor: string): NumericRollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Handle a math term.
+   * @param fn - The Math function.
+   * @param head - The first term.
+   * @param tail - Zero or more additional terms.
+   * @param flavor - Associated flavor text.
+   * @param formula - The original matched text.
+   * @internal
+   */
+  protected _onFunctionTerm(
+    fn: string,
+    head: RollParseNode,
+    tail: RollParseNode[],
+    flavor: string,
+    formula: string,
+  ): FunctionRollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Handle a pool term.
+   * @param head - The first term.
+   * @param tail - Zero or more additional terms.
+   * @param modifiers - The matched modifiers string.
+   * @param flavor - Associated flavor text.
+   * @param formula - The original matched text.
+   * @internal
+   */
+  protected _onPoolTerm(
+    head: RollParseNode,
+    tail: RollParseNode[],
+    modifiers: string | null,
+    flavor: string | null,
+    formula: string,
+  ): PoolRollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Handle a parenthetical.
+   * @param term - The inner term.
+   * @param flavor - Associated flavor text.
+   * @param formula - The original matched text.
+   * @internal
+   */
+  protected _onParenthetical(term: RollParseNode, flavor: string | null, formula: string): ParentheticalRollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Handle some string that failed to be classified.
+   * @param term - The term.
+   * @param flavor - Associated flavor text.
+   */
+  protected _onStringTerm(term: string, flavor: string | null): StringParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Collapse multiple additive operators into a single one.
+   * @param operators - A sequence of additive operators.
+   */
+  protected _collapseOperators(operators: string[]): string;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Wrap a term with a leading minus.
+   * @param term - The term to wrap.
+   */
+  protected _wrapNegativeTerm(term: RollParseNode): RollParseNode;
+
+  /* -------------------------------------------- */
+  /*  Tree Manipulation                           */
+  /* -------------------------------------------- */
+  /**
+   * Flatten a tree structure (either a parse tree or AST) into an array with operators in infix notation.
+   * @param root -The root of the tree.
+   */
+  static flattenTree(root: RollParseNode): RollParseNode[];
+
+  /* -------------------------------------------- */
+
+  /**
+   * Use the Shunting Yard algorithm to convert a parse tree or list of terms into an AST with correct operator
+   * precedence.
+   * See https://en.wikipedia.org/wiki/Shunting_yard_algorithm for a description of the algorithm in detail.
+   * @param root - The root of the parse tree or a list of terms.
+   */
+  static toAST(root: RollParseNode | RollTerm[]): RollParseNode;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Determine if a given node is an operator term.
+   */
+  static isOperatorTerm(node: RollParseNode | RollTerm): void;
+
+  /* -------------------------------------------- */
+  /*  Debug Formatting                            */
+  /* -------------------------------------------- */
+
+  /**
+   * Format a list argument.
+   * @param list - The list to format.
+   */
+  static formatList(list: RollParseArg[]): string;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Format a parser argument.
+   * @param arg - The argument.
+   */
+  static formatArg(arg: RollParseArg): string;
+
+  /* -------------------------------------------- */
+
+  /**
+   * Format arguments for debugging.
+   * @param method - The method name.
+   * @param args - The arguments.
+   */
+  static formatDebug(method: string, ...args: RollParseArg[]): string;
+}
+
+export default RollParser;