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

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

@@ -1,129 +1,152 @@
-// TODO: Remove when updating this class!!!
-// eslint-disable-next-line
-// @ts-nocheck
+import type { ConfiguredDocumentClassForName, DocumentConstructor } from '../../../../../types/helperTypes';
 
-/**
- * A Scene configuration sheet
- * @see {@link Scene} The Scene Entity which is being configured
- */
-declare class SceneConfig extends DocumentSheet<DocumentSheet.Options, SceneConfig.Data, Scene> {
+declare global {
   /**
-   * @override
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   classes: ["sheet", "scene-sheet"],
-   *   template: "templates/scene/config.html",
-   *   width: 680,
-   *   height: "auto"
-   * });
-   * ```
+   * The Application responsible for configuring a single Scene document.
+   * @see {@link Scene} The Scene Document which is being configured
+   *
+   * @typeParam Options - the type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
    */
-  static get defaultOptions(): typeof DocumentSheet['defaultOptions'];
+  class SceneConfig<
+    Options extends DocumentSheet.Options = DocumentSheet.Options,
+    Data extends object = SceneConfig.Data<Options>
+  > extends DocumentSheet<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Scene'>>> {
+    /**
+     * @override
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "scene-config",
+     *   classes: ["sheet", "scene-sheet"],
+     *   template: "templates/scene/config.html",
+     *   width: 680,
+     *   height: "auto",
+     * });
+     * ```
+     */
+    static get defaultOptions(): DocumentSheet.Options;
 
-  /**
-   * @override
-   */
-  get id(): string;
+    /**
+     * @override
+     */
+    get title(): string;
 
-  /**
-   * @override
-   */
-  get title(): string;
+    /**
+     * @override
+     * @remarks This incorrectly overrides `Application#render` by potentially returning `void`, see https://gitlab.com/foundrynet/foundryvtt/-/issues/6026.
+     */
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+    // @ts-expect-error
+    render(force?: boolean, options?: Application.RenderOptions<Options>): this | void;
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<DocumentSheet.Options>): SceneConfig.Data;
+    /**
+     * @param options - (unused)
+     * @override
+     */
+    getData(options?: Partial<DocumentSheet.Options>): Data | Promise<Data>;
 
-  /**
-   * Get an enumeration of the available grid types which can be applied to this Scene
-   */
-  protected static _getGridTypes(): Record<foundry.CONST.GridType, string>;
+    /**
+     * Get an enumeration of the available grid types which can be applied to this Scene
+     * @internal
+     */
+    protected static _getGridTypes(): Record<foundry.CONST.GridType, string>;
 
-  /**
-   * Get the available weather effect types which can be applied to this Scene
-   */
-  protected _getWeatherTypes(): Record<string, string>;
+    /**
+     * Get the available weather effect types which can be applied to this Scene
+     * @internal
+     */
+    protected _getWeatherTypes(): Record<string, string>;
 
-  /**
-   * Get the alphabetized entities which can be chosen as a configuration for the scene
-   */
-  protected _getEntities(collection: EntityCollection): { _id: string; name: string }[];
+    /**
+     * Get the alphabetized Documents which can be chosen as a configuration for the Scene
+     * @internal
+     */
+    protected _getDocuments(collection: WorldCollection<DocumentConstructor, string>): { _id: string; name: string }[];
 
-  /**
-   * @override
-   */
-  activateListeners(html: JQuery): void;
+    /** @override */
+    activateListeners(html: JQuery): void;
 
-  /**
-   * Capture the current Scene position and zoom level as the initial view in the Scene config
-   * @param event - The originating click event
-   */
-  protected _onCapturePosition(event: JQuery.ClickEvent): void;
+    /**
+     * Capture the current Scene position and zoom level as the initial view in the Scene config
+     * @param event - The originating click event
+     * @internal
+     */
+    protected _onCapturePosition(event: JQuery.ClickEvent): void;
 
-  /**
-   * @override
-   */
-  protected _onChangeRange(event: JQuery.ChangeEvent): void;
+    /** @override */
+    protected _onChangeRange(event: JQuery.ChangeEvent): void;
 
-  /**
-   * Handle click events to open the grid configuration application
-   * @param event - The originating click event
-   */
-  protected _onGridConfig(event: JQuery.ClickEvent): SceneConfig['minimize'];
+    /**
+     * Handle updating the select menu of PlaylistSound options when the Playlist is changed
+     * @param event - The initiating select change event
+     * @internal
+     */
+    _onChangePlaylist(event: JQuery.ChangeEvent): void;
 
-  /**
-   * @override
-   */
-  protected _updateObject(event: Event, formData: SceneConfig.FormData): Promise<Scene>;
-}
+    /**
+     * Handle click events to open the grid configuration application
+     * @param event - The originating click event
+     */
+    protected _onGridConfig(event: JQuery.ClickEvent): void;
+
+    /**
+     * @override
+     */
+    protected _updateObject(
+      event: Event,
+      formData: SceneConfig.FormData
+    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Scene'>> | undefined>;
+  }
+
+  namespace SceneConfig {
+    interface Data<Options extends DocumentSheet.Options = DocumentSheet.Options>
+      extends DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Scene'>>, Options> {
+      gridTypes: ReturnType<typeof SceneConfig['_getGridTypes']>;
+      weatherTypes: ReturnType<SceneConfig['_getWeatherTypes']>;
+      playlists: ReturnType<SceneConfig['_getDocuments']>;
+      sounds: ReturnType<SceneConfig['_getDocuments']>;
+      journals: ReturnType<SceneConfig['_getDocuments']>;
+      hasGlobalThreshold: boolean;
+      data: DocumentSheet.Data<InstanceType<ConfiguredDocumentClassForName<'Scene'>>, Options>['data'] & {
+        /**
+         * @defaultValue `0`
+         */
+        globalLightThreshold: number;
+      };
+    }
 
-declare namespace SceneConfig {
-  interface Data extends DocumentSheet.Data {
-    gridTypes: ReturnType<typeof SceneConfig['_getGridTypes']>;
-    weatherTypes: ReturnType<SceneConfig['_getWeatherTypes']>;
-    playlists: ReturnType<SceneConfig['_getEntities']>;
-    journals: ReturnType<SceneConfig['_getEntities']>;
-    hasGlobalThreshold: boolean;
-    document: DocumentSheet.Data['document'] & {
-      /**
-       * @defaultValue `0`
-       */
+    type FormData = {
+      backgroundColor: string;
+      darkness: number;
+      fogExploration: boolean;
+      foreground: string;
+      globalLight: boolean;
       globalLightThreshold: number;
+      grid: number | null;
+      gridAlpha: number;
+      gridColor: string;
+      gridDistance: number | null;
+      gridType: foundry.CONST.GridType;
+      gridUnits: string;
+      hasGlobalThreshold: boolean;
+      height: number | null;
+      img: string;
+      'initial.scale': number | null;
+      'initial.x': number | null;
+      'initial.y': number | null;
+      journal: string;
+      name: string;
+      navName: string;
+      navigation: boolean;
+      padding: number;
+      'permission.default': foundry.CONST.EntityPermission;
+      playlist: string;
+      shiftX: number | null;
+      shiftY: number | null;
+      tokenVision: boolean;
+      weather: string;
+      width: number | null;
     };
   }
-
-  type FormData = {
-    backgroundColor: Scene.Data['backgroundColor'];
-    darkness: Scene.Data['darkness'];
-    fogExploration: Scene.Data['fogExploration'];
-    globalLight: Scene.Data['globalLight'];
-    globalLightThreshold: Scene.Data['globalLightThreshold'];
-    grid: GridConfig.FormData['grid'];
-    gridAlpha: Scene.Data['gridAlpha'];
-    gridColor: Scene.Data['gridColor'];
-    gridDistance: Scene.Data['gridDistance'] | null;
-    gridType: foundry.CONST.GridType;
-    gridUnits: Scene.Data['gridUnits'];
-    hasGlobalThreshold: boolean;
-    height: Scene.Data['height'] | null;
-    img: Scene.Data['img'];
-    'initial.scale': number | null;
-    'initial.x': number | null;
-    'initial.y': number | null;
-    journal: Scene.Data['journal'];
-    name: string;
-    navName: Scene.Data['navName'];
-    navigation: Scene.Data['navigation'];
-    padding: Scene.Data['padding'];
-    'permission.default': Scene.Data['permission'];
-    playlist: Scene.Data['playlist'];
-    shiftX: GridConfig.FormData['shiftX'];
-    shiftY: GridConfig.FormData['shiftY'];
-    tokenVision: Scene.Data['tokenVision'];
-    weather: Scene.Data['weather'];
-    width: Scene.Data['width'] | null;
-  };
 }

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

@@ -1,112 +1,110 @@
-/**
- * Configuration sheet for the Drawing object
- * @typeParam P - the type of the options object
- */
-declare class DrawingConfig<P extends DrawingConfig.Options = DrawingConfig.Options> extends FormApplication<
-  P,
-  DrawingConfig.Data,
-  Drawing
-> {
-  /**
-   * @param drawing - The Drawing object being configured
-   * @param options - Additional application rendering options
-   */
-  constructor(drawing: Drawing, options?: Partial<P>);
+import type { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 
+declare global {
   /**
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   id: "drawing-config",
-   *   classes: ["sheet"],
-   *   template: "templates/scene/drawing-config.html",
-   *   width: 480,
-   *   height: 360,
-   *   configureDefault: false,
-   *   tabs: [{navSelector: ".tabs", contentSelector: "form", initial: "position"}]
-   * });
-   * ```
+   * The Application responsible for configuring a single Drawing document within a parent Scene.
+   * @typeParam Options - the type of the options object
+   * @typeParam Data    - The data structure used to render the handlebars template.
    */
-  static get defaultOptions(): DrawingConfig.Options;
+  class DrawingConfig<
+    Options extends DrawingConfig.Options = DrawingConfig.Options,
+    Data extends object = DrawingConfig.Data<Options>
+  > extends FormApplication<Options, Data, InstanceType<ConfiguredDocumentClassForName<'Drawing'>>> {
+    /**
+     * @defaultValue
+     * ```typescript
+     * foundry.utils.mergeObject(super.defaultOptions, {
+     *   id: "drawing-config",
+     *   classes: ["sheet"],
+     *   template: "templates/scene/drawing-config.html",
+     *   width: 480,
+     *   height: 360,
+     *   configureDefault: false,
+     *   tabs: [{ navSelector: ".tabs", contentSelector: "form", initial: "position" }],
+     * });
+     * ```
+     */
+    static get defaultOptions(): DrawingConfig.Options;
 
-  /** @override */
-  get title(): string;
+    /** @override */
+    get title(): string;
 
-  /**
-   * @param options - (unused)
-   * @override
-   */
-  getData(options?: Partial<P>): DrawingConfig.Data;
+    /** @override */
+    getData(options?: Partial<Options>): Data | Promise<Data>;
 
-  /**
-   * Get the names and labels of fill type choices which can be applied
-   */
-  protected static _getFillTypes(): DrawingConfig.FillTypes;
-
-  /**
-   * @param event - (unused)
-   * @override
-   */
-  protected _updateObject<F extends DrawingConfig.FormData>(
-    event: Event,
-    formData: F
-  ): Promise<this['options']['configureDefault'] extends true ? F : Drawing>;
+    /**
+     * Get the names and labels of fill type choices which can be applied
+     * @internal
+     */
+    protected static _getFillTypes(): DrawingConfig.FillTypes;
 
-  /** @override */
-  close(options?: FormApplication.CloseOptions): Promise<void>;
+    /** @override */
+    protected _updateObject(
+      event: Event,
+      formData: DrawingConfig.FormData
+    ): Promise<foundry.data.DrawingData['_source'] | ConfiguredDocumentClassForName<'Drawing'> | undefined>;
 
-  /** @override */
-  activateListeners(html: JQuery): void;
+    /** @override */
+    close(options?: FormApplication.CloseOptions): Promise<void>;
 
-  /**
-   * Reset the user Drawing configuration settings to their default values
-   */
-  protected _onResetDefaults(event: JQuery.ClickEvent): void;
-}
+    /** @override */
+    activateListeners(html: JQuery): void;
 
-declare namespace DrawingConfig {
-  interface Data {
-    author: string;
-    isDefault: Options['configureDefault'];
-    fillTypes: ReturnType<typeof DrawingConfig['_getFillTypes']>;
-    fontFamilies: Record<typeof CONFIG['fontFamilies'][number], typeof CONFIG['fontFamilies'][number]>;
-    object: DrawingConfig['object']['data'];
-    options: DrawingConfig['options'];
-    submitText: string;
+    /**
+     * Reset the user Drawing configuration settings to their default values
+     * @param event - The originating mouse-click event
+     */
+    protected _onResetDefaults(event: JQuery.ClickEvent): void;
   }
 
-  type FillTypes = {
-    [Key in keyof typeof foundry.CONST['DRAWING_FILL_TYPES'] as typeof foundry.CONST['DRAWING_FILL_TYPES'][Key]]: `DRAWING.FillType${Titlecase<Key>}`;
-  };
+  namespace DrawingConfig {
+    interface Data<Options extends DrawingConfig.Options = DrawingConfig.Options> {
+      author: string;
+      isDefault: boolean;
+      fillTypes: DrawingConfig.FillTypes;
+      fontFamilies: Record<string, string>;
+      object: foundry.data.DrawingData['_source'];
+      options: Options;
+      submitText: string;
+    }
 
-  interface FormData {
-    bezierFactor: foundry.data.DrawingData['_source']['bezierFactor'];
-    fillAlpha: foundry.data.DrawingData['_source']['fillAlpha'];
-    fillColor: foundry.data.DrawingData['_source']['fillColor'];
-    fillType: foundry.data.DrawingData['_source']['fillType'];
-    fontFamily: foundry.data.DrawingData['_source']['fontFamily'];
-    fontSize: foundry.data.DrawingData['_source']['fontSize'] | null;
-    height: foundry.data.DrawingData['_source']['height'] | null;
-    rotation: foundry.data.DrawingData['_source']['rotation'] | null;
-    strokeAlpha: foundry.data.DrawingData['_source']['strokeAlpha'];
-    strokeColor: foundry.data.DrawingData['_source']['strokeColor'];
-    strokeWidth: foundry.data.DrawingData['_source']['strokeWidth'] | null;
-    text: string;
-    textAlpha: foundry.data.DrawingData['_source']['textAlpha'];
-    textColor: foundry.data.DrawingData['_source']['textColor'];
-    texture: string;
-    width: foundry.data.DrawingData['_source']['width'] | null;
-    x: foundry.data.DrawingData['_source']['x'] | null;
-    y: foundry.data.DrawingData['_source']['y'] | null;
-    z: foundry.data.DrawingData['_source']['z'] | null;
-  }
+    type FillTypes = {
+      [Key in keyof typeof foundry.CONST['DRAWING_FILL_TYPES'] as typeof foundry.CONST['DRAWING_FILL_TYPES'][Key]]: `DRAWING.FillType${Titlecase<Key>}`;
+    };
 
-  interface Options extends FormApplication.Options {
-    configureDefault: boolean;
+    interface FormData {
+      bezierFactor: number;
+      fillAlpha: number;
+      fillColor: string;
+      fillType: foundry.CONST.DrawingFillType;
+      fontFamily: string;
+      fontSize: number | null;
+      height: number | null;
+      rotation: number | null;
+      strokeAlpha: number;
+      strokeColor: string;
+      strokeWidth: number | null;
+      text: string;
+      textAlpha: number;
+      textColor: string;
+      texture: string;
+      width: number | null;
+      x: number | null;
+      y: number | null;
+      z: number | null;
+    }
 
-    /**
-     * Configure a preview version of the Drawing which is not yet saved
-     */
-    preview?: boolean;
+    interface Options extends FormApplication.Options {
+      /**
+       * Configure the default drawing settings, instead of a specific Drawing
+       * @defaultValue `false`
+       */
+      configureDefault: boolean;
+
+      /**
+       * Configure a preview version of the Drawing which is not yet saved
+       */
+      preview?: boolean;
+    }
   }
 }