temba 0.7.10 → 0.9.0

package/dist/routes/validator.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateRequestBody = void 0;
+const errors_1 = require("../errors");
+function validateRequestBody(validator, resourceName, requestBody) {
+    const validationResult = validator(resourceName, requestBody);
+    if (!validationResult)
+        return requestBody;
+    if (typeof validationResult === 'string') {
+        throw (0, errors_1.new400BadRequestError)(validationResult);
+    }
+    // The requestBody was replaced by something else.
+    if (validationResult)
+        requestBody = validationResult;
+    return requestBody;
+}
+exports.validateRequestBody = validateRequestBody;
+//# sourceMappingURL=validator.js.map

package/dist/routes/validator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"validator.js","sourceRoot":"","sources":["../../src/routes/validator.ts"],"names":[],"mappings":";;;AAAA,sCAAiD;AAEjD,SAAS,mBAAmB,CAAC,SAAS,EAAE,YAAY,EAAE,WAAW;IAC/D,MAAM,gBAAgB,GAAG,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAA;IAE7D,IAAI,CAAC,gBAAgB;QAAE,OAAO,WAAW,CAAA;IAEzC,IAAI,OAAO,gBAAgB,KAAK,QAAQ,EAAE;QACxC,MAAM,IAAA,8BAAqB,EAAC,gBAAgB,CAAC,CAAA;KAC9C;IAED,kDAAkD;IAClD,IAAI,gBAAgB;QAAE,WAAW,GAAG,gBAAgB,CAAA;IAEpD,OAAO,WAAW,CAAA;AACpB,CAAC;AAEQ,kDAAmB"}

package/dist/server.js

@@ -1,80 +1,77 @@
 "use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-var _typeof = require("@babel/runtime/helpers/typeof");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
 });
-exports.create = create;
-
-var _express = _interopRequireWildcard(require("express"));
-
-var _morgan = _interopRequireDefault(require("morgan"));
-
-var _middleware = require("./errors/middleware");
-
-var _routes = require("./routes");
-
-var _queries = require("./queries");
-
-var _config = require("./config");
-
-var _cors = _interopRequireDefault(require("cors"));
-
-var _middleware2 = require("./delay/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; }
-
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.create = void 0;
+const express_1 = __importStar(require("express"));
+const morgan_1 = __importDefault(require("morgan"));
+const middleware_1 = require("./errors/middleware");
+const routes_1 = require("./routes");
+const queries_1 = require("./queries");
+const config_1 = require("./config");
+const cors_1 = __importDefault(require("cors"));
+const middleware_2 = require("./delay/middleware");
 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)()); // Add HTTP request logging.
-
-  app.use((0, _morgan["default"])('tiny')); // Enable CORS for all requests.
-
-  app.use((0, _cors["default"])({
-    origin: true,
-    credentials: true
-  }));
-
-  if (config.delay > 0) {
-    var delayMiddleware = (0, _middleware2.createDelayMiddleware)(config.delay);
-    app.use(delayMiddleware);
-  } // 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.
-
-
-  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.
-
-  var resourceRouter = (0, _routes.createResourceRouter)(queries, config);
-  var resourcePath = config.apiPrefix ? "".concat(config.apiPrefix, "*") : '*';
-  app.use(resourcePath, resourceRouter); // In case of an API prefix, GET, POST, PUT and DELETE requests to all other URLs return a 404 Not Found.
-
-  if (config.apiPrefix) {
-    app.get('*', _routes.handleNotFound);
-    app.post('*', _routes.handleNotFound);
-    app.put('*', _routes.handleNotFound);
-    app["delete"]('*', _routes.handleNotFound);
-  } // All other methods to any URL are not allowed.
-
-
-  app.all('*', _routes.handleMethodNotAllowed);
-  if (config.apiPrefix) app.all("".concat(config.apiPrefix, "*"), _routes.handleMethodNotAllowed); // Error middleware.
-
-  app.use(_middleware.errorHandler);
-  return app;
+    const config = (0, config_1.initConfig)(userConfig);
+    const queries = (0, queries_1.createQueries)(config.connectionString);
+    const app = (0, express_1.default)();
+    app.use((0, express_1.json)());
+    // Add HTTP request logging.
+    app.use((0, morgan_1.default)('tiny'));
+    // Enable CORS for all requests.
+    app.use((0, cors_1.default)({ origin: true, credentials: true }));
+    if (config.delay > 0) {
+        const delayMiddleware = (0, middleware_2.createDelayMiddleware)(config.delay);
+        app.use(delayMiddleware);
+    }
+    // Serve a static folder, if configured.
+    if (config.staticFolder) {
+        app.use(express_1.default.static(config.staticFolder));
+    }
+    // On the root URL (with apiPrefix if applicable) only a GET is allowed.
+    const rootPath = config.apiPrefix ? `${config.apiPrefix}` : '/';
+    app.use(rootPath, routes_1.rootRouter);
+    // For all other URLs, only GET, POST, PUT and DELETE are allowed and handled.
+    const resourceRouter = (0, routes_1.createResourceRouter)(queries, config);
+    const resourcePath = config.apiPrefix ? `${config.apiPrefix}*` : '*';
+    app.use(resourcePath, resourceRouter);
+    // In case of an API prefix, GET, POST, PUT and DELETE requests to all other URLs return a 404 Not Found.
+    if (config.apiPrefix) {
+        app.get('*', routes_1.handleNotFound);
+        app.post('*', routes_1.handleNotFound);
+        app.put('*', routes_1.handleNotFound);
+        app.delete('*', routes_1.handleNotFound);
+    }
+    // All other methods to any URL are not allowed.
+    app.all('*', routes_1.handleMethodNotAllowed);
+    if (config.apiPrefix)
+        app.all(`${config.apiPrefix}*`, routes_1.handleMethodNotAllowed);
+    // Error middleware.
+    app.use(middleware_1.errorHandler);
+    return app;
 }
-
 function create(userConfig) {
-  return createServer(userConfig);
-}
+    return createServer(userConfig);
+}
+exports.create = create;
+//# sourceMappingURL=server.js.map

package/dist/server.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.js","sourceRoot":"","sources":["../src/server.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAuC;AACvC,oDAA2B;AAC3B,oDAAkD;AAClD,qCAKiB;AACjB,uCAAyC;AACzC,qCAAqC;AACrC,gDAAuB;AACvB,mDAA0D;AAE1D,SAAS,YAAY,CAAC,UAAU;IAC9B,MAAM,MAAM,GAAG,IAAA,mBAAU,EAAC,UAAU,CAAC,CAAA;IAErC,MAAM,OAAO,GAAG,IAAA,uBAAa,EAAC,MAAM,CAAC,gBAAgB,CAAC,CAAA;IAEtD,MAAM,GAAG,GAAG,IAAA,iBAAO,GAAE,CAAA;IACrB,GAAG,CAAC,GAAG,CAAC,IAAA,cAAI,GAAE,CAAC,CAAA;IAEf,4BAA4B;IAC5B,GAAG,CAAC,GAAG,CAAC,IAAA,gBAAM,EAAC,MAAM,CAAC,CAAC,CAAA;IAEvB,gCAAgC;IAChC,GAAG,CAAC,GAAG,CAAC,IAAA,cAAI,EAAC,EAAE,MAAM,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;IAElD,IAAI,MAAM,CAAC,KAAK,GAAG,CAAC,EAAE;QACpB,MAAM,eAAe,GAAG,IAAA,kCAAqB,EAAC,MAAM,CAAC,KAAK,CAAC,CAAA;QAC3D,GAAG,CAAC,GAAG,CAAC,eAAe,CAAC,CAAA;KACzB;IAED,wCAAwC;IACxC,IAAI,MAAM,CAAC,YAAY,EAAE;QACvB,GAAG,CAAC,GAAG,CAAC,iBAAO,CAAC,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAA;KAC7C;IAED,wEAAwE;IACxE,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,EAAE,CAAC,CAAC,CAAC,GAAG,CAAA;IAC/D,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,mBAAU,CAAC,CAAA;IAE7B,8EAA8E;IAC9E,MAAM,cAAc,GAAG,IAAA,6BAAoB,EAAC,OAAO,EAAE,MAAM,CAAC,CAAA;IAC5D,MAAM,YAAY,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,GAAG,CAAA;IACpE,GAAG,CAAC,GAAG,CAAC,YAAY,EAAE,cAAc,CAAC,CAAA;IAErC,yGAAyG;IACzG,IAAI,MAAM,CAAC,SAAS,EAAE;QACpB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,uBAAc,CAAC,CAAA;QAC5B,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,uBAAc,CAAC,CAAA;QAC7B,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,uBAAc,CAAC,CAAA;QAC5B,GAAG,CAAC,MAAM,CAAC,GAAG,EAAE,uBAAc,CAAC,CAAA;KAChC;IAED,gDAAgD;IAChD,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,+BAAsB,CAAC,CAAA;IACpC,IAAI,MAAM,CAAC,SAAS;QAAE,GAAG,CAAC,GAAG,CAAC,GAAG,MAAM,CAAC,SAAS,GAAG,EAAE,+BAAsB,CAAC,CAAA;IAE7E,oBAAoB;IACpB,GAAG,CAAC,GAAG,CAAC,yBAAY,CAAC,CAAA;IAErB,OAAO,GAAG,CAAA;AACZ,CAAC;AAED,SAAgB,MAAM,CAAC,UAAU;IAC/B,OAAO,YAAY,CAAC,UAAU,CAAC,CAAA;AACjC,CAAC;AAFD,wBAEC"}

package/dist/urls/middleware.js

@@ -1,42 +1,30 @@
 "use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createResourceAndIdParser = createResourceAndIdParser;
-exports.createValidateResourceMiddleware = createValidateResourceMiddleware;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _urlParser = require("./urlParser");
-
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
-
-function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createValidateResourceMiddleware = exports.createResourceAndIdParser = void 0;
+const errors_1 = require("../errors");
+const urlParser_1 = require("./urlParser");
 function createResourceAndIdParser(apiPrefix) {
-  return function getResourceAndId(req, _, next) {
-    var url = req.baseUrl.replace(apiPrefix, '');
-    var urlInfo = (0, _urlParser.parseUrl)(url);
-    req.requestInfo = _objectSpread(_objectSpread({}, req.requestInfo), urlInfo);
-    return next();
-  };
+    return function getResourceAndId(req, _, next) {
+        const url = req.baseUrl.replace(apiPrefix, '');
+        let urlInfo = (0, urlParser_1.parseUrl)(url);
+        req.requestInfo = Object.assign(Object.assign({}, req.requestInfo), urlInfo);
+        return next();
+    };
 }
-
+exports.createResourceAndIdParser = createResourceAndIdParser;
 function createValidateResourceMiddleware(validateResources, resourceNames) {
-  return function validateResource(req, _, next) {
-    if (!validateResources) return next();
-    var resourceName = req.requestInfo.resourceName;
-    if (!resourceName) return next();
-
-    if (!resourceNames.includes(resourceName.toLowerCase())) {
-      var error = new Error("'".concat(resourceName, "' is an unknown resource"));
-      error.status = 404;
-      return next(error);
-    }
-
-    return next();
-  };
-}
+    return function validateResource(req, _, next) {
+        if (!validateResources)
+            return next();
+        const { resourceName } = req.requestInfo;
+        if (!resourceName)
+            return next();
+        if (!resourceNames.includes(resourceName.toLowerCase())) {
+            const error = (0, errors_1.new404NotFoundError)(`'${resourceName}' is an unknown resource`);
+            return next(error);
+        }
+        return next();
+    };
+}
+exports.createValidateResourceMiddleware = createValidateResourceMiddleware;
+//# sourceMappingURL=middleware.js.map

package/dist/urls/middleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middleware.js","sourceRoot":"","sources":["../../src/urls/middleware.ts"],"names":[],"mappings":";;;AAAA,sCAA+C;AAC/C,2CAAsC;AAEtC,SAAS,yBAAyB,CAAC,SAAS;IAC1C,OAAO,SAAS,gBAAgB,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI;QAC3C,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;QAC9C,IAAI,OAAO,GAAG,IAAA,oBAAQ,EAAC,GAAG,CAAC,CAAA;QAE3B,GAAG,CAAC,WAAW,mCAAQ,GAAG,CAAC,WAAW,GAAK,OAAO,CAAE,CAAA;QAEpD,OAAO,IAAI,EAAE,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AAqBQ,8DAAyB;AAnBlC,SAAS,gCAAgC,CAAC,iBAAiB,EAAE,aAAa;IACxE,OAAO,SAAS,gBAAgB,CAAC,GAAG,EAAE,CAAC,EAAE,IAAI;QAC3C,IAAI,CAAC,iBAAiB;YAAE,OAAO,IAAI,EAAE,CAAA;QAErC,MAAM,EAAE,YAAY,EAAE,GAAG,GAAG,CAAC,WAAW,CAAA;QAExC,IAAI,CAAC,YAAY;YAAE,OAAO,IAAI,EAAE,CAAA;QAEhC,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE;YACvD,MAAM,KAAK,GAAG,IAAA,4BAAmB,EAC/B,IAAI,YAAY,0BAA0B,CAC3C,CAAA;YACD,OAAO,IAAI,CAAC,KAAK,CAAC,CAAA;SACnB;QAED,OAAO,IAAI,EAAE,CAAA;IACf,CAAC,CAAA;AACH,CAAC;AAEmC,4EAAgC"}

package/dist/urls/urlParser.js

@@ -1,22 +1,13 @@
 "use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.parseUrl = parseUrl;
-
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseUrl = void 0;
 function parseUrl(url) {
-  if (!url || url && !url.trim()) return {
-    resourceName: null,
-    id: null
-  };
-  var urlSegments = url.split('/').filter(function (i) {
-    return i;
-  });
-  var resourceName = urlSegments.length > 0 ? urlSegments[0] : null;
-  var id = urlSegments.length > 1 ? urlSegments[1] : null;
-  return {
-    resourceName: resourceName,
-    id: id
-  };
-}
+    if (!url || (url && !url.trim()))
+        return { resourceName: null, id: null };
+    const urlSegments = url.split('/').filter((i) => i);
+    const resourceName = urlSegments.length > 0 ? urlSegments[0] : null;
+    const id = urlSegments.length > 1 ? urlSegments[1] : null;
+    return { resourceName, id };
+}
+exports.parseUrl = parseUrl;
+//# sourceMappingURL=urlParser.js.map

package/dist/urls/urlParser.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"urlParser.js","sourceRoot":"","sources":["../../src/urls/urlParser.ts"],"names":[],"mappings":";;;AAAA,SAAS,QAAQ,CAAC,GAAG;IACnB,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;QAAE,OAAO,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAA;IAEzE,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAA;IAEnD,MAAM,YAAY,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACnE,MAAM,EAAE,GAAG,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IAEzD,OAAO,EAAE,YAAY,EAAE,EAAE,EAAE,CAAA;AAC7B,CAAC;AAEQ,4BAAQ"}

package/package.json

@@ -1,11 +1,14 @@
 {
   "name": "temba",
-  "version": "0.7.10",
+  "version": "0.9.0",
   "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",
-    "start": "npx babel src --watch --out-dir dist"
+    "build": "tsc",
+    "start": "tsc && node dist/server.ts",
+    "test": "jest",
+    "lint": "eslint --ignore-path .eslintignore --ext .js,.ts .",
+    "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\""
   },
   "repository": {
     "type": "git",
@@ -20,16 +23,23 @@
     "!__tests__"
   ],
   "devDependencies": {
-    "@babel/core": "^7.15.5",
-    "@babel/node": "^7.15.4",
-    "@babel/plugin-transform-runtime": "^7.15.0",
-    "@babel/preset-env": "^7.15.4",
-    "babel-core": "^7.0.0-bridge.0",
-    "jest": "^27.1.0",
-    "jest-extended": "^0.11.5"
+    "@types/cors": "^2.8.12",
+    "@types/express": "^4.17.13",
+    "@types/jest": "^27.4.0",
+    "@types/morgan": "^1.9.3",
+    "@types/supertest": "^2.0.11",
+    "@typescript-eslint/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/parser": "^5.10.0",
+    "eslint": "^8.7.0",
+    "eslint-config-prettier": "^8.3.0",
+    "jest": "^27.4.7",
+    "jest-extended": "^0.11.5",
+    "prettier": "^2.5.1",
+    "supertest": "^6.2.2",
+    "ts-jest": "^27.1.3",
+    "typescript": "^4.5.5"
   },
   "dependencies": {
-    "@babel/runtime": "^7.15.4",
     "@rakered/mongo": "^1.6.0",
     "connect-pause": "^0.1.0",
     "cors": "^2.8.5",

package/readme.md

@@ -1,214 +0,0 @@
-# Temba
-
-**Get a simple MongoDB REST API with zero coding in less than 30 seconds (seriously).**
-
-For developers who need a quick backend for small projects.
-
-Powered by NodeJS, Express and MongoDB.
-
-This project is inspired by the fantastic [json-server](https://github.com/typicode/json-server) project, but instead of a JSON file Temba uses a real database. The goal, however, is the same: Get you started with a REST API very quickly.
-
-## Table of contents
-
-[Temba?](#temba-1)
-
-[Getting Started](#getting-started)
-
-[Usage](#usage)
-
-## Temba?
-
-> _"Temba, at rest"_
-
-A metaphor for the declining of a gift, from the [Star Trek - The Next Generation, episode "Darmok"](https://memory-alpha.fandom.com/wiki/Temba).
-
-In the fictional Tamarian language the word _"Temba"_ means something like _"gift"_.
-
-## Getting Started
-
-Prerequisites you need to have:
-
-- Node, NPM
-- Optional: A MongoDB database, either locally or in the cloud
-
-> Wthout a database, Temba also works. However, then data is kept in memory and flushed every time the server restarts.
-
-### Use `npx`
-
-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
-
-If you don't want to (or can't) use the starter, add Temba to your app manually:
-
-1. `npm i temba`
-
-2. Example code to create a Temba server:
-
-```js
-import temba from ("temba");
-const server = temba.create();
-
-const port = process.env.PORT || 3000;
-server.listen(port, () => {
-  console.log(`Temba is running on port ${port}`);
-});
-```
-
-### Configuration
-
-By passing a config object to the `create` function you can customize Temba's behavior. Refer to the documentation below for the various possibilities.
-
-## Usage
-
-### Introduction
-
-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 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 every resource, for example `/movies`, Temba supports the following requests:
-
-- `GET /movies` - Get all movies
-- `GET /movies/:id` - Get a movie by its ID
-- `POST /movies` - Create a new movie
-- `PUT /movies/:id` - Update (fully replace) a movie by its ID
-- `DELETE /movies` - Delete all movies
-- `DELETE /movies/:id` - Delete a movie by its ID
-
-### Supported HTTP methods
-
-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.
-
-### MongoDB
-
-When starting Temba, you can send your requests to it immediately. However, then the data resides in memory and is flushed as soon as the server restarts. To persist your data, provide the `connectionString` config setting for your MongoDB database:
-
-```js
-const config = {
-  connectionString: 'mongodb://localhost:27017',
-}
-const server = temba.create(config)
-```
-
-For every resource you use in your requests a collection is created in the database. However, not until you actually store (create) a resource with a `POST`.
-
-### Allowing specific resources only
-
-If you only want to allow specific resource names, configure them by providing a `resourceNames` key in the config object when creating the Temba server:
-
-```js
-const config = { resourceNames: ['movies', 'actors'] }
-const server = temba.create(config)
-```
-
-Requests on these resources only give a `404 Not Found` if the ID does not exist. Requests on any other resource will always return a `404 Not Found`.
-
-### 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.
-
-### Static assets
-
-If you want to host static assets next to the REST API, configure the `staticFolder`:
-
-```js
-const config = { staticFolder: 'build' }
-const server = temba.create(config)
-```
-
-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:
-
-### REST URIs prefixes
-
-With the `apiPrefix` config setting, all REST resources get an extra path segment in front of them. If the `apiPrefix` is `'api'`, then `/movies/12345` becomes `/api/movies/12345`:
-
-```js
-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 used until you configure them:
-
-```js
-const config = {
-  resourceNames: ['movies', 'actors'],
-  connectionString: 'mongodb://localhost:27017',
-  staticFolder: 'build',
-  apiPrefix: 'api',
-  cacheControl: 'public, max-age=300',
-  delay: 500,
-}
-const server = temba.create(config)
-```
-
-These are all the possible settings:
-
-| Config setting     | Description                                                                                |
-| :----------------- | :----------------------------------------------------------------------------------------- |
-| `resourceNames`    | See [Allowing specific resources only](#allowing-specific-resources-only)                  |
-| `connectionString` | See [MongoDB](#mongodb)                                                                    |
-| `staticFolder`     | See [Static assets](#static-assets)                                                        |
-| `apiPrefix`        | See [REST URIs prefixes](#rest-uris-prefixes)                                              |
-| `cacheControl`     | The `Cache-control` response header value for each GET request.                            |
-| `delay`            | After processing the request, the delay in milliseconds before the request should be sent. |
-
-## Not supported (yet?)
-
-Temba is still very basic. It does not have any model validation, so you can store your resources in any format you like.
-
-So creating the following two (very different) movies is perfectly fine:
-
-```
-POST /movies
-{
-    "title": "O Brother, Where Art Thou?",
-    "description": "In the deep south during the 1930s, three escaped convicts search for hidden treasure while a relentless lawman pursues them."
-}
-
-POST /movies
-{
-    "foo": "bar",
-    "baz": "boo"
-}
-```
-
-Partial updates using `PATCH`, or other HTTP methods are not (yet?) supported.
-
-Temba offers no ways for authentication or authorization (yet?), so if someone knows how to reach the API, they can read and mutate all your data, unless you restrict this in another way.
-
-Also nested (parent-child) routes are not supported (yet?), so every URI has the /:resource/:id structure and there is no way to indicate any relation, apart from within the JSON itself perhaps.
-
-And there is no filtering, sorting, searching, custom routes, etc. (yet?).
-
-## Under the hood
-
-Temba is built with JavaScript, Node, Express, Jest, Testing Library, Supertest, and [@rakered/mongo](https://www.npmjs.com/package/@rakered/mongo).
-
-## Which problem does Temba solve?
-
-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.
-
-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 simple mocking and prototyping. But if you want more (persistence wise) and don't mind having a database, you might want to try Temba.