@league-of-foundry-developers/foundry-vtt-types 12.331.3-beta → 12.331.5

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig.json",
+  "compilerOptions": {
+    "types": [],
+    "allowImportingTsExtensions": true,
+    "allowSyntheticDefaultImports": true,
+    "esModuleInterop": true,
+    "exactOptionalPropertyTypes": true,
+    "module": "ESNext",
+    "moduleResolution": "Bundler",
+    "noEmit": true,
+    "noImplicitOverride": true,
+    "strict": true,
+    "target": "ESNext",
+    "verbatimModuleSyntax": true,
+    "noUncheckedSideEffectImports": true,
+    "noUncheckedIndexedAccess": true,
+    "incremental": true
+  },
+
+  // This root project includes nothing on purpose.
+  "include": [],
+
+  "references": [
+    { "path": "./src/tsconfig.json" },
+    { "path": "./tsconfig.miscellaneous.json" },
+    { "path": "./tests/tsconfig.json" }
+  ]
+}

package/tsconfig.main.json

@@ -0,0 +1,8 @@
+// This file exists because for CI the `tests` folder's typechecking must be skipped.
+// This has to exist until tests are fixed.
+{
+  "$schema": "https://json.schemastore.org/tsconfig.json",
+  "extends": "./tsconfig.json",
+
+  "references": [{ "path": "./src" }, { "path": "./tsconfig.miscellaneous.json" }]
+}

package/tsconfig.miscellaneous.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig.json",
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "allowJs": true,
+    "checkJs": true,
+    "types": [],
+    "outDir": ".typescript-build/miscellaneous",
+    "composite": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true
+  },
+  // There are miscellaneous JS files at the root of the repo as well as .github, e.g. .lintstagedrc.js and vitest.config.ts
+  "include": ["*", ".*", ".github/**/*"],
+  "references": []
+}

package/index.d.mts

@@ -1,5 +0,0 @@
-import "handlebars";
-import "jquery";
-import "pixi.js";
-import "showdown";
-import "./src/index.d.mts";

package/src/foundry/client/apps/placeables/light-config.d.mts

@@ -1,100 +0,0 @@
-import type { InterfaceToObject } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, DeepPartial, MaybePromise } from "../../../../types/utils.d.mts";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single AmbientLight document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   */
-  class AmbientLightConfig<
-    Options extends DocumentSheetOptions<AmbientLightDocument> = DocumentSheetOptions<AmbientLightDocument>,
-  > extends DocumentSheet<Options, AmbientLightDocument.ConfiguredInstance> {
-    /**
-     * Maintain a copy of the original to show a real-time preview of changes.
-     */
-    preview: AmbientLightDocument.ConfiguredInstance;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: "ambient-light-config",
-     *   classes: ["sheet", "ambient-light-config"],
-     *   title: "LIGHT.ConfigTitle",
-     *   template: "templates/scene/ambient-light-config.html",
-     *   width: 480,
-     *   height: "auto",
-     *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "basic"}]
-     * });
-     * ```
-     */
-    static override get defaultOptions(): DocumentSheetOptions<AmbientLightDocument>;
-
-    protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-
-    override activateListeners(html: JQuery): void;
-
-    /**
-     * Preview the change caused by a change on the form by refreshing the display of the light source
-     */
-    protected _onChangeInput(event: JQuery.ChangeEvent): Promise<void>;
-
-    protected _onResetForm(event: PointerEvent): void;
-
-    /**
-     * Preview changes to the AmbientLight document as if they were true document updates.
-     * @param change - A change to preview
-     */
-    protected _previewChanges(change: DeepPartial<AmbientLightDocument["_source"]>): void;
-
-    /**
-     * Restore the true data for the AmbientLight document when the form is submitted or closed.
-     */
-    protected _resetPreview(): void;
-
-    protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
-
-    protected override _getSubmitData(updateData?: AnyObject | null): InterfaceToObject<AmbientLightConfig.FormData>;
-
-    protected override _updateObject(event: Event, formData: AmbientLightConfig.FormData): Promise<unknown>;
-
-    /**
-     * Refresh the display of the AmbientLight object
-     * @internal
-     */
-    protected _refresh(): void;
-  }
-
-  namespace AmbientLightConfig {
-    type Any = AmbientLightConfig<any>;
-
-    interface FormData {
-      x: AmbientLightDocument["x"];
-      y: AmbientLightDocument["y"];
-      rotation: AmbientLightDocument["rotation"];
-      walls: AmbientLightDocument["walls"];
-      vision: AmbientLightDocument["vision"];
-      "config.dim": AmbientLightDocument["config"]["dim"];
-      "config.bright": AmbientLightDocument["config"]["bright"];
-      "config.angle": AmbientLightDocument["config"]["angle"];
-      "config.color": AmbientLightDocument["config"]["color"];
-      "config.alpha": AmbientLightDocument["config"]["alpha"];
-      "config.darkness.min": AmbientLightDocument["config"]["darkness"]["min"];
-      "config.darkness.max": AmbientLightDocument["config"]["darkness"]["max"];
-      "config.animation.type": AmbientLightDocument["config"]["animation"]["type"];
-      "config.animation.speed": AmbientLightDocument["config"]["animation"]["speed"];
-      "config.animation.reverse": AmbientLightDocument["config"]["animation"]["reverse"];
-      "config.animation.intensity": AmbientLightDocument["config"]["animation"]["intensity"];
-      "config.coloration": AmbientLightDocument["config"]["coloration"];
-      "config.luminosity": AmbientLightDocument["config"]["luminosity"];
-      "config.attenuation": AmbientLightDocument["config"]["attenuation"];
-      "config.saturation": AmbientLightDocument["config"]["saturation"];
-      "config.contrast": AmbientLightDocument["config"]["contrast"];
-      "config.shadows": AmbientLightDocument["config"]["shadows"];
-    }
-  }
-}

package/src/foundry/client/apps/placeables/sound-config.d.mts

@@ -1,43 +0,0 @@
-import type { MaybePromise } from "../../../../types/utils.d.mts";
-
-declare global {
-  /**
-   * The Application responsible for configuring a single AmbientSound document within a parent Scene.
-   * @typeParam Options - the type of the options object
-   */
-  class AmbientSoundConfig<
-    Options extends DocumentSheetOptions<AmbientSoundDocument> = DocumentSheetOptions<AmbientSoundDocument>,
-  > extends DocumentSheet<Options, AmbientSoundDocument.ConfiguredInstance> {
-    /**
-     * @defaultValue
-     * ```typescript
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   title: "SOUND.ConfigTitle",
-     *   template: "templates/scene/sound-config.html",
-     *   width: 480
-     * });
-     * ```
-     */
-    static get defaultOptions(): DocumentSheetOptions<AmbientSoundDocument>;
-
-    override get title(): string;
-
-    override getData(options?: Partial<Options>): MaybePromise<object>; // TODO: Implement GetDataReturnType
-
-    protected override _updateObject(event: Event, formData: AmbientSoundConfig.FormData): Promise<unknown>;
-
-    override close(options?: Application.CloseOptions): Promise<void>;
-  }
-
-  namespace AmbientSoundConfig {
-    type Any = AmbientSoundConfig<any>;
-
-    type FormData = Pick<
-      foundry.documents.BaseAmbientSound,
-      "easing" | "path" | "volume" | "x" | "y" | "radius" | "walls"
-    > & {
-      "darkness.min": AmbientSoundDocument["darkness"]["min"];
-      "darkness.max": AmbientSoundDocument["darkness"]["max"];
-    };
-  }
-}

package/src/foundry/common/documents/module.d.mts

@@ -1,35 +0,0 @@
-// 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 BaseActiveEffect } from "./active-effect.mjs";
-export { default as BaseActorDelta } from "./actor-delta.mjs";
-export { default as BaseActor } from "./actor.mjs";
-export { default as BaseAdventure } from "./adventure.mjs";
-export { default as BaseAmbientLight } from "./ambient-light.mjs";
-export { default as BaseAmbientSound } from "./ambient-sound.mjs";
-export { default as BaseCard } from "./card.mjs";
-export { default as BaseCards } from "./cards.mjs";
-export { default as BaseChatMessage } from "./chat-message.mjs";
-export { default as BaseCombat } from "./combat.mjs";
-export { default as BaseCombatant } from "./combatant.mjs";
-export { default as BaseDrawing } from "./drawing.mjs";
-export { default as BaseFogExploratidn } from "./fog-exploration.mjs";
-export { default as BaseFolder } from "./folder.mjs";
-export { default as BaseItem } from "./item.mjs";
-export { default as BaseJournalEntry } from "./journal-entry.mjs";
-export { default as BaseJournalEntryPage } from "./journal-entry-page.mjs";
-export { default as BaseMacro } from "./macro.mjs";
-export { default as BaseMeasuredTemplate } from "./measured-template.mjs";
-export { default as BaseNote } from "./note.mjs";
-export { default as BasePlaylist } from "./playlist.mjs";
-export { default as BasePlaylistSound } from "./playlist-sound.mjs";
-export { default as BaseRollTable } from "./roll-table.mjs";
-export { default as BaseScene } from "./scene.mjs";
-export { default as BaseSetting } from "./setting.mjs";
-export { default as BaseTableResult } from "./table-result.mjs";
-export { default as BaseTile } from "./tile.mjs";
-export { default as BaseToken } from "./token.mjs";
-export { default as BaseUser } from "./user.mjs";
-export { default as BaseWall } from "./wall.mjs";

package/src/foundry/common/primitives/regex.d.mts

@@ -1,12 +0,0 @@
-export {};
-
-declare global {
-  interface RegExpConstructor {
-    /**
-     * Escape a given input string, prefacing special characters with backslashes for use in a regular expression
-     * @param string - The un-escaped input string
-     * @returns The escaped string, suitable for use in regular expression
-     */
-    escape(string: string): string;
-  }
-}