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

package/README.md

@@ -7,10 +7,6 @@
 TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.com/) (unofficial)
 
 [![League Discord Server](https://img.shields.io/discord/732325252788387980?label=League%20of%20Extraordinary%20Foundry%20VTT%20Developers)](https://discord.gg/52DNPzqm2Z)
-![GitHub V9 issues by-label](https://img.shields.io/github/issues-raw/League-of-Foundry-Developers/foundry-vtt-types/foundry%20V9?color=%23fe631d)
-![GitHub closed V9 issues by-label](https://img.shields.io/github/issues-closed-raw/League-of-Foundry-Developers/foundry-vtt-types/foundry%20V9?color=%23fe631d)
-![GitHub V10 issues by-label](https://img.shields.io/github/issues-raw/League-of-Foundry-Developers/foundry-vtt-types/foundry%20V10?color=%23fe631d)
-![GitHub closed V10 issues by-label](https://img.shields.io/github/issues-closed-raw/League-of-Foundry-Developers/foundry-vtt-types/foundry%20V10?color=%23fe631d)
 [![npm (tag)](https://img.shields.io/npm/v/@league-of-foundry-developers/foundry-vtt-types/latest)](https://www.npmjs.com/package/@league-of-foundry-developers/foundry-vtt-types)
 
 </div>
@@ -19,13 +15,27 @@ TypeScript type definitions for [Foundry Virtual Tabletop](https://foundryvtt.co
 
 We aim to support the latest release of each Foundry VTT version (0.7, 0.8, 9, etc.), starting with 0.7.
 
-At the moment, versions 0.7, 0.8, and 9 are fully supported. Work on support for version 10 is just starting out. See the [open foundry V10 issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V10%22) to keep track of the progress.
+At the moment, versions 0.7, 0.8, and 9 are fully supported with partial support for versions 10 and 11. Work on support for version 12 is currently underway. See the [open foundry V12 issues](https://github.com/League-of-Foundry-Developers/foundry-vtt-types/issues?q=is%3Aopen+is%3Aissue+label%3A%22foundry+V12%22).
+
+## 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.
+
+The recommended way to install for v12 is this command:
+
+```sh
+npm add --include=dev github:League-of-Foundry-Developers/foundry-vtt-types#main
+```
+
+Alternatively, if you're using yarn you'll need to use the command `yarn add --dev foundry-vtt-types@github:League-of-Foundry-Developers/foundry-vtt-types#main`.
+
+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.
 
 ## Installation
 
-You can install foundry-vtt-types from the [npm registry](https://npmjs.org/).
+You can install historical versions of foundry-vtt-types from the [npm registry](https://npmjs.org/).
 
-In order to install the latest version, run
+In order to install the latest stable version (v9), run
 
 ```sh
 npm install --save-dev @league-of-foundry-developers/foundry-vtt-types
@@ -50,16 +60,21 @@ You can then update foundry-vtt-types using the regular update mechanism for npm
 
 The versions of the foundry-vtt-types correspond to the releases of Foundry VTT. The versioning scheme of Foundry VTT
 changed with version 9, so the versioning scheme for the foundry-vtt-types also changes with that version:
-* For Foundry VTT version 0.7 and 0.8, the versioning scheme is
-  ```
+
+- For Foundry VTT version 0.7 and 0.8, the versioning scheme is
+
+  ```text
   0.<foundy-minor-version>.<foundry-patch-version>-<increment>
   ```
-* For Foundry VTT version 9 and onwards, the versioning scheme is
-  ```
+
+- For Foundry VTT version 9 and onwards, the versioning scheme is
+
+  ```text
   <foundry-version>.<foundry-build>.<increment>
   ```
-In both cases, `increment` is a number that increases with every individual release of the foundry-vtt-types for that
-Foundry VTT release.
+
+  In both cases, `increment` is a number that increases with every individual release of the foundry-vtt-types for that
+  Foundry VTT release.
 
 ## Usage
 
@@ -69,16 +84,18 @@ Add foundry-vtt-types to your types section in your `tsconfig.json`:
 {
   "compilerOptions": {
     "types": ["@league-of-foundry-developers/foundry-vtt-types"],
-    "moduleResolution": "node",
-    "strictNullChecks": true,
+    "module": "node16",
+    "moduleResolution": "node16",
+    "esModuleInterop": true,
+    "strictNullChecks": true
   }
 }
 ```
 
 This will make the type definitions available globally in your project.
 
-Make sure you are using `"moduleResolution": "node"`, too. It is required for some dependencies to be resolved
-correctly.
+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
@@ -116,13 +133,13 @@ for the CI.
 
 You can run type checking and linting with the following command:
 
-```
+```shell
 npm run lint
 ```
 
 You can run the tests with
 
-```
+```shell
 npm run test
 ```
 
@@ -131,7 +148,7 @@ npm run test
 To create a release, you have to create a new release commit, tag it and create a GitHub release from that. The CI will
 handle the rest.
 
-```
+```shell
 npm version <release-type>
 git push --follow-tags
 ```

package/index-lenient.d.mts

@@ -0,0 +1,7 @@
+import "./index.d.mts";
+
+declare global {
+  interface AssumeHookRan {
+    ready: never;
+  }
+}

package/index.d.mts

@@ -0,0 +1,5 @@
+import "handlebars";
+import "jquery";
+import "pixi.js";
+import "showdown";
+import "./src/index.d.mts";

package/package.json

@@ -1,24 +1,19 @@
 {
+  "$schema": "https://json.schemastore.org/package.json",
   "name": "@league-of-foundry-developers/foundry-vtt-types",
-  "version": "9.280.1",
+  "version": "12.331.2-beta",
   "description": "TypeScript type definitions for Foundry VTT",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts"
-    },
-    "./lenient": {
-      "types": "./index-lenient.d.ts"
-    }
-  },
-  "types": "./index.d.ts",
+  "type": "module",
+  "types": "./index.d.mts",
   "scripts": {
-    "lint": "./node_modules/typescript/bin/tsc && eslint --ext .d.ts,.test-d.ts .",
-    "lint:fix": "eslint --fix --ext .d.ts,.test-d.ts .",
-    "lint:ci": "eslint --ext .d.ts,.test-d.ts .",
-    "eslint:report": "eslint --output-file eslint_report.json --format json --ext .d.ts,.test-d.ts .",
-    "test": "tsd",
+    "lint": "./node_modules/typescript/bin/tsc; eslint .",
+    "lint:fix": "eslint --fix .",
+    "lint:ci": "eslint .",
+    "eslint:report": "eslint --output-file eslint_report.json --format json .",
+    "test": "vitest --typecheck",
     "typecheck": "./node_modules/typescript/bin/tsc",
-    "prepare": "husky install"
+    "prepare": "is-ci || husky",
+    "postinstall": "patch-package"
   },
   "repository": {
     "type": "git",
@@ -42,6 +37,9 @@
     },
     {
       "name": "BoltsJ"
+    },
+    {
+      "name": "JPMeehan"
     }
   ],
   "license": "MIT",
@@ -53,30 +51,59 @@
     "foundry",
     "foundry-vtt",
     "types",
-    "typscript"
+    "typescript"
   ],
   "dependencies": {
-    "@pixi/graphics-smooth": "0.0.22",
-    "@types/jquery": "~3.5.9",
+    "@pixi/graphics-smooth": "^1.1.0",
+    "@pixi/particle-emitter": "^5.0.8",
+    "@types/jquery": "~3.5.22",
+    "@types/showdown": "~2.0.6",
     "@types/simple-peer": "~9.11.1",
-    "handlebars": "4.7.7",
-    "pixi-particles": "4.3.1",
-    "pixi.js": "5.3.11",
-    "socket.io-client": "4.3.2",
-    "tinymce": "5.10.1"
+    "@types/youtube": "~0.0.48",
+    "handlebars": "^4.7.8",
+    "patch-package": "^8.0.0",
+    "pixi.js": "^7.4.2",
+    "postinstall-postinstall": "^2.1.0",
+    "prosemirror-collab": "^1.3.1",
+    "prosemirror-commands": "^1.5.2",
+    "prosemirror-dropcursor": "^1.8.1",
+    "prosemirror-gapcursor": "^1.3.2",
+    "prosemirror-history": "^1.4.0",
+    "prosemirror-inputrules": "^1.4.0",
+    "prosemirror-keymap": "^1.2.2",
+    "prosemirror-model": "^1.21.0",
+    "prosemirror-schema-list": "^1.3.0",
+    "prosemirror-state": "^1.4.3",
+    "prosemirror-tables": "^1.3.7",
+    "prosemirror-transform": "^1.9.0",
+    "prosemirror-view": "^1.33.6",
+    "socket.io-client": "^4.7.5",
+    "tinymce": "^6.8.3"
   },
   "devDependencies": {
-    "@typescript-eslint/eslint-plugin": "^5.5.0",
-    "@typescript-eslint/parser": "^5.5.0",
-    "eslint": "^8.4.0",
-    "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-tsdoc": "^0.2.14",
-    "husky": "^8.0.0",
-    "lint-staged": "^12.1.2",
-    "prettier": "^2.5.1",
-    "tsd": "^0.20.0",
-    "typescript": "~4.7.2"
+    "@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",
+    "husky": "^9.1.4",
+    "is-ci": "^4.1.0",
+    "lint-staged": "^15.2.10",
+    "prettier": "^3.0.3",
+    "typescript": "~5.7",
+    "vitest": "^2.1.4"
+  },
+  "peerDependencies": {
+    "typescript": "^5.4"
+  },
+  "overrides": {
+    "@types/css-font-loading-module": "^0.0.12s"
+  },
+  "resolutions": {
+    "@types/earcut": "patch:@types/earcut@2.1.4#./patches/@types+earcut+2.1.4.patch"
   },
   "husky": {
     "hooks": {
@@ -84,15 +111,16 @@
     }
   },
   "lint-staged": {
-    "*.(d.ts|test-d.ts)": "eslint --fix",
+    "*.(d.mts|test-d.ts)": "eslint --fix",
     "*.(js|json|yml)": "prettier --write"
   },
   "files": [
-    "index.d.ts",
-    "index-lenient.d.ts",
+    "index.d.mts",
+    "index-lenient.d.mts",
     "src"
   ],
   "publishConfig": {
     "access": "public"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }