@sap/cds-dk 4.8.0 → 4.9.0

package/lib/compile/openapi/index.js

@@ -1,6 +1,5 @@
 const csdl2openapi = require('./csdl2openapi');
 const cds = require('@sap/cds');
-const { path4 } = cds.serve
 
 module.exports = function processor(csn, options = {}) {
 
@@ -55,6 +54,6 @@ function servicePath(csdl, csn) {
     if (csdl.$EntityContainer) {
         const serviceName = csdl.$EntityContainer.replace(/\.[^.]+$/, '')
         const service = csn.definitions[serviceName]
-        return path4(service)
+        return cds.service.path4 ? cds.service.path4(service) : cds.serve.path4(service)
     }
 }

package/lib/compile/to-xsuaa.js

@@ -3,7 +3,7 @@ const fs = require('fs')
 const path = require('path')
 
 const hardcoded = {
-  Scopes: ['system-user', 'authenticated-user', 'registered-user', 'identified-user', 'any'],
+  Scopes: ['system-user', 'authenticated-user', 'registered-user', 'identified-user', 'internal-user', 'any'],
   Attributes: ['id', 'tenant', 'ext_attr']
 }
 

package/lib/import/index.js

@@ -130,25 +130,32 @@ function _convertEDMXWithMultipleSchemas(edmx, multipleSchemas, namespace) {
 }
 
 async function edmx2csn(edmx, filename, context) {
-    const result = edmx.match(/EntityType="([^"]+)/);
-    const multipleSchemas = /(\s*<\/Schema>\s*<Schema [^>]*>)\s*/m;
-    if (!result) {
-        throw new Error(messages.MISSING_ENTITIES);
-    }
-    const index = result[1].lastIndexOf(".");
-	const namespace = (index > 0 ) ? result[1].substring(0, index) : result[1];
-
-    if (multipleSchemas.test(edmx)) {
-        edmx = _convertEDMXWithMultipleSchemas(edmx, multipleSchemas, namespace);
-    }
+	const result = edmx.match(/EntityType="([^"]+)/);
+	const multipleSchemas = /(\s*<\/Schema>\s*<Schema [^>]*>)\s*/m;
+	if (!result) {
+		throw new Error(messages.MISSING_ENTITIES);
+	}
+	const index = result[1].lastIndexOf(".");
+	const namespace = (index > 0) ? result[1].substring(0, index) : result[1];
+
+	if (multipleSchemas.test(edmx)) {
+		edmx = _convertEDMXWithMultipleSchemas(edmx, multipleSchemas, namespace);
+	}
 	let csn = await generateCSN(edmx, false, true, context);
+	const regex = /^[\p{Letter}\p{Nl}_]{1}[_\p{Letter}\p{Nl}\p{Nd}\p{Mn}\p{Mc}\p{Pc}\p{Cf}]{0,127}$/gu
+	// Regex checks for this condition “A-B” must start with a letter or underscore, followed by at most 127 letters, underscores or digits in the fileName
 	if (filename) {
 		// Replace namespace by given filename in the csn file instead of edmx file
-        const re = RegExp(`([("/])${namespace}([/").])`, 'g');
-        const fn = `$1${path.parse(filename).name}$2`;
+		const re = RegExp(`([("/])${namespace}([/").])`, 'g');
+		let name = path.parse(filename).name;
+		if (!(name.match(regex))) { // check if the filename is in the right format with the regex if not replace unaccepted characters with underscore (_)
+			name = name.replace(/^[^a-z\p{Nl}_]/gui, '_');
+			name = name.replace(/[^a-z0-9_\p{Nl}\p{Nd}\p{Mn}\p{Mc}\p{Pc}\p{Cf}]/gui, '_');
+		}
+		const fn = `$1${name}$2`;
 		csn = csn.replace(re, fn);
-    }
-    return JSON.parse(csn);
+	}
+	return JSON.parse(csn);
 }
 
 async function _generateEDMX2JSON(edmx) {

package/lib/import/message.js

@@ -13,7 +13,9 @@ const messages = {
 	OUTPUT_FILE_MISMATCH: 'Specify the file extension that --as option supports.',
 	INVALID_AS_OPTION: 'For --as option, please specify one of these output file format [cds, csn, json].',
 	INCORRECT_EXTENSION: 'If --as option is not provided, then please provide either .json or .csn output file extension.',
-	INCORRECT_INPUT_NAMESPACES: 'Invalid value for --include-namespaces option. Specify namespaces as comma-separated list or "*"'
+	INCORRECT_INPUT_NAMESPACES: 'Invalid value for --include-namespaces option. Specify namespaces as comma-separated list or "*"',
+	MISSING_ASSOCIATION_SETS: 'Input file provided has missing Association Sets. Please check the edmx file.',
+	COLLECTION_IN_KEY: 'Key Property of an Entity cannot be of the type Collection.'
 };
 
 function getMessages() {

package/lib/import/utils/MetadataConverter.js

@@ -583,7 +583,7 @@ class Expression {
             if(attrName)
                 attrName = attrName.replace(/-/g,'.');
             let attribute;
-            if ((MetadataConverter.custom_namespace.includes(prefix) && attrName !== undefined) || MetadataConverter.custom_namespace.includes(true))
+            if ((MetadataConverter.custom_namespace.includes(prefix) || MetadataConverter.custom_namespace.includes(true)) && attrName !== undefined)
                 attribute = "@" + prefix + "." + attrName;
             else if (attrName === undefined)
                 attribute = "$" + prefix;

package/lib/import/v2parser.js

@@ -231,6 +231,8 @@ function _extractAllAssociations(associations) {
 }
 
 function _extractEntityFromNamespace(entityName) {
+	if (!entityName)	
+		return;
 	let entityId = "";
 	let pos = entityName.lastIndexOf(".");
 	if (pos < 0) {
@@ -428,6 +430,11 @@ function _getServiceEntityProperty(
 		isCollection = 1;
 	}
 
+	//if primary key is of type Collection, an error is thrown
+	if (isKey && isCollection === 1) {
+		throw new Error(messages.COLLECTION_IN_KEY);
+	}
+
 	let cdsDataType = null;
 	let hasInvalidPrecision = false;
 	let propertyJson='';
@@ -657,24 +664,38 @@ function _parseParameter(parameter)
 	return csn;
 }
 
-function  _parseParametersFunctionImport(parameters, isBounded) {
+function _checkParameterKey(parameter, entityKeysList){
+	if ( entityKeysList && (Object.values(entityKeysList).indexOf(parameter._attributes.Name) > -1)){
+		return true;
+	}
+	return false;	
+}
+
+function  _parseParametersFunctionImport(parameters, isBounded, entityKeysList) {
 	let csn = "";
 	let parameterCsn = "";
-	let i = isBounded===1 ? 1 : 0;
+	let i = 0;
 	if(parameters.length)
 	{
-		for(i;i<parameters.length;i++)
-		{
-			parameterCsn = _parseParameter(parameters[i]);
-			csn = csn + parameterCsn;
-			if(i!== parameters.length - 1 && parameterCsn != "") {
-				csn = csn + ",\n";
-			} else {
-				csn = csn + "\n";
+		for (i; i < parameters.length; i++) {
+			// check if the parameter is a key of the entity type or not
+			// If yes then that paramater is ignored in CSN 
+			let isKey = _checkParameterKey(parameters[i], entityKeysList);
+			if (isKey == false) {
+				parameterCsn = _parseParameter(parameters[i]);
+				csn = csn + parameterCsn;
+				if (i !== parameters.length - 1 && parameterCsn != "") {
+					csn = csn + ",\n";
+				} else {
+					csn = csn + "\n";
+				}
 			}
 		}
 	} else {
-		csn = csn + _parseParameter(parameters);
+		let isKey = _checkParameterKey(parameters);
+		if (isKey === false) {
+			csn = csn + _parseParameter(parameters);
+		}
 	}
 
 	if (csn && (csn.endsWith(",\n") || csn.endsWith(",\n\n"))) {
@@ -683,7 +704,7 @@ function  _parseParametersFunctionImport(parameters, isBounded) {
 	return csn;
 }
 
-function _getFunctionImport(functionImport,isBounded) {
+function _getFunctionImport(functionImport,isBounded,entityKeysList) {
 	let noValue;
 	let csn = "";
 	csn = csn + '"' + functionImport[0] + '": { \n';
@@ -704,12 +725,12 @@ function _getFunctionImport(functionImport,isBounded) {
 	{
 		if(isBounded === 0 || (isBounded === 1 && functionImport[3] instanceof Array ))
 		{
-			let parametersCsn = _parseParametersFunctionImport(functionImport[3],isBounded);
+			let parametersCsn = _parseParametersFunctionImport(functionImport[3],isBounded,entityKeysList);
 			if(parametersCsn != "")
 			{
 				csn = csn + ", \n";
 				csn = csn + '"params": { \n';
-				csn = csn + _parseParametersFunctionImport(functionImport[3],isBounded);
+				csn = csn + parametersCsn;
 				csn = csn + '\n }';
 			}
 		}
@@ -735,13 +756,13 @@ function _getFunctionImport(functionImport,isBounded) {
 	return csn;
 }
 
-function _getAllFunctionImports(functionImports,isBounded) {
+function _getAllFunctionImports(functionImports,isBounded,entityKeysList) {
 	let functionImportsCSN = "";
 	let i;
 	let functionImportCSN = "";
 	for(i=0; i<functionImports.length;i++)
 	{
-		functionImportCSN = _getFunctionImport(functionImports[i],isBounded);
+		functionImportCSN = _getFunctionImport(functionImports[i],isBounded, entityKeysList);
 		functionImportsCSN = functionImportsCSN + functionImportCSN;
 		if(i!== functionImports.length - 1 && functionImportCSN !== "" ) {
 			functionImportsCSN = functionImportsCSN + ",\n";
@@ -1187,6 +1208,9 @@ function _getCSNAssociatedEntitySet(
 	mockServerUc
 ) {
 	let associationSet = allAssociationSets[relationshipName];
+	if(associationSet === undefined) {
+		throw new Error(messages.MISSING_ASSOCIATION_SETS);
+	}
 	let associationName = associationSet.Name;
 	let entityName = _getAssociatedEntity(
 		associationSet.End,
@@ -1296,6 +1320,16 @@ function _generateCSNEntityNavigationProperties(
 	return csn;
 }
 
+function _getBaseTypeEntityName(entityName, serviceNamespaceParam) {
+	let baseTypeName;
+	// if one entity type has mapping to multiple entity sets, use the first entity set
+	if (allEntitySetMapMC[entityName]) {
+		baseTypeName = serviceNamespaceParam + "." + allEntitySetMapMC[entityName][0];
+		return baseTypeName;
+	}
+	return entityName;
+}
+
 function _constructServiceEntity(
 	serviceNamespaceParam,
 	entityName,
@@ -1318,10 +1352,7 @@ function _constructServiceEntity(
 	if (ignorePersistenceSkip === false) {	
 		csnEntity = csnEntity + '"@cds.persistence.skip": true,\n';	
 	}
-	if (
-		entityAttributes.Abstract &&
-		entityAttributes.Abstract.toUpperCase() === "TRUE"
-	) {
+	if (entityAttributes.Abstract && entityAttributes.Abstract.toUpperCase() === "TRUE") {
 		csnEntity = csnEntity + '"abstract": true,\n';
 	}
 
@@ -1386,22 +1417,22 @@ function _constructServiceEntity(
 	csnEntity = csnEntity + "}\n";
 
 	if (entityAttributes.BaseType) {
+		let baseTypeName = _getBaseTypeEntityName(entityAttributes.BaseType, serviceNamespaceParam);
 		csnEntity = csnEntity + ",\n";
-		csnEntity =
-			csnEntity + '"includes": ["' + entityAttributes.BaseType + '"]\n';
+		csnEntity = csnEntity + '"includes": ["' + baseTypeName + '"]\n';
 	}
 
 	//if the function import is bounded to entitySet 
 	if (allFunctionImportsMap[entityName])
 	{
 		csnEntity = csnEntity + ', \n "actions": {\n';
-		csnEntity = csnEntity + _getAllFunctionImports(allFunctionImportsMap[entityName],1);
+		csnEntity = csnEntity + _getAllFunctionImports(allFunctionImportsMap[entityName],1,entityKeysList);
 		csnEntity = csnEntity + "}";
 	}
 	else if (allFunctionImportsMap[_extractEntityFromNamespace(allEntitySetMap[entityName])]) //if the function import is bounded to entityType
 	{
 		csnEntity = csnEntity + ', \n "actions": {\n';
-		csnEntity = csnEntity + _getAllFunctionImports(allFunctionImportsMap[_extractEntityFromNamespace(allEntitySetMap[entityName])],1);
+		csnEntity = csnEntity + _getAllFunctionImports(allFunctionImportsMap[_extractEntityFromNamespace(allEntitySetMap[entityName])],1,entityKeysList);
 		csnEntity = csnEntity + "}";
 	}
 
@@ -1442,10 +1473,7 @@ function _parseServiceEntity(
 		entityPropertiesMap = [];
 	}
 	// No navigation properties in entity
-	if (
-		entityNavigationPropertiesMap === undefined ||
-		entityNavigationPropertiesMap == null
-	) {
+	if (entityNavigationPropertiesMap === undefined || entityNavigationPropertiesMap == null) {
 		entityNavigationPropertiesMap = [];
 	}
 	// If inherited entity found
@@ -1467,16 +1495,9 @@ function _parseServiceEntity(
 	);
 }
 
-function _getEntitesWithNamesFromEntitySets(
-	serviceNamespaceParam,
-	entityJson,
-	mockServerUc
-) {
+function _getEntitesWithNamesFromEntitySets(serviceNamespaceParam, entityJson, mockServerUc) {
 	const getEntityName = mockServerUc
-		? (entity) =>
-			allEntitySetMapMC[
-			serviceNamespaceParam + "." + _getEntityName(entity)
-			]
+		? (entity) => allEntitySetMapMC[serviceNamespaceParam + "." + _getEntityName(entity)]
 		: (entity) => [_getEntityName(entity)];
 
 	const isNameInEntitySet = mockServerUc
@@ -1495,27 +1516,36 @@ function _getEntitesWithNamesFromEntitySets(
 	return entityJson
 		.map((entity) => ({
 			entity,
-			name: getEntityName(entity),
+			name: getEntityName(entity)
 		}))
 		.filter((entityWithName) => getEntitySetNames(entityWithName));
 }
 
-function _getServiceEntitites(
+function _getEntitesWithNamesFromEntityTypes(serviceNamespaceParam, entityJson) {
+	let entities = [];
+	// we are not making any decision here on the basis of mockserverUc variable as of now
+	for (let i = 0; i < entityJson.length; i++) {
+		let entity = _getEntityName(entityJson[i]);
+		// if entity doesn't have any mapping with entity set,
+		// then collect those entityType
+		if (!allEntitySetMapMC[serviceNamespaceParam + "." + entity]) {
+			entities.push( { 
+				entity: entityJson[i], 
+				name: [entity] 
+			} );
+		}
+	}
+
+	return entities;
+}
+
+function _parsingServiceEntities(
+	entitiesWithNames,
 	serviceNamespaceParam,
-	entityJson = [],
 	ignorePersistenceSkip,
 	mockServerUc
-) {
-	const entities = Array.isArray(entityJson) ? entityJson : [entityJson];
-	const entitiesWithNames = _getEntitesWithNamesFromEntitySets(
-		serviceNamespaceParam,
-		entities,
-		mockServerUc
-	);
-
-	if (entitiesWithNames.length) {
-		return (
-			entitiesWithNames.map((entityWithName) => 
+){
+	return  entitiesWithNames.map((entityWithName) => 
 				entityWithName.name.map((entityName) =>
 					_parseServiceEntity(
 						serviceNamespaceParam,
@@ -1524,11 +1554,37 @@ function _getServiceEntitites(
 						ignorePersistenceSkip,
 						mockServerUc
 					)
-				)
-				.join("},") + "}"
-			)
-		);
+				).join("},") + "}"
+			);
+}
+
+function _getServiceEntitites(
+	serviceNamespaceParam,
+	entityJson = [],
+	ignorePersistenceSkip,
+	mockServerUc
+) {
+	const entities = Array.isArray(entityJson) ? entityJson : [entityJson];
+	let entitiesWithNames = []; // [0]-> entity set, [1]-> entity type
+	let parsedEntities = []; // [0]-> entity set, [1]-> entity type
+
+	entitiesWithNames[0] = _getEntitesWithNamesFromEntitySets(serviceNamespaceParam, entities, mockServerUc);
+	entitiesWithNames[1] = _getEntitesWithNamesFromEntityTypes(serviceNamespaceParam, entities);
+
+	for (let i = 0; i < 2; i++) {
+		if (entitiesWithNames[i].length) {
+			parsedEntities[i] = _parsingServiceEntities(entitiesWithNames[i],
+				serviceNamespaceParam, ignorePersistenceSkip, mockServerUc);
+		}
 	}
+	// if entities from entity set and entity type both are parsed
+	if (parsedEntities[0] && parsedEntities[1])
+		return parsedEntities[0].concat(parsedEntities[1]);
+	else if (parsedEntities[0] && !parsedEntities[1])
+		return parsedEntities[0];
+	else if (!parsedEntities[0] && parsedEntities[1])
+		return parsedEntities[1];
+
 	return "";
 }
 
@@ -1606,7 +1662,7 @@ function _generateEDMXJSON2CSN(
 	//if there are unbounded function imports
 	if(Object.keys(allFunctionImports).length > 0)
 	{
-		definitions.push(_getAllFunctionImports(allFunctionImports,0)); //passing 0 for unbounded actions/functions
+		definitions.push(_getAllFunctionImports(allFunctionImports,0,0)); //passing 0 for unbounded actions/functions and 0 for entityKeysList 
 	}
 
 	if (entityJson) {