feat: Add TypeScript support

.gitignore

@@ -30,3 +30,6 @@ node_modules
 # Emacs
 *~
 .eslintcache
+
+# build folder
+dist

README.md

@@ -54,15 +54,15 @@ The [Parse Server guide](https://docs.parseplatform.org/parse-server/guide/) is
 These scripts can help you to develop your app for Parse Server:
 
 * `npm run watch` will start your Parse Server and restart if you make any changes.
-* `npm run lint` will check the linting of your cloud code, tests and `index.js`, as defined in `.eslintrc.json`.
-* `npm run lint-fix` will attempt fix the linting of your cloud code, tests and `index.js`.
-* `npm run prettier` will help improve the formatting and layout of your cloud code, tests and `index.js`, as defined in `.prettierrc`.
+* `npm run lint` will check the linting of your cloud code, tests and `index.ts`, as defined in `.eslintrc.json`.
+* `npm run lint-fix` will attempt fix the linting of your cloud code, tests and `index.ts`.
+* `npm run prettier` will help improve the formatting and layout of your cloud code, tests and `index.ts`, as defined in `.prettierrc`.
 * `npm test` will run all tests
 * `npm run coverage` will run tests and check coverage. Output is available in the `/coverage` folder.
 
 ## Configuration
 
-Configuration is located in `config.js`.
+Configuration is located in `config.ts`.
 
 
 # Remote Deployment

cloud/functions.js → cloud/functions.ts

@@ -1,14 +1,18 @@
 Parse.Cloud.define('hello', req => {
+  // @ts-ignore
   req.log.info(req);
   return 'Hi';
 });
 
 Parse.Cloud.define('helloAsyncFunction', async req => {
   await new Promise(resolve => setTimeout(resolve, 1000));
+  // @ts-ignore
   req.log.info(req);
   return 'Hi async';
 });
 
 Parse.Cloud.beforeSave('TestObject', () => {
-  throw new Parse.Error(9001, 'Saving test objects is not available.');
+  throw new Parse.Error(Parse.Error.OTHER_CAUSE, 'Saving test objects is not available.');
 });
+
+export {};

cloud/main.js → cloud/main.ts

@@ -1,4 +1,4 @@
 // It is best practise to organize your cloud functions group into their own file. You can then import them in your main.js.
-await Promise.all([
-  import('./functions.js')
-]);
+await Promise.all([import('./functions.js')]);
+
+export {};

cloud/schema.ts

@@ -0,0 +1,17 @@
+export const schemaDefinitions = [
+  {
+    className: 'TestObject',
+    fields: {
+      beforeSave: { type: 'Boolean', defaultValue: false },
+      additionalData: { type: 'String' },
+    },
+    classLevelPermissions: {
+      find: { '*': true },
+      count: { '*': true },
+      get: { '*': true },
+      update: { '*': true },
+      create: { '*': true },
+      delete: { '*': true },
+    },
+  },
+];

config.js → config.ts

@@ -1,7 +1,11 @@
-import { schemaDefinitions } from "./cloud/schema.js";
+import { schemaDefinitions } from './cloud/schema.js';
+
 export const config = {
-  databaseURI: process.env.DATABASE_URI || process.env.MONGODB_URI || 'mongodb://localhost:27017/dev',
-  cloud: process.env.CLOUD_CODE_MAIN || './cloud/main.js',
+  databaseURI:
+    process.env.DATABASE_URI || process.env.MONGODB_URI || 'mongodb://localhost:27017/dev',
+  cloud: async () => {
+    await import('./cloud/main.js');
+  },
   appId: process.env.APP_ID || 'myAppId',
   masterKey: process.env.MASTER_KEY || '', //Add your master key here. Keep it secret!
   serverURL: process.env.SERVER_URL || 'http://localhost:1337/parse', // Don't forget to change to https if needed

eslint.config.js

@@ -1,6 +1,6 @@
 export default [
   {
-    files: ['**/*.js'], // Apply to JavaScript files.
+    files: ['**/*.js', '**/*.ts', '**/*.mjs', '**/*.cjs'], // Apply to JavaScript files.
     languageOptions: {
       ecmaVersion: 2022,
       sourceType: 'module',

nodemon.json

@@ -0,0 +1,9 @@
+{
+  "ignore": [
+    "dist"
+  ],
+  "ext": "json,ts,mjs,cjs,js",
+  "execMap": {
+    "ts": "node -r source-map-support/register --loader=ts-node/esm/transpile-only"
+  }
+}