Merge pull request #12 from tinacious/typescript-support

Typescript support

README.md

@@ -39,3 +39,11 @@ Test the 3 different types of validations using the tests and mock server:
 ```
 npm test
 ```
+
+### TypeScript
+
+Generate TypeScript definitions:
+
+```
+npm run tsc
+```

lib/validate.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="hapi__joi" />
+import { Handler } from 'express';
+import { SchemaMap } from '@hapi/joi';
+interface Options {
+    params?: SchemaMap;
+    body?: SchemaMap;
+    query?: SchemaMap;
+}
+interface ExpressJoiValidate {
+    (schemaOptions: Options): Handler;
+}
+/**
+ * Route validation using Joi
+ * Takes a schema with properties defined using Joi:
+ *  - params
+ *  - body
+ *  - query
+ * Validates the request properties specified in the schema
+ * @param {Object} schema { params, body, query }
+ */
+declare const validate: ExpressJoiValidate;
+export default validate;
+//# sourceMappingURL=validate.d.ts.map

lib/validate.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var Joi = require('@hapi/joi');
+/**
+ * Route validation using Joi
+ * Takes a schema with properties defined using Joi:
+ *  - params
+ *  - body
+ *  - query
+ * Validates the request properties specified in the schema
+ * @param {Object} schema { params, body, query }
+ */
+var validate = function (schema) { return function (req, res, next) {
+    if (!schema) {
+        return next();
+    }
+    var obj = {};
+    ['params', 'body', 'query']
+        .forEach(function (key) {
+        var k = key;
+        if (schema[k]) {
+            obj[k] = req[k];
+        }
+    });
+    var joiSchema = Joi.object(schema);
+    var error = joiSchema.validate(obj).error;
+    if (error) {
+        var field = error.details[0].path.join('.');
+        var message = error.details[0].message.replace(/"/g, "'");
+        return res.status(400).json({ message: message, field: field }).end();
+    }
+    return next();
+}; };
+// lolz required...
+// https://stackoverflow.com/questions/12696236/module-exports-in-typescript
+module.exports = validate;
+exports.default = validate;

package.json

@@ -1,10 +1,12 @@
 {
   "name": "express-joi-validate",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Simple route validation middleware for Express using Joi",
-  "main": "validate.js",
+  "main": "./lib/validate.js",
+  "types": "./lib/validate.d.ts",
   "scripts": {
     "test": "mocha tests/validate-test.js",
+    "tsc": "tsc",
     "coverage": "istanbul cover ./node_modules/mocha/bin/_mocha tests/validate-test.js",
     "coverage-ci": "npm run coverage && codecov"
   },
@@ -22,12 +24,16 @@
   "author": "Tina Holly",
   "license": "MIT",
   "devDependencies": {
+    "@types/express": "^4.17.6",
+    "@types/hapi__joi": "^17.1.3",
     "body-parser": "^1.18.3",
     "codecov": "^3.1.0",
-    "express": "^4.16.4",
+    "express": "^4.17.1",
     "istanbul": "^0.4.5",
     "mocha": "^6.0.2",
-    "supertest": "^4.0.0"
+    "supertest": "^4.0.0",
+    "tsc": "^1.20150623.0",
+    "typescript": "^3.9.6"
   },
   "resolutions": {
     "handlebars": "v4.1.2"

tests/mock-server.js

@@ -1,7 +1,7 @@
 const express = require('express');
 const Joi = require('@hapi/joi');
 
-const validate = require('../validate');
+const validate = require('../lib/validate');
 
 const app = express();
 

tsconfig.json

@@ -0,0 +1,69 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+
+    /* 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": "./lib",                        /* 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 */
+    "skipLibCheck": true,                     /* Skip type checking of declaration files. */
+    "forceConsistentCasingInFileNames": true  /* Disallow inconsistently-cased references to the same file. */
+  }
+}