temba 0.7.2 → 0.7.6

package/dist/caching/middleware.js

@@ -0,0 +1,16 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.addCacheHeaders = addCacheHeaders;
+
+function addCacheHeaders(req, res, next) {
+  if (req.method == 'GET') {
+    res.set('Cache-control', "public, max-age=300");
+  } else {
+    res.set('Cache-control', "no-store");
+  }
+
+  return next();
+}

package/dist/server.js

@@ -21,6 +21,10 @@ var _queries = require("./queries");
 
 var _config = require("./config");
 
+var _cors = _interopRequireDefault(require("cors"));
+
+var _middleware2 = require("./caching/middleware");
+
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -29,13 +33,21 @@ function createServer(userConfig) {
   var config = (0, _config.initConfig)(userConfig);
   var queries = (0, _queries.createQueries)(config.connectionString);
   var app = (0, _express["default"])();
-  app.use((0, _express.json)());
-  app.use((0, _morgan["default"])('tiny'));
+  app.use((0, _express.json)()); // Add HTTP request logging.
+
+  app.use((0, _morgan["default"])('tiny')); // Enable CORS for all requests.
+
+  app.use((0, _cors["default"])({
+    origin: true,
+    credentials: true
+  })); // Serve a static folder, if configured.
 
   if (config.staticFolder) {
     app.use(_express["default"]["static"](config.staticFolder));
-  } // On the root URL (with apiPrefix if applicable) only a GET is allowed.
+  } // Add cache headers to every response.
+
 
+  app.use(_middleware2.addCacheHeaders); // On the root URL (with apiPrefix if applicable) only a GET is allowed.
 
   var rootPath = config.apiPrefix ? "".concat(config.apiPrefix) : '/';
   app.use(rootPath, _routes.rootRouter); // For all other URLs, only GET, POST, PUT and DELETE are allowed and handled.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "temba",
-  "version": "0.7.2",
-  "description": "",
+  "version": "0.7.6",
+  "description": "Get a simple MongoDB REST API with zero coding in less than 30 seconds (seriously).",
   "main": "dist/server.js",
   "scripts": {
     "build": "rm -rf dist && npx babel src --out-dir dist",
@@ -9,9 +9,10 @@
   },
   "repository": {
     "type": "git",
-    "url": "temba"
+    "url": "https://github.com/bouwe77/temba.git"
   },
-  "author": "Bouwe",
+  "homepage": "https://github.com/bouwe77/temba#readme",
+  "author": "Bouwe (https://bouwe.io)",
   "license": "ISC",
   "files": [
     "dist/**",
@@ -30,6 +31,7 @@
   "dependencies": {
     "@babel/runtime": "^7.15.4",
     "@rakered/mongo": "^1.6.0",
+    "cors": "^2.8.5",
     "express": "^4.17.1",
     "morgan": "^1.10.0"
   }

package/readme.md

@@ -33,9 +33,13 @@ Prerequisites you need to have:
 
 > Wthout a database, Temba also works. However, then data is kept in memory and flushed every time the server restarts.
 
-### Use the `temba-starter` project
+### Use `npx`
 
-Clone the [temba-starter](https://github.com/bouwe77/temba-starter) repo and you are up and running! Refer to the [Config settings overview](#config-settings-overview) section for configuration options.
+Create your own Temba server with the following command and you are up and running!
+
+```bash
+npx create-temba-server my-rest-api
+```
 
 ### Manually adding to an existing app
 
@@ -65,9 +69,9 @@ By passing a config object to the `create` function you can customize Temba's be
 
 Out of the box, Temba gives you a CRUD REST API to any resource name you can think of.
 
-Whether you `GET` either `/people`, `/movies`, `/pokemons`, or whatever, it all returns a `200 OK` with a `[]` JSON response. As soon as you `POST` a resource, then that will be returned upon a `GET` of that resource. You can also `DELETE`, or `PUT` resources by its ID, unless it does not exist of course.
+Whether you `GET` either `/people`, `/movies`, `/pokemons`, or whatever, it all returns a `200 OK` with a `[]` JSON response. As soon as you `POST` a new resource, followed by a `GET` of that resource, the new resource will be returned. You can also `DELETE`, or `PUT` resources by its ID.
 
-For a specific resource, in this case `/movies`, Temba supports the following requests:
+For a every resource, for example `/movies`, Temba supports the following requests:
 
 - `GET /movies` - Get all movies
 - `GET /movies/:id` - Get a movie by its ID
@@ -78,7 +82,7 @@ For a specific resource, in this case `/movies`, Temba supports the following re
 
 ### Supported HTTP methods
 
-Requests with an HTTP method that is not supported, everything but `GET`, `POST`, `PUT` and `DELETE`, will return a `405 Method Not Allowed` response.
+Requests with an HTTP method that is not supported, so everything but `GET`, `POST`, `PUT` and `DELETE`, a `405 Method Not Allowed` response will be returned.
 
 On the root URI (e.g. http://localhost:8080/) only a `GET` request is supported, which shows you a message indicating the API is working. All other HTTP methods on the root URI return a `405 Method Not Allowed` response.
 
@@ -108,12 +112,12 @@ Requests on these resources only give a `404 Not Found` if the ID does not exist
 
 ### JSON
 
+Temba only supports JSON. If you send a request with invalid formatted JSON, a `400 Bad Request` response is returned.
+
 When sending JSON data (`POST` and `PUT` requests), adding a `Content-Type: application/json` header is required.
 
 IDs are auto generated when creating resources. IDs in the JSON request body are ignored.
 
-Temba only supports JSON. If you send a request with invalid formatted JSON, a `400 Bad Request` response is returned.
-
 ### Static assets
 
 If you want to host static assets next to the REST API, configure the `staticFolder`:
@@ -123,7 +127,7 @@ const config = { staticFolder: 'build' }
 const server = temba.create(config)
 ```
 
-This way, you can create a REST API, and the web app consuming it, in one project.
+This way, you could create a REST API, and the web app consuming it, in one project.
 
 However, to avoid possible conflicts between the API resources and the routes in your web app you might want to add an `apiPrefix` to the REST API:
 
@@ -136,6 +140,10 @@ const config = { apiPrefix: 'api' }
 const server = temba.create(config)
 ```
 
+After configuring the `apiPrefix`, requests to the root URL will either return a `404 Not Found` or a `405 Method Not Allowed`, depending on the HTTP method.
+
+If you have configured both an `apiPrefix` and a `staticFolder`, a `GET` on the root URL will return the `index.html` in the `staticFolder`, if there is one.
+
 ### Config settings overview
 
 Configuring Temba is optional, it already works out of the box. None of the settings are applicable until you configure them:
@@ -193,10 +201,10 @@ Temba is built with JavaScript, Node, Express, Jest, Testing Library, Supertest,
 
 ## Which problem does Temba solve?
 
-The problem with JSON file solutions like json-server is the limitations you have when hosting your app.
+The problem with JSON file solutions like json-server is the limitations you have when hosting your app, because your data is stored in a file.
 
-For example, hosting json-server on GitHub Pages means your API is essentially readonly, because although mutations are supported, your data is not really persisted.
+For example, hosting json-server on GitHub Pages means your API is essentially readonly, because, although mutations are supported, your data is not really persisted.
 
 And hosting json-server on Heroku does give you persistence, but is not reliable because of its [ephemeral filesystem](https://devcenter.heroku.com/articles/dynos#ephemeral-filesystem).
 
-These limitations are of course the whole idea behind json-server, it's for mocking and prototyping. But if you want more (persistence wise) and don't mind having a database, although not yet very feature rich, you might want to try Temba.
+These limitations are of course the whole idea behind json-server, it's for simple mocking and prototyping. But if you want more (persistence wise) and don't mind having a database, you might want to try Temba.