feat: Add TypeScript support (#595)

Author: abubkr-hago

.dockerignore

@@ -0,0 +1,38 @@
+# Logs
+logs
+*.log
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
+node_modules
+
+# Emacs
+*~
+.eslintcache
+
+# build folder
+dist
+
+# Docker files
+Docker*

.env.example

@@ -0,0 +1,5 @@
+APP_ID=myAppId
+MASTER_KEY=myMasterKey
+MONGODB_URI=mongodb://localhost:27017/parse
+PORT=1337
+SERVER_URL=http://localhost:1337

.gitignore

@@ -30,3 +30,10 @@ node_modules
 # Emacs
 *~
 .eslintcache
+
+# build folder
+dist
+
+# env files
+.env*
+!.env.example

Dockerfile

@@ -1,26 +1,28 @@
-FROM node:latest
+# Builder stage
+FROM node:20.19.1-alpine AS builder
 
-RUN mkdir parse
+WORKDIR /usr/src/parse
+
+COPY package*.json .
 
-ADD . /parse
-WORKDIR /parse
 RUN npm install
 
-ENV APP_ID setYourAppId
-ENV MASTER_KEY setYourMasterKey
-ENV DATABASE_URI setMongoDBURI
+COPY . .
 
-# Optional (default : 'parse/cloud/main.js')
-# ENV CLOUD_CODE_MAIN cloudCodePath
+RUN npm run build
 
-# Optional (default : '/parse')
-# ENV PARSE_MOUNT mountPath
+# latest supported node version when this Dockerfile was written
+FROM node:20.19.1-alpine
 
-EXPOSE 1337
+WORKDIR /usr/src/parse
 
-# Uncomment if you want to access cloud code outside of your container
-# A main.js file must be present, if not Parse will not start
+# Copy only the required files from the builder stage
+COPY --from=builder /usr/src/parse/node_modules ./node_modules
+COPY --from=builder /usr/src/parse/dist ./
+COPY --from=builder /usr/src/parse/public ./public
 
-# VOLUME /parse/cloud               
+VOLUME ["/usr/src/parse/cloud", "/usr/src/parse/logs"]
+
+EXPOSE 1337
 
-CMD [ "npm", "start" ]
+CMD ["node", "index.js"]

README.md

@@ -23,6 +23,7 @@ The [Parse Server guide](https://docs.parseplatform.org/parse-server/guide/) is
 ---
 
 - [Local Development](#local-development)
+  - [Docker Deployment](#docker-deployment)
   - [Helpful Scripts](#helpful-scripts)
 - [Remote Deployment](#remote-deployment)
   - [Heroku](#heroku)
@@ -50,19 +51,48 @@ The [Parse Server guide](https://docs.parseplatform.org/parse-server/guide/) is
 7. By default the API route will use `/parse` as a base. You can change this by setting the environment variable `PARSE_MOUNT`, for example in the CLI run run `export PARSE_MOUNT=/app` to set the path to `app`.
 8. Your Parse Server is not running and is connected to your local database named `dev` in which the data is stored that you manage via Parse Server.
 
+## Docker Deployment
+
+You can also run Parse Server using Docker:
+
+1. Create a `.env` file with your configuration variables. For example:
+   ```env
+   APP_ID=myAppId
+   MASTER_KEY=myMasterKey
+   DATABASE_URI=mongodb://localhost:27017/parse
+   PORT=1337
+   PARSE_MOUNT=/parse
+   ```
+
+2. Run Docker with the following command, mounting volumes as needed:
+   ```bash
+   docker build -t parse-server .
+   docker run -p 1337:1337 --env-file .env \
+     -v $(pwd)/logs:/usr/src/parse/logs \
+     -v $(pwd)/cloud:/usr/src/parse/cloud \
+     parse-server
+   ```
+
+This allows you to:
+- Use an environment file for configuration
+- Mount the logs directory to persist logs outside the container
+- Mount the cloud directory to access your Cloud Code files from the container
+
+You can customize the mounted volumes based on your needs, such as mounting config files or other directories that require persistence or runtime modifications.
+
 ## Helpful Scripts
 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 renamed to cloud/functions.ts

@@ -1,14 +1,16 @@
 Parse.Cloud.define('hello', req => {
+  // @ts-expect-error req.log exists, but it was not added to types/parse
   req.log.info(req);
   return 'Hi';
 });
 
 Parse.Cloud.define('helloAsyncFunction', async req => {
   await new Promise(resolve => setTimeout(resolve, 1000));
+  // @ts-expect-error req.log exists, but it was not added to types/parse
   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.');
 });

cloud/main.js renamed to cloud/main.ts

@@ -1,4 +1,2 @@
 // 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')]);

cloud/schema.js

@@ -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 },
+    },
+  },
+];

cloud/schema.ts

@@ -1,7 +1,9 @@
-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: () => 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

config.js renamed to config.ts

@@ -0,0 +1,47 @@
+import js from '@eslint/js';
+import tseslint from 'typescript-eslint';
+import globals from 'globals';
+import path from 'node:path';
+
+const __dirname = path.resolve();
+
+export default tseslint.config(
+  js.configs.recommended,
+  ...tseslint.configs.recommended,
+  {
+    files: ['**/*.ts'],
+    languageOptions: {
+      ecmaVersion: 2022,
+      sourceType: 'module',
+      parser: tseslint.parser,
+      parserOptions: {
+        project: ['./tsconfig.json', './spec/tsconfig.json'],
+        tsconfigRootDir: __dirname,
+      },
+      globals: {
+        ...globals.node,
+        Parse: 'readonly',
+      },
+    },
+    rules: {
+      '@typescript-eslint/explicit-function-return-type': 'off',
+      '@typescript-eslint/no-explicit-any': 'warn',
+      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_' }],
+      indent: ['error', 2, { SwitchCase: 1 }],
+      'linebreak-style': ['error', 'unix'],
+      'no-trailing-spaces': 'error',
+      'eol-last': 'error',
+      'space-in-parens': ['error', 'never'],
+      'no-multiple-empty-lines': 'warn',
+      'prefer-const': 'error',
+      'space-infix-ops': 'error',
+      'no-useless-escape': 'off',
+      'require-atomic-updates': 'off',
+      'no-var': 'warn',
+      'no-await-in-loop': 'warn',
+    },
+  },
+  {
+    ignores: ['dist/**/*', 'logs/**/*', 'public/**/*', 'release.config.js'],
+  }
+);

eslint.config.js

@@ -6,6 +6,7 @@ import { ParseServer } from 'parse-server';
 import path from 'path';
 import http from 'http';
 import { config } from './config.js';
+
 const __dirname = path.resolve();
 const app = express();
 

eslint.config.mjs

@@ -0,0 +1,9 @@
+{
+  "ignore": [
+    "dist"
+  ],
+  "ext": "json,ts,mjs,cjs,js",
+  "execMap": {
+    "ts": "tsx"
+  }
+}