[Issue #183] Move getValidationConstraints() to exported module

Author: DrewImm

CHANGELOG.md

@@ -4,9 +4,11 @@
 
 ### Additions
 - [Issue #187] Add HttpClient::request for proxy
+- [Issue #183] Move getValidationConstraints() to exported module
 
 ### Fixes
 - npm update
+- Cleaned up query-tools
 
 ## [3.0.3] Jul-23-2019
 

src/query-tools.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/get-validation-constraints.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/query-validator.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

test/spec/api/query-tools/get-validation-constraints.spec.ts

@@ -0,0 +1,29 @@
+import { getValidationConstraints } from '../../../../src/query-tools';
+import { User } from '../../../examples/terms/models/user';
+
+/**
+ * getValidationConstraints()
+ * pointyapi/query-tools
+ */
+describe('[QueryTools] getValidationConstraints()', () => {
+	it('returns a map of constraints for model', () => {
+		const constraints = getValidationConstraints(User);
+
+		expect(constraints).toEqual(jasmine.any(Object));
+		expect('username' in constraints).toBe(true);
+		expect(constraints.username.isAlphanumeric).toBe(true);
+	});
+
+	it('returns constraint for specific key', () => {
+		const constraints = getValidationConstraints(User, 'username');
+
+		expect(constraints).toEqual(jasmine.any(Object));
+		expect(constraints.isAlphanumeric).toBe(true);
+	});
+
+	it('returns false if key has no constraints', () => {
+		const constraints = getValidationConstraints(User, 'id');
+
+		expect(constraints).toBe(false);
+	});
+});