@league-of-foundry-developers/foundry-vtt-types 12.331.4-beta → 13.340.1

package/src/foundry/client-esm/documents/_module.d.mts

@@ -0,0 +1,11 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export * from "#common/documents/_module.mjs";
+export * as types from "./_types.mjs";
+
+// Abstract Classes
+export * as abstract from "./abstract/_module.mjs";
+export * as collections from "./collections/_module.mjs";

package/src/foundry/client-esm/documents/_types.d.mts

@@ -0,0 +1,8 @@
+export {};
+
+// After seeing that none of these types add anything or are even exported a
+// very reasonable question may be: Why on earth does this file exist?
+//
+// Well this is the file in which Foundry defines these types. We don't house
+// them here because it has poor discoverability. It's also just nice to
+// have as reference to keep us synced with the latest version of Foundry.

package/src/foundry/client-esm/documents/abstract/_module.d.mts

@@ -0,0 +1,6 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+// /* eslint-disable import-x/extensions */
+
+export {};

package/src/foundry/client-esm/documents/collections/_module.d.mts

@@ -0,0 +1,6 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+// /* eslint-disable import-x/extensions */
+
+export {};

package/src/foundry/client-esm/game.d.mts

@@ -0,0 +1,7 @@
+// TODO: Move Game class in here
+
+declare class Game {}
+
+declare namespace Game {}
+
+export default Game;

package/src/foundry/client-esm/helpers/compendium-art.d.mts

@@ -1,4 +1,4 @@
-import type { SchemaField } from "../../common/data/fields.d.mts";
+import type { SchemaField } from "#common/data/fields.d.mts";
 import type { PrototypeToken } from "../data/_module.d.mts";
 
 /**
@@ -55,6 +55,7 @@ declare namespace CompendiumArt {
     /**
      * The path to the token image, or an object to merge into the Actor's prototype token.
      */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     token?: string | SchemaField.AssignmentData<PrototypeToken.Schema> | undefined;
 
     /**

package/src/foundry/client-esm/hooks.d.mts

@@ -0,0 +1 @@
+// TODO: Move hook type defs in here

package/src/foundry/client-esm/nue/_module.d.mts

@@ -0,0 +1,9 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export * as tours from "./tours/_module.mjs";
+export { default as Tour } from "./tour.mjs";
+export { default as NewUserExperienceManager } from "./nue-manager.mjs";
+export { default as ToursCollection } from "./tours-collection.mjs";

package/src/foundry/client-esm/nue/nue-manager.d.mts

@@ -0,0 +1,18 @@
+/**
+ * Responsible for managing the New User Experience workflows.
+ */
+declare class NewUserExperienceManager {
+  constructor();
+
+  /**
+   * Initialize the new user experience.
+   * Currently, this generates some chat messages with hints for getting started if we detect this is a new world.
+   */
+  initialize(): void;
+
+  #private: true;
+}
+
+declare namespace NewUserExperienceManager {}
+
+export default NewUserExperienceManager;

package/src/foundry/client-esm/nue/tour.d.mts

@@ -0,0 +1,9 @@
+/**
+ * A Tour that shows a series of guided steps.
+ * @remarks TODO: Stub
+ */
+declare class Tour {}
+
+declare namespace Tour {}
+
+export default Tour;

package/src/foundry/client-esm/nue/tours/_module.d.mts

@@ -0,0 +1,8 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export { default as CanvasTour } from "./canvas-tour.mjs";
+export { default as SetupTour } from "./setup-tour.mjs";
+export { default as SidebarTour } from "./sidebar-tour.mjs";

package/src/foundry/client-esm/nue/tours/canvas-tour.d.mts

@@ -0,0 +1,12 @@
+import type Tour from "../tour.mjs";
+
+/**
+ * A tour for demonstrating an aspect of Canvas functionality.
+ * Automatically activates a certain canvas layer or tool depending on the needs of the step.
+ * @remarks TODO: Stub
+ */
+declare class CanvasTour extends Tour {}
+
+declare namespace CanvasTour {}
+
+export default CanvasTour;

package/src/foundry/client-esm/nue/tours/setup-tour.d.mts

@@ -0,0 +1,11 @@
+import type Tour from "../tour.mjs";
+
+/**
+ * A Tour subclass that handles controlling the UI state of the Setup screen
+ * @remarks TODO: Stub
+ */
+declare class SetupTour extends Tour {}
+
+declare namespace SetupTour {}
+
+export default SetupTour;

package/src/foundry/client-esm/nue/tours/sidebar-tour.d.mts

@@ -0,0 +1,11 @@
+import type Tour from "../tour.mjs";
+
+/**
+ * A Tour subclass for the Sidebar Tour
+ * @remarks TODO: Stub
+ */
+declare class SidebarTour extends Tour {}
+
+declare namespace SidebarTour {}
+
+export default SidebarTour;

package/src/foundry/client-esm/nue/tours-collection.d.mts

@@ -0,0 +1,25 @@
+import type Tour from "./tour.d.mts";
+
+/**
+ * A singleton Tour Collection class responsible for registering and activating Tours, accessible as game.tours.
+ */
+declare class ToursCollection extends Collection<Tour> {
+  constructor();
+
+  /**
+   * Register a new Tour.
+   * @param namespace - The namespace of the Tour
+   * @param id        - The machine-readable id of the Tour
+   * @param tour      - The constructed Tour
+   */
+  register(namespace: string, id: string, tour: Tour): void;
+
+  /**
+   * Set a Tour to the collection.
+   */
+  set(key: string, tour: Tour): this;
+}
+
+declare namespace ToursCollection {}
+
+export default ToursCollection;

package/src/foundry/client-esm/packages/_module.d.mts

@@ -0,0 +1,22 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+import Module from "./module.mjs";
+import System from "./system.mjs";
+import World from "./world.mjs";
+
+export * as types from "./_types.mjs";
+// export * from "#common/packages/_module.mjs";
+export { default as ClientPackageMixin } from "./client-package.mjs";
+export { Module, System, World };
+
+/**
+ * A mapping of allowed package types and the classes which implement them.
+ */
+export const PACKAGE_TYPES: {
+  world: typeof World;
+  system: typeof System;
+  module: typeof Module;
+};

package/src/foundry/client-esm/packages/_types.d.mts

@@ -0,0 +1,13 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+// After seeing that none of these types add anything or are even exported a
+// very reasonable question may be: Why on earth does this file exist?
+//
+// Well this is the file in which Foundry defines these types. We don't house
+// them here because it has poor discoverability. The names Foundry has chosen
+// also overlaps with other existing names, such as SettingConfig vs. ClientSetting.SettingConfig
+
+// TODO: Stubs
+export {};
+
+type PackageCompatibilityBadge = unknown;

package/src/foundry/client-esm/packages/client-package.d.mts

@@ -0,0 +1,11 @@
+/**
+ * A client-side mixin used for all Package types.
+ * @param BasePackage - The parent BasePackage class being mixed
+ * @returns A BasePackage subclass mixed with ClientPackage features
+ * @remarks TODO: Stub
+ */
+declare function ClientPackageMixin(): void;
+
+declare namespace ClientPackageMixin {}
+
+export default ClientPackageMixin;

package/src/foundry/client-esm/packages/module.d.mts

@@ -0,0 +1,8 @@
+/**
+ * @remarks TODO: Stub
+ */
+declare class Module {}
+
+declare namespace Module {}
+
+export default Module;

package/src/foundry/client-esm/packages/system.d.mts

@@ -0,0 +1,8 @@
+/**
+ * @remarks TODO: Stub
+ */
+declare class System {}
+
+declare namespace System {}
+
+export default System;

package/src/foundry/client-esm/packages/world.d.mts

@@ -0,0 +1,8 @@
+/**
+ * @remarks TODO: Stub
+ */
+declare class World {}
+
+declare namespace World {}
+
+export default World;

package/src/foundry/client-esm/ui.d.mts

@@ -0,0 +1 @@
+// TODO: This is a set of global UI properties accessible even before `init` as undefined or null

package/src/foundry/client-esm/utils/_module.d.mts

@@ -0,0 +1,7 @@
+// In Foundry itself this file contains re-exports of these other modules.
+// Therefore it has a runtime effect and uses `.mjs` instead of `.d.mts`.
+// While `.mts` could work, to avoid `import-x/no-unresolved` from erroring `.mjs` is used.
+/* eslint-disable import-x/extensions */
+
+export * from "#common/utils/_module.mjs";
+export * from "./helpers.mjs";

package/src/foundry/client-esm/utils/_types.d.mts

@@ -0,0 +1,3 @@
+// Only exists to re-export these types
+// eslint-disable-next-line import-x/export, import-x/extensions
+export * from "#common/utils/_types.mjs";

package/src/foundry/client-esm/utils/helpers.d.mts

@@ -0,0 +1,6 @@
+/**
+ * Clean a provided HTML fragment, closing unbalanced tags and stripping some undesirable properties
+ * @param raw - A raw HTML string
+ * @returns The cleaned HTML content
+ */
+export function cleanHTML(raw: string): string;

package/src/foundry/common/{types.d.mts → _types.d.mts}

@@ -1,5 +1,5 @@
 import type { AnyConcreteConstructor, AnyConstructor, AnyFunction } from "fvtt-types/utils";
-import type { Document } from "./abstract/module.d.mts";
+import type { Document } from "./abstract/_module.d.mts";
 
 // After seeing that none of these types add anything or are even exported a
 // very reasonable question may be: Why on earth does this file exist?

package/src/foundry/common/abstract/data.d.mts

@@ -1,6 +1,6 @@
 import type { AnyMutableObject, AnyObject, EmptyObject, Identity } from "fvtt-types/utils";
 import type { DataField, SchemaField } from "../data/fields.d.mts";
-import type { fields } from "../data/module.d.mts";
+import type { fields } from "../data/_module.d.mts";
 import type { DataModelValidationFailure } from "../data/validation-failure.d.mts";
 
 type DataSchema = foundry.data.fields.DataSchema;
@@ -36,6 +36,7 @@ declare abstract class DataModel<
   " __fvtt_types_internal_source_data": SchemaField.SourceData<Schema>;
 
   /** @internal */
+  // eslint-disable-next-line @typescript-eslint/no-deprecated
   " __fvtt_types_internal_assignment_data": SchemaField.AssignmentData<Schema>;
 
   /** @internal */
@@ -144,7 +145,7 @@ declare abstract class DataModel<
    * @param context - Context options passed to the data model constructor
    * @returns The cloned Document instance
    */
-  clone(data?: fields.SchemaField.AssignmentData<Schema>, context?: DataModel.DataValidationOptions<Parent>): this;
+  clone(data?: fields.SchemaField.CreateData<Schema>, context?: DataModel.DataValidationOptions<Parent>): this;
 
   /**
    * Validate the data contained in the document to check for type and content
@@ -279,7 +280,7 @@ declare abstract class DataModel<
 }
 
 declare namespace DataModel {
-  type CreateData<Schema extends DataSchema> = fields.SchemaField.AssignmentData<Schema> | DataModel<Schema, any>;
+  type CreateData<Schema extends DataSchema> = fields.SchemaField.CreateData<Schema> | DataModel<Schema, any>;
 
   type ConstructorDataFor<ConcreteDataModel extends DataModel.Any> = CreateData<SchemaOf<ConcreteDataModel>>;
 
@@ -387,6 +388,7 @@ declare namespace DataModel {
     /**
      * A specific set of proposed changes to validate, rather than the full source data of the model.
      */
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     changes?: fields.SchemaField.AssignmentData<Schema>;
 
     /**

package/src/foundry/common/abstract/document.d.mts

@@ -33,7 +33,7 @@ import type {
   SchemaField,
   TypeDataField,
 } from "../data/fields.d.mts";
-import type { fields } from "../data/module.mts";
+import type { fields } from "../data/_module.d.mts";
 import type { LogCompatibilityWarningOptions } from "../utils/logging.mts";
 import type {
   DatabaseAction,

package/src/foundry/common/data/_types.d.mts

@@ -0,0 +1,49 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+// After seeing that none of these types add anything or are even exported a
+// very reasonable question may be: Why on earth does this file exist?
+//
+// Well this is the file in which Foundry defines these types. We don't house
+// them here because it has poor discoverability. The names Foundry has chosen
+// also overlaps with other existing names, such as SettingConfig vs. ClientSetting.SettingConfig
+
+// TODO: Stubs
+export {};
+
+type DataFieldValidator = unknown;
+
+type DataFieldOptions = unknown;
+
+type DataFieldContext = unknown;
+
+type FormGroupConfig = unknown;
+
+type FormInputConfig = unknown;
+
+type StringFieldInputConfig = unknown;
+
+type CodeMirrorLanguage = unknown;
+
+type CodeMirrorInputConfig = unknown;
+
+type LightAnimationData = unknown;
+
+type NumberFieldOptions = unknown;
+
+type StringFieldOptions = unknown;
+
+type ChoiceInputConfig = unknown;
+
+type ArrayFieldOptions = unknown;
+
+type DocumentUUIDFieldOptions = unknown;
+
+type FilePathFieldOptions = unknown;
+
+type DocumentFlags = unknown;
+
+type DocumentStats = unknown;
+
+type JavaScriptFieldOptions = unknown;
+
+type ElementValidationFailure = unknown;

package/src/foundry/common/data/data.d.mts

@@ -8,6 +8,7 @@ import type {
   ToMethod,
   ValueOf,
 } from "fvtt-types/utils";
+
 import fields = foundry.data.fields;
 import documents = foundry.documents;
 
@@ -454,6 +455,7 @@ declare namespace TextureData {
 
   /** @remarks The keys picked directly are passed on to the `src: FilePathField` field, but `initial` is an object of initial values for potentially every field in the schema */
   interface SrcOptions extends Pick<fields.FilePathField.Options, "categories" | "wildcard" | "label"> {
+    // eslint-disable-next-line @typescript-eslint/no-deprecated
     initial: _SrcOptionsInitial<fields.SchemaField.AssignmentData<Schema<DefaultOptions>>>;
   }