expressa 2.0.23 → 2.1.0

package/index.js

@@ -1,297 +1,314 @@
-const fs = require('fs')
-const express = require('express')
-const bodyParser = require('body-parser')
-const debug = require('debug')('expressa')
-const randomstring = require('randomstring')
-
-const dbTypeNames = ['cached', 'file', 'memory', 'postgres', 'mongo']
-const dbTypes = dbTypeNames.reduce((obj, name) => {
-  obj[name] = require('./db/' + name)
-  return obj
-}, {})
-dbTypes['mongodb'] = dbTypes['mongo'] // alias
-const auth = require('./auth')
-const util = require('./util')
-
-const collectionsApi = require('./controllers/collections')
-const usersApi = require('./controllers/users')
-const installApi = require('./controllers/install')
-const statusApi = require('./controllers/status')
-const permissions = require('./middleware/permissions')
-const loggingMiddleware = require('./middleware/logging')
-
-process.env.NODE_ENV = process.env.NODE_ENV || 'development'
-
-async function bootstrapCollections (router) {
-  const collections = await router.db.collection.all()
-  await Promise.all(collections.map((collection) => {
-    if (!dbTypes[collection.storage]) {
-      console.error('missing ' + collection.storage + ' dbtype which is used by ' + collection._id)
-      console.error('try updating to the latest version of expressa')
-    }
-    return router.setupCollectionDb(collection)
-  }))
-}
-
-async function initCollections (db, router) {
-  debug('init collections')
-  try {
-    const data = await db.settings.get(process.env.NODE_ENV)
-    Object.assign(router.settings, data)
-  } catch (err) {
-    const filePath = router.settings.file_storage_path || 'data'
-    if (!fs.existsSync(filePath + '/settings/' + process.env.NODE_ENV + '.json')) {
-      console.error('Settings not found. Please visit the expressa admin page for the installation process.')
-      console.error('This is likely at http://localhost:3000/admin but may be different if you changed ports, etc.')
-    } else {
-      console.error('error reading settings')
-      console.error(err.stack)
-    }
-  }
-  console.log('Starting expressa server using environment: ' + process.env.NODE_ENV) // eslint-disable-line no-console
-  db.collection = dbTypes[router.settings.collection_db_type || 'file'](router.settings, 'collection')
-  await bootstrapCollections(router)
-  debug('collections loaded.')
-
-  await Promise.all([
-    require('./listeners_collection_permissions')(router),
-    require('./listeners')(router),
-    require('./listeners_validation')(router),
-    require('./listeners_users')(router),
-  ])
-  debug('added standard listeners')
-}
-
-function ph (requestHandler) {
-  return async function wrapper (req, res, next) {
-    const collectionName = req.params.collection
-    let collection = {}
-    try {
-      collection = collectionName ? await req.db.collection.get(collectionName) : {}
-    } catch (e) {
-      if (!e.message.includes('document not found')) {
-        console.error(e)
-      }
-    }
-    if (!collection.allowHTTPCaching) {
-      res.header('Cache-Control', 'no-cache, no-store, must-revalidate')
-      res.header('Expires', '-1')
-      res.header('Pragma', 'no-cache')
-    }
-    try {
-      const result = await requestHandler(req, res, next)
-      if (typeof result !== 'object') {
-        res.status(500).send('invalid result')
-      }
-      debug(`${200} ${req.method} ${req.url} body: ${JSON.stringify(req.body)} result: ${JSON.stringify(result)}`)
-      res.send(result)
-    } catch (err) {
-      err.status = err.status || 500
-      debug(`${err.status} ${req.method} ${req.url} ${err.stack} ${req.uerror}`)
-      if ((req.settings.print_400_errors) || err.status >= 500) {
-        console.error(err + ' | ' + req.uerror)
-      }
-      req.returnedError = err
-      res.status(err.status).send({
-        error: err.result || err.message || err,
-        tokenError: req.uerror ?  (req.uerror === 'jwt expired' ? 'expired token' : 'jwt error') : undefined
-      })
-    }
-  }
-}
-
-module.exports.api = function (settings) {
-  const router = express.Router()
-  router.initialized = false
-  router.custom = express.Router()
-  router.dbTypes = dbTypes
-  router.settings = settings || {}
-  router.db = {
-    settings: dbTypes[router.settings.settings_db_type || 'file'](router.settings, 'settings')
-  }
-  router.util = {
-    get pgpool() {
-      return util.getPgPool(router.settings.postgresql_uri)
-    },
-    ...util,
-  }
-  router.eventListeners = {}
-
-  router.setupCollectionDb = async function(collection) {
-    debug(`init collection db ${collection._id} ${collection.storage}`)
-    router.db[collection._id] = dbTypes[collection.storage](router.settings, collection._id, collection)
-    if (collection.cacheInMemory) {
-      router.db[collection._id] = dbTypes['cached'](router.db[collection._id])
-      debug('initializing ' + collection._id + ' as a memory cached collection')
-    }
-    return Promise.resolve(router.db[collection._id].init())
-  }
-
-  router.addSingleCollectionListener = function (event, listener) {
-    if (!router.eventListeners[event]) {
-      router.eventListeners[event] = []
-    }
-    router.eventListeners[event].push(listener)
-    router.eventListeners[event].sort((a, b) => a.priority - b.priority)
-    if (event === 'ready' && router.initialized) {
-      listener(router)
-    }
-  }
-
-  router.addCollectionListenerWithPriority = function (events, collections, priority, listener) {
-    listener.priority = priority
-    router.addCollectionListener(events, collections, listener)
-  }
-
-  router.addLateCollectionListener = function (events, collections, listener) {
-    listener.priority = 10
-    router.addCollectionListener(events, collections, listener)
-  }
-
-  router.addCollectionListener = function (events, collections, listener) {
-    events = util.castArray(events)
-    collections = util.castArray(collections)
-    listener.priority = listener.priority || 0
-    listener.collections = collections
-    if (!listener.name) {
-      throw new Error('Listeners must be named')
-    }
-    events.forEach(function (event) {
-      router.addSingleCollectionListener(event, listener)
-    })
-  }
-
-  router.addListener = function addListener (events, priority, listener) {
-    events = util.castArray(events)
-    if (typeof priority === 'function') {
-      listener = priority
-      priority = 0
-    }
-    if (!listener.name) {
-      throw new Error('Listeners must be named')
-    }
-    listener.priority = priority
-    events.forEach(function (event) {
-      router.addSingleCollectionListener(event, listener)
-    })
-  }
-
-  router.getSetting = function (name) {
-    return util.getPath(router.settings, name)
-  };
-
-  (async function setup() {
-    await initCollections(router.db, router)
-
-    const modules = ['collections', 'core', 'logging', 'permissions', 'access_keys']
-    router.modules = {}
-    for (const module of modules) {
-      router.modules[module] = require(`./modules/${module}/${module}`)
-      if (router.modules[module].init) {
-        router.modules[module].init(router)
-      }
-    }
-
-    await addRoutesAndMiddleware()
-
-    try {
-      await installApi.updateAdminPermissions(router)
-    } catch (e) {
-      console.error('Error while attempting to update admin permissions')
-      console.error(e)
-    }
-
-    router.initialized = true
-    await util.notify('ready', router)
-  })()
-
-  async function addRoutesAndMiddleware() {
-    // Allow CORS
-    router.use(function addCorsHeaders(req, res, next) {
-      res.header('Access-Control-Allow-Origin', '*')
-      res.header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE')
-      res.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept, x-access-token')
-      next()
-    })
-
-    router.use(bodyParser.json({
-      type: '*/*', // The wildcard type ensures it works even without the application/json header
-      limit: router.settings.body_limit || '1mb',
-    }))
-
-    router.use(function attachVariablesToReq(req, res, next) {
-      req.settings = router.settings
-      req.eventListeners = router.eventListeners
-      req.db = router.db
-      req.modules = router.modules
-      req.setupCollectionDb = router.setupCollectionDb
-      req.getSetting = router.getSetting
-      req.requestId = randomstring.generate(12)
-      res.header('X-Request-ID', req.requestId)
-      next()
-    })
-
-    router.use(loggingMiddleware)
-
-    router.notify = util.notify
-
-    router.post('/install', ph(async (req) => installApi.install(req, router)))
-    router.get('/install/settings/schema', ph(async (req) => installApi.getSettingsSchema(req, router)))
-
-    const loginCollections = await util.getLoginCollections(router)
-
-    for (const { _id: name } of loginCollections) {
-      router.post(`/${name}/login`, ph((req) => usersApi.login(req, name)))
-    }
-
-    router.use(auth.middleware) // Add user id to request
-    router.use(permissions.middleware) // Add user and permissions to request
-
-    router.get('/status', ph(statusApi.getStatus(router)))
-
-    router.use(router.custom) // Externally added middleware
-
-    for (const { _id: name } of loginCollections) {
-      router.post(`/${name}/register`, ph((req) => usersApi.register(req, name)))
-      router.get(`/${name}/me`, ph((req) => usersApi.getMe(req, name)))
-    }
-
-    router.get('/:collection/schema', ph(collectionsApi.getSchema))
-    router.get('/:collection', ph(collectionsApi.get))
-    router.post('/:collection', ph(collectionsApi.insert))
-    router.get('/:collection/:id', ph(collectionsApi.getById))
-    router.put('/:collection/:id', ph(collectionsApi.replaceById))
-    router.post('/:collection/:id/update', ph(collectionsApi.updateById))
-    router.delete('/:collection/:id', ph(collectionsApi.deleteById))
-
-    // Error handler, log and send to user
-    // eslint-disable-next-line no-unused-vars
-    router.use(function safeErrorHandler(err, req, res, next) {
-      console.error('my err handler')
-      console.error(err.stack)
-      req.returnedError = err
-      res.status(res.errCode || 500)
-      if (process.env.DEBUG || (req.hasPermission && req.hasPermission('view errors'))) {
-        res.send({
-          error: err
-        })
-      } else {
-        res.send({
-          error: 'something wrong happened'
-        })
-      }
-    })
-  }
-
-  return router
-}
-
-module.exports.admin = function (settings) {
-  const router = express.Router()
-  router.get('/settings.js', function (req, res) {
-    res.set('Content-Type', 'text/javascript')
-    res.send('window.settings = ' + JSON.stringify(settings || {}) + '')
-  })
-  router.use(express.static(__dirname + '/modules/admin/dist'))
-  return router
-}
+const fs = require('fs')
+const express = require('express')
+const bodyParser = require('body-parser')
+const debug = require('debug')('expressa')
+const randomstring = require('randomstring')
+
+const dbTypeNames = ['cached', 'file', 'memory', 'postgres', 'mongo']
+const dbTypes = dbTypeNames.reduce((obj, name) => {
+  obj[name] = require('./db/' + name)
+  return obj
+}, {})
+dbTypes['mongodb'] = dbTypes['mongo'] // alias
+const auth = require('./auth')
+const util = require('./util')
+
+const collectionsApi = require('./controllers/collections')
+const usersApi = require('./controllers/users')
+const installApi = require('./controllers/install')
+const statusApi = require('./controllers/status')
+const permissions = require('./middleware/permissions')
+const loggingMiddleware = require('./middleware/logging')
+
+process.env.NODE_ENV = process.env.NODE_ENV || 'development'
+
+async function bootstrapCollections (router) {
+  const collections = await router.db.collection.all()
+  await Promise.all(collections.map((collection) => {
+    if (!dbTypes[collection.storage]) {
+      console.error('missing ' + collection.storage + ' dbtype which is used by ' + collection._id)
+      console.error('try updating to the latest version of expressa')
+    }
+    return router.setupCollectionDb(collection)
+  }))
+}
+
+async function initCollections (db, router) {
+  debug('init collections')
+  try {
+    const data = await db.settings.get(process.env.NODE_ENV)
+    Object.assign(router.settings, data)
+  } catch (err) {
+    const filePath = router.settings.file_storage_path || 'data'
+    if (!fs.existsSync(filePath + '/settings/' + process.env.NODE_ENV + '.json')) {
+      console.error('Settings not found. Please visit the expressa admin page for the installation process.')
+      console.error('This is likely at http://localhost:3000/admin but may be different if you changed ports, etc.')
+    } else {
+      console.error('error reading settings')
+      console.error(err.stack)
+    }
+  }
+  console.log('Starting expressa server using environment: ' + process.env.NODE_ENV) // eslint-disable-line no-console
+  db.collection = dbTypes[router.settings.collection_db_type || 'file'](router.settings, 'collection')
+  await bootstrapCollections(router)
+  debug('collections loaded.')
+
+  await Promise.all([
+    require('./listeners_collection_permissions')(router),
+    require('./listeners')(router),
+    require('./listeners_validation')(router),
+    require('./listeners_users')(router),
+  ])
+  debug('added standard listeners')
+}
+
+function ph (requestHandler) {
+  return async function wrapper (req, res, next) {
+    const collectionName = req.params.collection
+    let collection = {}
+    try {
+      collection = collectionName ? await req.db.collection.get(collectionName) : {}
+    } catch (e) {
+      if (!e.message.includes('document not found')) {
+        console.error(e)
+      }
+    }
+    if (!collection.allowHTTPCaching) {
+      res.header('Cache-Control', 'no-cache, no-store, must-revalidate')
+      res.header('Expires', '-1')
+      res.header('Pragma', 'no-cache')
+    }
+    try {
+      const result = await requestHandler(req, res, next)
+      if (typeof result !== 'object') {
+        res.status(500).send('invalid result')
+      }
+      debug(`${200} ${req.method} ${req.url} body: ${JSON.stringify(req.body)} result: ${JSON.stringify(result)}`)
+      res.send(result)
+    } catch (err) {
+      err.status = err.status || 500
+      debug(`${err.status} ${req.method} ${req.url} ${err.stack} ${req.uerror}`)
+      if ((req.settings.print_400_errors) || err.status >= 500) {
+        console.error(err + ' | ' + req.uerror)
+      }
+      req.returnedError = err
+      res.status(err.status).send({
+        error: err.result || err.message || err,
+        ...auth.getTokenError(req)
+      })
+    }
+  }
+}
+
+module.exports.api = function (settings) {
+  const router = express.Router()
+  router.initialized = false
+  router.custom = express.Router()
+  router.dbTypes = dbTypes
+  router.settings = settings || {}
+  router.db = {
+    settings: dbTypes[router.settings.settings_db_type || 'file'](router.settings, 'settings')
+  }
+  router.util = {
+    get pgpool() {
+      return util.getPgPool(router.settings.postgresql_uri)
+    },
+    ...util,
+  }
+  router.eventListeners = {}
+
+  router.setupCollectionDb = async function(collection) {
+    debug(`init collection db ${collection._id} ${collection.storage}`)
+    router.db[collection._id] = dbTypes[collection.storage](router.settings, collection._id, collection)
+    if (collection.cacheInMemory) {
+      router.db[collection._id] = dbTypes['cached'](router.db[collection._id])
+      debug('initializing ' + collection._id + ' as a memory cached collection')
+    }
+    return Promise.resolve(router.db[collection._id].init())
+  }
+
+  router.addSingleCollectionListener = function (event, listener) {
+    if (!router.eventListeners[event]) {
+      router.eventListeners[event] = []
+    }
+    router.eventListeners[event].push(listener)
+    router.eventListeners[event].sort((a, b) => a.priority - b.priority)
+    if (event === 'ready' && router.initialized) {
+      listener(router)
+    }
+  }
+
+  router.addCollectionListenerWithPriority = function (events, collections, priority, listener) {
+    listener.priority = priority
+    router.addCollectionListener(events, collections, listener)
+  }
+
+  router.addLateCollectionListener = function (events, collections, listener) {
+    listener.priority = 10
+    router.addCollectionListener(events, collections, listener)
+  }
+
+  router.addCollectionListener = function (events, collections, listener) {
+    events = util.castArray(events)
+    collections = util.castArray(collections)
+    listener.priority = listener.priority || 0
+    listener.collections = collections
+    if (!listener.name) {
+      throw new Error('Listeners must be named')
+    }
+    events.forEach(function (event) {
+      router.addSingleCollectionListener(event, listener)
+    })
+  }
+
+  router.addListener = function addListener (events, priority, listener) {
+    events = util.castArray(events)
+    if (typeof priority === 'function') {
+      listener = priority
+      priority = 0
+    }
+    if (!listener.name) {
+      throw new Error('Listeners must be named')
+    }
+    listener.priority = priority
+    events.forEach(function (event) {
+      router.addSingleCollectionListener(event, listener)
+    })
+  }
+
+  router.getSetting = function (name) {
+    return util.getPath(router.settings, name)
+  };
+
+  (async function setup() {
+    await initCollections(router.db, router)
+
+    const modules = ['collections', 'core', 'logging', 'permissions', 'access_keys']
+    router.modules = {}
+    for (const module of modules) {
+      router.modules[module] = require(`./modules/${module}/${module}`)
+      if (router.modules[module].init) {
+        router.modules[module].init(router)
+      }
+    }
+
+    await addRoutesAndMiddleware()
+
+    try {
+      await installApi.updateAdminPermissions(router)
+    } catch (e) {
+      console.error('Error while attempting to update admin permissions')
+      console.error(e)
+    }
+
+    router.initialized = true
+    await util.notify('ready', router)
+  })()
+
+  async function addRoutesAndMiddleware() {
+    // Allow CORS
+    router.use(function addCorsHeaders(req, res, next) {
+      res.header('Access-Control-Allow-Origin', '*')
+      res.header('Access-Control-Allow-Methods', 'GET, POST, PUT, DELETE')
+      res.header('Access-Control-Allow-Headers', 'Origin, X-Requested-With, Content-Type, Accept, x-access-token')
+      next()
+    })
+
+    router.use(bodyParser.json({
+      type: (req) => {
+        const contentType = req.headers['content-type'] || ''
+        // Don't parse any multipart/* content - body-parser can't handle these
+        if (contentType.startsWith('multipart/')) {
+          return false
+        }
+        return true
+      },
+      limit: router.settings.body_limit || '1mb',
+    }))
+
+    router.use(function attachVariablesToReq(req, res, next) {
+      req.settings = router.settings
+      req.eventListeners = router.eventListeners
+      req.db = router.db
+      req.modules = router.modules
+      req.setupCollectionDb = router.setupCollectionDb
+      req.getSetting = router.getSetting
+      req.requestId = randomstring.generate(12)
+      res.header('X-Request-ID', req.requestId)
+
+      // Token error helpers for custom endpoints
+      req.getTokenError = () => auth.getTokenError(req)
+      res.sendApiError = function (status, message) {
+        return this.status(status).send({
+          error: message,
+          ...auth.getTokenError(req)
+        })
+      }
+
+      next()
+    })
+
+    router.use(loggingMiddleware)
+
+    router.notify = util.notify
+
+    router.post('/install', ph(async (req) => installApi.install(req, router)))
+    router.get('/install/settings/schema', ph(async (req) => installApi.getSettingsSchema(req, router)))
+
+    const loginCollections = await util.getLoginCollections(router)
+
+    for (const { _id: name } of loginCollections) {
+      router.post(`/${name}/login`, ph((req) => usersApi.login(req, name)))
+    }
+
+    router.use(auth.middleware) // Add user id to request
+    router.use(permissions.middleware) // Add user and permissions to request
+
+    router.get('/status', ph(statusApi.getStatus(router)))
+
+    router.use(router.custom) // Externally added middleware
+
+    for (const { _id: name } of loginCollections) {
+      router.post(`/${name}/register`, ph((req) => usersApi.register(req, name)))
+      router.get(`/${name}/me`, ph((req) => usersApi.getMe(req, name)))
+    }
+
+    router.get('/:collection/schema', ph(collectionsApi.getSchema))
+    router.get('/:collection', ph(collectionsApi.get))
+    router.post('/:collection', ph(collectionsApi.insert))
+    router.get('/:collection/:id', ph(collectionsApi.getById))
+    router.put('/:collection/:id', ph(collectionsApi.replaceById))
+    router.post('/:collection/:id/update', ph(collectionsApi.updateById))
+    router.delete('/:collection/:id', ph(collectionsApi.deleteById))
+
+    // Error handler, log and send to user
+    // eslint-disable-next-line no-unused-vars
+    router.use(function safeErrorHandler(err, req, res, next) {
+      console.error('my err handler')
+      console.error(err.stack)
+      req.returnedError = err
+      res.status(res.errCode || 500)
+      if (process.env.DEBUG || (req.hasPermission && req.hasPermission('view errors'))) {
+        res.send({
+          error: err
+        })
+      } else {
+        res.send({
+          error: 'something wrong happened'
+        })
+      }
+    })
+  }
+
+  return router
+}
+
+module.exports.admin = function (settings) {
+  const router = express.Router()
+  router.get('/settings.js', function (req, res) {
+    res.set('Content-Type', 'text/javascript')
+    res.send('window.settings = ' + JSON.stringify(settings || {}) + '')
+  })
+  router.use(express.static(__dirname + '/modules/admin/dist'))
+  return router
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "expressa",
-  "version": "2.0.23",
+  "version": "2.1.0",
   "description": "API framework using JSON schemas",
   "main": "index.js",
   "repository": "https://github.com/thomas4019/expressa",

package/.vscode/launch.json

@@ -1,19 +0,0 @@
-{
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-
-    {
-      "type": "node-terminal",
-      "name": "Run Script: test",
-      "request": "launch",
-      "command": "npm run test",
-      "cwd": "${workspaceFolder}",
-      "env": {
-        "TEST_POSTGRES": "true"
-      }
-    },
-  ]
-}

package/modules/admin/dist/css/197.e66ce8d8.css

@@ -1,7 +0,0 @@
-
-.el-table[data-v-4b9ae5da] th {
- background-color: #343a40 !important;
- border-color: #454d55;
- color: #fff;
-}
-