@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/av/settings.d.mts

@@ -1,314 +1,407 @@
-import type { GetKey, ValueOf } from "fvtt-types/utils";
+import type { fields } from "#common/data/_module.mjs";
+import type { DataSchema } from "#common/data/fields.mjs";
+import type { GetKey, ValueOf } from "#utils";
 
-declare global {
-  interface AVSettingsData {
-    /** Whether this user has muted themselves. */
-    muted?: boolean | undefined;
+declare class AVSettings {
+  constructor();
 
-    /** Whether this user has hidden their video. */
-    hidden?: boolean | undefined;
+  /** @internal */
+  protected _set: <T>(key: string, value: T) => void;
 
-    /** Whether the user is broadcasting audio. */
-    speaking?: boolean | undefined;
-  }
+  /** @internal */
+  protected _change: () => void;
+
+  client: AVSettings.ClientSettings;
+
+  world: AVSettings.WorldSettings;
+
+  protected _original: AVSettings.Settings;
+
+  /**
+   * WebRTC Mode, Disabled, Audio only, Video only, Audio & Video
+   */
+  static AV_MODES: {
+    DISABLED: 0;
+    AUDIO: 1;
+    VIDEO: 2;
+    AUDIO_VIDEO: 3;
+  };
+
+  /**
+   * Voice modes: Always-broadcasting, voice-level triggered, push-to-talk.
+   */
+  static VOICE_MODES: AVSettings.VoiceModes;
+
+  /**
+   * Displayed nameplate options: Off entirely, animate between player and character name, player name only, character
+   * name only.
+   */
+  static NAMEPLATE_MODES: AVSettings.NameplateModes;
+
+  /**
+   * AV dock positions.
+   */
+  static DOCK_POSITIONS: AVSettings.DockPositions;
+
+  static get schemaFields(): AVSettings.SchemaFields;
+
+  /**
+   * Default Client Settings
+   */
+  static DEFAULT_CLIENT_SETTINGS: AVSettings.ClientSettings;
+
+  /**
+   * Default world-level AV settings.
+   */
+  static DEFAULT_WORLD_SETTINGS: AVSettings.WorldSettings;
+
+  static DEFAULT_USER_SETTINGS: AVSettings.StoredUserSettings;
+
+  /**
+   * Stores the transient AV activity data received from other users.
+   */
+  activity: Record<string, AVSettings.Data>;
+
+  initialize(): void;
 
-  class AVSettings {
-    constructor();
+  changed(): void;
 
-    /** @internal */
-    protected _set: <T>(key: string, value: T) => void;
+  get<S extends "client" | "world">(scope: S, setting: string): unknown; // TODO: Improve once we have proper typing for dot notation
 
-    /** @internal */
-    protected _change: () => void;
+  getUser(userId: string): AVSettings.UserSettings | null;
 
-    client: AVSettings.ClientSettings;
+  set<S extends "client" | "world">(scope: S, setting: string, value: unknown): void; // TODO: Improve once we have proper typing for dot notation
 
-    world: AVSettings.WorldSettings;
+  /**
+   * Return a mapping of AV settings for each game User.
+   */
+  get users(): Record<string, AVSettings.UserSettings>;
 
-    protected _original: AVSettings.Settings;
+  /**
+   * A helper to determine if the dock is configured in a vertical position.
+   */
+  get verticalDock(): boolean;
 
+  /**
+   * Prepare a standardized object of user settings data for a single User
+   * @internal
+   */
+  protected _getUserSettings(user: User.Implementation): AVSettings.UserSettings;
+
+  /**
+   * Handle setting changes to either rctClientSettings or rtcWorldSettings.
+   * @internal
+   */
+  protected _onSettingsChanged(): void;
+
+  /**
+   * Handle another connected user changing their AV settings.
+   */
+  handleUserActivity(userId: string, settings: AVSettings.Data): void;
+}
+
+declare namespace AVSettings {
+  interface ClientSettings {
     /**
-     * WebRTC Mode, Disabled, Audio only, Video only, Audio & Video
+     * @defaultValue `"default"`
      */
-    static AV_MODES: {
-      DISABLED: 0;
-      AUDIO: 1;
-      VIDEO: 2;
-      AUDIO_VIDEO: 3;
-    };
+    videoSrc: string;
 
     /**
-     * Voice modes: Always-broadcasting, voice-level triggered, push-to-talk.
+     * @defaultValue `"default"`
      */
-    static VOICE_MODES: AVSettings.VoiceModes;
+    audioSrc: string;
 
     /**
-     * Displayed nameplate options: Off entirely, animate between player and character name, player name only, character
-     * name only.
+     * @defaultValue `"default"`
      */
-    static NAMEPLATE_MODES: AVSettings.NameplateModes;
+    audioSink: string;
 
     /**
-     * AV dock positions.
+     * @defaultValue `"bottom"`
      */
-    static DOCK_POSITIONS: AVSettings.DockPositions;
+    dockPosition: AVSettings.DOCK_POSITIONS;
 
     /**
-     * Default Client Settings
+     * @defaultValue `false`
      */
-    static DEFAULT_CLIENT_SETTINGS: {
-      /**
-       * @defaultValue `"default"`
-       */
-      videoSrc: string;
-
-      /**
-       * @defaultValue `"default"`
-       */
-      audioSrc: string;
-
-      /**
-       * @defaultValue `"default"`
-       */
-      audioSink: string;
+    hidePlayerList: boolean;
 
-      /**
-       * @defaultValue `"bottom"`
-       */
-      dockPosition: AVSettings.DOCK_POSITIONS;
-
-      /**
-       * @defaultValue `false`
-       */
-      hidePlayerList: boolean;
-
-      /**
-       * @defaultValue `false`
-       */
-      hideDock: boolean;
-
-      /**
-       * @defaultValue `false`
-       */
-      muteAll: boolean;
-
-      /**
-       * @defaultValue `false`
-       */
-      disableVideo: boolean;
+    /**
+     * @defaultValue `false`
+     */
+    hideDock: boolean;
 
-      /**
-       * @defaultValue `false`
-       */
-      borderColors: boolean;
+    /**
+     * @defaultValue `false`
+     */
+    muteAll: boolean;
 
-      /**
-       * @defaultValue `240`
-       */
-      dockWidth: number;
+    /**
+     * @defaultValue `false`
+     */
+    disableVideo: boolean;
 
-      /**
-       * @defaultValue `1`
-       */
-      nameplates: AVSettings.NAMEPLATE_MODES;
-
-      voice: {
-        /**
-         * @defaultValue `"AVSettings.VOICE_MODES.PTT"`
-         */
-        mode: AVSettings.VOICE_MODES;
-
-        /**
-         * @defaultValue
-         * ```
-         * "`"
-         * ```
-         */
-        pttName: string;
-
-        /**
-         * @defaultValue `100`
-         */
-        pttDelay: number;
-
-        /**
-         * @defaultValue `-45`
-         */
-        activityThreshold: number;
-      };
+    /**
+     * @defaultValue `false`
+     */
+    borderColors: boolean;
 
-      /**
-       * @defaultValue `{}`
-       */
-      users: Record<string, AVSettings.StoredUserSettings>;
-    };
+    /**
+     * @defaultValue `240`
+     */
+    dockWidth: number;
 
     /**
-     * Default world-level AV settings.
+     * @defaultValue `1`
      */
-    static DEFAULT_WORLD_SETTINGS: {
-      /**
-       * @defaultValue `AVSettings.AV_MODES.DISABLED`
-       */
-      mode: AVSettings.AV_MODES;
-
-      turn: {
-        /**
-         * @defaultValue `"server"`
-         */
-        type: string;
-
-        /**
-         * @defaultValue `""`
-         */
-        url: string;
-
-        /**
-         * @defaultValue `""`
-         */
-        username: string;
-
-        /**
-         * @defaultValue `""`
-         */
-        password: string;
-      };
-    };
+    nameplates: AVSettings.NAMEPLATE_MODES;
 
-    static DEFAULT_USER_SETTINGS: {
+    voice: {
       /**
-       * @defaultValue `false`
+       * @defaultValue `"AVSettings.VOICE_MODES.PTT"`
        */
-      popout: boolean;
+      mode: AVSettings.VOICE_MODES;
 
       /**
-       * @defaultValue `100`
+       * @defaultValue
+       * ```
+       * "`"
+       * ```
        */
-      x: number;
+      pttName: string;
 
       /**
        * @defaultValue `100`
        */
-      y: number;
+      pttDelay: number;
 
       /**
-       * @defaultValue `0`
+       * @defaultValue `-45`
        */
-      z: number;
+      activityThreshold: number;
+    };
 
-      /**
-       * @defaultValue `320`
-       */
-      width: number;
+    /**
+     * @defaultValue `{}`
+     */
+    users: Record<string, AVSettings.StoredUserSettings>;
+  }
 
-      /**
-       * @defaultValue `1.0`
-       */
-      volume: number;
+  interface WorldSettings {
+    /**
+     * @defaultValue `AVSettings.AV_MODES.DISABLED`
+     */
+    mode: AVSettings.AV_MODES;
 
+    turn: {
       /**
-       * @defaultValue `false`
+       * @defaultValue `"server"`
        */
-      muted: boolean;
+      type: string;
 
       /**
-       * @defaultValue `false`
+       * @defaultValue `""`
        */
-      hidden: boolean;
+      url: string;
 
       /**
-       * @defaultValue `false`
+       * @defaultValue `""`
        */
-      blocked: boolean;
+      username: string;
 
       /**
-       * @defaultValue `240`
+       * @defaultValue `""`
        */
-      dockWidth: number;
+      password: string;
     };
+  }
 
+  interface StoredUserSettings {
     /**
-     * Stores the transient AV activity data received from other users.
+     * @defaultValue `false`
      */
-    activity: Record<string, AVSettingsData>;
+    popout: boolean;
 
-    initialize(): void;
-
-    changed(): void;
+    /**
+     * @defaultValue `100`
+     */
+    x: number;
 
-    get<S extends "client" | "world">(scope: S, setting: string): unknown; // TODO: Improve once we have proper typing for dot notation
+    /**
+     * @defaultValue `100`
+     */
+    y: number;
 
-    getUser(userId: string): AVSettings.UserSettings | null;
+    /**
+     * @defaultValue `0`
+     */
+    z: number;
 
-    set<S extends "client" | "world">(scope: S, setting: string, value: unknown): void; // TODO: Improve once we have proper typing for dot notation
+    /**
+     * @defaultValue `320`
+     */
+    width: number;
 
     /**
-     * Return a mapping of AV settings for each game User.
+     * @defaultValue `1.0`
      */
-    get users(): Record<string, AVSettings.UserSettings>;
+    volume: number;
 
     /**
-     * A helper to determine if the dock is configured in a vertical position.
+     * @defaultValue `false`
      */
-    get verticalDock(): boolean;
+    muted: boolean;
 
     /**
-     * Prepare a standardized object of user settings data for a single User
-     * @internal
+     * @defaultValue `false`
      */
-    protected _getUserSettings(user: User): AVSettings.UserSettings;
+    hidden: boolean;
 
     /**
-     * Handle setting changes to either rctClientSettings or rtcWorldSettings.
-     * @internal
+     * @defaultValue `false`
      */
-    protected _onSettingsChanged(): void;
+    blocked: boolean;
 
     /**
-     * Handle another connected user changing their AV settings.
+     * @defaultValue `240`
      */
-    handleUserActivity(userId: string, settings: AVSettingsData): void;
+    dockWidth: number;
+  }
+
+  interface UserSettings extends StoredUserSettings {
+    canBroadcastAudio: boolean;
+    canBroadcastVideo: boolean;
+  }
+
+  interface Settings {
+    client: ClientSettings;
+    world: WorldSettings;
   }
 
-  namespace AVSettings {
-    type ClientSettings = typeof AVSettings.DEFAULT_CLIENT_SETTINGS;
-    type WorldSettings = typeof AVSettings.DEFAULT_WORLD_SETTINGS;
-    type StoredUserSettings = typeof AVSettings.DEFAULT_USER_SETTINGS;
-    type UserSettings = StoredUserSettings & { canBroadcastAudio: boolean; canBroadcastVideo: boolean };
-    interface Settings {
-      client: ClientSettings;
-      world: WorldSettings;
-    }
-
-    // eslint-disable-next-line @typescript-eslint/no-empty-object-type
-    interface Overrides {}
-
-    interface DefaultVoiceModes {
-      ALWAYS: "always";
-      ACTIVITY: "activity";
-      PTT: "ptt";
-    }
-    type VoiceModes = GetKey<AVSettings.Overrides, "VoiceModes", DefaultVoiceModes>;
-    type VOICE_MODES = ValueOf<VoiceModes>;
-
-    interface DefaultNamePlateModes {
-      OFF: 0;
-      BOTH: 1;
-      PLAYER_ONLY: 2;
-      CHAR_ONLY: 3;
-    }
-    type NameplateModes = GetKey<AVSettings.Overrides, "NameplateModes", DefaultNamePlateModes>;
-    type NAMEPLATE_MODES = ValueOf<NameplateModes>;
-
-    interface DefaultDockPositions {
-      TOP: "top";
-      RIGHT: "right";
-      BOTTOM: "bottom";
-      LEFT: "left";
-    }
-    type DockPositions = GetKey<AVSettings.Overrides, "DockPositions", DefaultDockPositions>;
-    type DOCK_POSITIONS = ValueOf<DockPositions>;
-
-    type AV_MODES = ValueOf<typeof AVSettings.AV_MODES>;
+  // eslint-disable-next-line @typescript-eslint/no-empty-object-type
+  interface Overrides {}
+
+  interface DefaultVoiceModes {
+    ALWAYS: "always";
+    ACTIVITY: "activity";
+    PTT: "ptt";
+  }
+  type VoiceModes = GetKey<AVSettings.Overrides, "VoiceModes", DefaultVoiceModes>;
+  type VOICE_MODES = ValueOf<VoiceModes>;
+
+  interface DefaultNamePlateModes {
+    OFF: 0;
+    BOTH: 1;
+    PLAYER_ONLY: 2;
+    CHAR_ONLY: 3;
+  }
+  type NameplateModes = GetKey<AVSettings.Overrides, "NameplateModes", DefaultNamePlateModes>;
+  type NAMEPLATE_MODES = ValueOf<NameplateModes>;
+
+  interface DefaultDockPositions {
+    TOP: "top";
+    RIGHT: "right";
+    BOTTOM: "bottom";
+    LEFT: "left";
+  }
+  type DockPositions = GetKey<AVSettings.Overrides, "DockPositions", DefaultDockPositions>;
+  type DOCK_POSITIONS = ValueOf<DockPositions>;
+
+  interface WorldSchema extends DataSchema {
+    mode: fields.NumberField<{
+      required: true;
+      nullable: false;
+      choices: AVSettings.AV_MODES[];
+      initial: typeof AVSettings.AV_MODES.DISABLED;
+    }>;
+    turn: fields.SchemaField<{
+      type: fields.StringField<{ required: true; choices: ["server", "custom"]; initial: "server" }>;
+      url: fields.StringField<{ required: true }>;
+      username: fields.StringField<{ required: true }>;
+      password: fields.StringField<{ required: true }>;
+    }>;
+  }
+
+  interface ClientSchema extends DataSchema {
+    videoSrc: fields.StringField<{ required: true; initial: "default" }>;
+    audioSrc: fields.StringField<{ required: true; initial: "default" }>;
+    audioSink: fields.StringField<{ required: true; initial: "default" }>;
+    dockPosition: fields.StringField<{
+      required: true;
+      // choices: Object.values(AVSettings.DOCK_POSITIONS>,
+      initial: typeof AVSettings.DOCK_POSITIONS.LEFT;
+    }>;
+    hidePlayerList: fields.BooleanField;
+    hideDock: fields.BooleanField;
+    muteAll: fields.BooleanField;
+    disableVideo: fields.BooleanField;
+    borderColors: fields.BooleanField;
+    dockWidth: fields.NumberField<{
+      required: true;
+      nullable: false;
+      integer: true;
+      positive: true;
+      initial: 240;
+    }>;
+    nameplates: fields.NumberField<{
+      required: true;
+      nullable: false;
+      choices: AVSettings.NAMEPLATE_MODES[];
+      initial: typeof AVSettings.NAMEPLATE_MODES.BOTH;
+    }>;
+    voice: fields.SchemaField<{
+      mode: fields.StringField<{
+        required: true;
+        choices: AVSettings.VOICE_MODES[];
+        initial: typeof AVSettings.VOICE_MODES.PTT;
+      }>;
+      pttName: fields.StringField<{ required: true; initial: "`" }>;
+      pttDelay: fields.NumberField<{ required: true; nullable: false; integer: true; min: 0; initial: 100 }>;
+      activityThreshold: fields.NumberField<{ required: true; nullable: false; integer: true; initial: -45 }>;
+    }>;
+    users: fields.TypedObjectField<
+      fields.SchemaField<{
+        popout: fields.BooleanField;
+        left: fields.NumberField<{ required: true; nullable: false; integer: true; initial: 100 }>;
+        top: fields.NumberField<{ required: true; nullable: false; integer: true; initial: 100 }>;
+        z: fields.NumberField<{ required: true; nullable: false; integer: true; initial: 0 }>;
+        width: fields.NumberField<{ required: true; nullable: false; integer: true; positive: true; initial: 320 }>;
+        volume: fields.NumberField<{ required: true; nullable: false; min: 0; max: 1; initial: 1 }>;
+        muted: fields.BooleanField;
+        hidden: fields.BooleanField;
+        blocked: fields.BooleanField;
+      }>,
+      { validateKey: typeof foundry.data.validators.isValidId }
+    >;
+  }
+
+  interface SchemaFields {
+    world: fields.SchemaField<WorldSchema>;
+    client: fields.SchemaField<ClientSchema>;
+  }
+
+  type AV_MODES = ValueOf<typeof AVSettings.AV_MODES>;
+
+  interface Data {
+    /**
+     * Whether this user has muted themselves.
+     * @remarks non-nullish due to use of `in`
+     */
+    muted?: boolean;
+
+    /**
+     * Whether this user has hidden their video.
+     * @remarks non-nullish due to use of `in`
+     */
+    hidden?: boolean;
+
+    /**
+     * Whether the user is broadcasting audio.
+     * @remarks non-nullish due to use of `in`
+     */
+    speaking?: boolean;
   }
 }
+
+export default AVSettings;

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

@@ -0,0 +1,23 @@
+// 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-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export { default as Canvas } from "./board.mjs";
+export { default as SceneManager } from "./scene-manager.mjs";
+export { default as TextureLoader, getTexture, loadTexture, srcExists } from "./loader.mjs";
+export { default as TextureExtractor } from "./texture-extractor.mjs";
+export { default as FramebufferSnapshot } from "./framebuffer-snapshot.mjs";
+export * as extensions from "./extensions/_module.mjs";
+export * as sources from "./sources/_module.mjs";
+export * as workers from "./workers/_module.mjs";
+export * as containers from "./containers/_module.mjs";
+export * as groups from "./groups/_module.mjs";
+export * as layers from "./layers/_module.mjs";
+export * as placeables from "./placeables/_module.mjs";
+export * as primary from "./primary/_module.mjs";
+export * as geometry from "./geometry/_module.mjs";
+export * as interaction from "./interaction/_module.mjs";
+export * as animation from "./animation/_module.mjs";
+export * as rendering from "./rendering/_module.mjs";
+export * as perception from "./perception/_module.mjs";

package/src/foundry/client/canvas/animation/_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-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export { default as CanvasAnimation } from "./canvas-animation.mjs";
+export { default as ChatBubbles } from "./chat-bubbles.mjs";
+export { default as SmoothNoise } from "./smooth-noise.mjs";

package/src/foundry/client/canvas/animation/_types.d.mts

@@ -0,0 +1,20 @@
+import type { CanvasAnimation } from "./_module.mjs";
+
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+// After seeing that none of these types add anything or are even exported a
+// very reasonable question may be: Why on earth does this file exist?
+//
+// Well this is the file in which Foundry defines these types. We don't house
+// them here because it has poor discoverability. It's also just nice to
+// have as reference to keep us synced with the latest version of Foundry.
+
+export {};
+
+type CanvasAnimationAttribute = CanvasAnimation.Attribute;
+
+type CanvasAnimationEasingFunction = CanvasAnimation.EasingFunction;
+
+type CanvasAnimationOptions = CanvasAnimation.AnimateOptions;
+
+type CanvasAnimationData = CanvasAnimation.AnimationData;