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

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

@@ -1,69 +0,0 @@
-import { FieldReturnType, PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentData } from '../abstract/module.mjs';
-import * as fields from '../data/fields.mjs';
-
-interface PackageDependencyDataSchema extends DocumentSchema {
-  name: fields.RequiredString;
-  type: FieldReturnType<
-    fields.RequiredString,
-    {
-      default: 'module';
-      validate: (v: unknown) => boolean;
-      validationError: 'Invalid package type "{value}" which must be a value from CONST.PACKAGE_TYPES';
-    }
-  >;
-  manifest: fields.StringField;
-}
-
-interface PackageDependencyDataProperties {
-  /** The dependency package name */
-  name: string;
-
-  /**
-   * 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 | undefined;
-}
-
-interface PackageDependencyDataConstructorData {
-  /** The dependency package name */
-  name: string;
-
-  /**
-   * 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 | undefined;
-}
-
-type PackageDependencyDataSource = PropertiesToSource<PackageDependencyDataProperties>;
-
-/**
- * An inner data object which represents a single package dependency in the dependencies array.
- */
-export class PackageDependencyData extends DocumentData<
-  PackageDependencyDataSchema,
-  PackageDependencyDataProperties,
-  PackageDependencyDataSource,
-  PackageDependencyDataConstructorData
-> {
-  static override defineSchema(): PackageDependencyDataSchema;
-
-  protected override _getMissingFieldErrorMessage(name: string, field: DocumentField<unknown>): string;
-
-  protected override _getInvalidFieldValueErrorMessage(
-    name: string,
-    field: DocumentField<unknown>,
-    value: unknown
-  ): string;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PackageDependencyData extends PackageDependencyDataProperties {}

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

@@ -1,75 +0,0 @@
-import { FieldReturnType, PropertiesToSource } from '../../../types/helperTypes';
-import { DocumentData } from '../abstract/module.mjs';
-import * as fields from '../data/fields.mjs';
-
-interface PackageLanguageDataSchema extends DocumentSchema {
-  lang: FieldReturnType<
-    fields.RequiredString,
-    {
-      validate: (lang: string) => boolean;
-      validationError: 'Invalid language code provided which is not supported by Intl.getCanonicalLocales';
-    }
-  >;
-  name: fields.StringField;
-  path: fields.RequiredString;
-  system: fields.StringField;
-  module: fields.StringField;
-}
-
-interface PackageLanguageDataProperties {
-  /** A string language code which is validated by Intl.getCanonicalLocales */
-  lang: string;
-
-  /** The human-readable language name */
-  name: string | undefined;
-
-  /** The relative path to included JSON translation strings */
-  path: string;
-
-  /** Only apply this set of translations when a specific system is being used */
-  system: string | undefined;
-
-  module: string | undefined;
-}
-
-interface PackageLanguageDataConstructorData {
-  /** A string language code which is validated by Intl.getCanonicalLocales */
-  lang: string;
-
-  /** The human-readable language name */
-  name?: string | null | undefined;
-
-  /** The relative path to included JSON translation strings */
-  path: string;
-
-  /** Only apply this set of translations when a specific system is being used */
-  system?: string | null | undefined;
-
-  module?: string | null | undefined;
-}
-
-type PackageLanguageDataSource = PropertiesToSource<PackageLanguageDataProperties>;
-
-/**
- * An inner data object which represents a single language specification provided by a package in the languages array.
- */
-export class PackageLanguageData extends DocumentData<
-  PackageLanguageDataSchema,
-  PackageLanguageDataProperties,
-  PackageLanguageDataSource,
-  PackageLanguageDataConstructorData
-> {
-  static override defineSchema(): PackageLanguageDataSchema;
-
-  protected override _initialize(): void;
-
-  /**
-   * Validate that a language code is supported as a canonical locale
-   * @param lang - The candidate language to validate
-   * @returns Is it valid?
-   */
-  static validateLocale(lang: string): boolean;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface PackageLanguageData extends PackageLanguageDataProperties {}

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

@@ -1,58 +0,0 @@
-import * as fields from '../data/fields.mjs';
-import { PackageData, PackageDataConstructorData, PackageDataProperties, PackageDataSchema } from './packageData';
-
-interface SystemDataSchema extends PackageDataSchema {
-  background: fields.StringField;
-  initiative: fields.StringField;
-  gridDistance: fields.NumericField;
-  gridUnits: fields.StringField;
-  primaryTokenAttribute: fields.StringField;
-  secondaryTokenAttribute: fields.StringField;
-}
-
-interface SystemDataProperties extends PackageDataProperties {
-  background: string | undefined;
-
-  initiative: string | undefined;
-
-  /** A default distance measurement to use for Scenes in this system */
-  gridDistance: number | null | undefined;
-
-  /** A default unit of measure to use for distance measurement in this system */
-  gridUnits: string | undefined;
-
-  /** An Actor data attribute path to use for Token primary resource bars */
-  primaryTokenAttribute: string | undefined;
-
-  /** An Actor data attribute path to use for Token secondary resource bars */
-  secondaryTokenAttribute: string | undefined;
-}
-
-interface SystemDataConstructorData extends PackageDataConstructorData {
-  background?: string | null | undefined;
-
-  initiative?: string | null | undefined;
-
-  /** A default distance measurement to use for Scenes in this system */
-  gridDistance?: number | null | undefined;
-
-  /** A default unit of measure to use for distance measurement in this system */
-  gridUnits?: string | null | undefined;
-
-  /** An Actor data attribute path to use for Token primary resource bars */
-  primaryTokenAttribute?: string | null | undefined;
-
-  /** An Actor data attribute path to use for Token secondary resource bars */
-  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 class SystemData extends PackageData<SystemDataSchema, SystemDataProperties, SystemDataConstructorData> {
-  static override defineSchema(): SystemDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface SystemData extends SystemDataProperties {}

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

@@ -1,9 +0,0 @@
-/**
- * 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` properties if needed.
- */
-export declare function tagPackageAvailability(pkg: {
-  availability: foundry.CONST.PACKAGE_AVAILABILITY_CODES;
-  type: foundry.CONST.PACKAGE_TYPES;
-}): void;

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

@@ -1,76 +0,0 @@
-import { FieldReturnType } from '../../../types/helperTypes';
-import * as fields from '../data/fields.mjs';
-import { PackageData, PackageDataConstructorData, PackageDataProperties, PackageDataSchema } from './packageData';
-
-interface WorldDataSchema extends Omit<PackageDataSchema, 'system'> {
-  system: fields.RequiredString;
-  background: fields.StringField;
-  coreVersion: fields.RequiredString;
-  nextSession: fields.StringField;
-  resetKeys: fields.BooleanField;
-  safeMode: fields.BooleanField;
-  systemVersion: FieldReturnType<fields.RequiredString, { default: () => string }>;
-}
-
-interface WorldDataProperties extends Omit<PackageDataProperties, 'system'> {
-  /** The game system name which this world relies upon */
-  system: string;
-
-  /** A web URL or local file path which provides a background banner image */
-  background: string | undefined;
-
-  /** The version of the core software for which this world has been migrated */
-  coreVersion: string;
-
-  /** An ISO datetime string when the next game session is scheduled to occur */
-  nextSession: string | undefined;
-
-  /** @defaultValue `false` */
-  resetKeys: boolean;
-
-  /** @defaultValue `false` */
-  safeMode: boolean;
-
-  /**
-   * The version of the game system for which this world has been migrated
-   * @defaultValue `"0"`
-   */
-  systemVersion: string;
-}
-
-interface WorldDataConstructorData extends Omit<PackageDataConstructorData, 'system'> {
-  /** The game system name which this world relies upon */
-  system: string;
-
-  /** A web URL or local file path which provides a background banner image */
-  background?: string | null | undefined;
-
-  /** The version of the core software for which this world has been migrated */
-  coreVersion: string;
-
-  /** An ISO datetime string when the next game session is scheduled to occur */
-  nextSession?: string | null | undefined;
-
-  /** @defaultValue `false` */
-  resetKeys?: boolean | null | undefined;
-
-  /** @defaultValue `false` */
-  safeMode?: boolean | null | undefined;
-
-  /**
-   * The version of the game system for which this world has been migrated
-   * @defaultValue `"0"`
-   */
-  systemVersion?: string | null | undefined;
-}
-
-/**
- * The data schema used to define World manifest files.
- * Extends the basic PackageData schema with some additional world-specific fields.
- */
-export class WorldData extends PackageData<WorldDataSchema, WorldDataProperties, WorldDataConstructorData> {
-  static override defineSchema(): WorldDataSchema;
-}
-
-// eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface WorldData extends WorldDataProperties {}

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

@@ -1,299 +0,0 @@
-/**
- * A single point, expressed as an object \{x, y\}
- */
-type Point = PIXI.Point | { x: number; y: number };
-
-/**
- * A single point, expressed as an array \[x,y\]
- */
-type PointArray = [x: number, y: number];
-
-/**
- * A standard rectangle interface.
- */
-type Rectangle =
-  | PIXI.Rectangle
-  | {
-      x: number;
-      y: number;
-      width: number;
-      height: number;
-    };
-
-/** A Client Setting */
-interface SettingConfig<T = unknown> {
-  /** A unique machine-readable id for the setting */
-  key: string;
-
-  /** The namespace the setting belongs to */
-  namespace: string;
-
-  /** The human readable name */
-  name?: string | undefined;
-
-  /** An additional human readable hint */
-  hint?: string | undefined;
-
-  /**
-   * The scope the Setting is stored in, either World or Client
-   * @defaultValue `'client'`
-   */
-  scope: 'world' | 'client';
-
-  /** Indicates if this Setting should render in the Config application */
-  config?: boolean | undefined;
-
-  /** The JS Type that the Setting is storing */
-  type?: T extends string
-    ? typeof String
-    : T extends number
-    ? typeof Number
-    : T extends boolean
-    ? typeof Boolean
-    : T extends Array<any>
-    ? typeof Array
-    : ConstructorOf<T>;
-
-  /** For string Types, defines the allowable values */
-  choices?: (T extends number | string ? Record<T, string> : never) | undefined;
-
-  /** For numeric Types, defines the allowable range */
-  range?:
-    | (T extends number
-        ? {
-            max: number;
-            min: number;
-            step: number;
-          }
-        : never)
-    | undefined;
-
-  /** The default value */
-  default?: T;
-
-  /** Executes when the value of this Setting changes */
-  onChange?: (value: T) => void;
-
-  filePicker?: (T extends string ? true | 'audio' | 'image' | 'video' | 'imagevideo' | 'folder' : never) | undefined;
-}
-
-interface SettingSubmenuConfig {
-  key: string;
-
-  namespace: string;
-
-  /** The human readable name */
-  name?: string | undefined;
-
-  /** The human readable label */
-  label?: string | undefined;
-
-  /** An additional human readable hint */
-  hint?: string | undefined;
-
-  /** The classname of an Icon to render */
-  icon?: string | undefined;
-
-  /** The FormApplication to render */
-  type: new () => FormApplication<any, any, any>;
-
-  /** If true, only a GM can edit this Setting */
-  restricted?: boolean | undefined;
-}
-
-/** A Client Keybinding Action Configuration */
-interface KeybindingActionConfig {
-  /** The namespace within which the action was registered */
-  namespace?: string;
-
-  /** The human readable name */
-  name: string;
-
-  /** An additional human readable hint */
-  hint?: string;
-
-  /** The default bindings that can never be changed nor removed. */
-  uneditable?: KeybindingActionBinding[];
-
-  /** The default bindings that can be changed by the user. */
-  editable?: KeybindingActionBinding[];
-
-  /** A function to execute when a key down event occurs. If True is returned, the event is consumed and no further keybinds execute. */
-  onDown?: (ctx: KeyboardEventContext) => boolean | void;
-
-  /** A function to execute when a key up event occurs. If True is returned, the event is consumed and no further keybinds execute. */
-  onUp?: (ctx: KeyboardEventContext) => boolean | void;
-
-  /** If True, allows Repeat events to execute the Action's onDown. Defaults to false. */
-  repeat?: boolean;
-
-  /** If true, only a GM can edit and execute this Action */
-  restricted?: boolean;
-
-  /** Modifiers such as [ "CONTROL" ] that can be also pressed when executing this Action. Prevents using one of these modifiers as a Binding. */
-  reservedModifiers?: string[];
-
-  /** The preferred precedence of running this Keybinding Action */
-  precedence?: number; // TODO: KEYBINDING_PRECEDENCE?
-
-  /** The recorded registration order of the action */
-  order?: number;
-}
-
-/** A Client Keybinding Action Binding */
-interface KeybindingActionBinding {
-  /** The KeyboardEvent#code value from https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/code/code_values */
-  key: string;
-
-  /** An array of modifiers keys from KeyboardManager.MODIFIER_KEYS which are required for this binding to be activated */
-  modifiers?: string[];
-}
-
-/** An action that can occur when a key is pressed */
-interface KeybindingAction {
-  /** The namespaced machine identifier of the Action */
-  action: string;
-
-  /** The Keyboard key */
-  key: string;
-
-  /** The human readable name */
-  name: string;
-
-  /** Required modifiers */
-  requiredModifiers: string[];
-
-  /** Optional (reserved) modifiers */
-  optionalModifiers: string[];
-
-  /** The handler that executes onDown */
-  onDown: Function;
-
-  /** The handler that executes onUp */
-  onUp: Function;
-
-  /** If True, allows Repeat events to execute this Action's onDown */
-  repeat: boolean;
-
-  /** If true, only a GM can execute this Action */
-  restricted: boolean;
-
-  /** The registration precedence */
-  precedence: number;
-
-  /** The registration order */
-  order: number;
-}
-
-/** Keyboard event context */
-interface KeyboardEventContext {
-  /** The normalized string key, such as "A" */
-  key: string;
-
-  /** The originating keypress event */
-  event: KeyboardEvent;
-
-  /** Is the Shift modifier being pressed */
-  isShift: boolean;
-
-  /** Is the Control or Meta modifier being processed */
-  isControl: boolean;
-
-  /** Is the Alt modifier being pressed */
-  isAlt: boolean;
-
-  /** Are any of the modifiers being pressed */
-  hasModifier: boolean;
-
-  /** A list of string modifiers applied to this context, such as [ "CONTROL" ] */
-  modifiers: string[];
-
-  /** True if the Key is Up, else False if down */
-  up: boolean;
-
-  /** True if the given key is being held down such that it is automatically repeating. */
-  repeat: boolean;
-
-  /** The executing Keybinding Action. May be undefined until the action is known. */
-  action: string | undefined;
-}
-
-/** Connected Gamepad info */
-interface ConnectedGamepad {
-  /** A map of axes values */
-  axes: Map<string, number>;
-
-  /** The Set of pressed Buttons */
-  activeButtons: Set<string>;
-}
-
-type RequestData = object | object[] | string | string[];
-
-interface SocketRequest {
-  /**
-   * The server-side action being requested
-   */
-  action?: string;
-
-  /**
-   * The type of object being modified
-   */
-  type?: string;
-
-  /**
-   * Data applied to the operation
-   */
-  data?: RequestData;
-
-  /**
-   * A Compendium pack name
-   */
-  pack?: string;
-
-  /**
-   * The type of parent document
-   */
-  parentType?: string;
-
-  /**
-   * The ID of a parent document
-   */
-  parentId?: string;
-
-  /**
-   * Additional options applied to the request
-   */
-  options?: object;
-}
-
-interface SocketResponse {
-  /**
-   * The initial request
-   */
-  request: SocketRequest;
-
-  /**
-   * An error, if one occurred
-   */
-  error?: Error;
-
-  /**
-   * The status of the request
-   */
-  status?: string;
-
-  /**
-   * The ID of the requesting User
-   */
-  userId?: string;
-
-  /**
-   * Data returned as a result of the request
-   */
-  data?: RequestData;
-
-  /**
-   * An Array of created data objects
-   */
-  result?: object[] | string[];
-}