openapi-explorer 1.0.557 → 1.0.561

package/dist/lib/utils/schema-utils.js

@@ -63,7 +63,7 @@ function getTypeInfo(schema, options = {
     default: schema.default || '',
     title: schema.title || '',
     description: schema.description || '',
-    constraint: '',
+    constraints: [],
     allowedValues: (_schema$const = schema.const) !== null && _schema$const !== void 0 ? _schema$const : Array.isArray(schema.enum) ? schema.enum.join('┃') : '',
     arrayType: ''
   };
@@ -78,6 +78,10 @@ function getTypeInfo(schema, options = {
     info.allowedValues = (_schema$const2 = schema.const) !== null && _schema$const2 !== void 0 ? _schema$const2 : Array.isArray(schema.items.enum) ? schema.items.enum.join('┃') : '';
   }
 
+  if (schema.uniqueItems) {
+    info.constraints.push('Requires unique items');
+  }
+
   if (dataType.match(/integer|number/g)) {
     var _schema$minimum, _schema$maximum;
 
@@ -87,21 +91,21 @@ function getTypeInfo(schema, options = {
     const rightBound = schema.maximum !== undefined ? ']' : ')';
 
     if (typeof minimum === 'number' || typeof maximum === 'number') {
-      info.constraint = `Range: ${leftBound}${minimum !== null && minimum !== void 0 ? minimum : ''},${maximum !== null && maximum !== void 0 ? maximum : ''}${rightBound}`;
+      info.constraints.push(`Range: ${leftBound}${minimum !== null && minimum !== void 0 ? minimum : ''},${maximum !== null && maximum !== void 0 ? maximum : ''}${rightBound}`);
     }
 
     if (schema.multipleOf !== undefined) {
-      info.constraint += `${info.constraint ? ', ' : ''}Multiples: ${schema.multipleOf}`;
+      info.constraints.push(`Multiples: ${schema.multipleOf}`);
     }
   }
 
   if (dataType.match(/string/g)) {
     if (schema.minLength !== undefined && schema.maxLength !== undefined) {
-      info.constraint += `Min length: ${schema.minLength}, Max length: ${schema.maxLength}`;
+      info.constraints.push(`Min length: ${schema.minLength}, Max length: ${schema.maxLength}`);
     } else if (schema.minLength !== undefined) {
-      info.constraint += `Min length: ${schema.minLength}`;
+      info.constraints.push(`Min length: ${schema.minLength}`);
     } else if (schema.maxLength !== undefined) {
-      info.constraint += `Max length: ${schema.maxLength}`;
+      info.constraints.push(`Max length: ${schema.maxLength}`);
     }
   }
 
@@ -110,7 +114,7 @@ function getTypeInfo(schema, options = {
     format: info.format,
     cssType: info.cssType,
     readOrWriteOnly: info.readOrWriteOnly,
-    constraint: info.constraint,
+    constraints: info.constraints,
     defaultValue: info.default,
     example: info.example,
     allowedValues: info.allowedValues,
@@ -417,8 +421,23 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     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');
+  }
+
+  if (typeof schema.minItems === 'number' || typeof schema.maxItems === 'number') {
+    metadata.constraints.push(`Length: [${schema.minItems || 0}${schema.maxItems ? ', ' : '+'}${schema.maxItems || ''}]`);
+  }
 
   if (allOf) {
     // If allOf is an array of multiple elements, then all the keys makes a single object
@@ -491,8 +510,9 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     };
     resultObj['::title'] = schema.title || '';
     resultObj['::description'] = schema.description || '';
+    resultObj['::metadata'] = metadata;
     return resultObj;
-  } else if (Array.isArray(schema.type)) {
+  } else 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
@@ -504,7 +524,7 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     subSchema.type.forEach(v => {
       if (v.match(/integer|number|string|null|boolean/g)) {
         primitiveType.push(v);
-      } else if (v === 'array' && typeof (subSchema.items && subSchema.items.type) === 'string' && schema.items && subSchema.items.type.match(/integer|number|string|null|boolean/g)) {
+      } else if (v === 'array' && typeof (subSchema.items && subSchema.items.type) === 'string' && arrayItemsSchema && subSchema.items.type.match(/integer|number|string|null|boolean/g)) {
         // Array with primitive types should also be treated as primitive type
         if (subSchema.items.type === 'string' && subSchema.items.format) {
           primitiveType.push(`${subSchema.items.format}[]`);
@@ -551,16 +571,17 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
               '🆆': schema.writeOnly && '🆆'
             },
             '::type': 'object',
-            '::deprecated': schema.deprecated || false
+            '::deprecated': schema.deprecated || false,
+            '::metadata': metadata
           };
 
-          for (const key in schema.properties) {
+          for (const key in schemaProperties) {
             var _schema$required;
 
-            if (!schema.deprecated && !schema.properties[key].deprecated && (_schema$required = schema.required) !== null && _schema$required !== void 0 && _schema$required.includes(key)) {
-              objTypeOption[`${key}*`] = schemaInObjectNotation(schema.properties[key], options, level + 1);
+            if (!schema.deprecated && !schemaProperties[key].deprecated && (_schema$required = schema.required) !== null && _schema$required !== void 0 && _schema$required.includes(key)) {
+              objTypeOption[`${key}*`] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
             } else {
-              objTypeOption[key] = schemaInObjectNotation(schema.properties[key], options, level + 1);
+              objTypeOption[key] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
             }
           }
 
@@ -574,10 +595,11 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
               '🆆': schema.writeOnly && '🆆'
             },
             '::type': 'array',
-            '::props': schemaInObjectNotation(Object.assign({
-              readOnly: schema.readOnly,
-              writeOnly: schema.writeOnly
-            }, schema.items), options, level + 1)
+            // Array properties are read from the ::props object instead of reading from the keys of this object
+            // '::props': schemaInObjectNotation(Object.assign({ deprecated: schema.deprecated, readOnly: schema.readOnly, writeOnly: schema.writeOnly }, arrayItemsSchema), options, (level + 1)),
+            '::props': schemaInObjectNotation(Object.assign({}, schema, arrayItemsSchema), options, level + 1),
+            '::deprecated': schema.deprecated || false,
+            '::metadata': metadata
           };
         }
       });
@@ -586,7 +608,7 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     }
 
     return obj;
-  } else if (schema.type === 'object' || schema.properties) {
+  } else if (propertyType === 'object' || schemaProperties) {
     const obj = {
       '::type': ''
     };
@@ -598,19 +620,20 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     };
     obj['::type'] = 'object';
     obj['::deprecated'] = schema.deprecated || false;
+    obj['::metadata'] = metadata;
 
-    for (const key in schema.properties) {
+    for (const key in schemaProperties) {
       var _schema$required2;
 
-      if (!schema.deprecated && !schema.properties[key].deprecated && (_schema$required2 = schema.required) !== null && _schema$required2 !== void 0 && _schema$required2.includes(key)) {
-        obj[`${key}*`] = schemaInObjectNotation(schema.properties[key], options, level + 1);
+      if (!schema.deprecated && !schemaProperties[key].deprecated && (_schema$required2 = schema.required) !== null && _schema$required2 !== void 0 && _schema$required2.includes(key)) {
+        obj[`${key}*`] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
       } else {
-        obj[key] = schemaInObjectNotation(schema.properties[key], options, level + 1);
+        obj[key] = schemaInObjectNotation(schemaProperties[key], options, level + 1);
       }
     }
 
-    for (const key in schema.patternProperties) {
-      obj[`<pattern: ${key}>`] = schemaInObjectNotation(schema.patternProperties[key], options, level + 1);
+    for (const key in schemaPatternProperties) {
+      obj[`<pattern: ${key}>`] = schemaInObjectNotation(schemaPatternProperties[key], options, level + 1);
     }
 
     if (schema.additionalProperties) {
@@ -618,29 +641,25 @@ function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
     }
 
     return obj;
-  } else if (schema.type === 'array' || schema.items) {
-    var _schema$items2, _schema$items3;
-
+  } else if (propertyType === 'array' || arrayItemsSchema) {
     // If Array
     const obj = {
       '::type': ''
     };
     obj['::title'] = schema.title || '';
-    obj['::description'] = schema.description || ((_schema$items2 = schema.items) !== null && _schema$items2 !== void 0 && _schema$items2.description ? `array&lt;${schema.items.description}&gt;` : '');
+    obj['::description'] = schema.description || (arrayItemsSchema !== null && arrayItemsSchema !== void 0 && arrayItemsSchema.description ? `array&lt;${arrayItemsSchema.description}&gt;` : '');
     obj['::flags'] = {
       '🆁': schema.readOnly && '🆁',
       '🆆': schema.writeOnly && '🆆'
     };
     obj['::type'] = 'array';
     obj['::deprecated'] = schema.deprecated || false;
-    obj['::props'] = schemaInObjectNotation(Object.assign({
-      deprecated: schema.deprecated,
-      readOnly: schema.readOnly,
-      writeOnly: schema.writeOnly
-    }, schema.items), options, level + 1);
-
-    if ((_schema$items3 = schema.items) !== null && _schema$items3 !== void 0 && _schema$items3.items) {
-      obj['::array-type'] = schema.items.items.type;
+    obj['::metadata'] = metadata; // Array properties are read from the ::props object instead of reading from the keys of this object
+
+    obj['::props'] = schemaInObjectNotation(Object.assign({}, schema, arrayItemsSchema), options, level + 1); // obj['::props'] = schemaInObjectNotation(Object.assign({ deprecated: schema.deprecated, readOnly: schema.readOnly, writeOnly: schema.writeOnly }, arrayItemsSchema), options, (level + 1));
+
+    if (arrayItemsSchema !== null && arrayItemsSchema !== void 0 && arrayItemsSchema.items) {
+      obj['::array-type'] = arrayItemsSchema.items.type;
     }
 
     return obj;
@@ -686,7 +705,7 @@ function generateExample(examples, example, schema, rawMimeType, includeReadOnly
 
       finalExamples.push({
         exampleId: eg,
-        exampleSummary: examples[eg].summary || eg,
+        exampleSummary: examples[eg].summary || '',
         exampleDescription: examples[eg].description || '',
         exampleType: mimeType,
         exampleValue: egContent,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-explorer",
-  "version": "1.0.557",
+  "version": "1.0.561",
   "description": "OpenAPI Explorer - API viewer with dynamically generated components, documentation, and interaction console",
   "author": "Rhosys Developers <developers@rhosys.ch>",
   "type": "module",