@league-of-foundry-developers/foundry-vtt-types 0.8.9-5 → 0.8.9-9

package/README.md

@@ -1,7 +1,5 @@
 # foundry-vtt-types
 
-
-
 <div align=center>
 
 TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.com/) (unofficial)
@@ -19,10 +17,16 @@ TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.co
 
 We aim to support the latest patch release of minor versions of Foundry VTT, starting with 0.7.
 
-At the moment, the latest 0.7.x and 0.8.x versions are supported. However, note that work on 0.8.x has not been completed yet, so there are still quite a few things which are either missing or typed incorrectly. Take a look at [0.8.x issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+0.8.x%22) to see what still needs to be done.
+At the moment, the latest 0.7.x and 0.8.x versions are supported. However, note that work on 0.8.x has not been
+completed yet, so there are still quite a few things which are either missing or typed incorrectly. Take a look at
+[0.8.x issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+0.8.x%22)
+to see what still needs to be done.
+
 ## Installation
 
-You can install foundry-vtt-types from the [npm registry](https://npmjs.org/). We provide distribution tags for the different supported Foundry VTT versions that have the form `fvtt-<foundry-version>`. For example, the distribution tag for Foundry VTT 0.8.8 is `fvtt-0.8.8`.
+You can install foundry-vtt-types from the [npm registry](https://npmjs.org/). We provide distribution tags for the
+different supported Foundry VTT versions that have the form `fvtt-<foundry-version>`. For example, the distribution tag
+for Foundry VTT 0.8.8 is `fvtt-0.8.8`.
 
 In order to install the desired version, run
 
@@ -36,7 +40,8 @@ For example, to install the type definitions for Foundry VTT 0.8.8 run
 npm install --save-dev @league-of-foundry-developers/foundry-vtt-types@fvtt-0.8.8
 ```
 
-You can then update foundry-vtt-types using the regular update mechanism for npm (see [npm update](https://docs.npmjs.com/cli/v7/commands/npm-update)).
+You can then update foundry-vtt-types using the regular update mechanism for npm
+(see [npm update](https://docs.npmjs.com/cli/v7/commands/npm-update)).
 
 ## Usage
 
@@ -54,29 +59,42 @@ Add foundry-vtt-types to your types section in your `tsconfig.json`:
 
 This will make the type definitions available globally in your project.
 
-Make sure you are using `"moduleResolution": "node"`, too. It is required for some dependencies to be resolved correctly.
+Make sure you are using `"moduleResolution": "node"`, too. It is required for some dependencies to be resolved
+correctly.
 
-Also make sure to set `"strictNullChecks": true` because otherwise, some of the conditional types used in the type definitions resolve incorrectly and you will see a lot of errors.
+Also make sure to set `"strictNullChecks": true` because otherwise, some of the conditional types used in the type
+definitions resolve incorrectly and you will see a lot of errors.
 
-You can find some information about how to actually work with the type definitions in the [Wiki](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki). If you are working with Foundry VTT 0.8.x, a good starting point is [[0.8.x] FAQ](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki/%5B0.8.x%5D-FAQ).
+You can find some information about how to actually work with the type definitions in the
+[Wiki](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki). If you are working with Foundry VTT
+0.8.x, a good starting point is
+[[0.8.x] FAQ](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki/%5B0.8.x%5D-FAQ).
 
 ## Acknowledgments
 
-Originally forked from [Foundry Project Creator Types](https://gitlab.com/foundry-projects/foundry-pc/foundry-pc-types) by [@NickEastNL](https://gitlab.com/NvanOosten)
+Originally forked from [Foundry Project Creator Types](https://gitlab.com/foundry-projects/foundry-pc/foundry-pc-types)
+by [@NickEastNL](https://gitlab.com/NvanOosten)
 
 ## Contributing
 
-Contributions are very welcome in order to decrease the individual workload. Filing issues for wrong / missing types is also a great way to help us improve the type definitions.
+Contributions are very welcome in order to decrease the individual workload. Filing issues for wrong / missing types is
+also a great way to help us improve the type definitions.
 
-There are individual branches for the different supported Foundry VTT versions that are being worked on. They are named according to the minor version of the Foundry VTT version, e.g. the branch for Foundry VTT 0.8 is called `foundry-0.8.x`. All work to improve the type definitions for a specific version needs to be done through Pull Requests to the corresponding branch.
+There are individual branches for the different supported Foundry VTT versions that are being worked on. They are named
+according to the minor version of the Foundry VTT version, e.g. the branch for Foundry VTT 0.8 is called
+`foundry-0.8.x`. All work to improve the type definitions for a specific version needs to be done through Pull Requests
+to the corresponding branch.
 
 Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to contribute.
 
-If you have any specific questions, feel free to contact us in the [League of Extraordinary Foundry Developers Discord](https://discord.gg/52DNPzqm2Z).
+If you have any specific questions, feel free to contact us in the
+[League of Extraordinary Foundry Developers Discord](https://discord.gg/52DNPzqm2Z).
 
 ## Type-Checking, Linting, Testing
 
-When contributing, make sure sure that the type checks pass, the linter is green and the tests are green. We _do_ have checks in the CI but running this locally also helps you while developing and saves you time as you don't have to wait for the CI.
+When contributing, make sure sure that the type checks pass, the linter is green and the tests are green. We _do_ have
+checks in the CI but running this locally also helps you while developing and saves you time as you don't have to wait
+for the CI.
 
 You can run type checking and linting with the following command:
 
@@ -90,6 +108,16 @@ You can run the tests with
 npm run test
 ```
 
+## Creating a release
+
+To create a release, you have to create a new release commit, tag it and create a GitHub release from that. The CI will
+handle the rest.
+
+```
+npm version prerelease
+git push --follow-tags
+```
+
 ## License
 
 This project is licensed under the MIT license. You can find a copy at [LICENSE](LICENSE).

package/index-lenient.d.ts

@@ -0,0 +1,10 @@
+import './index';
+
+declare global {
+  interface LenientGlobalVariableTypes {
+    canvas: never;
+    game: never;
+    socket: never;
+    ui: never;
+  }
+}

package/package.json

@@ -1,7 +1,15 @@
 {
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "0.8.9-5",
+  "version": "0.8.9-9",
   "description": "TypeScript type definitions for Foundry VTT",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts"
+    },
+    "./lenient": {
+      "types": "./index-lenient.d.ts"
+    }
+  },
   "scripts": {
     "lint": "./node_modules/typescript/bin/tsc && eslint --ext .d.ts,.test-d.ts .",
     "lint:fix": "eslint --fix --ext .d.ts,.test-d.ts .",
@@ -60,6 +68,7 @@
   },
   "files": [
     "index.d.ts",
+    "index-lenient.d.ts",
     "src"
   ],
   "publishConfig": {

package/src/foundry/common/abstract/backend.mjs.d.ts

@@ -27,22 +27,28 @@ declare abstract class DatabaseBackend {
 
   /**
    * Get primary Document instances
+   * @remarks
+   * foundry actually declares this function to take parameters `documentClass`, `query`, `options`, and `user` but
+   * that's not how it is called and also not how the subclasses implement it.
+   * See https://gitlab.com/foundrynet/foundryvtt/-/issues/6177
    */
   protected abstract _getDocuments<T extends Document<any, any>>(
     documentClass: ConstructorOf<T>,
-    query: Request,
-    options: RequestOptions,
+    request: Request,
     user: BaseUser
   ): Promise<T[]>;
 
   /**
    * Get embedded Document instances
+   * @remarks
+   * foundry actually declares this function to take parameters `documentClass`, `parent`, `query`, `options`, and
+   * `user` but that's not how it is called and also not how the subclasses implement it.
+   * See https://gitlab.com/foundrynet/foundryvtt/-/issues/6177
    */
   protected abstract _getEmbeddedDocuments<T extends Document<any, any>>(
     documentClass: ConstructorOf<T>,
     parent: T extends Document<any, infer U> ? U : never,
-    query: Request,
-    options: RequestOptions,
+    request: Request,
     user: BaseUser
   ): Promise<T[]>;
 
@@ -198,7 +204,8 @@ declare abstract class DatabaseBackend {
    * @param action    - The action performed
    * @param type      - The document type
    * @param documents - The documents modified
-   * @param info      - The logging level
+   * @param level     - The logging level
+   *                    (default: `'info'`)
    * @param parent    - A parent document
    * @param pack      - A compendium pack within which the operation occurred
    */
@@ -225,24 +232,16 @@ declare abstract class DatabaseBackend {
   protected _logContext({ parent, pack }?: { parent?: Document<any, any>; pack?: string }): string;
 }
 
-interface Request {
+export interface Request {
   data?: AnyDocumentData[];
   updates?: AnyDocumentData[];
   ids?: string[];
   parent?: Document<any, any>;
-  query?: object | IdQuery | SceneIdUserQuery;
+  query?: Record<string, unknown>;
   options?: RequestOptions;
   pack?: string;
 }
 
-export interface IdQuery {
-  _id: string;
-}
-export interface SceneIdUserQuery {
-  sceneId: string;
-  user: string;
-}
-
 export interface RequestOptions {
   index?: boolean;
   broadcast?: boolean;

package/src/foundry/common/abstract/document.mjs.d.ts

@@ -1,5 +1,4 @@
 import { BaseUser } from '../documents.mjs';
-import DatabaseBackend from './backend.mjs';
 import { AnyDocumentData } from './data.mjs';
 import {
   ConfiguredDocumentClass,
@@ -82,7 +81,7 @@ declare abstract class Document<
   /**
    * The database backend used to execute operations and handle results
    */
-  static get database(): DatabaseBackend; // TODO: Reference type defined in CONFIG
+  static get database(): CONFIG['DatabaseBackend'];
 
   /**
    * Return a reference to the implemented subclass of this base document type.
@@ -703,6 +702,11 @@ export interface DocumentModificationOptions {
    */
   index?: boolean;
 
+  /**
+   * An array of fields to retrieve when indexing the collection
+   */
+  indexFields?: string[];
+
   /**
    * When performing a creation operation, keep the provided _id instead of clearing it.
    * @defaultValue `false`

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

@@ -3,7 +3,12 @@ import { BaseUser } from '../../documents.mjs';
 import { ForeignDocumentField } from '../fields.mjs';
 import * as fields from '../fields.mjs';
 import * as documents from '../../documents.mjs';
-import { ConfiguredDocumentClass, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
+import {
+  ConfiguredDocumentClass,
+  ConfiguredFlags,
+  FieldReturnType,
+  PropertiesToSource
+} from '../../../../types/helperTypes';
 
 interface DrawingDataSchema extends DocumentSchema {
   _id: typeof fields.DOCUMENT_ID;
@@ -211,7 +216,7 @@ interface DrawingDataProperties {
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags: Record<string, unknown>;
+  flags: ConfiguredFlags<'Drawing'>;
 }
 
 interface DrawingDataConstructorData {
@@ -365,7 +370,7 @@ interface DrawingDataConstructorData {
    * An object of optional key/value flags
    * @defaultValue `{}`
    */
-  flags?: Record<string, unknown> | null;
+  flags?: ConfiguredFlags<'Drawing'> | null;
 }
 
 /**

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

@@ -84,4 +84,9 @@ interface SocketResponse {
    * Data returned as a result of the request
    */
   data?: RequestData;
+
+  /**
+   * An Array of created data objects
+   */
+  result?: object[];
 }

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

@@ -312,12 +312,9 @@ declare abstract class Application<Options extends Application.Options = Applica
    * Callback actions which occur when a dragged element is dropped on a target.
    * @param event - The originating DragEvent
    *                (unused)
-   * @remarks
-   * The implementation in {@link Application} actually returns `void` but it is
-   * typed as `unknown` to allow deriving methods to return whatever they want.
-   * The returned value is not meant to be used.
+   * @internal
    */
-  protected _onDrop(event: DragEvent): unknown;
+  protected _onDrop(event: DragEvent): void;
 
   /**
    * Bring the application to the top of the rendering stack

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

@@ -1,30 +1,24 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
-
 /**
  * The Camera UI View that displays all the camera feeds as individual video elements.
- * @typeParam P - the type of the options object
+ * @typeParam Options - the type of the options object
+ * @typeParam Data    - The data structure used to render the handlebars template.
  */
-declare class CameraViews<P extends Application.Options = Application.Options> extends Application<P> {
-  /**
-   * @param webrtc - The WebRTC Implementation to display
-   *                 (unused)
-   */
-  constructor(webrtc?: any, options?: Partial<P>);
-
+declare class CameraViews<
+  Options extends Application.Options = Application.Options,
+  Data extends object = CameraViews.Data
+> extends Application<Options> {
   /**
    * @override
    * @defaultValue
    * ```typescript
-   * mergeObject(super.defaultOptions, {
+   * return foundry.utils.mergeObject(super.defaultOptions, {
    *   id: "camera-views",
    *   template: "templates/hud/camera-views.html",
-   *   popOut: false
-   * });
+   *   popOut: false,
+   * })
    * ```
    */
-  static get defaultOptions(): typeof Application['defaultOptions'];
+  static get defaultOptions(): Application.Options;
 
   /**
    * A reference to the master AV orchestrator instance
@@ -56,26 +50,29 @@ declare class CameraViews<P extends Application.Options = Application.Options> e
    * Extend the render logic to first check whether a render is necessary based on the context
    * If a specific context was provided, make sure an update to the navigation is necessary before rendering
    */
-  render(force?: boolean, context?: Application.RenderOptions<P>): Application['render'];
+  render(force?: boolean, context?: Application.RenderOptions<Options>): this | void;
 
   /** @override */
-  protected _render(force?: boolean, options?: Application.RenderOptions<P>): Promise<void>;
+  protected _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
 
   /**
    * @param options - (unused)
    * @override
    */
-  getData(options?: Partial<P>): CameraViews.Data;
+  getData(options?: Partial<Options>): Data | Promise<Data>;
 
-  maxZ: number;
+  /** @defaultValue `undefined` */
+  maxZ?: number;
 
   /**
    * Prepare rendering data for a single user
+   * @internal
    */
   protected _getDataForUser(userId: string, settings: AVSettings.UserSettings): CameraViews.Data.User | null;
 
   /**
    * A custom sorting function that orders/arranges the user display frames
+   * @internal
    */
   protected static _sortUsers(a: CameraViews.Data.User, b: CameraViews.Data.User): number;
 
@@ -85,30 +82,35 @@ declare class CameraViews<P extends Application.Options = Application.Options> e
   /**
    * On hover in a camera container, show/hide the controls.
    * @param event - The original mouseover or mouseout hover event
+   * @internal
    */
   protected _onCameraViewHover(event: JQuery.MouseEnterEvent | JQuery.MouseLeaveEvent): void;
 
   /**
    * On clicking on a toggle, disable/enable the audio or video stream.
    * @param event - The originating click event
+   * @internal
    */
   protected _onClickControl(event: JQuery.ClickEvent): Promise<void>;
 
   /**
    * Change volume control for a stream
    * @param event - The originating change event from interaction with the range input
+   * @internal
    */
   protected _onVolumeChange(event: JQuery.ChangeEvent): void;
 
   /**
    * Dynamically refresh the state of a single camera view
    * @param view - The view container div
+   * @internal
    */
   protected _refreshView(view: HTMLElement): void;
 
   /**
    * Render changes needed to the PlayerList ui.
    * Show/Hide players depending on option.
+   * @internal
    */
   protected _setPlayerListVisibility(): void;
 
@@ -119,8 +121,9 @@ declare class CameraViews<P extends Application.Options = Application.Options> e
    * @param action - The named av-control button action
    * @param state  - The CURRENT action state.
    * @returns The icon that represents the NEXT action state.
+   * @internal
    */
-  protected _getToggleIcon(action: string, state?: boolean): null;
+  protected _getToggleIcon(action: string, state: boolean): string | null;
 
   /**
    * Get the text title that should be used for various action buttons with different toggled states.
@@ -129,6 +132,7 @@ declare class CameraViews<P extends Application.Options = Application.Options> e
    * @param action - The named av-control button action
    * @param state - The CURRENT action state.
    * @returns The icon that represents the NEXT action state.
+   * @internal
    */
   protected _getToggleTooltip(action: string, state: boolean): string;
 
@@ -142,6 +146,7 @@ declare class CameraViews<P extends Application.Options = Application.Options> e
    * @param show      - Whether to show or hide the controls
    * @param selector  - Override selector to specify which controls to show or hide
    *                    (default: `'.control-bar'`)
+   * @internal
    */
   protected _toggleControlVisibility(container: HTMLElement, show: boolean, selector?: string): void;
 }
@@ -149,24 +154,24 @@ declare class CameraViews<P extends Application.Options = Application.Options> e
 declare namespace CameraViews {
   interface Data {
     self: Game['user'];
-    users: CameraViews.Data.User[];
+    users: Data.User[];
     dockClass: string;
     muteAll: boolean;
   }
 
   namespace Data {
     interface User {
-      user: globalThis.User;
-      id: globalThis.User['id'];
-      local: globalThis.User['isSelf'];
-      name: globalThis.User['name'];
-      color: globalThis.User['data']['color'];
-      colorAlpha: ReturnType<typeof foundry.utils.hexToRGBAString>;
+      user: StoredDocument<globalThis.User>;
+      id: StoredDocument<globalThis.User>['id'];
+      local: StoredDocument<globalThis.User>['isSelf'];
+      name: StoredDocument<globalThis.User>['name'];
+      color: StoredDocument<globalThis.User>['data']['color'];
+      colorAlpha: `rgba(${number}, ${number}, ${number})`;
       charname: string;
-      avatar: globalThis.User['avatar'];
+      avatar: StoredDocument<globalThis.User>['avatar'];
       settings: AVSettings.UserSettings;
-      volume: ReturnType<typeof AudioHelper['volumeToInput']>;
-      cameraViewClass: ReturnType<Array<string>['filterJoin']>;
+      volume: number;
+      cameraViewClass: string;
     }
   }
 }

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

@@ -67,8 +67,11 @@ declare class Compendium<
   /** @override */
   protected _onDragStart(event: DragEvent): void;
 
-  /** @override */
-  protected _onDrop(event: DragEvent): ReturnType<this['collection']['importDocument']> | false;
+  /**
+   * @override
+   * @internal
+   */
+  protected _onDrop(event: DragEvent): void;
 
   /**
    * Render the ContextMenu which applies to each compendium Document