Merge pull request #5 from janis-commerce/add-postStructValidate-method

Add post struct validate method

CHANGELOG.md

@@ -5,6 +5,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [4.3.0] - 2019-11-28
+### Added
+- New method `postStructValidate` to add extra validation post struc validation
+
 ## [4.2.1] - 2019-11-13
 ### Changed
 - Updated `api` dependency

README.md

@@ -51,6 +51,10 @@ class MyApiSaveData extends ApiSaveData {
 		});
 	}
 
+	postStructValidate() {
+		return someAsyncTask(this.dataToSave.main);
+	}
+
 	format({ someField, ...restoOfTheRecord }) {
 		return {
 			...restoOfTheRecord,
@@ -95,6 +99,10 @@ Defaults to an object with any property.
 This is used to validate the data received in the request, checking the data to be passed to the relationships.
 Defaults to an object partial with no properties.
 
+### postStructValidate()
+This is used to validate the data received in the request, making additional validation even injecting data to the received data.
+If it returns a Promise, it will be awaited.
+
 ### format(record)
 You can use this to format your main record before it's saved. For example, mapping user friendly values to DB friendly values, add default values, etc.
 If it returns a Promise, it will be awaited.

lib/api-save-data.js

@@ -36,6 +36,14 @@ class ApiSaveData extends API {
 		this.dataToSave = apiSaveValidator.validateData();
 
 		this.model = apiSaveValidator.validateModel();
+
+		if(this.postStructValidate) {
+			try {
+				await this.postStructValidate();
+			} catch(e) {
+				throw new ApiSaveError(e, ApiSaveError.codes.INVALID_REQUEST_DATA);
+			}
+		}
 	}
 
 	async process() {

lib/api-save-error.js

@@ -7,6 +7,7 @@ class ApiSaveError extends Error {
 		return {
 			INVALID_REQUEST_DATA: 1,
 			INVALID_ENTITY: 2,
+			VALIDATION_ERROR: 3,
 			INTERNAL_ERROR: 99
 		};
 

lib/api-save-validator.js

@@ -37,7 +37,7 @@ class ApiSaveValidator {
 		} catch(e) {
 			const errorPath = e.path.join('.');
 			e.message = `${e.message} in ${errorPath}`;
-			throw new ApiSaveError(e, ApiSaveError.codes.INVALID_REQUEST_DATA);
+			throw new ApiSaveError(e, ApiSaveError.codes.VALIDATION_ERROR);
 		}
 	}
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@janiscommerce/api-save",
-  "version": "4.2.1",
+  "version": "4.3.0",
   "description": "A package to handle JANIS Views Save APIs",
   "main": "lib/index.js",
   "scripts": {

tests/api-save.js

@@ -1207,4 +1207,75 @@ describe('API Save', () => {
 		});
 	});
 
+	describe('Process with postStructValidate method', () => {
+
+		it('Should execute the postStructValidate after validate data', async () => {
+
+			class MyApiSaveWithPostStructValidate extends ApiSaveData {
+
+				async postStructValidate() {
+
+					const newField = 123;
+
+					this.dataToSave.main.newField = newField;
+				}
+			}
+
+			Model.prototype.insert.resolves('15');
+
+			sinon.spy(MyApiSaveWithPostStructValidate.prototype, 'postStructValidate');
+
+			const apiSave = new MyApiSaveWithPostStructValidate();
+
+			apiSave.endpoint = '/api/some-entity';
+			apiSave.data = {
+				name: 'The name',
+				otherField: 'foo'
+			};
+
+			const validation = await apiSave.validate();
+
+			assert.strictEqual(validation, undefined);
+
+			await apiSave.process();
+
+			sinon.assert.calledOnce(MyApiSaveWithPostStructValidate.prototype.postStructValidate);
+			sinon.assert.calledOnce(Model.prototype.insert);
+
+			sinon.assert.calledWithExactly(Model.prototype.insert, {
+				name: 'The name',
+				otherField: 'foo',
+				newField: 123
+			});
+		});
+
+		it('Should fail if postStructValidate throws a exception', async () => {
+
+			class MyApiSaveWithPostStructValidate extends ApiSaveData {
+
+				async postStructValidate() {
+					throw new Error('throws a nice exception');
+				}
+			}
+
+			sinon.spy(MyApiSaveWithPostStructValidate.prototype, 'postStructValidate');
+
+			const apiSave = new MyApiSaveWithPostStructValidate();
+
+			apiSave.endpoint = '/api/some-entity';
+			apiSave.data = {
+				name: 'The name',
+				otherField: 'foo'
+			};
+
+			await assert.rejects(() => apiSave.validate(), {
+				name: 'ApiSaveError',
+				code: ApiSaveError.codes.INVALID_REQUEST_DATA,
+				previousError: new Error('throws a nice exception')
+			});
+
+			sinon.assert.calledOnce(MyApiSaveWithPostStructValidate.prototype.postStructValidate);
+		});
+	});
+
 });