@sap/cds-dk 4.5.0 → 4.6.0

package/lib/import/v2parser.js

@@ -15,8 +15,12 @@ let allAssociations = {};
 let allAssociationSets = {};
 let allComplexTypes = {};
 let allComplexTypeDocs = {};
+let allComplexTypeNamespaces = {};
 let allInheritedComplexTypes = {};
+let allowedNamespaces = [];
+let allowAllNamespaces = false;
 let messages = require("./message").getMessages();
+let common = require("./common");
 let versionInfo = require('../../package.json').version;
 
 let edmxncdsdatatype = {
@@ -56,9 +60,49 @@ function _initialize() {
 	allAssociationSets = {};
 	allComplexTypes = {};
 	allComplexTypeDocs = {};
+	allComplexTypeNamespaces = {};
 	allInheritedComplexTypes = {};
+	allowedNamespaces = [];
+	allowAllNamespaces = false;
 }
 
+// Function to extract allowed namespace attributes from given set of attributes
+function namespaceAttributeFilter(attributes) {
+	let namespaceAttributes = allowAllNamespaces
+		? Object.keys(attributes).filter((attr) => attr.includes(':'))
+		: Object.keys(attributes).filter(
+				(attr) =>
+					attr.includes(':') &&
+					allowedNamespaces.includes(attr.split(':')[0]));
+			
+
+	namespaceAttributes = namespaceAttributes.map(attribute => {
+		const index = attribute.indexOf(':');
+		let namespace = attribute.slice(0, index);
+		let name = attribute.slice(index + 1);
+
+		name = name.replace(/-/g, '.');
+
+		let formattedAttribute = {};
+		formattedAttribute[`${namespace}.${name}`] = _replaceSpecialCharacters(attributes[attribute]);
+		return formattedAttribute;
+	});
+
+	return namespaceAttributes;
+}
+
+//Function to generate CSN for namespace attributes 
+function _generateNamespaceAttributes(attributes, isBefore) {
+	let csn = "";
+	attributes.forEach((attr) => {
+		let key = Object.keys(attr)[0];
+		if (isBefore) csn = csn + ',\n';
+		csn = csn + `"@${key}":"${attr[key]}"`;
+		if (!isBefore) csn = csn + ',\n';
+	});
+
+	return csn;
+}
 function _isValidEDMX(jsonObj) {
 	let isValid = false;
 	let edmx;
@@ -299,18 +343,20 @@ function _extractAllFunctionImports(functionImports, serviceNamespaceParam)
 	}
 }
 
+function _replaceSpecialCharacters(text) {
+    return text.replace(/(?:\\[rn]|[\r\n]+)+/gm, "\\n").replace(/\s+/g, ' ').replace(/"/g, """).trim();
+}
+
 // to parse the documentation tag
 function _parseDocumentationTag(documentedContent) {
-	let documentation = "", text = "";
+	let documentation = "";
 	if (documentedContent.Summary && documentedContent.Summary._text) {
-		text = documentedContent.Summary._text.replace(/(?:\\[rn]|[\r\n]+)+/gm, "\\n");
-		documentation = text;
+		documentation = _replaceSpecialCharacters(documentedContent.Summary._text);
 	}	
 	if (documentedContent.LongDescription && documentedContent.LongDescription._text) {
 		if (documentedContent.Summary)
 			documentation += "\\n\\n";
-		text = documentedContent.LongDescription._text.replace(/(?:\\[rn]|[\r\n]+)+/gm, "\\n");
-		documentation += text;
+		documentation += _replaceSpecialCharacters(documentedContent.LongDescription._text);
 	}
 	return documentation;
 }
@@ -319,10 +365,12 @@ function _extractComplexType(complexType, serviceNamespaceParam) {
 	let complexTypeKey = "";
 	let baseType = "";
 	let properties;
+	let namespaceAttributes = {};
 	Object.keys(complexType).forEach((key) => {
 		if (key === "_attributes") {
 			complexTypeKey =
 				serviceNamespaceParam + "." + complexType[key].Name;
+			namespaceAttributes = namespaceAttributeFilter(complexType[key]);
 			baseType = complexType[key].BaseType;
 		} else if (key === "Property") {
 			properties = complexType.Property;
@@ -334,6 +382,9 @@ function _extractComplexType(complexType, serviceNamespaceParam) {
 	if (complexTypeKey && baseType) {
 		allInheritedComplexTypes[complexTypeKey] = baseType;
 	}
+	if (namespaceAttributes.length) {
+		allComplexTypeNamespaces[complexTypeKey] = namespaceAttributes;
+	}
 }
 
 function _extractAllComplexTypes(complexTypes, serviceNamespaceParam) {
@@ -358,7 +409,8 @@ function _getServiceEntityProperty(
 	displayFormat,
 	isKey,
 	documentation,
-	isCollection
+	isCollection,
+	allowedNamespaceAttributes = -1
 ) {
 	let cdsDataType = null;
 	let hasInvalidPrecision = false;
@@ -424,6 +476,10 @@ function _getServiceEntityProperty(
 		propertyJson = propertyJson + ',\n"doc":"' + documentation + '"';
 	}
 
+	if (allowedNamespaceAttributes !== -1) {
+		propertyJson += _generateNamespaceAttributes(allowedNamespaceAttributes, true);
+	}
+
 	if(propertyName)
 		propertyJson = propertyJson + "\n}";
 	return propertyJson;
@@ -434,6 +490,9 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 	let complexTypeProperty;
 	let i;
 	complexTypeCSN = complexTypeCSN + '"kind": "type",\n';
+	if(allComplexTypeNamespaces[complexTypeKey]) {
+		complexTypeCSN += _generateNamespaceAttributes(allComplexTypeNamespaces[complexTypeKey], false);
+	}
 	if (allComplexTypeDocs[complexTypeKey])
 		complexTypeCSN = complexTypeCSN + '"doc":' + `"${allComplexTypeDocs[complexTypeKey]}",` + "\n";
 	complexTypeCSN = complexTypeCSN + '"elements": {\n';
@@ -444,6 +503,10 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 				complexTypeProperty = complexType[i]._attributes;
 				if(complexType[i].Documentation)
 					complexTypeProperty.doc = _parseDocumentationTag(complexType[i].Documentation);
+
+				let namespaceAttributes = namespaceAttributeFilter(complexTypeProperty)	
+				const complexTypePropertyNamespace = namespaceAttributes.length ? namespaceAttributes : -1
+					
 				complexTypeCSN =
 					complexTypeCSN +
 					_getServiceEntityProperty(
@@ -455,7 +518,8 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 						complexTypeProperty["sap:display-format"],
 						false,
 						complexTypeProperty.doc,
-						-1
+						-1,
+						complexTypePropertyNamespace
 					);
 				if (i !== complexType.length - 1) {
 					complexTypeCSN = complexTypeCSN + ",\n";
@@ -468,6 +532,10 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 			complexTypeProperty = complexType._attributes;
 			if(complexType.Documentation)
 				complexTypeProperty.doc = _parseDocumentationTag(complexType.Documentation);
+
+			let namespaceAttributes = namespaceAttributeFilter(complexTypeProperty);
+			const complexTypePropertyNamespace = namespaceAttributes.length ? namespaceAttributes : -1;
+			
 			complexTypeCSN =
 				complexTypeCSN +
 				_getServiceEntityProperty(
@@ -479,7 +547,8 @@ function _getServiceComplexType(complexTypeKey, complexType) {
 					complexTypeProperty["sap:display-format"],
 					false,
 					complexTypeProperty.doc,
-					-1
+					-1,
+					complexTypePropertyNamespace
 				);
 		}
 	}
@@ -524,6 +593,10 @@ function _parseParameter(parameter)
 	let isCollection = -1;
 	if(parameter.Documentation)
 		doc = _parseDocumentationTag(parameter.Documentation);
+
+	let namespaceAttributes = namespaceAttributeFilter(parameter._attributes);
+	const parameterNamespaceAttributes = namespaceAttributes.length ? namespaceAttributes : -1;
+
 	let type = parameter["_attributes"].Type;
 	if(type.substring(0,10) === 'Collection')
 	{
@@ -538,7 +611,8 @@ function _parseParameter(parameter)
 				parameter["_attributes"]["sap:display-format"],
 				false,
 				doc,
-				isCollection);
+				isCollection,
+				parameterNamespaceAttributes);
 	return csn;
 }
 
@@ -602,7 +676,7 @@ function _getFunctionImport(functionImport,isBounded) {
 	}
 	if(functionImport[4] !== -1)
 	{
-		csn = csn + ',\n "doc": "' + functionImport[4] + '"'; 
+		csn = csn + ',\n "doc": "' + _replaceSpecialCharacters(functionImport[4]) + '"';
 	}
 
 	csn = csn + "\n }";
@@ -637,6 +711,8 @@ function _parseEntityAttributes(attributes) {
 	entityAttributes.Name = attributes.Name;
 	entityAttributes.BaseType = attributes.BaseType;
 	entityAttributes.Abstract = attributes.Abstract;
+	entityAttributes.allowedNamespaceAttributes = namespaceAttributeFilter(attributes);
+
 	return entityAttributes;
 }
 
@@ -658,6 +734,9 @@ function _parseEntityKeys(keys) {
 
 function _getPropertyAttributes(propAttributes) {
 	let propOthers = [];
+
+	let namespaceAttributes = namespaceAttributeFilter(propAttributes)
+
 	propOthers.push(propAttributes.Type);
 	if (propAttributes.MaxLength) {
 		propOthers.push(propAttributes.MaxLength);
@@ -687,6 +766,13 @@ function _getPropertyAttributes(propAttributes) {
 	}else{
 		propOthers.push(-1);
 	}
+
+	if (namespaceAttributes.length) {
+		propOthers.push(namespaceAttributes);
+	} else {
+		propOthers.push(-1);
+	}
+
 	return propOthers;
 }
 
@@ -755,7 +841,8 @@ function _generateCSNEntityKeys(entityKeysList, entityPropertiesMap) {
 				propAttributes[4],
 				true,
 				propAttributes[5],
-				-1
+				-1,
+				propAttributes[6]
 			);
 		if (i !== entityKeysList.length - 1) {
 			csnEntity = csnEntity + ",\n";
@@ -793,7 +880,8 @@ function _generateCSNEntityProperties(entityKeysList, entityPropertiesMap) {
 					propAttributes[4],
 					false,
 					propAttributes[5],
-					-1
+					-1,
+					propAttributes[6]
 				);
 			if (i !== entityProperties.length - 1) {
 				csnEntity = csnEntity + ",\n";
@@ -1075,6 +1163,7 @@ function _getServiceEntityNavigationProperty(navPropAttributes, mockServerUc) {
 	let navPropName;
 	let relationshipName;
 	let navPropDoc;
+	let allowedNamespaceAttributes = namespaceAttributeFilter(navPropAttributes);
 	// var fromRole;
 	let toRole;
 	if (!navPropAttributes) {
@@ -1087,18 +1176,28 @@ function _getServiceEntityNavigationProperty(navPropAttributes, mockServerUc) {
 	navPropDoc = navPropAttributes.doc;
 
 	csn = csn + '"' + navPropName + '": {\n';
+	if(allowedNamespaceAttributes.length) {
+		csn += _generateNamespaceAttributes(allowedNamespaceAttributes, false);
+	}
 	// if documentatin exists for navigation property
-	if(navPropDoc)
-		csn = csn + `"doc": "${navPropDoc}",` + "\n";
+	if (navPropDoc) {
+		csn = csn + '"doc":' + `"Please add  an ON condition\\n${navPropDoc}",\n`;
+	} else {
+		csn = csn + '"doc": "Please add  an ON condition", \n';
+	}
 	csn = csn + '"type": "cds.Association",\n';
-	csn =
-		csn +
+	csn = csn +
 		_getCSNAssociatedEntitySet(
 			relationshipName,
 			toRole,
 			navPropName,
 			mockServerUc
 		);
+	// Convert managed associations and compositions in unmanaged with empty key to avoid
+    // "generation" of keys, that do not exist in the external service.
+	if (common.checkForEmptyKeys(csn, "V2")) {
+		csn = csn + ',\n"keys": []\n';
+	}
 	csn = csn + "}";
 
 	return csn;
@@ -1156,8 +1255,8 @@ function _constructServiceEntity(
 	let csnProperties;
 	let hasProperties;
 	csnEntity = csnEntity + '"kind": "entity",\n';
-	if (ignorePersistenceSkip === false) {
-		csnEntity = csnEntity + '"@cds.persistence.skip": true,\n';
+	if (ignorePersistenceSkip === false) {	
+		csnEntity = csnEntity + '"@cds.persistence.skip": true,\n';	
 	}
 	if (
 		entityAttributes.Abstract &&
@@ -1165,6 +1264,11 @@ function _constructServiceEntity(
 	) {
 		csnEntity = csnEntity + '"abstract": true,\n';
 	}
+
+	if(entityAttributes.allowedNamespaceAttributes.length)
+	{
+		csnEntity += _generateNamespaceAttributes(entityAttributes.allowedNamespaceAttributes, false);
+	}
 	// if documentation exists for the entity
 	if (documentation) {
 		csnEntity = csnEntity + `"doc": "${documentation}",` + '\n';
@@ -1395,11 +1499,12 @@ function _generateEDMXJSON2CSN(
 	const definitions = [];
 
 	if (mockServerUc) {
-		let def = '"' + serviceNamespaceParam + '": {"kind": "service"';
-		let schemaDoc = jsonObj["edmx:Edmx"]["edmx:DataServices"].Schema.Documentation;
-		// if documentation exists for schema
-		if(schemaDoc)
-			def += ',\n' + `"doc": "${_parseDocumentationTag(schemaDoc)}"`;
+		let def  = '"' + serviceNamespaceParam + '": {"kind": "service"' + ',\n' + '"@cds.external": true';
+		
+		let serviceDoc = jsonObj["edmx:Edmx"]["edmx:DataServices"]["Schema"].EntityContainer.Documentation;
+		// if documentation exists for service
+		if(serviceDoc)
+			def += ',\n' + `"doc": "${_parseDocumentationTag(serviceDoc)}"`;
 		def += "}";
 		definitions.push(def);
 	}
@@ -1437,14 +1542,27 @@ function _generateEDMXJSON2CSN(
 function getEdmxv2CSN(
 	edmx2jsonModel,
 	ignorePersistenceSkip,
-	mockServerUc
+	mockServerUc,
+	context
 ) {
 	let csnDataModel;
 	let isValid;
 	_initialize();
+	if (!context.include_all_namespaces && context.namespaces.length) {
+		allowedNamespaces = allowedNamespaces.concat(context.namespaces)
+	}
+	else if(context.include_all_namespaces) {
+		allowAllNamespaces = true;
+	} 
+
 	isValid = _validateEDMX(edmx2jsonModel);
 	if (isValid) {
 		serviceNamespace = _getServiceNameSpace(edmx2jsonModel);
+		let namespaceAlias = edmx2jsonModel["edmx:Edmx"]["edmx:DataServices"].Schema._attributes.Alias;
+		// replace the namespace alias value with original namespace value
+		if (namespaceAlias) {
+			edmx2jsonModel = common.replaceAliasValue(JSON.stringify(edmx2jsonModel), serviceNamespace, namespaceAlias);
+		}
 		csnDataModel = _generateEDMXJSON2CSN(
 			edmx2jsonModel,
 			serviceNamespace,