rapidoc 9.3.4 → 9.3.5

package/src/utils/schema-utils.js

@@ -1,3 +1,8 @@
+import RandExp from 'randexp';
+
+// Make RandExp determinist
+RandExp.prototype.randInt = (from) => from;
+
 // Takes a value as input and provides a printable string to replresent null values, spaces, blankstring etc
 export function getPrintableVal(val) {
   if (val === undefined) {
@@ -15,6 +20,10 @@ export function getPrintableVal(val) {
   if (Array.isArray(val)) {
     return val.map((v) => (v === null ? 'null' : v === '' ? '∅' : v.toString().replace(/^ +| +$/g, (m) => '●'.repeat(m.length)) || '')).join(', ');
   }
+  if (typeof val === 'object') {
+    const keys = Object.keys(val);
+    return `{ ${keys[0]}:${val[keys[0]]}${keys.length > 1 ? ',' : ''} ... }`;
+  }
   return val.toString().replace(/^ +| +$/g, (m) => '●'.repeat(m.length)) || '';
 }
 
@@ -154,7 +163,7 @@ export function normalizeExamples(examples, dataType = 'string') {
         description: v.description || '',
       }));
     const exampleVal = exampleList.length > 0
-      ? exampleList[0].value.toString()
+      ? exampleList[0].value
       : '';
     return { exampleVal, exampleList };
   }
@@ -219,7 +228,7 @@ export function getSampleValueByType(schemaObj) {
   }
   if (schemaObj.$ref) {
     // Indicates a Circular ref
-    return schemaObj.$ref;
+    return {};
   }
   if (schemaObj.const === false || schemaObj.const === 0 || schemaObj.const === null || schemaObj.const === '') {
     return schemaObj.const;
@@ -227,9 +236,12 @@ export function getSampleValueByType(schemaObj) {
   if (schemaObj.const) {
     return schemaObj.const;
   }
+  if (schemaObj.default) {
+    return schemaObj.default;
+  }
   const typeValue = Array.isArray(schemaObj.type) ? schemaObj.type[0] : schemaObj.type;
   if (!typeValue) {
-    return '?';
+    return null;
   }
   if (typeValue.match(/^integer|^number/g)) {
     const multipleOf = Number.isNaN(Number(schemaObj.multipleOf)) ? undefined : Number(schemaObj.multipleOf);
@@ -253,7 +265,13 @@ export function getSampleValueByType(schemaObj) {
   if (typeValue.match(/^string/g)) {
     if (schemaObj.enum) { return schemaObj.enum[0]; }
     if (schemaObj.const) { return schemaObj.const; }
-    if (schemaObj.pattern) { return schemaObj.pattern; }
+    if (schemaObj.pattern) {
+      try {
+        return new RandExp(schemaObj.pattern).gen();
+      } catch (error) {
+        return schemaObj.pattern;
+      }
+    }
     if (schemaObj.format) {
       const u = `${Date.now().toString(16)}${Math.random().toString(16)}0`.repeat(16);
       switch (schemaObj.format.toLowerCase()) {
@@ -280,6 +298,8 @@ export function getSampleValueByType(schemaObj) {
           return '2001:0db8:5b96:0000:0000:426f:8e17:642a';
         case 'uuid':
           return [u.substr(0, 8), u.substr(8, 4), `4000-8${u.substr(13, 3)}`, u.substr(16, 12)].join('-');
+        case 'byte':
+          return 'ZXhhbXBsZQ=='; // 'example' base64 encoded. See https://spec.openapis.org/oas/v3.0.0#data-types
         default:
           return '';
       }
@@ -291,7 +311,7 @@ export function getSampleValueByType(schemaObj) {
     }
   }
   // If type cannot be determined
-  return '?';
+  return null;
 }
 
 /*
@@ -584,6 +604,11 @@ export function schemaToSampleObj(schema, config = { }) {
         }
         obj = mergePropertyExamples(obj, propertyName, schemaToSampleObj(schema.properties[propertyName], config));
       }
+      if (typeof schema.additionalProperties === 'object') {
+        const propertyName = schema.additionalProperties['x-additionalPropertiesName'] || 'property';
+        obj = mergePropertyExamples(obj, `${propertyName}1`, schemaToSampleObj(schema.additionalProperties, config));
+        obj = mergePropertyExamples(obj, `${propertyName}2`, schemaToSampleObj(schema.additionalProperties, config));
+      }
     }
   } else if (schema.type === 'array' || schema.items) {
     if (schema.items || schema.example) {
@@ -790,6 +815,7 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::type'] = 'object';
     if ((Array.isArray(schema.type) && schema.type.includes('null')) || schema.nullable) {
       obj['::dataTypeLabel'] = 'object or null';
+      obj['::nullable'] = true;
     }
     obj['::deprecated'] = schema.deprecated || false;
     obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
@@ -812,6 +838,7 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::type'] = 'array';
     if ((Array.isArray(schema.type) && schema.type.includes('null')) || schema.nullable) {
       obj['::dataTypeLabel'] = 'array or null';
+      obj['::nullable'] = true;
     }
     obj['::deprecated'] = schema.deprecated || false;
     obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';

package/src/utils/spec-parser.js

@@ -3,7 +3,7 @@ import OpenApiParser from '@apitools/openapi-parser';
 import { marked } from 'marked';
 import { invalidCharsRegEx, rapidocApiKey, sleep } from '~/utils/common-utils';
 
-export default async function ProcessSpec(specUrl, generateMissingTags = false, sortTags = false, sortEndpointsBy = '', attrApiKey = '', attrApiKeyLocation = '', attrApiKeyValue = '', serverUrl = '') {
+export default async function ProcessSpec(specUrl, generateMissingTags = false, sortTags = false, sortSchemas = false, sortEndpointsBy = '', attrApiKey = '', attrApiKeyLocation = '', attrApiKeyValue = '', serverUrl = '') {
   let jsonParsedSpec;
   try {
     this.requestUpdate(); // important to show the initial loader
@@ -53,7 +53,7 @@ export default async function ProcessSpec(specUrl, generateMissingTags = false,
   const tags = groupByTags(jsonParsedSpec, sortEndpointsBy, generateMissingTags, sortTags);
 
   // Components
-  const components = getComponents(jsonParsedSpec);
+  const components = getComponents(jsonParsedSpec, sortSchemas);
 
   // Info Description Headers
   const infoDescriptionHeaders = jsonParsedSpec.info?.description ? getHeadersFromMarkdown(jsonParsedSpec.info.description) : [];
@@ -162,7 +162,7 @@ function getHeadersFromMarkdown(markdownContent) {
   return headers || [];
 }
 
-function getComponents(openApiSpec) {
+function getComponents(openApiSpec, sortSchemas = false) {
   if (!openApiSpec.components) {
     return [];
   }
@@ -184,6 +184,10 @@ function getComponents(openApiSpec) {
 
     switch (component) {
       case 'schemas':
+        if (sortSchemas) {
+          subComponents.sort((c1, c2) => c1.name.localeCompare(c2.name));
+        }
+
         cmpName = 'Schemas';
         cmpDescription = 'Schemas allows the definition of input and output data types. These types can be objects, but also primitives and arrays.';
         break;
@@ -246,6 +250,7 @@ function groupByTags(openApiSpec, sortEndpointsBy, generateMissingTags = false,
       show: true,
       elementId: `tag--${v.name.replace(invalidCharsRegEx, '-')}`,
       name: v.name,
+      displayName: v['x-displayName'] || v.name,
       description: v.description || '',
       headers: v.description ? getHeadersFromMarkdown(v.description) : [],
       paths: [],