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

package/src/foundry/client-esm/applications/forms/fields.d.mts

@@ -0,0 +1,219 @@
+export type CustomFormGroup = (
+  field: foundry.data.fields.DataField,
+  groupConfig: FormGroupConfig,
+  inputConfig: FormInputConfig,
+) => HTMLDivElement;
+
+export type CustomFormInput = (
+  field: foundry.data.fields.DataField,
+  config: FormInputConfig,
+) => HTMLElement | HTMLCollection;
+
+export interface FormGroupConfig {
+  /**
+   * A text label to apply to the form group
+   */
+  label: string;
+  /**
+   * An optional units string which is appended to the label
+   */
+  units?: string;
+  /**
+   * An HTML element or collection of elements which provide the inputs
+   * for the group
+   */
+  input: HTMLElement | HTMLCollection;
+  /**
+   * Hint text displayed as part of the form group
+   */
+  hint?: string;
+  /**
+   * Some parent CSS id within which field names are unique. If provided,
+   *                     this root ID is used to automatically assign "id" attributes to input
+   *                     elements and "for" attributes to corresponding labels
+   */
+  rootId?: string;
+  /**
+   * An array of CSS classes applied to the form group element
+   */
+  classes?: string[];
+  /**
+   * Is the "stacked" class applied to the form group
+   */
+  stacked?: boolean;
+  /**
+   * Should labels or other elements within this form group be
+   *            automatically localized?
+   */
+  localize?: boolean;
+  /**
+   * A custom form group widget function which replaces the default
+   *            group HTML generation
+   */
+  widget?: CustomFormGroup;
+}
+
+export interface FormInputConfig<FormInputValue = any> {
+  /**
+   * The name of the form element
+   */
+  name: string;
+  /**
+   * The current value of the form element
+   */
+  value?: FormInputValue;
+  /**
+   * Is the field required?
+   */
+  required?: boolean;
+  /**
+   * Is the field disabled?
+   */
+  disabled?: boolean;
+  /**
+   * Is the field readonly?
+   */
+  readonly?: boolean;
+  /**
+   * Is the field autofocused?
+   */
+  autofocus?: boolean;
+  /**
+   * Localize values of this field?
+   */
+  localize?: boolean;
+  /**
+   * Additional dataset attributes to assign to the input
+   */
+  dataset?: Record<string, string>;
+  /**
+   * A placeholder value, if supported by the element type
+   */
+  placeholder?: string;
+  input?: CustomFormInput;
+}
+
+/**
+ * Create a standardized form field group.
+ */
+export function createFormGroup(config: FormGroupConfig): HTMLDivElement;
+
+/**
+ * Create an `<input type="checkbox">` element for a BooleanField.
+ */
+export function createCheckboxInput(config: FormInputConfig<boolean>): HTMLInputElement;
+
+export interface EditorInputConfig extends FormInputConfig<string> {
+  /** @defaultValue `"prosemirror"` */
+  engine?: string;
+  height?: number;
+  editable?: boolean;
+  button?: boolean;
+  collaborate?: boolean;
+}
+
+/**
+ * Create a `<div class="editor">` element for a StringField.
+ */
+export function createEditorInput(config: EditorInputConfig): HTMLDivElement;
+
+/**
+ * Create a `<multi-select>` element for a StringField.
+ */
+export function createMultiSelectInput(
+  config: FormInputConfig<string[]> & Omit<SelectInputConfig, "blank">,
+): HTMLSelectElement;
+
+export interface NumberInputConfig extends FormInputConfig<number> {
+  min: number;
+  max: number;
+  step: number | "any";
+  type?: "range" | "number";
+}
+
+/**
+ * Create an `<input type="number">` element for a NumberField.
+ */
+export function createNumberInput(config: NumberInputConfig): HTMLInputElement;
+
+export interface FormSelectOption {
+  value: string;
+  label: string;
+  group?: string;
+  disabled?: boolean;
+  selected?: boolean;
+  rule?: boolean;
+}
+
+// Compatible with multiple different types of FormInputConfig so this does *not* extend that interface
+export interface SelectInputConfig {
+  options: FormSelectOption[];
+  /**
+   * An option to control the order and display of optgroup elements. The order of
+   *         strings defines the displayed order of optgroup elements.
+   *         A blank string may be used to define the position of ungrouped options.
+   *         If not defined, the order of groups corresponds to the order of options.
+   */
+  groups?: string[];
+  blank?: string;
+  /**
+   * An alternative value key of the object passed to the options array
+   */
+  valueAttr?: string;
+  /**
+   * An alternative label key of the object passed to the options array
+   */
+  labelAttr?: string;
+  /**
+   * Localize value labels
+   */
+  localize?: boolean;
+  /**
+   * Sort options alphabetically by label within groups
+   */
+  sort?: boolean;
+  /**
+   * Customize the type of select that is created
+   */
+  type?: "single" | "multi" | "checkboxes";
+}
+
+export interface TextAreaInputConfig extends FormInputConfig<string> {
+  rows: number;
+}
+
+/**
+ * Create a `<textarea>` element for a StringField.
+ */
+export function createTextareaInput(config: TextAreaInputConfig): HTMLTextAreaElement;
+
+/**
+ * Create an `<input type="text">` element for a StringField.
+ */
+export function createTextInput(config: FormInputConfig<string>): HTMLInputElement;
+
+/**
+ * Structure a provided array of select options into a standardized format for rendering optgroup and option elements.
+ *
+ * @example
+ * ```js
+ * const options = [
+ *   {value: "bar", label: "Bar", selected: true, group: "Good Options"},
+ *   {value: "foo", label: "Foo", disabled: true, group: "Bad Options"},
+ *   {value: "baz", label: "Baz", group: "Good Options"}
+ * ];
+ * const groups = ["Good Options", "Bad Options", "Unused Options"];
+ * const optgroups = foundry.applications.fields.prepareSelectOptionGroups({options, groups, blank: true, sort: true});
+ * ```
+ */
+export function prepareSelectOptionGroups(config: FormInputConfig & SelectInputConfig): {
+  group: string;
+  options: FormSelectOption[];
+}[];
+
+/**
+ * Apply standard attributes to all input elements.
+ * @param input  - The element being configured
+ * @param config - Configuration for the element
+ */
+export function setInputAttributes(input: HTMLElement, config: FormInputConfig<any>): void;

package/src/foundry/client-esm/applications/sheets/_module.d.mts

@@ -0,0 +1,12 @@
+// 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 { default as ActorSheetV2 } from "./actor-sheet.mjs";
+export { default as AmbientSoundConfig } from "./ambient-sound-config.mjs";
+export { default as AmbientLightConfig } from "./ambient-light-config.mjs";
+export { default as ItemSheetV2 } from "./item-sheet.mjs";
+export { default as RegionBehaviorConfig } from "./region-behavior-config.mjs";
+export { default as RegionConfig } from "./region-config.mjs";
+export { default as UserConfig } from "./user-config.mjs";

package/src/foundry/client-esm/applications/sheets/actor-sheet.d.mts

@@ -0,0 +1,31 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type ApplicationV2 from "../api/application.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+
+/**
+ * A base class for providing Actor Sheet behavior using ApplicationV2.
+ */
+export default class ActorSheetV2<
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends
+    DocumentSheetV2.Configuration<Actor.ConfiguredInstance> = DocumentSheetV2.Configuration<Actor.ConfiguredInstance>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends DocumentSheetV2<Actor.ConfiguredInstance, RenderContext, Configuration, RenderOptions> {
+  /**
+   * The Actor document managed by this sheet.
+   */
+  get actor(): this["document"];
+
+  /**
+   * If this sheet manages the ActorDelta of an unlinked Token, reference that Token document.
+   */
+  get token(): this["document"]["token"];
+
+  protected override _getHeaderControls(): ApplicationV2.HeaderControlsEntry[];
+
+  // ActorSheetV2 *does* override _renderHTML and _replaceHTML but these should always be overridden by the rendering mixin
+  // They are both leftovers from Atro hastily testing/putting together these subclasses
+
+  // The class includes a number of protected static functions for its actions
+  static #protected;
+}

package/src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts

@@ -0,0 +1,18 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * The AmbientLight configuration application.
+ */
+export default class AmbientLightConfig<
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends
+    DocumentSheetV2.Configuration<AmbientLightDocument.ConfiguredInstance> = DocumentSheetV2.Configuration<AmbientLightDocument.ConfiguredInstance>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<
+  AmbientLightDocument.ConfiguredInstance,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {}

package/src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts

@@ -0,0 +1,18 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * The AmbientSound configuration application.
+ */
+export default class AmbientSoundConfig<
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends
+    DocumentSheetV2.Configuration<AmbientSoundDocument.ConfiguredInstance> = DocumentSheetV2.Configuration<AmbientSoundDocument.ConfiguredInstance>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<
+  AmbientSoundDocument.ConfiguredInstance,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {}

package/src/foundry/client-esm/applications/sheets/item-sheet.d.mts

@@ -0,0 +1,22 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+
+/**
+ * A base class for providing Item Sheet behavior using ApplicationV2.
+ */
+export default class ItemSheetV2<
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends
+    DocumentSheetV2.Configuration<Item.ConfiguredInstance> = DocumentSheetV2.Configuration<Item.ConfiguredInstance>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends DocumentSheetV2<Item.ConfiguredInstance, RenderContext, Configuration, RenderOptions> {
+  /**
+   * The Item document managed by this sheet.
+   */
+  get item(): this["document"];
+
+  /**
+   * The Actor instance which owns this Item, if any.
+   */
+  get actor(): this["document"]["actor"];
+}

package/src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts

@@ -0,0 +1,13 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * The Scene Region configuration application.
+ */
+export default class RegionBehaviorConfig<
+  Document extends foundry.abstract.Document.Any,
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends DocumentSheetV2.Configuration<Document> = DocumentSheetV2.Configuration<Document>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<Document, RenderContext, Configuration, RenderOptions> {}

package/src/foundry/client-esm/applications/sheets/region-config.d.mts

@@ -0,0 +1,13 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * The Scene Region configuration application.
+ */
+export default class RegionConfig<
+  Document extends foundry.abstract.Document.Any,
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends DocumentSheetV2.Configuration<Document> = DocumentSheetV2.Configuration<Document>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<Document, RenderContext, Configuration, RenderOptions> {}

package/src/foundry/client-esm/applications/sheets/user-config.d.mts

@@ -0,0 +1,18 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type DocumentSheetV2 from "../api/document-sheet.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * The User configuration application.
+ */
+export default class UserConfig<
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends
+    DocumentSheetV2.Configuration<User.ConfiguredInstance> = DocumentSheetV2.Configuration<User.ConfiguredInstance>,
+  RenderOptions extends DocumentSheetV2.RenderOptions = DocumentSheetV2.RenderOptions,
+> extends HandlebarsApplicationMixin(DocumentSheetV2)<
+  User.ConfiguredInstance,
+  RenderContext,
+  Configuration,
+  RenderOptions
+> {}

package/src/foundry/client-esm/applications/ui/_module.d.mts

@@ -0,0 +1,6 @@
+// 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 { default as RegionLegend } from "./region-legend.mjs";

package/src/foundry/client-esm/applications/ui/region-legend.d.mts

@@ -0,0 +1,12 @@
+import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type ApplicationV2 from "../api/application.d.mts";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
+
+/**
+ * Scene Region Legend.
+ */
+export default class RegionLegend<
+  RenderContext extends AnyObject = EmptyObject,
+  Configuration extends ApplicationV2.Configuration = ApplicationV2.Configuration,
+  RenderOptions extends ApplicationV2.RenderOptions = ApplicationV2.RenderOptions,
+> extends HandlebarsApplicationMixin(ApplicationV2)<RenderContext, Configuration, RenderOptions> {}

package/src/foundry/client-esm/audio/_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 { default as AudioBufferCache } from "./cache.mjs";
+export { default as AudioHelper } from "./helper.mjs";
+export { default as AudioTimeout } from "./timeout.mjs";
+export { default as Sound } from "./sound.mjs";
+export { default as BiquadFilterEffect } from "./biquad.mjs";
+export { default as ConvolverEffect } from "./convolver.mjs";

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

@@ -0,0 +1 @@
+// Open question - this is just types?

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

@@ -0,0 +1,11 @@
+// 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 { default as SceneManager } from "./scene-manager.mjs";
+export { default as SMAAFilter } from "./smaa/smaa.mjs";
+export * as edges from "./edges/_module.mjs";
+export * as regions from "./regions/_module.mjs";
+export * as sources from "./sources/_module.mjs";
+export * as tokens from "./tokens/_module.mjs";

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

@@ -0,0 +1,9 @@
+// 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 { default as CanvasEdges } from "./edges.mjs";
+export { default as CollisionResult } from "./collision.mjs";
+export { default as Edge } from "./edge.mjs";
+export { default as PolygonVertex } from "./vertex.mjs";

package/src/foundry/client-esm/canvas/edges/collision.d.mts

@@ -0,0 +1,93 @@
+/**
+ * A specialized object that contains the result of a collision in the context of the ClockwiseSweepPolygon.
+ * This class is not designed or intended for use outside of that context.
+ * @internal
+ */
+declare class CollisionResult {
+  constructor(values?: {
+    target?: foundry.canvas.edges.PolygonVertex;
+    collisions?: foundry.canvas.edges.PolygonVertex[];
+    cwEdges?: EdgeSet;
+    ccwEdges?: EdgeSet;
+    isBehind?: boolean;
+    isLimited?: boolean;
+    wasLimited?: boolean;
+  });
+
+  /**
+   * The vertex that was the target of this result
+   * @defaultValue `null`
+   */
+  target: foundry.canvas.edges.PolygonVertex | null;
+
+  /**
+   * The array of collision points which apply to this result
+   * @defaultValue `[]`
+   */
+  collisions: foundry.canvas.edges.PolygonVertex[];
+
+  /**
+   * The set of edges connected to the target vertex that continue clockwise
+   * @defaultValue `new Set()`
+   */
+  cwEdges: EdgeSet;
+
+  /**
+   * The set of edges connected to the target vertex that continue counter-clockwise
+   * @defaultValue `new Set()`
+   */
+  ccwEdges: EdgeSet;
+
+  /**
+   * Is the target vertex for this result behind some closer active edge?
+   */
+  isBehind: boolean | undefined;
+
+  /**
+   * Does the target vertex for this result impose a limited collision?
+   */
+  isLimited: boolean | undefined;
+
+  /**
+   * Has the set of collisions for this result encountered a limited edge?
+   */
+  wasLimited: boolean | undefined;
+
+  /**
+   * Is this result limited in the clockwise direction?
+   * @defaultValue `false`
+   */
+  limitedCW: boolean;
+
+  /**
+   * Is this result limited in the counter-clockwise direction?
+   * @defaultValue `false`
+   */
+  limitedCCW: boolean;
+
+  /**
+   * Is this result blocking in the clockwise direction?
+   * @defaultValue `false`
+   */
+  blockedCW: boolean;
+
+  /**
+   * Is this result blocking in the counter-clockwise direction?
+   * @defaultValue `false`
+   */
+  blockedCCW: boolean;
+
+  /**
+   * Previously blocking in the clockwise direction?
+   * @defaultValue `false`
+   */
+  blockedCWPrev: boolean;
+
+  /**
+   * Previously blocking in the counter-clockwise direction?
+   * @defaultValue `false`
+   */
+  blockedCCWPrev: boolean;
+}
+
+export default CollisionResult;