@7h3laughingman/foundry-types 13.351.0

package/src/client/applications/sidebar/document-directory.d.mts

@@ -0,0 +1,327 @@
+import type { ApplicationConfiguration, ApplicationRenderContext } from "../_types.mjs";
+import type HandlebarsApplicationMixin from "../api/handlebars-application.mjs";
+import type { HandlebarsRenderOptions, HandlebarsTemplatePart } from "../api/handlebars-application.mjs";
+import { ContextMenuEntry } from "../ux/context-menu.mjs";
+import type Document from "./../../../common/abstract/document.mjs";
+import { Folder } from "./../../documents/_module.mjs";
+import { DirectoryCollection, DirectoryMixinEntry } from "./../../documents/abstract/directory-collection-mixin.mjs";
+import { CompendiumIndexData } from "./../../documents/collections/compendium-collection.mjs";
+import { DropCanvasData } from "./../../helpers/hooks.mjs";
+import type AbstractSidebarTab from "./sidebar-tab.mjs";
+
+export interface DocumentDirectoryConfiguration extends ApplicationConfiguration {
+    /** The Document collection that this directory represents. */
+    collection: DirectoryCollection;
+    /** Updating one of these properties of a displayed Document will trigger a re-render of the tab. */
+    renderUpdateKeys: string[];
+}
+
+/**
+ * An abstract class for rendering a foldered directory of Documents.
+ */
+export default class DocumentDirectory<TDocument extends DirectoryMixinEntry> extends HandlebarsApplicationMixin(
+    AbstractSidebarTab<DocumentDirectoryConfiguration, HandlebarsRenderOptions>,
+) {
+    constructor(options: DeepPartial<DocumentDirectoryConfiguration>);
+
+    static override DEFAULT_OPTIONS: DeepPartial<DocumentDirectoryConfiguration>;
+
+    static override PARTS: Record<string, HandlebarsTemplatePart>;
+
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /** The path to the template used to render a single entry within the directory. */
+    protected static _entryPartial: string;
+
+    /** The path to the template used to render a single folder within the directory. */
+    protected static _folderPartial: string;
+
+    /** The Document collection that this directory represents. */
+    get collection(): DirectoryCollection<TDocument>;
+
+    /** The implementation of the Document type that this directory represents. */
+    get documentClass(): ConstructorOf<TDocument>;
+
+    /** The named Document type that this directory represents. */
+    get documentName(): TDocument["documentName"];
+
+    override get title(): string;
+
+    /* -------------------------------------------- */
+    /*  Rendering                                   */
+    /* -------------------------------------------- */
+
+    protected override _initializeApplicationOptions(options: DeepPartial<DocumentDirectoryConfiguration>): DocumentDirectoryConfiguration;
+
+    /** Determine if the current user has permission to create directory entries. */
+    protected _canCreateEntry(): boolean;
+
+    /** Determine if the current user has permission to create folders in this directory. */
+    protected _canCreateFolder(): boolean;
+
+    protected override _canRender(options: HandlebarsRenderOptions): false | void;
+
+    protected override _configureRenderParts(options: HandlebarsRenderOptions): Record<string, HandlebarsTemplatePart>;
+
+    /** Register context menu entries and fire hooks. */
+    protected _createContextMenus(): void;
+
+    /** Get context menu entries for entries in this directory. */
+    protected _getEntryContextOptions(): ContextMenuEntry[];
+
+    /** Get context menu entries for folders in this directory. */
+    protected _getFolderContextOptions(): ContextMenuEntry[];
+
+    protected override _onFirstRender(context: ApplicationRenderContext, options: HandlebarsRenderOptions): Promise<void>;
+
+    protected override _prepareContext(options: HandlebarsRenderOptions): Promise<object>;
+
+    protected override _preparePartContext(partId: string, context: object, options: HandlebarsRenderOptions): Promise<object>;
+
+    /** Prepare render context for the directory part. */
+    protected _prepareDirectoryContext(context: object, options: HandlebarsRenderOptions): Promise<void>;
+
+    /** Prepare render context for the footer part. */
+    protected _prepareFooterContext(context: ApplicationRenderContext, options: HandlebarsRenderOptions): Promise<void>;
+
+    /**
+     * Prepare render context for the header part.
+     * @param {ApplicationRenderContext} context
+     * @param {HandlebarsRenderOptions} options
+     * @returns {Promise<void>}
+     * @protected
+     */
+    protected _prepareHeaderContext(context: object, options: HandlebarsRenderOptions): Promise<void>;
+
+    protected override _preRender(context: object, options: HandlebarsRenderOptions): Promise<void>;
+
+    protected override _preSyncPartState(partId: string, newElement: HTMLElement, priorElement: HTMLElement, state: object): void;
+
+    protected override _syncPartState(partId: string, newElement: HTMLElement, priorElement: HTMLElement, state: object): void;
+
+    /* -------------------------------------------- */
+    /*  Public API                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Collapse all open folders in this directory.
+     */
+    collapseAll(): void;
+
+    /* -------------------------------------------- */
+    /*  Event Listeners & Handlers                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Handle activating a directory entry.
+     * @param event The triggering click event.
+     * @param HTMLElement target The action target element.
+     * @param options._skipDeprecation Internal use only.
+     */
+    protected _onClickEntry(event: PointerEvent, target: HTMLElement, { _skipDeprecation }?: { _skipDeprecation?: boolean }): Promise<void>;
+
+    /**
+     * Handle creating a new entry in this directory.
+     * @param event  The triggering click event.
+     * @param target The action target element.
+     */
+    protected _onCreateEntry(event: PointerEvent, target: HTMLElement): Promise<Document | undefined>;
+
+    /**
+     * Handle creating a new folder in this directory.
+     * @param event  The triggering click event.
+     * @param target The action target element.
+     */
+    protected _onCreateFolder(event: PointerEvent, target: HTMLElement): void;
+
+    /**
+     * Handle toggling a folder's expanded state.
+     * @param {PointerEvent} event  The triggering click event.
+     * @param {HTMLElement} target  The action target element.
+     * @param {object} [options]
+     * @param {boolean} [options._skipDeprecation] Internal use only.
+     * @protected
+     */
+    protected _onToggleFolder(event: PointerEvent, target: HTMLElement, { _skipDeprecation }?: { _skipDeprecation?: boolean }): void;
+
+    /* -------------------------------------------- */
+    /*  Search & Filter                             */
+    /* -------------------------------------------- */
+
+    /**
+     * Handle matching a given directory entry with the search filter.
+     * @param query The input search string.
+     * @param entryIds The matched directory entry IDs.
+     * @param element The candidate entry element.
+     * @param options Additional options for subclass-specific behavior.
+     */
+    protected _onMatchSearchEntry(query: string, entryIds: Set<string>, element: HTMLElement, options?: object): void;
+
+    /**
+     * Handle directory searching and filtering.
+     * @param event The keyboard input event.
+     * @param query The input search string.
+     * @param rgx   The regular expression query that should be matched against.
+     * @param html  The container to filter entries from.
+     */
+    protected _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
+
+    /**
+     * Identify entries in the collection which match a provided search query.
+     * @param query The search query.
+     * @param entryIds The set of matched entry IDs.
+     * @param folderIds The set of matched folder IDs.
+     * @param autoExpandIds The set of folder IDs that should be auto-expanded.
+     */
+    protected _matchSearchEntries(query: RegExp, entryIds: Set<string>, folderIds: Set<string>, autoExpandIds: Set<string>): void;
+
+    /**
+     * Identify folders in the collection which match a provided search query.
+     * @param query         The search query.
+     * @param folderIds     The set of matched folder IDs.
+     * @param autoExpandIds The set of folder IDs that should be auto-expanded.
+     */
+    protected _matchSearchFolders(query: RegExp, folderIds: Set<string>, autoExpandIds: Set<string>): void;
+
+    /* -------------------------------------------- */
+    /*  Drag & Drop                                 */
+    /* -------------------------------------------- */
+
+    protected _canDragDrop(selector: string): boolean;
+
+    protected _canDragStart(selector: string): boolean;
+
+    /**
+     * Create a new entry in this directory from one that was dropped on it.
+     * @param entry     The dropped entry.
+     * @param [updates] Modifications to the creation data.
+     */
+    protected _createDroppedEntry(entry: TDocument, updates?: object): Promise<TDocument | undefined>;
+
+    /**
+     * Import a dropped folder and its children into this collection if they do not already exist.
+     * @param folder         The folder being dropped.
+     * @param [targetFolder] A folder to import into if not the directory root.
+     */
+    protected _createDroppedFolderContent(folder: Folder, targetFolder?: Folder): Promise<Folder[]>;
+
+    /**
+     * Create a set of documents in a dropped folder.
+     * @param folder    The dropped folder.
+     * @param documents The documents to create, or their indices.
+     */
+    protected _createDroppedFolderDocuments(folder: Folder, documents: TDocument[] | CompendiumIndexData[]): Promise<void>;
+
+    /**
+     * Test if the given entry is already present in this directory.
+     * @param entry The directory entry.
+     */
+    protected _entryAlreadyExists(entry: TDocument): boolean;
+
+    /**
+     * Determing whether a given directory entry belongs to the given folder.
+     * @param entry  The entry.
+     * @param folder The target folder ID.
+     */
+    protected _entryBelongsToFolder(entry: TDocument, folder: string): boolean;
+
+    /**
+     * Get the entry instance from its dropped data.
+     * @param data The drag data.
+     * @throws If the correct instance type could not be retrieved.
+     */
+    protected _getDroppedEntryFromData(data: DropCanvasData): Promise<TDocument>;
+
+    /**
+     * Get drag data for an entry in this directory.
+     * @param entryId The entry's ID.
+     */
+    protected _getEntryDragData(entryId: string): DropCanvasData;
+
+    /**
+     * Get drag data for a folder in this directory.
+     * @param folderId The folder ID.
+     */
+    protected _getFolderDragData(folderId: string): DropCanvasData;
+
+    /**
+     * Handle dropping a new entry into this directory.
+     * @param target The drop target element.
+     * @param data   The drop data.
+     */
+    protected _handleDroppedEntry(target: HTMLElement, data: object): Promise<void>;
+
+    /**
+     * Handle dropping a folder onto the directory.
+     * @param target The drop target element.
+     * @param data   The drop data.
+     */
+    protected _handleDroppedFolder(target: HTMLElement, data: DropCanvasData): Promise<void>;
+
+    /**
+     * Handle importing a new folder's into the directory.
+     * @param folder          The dropped folder.
+     * @param closestFolderId The ID of the closest folder to the drop target.
+     * @param sortData        Sort data for the folder.
+     */
+    protected _handleDroppedForeignFolder(folder: Folder, closestFolderId: string, sortData: object): Promise<{ folder: Folder; sortNeeded: boolean } | null>;
+
+    /**
+     * Highlight folders as drop targets when a drag event enters or exits their area.
+     * @param event The in-progress drag event.
+     */
+    protected _onDragHighlight(event: DragEvent): void;
+
+    /**
+     * Handle drag events over the directory.
+     */
+    protected _onDragOver(event: DragEvent): void;
+
+    protected _onDragStart(event: DragEvent): void;
+
+    protected _onDrop(event: DragEvent): void;
+
+    /**
+     * Organize a dropped folder and its children into a list of folders and documents to create.
+     * @param folder The dropped folder.
+     * @param [targetFolder] A folder to import into if not the directory root.
+     */
+    protected _organizeDroppedFoldersAndDocuments(
+        folder: Folder,
+        targetFolder?: Folder,
+    ): Promise<{ foldersToCreate: Folder[]; documentsToCreate: TDocument[] | object[] }>;
+
+    /* -------------------------------------------- */
+    /*  Helpers                                     */
+    /* -------------------------------------------- */
+
+    /**
+     * Get context menu entries for folders in a directory.
+     * @returns {ContextMenuEntry[]}
+     * @internal
+     */
+    static _getFolderContextOptions(): ContextMenuEntry[];
+
+    /**
+     * Helper method to handle dropping a folder onto the directory.
+     * @param target The drop target element.
+     * @param data The drop data.
+     * @param config.folders The sibling folders.
+     * @param config.label The label for entries in the directory.
+     * @param config.maxFolderDepth The maximum folder depth in this directory.
+     * @param config.type The type of entries in the directory.
+     * @internal
+     */
+    static _handleDroppedFolder(
+        target: HTMLElement,
+        data: object,
+        config: { folders: Folder[]; label: string; maxFolderDepth: number; type: string },
+    ): Promise<{ closestFolderId?: string; folder: Folder; sortData: object; foreign?: boolean } | void>;
+}
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+export default interface DocumentDirectory<TDocument extends DirectoryMixinEntry> {
+    render(options?: Partial<HandlebarsRenderOptions>): Promise<this>;
+}

package/src/client/applications/sidebar/sidebar-tab.d.mts

@@ -0,0 +1,89 @@
+import type { ApplicationClosingOptions, ApplicationConfiguration, ApplicationRenderContext, ApplicationRenderOptions } from "../_types.mjs";
+import type ApplicationV2 from "../api/application.mjs";
+
+/**
+ * The sidebar tab interface that allows any sidebar tab to also be rendered as a popout.
+ */
+export default abstract class AbstractSidebarTab<
+    TConfig extends ApplicationConfiguration = ApplicationConfiguration,
+    TRenderOptions extends ApplicationRenderOptions = ApplicationRenderOptions,
+> extends ApplicationV2<TConfig, TRenderOptions> {
+    /**
+     * The base name of the sidebar tab.
+     */
+    static tabName: string;
+
+    static override DEFAULT_OPTIONS: DeepPartial<ApplicationConfiguration>;
+
+    static override emittedEvents: readonly string[];
+
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Whether this tab is currently active in the sidebar.
+     */
+    get active(): boolean;
+
+    /**
+     * Whether this is the popped-out tab or the in-sidebar one.
+     */
+    get isPopout(): boolean;
+
+    /**
+     * A reference to the popped-out version of this tab, if one exists.
+     */
+    get popout(): this | undefined;
+
+    /**
+     * The base name of the sidebar tab.
+     */
+    get tabName(): string;
+
+    /* -------------------------------------------- */
+    /*  Rendering                                   */
+    /* -------------------------------------------- */
+
+    protected override _initializeApplicationOptions(options: DeepPartial<TConfig>): TConfig;
+
+    protected override _prepareContext(options: TRenderOptions): Promise<object>;
+
+    protected override _renderFrame(options: TRenderOptions): Promise<HTMLElement>;
+
+    override render(options?: boolean | DeepPartial<TRenderOptions>): Promise<this>;
+
+    /* -------------------------------------------- */
+    /*  Public API                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Activate this tab in the sidebar.
+     */
+    activate(): void;
+
+    /**
+     * Pop-out this sidebar tab as a new application.
+     */
+    renderPopout(): Promise<this>;
+
+    /* -------------------------------------------- */
+    /*  Events                                      */
+    /* -------------------------------------------- */
+
+    /**
+     * Actions performed when this tab is activated in the sidebar.
+     */
+    protected _onActivate(): void;
+
+    protected override _onClose(options: ApplicationClosingOptions): void;
+
+    /**
+     * Actions performed when this tab is deactivated in the sidebar.
+     */
+    protected _onDeactivate(): void;
+
+    protected override _onFirstRender(context: ApplicationRenderContext, options: TRenderOptions): Promise<void>;
+
+    protected override _onRender(context: ApplicationRenderContext, options: TRenderOptions): Promise<void>;
+}

package/src/client/applications/sidebar/sidebar.d.mts

@@ -0,0 +1,93 @@
+import { ApplicationConfiguration, ApplicationRenderContext } from "../_types.mjs";
+import ApplicationV2 from "../api/application.mjs";
+import HandlebarsApplicationMixin, { HandlebarsRenderOptions, HandlebarsTemplatePart } from "../api/handlebars-application.mjs";
+import AbstractSidebarTab from "./sidebar-tab.mjs";
+
+declare interface SidebarTabDescriptor {
+    /** The tab's tooltip. */
+    tooltip: string;
+    /** The tab's Font Awesome icon class. */
+    icon: string;
+}
+
+/**
+ * The main sidebar application.
+ */
+export default class Sidebar extends HandlebarsApplicationMixin(ApplicationV2) {
+    static override DEFAULT_OPTIONS: DeepPartial<ApplicationConfiguration>;
+
+    /**
+     * Tab configuration.
+     */
+    TABS: Record<string, SidebarTabDescriptor>;
+
+    override tabGroups: { primary: string };
+
+    static override PARTS: Record<string, HandlebarsTemplatePart>;
+
+    /* -------------------------------------------- */
+    /*  Properties                                  */
+    /* -------------------------------------------- */
+
+    /**
+     * Whether the sidebar is currently expanded.
+     */
+    get expanded(): boolean;
+
+    /**
+     * The currently popped-out sidebar tabs.
+     */
+    popouts: Record<string, AbstractSidebarTab>;
+
+    /* -------------------------------------------- */
+    /*  Rendering                                   */
+    /* -------------------------------------------- */
+
+    _configureRenderOptions(options: HandlebarsRenderOptions): void;
+
+    _onFirstRender(context: ApplicationRenderContext, options: HandlebarsRenderOptions): Promise<void>;
+
+    protected override _preparePartContext(
+        partId: string,
+        context: ApplicationRenderContext,
+        options: HandlebarsRenderOptions,
+    ): Promise<ApplicationRenderContext>;
+
+    /**
+     * Prepare render context for the tabs.
+     * @param context Shared context provided by _prepareContext.
+     * @param options Options for configuring rendering behavior.
+     */
+    protected _prepareTabContext(context: ApplicationRenderContext, options: HandlebarsRenderOptions): Promise<void>;
+
+    protected override _renderHTML(context: ApplicationRenderContext, options: HandlebarsRenderOptions): Promise<Record<string, HTMLElement>>;
+
+    /* -------------------------------------------- */
+    /*  Event Listeners & Handlers                  */
+    /* -------------------------------------------- */
+
+    protected override _onClickTab(event: PointerEvent): void;
+
+    /* -------------------------------------------- */
+    /*  Public API                                  */
+    /* -------------------------------------------- */
+
+    override changeTab(tab: string, group: string, options?: { event?: Event; navElement?: HTMLElement; force?: boolean; updatePosition?: boolean }): void;
+
+    /**
+     * Collapse the sidebar.
+     */
+    collapse(): void;
+
+    /**
+     * Expand the sidebar.
+     */
+    expand(): void;
+
+    /**
+     * Toggle the expanded state of the sidebar.
+     * @param expanded Force the expanded state to the provided value, otherwise toggle the state.
+     * @fires {hookEvents:collapseSidebar}
+     */
+    toggleExpanded(expanded?: boolean): void;
+}

package/src/client/applications/sidebar/tabs/_module.d.mts

@@ -0,0 +1,14 @@
+export { default as ActorDirectory } from "./actor-directory.mjs";
+export { default as CardsDirectory } from "./cards-directory.mjs";
+export { default as ChatLog } from "./chat.mjs";
+export { default as CombatTracker } from "./combat-tracker.mjs";
+export * from "./compendium-directory.mjs";
+export { default as CompendiumDirectory } from "./compendium-directory.mjs";
+export * from "./item-directory.mjs";
+export { default as ItemDirectory } from "./item-directory.mjs";
+export { default as JournalDirectory } from "./journal-directory.mjs";
+export { default as MacroDirectory } from "./macro-directory.mjs";
+export { default as PlaylistDirectory } from "./playlist-directory.mjs";
+export { default as RollTableDirectory } from "./roll-table-directory.mjs";
+export { default as SceneDirectory } from "./scene-directory.mjs";
+export { default as Settings } from "./settings.mjs";

package/src/client/applications/sidebar/tabs/actor-directory.d.mts

@@ -0,0 +1,26 @@
+import DocumentDirectory, { DocumentDirectoryConfiguration } from "../document-directory.mjs";
+import { ContextMenuEntry } from "./../../../applications/ux/context-menu.mjs";
+import Actor from "./../../../documents/actor.mjs";
+
+/**
+ * The World Actor directory listing.
+ */
+export default class ActorDirectory<TDocument extends Actor<null> = Actor<null>> extends DocumentDirectory<TDocument> {
+    static override DEFAULT_OPTIONS: DeepPartial<DocumentDirectoryConfiguration>;
+
+    static override tabName: "actors";
+
+    /* -------------------------------------------- */
+    /*  Rendering                                   */
+    /* -------------------------------------------- */
+
+    protected override _getEntryContextOptions(): ContextMenuEntry[];
+
+    /* -------------------------------------------- */
+    /*  Drag & Drop                                 */
+    /* -------------------------------------------- */
+
+    protected override _canDragStart(): boolean;
+
+    protected override _onDragStart(event: DragEvent): void;
+}

package/src/client/applications/sidebar/tabs/cards-directory.d.mts

@@ -0,0 +1,19 @@
+import DocumentDirectory from "../document-directory.mjs";
+import { ApplicationConfiguration } from "./../../../applications/_types.mjs";
+import { ContextMenuEntry } from "./../../../applications/ux/context-menu.mjs";
+import Cards from "./../../../documents/cards.mjs";
+
+/**
+ * The World Cards directory listing.
+ */
+export default class CardsDirectory extends DocumentDirectory<Cards> {
+    static override DEFAULT_OPTIONS: Partial<ApplicationConfiguration>;
+
+    static override tabName: "cards";
+
+    /* -------------------------------------------- */
+    /*  Rendering                                   */
+    /* -------------------------------------------- */
+
+    protected override _getEntryContextOptions(): ContextMenuEntry[];
+}