rapidoc 9.2.0 → 9.3.3

package/src/utils/schema-utils.js

@@ -12,7 +12,7 @@ export function getTypeInfo(schema) {
     const schemaNode = schema.$ref.substring(n + 1);
     dataType = `{recursive: ${schemaNode}} `;
   } else if (schema.type) {
-    dataType = Array.isArray(schema.type) ? schema.type.join('┃') : schema.type;
+    dataType = Array.isArray(schema.type) ? schema.type.join(schema.length === 2 ? ' or ' : '┃') : schema.type;
     if (schema.format || schema.enum) {
       dataType = dataType.replace('string', schema.enum ? 'enum' : schema.format);
     }
@@ -81,48 +81,69 @@ export function getTypeInfo(schema) {
   return info;
 }
 export function nestExampleIfPresent(example) {
+  if (typeof example === 'boolean') {
+    return {
+      Example: { value: `${example}` },
+    };
+  }
+  if (example === '') {
+    return {
+      Example: { value: '' },
+    };
+  }
   return example ? { Example: { value: example } } : example;
 }
+
 export function normalizeExamples(examples, dataType = 'string') {
-  let exampleVal;
-  let exampleList;
-  if (examples) {
-    if (examples.constructor === Object) {
-      const exampleValAndDescr = Object.values(examples);
-      exampleVal = exampleValAndDescr.length > 0
-        ? typeof exampleValAndDescr[0].value === 'boolean' || typeof exampleValAndDescr[0].value === 'number'
-          ? exampleValAndDescr[0].value.toString()
-          : exampleValAndDescr[0].value
-        : '';
-      exampleList = Object.values(examples).map((v) => ({
-        value: typeof v.value === 'boolean' || typeof v.value === 'number' ? v.value.toString() : v.value,
-        description: v.description || v.summary || v.value,
-      }));
-    } else {
-      // This is non standard way to provide example but will support for now
-      if (!Array.isArray(examples)) {
-        examples = examples ? [examples] : [];
-      }
-      if (examples.length > 0) {
-        if (dataType === 'array') {
-          [exampleVal] = examples;
-          exampleList = examples.map((v) => ({ value: v, description: Array.isArray(v) ? v.join(' , ') : v }));
-        } else {
-          exampleVal = examples[0].toString();
-          exampleList = examples.map((v) => ({ value: v.toString(), description: v }));
-        }
-      }
-    }
+  if (!examples) {
     return {
-      exampleVal,
-      exampleList,
+      exampleVal: '',
+      exampleList: [],
     };
   }
-  return {
-    exampleVal: '',
-    exampleList: [],
-  };
+
+  if (examples.constructor === Object) {
+    const exampleValAndDescr = Object.values(examples);
+    const exampleVal = exampleValAndDescr.length > 0
+      ? typeof exampleValAndDescr[0].value === 'boolean' || typeof exampleValAndDescr[0].value === 'number'
+        ? exampleValAndDescr[0].value.toString()
+        : exampleValAndDescr[0].value
+      : '';
+    const exampleList = Object.values(examples).map((v) => ({
+      value: typeof v.value === 'boolean' || typeof v.value === 'number' ? v.value.toString() : v.value,
+      summary: v.summary,
+      description: v.description,
+    }));
+    return { exampleVal, exampleList };
+  }
+
+  // This is non-standard way to provide example but will support for now
+  if (!Array.isArray(examples)) {
+    examples = examples ? [examples] : [];
+  }
+
+  if (examples.length === 0) {
+    return {
+      exampleVal: '',
+      exampleList: [],
+    };
+  }
+
+  if (dataType === 'array') {
+    const [exampleVal] = examples;
+    const exampleList = examples.map((v) => ({ value: v }));
+    return { exampleVal, exampleList };
+  }
+
+  const exampleVal = examples[0].toString();
+  const exampleList = examples.map((v) => ({ value: v.toString() }));
+  return { exampleVal, exampleList };
+}
+
+export function anyExampleWithSummaryOrDescription(examples) {
+  return examples.some((x) => x.summary?.length > 0 || x.description?.length > 0);
 }
+
 export function getSampleValueByType(schemaObj) {
   const example = schemaObj.examples
     ? schemaObj.examples[0]
@@ -389,12 +410,20 @@ export function schemaToSampleObj(schema, config = { }) {
         const oneOfSamples = schemaToSampleObj(schema.oneOf[key], config);
         for (const sampleKey in oneOfSamples) {
           // 2. In the final example include a one-of item along with properties
-          if (oneOfSamples[sampleKey] === null) {
-            const finalExample = Object.assign(oneOfSamples[sampleKey], objWithSchemaProps);
-            obj[`example-${i}`] = finalExample;
-            addSchemaInfoToExample(schema.oneOf[key], obj[`example-${i}`]);
-            i++;
+          let finalExample;
+          if (Object.keys(objWithSchemaProps).length > 0) {
+            if (oneOfSamples[sampleKey] === null || typeof oneOfSamples[sampleKey] !== 'object') {
+              // This doesn't really make sense since every oneOf schema _should_ be an object if there are common properties, so we'll skip this
+              continue;
+            } else {
+              finalExample = Object.assign(oneOfSamples[sampleKey], objWithSchemaProps);
+            }
+          } else {
+            finalExample = oneOfSamples[sampleKey];
           }
+          obj[`example-${i}`] = finalExample;
+          addSchemaInfoToExample(schema.oneOf[key], obj[`example-${i}`]);
+          i++;
         }
       }
     }
@@ -460,18 +489,22 @@ export function schemaToSampleObj(schema, config = { }) {
       }
     }
   } else if (schema.type === 'array' || schema.items) {
-    if (schema.example) {
-      obj['example-0'] = schema.example;
-    } else if (schema.items?.example) { // schemas and properties support single example but not multiple examples.
-      obj['example-0'] = [schema.items.example];
-    } else {
-      const samples = schemaToSampleObj(schema.items, config);
-      let i = 0;
-      for (const key in samples) {
-        obj[`example-${i}`] = [samples[key]];
-        addSchemaInfoToExample(schema.items, obj[`example-${i}`]);
-        i++;
+    if (schema.items || schema.example) {
+      if (schema.example) {
+        obj['example-0'] = schema.example;
+      } else if (schema.items?.example) { // schemas and properties support single example but not multiple examples.
+        obj['example-0'] = [schema.items.example];
+      } else {
+        const samples = schemaToSampleObj(schema.items, config);
+        let i = 0;
+        for (const key in samples) {
+          obj[`example-${i}`] = [samples[key]];
+          addSchemaInfoToExample(schema.items, obj[`example-${i}`]);
+          i++;
+        }
       }
+    } else {
+      obj['example-0'] = [];
     }
   } else {
     return { 'example-0': getSampleValueByType(schema) };
@@ -484,15 +517,15 @@ function generateMarkdownForArrayAndObjectDescription(schema, level = 0) {
   if (schema.title) {
     markdown = `**${schema.title}:** `;
   }
+  if (schema.description) {
+    markdown = `${markdown} ${schema.description} ${schema.minItems || schema.maxItems ? '<span class="more-content">⤵</span><br/>' : ''}`;
+  }
   if (schema.minItems) {
     markdown = `${markdown} **Min Items:** ${schema.minItems}`;
   }
   if (schema.maxItems) {
     markdown = `${markdown} **Max Items:** ${schema.maxItems}`;
   }
-  if (schema.description) {
-    markdown = `${markdown} ${schema.description}`;
-  }
   if (level > 0 && schema.items?.description) {
     let itemsMarkdown = '';
     if (schema.items.minProperties) {
@@ -600,7 +633,7 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     });
     let multiPrimitiveTypes;
     if (primitiveType.length > 0) {
-      subSchema.type = primitiveType.join('┃');
+      subSchema.type = primitiveType.join(primitiveType.length === 2 ? ' or ' : '┃');
       multiPrimitiveTypes = getTypeInfo(subSchema);
       if (complexTypes.length === 0) {
         return `${multiPrimitiveTypes?.html || ''}`;
@@ -652,6 +685,9 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::title'] = schema.title || '';
     obj['::description'] = generateMarkdownForArrayAndObjectDescription(schema, level);
     obj['::type'] = 'object';
+    if ((Array.isArray(schema.type) && schema.type.includes('null')) || schema.nullable) {
+      obj['::dataTypeLabel'] = 'object or null';
+    }
     obj['::deprecated'] = schema.deprecated || false;
     obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
     for (const key in schema.properties) {
@@ -668,9 +704,12 @@ export function schemaInObjectNotation(schema, obj, level = 0, suffix = '') {
     obj['::title'] = schema.title || '';
     obj['::description'] = generateMarkdownForArrayAndObjectDescription(schema, level);
     obj['::type'] = 'array';
+    if ((Array.isArray(schema.type) && schema.type.includes('null')) || schema.nullable) {
+      obj['::dataTypeLabel'] = 'array or null';
+    }
     obj['::deprecated'] = schema.deprecated || false;
     obj['::readwrite'] = schema.readOnly ? 'readonly' : schema.writeOnly ? 'writeonly' : '';
-    if (schema.items.items) {
+    if (schema.items?.items) {
       obj['::array-type'] = schema.items.items.type;
     }
     obj['::props'] = schemaInObjectNotation(schema.items, {}, (level + 1));

package/src/utils/spec-parser.js

@@ -106,7 +106,7 @@ export default async function ProcessSpec(specUrl, generateMissingTags = false,
     } else if (v.type === 'oauth2') {
       v.typeDisplay = `OAuth (${v.securitySchemeId})`;
     } else {
-      v.typeDisplay = v.type;
+      v.typeDisplay = v.type || 'None';
     }
   });
 

package/src/utils/theme.js

@@ -11,7 +11,7 @@ export default function setTheme(baseTheme, theme = {}) {
 
   // Dark and Light Theme colors
   if (baseTheme === 'dark') {
-    const bg1 = theme.bg1 ? theme.bg1 : '#333';
+    const bg1 = theme.bg1 ? theme.bg1 : '#2a2b2c';
     const fg1 = theme.fg1 ? theme.fg1 : '#bbb';
 
     const bg2 = theme.bg2 ? theme.bg2 : ColorUtils.color.brightness(bg1, 5); // or #383838;
@@ -27,7 +27,7 @@ export default function setTheme(baseTheme, theme = {}) {
     const headerColor = theme.headerColor ? theme.headerColor : ColorUtils.color.brightness(bg1, 10);
 
     const navBgColor = theme.navBgColor ? theme.navBgColor : ColorUtils.color.brightness(bg1, 10);
-    const navTextColor = theme.navTextColor ? theme.navTextColor : ColorUtils.color.opacity(ColorUtils.color.invert(navBgColor), '0.65');
+    const navTextColor = theme.navTextColor ? theme.navTextColor : ColorUtils.color.opacity(ColorUtils.color.invert(navBgColor), '0.50');
     const navHoverBgColor = theme.navHoverBgColor ? theme.navHoverBgColor : ColorUtils.color.brightness(navBgColor, -15);
     const navHoverTextColor = theme.navHoverTextColor ? theme.navHoverTextColor : ColorUtils.color.invert(navBgColor);
     const navAccentColor = theme.navAccentColor ? theme.navAccentColor : ColorUtils.color.brightness(primaryColor, 25);
@@ -96,7 +96,7 @@ export default function setTheme(baseTheme, theme = {}) {
       codeOperatorColor: theme.codeOperatorColor || '#67cdcc',
     };
   } else {
-    const bg1 = (theme.bg1 ? theme.bg1 : '#ffffff');
+    const bg1 = (theme.bg1 ? theme.bg1 : '#fafbfc');
     const fg1 = (theme.fg1 ? theme.fg1 : '#444444');
     const bg2 = theme.bg2 ? theme.bg2 : ColorUtils.color.brightness(bg1, -5); // or '#fafafa'
     const bg3 = theme.bg3 ? theme.bg3 : ColorUtils.color.brightness(bg1, -15); // or '#f6f6f6'
@@ -118,7 +118,7 @@ export default function setTheme(baseTheme, theme = {}) {
     const navHoverTextColor = theme.navHoverTextColor ? theme.navHoverTextColor : primaryColor;
     const navAccentColor = theme.navAccentColor ? theme.navAccentColor : primaryColor;
     */
-    const navBgColor = theme.navBgColor ? theme.navBgColor : ColorUtils.color.brightness(bg1, -180);
+    const navBgColor = theme.navBgColor ? theme.navBgColor : ColorUtils.color.brightness(bg1, -200);
     const navTextColor = theme.navTextColor ? theme.navTextColor : ColorUtils.color.opacity(ColorUtils.color.invert(navBgColor), '0.65');
     const navHoverBgColor = theme.navHoverBgColor ? theme.navHoverBgColor : ColorUtils.color.brightness(navBgColor, -15);
     const navHoverTextColor = theme.navHoverTextColor ? theme.navHoverTextColor : ColorUtils.color.invert(navBgColor);
@@ -206,8 +206,8 @@ export default function setTheme(baseTheme, theme = {}) {
       : '7px 16px 7px 10px')};
     
     --resp-area-height: ${this.responseAreaHeight};
-    --font-size-small:  ${this.fontSize === 'default' ? '12px' : (this.fontSize === 'large' ? '13px' : '14px')};
-    --font-size-mono:   ${this.fontSize === 'default' ? '13px' : (this.fontSize === 'large' ? '14px' : '15px')};
+    --font-size-small: ${this.fontSize === 'default' ? '12px' : (this.fontSize === 'large' ? '13px' : '14px')};
+    --font-size-mono: ${this.fontSize === 'default' ? '13px' : (this.fontSize === 'large' ? '14px' : '15px')};
     --font-size-regular: ${this.fontSize === 'default' ? '14px' : (this.fontSize === 'large' ? '15px' : '16px')};
     --dialog-z-index: 1000;
 
@@ -260,6 +260,13 @@ export default function setTheme(baseTheme, theme = {}) {
     --nav-hover-text-color:${newTheme.navHoverTextColor};
     --nav-accent-color:${newTheme.navAccentColor};
 
+    /* Nav API Method Colors*/
+    --nav-get-color:${newTheme.blue};
+    --nav-put-color:${newTheme.orange};
+    --nav-post-color:${newTheme.green};
+    --nav-delete-color:${newTheme.red};
+    --nav-head-color:${newTheme.yellow};
+
     /* Primary Colors */  
     --primary-color:${newTheme.primaryColor};
     --primary-color-invert:${newTheme.primaryColorInvert};

package/webpack.config.js

@@ -29,7 +29,7 @@ const rapidocBanner = `
 * @preserve
 * RapiDoc ${rapidocVersion.replace()} - WebComponent to View OpenAPI docs
 * License: MIT
-* Repo   : https://github.com/mrin9/RapiDoc
+* Repo   : https://github.com/rapi-doc/RapiDoc
 * Author : Mrinmoy Majumdar
 *`;
 

package/.vscode/settings.json

@@ -1,12 +0,0 @@
-{
-  "cSpell.ignoreWords": [
-    "doc",
-    "gtag",
-    "rapi"
-  ],
-  "cSpell.words": [
-    "descr",
-    "prismjs",
-    "webcomponent"
-  ]
-}