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

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

@@ -1,159 +0,0 @@
-import type { ConfiguredFlags, FieldReturnType, PropertiesToSource } from '../../../../types/helperTypes';
-import type DocumentData from '../../abstract/data.mjs';
-import type { documents } from '../../module.mjs';
-import * as fields from '../fields.mjs';
-
-interface PlaylistSoundDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  description: fields.BlankString;
-  path: fields.AudioField;
-  playing: fields.BooleanField;
-  pausedTime: FieldReturnType<fields.NumericField, { default: null }>;
-  repeat: fields.BooleanField;
-  volume: FieldReturnType<fields.AlphaField, { default: 0.5 }>;
-  fade: fields.IntegerField;
-  sort: fields.IntegerSortField;
-  flags: fields.ObjectField;
-}
-
-interface PlaylistSoundDataProperties {
-  /**
-   * The _id which uniquely identifies this PlaylistSound document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The name of this sound track
-   */
-  name: string;
-
-  /**
-   * The description of this sound track
-   * @defaultValue `""`
-   */
-  description: string;
-
-  /**
-   * The audio file path that is played by this sound
-   */
-  path: string | null | undefined;
-
-  /**
-   * Is this sound currently playing?
-   * @defaultValue `false`
-   */
-  playing: boolean;
-
-  /**
-   * The time in seconds at which playback was paused
-   * @defaultValue `null`
-   */
-  pausedTime: number | null;
-
-  /**
-   * Does this sound loop?
-   * @defaultValue `false`
-   */
-  repeat: boolean;
-
-  /**
-   * The audio volume of the sound, from 0 to 1
-   * @defaultValue `0.5`
-   */
-  volume: number;
-
-  /** A duration in milliseconds to fade volume transition */
-  fade: number | undefined;
-
-  /** @defaultValue `0` */
-  sort: number;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags: ConfiguredFlags<'PlaylistSound'>;
-}
-
-interface PlaylistSoundDataConstructorData {
-  /**
-   * The _id which uniquely identifies this PlaylistSound document
-   * @defaultValue `null`
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The name of this sound track
-   */
-  name: string;
-
-  /**
-   * The description of this sound track
-   * @defaultValue `""`
-   */
-  description?: string | null | undefined;
-
-  /**
-   * The audio file path that is played by this sound
-   */
-  path?: string | null | undefined;
-
-  /**
-   * Is this sound currently playing?
-   * @defaultValue `false`
-   */
-  playing?: boolean | null | undefined;
-
-  /**
-   * The time in seconds at which playback was paused
-   * @defaultValue `null`
-   */
-  pausedTime?: number | null | undefined;
-
-  /**
-   * Does this sound loop?
-   * @defaultValue `false`
-   */
-  repeat?: boolean | null | undefined;
-
-  /**
-   * The audio volume of the sound, from 0 to 1
-   * @defaultValue `0.5`
-   */
-  volume?: number | null | undefined;
-
-  /** A duration in milliseconds to fade volume transition */
-  fade?: number | null | undefined;
-
-  /** @defaultValue `0` */
-  sort: number | null | undefined;
-
-  /**
-   * An object of optional key/value flags
-   * @defaultValue `{}`
-   */
-  flags?: ConfiguredFlags<'PlaylistSound'> | null | undefined;
-}
-
-type PlaylistSoundDataSource = PropertiesToSource<PlaylistSoundDataProperties>;
-
-/**
- * The data schema for a PlaylistSound embedded document.
- * @see BasePlaylistSound
- */
-export class PlaylistSoundData extends DocumentData<
-  PlaylistSoundDataSchema,
-  PlaylistSoundDataProperties,
-  PlaylistSoundDataSource,
-  PlaylistSoundDataConstructorData,
-  documents.BasePlaylistSound
-> {
-  static override defineSchema(): PlaylistSoundDataSchema;
-
-  protected override _initialize(): void;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PlaylistSoundData extends PlaylistSoundDataProperties {}

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

@@ -1,75 +0,0 @@
-import { FieldReturnType, PropertiesToSource, ToObjectFalseType } from '../../../../types/helperTypes';
-import DocumentData from '../../abstract/data.mjs';
-import { documents } from '../../module.mjs';
-import * as fields from '../fields.mjs';
-import { TokenDataConstructorData, TokenDataProperties, TokenDataSchema } from './tokenData';
-
-type FieldExclusions =
-  | '_id'
-  | 'actorId'
-  | 'actorData'
-  | 'img'
-  | 'x'
-  | 'y'
-  | 'elevation'
-  | 'effects'
-  | 'overlayEffect'
-  | 'hidden';
-
-interface PrototypeTokenDataSchema extends Omit<TokenDataSchema, FieldExclusions> {
-  randomImg: fields.BooleanField;
-  img: FieldReturnType<
-    fields.VideoField,
-    { default: typeof foundry.CONST.DEFAULT_TOKEN; validate: (src: unknown) => boolean }
-  >;
-}
-
-interface PrototypeTokenDataProperties extends Omit<TokenDataProperties, FieldExclusions> {
-  /**
-   * Uses a random "wildcard" image path which is resolved with a Token is created
-   * @defaultValue `false`
-   */
-  randomImg: boolean;
-
-  /**
-   * A file path to an image or video file used to depict the Token
-   * @defaultValue `CONST.DEFAULT_TOKEN`
-   */
-  img: string | null;
-}
-
-interface PrototypeTokenDataConstructorData extends Omit<TokenDataConstructorData, FieldExclusions> {
-  /**
-   * Uses a random "wildcard" image path which is resolved with a Token is created
-   * @defaultValue `false`
-   */
-  randomImg?: boolean | null | undefined;
-
-  /**
-   * A file path to an image or video file used to depict the Token
-   * @defaultValue `CONST.DEFAULT_TOKEN`
-   */
-  img?: string | null | undefined;
-}
-
-type PrototypeTokenDataSource = PropertiesToSource<PrototypeTokenDataProperties>;
-
-export class PrototypeTokenData extends DocumentData<
-  PrototypeTokenDataSchema,
-  PrototypeTokenDataProperties,
-  PrototypeTokenDataSource,
-  PrototypeTokenDataConstructorData,
-  documents.BaseActor
-> {
-  override _initialize(): void;
-
-  override toObject(source?: true): ReturnType<this['toJSON']> & { actorId: documents.BaseActor['id'] };
-  toObject(source: false): {
-    [Key in keyof PrototypeTokenDataSchema as string extends Key ? never : Key]: Key extends keyof this
-      ? ToObjectFalseType<this[Key]>
-      : undefined;
-  } & { actorId: documents.BaseActor['id'] };
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PrototypeTokenData extends PrototypeTokenDataProperties {}

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

@@ -1,189 +0,0 @@
-import {
-  ConfiguredDocumentClass,
-  ConfiguredFlags,
-  FieldReturnType,
-  PropertiesToSource
-} from '../../../../types/helperTypes';
-import EmbeddedCollection from '../../abstract/embedded-collection.mjs';
-import { DocumentData } from '../../abstract/module.mjs';
-import * as documents from '../../documents.mjs';
-import * as fields from '../fields.mjs';
-
-interface RollTableDataSchema extends DocumentSchema {
-  _id: fields.DocumentId;
-  name: fields.RequiredString;
-  img: FieldReturnType<fields.ImageField, { default: () => typeof RollTableData.DEFAULT_ICON }>;
-  description: fields.StringField;
-  results: fields.EmbeddedCollectionField<typeof documents.BaseTableResult>;
-  formula: fields.StringField;
-  replacement: FieldReturnType<fields.BooleanField, { default: true }>;
-  displayRoll: FieldReturnType<fields.BooleanField, { default: true }>;
-  folder: fields.ForeignDocumentField<{ type: typeof documents.BaseFolder }>;
-  sort: fields.IntegerSortField;
-  permission: fields.DocumentPermissions;
-  flags: fields.ObjectField;
-}
-
-interface RollTableDataProperties {
-  /**
-   * The _id which uniquely identifies this RollTable document
-   * @defaultValue `null`
-   */
-  _id: string | null;
-
-  /**
-   * The name of this RollTable
-   */
-  name: string;
-
-  /**
-   * An image file path which provides the thumbnail artwork for this RollTable
-   * @defaultValue `RollTableData.DEFAULT_ICON`
-   */
-  img: string;
-
-  /**
-   * The HTML text description for this RollTable document
-   */
-  description: string | undefined;
-
-  /**
-   * A Collection of TableResult embedded documents which belong to this RollTable
-   * @defaultValue `new EmbeddedCollection(TableResultData, [], BaseTableResult.implementation)`
-   */
-  results: EmbeddedCollection<ConfiguredDocumentClass<typeof documents.BaseTableResult>, RollTableData>;
-
-  /**
-   * The Roll formula which determines the results chosen from the table
-   */
-  formula: string | undefined;
-
-  /**
-   * Are results from this table drawn with replacement?
-   * @defaultValue `true`
-   */
-  replacement: boolean;
-
-  /**
-   * Is the Roll result used to draw from this RollTable displayed in chat?
-   * @defaultValue `true`
-   */
-  displayRoll: boolean;
-
-  /**
-   * The _id of a Folder which contains this RollTable
-   */
-  folder: string | null;
-
-  /**
-   * The numeric sort value which orders this RollTable relative to its siblings
-   * @defaultValue `0`
-   */
-  sort: number;
-
-  /**
-   * An object which configures user permissions to this RollTable
-   * @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<'RollTable'>;
-}
-
-interface RollTableDataConstructorData {
-  /**
-   * The _id which uniquely identifies this RollTable document
-   */
-  _id?: string | null | undefined;
-
-  /**
-   * The name of this RollTable
-   */
-  name: string;
-
-  /**
-   * An image file path which provides the thumbnail artwork for this RollTable
-   * @defaultValue `RollTableData.DEFAULT_ICON`
-   */
-  img?: string | null | undefined;
-
-  /**
-   * The HTML text description for this RollTable document
-   */
-  description?: string | null | undefined;
-
-  /**
-   * A Collection of TableResult embedded documents which belong to this RollTable
-   * @defaultValue `new EmbeddedCollection(TableResultData, [], BaseTableResult.implementation)`
-   */
-  results?: ConstructorParameters<ConfiguredDocumentClass<typeof documents.BaseTableResult>>[0][] | null | undefined;
-
-  /**
-   * The Roll formula which determines the results chosen from the table
-   */
-  formula?: string | null | undefined;
-
-  /**
-   * Are results from this table drawn with replacement?
-   * @defaultValue `true`
-   */
-  replacement?: boolean | null | undefined;
-
-  /**
-   * Is the Roll result used to draw from this RollTable displayed in chat?
-   * @defaultValue `true`
-   */
-  displayRoll?: boolean | null | undefined;
-
-  /**
-   * The _id of a Folder which contains this RollTable
-   */
-  folder?: InstanceType<ConfiguredDocumentClass<typeof documents.BaseFolder>> | string | null | undefined;
-
-  /**
-   * The numeric sort value which orders this RollTable relative to its siblings
-   */
-  sort?: number | null | undefined;
-
-  /**
-   * An object which configures user permissions to this RollTable
-   * @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<'RollTable'> | null | undefined;
-}
-
-type RollTableDataSource = PropertiesToSource<RollTableDataProperties>;
-
-/**
- * The data schema for an RollTable document.
- * @see BaseRollTable
- */
-export class RollTableData extends DocumentData<
-  RollTableDataSchema,
-  RollTableDataProperties,
-  RollTableDataSource,
-  RollTableDataConstructorData,
-  documents.BaseRollTable
-> {
-  static override defineSchema(): RollTableDataSchema;
-
-  /**
-   * The default icon used for newly created Macro documents
-   * @remarks Incorrect description, really for the RollTables.
-   * @defaultValue `'icons/svg/d20-grey.svg'`
-   */
-  static DEFAULT_ICON: string;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface RollTableData extends RollTableDataProperties {}