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

package/src/foundry/common/documents.mjs/baseAdventure.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 AdventureMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Adventure';
-    collection: 'adventures';
-    label: 'DOCUMENT.Adventure';
-    labelPlural: 'DOCUMENT.Adventures';
-    isPrimary: false;
-    isEmbedded: false;
-  }
->;
-
-/**
- * The base Adventure model definition which defines common behavior of an Adventure document between both client and server.
- *
- * WARNING: This document is an early prototype which will be fully implemented in V10.
- * Until then it is for internal use only. Use this at your own risk.
- * @internal
- */
-export class BaseAdventure extends Document<data.AdventureData, null, AdventureMetadata> {
-  static override get schema(): typeof data.AdventureData;
-
-  static override get metadata(): AdventureMetadata;
-
-  /**
-   * A convenient reference to the file path of the Adventure's profile image.
-   */
-  get img(): string | null | undefined;
-
-  /**
-   * Provide a thumbnail image path used to represent the Adventure document.
-   */
-  get thumbnail(): string | null | undefined;
-}

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

@@ -1,31 +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 AmbientLightMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'AmbientLight';
-    collection: 'lights';
-    label: 'DOCUMENT.AmbientLight';
-    labelPlural: 'DOCUMENT.AmbientLights';
-    isEmbedded: true;
-  }
->;
-
-/**
- * The base AmbientLight model definition which defines common behavior of an AmbientLight document between both client and server.
- */
-export declare class BaseAmbientLight extends Document<
-  data.AmbientLightData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
-  AmbientLightMetadata
-> {
-  static override get schema(): typeof data.AmbientLightData;
-
-  static override get metadata(): AmbientLightMetadata;
-
-  protected override _initialize(): void;
-}

package/src/foundry/common/documents.mjs/baseAmbientSound.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 AmbientSoundMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'AmbientSound';
-    collection: 'sounds';
-    label: 'DOCUMENT.AmbientSound';
-    labelPlural: 'DOCUMENT.AmbientSounds';
-    isEmbedded: true;
-  }
->;
-
-/**
- * The base AmbientSound model definition which defines common behavior of an AmbientSound document between both client and server.
- */
-export declare class BaseAmbientSound extends Document<
-  data.AmbientSoundData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
-  AmbientSoundMetadata
-> {
-  static override get schema(): typeof data.AmbientSoundData;
-
-  static override get metadata(): AmbientSoundMetadata;
-}

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

@@ -1,58 +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 { CardDataConstructorData, CardDataSource } from '../data/data.mjs/cardData';
-import { BaseCards } from './baseCards';
-import { BaseUser } from './baseUser';
-
-type CardMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Card';
-    collection: 'cards';
-    label: 'DOCUMENT.Card';
-    labelPlural: 'DOCUMENT.Cards';
-    isEmbedded: true;
-    types: string[];
-    hasSystemData: true;
-    permissions: {
-      create: (user: BaseUser, doc: BaseCard, data: CardDataSource) => boolean;
-      update: (user: BaseUser, doc: BaseCard, data: DeepPartial<CardDataConstructorData>) => boolean;
-    };
-  }
->;
-
-/**
- * The base Card definition which defines common behavior of an embedded Card document shared by both client and server.
- */
-export declare class BaseCard extends Document<
-  data.CardData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseCards>>,
-  CardMetadata
-> {
-  static override get schema(): typeof data.CardData;
-
-  static override get metadata(): CardMetadata;
-
-  /**
-   * The sub-type of Card.
-   */
-  get type(): data.CardData['type'];
-
-  /**
-   * Is a User able to create a new embedded Card document within this parent?
-   */
-  protected static _canCreate(user: BaseUser, doc: BaseCard, data: CardDataSource): boolean;
-
-  /**
-   * Is a user able to update an existing Card?
-   */
-  protected static _canUpdate(user: BaseUser, doc: BaseCard, data: DeepPartial<CardDataConstructorData>): 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/baseCards.d.ts

@@ -1,39 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import { BaseCard } from './baseCard';
-
-type CardsMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Cards';
-    collection: 'cards';
-    label: 'DOCUMENT.Cards';
-    labelPlural: 'DOCUMENT.CardsPlural';
-    isPrimary: true;
-    types: string[];
-    hasSystemData: true;
-    embedded: {
-      Card: typeof BaseCard;
-    };
-  }
->;
-
-/**
- * The base Cards definition which defines common behavior of an Cards document shared by both client and server.
- */
-export declare class BaseCards extends Document<data.CardsData, null, CardsMetadata> {
-  static override get schema(): typeof data.CardsData;
-
-  static override get metadata(): CardsMetadata;
-
-  /**
-   * A reference to the Collection of Card documents contained within this Cards stack, indexed by _id.
-   */
-  get cards(): this['data']['cards'];
-
-  /**
-   * The sub-type of Cards.
-   */
-  get type(): data.CardsData['type'];
-}

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

@@ -1,49 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import { BaseUser } from './baseUser';
-import * as data from '../data/data.mjs';
-import type { ChatMessageDataConstructorData } from '../data/data.mjs/chatMessageData';
-
-type ChatMessageMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'ChatMessage';
-    collection: 'messages';
-    label: 'DOCUMENT.ChatMessage';
-    labelPlural: 'DOCUMENT.ChatMessages';
-    isPrimary: true;
-    permissions: {
-      create: (user: BaseUser, doc: BaseChatMessage) => boolean;
-      update: (user: BaseUser, doc: BaseChatMessage, data?: object) => boolean;
-      delete: (user: BaseUser, doc: BaseChatMessage) => boolean;
-    };
-  }
->;
-
-/**
- * The base ChatMessage model definition which defines common behavior of an ChatMessage document between both client and server.
- */
-export declare class BaseChatMessage extends Document<data.ChatMessageData, null, ChatMessageMetadata> {
-  static override get schema(): typeof data.ChatMessageData;
-
-  static override get metadata(): ChatMessageMetadata;
-
-  /**
-   * Is a user able to create a new chat message?
-   */
-  protected static _canCreate(user: BaseUser, doc: BaseChatMessage): boolean;
-
-  /**
-   * Is a user able to update an existing chat message?
-   */
-  protected static _canUpdate(
-    user: BaseUser,
-    doc: BaseChatMessage,
-    data: DeepPartial<ChatMessageDataConstructorData>
-  ): boolean;
-
-  /**
-   * Is a user able to delete an existing chat message?
-   */
-  protected static _canDelete(user: BaseUser, doc: BaseChatMessage): boolean;
-}

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

@@ -1,40 +0,0 @@
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import type { CombatDataConstructorData } from '../data/data.mjs/combatData';
-import { data } from '../module.mjs';
-import { BaseCombatant } from './baseCombatant';
-import { BaseUser } from './baseUser';
-
-type CombatMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Combat';
-    collection: 'combats';
-    label: 'DOCUMENT.Combat';
-    labelPlural: 'DOCUMENT.Combats';
-    embedded: {
-      Combatant: typeof BaseCombatant;
-    };
-    isPrimary: true;
-    permissions: {
-      update: (user: BaseUser, doc: BaseCombat, data: DeepPartial<CombatDataConstructorData>) => boolean;
-    };
-  }
->;
-
-/**
- * The base Combat model definition which defines common behavior of an Combat document between both client and server.
- */
-export declare class BaseCombat extends Document<data.CombatData, null, CombatMetadata> {
-  static override get schema(): typeof data.CombatData;
-
-  static override get metadata(): CombatMetadata;
-
-  /** A reference to the Collection of Combatant instances in the Combat document, indexed by id. */
-  get combatants(): this['data']['combatants'];
-
-  /**
-   * Is a user able to update an existing Combat?
-   */
-  protected static _canUpdate(user: BaseUser, doc: BaseCombat, data: DeepPartial<CombatDataConstructorData>): boolean;
-}

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

@@ -1,48 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import type { CombatantDataConstructorData, CombatantDataSource } from '../data/data.mjs/combatantData';
-import { data } from '../module.mjs';
-import { BaseCombat } from './baseCombat';
-import { BaseUser } from './baseUser';
-
-type CombatantMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Combatant';
-    collection: 'combatants';
-    label: 'DOCUMENT.Combatant';
-    isEmbedded: true;
-    labelPlural: 'DOCUMENT.Combatants';
-    permissions: {
-      create: (user: BaseUser, doc: BaseCombatant, data: CombatantDataSource) => boolean;
-      update: (user: BaseUser, doc: BaseCombatant, data: DeepPartial<CombatantDataConstructorData>) => boolean;
-    };
-  }
->;
-
-/**
- * The base Combatant model definition which defines common behavior of an Combatant document between both client and server.
- */
-export declare class BaseCombatant extends Document<
-  data.CombatantData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseCombat>>,
-  CombatantMetadata
-> {
-  static override get schema(): typeof data.CombatantData;
-
-  static override get metadata(): CombatantMetadata;
-
-  /**
-   * Is a user able to update an existing Combatant?
-   * @remarks doc seems unused
-   */
-  protected static _canUpdate(
-    user: BaseUser,
-    doc: BaseCombatant,
-    data: DeepPartial<CombatantDataConstructorData>
-  ): boolean;
-
-  /** Is a user able to create this Combatant? */
-  protected static _canCreate(user: BaseUser, doc: BaseCombatant, data: CombatantDataSource): boolean;
-}

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

@@ -1,54 +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 { CONST } from '../module.mjs';
-import { BaseScene } from './baseScene';
-import { BaseUser } from './baseUser';
-
-type DrawingMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Drawing';
-    collection: 'drawings';
-    label: 'DOCUMENT.Drawing';
-    labelPlural: 'DOCUMENT.Drawings';
-    isEmbedded: true;
-    types: [
-      typeof CONST.DRAWING_TYPES.RECTANGLE,
-      typeof CONST.DRAWING_TYPES.ELLIPSE,
-      typeof CONST.DRAWING_TYPES.TEXT,
-      typeof CONST.DRAWING_TYPES.POLYGON,
-      typeof CONST.DRAWING_TYPES.FREEHAND
-    ];
-    permissions: {
-      create: 'DRAWING_CREATE';
-      update: (user: BaseUser, doc: BaseDrawing, data?: object) => boolean;
-      delete: (user: BaseUser, doc: BaseDrawing, data?: object) => boolean;
-    };
-  }
->;
-
-/**
- * The base Drawing model definition which defines common behavior of an Drawing document between both client and server.
- */
-export declare class BaseDrawing extends Document<
-  data.DrawingData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
-  DrawingMetadata
-> {
-  static override get schema(): typeof data.DrawingData;
-
-  static override get metadata(): DrawingMetadata;
-
-  override testUserPermission(
-    user: BaseUser,
-    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
-    { exact }?: { exact?: boolean }
-  ): boolean;
-
-  /**
-   * Is a user able to update or delete an existing Drawing document??
-   */
-  protected static _canModify(user: BaseUser, doc: BaseDrawing, data?: object): boolean;
-}

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

@@ -1,41 +0,0 @@
-import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as data from '../data/data.mjs';
-import type { FogExplorationDataConstructorData } from '../data/data.mjs/fogExplorationData';
-import { BaseUser } from './baseUser';
-
-type FogExplorationMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'FogExploration';
-    collection: 'fog';
-    label: 'DOCUMENT.FogExploration';
-    labelPlural: 'DOCUMENT.FogExplorations';
-    isPrimary: true;
-    permissions: {
-      create: 'PLAYER';
-      update: (user: BaseUser, doc: BaseFogExploration) => boolean;
-      delete: (user: BaseUser, doc: BaseFogExploration) => boolean;
-    };
-  }
->;
-
-/**
- * The base FogExploration model definition which defines common behavior of an FogExploration document between both client and server.
- */
-export declare class BaseFogExploration extends Document<data.FogExplorationData, null, FogExplorationMetadata> {
-  static override get schema(): typeof data.FogExplorationData;
-
-  static override get metadata(): FogExplorationMetadata;
-
-  protected override _preUpdate(
-    changed: DeepPartial<FogExplorationDataConstructorData>,
-    options: DocumentModificationOptions,
-    user: BaseUser
-  ): Promise<void>;
-
-  /**
-   * Test whether a User can modify a FogExploration document.
-   */
-  protected static _canUserModify(user: BaseUser, doc: BaseFogExploration): boolean;
-}

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

@@ -1,30 +0,0 @@
-import * as data from '../data/data.mjs';
-import { Document } from '../abstract/module.mjs';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import * as CONST from '../constants.mjs';
-
-type FolderMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Folder';
-    collection: 'folders';
-    label: 'DOCUMENT.Folder';
-    labelPlural: 'DOCUMENT.Folders';
-    isPrimary: true;
-    types: typeof CONST.FOLDER_DOCUMENT_TYPES;
-  }
->;
-
-/**
- * The base Folder model definition which defines common behavior of an Folder document between both client and server.
- */
-export declare class BaseFolder extends Document<data.FolderData, BaseFolder, FolderMetadata> {
-  static override get schema(): typeof data.FolderData;
-
-  static override get metadata(): FolderMetadata;
-
-  /**
-   * The type of Document contained within this Folder.
-   */
-  get type(): CONST.FOLDER_DOCUMENT_TYPES;
-}

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

@@ -1,57 +0,0 @@
-import * as data from '../data/data.mjs';
-import { Document } from '../abstract/module.mjs';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { BaseActor } from './baseActor';
-import { BaseActiveEffect } from './baseActiveEffect';
-import { BaseUser } from './baseUser';
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-
-type ItemMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Item';
-    collection: 'items';
-    label: 'DOCUMENT.Item';
-    labelPlural: 'DOCUMENT.Items';
-    embedded: {
-      ActiveEffect: typeof BaseActiveEffect;
-    };
-    isPrimary: true;
-    hasSystemData: true;
-    types: string[];
-    permissions: {
-      create: 'ITEM_CREATE';
-    };
-  }
->;
-
-/**
- * The base Item model definition which defines common behavior of an Item document between both client and server.
- */
-export declare class BaseItem extends Document<
-  data.ItemData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseActor>>,
-  ItemMetadata
-> {
-  static override get schema(): typeof data.ItemData;
-
-  static override get metadata(): ItemMetadata;
-
-  /**
-   * A reference to the Collection of ActiveEffect instances in the Item document, indexed by _id.
-   */
-  get effects(): this['data']['effects'];
-
-  /**
-   * The sub-type of Item.
-   */
-  get type(): this['data']['type'];
-
-  override canUserModify(user: BaseUser, action: 'create' | 'update' | 'delete', data?: object): 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/baseJournalEntry.d.ts

@@ -1,26 +0,0 @@
-import * as data from '../data/data.mjs';
-import { Document } from '../abstract/module.mjs';
-import { DocumentMetadata } from '../abstract/document.mjs';
-
-type JournalEntryMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'JournalEntry';
-    collection: 'journal';
-    label: 'DOCUMENT.JournalEntry';
-    labelPlural: 'DOCUMENT.JournalEntries';
-    isPrimary: true;
-    permissions: {
-      create: 'JOURNAL_CREATE';
-    };
-  }
->;
-
-/**
- * The base JournalEntry model definition which defines common behavior of an JournalEntry document between both client and server.
- */
-export declare class BaseJournalEntry extends Document<data.JournalEntryData, null, JournalEntryMetadata> {
-  static override get schema(): typeof data.JournalEntryData;
-
-  static override get metadata(): JournalEntryMetadata;
-}

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

@@ -1,42 +0,0 @@
-import { DocumentMetadata, DocumentModificationOptions } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import * as CONST from '../constants.mjs';
-import * as data from '../data/data.mjs';
-import type { MacroDataConstructorData } from '../data/data.mjs/macroData';
-import { BaseUser } from './baseUser';
-
-type MacroMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'Macro';
-    collection: 'macros';
-    label: 'DOCUMENT.Macro';
-    labelPlural: 'DOCUMENT.Macros';
-    isPrimary: true;
-    types: [typeof CONST.MACRO_TYPES.SCRIPT, typeof CONST.MACRO_TYPES.CHAT];
-    permissions: {
-      create: 'PLAYER';
-    };
-  }
->;
-
-/**
- * The base Macro model definition which defines common behavior of an Macro document between both client and server.
- */
-export declare class BaseMacro extends Document<data.MacroData, null, MacroMetadata> {
-  static override get schema(): typeof data.MacroData;
-
-  static override get metadata(): MacroMetadata;
-
-  protected override _preCreate(
-    data: MacroDataConstructorData,
-    options: DocumentModificationOptions,
-    user: BaseUser
-  ): Promise<void>;
-
-  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/baseMeasuredTemplate.d.ts

@@ -1,66 +0,0 @@
-import { ConfiguredDocumentClass } from '../../../types/helperTypes';
-import * as data from '../data/data.mjs';
-import { DocumentMetadata } from '../abstract/document.mjs';
-import { Document } from '../abstract/module.mjs';
-import { BaseScene } from './baseScene';
-import { BaseUser } from './baseUser';
-import type { MeasuredTemplateDataConstructorData } from '../data/data.mjs/measuredTemplateData';
-
-type MeasuredTemplateMetadata = Merge<
-  DocumentMetadata,
-  {
-    name: 'MeasuredTemplate';
-    collection: 'templates';
-    label: 'DOCUMENT.MeasuredTemplate';
-    labelPlural: 'DOCUMENT.MeasuredTemplates';
-    isEmbedded: true;
-    permissions: {
-      create: (user: BaseUser, doc: BaseMeasuredTemplate) => boolean;
-      update: (
-        user: BaseUser,
-        doc: BaseMeasuredTemplate,
-        data: DeepPartial<MeasuredTemplateDataConstructorData> | {}
-      ) => boolean;
-      delete: (
-        user: BaseUser,
-        doc: BaseMeasuredTemplate,
-        data: DeepPartial<MeasuredTemplateDataConstructorData> | {}
-      ) => boolean;
-    };
-  }
->;
-
-/**
- * The base MeasuredTemplate model definition which defines common behavior of an MeasuredTemplate document between both client and server.
- */
-export declare class BaseMeasuredTemplate extends Document<
-  data.MeasuredTemplateData,
-  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
-  MeasuredTemplateMetadata
-> {
-  static override get schema(): typeof data.MeasuredTemplateData;
-
-  static override get metadata(): MeasuredTemplateMetadata;
-
-  override testUserPermission(
-    user: BaseUser,
-    permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
-    { exact }?: { exact?: boolean }
-  ): boolean;
-
-  /**
-   * Is a user able to create a new MeasuredTemplate?
-   * @param user - The user attempting the creation operation.
-   * @param doc  - The MeasuredTemplate being created.
-   */
-  protected static _canCreate(user: BaseUser, doc: BaseMeasuredTemplate): boolean;
-
-  /**
-   * Is a user able to modify an existing MeasuredTemplate?
-   */
-  protected static _canModify(
-    user: BaseUser,
-    doc: BaseMeasuredTemplate,
-    data: DeepPartial<MeasuredTemplateDataConstructorData> | {}
-  ): boolean;
-}