@league-of-foundry-developers/foundry-vtt-types 0.8.9-6 → 9.238.0

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

@@ -55,7 +55,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    *
    * @example <caption>A Document may belong to a Folder</caption>
    * ```typescript
-   * let folder = game.folders.entities[0];
+   * let folder = game.folders.contents[0];
    * let actor = await Actor.create({name: "New Actor", folder: folder.id});
    * console.log(actor.data.folder); // folder.id;
    * console.log(actor.folder); // folder;
@@ -86,7 +86,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
 
   /**
    * Return the permission level that the current game User has over this Document.
-   * See the CONST.ENTITY_PERMISSIONS object for an enumeration of these levels.
+   * See the CONST.DOCUMENT_PERMISSION_LEVELS object for an enumeration of these levels.
    *
    * @example
    * ```typescript
@@ -95,7 +95,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * actor.permission; // 2
    * ```
    */
-  get permission(): ValueOf<typeof CONST.ENTITY_PERMISSIONS>;
+  get permission(): ValueOf<typeof CONST.DOCUMENT_PERMISSION_LEVELS>;
 
   /**
    * Lazily obtain a FormApplication instance used to configure this Document, or null if no sheet is available.
@@ -133,7 +133,7 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
   /**
    * Prepare all embedded Document instances which exist within this primary Document.
    */
-  prepareEmbeddedEntities(): void;
+  prepareEmbeddedDocuments(): void;
 
   /**
    * Apply transformations or derivations to the values of the source data object.
@@ -273,18 +273,20 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * Choose a name and a type from a select menu of types.
    * @param data    - Initial data with which to populate the creation form
    *                  (default: `{}`)
-   * @param options - Positioning and sizing options for the resulting dialog
+   * @param context - Additional context options or dialog positioning options
    *                  (default: `{}`)
    * @returns A Promise which resolves to the created Document
    */
   static createDialog<T extends DocumentConstructor>(
     this: T,
-    data?: DeepPartial<
-      | ConstructorDataType<InstanceType<T>['data']>
-      | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
-    >,
-    options?: Dialog.Options
-  ): Promise<InstanceType<ConfiguredDocumentClass<T>> | undefined>;
+    data?:
+      | DeepPartial<
+          | ConstructorDataType<InstanceType<T>['data']>
+          | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
+        >
+      | undefined,
+    context?: (Pick<DocumentModificationContext, 'parent' | 'pack'> & Partial<Dialog.Options>) | undefined
+  ): Promise<InstanceType<ConfiguredDocumentClass<T>> | null | undefined>;
 
   /**
    * Present a Dialog form to confirm deletion of this Document.
@@ -292,18 +294,19 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    *                  (default: `{}`)
    * @returns A Promise which resolves to the deleted Document
    */
-  deleteDialog(options?: Dialog.Options): Promise<this | undefined>;
+  deleteDialog(options?: Partial<Dialog.Options> | undefined): Promise<this | false | null | undefined>;
 
   /**
-   * Export entity data to a JSON file which can be saved by the client and later imported into a different session.
+   * Export document data to a JSON file which can be saved by the client and later imported into a different session.
+   * @param options - Additional options passed to the {@link ClientDocumentMixin#toCompendium} method
    */
-  exportToJSON(): void;
+  exportToJSON(options?: CompendiumExportOptions): void;
 
   /**
    * A helper function to handle obtaining the relevant Document from dropped data provided via a DataTransfer event.
    * The dropped data could have:
    * 1. A compendium pack and entry id
-   * 2. A World Entity _id
+   * 2. A World Document _id
    * 3. A data object explicitly provided
    *
    * @param data    - The data object extracted from a DataTransfer event
@@ -332,104 +335,55 @@ export declare class ClientDocumentMixin<T extends foundry.abstract.Document<any
    * Transform the Document data to be stored in a Compendium pack.
    * Remove any features of the data which are world-specific.
    * This function is asynchronous in case any complex operations are required prior to exporting.
-   * @param pack - A specific pack being exported to
+   * @param pack    - A specific pack being exported to
+   *                  (unused)
+   * @param options - Additional options which modify how the document is converted
+   *                  (default: `{}`)
    * @returns A data object of cleaned data suitable for compendium import
    */
-  toCompendium(pack?: CompendiumCollection<CompendiumCollection.Metadata>): Omit<
-    T['data']['_source'],
-    '_id' | 'folder' | 'permission'
-  > & {
+  toCompendium(
+    pack?: CompendiumCollection<CompendiumCollection.Metadata> | null,
+    options?: CompendiumExportOptions
+  ): Omit<T['data']['_source'], '_id' | 'folder' | 'permission'> & {
     permission?: T['data']['_source']['permission'];
   };
 
   /**
-   * @deprecated since 0.8.0
-   */
-  get _id(): T['id'];
-
-  /**
-   * @deprecated since 0.8.0
-   */
-  static get config(): any;
-
-  /**
-   * @deprecated since 0.8.0
-   */
-  get entity(): T['documentName'];
-
-  /**
-   * @deprecated since 0.8.0
-   */
-  get owner(): this['isOwner'];
-
-  /**
-   * @deprecated since 0.8.0
-   */
-  hasPerm(
-    user: foundry.documents.BaseUser,
-    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.EntityPermission,
-    exact?: boolean
-  ): ReturnType<T['testUserPermission']>;
-
-  /**
-   * @deprecated since 0.8.0
+   * @deprecated since v9 - Use prepareEmbeddedDocuments instead.
    */
-  static update<T extends DocumentConstructor>(
-    this: T,
-    updates?:
-      | Array<
-          DeepPartial<
-            | ConstructorDataType<InstanceType<T>['data']>
-            | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
-          > & { _id: string }
-        >
-      | (DeepPartial<
-          | ConstructorDataType<InstanceType<T>['data']>
-          | (ConstructorDataType<InstanceType<T>['data']> & Record<string, unknown>)
-        > & { _id: string }),
-    options?: DocumentModificationContext & foundry.utils.MergeObjectOptions
-  ): Promise<InstanceType<ConfiguredDocumentClass<T>>[]>;
+  prepareEmbeddedEntities(): void;
+}
 
+interface CompendiumExportOptions {
   /**
-   * @deprecated since 0.8.0
+   * Clear the flags object
+   * @defaultValue `false`
    */
-  static delete<T extends DocumentConstructor>(
-    this: T,
-    ids?: string[],
-    options?: DocumentModificationContext
-  ): Promise<InstanceType<ConfiguredDocumentClass<T>>[]>;
+  clearFlags: boolean;
 
   /**
-   * @deprecated since 0.8.0
+   * Clear the currently assigned folder and sort order
+   * @defaultValue `true`
    */
-  getEmbeddedEntity(...args: Parameters<T['getEmbeddedDocument']>): ReturnType<T['getEmbeddedDocument']>;
+  clearSort: boolean;
 
   /**
-   * @deprecated since 0.8.0
+   * Clear document permissions
+   * @defaultValue `true`
    */
-  createEmbeddedEntity(
-    documentName: string,
-    data?: Record<string, unknown> | Array<Record<string, unknown>>,
-    options?: DocumentModificationContext
-  ): ReturnType<T['createEmbeddedDocuments']>;
+  clearPermissions: boolean;
 
   /**
-   * @deprecated since 0.8.0
+   * Clear fields which store document state
+   * @defaultValue `true`
    */
-  updateEmbeddedEntity(
-    documentName: string,
-    data?: Array<Record<string, unknown>> | Record<string, unknown>,
-    options?: DocumentModificationContext
-  ): ReturnType<T['updateEmbeddedDocuments']>;
+  clearState: boolean;
 
   /**
-   * @deprecated since 0.8.0
+   * Retain the current Document id
+   * @defaultValue `false`
    */
-  deleteEmbeddedEntity(
-    documentName: string,
-    ids: string[] | string,
-    options: DocumentModificationContext
-  ): ReturnType<T['deleteEmbeddedDocuments']>;
+  keepId: boolean;
 }
 
 interface SortOptions<T> {

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

@@ -1,5 +1,6 @@
+import { ConfiguredDocumentClass } from '../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../types/helperTypes';
+import type { ActiveEffectDataConstructorData } from '../../common/data/data.mjs/activeEffectData.js';
 import { EffectChangeData } from '../../common/data/data.mjs/effectChangeData';
 
 declare global {
@@ -133,7 +134,7 @@ declare global {
     protected _getSourceName(): Promise<string>;
 
     protected _preCreate(
-      data: ConstructorDataType<foundry.data.ActiveEffectData>,
+      data: ActiveEffectDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;

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

@@ -1,11 +1,7 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredObjectClassForName,
-  ConstructorDataType,
-  DocumentConstructor
-} from '../../../types/helperTypes';
+import { ConfiguredDocumentClass, ConfiguredObjectClassForName, DocumentConstructor } from '../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../common/abstract/document.mjs';
 import EmbeddedCollection from '../../common/abstract/embedded-collection.mjs';
+import type { ActorDataConstructorData } from '../../common/data/data.mjs/actorData.js';
 
 declare global {
   /**
@@ -170,7 +166,7 @@ declare global {
 
     /** @override */
     protected _preCreate(
-      data: ConstructorDataType<foundry.data.ActorData>,
+      data: ActorDataConstructorData,
       options: DocumentModificationOptions,
       user: foundry.documents.BaseUser
     ): Promise<void>;

package/src/foundry/foundry.js/clientDocuments/canvasDocuments/ambientSoundDocument.d.ts

@@ -6,9 +6,4 @@
  * @see {@link documents.Scene}                   The Scene document type which contains AmbientSound embedded documents
  * @see {@link applications.AmbientSoundConfig}   The AmbientSound configuration application
  */
-declare class AmbientSoundDocument extends CanvasDocumentMixin(foundry.documents.BaseAmbientSound) {
-  /**
-   * A convenience accessor for the sound type
-   */
-  get type(): foundry.data.AmbientSoundData['type'];
-}
+declare class AmbientSoundDocument extends CanvasDocumentMixin(foundry.documents.BaseAmbientSound) {}

package/src/foundry/foundry.js/clientDocuments/canvasDocuments/tokenDocument.d.ts

@@ -204,7 +204,7 @@ declare global {
     /**
      * Inspect the Actor data model and identify the set of attributes which could be used for a Token Bar
      */
-    static getTrackedAttributeChoices(attributes?: TrackedAttributes): Partial<Record<string, string[]>>;
+    static getTrackedAttributeChoices(attributes?: TrackedAttributes): Record<string, string[]>;
   }
 }
 

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

@@ -0,0 +1,133 @@
+import type { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../types/helperTypes';
+
+declare global {
+  /**
+   * The client-side Card document which extends the common BaseCard model.
+   * Each Card document contains CardData which defines its data schema.
+   *
+   * @see {@link data.CardData}                      The Card data schema
+   * @see {@link documents.Cards}                    The Cards document type which contains Card embedded documents
+   */
+  class Card extends ClientDocumentMixin(foundry.documents.BaseCard) {
+    /**
+     * The card back.
+     * This reference is cached and lazily evaluated to retrieve an image and name from the source deck.
+     */
+    get back(): foundry.data.CardFaceData;
+
+    /**
+     * @defaultValue `undefined`
+     * @internal
+     */
+    protected _back?: foundry.data.CardFaceData | undefined;
+
+    /**
+     * The current card face
+     */
+    get face(): foundry.data.CardFaceData | null;
+
+    /**
+     * The image used to depict the back of this card
+     */
+    get backImg(): string;
+
+    /**
+     * The image of the currently displayed card face or back
+     */
+    get img(): string;
+
+    /**
+     * The name of the current card face, or the name of the card itself
+     */
+    get name(): string;
+
+    /**
+     * A reference to the source Cards document which defines this Card.
+     */
+    get source(): InstanceType<ConfiguredDocumentClassForName<'Cards'>> | undefined | null;
+
+    /**
+     * A convenience property for whether or not the Card is within its source Cards stack.
+     */
+    get isHome(): boolean;
+
+    /**
+     * Whether or not to display the face of this card?
+     */
+    get showFace(): boolean;
+
+    /**
+     * Does this Card have a next face available to flip to?
+     */
+    get hasNextFace(): boolean;
+
+    /**
+     * Does this Card have a previous face available to flip to?
+     */
+    get hasPreviousFace(): boolean;
+
+    /** @override */
+    prepareDerivedData(): void;
+
+    /**
+     * Flip this card to some other face. A specific face may be requested, otherwise:
+     * If the card currently displays a face the card is flipped to the back.
+     * If the card currently displays the back it is flipped to the first face.
+     * @param face - A specific face to flip the card to
+     * @returns A reference to this card after the flip operation is complete
+     */
+    flip(face?: number | null | undefined): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
+
+    /**
+     * Pass this Card to some other Cards document.
+     * @param to      - A new Cards document this card should be passed to
+     * @param options - (default: `{}`)
+     * @returns A reference to this card after the it has been passed to another parent document
+     */
+    pass(
+      to: InstanceType<ConfiguredDocumentClassForName<'Cards'>>,
+      options?: Cards.PassOptions | undefined
+    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
+
+    /**
+     * Play a specific card to some other Cards document.
+     * This method is currently a more semantic alias for Card#pass.
+     * @see Card#pass
+     */
+    play(
+      to: InstanceType<ConfiguredDocumentClassForName<'Cards'>>,
+      options?: Cards.PassOptions | undefined
+    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
+
+    /**
+     * Discard a specific card to some other Cards document.
+     * This method is currently a more semantic alias for Card#pass.
+     * @see Card#pass
+     */
+    discard(
+      to: InstanceType<ConfiguredDocumentClassForName<'Cards'>>,
+      options?: Cards.PassOptions | undefined
+    ): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>> | undefined>;
+
+    /**
+     * Reset this Card to its original Cards parent.
+     * @param options - Options which modify the reset operation
+     *                  (default: `{}`)
+     * @returns A reference to the reset card belonging to its original parent
+     */
+    reset(options?: Cards.ResetOptions | undefined): Promise<InstanceType<ConfiguredDocumentClassForName<'Card'>>>;
+
+    /**
+     * Create a chat message which displays this Card.
+     * @param messageData - Additional data which becomes part of the created ChatMessageData
+     *                      (default: `{}`)
+     * @param options     - Options which modify the message creation operation
+     *                      (default: `{}`)
+     * @returns The created chat message
+     */
+    toMessage(
+      messageData?: ConstructorDataType<foundry.data.ChatMessageData> | undefined,
+      options?: DocumentModificationContext | undefined
+    ): Promise<InstanceType<ConfiguredDocumentClassForName<'ChatMessage'>> | undefined>;
+  }
+}