@league-of-foundry-developers/foundry-vtt-types 0.8.9-3 → 0.8.9-4

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "0.8.9-3",
+  "version": "0.8.9-4",
   "description": "TypeScript type definitions for Foundry VTT",
   "scripts": {
     "lint": "./node_modules/typescript/bin/tsc && eslint --ext .d.ts,.test-d.ts .",

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

@@ -278,11 +278,11 @@ export const TABLE_RESULT_TYPES: {
  * Define the valid anchor locations for a Tooltip displayed on a Placeable Object
  */
 export const TEXT_ANCHOR_POINTS: {
-  BOTTOM: 0;
-  CENTER: 1;
-  LEFT: 2;
-  RIGHT: 3;
-  TOP: 4;
+  CENTER: 0;
+  BOTTOM: 1;
+  TOP: 2;
+  LEFT: 3;
+  RIGHT: 4;
 };
 
 /**
@@ -360,30 +360,11 @@ export const MEASURED_TEMPLATE_TYPES: MeasuredTemplateTypes;
  * @defaultValue
  * ```typescript
  * [
- *   'application/json',
- *   'application/ogg',
- *   'application/pdf',
- *   'audio/wave',
- *   'audio/wav',
- *   'audio/webm',
- *   'audio/ogg',
- *   'audio/midi',
- *   'audio/mpeg',
- *   'audio/opus',
- *   'audio/aac',
- *   'image/apng',
- *   'image/bmp',
- *   'image/gif',
- *   'image/jpeg',
- *   'image/png',
- *   'image/svg+xml',
- *   'image/tiff',
- *   'image/webp',
- *   'text/plain',
- *   'text/markdown',
- *   'video/mpeg',
- *   'video/mp4',
- *   'video/ogg'
+ *   "application/json", "application/ogg", "application/pdf",
+ *   "audio/wave", "audio/wav", "audio/webm", "audio/ogg", "audio/midi", "audio/mpeg", "audio/opus", "audio/aac",
+ *   "image/apng", "image/bmp", "image/gif", "image/jpeg", "image/png", "image/svg+xml", "image/tiff", "image/webp",
+ *   "text/plain", "text/markdown",
+ *   "video/mpeg", "video/mp4", "video/ogg"
  * ]
  * ```
  */
@@ -695,7 +676,7 @@ export const WALL_SENSE_TYPES: {
 
 /**
  * The allowed set of HTML template extensions
- * @defaultValue `["html", "hbs"]`
+ * @defaultValue `["html", "handlebars", "hbs"]`
  */
 export const HTML_FILE_EXTENSIONS: string[];
 
@@ -717,6 +698,26 @@ export const VIDEO_FILE_EXTENSIONS: string[];
  */
 export const AUDIO_FILE_EXTENSIONS: string[];
 
+/**
+ * @deprecated since 0.8.0
+ */
+export const DRAWING_DEFAULT_VALUES: {
+  width: 0;
+  height: 0;
+  rotation: 0;
+  z: 0;
+  hidden: false;
+  locked: false;
+  fillType: typeof DRAWING_FILL_TYPES.NONE;
+  fillAlpha: 0.5;
+  bezierFactor: 0.0;
+  strokeAlpha: 1.0;
+  strokeWidth: 8;
+  fontSize: 48;
+  textAlpha: 1.0;
+  textColor: '#FFFFFF';
+};
+
 export type ActiveEffectMode = ValueOf<typeof ACTIVE_EFFECT_MODES>;
 export type ChatMessageType = ValueOf<typeof CHAT_MESSAGE_TYPES>;
 export type DiceRollMode = ValueOf<typeof DICE_ROLL_MODES>;

package/src/foundry/common/data/data.mjs/index.d.ts

@@ -14,8 +14,10 @@ export { MacroData } from './macroData';
 export { MeasuredTemplateData } from './measuredTemplateData';
 export { NoteData } from './noteData';
 export { PrototypeTokenData } from './prototypeTokenData';
+export { RollTableData } from './rollTableData';
 export { SceneData } from './sceneData';
 export { SettingData } from './settingData';
+export { TableResultData } from './tableResultData';
 export { TileData } from './tileData';
 export { TokenBarData } from './tokenBarData';
 export { TokenData } from './tokenData';

package/src/foundry/common/data/data.mjs/rollTableData.d.ts

@@ -0,0 +1,182 @@
+import {
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes';
+import EmbeddedCollection from '../../abstract/embedded-collection.mjs';
+import { DocumentData } from '../../abstract/module.mjs';
+import * as documents from '../../documents.mjs';
+import * as fields from '../fields.mjs';
+
+interface RollTableDataSchema extends DocumentSchema {
+  _id: typeof fields.DOCUMENT_ID;
+  name: typeof fields.REQUIRED_STRING;
+  img: FieldReturnType<typeof fields.IMAGE_FIELD, { default: () => string }>;
+  description: typeof fields.STRING_FIELD;
+  results: fields.EmbeddedCollectionField<typeof documents.BaseTableResult>;
+  formula: typeof fields.STRING_FIELD;
+  replacement: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
+  displayRoll: FieldReturnType<typeof fields.BOOLEAN_FIELD, { default: true }>;
+  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
+  sort: typeof fields.INTEGER_SORT_FIELD;
+  permission: typeof fields.DOCUMENT_PERMISSIONS;
+  flags: typeof fields.OBJECT_FIELD;
+}
+
+interface RollTableDataProperties {
+  /**
+   * The _id which uniquely identifies this RollTable document
+   */
+  _id: string | null;
+
+  /**
+   * The name of this RollTable
+   */
+  name: string;
+
+  /**
+   * An image file path which provides the thumbnail artwork for this RollTable
+   */
+  img: string;
+
+  /**
+   * The HTML text description for this RollTable document
+   */
+  description: string | undefined;
+
+  /**
+   * A Collection of TableResult embedded documents which belong to this RollTable
+   */
+  results: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseTableResult>, RollTableData>;
+
+  /**
+   * The Roll formula which determines the results chosen from the table
+   */
+  formula: string | undefined;
+
+  /**
+   * Are results from this table drawn with replacement?
+   * @defaultValue `true`
+   */
+  replacement: boolean;
+
+  /**
+   * Is the Roll result used to draw from this RollTable displayed in chat?
+   * @defaultValue `true`
+   */
+  displayRoll: boolean;
+
+  /**
+   * The _id of a Folder which contains this RollTable
+   */
+  folder: string | null;
+
+  /**
+   * The numeric sort value which orders this RollTable relative to its siblings
+   * @defaultValue `0`
+   */
+  sort: number;
+
+  /**
+   * An object which configures user permissions to this RollTable
+   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
+   */
+  permission: Partial<Record<string, foundry.CONST.EntityPermission>>;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags: ConfiguredFlags<'RollTable'>;
+}
+
+interface RollTableDataConstructorData {
+  /**
+   * The _id which uniquely identifies this RollTable document
+   */
+  _id?: string | null;
+
+  /**
+   * The name of this RollTable
+   */
+  name: string;
+
+  /**
+   * An image file path which provides the thumbnail artwork for this RollTable
+   */
+  img?: string | null;
+
+  /**
+   * The HTML text description for this RollTable document
+   */
+  description?: string | null;
+
+  /**
+   * A Collection of TableResult embedded documents which belong to this RollTable
+   */
+  results?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseTableResult>>[0][] | null;
+
+  /**
+   * The Roll formula which determines the results chosen from the table
+   */
+  formula?: string | null;
+
+  /**
+   * Are results from this table drawn with replacement?
+   * @defaultValue `true`
+   */
+  replacement?: boolean | null;
+
+  /**
+   * Is the Roll result used to draw from this RollTable displayed in chat?
+   * @defaultValue `true`
+   */
+  displayRoll?: boolean | null;
+
+  /**
+   * The _id of a Folder which contains this RollTable
+   */
+  folder?: string | null;
+
+  /**
+   * The numeric sort value which orders this RollTable relative to its siblings
+   */
+  sort?: number | null;
+
+  /**
+   * An object which configures user permissions to this RollTable
+   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
+   */
+  permission?: Partial<Record<string, foundry.CONST.EntityPermission>> | null;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags?: ConfiguredFlags<'RollTable'> | null;
+}
+
+/**
+ * The data schema for an RollTable document.
+ * @see BaseRollTable
+ */
+export declare class RollTableData extends DocumentData<
+  RollTableDataSchema,
+  RollTableDataProperties,
+  PropertiesToSource<RollTableDataProperties>,
+  RollTableDataConstructorData,
+  documents.BaseRollTable
+> {
+  static defineSchema(): RollTableDataSchema;
+
+  /**
+   * The default icon used for newly created Macro documents
+   * @remarks Incorrect description, really for the RollTables.
+   * @defaultValue `'icons/svg/d20-grey.svg'`
+   */
+  static DEFAULT_ICON: string;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-empty-interface
+export declare interface RollTableData extends RollTableDataProperties {}

package/src/foundry/common/data/data.mjs/tableResultData.d.ts

@@ -0,0 +1,162 @@
+import { ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
+import DocumentData from '../../abstract/data.mjs';
+import { BaseTableResult } from '../../documents.mjs';
+import { fields } from '../module.mjs';
+
+interface TableResultDataSchema extends DocumentSchema {
+  _id: typeof fields.DOCUMENT_ID;
+  type: DocumentField<foundry.CONST.TableResultType> & {
+    type: typeof Number;
+    default: typeof CONST.TABLE_RESULT_TYPES.TEXT;
+    validate: (t: unknown) => t is foundry.CONST.TableResultType;
+    validationError: 'Invalid TableResult type provided';
+  };
+  text: typeof fields.BLANK_STRING;
+  img: typeof fields.IMAGE_FIELD;
+  collection: typeof fields.STRING_FIELD;
+  resultId: typeof fields.STRING_FIELD;
+  weight: typeof fields.POSITIVE_INTEGER_FIELD;
+  range: {
+    type: [typeof Number];
+    required: true;
+    default: [];
+    validate: typeof _isValidResultRange;
+    validationError: 'Invalid TableResult range which must be a length-2 array of ascending integers';
+  };
+  drawn: typeof fields.BOOLEAN_FIELD;
+  flags: typeof fields.OBJECT_FIELD;
+}
+
+/**
+ * Validate whether a table result has a valid result range.
+ * @internal
+ * @param range - The proposed result range
+ * @returns Is the range valid?
+ */
+declare function _isValidResultRange(range: unknown): range is [number, number];
+
+interface TableResultDataProperties {
+  /**
+   * The _id which uniquely identifies this TableResult embedded document
+   * @defaultValue `null`
+   */
+  _id: string | null;
+
+  /**
+   * A result sub-type from CONST.TABLE_RESULT_TYPES
+   * @defaultValue `CONST.TABLE_RESULT_TYPES.TEXT`
+   */
+  type: foundry.CONST.TableResultType;
+
+  /**
+   * The text which describes the table result
+   */
+  text: string;
+
+  /**
+   * An image file url that represents the table result
+   */
+  img: string | undefined;
+
+  /**
+   * A named collection from which this result is drawn
+   */
+  collection: string | undefined;
+
+  /**
+   * The _id of a Document within the collection this result references
+   */
+  resultId: string | undefined;
+
+  /**
+   * The probabilistic weight of this result relative to other results
+   * @defaultValue `1`
+   */
+  weight: number | undefined;
+
+  /**
+   * A length 2 array of ascending integers which defines the range of dice roll
+   * totals which produce this drawn result
+   */
+  range: [number, number];
+
+  /**
+   * Has this result already been drawn (without replacement)
+   * @defaultValue `false`
+   */
+  drawn: boolean;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags: ConfiguredFlags<'TableResult'>;
+}
+
+interface TableResultDataConstructorData {
+  /**
+   * The _id which uniquely identifies this TableResult embedded document
+   * @defaultValue `null`
+   */
+  _id?: string | null;
+
+  /**
+   * A result sub-type from CONST.TABLE_RESULT_TYPES
+   * @defaultValue `CONST.TABLE_RESULT_TYPES.TEXT`
+   */
+  type?: foundry.CONST.TableResultType | null | undefined;
+
+  /**
+   * The text which describes the table result
+   */
+  text?: string | null;
+
+  /**
+   * An image file url that represents the table result
+   */
+  img?: string | undefined | null;
+
+  /**
+   * A named collection from which this result is drawn
+   */
+  collection?: string | undefined | null;
+
+  /**
+   * The _id of a Document within the collection this result references
+   */
+  resultId?: string | undefined | null;
+
+  /**
+   * The probabilistic weight of this result relative to other results
+   * @defaultValue `1`
+   */
+  weight?: number | undefined | null;
+
+  /**
+   * A length 2 array of ascending integers which defines the range of dice roll
+   * totals which produce this drawn result
+   */
+  range: [number, number];
+
+  /**
+   * Has this result already been drawn (without replacement)
+   * @defaultValue `false`
+   */
+  drawn?: boolean | undefined | null;
+
+  /**
+   * An object of optional key/value flags
+   * @defaultValue `{}`
+   */
+  flags?: ConfiguredFlags<'TableResult'> | undefined | null;
+}
+
+export declare class TableResultData extends DocumentData<
+  TableResultDataSchema,
+  TableResultDataProperties,
+  PropertiesToSource<TableResultDataProperties>,
+  TableResultDataConstructorData,
+  BaseTableResult
+> {
+  static defineSchema(): TableResultDataSchema;
+}

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

@@ -5,7 +5,9 @@ import { BaseTableResult } from './baseTableResult';
 /**
  * The base RollTable model definition which defines common behavior of an RollTable document between both client and server.
  */
-export declare class BaseRollTable extends Document<any, any> {
+export declare class BaseRollTable extends Document<foundry.data.RollTableData> {
+  static get schema(): typeof foundry.data.RollTableData;
+
   static get metadata(): Merge<
     DocumentMetadata,
     {
@@ -18,4 +20,9 @@ export declare class BaseRollTable extends Document<any, any> {
       isPrimary: true;
     }
   >;
+
+  /**
+   * A reference to the Collection of TableResult instances in this document, indexed by _id.
+   */
+  get results(): this['data']['results'];
 }

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

@@ -1,11 +1,18 @@
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
 import { DocumentMetadata } from '../abstract/document.mjs';
 import { Document } from '../abstract/module.mjs';
+import { BaseRollTable } from './baseRollTable';
 import { BaseUser } from './baseUser';
 
 /**
  * The base TableResult model definition which defines common behavior of an TableResult document between both client and server.
  */
-export declare class BaseTableResult extends Document<any, any> {
+export declare class BaseTableResult extends Document<
+  foundry.data.TableResultData,
+  InstanceType<ConfiguredDocumentClass<typeof BaseRollTable>>
+> {
+  static get schema(): typeof foundry.data.TableResultData;
+
   static get metadata(): Merge<
     DocumentMetadata,
     {
@@ -18,4 +25,16 @@ export declare class BaseTableResult extends Document<any, any> {
       };
     }
   >;
+
+  /**
+   * Is a user able to update an existing TableResult?
+   * @internal
+   */
+  protected static _canUpdate(user: BaseUser, doc: BaseTableResult, data?: object): boolean;
+
+  testUserPermission(
+    user: BaseUser,
+    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
+    { exact }?: { exact?: boolean }
+  ): boolean;
 }

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

@@ -1,41 +1,42 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
-/**
- * @typeParam P - the type of the options object
- */
-declare class ChatPopout<P extends Application.Options = Application.Options> extends Application<P> {
-  constructor(message: ChatPopout['message'], options?: Partial<P>);
+import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
 
+declare global {
   /**
-   * The displayed Chat Message entity
+   * A simple application which supports popping a ChatMessage out to a separate UI window.
+   * @typeParam Options - the type of the options object
    */
-  message: ChatMessage;
+  class ChatPopout<Options extends Application.Options = Application.Options> extends Application<Options> {
+    constructor(message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>, options?: Partial<Options>);
 
-  /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   width: 300,
-   *   height: "auto",
-   *   classes: ["chat-popout"]
-   * })
-   * ```
-   */
-  static get defaultOptions(): typeof Application['defaultOptions'];
+    /**
+     * The displayed Chat Message entity
+     */
+    message: InstanceType<ConfiguredDocumentClass<typeof ChatMessage>>;
 
-  /** @override */
-  get id(): string;
+    /**
+     * @override
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   width: 300,
+     *   height: "auto",
+     *   classes: ["chat-popout"]
+     * })
+     * ```
+     */
+    static get defaultOptions(): Application.Options;
 
-  /** @override */
-  get title(): string;
+    /** @override */
+    get id(): string;
 
-  /**
-   * @param data    - (unused)
-   * @param options - (unused)
-   * @override
-   */
-  protected _renderInner(data?: any, options?: any): ReturnType<this['message']['render']>;
+    /** @override */
+    get title(): string;
+
+    /**
+     * @param data    - (unused)
+     * @param options - (unused)
+     * @override
+     */
+    protected _renderInner(data: object, options?: unknown): Promise<JQuery> | JQuery;
+  }
 }

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

@@ -41,7 +41,10 @@ declare global {
     /**
      * @remarks This method not overridden in foundry but added to provide types when overriding the UserConfig.
      */
-    protected _updateObject(event: Event, formData: FormData): ReturnType<User['update']>;
+    protected _updateObject(
+      event: Event,
+      formData: FormData
+    ): Promise<InstanceType<ConfiguredDocumentClass<typeof User>> | undefined>;
   }
 
   namespace UserConfig {

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

@@ -67,10 +67,10 @@ declare namespace WallConfig {
 
   interface FormData {
     dir: foundry.CONST.WallDirection;
-    door: Wall.Data['door'];
-    ds?: Wall.Data['ds'];
-    move: Wall.Data['move'];
-    sense: Wall.Data['sense'];
+    door: Wall['data']['door'];
+    ds?: Wall['data']['ds'];
+    move: Wall['data']['move'];
+    sense: Wall['data']['sense'];
   }
 
   interface Options extends FormApplication.Options {

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

@@ -22,6 +22,7 @@ declare class ChatBubbles {
    * Track which Token was most recently panned to highlight
    * Use this to avoid repeat panning
    * @defaultValue `null`
+   * @internal
    */
   protected _panned: Token | null;
 
@@ -41,6 +42,7 @@ declare class ChatBubbles {
 
   /**
    * Clear any existing chat bubble for a certain Token
+   * @internal
    */
   protected _clearBubble(token: Token): Promise<void>;
 
@@ -48,6 +50,7 @@ declare class ChatBubbles {
    * Render the HTML template for the chat bubble
    * @param data - Template data
    * @returns The rendered HTML
+   * @internal
    */
   protected _renderHTML(data: { token: Token; message: string; emote: boolean }): Promise<string>;
 
@@ -55,11 +58,13 @@ declare class ChatBubbles {
    * Before displaying the chat message, determine it's constrained and unconstrained dimensions
    * @param message - The message content
    * @returns The rendered message dimensions
+   * @internal
    */
   protected _getMessageDimensions(message: string): ChatBubbles.Dimensions;
 
   /**
    * Assign styling parameters to the chat bubble, toggling either a left or right display (randomly)
+   * @internal
    */
   protected _setPosition(token: Token, html: JQuery, dimensions: ChatBubbles.Dimensions): void;
 

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

@@ -24,10 +24,10 @@ declare global {
     turns: InstanceType<ConfiguredDocumentClass<typeof Combatant>>[];
 
     /** Record the current round, turn, and tokenId to understand changes in the encounter state */
-    protected current: RoundData;
+    current: RoundData;
 
     /** Track the previous round, turn, and tokenId to understand changes in the encounter state */
-    protected previous: RoundData;
+    previous: RoundData;
 
     /**
      * Track whether a sound notification is currently being played to avoid double-dipping