temba 0.8.1 → 0.10.1

package/README.md

@@ -1,9 +1,8 @@
 # Temba
 
+[![Temba on NPM](https://img.shields.io/npm/v/temba)](https://www.npmjs.com/package/temba)
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-
 [![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)
-
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 **Get a simple MongoDB REST API with zero coding in less than 30 seconds (seriously).**
@@ -20,6 +19,8 @@ This project is inspired by the fantastic [json-server](https://github.com/typic
 
 [Getting Started](#getting-started)
 
+[What Tema does](#what-temba-does)
+
 [Usage](#usage)
 
 ## Temba?
@@ -39,7 +40,7 @@ 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 `npx`
+### Use the starter with `npx`
 
 Create your own Temba server with the following command and you are up and running!
 
@@ -47,7 +48,7 @@ Create your own Temba server with the following command and you are up and runni
 npx create-temba-server my-rest-api
 ```
 
-With this command you clone the [Temba-starter](https://github.com/bouwe77/temba-starter) repository and install all dependencies.
+This command clones the [Temba-starter](https://github.com/bouwe77/temba-starter) repository and installs all dependencies.
 
 ### Manually adding to an existing app
 
@@ -71,9 +72,7 @@ server.listen(port, () => {
 
 By passing a config object to the `create` function you can customize Temba's behavior. Refer to the [config settings](#config-settings-overview) below for the various possibilities.
 
-## Usage
-
-### Introduction
+## What Temba does
 
 Out of the box, Temba gives you a CRUD REST API to any resource name you can think of.
 
@@ -94,9 +93,21 @@ The HTTP methods that are supported are `GET`, `POST`, `PUT` and `DELETE`. For a
 
 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
+### JSON
+
+Temba supports JSON only.
+
+Request bodies sent with a `POST` and `PUT` requests are valid when the request body is either empty, or when it's valid formatted JSON. Adding a `Content-Type: application/json` header is required. If you send a request with invalid formatted JSON, a `400 Bad Request` response is returned.
+
+Any valid formatted JSON is accepted and stored. If you want to validate or even change the JSON in the request bodies, check out the [`requestBodyValidator`](#request-body-validation-or-mutation) callbacks.
+
+IDs are auto generated when creating resources. IDs in the JSON request body are ignored for any request.
 
-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:
+## Usage
+
+### In-memory or MongoDB
+
+By default data is stored in memory. This means the data is flushed when the server restarts. To persist your data, provide the `connectionString` config setting for your MongoDB database:
 
 ```js
 const config = {
@@ -118,14 +129,6 @@ 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`:
@@ -179,13 +182,13 @@ If you want to do input validation before the `POST` or `PUT` request body is sa
 ```js
 const config = {
   requestBodyValidator: {
-    post: (resourceName, requestBody) {
+    post: (resourceName, requestBody) => {
       // Validate, or even change the requestBody
     },
-    put: (resourceName, requestBody) {
+    put: (resourceName, requestBody) => {
       // Validate, or even change the requestBody
-    }
-  }
+    },
+  },
 }
 
 const server = temba.create(config)
@@ -206,16 +209,21 @@ Example:
 ```js
 const config = {
   requestBodyValidator: {
-    post: (resourceName, requestBody) {
+    post: (resourceName, requestBody) => {
       // Do not allow Pokemons to be created: 400 Bad Request
-      if (resourceName === 'pokemons') return 'You are not allowed to create new Pokemons'
+      if (resourceName === 'pokemons')
+        return 'You are not allowed to create new Pokemons'
 
       // Add a genre to Star Trek films:
-      if (resourceName === 'movies' && requestBody.title.startsWith('Star Trek')) return {...requestBody, genre: 'Science Fiction'}
+      if (
+        resourceName === 'movies' &&
+        requestBody.title.startsWith('Star Trek')
+      )
+        return { ...requestBody, genre: 'Science Fiction' }
 
       // If you end up here, void will be returned, so the request will just be saved.
     },
-  }
+  },
 }
 
 const server = temba.create(config)
@@ -236,13 +244,13 @@ const config = {
   cacheControl: 'public, max-age=300',
   delay: 500,
   requestBodyValidator: {
-    post: (resourceName, requestBody) {
+    post: (resourceName, requestBody) => {
       // Validate, or even change the requestBody
     },
-    put: (resourceName, requestBody) {
+    put: (resourceName, requestBody) => {
       // Validate, or even change the requestBody
-    }
-  }
+    },
+  },
 }
 const server = temba.create(config)
 ```

package/package.json

@@ -1,11 +1,13 @@
 {
   "name": "temba",
-  "version": "0.8.1",
+  "version": "0.10.1",
   "description": "Get a simple MongoDB REST API with zero coding in less than 30 seconds (seriously).",
-  "main": "dist/server.js",
+  "main": "dist/server.ts",
   "scripts": {
-    "build": "rm -rf dist && npx babel src --out-dir dist",
-    "start": "npx babel src --watch --out-dir dist"
+    "build": "rm -rf dist && tsc && cp package.json README.md ./dist",
+    "test": "jest --watch",
+    "lint": "eslint --ignore-path .gitignore --ext .js,.ts .",
+    "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\""
   },
   "repository": {
     "type": "git",
@@ -17,19 +19,26 @@
   "files": [
     "dist/**",
     "package.json",
-    "!__tests__"
+    "!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/dist/config/index.js

@@ -1,78 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.initConfig = initConfig;
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-var _logging = require("../logging");
-
-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; }
-
-var defaultConfig = {
-  resourceNames: [],
-  validateResources: false,
-  logLevel: _logging.logLevels.DEBUG,
-  staticFolder: null,
-  apiPrefix: '',
-  connectionString: null,
-  cacheControl: 'no-store',
-  delay: 0,
-  requestBodyValidator: {
-    post: function post() {},
-    put: function put() {}
-  }
-};
-
-function initConfig(userConfig) {
-  if (!userConfig) return defaultConfig;
-
-  var config = _objectSpread({}, defaultConfig);
-
-  if (userConfig.resourceNames && userConfig.resourceNames.length > 0) {
-    config.resourceNames = userConfig.resourceNames;
-    config.validateResources = true;
-  }
-
-  if (userConfig.logLevel && userConfig.logLevel.length !== 0 && Object.keys(_logging.logLevels).includes(userConfig.logLevel.toUpperCase())) {
-    config.logLevel = userConfig.logLevel.toUpperCase();
-  }
-
-  if (userConfig.staticFolder) {
-    config.staticFolder = userConfig.staticFolder.replace(/[^a-zA-Z0-9]/g, '');
-  }
-
-  if (userConfig.apiPrefix) {
-    config.apiPrefix = '/' + userConfig.apiPrefix.replace(/[^a-zA-Z0-9]/g, '') + '/';
-  }
-
-  if (userConfig.connectionString && userConfig.connectionString.length > 0) {
-    config.connectionString = userConfig.connectionString;
-  }
-
-  if (userConfig.cacheControl && userConfig.cacheControl.length > 0) {
-    config.cacheControl = userConfig.cacheControl;
-  }
-
-  if (userConfig.delay && userConfig.delay.length !== 0 && typeof Number(userConfig.delay) === 'number' && Number(userConfig.delay) > 0 && Number(userConfig.delay) < 10000) {
-    config.delay = Number(userConfig.delay);
-  }
-
-  if (userConfig.requestBodyValidator) {
-    if (userConfig.requestBodyValidator.post && typeof userConfig.requestBodyValidator.post === 'function') {
-      config.requestBodyValidator.post = userConfig.requestBodyValidator.post;
-    }
-
-    if (userConfig.requestBodyValidator.put && typeof userConfig.requestBodyValidator.put === 'function') {
-      config.requestBodyValidator.put = userConfig.requestBodyValidator.put;
-    }
-  }
-
-  return config;
-}

package/dist/delay/middleware.js

@@ -1,16 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createDelayMiddleware = createDelayMiddleware;
-
-var pause = require('connect-pause');
-
-function createDelayMiddleware(delay) {
-  return function (req, res, next) {
-    console.log('Start delay...');
-    pause(delay)(req, res, next);
-    console.log('Delay finished!');
-  };
-}

package/dist/errors/index.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.new404NotFoundError = new404NotFoundError;
-exports.new400BadRequestError = new400BadRequestError;
-
-function new404NotFoundError() {
-  var message = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'Not Found';
-  var error = new Error(message);
-  error.status = 404;
-  return error;
-}
-
-function new400BadRequestError() {
-  var message = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'Bad Request';
-  var error = new Error(message);
-  error.status = 400;
-  return error;
-}

package/dist/errors/middleware.js

@@ -1,14 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.errorHandler = errorHandler;
-
-function errorHandler(err, _, res, next) {
-  console.log('errorHandler: ' + err.message);
-  if (!err.status) err.status = 500;
-  return res.status(err.status).json({
-    message: err.message
-  });
-}

package/dist/logging/index.js

@@ -1,38 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createLogger = createLogger;
-exports.logLevels = void 0;
-var DEBUG = 'DEBUG';
-var INFO = 'INFO'; //TODO Add 'NONE'
-
-var logLevels = {
-  DEBUG: DEBUG,
-  INFO: INFO
-};
-exports.logLevels = logLevels;
-
-function createLogger(logLevel) {
-  return {
-    debug: function debug(message) {
-      try {
-        if (logLevel === DEBUG) console.log(new Date(), 'DEBUG -', message);
-      } catch (_unused) {//swallow exceptions during logging
-      }
-    },
-    info: function info(message) {
-      try {
-        if (logLevel === DEBUG || logLevel === INFO) console.info(new Date(), 'INFO  -', message);
-      } catch (_unused2) {//swallow exceptions during logging
-      }
-    },
-    error: function error(message) {
-      try {
-        console.error(new Date(), 'ERROR -', message);
-      } catch (_unused3) {//swallow exceptions during logging
-      }
-    }
-  };
-}

package/dist/queries/in-memory.js

@@ -1,96 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = void 0;
-
-var _toConsumableArray2 = _interopRequireDefault(require("@babel/runtime/helpers/toConsumableArray"));
-
-var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
-
-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; }
-
-var data = {};
-
-function connectToDatabase() {// do nothing
-}
-
-function getAll(resourceName) {
-  createResourceArrayIfNecessary(resourceName);
-  return new Promise(function (resolve) {
-    resolve(data[resourceName]);
-  });
-}
-
-function getById(resourceName, id) {
-  createResourceArrayIfNecessary(resourceName);
-  return new Promise(function (resolve) {
-    resolve(data[resourceName].find(function (item) {
-      return item.id === id;
-    }));
-  });
-}
-
-function create(resourceName, item) {
-  createResourceArrayIfNecessary(resourceName);
-
-  var newItem = _objectSpread(_objectSpread({}, item), {}, {
-    id: String(new Date().getTime())
-  });
-
-  data[resourceName] = [].concat((0, _toConsumableArray2["default"])(data[resourceName]), [newItem]);
-  return new Promise(function (resolve) {
-    resolve(newItem);
-  });
-}
-
-function update(resourceName, item) {
-  createResourceArrayIfNecessary(resourceName);
-
-  var updatedItem = _objectSpread({}, item);
-
-  data[resourceName] = [].concat((0, _toConsumableArray2["default"])(data[resourceName].filter(function (r) {
-    return r.id !== item.id;
-  })), [updatedItem]);
-  return new Promise(function (resolve) {
-    resolve(updatedItem);
-  });
-}
-
-function deleteById(resourceName, id) {
-  createResourceArrayIfNecessary(resourceName);
-  data[resourceName] = data[resourceName].filter(function (item) {
-    return item.id !== id;
-  });
-  return new Promise(function (resolve) {
-    resolve();
-  });
-}
-
-function deleteAll(resourceName) {
-  createResourceArrayIfNecessary(resourceName);
-  data[resourceName] = [];
-  return new Promise(function (resolve) {
-    resolve([]);
-  });
-}
-
-function createResourceArrayIfNecessary(resourceName) {
-  if (!data.hasOwnProperty(resourceName)) data[resourceName] = [];
-}
-
-var _default = {
-  connectToDatabase: connectToDatabase,
-  getAll: getAll,
-  getById: getById,
-  create: create,
-  update: update,
-  deleteById: deleteById,
-  deleteAll: deleteAll
-};
-exports["default"] = _default;

package/dist/queries/index.js

@@ -1,21 +0,0 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createQueries = createQueries;
-
-var _inMemory = _interopRequireDefault(require("./in-memory"));
-
-var _mongo = _interopRequireDefault(require("./mongo"));
-
-function createQueries(connectionString) {
-  if (!connectionString) {
-    return _inMemory["default"];
-  }
-
-  var mongoQueries = (0, _mongo["default"])(connectionString);
-  return mongoQueries;
-}