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

package/src/foundry/common/data/data.mjs/journalEntryData.d.ts

@@ -1,132 +0,0 @@
-import { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface JournalEntryDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  content: fields.BlankString;
-  img: fields.ImageField;
-  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: fields.IntegerSortField;
-  permission: fields.DocumentPermissions;
-  flags: fields.ObjectField;
-}
-
-interface JournalEntryDataProperties {
-  /**
-   * The _id which uniquely identifies this JournalEntry document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The name of this JournalEntry
-   */
-  name: string;
-
-  /**
-   * The HTML content of the JournalEntry
-   * @defaultValue `""`
-   */
-  content: string;
-
-  /**
-   * An image file path which provides the artwork for this JournalEntry
-   */
-  img: string | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this JournalEntry
-   * @defaultValue `null`
-   */
-  folder: string | null;
-
-  /**
-   * The numeric sort value which orders this JournalEntry relative to its siblings
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /**
-   * An object which configures user permissions to this JournalEntry
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>>;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'JournalEntry'>;
-}
-
-interface JournalEntryDataConstructorData {
-  /**
-   * The _id which uniquely identifies this JournalEntry document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The name of this JournalEntry
-   */
-  name: string;
-
-  /**
-   * The HTML content of the JournalEntry
-   * @defaultValue `""`
-   */
-  content?: string | null | undefined;
-
-  /**
-   * An image file path which provides the artwork for this JournalEntry
-   */
-  img?: string | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this JournalEntry
-   * @defaultValue `null`
-   */
-  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
-
-  /**
-   * The numeric sort value which orders this JournalEntry relative to its siblings
-   * @defaultValue `0`
-   */
-  sort?: number | null | undefined;
-
-  /**
-   * An object which configures user permissions to this JournalEntry
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission?: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>> | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'JournalEntry'> | null | undefined;
-}
-
-type JournalEntryDataSource = PropertiesToSource<JournalEntryDataProperties>;
-
-/**
- * The data schema for a JournalEntry document.
- * @see BaseJournalEntry
- */
-export class JournalEntryData extends DocumentData<
-  JournalEntryDataSchema,
-  JournalEntryDataProperties,
-  JournalEntryDataSource,
-  JournalEntryDataConstructorData,
-  documents.BaseJournalEntry
-> {
-  constructor(data: JournalEntryDataConstructorData, document?: documents.BaseJournalEntry | null);
-
-  static override defineSchema(): JournalEntryDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface JournalEntryData extends JournalEntryDataProperties {}

package/src/foundry/common/data/data.mjs/lightData.d.ts

@@ -1,227 +0,0 @@
-import type { FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-import type { AnimationData, AnimationDataConstructorData } from './animationData';
-import type { DarknessActivation, DarknessActivationConstructorData } from './darknessActivation';
-
-interface LightDataSchema extends DocumentSchema {
-  alpha: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
-  angle: fields.AngleField;
-  bright: fields.NonnegativeNumberField;
-  color: fields.ColorField;
-  coloration: FieldReturnType<fields.NonnegativeIntegerField, { default: 1 }>;
-  dim: fields.NonnegativeNumberField;
-  gradual: FieldReturnType<fields.BooleanField, { default: true }>;
-  luminosity: FieldReturnType<LightData.LightUniformField, { default: 0.5 }>;
-  saturation: LightData.LightUniformField;
-  contrast: LightData.LightUniformField;
-  shadows: LightData.LightUniformField;
-  animation: DocumentField<AnimationData> & {
-    type: typeof AnimationData;
-    required: true;
-    default: Record<string, never>;
-  };
-  darkness: DocumentField<DarknessActivation> & {
-    type: typeof DarknessActivation;
-    required: true;
-    default: Record<string, never>;
-  };
-}
-
-interface LightDataProperties {
-  /**
-   * An opacity for the emitted light, if any
-   * @defaultValue `0.5`
-   */
-  alpha: number;
-
-  /**
-   * The angle of emission for this point source
-   * @defaultValue `360`
-   */
-  angle: number;
-
-  /**
-   * The allowed radius of bright vision or illumination
-   * @defaultValue `0`
-   */
-  bright: number;
-
-  /** A tint color for the emitted light, if any */
-  color: string | null | undefined;
-
-  /**
-   * The coloration technique applied in the shader
-   * @defaultValue `1`
-   */
-  coloration: number;
-
-  /**
-   * The allowed radius of dim vision or illumination
-   * @defaultValue `0`
-   */
-  dim: number;
-
-  /**
-   * Fade the difference between bright, dim, and dark gradually?
-   * @defaultValue `true`
-   */
-  gradual: boolean;
-
-  /**
-   * The luminosity applied in the shader
-   * @defaultValue `0.5`
-   */
-  luminosity: number;
-
-  /**
-   * The amount of color saturation this light applies to the background texture
-   * @defaultValue `0`
-   */
-  saturation: number;
-
-  /**
-   * The amount of contrast this light applies to the background texture
-   * @defaultValue `0`
-   */
-  contrast: number;
-
-  /**
-   * The depth of shadows this light applies to the background texture
-   * @defaultValue `0`
-   */
-  shadows: number;
-
-  /**
-   * An animation configuration for the source
-   * @defaultValue `new AnimationData({})`
-   */
-  animation: AnimationData;
-
-  /**
-   * A darkness range (min and max) for which the source should be active
-   * @defaultValue `new DarknessActivation({})`
-   */
-  darkness: DarknessActivation;
-}
-
-interface LightDataConstructorData {
-  /**
-   * An opacity for the emitted light, if any
-   * @defaultValue `0.5`
-   */
-  alpha?: number | null | undefined;
-
-  /**
-   * The angle of emission for this point source
-   * @defaultValue `360`
-   */
-  angle?: number | null | undefined;
-
-  /**
-   * The allowed radius of bright vision or illumination
-   * @defaultValue `0`
-   */
-  bright?: number | null | undefined;
-
-  /** A tint color for the emitted light, if any */
-  color?: string | null | undefined;
-
-  /**
-   * The coloration technique applied in the shader
-   * @defaultValue `1`
-   */
-  coloration?: number | null | undefined;
-
-  /**
-   * The allowed radius of dim vision or illumination
-   * @defaultValue `0`
-   */
-  dim?: number | null | undefined;
-
-  /**
-   * Fade the difference between bright, dim, and dark gradually?
-   * @defaultValue `true`
-   */
-  gradual?: boolean | null | undefined;
-
-  /**
-   * The luminosity applied in the shader
-   * @defaultValue `0.5`
-   */
-  luminosity?: number | null | undefined;
-
-  /**
-   * The amount of color saturation this light applies to the background texture
-   * @defaultValue `0`
-   */
-  saturation?: number | null | undefined;
-
-  /**
-   * The amount of contrast this light applies to the background texture
-   * @defaultValue `0`
-   */
-  contrast?: number | null | undefined;
-
-  /**
-   * The depth of shadows this light applies to the background texture
-   * @defaultValue `0`
-   */
-  shadows?: number | null | undefined;
-
-  /**
-   * An animation configuration for the source
-   * @defaultValue `new AnimationData({})`
-   */
-  animation?: AnimationDataConstructorData | null | undefined;
-
-  /**
-   * A darkness range (min and max) for which the source should be active
-   * @defaultValue `new DarknessActivation({})`
-   */
-  darkness?: DarknessActivationConstructorData | null | undefined;
-}
-
-type LightDataSource = PropertiesToSource<LightDataProperties>;
-
-/**
- * A reusable document structure for the internal data used to render the appearance of a light source.
- * This is re-used by both the AmbientLightData and TokenData classes.
- */
-export class LightData extends DocumentData<
-  LightDataSchema,
-  LightDataProperties,
-  LightDataSource,
-  LightDataConstructorData,
-  documents.BaseAmbientLight | documents.BaseToken
-> {
-  static override defineSchema(): LightDataSchema;
-
-  /**
-   * A reusable field definition for uniform fields used by LightData
-   */
-  static LIGHT_UNIFORM_FIELD: LightData.LightUniformField;
-
-  override _initializeSource(data: LightDataConstructorData): LightDataSource;
-
-  protected override _initialize(): void;
-}
-
-declare namespace LightData {
-  /**
-   * Property type: `number`
-   * Constructor type: `number | null | undefined`
-   * Default: `0`
-   */
-  interface LightUniformField {
-    type: typeof Number;
-    required: true;
-    default: 0;
-    validate: (n: number) => boolean;
-    validationError: '{name} {field} "{value}" is not a number between -1 and 1';
-  }
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface LightData extends LightDataProperties {}

package/src/foundry/common/data/data.mjs/macroData.d.ts

@@ -1,199 +0,0 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  FieldReturnType,
-  PropertiesToSource
-} from '../../../../types/helperTypes';
-import { DocumentData } from '../../abstract/module.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface MacroDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  type: DocumentField<foundry.CONST.MACRO_TYPES> & {
-    type: String;
-    required: true;
-    default: typeof foundry.CONST.MACRO_TYPES.CHAT;
-    validate: (t: unknown) => t is foundry.CONST.MACRO_TYPES;
-    validationError: 'The provided Macro type must be in CONST.MACRO_TYPES';
-  };
-  author: fields.ForeignDocumentField<{
-    type: typeof documents.BaseUser;
-    default: () => Game['user'];
-  }>;
-  img: FieldReturnType<fields.ImageField, { required: true; default: typeof MacroData.DEFAULT_ICON }>;
-  scope: DocumentField<foundry.CONST.MACRO_SCOPES> & {
-    type: String;
-    required: true;
-    default: typeof foundry.CONST.MACRO_SCOPES[0];
-    validate: (t: unknown) => t is foundry.CONST.MACRO_SCOPES;
-    validationError: 'The provided Macro scope must be in CONST.MACRO_SCOPES';
-  };
-  command: fields.BlankString;
-  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: fields.IntegerSortField;
-  permission: fields.DocumentPermissions;
-  flags: fields.ObjectField;
-}
-
-interface MacroDataProperties {
-  /**
-   * The _id which uniquely identifies this Macro document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The name of this Macro
-   */
-  name: string;
-
-  /**
-   * A Macro subtype from CONST.MACRO_TYPES
-   * @defaultValue `foundry.CONST.MACRO_TYPES.CHAT`
-   */
-  type: foundry.CONST.MACRO_TYPES;
-
-  /**
-   * The _id of a User document which created this Macro *
-   * @defaultValue `game?.user`
-   */
-  author: string;
-
-  /**
-   * An image file path which provides the thumbnail artwork for this Macro
-   * @defaultValue `CONST.DEFAULT_MACRO_ICON`
-   */
-  img: string | null;
-
-  /**
-   * The scope of this Macro application from CONST.MACRO_SCOPES
-   * @defaultValue `CONST.MACRO_SCOPES[0]` ("global")
-   */
-  scope: foundry.CONST.MACRO_SCOPES;
-
-  /**
-   * The string content of the macro command
-   * @defaultValue `""`
-   */
-  command: string;
-
-  /**
-   * The _id of a Folder which contains this Macro
-   * @defaultValue `null`
-   */
-  folder: string | null;
-
-  /**
-   * The numeric sort value which orders this Macro relative to its siblings
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /**
-   * An object which configures user permissions to this Macro
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>>;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Macro'>;
-}
-
-interface MacroDataConstructorData {
-  /**
-   * The _id which uniquely identifies this Macro document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The name of this Macro
-   */
-  name: string;
-
-  /**
-   * A Macro subtype from CONST.MACRO_TYPES
-   * @defaultValue `foundry.CONST.MACRO_TYPES.CHAT`
-   */
-  type?: foundry.CONST.MACRO_TYPES | null | undefined;
-
-  /**
-   * The _id of a User document which created this Macro *
-   * @defaultValue `game?.user`
-   */
-  author?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseUser>> | string | null | undefined;
-
-  /**
-   * An image file path which provides the thumbnail artwork for this Macro
-   * @defaultValue `CONST.DEFAULT_MACRO_ICON`
-   */
-  img?: string | null | undefined;
-
-  /**
-   * The scope of this Macro application from CONST.MACRO_SCOPES
-   * @defaultValue `CONST.MACRO_SCOPES[0]` ("global")
-   */
-  scope?: foundry.CONST.MACRO_SCOPES | null | undefined;
-
-  /**
-   * The string content of the macro command
-   * @defaultValue `""`
-   */
-  command?: string | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this Macro
-   * @defaultValue `null`
-   */
-  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
-
-  /**
-   * The numeric sort value which orders this Macro relative to its siblings
-   * @defaultValue `0`
-   */
-  sort?: number | null | undefined;
-
-  /**
-   * An object which configures user permissions to this Macro
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission?: Partial<Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>> | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Macro'> | null | undefined;
-}
-
-type MacroDataSource = PropertiesToSource<MacroDataProperties>;
-
-/**
- * The data schema for a Macro document.
- * @see BaseMacro
- */
-export class MacroData extends DocumentData<
-  MacroDataSchema,
-  MacroDataProperties,
-  MacroDataSource,
-  MacroDataConstructorData,
-  documents.BaseMacro
-> {
-  constructor(data: MacroDataConstructorData, document?: documents.BaseMacro | null);
-
-  static override defineSchema(): MacroDataSchema;
-
-  /**
-   * The default icon used for newly created Macro documents.
-   * @defaultValue `"icons/svg/dice-target.svg"`
-   */
-  static DEFAULT_ICON: string;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MacroData extends MacroDataProperties {}