@getjones/test-infra 5.2.10 → 5.2.12

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

@@ -1,198 +1,198 @@
-const requirementsAPI = require('./requirements.api');
-const { CreateRequirementModel } = require('../models/create.requirement.model');
-const { UpdateRequirementModel } = require('../models/update.requirement.model');
-const requirementUtils = require('../utils/utils');
-const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
-
-const { validateType, validateArray } = require('../../../../common/validations/typeValidations');
-
-const createRequirement = (createRequirementModel, tabId, context) => {
-	validateType(createRequirementModel, CreateRequirementModel);
-	return requirementsAPI.createRequirement(createRequirementModel, tabId, context);
-};
-
-const getRequirementsByTabId = (tabId, context) => {
-	return requirementsAPI.getRequirementsByTabId(tabId, context);
-};
-
-const getRequirementById = (requirementId, context, { isPermanentLink } = {}) => {
-	return requirementsAPI.getRequirementById(requirementId, context, { isPermanentLink });
-};
-
-const getViewOnlyRequirement = (encryptedUrl, context = null, { isPermanent } = {}) => {
-	return requirementsAPI.getViewOnlyRequirement(encryptedUrl, context, { isPermanent });
-};
-
-const getEncryptedUrlFromViewOnlyLink = publicViewOnlyLink => {
-	if (!publicViewOnlyLink) {
-		return null;
-	}
-
-	return publicViewOnlyLink.split('/').pop();
-};
-
-const getRequirementByName = async (tabId, requirementName, context, { isPermanentLink } = {}) => {
-	const { data: requirementList } = await getRequirementsByTabId(tabId, context);
-
-	const requirement = requirementList.find(req => req.name === requirementName);
-
-	if (!requirement) {
-		return null;
-	}
-
-	const requirementResponse = await getRequirementById(requirement.id, context, { isPermanentLink });
-	return requirementResponse.data.requirement;
-};
-
-const getRequirementIdByName = async (tabId, requirementName, context) => {
-	const requirement = await getRequirementByName(tabId, requirementName, context);
-	return requirement ? requirement.id : requirement;
-};
-
-const getOrCreateRequirement = async (requirement, tabId, context) => {
-	let existingRequirement = await getRequirementByName(tabId, requirement.name, context);
-
-	if (!existingRequirement) {
-		const createRequirementModel = getCreateRequirementModel(requirement);
-		await createRequirement(createRequirementModel, tabId, context);
-		existingRequirement = await getRequirementByName(tabId, requirement.name, context);
-	}
-
-	return existingRequirement;
-};
-
-const updateRequirement = (updateRequirementModel, tabId, context) => {
-	validateType(updateRequirementModel, UpdateRequirementModel);
-	return requirementsAPI.updateRequirement(updateRequirementModel, tabId, context);
-};
-
-const updateRequirementWithNotification = (updateRequirementModel, tabId, context) => {
-	validateType(updateRequirementModel, UpdateRequirementModel);
-	return requirementsAPI.updateRequirementWithNotification(updateRequirementModel, tabId, context);
-};
-
-const updateBulkRequirementsVisibility = async (data, context) => {
-	validateArray(data);
-	const response = await requirementsAPI.updateRequirementsVisibility(data, context);
-
-	if (response.status !== httpResponseStatusCodes.NO_CONTENT) {
-		throw new Error('Failed to update bulk requirements visibility');
-	}
-
-	return response;
-};
-
-const updateRequirementsVisibility = async (requirementId, visibility, context) => {
-	const data = [{ id: requirementId, visibility }];
-	const response = await requirementsAPI.updateRequirementsVisibility(data, context);
-
-	if (response.status !== httpResponseStatusCodes.NO_CONTENT) {
-		throw new Error('Failed to update requirements visibility');
-	}
-
-	return response;
-};
-
-const deleteByRequirementId = (requirementId, context) => {
-	return requirementsAPI.deleteByRequirementId(requirementId, context);
-};
-
-const deleteRequirementByName = async (requirementName, tabId, context) => {
-	const requirementToDelete = await getRequirementByName(tabId, requirementName, context);
-
-	if (!requirementToDelete) {
-		return;
-	}
-
-	return deleteByRequirementId(requirementToDelete.id, context);
-};
-
-const deleteAllRequirementsInTabs = async (tabIds, context) => {
-	const failedToDeleteRequirements = [];
-	const successfulDeleteRes = [];
-	let requirementsToDelete = [];
-
-	for (const tabId of tabIds) {
-		const { data: existingRequirements } = await getRequirementsByTabId(tabId, context);
-		requirementsToDelete = existingRequirements || [];
-
-		for (const requirement of existingRequirements) {
-			const response = await deleteByRequirementId(requirement.id, context);
-
-			if (response.status !== httpResponseStatusCodes.OK) {
-				console.error('Failed to delete requirement: ', requirement.id);
-				failedToDeleteRequirements.push(response);
-			}
-
-			if (response.data.result === 'linked') {
-				console.error('Requirement is linked to a record and cannot be deleted', requirement.id);
-				failedToDeleteRequirements.push(response);
-			}
-
-			if (response.status === httpResponseStatusCodes.OK) {
-				successfulDeleteRes.push(response.data.result);
-			}
-		}
-	}
-
-	if (failedToDeleteRequirements.length) {
-		throw Error(`Failed to delete ${failedToDeleteRequirements.length} of ${requirementsToDelete.length} requirements in account. Failed with status: ${ failedToDeleteRequirements[0].status }`);
-	}
-
-	return successfulDeleteRes;
-};
-
-const getCreateRequirementModel = requirement => {
-	return requirementUtils.getCreateRequirementModel(requirement);
-};
-
-const getUpdatedRequirementModel = async (updatedRequirement, tabId, context, { originalRequirementName } = {}) => {
-	const requirementName = originalRequirementName || updatedRequirement.name;
-	const existingRequirement = await getRequirementByName(tabId, requirementName, context);
-	updatedRequirement.id = existingRequirement.id;
-	updatedRequirement.dateModified = existingRequirement.dateModified;
-
-	return requirementUtils.getUpdateRequirementModel(updatedRequirement);
-};
-
-const getRequirementDateModified = async (tabId, requirementName, context) => {
-	const requirementRes = await getRequirementByName(tabId, requirementName, context);
-
-	if (!requirementRes) {
-		throw new Error(`Failed to retrieve requirement - ${requirementName}`);
-	}
-
-	return requirementRes.dateModified;
-};
-
-const getRequirementLinkedRecordCount = async (requirementId, context, { shouldCountDraft } = {}) => {
-	const recordCount = await requirementsAPI.getRequirementLinkedRecordCount(requirementId, context, { shouldCountDraft });
-
-	if (recordCount.status !== httpResponseStatusCodes.OK) {
-		throw new Error(`Failed to retrieve linked record count for requirement - ${requirementId}\n${recordCount}`);
-	}
-
-	return recordCount;
-};
-
-module.exports = {
-	createRequirement,
-	getRequirementById,
-	getRequirementByName,
-	getRequirementIdByName,
-	getRequirementsByTabId,
-	getViewOnlyRequirement,
-	getEncryptedUrlFromViewOnlyLink,
-	getOrCreateRequirement,
-	updateRequirement,
-	updateRequirementWithNotification,
-	updateBulkRequirementsVisibility,
-	updateRequirementsVisibility,
-	deleteByRequirementId,
-	deleteRequirementByName,
-	deleteAllRequirementsInTabs,
-	getCreateRequirementModel,
-	getUpdatedRequirementModel,
-	getRequirementDateModified,
-	getRequirementLinkedRecordCount
-};
+const requirementsAPI = require('./requirements.api');
+const { CreateRequirementModel } = require('../models/create.requirement.model');
+const { UpdateRequirementModel } = require('../models/update.requirement.model');
+const requirementUtils = require('../utils/utils');
+const httpResponseStatusCodes = require('../../../../common/httpResponseStatusCodes.json');
+
+const { validateType, validateArray } = require('../../../../common/validations/typeValidations');
+
+const createRequirement = (createRequirementModel, tabId, context) => {
+	validateType(createRequirementModel, CreateRequirementModel);
+	return requirementsAPI.createRequirement(createRequirementModel, tabId, context);
+};
+
+const getRequirementsByTabId = (tabId, context) => {
+	return requirementsAPI.getRequirementsByTabId(tabId, context);
+};
+
+const getRequirementById = (requirementId, context, { isPermanentLink } = {}) => {
+	return requirementsAPI.getRequirementById(requirementId, context, { isPermanentLink });
+};
+
+const getViewOnlyRequirement = (encryptedUrl, context = null, { isPermanent } = {}) => {
+	return requirementsAPI.getViewOnlyRequirement(encryptedUrl, context, { isPermanent });
+};
+
+const getEncryptedUrlFromViewOnlyLink = publicViewOnlyLink => {
+	if (!publicViewOnlyLink) {
+		return null;
+	}
+
+	return publicViewOnlyLink.split('/').pop();
+};
+
+const getRequirementByName = async (tabId, requirementName, context, { isPermanentLink } = {}) => {
+	const { data: requirementList } = await getRequirementsByTabId(tabId, context);
+
+	const requirement = requirementList.find(req => req.name === requirementName);
+
+	if (!requirement) {
+		return null;
+	}
+
+	const requirementResponse = await getRequirementById(requirement.id, context, { isPermanentLink });
+	return requirementResponse.data.requirement;
+};
+
+const getRequirementIdByName = async (tabId, requirementName, context) => {
+	const requirement = await getRequirementByName(tabId, requirementName, context);
+	return requirement ? requirement.id : requirement;
+};
+
+const getOrCreateRequirement = async (requirement, tabId, context) => {
+	let existingRequirement = await getRequirementByName(tabId, requirement.name, context);
+
+	if (!existingRequirement) {
+		const createRequirementModel = getCreateRequirementModel(requirement);
+		await createRequirement(createRequirementModel, tabId, context);
+		existingRequirement = await getRequirementByName(tabId, requirement.name, context);
+	}
+
+	return existingRequirement;
+};
+
+const updateRequirement = (updateRequirementModel, tabId, context) => {
+	validateType(updateRequirementModel, UpdateRequirementModel);
+	return requirementsAPI.updateRequirement(updateRequirementModel, tabId, context);
+};
+
+const updateRequirementWithNotification = (updateRequirementModel, tabId, context) => {
+	validateType(updateRequirementModel, UpdateRequirementModel);
+	return requirementsAPI.updateRequirementWithNotification(updateRequirementModel, tabId, context);
+};
+
+const updateBulkRequirementsVisibility = async (data, context) => {
+	validateArray(data);
+	const response = await requirementsAPI.updateRequirementsVisibility(data, context);
+
+	if (response.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error('Failed to update bulk requirements visibility');
+	}
+
+	return response;
+};
+
+const updateRequirementsVisibility = async (requirementId, visibility, context) => {
+	const data = [{ id: requirementId, visibility }];
+	const response = await requirementsAPI.updateRequirementsVisibility(data, context);
+
+	if (response.status !== httpResponseStatusCodes.NO_CONTENT) {
+		throw new Error('Failed to update requirements visibility');
+	}
+
+	return response;
+};
+
+const deleteByRequirementId = (requirementId, context) => {
+	return requirementsAPI.deleteByRequirementId(requirementId, context);
+};
+
+const deleteRequirementByName = async (requirementName, tabId, context) => {
+	const requirementToDelete = await getRequirementByName(tabId, requirementName, context);
+
+	if (!requirementToDelete) {
+		return;
+	}
+
+	return deleteByRequirementId(requirementToDelete.id, context);
+};
+
+const deleteAllRequirementsInTabs = async (tabIds, context) => {
+	const failedToDeleteRequirements = [];
+	const successfulDeleteRes = [];
+	let requirementsToDelete = [];
+
+	for (const tabId of tabIds) {
+		const { data: existingRequirements } = await getRequirementsByTabId(tabId, context);
+		requirementsToDelete = existingRequirements || [];
+
+		for (const requirement of existingRequirements) {
+			const response = await deleteByRequirementId(requirement.id, context);
+
+			if (response.status !== httpResponseStatusCodes.OK) {
+				console.error('Failed to delete requirement: ', requirement.id);
+				failedToDeleteRequirements.push(response);
+			}
+
+			if (response.data.result === 'linked') {
+				console.error('Requirement is linked to a record and cannot be deleted', requirement.id);
+				failedToDeleteRequirements.push(response);
+			}
+
+			if (response.status === httpResponseStatusCodes.OK) {
+				successfulDeleteRes.push(response.data.result);
+			}
+		}
+	}
+
+	if (failedToDeleteRequirements.length) {
+		throw Error(`Failed to delete ${failedToDeleteRequirements.length} of ${requirementsToDelete.length} requirements in account. Failed with status: ${ failedToDeleteRequirements[0].status }`);
+	}
+
+	return successfulDeleteRes;
+};
+
+const getCreateRequirementModel = requirement => {
+	return requirementUtils.getCreateRequirementModel(requirement);
+};
+
+const getUpdatedRequirementModel = async (updatedRequirement, tabId, context, { originalRequirementName } = {}) => {
+	const requirementName = originalRequirementName || updatedRequirement.name;
+	const existingRequirement = await getRequirementByName(tabId, requirementName, context);
+	updatedRequirement.id = existingRequirement.id;
+	updatedRequirement.dateModified = existingRequirement.dateModified;
+
+	return requirementUtils.getUpdateRequirementModel(updatedRequirement);
+};
+
+const getRequirementDateModified = async (tabId, requirementName, context) => {
+	const requirementRes = await getRequirementByName(tabId, requirementName, context);
+
+	if (!requirementRes) {
+		throw new Error(`Failed to retrieve requirement - ${requirementName}`);
+	}
+
+	return requirementRes.dateModified;
+};
+
+const getRequirementLinkedRecordCount = async (requirementId, context, { shouldCountDraft } = {}) => {
+	const recordCount = await requirementsAPI.getRequirementLinkedRecordCount(requirementId, context, { shouldCountDraft });
+
+	if (recordCount.status !== httpResponseStatusCodes.OK) {
+		throw new Error(`Failed to retrieve linked record count for requirement - ${requirementId}\n${recordCount}`);
+	}
+
+	return recordCount;
+};
+
+module.exports = {
+	createRequirement,
+	getRequirementById,
+	getRequirementByName,
+	getRequirementIdByName,
+	getRequirementsByTabId,
+	getViewOnlyRequirement,
+	getEncryptedUrlFromViewOnlyLink,
+	getOrCreateRequirement,
+	updateRequirement,
+	updateRequirementWithNotification,
+	updateBulkRequirementsVisibility,
+	updateRequirementsVisibility,
+	deleteByRequirementId,
+	deleteRequirementByName,
+	deleteAllRequirementsInTabs,
+	getCreateRequirementModel,
+	getUpdatedRequirementModel,
+	getRequirementDateModified,
+	getRequirementLinkedRecordCount
+};

package/src/saas/internal-api/requirements/consts/attributeTypes.json

@@ -1,9 +1,9 @@
-{
-	"endorsement": "ENDORSEMENT",
-	"limit": "LIMIT",
-	"boolean": "BOOLEAN",
-	"multiple": "MULTIPLE",
-	"numeric": "NUMERIC",
-	"amBestRating": "AM_BEST_RATING",
-	"amBestFinancialSizeCategory": "AM_BEST_FINANCIAL_SIZE_CATEGORY"
+{
+	"endorsement": "ENDORSEMENT",
+	"limit": "LIMIT",
+	"boolean": "BOOLEAN",
+	"multiple": "MULTIPLE",
+	"numeric": "NUMERIC",
+	"amBestRating": "AM_BEST_RATING",
+	"amBestFinancialSizeCategory": "AM_BEST_FINANCIAL_SIZE_CATEGORY"
 }

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

@@ -1,15 +1,22 @@
-const REQUIREMENT_SHARING_LEVELS = {
-	TAB: 'Tab',
-	ACCOUNT: 'Account'
-};
-
-const leaseExtractionStatus = {
-	pending: 'PENDING',
-	inProgress: 'IN_PROGRESS',
-	completed: 'COMPLETED',
-	success: 'SUCCESS',
-	canceled: 'CANCELED',
-	closedReqSet: 'CLOSED_REQ_SET'
-};
-
-module.exports = { REQUIREMENT_SHARING_LEVELS, leaseExtractionStatus };
+const REQUIREMENT_SHARING_LEVELS = {
+	TAB: 'Tab',
+	ACCOUNT: 'Account'
+};
+
+const leaseExtractionStatus = {
+	pending: 'PENDING',
+	inProgress: 'IN_PROGRESS',
+	completed: 'COMPLETED',
+	success: 'SUCCESS',
+	canceled: 'CANCELED',
+	closedReqSet: 'CLOSED_REQ_SET'
+};
+
+const DEFAULT_LEASE_PATH = 'packages/test-infra/src/resources/lease/defaultLease.pdf';
+
+const LEASE_TRIGGER_TYPES = {
+	record: 'RECORD',
+	tab: 'TAB'
+};
+
+module.exports = { REQUIREMENT_SHARING_LEVELS, leaseExtractionStatus, LEASE_TRIGGER_TYPES, DEFAULT_LEASE_PATH };

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

@@ -1,21 +1,22 @@
-const createModel = require('./models/create.requirement.model');
-const updateModel = require('./models/update.requirement.model');
-const policyModel = require('./models/policy.model');
-const extractionRequestModel = require('./models/extraction.request.model');
-const services = require('./api/requirements.service');
-const consts = require('./consts/consts');
-const utils = require('./utils/utils');
-
-const models = { create: createModel, update: updateModel, policy: policyModel, extractionRequest: extractionRequestModel };
-
-const leaseServices = require('./api/lease/lease.service');
-
-module.exports = {
-	services,
-	models,
-	consts,
-	utils,
-	lease: {
-		services: leaseServices
-	}
-};
+const createModel = require('./models/create.requirement.model');
+const updateModel = require('./models/update.requirement.model');
+const policyModel = require('./models/policy.model');
+const extractionRequestModel = require('./models/extraction.request.model');
+const tabExtractionRequestModel = require('./models/tab.extraction.request.model');
+const services = require('./api/requirements.service');
+const consts = require('./consts/consts');
+const utils = require('./utils/utils');
+
+const models = { create: createModel, update: updateModel, policy: policyModel, extractionRequest: extractionRequestModel, tabExtractionRequest: tabExtractionRequestModel };
+
+const leaseServices = require('./api/lease/lease.service');
+
+module.exports = {
+	services,
+	models,
+	consts,
+	utils,
+	lease: {
+		services: leaseServices
+	}
+};

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

@@ -1,17 +1,17 @@
-const { validateType } = require('../../../../common/validations/typeValidations');
-const { PolicyModel } = require('./policy.model');
-
-const { REQUIREMENT_SHARING_LEVELS } = require('../consts/consts');
-
-class CreateRequirementModel {
-	constructor(name, policies, sharingLevel = REQUIREMENT_SHARING_LEVELS.TAB) {
-		this.name = name;
-		this.policies = policies;
-		this.sharingLevel = sharingLevel;
-
-		validateType(policies, Array);
-		policies.length > 0 && validateType(policies[0], PolicyModel);
-	}
-}
-
-module.exports = { CreateRequirementModel };
+const { validateType } = require('../../../../common/validations/typeValidations');
+const { PolicyModel } = require('./policy.model');
+
+const { REQUIREMENT_SHARING_LEVELS } = require('../consts/consts');
+
+class CreateRequirementModel {
+	constructor(name, policies, sharingLevel = REQUIREMENT_SHARING_LEVELS.TAB) {
+		this.name = name;
+		this.policies = policies;
+		this.sharingLevel = sharingLevel;
+
+		validateType(policies, Array);
+		policies.length > 0 && validateType(policies[0], PolicyModel);
+	}
+}
+
+module.exports = { CreateRequirementModel };

package/src/saas/internal-api/requirements/models/extraction.request.model.js

@@ -1,16 +1,16 @@
-const { RELATED_DOC_TYPES } = require('../../uploadFiles/consts');
-
-class ExtractionRequestModel {
-	// tempFileName, name, fileSize describe the lease to extract requirements from,
-	// coiDoc is the optional on-behalf COI
-	constructor({ tempFileName, name, fileSize, docType = RELATED_DOC_TYPES.LEASE, notes = null, coiDoc = null }) {
-		this.tempFileName = tempFileName;
-		this.name = name;
-		this.fileSize = fileSize;
-		this.docType = docType;
-		this.notes = notes;
-		this.coiDoc = coiDoc;
-	}
-}
-
-module.exports = { ExtractionRequestModel };
+const { RELATED_DOC_TYPES } = require('../../uploadFiles/consts');
+
+class ExtractionRequestModel {
+	// tempFileName, name, fileSize describe the lease to extract requirements from,
+	// coiDoc is the optional on-behalf COI
+	constructor({ tempFileName, name, fileSize, docType = RELATED_DOC_TYPES.LEASE, notes = null, coiDoc = null }) {
+		this.tempFileName = tempFileName;
+		this.name = name;
+		this.fileSize = fileSize;
+		this.docType = docType;
+		this.notes = notes;
+		this.coiDoc = coiDoc;
+	}
+}
+
+module.exports = { ExtractionRequestModel };

package/src/saas/internal-api/requirements/models/policy.model.js

@@ -1,35 +1,35 @@
-const Enum = require('enum');
-const { validateType } = require('../../../../common/validations/typeValidations');
-
-class PolicyModel {
-	constructor(name, attributes) {
-		this.policyName = name;
-		this.attributes = attributes;
-		validateType(attributes, Array);
-		attributes && validateType(attributes[0], AttributeModel);
-	}
-}
-
-class AttributeModel {
-	constructor(name, type, values) {
-		this.attributeName = name;
-		this.type = type.value;
-		this.values = values.map(value => ({ value }));
-
-		if (!AttributeTypes.get(type) || !AttributeTypes.get(type.key)) {
-			throw TypeError(`Expected type to be instance of: ${AttributeTypes.name}`);
-		}
-	}
-}
-
-const AttributeTypes = new Enum({
-	'ENDORSEMENT': 'endorsment', //typo in BE
-	'LIMIT': 'limit',
-	'BOOLEAN': 'boolean',
-	'NUMERIC': 'numeric',
-	'MULTIPLE': 'multiple',
-	'AM_BEST_RATING': 'amBestRating',
-	'AM_BEST_FINANCIAL_SIZE_CATEGORY': 'amBestFinancialSizeCategory'
-}, { name: 'AttributeTypes' });
-
-module.exports = { PolicyModel, AttributeModel, AttributeTypes };
+const Enum = require('enum');
+const { validateType } = require('../../../../common/validations/typeValidations');
+
+class PolicyModel {
+	constructor(name, attributes) {
+		this.policyName = name;
+		this.attributes = attributes;
+		validateType(attributes, Array);
+		attributes && validateType(attributes[0], AttributeModel);
+	}
+}
+
+class AttributeModel {
+	constructor(name, type, values) {
+		this.attributeName = name;
+		this.type = type.value;
+		this.values = values.map(value => ({ value }));
+
+		if (!AttributeTypes.get(type) || !AttributeTypes.get(type.key)) {
+			throw TypeError(`Expected type to be instance of: ${AttributeTypes.name}`);
+		}
+	}
+}
+
+const AttributeTypes = new Enum({
+	'ENDORSEMENT': 'endorsment', //typo in BE
+	'LIMIT': 'limit',
+	'BOOLEAN': 'boolean',
+	'NUMERIC': 'numeric',
+	'MULTIPLE': 'multiple',
+	'AM_BEST_RATING': 'amBestRating',
+	'AM_BEST_FINANCIAL_SIZE_CATEGORY': 'amBestFinancialSizeCategory'
+}, { name: 'AttributeTypes' });
+
+module.exports = { PolicyModel, AttributeModel, AttributeTypes };

package/src/saas/internal-api/requirements/models/tab.extraction.request.model.js

@@ -0,0 +1,14 @@
+const { RELATED_DOC_TYPES } = require('../../uploadFiles/consts');
+
+class TabExtractionRequestModel {
+	constructor({ tempFileName, name, requirementName, fileSize, docType = RELATED_DOC_TYPES.SERVICE_AGREEMENT, notes = null }) {
+		this.tempFileName = tempFileName;
+		this.name = name;
+		this.requirementName = requirementName;
+		this.fileSize = fileSize;
+		this.docType = docType;
+		this.notes = notes;
+	}
+}
+
+module.exports = { TabExtractionRequestModel };