expressa 2.0.18 → 2.0.20

package/db/postgres.js

@@ -1,93 +1,93 @@
-const util = require('../util')
-
-module.exports = function (settings, collectionId, collection) {
-  const pool = util.getPgPool(settings.postgresql_uri)
-
-  return {
-    init: async function () {
-      if (collection.plainStringIds) {
-        await pool.query('CREATE TABLE IF NOT EXISTS ' + collectionId + ' (id text primary key, data jsonb)')
-      } else {
-        await pool.query('CREATE TABLE IF NOT EXISTS ' + collectionId + ' (id uuid primary key, data jsonb)')
-      }
-    },
-    all: async function () {
-      return this.find({})
-    },
-    find: async function (rawQuery, offset, limit, orderby, fields) {
-      const pgSelect = util.mongoToPostgresSelect(collectionId, fields)
-      const pgWhere = util.mongoToPostgresWhere(collectionId, rawQuery)
-      let query = 'SELECT ' + pgSelect + ' FROM ' + collectionId + (pgWhere ? ' WHERE ' + pgWhere : '')
-      if (typeof orderby !== 'undefined') {
-        query += ' ORDER BY '
-        query += util.mongoToPostgresOrderBy(collectionId, orderby)
-      }
-      if (typeof offset !== 'undefined') {
-        query += ' OFFSET ' + offset
-      }
-      if (typeof limit !== 'undefined') {
-        query += ' LIMIT ' + limit
-      }
-      const result = await pool.query(query)
-      return result.rows.map((row) => row.data)
-    },
-    count: async function(rawQuery, offset, limit) {
-      const pgWhere = util.mongoToPostgresWhere(collectionId, rawQuery)
-      let query = 'SELECT COUNT(*) FROM ' + collectionId + (pgWhere ? ' WHERE ' + pgWhere : '')
-      if (typeof offset !== 'undefined') {
-        query += ' OFFSET ' + offset
-      }
-      if (typeof limit !== 'undefined') {
-        query += ' LIMIT ' + limit
-      }
-      const result = await pool.query(query)
-      return parseInt(result.rows[0].count)
-    },
-    get: async function (id, fields) {
-      const pgSelect = util.mongoToPostgresSelect(collectionId, fields)
-      const result = await pool.query(`SELECT ${pgSelect} FROM ${collectionId} WHERE id = $1`, [id])
-      if (result.rowCount === 0) {
-        throw new util.ApiError(404, 'document not found')
-      }
-      return result.rows[0].data
-    },
-    create: async function (data) {
-      util.addIdIfMissing(data)
-      try {
-        await pool.query('INSERT INTO ' + collectionId + ' (id, data) VALUES ($1, $2)', [data._id, data])
-      } catch (e) {
-        if (e.message.includes('duplicate key')) {
-          throw new util.ApiError(409, 'document already exists')
-        }
-        throw e
-      }
-      return data._id
-    },
-    update: async function (id, data) {
-      if (typeof data._id === 'undefined') {
-        data._id = id
-      }
-      const result = await pool.query('UPDATE ' + collectionId + ' SET data=$2,id=$3 WHERE id=$1', [id, data, data._id])
-      if (result.rowCount === 0) {
-        throw new util.ApiError(404, 'document not found')
-      }
-      return data
-    },
-    // eslint-disable-next-line no-unused-vars
-    updateWithQuery: async function (query, update, options) {
-      const pgWhere = util.mongoToPostgresWhere(collectionId, query)
-      const updateSql = util.mongoToPostgresUpdate(collectionId, update)
-      const result = await pool.query('UPDATE ' + collectionId + ' SET data=' + updateSql + ' WHERE ' + pgWhere)
-      return {
-        matchedCount: result.rowCount
-      }
-    },
-    delete: async function (id) {
-      const result = await pool.query('DELETE FROM ' + collectionId + ' WHERE id=$1', [id])
-      if (result.rowCount === 0) {
-        throw new util.ApiError(404, 'document not found')
-      }
-      return 'OK'
-    }
-  }
-}
+const util = require('../util')
+
+module.exports = function (settings, collectionId, collection) {
+  const pool = util.getPgPool(settings.postgresql_uri)
+
+  return {
+    init: async function () {
+      if (collection.plainStringIds) {
+        await pool.query('CREATE TABLE IF NOT EXISTS ' + collectionId + ' (id text primary key, data jsonb)')
+      } else {
+        await pool.query('CREATE TABLE IF NOT EXISTS ' + collectionId + ' (id uuid primary key, data jsonb)')
+      }
+    },
+    all: async function () {
+      return this.find({})
+    },
+    find: async function (rawQuery, offset, limit, orderby, fields) {
+      const pgSelect = util.mongoToPostgresSelect(collectionId, fields)
+      const pgWhere = util.mongoToPostgresWhere(collectionId, rawQuery)
+      let query = 'SELECT ' + pgSelect + ' FROM ' + collectionId + (pgWhere ? ' WHERE ' + pgWhere : '')
+      if (typeof orderby !== 'undefined') {
+        query += ' ORDER BY '
+        query += util.mongoToPostgresOrderBy(collectionId, orderby)
+      }
+      if (typeof offset !== 'undefined') {
+        query += ' OFFSET ' + offset
+      }
+      if (typeof limit !== 'undefined') {
+        query += ' LIMIT ' + limit
+      }
+      const result = await pool.query(query)
+      return result.rows.map((row) => row.data)
+    },
+    count: async function(rawQuery, offset, limit) {
+      const pgWhere = util.mongoToPostgresWhere(collectionId, rawQuery)
+      let query = 'SELECT COUNT(*) FROM ' + collectionId + (pgWhere ? ' WHERE ' + pgWhere : '')
+      if (typeof offset !== 'undefined') {
+        query += ' OFFSET ' + offset
+      }
+      if (typeof limit !== 'undefined') {
+        query += ' LIMIT ' + limit
+      }
+      const result = await pool.query(query)
+      return parseInt(result.rows[0].count)
+    },
+    get: async function (id, fields) {
+      const pgSelect = util.mongoToPostgresSelect(collectionId, fields)
+      const result = await pool.query(`SELECT ${pgSelect} FROM ${collectionId} WHERE id = $1`, [id])
+      if (result.rowCount === 0) {
+        throw new util.ApiError(404, 'document not found')
+      }
+      return result.rows[0].data
+    },
+    create: async function (data) {
+      util.addIdIfMissing(data)
+      try {
+        await pool.query('INSERT INTO ' + collectionId + ' (id, data) VALUES ($1, $2)', [data._id, data])
+      } catch (e) {
+        if (e.message.includes('duplicate key')) {
+          throw new util.ApiError(409, 'document already exists')
+        }
+        throw e
+      }
+      return data._id
+    },
+    update: async function (id, data) {
+      if (typeof data._id === 'undefined') {
+        data._id = id
+      }
+      const result = await pool.query('UPDATE ' + collectionId + ' SET data=$2,id=$3 WHERE id=$1', [id, data, data._id])
+      if (result.rowCount === 0) {
+        throw new util.ApiError(404, 'document not found')
+      }
+      return data
+    },
+    // eslint-disable-next-line no-unused-vars
+    updateWithQuery: async function (query, update, options) {
+      const pgWhere = util.mongoToPostgresWhere(collectionId, query)
+      const updateSql = util.mongoToPostgresUpdate(collectionId, update)
+      const result = await pool.query('UPDATE ' + collectionId + ' SET data=' + updateSql + ' WHERE ' + pgWhere)
+      return {
+        matchedCount: result.rowCount
+      }
+    },
+    delete: async function (id) {
+      const result = await pool.query('DELETE FROM ' + collectionId + ' WHERE id=$1', [id])
+      if (result.rowCount === 0) {
+        throw new util.ApiError(404, 'document not found')
+      }
+      return 'OK'
+    }
+  }
+}

package/doc/authentication.md

@@ -1,38 +1,38 @@
-## Authentication
-Uses [JSON Web Tokens](https://jwt.io/)
-
-| method | endpoint                      | description  |
-|--------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| POST   | /users/login                  | expects JSON in the message body. e.g. `{"email": "email@example.com", password: "<the password>"}                                                                                             |
-
-Returns the following
-```javascript
-{
-  "uid": "a52ee085-ff47-4ee1-bac3-a8a319f674ed",
-  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiI1NmNkNWM5NmY4MjA4N2I1MDQ0OTM3YjEiLCJ1bml2ZXJzaXR5IjoiQllVIiwiZnVsbE5hbWUiOiJUaG9tYXMgSGFuc2VuIiwicGFzc3dvcmQiOiIkMmEkMTAkb0prdlBnTTlkR2FJRTIzaWFabGEvT0tjZC9PL3phSGFJOHFRUDBuZ2pPUVV1Ums3Vng2QkciLCJlbWFpbCI6InRoNDAxOUBnbWFpbC5jb20iLCJfX3YiOjAsImxpc3RpbmdzIjpbXSwiaWF0IjoxNDU2NDMwMjE5LCJleHAiOjE0NTY1MTY2MTl9._ijngdgwLU9AJnAjbySUgEFsR8hJCSw8PhH1AnyBHuM"
-}
-```
-Or it will respond with a status code of 401 and a message explaining why they can't login.
-
-```javascript
-{
-  "success": false,
-  "message": "Authentication failed. Wrong password."
-}
-```
-
-The returned token must then be passed in as a header on future requests using the header x-access-token
-
-* `GET /users/me` - returns the logged in user's object
-
-## Making authenticated requests
-
-After obtaining a token as described above you need to pass it with your request in one of these ways
-
-1. Using the `x-access-token`
-
-	`curl --header "x-access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiI1NmNkNWM5NmY4MjA4N2I1MDQ0OTM3YjEiLCJ1bml2ZXJzaXR5IjoiQllVIiwiZnVsbE5hbWUiOiJUaG9tYXMgSGFuc2VuIiwicGFzc3dvcmQiOiIkMmEkMTAkb0prdlBnTTlkR2FJRTIzaWFabGEvT0tjZC9PL3phSGFJOHFRUDBuZ2pPUVV1Ums3Vng2QkciLCJlbWFpbCI6InRoNDAxOUBnbWFpbC5jb20iLCJfX3YiOjAsImxpc3RpbmdzIjpbXSwiaWF0IjoxNDU2NDMwMjE5LCJleHAiOjE0NTY1MTY2MTl9._ijngdgwLU9AJnAjbySUgEFsR8hJCSw8PhH1AnyBHuM" api.example.com/users/me`
-
-2. Pass the token as a query parameter.
-
-	`curl api.example.com/users/me?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiI1NmNkNWM5NmY4MjA4N2I1MDQ0OTM3YjEiLCJ1bml2ZXJzaXR5IjoiQllVIiwiZnVsbE5hbWUiOiJUaG9tYXMgSGFuc2VuIiwicGFzc3dvcmQiOiIkMmEkMTAkb0prdlBnTTlkR2FJRTIzaWFabGEvT0tjZC9PL3phSGFJOHFRUDBuZ2pPUVV1Ums3Vng2QkciLCJlbWFpbCI6InRoNDAxOUBnbWFpbC5jb20iLCJfX3YiOjAsImxpc3RpbmdzIjpbXSwiaWF0IjoxNDU2NDMwMjE5LCJleHAiOjE0NTY1MTY2MTl9._ijngdgwLU9AJnAjbySUgEFsR8hJCSw8PhH1AnyBHuM`
+## Authentication
+Uses [JSON Web Tokens](https://jwt.io/)
+
+| method | endpoint                      | description  |
+|--------|-------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| POST   | /users/login                  | expects JSON in the message body. e.g. `{"email": "email@example.com", password: "<the password>"}                                                                                             |
+
+Returns the following
+```javascript
+{
+  "uid": "a52ee085-ff47-4ee1-bac3-a8a319f674ed",
+  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiI1NmNkNWM5NmY4MjA4N2I1MDQ0OTM3YjEiLCJ1bml2ZXJzaXR5IjoiQllVIiwiZnVsbE5hbWUiOiJUaG9tYXMgSGFuc2VuIiwicGFzc3dvcmQiOiIkMmEkMTAkb0prdlBnTTlkR2FJRTIzaWFabGEvT0tjZC9PL3phSGFJOHFRUDBuZ2pPUVV1Ums3Vng2QkciLCJlbWFpbCI6InRoNDAxOUBnbWFpbC5jb20iLCJfX3YiOjAsImxpc3RpbmdzIjpbXSwiaWF0IjoxNDU2NDMwMjE5LCJleHAiOjE0NTY1MTY2MTl9._ijngdgwLU9AJnAjbySUgEFsR8hJCSw8PhH1AnyBHuM"
+}
+```
+Or it will respond with a status code of 401 and a message explaining why they can't login.
+
+```javascript
+{
+  "success": false,
+  "message": "Authentication failed. Wrong password."
+}
+```
+
+The returned token must then be passed in as a header on future requests using the header x-access-token
+
+* `GET /users/me` - returns the logged in user's object
+
+## Making authenticated requests
+
+After obtaining a token as described above you need to pass it with your request in one of these ways
+
+1. Using the `x-access-token`
+
+	`curl --header "x-access-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiI1NmNkNWM5NmY4MjA4N2I1MDQ0OTM3YjEiLCJ1bml2ZXJzaXR5IjoiQllVIiwiZnVsbE5hbWUiOiJUaG9tYXMgSGFuc2VuIiwicGFzc3dvcmQiOiIkMmEkMTAkb0prdlBnTTlkR2FJRTIzaWFabGEvT0tjZC9PL3phSGFJOHFRUDBuZ2pPUVV1Ums3Vng2QkciLCJlbWFpbCI6InRoNDAxOUBnbWFpbC5jb20iLCJfX3YiOjAsImxpc3RpbmdzIjpbXSwiaWF0IjoxNDU2NDMwMjE5LCJleHAiOjE0NTY1MTY2MTl9._ijngdgwLU9AJnAjbySUgEFsR8hJCSw8PhH1AnyBHuM" api.example.com/users/me`
+
+2. Pass the token as a query parameter.
+
+	`curl api.example.com/users/me?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJfaWQiOiI1NmNkNWM5NmY4MjA4N2I1MDQ0OTM3YjEiLCJ1bml2ZXJzaXR5IjoiQllVIiwiZnVsbE5hbWUiOiJUaG9tYXMgSGFuc2VuIiwicGFzc3dvcmQiOiIkMmEkMTAkb0prdlBnTTlkR2FJRTIzaWFabGEvT0tjZC9PL3phSGFJOHFRUDBuZ2pPUVV1Ums3Vng2QkciLCJlbWFpbCI6InRoNDAxOUBnbWFpbC5jb20iLCJfX3YiOjAsImxpc3RpbmdzIjpbXSwiaWF0IjoxNDU2NDMwMjE5LCJleHAiOjE0NTY1MTY2MTl9._ijngdgwLU9AJnAjbySUgEFsR8hJCSw8PhH1AnyBHuM`

package/doc/automatic-fields.md

@@ -1,12 +1,12 @@
-## Automatic Fields
-
-Each object will contain this meta property which has autogenerated fields shared across all collection types:
-
-```javascript
-  "meta": {
-    "created": "2016-05-16T23:56:11.615Z",
-    "updated": "2016-05-16T23:56:28.262Z",
-    "owner": "56cb5df7f56ef0b92f7b984b"
-  },
-```
-
+## Automatic Fields
+
+Each object will contain this meta property which has autogenerated fields shared across all collection types:
+
+```javascript
+  "meta": {
+    "created": "2016-05-16T23:56:11.615Z",
+    "updated": "2016-05-16T23:56:28.262Z",
+    "owner": "56cb5df7f56ef0b92f7b984b"
+  },
+```
+

package/doc/blogexample.md

@@ -1,16 +1,16 @@
-## Blog Example
-
-### Creating the blog "post" collection and its schema.
-
-Here's what the UI looks like for adding this new custom collection type.
-
-![post schema 3](https://cloud.githubusercontent.com/assets/406149/15308189/c3612ade-1b97-11e6-8f87-faeee4aba8bd.png)
-
---------------------------------
-
-### Creating a post
-
-After creating the blog post collection, here's what adding a document of that type looks like using the built in editor.
-
-![create post 3](https://cloud.githubusercontent.com/assets/406149/15308188/c361368c-1b97-11e6-869a-ac40ba838dde.png)
-
+## Blog Example
+
+### Creating the blog "post" collection and its schema.
+
+Here's what the UI looks like for adding this new custom collection type.
+
+![post schema 3](https://cloud.githubusercontent.com/assets/406149/15308189/c3612ade-1b97-11e6-8f87-faeee4aba8bd.png)
+
+--------------------------------
+
+### Creating a post
+
+After creating the blog post collection, here's what adding a document of that type looks like using the built in editor.
+
+![create post 3](https://cloud.githubusercontent.com/assets/406149/15308188/c361368c-1b97-11e6-869a-ac40ba838dde.png)
+

package/doc/custom-endpoints.md

@@ -1,20 +1,20 @@
-## Custom Endpoints
-
-Since Expressa exports a middleware you can include it in express apps that have other endpoints. These other endpoints
-do not have access to the current user and other expressa objects attached to the request object. If you need these see
-the section below.
-
-## Add endpoints within expressa
-
-The api middleware exposes a "custom" which is an express router you can attach additional endpoints to. These endpoints
-are called after internal expressa middleware, but before any expressa endpoints.
-
-Note: you can use req.hasPermission('users: edit') to check if the user has a specific permission.
-
-Example:
-```javascript
-const api = expressa.api();
-api.custom.get('/test', function (req, res) {
-    res.send(req.user)
-})
-```
+## Custom Endpoints
+
+Since Expressa exports a middleware you can include it in express apps that have other endpoints. These other endpoints
+do not have access to the current user and other expressa objects attached to the request object. If you need these see
+the section below.
+
+## Add endpoints within expressa
+
+The api middleware exposes a "custom" which is an express router you can attach additional endpoints to. These endpoints
+are called after internal expressa middleware, but before any expressa endpoints.
+
+Note: you can use req.hasPermission('users: edit') to check if the user has a specific permission.
+
+Example:
+```javascript
+const api = expressa.api();
+api.custom.get('/test', function (req, res) {
+    res.send(req.user)
+})
+```

package/doc/database.md

@@ -1,23 +1,23 @@
-### Generic JSON Database API
-
-You can access a collection's database using `expressa.db[collectionName].action where action is one of the following:
-
-* all - returns all documents
-* find - returns array of documents matching the mongo query
-* get - retrieve a document by id
-* create - create a new document
-* update - modify an existing document
-* delete - delete a document by id
-* init - called once during startup, useful to create/ensure collection exists
-
-### Implemented JSON databases
-* MongoDB
-* PostgreSQL (using [jsonb](http://www.postgresql.org/docs/9.4/static/datatype-json.html) and [mongo-query-to-postgres-jsonb](https://github.com/thomas4019/mongo-query-to-postgres-jsonb))
-* Text files (using [json-file-store](https://github.com/flosse/json-file-store) and [mongo-query](https://github.com/Automattic/mongo-query))
-* In-memory (useful for small/medium ephemeral datasets like logs)
-
-Other JSON capable databases can be added easily (pull requests welcome!) by writing a wrapper that supports each of the above methods.
-
-### Smart database objects
-
-[expressa-folder](https://npmjs.org/package/expressa-folder) will automatically add functions to objects returned by `all`,`find` and `get`
+### Generic JSON Database API
+
+You can access a collection's database using `expressa.db[collectionName].action where action is one of the following:
+
+* all - returns all documents
+* find - returns array of documents matching the mongo query
+* get - retrieve a document by id
+* create - create a new document
+* update - modify an existing document
+* delete - delete a document by id
+* init - called once during startup, useful to create/ensure collection exists
+
+### Implemented JSON databases
+* MongoDB
+* PostgreSQL (using [jsonb](http://www.postgresql.org/docs/9.4/static/datatype-json.html) and [mongo-query-to-postgres-jsonb](https://github.com/thomas4019/mongo-query-to-postgres-jsonb))
+* Text files (using [json-file-store](https://github.com/flosse/json-file-store) and [mongo-query](https://github.com/Automattic/mongo-query))
+* In-memory (useful for small/medium ephemeral datasets like logs)
+
+Other JSON capable databases can be added easily (pull requests welcome!) by writing a wrapper that supports each of the above methods.
+
+### Smart database objects
+
+[expressa-folder](https://npmjs.org/package/expressa-folder) will automatically add functions to objects returned by `all`,`find` and `get`

package/doc/development.md

@@ -1,34 +1,34 @@
-## Setup for developing expressa
-1. git clone git@github.com:thomas4019/expressa.git
-1. cd expressa
-1. npm install
-1. npm link
-1. cd modules/admin
-1. npm install
-1. npm run build
-
-In another folder, create a project using app.js from the readme.
-1. npm link expressa
-1. node app.js
-
-## Developing admin UI locally
-* npm run testserver
-* (cd modules/admin && npm run dev)
-* npm run cypress (to manually run specific tests)
-
-## Before committing/releasing
-* npm run test
-* npm run testdbs (if changing Postgres or Mongo code)
-* npm run testcypress (if changing admin UI or related)
-* npm run fixlint
-* (cd modules/admin && npm run lint) (if changing admin UI)
-
-## To release
-* Update version in package.json
-* (cd modules/admin && npm run build)
-* ls -la modules/admin/dist/static/js
-* npm publish
-* Create release on GitHub
-
-## More info
+## Setup for developing expressa
+1. git clone git@github.com:thomas4019/expressa.git
+1. cd expressa
+1. npm install
+1. npm link
+1. cd modules/admin
+1. npm install
+1. npm run build
+
+In another folder, create a project using app.js from the readme.
+1. npm link expressa
+1. node app.js
+
+## Developing admin UI locally
+* npm run testserver
+* (cd modules/admin && npm run dev)
+* npm run cypress (to manually run specific tests)
+
+## Before committing/releasing
+* npm run test
+* npm run testdbs (if changing Postgres or Mongo code)
+* npm run testcypress (if changing admin UI or related)
+* npm run fixlint
+* (cd modules/admin && npm run lint) (if changing admin UI)
+
+## To release
+* Update version in package.json
+* (cd modules/admin && npm run build)
+* ls -la modules/admin/dist/static/js
+* npm publish
+* Create release on GitHub
+
+## More info
 [Modules](doc/modules.md)