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

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

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

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

@@ -3,49 +3,56 @@ import { DocumentData } from '../abstract/module.mjs';
 import * as fields from '../data/fields.mjs';
 
 interface PackageDependencyDataSchema extends DocumentSchema {
-  name: typeof fields.REQUIRED_STRING;
+  name: fields.RequiredString;
   type: FieldReturnType<
-    typeof fields.REQUIRED_STRING,
+    fields.RequiredString,
     {
       default: 'module';
       validate: (v: unknown) => boolean;
       validationError: 'Invalid package type "{value}" which must be a value from CONST.PACKAGE_TYPES';
     }
   >;
-  manifest: typeof fields.STRING_FIELD;
+  manifest: fields.StringField;
 }
 
 interface PackageDependencyDataProperties {
   /** The dependency package name */
   name: string;
 
-  /** The dependency package type, from CONST.PACKAGE_TYPES */
-  type: foundry.CONST.PackageTypes;
+  /**
+   * The dependency package type, from CONST.PACKAGE_TYPES
+   * @defaultValue `"module"`
+   */
+  type: foundry.CONST.PACKAGE_TYPES;
 
   /** An explicit manifest URL, otherwise learned from the Foundry web server */
-  manifest?: string;
+  manifest: string | undefined;
 }
 
 interface PackageDependencyDataConstructorData {
   /** The dependency package name */
   name: string;
 
-  /** The dependency package type, from CONST.PACKAGE_TYPES */
-  type?: foundry.CONST.PackageTypes | null;
+  /**
+   * The dependency package type, from CONST.PACKAGE_TYPES
+   * @defaultValue `"module"`
+   */
+  type?: foundry.CONST.PACKAGE_TYPES | null | undefined;
 
   /** An explicit manifest URL, otherwise learned from the Foundry web server */
-  manifest?: string | null;
+  manifest?: string | null | undefined;
 }
 
 /**
  * An inner data object which represents a single package dependency in the dependencies array.
  */
-export declare class PackageDependencyData extends DocumentData<
+export class PackageDependencyData extends DocumentData<
   PackageDependencyDataSchema,
   PackageDependencyDataProperties,
   PropertiesToSource<PackageDependencyDataProperties>,
   PackageDependencyDataConstructorData
 > {
+  /** @override */
   static defineSchema(): PackageDependencyDataSchema;
 
   /** @override */
@@ -56,4 +63,4 @@ export declare class PackageDependencyData extends DocumentData<
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface PackageDependencyData extends PackageDependencyDataProperties {}
+export interface PackageDependencyData extends PackageDependencyDataProperties {}

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

@@ -4,16 +4,16 @@ import * as fields from '../data/fields.mjs';
 
 interface PackageLanguageDataSchema extends DocumentSchema {
   lang: FieldReturnType<
-    typeof fields.REQUIRED_STRING,
+    fields.RequiredString,
     {
       validate: (lang: string) => boolean;
       validationError: 'Invalid language code provided which is not supported by Intl.getCanonicalLocales';
     }
   >;
-  name: typeof fields.STRING_FIELD;
-  path: typeof fields.STRING_FIELD;
-  system: typeof fields.STRING_FIELD;
-  module: typeof fields.STRING_FIELD;
+  name: fields.StringField;
+  path: fields.RequiredString;
+  system: fields.StringField;
+  module: fields.StringField;
 }
 
 interface PackageLanguageDataProperties {
@@ -21,15 +21,15 @@ interface PackageLanguageDataProperties {
   lang: string;
 
   /** The human-readable language name */
-  name?: string;
+  name: string | undefined;
 
   /** The relative path to included JSON translation strings */
-  path?: string;
+  path: string;
 
   /** Only apply this set of translations when a specific system is being used */
-  system?: string;
+  system: string | undefined;
 
-  module?: string;
+  module: string | undefined;
 }
 
 interface PackageLanguageDataConstructorData {
@@ -37,26 +37,27 @@ interface PackageLanguageDataConstructorData {
   lang: string;
 
   /** The human-readable language name */
-  name?: string | null;
+  name?: string | null | undefined;
 
   /** The relative path to included JSON translation strings */
-  path?: string | null;
+  path: string;
 
   /** Only apply this set of translations when a specific system is being used */
-  system?: string | null;
+  system?: string | null | undefined;
 
-  module?: string | null;
+  module?: string | null | undefined;
 }
 
 /**
  * An inner data object which represents a single language specification provided by a package in the languages array.
  */
-export declare class PackageLanguageData extends DocumentData<
+export class PackageLanguageData extends DocumentData<
   PackageLanguageDataSchema,
   PackageLanguageDataProperties,
   PropertiesToSource<PackageLanguageDataProperties>,
   PackageLanguageDataConstructorData
 > {
+  /** @override */
   static defineSchema(): PackageLanguageDataSchema;
 
   /** @override */
@@ -71,4 +72,4 @@ export declare class PackageLanguageData extends DocumentData<
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface PackageLanguageData extends PackageLanguageDataProperties {}
+export interface PackageLanguageData extends PackageLanguageDataProperties {}

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

@@ -2,57 +2,58 @@ import * as fields from '../data/fields.mjs';
 import { PackageData, PackageDataConstructorData, PackageDataProperties, PackageDataSchema } from './packageData';
 
 interface SystemDataSchema extends PackageDataSchema {
-  background: typeof fields.STRING_FIELD;
-  initiative: typeof fields.STRING_FIELD;
-  gridDistance: typeof fields.NUMERIC_FIELD;
-  gridUnits: typeof fields.STRING_FIELD;
-  primaryTokenAttribute: typeof fields.STRING_FIELD;
-  secondaryTokenAttribute: typeof fields.STRING_FIELD;
+  background: fields.StringField;
+  initiative: fields.StringField;
+  gridDistance: fields.NumericField;
+  gridUnits: fields.StringField;
+  primaryTokenAttribute: fields.StringField;
+  secondaryTokenAttribute: fields.StringField;
 }
 
 interface SystemDataProperties extends PackageDataProperties {
-  background?: string;
+  background: string | undefined;
 
-  initiative?: string;
+  initiative: string | undefined;
 
   /** A default distance measurement to use for Scenes in this system */
-  gridDistance?: number | null;
+  gridDistance: number | null | undefined;
 
   /** A default unit of measure to use for distance measurement in this system */
-  gridUnits?: string;
+  gridUnits: string | undefined;
 
   /** An Actor data attribute path to use for Token primary resource bars */
-  primaryTokenAttribute?: string;
+  primaryTokenAttribute: string | undefined;
 
   /** An Actor data attribute path to use for Token secondary resource bars */
-  secondaryTokenAttribute?: string;
+  secondaryTokenAttribute: string | undefined;
 }
 
 interface SystemDataConstructorData extends PackageDataConstructorData {
-  background?: string | null;
+  background?: string | null | undefined;
 
-  initiative?: string | null;
+  initiative?: string | null | undefined;
 
   /** A default distance measurement to use for Scenes in this system */
-  gridDistance?: number | null;
+  gridDistance?: number | null | undefined;
 
   /** A default unit of measure to use for distance measurement in this system */
-  gridUnits?: string | null;
+  gridUnits?: string | null | undefined;
 
   /** An Actor data attribute path to use for Token primary resource bars */
-  primaryTokenAttribute?: string | null;
+  primaryTokenAttribute?: string | null | undefined;
 
   /** An Actor data attribute path to use for Token secondary resource bars */
-  secondaryTokenAttribute?: string | null;
+  secondaryTokenAttribute?: string | null | undefined;
 }
 
 /**
  * The data schema used to define System manifest files.
  * Extends the basic PackageData schema with some additional system-specific fields.
  */
-export declare class SystemData extends PackageData<SystemDataSchema, SystemDataProperties, SystemDataConstructorData> {
+export class SystemData extends PackageData<SystemDataSchema, SystemDataProperties, SystemDataConstructorData> {
+  /** @override */
   static defineSchema(): SystemDataSchema;
 }
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export declare interface SystemData extends SystemDataProperties {}
+export interface SystemData extends SystemDataProperties {}

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

@@ -1,9 +1,9 @@
 /**
  * Checks a package against its availability code to see if it requires a compability warning, and if so, updates the pkg
  * @param pkg - The package
- * @remarks This doesn't actually update the package, it just sets the `unavailable` and `incompatible` flags if needed.
+ * @remarks This doesn't actually update the package, it just sets the `unavailable` and `incompatible` properties if needed.
  */
 export declare function tagPackageAvailability(pkg: {
-  availability: foundry.CONST.PackageAvailabilityCode;
-  type: foundry.CONST.PackageTypes;
+  availability: foundry.CONST.PACKAGE_AVAILABILITY_CODES;
+  type: foundry.CONST.PACKAGE_TYPES;
 }): void;