index.js

'use strict';

const express = require('express');
const router = express.Router();

const options = require('../grove-node-server-utils/options')();
const authProvider = require('../grove-node-server-utils/auth-helper');
const four0four = require('../grove-node-server-utils/404')();
const enableLegacyProxy = true; // TODO: expose this as an env option

if (options.maintenanceMode) {
  router.all('*', four0four.maintenanceMode);
}

router.use('/api', require('./api'));

// This is a legacy proxy to the MarkLogic REST API.
// Best practice is to create endpoints in this middle-tier and to
// avoid directly calling MarkLogic APIs from the UI.
// But sometimes, particularly for demos and PoCs, it is helpful
// to punch through the middle-tier.
//
// A minimum of proxies are setup by default, and we will eventually
// replace those with Grove middle-tier endpoints.
//
// Further down in this file, you will find more examples
// of other proxies that can be setup.

if (enableLegacyProxy) {
  router.use(
    /\/v1|\/LATEST/,
    require('../grove-legacy-routes').whitelistProxyRoute({
      authProvider: authProvider,
      whitelist: [
        {
          endpoint: '/suggest',
          methods: ['get', 'post'],
          authed: true // return 401 if user not authenticated to middle-tier
          // when `authed: false`, will authenticate proxied request if the
          // user is authenticated. If not authenticated, it will still allow
          // a request without authentication.
        },
        // Follow this pattern for other REST extensions
        {
          endpoint: '/resources/extsimilar',
          methods: ['get'],
          authed: true
        },
        // TODO: move this to visjs documentation for visjs-graph
        // Other possibilities:
        // {
        //   endpoint: '/config/query/*',
        //   methods: ['get'],
        //   authed: true
        // },
        {
          endpoint: '/graphs/sparql',
          methods: ['post'],
          authed: true
        }
        // {
        //   endpoint: '/search',
        //   methods: ['get', 'post'],
        //   authed: true
        // },
        // {
        //   endpoint: '/values/*',
        //   methods: ['get', 'post'],
        //   authed: true
        // },
        // {
        //   endpoint: '/documents',
        //   methods: ['get'],
        //   authed: true
        // },
        // {
        //   endpoint: '/documents',
        //   methods: ['all'],
        //   authed: true,
        //   update: true
        // },
        // {
        //   endpoint: '/resources/*', // NOTE: allows get on all extensions
        //   methods: ['get'],
        //   authed: true
        // },
        // {
        //   endpoint: '/resources/*', // NOTE: this is for put, post, delete
        //   // which fall through after the 'get' above
        //   // CAUTION: exposes all REST extensions, even future ones
        //   methods: ['all'],
        //   authed: true,
        //   update: true
        // }
      ]
    })
  );
}

// This sets up this middle-tier to serve static assets found in the
// directory specified by GROVE_UI_BUILD_PATH (if that is set).
//
// If you will never use this middle-tier to serve such assets (for
// example, if you are following the best practice of using a reverse proxy
// like Nginx or HAProxy to serve them instead), you can remove these lines.
if (options.staticUIDirectory) {
  router.use(
    require('../grove-default-routes').defaultStaticRoute({
      staticUIDirectory: options.staticUIDirectory
    })
  );
}

// error handling
router.use(function(error, req, res, next) {
  res.status(500).json({ message: error.toString() });
});

module.exports = router;