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

package/src/foundry/client/ui/notifications.d.ts

@@ -1,110 +0,0 @@
-/**
- * A common framework for displaying notifications to the client.
- * Submitted notifications are added to a queue, and up to 3 notifications are displayed at once.
- * Each notification is displayed for 5 seconds at which point further notifications are pulled from the queue.
- *
- * @example
- * ```typescript
- * ui.notifications.info("This is an info message");
- * ui.notifications.warn("This is a warning message");
- * ui.notifications.error("This is an error message");
- * ui.notifications.info("This is a 4th message which will not be shown until the first info message is done");
- * ```
- *
- * @typeParam Options - the type of the options object
- */
-declare class Notifications<Options extends ApplicationOptions = ApplicationOptions> extends Application<Options> {
-  constructor(options?: Partial<Options>);
-
-  /**
-   * Submitted notifications which are queued for display
-   * @defaultValue `[]`
-   */
-  queue: Notifications.Notification[];
-
-  /**
-   * Notifications which are currently displayed
-   * @defaultValue `[]`
-   */
-  active: JQuery[];
-
-  /**
-   * @defaultValue
-   * ```typescript
-   * mergeObject(super.defaultOptions, {
-   *   popOut: false,
-   *   id: "notifications",
-   *   template: "templates/hud/notifications.html"
-   * });
-   * ```
-   */
-  static override get defaultOptions(): ApplicationOptions;
-
-  /**
-   * Initialize the Notifications system by displaying any system-generated messages which were passed from the server.
-   */
-  initialize(): void;
-
-  protected override _renderInner(data: object): Promise<JQuery>;
-
-  protected override _render(force?: boolean, options?: Application.RenderOptions<Options>): Promise<void>;
-
-  /**
-   * Push a new notification into the queue
-   * @param message   - The content of the notification message
-   * @param type      - The type of notification, currently "info", "warning", and "error" are supported
-   *                    (default: `'info'`)
-   * @param options   - Additional options which affect the notification
-   *                    (default: `{}`)
-   */
-  notify(message: string, type?: 'info' | 'warning' | 'error', options?: Notifications.Options): void;
-
-  /**
-   * Display a notification with the "info" type
-   * @param message - The content of the notification message
-   * @param options - Notification options passed to the notify function
-   */
-  info(message: string, options?: Notifications.Options): void;
-
-  /**
-   * Display a notification with the "warning" type
-   * @param message - The content of the notification message
-   * @param options - Notification options passed to the notify function
-   */
-  warn(message: string, options?: Notifications.Options): void;
-
-  /**
-   * Display a notification with the "error" type
-   * @param message - The content of the notification message
-   * @param options - Notification options passed to the notify function
-   */
-  error(message: string, options?: Notifications.Options): void;
-
-  /**
-   * Retrieve a pending notification from the queue and display it
-   */
-  protected fetch(): void;
-}
-
-declare namespace Notifications {
-  interface Options {
-    /**
-     * Whether the notification should be permanently displayed unless otherwise dismissed
-     * @defaultValue `false`
-     */
-    permanent?: boolean;
-
-    /**
-     * Whether to localize the message content before displaying it
-     * @defaultValue `false`
-     */
-    localize?: boolean;
-  }
-
-  interface Notification {
-    message: string;
-    type: 'info' | 'warning' | 'error';
-    timestamp: number;
-    permanent: boolean;
-  }
-}

package/src/foundry/client/ui/tabs.d.ts

@@ -1,103 +0,0 @@
-declare interface TabsConfiguration {
-  /**
-   * The CSS selector used to target the navigation element for these tabs
-   */
-  navSelector: string;
-
-  /**
-   * The CSS selector used to target the content container for these tabs
-   */
-  contentSelector?: string;
-
-  /**
-   * The tab name of the initially active tab
-   */
-  initial?: string;
-
-  /**
-   * An optional callback function that executes when the active tab is changed
-   */
-  callback?: ((event: MouseEvent | null, tabs: Tabs, tabName: string) => unknown) | null;
-}
-
-/**
- * A controller class for managing tabbed navigation within an Application instance.
- * @see {@link Application}
- *
- * @example
- * ```html
- * <!-- Example HTML -->
- * <nav class="tabs" data-group="primary-tabs">
- *   <a class="item" data-tab="tab1">Tab 1</li>
- *   <a class="item" data-tab="tab2">Tab 2</li>
- * </nav>
- *
- * <section class="content">
- *   <div class="tab" data-tab="tab1" data-group="primary-tabs">Content 1</div>
- *   <div class="tab" data-tab="tab2" data-group="primary-tabs">Content 2</div>
- * </section>
- * ```
- * @example
- * ```typescript
- * // JavaScript
- * const tabs = new Tabs({navSelector: ".tabs", contentSelector: ".content", initial: "tab1"});
- * tabs.bind(html);
- * ```
- */
-declare class Tabs {
-  /**
-   * @param config - The Tabs Configuration to use for this tabbed container
-   */
-  constructor(config: TabsConfiguration);
-
-  /**
-   * The value of the active tab
-   */
-  active: TabsConfiguration['initial'];
-
-  /**
-   * A callback function to trigger when the tab is changed
-   */
-  callback: TabsConfiguration['callback'];
-
-  /**
-   * The CSS selector used to target the tab navigation element
-   */
-  protected _navSelector: TabsConfiguration['navSelector'];
-
-  /**
-   * A reference to the HTML navigation element the tab controller is bound to
-   * @defaultValue `null`
-   */
-  protected _nav: HTMLElement | null;
-
-  /**
-   * The CSS selector used to target the tab content element
-   */
-  protected _contentSelector: TabsConfiguration['contentSelector'];
-
-  /**
-   * A reference to the HTML container element of the tab content
-   * @defaultValue `null`
-   */
-  protected _content: HTMLElement | null;
-
-  /**
-   * Bind the Tabs controller to an HTML application
-   */
-  bind(html: HTMLElement): void;
-
-  /**
-   * Activate a new tab by name
-   * @param triggerCallback - (default: `false`)
-   */
-  activate(tabName: string, { triggerCallback }?: { triggerCallback?: boolean }): void;
-
-  /**
-   * Handle click events on the tab navigation entries
-   * @param event - A left click event
-   */
-  protected _onClickNav(event: MouseEvent): void;
-}
-
-declare const TabsV2: typeof Tabs;

package/src/foundry/common/abstract/backend.mjs.d.ts

@@ -1,253 +0,0 @@
-import { BaseUser } from '../documents.mjs';
-import { AnyDocumentData } from './data.mjs';
-import Document from './document.mjs';
-
-/**
- * An interface shared by both the client and server-side which defines how creation, update, and deletion operations are transacted.
- */
-declare abstract class DatabaseBackend {
-  /**
-   * Retrieve Documents based on provided query parameters
-   * @param documentClass - The Document definition
-   * @param request       - The requested operation
-   * @param user          - The requesting User
-   * @returns The created Document instances
-   */
-  get<T extends Document<any, any>>(documentClass: ConstructorOf<T>, request: Request, user: BaseUser): T[];
-
-  /**
-   * Validate the arguments passed to the get operation
-   * @param query   - A document search query to execute
-   *                  (default: `{}`)
-   * @param options - Operation options
-   *                  (default: `{}`)
-   * @param pack    - A Compendium pack identifier
-   */
-  protected _getArgs({ query, options, pack }?: Request): { query: object; options: RequestOptions; pack?: string };
-
-  /**
-   * Get primary Document instances
-   * @remarks
-   * foundry actually declares this function to take parameters `documentClass`, `query`, `options`, and `user` but
-   * that's not how it is called and also not how the subclasses implement it.
-   * See https://gitlab.com/foundrynet/foundryvtt/-/issues/6177
-   */
-  protected abstract _getDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Get embedded Document instances
-   * @remarks
-   * foundry actually declares this function to take parameters `documentClass`, `parent`, `query`, `options`, and
-   * `user` but that's not how it is called and also not how the subclasses implement it.
-   * See https://gitlab.com/foundrynet/foundryvtt/-/issues/6177
-   */
-  protected abstract _getEmbeddedDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    parent: T extends Document<any, infer U> ? U : never,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Get the parent Document (if any) associated with a request
-   * @param request - The requested operation
-   * @returns The parent Document, or null
-   *
-   * @remarks Actually, this returns `undefined` if  there is no parent, the JSDoc is incorrect.
-   */
-  protected _getParent(request: Request): Promise<Document<any, any> | undefined>;
-
-  /**
-   * Perform document creation operations
-   * @param documentClass - The Document definition
-   * @param request       - The requested operation
-   * @param user          - The requesting User
-   * @returns The created Document instances
-   */
-  create<T extends Document<any, any>>(documentClass: ConstructorOf<T>, request: Request, user: BaseUser): Promise<T[]>;
-
-  /**
-   * Validate the arguments passed to the create operation
-   * @param data    - An array of document data
-   *                  (default: `[]`)
-   * @param options - Operation options
-   *                  (default: `{}`)
-   * @param pack    - A Compendium pack identifier
-   */
-  protected _createArgs({ data, options, pack }?: Request): {
-    data: AnyDocumentData[];
-    options: RequestOptions;
-    pack?: string;
-  };
-
-  /**
-   * Create primary Document instances
-   */
-  protected abstract _createDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Create embedded Document instances
-   */
-  protected abstract _createEmbeddedDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    parent: T extends Document<any, infer U> ? U : never,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Perform document update operations
-   * @param documentClass - The Document definition
-   * @param request       - The requested operation
-   * @param user          - The requesting User
-   * @returns The updated Document instances
-   */
-  update<T extends Document<any, any>>(documentClass: ConstructorOf<T>, request: Request, user: BaseUser): Promise<T[]>;
-
-  /**
-   * Validate the arguments passed to the update operation
-   * @param updates - An array of document data
-   *                  (default: `[]`)
-   * @param options - Operation options
-   *                  (default: `{}`)
-   * @param pack    - A Compendium pack identifier
-   */
-  protected _updateArgs({ updates, options, pack }?: Request): {
-    updates: AnyDocumentData[];
-    options: RequestOptions;
-    pack?: string;
-  };
-
-  /**
-   * Update primary Document instances
-   */
-  protected abstract _updateDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Update embedded Document instances
-   */
-  protected abstract _updateEmbeddedDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    parent: T extends Document<any, infer U> ? U : never,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Perform document deletion operations
-   * @param documentClass - The Document definition
-   * @param request       - The requested operation
-   * @param user          - The requesting User
-   * @returns The deleted Document instances
-   */
-  delete<T extends Document<any, any>>(documentClass: ConstructorOf<T>, request: Request, user: BaseUser): Promise<T[]>;
-
-  /**
-   * Validate the arguments passed to the delete operation
-   * @param request - The requested operation
-   * @param ids     - An array of document ids
-   *                  (default: `[]`)
-   * @param options - Operation options
-   *                  (default: `{}`)
-   * @param pack    - A Compendium pack identifier
-   */
-  protected _deleteArgs({ ids, options, pack }?: Request): { ids: string[]; options: RequestOptions; pack?: string };
-
-  /**
-   * Delete primary Document instances
-   */
-  protected abstract _deleteDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Delete embedded Document instances
-   */
-  protected abstract _deleteEmbeddedDocuments<T extends Document<any, any>>(
-    documentClass: ConstructorOf<T>,
-    parent: T extends Document<any, infer U> ? U : never,
-    request: Request,
-    user: BaseUser
-  ): Promise<T[]>;
-
-  /**
-   * Describe the scopes which are suitable as the namespace for a flag key
-   */
-  protected getFlagScopes(): string[];
-
-  /**
-   * Describe the scopes which are suitable as the namespace for a flag key
-   */
-  protected getCompendiumScopes(): string[];
-
-  /**
-   * Provide the Logger implementation that should be used for database operations
-   */
-  protected _getLogger(): Console;
-
-  /**
-   * Log a database operation for an embedded document, capturing the action taken and relevant IDs
-   * @param action    - The action performed
-   * @param type      - The document type
-   * @param documents - The documents modified
-   * @param level     - The logging level
-   *                    (default: `'info'`)
-   * @param parent    - A parent document
-   * @param pack      - A compendium pack within which the operation occurred
-   */
-  protected _logOperation(
-    action: string,
-    type: string,
-    documents: Document<any, any>[],
-    { parent, pack, level }?: { parent?: Document<any, any>; pack?: string; level?: string }
-  ): void;
-
-  /**
-   * Construct a standardized error message given the context of an attempted operation
-   */
-  protected _logError(
-    user: BaseUser,
-    action: string,
-    subject: Document<any, any> | string,
-    { parent, pack }?: { parent?: Document<any, any>; pack?: string }
-  ): string;
-
-  /**
-   * Determine a string suffix for a log message based on the parent and/or compendium context.
-   */
-  protected _logContext({ parent, pack }?: { parent?: Document<any, any>; pack?: string }): string;
-}
-
-export interface Request {
-  data?: AnyDocumentData[];
-  updates?: AnyDocumentData[];
-  ids?: string[];
-  parent?: Document<any, any>;
-  query?: Record<string, unknown>;
-  options?: RequestOptions;
-  pack?: string;
-}
-
-export interface RequestOptions {
-  index?: boolean;
-  broadcast?: boolean;
-  temporary?: boolean;
-  nohook?: boolean;
-  [key: string]: unknown;
-}
-
-export default DatabaseBackend;