Merge pull request #188 from StatelessStudio/v3.1.0

[3.1.0] Aug-06-2019

Author: DrewImm

CHANGELOG.md

@@ -1,5 +1,16 @@
 # PointyApi Changelog
 
+## [3.1.0] Aug-06-2019
+
+### Additions
+- [Issue #187] Add HttpClient::request for proxy
+- [Issue #183] Move getValidationConstraints() to exported module
+
+### Fixes
+- npm update
+- Cleaned up query-tools
+- Move imports to query-tools
+
 ## [3.0.3] Jul-23-2019
 
 ### Fixes

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "pointyapi",
-	"version": "3.0.3",
+	"version": "3.1.0",
 	"author": "stateless-studio",
 	"license": "MIT",
 	"scripts": {
@@ -26,7 +26,7 @@
 		"@types/btoa": "^1.2.3",
 		"@types/express": "^4.17.0",
 		"@types/jsonwebtoken": "^7.2.8",
-		"@types/node": "^10.14.13",
+		"@types/node": "^10.14.14",
 		"@types/request": "^2.48.2",
 		"atob": "^2.1.2",
 		"bcryptjs": "^2.4.3",
@@ -35,11 +35,11 @@
 		"express": "^4.17.1",
 		"jsonwebtoken": "^8.5.1",
 		"mock-req-res": "^1.1.1",
-		"pg": "^7.11.0",
+		"pg": "^7.12.0",
 		"pg-connection-string": "^2.1.0",
 		"reflect-metadata": "^0.1.13",
 		"request": "^2.88.0",
-		"sinon": "^7.3.2",
+		"sinon": "^7.4.1",
 		"typeorm": "^0.2.18",
 		"validator": "^10.11.0"
 	},
@@ -51,7 +51,7 @@
 		"coveralls": "^3.0.5",
 		"jasmine": "^3.4.0",
 		"nyc": "^14.1.1",
-		"source-map-support": "^0.5.12",
+		"source-map-support": "^0.5.13",
 		"ts-node": "^7.0.1",
 		"tslint": "^5.18.0",
 		"tslint-eslint-rules": "^5.4.0",

package.json

@@ -16,6 +16,8 @@ import * as request from 'request';
 import { HttpClientResponse } from './http-client-response';
 
 export class HttpClient {
+	public request = request;
+
 	// Server URL
 	public url = 'http://localhost';
 
@@ -48,7 +50,7 @@ export class HttpClient {
 		}
 
 		return new Promise<HttpClientResponse>((accept, reject) => {
-			request(options, (error, response, body) => {
+			this.request(options, (error, response, body) => {
 				if (error) {
 					reject(new HttpClientResponse(response, error));
 				}
@@ -93,7 +95,7 @@ export class HttpClient {
 				options['auth'] = { bearer: `${bearer}` };
 			}
 
-			request(options, (error, response, body) => {
+			this.request(options, (error, response, body) => {
 				if (error) {
 					reject(new HttpClientResponse(response, error));
 				}
@@ -138,7 +140,7 @@ export class HttpClient {
 		}
 
 		return new Promise<HttpClientResponse>((accept, reject) => {
-			request(options, (error, response, body) => {
+			this.request(options, (error, response, body) => {
 				if (error) {
 					reject(new HttpClientResponse(response, error));
 				}
@@ -180,7 +182,7 @@ export class HttpClient {
 				options['auth'] = { bearer: `${bearer}` };
 			}
 
-			request(options, (error, response, body) => {
+			this.request(options, (error, response, body) => {
 				if (error) {
 					reject(new HttpClientResponse(response, error));
 				}

src/http/http-client.ts

@@ -7,6 +7,7 @@
 /**
  * Middleware
  */
+// TODO: Remove in v4 vvv
 export { getQuery } from './query-tools/get-query';
 export { loadEntity } from './middleware/load-entity';
 export { loadUser } from './middleware/load-user';

src/middleware.ts

@@ -0,0 +1,16 @@
+/**
+ * # Query Tools
+ *
+ * Query tools assist in processing incoming requests and querying the database
+ */
+
+/**
+ * Query Tools
+ */
+export { createSearchQuery } from './query-tools/create-search-query';
+export { getQuery } from './query-tools/get-query';
+export {
+	getValidationConstraints
+} from './query-tools/get-validation-constraints';
+export { queryTypes } from './query-tools/query-types';
+export { queryValidator } from './query-tools/query-validator';

src/query-tools.ts

@@ -1,8 +1,8 @@
 import { Request, Response } from 'express';
 import { getReadableFields, getBodyguardKeys } from '../bodyguard';
-import { UserRole } from '../enums/user-role';
 
 import { createSearchQuery } from '../utils';
+
 /**
  * Get the objects represented by the request query
  * @param request Request to query by

src/query-tools/get-query.ts

@@ -0,0 +1,49 @@
+import { MetadataStorage, getFromContainer } from 'class-validator';
+
+/**
+ * Get class-validator constraints for a class
+ * @param someClass BaseModel class(e.g `request.payloadType`)
+ * @param key (Optional) Key to get constraints for. If unset, constraints for
+ * 	all keys will be returned.
+ */
+export function getValidationConstraints(someClass: Function, key?: string) {
+	const container = <MetadataStorage>getFromContainer(MetadataStorage);
+	const metadata = container.getTargetValidationMetadatas(
+		someClass,
+		JSON.stringify(someClass)
+	);
+	const properties = container.groupByPropertyName(metadata);
+
+	const validators = Object.keys(properties).reduce((schema, property) => {
+		schema[property] = properties[
+			property
+		].reduce((propertySchema, { type, constraints }) => {
+			if (Array.isArray(constraints) && constraints.length === 1) {
+				constraints = constraints[0];
+			}
+
+			if (typeof constraints === 'undefined') {
+				propertySchema[type] = true;
+			}
+			else {
+				propertySchema[type] = constraints;
+			}
+
+			return propertySchema;
+		}, {});
+
+		return schema;
+	}, {});
+
+	if (key) {
+		if (key in validators) {
+			return validators[key];
+		}
+		else {
+			return false;
+		}
+	}
+	else {
+		return validators;
+	}
+}

src/query-tools/get-validation-constraints.ts

@@ -2,59 +2,8 @@ import { Request, Response } from 'express';
 import { isKeyInModel } from '../utils';
 import { queryTypes, queryTypeKeys } from './query-types';
 import { getReadableFields, getReadableRelations } from '../bodyguard';
-import {
-	validateSync,
-	MetadataStorage,
-	getFromContainer
-} from 'class-validator';
-
-/**
- * Get class-validator constraints for a class
- * @param someClass BaseModel class(e.g `request.payloadType`)
- * @param key (Optional) Key to get constraints for. If unset, constraints for
- * 	all keys will be returned.
- */
-function getValidationConstraints(someClass: Function, key?: string) {
-	const container = <MetadataStorage>getFromContainer(MetadataStorage);
-	const metadata = container.getTargetValidationMetadatas(
-		someClass,
-		JSON.stringify(someClass)
-	);
-	const properties = container.groupByPropertyName(metadata);
-
-	const validators = Object.keys(properties).reduce((schema, property) => {
-		schema[property] = properties[
-			property
-		].reduce((propertySchema, { type, constraints }) => {
-			if (Array.isArray(constraints) && constraints.length === 1) {
-				constraints = constraints[0];
-			}
-
-			if (typeof constraints === 'undefined') {
-				propertySchema[type] = true;
-			}
-			else {
-				propertySchema[type] = constraints;
-			}
-
-			return propertySchema;
-		}, {});
-
-		return schema;
-	}, {});
-
-	if (key) {
-		if (key in validators) {
-			return validators[key];
-		}
-		else {
-			return false;
-		}
-	}
-	else {
-		return validators;
-	}
-}
+import { validateSync } from 'class-validator';
+import { getValidationConstraints } from './get-validation-constraints';
 
 /**
  * Validate a GET query type

src/query-tools/query-validator.ts

@@ -1,5 +1,6 @@
 export { addResource } from './utils/add-resource';
 export { bindResponders } from './utils/bind-responders';
+// TODO: Remove in v4 vvv
 export { createSearchQuery } from './query-tools/create-search-query';
 export { createTimestamp } from './utils/create-timestamp';
 export { deleteUndefinedMembers } from './utils/delete-undefined-members';