@league-of-foundry-developers/foundry-vtt-types 9.238.1 → 9.249.1

package/src/foundry/foundry.js/clientDocuments/scene.d.ts

@@ -1,23 +1,24 @@
-import { ConfiguredDocumentClass, PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import {
+import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
+import type { DocumentModificationOptions } from '../../common/abstract/document.mjs';
+import type {
   AmbientLightDataConstructorData,
-  AmbientLightDataProperties
+  AmbientLightDataSource
 } from '../../common/data/data.mjs/ambientLightData';
-import {
+import type {
   AmbientSoundDataConstructorData,
-  AmbientSoundDataProperties
+  AmbientSoundDataSource
 } from '../../common/data/data.mjs/ambientSoundData';
-import { DrawingDataConstructorData, DrawingDataProperties } from '../../common/data/data.mjs/drawingData';
-import {
+import type { DrawingDataConstructorData, DrawingDataSource } from '../../common/data/data.mjs/drawingData';
+import type {
   MeasuredTemplateDataConstructorData,
-  MeasuredTemplateDataProperties
+  MeasuredTemplateDataSource
 } from '../../common/data/data.mjs/measuredTemplateData';
-import { NoteDataConstructorData, NoteDataProperties } from '../../common/data/data.mjs/noteData';
-import type { SceneDataConstructorData } from '../../common/data/data.mjs/sceneData.js';
-import { TileDataConstructorData, TileDataProperties } from '../../common/data/data.mjs/tileData';
-import { TokenDataConstructorData, TokenDataProperties } from '../../common/data/data.mjs/tokenData';
-import { WallDataConstructorData, WallDataProperties } from '../../common/data/data.mjs/wallData';
+import type { NoteDataConstructorData, NoteDataSource } from '../../common/data/data.mjs/noteData';
+import type { TileDataConstructorData, TileDataSource } from '../../common/data/data.mjs/tileData';
+import type { TokenDataConstructorData, TokenDataSource } from '../../common/data/data.mjs/tokenData';
+import type { WallDataConstructorData, WallDataSource } from '../../common/data/data.mjs/wallData';
+
+import type { SceneDataConstructorData } from '../../common/data/data.mjs/sceneData';
 
 declare global {
   /**
@@ -205,56 +206,56 @@ declare global {
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>[],
-      result: DeepPartial<PropertiesToSource<DrawingDataProperties>>[],
+      result: DeepPartial<DrawingDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof TokenDocument>>[],
-      result: DeepPartial<PropertiesToSource<TokenDataProperties>>[],
+      result: DeepPartial<TokenDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof AmbientLightDocument>>[],
-      result: DeepPartial<PropertiesToSource<AmbientLightDataProperties>>[],
+      result: DeepPartial<AmbientLightDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof NoteDocument>>[],
-      result: DeepPartial<PropertiesToSource<NoteDataProperties>>[],
+      result: DeepPartial<NoteDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof AmbientSoundDocument>>[],
-      result: DeepPartial<PropertiesToSource<AmbientSoundDataProperties>>[],
+      result: DeepPartial<AmbientSoundDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>[],
-      result: DeepPartial<PropertiesToSource<MeasuredTemplateDataProperties>>[],
+      result: DeepPartial<MeasuredTemplateDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof TileDocument>>[],
-      result: DeepPartial<PropertiesToSource<TileDataProperties>>[],
+      result: DeepPartial<TileDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onCreateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof WallDocument>>[],
-      result: DeepPartial<PropertiesToSource<WallDataProperties>>[],
+      result: DeepPartial<WallDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
@@ -262,49 +263,49 @@ declare global {
     /** @override */
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<DrawingDataProperties>>[],
+      result: DeepPartial<DrawingDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<TokenDataProperties>>[],
+      result: DeepPartial<TokenDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<AmbientLightDataProperties>>[],
+      result: DeepPartial<AmbientLightDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<NoteDataProperties>>[],
+      result: DeepPartial<NoteDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<AmbientSoundDataProperties>>[],
+      result: DeepPartial<AmbientSoundDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<MeasuredTemplateDataProperties>>[],
+      result: DeepPartial<MeasuredTemplateDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<TileDataProperties>>[],
+      result: DeepPartial<TileDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _preUpdateEmbeddedDocuments(
       embeddedName: string,
-      result: DeepPartial<PropertiesToSource<WallDataProperties>>[],
+      result: DeepPartial<WallDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
@@ -313,56 +314,56 @@ declare global {
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof DrawingDocument>>[],
-      result: DeepPartial<PropertiesToSource<DrawingDataProperties>>[],
+      result: DeepPartial<DrawingDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof TokenDocument>>[],
-      result: DeepPartial<PropertiesToSource<TokenDataProperties>>[],
+      result: DeepPartial<TokenDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof AmbientLightDocument>>[],
-      result: DeepPartial<PropertiesToSource<AmbientLightDataProperties>>[],
+      result: DeepPartial<AmbientLightDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof NoteDocument>>[],
-      result: DeepPartial<PropertiesToSource<NoteDataProperties>>[],
+      result: DeepPartial<NoteDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof AmbientSoundDocument>>[],
-      result: DeepPartial<PropertiesToSource<AmbientSoundDataProperties>>[],
+      result: DeepPartial<AmbientSoundDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof MeasuredTemplateDocument>>[],
-      result: DeepPartial<PropertiesToSource<MeasuredTemplateDataProperties>>[],
+      result: DeepPartial<MeasuredTemplateDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof TileDocument>>[],
-      result: DeepPartial<PropertiesToSource<TileDataProperties>>[],
+      result: DeepPartial<TileDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;
     _onUpdateEmbeddedDocuments(
       embeddedName: string,
       documents: InstanceType<ConfiguredDocumentClass<typeof WallDocument>>[],
-      result: DeepPartial<PropertiesToSource<WallDataProperties>>[],
+      result: DeepPartial<WallDataSource>[],
       options: DocumentModificationContext,
       userId: string
     ): void;

package/src/foundry/foundry.js/clientDocuments/user.d.ts

@@ -2,6 +2,32 @@ import { ConfiguredDocumentClass } from '../../../types/helperTypes';
 import { DocumentDataType, DocumentModificationOptions } from '../../common/abstract/document.mjs';
 
 declare global {
+  interface ActivityData {
+    /** The ID of the scene that the user is viewing. */
+    sceneId?: string | null | undefined;
+
+    /** The position of the user's cursor. */
+    cursor?: { x: number; y: number } | null | undefined;
+
+    /** The state of the user's ruler, if they are currently using one. */
+    ruler?: RulerData | null | undefined;
+
+    /** The IDs of the tokens the user has targeted in the currently viewed */
+    targets?: string[] | undefined;
+
+    /** Whether the user has an open WS connection to the server or not. */
+    active?: boolean | undefined;
+
+    /** Is the user pulling focus to the cursor coordinates? */
+    focus?: boolean | undefined;
+
+    /** Is the user emitting a ping at the cursor coordinates? */
+    ping?: boolean | undefined;
+
+    /** The state of the user's AV settings. */
+    av?: AVSettingsData | undefined;
+  }
+
   /**
    * The client-side User document which extends the common BaseUser model.
    * Each User document contains UserData which defines its data schema.
@@ -91,7 +117,7 @@ declare global {
      * @param activityData - An object of User activity data to submit to the server for broadcast.
      *                       (default: `{}`)
      */
-    broadcastActivity(activityData?: User.ActivityData): void;
+    broadcastActivity(activityData?: ActivityData): void;
 
     /**
      * Get an Array of Macro Entities on this User's Hotbar by page
@@ -138,38 +164,4 @@ declare global {
     /** @remarks This property is set by PlayerList.getData() */
     border?: string;
   }
-
-  namespace User {
-    interface ActivityData {
-      /**
-       * The coordinates of the user's cursor
-       */
-      cursor?: boolean;
-
-      /**
-       * Is the user pulling focus to the cursor coordinates?
-       */
-      focus?: boolean;
-
-      /**
-       * Is the user emitting a ping at the cursor coordinates?
-       */
-      ping?: boolean;
-
-      /**
-       * Serialized Ruler coordinate data in JSON format
-       */
-      ruler?: string;
-
-      /**
-       * The id of the Scene currently being viewed by the User
-       */
-      sceneId?: string;
-
-      /**
-       * An array of Token ids which are targeted by the User
-       */
-      targets?: string[];
-    }
-  }
 }

package/src/foundry/foundry.js/clientKeybindings.d.ts

@@ -240,11 +240,21 @@ declare class ClientKeybindings {
   protected _onPan(context: KeyboardEventContext, movementDirections: ClientKeybindings.MovementDirection[]): boolean;
 
   /**
-   * Handle number key presses
+   * Handle Macro executions
    * @param context - The context data of the event
    * @internal
    */
-  protected static _onMacro(context: KeyboardEventContext): true;
+  protected static _onMacroExecute(
+    context: KeyboardEventContext,
+    number: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 0
+  ): boolean;
+
+  /**
+   * Handle Macro page swaps
+   * @param context - The context data of the event
+   * @internal
+   */
+  protected static _onMacroPageSwap(context: KeyboardEventContext, page: number): true;
 
   /**
    * Handle action to copy data to clipboard

package/src/foundry/foundry.js/clientSettings.d.ts

@@ -211,7 +211,7 @@ declare namespace ClientSettings {
     label?: string;
     name?: string;
     restricted: boolean;
-    type: ConstructorOf<FormApplication<FormApplication.Options, object>>;
+    type: ConstructorOf<FormApplication<FormApplicationOptions, object>>;
   }
 
   interface RegisteredMenuSettings {
@@ -239,7 +239,7 @@ declare namespace ClientSettings {
     'core.nue.shownTips': boolean;
     'core.noCanvas': boolean;
     'core.permissions': Game.Permissions;
-    'core.rollMode': foundry.CONST.DICE_ROLL_MODES;
+    'core.rollMode': keyof CONFIG.Dice.RollModes;
     'core.softShadows': boolean;
     'core.time': number;
     'core.tokenDragPreview': boolean;

package/src/foundry/foundry.js/collections/documentCollection.d.ts

@@ -39,7 +39,7 @@ declare global {
     /**
      * Render any Applications associated with this DocumentCollection.
      */
-    render(force?: boolean, options?: Application.Options): void;
+    render(force?: boolean, options?: ApplicationOptions): void;
 
     /**
      * Update all objects in this DocumentCollection with a provided transformation.
@@ -47,7 +47,7 @@ declare global {
      * @param transformation - An object of data or function to apply to all matched objects
      * @param condition      - A function which tests whether to target each object
      *                         (default: `null`)
-     * @param options        - Additional options passed to Entity.update
+     * @param options        - Additional options passed to Document.update
      *                         (default: `{}`)
      * @returns An array of updated data once the operation is complete
      */
@@ -67,8 +67,8 @@ declare global {
      * @param options - Options which modified the creation operation
      * @param userId  - The ID of the User who triggered the operation
      */
-    _preCreateDocuments(
-      result: InstanceType<ConfiguredDocumentClass<T>>['data']['_source'][],
+    protected _preCreateDocuments(
+      result: (InstanceType<T>['data']['_source'] & { _id: string })[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
@@ -80,9 +80,9 @@ declare global {
      * @param options   - Options which modified the creation operation
      * @param userId    - The ID of the User who triggered the operation
      */
-    _onCreateDocuments(
+    protected _onCreateDocuments(
       documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      result: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>['data']['_source'][],
+      result: (InstanceType<T>['data']['_source'] & { _id: string })[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
@@ -93,8 +93,8 @@ declare global {
      * @param options - Options which modified the update operation
      * @param userId  - The ID of the User who triggered the operation
      */
-    _preUpdateDocuments(
-      result: DeepPartial<StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>>[],
+    protected _preUpdateDocuments(
+      result: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
@@ -106,9 +106,9 @@ declare global {
      * @param options   - Options which modified the update operation
      * @param userId    - The ID of the User who triggered the operation
      */
-    _onUpdateDocuments(
+    protected _onUpdateDocuments(
       documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      result: DeepPartial<StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>>[],
+      result: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
@@ -119,7 +119,7 @@ declare global {
      * @param options - Options which modified the deletion operation
      * @param userId  - The ID of the User who triggered the operation
      */
-    _preDeleteDocuments(result: string[], options: DocumentModificationOptions, userId: string): void;
+    protected _preDeleteDocuments(result: string[], options: DocumentModificationOptions, userId: string): void;
 
     /**
      * Follow-up actions taken after a set of Documents in this Collection are deleted.
@@ -128,11 +128,65 @@ declare global {
      * @param options   - Options which modified the deletion operation
      * @param userId    - The ID of the User who triggered the operation
      */
-    _onDeleteDocuments(
+    protected _onDeleteDocuments(
       documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
       result: string[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
+
+    /**
+     * Generate the render context information provided for CRUD operations.
+     * @param action    - The CRUD operation.
+     * @param documents - The documents being operated on.
+     * @param data      - An array of creation or update objects, or an array of document IDs, depending on
+     *                    the operation.
+     * @internal
+     */
+    protected _getRenderContext(
+      action: DocumentCollection.RenderContext.Create<T>['action'],
+      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
+      data: (InstanceType<T>['data']['_source'] & { _id: string })[]
+    ): DocumentCollection.RenderContext.Create<T>;
+    protected _getRenderContext(
+      action: DocumentCollection.RenderContext.Update<T>['action'],
+      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
+      data: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[]
+    ): DocumentCollection.RenderContext.Update<T>;
+    protected _getRenderContext(
+      action: DocumentCollection.RenderContext.Delete<T>['action'],
+      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
+      data: string[]
+    ): DocumentCollection.RenderContext.Delete<T>;
+  }
+
+  namespace DocumentCollection {
+    namespace RenderContext {
+      interface Base<T extends DocumentConstructor> {
+        documentType: T['metadata']['name'];
+        documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[];
+
+        /** @deprecated The 'entities' render context is deprecated. Please use 'documents' instead. */
+        get entities(): this['documents'];
+
+        /** @deprecated The 'entityType' render context is deprecated. Please use 'documentType' instead. */
+        get entityType(): this['documentType'];
+      }
+
+      interface Create<T extends DocumentConstructor> extends Base<T> {
+        action: 'create';
+        data: (InstanceType<T>['data']['_source'] & { _id: string })[];
+      }
+
+      interface Update<T extends DocumentConstructor> extends Base<T> {
+        action: 'update';
+        data: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[];
+      }
+
+      interface Delete<T extends DocumentConstructor> extends Base<T> {
+        action: 'delete';
+        data: string[];
+      }
+    }
   }
 }