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

package/src/foundry/client/apps/sidebar/apps/controls-reference.d.ts

@@ -1,30 +0,0 @@
-/**
- * Keyboard Controls Reference Sheet
- * @typeParam Options - the type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- * @deprecated since v9
- */
-declare class ControlsReference<
-  Options extends ApplicationOptions = ApplicationOptions,
-  Data extends object = ControlsReference.Data
-> extends Application<Options> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * const options = super.defaultOptions;
-   * options.title = game.i18n.localize("CONTROLS.Title");
-   * options.id = "controls-reference";
-   * options.template = "templates/sidebar/apps/controls-reference.html";
-   * options.width = 600;
-   * ```
-   */
-  static get defaultOptions(): ApplicationOptions;
-
-  override getData(options?: Partial<Options>): Data | Promise<Data>;
-}
-
-declare namespace ControlsReference {
-  interface Data {
-    controlKey: '⌘' | 'Control';
-  }
-}

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

@@ -1,10 +0,0 @@
-import './chat-popout';
-import './client-settings';
-import './compendium';
-import './controls-reference';
-import './invitation-links';
-import './keybindings-config';
-import './module-management';
-import './permission-config';
-import './support-details';
-import './world-config';

package/src/foundry/client/apps/sidebar/apps/invitation-links.d.ts

@@ -1,37 +0,0 @@
-/**
- * Game Invitation Links Reference
- *
- * @typeParam Options - the type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class InvitationLinks<
-  Options extends ApplicationOptions = ApplicationOptions,
-  Data extends object = InvitationLinks.Data
-> extends Application<Options> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   id: "invitation-links",
-   *   template: "templates/sidebar/apps/invitation-links.html",
-   *   title: game.i18n.localize("INVITATIONS.Title"),
-   *   width: 400
-   * })
-   * ```
-   */
-  static override get defaultOptions(): ApplicationOptions;
-
-  override getData(options?: Partial<Options> | undefined): Promise<Data>;
-
-  override activateListeners(html: JQuery): void;
-}
-
-declare namespace InvitationLinks {
-  type Adddresses = Game.Data['addresses'];
-  interface Data extends Adddresses {
-    remoteClass?: string;
-    remoteTitle?: string;
-    failedCheck?: boolean;
-    canConnect?: boolean;
-  }
-}

package/src/foundry/client/apps/sidebar/apps/keybindings-config.d.ts

@@ -1,247 +0,0 @@
-/**
- * Allows for viewing and editing of Keybinding Actions
- */
-declare class KeybindingsConfig<
-  Options extends FormApplicationOptions = FormApplicationOptions,
-  Data extends KeybindingsConfig.Data = KeybindingsConfig.Data
-> extends FormApplication<Options, Data> {
-  /**
-   * A cached copy of the Categories
-   */
-  protected _cachedData: KeybindingsConfig.CategoryData | null;
-
-  /**
-   * The category being filtered for
-   */
-  protected _category: string;
-
-  /**
-   * A Map of pending Edits. The Keys are bindingIds
-   * @internal
-   */
-  protected _pendingEdits: Map<string, KeybindingsConfig.PendingBinding[]>;
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   title: game.i18n.localize("SETTINGS.Keybindings"),
-   *   id: "keybindings",
-   *   template: "templates/sidebar/apps/keybindings-config.html",
-   *   width: 750,
-   *   height: 600,
-   *   resizable: true,
-   *   scrollY: [".filters", ".category-list"],
-   *   filters: [{inputSelector: 'input[name="filter"]', contentSelector: ".category-list"}]
-   * })
-   * ```
-   */
-  static override get defaultOptions(): FormApplicationOptions;
-
-  override getData(options?: Partial<Options>): Data;
-
-  /**
-   * Builds the set of Bindings into a form usable for display and configuration
-   * @internal
-   */
-  protected _getCategoryData(): KeybindingsConfig.CategoryData;
-
-  /**
-   * Add faux-keybind actions that represent the possible Mouse Controls
-   * @param categories - The current Map of Categories to add to
-   * @returns The number of Actions added
-   * @internal
-   */
-  protected _addMouseControlsReference(categories: Map<string, KeybindingsConfig.Category>): number;
-
-  /**
-   * Given an Binding and its parent Action, detects other Actions that might conflict with that binding
-   * @param actionId - The namespaced Action ID the Binding belongs to
-   * @param action   - The Action config
-   * @param binding  - The Binding
-   * @internal
-   */
-  protected _detectConflictingActions(
-    actionId: string,
-    action: KeybindingActionConfig,
-    binding: KeybindingActionBinding
-  ): KeybindingAction[];
-
-  /**
-   * Transforms a Binding into a human readable string representation
-   * @param binding - The Binding
-   * @returns A human readable string
-   * @internal
-   */
-  protected static _humanizeBinding(binding: KeybindingActionBinding): string;
-
-  /**
-   * Compares two Category Filters for rendering
-   * This method ignores cases of equality because we know our categories are unique
-   * @param a - The first Category
-   * @param b - The second Category
-   * @returns A number for usage in the Sort method
-   * @internal
-   */
-  protected static _sortCategories(a: KeybindingsConfig.Category, b: KeybindingsConfig.Category): number;
-
-  /**
-   * Classify what Category an Action belongs to
-   * @param action - The Action to classify
-   * @returns The category the Action belongs to
-   * @internal
-   */
-  protected _categorizeAction(action: KeybindingsConfig): KeybindingsConfig.BaseCategory;
-
-  override activateListeners(html: JQuery): void;
-
-  /**
-   * Handle left-click events to filter to a certain category
-   * @internal
-   */
-  protected _onClickCategoryFilter(event: MouseEvent): void;
-
-  /**
-   * Handle left-click events to show / hide a certain category
-   * @internal
-   */
-  protected _onClickCategoryCollapse(event: MouseEvent): void;
-
-  /**
-   * Handle left-click events to reset all Actions to Default
-   * @internal
-   */
-  protected _onClickResetActions(event: MouseEvent): Promise<void>;
-
-  /**
-   * Handle Control clicks
-   * @internal
-   */
-  protected _onClickBindingControl(event: MouseEvent): void;
-
-  /**
-   * Handle left-click events to show / hide a certain category
-   * @internal
-   */
-  protected _onClickAdd(event: MouseEvent): Promise<void>;
-
-  /**
-   * Handle left-click events to show / hide a certain category
-   * @internal
-   */
-  protected _onClickDelete(event: MouseEvent): Promise<void>;
-
-  /**
-   * Inserts a Binding into the Pending Edits object, creating a new Map entry as needed
-   * @internal
-   */
-  protected _addPendingEdit(
-    namespace: string,
-    action: string,
-    bindingIndex: number,
-    binding: KeybindingsConfig.PendingBinding
-  ): void;
-
-  /**
-   * Toggle visibility of the Edit / Save UI
-   * @internal
-   */
-  protected _onClickEditableBinding(event: MouseEvent): void;
-
-  /**
-   * Toggle visibility of the Edit UI
-   * @internal
-   */
-  protected _onDoubleClickKey(event: MouseEvent): void;
-
-  /**
-   * Save the new Binding value and update the display of the UI
-   * @internal
-   */
-  protected _onClickSaveBinding(event: MouseEvent): Promise<void>;
-
-  /**
-   * Given a clicked Action element, finds the parent Action
-   * @internal
-   */
-  protected _getParentAction(event: KeyboardEvent | MouseEvent): {
-    namespace: string;
-    action: string;
-    actionHtml: HTMLElement;
-  };
-
-  /**
-   * Given a Clicked binding control element, finds the parent Binding
-   * @internal
-   */
-  protected _getParentBinding(event: KeyboardEvent | MouseEvent): { bindingHtml: HTMLElement; bindingId: string };
-
-  /**
-   * Iterates over all Pending edits, merging them in with unedited Bindings and then saving and resetting the UI
-   * @internal
-   */
-  protected _savePendingEdits(): Promise<void>;
-
-  /**
-   * Processes input from the keyboard to form a list of pending Binding edits
-   * @param event - The keyboard event
-   * @internal
-   */
-  protected _onKeydownBindingInput(event: KeyboardEvent): void;
-
-  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-
-  /** @remarks KeybindingsConfig does not implement this method. */
-  protected _updateObject(event?: unknown, formData?: unknown): Promise<never>;
-}
-
-declare namespace KeybindingsConfig {
-  interface Data extends CategoryData {
-    categories: DataCategory[];
-    allActive: boolean;
-  }
-
-  interface DataCategory extends Category {
-    active: boolean;
-    hidden: boolean;
-  }
-
-  interface CategoryData {
-    categories: Category[];
-    totalActions: number;
-  }
-
-  interface BaseCategory {
-    id: string;
-    title: string;
-  }
-
-  interface Category extends BaseCategory {
-    actions: ActionData[];
-    count: number;
-  }
-
-  interface ActionData extends KeybindingActionConfig {
-    category: string;
-    bindings: DisplayBinding[];
-    id: string;
-    name: string;
-    hint?: string;
-    cssClass?: string;
-    notes: string;
-  }
-
-  interface DisplayBinding extends Partial<KeybindingActionBinding> {
-    id: string;
-    display: string;
-    cssClasses: string;
-    isEditable: boolean;
-    isFirst: boolean;
-    conflicts: string;
-    hasConflicts: boolean;
-  }
-
-  interface PendingBinding extends KeybindingActionBinding {
-    index: number;
-  }
-}

package/src/foundry/client/apps/sidebar/apps/module-management.d.ts

@@ -1,120 +0,0 @@
-/**
- * The Module Management Application.
- * This application provides a view of which modules are available to be used and allows for configuration of the
- * set of modules which are active within the World.
- * @typeParam Options - The type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class ModuleManagement<
-  Options extends FormApplicationOptions = FormApplicationOptions,
-  Data extends object = ModuleManagement.Data
-> extends FormApplication<Options, Data, undefined> {
-  /** @internal */
-  protected _filter: ModuleManagement.FilterName;
-
-  /**
-   * @defaultValue `true`
-   * @internal
-   */
-  protected _expanded: boolean;
-
-  /**
-   * The named game setting which persists module configuration.
-   */
-  static CONFIG_SETTING: 'moduleConfiguration';
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   title: game.i18n.localize("MODMANAGE.Title"),
-   *   id: "module-management",
-   *   template: "templates/sidebar/apps/module-management.html",
-   *   popOut: true,
-   *   width: 680,
-   *   height: "auto",
-   *   scrollY: [".package-list"],
-   *   closeOnSubmit: false,
-   *   filters: [{inputSelector: 'input[name="search"]', contentSelector: ".package-list"}]
-   * });
-   * ```
-   */
-  static override get defaultOptions(): FormApplicationOptions;
-
-  override get isEditable(): boolean;
-
-  override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-  override activateListeners(html: JQuery): void;
-
-  protected override _renderInner(data: Data): Promise<JQuery>;
-
-  protected override _updateObject(event: Event, formData: ModuleManagement.FormData): Promise<unknown>;
-
-  /**
-   * Handle changes to a module checkbox to prompt for whether or not to enable dependencies
-   * @internal
-   */
-  protected _onChangeCheckbox(event: JQuery.ChangeEvent): unknown;
-
-  /**
-   * Handle a button-click to deactivate all modules
-   * @internal
-   */
-  protected _onDeactivateAll(event: JQuery.ClickEvent): void;
-
-  /**
-   * Handle expanding or collapsing the display of descriptive elements
-   * @internal
-   */
-  protected _onExpandCollapse(event: JQuery.ClickEvent): void;
-
-  /**
-   * Handle a button-click to deactivate all modules
-   * @internal
-   */
-  protected _onFilterList(event: JQuery.ClickEvent): void;
-
-  protected override _onSearchFilter(event: KeyboardEvent, query: string, rgx: RegExp, html: HTMLElement): void;
-}
-
-declare namespace ModuleManagement {
-  interface Data {
-    editable: boolean;
-    filters: [Data.Filter<'all'>, Data.Filter<'active'>, Data.Filter<'inactive'>];
-    modules: Data.Module[];
-    expanded: boolean;
-  }
-
-  namespace Data {
-    interface Filter<F extends FilterName> {
-      id: F;
-      label: string;
-      css: ' active' | '';
-      count: number;
-    }
-
-    type Module = Exclude<foundry.packages.ModuleData['_source'], 'authors'> & {
-      active: boolean;
-      availability: number;
-      data: foundry.packages.ModuleData;
-      css: string;
-      hasPacks: boolean;
-      hasScripts: boolean;
-      hasStyles: boolean;
-      systemOnly: boolean;
-      systemTag: Game['system']['id'];
-      dependencies: string[] | null;
-      unavailable?: string;
-      incompatible?: string;
-      authors: string | undefined;
-      labels: string;
-    };
-  }
-
-  type FilterName = 'all' | 'active' | 'inactive';
-
-  type FormData = Record<string, boolean> & {
-    search: string;
-  };
-}

package/src/foundry/client/apps/sidebar/apps/permission-config.d.ts

@@ -1,64 +0,0 @@
-/**
- * An application for configuring the permissions which are available to each User role.
- */
-declare class PermissionConfig extends FormApplication<FormApplicationOptions, PermissionConfig.Data> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   title: game.i18n.localize("PERMISSION.Title"),
-   *   id: "permissions-config",
-   *   template: "templates/sidebar/apps/permission-config.html",
-   *   width: 660,
-   *   height: "auto",
-   *   scrollY: [".permissions-list"],
-   *   closeOnSubmit: true
-   * })
-   * ```
-   */
-  static override get defaultOptions(): typeof FormApplication['defaultOptions'];
-
-  override getData(options?: Partial<FormApplicationOptions>): PermissionConfig.Data;
-
-  /**
-   * Prepare the permissions object used to render the configuration template
-   */
-  protected _getPermissions(current: Game.Permissions): PermissionConfig.Permission[];
-
-  override activateListeners(html: JQuery): void;
-
-  /**
-   * Handle button click to reset default settings
-   * @param event - The initial button click event
-   */
-  protected _onResetDefaults(event: JQuery.ClickEvent): void;
-
-  protected override _onSubmit(
-    event: Event,
-    options?: FormApplication.OnSubmitOptions
-  ): ReturnType<FormApplication['_onSubmit']>;
-
-  protected override _updateObject(event: Event, formData: PermissionConfig.FormData): Promise<unknown>;
-}
-
-declare namespace PermissionConfig {
-  interface Data {
-    roles: { [Key in Exclude<keyof typeof foundry.CONST['USER_ROLES'], 'NONE'>]: `USER.Role${Titlecase<Key>}` };
-    permissions: ReturnType<PermissionConfig['_getPermissions']>;
-  }
-
-  type FormData = Record<string, boolean>;
-
-  interface Permission extends foundry.CONST.UserCapability {
-    id: string;
-    roles: Permission.Role[];
-  }
-
-  namespace Permission {
-    interface Role {
-      name: string;
-      value: boolean;
-      disabled: boolean;
-    }
-  }
-}

package/src/foundry/client/apps/sidebar/apps/support-details.d.ts

@@ -1,76 +0,0 @@
-/**
- * Support Info and Report
- * @typeParam Options - the type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class SupportDetails<
-  Options extends ApplicationOptions = ApplicationOptions,
-  Data extends object = SupportDetails.Data
-> extends Application<Options> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * const options = super.defaultOptions;
-   * options.title = "SUPPORT.Title";
-   * options.id = "support-details";
-   * options.template = "templates/sidebar/apps/support-details.html";
-   * options.width = 620;
-   * options.height = "auto";
-   * return options;
-   * ```
-   */
-  static override get defaultOptions(): ApplicationOptions;
-
-  /**
-   * Returns the support report data
-   */
-  getData(options?: Partial<Options> | undefined): Data | Promise<Data>;
-
-  /**
-   * Binds the Support Report copy button
-   */
-  override activateListeners(html: JQuery): void;
-
-  /**
-   * Collects a number of metrics that is useful for Support
-   */
-  static generateSupportReport(): SupportReportData;
-
-  /**
-   * Get a WebGL renderer information string
-   * @param gl - The rendering context
-   * @returns The unmasked renderer string
-   */
-  static getWebGLRendererInfo(gl: WebGLRenderingContext): string;
-}
-
-interface SupportReportData {
-  coreVersion: number;
-  systemVersion: string;
-  activeModuleCount: number;
-  os: string;
-  client: string;
-  gpu: string;
-  maxTextureSize: number | string;
-  sceneDimensions: string;
-  grid: number;
-  padding: number;
-  walls: number;
-  lights: number;
-  sounds: number;
-  tiles: number;
-  tokens: number;
-  actors: number;
-  items: number;
-  journals: number;
-  tables: number;
-  playlists: number;
-  packs: number;
-  messages: number;
-}
-
-declare namespace SupportDetails {
-  interface Data {
-    report: SupportReportData;
-  }
-}

package/src/foundry/client/apps/sidebar/apps/world-config.d.ts

@@ -1,77 +0,0 @@
-interface WorldConfigOptions extends FormApplicationOptions {
-  /**
-   * Whether the world is being created or updated.
-   * @defaultValue `false`
-   */
-  create: boolean;
-
-  inWorld?: boolean | undefined;
-}
-
-/**
- * The World Management setup application
- * @typeParam Options - The type of the options object
- * @typeParam Data    - The data structure used to render the handlebars template.
- */
-declare class WorldConfig<
-  Options extends WorldConfigOptions = WorldConfigOptions,
-  Data extends object = WorldConfig.Data
-> extends FormApplication<Options, Data, Game.WorldData<foundry.packages.WorldData>> {
-  /**
-   * @defaultValue
-   * ```typescript
-   * foundry.utils.mergeObject(super.defaultOptions, {
-   *   id: "world-config",
-   *   template: "templates/sidebar/apps/world-config.html",
-   *   width: 600,
-   *   height: "auto",
-   *   create: false,
-   * })
-   * ```
-   */
-  static override get defaultOptions(): WorldConfigOptions;
-
-  static WORLD_KB_URL: 'https://foundryvtt.com/article/game-worlds/';
-
-  override get title(): string;
-
-  override activateListeners(html: JQuery): void;
-
-  override getData(options?: Partial<Options>): Data | Promise<Data>;
-
-  /**
-   * @remarks This method returns `Promise<void>`.
-   */
-  protected override _onSubmit(event: Event): Promise<any>;
-
-  /**
-   * @remarks This method does not exist on WorldConfig and only exists to make the typescript compile!
-   */
-  protected _updateObject(...args: unknown[]): Promise<unknown>;
-
-  /**
-   * Update the world name placeholder when the title is changed.
-   * @internal
-   */
-  protected _onTitleChange(event: JQuery.TriggeredEvent): void;
-
-  override activateEditor(
-    name: string,
-    options?: TextEditor.Options | undefined,
-    initialContent?: string | undefined
-  ): void;
-}
-
-declare namespace WorldConfig {
-  interface Data {
-    world: Game.WorldData<foundry.packages.WorldData>;
-    isCreate: boolean;
-    submitText: string;
-    nextDate: string;
-    nextTime: string;
-    worldKbUrl: typeof WorldConfig['WORLD_KB_URL'];
-    inWorld: boolean;
-    showEditFields: boolean;
-    systems?: Game.SystemData<foundry.packages.SystemData>[];
-  }
-}

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

@@ -1,5 +0,0 @@
-import './apps';
-import './tabs';
-import './sidebar';
-import './tab-base';
-import './tab-directory';