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

package/src/foundry/client/apps/sidebar/sidebar.d.ts

@@ -1,102 +0,0 @@
-/**
- * Render the Sidebar container, and after rendering insert Sidebar tabs.
- * @typeParam Options - the type of the options object
- */
-declare class Sidebar<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-  /**
-   * Singleton application instances for each sidebar tab
-   * @defaultValue `{}`
-   */
-  tabs: Partial<Record<string, SidebarTab>>;
-
-  /**
-   * Track whether the sidebar container is currently collapsed
-   * @defaultValue `false`
-   * @internal
-   */
-  protected _collapsed: boolean;
-
-  /**
-   * @defaultValue
-   * ```ts
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   id: "sidebar",
-   *   template: "templates/sidebar/sidebar.html",
-   *   popOut: false,
-   *   width: 300,
-   *   tabs: [{navSelector: ".tabs", contentSelector: "#sidebar", initial: "chat"}]
-   * }
-   * ```
-   */
-  static override get defaultOptions(): ApplicationOptions;
-
-  /**
-   * Return the name of the active Sidebar tab
-   */
-  get activeTab(): string;
-
-  /**
-   * Singleton application instances for each popout tab
-   */
-  get popouts(): Partial<Record<string, SidebarTab>>;
-
-  override getData(options?: Partial<Options>): Sidebar.Data;
-
-  /**
-   * @internal
-   */
-  protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-  /**
-   * Activate a Sidebar tab by it's name
-   * @param tabName - The tab name corresponding to it's "data-tab" attribute
-   */
-  activateTab(tabName: string): void;
-
-  /**
-   * Expand the Sidebar container from a collapsed state.
-   * Take no action if the sidebar is already expanded.
-   */
-  expand(): void;
-
-  /**
-   * Collapse the sidebar to a minimized state.
-   * Take no action if the sidebar is already collapsed.
-   */
-  collapse(): void;
-
-  override activateListeners(html: JQuery): void;
-
-  /**
-   * @internal
-   */
-  protected override _onChangeTab(event: MouseEvent | null, tabs: Tabs, active: string): void;
-
-  /**
-   * Handle the special case of left-clicking a tab when the sidebar is collapsed.
-   * @param event - The originating click event
-   * @internal
-   */
-  protected _onLeftClickTab(event: MouseEvent): void;
-
-  /**
-   * Handle right-click events on tab controls to trigger pop-out containers for each tab
-   * @param event - The originating contextmenu event
-   * @internal
-   */
-  protected _onRightClickTab(event: MouseEvent): void;
-
-  /**
-   * Handle toggling of the Sidebar container's collapsed or expanded state
-   * @internal
-   */
-  protected _onToggleCollapse(event: MouseEvent): void;
-}
-
-declare namespace Sidebar {
-  interface Data {
-    coreUpdate: string | false;
-    systemUpdate: string | false;
-    user: Game['user'];
-  }
-}

package/src/foundry/client/apps/sidebar/tab-base.d.ts

@@ -1,68 +0,0 @@
-/**
- * An abstract pattern followed by the different tabs of the sidebar
- * @typeParam Options - The type of the options object
- */
-declare abstract class SidebarTab<
-  Options extends ApplicationOptions = ApplicationOptions
-> extends Application<Options> {
-  constructor(...args: ConstructorParameters<typeof Application>);
-  /**
-   * The base name of this sidebar tab
-   * @defaultValue `""`
-   */
-  tabName: string;
-
-  /**
-   * A reference to the pop-out variant of this SidebarTab, if one exists
-   * @defaultValue `null`
-   */
-  protected _popout: this | null;
-
-  /**
-   * Denote whether or not this is the original version of the sidebar tab, or a pop-out variant
-   * @defaultValue `null`
-   */
-  protected _original: this | null;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   popOut: false,
-   *   width: 300,
-   *   height: "auto",
-   *   baseApplication: "SidebarTab"
-   * });
-   * ```
-   */
-  static override get defaultOptions(): ApplicationOptions;
-
-  protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-  protected override _renderInner(data: object): Promise<JQuery>;
-
-  /**
-   * Activate this SidebarTab, switching focus to it
-   */
-  activate(): void;
-
-  override close(options?: Application.CloseOptions): Promise<void>;
-
-  /**
-   * Create a second instance of this SidebarTab class which represents a singleton popped-out container
-   * @returns The popped out sidebar tab instance
-   */
-  createPopout(): this;
-
-  /**
-   * Render the SidebarTab as a pop-out container
-   */
-  renderPopout(): void;
-
-  /**
-   * Handle lazy loading for sidebar images to only load them once they become observed
-   * @param entries  - The entries which are now observed
-   * @param observer - The intersection observer instance
-   */
-  protected _onLazyLoadImage(entries: IntersectionObserverEntry[], observer: IntersectionObserver): void;
-}

package/src/foundry/client/apps/sidebar/tab-directory.d.ts

@@ -1,236 +0,0 @@
-import { ConfiguredDocumentClass, ConfiguredDocumentClassForName } from '../../../../types/helperTypes';
-import { DropData } from '../../data/abstract/client-document';
-
-declare global {
-  /**
-   * A shared pattern for the sidebar directory which Actors, Items, and Scenes all use
-   * @typeParam Name    - The the type of document being handled by this {@link SidebarDirectory}.
-   * @typeParam Options - The type of the options object
-   */
-  abstract class SidebarDirectory<
-    Name extends foundry.CONST.DOCUMENT_TYPES,
-    Options extends SidebarDirectory.Options = SidebarDirectory.Options
-  > extends SidebarTab<Options> {
-    constructor(options?: Partial<SidebarDirectory.Options>);
-
-    /**
-     * References to the set of Documents which are displayed in the Sidebar
-     */
-    documents: InstanceType<ConfiguredDocumentClassForName<Name>>[];
-
-    /**
-     * Reference the set of Folders which exist in this Sidebar
-     */
-    folders: InstanceType<ConfiguredDocumentClass<typeof Folder>>[];
-
-    /**
-     * A reference to the named Document type that this Sidebar Directory instance displays
-     * @defaultValue `'Document'`
-     */
-    static documentName: string;
-
-    /**
-     * The path to the template partial which renders a single Document within this directory
-     * @defaultValue `"templates/sidebar/document-partial.html"`
-     */
-    static documentPartial: string;
-
-    /**
-     * The path to the template partial which renders a single Folder within this directory
-     * @defaultValue `"templates/sidebar/folder-partial.html"`
-     */
-    static folderPartial: string;
-
-    /**
-     * @defaultValue
-     * ```typescript
-     * const cls = getDocumentClass(this.documentName);
-     * const collection = cls.metadata.collection;
-     * foundry.utils.mergeObject(super.defaultOptions, {
-     *   id: collection,
-     *   template: `templates/sidebar/${collection}-directory.html`,
-     *   title: `${game.i18n.localize(cls.metadata.label)} Directory`,
-     *   renderUpdateKeys: ["name", "img", "thumb", "permission", "sort", "sorting", "folder"],
-     *   height: "auto",
-     *   scrollY: ["ol.directory-list"],
-     *   dragDrop: [{ dragSelector: ".directory-item",  dropSelector: ".directory-list"}],
-     *   filters: [{inputSelector: 'input[name="search"]', contentSelector: ".directory-list"}],
-     *   contextMenuSelector: ".entity"
-     * });
-     * ```
-     */
-    static override get defaultOptions(): SidebarDirectory.Options;
-
-    /**
-     * The WorldCollection instance which this Sidebar Directory displays.
-     */
-    static get collection(): WorldCollection<
-      ConfiguredDocumentClassForName<foundry.CONST.DOCUMENT_TYPES | 'FogExploration'>,
-      string
-    >;
-
-    /**
-     * Initialize the content of the directory by categorizing folders and entities into a hierarchical tree structure.
-     */
-    initialize(): void;
-
-    tree: SidebarDirectory.Tree<this['documents'][number]>;
-
-    /**
-     * Given an entity type and a list of entities, set up the folder tree for that entity
-     * @param folders  - The Array of Folder objects to organize
-     * @param entities - The Array of Entity objects to organize
-     * @returns A tree structure containing the folders and entities
-     */
-    static setupFolders<T extends SidebarDirectory<any, any>>(
-      this: ConstructorOf<T>,
-      folders: T['folders'],
-      entities: T['documents']
-    ): SidebarDirectory.Tree<T['documents'][number]>;
-
-    /**
-     * Populate a single folder with child folders and content
-     * This method is called recursively when building the folder tree
-     * @param allowChildren - (default: `true`)
-     */
-    protected static _populate<T extends SidebarDirectory<any, any>>(
-      this: ConstructorOf<T>,
-      folder: T['folders'][number],
-      folders: T['folders'],
-      entities: T['documents'],
-      {
-        allowChildren
-      }?: {
-        allowChildren: boolean;
-      }
-    ): [T['folders'], T['documents']];
-
-    override render(force?: boolean, context?: SidebarDirectory.RenderContext<Options>): this | void;
-
-    override getData(
-      options?: Partial<Options>
-    ): SidebarDirectory.Data<this['tree']> | Promise<SidebarDirectory.Data<this['tree']>>;
-
-    protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-
-    /**
-     * Collapse all subfolders in this directory
-     */
-    collapseAll(): void;
-
-    /**
-     * Activate event listeners triggered within the Actor Directory HTML
-     */
-    activateListeners(html: JQuery): void;
-
-    /**
-     * Handle clicking on an Entity name in the Sidebar directory
-     * @param event - The originating click event
-     */
-    protected _onClickEntityName(event: JQuery.ClickEvent): void | Promise<void>;
-
-    /**
-     * Handle new creation request
-     * @param event - The originating button click event
-     */
-    protected _onCreateDocument(
-      event: JQuery.ClickEvent
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<Name>> | undefined>;
-
-    /**
-     * Create a new Folder in this SidebarDirectory
-     * @param event - The originating button click event
-     */
-    protected _onCreateFolder(event: JQuery.ClickEvent): void;
-
-    /**
-     * Handle toggling the collapsed or expanded state of a folder within the directory tab
-     * @param event - The originating click event
-     */
-    protected _toggleFolder(event: JQuery.ClickEvent): void;
-
-    protected override _onDragStart(event: DragEvent): void;
-
-    protected _dragType: string;
-
-    protected override _canDragStart(selector: string): boolean;
-
-    /**
-     * Highlight folders as drop targets when a drag event enters or exits their area
-     * @param event - The DragEvent which is in progress
-     */
-    protected _onDragHighlight(event: JQuery.DragEnterEvent | JQuery.DragLeaveEvent): void;
-
-    protected override _onDrop(event: DragEvent): void;
-
-    /**
-     * Handle Document data being dropped into the directory.
-     * @param target - The target element
-     * @param data   - The data being dropped
-     */
-    protected _handleDroppedDocument(
-      target: HTMLElement,
-      data: DropData<InstanceType<ConfiguredDocumentClassForName<Name>>>
-    ): Promise<InstanceType<ConfiguredDocumentClassForName<Name>> | undefined>;
-
-    /**
-     * Handle Folder data being dropped into the directory.
-     * @param target - The target element
-     * @param data   - The data being dropped
-     */
-    protected _handleDroppedFolder(
-      target: HTMLElement,
-      data: DropData<InstanceType<ConfiguredDocumentClass<typeof Folder>>>
-    ): Promise<InstanceType<ConfiguredDocumentClass<typeof Folder>> | undefined>;
-
-    /**
-     * Default folder context actions
-     * @param html - The context menu HTML being rendered for the directory
-     */
-    protected _contextMenu(html: JQuery): void;
-
-    /**
-     * Get the set of ContextMenu options which should be used for Folders in a SidebarDirectory
-     * @returns The Array of context options passed to the ContextMenu instance
-     */
-    protected _getFolderContextOptions(): ContextMenuEntry[];
-
-    /**
-     * Get the set of ContextMenu options which should be used for Entities in a SidebarDirectory
-     * @returns The Array of context options passed to the ContextMenu instance
-     */
-    protected _getEntryContextOptions(): ContextMenuEntry[];
-
-    /**
-     * @deprecated since 0.8.0
-     */
-    get entities(): this['documents'];
-  }
-
-  namespace SidebarDirectory {
-    interface Data<ConcreteTree extends Tree<foundry.abstract.Document<any, any>>> {
-      user: InstanceType<ConfiguredDocumentClass<typeof User>>;
-      tree: ConcreteTree;
-      canCreate: boolean;
-      sidebarIcon: string;
-    }
-
-    interface Options extends ApplicationOptions {
-      renderUpdateKeys: string[];
-      contextMenuSelector: string;
-    }
-
-    type RenderContext<Options extends SidebarDirectory.Options = SidebarDirectory.Options> =
-      Application.RenderOptions<Options> & {
-        action?: string;
-        data?: string;
-        entityType?: string;
-      };
-
-    interface Tree<ConcreteDocument extends foundry.abstract.Document<any, any>> {
-      root?: boolean;
-      content: ConcreteDocument[];
-      children: (Folder & Tree<ConcreteDocument>)[];
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/tabs/actors-directory.d.ts

@@ -1,16 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level Actor documents.
- */
-declare class ActorDirectory extends SidebarDirectory<'Actor'> {
-  constructor(...args: ConstructorParameters<typeof SidebarDirectory>);
-
-  static override documentName: 'Actor';
-
-  protected override _canDragStart(selector: string): boolean;
-
-  protected override _onDragStart(event: DragEvent): void;
-
-  protected override _canDragDrop(selector: string): boolean;
-
-  protected override _getEntryContextOptions(): ContextMenuEntry[];
-}

package/src/foundry/client/apps/sidebar/tabs/cards-directory.d.ts

@@ -1,6 +0,0 @@
-/**
- * The sidebar directory which organizes and displays world-level Cards documents.
- */
-declare class CardsDirectory extends SidebarDirectory<'Cards'> {
-  static override documentName: 'Cards';
-}