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

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

@@ -1,114 +0,0 @@
-import './types.mjs';
-import './utils/primitives.mjs';
-import * as _CONST from './constants.mjs';
-import * as _abstract from './abstract/module.mjs';
-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.
- */
-export * as CONST from './constants.mjs';
-
-/**
- * Abstract class definitions providing fundamental interfaces used throughout the Foundry Virtual Tabletop framework.
- */
-export * as abstract from './abstract/module.mjs';
-
-/**
- * Data schema definitions providing structure for Documents used throughout the Foundry Virtual Tabletop framework.
- */
-export * as data from './data/module.mjs';
-
-/**
- * Document definitions used throughout the Foundry Virtual Tabletop framework.
- */
-export * as documents from './documents.mjs';
-
-/**
- * Package data definitions, validations, and schema
- */
-export * as packages from './packages.mjs';
-
-/**
- * Utility functions providing helpful functionality.
- */
-export * as utils from './utils/module.mjs';
-
-declare global {
-  namespace foundry {
-    /**
-     * Constant definitions used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import CONST = _CONST; // eslint-disable-line @typescript-eslint/no-unused-vars
-
-    /**
-     * Abstract class definitions providing fundamental interfaces used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import abstract = _abstract; // eslint-disable-line @typescript-eslint/no-unused-vars
-
-    /**
-     * Data schema definitions providing structure for Documents used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import data = _data; // eslint-disable-line @typescript-eslint/no-unused-vars
-
-    /**
-     * Utility functions providing helpful functionality.
-     */
-    export import utils = _utils; // eslint-disable-line @typescript-eslint/no-unused-vars
-
-    /**
-     * Document definitions used throughout the Foundry Virtual Tabletop framework.
-     */
-    export import documents = _documents; // eslint-disable-line @typescript-eslint/no-unused-vars
-
-    /**
-     * 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
-  }
-
-  /**
-   * Constant definitions used throughout the Foundry Virtual Tabletop framework.
-   */
-  const CONST: typeof _CONST;
-
-  type Collection<T> = _utils.Collection<T>;
-  var Collection: typeof _utils.Collection; // eslint-disable-line no-var
-
-  type Semaphore = _utils.Semaphore;
-  var Semaphore: typeof _utils.Semaphore; // eslint-disable-line no-var
-
-  var benchmark: typeof _utils.benchmark; // eslint-disable-line no-var
-  var debounce: typeof _utils.debounce; // eslint-disable-line no-var
-  var deepClone: typeof _utils.deepClone; // eslint-disable-line no-var
-  var diffObject: typeof _utils.diffObject; // eslint-disable-line no-var
-  var duplicate: typeof _utils.duplicate; // eslint-disable-line no-var
-  var encodeURL: typeof _utils.encodeURL; // eslint-disable-line no-var
-  var expandObject: typeof _utils.expandObject; // eslint-disable-line no-var
-  var filterObject: typeof _utils.filterObject; // eslint-disable-line no-var
-  var flattenObject: typeof _utils.flattenObject; // eslint-disable-line no-var
-  var getParentClasses: typeof _utils.getParentClasses; // eslint-disable-line no-var
-  var getProperty: typeof _utils.getProperty; // eslint-disable-line no-var
-  var getRoute: typeof _utils.getRoute; // eslint-disable-line no-var
-  var getType: typeof _utils.getType; // eslint-disable-line no-var
-  var hasProperty: typeof _utils.hasProperty; // eslint-disable-line no-var
-  var invertObject: typeof _utils.invertObject; // eslint-disable-line no-var
-  var isNewerVersion: typeof _utils.isNewerVersion; // eslint-disable-line no-var
-  var isObjectEmpty: typeof _utils.isObjectEmpty; // eslint-disable-line no-var
-  var mergeObject: typeof _utils.mergeObject; // eslint-disable-line no-var
-  var randomID: typeof _utils.randomID; // eslint-disable-line no-var
-  var setProperty: typeof _utils.setProperty; // eslint-disable-line no-var
-  var timeSince: typeof _utils.timeSince; // eslint-disable-line no-var
-  var rgbToHsv: typeof _utils.rgbToHsv; // eslint-disable-line no-var
-  var hsvToRgb: typeof _utils.hsvToRgb; // eslint-disable-line no-var
-  var rgbToHex: typeof _utils.rgbToHex; // eslint-disable-line no-var
-  var hexToRGB: typeof _utils.hexToRGB; // eslint-disable-line no-var
-  var hexToRGBAString: typeof _utils.hexToRGBAString; // eslint-disable-line no-var
-  var colorStringToHex: typeof _utils.colorStringToHex; // eslint-disable-line no-var
-}

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

@@ -1,8 +0,0 @@
-export { tagPackageAvailability } from './tagPackageAvailability';
-export { WorldData } from './worldData';
-export { SystemData } from './systemData';
-export { ModuleData } from './moduleData';
-export { PackageAuthorData } from './packageAuthorData';
-export { PackageCompendiumData } from './packageCompendiumData';
-export { PackageDependencyData } from './packageDependencyData';
-export { PackageLanguageData } from './packageLanguageData';

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

@@ -1,55 +0,0 @@
-import * as fields from '../data/fields.mjs';
-import { PackageData, PackageDataConstructorData, PackageDataProperties, PackageDataSchema } from './packageData';
-
-interface ModuleDataSchema extends PackageDataSchema {
-  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 | 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;
-}
-
-interface ModuleDataConstructorData extends PackageDataConstructorData {
-  /**
-   * Does this module provide a translation for the core software?
-   * @defaultValue `false`
-   */
-  coreTranslation?: boolean | null | undefined;
-
-  /** A minimum version number of the game system that this module requires */
-  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 | undefined;
-}
-
-/**
- * The data schema used to define Module manifest files.
- * Extends the basic PackageData schema with some additional module-specific fields.
- */
-export class ModuleData extends PackageData<ModuleDataSchema, ModuleDataProperties, ModuleDataConstructorData> {
-  static override defineSchema(): ModuleDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface ModuleData extends ModuleDataProperties {}

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

@@ -1,58 +0,0 @@
-import { PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentData } from '../abstract/module.mjs';
-import * as fields from '../data/fields.mjs';
-
-interface PackageAuthorDataSchema extends DocumentSchema {
-  name: fields.RequiredString;
-  email: fields.StringField;
-  url: fields.StringField;
-  discord: fields.StringField;
-}
-
-interface PackageAuthorDataProperties {
-  /** The author name */
-  name: string;
-
-  /** The author email address */
-  email: string | undefined;
-
-  /** A website url for the author */
-  url: string | undefined;
-
-  /** A Discord username for the author */
-  discord: string | undefined;
-}
-
-interface PackageAuthorDataConstructorData {
-  /** The author name */
-  name: string;
-
-  /** 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;
-}
-
-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,
-  PackageAuthorDataSource,
-  PackageAuthorDataConstructorData,
-  null
-> {
-  constructor(data?: PackageAuthorDataConstructorData, document?: null);
-
-  static override defineSchema(): PackageAuthorDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PackageAuthorData extends PackageAuthorDataProperties {}

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

@@ -1,88 +0,0 @@
-import { FieldReturnType, PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentData } from '../abstract/module.mjs';
-import * as fields from '../data/fields.mjs';
-
-interface PackageCompendiumDataSchema extends DocumentSchema {
-  name: FieldReturnType<
-    fields.RequiredString,
-    {
-      validate: (v: string) => boolean;
-      validationError: "Invalid compendium name '{value}'. Compendium names cannot contain dots.";
-    }
-  >;
-  label: fields.RequiredString;
-  path: fields.RequiredString;
-  private: FieldReturnType<fields.BooleanField, { default: false }>;
-  entity: fields.StringField;
-  type: FieldReturnType<
-    fields.RequiredString,
-    {
-      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';
-    }
-  >;
-  system: fields.StringField;
-}
-
-interface PackageCompendiumDataProperties {
-  /** The canonical compendium name. This should contain no spaces or special characters. */
-  name: string;
-
-  /** The human-readable compendium name. */
-  label: string;
-
-  /** 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 */
-  type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-
-  /** Denote that this compendium pack requires a specific game system to function properly. */
-  system: string | undefined;
-}
-
-interface PackageCompendiumDataConstructorData {
-  /** The canonical compendium name. This should contain no spaces or special characters. */
-  name: string;
-
-  /** The human-readable compendium name. */
-  label: string;
-
-  /** The local relative path to the compendium source .db file. The filename should match the name attribute. */
-  path: string;
-
-  /** @defaultValue `false` */
-  private?: boolean | null | undefined;
-
-  entity?: string | null | undefined;
-
-  /** The specific document type that is contained within this compendium pack */
-  type: foundry.CONST.COMPENDIUM_DOCUMENT_TYPES;
-
-  /** Denote that this compendium pack requires a specific game system to function properly. */
-  system?: string | null | undefined;
-}
-
-type PackageCompendiumDataSource = PropertiesToSource<PackageCompendiumDataProperties>;
-
-/**
- * An inner data object which represents a single compendium pack definition provided by a package in the packs array.
- */
-export class PackageCompendiumData extends DocumentData<
-  PackageCompendiumDataSchema,
-  PackageCompendiumDataProperties,
-  PackageCompendiumDataSource,
-  PackageCompendiumDataConstructorData
-> {
-  static override defineSchema(): PackageCompendiumDataSchema;
-
-  override _initializeSource(data: PackageCompendiumDataConstructorData): PackageCompendiumDataSource;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PackageCompendiumData extends PackageCompendiumDataProperties {}

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

@@ -1,319 +0,0 @@
-import { FieldReturnType, PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentData } from '../abstract/module.mjs';
-import type { PACKAGE_AVAILABILITY_CODES } from '../constants.mjs';
-import * as fields from '../data/fields.mjs';
-import { PackageAuthorData, PackageAuthorDataConstructorData } from './packageAuthorData';
-import { PackageCompendiumData, PackageCompendiumDataConstructorData } from './packageCompendiumData';
-import { PackageDependencyData, PackageDependencyDataConstructorData } from './packageDependencyData';
-import { PackageLanguageData, PackageLanguageDataConstructorData } from './packageLanguageData';
-
-/**
- * A helper field used for string arrays
- */
-declare const STRING_ARRAY_FIELD: StringArrayField;
-/**
- * Property type: `string[]`
- * Constructor type: `string[] | null | undefined`
- * Default `[]`
- */
-type StringArrayField = DocumentField<string[]> & {
-  type: [typeof String];
-  required: true;
-  default: [];
-  clean: (v: unknown) => string[];
-};
-
-/**
- * A helper field used for arrays of package include objects
- */
-declare const INCLUDE_ARRAY_FIELD: <T extends ConstructorOf<DocumentData<any, any>>>(
-  type: T
-) => IncludeArrayFieldReturnType<T>;
-/**
- * Property type: `T[]`
- * Constructor type: `T[] | null | undefined`
- * Default `[]`
- */
-type IncludeArrayFieldReturnType<T extends ConstructorOf<DocumentData<any, any>>> = DocumentField<
-  Array<InstanceType<T>>
-> & {
-  type: [T];
-  required: true;
-  default: [];
-  clean: (v: unknown) => InstanceType<T>['_source'][];
-};
-
-interface PackageDataSchema extends DocumentSchema {
-  name: fields.RequiredString;
-  title: fields.RequiredString;
-  description: fields.BlankString;
-  author: fields.StringField;
-  authors: IncludeArrayFieldReturnType<typeof PackageAuthorData>;
-  url: fields.StringField;
-  license: fields.StringField;
-  readme: fields.StringField;
-  bugs: fields.StringField;
-  changelog: fields.StringField;
-  flags: fields.ObjectField;
-  version: FieldReturnType<fields.RequiredString, { default: '1.0.0' }>;
-  minimumCoreVersion: fields.StringField;
-  compatibleCoreVersion: fields.StringField;
-  scripts: StringArrayField;
-  esmodules: StringArrayField;
-  styles: StringArrayField;
-  languages: IncludeArrayFieldReturnType<typeof PackageLanguageData>;
-  packs: IncludeArrayFieldReturnType<typeof PackageCompendiumData>;
-  system: StringArrayField;
-  dependencies: IncludeArrayFieldReturnType<typeof PackageDependencyData>;
-  socket: FieldReturnType<fields.BooleanField, { default: false }>;
-  manifest: fields.StringField;
-  download: fields.StringField;
-  protected: FieldReturnType<fields.BooleanField, { default: false }>;
-}
-
-interface PackageDataProperties {
-  /** The canonical package name, should be lower-case with no spaces or special characters */
-  name: string;
-
-  /** The human-readable package title, containing spaces and special characters */
-  title: string;
-
-  /**
-   * An optional package description, may contain HTML
-   * @defaultValue `""`
-   */
-  description: string;
-
-  /** A singular package author; this is an old field staged for later deprecation, please use authors */
-  author: string | undefined;
-
-  /**
-   * An array of author objects who are co-authors of this package. Preferred to the singular author field.
-   * @defaultValue `[]`
-   */
-  authors: PackageAuthorData[];
-
-  /** A web url where more details about the package may be found */
-  url: string | undefined;
-
-  /** A web url or relative file path where license details may be found */
-  license: string | undefined;
-
-  /** A web url or relative file path where readme instructions may be found */
-  readme: string | undefined;
-
-  /** A web url where bug reports may be submitted and tracked */
-  bugs: string | undefined;
-
-  /** A web url where notes detailing package updates are available */
-  changelog: string | undefined;
-
-  /** @defaultValue `{}` */
-  flags: Record<string, unknown>;
-
-  /**
-   * The current package version
-   * @defaultValue `"1.0.0"`
-   */
-  version: string;
-
-  /** A minimum version of the core Foundry software which is required to use this package */
-  minimumCoreVersion: string | undefined;
-
-  /** A maximum version of the core Foundry software beyond which compatibility is not guaranteed */
-  compatibleCoreVersion: string | undefined;
-
-  /**
-   * An array of urls or relative file paths for JavaScript files which should be included
-   * @defaultValue `[]`
-   */
-  scripts: string[];
-
-  /**
-   * An array of urls or relative file paths for ESModule files which should be included
-   * @defaultValue `[]`
-   */
-  esmodules: string[];
-
-  /**
-   * An array of urls or relative file paths for CSS stylesheet files which should be included
-   * @defaultValue `[]`
-   */
-  styles: string[];
-
-  /**
-   * An array of language data objects which are included by this package
-   * @defaultValue `[]`
-   */
-  languages: PackageLanguageData[];
-
-  /**
-   * An array of compendium packs which are included by this package
-   * @defaultValue `[]`
-   */
-  packs: PackageCompendiumData[];
-
-  /**
-   * An array of game system names which this module supports
-   * @defaultValue `[]`
-   */
-  system: string[];
-
-  /**
-   * An array of dependency objects which define required dependencies for using this package
-   * @defaultValue `[]`
-   */
-  dependencies: PackageDependencyData[];
-
-  /**
-   * Whether to require a package-specific socket namespace for this package
-   * @defaultValue `false`
-   */
-  socket: boolean;
-
-  /** A publicly accessible web URL which provides the latest available package manifest file. Required in order to support module updates. */
-  manifest: string | undefined;
-
-  /** A publicly accessible web URL where the source files for this package may be downloaded. Required in order to support module installation. */
-  download: string | undefined;
-
-  /**
-   * Whether this package uses the protected content access system.
-   * @defaultValue `false`
-   */
-  protected: boolean;
-}
-
-interface PackageDataConstructorData {
-  /** The canonical package name, should be lower-case with no spaces or special characters */
-  name: string;
-
-  /** The human-readable package title, containing spaces and special characters */
-  title: string;
-
-  /**
-   * An optional package description, may contain HTML
-   * @defaultValue `""`
-   */
-  description?: string | null | undefined;
-
-  /** A singular package author; this is an old field staged for later deprecation, please use authors */
-  author?: string | null | undefined;
-
-  /**
-   * An array of author objects who are co-authors of this package. Preferred to the singular author field.
-   * @defaultValue `[]`
-   */
-  authors?: PackageAuthorDataConstructorData[] | null | undefined;
-
-  /** A web url where more details about the package may be found */
-  url?: string | null | undefined;
-
-  /** A web url or relative file path where license details may be found */
-  license?: string | null | undefined;
-
-  /** A web url or relative file path where readme instructions may be found */
-  readme?: string | null | undefined;
-
-  /** A web url where bug reports may be submitted and tracked */
-  bugs?: string | null | undefined;
-
-  /** A web url where notes detailing package updates are available */
-  changelog?: string | null | undefined;
-
-  /** @defaultValue `{}` */
-  flags?: Record<string, unknown> | null | undefined;
-
-  /**
-   * The current package version
-   * @defaultValue `"1.0.0"`
-   */
-  version?: string | null | undefined;
-
-  /** A minimum version of the core Foundry software which is required to use this package */
-  minimumCoreVersion?: string | null | undefined;
-
-  /** A maximum version of the core Foundry software beyond which compatibility is not guaranteed */
-  compatibleCoreVersion?: string | null | undefined;
-
-  /**
-   * An array of urls or relative file paths for JavaScript files which should be included
-   * @defaultValue `[]`
-   */
-  scripts?: string[] | null | undefined;
-
-  /**
-   * An array of urls or relative file paths for ESModule files which should be included
-   * @defaultValue `[]`
-   */
-  esmodules?: string[] | null | undefined;
-
-  /**
-   * An array of urls or relative file paths for CSS stylesheet files which should be included
-   * @defaultValue `[]`
-   */
-  styles?: string[] | null | undefined;
-
-  /**
-   * An array of language data objects which are included by this package
-   * @defaultValue `[]`
-   */
-  languages?: PackageLanguageDataConstructorData[] | null | undefined;
-
-  /**
-   * An array of compendium packs which are included by this package
-   * @defaultValue `[]`
-   */
-  packs?: PackageCompendiumDataConstructorData[] | null | undefined;
-
-  /**
-   * An array of game system names which this module supports
-   * @defaultValue `[]`
-   */
-  system?: string[] | null | undefined;
-
-  /**
-   * An array of dependency objects which define required dependencies for using this package
-   * @defaultValue `[]`
-   */
-  dependencies?: PackageDependencyDataConstructorData[] | null | undefined;
-
-  /**
-   * Whether to require a package-specific socket namespace for this package
-   * @defaultValue `false`
-   */
-  socket?: boolean | null | undefined;
-
-  /** A publicly accessible web URL which provides the latest available package manifest file. Required in order to support module updates. */
-  manifest?: string | null | undefined;
-
-  /** A publicly accessible web URL where the source files for this package may be downloaded. Required in order to support module installation. */
-  download?: string | null | undefined;
-
-  /**
-   * Whether this package uses the protected content access system.
-   * @defaultValue `false`
-   */
-  protected?: boolean | null | undefined;
-}
-/**
- * The data schema used to define a Package manifest.
- * Specific types of packages extend this schema with additional fields.
- */
-export class PackageData<
-  Schema extends Omit<PackageDataSchema, 'system'>,
-  Properties extends Omit<PackageDataProperties, 'system'>,
-  ConstructorData extends Omit<PackageDataConstructorData, 'system'>
-> extends DocumentData<Schema, Properties, PropertiesToSource<Properties>, ConstructorData> {
-  static override defineSchema(): Omit<PackageDataSchema, 'system'>;
-
-  override _initializeSource(data: ConstructorData): PropertiesToSource<Properties>;
-
-  /**
-   * Determine the availability a package based on the version numbers of its dependencies.
-   */
-  static checkAvailability(
-    minimumCoreVersion: number | string | null | undefined,
-    compatibleCoreVersion: number | string | null | undefined
-  ): PACKAGE_AVAILABILITY_CODES;
-}