expressa 2.0.21 → 2.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (222) hide show
  1. package/.circleci/config.yml +21 -21
  2. package/.eslintrc.json +29 -29
  3. package/.vscode/launch.json +19 -0
  4. package/LICENSE +21 -21
  5. package/README.md +137 -137
  6. package/auth/index.js +76 -76
  7. package/auth/jwt.js +31 -31
  8. package/controllers/collections.js +260 -260
  9. package/controllers/install.js +105 -105
  10. package/controllers/status.js +43 -43
  11. package/controllers/users.js +52 -52
  12. package/cypress/fixtures/example.json +4 -4
  13. package/cypress/integration/0_install_spec.js +8 -8
  14. package/cypress/integration/custom_collections.js +30 -30
  15. package/cypress/integration/home.js +9 -9
  16. package/cypress/integration/settings.js +34 -34
  17. package/cypress/integration/users.js +61 -61
  18. package/cypress/plugins/index.js +17 -17
  19. package/cypress/support/commands.js +69 -69
  20. package/cypress/support/index.js +20 -20
  21. package/cypress/support/util.js +10 -10
  22. package/cypress.config.js +18 -18
  23. package/cypress.json +4 -4
  24. package/db/cached.js +44 -40
  25. package/db/file.js +131 -112
  26. package/db/memory.js +92 -79
  27. package/db/mongo.js +93 -86
  28. package/db/postgres.js +100 -93
  29. package/doc/authentication.md +38 -38
  30. package/doc/automatic-fields.md +12 -12
  31. package/doc/blogexample.md +16 -16
  32. package/doc/custom-endpoints.md +20 -20
  33. package/doc/database.md +23 -23
  34. package/doc/development.md +33 -33
  35. package/doc/listeners.md +103 -103
  36. package/doc/modules.md +8 -8
  37. package/doc/permissions.md +14 -14
  38. package/doc/relationships.md +65 -65
  39. package/doc/testing.md +47 -47
  40. package/doc/uploading-files.md +53 -53
  41. package/index.js +297 -297
  42. package/listeners.js +65 -65
  43. package/listeners_collection_permissions.js +29 -29
  44. package/listeners_users.js +96 -96
  45. package/listeners_validation.js +43 -43
  46. package/middleware/logging.js +30 -30
  47. package/middleware/permissions.js +41 -41
  48. package/modules/access_keys/access_keys.js +32 -32
  49. package/modules/admin/.babelrc +8 -19
  50. package/modules/admin/.editorconfig +14 -14
  51. package/modules/admin/.eslintignore +5 -5
  52. package/modules/admin/.eslintrc.js +197 -197
  53. package/modules/admin/.postcssrc.js +10 -10
  54. package/modules/admin/.travis.yml +5 -5
  55. package/modules/admin/LICENSE +21 -21
  56. package/modules/admin/README.md +88 -88
  57. package/modules/admin/build/build.js +46 -46
  58. package/modules/admin/build/check-versions.js +64 -64
  59. package/modules/admin/build/utils.js +109 -109
  60. package/modules/admin/build/vue-loader.conf.js +5 -5
  61. package/modules/admin/build/webpack.base.conf.js +112 -112
  62. package/modules/admin/build/webpack.dev.conf.js +95 -95
  63. package/modules/admin/build/webpack.prod.conf.js +112 -112
  64. package/modules/admin/config/dev.env.js +8 -8
  65. package/modules/admin/config/index.js +86 -86
  66. package/modules/admin/config/prod.env.js +5 -5
  67. package/modules/admin/dist/css/{197.7a90435e.css → 197.e66ce8d8.css} +4 -4
  68. package/modules/admin/dist/css/197.e66ce8d8.css.gz +0 -0
  69. package/modules/admin/dist/css/{430.8c9b0482.css → 430.e83d8cfe.css} +4 -4
  70. package/modules/admin/dist/css/430.e83d8cfe.css.gz +0 -0
  71. package/modules/admin/dist/css/451.c6646d20.css.gz +0 -0
  72. package/modules/admin/dist/css/{566.7a90435e.css → 566.e66ce8d8.css} +4 -4
  73. package/modules/admin/dist/css/566.e66ce8d8.css.gz +0 -0
  74. package/modules/admin/dist/css/569.db9a10c2.css +213 -0
  75. package/modules/admin/dist/css/569.db9a10c2.css.gz +0 -0
  76. package/modules/admin/dist/css/572.513a323e.css +210 -0
  77. package/modules/admin/dist/css/572.513a323e.css.gz +0 -0
  78. package/modules/admin/dist/css/651.e946bda7.css.gz +0 -0
  79. package/modules/admin/dist/css/750.4086915d.css.gz +0 -0
  80. package/modules/admin/dist/css/950.1fd9d57c.css.gz +0 -0
  81. package/modules/admin/dist/css/{app.eba5f5e2.css → app.1c3232a3.css} +25 -25
  82. package/modules/admin/dist/css/app.1c3232a3.css.gz +0 -0
  83. package/modules/admin/dist/index.html +1 -1
  84. package/modules/admin/dist/static/js/197.36982650.js +1 -0
  85. package/modules/admin/dist/static/js/197.36982650.js.gz +0 -0
  86. package/modules/admin/dist/static/js/311.25e842dc.js +1 -0
  87. package/modules/admin/dist/static/js/311.25e842dc.js.gz +0 -0
  88. package/modules/admin/dist/static/js/430.53aea612.js +1 -0
  89. package/modules/admin/dist/static/js/430.53aea612.js.gz +0 -0
  90. package/modules/admin/dist/static/js/451.9f6dcdb1.js +1 -0
  91. package/modules/admin/dist/static/js/451.9f6dcdb1.js.gz +0 -0
  92. package/modules/admin/dist/static/js/460.351dad91.js +1 -0
  93. package/modules/admin/dist/static/js/460.351dad91.js.gz +0 -0
  94. package/modules/admin/dist/static/js/550.87e54b29.js +1 -0
  95. package/modules/admin/dist/static/js/550.87e54b29.js.gz +0 -0
  96. package/modules/admin/dist/static/js/569.52dba3a7.js +1 -0
  97. package/modules/admin/dist/static/js/569.52dba3a7.js.gz +0 -0
  98. package/modules/admin/dist/static/js/572.296cfd3b.js +1 -0
  99. package/modules/admin/dist/static/js/572.296cfd3b.js.gz +0 -0
  100. package/modules/admin/dist/static/js/603.98d5f5d9.js +1 -0
  101. package/modules/admin/dist/static/js/603.98d5f5d9.js.gz +0 -0
  102. package/modules/admin/dist/static/js/651.6dca6fbe.js +1 -0
  103. package/modules/admin/dist/static/js/651.6dca6fbe.js.gz +0 -0
  104. package/modules/admin/dist/static/js/653.0dff78dc.js +1 -0
  105. package/modules/admin/dist/static/js/653.0dff78dc.js.gz +0 -0
  106. package/modules/admin/dist/static/js/750.6877a6b8.js +1 -0
  107. package/modules/admin/dist/static/js/750.6877a6b8.js.gz +0 -0
  108. package/modules/admin/dist/static/js/950.4f40455a.js +1 -0
  109. package/modules/admin/dist/static/js/950.4f40455a.js.gz +0 -0
  110. package/modules/admin/dist/static/js/app.2dd732d9.js +2 -0
  111. package/modules/admin/dist/static/js/{app.083328f8.js.LICENSE.txt → app.2dd732d9.js.LICENSE.txt} +0 -2
  112. package/modules/admin/dist/static/js/app.2dd732d9.js.LICENSE.txt.gz +0 -0
  113. package/modules/admin/dist/static/js/app.2dd732d9.js.gz +0 -0
  114. package/modules/admin/index.html +16 -16
  115. package/modules/admin/package.json +101 -101
  116. package/modules/admin/src/App.vue +11 -11
  117. package/modules/admin/src/api/login.js +26 -26
  118. package/modules/admin/src/api/table.js +9 -9
  119. package/modules/admin/src/components/Breadcrumb/index.vue +79 -79
  120. package/modules/admin/src/components/Hamburger/index.vue +62 -62
  121. package/modules/admin/src/components/JSONEditor.vue +206 -180
  122. package/modules/admin/src/components/SvgIcon/index.vue +43 -43
  123. package/modules/admin/src/icons/index.js +9 -9
  124. package/modules/admin/src/icons/svgo.yml +22 -22
  125. package/modules/admin/src/main.js +42 -42
  126. package/modules/admin/src/permission.js +49 -49
  127. package/modules/admin/src/router/index.js +200 -200
  128. package/modules/admin/src/store/getters.js +11 -11
  129. package/modules/admin/src/store/index.js +17 -17
  130. package/modules/admin/src/store/modules/app.js +43 -43
  131. package/modules/admin/src/store/modules/user.js +104 -104
  132. package/modules/admin/src/styles/element-ui.scss +29 -29
  133. package/modules/admin/src/styles/index.scss +78 -78
  134. package/modules/admin/src/styles/mixin.scss +27 -27
  135. package/modules/admin/src/styles/sidebar.scss +133 -133
  136. package/modules/admin/src/styles/transition.scss +46 -46
  137. package/modules/admin/src/styles/variables.scss +4 -4
  138. package/modules/admin/src/utils/auth.js +15 -15
  139. package/modules/admin/src/utils/index.js +74 -74
  140. package/modules/admin/src/utils/request.js +47 -47
  141. package/modules/admin/src/utils/validate.js +31 -31
  142. package/modules/admin/src/views/404.vue +235 -235
  143. package/modules/admin/src/views/Dev.vue +33 -33
  144. package/modules/admin/src/views/EditDocument.vue +121 -121
  145. package/modules/admin/src/views/Endpoints.vue +279 -279
  146. package/modules/admin/src/views/Home.vue +84 -84
  147. package/modules/admin/src/views/Install.vue +79 -79
  148. package/modules/admin/src/views/ListDocuments.vue +72 -72
  149. package/modules/admin/src/views/ListDocuments2.vue +467 -467
  150. package/modules/admin/src/views/ManageListeners.vue +67 -67
  151. package/modules/admin/src/views/ManageMiddleware.vue +43 -43
  152. package/modules/admin/src/views/ManagePermissions.vue +75 -75
  153. package/modules/admin/src/views/ViewRequest.vue +77 -77
  154. package/modules/admin/src/views/form/index.vue +91 -91
  155. package/modules/admin/src/views/layout/Layout.vue +69 -69
  156. package/modules/admin/src/views/layout/components/AppMain.vue +41 -41
  157. package/modules/admin/src/views/layout/components/Navbar.vue +97 -97
  158. package/modules/admin/src/views/layout/components/Sidebar/Item.vue +29 -29
  159. package/modules/admin/src/views/layout/components/Sidebar/Link.vue +39 -39
  160. package/modules/admin/src/views/layout/components/Sidebar/SidebarItem.vue +103 -103
  161. package/modules/admin/src/views/layout/components/Sidebar/index.vue +62 -62
  162. package/modules/admin/src/views/layout/components/index.js +3 -3
  163. package/modules/admin/src/views/layout/mixin/ResizeHandler.js +41 -41
  164. package/modules/admin/src/views/login/index.vue +195 -195
  165. package/modules/admin/src/views/tree/index.vue +77 -77
  166. package/modules/collections/collections.js +39 -39
  167. package/modules/core/core.js +197 -197
  168. package/modules/logging/logging.js +88 -88
  169. package/modules/permissions/permissions.js +106 -106
  170. package/package.json +59 -59
  171. package/scripts/expressa +12 -12
  172. package/scripts/run_cypress_tests.sh +35 -35
  173. package/scripts/run_db_tests.sh +8 -8
  174. package/test/0-install.js +96 -96
  175. package/test/collections.js +431 -431
  176. package/test/collections.querying.js +288 -288
  177. package/test/db.js +258 -258
  178. package/test/db.strings.js +73 -73
  179. package/test/db.updating.js +186 -144
  180. package/test/logging.js +29 -29
  181. package/test/test.js +93 -93
  182. package/test/testserver.js +30 -30
  183. package/test/testutils.js +136 -136
  184. package/test/users.js +425 -425
  185. package/util.js +522 -522
  186. package/modules/admin/dist/css/197.7a90435e.css.gz +0 -0
  187. package/modules/admin/dist/css/430.8c9b0482.css.gz +0 -0
  188. package/modules/admin/dist/css/566.7a90435e.css.gz +0 -0
  189. package/modules/admin/dist/css/569.f7d5c7d5.css +0 -37
  190. package/modules/admin/dist/css/569.f7d5c7d5.css.gz +0 -0
  191. package/modules/admin/dist/css/572.74d8e965.css +0 -34
  192. package/modules/admin/dist/css/572.74d8e965.css.gz +0 -0
  193. package/modules/admin/dist/css/app.eba5f5e2.css.gz +0 -0
  194. package/modules/admin/dist/static/js/197.e511d91e.js +0 -1
  195. package/modules/admin/dist/static/js/197.e511d91e.js.gz +0 -0
  196. package/modules/admin/dist/static/js/430.b3941f30.js +0 -1
  197. package/modules/admin/dist/static/js/430.b3941f30.js.gz +0 -0
  198. package/modules/admin/dist/static/js/451.645974a8.js +0 -1
  199. package/modules/admin/dist/static/js/451.645974a8.js.gz +0 -0
  200. package/modules/admin/dist/static/js/460.962d5bc0.js +0 -1
  201. package/modules/admin/dist/static/js/460.962d5bc0.js.gz +0 -0
  202. package/modules/admin/dist/static/js/550.f27feb23.js +0 -1
  203. package/modules/admin/dist/static/js/550.f27feb23.js.gz +0 -0
  204. package/modules/admin/dist/static/js/556.1e08866a.js +0 -1
  205. package/modules/admin/dist/static/js/556.1e08866a.js.gz +0 -0
  206. package/modules/admin/dist/static/js/569.0fecfbee.js +0 -1
  207. package/modules/admin/dist/static/js/569.0fecfbee.js.gz +0 -0
  208. package/modules/admin/dist/static/js/572.13392e1d.js +0 -1
  209. package/modules/admin/dist/static/js/572.13392e1d.js.gz +0 -0
  210. package/modules/admin/dist/static/js/603.7b34a650.js +0 -1
  211. package/modules/admin/dist/static/js/603.7b34a650.js.gz +0 -0
  212. package/modules/admin/dist/static/js/651.564b24b6.js +0 -1
  213. package/modules/admin/dist/static/js/651.564b24b6.js.gz +0 -0
  214. package/modules/admin/dist/static/js/653.02ec1098.js +0 -1
  215. package/modules/admin/dist/static/js/653.02ec1098.js.gz +0 -0
  216. package/modules/admin/dist/static/js/750.50c950da.js +0 -1
  217. package/modules/admin/dist/static/js/750.50c950da.js.gz +0 -0
  218. package/modules/admin/dist/static/js/950.d4ff0a18.js +0 -1
  219. package/modules/admin/dist/static/js/950.d4ff0a18.js.gz +0 -0
  220. package/modules/admin/dist/static/js/app.083328f8.js +0 -2
  221. package/modules/admin/dist/static/js/app.083328f8.js.LICENSE.txt.gz +0 -0
  222. package/modules/admin/dist/static/js/app.083328f8.js.gz +0 -0
@@ -1,21 +1,21 @@
1
- version: 2
2
- jobs:
3
- build:
4
- docker:
5
- - image: circleci/node:16.13.0
6
- steps:
7
- - checkout
8
- - run:
9
- name: set npm registry
10
- command: 'npm config set registry https://registry.npmjs.org/'
11
- - run:
12
- name: install-npm
13
- command: npm install
14
- - run:
15
- name: test
16
- command: MOCHA_FILE=~/junit/mocha/results.xml npm run ci-test
17
- when: always
18
- - store_test_results:
19
- path: ~/junit
20
- - store_artifacts:
21
- path: ~/junit
1
+ version: 2
2
+ jobs:
3
+ build:
4
+ docker:
5
+ - image: circleci/node:16.13.0
6
+ steps:
7
+ - checkout
8
+ - run:
9
+ name: set npm registry
10
+ command: 'npm config set registry https://registry.npmjs.org/'
11
+ - run:
12
+ name: install-npm
13
+ command: npm install
14
+ - run:
15
+ name: test
16
+ command: MOCHA_FILE=~/junit/mocha/results.xml npm run ci-test
17
+ when: always
18
+ - store_test_results:
19
+ path: ~/junit
20
+ - store_artifacts:
21
+ path: ~/junit
package/.eslintrc.json CHANGED
@@ -1,29 +1,29 @@
1
- {
2
- "extends": "eslint:recommended",
3
- "ignorePatterns": ["node_modules", "modules/admin", "**/build/", "cypress"],
4
- "rules": {
5
- "no-var": "error",
6
- "prefer-const": "error",
7
- "no-console": ["error", { "allow": ["error"] }],
8
- "semi": ["error", "never"],
9
- "quotes": ["error", "single"],
10
- "quote-props": ["error", "as-needed"],
11
- "indent": ["error", 2, { "MemberExpression": 1 }],
12
- "linebreak-style": ["error", "unix"]
13
- },
14
- "globals": {
15
- "after": true,
16
- "before": true,
17
- "describe": true,
18
- "it": true,
19
- "xit": true,
20
- "xdescribe": true
21
- },
22
- "parserOptions": {
23
- "ecmaVersion": 12
24
- },
25
- "env": {
26
- "es6": true,
27
- "node": true
28
- }
29
- }
1
+ {
2
+ "extends": "eslint:recommended",
3
+ "ignorePatterns": ["node_modules", "modules/admin", "**/build/", "cypress"],
4
+ "rules": {
5
+ "no-var": "error",
6
+ "prefer-const": "error",
7
+ "no-console": ["error", { "allow": ["error"] }],
8
+ "semi": ["error", "never"],
9
+ "quotes": ["error", "single"],
10
+ "quote-props": ["error", "as-needed"],
11
+ "indent": ["error", 2, { "MemberExpression": 1 }],
12
+ "linebreak-style": ["error", "unix"]
13
+ },
14
+ "globals": {
15
+ "after": true,
16
+ "before": true,
17
+ "describe": true,
18
+ "it": true,
19
+ "xit": true,
20
+ "xdescribe": true
21
+ },
22
+ "parserOptions": {
23
+ "ecmaVersion": 12
24
+ },
25
+ "env": {
26
+ "es6": true,
27
+ "node": true
28
+ }
29
+ }
@@ -0,0 +1,19 @@
1
+ {
2
+ // Use IntelliSense to learn about possible attributes.
3
+ // Hover to view descriptions of existing attributes.
4
+ // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
5
+ "version": "0.2.0",
6
+ "configurations": [
7
+
8
+ {
9
+ "type": "node-terminal",
10
+ "name": "Run Script: test",
11
+ "request": "launch",
12
+ "command": "npm run test",
13
+ "cwd": "${workspaceFolder}",
14
+ "env": {
15
+ "TEST_POSTGRES": "true"
16
+ }
17
+ },
18
+ ]
19
+ }
package/LICENSE CHANGED
@@ -1,21 +1,21 @@
1
- MIT License
2
-
3
- Copyright (c) 2017 Thomas Hansen
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in all
13
- copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
- SOFTWARE.
1
+ MIT License
2
+
3
+ Copyright (c) 2017 Thomas Hansen
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,137 +1,137 @@
1
- ![](expressa.png)
2
- [![CircleCI](https://circleci.com/gh/thomas4019/expressa.svg?style=svg)](https://circleci.com/gh/thomas4019/expressa)
3
-
4
- ## data-driven extendable API middleware for Node.js/Express
5
-
6
- Expressa makes it easy to create basic APIs by using [JSON schema](http://json-schema.org):
7
-
8
- * django-like __admin interface__ for creating collection-__REST__ endpoints and managing permissions
9
- * collection schema's can be edited *and* added __through the admin interface__
10
- * re-use collection schema's in your frontend to generate forms
11
- * easily extendable so you can add complex features as well
12
- * define collections as [JSON schema](http://json-schema.org) instead of custom code
13
- * per-collection database storage: *MongoDB*, *PostgreSQL*, or *JSON-files* (useful for version control)
14
-
15
- > Best of all: it's just middleware, not a framework
16
-
17
- * mix-and-mash: easily throw in other express middleware and endpoints
18
- * decorate expressa-endpoints: add event listeners which stop/modify requests (responses)
19
-
20
- --------------------------------
21
-
22
- ## Getting Started
23
-
24
- It's very easy to install expressa in your project directory:
25
-
26
- mkdir myapp
27
- cd myapp
28
- npm init
29
- npm install expressa express
30
-
31
- Create a file `app.js` with the following code (or just copy the middle 3 lines into your existing express app)
32
-
33
- var express = require('express');
34
- var app = express();
35
-
36
- var expressa = require('expressa');
37
- app.use('/admin', expressa.admin({ apiurl: '/api/' }));
38
- app.use('/api', expressa.api());
39
-
40
- app.listen(3000, function () {
41
- console.log('Example app listening on port 3000!');
42
- });
43
-
44
- Now start the server by running `node --use-strict app.js` and navigate your browser to [http://localhost:3000/admin/](http://localhost:3000/admin/)
45
-
46
- ## API endpoints
47
-
48
- Once you add a collections in the admin interface, every collection will have the following endpoints:
49
-
50
- | method | endpoint | description |
51
- |--------|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52
- | POST | /users/login | expects JSON in the message body. e.g. `{"email": "email@example.com", password: "<the password>"} |
53
- | GET | /:collection | get an array of all documents in a collection |
54
- | GET | /:collection/:id | get a specific document |
55
- | GET | /:collection/?query={..} | get an array of documents matching the [mongo query](https://www.npmjs.com/package/mongo-query) |
56
- | GET | /:collection/?query={..}&limit=10&offset=10&orderby={"meta.created":1} | same as previous, but with targeted output control and sorting |
57
- | GET | /:collection/?query={..}&page=1&pageitems=10 | similar to previous, but with pagination support |
58
- | GET | /:collection/?query={..}&page=1&pageitems=10&pagemetadisable=1 | same as previous but *slightly* faster and with less pagination detail |
59
- | GET | /:collection/?query={..}&fields={..} | the fields param can be used to do a mongo projection to request only specific fields |
60
- | GET | /:collection/?fieldname=value | get an array of documents matching with the specified values. See [node-mongo-querystring](https://github.com/Turistforeningen/node-mongo-querystring) for details. |
61
- | GET | /:collection/schema | get the collection schema |
62
- | POST | /:collection/ | create a new document, the message body should be the JSON document |
63
- | PUT | /:collection/:id | replace the document with id. The message body should be the JSON document. If the _id in document is different (the old document _id is deleted and a new one with id is created.) |
64
- | POST | /:collection/:id/update | modify the document with id using a [mongo update query](https://docs.mongodb.com/manual/reference/method/db.collection.update/#update-parameter). The message body should be the update query |
65
- | DELETE | /:collection/:id | delete the document |
66
-
67
- > Supported Data: Only standard JSON (strings, numbers, booleans, null) is supported. Dates can be stored as strings using [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
68
-
69
- ## Documentation
70
-
71
- * Requests
72
- * [Querying](doc/querying.md)
73
- * [Making authenticated requests](doc/authentication.md)
74
- * [Pagination and sorting](doc/querying.md)
75
- * Collections
76
- * [Automatic fields](doc/automatic-fields.md)
77
- * Server-side implementation
78
- * [Modifying behavior using listeners](doc/listeners.md)
79
- * [Adding custom endpoints](doc/custom-endpoints.md)
80
- * [Accessing the database](doc/database.md)
81
- * Admin Panel
82
- * [Relationships](doc/relationships.md)
83
- * [Permissions](doc/permissions.md)
84
- * [Uploading files](doc/uploading-files.md)
85
- * [Testing / CI integrating your expressa app](doc/testing.md)
86
-
87
- # Folder Structure
88
- The Expressa configuration is in a folder called "data" in your project. There is a subfolder for the collections that you choose to persist to disk. By default, the following will be added once you finish the installation.
89
-
90
- | folder | purpose |
91
- |------------|--------------------------------------------------------------------------------------|
92
- | data/settings | Config file per environment. Can include custom variables specific to your project. |
93
- | data/role | List of roles in the permission system. Defaults to "Admin", "Anonymous" and "Authenticated". |
94
- | data/collection | JSON Schemas and settings for each collection. |
95
-
96
- Note: The files in these data folders are JSON so they can be manually updated or you can edit them in the Admin UI. Generally these files should be checked into version control.
97
-
98
- # Admin UI Examples/Screenshots
99
- * [Example: Creating a blog collection and post in the UI](doc/blogexample.md)
100
- * [Managing CRUD permissions in the UI](doc/permissions.md)
101
-
102
- ## Expressa ecosystem
103
- * [expressa-folder](https://npmjs.org/package/expressa-folder) easily extend expressa collections with ORM-ish js-code (get.js/post.js/functions.js/etc) & setup sub-endpoints
104
- * [expressa-swagger](https://npmjs.org/package/expressa-swagger) middleware to generate online api documentation
105
- * [expressa-client](https://npmjs.org/package/expressa-client) middleware to generate browser REST-client (+nodejs client)
106
- * [expressa-cli](https://npmjs.org/package/expressa-cli) commandline interface for expressa
107
-
108
- ## Roadmap
109
- * Automatic GraphQL Support
110
- * JWT token expiration
111
- * Support cookie based authentication as well
112
- * File uploads
113
-
114
- ## Alternatives
115
- Expressa is not primarily built for simple blog websites or mostly static content websites. For those a cms like Keystone.js and enduro.js could work or maybe you could build you site with a static site generator like Hugo. For database-driven websites that need a strong CRUD backend where you want a clear separation between the frontend and backend, expressa.js is a great choice.
116
-
117
- ## Changelog
118
-
119
- | Version | Important Changes |
120
- |---------|--------------------------------------------------------------------|
121
- | 0.5.3 | Fixes bug in install where enforce permissions wasn't activated. Fixes CSV download. |
122
- | 0.5.2 | Fixes bug when installing super user in Admin tool |
123
- | 0.5.1 | Includes built Admin UI in npm package |
124
- | 0.5.0 | Migrates server to use async/await. New Admin UI built with Vue.js. Adds request-id headers |
125
- | 0.4.6 | Fix some errors in the install process when choosing to store users in mongo or postgres |
126
- | 0.4.5 | Security update |
127
- | 0.4.1 | db.create (postgres) now returns the id instead of the full document. |
128
- | 0.4.0 | Pagination now starts with page 1. Delete requests can no longer bypass rejections by listeners. Updated permission error codes/messages. Error responses now always json (with an "error" field explaining) PUT /collection/:id response changed to match POST /collection |
129
- | 0.3.3 | Fixes security vulnerability with the "edit own" permission and the :collection/:id/update endpoint. Update immediately. |
130
- | 0.3.2 | Pagination is now supported by specifying the "page" and "limit" |
131
- | 0.3.1 | Makes "development" the default settings file instead of "production". Use NODE_ENV environmental variable to change this. To quickly migrate, just rename your settings file to "development". |
132
-
133
- ## Inspired by
134
-
135
- * [deployd](http://deployd.com/) (API design)
136
- * [Django](https://www.djangoproject.com/) (admin UI)
137
- * [Drupal](https://www.drupal.org/) (roles/permissions)
1
+ ![](expressa.png)
2
+ [![CircleCI](https://circleci.com/gh/thomas4019/expressa.svg?style=svg)](https://circleci.com/gh/thomas4019/expressa)
3
+
4
+ ## data-driven extendable API middleware for Node.js/Express
5
+
6
+ Expressa makes it easy to create basic APIs by using [JSON schema](http://json-schema.org):
7
+
8
+ * django-like __admin interface__ for creating collection-__REST__ endpoints and managing permissions
9
+ * collection schema's can be edited *and* added __through the admin interface__
10
+ * re-use collection schema's in your frontend to generate forms
11
+ * easily extendable so you can add complex features as well
12
+ * define collections as [JSON schema](http://json-schema.org) instead of custom code
13
+ * per-collection database storage: *MongoDB*, *PostgreSQL*, or *JSON-files* (useful for version control)
14
+
15
+ > Best of all: it's just middleware, not a framework
16
+
17
+ * mix-and-mash: easily throw in other express middleware and endpoints
18
+ * decorate expressa-endpoints: add event listeners which stop/modify requests (responses)
19
+
20
+ --------------------------------
21
+
22
+ ## Getting Started
23
+
24
+ It's very easy to install expressa in your project directory:
25
+
26
+ mkdir myapp
27
+ cd myapp
28
+ npm init
29
+ npm install expressa express
30
+
31
+ Create a file `app.js` with the following code (or just copy the middle 3 lines into your existing express app)
32
+
33
+ var express = require('express');
34
+ var app = express();
35
+
36
+ var expressa = require('expressa');
37
+ app.use('/admin', expressa.admin({ apiurl: '/api/' }));
38
+ app.use('/api', expressa.api());
39
+
40
+ app.listen(3000, function () {
41
+ console.log('Example app listening on port 3000!');
42
+ });
43
+
44
+ Now start the server by running `node --use-strict app.js` and navigate your browser to [http://localhost:3000/admin/](http://localhost:3000/admin/)
45
+
46
+ ## API endpoints
47
+
48
+ Once you add a collections in the admin interface, every collection will have the following endpoints:
49
+
50
+ | method | endpoint | description |
51
+ |--------|----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
52
+ | POST | /users/login | expects JSON in the message body. e.g. `{"email": "email@example.com", password: "<the password>"} |
53
+ | GET | /:collection | get an array of all documents in a collection |
54
+ | GET | /:collection/:id | get a specific document |
55
+ | GET | /:collection/?query={..} | get an array of documents matching the [mongo query](https://www.npmjs.com/package/mongo-query) |
56
+ | GET | /:collection/?query={..}&limit=10&offset=10&orderby={"meta.created":1} | same as previous, but with targeted output control and sorting |
57
+ | GET | /:collection/?query={..}&page=1&pageitems=10 | similar to previous, but with pagination support |
58
+ | GET | /:collection/?query={..}&page=1&pageitems=10&pagemetadisable=1 | same as previous but *slightly* faster and with less pagination detail |
59
+ | GET | /:collection/?query={..}&fields={..} | the fields param can be used to do a mongo projection to request only specific fields |
60
+ | GET | /:collection/?fieldname=value | get an array of documents matching with the specified values. See [node-mongo-querystring](https://github.com/Turistforeningen/node-mongo-querystring) for details. |
61
+ | GET | /:collection/schema | get the collection schema |
62
+ | POST | /:collection/ | create a new document, the message body should be the JSON document |
63
+ | PUT | /:collection/:id | replace the document with id. The message body should be the JSON document. If the _id in document is different (the old document _id is deleted and a new one with id is created.) |
64
+ | POST | /:collection/:id/update | modify the document with id using a [mongo update query](https://docs.mongodb.com/manual/reference/method/db.collection.update/#update-parameter). The message body should be the update query |
65
+ | DELETE | /:collection/:id | delete the document |
66
+
67
+ > Supported Data: Only standard JSON (strings, numbers, booleans, null) is supported. Dates can be stored as strings using [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
68
+
69
+ ## Documentation
70
+
71
+ * Requests
72
+ * [Querying](doc/querying.md)
73
+ * [Making authenticated requests](doc/authentication.md)
74
+ * [Pagination and sorting](doc/querying.md)
75
+ * Collections
76
+ * [Automatic fields](doc/automatic-fields.md)
77
+ * Server-side implementation
78
+ * [Modifying behavior using listeners](doc/listeners.md)
79
+ * [Adding custom endpoints](doc/custom-endpoints.md)
80
+ * [Accessing the database](doc/database.md)
81
+ * Admin Panel
82
+ * [Relationships](doc/relationships.md)
83
+ * [Permissions](doc/permissions.md)
84
+ * [Uploading files](doc/uploading-files.md)
85
+ * [Testing / CI integrating your expressa app](doc/testing.md)
86
+
87
+ # Folder Structure
88
+ The Expressa configuration is in a folder called "data" in your project. There is a subfolder for the collections that you choose to persist to disk. By default, the following will be added once you finish the installation.
89
+
90
+ | folder | purpose |
91
+ |------------|--------------------------------------------------------------------------------------|
92
+ | data/settings | Config file per environment. Can include custom variables specific to your project. |
93
+ | data/role | List of roles in the permission system. Defaults to "Admin", "Anonymous" and "Authenticated". |
94
+ | data/collection | JSON Schemas and settings for each collection. |
95
+
96
+ Note: The files in these data folders are JSON so they can be manually updated or you can edit them in the Admin UI. Generally these files should be checked into version control.
97
+
98
+ # Admin UI Examples/Screenshots
99
+ * [Example: Creating a blog collection and post in the UI](doc/blogexample.md)
100
+ * [Managing CRUD permissions in the UI](doc/permissions.md)
101
+
102
+ ## Expressa ecosystem
103
+ * [expressa-folder](https://npmjs.org/package/expressa-folder) easily extend expressa collections with ORM-ish js-code (get.js/post.js/functions.js/etc) & setup sub-endpoints
104
+ * [expressa-swagger](https://npmjs.org/package/expressa-swagger) middleware to generate online api documentation
105
+ * [expressa-client](https://npmjs.org/package/expressa-client) middleware to generate browser REST-client (+nodejs client)
106
+ * [expressa-cli](https://npmjs.org/package/expressa-cli) commandline interface for expressa
107
+
108
+ ## Roadmap
109
+ * Automatic GraphQL Support
110
+ * JWT token expiration
111
+ * Support cookie based authentication as well
112
+ * File uploads
113
+
114
+ ## Alternatives
115
+ Expressa is not primarily built for simple blog websites or mostly static content websites. For those a cms like Keystone.js and enduro.js could work or maybe you could build you site with a static site generator like Hugo. For database-driven websites that need a strong CRUD backend where you want a clear separation between the frontend and backend, expressa.js is a great choice.
116
+
117
+ ## Changelog
118
+
119
+ | Version | Important Changes |
120
+ |---------|--------------------------------------------------------------------|
121
+ | 0.5.3 | Fixes bug in install where enforce permissions wasn't activated. Fixes CSV download. |
122
+ | 0.5.2 | Fixes bug when installing super user in Admin tool |
123
+ | 0.5.1 | Includes built Admin UI in npm package |
124
+ | 0.5.0 | Migrates server to use async/await. New Admin UI built with Vue.js. Adds request-id headers |
125
+ | 0.4.6 | Fix some errors in the install process when choosing to store users in mongo or postgres |
126
+ | 0.4.5 | Security update |
127
+ | 0.4.1 | db.create (postgres) now returns the id instead of the full document. |
128
+ | 0.4.0 | Pagination now starts with page 1. Delete requests can no longer bypass rejections by listeners. Updated permission error codes/messages. Error responses now always json (with an "error" field explaining) PUT /collection/:id response changed to match POST /collection |
129
+ | 0.3.3 | Fixes security vulnerability with the "edit own" permission and the :collection/:id/update endpoint. Update immediately. |
130
+ | 0.3.2 | Pagination is now supported by specifying the "page" and "limit" |
131
+ | 0.3.1 | Makes "development" the default settings file instead of "production". Use NODE_ENV environmental variable to change this. To quickly migrate, just rename your settings file to "development". |
132
+
133
+ ## Inspired by
134
+
135
+ * [deployd](http://deployd.com/) (API design)
136
+ * [Django](https://www.djangoproject.com/) (admin UI)
137
+ * [Drupal](https://www.drupal.org/) (roles/permissions)
package/auth/index.js CHANGED
@@ -1,76 +1,76 @@
1
- const bcrypt = require('bcryptjs')
2
- const handler = require('./jwt')
3
-
4
- exports.isHashed = function (string) {
5
- return string && string.length === 60 && string[0] === '$'
6
- }
7
-
8
- exports.createHash = function (password) {
9
- const salt = bcrypt.genSaltSync(10)
10
- return bcrypt.hashSync(password, salt)
11
- }
12
-
13
- exports.isValidPassword = function (password, hashedPassword) {
14
- return bcrypt.compareSync(password, hashedPassword)
15
- }
16
-
17
- exports.doLogin = handler.doLogin
18
-
19
- exports.middleware = async function authMiddleware(req, res, next) {
20
- const key = req.query['access_key'] || req.headers['x-access-key']
21
- if (key) {
22
- if (typeof key == 'string' && req.db['access_keys']) {
23
- const accessKeys = await req.db['access_keys'].find({ key: { $eq: key } }, 0, 1)
24
- if (accessKeys && accessKeys.length > 0) {
25
- const accessKey = accessKeys[0]
26
- // check if access key is still valid
27
- if (accessKey.expires_at >= new Date().toISOString()) {
28
- let user
29
- try {
30
- user = await req.db[accessKey.user_collection].get(accessKey.user_id)
31
- } catch (e) {
32
- req.uerror = 'user no longer exists'
33
- }
34
- if (user && !req.uerror) {
35
- req.uid = user._id
36
- req.ucollection = 'users'
37
- req.user = user
38
- }
39
- }
40
- }
41
- } else {
42
- console.error('Non-string access key sent')
43
- }
44
- }
45
-
46
- req.query = req.query || {}
47
- const token = req.query['token'] || req.headers['x-access-token']
48
- delete req.query['token']
49
- delete req.headers['x-access-token']
50
- let payload
51
- try {
52
- payload = await handler.isLoggedIn(token, req.getSetting('jwt_secret'))
53
- }
54
- catch(e) {
55
- req.uerror = e.message
56
- }
57
- if (payload) {
58
- let user
59
- try {
60
- user = await req.db[payload.collection].get(payload._id)
61
- } catch (e) {
62
- req.uerror = 'user no longer exists'
63
- }
64
- if (user) {
65
- if (req.getSetting('jwt_expire_on_password_change') && user.meta.password_last_updated_at !== payload.timestamp) {
66
- req.uerror = 'jwt expired'
67
- }
68
- if (!req.uerror) {
69
- req.uid = payload._id
70
- req.ucollection = payload.collection
71
- req.user = user
72
- }
73
- }
74
- }
75
- next()
76
- }
1
+ const bcrypt = require('bcryptjs')
2
+ const handler = require('./jwt')
3
+
4
+ exports.isHashed = function (string) {
5
+ return string && string.length === 60 && string[0] === '$'
6
+ }
7
+
8
+ exports.createHash = function (password) {
9
+ const salt = bcrypt.genSaltSync(10)
10
+ return bcrypt.hashSync(password, salt)
11
+ }
12
+
13
+ exports.isValidPassword = function (password, hashedPassword) {
14
+ return bcrypt.compareSync(password, hashedPassword)
15
+ }
16
+
17
+ exports.doLogin = handler.doLogin
18
+
19
+ exports.middleware = async function authMiddleware(req, res, next) {
20
+ const key = req.query['access_key'] || req.headers['x-access-key']
21
+ if (key) {
22
+ if (typeof key == 'string' && req.db['access_keys']) {
23
+ const accessKeys = await req.db['access_keys'].find({ key: { $eq: key } }, 0, 1)
24
+ if (accessKeys && accessKeys.length > 0) {
25
+ const accessKey = accessKeys[0]
26
+ // check if access key is still valid
27
+ if (accessKey.expires_at >= new Date().toISOString()) {
28
+ let user
29
+ try {
30
+ user = await req.db[accessKey.user_collection].get(accessKey.user_id)
31
+ } catch (e) {
32
+ req.uerror = 'user no longer exists'
33
+ }
34
+ if (user && !req.uerror) {
35
+ req.uid = user._id
36
+ req.ucollection = 'users'
37
+ req.user = user
38
+ }
39
+ }
40
+ }
41
+ } else {
42
+ console.error('Non-string access key sent')
43
+ }
44
+ }
45
+
46
+ req.query = req.query || {}
47
+ const token = req.query['token'] || req.headers['x-access-token']
48
+ delete req.query['token']
49
+ delete req.headers['x-access-token']
50
+ let payload
51
+ try {
52
+ payload = await handler.isLoggedIn(token, req.getSetting('jwt_secret'))
53
+ }
54
+ catch(e) {
55
+ req.uerror = e.message
56
+ }
57
+ if (payload) {
58
+ let user
59
+ try {
60
+ user = await req.db[payload.collection].get(payload._id)
61
+ } catch (e) {
62
+ req.uerror = 'user no longer exists'
63
+ }
64
+ if (user) {
65
+ if (req.getSetting('jwt_expire_on_password_change') && user.meta.password_last_updated_at !== payload.timestamp) {
66
+ req.uerror = 'jwt expired'
67
+ }
68
+ if (!req.uerror) {
69
+ req.uid = payload._id
70
+ req.ucollection = payload.collection
71
+ req.user = user
72
+ }
73
+ }
74
+ }
75
+ next()
76
+ }