Merge pull request #212 from StatelessStudio/v3.3.5

[3.3.5] May-02-2021

Author: DrewImm

CHANGELOG.md

@@ -1,5 +1,11 @@
 # PointyApi Changelog
 
+## [3.3.5] May-02-2021
+
+### Fixes
+- npm update
+- Fix typescript build errors
+
 ## [3.3.4] Mar-15-2021
 
 ### Fixes

package-lock.json

@@ -1,6 +1,6 @@
 {
 	"name": "pointyapi",
-	"version": "3.3.4",
+	"version": "3.3.5",
 	"author": "stateless-studio",
 	"license": "MIT",
 	"scripts": {
@@ -24,38 +24,38 @@
 	"dependencies": {
 		"@types/atob": "^2.1.2",
 		"@types/btoa": "^1.2.3",
-		"@types/express": "^4.17.3",
-		"@types/jsonwebtoken": "^8.3.8",
-		"@types/node": "^12.12.32",
-		"@types/request": "^2.48.4",
+		"@types/express": "^4.17.11",
+		"@types/jsonwebtoken": "^8.5.1",
+		"@types/node": "^12.20.11",
+		"@types/request": "^2.48.5",
 		"atob": "^2.1.2",
 		"bcryptjs": "^2.4.3",
 		"btoa": "^1.2.1",
 		"class-validator": "^0.11.1",
 		"express": "^4.17.1",
 		"jsonwebtoken": "^8.5.1",
-		"mock-req-res": "^1.1.4",
+		"mock-req-res": "^1.2.0",
 		"pg": "^7.18.2",
-		"pg-connection-string": "^2.2.0",
+		"pg-connection-string": "^2.5.0",
 		"reflect-metadata": "^0.1.13",
 		"request": "^2.88.2",
 		"sinon": "^7.5.0",
-		"typeorm": "^0.2.24",
+		"typeorm": "^0.2.32",
 		"validator": "^12.2.0"
 	},
 	"main": "./index.js",
 	"types": "./index.d.ts",
 	"devDependencies": {
 		"@istanbuljs/nyc-config-typescript": "^0.1.3",
-		"@types/jasmine": "^3.5.10",
-		"coveralls": "^3.0.11",
-		"jasmine": "^3.5.0",
+		"@types/jasmine": "^3.6.10",
+		"coveralls": "^3.1.0",
+		"jasmine": "^3.7.0",
 		"nyc": "^14.1.1",
-		"source-map-support": "^0.5.16",
-		"ts-node": "^8.8.1",
+		"source-map-support": "^0.5.19",
+		"ts-node": "^8.10.2",
 		"tslint": "^5.20.1",
 		"tslint-eslint-rules": "^5.4.0",
-		"typescript": "^3.8.3"
+		"typescript": "^3.9.9"
 	},
 	"description": "*\"Stop writing endpoints\"*",
 	"directories": {

package.json

@@ -37,6 +37,6 @@ export class BaseDb {
 
 	// Create database connection
 	public async connect(options: string | Object): Promise<any> {
-		return new Promise((accept) => accept());
+		return new Promise((accept) => accept(null));
 	}
 }

src/database/base-db.ts

@@ -26,10 +26,6 @@ export function basicCors(
 			let host = request.headers.origin;
 			const clientUrls = process.env.ALLOW_ORIGIN.split(', ');
 
-			if (host instanceof Array) {
-				host = host[0];
-			}
-
 			if (clientUrls.includes(host)) {
 				origin = host;
 			}

src/middleware/basic-cors.ts

@@ -2,6 +2,7 @@ import { Request, Response } from 'express';
 import { getReadableFields, getBodyguardKeys } from '../bodyguard';
 
 import { createSearchQuery } from '../utils';
+import { Query } from './query';
 
 /**
  * Get the objects represented by the request query
@@ -13,14 +14,16 @@ export async function getQuery(
 	request: Request,
 	response: Response
 ): Promise<any> {
-	if ('query' in request && 'id' in request.query && request.query.id) {
+	const requestQueryParams: Query = request.query;
+
+	if ('id' in requestQueryParams && requestQueryParams.id) {
 		// Read one
-		return request.repository.findOne(request.query.id);
+		return request.repository.findOne(requestQueryParams.id);
 	}
-	else if ('query' in request && Object.keys(request.query).length) {
+	else if (Object.keys(requestQueryParams).length) {
 		// Read query
 
-		const shouldCount = 'count' in request.query && request.query.count;
+		const shouldCount = 'count' in requestQueryParams && requestQueryParams.count;
 
 		// Readable keys
 		let readableFields = getReadableFields(
@@ -31,8 +34,8 @@ export async function getQuery(
 
 		// Extract select query keys
 		const selectKeys = [];
-		if ('select' in request.query) {
-			for (let key of request.query.select) {
+		if ('select' in requestQueryParams) {
+			for (let key of requestQueryParams.select) {
 				key = `obj.${key}`;
 				selectKeys.push(key);
 			}
@@ -41,8 +44,8 @@ export async function getQuery(
 		}
 
 		// Extract Join join query keys
-		if ('join' in request.query) {
-			request.query.join.forEach((key) => {
+		if ('join' in requestQueryParams) {
+			requestQueryParams.join.forEach((key) => {
 				if (!request.joinMembers.includes(key)) {
 					request.joinMembers.push(key);
 				}
@@ -51,15 +54,15 @@ export async function getQuery(
 
 		// Extract Group By query keys
 		const groupByKeys = [];
-		if ('groupBy' in request.query) {
-			request.query.groupBy.forEach((key) => {
+		if ('groupBy' in requestQueryParams) {
+			requestQueryParams.groupBy.forEach((key) => {
 				groupByKeys.push(key);
 			});
 
 			// Add 'id' to array if not already
 			if (
 				readableFields.includes('obj.id') &&
-				!('id' in request.query.groupBy)
+				!('id' in requestQueryParams.groupBy)
 			) {
 				groupByKeys.push('id');
 			}
@@ -68,11 +71,11 @@ export async function getQuery(
 		// Extract order By query keys
 		const orderByKeys = [];
 		const orderByOrders = [];
-		if ('orderBy' in request.query) {
-			for (const key in request.query.orderBy) {
+		if ('orderBy' in requestQueryParams) {
+			for (const key in requestQueryParams.orderBy) {
 				orderByKeys.push(key);
 				orderByOrders.push(
-					request.query.orderBy[key] === 'DESC' ? 'DESC' : 'ASC'
+					requestQueryParams.orderBy[key] === 'DESC' ? 'DESC' : 'ASC'
 				);
 			}
 		}
@@ -81,7 +84,7 @@ export async function getQuery(
 		// tslint:disable-next-line:prefer-const
 		let { queryString, queryParams } = createSearchQuery(
 			request.payloadType,
-			request.query
+			requestQueryParams
 		);
 
 		// Join bodyguard keys, unless this is the User
@@ -161,17 +164,17 @@ export async function getQuery(
 			}
 
 			// Add limit
-			if ('limit' in request.query && request.query.limit) {
-				query.take(request.query.limit);
+			if ('limit' in requestQueryParams && requestQueryParams.limit) {
+				query.take(requestQueryParams.limit);
 			}
 
 			// Add offset
-			if ('offset' in request.query && request.query.offset) {
-				query.skip(request.query.offset);
+			if ('offset' in requestQueryParams && requestQueryParams.offset) {
+				query.skip(requestQueryParams.offset);
 			}
 		}
 
-		if ('raw' in request.query && request.query.raw) {
+		if ('raw' in requestQueryParams && requestQueryParams.raw) {
 			return query.getRawMany();
 		}
 		else if (groupByKeys.length) {

src/query-tools/get-query.ts

@@ -4,6 +4,7 @@ import { queryTypes, queryTypeKeys } from './query-types';
 import { getReadableFields, getReadableRelations } from '../bodyguard';
 import { validateSync } from 'class-validator';
 import { getValidationConstraints } from './get-validation-constraints';
+import { Query } from './query';
 
 /**
  * Validate a GET query type
@@ -27,13 +28,15 @@ function queryFieldValidator(
 		request.user
 	);
 
-	if (type in request.query) {
-		if (request.query[type] instanceof Array) {
-			for (let i = 0; i < request.query[type].length; i++) {
-				const key = request.query[type][i];
+	const requestQueryParams: Query = request.query;
+
+	if (type in requestQueryParams) {
+		if (requestQueryParams[type] instanceof Array) {
+			for (let i = 0; i < requestQueryParams[type].length; i++) {
+				const key = requestQueryParams[type][i];
 
 				if (key === undefined) {
-					request.query[type].splice(i, 1);
+					requestQueryParams[type].splice(i, 1);
 
 					continue;
 				}
@@ -60,14 +63,14 @@ function queryFieldValidator(
 				}
 			}
 		}
-		else if (request.query[type] instanceof Object) {
+		else if (requestQueryParams[type] instanceof Object) {
 			const validators = getValidationConstraints(request.payloadType);
 
-			for (const key in request.query[type]) {
-				const value = request.query[type][key];
+			for (const key in requestQueryParams[type]) {
+				const value = requestQueryParams[type][key];
 
 				if (value === undefined) {
-					delete request.query[type][key];
+					delete requestQueryParams[type][key];
 
 					continue;
 				}
@@ -112,7 +115,7 @@ function queryFieldValidator(
 						const asInt = parseInt(value, 10);
 
 						if (!isNaN(asInt)) {
-							request.query[type][key] = asInt;
+							requestQueryParams[type][key] = asInt;
 						}
 					}
 				}
@@ -129,7 +132,7 @@ function queryFieldValidator(
 			) {
 				const testObject = Object.assign(
 					new request.payloadType(),
-					request.query[type]
+					requestQueryParams[type]
 				);
 
 				const validationErrors = validateSync(testObject, {
@@ -149,15 +152,15 @@ function queryFieldValidator(
 			);
 
 			if (validator && 'isInt' in validator && validator.isInt === true) {
-				const asInt = parseInt(request.query.id, 10);
+				const asInt = parseInt(`${requestQueryParams.id}`, 10);
 
 				if (!isNaN(asInt)) {
-					request.query.id = asInt;
+					requestQueryParams.id = asInt;
 				}
 			}
 
 			const testObject = Object.assign(new request.payloadType(), {
-				id: request.query[type]
+				id: requestQueryParams[type]
 			});
 
 			const validationErrors = validateSync(testObject, {
@@ -182,10 +185,12 @@ function queryFieldValidator(
  * @return Returns if the get query is valid
  */
 export function queryValidator(request: Request, response: Response): boolean {
-	for (const type in request.query) {
+	const requestQueryParams: Query = request.query;
+
+	for (const type in requestQueryParams) {
 		// Is this defined?
-		if (request.query[type] === undefined) {
-			delete request.query[type];
+		if (requestQueryParams[type] === undefined) {
+			delete requestQueryParams[type];
 
 			continue;
 		}
@@ -202,11 +207,11 @@ export function queryValidator(request: Request, response: Response): boolean {
 		}
 
 		// Is query type proper (array, object, etc)?
-		let queryTypeConstructor: string = typeof request.query[type];
+		let queryTypeConstructor: string = typeof requestQueryParams[type];
 
 		if (
 			queryTypeConstructor === 'object' &&
-			'length' in request.query[type]
+			'length' in requestQueryParams[type]
 		) {
 			queryTypeConstructor = 'array';
 		}
@@ -221,7 +226,7 @@ export function queryValidator(request: Request, response: Response): boolean {
 						']. It is: ' +
 						queryTypeConstructor +
 						'. Value: ' +
-						request.query[type]
+						requestQueryParams[type]
 				);
 			}
 

src/query-tools/query-validator.ts

@@ -0,0 +1,13 @@
+export interface Query
+{
+	id?: number|string,
+	count?: boolean,
+	raw?: boolean,
+	select?: string[],
+	join?: string[],
+	search?: string,
+	groupBy?: string[],
+	orderBy?: object,
+	limit?: number,
+	offset?: number
+}