@league-of-foundry-developers/foundry-vtt-types 0.8.9-9 → 9.238.0

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

@@ -13,14 +13,17 @@ export declare class BaseUser extends Document<data.UserData, null> {
    */
   readonly role: ValueOf<typeof CONST.USER_ROLES>;
 
+  /** @override */
   static get schema(): typeof data.UserData;
 
+  /** @override */
   static get metadata(): Merge<
     DocumentMetadata,
     {
       name: 'User';
       collection: 'users';
       label: 'DOCUMENT.User';
+      labelPlural: 'DOCUMENT.Users';
       isPrimary: true;
     }
   >;
@@ -42,7 +45,10 @@ export declare class BaseUser extends Document<data.UserData, null> {
     action: ValueOf<typeof CONST.USER_ROLES> | keyof typeof CONST.USER_ROLES | keyof typeof CONST.USER_PERMISSIONS
   ): boolean;
 
-  getUserLevel(user: BaseUser): typeof CONST.ENTITY_PERMISSIONS.OWNER | typeof CONST.ENTITY_PERMISSIONS.NONE;
+  /** @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

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

@@ -1,10 +1,10 @@
-import { Context } from '../abstract/document.mjs';
-import { ConfiguredDocumentClass, ConstructorDataType } from '../../../types/helperTypes';
-import { DocumentMetadata } from '../abstract/document.mjs';
+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 { BaseScene } from './baseScene';
 import { BaseUser } from './baseUser';
-import * as data from '../data/data.mjs';
 
 /**
  * The base Wall model definition which defines common behavior of an Wall document between both client and server.
@@ -14,7 +14,7 @@ export declare class BaseWall extends Document<data.WallData, InstanceType<Confi
    * @remarks This is not overridden in foundry but reflects the real behavior.
    */
   constructor(
-    data: ConstructorDataType<data.WallData>,
+    data: WallDataConstructorData,
     context?: Context<InstanceType<ConfiguredDocumentClass<typeof BaseScene>>>
   );
 
@@ -28,6 +28,7 @@ export declare class BaseWall extends Document<data.WallData, InstanceType<Confi
       name: 'Wall';
       collection: 'walls';
       label: 'DOCUMENT.Wall';
+      labelPlural: 'DOCUMENT.Walls';
       isEmbedded: true;
       permissions: {
         update: typeof BaseWall._canUpdate;
@@ -38,9 +39,5 @@ export declare class BaseWall extends Document<data.WallData, InstanceType<Confi
   /**
    * Is a user able to update an existing Wall?
    */
-  protected static _canUpdate(
-    user: BaseUser,
-    doc: BaseWall,
-    data?: Partial<ConstructorDataType<data.WallData>>
-  ): boolean;
+  protected static _canUpdate(user: BaseUser, doc: BaseWall, data?: Partial<WallDataConstructorData>): boolean;
 }

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

@@ -1,7 +1,10 @@
 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';

package/src/foundry/common/module.mjs.d.ts

@@ -6,6 +6,7 @@ import * as _data from './data/module.mjs';
 import * as _documents from './documents.mjs';
 import * as _packages from './packages.mjs';
 import * as _utils from './utils/module.mjs';
+import * as _config from './config.mjs';
 
 /**
  * Constant definitions used throughout the Foundry Virtual Tabletop framework.
@@ -68,6 +69,8 @@ declare global {
      * Package data definitions, validations, and schema
      */
     export import packages = _packages; // eslint-disable-line @typescript-eslint/no-unused-vars
+
+    export import config = _config; // eslint-disable-line @typescript-eslint/no-unused-vars
   }
 
   /**

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

@@ -2,19 +2,20 @@ import * as fields from '../data/fields.mjs';
 import { PackageData, PackageDataConstructorData, PackageDataProperties, PackageDataSchema } from './packageData';
 
 interface ModuleDataSchema extends PackageDataSchema {
-  coreTranslation: typeof fields.BOOLEAN_FIELD;
-  minimumSystemVersion: typeof fields.STRING_FIELD;
-  library: typeof fields.BOOLEAN_FIELD;
+  coreTranslation: fields.BooleanField;
+  minimumSystemVersion: fields.StringField;
+  library: fields.BooleanField;
 }
 
 interface ModuleDataProperties extends PackageDataProperties {
   /**
    * Does this module provide a translation for the core software?
+   * @defaultValue `false`
    */
   coreTranslation: boolean;
 
   /** A minimum version number of the game system that this module requires */
-  minimumSystemVersion?: string;
+  minimumSystemVersion: string | undefined;
 
   /**
    * A library module provides no user-facing functionality and is solely for
@@ -27,27 +28,29 @@ interface ModuleDataProperties extends PackageDataProperties {
 interface ModuleDataConstructorData extends PackageDataConstructorData {
   /**
    * Does this module provide a translation for the core software?
+   * @defaultValue `false`
    */
-  coreTranslation?: boolean | null;
+  coreTranslation?: boolean | null | undefined;
 
   /** A minimum version number of the game system that this module requires */
-  minimumSystemVersion?: string | null;
+  minimumSystemVersion?: string | null | undefined;
 
   /**
    * A library module provides no user-facing functionality and is solely for
    * use by other modules. Loaded before any system or module scripts.
    * @defaultValue `false`
    */
-  library?: boolean | null;
+  library?: boolean | null | undefined;
 }
 
 /**
  * The data schema used to define Module manifest files.
  * Extends the basic PackageData schema with some additional module-specific fields.
  */
-export declare class ModuleData extends PackageData<ModuleDataSchema, ModuleDataProperties, ModuleDataConstructorData> {
+export class ModuleData extends PackageData<ModuleDataSchema, ModuleDataProperties, ModuleDataConstructorData> {
+  /** @override */
   static defineSchema(): ModuleDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface ModuleData extends ModuleDataProperties {}
+export interface ModuleData extends ModuleDataProperties {}

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

@@ -3,53 +3,53 @@ import { DocumentData } from '../abstract/module.mjs';
 import * as fields from '../data/fields.mjs';
 
 interface PackageAuthorDataSchema extends DocumentSchema {
-  name: typeof fields.REQUIRED_STRING;
-  email: typeof fields.STRING_FIELD;
-  url: typeof fields.STRING_FIELD;
-  discord: typeof fields.STRING_FIELD;
+  name: fields.RequiredString;
+  email: fields.StringField;
+  url: fields.StringField;
+  discord: fields.StringField;
 }
 
 interface PackageAuthorDataProperties {
-  /**
-   * The author name
-   */
+  /** The author name */
   name: string;
 
-  /**
-   * The author email address
-   */
-  email?: string;
+  /** The author email address */
+  email: string | undefined;
 
-  /**
-   *  A website url for the author
-   */
-  url?: string;
+  /** A website url for the author */
+  url: string | undefined;
 
-  /**
-   *  A Discord username for the author
-   */
-  discord?: string;
+  /** A Discord username for the author */
+  discord: string | undefined;
 }
 
 interface PackageAuthorDataConstructorData {
+  /** The author name */
   name: string;
-  email?: string | null;
-  url?: string | null;
-  discord?: string | null;
+
+  /** The author email address */
+  email?: string | null | undefined;
+
+  /** A website url for the author */
+  url?: string | null | undefined;
+
+  /** A Discord username for the author */
+  discord?: string | null | undefined;
 }
 
 /**
  * An inner data object which represents a single package author in the authors array.
  */
-export declare class PackageAuthorData extends DocumentData<
+export class PackageAuthorData extends DocumentData<
   PackageAuthorDataSchema,
   PackageAuthorDataProperties,
   PropertiesToSource<PackageAuthorDataProperties>,
   PackageAuthorDataConstructorData,
   null
 > {
-  constructor(data?: DeepPartial<PropertiesToSource<PackageAuthorDataProperties>>, document?: null);
+  constructor(data?: PackageAuthorDataConstructorData, document?: null);
 
+  /** @override */
   static defineSchema(): PackageAuthorDataSchema;
 }
 

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

@@ -3,23 +3,19 @@ import { DocumentData } from '../abstract/module.mjs';
 import * as fields from '../data/fields.mjs';
 
 interface PackageCompendiumDataSchema extends DocumentSchema {
-  name: typeof fields.REQUIRED_STRING;
-  label: typeof fields.REQUIRED_STRING;
-  path: typeof fields.REQUIRED_STRING;
-  private: FieldReturnType<
-    typeof fields.BOOLEAN_FIELD,
+  name: fields.RequiredString;
+  label: fields.RequiredString;
+  path: fields.RequiredString;
+  private: FieldReturnType<fields.BooleanField, { default: false }>;
+  entity: fields.StringField;
+  type: FieldReturnType<
+    fields.RequiredString,
     {
-      default: false;
+      validate: (v: string) => v is foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
+      validationError: 'Invalid package compendium document type provided which must be a value in CONST.COMPENDIUM_DOCUMENT_TYPES';
     }
   >;
-  entity: FieldReturnType<
-    typeof fields.REQUIRED_STRING,
-    {
-      validate: (v: string) => v is foundry.CONST.CompendiumEntityType;
-      validationError: 'Invalid package compendium entity type provided which must be a value in CONST.COMPENDIUM_ENTITY_TYPES';
-    }
-  >;
-  system: typeof fields.STRING_FIELD;
+  system: fields.StringField;
 }
 
 interface PackageCompendiumDataProperties {
@@ -32,13 +28,16 @@ interface PackageCompendiumDataProperties {
   /** The local relative path to the compendium source .db file. The filename should match the name attribute. */
   path: string;
 
+  /** @defaultValue `false` */
   private: boolean;
 
+  entity: string | undefined;
+
   /** The specific document type that is contained within this compendium pack */
-  entity: foundry.CONST.CompendiumEntityType;
+  type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
 
   /** Denote that this compendium pack requires a specific game system to function properly. */
-  system?: string;
+  system: string | undefined;
 }
 
 interface PackageCompendiumDataConstructorData {
@@ -51,26 +50,33 @@ interface PackageCompendiumDataConstructorData {
   /** The local relative path to the compendium source .db file. The filename should match the name attribute. */
   path: string;
 
-  private?: boolean | null;
+  /** @defaultValue `false` */
+  private?: boolean | null | undefined;
+
+  entity?: string | null | undefined;
 
   /** The specific document type that is contained within this compendium pack */
-  entity: foundry.CONST.CompendiumEntityType;
+  type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
 
   /** Denote that this compendium pack requires a specific game system to function properly. */
-  system?: string;
+  system?: string | null | undefined;
 }
 
 /**
  * An inner data object which represents a single compendium pack definition provided by a package in the packs array.
  */
-export declare class PackageCompendiumData extends DocumentData<
+export class PackageCompendiumData extends DocumentData<
   PackageCompendiumDataSchema,
   PackageCompendiumDataProperties,
   PropertiesToSource<PackageCompendiumDataProperties>,
   PackageCompendiumDataConstructorData
 > {
+  /** @override */
   static defineSchema(): PackageCompendiumDataSchema;
+
+  /** @override */
+  _initializeSource(data: PackageCompendiumDataConstructorData): PropertiesToSource<PackageCompendiumDataProperties>;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface PackageCompendiumData extends PackageCompendiumDataProperties {}
+export interface PackageCompendiumData extends PackageCompendiumDataProperties {}