@league-of-foundry-developers/foundry-vtt-types 9.238.1 → 9.249.1

package/src/foundry/foundry.js/collections/documentCollections/compendiumCollection.d.ts

@@ -1,4 +1,4 @@
-import { ConfiguredDocumentClassForName, ConstructorDataType } from '../../../../types/helperTypes';
+import { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
 import { DocumentModificationOptions } from '../../../common/abstract/document.mjs';
 
 declare global {
@@ -16,12 +16,18 @@ declare global {
     constructor(metadata: T);
 
     /** The compendium metadata which defines the compendium content and location */
-    metadata: T;
+    metadata: T & {
+      /** @deprecated "The 'entity' field of compendium metadata is deprecated. Please use CompendiumCollection#documentName instead." */
+      get entity(): T['type'];
+    };
 
     /**  A subsidiary collection which contains the more minimal index of the pack */
     index: IndexTypeForMetadata<T>;
 
-    /** A debounced function which will clear the contents of the Compendium pack if it is not accessed frequently. */
+    /**
+     * A debounced function which will clear the contents of the Compendium pack if it is not accessed frequently.
+     * @internal
+     */
     _flush: () => void;
 
     /**
@@ -44,14 +50,21 @@ declare global {
 
     /**
      * The default index fields which should be retrieved for each Compendium document type
+     * @remarks TODO: We should also allow nested paths
      */
     static INDEX_FIELDS: {
       /** @defaultValue `["name", "img", "type"]` */
       Actor: (keyof foundry.data.ActorData['_source'])[];
 
+      /** @defaultValue `["name", "img"]` */
+      Adventure: (keyof foundry.data.AdventureData['_source'])[];
+
       /** @defaultValue `["name", "img", "type"]` */
       Item: (keyof foundry.data.ItemData['_source'])[];
 
+      /** @defaultValue `["name", "img", "type"]` */
+      Cards: (keyof foundry.data.CardsData['_source'])[];
+
       /** @defaultValue `["name", "thumb"]` */
       Scene: (keyof foundry.data.SceneData['_source'])[];
 
@@ -74,7 +87,7 @@ declare global {
     /** Access the compendium configuration data for this pack */
     get config(): CompendiumCollection.Configuration | {};
 
-    get documentName(): this['metadata']['entity'];
+    get documentName(): this['metadata']['type'];
 
     /** Track whether the Compendium Collection is locked for editing */
     get locked(): boolean;
@@ -88,7 +101,7 @@ declare global {
     get(key: string, { strict }: { strict: true }): StoredDocument<DocumentInstanceForCompendiumMetadata<T>>;
     get(
       key: string,
-      { strict }?: { strict?: false }
+      { strict }?: { strict?: false | undefined } | undefined
     ): StoredDocument<DocumentInstanceForCompendiumMetadata<T>> | undefined;
 
     set(id: string, document: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>): this;
@@ -99,7 +112,7 @@ declare global {
      * Load the Compendium index and cache it as the keys and values of the Collection.
      * @param options - Options which customize how the index is created
      */
-    getIndex(options?: CompendiumCollection.GetIndexOptions<T>): Promise<this['index']>;
+    getIndex(options?: CompendiumCollection.GetIndexOptions<T> | undefined): Promise<this['index']>;
 
     /**
      * Get a single Document from this Compendium by ID.
@@ -115,26 +128,47 @@ declare global {
      *                default: `{}`
      * @returns The retrieved Document instances
      */
-    getDocuments(query?: Record<string, unknown>): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[]>;
+    getDocuments(
+      query?: Record<string, unknown> | undefined
+    ): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[]>;
 
     /**
      * Import a Document into this Compendium Collection.
      * @param document - The existing Document you wish to import
+     * @param options  - Additional options which modify how the data is imported. See {@link ClientDocumentMixin#toCompendium}
+     *                   (default: `{}`)
      * @returns The imported Document instance
      */
     importDocument(
-      document: DocumentInstanceForCompendiumMetadata<T>
+      document: DocumentInstanceForCompendiumMetadata<T>,
+      options?: ClientDocumentMixin.CompendiumExportOptions | undefined
     ): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>> | undefined>;
 
     /**
      * Fully import the contents of a Compendium pack into a World folder.
+     * @param folderId   - An existing Folder _id to use.
+     *                     (default: `null`)
+     * @param folderName - A new Folder name to create.
+     *                     (default: `''`)
+     * @param options    - Additional options forwarded to {@link WorldCollection#fromCompendium} and {@link Document.createDocuments}
+     *                     (default: `{}`)
      * @returns The imported Documents, now existing within the World
      */
     importAll({
       folderId,
       folderName,
       options
-    }: ImportAllOptions): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[]>;
+    }?: ImportAllOptions | undefined): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[]>;
+
+    /**
+     * Provide a dialog form that prompts the user to import the full contents of a Compendium pack into the World.
+     * @param options - Additional options passed to the Dialog.confirm method
+     *                  (default: `{}`)
+     * @returns A Promise which resolves or rejects once the dialog has been submitted or closed
+     */
+    importDialog(
+      options?: Dialog.Options | undefined
+    ): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[] | null | false>;
 
     /**
      * Add a Document to the index, capturing it's relevant index attributes
@@ -150,7 +184,7 @@ declare global {
      */
     static createCompendium<T extends CompendiumCollection.Metadata>(
       metadata: T,
-      options?: Partial<DocumentModificationOptions>
+      options?: Partial<DocumentModificationOptions> | undefined
     ): Promise<CompendiumCollection<T>>;
 
     /**
@@ -159,7 +193,9 @@ declare global {
      *                   default: `{}`
      * @returns A Promise which resolves once the setting is updated
      */
-    configure(settings?: Partial<CompendiumCollection.Configuration>): Promise<CompendiumCollection.Configuration>;
+    configure(
+      settings?: Partial<CompendiumCollection.Configuration> | undefined
+    ): Promise<CompendiumCollection.Configuration>;
 
     /**
      * Delete an existing world-level Compendium Collection.
@@ -171,35 +207,49 @@ declare global {
      * Duplicate a compendium pack to the current World.
      * @param label - A new Compendium label
      */
-    duplicateCompendium({ label }?: { label?: string }): Promise<this>;
+    duplicateCompendium({ label }?: { label?: string | undefined }): Promise<this>;
 
     /**
      * Validate that the current user is able to modify content of this Compendium pack
      * @param requireUnlocked - `(default: true)`
+     * @internal
      */
-    protected _assertUserCanModify({ requireUnlocked }?: { requireUnlocked?: boolean }): true;
+    protected _assertUserCanModify({ requireUnlocked }?: { requireUnlocked?: boolean | undefined } | undefined): true;
 
     /**
      * Request that a Compendium pack be migrated to the latest System data template
-     * TODO: find better type for options, used in socket dispatch
+     * @remarks
+     * Currently, there are no options that are being considered by foundry when migrating a
+     * a compendium pack.
      */
-    migrate(options?: object): Promise<this>;
-
-    _onCreateDocuments(
+    migrate(options?: Record<string, unknown> | undefined): Promise<this>;
+
+    /** @override */
+    updateAll(
+      transformation:
+        | DeepPartial<DocumentInstanceForCompendiumMetadata<T>['data']['_source']>
+        | ((
+            doc: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>
+          ) => DeepPartial<DocumentInstanceForCompendiumMetadata<T>['data']['_source']>),
+      condition?: ((obj: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>) => boolean) | null,
+      options?: DocumentModificationContext
+    ): ReturnType<this['documentClass']['updateDocuments']>;
+
+    protected _onCreateDocuments(
       documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
-      result: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>['data']['_source'][],
+      result: (DocumentInstanceForCompendiumMetadata<T>['data']['_source'] & { _id: string })[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    _onUpdateDocuments(
+    protected _onUpdateDocuments(
       documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
-      result: DeepPartial<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>>[],
+      result: (DeepPartial<DocumentInstanceForCompendiumMetadata<T>['data']['_source']> & { _id: string })[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
 
-    _onDeleteDocuments(
+    protected _onDeleteDocuments(
       documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
       result: string[],
       options: DocumentModificationOptions,
@@ -208,52 +258,13 @@ declare global {
 
     /**
      * Follow-up actions taken when Documents within this Compendium pack are modified
+     * @internal
      */
     protected _onModifyContents(
       documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
       options: DocumentModificationOptions,
       userId: string
     ): void;
-
-    /** @deprecated since 0.8.0 */
-    get entity(): this['documentClass']['documentName'];
-
-    /** @deprecated since 0.8.0 */
-    getContent(): ReturnType<this['getDocuments']>;
-
-    /** @deprecated since 0.8.0 */
-    getEntry(id: string): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>['data']>;
-
-    /** @deprecated since 0.8.0 */
-    getEntity(id: string): ReturnType<this['getDocument']>;
-
-    /** @deprecated since 0.8.0 */
-    importEntity(document: DocumentInstanceForCompendiumMetadata<T>): ReturnType<this['importDocument']>;
-
-    /** @deprecated since 0.8.0 */
-    createEntity(
-      data:
-        | ConstructorDataType<DocumentInstanceForCompendiumMetadata<T>['data']>
-        | (ConstructorDataType<DocumentInstanceForCompendiumMetadata<T>['data']> & Record<string, unknown>),
-      options?: Partial<DocumentModificationOptions>
-    ): ReturnType<this['documentClass']['create']>;
-
-    /** @deprecated since 0.8.0 */
-    updateEntity(
-      data: DeepPartial<
-        | ConstructorDataType<DocumentInstanceForCompendiumMetadata<T>['data']>
-        | (ConstructorDataType<DocumentInstanceForCompendiumMetadata<T>['data']> & Record<string, unknown>)
-      > & {
-        _id: string;
-      },
-      options?: Partial<DocumentModificationOptions>
-    ): ReturnType<DocumentInstanceForCompendiumMetadata<T>['update']>;
-
-    /** @deprecated since 0.8.0 */
-    deleteEntity(
-      id: string,
-      options?: Partial<DocumentModificationOptions>
-    ): ReturnType<DocumentInstanceForCompendiumMetadata<T>['delete']>;
   }
 
   namespace CompendiumCollection {
@@ -262,7 +273,7 @@ declare global {
       locked: boolean;
     }
     interface Metadata {
-      entity: 'Actor' | 'Item' | 'JournalEntry' | 'Macro' | 'Playlist' | 'RollTable' | 'Scene';
+      type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
       name: string;
       label: string;
       path: string;
@@ -283,21 +294,21 @@ interface ImportAllOptions {
    * An existing Folder _id to use.
    * @defaultValue `null`
    * */
-  folderId?: string | null;
+  folderId?: string | null | undefined;
   /**
    * A new Folder name to create.
    * @defaultValue `""`
    * */
-  folderName?: string;
+  folderName?: string | undefined;
   /**
-   * Additional options forwarded to Document.createDocuments
+   * Additional options forwarded to {@link WorldCollection#fromCompendium} and {@link Document.createDocuments}
    * @defaultValue `{}`
    */
-  options?: DocumentModificationContext;
+  options?: (DocumentModificationContext & WorldCollection.FromCompendiumOptions) | undefined;
 }
 
 type DocumentClassForCompendiumMetadata<T extends CompendiumCollection.Metadata> = ConfiguredDocumentClassForName<
-  T['entity']
+  T['type']
 >;
 
 type DocumentInstanceForCompendiumMetadata<T extends CompendiumCollection.Metadata> = InstanceType<

package/src/foundry/foundry.js/collections/documentCollections/worldCollection.d.ts

@@ -1,4 +1,5 @@
 import { ConfiguredDocumentClass, DocumentConstructor } from '../../../../types/helperTypes';
+import type { DOCUMENT_TYPES } from '../../../common/constants.mjs';
 
 declare global {
   /**
@@ -21,6 +22,7 @@ declare global {
 
     /**
      * Initialize the WorldCollection object by constructing its contained Document instances
+     * @internal
      */
     protected _initialize(): void;
 
@@ -39,14 +41,19 @@ declare global {
     static documentName: string | null;
 
     /**
-     * Return a reference to the SidebarDirectory application for this WorldCollection, or null if it has not yet been created.
+     * 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 `null` but
-     * {@link RollTables} overrides this so we need to allow a wider return type.
+     * 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>]
-      : null | SidebarDirectory<ConfiguredDocumentClass<T>['metadata']['name']> | undefined;
+      :
+          | (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.
@@ -63,23 +70,30 @@ declare global {
      * @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
-     * @param options    - Optional arguments passed to the Document.create method
+     *                     (default: `{}`)
+     * @param options    - Optional arguments passed to the {@link WorldCollection#fromCompendium} and {@link Document.create} methods
+     *                     (default: `{}`)
      * @returns The imported Document instance
      */
     importFromCompendium(
-      pack: any, // TODO: CompendiumCollection
+      pack: CompendiumCollection<
+        CompendiumCollection.Metadata & { type: ConfiguredDocumentClass<T>['metadata']['name'] }
+      >,
       id: string,
-      updateData?: DeepPartial<InstanceType<ConfiguredDocumentClass<T>>['data']['_source']>,
-      options?: DocumentModificationContext
+      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']
+      document: InstanceType<ConfiguredDocumentClass<T>> | InstanceType<ConfiguredDocumentClass<T>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<InstanceType<ConfiguredDocumentClass<T>>['data']['_source'], '_id' | 'folder'>;
 
     /**
@@ -92,36 +106,63 @@ declare global {
     ): Omit<InstanceType<ConfiguredDocumentClass<T>>['data']['_source'], '_id' | 'folder'>;
 
     /**
-     * The WorldCollection#insert method is deprecated in favor of the WorldCollection#set method and will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    insert(document: InstanceType<ConfiguredDocumentClass<T>>): this;
-
-    /**
-     * The WorldCollection#remove method is deprecated in favor of the WorldCollection#delete method and will be removed in 0.9.0
-     * @deprecated since 0.8.0
+     * 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 });
+     * ```
      */
-    remove(id: string): boolean;
+    static registerSheet(...args: DropFirst<Parameters<typeof EntitySheetConfig.registerSheet>>): void;
 
     /**
-     * The WorldCollection#entities property is deprecated in favor of the Collection#contents attribute and will be removed in 0.9.0
-     * @deprecated since 0.8.0
+     * 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);
      */
-    get entities(): this['contents'];
+    static unregisterSheet(...args: DropFirst<Parameters<typeof EntitySheetConfig.unregisterSheet>>): void;
 
     /**
-     * The WorldCollection#object property has been deprecated in favor of WorldCollection#documentClass. Support will be removed in 0.9.0
-     * @deprecated since 0.8.0
+     * 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.
      */
-    get object(): this['documentClass'];
+    static get registeredSheets(): FormApplication[];
+  }
 
-    /**
-     * The WorldCollection#importFromCollection method has been deprecated in favor of WorldCollection#importFromCompendium. Support for the old method name will be removed in 0.9.0
-     * @deprecated since 0.8.0
-     */
-    importFromCollection(
-      packName: string,
-      ...args: Parameters<this['importFromCompendium']> extends [any, ...infer U] ? U : never
-    ): ReturnType<this['importFromCompendium']>;
+  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/foundry.js/collections/documentCollections/worldCollections/actors.d.ts

@@ -5,7 +5,7 @@ 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 entity
+   * @see {@link Actor} The Actor document
    * @see {@link ActorDirectory} The ActorDirectory sidebar directory
    *
    * @example <caption>Retrieve an existing Actor by its id</caption>
@@ -27,45 +27,11 @@ declare global {
     fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source']
+        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<
       InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseActor>>['data']['_source'],
       '_id' | 'folder'
     >;
-
-    /**
-     * Register an Actor sheet class as a candidate which can be used to display Actors of a given type
-     * See EntitySheetConfig.registerSheet for details
-     *
-     * @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(
-      scope: string,
-      sheetClass: ConstructorOf<ActorSheet>,
-      { label, types, makeDefault }?: { label?: string; types?: string[]; makeDefault?: boolean }
-    ): void;
-
-    /**
-     * Unregister an Actor sheet class, removing it from the list of avaliable sheet Applications to use
-     * See EntitySheetConfig.unregisterSheet for details
-     *
-     * @example <caption>Deregister the default ActorSheet subclass to replace it with others.</caption>
-     * ```typescript
-     * Actors.unregisterSheet("core", ActorSheet);
-     * ```
-     */
-    static unregisterSheet(
-      scope: string,
-      sheetClass: ConstructorOf<ActorSheet>,
-      { types }?: { types?: string[] }
-    ): void;
-
-    /**
-     * Return an Array of currently registered sheet classes for this Entity type
-     */
-    static get registeredSheets(): typeof ActorSheet[];
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/combatEncounters.d.ts

@@ -5,7 +5,7 @@ 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 entity
+   * @see {@link Combat} The Combat document
    * @see {@link CombatTracker} The CombatTracker sidebar directory
    */
   class CombatEncounters extends WorldCollection<typeof foundry.documents.BaseCombat, 'CombatEncounters'> {
@@ -13,10 +13,13 @@ declare global {
     static documentName: 'Combat';
 
     /**
-     * Provide the settings object which configures the Combat entity
+     * 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
      */

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/fogExplorations.d.ts

@@ -1,7 +1,5 @@
 /**
  * The singleton collection of FogExploration documents which exist within the active World.
- * This Collection is accessible within the Game object as game.fog.
- *
  * @see {@link FogExploration} The FogExploration document
  */
 declare class FogExplorations extends WorldCollection<typeof foundry.documents.BaseFogExploration, 'FogExplorations'> {

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/folders.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Folder documents which exist within the active World.
    * This Collection is accessible within the Game object as game.fog.
    *
-   * @see {@link FogExploration} The FogExploration document
+   * @see {@link Folder} The Folder document
    */
   class Folders extends WorldCollection<typeof foundry.documents.BaseFolder, 'Folders'> {
     constructor(data?: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Folder>>>['data']['_source'][]);
@@ -19,7 +19,7 @@ declare global {
     static documentName: 'Folder';
 
     /** @override */
-    render(force?: boolean, context?: Application.Options): void;
+    render(force?: boolean, context?: ApplicationOptions): void;
 
     /**
      * Refresh the display of any active JournalSheet instances where the folder list will change.

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/items.d.ts

@@ -2,31 +2,10 @@
  * The singleton collection of Item documents which exist within the active World.
  * This Collection is accessible within the Game object as game.items.
  *
- * @see {@link Item} The Item entity
+ * @see {@link Item} The Item document
  * @see {@link ItemDirectory} The ItemDirectory sidebar directory
  */
 declare class Items extends WorldCollection<typeof foundry.documents.BaseItem, 'Items'> {
   /** @override */
   static documentName: 'Item';
-
-  /**
-   * Register an Item sheet class as a candidate which can be used to display Items of a given type
-   * See EntitySheetConfig.registerSheet for details
-   */
-  static registerSheet(
-    scope: string,
-    sheetClass: ConstructorOf<ItemSheet>,
-    { label, types, makeDefault }?: { label?: string; types?: string[]; makeDefault?: boolean }
-  ): void;
-
-  /**
-   * Unregister an Item sheet class, removing it from the list of available sheet Applications to use
-   * See EntitySheetConfig.unregisterSheet for details
-   */
-  static unregisterSheet(scope: string, sheetClass: ConstructorOf<ItemSheet>, { types }?: { types?: string[] }): void;
-
-  /**
-   * Return an Array of currently registered sheet classes for this Entity type
-   */
-  static get registeredSheets(): typeof ItemSheet[];
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/journal.d.ts

@@ -2,7 +2,7 @@
  * The singleton collection of JournalEntry documents which exist within the active World.
  * This Collection is accessible within the Game object as game.journal.
  *
- * @see {@link JournalEntry} The JournalEntry entity
+ * @see {@link JournalEntry} The JournalEntry document
  * @see {@link JournalDirectory} The JournalDirectory sidebar directory
  */
 declare class Journal extends WorldCollection<typeof foundry.documents.BaseJournalEntry, 'Journal'> {

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/macros.d.ts

@@ -5,7 +5,7 @@ declare global {
    * The singleton collection of Macro documents which exist within the active World.
    * This Collection is accessible within the Game object as game.macros.
    *
-   * @see {@link Macro} The Macro entity
+   * @see {@link Macro} The Macro document
    * @see {@link MacroDirectory} The MacroDirectory sidebar directory
    */
   class Macros extends WorldCollection<typeof foundry.documents.BaseMacro, 'Macros'> {
@@ -19,16 +19,11 @@ declare global {
     fromCompendium(
       document:
         | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source']
+        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],
+      options?: WorldCollection.FromCompendiumOptions | undefined
     ): Omit<
       InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],
       '_id' | 'folder'
     >;
-
-    /**
-     * You are calling Macros.canUseScripts which has been deprecated in favor of User#can('MACRO_SCRIPT')
-     * @deprecated since 0.8.1
-     */
-    static canUseScripts(user: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>>): boolean;
   }
 }

package/src/foundry/foundry.js/collections/documentCollections/worldCollections/messages.d.ts

@@ -5,19 +5,24 @@ declare global {
    * The singleton collection of ChatMessage documents which exist within the active World.
    * This Collection is accessible within the Game object as game.messages.
    *
-   * @see {@link ChatMessage} The ChatMessage entity
+   * @see {@link ChatMessage} The ChatMessage document
    * @see {@link ChatLog} The ChatLog sidebar directory
    */
   class Messages extends WorldCollection<typeof foundry.documents.BaseChatMessage, 'Messages'> {
     /** @override */
     static documentName: 'ChatMessage';
 
+    /**
+     * @override
+     * */
+    get directory(): typeof ui.chat;
+
     /** @override */
     render(force?: boolean): void;
 
     /**
      * If requested, dispatch a Chat Bubble UI for the newly created message
-     * @param message - The ChatMessage entity to say
+     * @param message - The ChatMessage document to say
      */
     sayBubble(message: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseChatMessage>>): void;