Move helperTypes and utils to fvtt-types/utils

.eslintrc.cjs

@@ -37,6 +37,7 @@ module.exports = {
       },
     ],
     "@typescript-eslint/prefer-namespace-keyword": "error",
+
     "import/consistent-type-specifier-style": ["warn", "prefer-top-level"],
     "import/extensions": ["error", "always"],
     "import/first": "warn",
@@ -55,6 +56,7 @@ module.exports = {
     "import/no-unused-modules": "warn",
     "import/no-useless-path-segments": "warn",
     "import/no-webpack-loader-syntax": "error",
+
     "tsdoc/syntax": "warn",
   },
   settings: {

CONTRIBUTING.md

@@ -149,7 +149,7 @@ declare class ActorSheet<Options extends ActorSheet.Options = ActorSheet.Options
 
 #### Type for a class being used as a value (e.g. assigned to a variable)
 
-If the type is not configurable by the user, it should most likely be `ConstructorOf<NameOfTheClass>`. This will also
+If the type is not configurable by the user, it should most likely be `NameOfTheClass.AnyConstructor`. This will also
 allow deriving classes to be used as value. In rare occasions (i.e. when really only instances of this specific class
 may be assigned, no deriving classes), `typeof NameOfTheClass` can be used.
 
@@ -168,7 +168,7 @@ Actor: {
   /**
    * @defaultValue `Actors`
    */
-  collection: ConstructorOf<Actors>;
+  collection: Actors.AnyConstructor;
 }
 ```
 

README.md

@@ -19,7 +19,7 @@ At the moment, versions 0.7, 0.8, and 9 are fully supported with partial support
 
 ## V12 Installation
 
-Currently v12 is still in beta. There are known bugs, issues in the ergonomics, and major unfinished work in the current implementation. To get a direct line of communication about the current status of development as well as to help us understand what areas need to be prioritizated first, join the [League of Extraordinary FoundryVTT Developers Discord](https://discord.gg/73HTMuK7dT) or file an issue.
+Currently v12 is still in beta. There are known bugs, issues in the ergonomics, and major unfinished work in the current implementation. To get a direct line of communication about the current status of development as well as to help us understand what areas need to be prioritized first, join the [League of Extraordinary FoundryVTT Developers Discord](https://discord.gg/73HTMuK7dT) or file an issue.
 
 The recommended way to install for v12 is this command:
 
@@ -31,6 +31,8 @@ Alternatively, if you're using yarn you'll need to use the command `yarn add --d
 
 This will add the current commit on `main` as a dependency. Both npm and yarn's lockfile will store the commit you initially installed this command and so updates to your dependency will not happen automatically or even after a fresh install. To update you will need to be rerun the prior command periodically to update as improvements are added frequently.
 
+If you've been using the types for a few months now, the best branch would be `maintenance` instead. `main` will have a number of backwards incompatible breaking changes going forward.
+
 ## Installation
 
 You can install historical versions of foundry-vtt-types from the [npm registry](https://npmjs.org/).
@@ -84,22 +86,16 @@ Add foundry-vtt-types to your types section in your `tsconfig.json`:
 {
   "compilerOptions": {
     "types": ["@league-of-foundry-developers/foundry-vtt-types"],
-    "module": "node16",
-    "moduleResolution": "node16",
-    "esModuleInterop": true,
-    "strictNullChecks": true
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "strict": true
   }
 }
 ```
 
 This will make the type definitions available globally in your project.
 
-Make sure you are using at least `"module": "node16"` and `"moduleResolution": "node16"`, too. It is required for some
-imports to be resolved correctly, such as `@league-of-foundry-developers/foundry-vtt-types/src/types/utils.mts`.
-
-Also make sure to set `"strictNullChecks": true` because otherwise, some conditional types used in the type definitions
-resolve incorrectly, and you will see a lot of errors. Alternatively, you can just set `"strict": true`, which
-implicitly sets `strictNullChecks`. This is actually what we **recommend**, but it's not required.
+We recommend using `"strict": true` because it enables a whole host of useful options. However if you want to check that your config supports foundry-vtt-types, the most important settings under `strict` would be `strictNullChecks` and `strictFunctionTypes` are the most important.
 
 You can find some information about how to actually work with the type definitions in the
 [Wiki](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/wiki). A good starting point is

package.json

@@ -7,7 +7,7 @@
   "types": "./index.d.mts",
   "scripts": {
     "lint": "./node_modules/typescript/bin/tsc; eslint .; prettier -c .",
-    "lint:fix": "eslint --fix .; prettier -w .",
+    "lint:fix": "eslint --fix .; prettier -l -w .",
     "lint:ci": "eslint .; prettier -c .",
     "eslint:report": "eslint --output-file eslint_report.json --format json .",
     "test": "vitest --typecheck",
@@ -20,6 +20,9 @@
     "url": "https://github.com/League-of-Foundry-Developers/foundry-vtt-types"
   },
   "contributors": [
+    {
+      "name": "LukeAbby"
+    },
     {
       "name": "Kai Moschcau"
     },
@@ -81,14 +84,14 @@
     "tinymce": "^6.8.3"
   },
   "devDependencies": {
-    "@fvtt-types/fvtt-types": "file:.",
     "@typescript-eslint/eslint-plugin": "^8.12.2",
     "@typescript-eslint/parser": "^8.12.2",
     "eslint": "^8.57.1",
     "eslint-config-prettier": "^9.1.0",
     "eslint-import-resolver-typescript": "^3.6.1",
     "eslint-plugin-import": "^2.29.1",
     "eslint-plugin-tsdoc": "^0.4.0",
+    "fvtt-types": "file:.",
     "husky": "^9.1.4",
     "is-ci": "^4.1.0",
     "lint-staged": "^15.2.10",

src/foundry/client-esm/applications/api/application.d.mts

@@ -1,5 +1,4 @@
-import type { MustConform } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, DeepPartial, EmptyObject, InexactPartial, MaybePromise } from "../../../../types/utils.d.mts";
+import type { MustConform, AnyObject, DeepPartial, EmptyObject, InexactPartial, MaybePromise } from "../../../../utils/index.d.mts";
 import type EventEmitterMixin from "../../../common/utils/event-emitter.d.mts";
 
 // TODO: Investigate use of DeepPartial vs Partial vs InexactPartial
@@ -15,6 +14,7 @@ type _InstanceMustBeAssignableToInternal = MustConform<ApplicationV2, Applicatio
 
 declare namespace ApplicationV2 {
   type Any = ApplicationV2<any, any, any>;
+  type AnyConstructor = typeof AnyApplicationV2;
 
   // Documented at https://gist.github.com/LukeAbby/c7420b053d881db4a4d4496b95995c98
   namespace Internal {
@@ -703,4 +703,8 @@ declare class ApplicationV2<
   bringToTop(): void;
 }
 
+declare abstract class AnyApplicationV2 extends ApplicationV2<any, any, any> {
+  constructor(arg0: never, ...args: never[]);
+}
+
 export default ApplicationV2;

src/foundry/client-esm/applications/api/dialog.d.mts

@@ -1,4 +1,4 @@
-import type { AnyFunction, DeepPartial, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyFunction, DeepPartial, EmptyObject } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "./application.d.mts";
 
 /**

src/foundry/client-esm/applications/api/document-sheet.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, DeepPartial, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyObject, DeepPartial, EmptyObject } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "./application.d.mts";
 
 declare namespace DocumentSheetV2 {

src/foundry/client-esm/applications/api/handlebars-application.d.mts

@@ -1,4 +1,4 @@
-import type { DeepPartial, Mixin } from "../../../../types/utils.d.mts";
+import type { DeepPartial, Mixin } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "./application.d.mts";
 
 declare namespace HandlebarsApplication {

src/foundry/client-esm/applications/apps/compendium-art-config.d.mts

@@ -1,5 +1,4 @@
-import type { ConformRecord, InterfaceToObject, MustConform } from "../../../../types/helperTypes.d.mts";
-import type { DeepPartial } from "../../../../types/utils.d.mts";
+import type { ConformRecord, InterfaceToObject, MustConform, DeepPartial } from "../../../../utils/index.d.mts";
 import type { CompendiumArtDescriptor } from "../../helpers/_types.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";

src/foundry/client-esm/applications/apps/permission-config.d.mts

@@ -1,5 +1,4 @@
-import type { ConformRecord, InterfaceToObject, MustConform } from "../../../../types/helperTypes.d.mts";
-import type { DeepPartial } from "../../../../types/utils.d.mts";
+import type { ConformRecord, InterfaceToObject, MustConform, DeepPartial } from "../../../../utils/index.d.mts";
 import type { UserPermission } from "../../../common/constants.d.mts";
 import type { CONST } from "../../client.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";

src/foundry/client-esm/applications/dice/roll-resolver.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, DeepPartial, EmptyObject, InexactPartial } from "../../../../types/utils.d.mts";
+import type { AnyObject, DeepPartial, EmptyObject, InexactPartial } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
 

src/foundry/client-esm/applications/forms/fields.d.mts

@@ -1,4 +1,4 @@
-import type { NullishProps } from "../../../../types/utils.d.mts";
+import type { NullishProps } from "../../../../utils/index.d.mts";
 
 export type CustomFormGroup = (
   field: foundry.data.fields.DataField,

src/foundry/client-esm/applications/sheets/actor-sheet.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyObject, EmptyObject } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 

src/foundry/client-esm/applications/sheets/ambient-light-config.d.mts

@@ -1,5 +1,4 @@
-import type { InterfaceToObject } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, DeepPartial } from "../../../../types/utils.d.mts";
+import type { InterfaceToObject, AnyObject, DeepPartial } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";

src/foundry/client-esm/applications/sheets/ambient-sound-config.d.mts

@@ -1,5 +1,4 @@
-import type { InterfaceToObject } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, DeepPartial } from "../../../../types/utils.d.mts";
+import type { InterfaceToObject, AnyObject, DeepPartial } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";

src/foundry/client-esm/applications/sheets/item-sheet.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyObject, EmptyObject } from "../../../../utils/index.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 
 /**

src/foundry/client-esm/applications/sheets/region-behavior-config.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyObject, EmptyObject } from "../../../../utils/index.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
 

src/foundry/client-esm/applications/sheets/region-config.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyObject, EmptyObject } from "../../../../utils/index.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
 

src/foundry/client-esm/applications/sheets/user-config.d.mts

@@ -1,5 +1,4 @@
-import type { InterfaceToObject } from "../../../../types/helperTypes.d.mts";
-import type { AnyObject, DeepPartial } from "../../../../types/utils.d.mts";
+import type { InterfaceToObject, AnyObject, DeepPartial } from "../../../../utils/index.d.mts";
 import type DocumentSheetV2 from "../api/document-sheet.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
 import type { CustomFormGroup } from "../forms/fields.d.mts";

src/foundry/client-esm/applications/ui/region-legend.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, EmptyObject } from "../../../../types/utils.d.mts";
+import type { AnyObject, EmptyObject } from "../../../../utils/index.d.mts";
 import type ApplicationV2 from "../api/application.d.mts";
 import type HandlebarsApplicationMixin from "../api/handlebars-application.d.mts";
 

src/foundry/client-esm/audio/biquad.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../utils/index.d.mts";
 
 /**
  * A sound effect which applies a biquad filter.

src/foundry/client-esm/audio/convolver.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../utils/index.d.mts";
 
 declare namespace ConvolverEffect {}
 

src/foundry/client-esm/audio/helper.d.mts

@@ -1,6 +1,6 @@
 import type Sound from "./sound.d.mts";
 import type AudioBufferCache from "./cache.d.mts";
-import type { InexactPartial } from "../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../utils/index.d.mts";
 
 /**
  * A helper class to provide common functionality for working with the Web Audio API.

src/foundry/client-esm/audio/sound.d.mts

@@ -1,4 +1,4 @@
-import type { AnyObject, InexactPartial, ValueOf } from "../../../types/utils.d.mts";
+import type { AnyObject, InexactPartial, ValueOf } from "../../../utils/index.d.mts";
 import type EventEmitterMixin from "../../common/utils/event-emitter.d.mts";
 
 declare namespace Sound {

src/foundry/client-esm/canvas/edges/edge.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../../utils/index.d.mts";
 import type { WallThresholdData } from "../../../common/documents/_types.d.mts";
 
 /**

src/foundry/client-esm/canvas/smaa/smaa.d.mts

@@ -1,6 +1,6 @@
 import type { CLEAR_MODES, FilterState, FilterSystem, RenderTexture } from "pixi.js";
 
-import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../../utils/index.d.mts";
 
 declare class SMAAFilter extends PIXI.Filter {
   /**

src/foundry/client-esm/canvas/sources/base-effect-source.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../../utils/index.d.mts";
 
 /**
  * TODO - Re-document after ESM refactor.

src/foundry/client-esm/canvas/sources/base-light-source.d.mts

@@ -1,4 +1,4 @@
-import type { InexactPartial } from "../../../../types/utils.d.mts";
+import type { InexactPartial } from "../../../../utils/index.d.mts";
 import type RenderedEffectSource from "./rendered-effect-source.d.mts";
 
 /**

src/foundry/client-esm/canvas/sources/point-effect-source.d.mts

@@ -1,4 +1,4 @@
-import type { Mixin } from "../../../../types/utils.d.mts";
+import type { Mixin } from "../../../../utils/index.d.mts";
 import type BaseEffectSource from "./base-effect-source.d.mts";
 
 declare class PointEffectSource {

src/foundry/client-esm/canvas/sources/rendered-effect-source.d.mts

@@ -1,4 +1,4 @@
-import type { AnyFunction, InexactPartial } from "../../../../types/utils.d.mts";
+import type { AnyFunction, InexactPartial } from "../../../../utils/index.d.mts";
 import type BaseEffectSource from "./base-effect-source.d.mts";
 
 // TODO: Remove after shaders are done

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

@@ -21,7 +21,7 @@ import * as _canvas from "./canvas/_module.mjs";
 import * as _helpers from "./helpers/_module.mjs";
 import * as _data from "./data/_module.mjs";
 import * as _dice from "./dice/_module.mjs";
-import type { AnyObject } from "../../types/utils.d.mts";
+import type { AnyObject } from "../../utils/index.d.mts";
 
 /**
  * Constant definitions used throughout the Foundry Virtual Tabletop framework.