@league-of-foundry-developers/foundry-vtt-types 9.280.1 → 12.331.1-beta

package/src/foundry/client/data/abstract/document-collection.d.ts

@@ -1,192 +0,0 @@
-import { ConfiguredDocumentClass, DocumentConstructor } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
-
-declare global {
-  /**
-   * An abstract subclass of the Collection container which defines a collection of Document instances.
-   */
-  abstract class DocumentCollection<T extends DocumentConstructor, Name extends string> extends foundry.utils
-    .Collection<StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>> {
-    constructor();
-
-    /**
-     * An Array of application references which will be automatically updated when the collection content changes
-     * @defaultValue `[]`
-     */
-    apps: Application[];
-
-    /**
-     * The Collection class name
-     */
-    get name(): Name;
-
-    /**
-     * A reference to the Document class definition which is contained within this DocumentCollection.
-     */
-    get documentClass(): ConfiguredDocumentClass<T>;
-
-    /**
-     * A reference to the named Document class which is contained within this DocumentCollection.
-     * @remarks This accessor is abstract: A subclass of DocumentCollection must implement the documentName getter
-     */
-    get documentName(): ConfiguredDocumentClass<T>['metadata']['name'];
-
-    /**
-     * @remarks The parameter `id` is ignored, instead `document.id` is used as the key.
-     */
-    set(id: string, document: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>): this;
-
-    /**
-     * Render any Applications associated with this DocumentCollection.
-     */
-    render(force?: boolean, options?: ApplicationOptions): void;
-
-    /**
-     * Update all objects in this DocumentCollection with a provided transformation.
-     * Conditionally filter to only apply to Entities which match a certain condition.
-     * @param transformation - An object of data or function to apply to all matched objects
-     * @param condition      - A function which tests whether to target each object
-     *                         (default: `null`)
-     * @param options        - Additional options passed to Document.update
-     *                         (default: `{}`)
-     * @returns An array of updated data once the operation is complete
-     */
-    updateAll(
-      transformation:
-        | DeepPartial<InstanceType<ConfiguredDocumentClass<T>>['data']['_source']>
-        | ((
-            doc: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>
-          ) => DeepPartial<InstanceType<ConfiguredDocumentClass<T>>['data']['_source']>),
-      condition?: ((obj: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>) => boolean) | null,
-      options?: DocumentModificationContext
-    ): ReturnType<this['documentClass']['updateDocuments']>;
-
-    /**
-     * Preliminary actions taken before a set of Documents in this Collection are created.
-     * @param result  - An Array of created data objects
-     * @param options - Options which modified the creation operation
-     * @param userId  - The ID of the User who triggered the operation
-     */
-    protected _preCreateDocuments(
-      result: (InstanceType<T>['data']['_source'] & { _id: string })[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    /**
-     * Follow-up actions taken after a set of Documents in this Collection are created.
-     * @param documents - An Array of created Documents
-     * @param result    - An Array of created data objects
-     * @param options   - Options which modified the creation operation
-     * @param userId    - The ID of the User who triggered the operation
-     */
-    protected _onCreateDocuments(
-      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      result: (InstanceType<T>['data']['_source'] & { _id: string })[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    /**
-     * Preliminary actions taken before a set of Documents in this Collection are updated.
-     * @param result  - An Array of incremental data objects
-     * @param options - Options which modified the update operation
-     * @param userId  - The ID of the User who triggered the operation
-     */
-    protected _preUpdateDocuments(
-      result: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    /**
-     * Follow-up actions taken after a set of Documents in this Collection are updated.
-     * @param documents - An Array of updated Documents
-     * @param result    - An Array of incremental data objects
-     * @param options   - Options which modified the update operation
-     * @param userId    - The ID of the User who triggered the operation
-     */
-    protected _onUpdateDocuments(
-      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      result: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    /**
-     * Preliminary actions taken before a set of Documents in this Collection are deleted.
-     * @param result  - An Array of document IDs being deleted
-     * @param options - Options which modified the deletion operation
-     * @param userId  - The ID of the User who triggered the operation
-     */
-    protected _preDeleteDocuments(result: string[], options: DocumentModificationOptions, userId: string): void;
-
-    /**
-     * Follow-up actions taken after a set of Documents in this Collection are deleted.
-     * @param documents - An Array of deleted Documents
-     * @param result    - An Array of document IDs being deleted
-     * @param options   - Options which modified the deletion operation
-     * @param userId    - The ID of the User who triggered the operation
-     */
-    protected _onDeleteDocuments(
-      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      result: string[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    /**
-     * Generate the render context information provided for CRUD operations.
-     * @param action    - The CRUD operation.
-     * @param documents - The documents being operated on.
-     * @param data      - An array of creation or update objects, or an array of document IDs, depending on
-     *                    the operation.
-     * @internal
-     */
-    protected _getRenderContext(
-      action: DocumentCollection.RenderContext.Create<T>['action'],
-      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      data: (InstanceType<T>['data']['_source'] & { _id: string })[]
-    ): DocumentCollection.RenderContext.Create<T>;
-    protected _getRenderContext(
-      action: DocumentCollection.RenderContext.Update<T>['action'],
-      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      data: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[]
-    ): DocumentCollection.RenderContext.Update<T>;
-    protected _getRenderContext(
-      action: DocumentCollection.RenderContext.Delete<T>['action'],
-      documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[],
-      data: string[]
-    ): DocumentCollection.RenderContext.Delete<T>;
-  }
-
-  namespace DocumentCollection {
-    namespace RenderContext {
-      interface Base<T extends DocumentConstructor> {
-        documentType: T['metadata']['name'];
-        documents: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>[];
-
-        /** @deprecated The 'entities' render context is deprecated. Please use 'documents' instead. */
-        get entities(): this['documents'];
-
-        /** @deprecated The 'entityType' render context is deprecated. Please use 'documentType' instead. */
-        get entityType(): this['documentType'];
-      }
-
-      interface Create<T extends DocumentConstructor> extends Base<T> {
-        action: 'create';
-        data: (InstanceType<T>['data']['_source'] & { _id: string })[];
-      }
-
-      interface Update<T extends DocumentConstructor> extends Base<T> {
-        action: 'update';
-        data: (DeepPartial<InstanceType<T>['data']['_source']> & { _id: string })[];
-      }
-
-      interface Delete<T extends DocumentConstructor> extends Base<T> {
-        action: 'delete';
-        data: string[];
-      }
-    }
-  }
-}

package/src/foundry/client/data/abstract/index.d.ts

@@ -1,5 +0,0 @@
-import './canvas-document';
-import './client-backend';
-import './client-document';
-import './document-collection';
-import './world-collection';

package/src/foundry/client/data/abstract/world-collection.d.ts

@@ -1,167 +0,0 @@
-import { ConfiguredDocumentClass, DocumentConstructor } from '../../../../types/helperTypes';
-import type { DOCUMENT_TYPES } from '../../../common/constants.mjs.js';
-
-declare global {
-  /**
-   * A collection of world-level Document objects with a singleton instance per primary Document type.
-   * Each primary Document type has an associated subclass of WorldCollection which contains them.
-   * @see {@link Game#collections}
-   */
-  abstract class WorldCollection<T extends DocumentConstructor, Name extends string> extends DocumentCollection<
-    T,
-    Name
-  > {
-    /**
-     *
-     * @param data - An array of data objects from which to create Document instances
-     *               (default: `[]`)
-     */
-    constructor(data?: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>['data']['_source'][]);
-
-    readonly _source: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>['data']['_source'][];
-
-    /**
-     * Initialize the WorldCollection object by constructing its contained Document instances
-     * @internal
-     */
-    protected _initialize(): void;
-
-    /**
-     * @remarks In the abstract {@link WorldCollection}, this actually returns `null` but all deriving classes implement it properly.
-     */
-    get documentName(): ConfiguredDocumentClass<T>['metadata']['name'];
-
-    /**
-     * The base Document type which is contained within this WorldCollection
-     * @defaultValue `null`
-     * @remarks
-     * All deriving classes must set this to the string matching the name of the document type they contain because it
-     * is used as value for {@link WorldCollection#documentName}.
-     */
-    static documentName: string | null;
-
-    /**
-     * Return a reference to the SidebarDirectory application for this WorldCollection.
-     * @remarks
-     * In the case where `Lowercase<Name>` is not a property of {@link ui}, this actually always returns `undefined`,
-     * but {@link RollTables} overrides this, so we need to allow a wider return type.
-     */
-    get directory(): Lowercase<Name> extends keyof typeof ui
-      ? typeof ui[Lowercase<Name>]
-      :
-          | (ConfiguredDocumentClass<T>['metadata']['name'] extends DOCUMENT_TYPES
-              ? SidebarDirectory<ConfiguredDocumentClass<T>['metadata']['name']>
-              : never)
-          | SidebarTab
-          | undefined;
-
-    /**
-     * Return a reference to the singleton instance of this WorldCollection, or null if it has not yet been created.
-     */
-    static get instance(): WorldCollection<DocumentConstructor, any>; // TODO: Find a way to type this more concretely. One option would be to separate the static and non static side of this class, which allows accessing the the static this type to use the `documentName`.
-
-    override set(id: string, document: StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>): this;
-
-    delete: (id: string) => boolean;
-
-    /**
-     * Import a Document from a Compendium collection, adding it to the current World.
-     * @param pack       - The CompendiumCollection instance from which to import
-     * @param id         - The ID of the compendium entry to import
-     * @param updateData - Optional additional data used to modify the imported Document before it is created
-     *                     (default: `{}`)
-     * @param options    - Optional arguments passed to the {@link WorldCollection#fromCompendium} and {@link Document.create} methods
-     *                     (default: `{}`)
-     * @returns The imported Document instance
-     */
-    importFromCompendium(
-      pack: CompendiumCollection<
-        CompendiumCollection.Metadata & { type: ConfiguredDocumentClass<T>['metadata']['name'] }
-      >,
-      id: string,
-      updateData?: DeepPartial<InstanceType<ConfiguredDocumentClass<T>>['data']['_source']> | undefined,
-      options?: (DocumentModificationContext & WorldCollection.FromCompendiumOptions) | undefined
-    ): Promise<StoredDocument<InstanceType<ConfiguredDocumentClass<T>>>>;
-
-    /**
-     * Apply data transformations when importing a Document from a Compendium pack
-     * @param document - The source Document, or a plain data object
-     * @param options  - Additional options which modify how the document is imported
-     *                   (default: `{}`)
-     * @returns The processed data ready for world Document creation
-     */
-    fromCompendium(
-      document: InstanceType<ConfiguredDocumentClass<T>> | InstanceType<ConfiguredDocumentClass<T>>['data']['_source'],
-      options?: WorldCollection.FromCompendiumOptions | undefined
-    ): Omit<InstanceType<ConfiguredDocumentClass<T>>['data']['_source'], '_id' | 'folder'>;
-
-    /**
-     * Prepare a document from an outside source for import into this collection.
-     * @param data - The data to be prepared.
-     * @returns The prepared data.
-     */
-    prepareForImport(
-      data: InstanceType<ConfiguredDocumentClass<T>>['data']['_source']
-    ): Omit<InstanceType<ConfiguredDocumentClass<T>>['data']['_source'], '_id' | 'folder'>;
-
-    /**
-     * Register a Document sheet class as a candidate which can be used to display Documents of a given type.
-     * See {@link DocumentSheetConfig.registerSheet} for details.
-     * @see DocumentSheetConfig.registerSheet
-     *
-     * @example <caption>Register a new ActorSheet subclass for use with certain Actor types.</caption>
-     * ```typescript
-     * Actors.registerSheet("dnd5e", ActorSheet5eCharacter, { types: ["character], makeDefault: true });
-     * ```
-     */
-    static registerSheet(...args: DropFirst<Parameters<typeof DocumentSheetConfig.registerSheet>>): void;
-
-    /**
-     * Unregister a Document sheet class, removing it from the list of available sheet Applications to use.
-     * See {@link DocumentSheetConfig.unregisterSheet} for detauls.
-     * @see DocumentSheetConfig.unregisterSheet
-     *
-     * @example <caption>Deregister the default ActorSheet subclass to replace it with others.</caption>
-     * Actors.unregisterSheet("core", ActorSheet);
-     */
-    static unregisterSheet(...args: DropFirst<Parameters<typeof DocumentSheetConfig.unregisterSheet>>): void;
-
-    /**
-     * Return an array of currently registered sheet classes for this Document type.
-     * @remarks
-     * This is documented to return only {@link DocumentSheet}s but {@link DrawingConfig} is just a
-     * {@link FormApplication}. See https://gitlab.com/foundrynet/foundryvtt/-/issues/6454.
-     */
-    static get registeredSheets(): FormApplication[];
-  }
-
-  namespace WorldCollection {
-    interface FromCompendiumOptions {
-      /**
-       * Add flags which track the import source
-       * @defaultValue `false`
-       */
-      addFlags?: boolean | undefined;
-
-      /**
-       * Clear the currently assigned folder and sort order
-       * @defaultValue `true`
-       */
-      clearSort?: boolean | undefined;
-
-      /**
-       * Clear document permissions
-       * @defaultValue `true`
-       */
-      clearPermissions?: boolean | undefined;
-
-      /**
-       * Retain the Document id from the source Compendium
-       * @defaultValue `false`
-       */
-      keepId?: boolean | undefined;
-    }
-  }
-}
-
-type DropFirst<T extends Array<unknown>> = T extends [unknown, ...infer V] ? V : T;

package/src/foundry/client/data/collections/actors.d.ts

@@ -1,35 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The singleton collection of Actor documents which exist within the active World.
-   * This Collection is accessible within the Game object as game.actors.
-   *
-   * @see {@link Actor} The Actor document
-   * @see {@link ActorDirectory} The ActorDirectory sidebar directory
-   *
-   * @example <caption>Retrieve an existing Actor by its id</caption>
-   * ```typescript
-   * let actor = game.actors.get(actorId);
-   * ```
-   */
-  class Actors extends WorldCollection<typeof foundry.documents.BaseActor, 'Actors'> {
-    /**
-     * A mapping of synthetic Token Actors which are currently active within the viewed Scene.
-     * Each Actor is referenced by the Token.id.
-     */
-    get tokens(): Partial<Record<string, InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>>>;
-
-    static override documentName: 'Actor';
-
-    override fromCompendium(
-      document:
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],
-      options?: WorldCollection.FromCompendiumOptions | undefined
-    ): Omit<
-      InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],
-      '_id' | 'folder'
-    >;
-  }
-}

package/src/foundry/client/data/collections/cards.d.ts

@@ -1,8 +0,0 @@
-/**
- * The collection of Cards documents which exist within the active World.
- * This Collection is accessible within the Game object as game.cards.
- * @see {@link Cards} The Cards document
- */
-declare class CardStacks extends WorldCollection<typeof foundry.documents.BaseCards, 'Cards'> {
-  static override documentName: 'Cards';
-}

package/src/foundry/client/data/collections/combats.d.ts

@@ -1,43 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The singleton collection of Combat documents which exist within the active World.
-   * This Collection is accessible within the Game object as game.combats.
-   *
-   * @see {@link Combat} The Combat document
-   * @see {@link CombatTracker} The CombatTracker sidebar directory
-   */
-  class CombatEncounters extends WorldCollection<typeof foundry.documents.BaseCombat, 'CombatEncounters'> {
-    static override documentName: 'Combat';
-
-    /**
-     * Provide the settings object which configures the Combat document
-     */
-    static get settings(): ClientSettings.Values[`core.${typeof Combat['CONFIG_SETTING']}`];
-
-    override get directory(): typeof ui['combat'];
-
-    /**
-     * Get an Array of Combat instances which apply to the current canvas scene
-     */
-    get combats(): ReturnType<this['filter']>;
-
-    /**
-     * The currently active Combat instance
-     */
-    get active(): ReturnType<this['find']>;
-
-    /**
-     * The currently viewed Combat encounter
-     */
-    get viewed(): StoredDocument<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseCombat>>> | null;
-
-    /**
-     * When a Token is deleted, remove it as a combatant from any combat encounters which included the Token
-     * @param sceneId - The Scene id within which a Token is being deleted
-     * @param tokenId - The Token id being deleted
-     */
-    protected _onDeleteToken(sceneId: string, tokenId: string): Promise<void>;
-  }
-}