fvtt-types/src/foundry/common/packages/base-world.d.mts

TypeScript type definitions for Foundry VTT

import type BasePackage from "./base-package.d.mts";
import type { AnyMutableObject, InexactPartial } from "#utils";
import type { ReleaseData } from "../config.d.mts";

declare namespace BaseWorld {
  export import Source = World.Source;
  export import CreateData = World.CreateData;
  export import InitializedData = World.InitializedData;
  export import UpdateData = World.UpdateData;
  export import Schema = World.Schema;

  interface TestAvailabilityOptions {
    /**
     * A specific software release for which to test availability.
     * Tests against the current release by default.
     */
    release?: ReleaseData | undefined;

    /**
     * A specific collection of modules to test availability
     * against. Tests against the currently installed modules by
     * default.
     */
    modules?: Collection<foundry.packages.Module> | undefined;

    /**
     * A specific collection of modules to test availability
     * against. Tests against the currently installed modules by
     * default.
     */
    systems?: Collection<foundry.packages.System> | undefined;

    /**
     * Ignore the world's own core software compatibility and
     * instead defer entirely to the system's core software
     * compatibility, if the world's availability is less than
     * this.
     */
    systemAvailabilityThreshold?: foundry.CONST.PACKAGE_AVAILABILITY_CODES | undefined;
  }
}

/**
 * The data schema used to define World manifest files.
 * Extends the basic PackageData schema with some additional world-specific fields.
 */
declare class BaseWorld extends BasePackage<BaseWorld.Schema> {
  // TODO(LukeAbby): This override is unsound. Revisit.
  // static defineSchema(): BaseWorld.Schema;

  static type: "world";

  /**
   * The default icon used for this type of Package.
   * @defaultValue `"fa-globe-asia"`
   */
  static icon: string;

  /**
   * @remarks
   * Migrations:
   * - Enforces `compatibility` being an object
   * - `compatibility.maximum === "1.0.0"` to `undefined`
   * - If `coreVersion` but no `compatibility.verified`, sets both `compatibility.verified` and `.minimum` to `coreVersion`
   */
  static migrateData(data: AnyMutableObject): AnyMutableObject;

  static testAvailability(
    data: InexactPartial<PackageManifestData>,
    options: BaseWorld.TestAvailabilityOptions,
  ): foundry.CONST.PACKAGE_AVAILABILITY_CODES;
}

export default BaseWorld;