@league-of-foundry-developers/foundry-vtt-types 9.249.0 → 9.249.4

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

@@ -4,43 +4,59 @@ 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: 'TEMPLATE_CREATE';
+      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>>
+  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
+  MeasuredTemplateMetadata
 > {
   /** @override */
   static get schema(): typeof data.MeasuredTemplateData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'MeasuredTemplate';
-      collection: 'templates';
-      label: 'DOCUMENT.MeasuredTemplate';
-      labelPlural: 'DOCUMENT.MeasuredTemplates';
-      isEmbedded: true;
-      permissions: {
-        create: 'TEMPLATE_CREATE';
-        update: typeof BaseMeasuredTemplate['_canModify'];
-        delete: typeof BaseMeasuredTemplate['_canModify'];
-      };
-    }
-  >;
+  static get metadata(): MeasuredTemplateMetadata;
 
   /** @override */
   testUserPermission(
     user: BaseUser,
-    permission: keyof typeof foundry.CONST.ENTITY_PERMISSIONS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
+    permission: keyof typeof foundry.CONST.DOCUMENT_PERMISSION_LEVELS | foundry.CONST.DOCUMENT_PERMISSION_LEVELS,
     { exact }?: { exact?: boolean }
   ): boolean;
 
   /**
    * Is a user able to modify an existing MeasuredTemplate?
    */
-  protected static _canModify(user: BaseUser, doc: BaseMeasuredTemplate, data: unknown): boolean;
+  protected static _canModify(
+    user: BaseUser,
+    doc: BaseMeasuredTemplate,
+    data: DeepPartial<MeasuredTemplateDataConstructorData> | {}
+  ): boolean;
 }

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

@@ -5,27 +5,33 @@ 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>>> {
+export declare class BaseNote extends Document<
+  data.NoteData,
+  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
+  NoteMetadata
+> {
   /** @override */
   static get schema(): typeof data.NoteData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'Note';
-      collection: 'notes';
-      label: 'DOCUMENT.Note';
-      labelPlural: 'DOCUMENT.Notes';
-      isEmbedded: true;
-      permissions: {
-        create: 'NOTE_CREATE';
-      };
-    }
-  >;
+  static get metadata(): NoteMetadata;
 
   /** @override */
   testUserPermission(

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

@@ -3,27 +3,29 @@ 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> {
+export declare class BasePlaylist extends Document<data.PlaylistData, null, PlaylistMetadata> {
   /** @override */
   static get schema(): typeof data.PlaylistData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'Playlist';
-      collection: 'playlists';
-      label: 'DOCUMENT.Playlist';
-      labelPlural: 'DOCUMENT.Playlists';
-      embedded: {
-        PlaylistSound: typeof BasePlaylistSound;
-      };
-      isPrimary: true;
-    }
-  >;
+  static get metadata(): PlaylistMetadata;
 
   /**
    * A reference to the Collection of ActiveEffect instances in the Actor document, indexed by _id.

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

@@ -6,27 +6,30 @@ 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>>
+  InstanceType<ConfiguredDocumentClass<typeof BasePlaylist>>,
+  PlaylistSoundMetadata
 > {
   /** @override */
   static get schema(): typeof data.PlaylistSoundData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'PlaylistSound';
-      collection: 'sounds';
-      label: 'DOCUMENT.PlaylistSound';
-      labelPlural: 'DOCUMENT.PlaylistSounds';
-      isEmbedded: true;
-    }
-  >;
+  static get metadata(): PlaylistSoundMetadata;
 
   /** @override */
   testUserPermission(

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

@@ -2,27 +2,29 @@ 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> {
+export declare class BaseRollTable extends Document<foundry.data.RollTableData, null, RollTableMetadata> {
   /** @override */
   static get schema(): typeof foundry.data.RollTableData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'RollTable';
-      collection: 'tables';
-      label: 'DOCUMENT.RollTable';
-      labelPlural: 'DOCUMENT.RollTables';
-      embedded: {
-        TableResult: typeof BaseTableResult;
-      };
-      isPrimary: true;
-    }
-  >;
+  static get metadata(): RollTableMetadata;
 
   /**
    * A reference to the Collection of TableResult instances in this document, indexed by _id.

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

@@ -10,34 +10,36 @@ 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> {
+export declare class BaseScene extends Document<data.SceneData, null, SceneMetadata> {
   /** @override */
   static get schema(): typeof data.SceneData;
 
   /** @override */
-  static get metadata(): 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;
-      };
-    }
-  >;
+  static get metadata(): SceneMetadata;
 
   /**
    * A reference to the Collection of Drawing instances in the Scene document, indexed by _id.

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

@@ -2,29 +2,31 @@ 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> {
+export declare class BaseSetting extends Document<data.SettingData, null, SettingMetadata> {
   /** @override */
   static get schema(): typeof data.SettingData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'Setting';
-      collection: 'settings';
-      label: 'DOCUMENT.Setting';
-      labelPlural: 'DOCUMENT.Settings';
-      isPrimary: true;
-      permissions: {
-        create: 'SETTINGS_MODIFY';
-        update: 'SETTINGS_MODIFY';
-        delete: 'SETTINGS_MODIFY';
-      };
-    }
-  >;
+  static get metadata(): SettingMetadata;
 
   /**
    * A convenience reference to the key which identifies this game setting.

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

@@ -1,42 +1,50 @@
 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>>
+  InstanceType<ConfiguredDocumentClass<typeof BaseRollTable>>,
+  TableResultMetadata
 > {
   /** @override */
   static get schema(): typeof foundry.data.TableResultData;
 
   /** @override */
-  static get metadata(): 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: any, data?: object) => boolean;
-      };
-    }
-  >;
+  static get metadata(): TableResultMetadata;
 
   /**
    * Is a user able to update an existing TableResult?
    */
-  protected static _canUpdate(user: BaseUser, doc: BaseTableResult, data?: object): boolean;
+  protected static _canUpdate(
+    user: BaseUser,
+    doc: BaseTableResult,
+    data: DeepPartial<TableResultDataConstructorData>
+  ): boolean;
 
   /** @override */
   testUserPermission(

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

@@ -4,22 +4,28 @@ 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>>> {
+export declare class BaseTile extends Document<
+  data.TileData,
+  InstanceType<ConfiguredDocumentClass<typeof BaseScene>>,
+  TileMetadata
+> {
   /** @override */
   static get schema(): typeof data.TileData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'Tile';
-      collection: 'tiles';
-      label: 'DOCUMENT.Tile';
-      labelPlural: 'DOCUMENT.Tiles';
-      isEmbedded: true;
-    }
-  >;
+  static get metadata(): TileMetadata;
 }

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

@@ -2,33 +2,37 @@ 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>>
+  InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>,
+  TokenMetadata
 > {
   /** @override */
   static get schema(): typeof data.TokenData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'Token';
-      collection: 'tokens';
-      label: 'DOCUMENT.Token';
-      labelPlural: 'DOCUMENT.Tokens';
-      isEmbedded: true;
-      permissions: {
-        create: 'TOKEN_CREATE';
-        update: typeof BaseToken['_canUpdate'];
-      };
-    }
-  >;
+  static get metadata(): TokenMetadata;
 
   /**
    * A convenience reference to the name which should be displayed for the Token
@@ -38,5 +42,5 @@ export declare class BaseToken extends Document<
   /**
    * Is a user able to update an existing Token?
    */
-  protected static _canUpdate(user: BaseUser, doc: BaseToken, data: unknown): boolean;
+  protected static _canUpdate(user: BaseUser, doc: BaseToken, data: DeepPartial<TokenDataConstructorData>): boolean;
 }

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

@@ -1,11 +1,28 @@
 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> {
+export declare class BaseUser extends Document<data.UserData, null, UserMetadata> {
   constructor(...args: ConstructorParameters<ConstructorOf<Document<data.UserData, null>>>);
 
   /**
@@ -17,16 +34,33 @@ export declare class BaseUser extends Document<data.UserData, null> {
   static get schema(): typeof data.UserData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'User';
-      collection: 'users';
-      label: 'DOCUMENT.User';
-      labelPlural: 'DOCUMENT.Users';
-      isPrimary: true;
-    }
-  >;
+  static 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?

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

@@ -2,10 +2,24 @@ 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.js';
+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.
  */
@@ -22,22 +36,10 @@ export declare class BaseWall extends Document<data.WallData, InstanceType<Confi
   static get schema(): typeof data.WallData;
 
   /** @override */
-  static get metadata(): Merge<
-    DocumentMetadata,
-    {
-      name: 'Wall';
-      collection: 'walls';
-      label: 'DOCUMENT.Wall';
-      labelPlural: 'DOCUMENT.Walls';
-      isEmbedded: true;
-      permissions: {
-        update: typeof BaseWall._canUpdate;
-      };
-    }
-  >;
+  static get metadata(): WallMetadata;
 
   /**
    * Is a user able to update an existing Wall?
    */
-  protected static _canUpdate(user: BaseUser, doc: BaseWall, data?: Partial<WallDataConstructorData>): boolean;
+  protected static _canUpdate(user: BaseUser, doc: BaseWall, data: DeepPartial<WallDataConstructorData>): boolean;
 }

package/src/foundry/common/packages.mjs/packageAuthorData.d.ts

@@ -37,13 +37,15 @@ interface PackageAuthorDataConstructorData {
   discord?: string | null | undefined;
 }
 
+type PackageAuthorDataSource = PropertiesToSource<PackageAuthorDataProperties>;
+
 /**
  * An inner data object which represents a single package author in the authors array.
  */
 export class PackageAuthorData extends DocumentData<
   PackageAuthorDataSchema,
   PackageAuthorDataProperties,
-  PropertiesToSource<PackageAuthorDataProperties>,
+  PackageAuthorDataSource,
   PackageAuthorDataConstructorData,
   null
 > {