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

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

@@ -1,212 +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 MeasuredTemplateDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  user: fields.ForeignDocumentField<{ type: typeof documents.BaseUser; required: true }>;
-  t: DocumentField<typeof foundry.CONST.MEASURED_TEMPLATE_TYPES> & {
-    type: typeof String;
-    required: true;
-    default: typeof foundry.CONST.MEASURED_TEMPLATE_TYPES.CIRCLE;
-    validate: (t: unknown) => t is typeof foundry.CONST.MEASURED_TEMPLATE_TYPES;
-    validationError: 'Invalid {name} {field} which must be a value in CONST.MEASURED_TEMPLATE_TYPES';
-  };
-  x: fields.RequiredNumber;
-  y: fields.RequiredNumber;
-  distance: FieldReturnType<fields.RequiredPositiveNumber, { default: 1; validate: (n: number) => boolean }>;
-  direction: FieldReturnType<fields.AngleField, { default: 0 }>;
-  angle: fields.AngleField;
-  width: FieldReturnType<fields.RequiredPositiveNumber, { default: 1 }>;
-  borderColor: FieldReturnType<fields.ColorField, { required: true; default: '#000000' }>;
-  fillColor: FieldReturnType<fields.ColorField, { required: true; default: '#FF0000' }>;
-  texture: fields.VideoField;
-  flags: fields.ObjectField;
-}
-
-interface MeasuredTemplateDataProperties {
-  /**
-   * The _id which uniquely identifies this BaseMeasuredTemplate embedded document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  user: string | null;
-
-  /**
-   * The value in CONST.MEASURED_TEMPLATE_TYPES which defines the geometry type of this template
-   * @defaultValue `foundry.CONST.MEASURED_TEMPLATE_TYPES.CIRCLE`
-   */
-  t: foundry.CONST.MEASURED_TEMPLATE_TYPES;
-
-  /**
-   * The x-coordinate position of the origin of the template effect
-   * @defaultValue `0`
-   */
-  x: number;
-
-  /**
-   * The y-coordinate position of the origin of the template effect
-   * @defaultValue `0`
-   */
-  y: number;
-
-  /**
-   * The distance of the template effect
-   * @defaultValue `1`
-   */
-  distance: number;
-
-  /**
-   * The angle of rotation for the measured template
-   * @defaultValue `0`
-   */
-  direction: number;
-
-  /**
-   * The angle of effect of the measured template, applies to cone types
-   * @defaultValue `360`
-   */
-  angle: number;
-
-  /**
-   * The width of the measured template, applies to ray types
-   * @defaultValue `1`
-   */
-  width: number;
-
-  /**
-   * A color string used to tint the border of the template shape
-   * @defaultValue `'#000000'`
-   */
-  borderColor: string | null;
-
-  /**
-   * A color string used to tint the fill of the template shape
-   * @defaultValue `'#FF0000'`
-   */
-  fillColor: string | null;
-
-  /**
-   * A repeatable tiling texture used to add a texture fill to the template shape
-   */
-  texture: string | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'MeasuredTemplate'>;
-}
-
-interface MeasuredTemplateDataConstructorData {
-  /**
-   * The _id which uniquely identifies this BaseMeasuredTemplate embedded document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  user?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseUser>> | string | null | undefined;
-
-  /**
-   * The value in CONST.MEASURED_TEMPLATE_TYPES which defines the geometry type of this template
-   * @defaultValue `foundry.CONST.MEASURED_TEMPLATE_TYPES.CIRCLE`
-   */
-  t?: foundry.CONST.MEASURED_TEMPLATE_TYPES | null | undefined;
-
-  /**
-   * The x-coordinate position of the origin of the template effect
-   * @defaultValue `0`
-   */
-  x?: number | null | undefined;
-
-  /**
-   * The y-coordinate position of the origin of the template effect
-   * @defaultValue `0`
-   */
-  y?: number | null | undefined;
-
-  /**
-   * The distance of the template effect
-   * @defaultValue `1`
-   */
-  distance?: number | null | undefined;
-
-  /**
-   * The angle of rotation for the measured template
-   * @defaultValue `0`
-   */
-  direction?: number | null | undefined;
-
-  /**
-   * The angle of effect of the measured template, applies to cone types
-   * @defaultValue `360`
-   */
-  angle?: number | null | undefined;
-
-  /**
-   * The width of the measured template, applies to ray types
-   * @defaultValue `1`
-   */
-  width?: number | null | undefined;
-
-  /**
-   * A color string used to tint the border of the template shape
-   * @defaultValue `'#000000'`
-   */
-  borderColor?: string | null | undefined;
-
-  /**
-   * A color string used to tint the fill of the template shape
-   * @defaultValue `'#FF0000'`
-   */
-  fillColor?: string | null | undefined;
-
-  /**
-   * A repeatable tiling texture used to add a texture fill to the template shape
-   */
-  texture?: string | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'MeasuredTemplate'> | null | undefined;
-}
-
-type MeasuredTemplateDataSource = PropertiesToSource<MeasuredTemplateDataProperties>;
-
-/**
- * The data schema for a MeasuredTemplate embedded document.
- * @see BaseMeasuredTemplate
- */
-export class MeasuredTemplateData extends DocumentData<
-  MeasuredTemplateDataSchema,
-  MeasuredTemplateDataProperties,
-  MeasuredTemplateDataSource,
-  MeasuredTemplateDataConstructorData,
-  documents.BaseMeasuredTemplate
-> {
-  /**
-   * @remarks This override does not exist in foundry but is added here to prepend runtime errors.
-   */
-  constructor(
-    data: MeasuredTemplateDataConstructorData | undefined,
-    document: InstanceType<ConfiguredDocumentClass<typeof foundry.documents.BaseScene>>
-  );
-
-  static override defineSchema(): MeasuredTemplateDataSchema;
-
-  protected override _initialize(): void;
-
-  protected override _validateDocument(): void;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface MeasuredTemplateData extends MeasuredTemplateDataProperties {}

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

@@ -1,233 +0,0 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  FieldReturnType,
-  PropertiesToSource
-} from '../../../../types/helperTypes';
-import DocumentData from '../../abstract/data.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface NoteDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  entryId: fields.ForeignDocumentField<{ type: typeof documents.BaseJournalEntry; required: false }>;
-  x: fields.RequiredNumber;
-  y: fields.RequiredNumber;
-  icon: FieldReturnType<fields.ImageField, { required: true; default: typeof NoteData.DEFAULT_ICON }>;
-  iconSize: FieldReturnType<
-    fields.RequiredNumber,
-    {
-      default: 40;
-      validate: (n: unknown) => n is number;
-      validationError: 'Invalid {name} {field} which must be an integer greater than 32';
-    }
-  >;
-  iconTint: fields.ColorField;
-  text: fields.StringField;
-  fontFamily: FieldReturnType<
-    fields.RequiredString,
-    {
-      default: () => typeof CONFIG['defaultFontFamily'];
-    }
-  >;
-  fontSize: FieldReturnType<
-    fields.RequiredNumber,
-    {
-      default: 48;
-      validate: (n: unknown) => n is number;
-      validationError: 'Invalid {name} {field} which must be an integer between 8 and 128';
-    }
-  >;
-  textAnchor: DocumentField<typeof foundry.CONST.TEXT_ANCHOR_POINTS> & {
-    type: typeof Number;
-    required: true;
-    default: typeof foundry.CONST.TEXT_ANCHOR_POINTS.BOTTOM;
-    validate: (p: unknown) => p is foundry.CONST.TEXT_ANCHOR_POINTS;
-    validationError: 'Invalid {name} {field} which must be a value in CONST.TEXT_ANCHOR_POINTS';
-  };
-  textColor: FieldReturnType<fields.ColorField, { default: '#FFFFFF' }>;
-  flags: fields.ObjectField;
-}
-
-interface NoteDataProperties {
-  /**
-   * The _id which uniquely identifies this BaseNote embedded document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The _id of a JournalEntry document which this Note represents
-   * @defaultValue `null`
-   */
-  entryId: string | null;
-
-  /**
-   * The x-coordinate position of the center of the note icon
-   * @defaultValue `0`
-   */
-  x: number;
-
-  /**
-   * The y-coordinate position of the center of the note icon
-   * @defaultValue `0`
-   */
-  y: number;
-
-  /**
-   * An image icon path used to represent this note
-   * @defaultValue `CONST.DEFAULT_NOTE_ICON`
-   */
-  icon: string | null;
-
-  /**
-   * The pixel size of the map note icon
-   * @defaultValue `40`
-   */
-  iconSize: number;
-
-  /**
-   * An optional color string used to tint the map note icon
-   */
-  iconTint: string | null | undefined;
-
-  /**
-   * Optional text which overrides the title of the linked Journal Entry
-   */
-  text: string | undefined;
-
-  /**
-   * The font family used to display the text label on this note
-   * @defaultValue `CONFIG?.defaultFontFamily || "Signika"`
-   */
-  fontFamily: string;
-
-  /**
-   * The font size used to display the text label on this note
-   * @defaultValue `48`
-   */
-  fontSize: number;
-
-  /**
-   * A value in CONST.TEXT_ANCHOR_POINTS which defines where the text label anchors
-   * to the note icon.
-   * @defaultValue `CONST.TEXT_ANCHOR_POINTS.BOTTOM`
-   */
-  textAnchor: foundry.CONST.TEXT_ANCHOR_POINTS;
-
-  /**
-   * The string that defines the color with which the note text is rendered
-   * @defaultValue `#FFFFFF`
-   */
-  textColor: string | null;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Note'>;
-}
-
-interface NoteDataConstructorData {
-  /**
-   * The _id which uniquely identifies this BaseNote embedded document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The _id of a JournalEntry document which this Note represents
-   * @defaultValue `null`
-   */
-  entryId?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseJournalEntry>> | string | null | undefined;
-
-  /**
-   * The x-coordinate position of the center of the note icon
-   * @defaultValue `0`
-   */
-  x?: number | null | undefined;
-
-  /**
-   * The y-coordinate position of the center of the note icon
-   * @defaultValue `0`
-   */
-  y?: number | null | undefined;
-
-  /**
-   * An image icon path used to represent this note
-   * @defaultValue `CONST.DEFAULT_NOTE_ICON`
-   */
-  icon?: string | null | undefined;
-
-  /**
-   * The pixel size of the map note icon
-   * @defaultValue `40`
-   */
-  iconSize?: number | null | undefined;
-
-  /**
-   * An optional color string used to tint the map note icon
-   */
-  iconTint?: string | null | undefined;
-
-  /**
-   * Optional text which overrides the title of the linked Journal Entry
-   */
-  text?: string | null | undefined;
-
-  /**
-   * The font family used to display the text label on this note
-   * @defaultValue `CONFIG?.defaultFontFamily || "Signika"`
-   */
-  fontFamily?: string | null | undefined;
-
-  /**
-   * The font size used to display the text label on this note
-   * @defaultValue `48`
-   */
-  fontSize?: number | null | undefined;
-
-  /**
-   * A value in CONST.TEXT_ANCHOR_POINTS which defines where the text label anchors
-   * to the note icon.
-   * @defaultValue `CONST.TEXT_ANCHOR_POINTS.BOTTOM`
-   */
-  textAnchor?: foundry.CONST.TEXT_ANCHOR_POINTS | null | undefined;
-
-  /**
-   * The string that defines the color with which the note text is rendered
-   * @defaultValue `#FFFFFF`
-   */
-  textColor?: string | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Note'> | null | undefined;
-}
-
-type NoteDataSource = PropertiesToSource<NoteDataProperties>;
-
-/**
- * The data schema for a Note embedded document.
- * @see BaseNote
- */
-export class NoteData extends DocumentData<
-  NoteDataSchema,
-  NoteDataProperties,
-  NoteDataSource,
-  NoteDataConstructorData,
-  documents.BaseNote
-> {
-  static override defineSchema(): NoteDataSchema;
-
-  /**
-   * The default icon used for newly created Note documents.
-   * @defaultValue `"icons/svg/book.svg"`
-   */
-  static DEFAULT_ICON: string;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface NoteData extends NoteDataProperties {}

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

@@ -1,201 +0,0 @@
-import type { ConfiguredDocumentClass, ConfiguredFlags, PropertiesToSource } from '../../../../types/helperTypes';
-import type DocumentData from '../../abstract/data.mjs';
-import type EmbeddedCollection from '../../abstract/embedded-collection.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface PlaylistDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  description: fields.BlankString;
-  sounds: fields.EmbeddedCollectionField<typeof documents.BasePlaylistSound>;
-  mode: DocumentField<foundry.CONST.PLAYLIST_MODES> & {
-    type: typeof Number;
-    required: true;
-    default: typeof foundry.CONST.PLAYLIST_MODES.SEQUENTIAL;
-    validate: (m: unknown) => m is foundry.CONST.PLAYLIST_MODES;
-    validationError: 'Invalid {name} {field} provided which must be a value from CONST.PLAYLIST_MODES';
-  };
-  playing: fields.BooleanField;
-  fade: fields.IntegerField;
-  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sorting: DocumentField<foundry.CONST.PLAYLIST_SORT_MODES> & {
-    type: foundry.CONST.PLAYLIST_SORT_MODES;
-    required: true;
-    default: typeof foundry.CONST.PLAYLIST_SORT_MODES.ALPHABETICAL;
-    validate: (m: unknown) => m is foundry.CONST.PLAYLIST_SORT_MODES;
-    validationError: 'Invalid Playlist sorting mode';
-  };
-  sort: fields.IntegerSortField;
-  seed: fields.NonnegativeIntegerField;
-  permission: fields.DocumentPermissions;
-  flags: fields.ObjectField;
-}
-
-interface PlaylistDataProperties {
-  /**
-   * The _id which uniquely identifies this Playlist document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The name of this playlist
-   */
-  name: string;
-
-  /**
-   * The description of this playlist
-   * @defaultValue `""`
-   */
-  description: string;
-
-  /**
-   * A Collection of PlaylistSounds embedded documents which belong to this playlist
-   * @defaultValue `new EmbeddedCollection(PlaylistSoundData, [], BasePlaylistSound.implementation)`
-   */
-  sounds: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BasePlaylistSound>, PlaylistData>;
-
-  /**
-   * The playback mode for sounds in this playlist
-   * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
-   */
-  mode: foundry.CONST.PLAYLIST_MODES;
-
-  /**
-   * Is this playlist currently playing?
-   * @defaultValue `false`
-   */
-  playing: boolean;
-
-  /** A duration in milliseconds to fade volume transition */
-  fade: number | undefined;
-
-  /**
-   * The _id of a Folder which contains this playlist
-   * @defaultValue `null`
-   */
-  folder: string | null;
-
-  /**
-   * The sorting mode used for this playlist.
-   * @defaultValue `CONST.PLAYLIST_SORT_MODES.ALPHABETICAL`
-   */
-  sorting: foundry.CONST.PLAYLIST_SORT_MODES;
-
-  /**
-   * The numeric sort value which orders this playlist relative to its siblings
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /** A seed used for playlist randomization to guarantee that all clients generate the same random order. */
-  seed: number | undefined;
-
-  /**
-   * An object which configures user permissions to this playlist
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission: Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS>;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'Playlist'>;
-}
-
-interface PlaylistDataConstructorData {
-  /**
-   * The _id which uniquely identifies this Playlist document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The name of this playlist
-   */
-  name: string;
-
-  /**
-   * The description of this playlist
-   * @defaultValue `""`
-   */
-  description?: string | null | undefined;
-
-  /**
-   * A Collection of PlaylistSounds embedded documents which belong to this playlist
-   * @defaultValue `new EmbeddedCollection(PlaylistSoundData, [], BasePlaylistSound.implementation)`
-   */
-  sounds?:
-    | EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BasePlaylistSound>, PlaylistData>
-    | null
-    | undefined;
-
-  /**
-   * The playback mode for sounds in this playlist
-   * @defaultValue `CONST.PLAYLIST_MODES.SEQUENTIAL`
-   */
-  mode?: foundry.CONST.PLAYLIST_MODES | null | undefined;
-
-  /**
-   * Is this playlist currently playing?
-   * @defaultValue `false`
-   */
-  playing?: boolean | null | undefined;
-
-  /** A duration in milliseconds to fade volume transition */
-  fade?: number | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this playlist
-   * @defaultValue `null`
-   */
-  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
-
-  /**
-   * The sorting mode used for this playlist.
-   * @defaultValue `CONST.PLAYLIST_SORT_MODES.ALPHABETICAL`
-   */
-  sorting?: foundry.CONST.PLAYLIST_SORT_MODES | null | undefined;
-
-  /**
-   * The numeric sort value which orders this playlist relative to its siblings
-   * @defaultValue `0`
-   */
-  sort?: number | null | undefined;
-
-  /** A seed used for playlist randomization to guarantee that all clients generate the same random order. */
-  seed?: number | null | undefined;
-
-  /**
-   * An object which configures user permissions to this playlist
-   * @defaultValue `{ default: CONST.ENTITY_PERMISSIONS.NONE }`
-   */
-  permission?: Record<string, foundry.CONST.DOCUMENT_PERMISSION_LEVELS> | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'Playlist'> | null | undefined;
-}
-
-type PlaylistDataSource = PropertiesToSource<PlaylistDataProperties>;
-
-/**
- * The data schema for a Playlist document.
- * @see BasePlaylist
- */
-export class PlaylistData extends DocumentData<
-  PlaylistDataSchema,
-  PlaylistDataProperties,
-  PlaylistDataSource,
-  PlaylistDataConstructorData,
-  documents.BasePlaylist
-> {
-  static override defineSchema(): PlaylistDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PlaylistData extends PlaylistDataProperties {}