@league-of-foundry-developers/foundry-vtt-types 13.340.0 → 13.345.1-beta.20250704.94554

package/src/foundry/client/data/documents/scene.d.mts

@@ -1,264 +0,0 @@
-import type { InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseScene from "../../../common/documents/scene.d.mts";
-
-declare global {
-  namespace Scene {
-    type Metadata = Document.MetadataFor<Scene>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Scene">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Scene">;
-
-    /* eslint-disable @typescript-eslint/no-empty-object-type */
-    export interface DatabaseOperations
-      extends Document.Database.Operations<
-        Scene,
-        {},
-        { thumb: (string | null)[]; autoReposition: boolean; animateDarkness: number },
-        {}
-      > {}
-    /* eslint-enable @typescript-eslint/no-empty-object-type */
-
-    // Helpful aliases
-    type ConstructorData = BaseScene.ConstructorData;
-    type UpdateData = BaseScene.UpdateData;
-    type Schema = BaseScene.Schema;
-    type Source = BaseScene.Source;
-  }
-
-  /**
-   * The client-side Scene document which extends the common BaseScene model.
-   *
-   * @see {@link Scenes}            The world-level collection of Scene documents
-   * @see {@link SceneConfig}       The Scene configuration application
-   *
-   */
-  class Scene extends ClientDocumentMixin(foundry.documents.BaseScene) {
-    static override metadata: Scene.Metadata;
-
-    static get implementation(): Scene.ConfiguredClass;
-
-    /**
-     * Track the viewed position of each scene (while in memory only, not persisted)
-     * When switching back to a previously viewed scene, we can automatically pan to the previous position.
-     * @defaultValue `{}`
-     * @remarks This is intentionally public because it is used in Canvas._initializeCanvasPosition() and Canvas.pan()
-     */
-    _viewPosition: Canvas.ViewPosition;
-
-    /**
-     * Track whether the scene is the active view
-     */
-    protected _view: this["active"];
-
-    /**
-     * The grid instance
-     */
-    grid: foundry.grid.BaseGrid;
-
-    /**
-     * Determine the canvas dimensions this Scene would occupy, if rendered
-     * @defaultValue `{}`
-     */
-    dimensions: ReturnType<this["getDimensions"]>;
-
-    /**
-     * Provide a thumbnail image path used to represent this document.
-     */
-    get thumbnail(): this["thumb"];
-
-    /**
-     * A convenience accessor for whether the Scene is currently viewed
-     */
-    get isView(): boolean;
-
-    /**
-     * Set this scene as currently active
-     * @returns A Promise which resolves to the current scene once it has been successfully activated
-     */
-    activate(): Promise<this | undefined>;
-
-    /**
-     * Set this scene as the current view
-     */
-    view(): Promise<this | undefined>;
-
-    /**
-     * @param createData - (default: `{}`)
-     * @param options    - (default: `{}`)
-     */
-    override clone<Save extends boolean = false>(
-      createData?: foundry.documents.BaseScene.ConstructorData,
-      context?: InexactPartial<
-        {
-          /**
-           * Save the clone to the World database?
-           * @defaultValue `false`
-           */
-          save: Save;
-
-          /**
-           * Keep the same ID of the original document
-           * @defaultValue `false`
-           */
-          keepId: boolean;
-        } & Document.ConstructionContext<this["parent"]>
-      >,
-    ): Save extends true ? Promise<this> : this;
-
-    override reset(): void;
-
-    override prepareBaseData(): void;
-
-    /**
-     * Get the Canvas dimensions which would be used to display this Scene.
-     * Apply padding to enlarge the playable space and round to the nearest 2x grid size to ensure symmetry.
-     * The rounding accomplishes that the padding buffer around the map always contains whole grid spaces.
-     */
-    getDimensions(): SceneDimensions;
-
-    override _onClickDocumentLink(event: MouseEvent): unknown;
-
-    /**
-     * @privateRemarks _onCreate, _preUpdate, _onUpdate, _preDelete, and _onDelete are all overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-
-    /**
-     * Handle repositioning of placed objects when the Scene dimensions change
-     */
-    protected _repositionObject(
-      sceneUpdateData: foundry.documents.BaseScene.ConstructorData,
-    ): foundry.documents.BaseScene.ConstructorData;
-
-    /**
-     * Handle Scene activation workflow if the active state is changed to true
-     * @param active - Is the scene now active?
-     */
-    protected _onActivate(active: boolean): ReturnType<this["view"]> | ReturnType<Canvas["draw"]>;
-
-    /**
-     * @privateRemarks _preCreateDescendantDocuments, _preUpdateDescendantDocuments, _preDeleteDescendantDocuments, and_onUpdateDescendantDocuments are all overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-
-    override toCompendium<
-      FlagsOpt extends boolean = false,
-      SourceOpt extends boolean = true,
-      SortOpt extends boolean = true,
-      FolderOpt extends boolean = false,
-      OwnershipOpt extends boolean = false,
-      StateOpt extends boolean = true,
-      IdOpt extends boolean = false,
-    >(
-      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-      options?: InexactPartial<
-        ClientDocument.CompendiumExportOptions<FlagsOpt, SourceOpt, SortOpt, FolderOpt, OwnershipOpt, StateOpt, IdOpt>
-      >,
-    ): Omit<
-      this["_source"],
-      | (IdOpt extends false ? "_id" : never)
-      | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
-      | ClientDocument.OmitProperty<FolderOpt, "folder">
-      | ClientDocument.OmitProperty<FlagsOpt, "flags">
-      | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
-      | ClientDocument.OmitProperty<StateOpt, "active" | "fogReset" | "playing">
-    >;
-
-    /**
-     * Create a 300px by 100px thumbnail image for this scene background
-     * @param data - (default: `{}`)
-     * @returns The created thumbnail data.
-     */
-    createThumbnail(data?: ThumbnailCreationData): ReturnType<typeof ImageHelper.createThumbnail>;
-  }
-
-  interface SceneDimensions {
-    /** The width of the canvas. */
-    width: number;
-
-    /** The height of the canvas. */
-    height: number;
-
-    /** The grid size. */
-    size: number;
-
-    /** The canvas rectangle. */
-    rect: Canvas.Rectangle;
-
-    /** The X coordinate of the scene rectangle within the larger canvas. */
-    sceneX: number;
-
-    /** The Y coordinate of the scene rectangle within the larger canvas. */
-    sceneY: number;
-
-    /** The width of the scene. */
-    sceneWidth: number;
-
-    /** The height of the scene. */
-    sceneHeight: number;
-
-    /** The scene rectangle. */
-    sceneRect: Canvas.Rectangle;
-
-    /** The number of distance units in a single grid space. */
-    distance: number;
-
-    /** The factor to convert distance units to pixels */
-    distancePixels: number;
-
-    /** The units of distance */
-    units: string;
-
-    /** The aspect ratio of the scene rectangle. */
-    ratio: number;
-
-    /** The length of the longest line that can be drawn on the canvas. */
-    maxR: number;
-
-    /** The number of grid rows on the canvas */
-    rows: number;
-
-    /** The number of grid columns on the canvas */
-    columns: number;
-  }
-}
-
-interface _ThumbnailCreationData extends ImageHelper.TextureToImageOptions {
-  /**
-   * A background image to use for thumbnail creation, otherwise the current scene
-   * background is used.
-   *
-   * @remarks This cannot be `null` because Foundry writes `const newImage = img !== undefined;`.
-   */
-  img: string;
-
-  /**
-   * The desired thumbnail width. Default is 300px
-   * @defaultValue `300`
-   */
-  width: number | null;
-
-  /**
-   * The desired thumbnail height. Default is 100px;
-   * @defaultValue `100`
-   */
-  height: number | null;
-
-  /**
-   * Which image format should be used? image/png, image/jpeg, or image/webp
-   * @defaultValue `"image/webp"`
-   *
-   * @remarks Foundry writes `image/jpg` but this functions the same as `image/png  `.
-   * The correct MIME type is `image/jpeg`.
-   */
-  format: ImageHelper.Format | null;
-
-  /**
-   * What compression quality should be used for jpeg or webp, between 0 and 1
-   * @defaultValue `0.8`
-   */
-  quality: number | null;
-}
-
-interface ThumbnailCreationData extends InexactPartial<_ThumbnailCreationData> {}

package/src/foundry/client/data/documents/setting.d.mts

@@ -1,55 +0,0 @@
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseSetting from "../../../common/documents/setting.d.mts";
-
-declare global {
-  namespace Setting {
-    type Metadata = Document.MetadataFor<Setting>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"Setting">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"Setting">;
-
-    interface DatabaseOperations extends Document.Database.Operations<Setting> {}
-
-    // Helpful aliases
-    type ConstructorData = BaseSetting.ConstructorData;
-    type UpdateData = BaseSetting.UpdateData;
-    type Schema = BaseSetting.Schema;
-    type Source = BaseSetting.Source;
-  }
-
-  /**
-   * The client-side Setting document which extends the common BaseSetting model.
-   *
-   * @see {@link WorldSettings}       The world-level collection of Setting documents
-   */
-  class Setting extends ClientDocumentMixin(foundry.documents.BaseSetting) {
-    static override metadata: Setting.Metadata;
-
-    static get implementation(): Setting.ConfiguredClass;
-
-    /**
-     * @privateRemarks This exists to let ts know that this class has a private property
-     */
-    static #PRIMITIVE_TYPES: any;
-
-    /**
-     * The setting configuration for this setting document.
-     */
-    get config(): SettingsConfig | undefined;
-
-    // TODO: This is the same as `DataModel._initialize`
-    protected _initialize(options?: any): void;
-
-    /**
-     * @privateRemarks _onCreate and _preUpdate are overridden but with no signature changes.
-     * For type simplicity they are left off. These methods historically have been the source of a large amount of computation from tsc.
-     */
-
-    /**
-     * Cast the value of the Setting into its defined type.
-     * @returns The initialized type of the Setting document.
-     */
-    // TODO: This could probably be derived
-    protected _castType(): any;
-  }
-}

package/src/foundry/client/data/documents/table-result.d.mts

@@ -1,42 +0,0 @@
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseTableResult from "../../../common/documents/table-result.d.mts";
-
-declare global {
-  namespace TableResult {
-    type Metadata = Document.MetadataFor<TableResult>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"TableResult">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"TableResult">;
-
-    interface DatabaseOperations extends Document.Database.Operations<TableResult> {}
-
-    // Helpful aliases
-    type TypeNames = BaseTableResult.TypeNames;
-    type ConstructorData = BaseTableResult.ConstructorData;
-    type UpdateData = BaseTableResult.UpdateData;
-    type Schema = BaseTableResult.Schema;
-    type Source = BaseTableResult.Source;
-  }
-
-  /**
-   * The client-side TableResult document which extends the common BaseTableResult model.
-   *
-   * @see {@link RollTable}         The RollTable document which contains TableResult embedded documents
-   */
-  class TableResult extends ClientDocumentMixin(foundry.documents.BaseTableResult) {
-    static override metadata: TableResult.Metadata;
-
-    static get implementation(): TableResult.ConfiguredClass;
-
-    /**
-     * A path reference to the icon image used to represent this result
-     */
-    get icon(): string;
-
-    /**
-     * Prepare a string representation for the result which (if possible) will be a dynamic link or otherwise plain text
-     * @returns The text to display
-     */
-    getChatText(): string;
-  }
-}

package/src/foundry/client/data/documents/table.d.mts

@@ -1,322 +0,0 @@
-import type { InexactPartial } from "fvtt-types/utils";
-import type Document from "../../../common/abstract/document.d.mts";
-import type BaseRollTable from "../../../common/documents/roll-table.d.mts";
-
-declare global {
-  namespace RollTable {
-    type Metadata = Document.MetadataFor<RollTable>;
-
-    type ConfiguredClass = Document.ConfiguredClassForName<"RollTable">;
-    type ConfiguredInstance = Document.ConfiguredInstanceForName<"RollTable">;
-
-    interface DatabaseOperations extends Document.Database.Operations<RollTable> {}
-
-    // Helpful aliases
-    type ConstructorData = BaseRollTable.ConstructorData;
-    type UpdateData = BaseRollTable.UpdateData;
-    type Schema = BaseRollTable.Schema;
-    type Source = BaseRollTable.Source;
-
-    /**
-     * Optional arguments which customize the draw
-     */
-    interface DrawOptions {
-      /**
-       * An existing Roll instance to use for drawing from the table
-       */
-      roll: Roll;
-
-      /**
-       * Allow drawing recursively from inner RollTable results
-       * @defaultValue `true`
-       */
-      recursive: boolean;
-
-      /**
-       * One or more table results which have been drawn
-       * @defaultValue `[]`
-       */
-      results: TableResult[];
-
-      /**
-       * Whether to automatically display the results in chat
-       * @defaultValue `true`
-       */
-      displayChat: boolean;
-
-      /**
-       * The chat roll mode to use when displaying the result
-       */
-      rollMode: keyof CONFIG.Dice.RollModes | "roll";
-    }
-
-    /**
-     * Additional options which modify message creation
-     */
-    interface ToMessageOptions {
-      /**
-       * An optional Roll instance which produced the drawn results
-       */
-      roll: Roll | null;
-
-      /**
-       * Additional data which customizes the created messages
-       * @defaultValue `{}`
-       */
-      messageData: ConstructorParameters<typeof foundry.documents.BaseChatMessage>[0];
-
-      /**
-       * Additional options which customize the created messages
-       * @defaultValue `{}`
-       */
-      messageOptions: Document.OnCreateOptions<"ChatMessage">;
-    }
-
-    interface RollOptions {
-      /**
-       * An alternative dice Roll to use instead of the default table formula
-       */
-      roll?: Roll;
-
-      /**
-       * If a RollTable document is drawn as a result, recursively roll it
-       * @defaultValue `true`
-       */
-      recursive?: boolean;
-
-      /**
-       * An internal flag used to track recursion depth
-       * @defaultValue `0`
-       */
-      _depth?: number;
-    }
-
-    interface RollTableHTMLEmbedConfig extends TextEditor.DocumentHTMLEmbedConfig {
-      /**
-       * Adds a button allowing the table to be rolled directly from its embedded context.
-       * Default: `false`
-       */
-      rollable?: boolean | undefined;
-    }
-  }
-
-  /**
-   * The client-side RollTable document which extends the common BaseRollTable model.
-   *
-   * @see {@link RollTables}         The world-level collection of RollTable documents
-   * @see {@link TableResult}        The embedded TableResult document
-   * @see {@link RollTableConfig}    The RollTable configuration application
-   */
-  class RollTable extends ClientDocumentMixin(foundry.documents.BaseRollTable) {
-    static override metadata: RollTable.Metadata;
-
-    static get implementation(): RollTable.ConfiguredClass;
-
-    /**
-     * Provide a thumbnail image path used to represent this document.
-     */
-    get thumbnail(): this["img"];
-
-    /**
-     * Display a result drawn from a RollTable in the Chat Log along.
-     * Optionally also display the Roll which produced the result and configure aspects of the displayed messages.
-     *
-     * @param results - An Array of one or more TableResult Documents which were drawn and should be displayed
-     * @param options - Additional options which modify message creation
-     */
-    toMessage(
-      results: TableResult.ConfiguredInstance[],
-      options?: InexactPartial<RollTable.ToMessageOptions>,
-    ): Promise<ChatMessage.ConfiguredInstance | undefined>;
-
-    /**
-     * Draw a result from the RollTable based on the table formula or a provided Roll instance
-     * @param options - Optional arguments which customize the draw behavior
-     * @returns A Promise which resolves to an object containing the executed roll and the produced results
-     */
-    draw(options?: RollTable.DrawOptions): Promise<RollTableDraw>;
-
-    /**
-     * Draw multiple results from a RollTable, constructing a final synthetic Roll as a dice pool of inner rolls.
-     * @param number  - The number of results to draw
-     * @param options - Optional arguments which customize the draw
-     * @returns The drawn results
-     */
-    drawMany(number: number, options?: InexactPartial<RollTable.DrawOptions>): Promise<RollTableDraw>;
-
-    /**
-     * Normalize the probabilities of rolling each item in the RollTable based on their assigned weights
-     */
-    normalize(): Promise<this | undefined>;
-
-    /**
-     * Reset the state of the RollTable to return any drawn items to the table
-     * @remarks Actually, returns list of TableEntries updated, not the RollTable.
-     * As written, it force updates all records, not just the ones already drawn.
-     */
-    resetResults(): Promise<TableResult.ConfiguredInstance[]>;
-
-    /**
-     * Evaluate a RollTable by rolling its formula and retrieving a drawn result.
-     *
-     * Note that this function only performs the roll and identifies the result, the RollTable#draw function should be
-     * called to formalize the draw from the table.
-     *
-     * @param options - Options which modify rolling behavior
-     *                  (default: `{}`)
-     * @returns The Roll and results drawn by that Roll
-     *
-     * @example
-     * ```typescript
-     * // Draw results using the default table formula
-     * const defaultResults = await table.roll();
-     *
-     * // Draw results using a custom roll formula
-     * const roll = new Roll("1d20 + @abilities.wis.mod", actor.getRollData());
-     * const customResults = await table.roll({roll});
-     * ```
-     */
-    roll(options?: RollTable.RollOptions): Promise<RollTableDraw>;
-
-    /**
-     * Handle a roll from within embedded content.
-     * @param event - The originating event.
-     */
-    protected _rollFromEmbeddedHTML(event: PointerEvent): Promise<void>;
-
-    /**
-     * Get an Array of valid results for a given rolled total
-     * @param value - The rolled value
-     * @returns An Array of results
-     */
-    getResultsForRoll(value: number): TableResult.ConfiguredInstance[];
-
-    /**
-     * Create embedded roll table markup.
-     * @param config  - Configuration for embedding behavior.
-     * @param options - The original enrichment options for cases where the Document embed content
-     *                  also contains text that must be enriched.
-     *
-     * @example Embed the content of a Roll Table as a figure.
-     * ```
-     * @Embed[RollTable.kRfycm1iY3XCvP8c]
-     * ```
-     * becomes
-     * ```html
-     * <figure class="content-embed" data-content-embed data-uuid="RollTable.kRfycm1iY3XCvP8c" data-id="kRfycm1iY3XCvP8c">
-     *   <table class="roll-table-embed">
-     *     <thead>
-     *       <tr>
-     *         <th>Roll</th>
-     *         <th>Result</th>
-     *       </tr>
-     *     </thead>
-     *     <tbody>
-     *       <tr>
-     *         <td>1&mdash;10</td>
-     *         <td>
-     *           <a class="inline-roll roll" data-mode="roll" data-formula="1d6">
-     *             <i class="fas fa-dice-d20"></i>
-     *             1d6
-     *           </a>
-     *           Orcs attack!
-     *         </td>
-     *       </tr>
-     *       <tr>
-     *         <td>11&mdash;20</td>
-     *         <td>No encounter</td>
-     *       </tr>
-     *     </tbody>
-     *   </table>
-     *   <figcaption>
-     *     <div class="embed-caption">
-     *       <p>This is the Roll Table description.</p>
-     *     </div>
-     *     <cite>
-     *       <a class="content-link" data-link data-uuid="RollTable.kRfycm1iY3XCvP8c" data-id="kRfycm1iY3XCvP8c"
-     *          data-type="RollTable" data-tooltip="Rollable Table">
-     *         <i class="fas fa-th-list"></i>
-     *         Rollable Table
-     *     </cite>
-     *   </figcaption>
-     * </figure>
-     * ```
-     */
-    protected _buildEmbedHTML(
-      config: TextEditor.DocumentHTMLEmbedConfig & { rollable: boolean },
-      options?: TextEditor.EnrichmentOptions,
-    ): Promise<HTMLElement | null>;
-
-    protected override _createFigureEmbed(
-      content: HTMLElement | HTMLCollection,
-      config: TextEditor.DocumentHTMLEmbedConfig,
-      options?: TextEditor.EnrichmentOptions,
-    ): Promise<HTMLElement | null>;
-
-    protected override _onCreateDescendantDocuments(
-      parent: ClientDocument,
-      collection: string,
-      documents: ClientDocument[],
-      data: unknown[],
-      options: Document.OnCreateOptions<"TableResult">,
-      userId: string,
-    ): void;
-
-    protected override _onDeleteDescendantDocuments(
-      parent: ClientDocument,
-      collection: string,
-      documents: ClientDocument[],
-      ids: string[],
-      options: Document.OnDeleteOptions<"TableResult">,
-      userId: string,
-    ): void;
-
-    override toCompendium<
-      FlagsOpt extends boolean = false,
-      SourceOpt extends boolean = true,
-      SortOpt extends boolean = true,
-      FolderOpt extends boolean = false,
-      OwnershipOpt extends boolean = false,
-      StateOpt extends boolean = true,
-      IdOpt extends boolean = false,
-    >(
-      pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
-      options?: InexactPartial<
-        ClientDocument.CompendiumExportOptions<FlagsOpt, SourceOpt, SortOpt, FolderOpt, OwnershipOpt, StateOpt, IdOpt>
-      >,
-    ): Omit<
-      this["_source"],
-      | (IdOpt extends false ? "_id" : never)
-      | ClientDocument.OmitProperty<SortOpt, "sort" | "navigation" | "navOrder">
-      | ClientDocument.OmitProperty<FolderOpt, "folder">
-      | ClientDocument.OmitProperty<FlagsOpt, "flags">
-      | ClientDocument.OmitProperty<OwnershipOpt, "ownership">
-      | ClientDocument.OmitProperty<StateOpt, "active" | "fogReset" | "playing"> // does not model the results.drawn = false
-    >;
-
-    /**
-     * Create a new RollTable document using all of the Documents from a specific Folder as new results.
-     * @param folder  - The Folder document from which to create a roll table
-     * @param options - Additional options passed to the RollTable.create method
-     */
-    static fromFolder(
-      folder: Folder,
-      options?: Document.OnCreateOptions<"Folder">,
-    ): Promise<RollTable.ConfiguredInstance | undefined>;
-  }
-
-  /**
-   * An object containing the executed Roll and the produced results
-   */
-  interface RollTableDraw {
-    /**
-     * The Dice roll which generated the draw
-     */
-    roll: Roll;
-
-    /**
-     * An array of drawn TableResult documents
-     */
-    results: Document.ToConfiguredInstance<typeof foundry.documents.BaseTableResult>[];
-  }
-}