feat: Add TypeScript definitions

.github/workflows/ci.yml

@@ -147,6 +147,8 @@ jobs:
       - run: npm ci
       - name: Build types
         run: npm run build:types
+      - name: Test Types
+        run: npm run test:types
   check-mongo:
     strategy:
       matrix:

.npmignore

@@ -0,0 +1,2 @@
+types/tests.ts
+types/eslint.config.mjs

CONTRIBUTING.md

@@ -21,6 +21,7 @@
   - [Good to Know](#good-to-know)
   - [Troubleshooting](#troubleshooting)
   - [Please Do's](#please-dos)
+  - [TypeScript Tests](#typescript-tests)
   - [Test against Postgres](#test-against-postgres)
     - [Postgres with Docker](#postgres-with-docker)
 - [Breaking Changes](#breaking-changes)
@@ -239,6 +240,15 @@ Once you have babel running in watch mode, you can start making changes to parse
 * Mocks belong in the `spec/support` folder.
 * Please consider if any changes to the [docs](http://docs.parseplatform.org) are needed or add additional sections in the case of an enhancement or feature.
 
+#### TypeScript Tests
+
+Type tests are located in [/types/tests.ts](/types/tests.ts) and are responsible for ensuring that the type generation for each class is behaving as expected. Types are generated by manually running the script `npm run build:types`. The generated types are `.d.ts` files located in [/types](/types) and must not be manually changed after generation.
+
+> [!CAUTION]
+> An exemption are type changes to `src/Options/index.js` which must be manually updated in `types/Options/index.d.ts`, as these types are not generated via a script.
+
+When developing type definitions you can run `npm run watch:ts` in order to rebuild your changes automatically upon each save. Use `npm run test:types` in order to run types tests against generated `.d.ts` files.
+
 ### Test against Postgres
 
 If your pull request introduces a change that may affect the storage or retrieval of objects, you may want to make sure it plays nice with Postgres.

eslint.config.js

@@ -3,7 +3,7 @@ const babelParser = require("@babel/eslint-parser");
 const globals = require("globals");
 module.exports = [
   {
-    ignores: ["**/lib/**", "**/coverage/**", "**/out/**"],
+    ignores: ["**/lib/**", "**/coverage/**", "**/out/**", "**/types/**"],
   },
   js.configs.recommended,
   {