remodel to typescript

.gitignore

@@ -1,6 +1,7 @@
 /node_modules/
 /coverage/
 /.nyc_output/
+/dist/
 
 # stryker temp files
 .stryker-tmp

dist/index.js

@@ -4,12 +4,9 @@
  * See file 'LICENSE' for full license details.
  * Created by Timo Hocker <timo@scode.ovh>, March 2020
  */
-
 /* eslint-disable no-console */
 /* eslint-disable no-sync */
-
 'use strict';
-
 const fs = require ('fs');
 const path = require ('path');
 
@@ -20,7 +17,6 @@ const path = require ('path');
  * @property {boolean} [verbose] enable verbose logging
  * @property {boolean} [rethrow] rethrow errors (default: true)
  */
-
 /**
  * @typedef {object} handler_description
  * @property {string} module_folder folder the module file is in
@@ -28,27 +24,29 @@ const path = require ('path');
  * @property {any} opts optional arguments
  * @property {boolean} rethrow should errors be rethrown
  */
-
 /**
  * wrap a requestor handler to be compatible with express
  *
+ * @param _a
  * @param {handler_description} data handler data
  * @returns {Function} requestor handler
  */
-function get_handler ({ module_folder, file, opts, rethrow }) {
+function get_handler (_a) {
+  const { module_folder } = _a;
+  const { file } = _a;
+  const { opts } = _a;
+  const { rethrow } = _a;
   // eslint-disable-next-line global-require
   const handler = require (path.join (process.cwd (), module_folder, file));
-
-  return (req, res, next) => new Promise (
-    (resolve) => resolve (handler (req, res, next, opts))
-  )
-    .catch ((e) => {
-      if (rethrow)
-        throw e;
-    });
+  return function (req, res, next) {
+    return new Promise ((resolve) => resolve (handler (req, res, next, opts)))
+      .catch ((e) => {
+        if (rethrow)
+          throw e;
+      });
+  };
 }
 
-
 /**
  * register a handler to the given app
  *
@@ -58,20 +56,10 @@ function get_handler ({ module_folder, file, opts, rethrow }) {
  * @param {string} url url to respond to
  * @param {boolean} verbose should verbose logging be enabled
  */
-function register_handler (
-  app,
-  handler_description,
-  method,
-  url,
-  verbose
-) {
+function register_handler (app, handler_description, method, url, verbose) {
   const handler = get_handler (handler_description);
-
-  if (verbose) {
-    console.log (
-      `[requestor info] redirecting ${url} to ${handler_description.file}`
-    );
-  }
+  if (verbose)
+    console.log (`[requestor info] redirecting ${url} to ${handler_description.file}`);
 
   switch (method) {
     case 'post':
@@ -90,11 +78,8 @@ function register_handler (
       app.all (url, handler);
       break;
     default:
-      if (verbose) {
-        console.warn (
-          `'${method}' did not match any request method, ignoring`
-        );
-      }
+      if (verbose)
+        console.warn (`'${method}' did not match any request method, ignoring`);
 
       break;
   }
@@ -107,38 +92,30 @@ function register_handler (
  * @param {string} module_folder folder that contains all modules
  * @param {options} options additional options
  */
-module.exports = function main (
-  app,
-  module_folder,
-  options = { opts: null, subdir: '', verbose: false, rethrow: true }
-) {
-  const { opts, subdir, verbose, rethrow } = options;
-
-  for (const file of fs.readdirSync (module_folder)) {
+module.exports = function main (app, module_folder, options) {
+  if (options === void 0)
+    options = { opts: null, subdir: '', verbose: false, rethrow: true };
+  const { opts } = options;
+  const { subdir } = options;
+  const { verbose } = options;
+  const { rethrow } = options;
+  for (let _i = 0, _a = fs.readdirSync (module_folder); _i < _a.length; _i++) {
+    const file = _a[_i];
     const regex = /(?<method>.*?)-(?<url>.*?)\.js/u;
     const { groups } = regex.exec (file);
-
     if (typeof subdir === 'undefined')
       groups.url = `/${groups.url}/`;
     else
       groups.url = `/${subdir}/${groups.url}/`;
-
     groups.url = groups.url
       .replace (/^\/[^/]*\/root/iu, '/')
       .replace (/\./gu, '/')
       .replace (/\/+/gu, '/');
-
-    register_handler (
-      app,
-      {
-        file,
-        module_folder,
-        opts,
-        rethrow
-      },
-      groups.method,
-      groups.url,
-      verbose
-    );
+    register_handler (app, {
+      file,
+      module_folder,
+      opts,
+      rethrow
+    }, groups.method, groups.url, verbose);
   }
 };

lib/handler_interfaces.ts

@@ -0,0 +1,27 @@
+export interface all_handler {
+  async handle_all_request(req: Request, res: Response): void
+}
+
+export interface delete_handler {
+  async handle_delete_request(req: Request, res: Response): void
+}
+
+export interface get_handler {
+  async handle_get_request(req: Request, res: Response): void
+}
+
+export interface head_handler {
+  async handle_head_request(req: Request, res: Response): void
+}
+
+export interface post_handler {
+  async handle_post_request(req: Request, res: Response): void
+}
+
+export interface put_handler {
+  async handle_put_request(req: Request, res: Response): void
+}
+
+export interface trace_handler {
+  async handle_trace_request(req: Request, res: Response): void
+}

lib/transaction.ts

@@ -0,0 +1,28 @@
+import consts from '@scode/consts';
+import {Request,Response} from 'express';
+
+class Transaction {
+  /* private */
+  private _req: Request;
+  private _res: Response;
+
+  /* public */
+  public status: number = -1;
+
+  /* properties */
+  public get has_status(): boolean => this.status !== -1;
+  public get req(): Request => this._req;
+  public get res(): Response => this._res;
+
+  /* constructor */
+  public Request(req: Request,res: Response) {
+    this._req = req;
+    this._res = res;
+  }
+
+  /* methods */
+  public end() {
+    if (this.status !== -1)
+      this.res.setHeader(this.status);
+  }
+}

package.json

@@ -2,7 +2,7 @@
   "name": "@scode/requestor",
   "version": "1.0.0",
   "description": "Split express paths into individual files to make api programming more structured",
-  "main": "index.js",
+  "main": "dist/index.js",
   "scripts": {
     "test": "nyc ava",
     "lint": "eslint .",
@@ -22,11 +22,15 @@
     "node": ">=10.0.0"
   },
   "devDependencies": {
-    "@scode/eslint-config": "^1.2.15",
-    "@stryker-mutator/core": "^3.0.2",
-    "@stryker-mutator/javascript-mutator": "^3.0.2",
-    "ava": "^3.4.0",
+    "@scode/eslint-config": "^1.2.31",
+    "@stryker-mutator/core": "^3.1.0",
+    "@stryker-mutator/javascript-mutator": "^3.1.0",
+    "ava": "^3.5.2",
     "eslint": "^6.8.0",
     "nyc": "^15.0.0"
+  },
+  "dependencies": {
+    "@scode/consts": "^1.0.12",
+    "@types/express": "^4.17.4"
   }
 }

stryker.conf.js

@@ -20,5 +20,5 @@ module.exports = {
   testRunner:       'command',
   transpilers:      [],
   coverageAnalysis: 'all',
-  mutate:           [ 'index.js' ]
+  mutate:           [ 'lib/*' ]
 };

tsconfig.json

@@ -0,0 +1,66 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es5",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+    "module": "commonjs",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./dist",                       /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true,                           /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+
+    /* Advanced Options */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}