@getjones/test-infra 2.7.13 → 2.7.15

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getjones/test-infra",
-  "version": "2.7.13",
+  "version": "2.7.15",
   "description": "Providing internal and openapi interface",
   "main": "src/index.js",
   "scripts": {

package/src/factory/records/records.js

@@ -113,7 +113,7 @@ const prepareWaivedRecord = async (recordCompany, recordEmail, tabId, requiremen
 	const recordId = await prepareRecord(recordCompany, recordEmail, complianceStatuses.notCompliant, tabId, requirementId, context);
 
 	const { data: record } = await contractors.services.getContractorById(recordId, context);
-	await compliance.services.overrideGap.waiveAllGaps(record, context);
+	await compliance.services.overrideGap.waiveAll(record, context);
 
 	return recordId;
 };

package/src/index.js

@@ -38,6 +38,7 @@ const getInternalAPI = () => {
 
 	const threadScheduler = require('./saas/internal-api/thread-scheduler/runner');
 	const dbEmails = require('./saas/internal-api/dbEmails/index');
+	const agreement = require('./saas/internal-api/agreement/index');
 
 	const internalAPI = {
 		defaults,
@@ -61,7 +62,8 @@ const getInternalAPI = () => {
 		requestsTable,
 		threadScheduler,
 		dbEmails,
-		factory
+		factory,
+		agreement
 	};
 
 	return internalAPI;
@@ -70,7 +72,7 @@ const getInternalAPI = () => {
 const getOpenAPI = () => {
 	const accounts = require('./saas/openapi/accounts/accounts.service');
 	const projects = require('./saas/openapi/projects/projects.service');
-	const tabs = require('./saas/openapi/tabs/tabs.service');
+	const tabs = require('./saas/openapi/tabs');
 	const requirements = require('./saas/openapi/requirements');
 	const requests = require('./saas/openapi/requests');
 	const coi = require('./saas/openapi/coi/coi.service');

package/src/saas/internal-api/agreement/api/agreement.api.js

@@ -0,0 +1,22 @@
+const requests = require('../../../../common/requests/cookieAuth/requests');
+const { backendUrl } = require('../../../../env').getEnv();
+
+const Endpoints = {
+	create: `${backendUrl}/saas/contractor/agreement`,
+	delete: `${backendUrl}/saas/contractor/agreement`
+};
+
+const createAgreement = (createAgreementModel, context) => {
+	return requests.postRequestHandler(Endpoints.create, createAgreementModel, context);
+};
+
+const deleteAgreement = (recordId, context) => {
+	const headers = {};
+	const params = { contractorId: recordId };
+	return requests.deleteRequestHandler(Endpoints.delete, context, headers, params);
+};
+
+module.exports = {
+	createAgreement,
+	deleteAgreement
+};

package/src/saas/internal-api/agreement/api/agreement.service.js

@@ -0,0 +1,17 @@
+const agreementAPI = require('./agreement.api');
+const { CreateAgreementModel } = require('../models/create.agreement.model');
+const { validateType } = require('../../../../common/validations/typeValidations');
+
+const createAgreement = (createAgreementModel, context) => {
+	validateType(createAgreementModel, CreateAgreementModel);
+	return agreementAPI.createAgreement(createAgreementModel, context);
+};
+
+const deleteAgreement = (recordId, context) => {
+	return agreementAPI.deleteAgreement(recordId, context);
+};
+
+module.exports = {
+	createAgreement,
+	deleteAgreement
+};

package/src/saas/internal-api/agreement/consts/consts.js

@@ -0,0 +1,8 @@
+const UPLOADER_TYPE = {
+	VENDOR: 'VENDOR',
+	USER: 'USER'
+};
+
+const DEFAULT_AGREEMENT_TEMPLATE = 'tpl_C3sgbpYx7LHyRNdtM7';
+
+module.exports = { UPLOADER_TYPE, DEFAULT_AGREEMENT_TEMPLATE };

package/src/saas/internal-api/agreement/index.js

@@ -0,0 +1,11 @@
+const createModel = require('./models/create.agreement.model');
+const services = require('./api/agreement.service');
+const agreementConsts = require('./consts/consts');
+
+const models = { create: createModel };
+
+const consts = {
+	audit: agreementConsts
+};
+
+module.exports = { services, models, consts };

package/src/saas/internal-api/agreement/models/create.agreement.model.js

@@ -0,0 +1,12 @@
+const { UPLOADER_TYPE } = require('../consts/consts');
+
+class CreateAgreementModel {
+	constructor({ contractorId, contractorDateModified, uploaderId, signedContractName, uploaderType = UPLOADER_TYPE.USER }) {
+		this.contractorId = contractorId;
+		this.contractorDateModified = contractorDateModified;
+		this.uploaderId = uploaderId;
+		this.signedContractName = signedContractName;
+		this.uploaderType = uploaderType;
+	}
+}
+module.exports = { CreateAgreementModel };

package/src/saas/internal-api/compliance/api/overrideGap/override.gap.api.js

@@ -2,18 +2,32 @@ const requests = require('../../../../../common/requests/cookieAuth/requests');
 const { backendUrl } = require('../../../../../env').getEnv();
 
 const Endpoints = {
+	waive: contractorId => `${backendUrl}/saas/contractors/${contractorId}/waiver`,
+	retract: contractorId => `${backendUrl}/saas/contractors/${contractorId}/waiver`,
 	overrideGap: `${backendUrl}/saas/record/override-gap`,
 	retractOverride: `${backendUrl}/saas/record/retract-override`
 };
 
-const overrideGap = ({ overrideGapModel, isTestingBackwardCompatibility = false, context }) => {
+const waive = async (contractorId, waiveRequestModel, context) => {
+	const status = waiveRequestModel.status;
+	delete waiveRequestModel.status;
+	return requests.postRequestHandler(Endpoints.waive(contractorId), waiveRequestModel, context, {}, { status });
+};
+
+const retract = async (contractorId, retractRequestModel, context) => {
+	const status = retractRequestModel.status;
+	delete retractRequestModel.status;
+	return requests.postRequestHandler(Endpoints.retract(contractorId), retractRequestModel, context, {}, { status });
+};
+
+const overrideGap = ({ waiveRequestModel, isTestingBackwardCompatibility = false, context }) => {
 	const headers = {};
 	const params = { isTestingBackwardCompatibility };
-	return requests.postRequestHandler(Endpoints.overrideGap, overrideGapModel, context, headers, params);
+	return requests.postRequestHandler(Endpoints.overrideGap, waiveRequestModel, context, headers, params);
 };
 
-const retractOverride = (retractModel, context) => {
-	return requests.postRequestHandler(Endpoints.retractOverride, retractModel, context);
+const retractOverride = (retractRequestModel, context) => {
+	return requests.postRequestHandler(Endpoints.retractOverride, retractRequestModel, context);
 };
 
-module.exports = { overrideGap, retractOverride };
+module.exports = { waive, retract, overrideGap, retractOverride };

package/src/saas/internal-api/compliance/api/overrideGap/override.gap.service.js

@@ -1,9 +1,7 @@
 const env = require('../../../../../env');
 
 const overrideGapApi = require('./override.gap.api');
-const { OverrideGapModel } = require('../../models/overrideGap/override.gap.model');
-const { RetractOverrideGapModel } = require('../../models/overrideGap/retract.override.gap.model');
-const { OVERRIDE_GAP_REASONS } = require('../../consts/overrideGap');
+const { WaiveRequestModel, RetractRequestModel, WAIVER_REASONS } = require('../../models/waive/waive.model');
 const { validateType } = require('../../../../../common/validations/typeValidations');
 const auditUtil = require('../../utils/auditUtil');
 const httpResponseStatusCodes = require('../../../../../common/httpResponseStatusCodes.json');
@@ -11,17 +9,27 @@ const httpResponseStatusCodes = require('../../../../../common/httpResponseStatu
 const { credentials } = env.getEnv();
 const userTypes = require('../../../../../common/consts/userTypes');
 
-const overrideGap = ({ overrideGapModel, isTestingBackwardCompatibility = false, context }) => {
-	validateType(overrideGapModel, OverrideGapModel);
-	return overrideGapApi.overrideGap({ overrideGapModel, isTestingBackwardCompatibility, context });
+const waive = (waiveRequestModel, context) => {
+	validateType(waiveRequestModel, WaiveRequestModel);
+	return overrideGapApi.waive(waiveRequestModel.contractorId, waiveRequestModel, context);
 };
 
-const retractOverride = (retractModel, context) => {
-	validateType(retractModel, RetractOverrideGapModel);
-	return overrideGapApi.retractOverride(retractModel, context);
+const retract = (retractRequestModel, context) => {
+	validateType(retractRequestModel, RetractRequestModel);
+	return overrideGapApi.retract(retractRequestModel.contractorId, retractRequestModel, context);
 };
 
-const getOverrideGapModel = (
+const overrideGap = ({ waiveRequestModel, isTestingBackwardCompatibility = false, context }) => {
+	validateType(waiveRequestModel, WaiveRequestModel);
+	return overrideGapApi.overrideGap({ waiveRequestModel, isTestingBackwardCompatibility, context });
+};
+
+const retractOverride = (retractRequestModel, context) => {
+	validateType(retractRequestModel, RetractRequestModel);
+	return overrideGapApi.retractOverride(retractRequestModel, context);
+};
+
+const getWaiveModel = (
 	record,
 	policyName,
 	attributeName,
@@ -35,7 +43,7 @@ const getOverrideGapModel = (
 	userId = userId || env.getSystemUserIdentity(credentials.superUser).id;
 	userRole = userRole || userTypes.ICS;
 
-	const waiveModel = new OverrideGapModel({
+	const waiveModel = new WaiveRequestModel({
 		contractorId: record.id,
 		auditId,
 		waiverReason,
@@ -59,7 +67,7 @@ const getWaiveModelByGap = (
 	} = {}) => {
 	const attributeName = auditUtil.getAttributeNameByGap(record, policyName, gap);
 
-	return getOverrideGapModel(record, policyName, attributeName, reason, note, { userId, userRole });
+	return getWaiveModel(record, policyName, attributeName, reason, note, { userId, userRole });
 };
 
 const getRetractModel = (record, policyName, attributeName) => {
@@ -67,7 +75,7 @@ const getRetractModel = (record, policyName, attributeName) => {
 	const userId = env.getSystemUserIdentity(credentials.superUser).id;
 	const userRole = userTypes.ICS;
 
-	const retractModel = new RetractOverrideGapModel({
+	const retractModel = new RetractRequestModel({
 		contractorId: record.id,
 		auditId,
 		userId,
@@ -94,13 +102,12 @@ const getPolicyAuditIdFromRecord = (record, policyName, attributeName) => {
 	return attribute.auditId;
 };
 
-// PRIVATE METHOD - please refer to waiveAllGaps / acceptAllGaps according to your needs
-const overrideAllGaps = async (record, context, { reason = OVERRIDE_GAP_REASONS.BUSINESS_DECISION, note = 'WAIVED AUTOMATICALLY' } = {}) => {
+const waiveAll = async (record, context, { reason = WAIVER_REASONS.BUSINESS_DECISION, note = 'WAIVED AUTOMATICALLY' } = {}) => {
 	const allWaivablePolicies = auditUtil.getAllWaivablePolicies(record, context);
 
 	for (const waivable of allWaivablePolicies) {
-		const overrideGapModel = getOverrideGapModel(record, waivable.policyName, waivable.attributeName, reason, note);
-		const waiveResponse = await overrideGap({ overrideGapModel, context });
+		const waiveModel = getWaiveModel(record, waivable.policyName, waivable.attributeName, reason, note);
+		const waiveResponse = await waive(waiveModel, context);
 
 		if (waiveResponse.status !== httpResponseStatusCodes.OK) {
 			throw Error(`Failed to waive ${waivable.policyName} - ${waivable.attributeName} for ${record.company}`);
@@ -108,24 +115,11 @@ const overrideAllGaps = async (record, context, { reason = OVERRIDE_GAP_REASONS.
 	}
 };
 
-const waiveAllGaps = async (record, context, { reason = OVERRIDE_GAP_REASONS.BUSINESS_DECISION, note = 'WAIVED AUTOMATICALLY' } = {}) => {
-	const waivedReasons = new Set([OVERRIDE_GAP_REASONS.BUSINESS_DECISION, OVERRIDE_GAP_REASONS.EXECUTIVE_APPROVAL, OVERRIDE_GAP_REASONS.NO_EXPOSURE]);
-
-	if (!waivedReasons.has(reason)) {
-		throw Error(`Invalid waive reason ${reason} provided when trying to waive all gaps to waive`);
-	}
-
-	await overrideAllGaps(record, context, { reason, note });
-};
-
-const acceptAllGaps = async (record, context, { note = 'ACCEPTED AUTOMATICALLY' } = {}) => {
-	overrideAllGaps(record, context, { reason: OVERRIDE_GAP_REASONS.ACCEPT_NO_EXPOSURE, note });
-};
-
 module.exports = {
-	acceptAllGaps,
-	waiveAllGaps,
-	getOverrideGapModel,
+	waive,
+	waiveAll,
+	retract,
+	getWaiveModel,
 	getRetractModel,
 	getWaiveModelByGap,
 	overrideGap,

package/src/saas/internal-api/compliance/index.js

@@ -1,14 +1,13 @@
 const auditModels = require('./models/audit/audit.model');
 const auditServices = require('./api/audit/audit.service');
 
-const waiveModels = require('./models/overrideGap/override.gap.model');
+const waiveModels = require('./models/waive/waive.model');
 const overrideGapServices = require('./api/overrideGap/override.gap.service');
 
 const convertServices = require('./api/convert/convert.service');
 const coverageServices = require('./api/coverage/coverage.service');
 
 const auditConsts = require('./consts/audit');
-const overrideGapConsts = require('./consts/overrideGap');
 const auditUtils = require('./utils/auditUtil');
 
 const models = {
@@ -17,8 +16,7 @@ const models = {
 };
 
 const consts = {
-	audit: auditConsts,
-	overrideGap: overrideGapConsts
+	audit: auditConsts
 };
 
 const utils = {

package/src/saas/internal-api/compliance/models/audit/audit.model.js

@@ -59,7 +59,7 @@ class AuditDatesModel {
 }
 
 class AuditListParametersModel {
-	constructor(page, accountIds, { fromDate, toDate } = {}) {
+	constructor(page, accountIds, { fromDate, toDate, recordId } = {}) {
 		validateInteger(page, { min: 1 });
 		validateArray(accountIds);
 
@@ -72,7 +72,7 @@ class AuditListParametersModel {
 		}
 
 		this.page = page;
-		this.filters = { accountIds, fromDate, toDate };
+		this.filters = { accountIds, fromDate, toDate, recordId };
 	}
 }
 

package/src/saas/internal-api/compliance/models/waive/waive.model.js

@@ -0,0 +1,49 @@
+const WAIVE_ACTIONS = {
+	WAIVE: 'ignored',
+	RETRACT: 'notIgnored'
+};
+
+const WAIVER_REASONS = {
+	BUSINESS_DECISION: 'Business Decision',
+	EXECUTIVE_APPROVAL: 'Executive Approval',
+	ACCEPT_NO_EXPOSURE: 'Accept / No Exposure',
+	NO_EXPOSURE: 'No Exposure' // DEPRECATED - BACKWARD COMPATIBILITY
+};
+
+function WaiveRequestModel({
+	contractorId,
+	auditId,
+	waiverReason,
+	remarks,
+	userId,
+	userRole
+}) {
+	this.auditorContractorId = auditId;
+	this.contractorId = contractorId;
+	this.waiverReason = waiverReason;
+	this.remarks = remarks || '';
+
+	this.userId = userId,
+	this.userRole = userRole,
+	this.status = WAIVE_ACTIONS.WAIVE;
+}
+
+function RetractRequestModel({
+	contractorId,
+	auditId,
+	userId,
+	userRole
+}) {
+	this.auditorContractorId = auditId;
+	this.contractorId = contractorId;
+	this.userId = userId;
+	this.userRole = userRole;
+	this.status = WAIVE_ACTIONS.RETRACT;
+}
+
+module.exports = {
+	WaiveRequestModel,
+	RetractRequestModel,
+	WAIVE_ACTIONS,
+	WAIVER_REASONS
+};

package/src/saas/internal-api/compliance/utils/auditUtil.js

@@ -2,7 +2,7 @@ const { AUDIT_ENTITY_STATUSES, DEFAULT_POLICY_ID, VALID_SCORES } = require('../c
 const { isObject, isArray } = require('../../../../common/utils/dataTypeUtils');
 const timeUtils = require('../../../../common/utils/timeUtils');
 const auditModels = require('../models/audit/audit.model');
-const { OVERRIDE_GAP_REASONS } = require('../consts/overrideGap');
+const waiveModels = require('../models/waive/waive.model');
 
 const emptyValue = '';
 
@@ -216,7 +216,7 @@ const specialAttributes = {
 };
 
 const waiveReasons = {
-	'No Exposure': OVERRIDE_GAP_REASONS.NO_EXPOSURE,
-	'Business Decision': OVERRIDE_GAP_REASONS.BUSINESS_DECISION,
-	'Executive Approval': OVERRIDE_GAP_REASONS.EXECUTIVE_APPROVAL
+	'No Exposure': waiveModels.WAIVER_REASONS.NO_EXPOSURE,
+	'Business Decision': waiveModels.WAIVER_REASONS.BUSINESS_DECISION,
+	'Executive Approval': waiveModels.WAIVER_REASONS.EXECUTIVE_APPROVAL
 };

package/src/saas/openapi/tabs/index.js

@@ -0,0 +1,6 @@
+const services = require('./tabs.service');
+const CreateTabModel = require('./models/create.tab.model');
+
+const models = { CreateTabModel };
+
+module.exports = { ... services, models };

package/src/saas/openapi/tabs/models/create.tab.model.js

@@ -0,0 +1,6 @@
+function CreateTabModel(name, type) {
+	this.name = name;
+	this.type = type;
+}
+
+module.exports = CreateTabModel;

package/src/saas/openapi/tabs/tabs.api.js

@@ -3,11 +3,16 @@ const { openapiUrl, backendUrl } = require('../../../env').getEnv();
 
 const Endpoints = {
 	delete: tabId => `${openapiUrl}/tabs/${tabId}`,
-	get: tabId => `${backendUrl}/tabs/${tabId}`
+	get: tabId => `${backendUrl}/tabs/${tabId}`,
+	create: projectId => `${openapiUrl}/properties/${projectId}/tab`
 };
 
-const deleteTabById = async (tabId, apiKey) => {
+const deleteTabById = (tabId, apiKey) => {
 	return requests.deleteRequestHandler(Endpoints.delete(tabId), apiKey);
 };
 
-module.exports = { deleteTabById };
+const createTab = (projectId, createTabModel, apiKey) => {
+	return requests.postRequestHandler(Endpoints.create(projectId), apiKey, createTabModel);
+};
+
+module.exports = { deleteTabById, createTab };

package/src/saas/openapi/tabs/tabs.service.js

@@ -1,7 +1,11 @@
 const tabsApi = require('./tabs.api');
 
-const deleteTabById = async (tabId, apiKey) => {
+const deleteTabById = (tabId, apiKey) => {
 	return tabsApi.deleteTabById(tabId, apiKey);
 };
 
-module.exports = { deleteTabById };
+const createTab = (projectId, createTabModel, apiKey) => {
+	return tabsApi.createTab(projectId, createTabModel, apiKey);
+};
+
+module.exports = { deleteTabById, createTab };

package/src/saas/internal-api/compliance/consts/overrideGap.js

@@ -1,10 +0,0 @@
-const OVERRIDE_GAP_REASONS = {
-	BUSINESS_DECISION: 'Business Decision',
-	EXECUTIVE_APPROVAL: 'Executive Approval',
-	ACCEPT_NO_EXPOSURE: 'Accept / No Exposure',
-	NO_EXPOSURE: 'No Exposure' // DEPRECATED - BACKWARD COMPATIBILITY
-};
-
-module.exports = {
-	OVERRIDE_GAP_REASONS
-};

package/src/saas/internal-api/compliance/models/overrideGap/override.gap.model.js

@@ -1,16 +0,0 @@
-class OverrideGapModel {
-	constructor({
-		contractorId, auditId, waiverReason, remarks, userId, userRole
-	}) {
-		this.auditorContractorId = auditId;
-		this.contractorId = contractorId;
-		this.waiverReason = waiverReason;
-		this.remarks = remarks || '';
-		this.userId = userId;
-		this.userRole = userRole;
-	}
-}
-
-module.exports = {
-	OverrideGapModel
-};

package/src/saas/internal-api/compliance/models/overrideGap/retract.override.gap.model.js

@@ -1,14 +0,0 @@
-class RetractOverrideGapModel {
-	constructor({
-		contractorId, auditId, userId, userRole
-	}) {
-		this.auditorContractorId = auditId;
-		this.contractorId = contractorId;
-		this.userId = userId;
-		this.userRole = userRole;
-	}
-}
-
-module.exports = {
-	RetractOverrideGapModel
-};