@league-of-foundry-developers/foundry-vtt-types 0.8.9-7 → 0.8.9-8

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-7",
+  "version": "0.8.9-8",
   "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/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