Merge pull request #240 from Authress-Engineering/render-unknown-sche…

…ma-types Prevent issues with explicitly null properties. fix #238.
Authress-Engineering · Feb 19, 2024 · a8c5bf8 · a8c5bf8
2 parents 710ba83 + 18a424f
commit a8c5bf8
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 13 deletions.
diff --git a/src/components/schema-table.js b/src/components/schema-table.js
@@ -189,9 +189,9 @@ export default class SchemaTable extends LitElement {
     } else if (data['::type']) {
       displaySchemaLink = data['::link'];
       if (dataType === 'array') {
-        detailObjType = data['::link'] || keyLabel.replace(/(s|Collection|List)[*]?$/i, ''); // Array of Object
+        detailObjType = data['::link'] || keyLabel.replace(/(s|Collection|List)[*]?$/i, '').replace(/[*]$/, ''); // Array of Object
       } else {
-        detailObjType = data['::link'] || data['::type'];
+        detailObjType = (data['::link'] || data['::type']).replace(/[*]$/, '');
       }
     }
 

diff --git a/src/utils/common-utils.js b/src/utils/common-utils.js
@@ -71,7 +71,7 @@ export function pathIsInSearch(searchVal, path) {
     || stringToSearch.toLowerCase().normalize('NFD').replace(/[\u0300-\u036f]/g, '').includes(searchVal);
 }
 
-export function schemaKeys(schemaProps, result = new Set()) {
+function schemaKeys(schemaProps, result = new Set()) {
   if (!schemaProps) {
     return result;
   }

diff --git a/src/utils/schema-utils.js b/src/utils/schema-utils.js
@@ -269,7 +269,7 @@ function getSimpleValueResult(schema, config, namespace, prefix, xmlAttributes,
     let objectExamples = [{}];
 
     Object.keys(schema.properties || {}).forEach((propertyName) => {
-      const innerSchema = schema.properties[propertyName];
+      const innerSchema = schema.properties[propertyName] || {};
       if (innerSchema.deprecated) { return; }
       if (innerSchema.readOnly && !config.includeReadOnly) { return; }
       if (innerSchema.writeOnly && !config.includeWriteOnly) { return; }
@@ -311,10 +311,7 @@ export function isPatternProperty(label) {
  * @param {string} suffix - used for suffixing property names to avoid duplicate props during object composition
  */
 export function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
-  if (!rawSchema) {
-    return undefined;
-  }
-  const { allOf, oneOf, anyOf, items: arrayItemsSchema, properties: schemaProperties, patternProperties: schemaPatternProperties, ...schema } = rawSchema;
+  const { allOf, oneOf, anyOf, items: arrayItemsSchema, properties: schemaProperties, patternProperties: schemaPatternProperties, ...schema } = (rawSchema || {});
   const propertyType = schema.type;
   const metadata = { constraints: [] };
   if (schema.uniqueItems) { metadata.constraints.push('Requires unique items'); }
@@ -342,7 +339,9 @@ export function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '
 
     const obj = schemaInObjectNotation(schema, options, 0);
     return Object.assign({}, objWithAllProps, typeof obj === 'object' && !Array.isArray(obj) ? obj : {});
-  } else if (anyOf || oneOf) {
+  }
+
+  if (anyOf || oneOf) {
     const objWithAnyOfProps = {};
     let writeOnly = true;
     let readOnly = true;
@@ -385,7 +384,9 @@ export function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '
     resultObj['::description'] = schema.description || '';
     resultObj['::metadata'] = metadata;
     return resultObj;
-  } else if (Array.isArray(propertyType)) {
+  }
+
+  if (Array.isArray(propertyType)) {
     const obj = { '::type': '' };
     // When a property has multiple types, then check further if any of the types are array or object, if yes then modify the schema using one-of
     // Clone the schema - as it will be modified to replace multi-data-types with one-of;
@@ -467,7 +468,9 @@ export function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '
       obj['::ONE~OF'] = multiTypeOptions;
     }
     return obj;
-  } else if (propertyType === 'object' || schemaProperties) {
+  }
+
+  if (propertyType === 'object' || schemaProperties) {
     const obj = { '::type': '' };
     obj['::title'] = schema.title || '';
     obj['::description'] = schema.description || '';
@@ -477,7 +480,7 @@ export function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '
     obj['::deprecated'] = schema.deprecated || false;
     obj['::metadata'] = metadata;
     for (const key in schemaProperties) {
-      if (!schema.deprecated && !schemaProperties[key].deprecated && schema.required?.includes(key)) {
+      if (!schema.deprecated && !schemaProperties[key]?.deprecated && schema.required?.includes(key)) {
         obj[`${key}*`] = schemaInObjectNotation(schemaProperties[key], options, (level + 1));
       } else {
         obj[key] = schemaInObjectNotation(schemaProperties[key], options, (level + 1));
@@ -490,7 +493,9 @@ export function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '
       obj['<any-key>'] = schemaInObjectNotation(schema.additionalProperties, options);
     }
     return obj;
-  } else if (propertyType === 'array' || arrayItemsSchema) { // If Array
+  }
+
+  if (propertyType === 'array' || arrayItemsSchema) { // If Array
     const obj = { '::type': '' };
     obj['::title'] = schema.title || '';
     obj['::description'] = schema.description || (arrayItemsSchema?.description ? `array&lt;${arrayItemsSchema.description}&gt;` : '');