Choices and references in components

Author: pdesmarets

forward_engineering/helpers/commonHelper.js

@@ -2,7 +2,10 @@ const get = require('lodash.get');
 const getExtensions = require('./extensionsHelper');
 const { hasRef } = require('./typeHelper');
 
-function mapEnum(enums = [], key) {
+function mapEnum(enums, key) {
+	if (!enums) {
+		return;
+	}
 	return enums
 		.filter(item => item[key])
 		.map(item => item[key]);

forward_engineering/helpers/componentsHelpers/index.js

@@ -7,12 +7,12 @@ const { getSecuritySchemes } = require('./securitySchemesHelper');
 const { getExamples } = require('./examplesHelper');
 const { getLinks } = require('./linksHelper');
 const { getCallbacks } = require('../pathHelper');
-
+const getExtensions = require('../extensionsHelper');
 
 function getComponents(data) {
-	const componentsData = get(JSON.parse(data.modelDefinitions), 'properties', {});
+    const componentsData = get(JSON.parse(data.modelDefinitions), 'properties', {});
 
-	const schemas = getSchemas(componentsData.schemas);
+    const schemas = getSchemas(componentsData.schemas);
     const responses = getResponses(componentsData.responses);
     const parameters = getParameters(componentsData.parameters);
     const examples = getExamples(componentsData.examples);
@@ -22,17 +22,23 @@ function getComponents(data) {
     const links = getLinks(componentsData.links);
     const callbacks = getCallbacks(componentsData.callbacks, data.containers);
 
-	return {
-        schemas,
-        responses,
-        parameters,
-        examples,
-        requestBodies,
-        headers,
-        securitySchemes,
-        links,
-        callbacks
-	};
+    const extensions = getExtensions(get(componentsData, `['Specification Extensions'].scopesExtensions`));
+
+    return Object.assign(
+        {}, 
+        {
+            schemas,
+            responses,
+            parameters,
+            examples,
+            requestBodies,
+            headers,
+            securitySchemes,
+            links,
+            callbacks
+        },
+        extensions
+    );
 }
 
 module.exports = getComponents;

forward_engineering/helpers/componentsHelpers/parametersHelper.js

@@ -38,7 +38,7 @@ function mapParameter(data, required) {
 		style: data.style,
 		explode: data.explode,
 		allowReserved: data.allowReserved,
-		schema: mapSchema(get(data, 'properties.schema')),
+		schema: mapSchema(get(data, 'properties.schema'), 'schema'),
 		example: data.sample,
 		examples: getExamples(get(data, 'properties.examples')),
 		content: getContent(get(data, 'properties.content'))
@@ -107,15 +107,15 @@ function mapMediaTypeObject(data) {
     if (!data || !data.properties) {
         return;
     }
-	let schema = mapSchema(get(data, 'properties.schema'));
+	let schema = mapSchema(get(data, 'properties.schema'), 'schema');
 	if (!schema && hasChoice(data)) {
 		schema = mapSchema({
 			type: 'object',
 			allOf: data.allOf,
 			oneOf: data.oneOf,
 			anyOf: data.anyOf,
 			not: data.not
-		});
+		}, 'schema');
 	}
     const examples = getExamples(get(data, 'properties.examples'));
     const encoding = mapEncoding(get(data, 'properties.encoding'));

forward_engineering/helpers/componentsHelpers/schemasHelper.js

@@ -1,4 +1,3 @@
-const get = require('lodash.get');
 const typeHelper = require('../typeHelper');
 
 function getSchemas(data) {
@@ -7,38 +6,13 @@ function getSchemas(data) {
 	}
 
 	return Object.keys(data.properties).reduce((acc, key) => {
-		acc[key] = mapSchema(prepareSchemaChoices(data.properties[key], key));
+		acc[key] = mapSchema(data.properties[key], key);
 		return acc;
 	}, {});
 }
 
-function mapSchema(data) {
-	return typeHelper.getType(data);
-}
-
-function prepareSchemaChoices(definition, key) {
-	const mapChoice = (item) => {
-		const choiceValue = get(item, `properties.${key}`); 
-		if (choiceValue) {
-			return choiceValue;
-		}
-		return item;
-	}
-
-	if (!definition) {
-		return;
-	}
-	const multipleChoices = ['allOf', 'anyOf', 'oneOf', 'not'];
-	return multipleChoices.reduce((acc, choice) => {
-		if (acc[choice]) {
-			if (choice === 'not') {
-				acc[choice] = mapChoice(acc[choice]);
-			} else {
-				acc[choice] = acc[choice].map(mapChoice); 
-			}
-		}
-		return acc;
-	}, Object.assign({}, definition));
+function mapSchema(data, key) {
+	return typeHelper.getType(data, key);
 }
 
 module.exports = {

forward_engineering/helpers/typeHelper.js

@@ -1,6 +1,7 @@
+const get = require('lodash.get');
 const getExtensions = require('./extensionsHelper');
 
-function getType(data) {
+function getType(data, key) {
 	if (!data) {
 		return;
 	}
@@ -13,10 +14,10 @@ function getType(data) {
 		return getRef(data);
 	}
 
-	return getTypeProps(data);
+	return getTypeProps(data, key);
 }
 
-function getTypeProps(data) {
+function getTypeProps(data, key) {
 	const { type, properties, items, required } = data;
 
 	switch (type) {
@@ -30,9 +31,9 @@ function getTypeProps(data) {
 				uniqueItems: data.uniqueItems || undefined,
 				discriminator: data.discriminator,
 				readOnly: data.readOnly,
-				xml: getXml(data.xml),
+				xml: getXml(data.xml)
 			};
-			const arrayChoices = getChoices(data);
+			const arrayChoices = getChoices(data, key);
 
 			return Object.assign({}, arrayProps, arrayChoices);
 		}
@@ -50,7 +51,7 @@ function getTypeProps(data) {
 				example: parseExample(data.sample),
 				xml: getXml(data.xml)
 			};
-			const objectChoices = getChoices(data);
+			const objectChoices = getChoices(data, key);
 
 			return Object.assign({}, objectProps, objectChoices);
 		}
@@ -87,7 +88,7 @@ function getObjectProperties(properties) {
 		return;
 	}
 	return Object.keys(properties).reduce((acc, propName) => {
-		acc[propName] = getType(properties[propName]);
+		acc[propName] = getType(properties[propName], propName);
 		return acc;
 	}, {});
 }
@@ -151,19 +152,31 @@ function getAdditionalProperties(data) {
 	return getAdditionalPropsObject(data);
 }
 
-function getChoices(data) {
-	const choices = {};
-	const multipleChoices = ['allOf', 'anyOf', 'oneOf'];
-	multipleChoices.forEach(choiceName => {
-		if (data[choiceName]) {
-			choices[choiceName] = data[choiceName].map(getType);
+function getChoices(data, key) {
+	const mapChoice = (item, key) => {
+		const choiceValue = get(item, `properties.${key}`); 
+		if (choiceValue) {
+			return getType(choiceValue);
 		}
-	})
-	if (data.not) {
-		choices.not = getType(data.not);
+		return getType(item);
 	}
 
-	return choices;
+	if (!data) {
+		return;
+	}
+	const { allOf, anyOf, oneOf, not } = data;
+	const multipleChoices = ['allOf', 'anyOf', 'oneOf', 'not'];
+
+	return multipleChoices.reduce((acc, choice) => {
+		if (acc[choice]) {
+			if (choice === 'not') {
+				acc[choice] = mapChoice(acc[choice], key);
+			} else {
+				acc[choice] = acc[choice].map(item => mapChoice(item, key)); 
+			}
+		}
+		return acc;
+	}, { allOf, anyOf, oneOf, not });
 }
 
 function hasChoice(data) {

package.json

@@ -1,7 +1,7 @@
 {
 	"name": "OpenAPI",
-	"version": "0.1.1",
-	"versionDate": "2019-06-23",
+	"version": "0.1.2",
+	"versionDate": "2019-06-26",
 	"author": "hackolade",
 	"engines": {
 		"hackolade": "3.3.0",
@@ -44,7 +44,10 @@
 				"entityLevel": true,
 				"containerLevel": true,
 				"fieldLevel": {
-					"componentObject": true
+					"componentObject": true,
+					"operationObject": true,
+					"extensions": true,
+					"media": true
 				}
 			},
 			"disableChildren": {

properties_pane/container_level/containerLevelConfig.json

@@ -164,8 +164,9 @@ making sure that you maintain a proper JSON format.
 					{
 						"propertyName": "pattern",
 						"propertyKeyword": "extensionPattern",
-						"shouldValidate": false,
-						"propertyType": "text"
+						"shouldValidate": true,
+						"propertyType": "text",
+						"regex":"^x-"
 					},
 					{
 						"propertyName": "value",

properties_pane/entity_level/entityLevelConfig.json

@@ -301,8 +301,9 @@ making sure that you maintain a proper JSON format.
 							{
 								"propertyName": "pattern",
 								"propertyKeyword": "extensionPattern",
-								"shouldValidate": false,
-								"propertyType": "text"
+								"shouldValidate": true,
+								"propertyType": "text",
+								"regex":"^x-"
 							},
 							{
 								"propertyName": "value",
@@ -446,8 +447,9 @@ making sure that you maintain a proper JSON format.
 									{
 										"propertyName": "pattern",
 										"propertyKeyword": "extensionPattern",
-										"shouldValidate": false,
-										"propertyType": "text"
+										"shouldValidate": true,
+										"propertyType": "text",
+										"regex":"^x-"
 									},
 									{
 										"propertyName": "value",
@@ -472,8 +474,9 @@ making sure that you maintain a proper JSON format.
 							{
 								"propertyName": "pattern",
 								"propertyKeyword": "extensionPattern",
-								"shouldValidate": false,
-								"propertyType": "text"
+								"shouldValidate": true,
+								"propertyType": "text",
+								"regex":"^x-"
 							},
 							{
 								"propertyName": "value",
@@ -498,8 +501,9 @@ making sure that you maintain a proper JSON format.
 					{
 						"propertyName": "pattern",
 						"propertyKeyword": "extensionPattern",
-						"shouldValidate": false,
-						"propertyType": "text"
+						"shouldValidate": true,
+						"propertyType": "text",
+						"regex":"^x-"
 					},
 					{
 						"propertyName": "value",