parse-dashboard 5.2.0 → 5.3.0-alpha.2

package/Parse-Dashboard/server.js

@@ -27,18 +27,18 @@ module.exports = (options) => {
     process.exit(-1);
   }
 
-  let explicitConfigFileProvided = !!options.config;
+  const explicitConfigFileProvided = !!options.config;
   let configFile = null;
   let configFromCLI = null;
-  let configServerURL = options.serverURL || process.env.PARSE_DASHBOARD_SERVER_URL;
-  let configGraphQLServerURL = options.graphQLServerURL || process.env.PARSE_DASHBOARD_GRAPHQL_SERVER_URL;
-  let configMasterKey = options.masterKey || process.env.PARSE_DASHBOARD_MASTER_KEY;
-  let configAppId = options.appId || process.env.PARSE_DASHBOARD_APP_ID;
-  let configAppName = options.appName || process.env.PARSE_DASHBOARD_APP_NAME;
-  let configUserId = options.userId || process.env.PARSE_DASHBOARD_USER_ID;
-  let configUserPassword = options.userPassword || process.env.PARSE_DASHBOARD_USER_PASSWORD;
-  let configSSLKey = options.sslKey || process.env.PARSE_DASHBOARD_SSL_KEY;
-  let configSSLCert = options.sslCert || process.env.PARSE_DASHBOARD_SSL_CERT;
+  const configServerURL = options.serverURL || process.env.PARSE_DASHBOARD_SERVER_URL;
+  const configGraphQLServerURL = options.graphQLServerURL || process.env.PARSE_DASHBOARD_GRAPHQL_SERVER_URL;
+  const configMasterKey = options.masterKey || process.env.PARSE_DASHBOARD_MASTER_KEY;
+  const configAppId = options.appId || process.env.PARSE_DASHBOARD_APP_ID;
+  const configAppName = options.appName || process.env.PARSE_DASHBOARD_APP_NAME;
+  const configUserId = options.userId || process.env.PARSE_DASHBOARD_USER_ID;
+  const configUserPassword = options.userPassword || process.env.PARSE_DASHBOARD_USER_PASSWORD;
+  const configSSLKey = options.sslKey || process.env.PARSE_DASHBOARD_SSL_KEY;
+  const configSSLCert = options.sslCert || process.env.PARSE_DASHBOARD_SSL_CERT;
 
   function handleSIGs(server) {
     const signals = {
@@ -143,10 +143,10 @@ module.exports = (options) => {
 
   const app = express();
 
-  if (allowInsecureHTTP || trustProxy || dev) app.enable('trust proxy');
+  if (allowInsecureHTTP || trustProxy || dev) {app.enable('trust proxy');}
 
   config.data.trustProxy = trustProxy;
-  let dashboardOptions = { allowInsecureHTTP, cookieSessionSecret, dev, cookieSessionMaxAge };
+  const dashboardOptions = { allowInsecureHTTP, cookieSessionSecret, dev, cookieSessionMaxAge };
   app.use(mountPath, parseDashboard(config.data, dashboardOptions));
   let server;
   if(!configSSLKey || !configSSLCert){
@@ -156,8 +156,8 @@ module.exports = (options) => {
     });
   } else {
     // Start the server using SSL.
-    var privateKey = fs.readFileSync(configSSLKey);
-    var certificate = fs.readFileSync(configSSLCert);
+    const privateKey = fs.readFileSync(configSSLKey);
+    const certificate = fs.readFileSync(configSSLCert);
 
     server = require('https').createServer({
       key: privateKey,

package/README.md

@@ -31,6 +31,7 @@ Parse Dashboard is a standalone dashboard for managing your [Parse Server](https
     - [Parse Server](#parse-server)
     - [Node.js](#nodejs)
   - [Configuring Parse Dashboard](#configuring-parse-dashboard)
+    - [Options](#options)
     - [File](#file)
     - [Environment variables](#environment-variables)
       - [Multiple apps](#multiple-apps)
@@ -42,6 +43,8 @@ Parse Dashboard is a standalone dashboard for managing your [Parse Server](https
   - [Other Configuration Options](#other-configuration-options)
     - [Prevent columns sorting](#prevent-columns-sorting)
     - [Custom order in the filter popup](#custom-order-in-the-filter-popup)
+    - [Persistent Filters](#persistent-filters)
+    - [Scripts](#scripts)
 - [Running as Express Middleware](#running-as-express-middleware)
 - [Deploying Parse Dashboard](#deploying-parse-dashboard)
   - [Preparing for Deployment](#preparing-for-deployment)
@@ -102,14 +105,26 @@ Parse Dashboard is compatible with the following Parse Server versions.
 ### Node.js
 Parse Dashboard is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date.
 
-| Version    | Latest Version | End-of-Life | Compatible   |
-|------------|----------------|-------------|--------------|
-| Node.js 14 | 14.20.1        | April 2023  | ✅ Yes        |
-| Node.js 16 | 16.17.0        | April 2024  | ✅ Yes        |
-| Node.js 18 | 18.9.0         | May 2025    | ✅ Yes        |
+| Version    | Latest Version | End-of-Life | Compatible |
+|------------|----------------|-------------|------------|
+| Node.js 14 | 14.20.1        | April 2023  | ✅ Yes      |
+| Node.js 16 | 16.17.0        | April 2024  | ✅ Yes      |
+| Node.js 18 | 18.9.0         | May 2025    | ✅ Yes      |
 
 ## Configuring Parse Dashboard
 
+### Options
+
+| Parameter                              | Type                | Optional | Default | Example              | Description                                                                                                                                 |
+|----------------------------------------|---------------------|----------|---------|----------------------|---------------------------------------------------------------------------------------------------------------------------------------------|
+| `apps`                                 | Array<Object> | no       | -       | `[{ ... }, { ... }]` | The apps that are configured for the dashboard.                                                                                             |
+| `apps.scripts`                         | Array<Object> | yes      | `[]`    | `[{ ... }, { ... }]` | The scripts that can be executed for that app.                                                                                              |
+| `apps.scripts.title`                   | String              | no       | -       | `'Delete User'`      | The title that will be displayed in the data browser context menu and the script run confirmation dialog.                                   |
+| `apps.scripts.classes`                 | Array<String> | no       | -       | `['_User']`          | The classes of Parse Objects for which the scripts can be executed.                                                                         |
+| `apps.scripts.cloudCodeFunction`       | String              | no       | -       | `'deleteUser'`       | The name of the Parse Cloud Function to execute.                                                                                            |
+| `apps.scripts.showConfirmationDialog`  | Bool                | yes      | `false` | `true`               | Is `true` if a confirmation dialog should be displayed before the script is executed, `false` if the script should be executed immediately. |
+| `apps.scripts.confirmationDialogStyle` | String              | yes      | `info`  | `critical`           | The style of the confirmation dialog. Valid values: `info` (blue style), `critical` (red style).                                            |
+
 ### File
 
 You can also start the dashboard from the command line with a config file.  To do this, create a new file called `parse-dashboard-config.json` inside your local Parse Dashboard directory hierarchy.  The file should match the following format:
@@ -362,6 +377,86 @@ For example:
 
 You can conveniently create a filter definition without having to write it by hand by first saving a filter in the data browser, then exporting the filter definition under *App Settings > Export Class Preferences*.
 
+### Scripts
+
+You can specify scripts to execute Cloud Functions with the `scripts` option:
+
+```json
+"apps": [
+  {
+    "scripts": [
+      {
+        "title": "Delete Account",
+        "classes": ["_User"],
+        "cloudCodeFunction": "deleteAccount",
+        "showConfirmationDialog": true,
+        "confirmationDialogStyle": "critical"
+      }
+    ]
+  }
+]
+```
+
+Next, define the Cloud Function in Parse Server that will be called. The object that has been selected in the data browser will be made available as a request parameter:
+
+```js
+Parse.Cloud.define('deleteAccount', async (req) => {
+  req.params.object.set('deleted', true);
+  await req.params.object.save(null, {useMasterKey: true});
+}, {
+  requireMaster: true
+});
+```
+
+The field which the script was invoked on can be accessed by `selectedField`:
+
+```js
+Parse.Cloud.define('deleteAccount', async (req) => {
+  if (req.params.selectedField !== 'objectId') {
+    throw new Parse.Error(Parse.Error.SCRIPT_FAILED, 'Deleting accounts is only available on the objectId field.');
+  }
+  req.params.object.set('deleted', true);
+  await req.params.object.save(null, {useMasterKey: true});
+}, {
+  requireMaster: true
+});
+```
+
+⚠️ Depending on your Parse Server version you may need to set the Parse Server option `encodeParseObjectInCloudFunction` to `true` so that the selected object in the data browser is made available in the Cloud Function as an instance of `Parse.Object`. If the option is not set, is set to `false`, or you are using an older version of Parse Server, the object is made available as a plain JavaScript object and needs to be converted from a JSON object to a `Parse.Object` instance with `req.params.object = Parse.Object.fromJSON(req.params.object);`, before you can call any `Parse.Object` properties and methods on it.
+
+For older versions of Parse Server:
+
+<details>
+<summary>Parse Server &gt;=4.4.0 &lt;6.2.0</summary>
+
+```js
+Parse.Cloud.define('deleteAccount', async (req) => {
+  req.params.object = Parse.Object.fromJSON(req.params.object);
+  req.params.object.set('deleted', true);
+  await req.params.object.save(null, {useMasterKey: true});
+}, {
+  requireMaster: true
+});
+```
+
+</details>
+
+<details>
+<summary>Parse Server &gt;=2.1.4 &lt;4.4.0</summary>
+
+```js
+Parse.Cloud.define('deleteAccount', async (req) => {
+  if (!req.master || !req.params.object) {
+    throw 'Unauthorized';
+  }
+  req.params.object = Parse.Object.fromJSON(req.params.object);
+  req.params.object.set('deleted', true);
+  await req.params.object.save(null, {useMasterKey: true});
+});
+```
+
+</details>
+
 # Running as Express Middleware
 
 Instead of starting Parse Dashboard with the CLI, you can also run it as an [express](https://github.com/expressjs/express) middleware.
@@ -445,6 +540,24 @@ var dashboard = new ParseDashboard({
 });
 ```
 
+## Security Checks
+
+You can view the security status of your Parse Server by enabling the dashboard option `enableSecurityChecks`, and visiting App Settings > Security.
+
+```javascript
+const dashboard = new ParseDashboard({
+  "apps": [
+    {
+      "serverURL": "http://localhost:1337/parse",
+      "appId": "myAppId",
+      "masterKey": "myMasterKey",
+      "appName": "MyApp"
+      "enableSecurityChecks": true
+    }
+  ],
+});
+```
+
 
 
 ### Configuring Basic Authentication

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "parse-dashboard",
-  "version": "5.2.0",
+  "version": "5.3.0-alpha.2",
   "repository": {
     "type": "git",
     "url": "https://github.com/ParsePlatform/parse-dashboard"
@@ -47,7 +47,7 @@
     "csurf": "1.11.0",
     "express": "4.18.1",
     "graphiql": "2.0.8",
-    "graphql": "16.6.0",
+    "graphql": "16.8.1",
     "immutable": "4.1.0",
     "immutable-devtools": "0.1.5",
     "inquirer": "8.2.4",
@@ -70,7 +70,7 @@
     "react-popper-tooltip": "4.4.2",
     "react-router-dom": "6.4.1",
     "regenerator-runtime": "0.13.11",
-    "semver": "7.3.7",
+    "semver": "7.5.2",
     "typescript": "4.8.3"
   },
   "devDependencies": {
@@ -96,11 +96,13 @@
     "eslint-plugin-jest": "27.0.4",
     "eslint-plugin-react": "7.31.8",
     "http-server": "14.0.0",
+    "husky": "8.0.3",
     "jest": "29.1.2",
     "jest-environment-jsdom": "29.1.2",
     "madge": "5.0.1",
     "marked": "4.0.10",
     "null-loader": "4.0.1",
+    "prettier": "2.8.8",
     "puppeteer": "18.0.5",
     "react-test-renderer": "16.13.1",
     "request": "2.88.2",
@@ -122,7 +124,9 @@
     "pig": "http-server ./PIG -p 4041 -s & webpack --config webpack/PIG.config.js --progress --watch",
     "build": "webpack --node-env=production --config webpack/production.config.js && webpack --config webpack/PIG.config.js",
     "test": "jest",
-    "lint": "eslint . --ignore-path .gitignore --cache",
+    "lint": "eslint --ignore-path .gitignore --cache ./",
+    "lint:fix": "DEBUG=eslint:cli-engine eslint --ignore-path .gitignore --fix --cache ./",
+    "prettier": "prettier --write '{src,webpack}/**/*.js'",
     "generate": "node scripts/generate.js",
     "prepare": "webpack --config webpack/publish.config.js --progress",
     "start": "node ./Parse-Dashboard/index.js",
@@ -152,5 +156,17 @@
       "react-addons-test-utils",
       "fbjs"
     ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "{src,webpack}/{**/*,*}.js": [
+      "prettier --write",
+      "eslint --fix --cache",
+      "git add"
+    ]
   }
 }