Domain references and de-activation of sections

Author: pdesmarets

adapter/0.1.13.json

@@ -0,0 +1,48 @@
+/**
+ * Copyright © 2016-2020 by IntegrIT S.A. dba Hackolade.  All rights reserved.
+ *
+ * The copyright to the computer software herein is the property of IntegrIT S.A.
+ * The software may be used and/or copied only with the written permission of 
+ * IntegrIT S.A. or in accordance with the terms and conditions stipulated in 
+ * the agreement/contract under which the software has been supplied. 
+ * 
+ * {
+ * 		"add": {
+ * 			"entity": [<names of new property>],
+ * 			"container": [<names of new property>],
+ * 			"model": [<names of new property>],
+ * 			"view": [<names of new property>],
+ *			"field": {
+ *				"<type>": [<names of new property>]
+ *			}
+ * 		},
+ * 		"delete": {
+ * 			"entity": [<names of new property>],
+ * 			"container": [<names of new property>],
+ * 			"model": [<names of new property>],
+ * 			"view": [<names of new property>],
+ *			"field": {
+ *				"<type>": [<names of new property>]
+ *			}
+ * 		},
+ * 		"modify": {
+ *	 		"entity": [
+ *	 			{
+ *					"from": { <properties that identify record> },
+ *					"to": { <properties that need to be changed> }
+ *				}
+ *			],
+ *			"container": [],
+ *			"model": [],
+ *			"view": [],
+ *			"field": []
+ * 		},
+ * }
+ */
+ 
+{
+	"add": {
+		"container": ["isActivated"],
+		"entity": ["isActivated"]
+	}
+}

forward_engineering/api.js

@@ -1,4 +1,5 @@
 const yaml = require('js-yaml');
+const get = require('lodash.get');
 const validationHelper = require('./helpers/validationHelper');
 const getInfo = require('./helpers/infoHelper');
 const { getPaths } = require('./helpers/pathHelper');
@@ -43,12 +44,21 @@ module.exports = {
 			const resultSchema = Object.assign({}, openApiSchema, extensions);
 
 			switch (data.targetScriptOptions.format) {
-				case 'yaml':
-					cb(null, yaml.safeDump(resultSchema, { skipInvalid: true }));
+				case 'yaml': {
+					const schema = yaml.safeDump(resultSchema, { skipInvalid: true });
+					const schemaWithComments = addCommentsSigns(schema, 'yaml');
+					cb(null, schemaWithComments);
 					break;
+				}
 				case 'json':
-				default:
-					cb(null, JSON.stringify(resultSchema, null, 2));
+				default: {
+					const schemaString = JSON.stringify(resultSchema, null, 2);
+					let schema = addCommentsSigns(schemaString, 'json');
+					if (!get(data, 'options.isCalledFromFETab')) {
+						schema = removeCommentLines(schema);
+					}
+					cb(null, schema);
+				}
 			}
 		} catch (err) {
 			logger.log('error', { error: err }, 'OpenAPI FE Error');
@@ -58,17 +68,17 @@ module.exports = {
 
 	validate(data, logger, cb) {
 		const { script, targetScriptOptions } = data;
-
 		try {
+			const filteredScript = removeCommentLines(script);
 			let parsedScript = {};
 
 			switch (targetScriptOptions.format) {
 				case 'yaml':
-					parsedScript = yaml.safeLoad(script);
+					parsedScript = yaml.safeLoad(filteredScript);
 					break;
 				case 'json':
 				default:
-					parsedScript = JSON.parse(script);
+					parsedScript = JSON.parse(filteredScript);
 			}
 
 			validationHelper.validate(parsedScript)
@@ -85,3 +95,46 @@ module.exports = {
 		}
 	}
 };
+
+const addCommentsSigns = (string, format) => {
+	const commentsStart = /hackoladeCommentStart\d+/i;
+	const commentsEnd = /hackoladeCommentEnd\d+/i;
+	const innerCommentStart = /hackoladeInnerCommentStart/i;
+	const innerCommentEnd = /hackoladeInnerCommentEnd/i;
+	
+	const { result } = string.split('\n').reduce(({ isCommented, result }, line, index, array) => {
+		if (commentsStart.test(line) || innerCommentStart.test(line)) {
+			return { isCommented: true, result: result };
+		}
+		if (commentsEnd.test(line)) {
+			return { isCommented: false, result };
+		}
+		if (innerCommentEnd.test(line)) {
+			if (format === 'json') {
+				array[index + 1] = '# ' + array[index + 1];
+			}
+			return { isCommented: false, result };
+		}
+
+		const isNextLineInnerCommentStart = index + 1 < array.length && innerCommentStart.test(array[index + 1]);
+		if (isCommented || isNextLineInnerCommentStart) {
+			result = result + '# ' + line + '\n';
+		} else {
+			result = result + line + '\n';
+		}
+
+		return { isCommented, result };
+	}, { isCommented: false, result: '' });
+
+	return result;
+}
+
+const removeCommentLines = (scriptString) => {
+	const isCommentedLine = /^\s*#\s+/i;
+
+	return scriptString
+		.split('\n')
+		.filter(line => !isCommentedLine.test(line))
+		.join('\n')
+		.replace(/(.*?),\s*(\}|])/g, '$1$2');
+}

forward_engineering/helpers/componentsHelpers/responsesHelper.js

@@ -22,7 +22,7 @@ function getResponses(data) {
 		}, {});
 }
 
-function mapResponse(data, responseCollectionDescription) {
+function mapResponse(data, responseCollectionDescription, shouldResponseBeCommented = false) {
 	if (!data) {
 		return;
 	} 
@@ -34,8 +34,18 @@ function mapResponse(data, responseCollectionDescription) {
 	const content = getContent(get(data, `properties.content`));
 	const links = getLinks(get(data, `properties.links`));
 	const extensions = getExtensions(data.scopesExtensions);
+	const response = {};
+	if (shouldResponseBeCommented) {
+		response[`hackoladeInnerCommentStart`] = true;
+	}
+
+	Object.assign(response, { description, headers, content, links }, extensions);
+	
+	if (shouldResponseBeCommented) {
+		response[`hackoladeInnerCommentEnd`] = true;
+	}
 
-	return Object.assign({}, { description, headers, content, links }, extensions);
+	return response;
 }
 
 module.exports = {

forward_engineering/helpers/pathHelper.js

@@ -10,20 +10,28 @@ const { hasRef, getRef } = require('./typeHelper');
 function getPaths(containers, containersIdsForCallbacks = []) {
 	return containers
 		.filter(({ id }) => !containersIdsForCallbacks.includes(id))
-		.reduce((acc, container) => {
-			const { name } = container.containerData[0];
-			const containerData = getRequestsForContainer(container, containers);
+		.reduce((acc, container, index) => {
+			const { name, isActivated } = container.containerData[0];
+			const containerData = getRequestsForContainer(container, containers, [], isActivated);
+
+			if (!isActivated) {
+				acc[`hackoladeCommentStart${index}`] = true; 
+			}
 
 			acc[name] = containerData;
+
+			if (!isActivated) {
+				acc[`hackoladeCommentEnd${index}`] = true; 
+			}
 			return acc;
 		}, {});
 }
 
-function getRequestsForContainer(container, containers, containersPath = []) {
+function getRequestsForContainer(container, containers, containersPath = [], isPathActivated = true) {
 	const { contactExtensions, summary, description } = container.containerData[0];
 
 	const collections = container.entities.map(collectionId => JSON.parse(container.jsonSchema[collectionId]));
-	const containerData = getRequestData(collections, containers, container.id, containersPath);
+	const containerData = getRequestData(collections, containers, container.id, containersPath, isPathActivated);
 	const additionalContainerData = {
 		summary,
 		description: description || undefined 
@@ -34,7 +42,7 @@ function getRequestsForContainer(container, containers, containersPath = []) {
 	return Object.assign({}, containerData, additionalContainerData, containerExtensions);
 }
 
-function getRequestData(collections, containers, containerId, containersPath = []) {
+function getRequestData(collections, containers, containerId, containersPath = [], isPathActivated = true) {
 	return collections
 		.filter(collection => collection.entityType === 'request')
 		.map(data => {
@@ -46,21 +54,30 @@ function getRequestData(collections, containers, containerId, containersPath = [
 				operationId: data.operationId,
 				parameters: mapRequestParameters(get(data, 'properties.parameters')),
 				requestBody: mapRequestBody(get(data, 'properties.requestBody'), get(data, 'required', []).includes('requestBody')),
-				responses: mapResponses(collections, data.GUID),
+				responses: mapResponses(collections, data.GUID, isPathActivated && data.isActivated),
 				callbacks: getCallbacks(get(data, 'properties.callbacks'), containers, containerId, containersPath),
 				deprecated: data.deprecated,
 				security: commonHelper.mapSecurity(data.security),
 				servers: getServers(data.servers),
-				methodName: data.collectionName
+				methodName: data.collectionName,
+				isActivated: data.isActivated
 			};
 			const extensions = getExtensions(data.operationExtensions);
 
 			return Object.assign({}, request, extensions);
 		})
-		.reduce((acc, collection) => {
-			const { methodName } = collection;
+		.reduce((acc, collection, index) => {
+			const { methodName, isActivated } = collection;
 			delete collection.methodName;
+			delete collection.isActivated;
+			const shouldCommentedFlagBeInserted = !isActivated && isPathActivated;
+			if (shouldCommentedFlagBeInserted) {
+				acc[`hackoladeCommentStart${index}`] = true; 
+			}
 			acc[methodName] = collection;
+			if (shouldCommentedFlagBeInserted) {
+				acc[`hackoladeCommentEnd${index}`] = true; 
+			}
 			return acc;
 		}, {});
 }
@@ -76,7 +93,7 @@ function mapRequestParameters(parameters) {
 	return [mapParameter(parameters.items)];
 }
 
-function mapResponses(collections, collectionId) {
+function mapResponses(collections, collectionId, isParentActivated) {
 	if (!collections || !collectionId) {
 		return;
 	}
@@ -85,13 +102,13 @@ function mapResponses(collections, collectionId) {
 		.filter(collection => collection.entityType === 'response' && collection.parentCollection === collectionId)
 		.map(collection => {
 			const responseCode = collection.collectionName;
-			const response = mapResponse(get(collection, 'properties.response'), collection.description);
+			const shouldResponseBeCommented = !collection.isActivated && isParentActivated;
+			const response = mapResponse(get(collection, 'properties.response'), collection.description, shouldResponseBeCommented);
 
 			return { responseCode, response };
 		})
 		.reduce((acc, { responseCode, response }) => {
 			acc[responseCode] = response;
-
 			return acc;
 		}, {});
 

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "OpenAPI",
-	"version": "0.1.12",
-	"versionDate": "2020-01-03",
+	"version": "0.1.13",
+	"versionDate": "2020-01-16",
 	"author": "hackolade",
 	"engines": {
 		"hackolade": "3.3.0",

properties_pane/container_level/containerLevelConfig.json

@@ -147,6 +147,12 @@ making sure that you maintain a proper JSON format.
 				"propertyType": "details",
 				"template": "textarea"
 			},
+			{
+				"propertyName": "Activated",
+				"propertyKeyword": "isActivated",
+				"propertyType": "checkbox",
+				"propertyTooltip": "Deactivated item will be commented out in the schema"
+			},
 			{
 				"propertyName": "summary",
 				"propertyKeyword": "summary",

properties_pane/defaultData.json

@@ -5,19 +5,22 @@
 		"dbVendor": "OpenAPI"
 	},
 	"container": {
-		"name": "/path"
+		"name": "/path",
+		"isActivated": true
 	},
 	"collection": {
 		"collectionName": "get",
 		"entityType": "request",
 		"snippet": "requestStructure",
-		"subtype": "requestBody"
+		"subtype": "requestBody",
+		"isActivated": true
 	},
 	"nestedCollection": {
 		"collectionName": "200",
 		"entityType": "response",
 		"snippet": "responseStructure",
-		"subtype": "response"
+		"subtype": "response",
+		"isActivated": true
 	},
 	"field": {
 		"hackoladeMeta": {

properties_pane/entity_level/entityLevelConfig.json

@@ -234,6 +234,12 @@ making sure that you maintain a proper JSON format.
 				"propertyType": "checkbox",
 				"hidden": true
 			},
+			{
+				"propertyName": "Activated",
+				"propertyKeyword": "isActivated",
+				"propertyType": "checkbox",
+				"propertyTooltip": "Deactivated item will be commented out in the schema"
+			},
 			{
 				"propertyName": "schema",
 				"propertyKeyword": "pathItemSchema",

reverse_engineering/helpers/dataHelper.js

@@ -710,7 +710,8 @@ const handleRequestData = (requestData, request, fieldOrder) => {
 		entityType: REQUEST,
 		subtype: 'requestBody',
 		collectionName: request,
-		properties: requestSchema
+		properties: requestSchema,
+		isActivated: true
 	});
 	return { jsonSchema, responses };
 };
@@ -742,7 +743,8 @@ const handleResponseData = (responseObj, response, request, fieldOrder) => {
 		parentCollection: request,
 		properties: {
 			response: responseData
-		}
+		},
+		isActivated: true
 	};
 	return jsonSchema;
 };

reverse_engineering/helpers/resolveExternalDefinitionPathHelper.js

@@ -23,7 +23,7 @@ const resolvePath = (data, callback) => {
 	return callback(null, `${bucket}/${request}${addPropertiesToPath(path.slice(3))}`);
 };
 
-const addPropertiesToPath = path => path.length ? '/properties/' + path.join('/properties/') : '';
+const addPropertiesToPath = path => path.length ? '/properties/' + path.filter(item => item !== 'properties').join('/properties/') : '';
 
 module.exports = {
 	resolvePath