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

package/src/foundry/common/utils/helpers.d.mts

@@ -1,4 +1,4 @@
-import type { AnyConstructor, AnyFunction, DeepPartial, InexactPartial } from "../../../types/utils.d.mts";
+import type { AnyConstructor, AnyFunction, DeepPartial, InexactPartial, NonNullish } from "fvtt-types/utils";
 import type Document from "../abstract/document.d.mts";
 
 /**
@@ -273,8 +273,15 @@ export function getProperty(object: object, key: string): any;
  */
 export function setProperty(object: object, key: string, value: any): boolean;
 
-export type InvertableObject = Record<string | number | symbol, string | number | symbol>;
-export type InvertObject<in out T extends InvertableObject> = { [Key in keyof T as T[Key]]: Key };
+// Merging into this would be antithetical to its purpose.
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export type InvertableObject = {
+  readonly [K: PropertyKey]: PropertyKey;
+};
+
+export type InvertObject<in out T extends InvertableObject> = {
+  [K in keyof T as T[K]]: K;
+};
 
 /**
  * Invert an object by assigning its values as keys and its keys as values.
@@ -297,7 +304,10 @@ export function isNewerVersion(v1: number | string, v0: number | string): boolea
  * @param value - The value to test
  * @returns Is the value empty-like?
  */
-export function isEmpty(value: undefined | null | unknown[] | object | Set<unknown> | Map<unknown, unknown>): boolean;
+
+export function isEmpty(
+  value: undefined | null | unknown[] | object | Set<unknown> | Map<unknown, unknown> | NonNullish,
+): boolean;
 
 export type MergeObject<T, U, M extends MergeObjectOptions> = UpdateInsert<
   DeleteByObjectKeys<T, U, M>,
@@ -415,7 +425,7 @@ export interface MergeObjectOptions {
  */
 declare function _mergeInsert(
   original: object,
-  k: string | number | symbol,
+  k: PropertyKey,
   v: any,
   options?: Pick<MergeObjectOptions, "insertKeys" | "insertValues" | "performDeletions">,
   _d?: number,
@@ -463,7 +473,7 @@ export function timeSince(timeStamp: Date | string): string;
  * @param options - Additional options. (default: `{}`)
  * @returns
  */
-export function formatFileSize(size: number, options: FormatFileSizeOptions): string;
+export function formatFileSize(size: number, options?: FormatFileSizeOptions): string;
 
 interface FormatFileSizeOptions {
   /**
@@ -488,7 +498,7 @@ interface ResolvedUUID {
   /**
    * The type of Document referenced. Legacy compendium UUIDs will not populate this field if the compendium is not active in the World.
    */
-  type?: Document.Type;
+  type?: Document.Type | undefined;
 
   /**
    * The ID of the Document referenced.
@@ -498,17 +508,17 @@ interface ResolvedUUID {
   /**
    * The primary Document type of this UUID. Only present if the Document is embedded.
    */
-  primaryType?: foundry.CONST.PRIMARY_DOCUMENT_TYPES;
+  primaryType?: foundry.CONST.PRIMARY_DOCUMENT_TYPES | undefined;
 
   /**
    * The primary Document ID of this UUID. Only present if the Document is embedded.
    */
-  primaryId?: string;
+  primaryId?: string | undefined;
 
   /**
    * The collection that the primary Document belongs to.
    */
-  collection?: DocumentCollection.Any;
+  collection?: DocumentCollection.Any | undefined;
 
   /**
    * Additional Embedded Document parts.
@@ -518,17 +528,17 @@ interface ResolvedUUID {
   /**
    * An already-resolved parent Document.
    */
-  doc?: Document.Any;
+  doc?: Document.Any | undefined;
 
   /**
    * Either the document type or the parent type. Retained for backwards compatibility.
    */
-  documentType?: DocumentType;
+  documentType?: Document.Type | undefined;
 
   /**
    * Either the document id or the parent id. Retained for backwards compatibility.
    */
-  documentId?: string;
+  documentId?: string | undefined;
 }
 
 interface ParseUUIDOptions {

package/src/foundry/common/utils/string-tree.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 
 /**
  * A data structure representing a tree of string nodes with arbitrary object leaves.

package/src/foundry/common/utils/word-tree.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "fvtt-types/utils";
 import type StringTree from "./string-tree.d.mts";
 
 /**

package/src/foundry/index.d.mts

@@ -1,5 +1,4 @@
 import "./client/index.d.mts";
 import "./client-esm/client.d.mts";
-import "./clipper/index.d.mts";
 import "./common/prosemirror/index.d.mts";
 import "./public/index.d.mts";

package/src/foundry/{clipper → public/scripts/clipper}/clipper.d.mts

@@ -1,4 +1,4 @@
-import type { Brand } from "../../types/helperTypes.d.mts";
+import type { Brand } from "fvtt-types/utils";
 
 declare global {
   namespace ClipperLib {
@@ -110,10 +110,8 @@ declare global {
     let PI2: number;
 
     class IntPoint {
-      constructor(x: number, y: number, z: number);
-      constructor(x: number, y: number);
-      constructor(dp: DoublePoint);
-      constructor();
+      constructor(x: number, y: number, z?: number);
+      constructor(dp?: DoublePoint);
 
       X: number;
       Y: number;
@@ -164,25 +162,54 @@ declare global {
     }
 
     type ClipType = Brand<number, "ClipperLib.ClipType">;
-    const ClipType: Record<"ctIntersection" | "ctUnion" | "ctDifference" | "ctXor", ClipType>;
+    const ClipType: {
+      ctIntersection: 0 & ClipType;
+      ctUnion: 1 & ClipType;
+      ctDifference: 2 & ClipType;
+      ctXor: 3 & ClipType;
+    };
 
     type PolyType = Brand<number, "ClipperLib.PolyType">;
-    const PolyType: Record<"ptSubject" | "ptClip", PolyType>;
+    const PolyType: {
+      ptSubject: 0 & PolyType;
+      ptClip: 1 & PolyType;
+    };
 
     type PolyFillType = Brand<number, "ClipperLib.PolyFillType">;
-    const PolyFillType: Record<"pftEvenOdd" | "pftNonZero" | "pftPositive" | "pftNegative", PolyFillType>;
+    const PolyFillType: {
+      pftEvenOdd: 0 & PolyFillType;
+      pftNonZero: 1 & PolyFillType;
+      pftPositive: 2 & PolyFillType;
+      pftNegative: 3 & PolyFillType;
+    };
 
     type JoinType = Brand<number, "ClipperLib.JoinType">;
-    const JoinType: Record<"jtSquare" | "jtRound" | "jtMiter", JoinType>;
+    const JoinType: {
+      jtSquare: 0 & JoinType;
+      jtRound: 1 & JoinType;
+      jtMiter: 2 & JoinType;
+    };
 
     type EndType = Brand<number, "ClipperLib.EndType">;
-    const EndType: Record<"etOpenSquare" | "etOpenRound" | "etOpenButt" | "etClosedLine" | "etClosedPolygon", EndType>;
+    const EndType: {
+      etOpenSquare: 0 & EndType;
+      etOpenRound: 1 & EndType;
+      etOpenButt: 2 & EndType;
+      etClosedLine: 3 & EndType;
+      etClosedPolygon: 4 & EndType;
+    };
 
     type EdgeSide = Brand<number, "ClipperLib.EdgeSide">;
-    const EdgeSide: Record<"esLeft" | "esRight", EdgeSide>;
+    const EdgeSide: {
+      esLeft: 0 & EdgeSide;
+      esRight: 1 & EdgeSide;
+    };
 
     type Direction = Brand<number, "Direction">;
-    const Direction: Record<"dRightToLeft" | "dLeftToRight", Direction>;
+    const Direction: {
+      dRightToLeft: 0 & Direction;
+      dLeftToRight: 1 & Direction;
+    };
 
     class TEdge {
       Bot: IntPoint;
@@ -362,10 +389,10 @@ declare global {
       protected m_Scanbeam: Scanbeam | null;
 
       /** @defaultValue `null` */
-      protected m_PolyOuts: unknown | null;
+      protected m_PolyOuts: unknown;
 
       /** @defaultValue `null` */
-      protected m_ActiveEdges: unknown | null;
+      protected m_ActiveEdges: unknown;
 
       /**
        * -2^53
@@ -465,7 +492,16 @@ declare global {
     }
 
     class Clipper extends ClipperBase {
-      constructor(InitOptions?: number);
+      constructor(
+        /**
+         * @defaultValue `0`
+         * @remarks Bitmask options:
+         * - `ReverseSolution`:  `0b0000001`
+         * - `StrictlySimple`:   `0b0000010`
+         * - `PreserveColinear`: `0b0000100`
+         */
+        InitOptions?: number | null,
+      );
 
       /** @defaultValue `[]` */
       protected m_PolyOuts: OutRec[];
@@ -748,11 +784,17 @@ declare global {
 
       ClosedPathsFromPolyTree(polytree: PolyTree): Paths;
 
-      static NodeType: Record<"ntAny" | "ntOpen" | "ntClosed", Clipper.NodeType>;
+      static NodeType: Clipper.NodeTypes;
     }
 
     namespace Clipper {
       type NodeType = Brand<number, "ClipperLib.Clipper.NodeType">;
+
+      interface NodeTypes {
+        ntAny: 0 & NodeType;
+        ntOpen: 1 & NodeType;
+        ntClosed: 2 & NodeType;
+      }
     }
 
     class ClipperOffset {

package/src/foundry/public/scripts/index.d.mts

@@ -1 +1,2 @@
 import "./earcut-edges/index.d.mts";
+import "./clipper/index.d.mts";

package/src/foundry/public/scripts/workers/image-compressor.d.mts

@@ -0,0 +1,23 @@
+// eslint-disable-next-line import-x/extensions
+import * as worker from "../../../../types/workers/image-compressor.mjs";
+
+declare global {
+  export import FORMATS = worker.FORMATS;
+  export import Debug = worker.Debug;
+
+  export import ProcessBufferToBase64Options = worker.ProcessBufferToBase64Options;
+  export import ExpandOrReduceBufferOptions = worker.ExpandOrReduceBufferOptions;
+  export import ProcessBufferToBase64Return = worker.ProcessBufferToBase64Return;
+  export import ProcessBufferRedToBufferRGBAReturn = worker.ProcessBufferRedToBufferRGBAReturn;
+  export import ProcessBufferRGBAToBufferREDReturn = worker.ProcessBufferRGBAToBufferREDReturn;
+
+  export import processBufferToBase64 = worker.processBufferToBase64;
+  export import processBufferRedToBufferRGBA = worker.processBufferRedToBufferRGBA;
+  export import processBufferRGBAToBufferRED = worker.processBufferRGBAToBufferRED;
+  export import controlHashes = worker.controlHashes;
+  export import pixelsToOffscreenCanvas = worker.pixelsToOffscreenCanvas;
+  export import offscreenToBase64 = worker.offscreenToBase64;
+  export import blobToBase64 = worker.blobToBase64;
+  export import expandBuffer = worker.expandBuffer;
+  export import reduceBuffer = worker.reduceBuffer;
+}

package/src/foundry/public/scripts/workers/index.d.mts

@@ -0,0 +1 @@
+import "./image-compressor.d.mts";

package/{index-lenient.d.mts → src/index-lenient.d.mts}

@@ -1,3 +1,5 @@
+/* eslint-disable */
+
 import "./index.d.mts";
 
 declare global {

package/src/index.d.mts

@@ -1,2 +1,8 @@
+import "handlebars";
+import "jquery";
+import "pixi.js";
+import "showdown";
+
 import "./foundry/index.d.mts";
 import "./types/index.d.mts";
+import "./configuration/index.d.mts";

package/src/tsconfig.json

@@ -0,0 +1,19 @@
+{
+  "$schema": "https://json.schemastore.org/tsconfig.json",
+  "extends": "../tsconfig.json",
+  "compilerOptions": {
+    "types": [],
+    "outDir": "../.typescript-build/src",
+    "composite": true,
+    "noEmit": false,
+    "emitDeclarationOnly": true,
+    "paths": {
+      "@client/*": ["./foundry/client/*"],
+      "@common/*": ["./foundry/common/*"]
+    }
+  },
+  // Note: `**/*` is used to work around a bug with `eslint`. This will be removed once it's fixed.
+  "include": ["index.d.mts", "**/*"],
+  "exclude": ["index-lenient.d.mts"],
+  "references": []
+}

package/src/types/augments/particles.d.mts

@@ -0,0 +1,29 @@
+/* eslint-disable import-x/export */
+
+import type { Brand } from "fvtt-types/utils";
+
+export namespace behaviors {
+  type BehaviorOrder = Brand<number, "PIXI.particles.behaviors.BehaviorOrder">;
+
+  /**
+   * Standard behavior order values, specifying when/how they are used. Other numeric values can be used,
+   * but only the Spawn value will be handled in a special way. All other values will be sorted numerically.
+   * Behaviors with the same value will not be given any specific sort order, as they are assumed to not
+   * interfere with each other.
+   */
+  const BehaviorOrder: {
+    /**
+     * Spawn - initial placement and/or rotation. This happens before rotation/translation due to
+     * emitter rotation/position is applied.
+     */
+    Spawn: 0 & BehaviorOrder;
+
+    /** Normal priority, for things that don't matter when they are applied. */
+    Normal: 2 & BehaviorOrder;
+
+    /** Delayed priority, for things that need to read other values in order to act correctly. */
+    Late: 5 & BehaviorOrder;
+  };
+}
+
+export * from "@pixi/particle-emitter";