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

package/src/foundry/common/documents.mjs/baseNote.d.ts

@@ -1,39 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import { BaseScene } from './baseScene';
-import { BaseUser } from './baseUser';
-
-type NoteMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Note';
-    collection: 'notes';
-    label: 'DOCUMENT.Note';
-    labelPlural: 'DOCUMENT.Notes';
-    isEmbedded: true;
-    permissions: {
-      create: 'NOTE_CREATE';
-    };
-  }
->;
-
-/**
- * The base Note model definition which defines common behavior of an Note document between both client and server.
- */
-export declare class BaseNote extends Document<
-  data.NoteData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
-  NoteMetadata
-> {
-  static override get schema(): typeof data.NoteData;
-
-  static override get metadata(): NoteMetadata;
-
-  override testUserPermission(
-    user: BaseUser,
-    permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
-    { exact }?: { exact?: boolean }
-  ): boolean;
-}

package/src/foundry/common/documents.mjs/basePlaylist.d.ts

@@ -1,32 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import { BasePlaylistSound } from './basePlaylistSound';
-
-type PlaylistMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Playlist';
-    collection: 'playlists';
-    label: 'DOCUMENT.Playlist';
-    labelPlural: 'DOCUMENT.Playlists';
-    embedded: {
-      PlaylistSound: typeof BasePlaylistSound;
-    };
-    isPrimary: true;
-  }
->;
-
-/**
- * The base Playlist model definition which defines common behavior of an Playlist document between both client and server.
- */
-export declare class BasePlaylist extends Document<data.PlaylistData, null, PlaylistMetadata> {
-  static override get schema(): typeof data.PlaylistData;
-
-  static override get metadata(): PlaylistMetadata;
-
-  /**
-   * A reference to the Collection of ActiveEffect instances in the Actor document, indexed by _id.
-   */
-  get sounds(): this['data']['sounds'];
-}

package/src/foundry/common/documents.mjs/basePlaylistSound.d.ts

@@ -1,37 +0,0 @@
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-
-import type { BasePlaylist } from './basePlaylist';
-import type { BaseUser } from './baseUser';
-import type { DocumentMetadata } from '../abstract/document.mjs';
-import type { ConfiguredDocumentClass } from '../../../types/helperTypes';
-
-type PlaylistSoundMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'PlaylistSound';
-    collection: 'sounds';
-    label: 'DOCUMENT.PlaylistSound';
-    labelPlural: 'DOCUMENT.PlaylistSounds';
-    isEmbedded: true;
-  }
->;
-
-/**
- * The PlaylistSound model definition which defines common behaviour of a PlaylistSound document between both client and server.
- */
-export declare class BasePlaylistSound extends Document<
-  data.PlaylistSoundData,
-  InstanceType<ConfiguredDocumentClass<typeof BasePlaylist>>,
-  PlaylistSoundMetadata
-> {
-  static override get schema(): typeof data.PlaylistSoundData;
-
-  static override get metadata(): PlaylistSoundMetadata;
-
-  override testUserPermission(
-    user: BaseUser,
-    permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
-    { exact }?: { exact?: boolean }
-  ): boolean;
-}

package/src/foundry/common/documents.mjs/baseRollTable.d.ts

@@ -1,31 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import { BaseTableResult } from './baseTableResult';
-
-type RollTableMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'RollTable';
-    collection: 'tables';
-    label: 'DOCUMENT.RollTable';
-    labelPlural: 'DOCUMENT.RollTables';
-    embedded: {
-      TableResult: typeof BaseTableResult;
-    };
-    isPrimary: true;
-  }
->;
-
-/**
- * The base RollTable model definition which defines common behavior of an RollTable document between both client and server.
- */
-export declare class BaseRollTable extends Document<foundry.data.RollTableData, null, RollTableMetadata> {
-  static override get schema(): typeof foundry.data.RollTableData;
-
-  static override get metadata(): RollTableMetadata;
-
-  /**
-   * A reference to the Collection of TableResult instances in this document, indexed by _id.
-   */
-  get results(): this['data']['results'];
-}

package/src/foundry/common/documents.mjs/baseScene.d.ts

@@ -1,120 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import { BaseAmbientLight } from './baseAmbientLight';
-import { BaseAmbientSound } from './baseAmbientSound';
-import { BaseDrawing } from './baseDrawing';
-import { BaseMeasuredTemplate } from './baseMeasuredTemplate';
-import { BaseNote } from './baseNote';
-import { BaseTile } from './baseTile';
-import { BaseToken } from './baseToken';
-import { BaseWall } from './baseWall';
-
-type SceneMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Scene';
-    collection: 'scenes';
-    label: 'DOCUMENT.Scene';
-    labelPlural: 'DOCUMENT.Scenes';
-    isPrimary: true;
-    embedded: {
-      AmbientLight: typeof BaseAmbientLight;
-      AmbientSound: typeof BaseAmbientSound;
-      Drawing: typeof BaseDrawing;
-      MeasuredTemplate: typeof BaseMeasuredTemplate;
-      Note: typeof BaseNote;
-      Tile: typeof BaseTile;
-      Token: typeof BaseToken;
-      Wall: typeof BaseWall;
-    };
-  }
->;
-
-/**
- * The base Scene model definition which defines common behavior of an Scene document between both client and server.
- */
-export declare class BaseScene extends Document<data.SceneData, null, SceneMetadata> {
-  static override get schema(): typeof data.SceneData;
-
-  static override get metadata(): SceneMetadata;
-
-  /**
-   * A reference to the Collection of Drawing instances in the Scene document, indexed by _id.
-   */
-  get drawings(): this['data']['drawings'];
-
-  /**
-   * A reference to the Collection of AmbientLight instances in the Scene document, indexed by _id.
-   */
-  get lights(): this['data']['lights'];
-
-  /**
-   * A reference to the Collection of Note instances in the Scene document, indexed by _id.
-   */
-  get notes(): this['data']['notes'];
-
-  /**
-   * A reference to the Collection of AmbientSound instances in the Scene document, indexed by _id.
-   */
-  get sounds(): this['data']['sounds'];
-
-  /**
-   * A reference to the Collection of MeasuredTemplate instances in the Scene document, indexed by _id.
-   */
-  get templates(): this['data']['templates'];
-
-  /**
-   * A reference to the Collection of Token instances in the Scene document, indexed by _id.
-   */
-  get tokens(): this['data']['tokens'];
-
-  /**
-   * A reference to the Collection of Tile instances in the Scene document, indexed by _id.
-   */
-  get tiles(): this['data']['tiles'];
-
-  /**
-   * A reference to the Collection of Wall instances in the Scene document, indexed by _id.
-   */
-  get walls(): this['data']['walls'];
-
-  /**
-   * Get the Canvas dimensions which would be used to display this Scene.
-   * Apply padding to enlarge the playable space and round to the nearest 2x grid size to ensure symmetry.
-   * @returns An object describing the configured dimensions
-   */
-  static getDimensions({
-    width,
-    height,
-    size,
-    gridDistance,
-    padding,
-    shiftX,
-    shiftY
-  }?: Partial<DimensionsArguments>): Dimensions;
-}
-
-interface DimensionsArguments {
-  width: number;
-  height: number;
-  size: number;
-  gridDistance: number;
-  padding: number;
-  shiftX: number;
-  shiftY: number;
-}
-
-interface Dimensions {
-  sceneWidth: number;
-  sceneHeight: number;
-  size: number;
-  distance: number;
-  shiftX: number;
-  shiftY: number;
-  ratio: number;
-  paddingX: number;
-  width: number;
-  paddingY: number;
-  height: number;
-}

package/src/foundry/common/documents.mjs/baseSetting.d.ts

@@ -1,38 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-
-type SettingMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Setting';
-    collection: 'settings';
-    label: 'DOCUMENT.Setting';
-    labelPlural: 'DOCUMENT.Settings';
-    isPrimary: true;
-    permissions: {
-      create: 'SETTINGS_MODIFY';
-      update: 'SETTINGS_MODIFY';
-      delete: 'SETTINGS_MODIFY';
-    };
-  }
->;
-
-/**
- * The base Setting model definition which defines common behavior of an Setting document between both client and server.
- */
-export declare class BaseSetting extends Document<data.SettingData, null, SettingMetadata> {
-  static override get schema(): typeof data.SettingData;
-
-  static override get metadata(): SettingMetadata;
-
-  /**
-   * A convenience reference to the key which identifies this game setting.
-   */
-  get key(): string;
-
-  /**
-   * The parsed value of the saved setting
-   */
-  get value(): unknown;
-}

package/src/foundry/common/documents.mjs/baseTableResult.d.ts

@@ -1,52 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import type { TableResultDataConstructorData } from '../data/data.mjs/tableResultData';
-import { BaseRollTable } from './baseRollTable';
-import { BaseUser } from './baseUser';
-
-type TableResultMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'TableResult';
-    collection: 'results';
-    label: 'DOCUMENT.TableResult';
-    labelPlural: 'DOCUMENT.TableResults';
-    types: [
-      `${typeof CONST.TABLE_RESULT_TYPES.TEXT}`,
-      `${typeof CONST.TABLE_RESULT_TYPES.DOCUMENT}`,
-      `${typeof CONST.TABLE_RESULT_TYPES.COMPENDIUM}`
-    ];
-    permissions: {
-      update: (user: BaseUser, doc: BaseTableResult, data: DeepPartial<TableResultDataConstructorData>) => boolean;
-    };
-  }
->;
-
-/**
- * The base TableResult model definition which defines common behavior of an TableResult document between both client and server.
- */
-export declare class BaseTableResult extends Document<
-  foundry.data.TableResultData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseRollTable>>,
-  TableResultMetadata
-> {
-  static override get schema(): typeof foundry.data.TableResultData;
-
-  static override get metadata(): TableResultMetadata;
-
-  /**
-   * Is a user able to update an existing TableResult?
-   */
-  protected static _canUpdate(
-    user: BaseUser,
-    doc: BaseTableResult,
-    data: DeepPartial<TableResultDataConstructorData>
-  ): boolean;
-
-  override testUserPermission(
-    user: BaseUser,
-    permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
-    { exact }?: { exact?: boolean }
-  ): boolean;
-}

package/src/foundry/common/documents.mjs/baseTile.d.ts

@@ -1,29 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import { BaseScene } from './baseScene';
-
-type TileMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Tile';
-    collection: 'tiles';
-    label: 'DOCUMENT.Tile';
-    labelPlural: 'DOCUMENT.Tiles';
-    isEmbedded: true;
-  }
->;
-
-/**
- * The base Tile model definition which defines common behavior of an Tile document between both client and server.
- */
-export declare class BaseTile extends Document<
-  data.TileData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
-  TileMetadata
-> {
-  static override get schema(): typeof data.TileData;
-
-  static override get metadata(): TileMetadata;
-}

package/src/foundry/common/documents.mjs/baseToken.d.ts

@@ -1,44 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import type { TokenDataConstructorData } from '../data/data.mjs/tokenData';
-import { BaseUser } from './baseUser';
-
-type TokenMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Token';
-    collection: 'tokens';
-    label: 'DOCUMENT.Token';
-    labelPlural: 'DOCUMENT.Tokens';
-    isEmbedded: true;
-    permissions: {
-      create: 'TOKEN_CREATE';
-      update: (user: BaseUser, doc: BaseToken, data: DeepPartial<TokenDataConstructorData>) => boolean;
-    };
-  }
->;
-
-/**
- * The base Token model definition which defines common behavior of an Token document between both client and server.
- */
-export declare class BaseToken extends Document<
-  data.TokenData,
-  InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>,
-  TokenMetadata
-> {
-  static override get schema(): typeof data.TokenData;
-
-  static override get metadata(): TokenMetadata;
-
-  /**
-   * A convenience reference to the name which should be displayed for the Token
-   */
-  get name(): string;
-
-  /**
-   * Is a user able to update an existing Token?
-   */
-  protected static _canUpdate(user: BaseUser, doc: BaseToken, data: DeepPartial<TokenDataConstructorData>): boolean;
-}

package/src/foundry/common/documents.mjs/baseUser.d.ts

@@ -1,102 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import type { UserDataConstructorData, UserDataSource } from '../data/data.mjs/userData';
-
-type UserMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'User';
-    collection: 'users';
-    label: 'DOCUMENT.User';
-    labelPlural: 'DOCUMENT.Users';
-    isPrimary: true;
-    permissions: {
-      create: (user: BaseUser, doc: BaseUser, data: UserDataSource) => boolean;
-      update: (user: BaseUser, doc: BaseUser, data: DeepPartial<UserDataConstructorData>) => boolean;
-      delete: (user: BaseUser, doc: BaseUser) => boolean;
-    };
-  }
->;
-
-/**
- * The base User model definition which defines common behavior of an User document between both client and server.
- */
-export declare class BaseUser extends Document<data.UserData, null, UserMetadata> {
-  constructor(...args: ConstructorParameters<ConstructorOf<Document<data.UserData, null>>>);
-
-  /**
-   * Define an immutable property for the User's role
-   */
-  readonly role: ValueOf<typeof CONST.USER_ROLES>;
-
-  static override get schema(): typeof data.UserData;
-
-  static override get metadata(): UserMetadata;
-
-  /**
-   * Is a user able to create an existing User?
-   * @param user - The user attempting the creation.
-   * @param doc  - The User document being created.
-   * @param data - The supplied creation data.
-   * @internal
-   */
-  protected static _canCreate(user: BaseUser, doc: BaseUser, data: UserDataSource): boolean;
-
-  /**
-   * Is a user able to update an existing User?
-   * @param user - The user attempting the update.
-   * @param doc  - The User document being updated.
-   * @param data - The update delta.
-   * @internal
-   */
-  protected static _canUpdate(user: BaseUser, doc: BaseUser, data: DeepPartial<UserDataConstructorData>): boolean;
-
-  /**
-   * Is a user able to delete an existing User?
-   * @param user - The user attempting the deletion.
-   * @param doc  - The User document being deleted.
-   * @internal
-   */
-  protected static _canDelete(user: BaseUser, doc: BaseUser): boolean;
-
-  /**
-   * Test whether the User has a GAMEMASTER or ASSISTANT role in this World?
-   */
-  get isGM(): boolean;
-
-  /**
-   * Test whether the User is able to perform a certain permission action.
-   * The provided permission string may pertain to an explicit permission setting or a named user role.
-   * Alternatively, Gamemaster users are assumed to be allowed to take all actions.
-   *
-   * @param action - The action to test
-   * @returns Does the user have the ability to perform this action?
-   */
-  can(
-    action: ValueOf<typeof CONST.USER_ROLES> | keyof typeof CONST.USER_ROLES | keyof typeof CONST.USER_PERMISSIONS
-  ): boolean;
-
-  override getUserLevel(
-    user: BaseUser
-  ): typeof CONST.DOCUMENT_PERMISSION_LEVELS.OWNER | typeof CONST.DOCUMENT_PERMISSION_LEVELS.NONE;
-
-  /**
-   * Test whether the User has at least a specific permission
-   * @param permission - The permission name from USER_PERMISSIONS to test
-   * @returns Does the user have at least this permission
-   */
-  hasPermission(permission: keyof typeof CONST.USER_PERMISSIONS): boolean;
-
-  /**
-   * Test whether the User has at least the permission level of a certain role
-   * @param role  - The role name from USER_ROLES to test
-   * @param exact - Require the role match to be exact
-   *                (default: `false`)
-   * @returns Does the user have at this role level (or greater)?
-   */
-  hasRole(
-    role: ValueOf<typeof CONST.USER_ROLES> | keyof typeof CONST.USER_ROLES,
-    { exact }?: { exact?: boolean }
-  ): boolean;
-}

package/src/foundry/common/documents.mjs/baseWall.d.ts

@@ -1,43 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { Context, DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import type { WallDataConstructorData } from '../data/data.mjs/wallData';
-import { BaseScene } from './baseScene';
-import { BaseUser } from './baseUser';
-
-type WallMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Wall';
-    collection: 'walls';
-    label: 'DOCUMENT.Wall';
-    labelPlural: 'DOCUMENT.Walls';
-    isEmbedded: true;
-    permissions: {
-      update: (user: BaseUser, doc: BaseWall, data: DeepPartial<WallDataConstructorData>) => boolean;
-    };
-  }
->;
-
-/**
- * The base Wall model definition which defines common behavior of an Wall document between both client and server.
- */
-export declare class BaseWall extends Document<data.WallData, InstanceType<ConfiguredDocumentClass<typeof BaseScene>>> {
-  /**
-   * @remarks This is not overridden in foundry but reflects the real behavior.
-   */
-  constructor(
-    data: WallDataConstructorData,
-    context?: Context<InstanceType<ConfiguredDocumentClass<typeof BaseScene>>>
-  );
-
-  static override get schema(): typeof data.WallData;
-
-  static override get metadata(): WallMetadata;
-
-  /**
-   * Is a user able to update an existing Wall?
-   */
-  protected static _canUpdate(user: BaseUser, doc: BaseWall, data: DeepPartial<WallDataConstructorData>): boolean;
-}

package/src/foundry/common/documents.mjs/index.d.ts

@@ -1,28 +0,0 @@
-export { BaseActiveEffect } from './baseActiveEffect';
-export { BaseActor } from './baseActor';
-export { BaseAdventure } from './baseAdventure';
-export { BaseAmbientLight } from './baseAmbientLight';
-export { BaseAmbientSound } from './baseAmbientSound';
-export { BaseCard } from './baseCard';
-export { BaseCards } from './baseCards';
-export { BaseCombat } from './baseCombat';
-export { BaseCombatant } from './baseCombatant';
-export { BaseChatMessage } from './baseChatMessage';
-export { BaseDrawing } from './baseDrawing';
-export { BaseFogExploration } from './baseFogExploration';
-export { BaseFolder } from './baseFolder';
-export { BaseItem } from './baseItem';
-export { BaseJournalEntry } from './baseJournalEntry';
-export { BaseMacro } from './baseMacro';
-export { BaseMeasuredTemplate } from './baseMeasuredTemplate';
-export { BaseNote } from './baseNote';
-export { BasePlaylist } from './basePlaylist';
-export { BasePlaylistSound } from './basePlaylistSound';
-export { BaseRollTable } from './baseRollTable';
-export { BaseScene } from './baseScene';
-export { BaseSetting } from './baseSetting';
-export { BaseTableResult } from './baseTableResult';
-export { BaseTile } from './baseTile';
-export { BaseToken } from './baseToken';
-export { BaseUser } from './baseUser';
-export { BaseWall } from './baseWall';