@league-of-foundry-developers/foundry-vtt-types 9.249.4 → 9.255.2

package/README.md

@@ -17,7 +17,7 @@ TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.co
 
 We aim to support the latest release of each Foundry VTT version (0.7, 0.8, 9, etc.), starting with 0.7.
 
-At the moment, both version 0.7 and 0.8 are fully supported. Version 9 is already partially supported, but there is still a lot to be done. See https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V9%22 to keep track of the progress.
+At the moment, both version 0.7 and 0.8 are fully supported. Version 9 is already partially supported, but there is still a lot to be done. See the [open foundry V9 issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V9%22) to keep track of the progress.
 
 
 ## Installation

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.249.4",
+  "version": "9.255.2",
   "description": "TypeScript type definitions for Foundry VTT",
   "exports": {
     ".": {
@@ -74,7 +74,7 @@
     "lint-staged": "^12.1.2",
     "prettier": "^2.5.1",
     "tsd": "^0.19.1",
-    "typescript": "~4.5.3"
+    "typescript": "~4.6.2"
   },
   "husky": {
     "hooks": {

package/src/foundry/common/constants.mjs.d.ts

@@ -817,6 +817,7 @@ export const TEXT_FILE_EXTENSIONS: Readonly<{
   md: 'text/markdown';
   pdf: 'application/pdf';
   txt: 'text/plain';
+  xml: 'application/xml';
 }>;
 export type TEXT_FILE_EXTENSIONS = ValueOf<typeof TEXT_FILE_EXTENSIONS>;
 

package/src/foundry/common/documents.mjs/baseMacro.d.ts

@@ -16,9 +16,6 @@ type MacroMetadata = Merge<
     types: [typeof CONST.MACRO_TYPES.SCRIPT, typeof CONST.MACRO_TYPES.CHAT];
     permissions: {
       create: 'PLAYER';
-      // TODO: fix when fixed by foundry (https://gitlab.com/foundrynet/foundryvtt/-/issues/6694)
-      // update: undefined;
-      // delete: undefined;
     };
   }
 >;

package/src/foundry/common/documents.mjs/baseMeasuredTemplate.d.ts

@@ -15,7 +15,7 @@ type MeasuredTemplateMetadata = Merge<
     labelPlural: 'DOCUMENT.MeasuredTemplates';
     isEmbedded: true;
     permissions: {
-      create: 'TEMPLATE_CREATE';
+      create: (user: BaseUser, doc: BaseMeasuredTemplate) => boolean;
       update: (
         user: BaseUser,
         doc: BaseMeasuredTemplate,
@@ -51,6 +51,13 @@ export declare class BaseMeasuredTemplate extends Document<
     { exact }?: { exact?: boolean }
   ): boolean;
 
+  /**
+   * Is a user able to create a new MeasuredTemplate?
+   * @param user - The user attempting the creation operation.
+   * @param doc  - The MeasuredTemplate being created.
+   */
+  protected static _canCreate(user: BaseUser, doc: BaseMeasuredTemplate): boolean;
+
   /**
    * Is a user able to modify an existing MeasuredTemplate?
    */

package/src/foundry/common/packages.mjs/packageCompendiumData.d.ts

@@ -3,7 +3,13 @@ import { DocumentData } from '../abstract/module.mjs';
 import * as fields from '../data/fields.mjs';
 
 interface PackageCompendiumDataSchema extends DocumentSchema {
-  name: fields.RequiredString;
+  name: FieldReturnType<
+    fields.RequiredString,
+    {
+      validate: (v: string) => boolean;
+      validationError: "Invalid compendium name '{value}'. Compendium names cannot contain dots.";
+    }
+  >;
   label: fields.RequiredString;
   path: fields.RequiredString;
   private: FieldReturnType<fields.BooleanField, { default: false }>;

package/src/foundry/common/types.mjs.d.ts

@@ -1,17 +1,17 @@
 /**
  * A single point, expressed as an object \{x, y\}
  */
-declare type Point = PIXI.Point | { x: number; y: number };
+type Point = PIXI.Point | { x: number; y: number };
 
 /**
  * A single point, expressed as an array \[x,y\]
  */
-declare type PointArray = [x: number, y: number];
+type PointArray = [x: number, y: number];
 
 /**
  * A standard rectangle interface.
  */
-declare type Rectangle =
+type Rectangle =
   | PIXI.Rectangle
   | {
       x: number;
@@ -20,8 +20,92 @@ declare type Rectangle =
       height: number;
     };
 
+/** A Client Setting */
+interface SettingConfig<T = unknown> {
+  /** A unique machine-readable id for the setting */
+  key: string;
+
+  /** The namespace the setting belongs to */
+  namespace: string;
+
+  /** The human readable name */
+  name?: string | undefined;
+
+  /** An additional human readable hint */
+  hint?: string | undefined;
+
+  /**
+   * The scope the Setting is stored in, either World or Client
+   * @defaultValue `'client'`
+   */
+  scope: 'world' | 'client';
+
+  /** Indicates if this Setting should render in the Config application */
+  config?: boolean | undefined;
+
+  /** The JS Type that the Setting is storing */
+  type?: T extends string
+    ? typeof String
+    : T extends number
+    ? typeof Number
+    : T extends boolean
+    ? typeof Boolean
+    : T extends Array<any>
+    ? typeof Array
+    : ConstructorOf<T>;
+
+  /** For string Types, defines the allowable values */
+  choices?: (T extends string ? Record<string, string> : never) | undefined;
+
+  /** For numeric Types, defines the allowable range */
+  range?:
+    | (T extends number
+        ? {
+            max: number;
+            min: number;
+            step: number;
+          }
+        : never)
+    | undefined;
+
+  /** The default value */
+  default?: T;
+
+  /** Executes when the value of this Setting changes */
+  onChange?: (value: T) => void;
+
+  filePicker?: (T extends string ? true | 'audio' | 'image' | 'video' | 'imagevideo' | 'folder' : never) | undefined;
+}
+
+interface SettingSubmenuConfig {
+  key: string;
+
+  namespace: string;
+
+  /** The human readable name */
+  name?: string | undefined;
+
+  /** The human readable label */
+  label?: string | undefined;
+
+  /** An additional human readable hint */
+  hint?: string | undefined;
+
+  /** The classname of an Icon to render */
+  icon?: string | undefined;
+
+  /** The FormApplication to render */
+  // TODO: Find a better way to type this. Ideally, we would find a way to conditionally make the first parameter of FormApplication optional...
+  type:
+    | (new () => FormApplication<any, any, any>)
+    | ConstructorOf<FormApplication<FormApplicationOptions, object, undefined>>;
+
+  /** If true, only a GM can edit this Setting */
+  restricted?: boolean | undefined;
+}
+
 /** A Client Keybinding Action Configuration */
-declare interface KeybindingActionConfig {
+interface KeybindingActionConfig {
   /** The namespace within which the action was registered */
   namespace?: string;
 
@@ -38,10 +122,10 @@ declare interface KeybindingActionConfig {
   editable?: KeybindingActionBinding[];
 
   /** A function to execute when a key down event occurs. If True is returned, the event is consumed and no further keybinds execute. */
-  onDown?: () => boolean | void;
+  onDown?: (ctx: KeyboardEventContext) => boolean | void;
 
   /** A function to execute when a key up event occurs. If True is returned, the event is consumed and no further keybinds execute. */
-  onUp?: () => boolean | void;
+  onUp?: (ctx: KeyboardEventContext) => boolean | void;
 
   /** If True, allows Repeat events to execute the Action's onDown. Defaults to false. */
   repeat?: boolean;
@@ -60,7 +144,7 @@ declare interface KeybindingActionConfig {
 }
 
 /** A Client Keybinding Action Binding */
-declare interface KeybindingActionBinding {
+interface KeybindingActionBinding {
   /** The KeyboardEvent#code value from https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values */
   key: string;
 
@@ -68,22 +152,44 @@ declare interface KeybindingActionBinding {
   modifiers?: string[];
 }
 
-declare interface KeybindingAction {
+/** An action that can occur when a key is pressed */
+interface KeybindingAction {
+  /** The namespaced machine identifier of the Action */
   action: string;
+
+  /** The Keyboard key */
   key: string;
+
+  /** The human readable name */
   name: string;
+
+  /** Required modifiers */
   requiredModifiers: string[];
+
+  /** Optional (reserved) modifiers */
   optionalModifiers: string[];
+
+  /** The handler that executes onDown */
   onDown: Function;
+
+  /** The handler that executes onUp */
   onUp: Function;
+
+  /** If True, allows Repeat events to execute this Action's onDown */
   repeat: boolean;
+
+  /** If true, only a GM can execute this Action */
   restricted: boolean;
+
+  /** The registration precedence */
   precedence: number;
+
+  /** The registration order */
   order: number;
 }
 
 /** Keyboard event context */
-declare interface KeyboardEventContext {
+interface KeyboardEventContext {
   /** The normalized string key, such as "A" */
   key: string;
 
@@ -115,6 +221,15 @@ declare interface KeyboardEventContext {
   action: string | undefined;
 }
 
+/** Connected Gamepad info */
+interface ConnectedGamepad {
+  /** A map of axes values */
+  axes: Map<string, number>;
+
+  /** The Set of pressed Buttons */
+  activeButtons: Set<string>;
+}
+
 type RequestData = object | object[] | string | string[];
 
 interface SocketRequest {
@@ -183,5 +298,5 @@ interface SocketResponse {
   /**
    * An Array of created data objects
    */
-  result?: object[];
+  result?: object[] | string[];
 }

package/src/foundry/common/utils/helpers.mjs.d.ts

@@ -441,7 +441,6 @@ export declare function setProperty(object: object, key: string, value: any): bo
 
 /**
  * Express a timestamp as a relative string
- * TODO - figure out a way to localize this
  * @param timeStamp - A timestamp string or Date object to be formatted as a relative time
  * @returns A string expression for the relative time
  */

package/src/foundry/common/utils/http.mjs.d.ts

@@ -0,0 +1,52 @@
+/**
+ * A wrapper method around `fetch` that attaches an AbortController signal to the `fetch` call for clean timeouts
+ * @see https://www.npmjs.com/package/node-fetch#request-cancellation-with-abortsignal
+ * @param url            - The URL to make the Request to
+ * @param data           - The data of the Request
+ *                         (defalt: `{}`)
+ * @param timeoutOptions - (default: `{}`)
+ * @throws {@link HttpError}
+ */
+export function fetchWithTimeout(
+  url: string,
+  data?: RequestInit | undefined,
+  { timeoutMs, onTimeout }?: TimeoutOptions | undefined
+): Promise<Response>;
+
+/**
+ * A small wrapper that automatically asks for JSON
+ * @param url            - The URL to make the Request to
+ * @param data           - The data of the Request
+ *                         (defalt: `{}`)
+ * @param timeoutOptions - (default: `{}`)
+ */
+export function fetchJsonWithTimeout(
+  url: string,
+  data?: RequestInit | undefined,
+  { timeoutMs, onTimeout }?: TimeoutOptions | undefined
+): Promise<unknown>;
+
+/**
+ * Represents an HTTP Error when a non-OK response is returned by Fetch
+ */
+export class HttpError extends Error {
+  constructor(statusText: string, code: number, displayMessage?: string | undefined);
+
+  code: number;
+
+  displayMessage: string;
+}
+
+interface TimeoutOptions {
+  /**
+   * How long to wait for a Response before cleanly aborting
+   * @defaultValue `30000`
+   */
+  timeoutMs?: number | undefined;
+
+  /**
+   * A method to invoke if and when the timeout is reached
+   * @defaultValue `() => {}`
+   */
+  onTimeout?: (() => void) | undefined;
+}

package/src/foundry/common/utils/module.mjs.d.ts

@@ -1,4 +1,5 @@
 export * from './geometry.mjs';
 export * from './helpers.mjs';
+export * from './http.mjs';
 export { default as Collection } from './collection.mjs';
 export { default as Semaphore } from './semaphore.mjs';

package/src/foundry/common/utils/primitives.mjs.d.ts

@@ -201,10 +201,10 @@ interface NumberConstructor {
 
   /**
    * Attempt to create a number from a user-provided string.
-   * @param str - The string.
+   * @param n - The value to convert; typically a string, but may already be a number.
    * @returns The number that the string represents, or NaN if no number could be determined.
    */
-  fromString(str: string): number;
+  fromString(str: string | number): number;
 }
 
 interface ArrayConstructor {

package/src/foundry/common/utils/semaphore.mjs.d.ts

@@ -35,6 +35,7 @@ declare class Semaphore {
   /**
    * A queue of pending function signatures
    * @defaultValue `[]`
+   * @internal
    * @remarks The first element of an element of `_queue` is always a function and the rest of the elements are
    * parameters to be passed to that function.
    */
@@ -43,6 +44,7 @@ declare class Semaphore {
   /**
    * The number of tasks which are currently underway
    * @defaultValue `0`
+   * @internal
    */
   protected _active: number;
 
@@ -60,8 +62,9 @@ declare class Semaphore {
    * Add a new tasks to the managed queue
    * @param fn   - A callable function
    * @param args - Function arguments
+   * @returns A promise that resolves once the added function is executed
    */
-  add<F extends (...args: any[]) => any>(fn: F, ...args: Parameters<F>): void;
+  add<F extends (...args: any[]) => any>(fn: F, ...args: Parameters<F>): Promise<Awaited<ReturnType<F>>>;
 
   /**
    * Abandon any tasks which have not yet concluded
@@ -72,9 +75,9 @@ declare class Semaphore {
    * Attempt to perform a task from the queue.
    * If all workers are busy, do nothing.
    * If successful, try again.
-   * @returns Was a function called?
+   * @internal
    */
-  protected _try(): Promise<boolean>;
+  protected _try(): Promise<false | void>;
 }
 
 export default Semaphore;

package/src/foundry/foundry.js/applications/dialog.d.ts

@@ -1,3 +1,13 @@
+interface DialogOptions extends ApplicationOptions {
+  /**
+   * Whether to provide jQuery objects to callback functions (if true) or plain
+   * HTMLElement instances (if false). This is currently true by default but in the
+   * future will become false by default.
+   * @defaultValue `true`
+   */
+  jQuery: boolean;
+}
+
 /**
  * Create a modal dialog window displaying a title, a message, and a set of buttons which trigger callback functions.
  *
@@ -26,7 +36,7 @@
  * ```
  * @typeParam Options - the type of the options object
  */
-declare class Dialog<Options extends Dialog.Options = Dialog.Options> extends Application<Options> {
+declare class Dialog<Options extends DialogOptions = DialogOptions> extends Application<Options> {
   /**
    * @param data    - An object of dialog data which configures how the modal window is rendered
    * @param options - Dialog rendering options, see {@link Application}
@@ -47,7 +57,7 @@ declare class Dialog<Options extends Dialog.Options = Dialog.Options> extends Ap
    * })
    * ```
    */
-  static get defaultOptions(): Dialog.Options;
+  static get defaultOptions(): DialogOptions;
 
   /**
    * @override
@@ -192,31 +202,6 @@ declare namespace Dialog {
      */
     default: string;
   }
-
-  interface Options extends ApplicationOptions {
-    /**
-     * @defaultValue `400`
-     */
-    width: number;
-
-    /**
-     * @defaultValue `['dialog']`
-     */
-    classes: string[];
-
-    /**
-     * @defaultValue `'templates/hud/dialog.html'`
-     */
-    template: string;
-
-    /**
-     * Whether to provide jQuery objects to callback functions (if true) or plain
-     * HTMLElement instances (if false). This is currently true by default but in the
-     * future will become false by default.
-     * @defaultValue `true`
-     */
-    jQuery: boolean;
-  }
 }
 
 /**
@@ -266,7 +251,7 @@ interface ConfirmConfig<Yes, No, JQueryOrHtml> {
    * Additional rendering options passed to the Dialog
    * @defaultValue `{}`
    */
-  options?: Partial<Dialog.Options>;
+  options?: Partial<DialogOptions>;
 }
 
 /**
@@ -310,5 +295,5 @@ interface PromptConfig<Value, JQueryOrHtml> {
    * Additional rendering options
    * @defaultValue `{}`
    */
-  options?: Partial<Dialog.Options>;
+  options?: Partial<DialogOptions>;
 }

package/src/foundry/foundry.js/applications/formApplications/avConfig.d.ts

@@ -1,12 +1,24 @@
 /**
  * Audio/Video Conferencing Configuration Sheet
+ *
+ * @typeParam Options - The type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data, AVMaster> {
+declare class AVConfig<
+  Options extends FormApplicationOptions = FormApplicationOptions,
+  Data extends object = AVConfig.Data
+> extends FormApplication<Options, Data, AVMaster> {
+  /**
+   * @param object  - The {@link AVMaster} instance being configured.
+   * @param options - Application configuration options.
+   */
+  constructor(object?: AVMaster | undefined, options?: Partial<Options> | undefined);
+
   /** @override */
-  static get defaultOptions(): AVConfig.Options;
+  static get defaultOptions(): FormApplicationOptions;
 
   /** @override */
-  getData(options: Partial<AVConfig.Options>): Promise<AVConfig.Data>;
+  getData(options: Partial<Options>): Promise<Data>;
 
   /** @override */
   activateListeners(html: JQuery): void;
@@ -16,6 +28,7 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
    * @param selector - Selector for the section to enable or disable
    * @param enabled  - Whether to enable or disable this section
    *                   (default: true)
+   * @internal
    */
   protected _setConfigSectionEnabled(selector: string, enabled?: boolean): void;
 
@@ -24,75 +37,23 @@ declare class AVConfig extends FormApplication<AVConfig.Options, AVConfig.Data,
    * unavailable since the last time it was set.
    * @param sources - The available devices
    * @param source  - The selected device
+   * @internal
    */
   protected _isSourceUnavailable(sources: Record<string, string>, source: string): boolean;
 
-  /**
-   * Callback when the server type changes
-   * Will enable or disable the server section based on whether the user selected a custom server or not
-   * @param event - The event that triggered the server type change
-   */
-  protected _onServerTypeChanged(event: JQuery.ChangeEvent): void;
-
   /**
    * Callback when the turn server type changes
    * Will enable or disable the turn section based on whether the user selected a custom turn or not
    * @param event - The event that triggered the turn server type change
+   * @internal
    */
   protected _onTurnTypeChanged(event: JQuery.ChangeEvent): void;
 
-  /**
-   * Handle the assignment of a push-to-talk/push-to-mute key
-   */
-  protected _onPTTKeyDown(event: JQuery.KeyDownEvent): void;
-
-  /**
-   * Handle the assignment of a push-to-talk/push-to-mute mouse key
-   */
-  protected _onPTTMouseDown(event: JQuery.MouseDownEvent): void;
-
   /** @override */
   protected _updateObject(event: Event, formData?: object): Promise<void>;
 }
 
 declare namespace AVConfig {
-  interface Options extends FormApplicationOptions {
-    /**
-     * @defaultValue `game.i18n.localize('WEBRTC.Title')`
-     */
-    title: string;
-
-    /**
-     * @defaultValue `'av-config'`
-     */
-    id: string;
-
-    /**
-     * @defaultValue `'templates/sidebar/apps/av-config.html'`
-     */
-    template: string;
-
-    /**
-     * @defaultValue `true`
-     */
-    popOut: boolean;
-
-    /**
-     * @defaultValue `480`
-     */
-    width: number;
-
-    /**
-     * @defaultValue `'auto'`
-     */
-    height: number | 'auto';
-
-    /**
-     * @defaultValue `[{navSelector: '.tabs', contentSelector: 'form', initial: 'general'}]`
-     */
-    tabs: (TabsConfiguration & { contentSelector: string; initial: string })[];
-  }
-
   interface Data {
     user: Game['user'];
     modes: {

package/src/foundry/foundry.js/applications/formApplications/documentSheets/actorSheet.d.ts

@@ -41,7 +41,7 @@ declare global {
     get title(): string;
 
     /**
-     * A convenience reference to the Actor entity
+     * A convenience reference to the Actor document
      */
     get actor(): this['object'];
 
@@ -72,11 +72,6 @@ declare global {
      */
     protected _onConfigureToken(event: JQuery.ClickEvent): void;
 
-    /**
-     * Handle requests to configure the default sheet used by this Actor
-     */
-    protected _onConfigureSheet(event: JQuery.ClickEvent): void;
-
     /**
      * Handle changing the actor profile image by opening a FilePicker
      */
@@ -156,6 +151,13 @@ declare global {
       event: DragEvent,
       itemData: foundry.data.ItemData['_source']
     ): undefined | Promise<InstanceType<ConfiguredDocumentClass<typeof Item>>[]>;
+
+    /**
+     * Is the drop data coming from the same actor?
+     * @param data - The drop data.
+     * @internal
+     */
+    protected _isFromSameActor(data: ActorSheet.DropData.Item): Promise<boolean>;
   }
 
   namespace ActorSheet {

package/src/foundry/foundry.js/applications/formApplications/settingsConfig.d.ts

@@ -66,20 +66,20 @@ declare global {
       interface Data {
         core: {
           version: string;
-          menus: ClientSettings.CompleteMenuSetting[];
+          menus: SettingSubmenuConfig[];
           settings: Setting[];
           none: boolean;
         };
         system: {
           title: Game['system']['data']['title'];
-          menus: ClientSettings.CompleteMenuSetting[];
+          menus: SettingSubmenuConfig[];
           settings: Setting[];
           none: boolean;
         };
-        modules: { title: string; menus: ClientSettings.CompleteMenuSetting[]; settings: Setting[] }[];
+        modules: { title: string; menus: SettingSubmenuConfig[]; settings: Setting[] }[];
       }
 
-      interface Setting extends Omit<ClientSettings.CompleteSetting, 'type'> {
+      interface Setting extends Omit<SettingConfig, 'type'> {
         id: string;
         name: string;
         hint: string;