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

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

@@ -1,321 +0,0 @@
-import { ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { DocumentModificationOptions } from '../../../common/abstract/document.mjs.js';
-
-declare global {
-  /**
-   * A collection of Document objects contained within a specific compendium pack.
-   * Each Compendium pack has its own associated instance of the CompendiumCollection class which contains its contents.
-   *
-   * @see {@link Game#packs}
-   */
-  class CompendiumCollection<T extends CompendiumCollection.Metadata> extends DocumentCollection<
-    DocumentClassForCompendiumMetadata<T>,
-    'CompendiumCollection'
-  > {
-    /** @param metadata - The compendium metadata, an object provided by game.data */
-    constructor(metadata: T);
-
-    /** The compendium metadata which defines the compendium content and location */
-    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.
-     * @internal
-     */
-    _flush: () => void;
-
-    /**
-     * Has this Compendium pack been fully indexed?
-     * @defaultValue `false`
-     */
-    indexed: boolean;
-
-    /**
-     * The amount of time that Document instances within this CompendiumCollection are held in memory.
-     * Accessing the contents of the Compendium pack extends the duration of this lifetime.
-     * @defaultValue `300`
-     */
-    static CACHE_LIFETIME_SECONDS: number;
-
-    /**
-     * The named game setting which contains Compendium configurations.
-     */
-    static CONFIG_SETTING: 'compendiumConfiguration';
-
-    /**
-     * 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'])[];
-
-      /** @defaultValue `["name", "img"]` */
-      JournalEntry: (keyof foundry.data.JournalEntryData['_source'])[];
-
-      /** @defaultValue `["name", "img"]` */
-      Macro: (keyof foundry.data.MacroData['_source'])[];
-
-      /** @defaultValue `["name", "img"]` */
-      RollTable: (keyof foundry.data.RollTableData['_source'])[];
-
-      /** @defaultValue `["name"]` */
-      Playlist: (keyof foundry.data.PlaylistData['_source'])[];
-    };
-
-    /** The canonical Compendium name - comprised of the originating package and the pack name */
-    get collection(): string;
-
-    /** Access the compendium configuration data for this pack */
-    get config(): CompendiumCollection.Configuration | {};
-
-    get documentName(): this['metadata']['type'];
-
-    /** Track whether the Compendium Collection is locked for editing */
-    get locked(): boolean;
-
-    /** Track whether the Compendium Collection is private */
-    get private(): boolean;
-
-    /** A convenience reference to the label which should be used as the title for the Compendium pack. */
-    get title(): string;
-
-    get(key: string, { strict }: { strict: true }): StoredDocument<DocumentInstanceForCompendiumMetadata<T>>;
-    get(
-      key: string,
-      { strict }?: { strict?: false | undefined } | undefined
-    ): StoredDocument<DocumentInstanceForCompendiumMetadata<T>> | undefined;
-
-    set(id: string, document: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>): this;
-
-    delete: (id: string) => boolean;
-
-    /**
-     * 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> | undefined): Promise<this['index']>;
-
-    /**
-     * Get a single Document from this Compendium by ID.
-     * The document may already be locally cached, otherwise it is retrieved from the server.
-     * @param id -  The requested Document id
-     * @returns The retrieved Document instance
-     */
-    getDocument(id: string): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>> | undefined | null>;
-
-    /**
-     * Load multiple documents from the Compendium pack using a provided query object.
-     * @param query - A database query used to retrieve documents from the underlying database
-     *                default: `{}`
-     * @returns The retrieved Document instances
-     */
-    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>,
-      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 | 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 in the following ways: an array of imported
-     *          Documents if the "yes" button was pressed, false if the "no" button was pressed, or
-     *          null if the dialog was closed without making a choice.
-     */
-    importDialog(
-      options?: DialogOptions | undefined
-    ): Promise<StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[] | null | false>;
-
-    /**
-     * Add a Document to the index, capturing it's relevant index attributes
-     * @param document -The document to index
-     */
-    indexDocument(document: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>): void;
-
-    /**
-     * Create a new Compendium Collection using provided metadata.
-     * @param metadata - The compendium metadata used to create the new pack
-     * @param options - Additional options which modify the Compendium creation request
-     *                  default `{}`
-     */
-    static createCompendium<T extends CompendiumCollection.Metadata>(
-      metadata: T,
-      options?: Partial<DocumentModificationOptions> | undefined
-    ): Promise<CompendiumCollection<T>>;
-
-    /**
-     * Assign configuration metadata settings to the compendium pack
-     * @param settings - The object of compendium settings to define
-     *                   default: `{}`
-     * @returns A Promise which resolves once the setting is updated
-     */
-    configure(
-      settings?: Partial<CompendiumCollection.Configuration> | undefined
-    ): Promise<CompendiumCollection.Configuration>;
-
-    /**
-     * Delete an existing world-level Compendium Collection.
-     * This action may only be performed for world-level packs by a Gamemaster User.
-     */
-    deleteCompendium(): Promise<this>;
-
-    /**
-     * Duplicate a compendium pack to the current World.
-     * @param label - A new Compendium label
-     */
-    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 | undefined } | undefined): true;
-
-    /**
-     * Request that a Compendium pack be migrated to the latest System data template
-     * @remarks
-     * Currently, there are no options that are being considered by foundry when migrating a
-     * a compendium pack.
-     */
-    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: (DocumentInstanceForCompendiumMetadata<T>['data']['_source'] & { _id: string })[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected _onUpdateDocuments(
-      documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
-      result: (DeepPartial<DocumentInstanceForCompendiumMetadata<T>['data']['_source']> & { _id: string })[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    protected _onDeleteDocuments(
-      documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
-      result: string[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-
-    /**
-     * Follow-up actions taken when Documents within this Compendium pack are modified
-     * @internal
-     */
-    protected _onModifyContents(
-      documents: StoredDocument<DocumentInstanceForCompendiumMetadata<T>>[],
-      options: DocumentModificationOptions,
-      userId: string
-    ): void;
-  }
-
-  namespace CompendiumCollection {
-    interface Configuration {
-      private: boolean;
-      locked: boolean;
-    }
-    interface Metadata {
-      type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-      name: string;
-      label: string;
-      path: string;
-      private: boolean;
-      package: string;
-      system?: string;
-    }
-
-    interface GetIndexOptions<T extends CompendiumCollection.Metadata> {
-      /** An array of fields to return as part of the index */
-      fields?: (keyof DocumentInstanceForCompendiumMetadata<T>['data']['_source'])[];
-    }
-  }
-}
-
-interface ImportAllOptions {
-  /**
-   * An existing Folder _id to use.
-   * @defaultValue `null`
-   * */
-  folderId?: string | null | undefined;
-  /**
-   * A new Folder name to create.
-   * @defaultValue `""`
-   * */
-  folderName?: string | undefined;
-  /**
-   * Additional options forwarded to {@link WorldCollection#fromCompendium} and {@link Document.createDocuments}
-   * @defaultValue `{}`
-   */
-  options?: (DocumentModificationContext & WorldCollection.FromCompendiumOptions) | undefined;
-}
-
-type DocumentClassForCompendiumMetadata<T extends CompendiumCollection.Metadata> = ConfiguredDocumentClassForName<
-  T['type']
->;
-
-type DocumentInstanceForCompendiumMetadata<T extends CompendiumCollection.Metadata> = InstanceType<
-  DocumentClassForCompendiumMetadata<T>
->;
-
-type IndexTypeForMetadata<T extends CompendiumCollection.Metadata> = foundry.utils.Collection<
-  { _id: string } & Partial<DocumentInstanceForCompendiumMetadata<T>['data']['_source']>
->;

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

@@ -1,7 +0,0 @@
-/**
- * The singleton collection of FogExploration documents which exist within the active World.
- * @see {@link FogExploration} The FogExploration document
- */
-declare class FogExplorations extends WorldCollection<typeof foundry.documents.BaseFogExploration, 'FogExplorations'> {
-  static documentName: 'FogExploration';
-}

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

@@ -1,27 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-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 Folder} The Folder document
-   */
-  class Folders extends WorldCollection<typeof foundry.documents.BaseFolder, 'Folders'> {
-    constructor(data?: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof Folder>>>['data']['_source'][]);
-
-    /**
-     * Track which Folders are currently expanded in the UI
-     */
-    protected _expanded: Partial<Record<string, boolean>>;
-
-    static override documentName: 'Folder';
-
-    override render(force?: boolean, context?: ApplicationOptions): void;
-
-    /**
-     * Refresh the display of any active JournalSheet instances where the folder list will change.
-     */
-    protected _refreshJournalEntrySheets(): void;
-  }
-}

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

@@ -1,15 +0,0 @@
-import './actors';
-import './cards';
-import './combats';
-import './compendium';
-import './fog';
-import './folder';
-import './items';
-import './journal';
-import './macros';
-import './messages';
-import './playlists';
-import './scenes';
-import './settings';
-import './tables';
-import './users';

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

@@ -1,10 +0,0 @@
-/**
- * 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 document
- * @see {@link ItemDirectory} The ItemDirectory sidebar directory
- */
-declare class Items extends WorldCollection<typeof foundry.documents.BaseItem, 'Items'> {
-  static override documentName: 'Item';
-}

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

@@ -1,26 +0,0 @@
-/**
- * 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 document
- * @see {@link JournalDirectory} The JournalDirectory sidebar directory
- */
-declare class Journal extends WorldCollection<typeof foundry.documents.BaseJournalEntry, 'Journal'> {
-  static override documentName: 'JournalEntry';
-
-  /**
-   * Open Socket listeners which transact JournalEntry data
-   * @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners}
-   */
-  protected static _activateSocketListeners(socket: io.Socket): void;
-
-  /**
-   * Handle a received request to show a JournalEntry to the current client
-   * @param entryId - The ID of the journal entry to display for other players
-   * @param mode    - The JournalEntry mode to display
-   *                  (default: `'text'`)
-   * @param force   - Display the entry to all players regardless of normal permissions
-   *                  (default: `true`)
-   */
-  protected static _showEntry(entryId: string, mode?: 'text' | 'image', force?: boolean): Promise<void>;
-}

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

@@ -1,26 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-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 document
-   * @see {@link MacroDirectory} The MacroDirectory sidebar directory
-   */
-  class Macros extends WorldCollection<typeof foundry.documents.BaseMacro, 'Macros'> {
-    static override documentName: 'Macro';
-
-    override get directory(): typeof ui.macros;
-
-    override fromCompendium(
-      document:
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],
-      options?: WorldCollection.FromCompendiumOptions | undefined
-    ): Omit<
-      InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseMacro>>['data']['_source'],
-      '_id' | 'folder'
-    >;
-  }
-}

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

@@ -1,39 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-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 document
-   * @see {@link ChatLog} The ChatLog sidebar directory
-   */
-  class Messages extends WorldCollection<typeof foundry.documents.BaseChatMessage, 'Messages'> {
-    static override 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 document to say
-     */
-    sayBubble(message: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseChatMessage>>): void;
-
-    /**
-     * Handle export of the chat log to a text file
-     */
-    export(): void;
-
-    /**
-     * Allow for bulk deletion of all chat messages, confirm first with a yes/no dialog.
-     * @see {@link Dialog.confirm}
-     */
-    flush(): Promise<
-      | Promise<StoredDocument<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseChatMessage>>>[]>
-      | false
-      | null
-    >;
-  }
-}

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

@@ -1,41 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-import type { SceneDataConstructorData } from '../../../common/data/data.mjs/sceneData';
-
-declare global {
-  /**
-   * The singleton collection of Playlist documents which exist within the active World.
-   * This Collection is accessible within the Game object as game.playlists.
-   *
-   * @see {@link Playlist} The Playlist document
-   * @see {@link PlaylistDirectory} The PlaylistDirectory sidebar directory
-   */
-  class Playlists extends WorldCollection<typeof foundry.documents.BasePlaylist, 'Playlists'> {
-    constructor(
-      data?: StoredDocument<
-        InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BasePlaylist>>
-      >['data']['_source'][]
-    );
-
-    static override documentName: 'Playlist';
-
-    /**
-     * Return the subset of Playlist documents which are currently playing
-     */
-    get playing(): ReturnType<this['filter']>;
-
-    /**
-     * Perform one-time initialization to begin playback of audio
-     */
-    initialize(): void;
-
-    /**
-     * Handle changes to a Scene to determine whether to trigger changes to Playlist documents.
-     * @param scene - The Scene document being updated
-     * @param data  - The incremental update data
-     */
-    protected _onChangeScene(
-      scene: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>>,
-      data: DeepPartial<SceneDataConstructorData>
-    ): Promise<void>;
-  }
-}

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

@@ -1,62 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The singleton collection of Scene documents which exist within the active World.
-   * This Collection is accessible within the Game object as game.scenes.
-   *
-   * @see {@link Scene} The Scene document
-   * @see {@link SceneDirectory} The SceneDirectory sidebar directory
-   */
-  class Scenes extends WorldCollection<typeof foundry.documents.BaseScene, 'Scenes'> {
-    static override documentName: 'Scene';
-
-    /**
-     * Return a reference to the Scene which is currently active
-     */
-    get active(): StoredDocument<Scene> | undefined;
-
-    /**
-     * Return the current Scene target.
-     * This is the viewed scene if the canvas is active, otherwise it is the currently active scene.
-     */
-    get current(): StoredDocument<Scene> | undefined;
-
-    /**
-     * Return a reference to the Scene which is currently viewed
-     */
-    get viewed(): StoredDocument<Scene> | undefined;
-
-    /**
-     * Handle pre-loading the art assets for a Scene
-     *
-     * @param sceneId - The Scene id to begin loading
-     * @param push    - Trigger other connected clients to also pre-load Scene resources
-     *                  (default: `false`)
-     */
-    preload(sceneId: string, push?: boolean): io.Socket | Promise<unknown[]>;
-
-    /** @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners} */
-    static _activateSocketListeners(socket: io.Socket): void;
-
-    /**
-     * Augment the standard modifyDocument listener to flush fog exploration
-     */
-    protected static _resetFog(response: { scene: Scene; reset: boolean }): Promise<Canvas | undefined> | undefined;
-
-    /**
-     * Handle requests pulling the current User to a specific Scene
-     */
-    protected static _pullToScene(sceneId: string): void;
-
-    override fromCompendium(
-      document:
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
-        | InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],
-      options?: WorldCollection.FromCompendiumOptions | undefined
-    ): Omit<
-      InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>['data']['_source'],
-      '_id' | 'folder'
-    >;
-  }
-}

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

@@ -1,25 +0,0 @@
-/**
- * The Collection of Setting documents which exist within the active World.
- * This collection is accessible as game.settings.storage.get("world")
- *
- * @see {@link Setting} The Setting document
- */
-declare class WorldSettings extends WorldCollection<typeof foundry.documents.BaseSetting, 'WorldSettings'> {
-  static override documentName: 'Setting';
-
-  override get directory(): undefined;
-
-  /**
-   * Return the Setting or Keybind document with the given key.
-   * @param key - The setting key
-   * @returns The Setting.
-   */
-  getSetting(key: string): ReturnType<this['find']>;
-
-  /**
-   * Return the serialized value of the world setting as a string
-   * @param key - The setting key
-   * @returns The serialized setting string
-   */
-  getItem(key: string): string | null;
-}

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

@@ -1,17 +0,0 @@
-/**
- * The singleton collection of RollTable documents which exist within the active World.
- * This Collection is accessible within the Game object as game.tables.
- *
- * @see {@link RollTable} The RollTable document
- * @see {@link RollTableDirectory} The RollTableDirectory sidebar directory
- */
-declare class RollTables extends WorldCollection<typeof foundry.documents.BaseRollTable, 'RollTables'> {
-  static override documentName: 'RollTable';
-
-  override get directory(): typeof ui['tables'];
-
-  /**
-   * Register world settings related to RollTable documents
-   */
-  static registerSettings(): void;
-}

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

@@ -1,43 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../../types/helperTypes';
-
-declare global {
-  /**
-   * The singleton collection of User documents which exist within the active World.
-   * This Collection is accessible within the Game object as game.users.
-   *
-   * @see {@link User} The User document
-   */
-  class Users extends WorldCollection<typeof foundry.documents.BaseUser, 'Users'> {
-    constructor(data?: foundry.data.UserData['_source'][]);
-
-    /**
-     * The User document of the currently connected user
-     * @defaultValue `null`
-     */
-    current: StoredDocument<InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseUser>>> | null;
-
-    /**
-     * Initialize the Map object and all its contained documents
-     * @internal
-     */
-    protected override _initialize(): void;
-
-    static override documentName: 'User';
-
-    /**
-     * Get the users with player roles
-     */
-    get players(): ReturnType<this['filter']>;
-
-    /** @remarks This is not marked as protected because it is used in {@link Game#activateSocketListeners} */
-    static _activateSocketListeners(socket: io.Socket): void;
-
-    /**
-     * Handle receipt of activity data from another User connected to the Game session
-     * @param userId       - The User id who generated the activity data
-     * @param activityData - The object of activity data
-     *                       (default: `{}`)
-     */
-    protected static _handleUserActivity(userId: string, activityData?: ActivityData | undefined): void;
-  }
-}