fvtt-types/src/foundry/client/documents/collections/macros.d.mts

TypeScript type definitions for Foundry VTT

import type { Identity } from "#utils";
import type Document from "#common/abstract/document.d.mts";

/**
 * The singleton collection of Macro documents which exist within the active World.
 * This Collection is accessible within the Game object as game.macros.
 *
 * @see {@linkcode Macro} The Macro document
 * @see {@linkcode MacroDirectory} The MacroDirectory sidebar directory
 */
declare class Macros extends foundry.documents.abstract.WorldCollection<"Macro", "Macros"> {
  static documentName: "Macro";

  override get directory(): typeof ui.macros;

  override fromCompendium<Options extends foundry.documents.abstract.WorldCollection.FromCompendiumOptions | undefined>(
    document: Macro.Implementation | Macro.CreateData,
    options?: Options,
  ): foundry.documents.abstract.WorldCollection.FromCompendiumReturnType<"Macro", Options>;
}

declare namespace Macros {
  /** @deprecated There should only be a single implementation of this class in use at one time, use {@linkcode Implementation} instead */
  type Any = Internal.Any;

  /** @deprecated There should only be a single implementation of this class in use at one time, use {@linkcode ImplementationClass} instead */
  type AnyConstructor = Internal.AnyConstructor;

  namespace Internal {
    interface Any extends AnyMacros {}
    interface AnyConstructor extends Identity<typeof AnyMacros> {}
  }

  interface ImplementationClass extends Document.Internal.ConfiguredCollectionClass<"Macro"> {}
  interface Implementation extends Document.Internal.ConfiguredCollection<"Macro"> {}

  /**
   * @deprecated Replaced by {@linkcode Macros.ImplementationClass}.
   */
  type ConfiguredClass = ImplementationClass;

  /**
   * @deprecated Replaced by {@linkcode Macros.Implementation}.
   */
  type Configured = Implementation;
}

declare abstract class AnyMacros extends Macros {
  constructor(...args: never);
}

export default Macros;