openapi-explorer 2.1.656 → 2.1.658

package/dist/es/utils/spec-parser.js

@@ -1,14 +1,11 @@
 import OpenApiResolver from 'openapi-resolver/dist/openapi-resolver.browser.js';
 import { marked } from 'marked';
 import { invalidCharsRegEx } from './common-utils.js';
-import { getI18nText } from '../languages/index.js';
 import cloneDeep from 'lodash.clonedeep';
 export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
   var _jsonParsedSpec$info, _jsonParsedSpec$compo;
-
   const inputSpecIsAUrl = typeof specUrlOrObject === 'string' && specUrlOrObject.match(/^http/) || typeof specUrlOrObject === 'object' && typeof specUrlOrObject.href === 'string';
   let jsonParsedSpec;
-
   try {
     jsonParsedSpec = await OpenApiResolver(specUrlOrObject);
   } catch (error) {
@@ -16,20 +13,21 @@ export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
     console.error('Error parsing specification', error);
     throw Error('SpecificationNotFound');
   }
-
   if (!jsonParsedSpec) {
     throw Error('SpecificationNotFound');
-  } // Tags with Paths and WebHooks
-
+  }
 
-  const tags = groupByTags(jsonParsedSpec); // Components
+  // Tags with Paths and WebHooks
+  const tags = groupByTags(jsonParsedSpec);
 
-  const components = getComponents(jsonParsedSpec); // Info Description Headers
+  // Components
+  const components = getComponents(jsonParsedSpec);
 
-  const infoDescriptionHeaders = (_jsonParsedSpec$info = jsonParsedSpec.info) !== null && _jsonParsedSpec$info !== void 0 && _jsonParsedSpec$info.description ? getHeadersFromMarkdown(jsonParsedSpec.info.description) : []; // Security Scheme
+  // Info Description Headers
+  const infoDescriptionHeaders = (_jsonParsedSpec$info = jsonParsedSpec.info) !== null && _jsonParsedSpec$info !== void 0 && _jsonParsedSpec$info.description ? getHeadersFromMarkdown(jsonParsedSpec.info.description) : [];
 
+  // Security Scheme
   const securitySchemes = [];
-
   if ((_jsonParsedSpec$compo = jsonParsedSpec.components) !== null && _jsonParsedSpec$compo !== void 0 && _jsonParsedSpec$compo.securitySchemes) {
     Object.entries(jsonParsedSpec.components.securitySchemes).forEach(kv => {
       const securityObj = {
@@ -38,7 +36,6 @@ export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
       };
       securityObj.value = '';
       securityObj.finalKeyValue = '';
-
       if (kv[1].type === 'apiKey' || kv[1].type === 'http') {
         securityObj.name = kv[1].name || 'Authorization';
         securityObj.user = '';
@@ -48,26 +45,22 @@ export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
         securityObj.clientId = '';
         securityObj.clientSecret = '';
       }
-
       securitySchemes.push(securityObj);
     });
-  } // Servers
-
+  }
 
+  // Servers
   let servers = [];
-
   if (Array.isArray(jsonParsedSpec.servers) && jsonParsedSpec.servers.length) {
     jsonParsedSpec.servers.filter(s => s).forEach(v => {
       let computedUrl = v.url.trim();
-
       if (!(computedUrl.startsWith('http') || computedUrl.startsWith('//') || computedUrl.startsWith('{'))) {
         if (window.location.origin.startsWith('http')) {
           v.url = window.location.origin + v.url;
           computedUrl = v.url;
         }
-      } // Apply server-variables to generate final computed-url
-
-
+      }
+      // Apply server-variables to generate final computed-url
       if (v.variables) {
         Object.entries(v.variables).forEach(kv => {
           const regex = new RegExp(`{${kv[0]}}`, 'g');
@@ -75,7 +68,6 @@ export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
           kv[1].value = kv[1].default || '';
         });
       }
-
       v.computedUrl = computedUrl;
     });
     const explicitServers = serverUrl && !jsonParsedSpec.servers.some(s => s.url === serverUrl || s.computedUrl === serverUrl) ? [{
@@ -104,7 +96,6 @@ export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
       computedUrl: 'http://localhost'
     }];
   }
-
   const parsedSpec = {
     info: jsonParsedSpec.info,
     infoDescriptionHeaders,
@@ -117,96 +108,36 @@ export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
   };
   return parsedSpec;
 }
-
 function getHeadersFromMarkdown(markdownContent) {
   const tokens = marked.lexer(markdownContent);
   const headers = tokens.filter(v => v.type === 'heading' && v.depth <= 2);
   return headers || [];
 }
-
 function getComponents(openApiSpec) {
   if (!openApiSpec.components) {
     return [];
   }
-
   const components = [];
-
-  for (const component in openApiSpec.components) {
-    const subComponents = Object.keys(openApiSpec.components[component]).map(sComponent => ({
+  for (const componentKeyId in openApiSpec.components) {
+    const subComponents = Object.keys(openApiSpec.components[componentKeyId]).map(sComponent => ({
       expanded: true,
-      id: `${component.toLowerCase()}-${sComponent.toLowerCase()}`.replace(invalidCharsRegEx, '-'),
+      id: `${componentKeyId.toLowerCase()}-${sComponent.toLowerCase()}`.replace(invalidCharsRegEx, '-'),
       name: sComponent,
-      component: openApiSpec.components[component][sComponent]
+      component: openApiSpec.components[componentKeyId][sComponent]
     })).sort((a, b) => a.name.toLowerCase().localeCompare(b.name.toLowerCase()));
-    let cmpDescription;
-    let cmpName;
-
-    switch (component) {
-      case 'schemas':
-        cmpName = getI18nText('menu.schemas');
-        cmpDescription = '';
-        break;
-
-      case 'responses':
-        cmpName = 'Responses';
-        cmpDescription = 'Describes responses from an API Operation, including design-time, static links to operations based on the response.';
-        break;
-
-      case 'parameters':
-        cmpName = 'Parameters';
-        cmpDescription = 'Describes operation parameters. A unique parameter is defined by a combination of a name and location.';
-        break;
-
-      case 'examples':
-        cmpName = 'Examples';
-        cmpDescription = 'List of Examples for operations, can be requests, responses and objects examples.';
-        break;
-
-      case 'requestBodies':
-        break;
-
-      case 'headers':
-        cmpName = 'Headers';
-        cmpDescription = 'Headers follows the structure of the Parameters but they are explicitly in "header"';
-        break;
-
-      case 'securitySchemes':
-      case 'securitySchemas':
-        break;
-
-      case 'links':
-        cmpName = 'Links';
-        cmpDescription = 'Links represent a possible design-time link for a response. The presence of a link does not guarantee the caller\'s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations.';
-        break;
-
-      case 'callbacks':
-        cmpName = 'Callbacks'; // eslint-disable-next-line max-len
-
-        cmpDescription = 'A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the path item object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation.';
-        break;
-
-      default:
-        cmpName = component;
-        cmpDescription = component;
-        break;
-    }
-
-    if (cmpName) {
-      components.push({
-        expanded: true,
-        name: cmpName,
-        description: cmpDescription,
-        subComponents
-      });
+    if (componentKeyId === 'requestBodies' || componentKeyId === 'securitySchemes' || componentKeyId === 'securitySchemas') {
+      continue;
     }
+    components.push({
+      expanded: true,
+      componentKeyId,
+      subComponents
+    });
   }
-
   return components;
 }
-
 function groupByTags(openApiSpec) {
   const supportedMethods = ['get', 'query', 'put', 'post', 'patch', 'delete', 'head', 'options']; // this is also used for ordering endpoints by methods
-
   const tags = openApiSpec.tags && Array.isArray(openApiSpec.tags) ? openApiSpec.tags.map(t => {
     const name = typeof t === 'string' ? t : t.name;
     return {
@@ -219,42 +150,32 @@ function groupByTags(openApiSpec) {
     };
   }) : [];
   const pathsAndWebhooks = openApiSpec.paths || {};
-
   if (openApiSpec.webhooks) {
     for (const [key, value] of Object.entries(openApiSpec.webhooks)) {
       value._type = 'webhook'; // eslint-disable-line no-underscore-dangle
-
       pathsAndWebhooks[key] = value;
     }
-  } // For each path find the tag and push it into the corresponding tag
-
-
+  }
+  // For each path find the tag and push it into the corresponding tag
   for (const pathOrHookName in pathsAndWebhooks) {
     const commonPathPropServers = pathsAndWebhooks[pathOrHookName].servers || [];
     const isWebhook = pathsAndWebhooks[pathOrHookName]._type === 'webhook'; // eslint-disable-line no-underscore-dangle
-
     supportedMethods.forEach(methodName => {
       const commonParams = cloneDeep(pathsAndWebhooks[pathOrHookName].parameters);
-
       if (pathsAndWebhooks[pathOrHookName][methodName]) {
-        const pathOrHookObj = openApiSpec.paths[pathOrHookName][methodName]; // If path.methods are tagged, else generate it from path
-
+        const pathOrHookObj = openApiSpec.paths[pathOrHookName][methodName];
+        // If path.methods are tagged, else generate it from path
         const pathTags = Array.isArray(pathOrHookObj.tags) ? pathOrHookObj.tags : pathOrHookObj.tags && [pathOrHookObj.tags] || [];
-
         if (pathTags.length === 0) {
           pathTags.push('General ⦂');
         }
-
         pathTags.forEach(tag => {
           let tagObj;
           let specTagsItem;
-
           if (openApiSpec.tags) {
             specTagsItem = tags.find(v => v.name.toLowerCase() === tag.toLowerCase());
           }
-
           tagObj = tags.find(v => v.name === tag);
-
           if (!tagObj) {
             tagObj = {
               elementId: `tag--${tag.replace(invalidCharsRegEx, '-')}`,
@@ -265,25 +186,21 @@ function groupByTags(openApiSpec) {
               expanded: true
             };
             tags.push(tagObj);
-          } // Generate a short summary which is broken
-
+          }
 
+          // Generate a short summary which is broken
           let shortSummary = (pathOrHookObj.summary || pathOrHookObj.description || `${methodName.toUpperCase()} ${pathOrHookName}`).trim();
-
           if (shortSummary.length > 100) {
             shortSummary = shortSummary.split(/[.|!|?]\s|[\r?\n]/)[0]; // take the first line (period or carriage return)
-          } // Merge Common Parameters with This methods parameters
-
-
+          }
+          // Merge Common Parameters with This methods parameters
           let finalParameters = [];
-
           if (commonParams) {
             if (pathOrHookObj.parameters) {
               finalParameters = commonParams.filter(commonParam => {
                 if (!pathOrHookObj.parameters.some(param => commonParam.name === param.name && commonParam.in === param.in)) {
                   return commonParam;
                 }
-
                 return undefined;
               }).concat(pathOrHookObj.parameters);
             } else {
@@ -291,22 +208,21 @@ function groupByTags(openApiSpec) {
             }
           } else {
             finalParameters = pathOrHookObj.parameters ? pathOrHookObj.parameters.slice(0) : [];
-          } // Remove bad callbacks
-
+          }
 
+          // Remove bad callbacks
           if (pathOrHookObj.callbacks) {
             for (const [callbackName, callbackConfig] of Object.entries(pathOrHookObj.callbacks)) {
               const originalCallbackEntries = Object.entries(callbackConfig);
               const filteredCallbacks = originalCallbackEntries.filter(entry => typeof entry[1] === 'object') || [];
               pathOrHookObj.callbacks[callbackName] = Object.fromEntries(filteredCallbacks);
-
               if (filteredCallbacks.length !== originalCallbackEntries.length) {
                 console.warn(`OpenAPI Explorer: Invalid Callback found in ${callbackName}`); // eslint-disable-line no-console
               }
             }
-          } // Update Responses
-
+          }
 
+          // Update Responses
           const pathObject = {
             expanded: false,
             isWebhook,
@@ -338,6 +254,5 @@ function groupByTags(openApiSpec) {
       }
     }); // End of Methods
   }
-
   return tags;
 }

package/dist/es/utils/theme.js

@@ -1,9 +1,10 @@
 import { html } from 'lit';
 import color from 'color';
 import ColorUtils from './color-utils.js';
+
 /* Generates an schema object containing type and constraint info */
-// TODO: possible drive theme from:
 
+// TODO: possible drive theme from:
 /*
   if (!this.theme || !'light, dark,'.includes(`${this.theme},`)) {
     this.theme = (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) ? 'light' : 'dark';
@@ -14,16 +15,11 @@ export default function setTheme(theme = {}) {
   const bg1 = theme.bg1 ? theme.bg1 : '#ffffff';
   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'
-
   const lightBg = theme.bg3 ? theme.bg3 : ColorUtils.color.brightness(bg1, -45);
   const fg2 = theme.fg2 ? theme.fg2 : ColorUtils.color.brightness(fg1, 17); // or '#555'
-
   const fg3 = theme.fg3 ? theme.fg3 : ColorUtils.color.brightness(fg1, 30); // or #666
-
   const lightFg = theme.fg3 ? theme.fg3 : ColorUtils.color.brightness(fg1, 70); // or #999
-
   const inlineCodeFg = theme.inlineCodeFg ? theme.inlineCodeFg : 'brown';
   const selectionBg = '#444';
   const selectionFg = '#eee';
@@ -66,6 +62,7 @@ export default function setTheme(theme = {}) {
     // #dedede
     hoverColor: theme.hoverColor || ColorUtils.color.brightness(bg1, -5),
     // # f1f1f1
+
     codeFg: theme.codeFg || '#666',
     codePropertyColor: theme.codePropertyColor || '#905',
     codeKeywordColor: theme.codeKeywordColor || '#07a',

package/dist/es/utils/xml/xml.js

@@ -1,4 +1,5 @@
 /* eslint-disable no-underscore-dangle */
+
 const XML_CHARACTER_MAP = {
   '&': '&',
   '"': '"',
@@ -6,47 +7,38 @@ const XML_CHARACTER_MAP = {
   '<': '&lt;',
   '>': '&gt;'
 };
-
 function escapeForXML(string) {
   return string && string.replace ? string.replace(/([&"<>'])/g, function (str, item) {
     return XML_CHARACTER_MAP[item];
   }) : string;
 }
-
 const DEFAULT_INDENT = '    ';
 export default function xml(input, rawOptions) {
   let options = rawOptions;
-
   if (typeof options !== 'object') {
     options = {
       indent: options
     };
   }
-
   let output = '';
   const indent = !options.indent ? '' : options.indent === true ? DEFAULT_INDENT : options.indent;
-
   function append(_, out) {
     if (out !== undefined) {
       output += out;
     }
   }
-
   function add(value, last) {
     format(append, resolve(value, indent, indent ? 1 : 0), last);
   }
-
   function addXmlDeclaration(declaration) {
     const encoding = declaration.encoding || 'UTF-8';
     const attr = {
       version: '1.0',
       encoding: encoding
     };
-
     if (declaration.standalone) {
       attr.standalone = declaration.standalone;
     }
-
     add({
       '?xml': {
         _attr: attr
@@ -54,11 +46,9 @@ export default function xml(input, rawOptions) {
     });
     output = output.replace('/>', '?>');
   }
-
   if (options.declaration) {
     addXmlDeclaration(options.declaration);
   }
-
   if (input && input.forEach) {
     input.forEach(function (value, i) {
       add(value, i + 1 === input.length);
@@ -66,26 +56,21 @@ export default function xml(input, rawOptions) {
   } else {
     add(input, true);
   }
-
   return output;
 }
-
 function create_indent(character, count) {
   return new Array(count || 0).join(character || '');
 }
-
 function resolve(data, indent, indent_count_raw) {
   const indent_count = indent_count_raw || 0;
   const indent_spaces = create_indent(indent, indent_count);
   let name;
   let values = data;
   const interrupt = false;
-
   if (typeof data === 'object') {
     const keys = Object.keys(data);
     name = keys[0];
     values = data[name];
-
     if (values && values._elem) {
       values._elem.name = name;
       values._elem.icount = indent_count;
@@ -95,39 +80,32 @@ function resolve(data, indent, indent_count_raw) {
       return values._elem;
     }
   }
-
   const attributes = [];
   const content = [];
   let isStringContent;
-
   function get_attributes(obj) {
     const keys = Object.keys(obj);
     keys.forEach(function (key) {
       attributes.push(attribute(key, obj[key]));
     });
   }
-
   switch (typeof values) {
     case 'object':
       if (values === null) {
         break;
       }
-
       if (values._attr) {
         get_attributes(values._attr);
       }
-
       if (values._cdata) {
         content.push(`${`<![CDATA[${values._cdata}`.replace(/\]\]>/g, ']]]]><![CDATA[>')}]]>`);
       }
-
       if (values.forEach) {
         isStringContent = false;
         content.push('');
         values.forEach(function (value) {
           if (typeof value === 'object') {
             const _name = Object.keys(value)[0];
-
             if (_name === '_attr') {
               get_attributes(value._attr);
             } else {
@@ -140,19 +118,15 @@ function resolve(data, indent, indent_count_raw) {
             content.push(escapeForXML(value));
           }
         });
-
         if (!isStringContent) {
           content.push('');
         }
       }
-
       break;
-
     default:
       // string
       content.push(escapeForXML(values));
   }
-
   return {
     name: name,
     interrupt: interrupt,
@@ -163,33 +137,25 @@ function resolve(data, indent, indent_count_raw) {
     indent: indent
   };
 }
-
 function format(append, elem, end) {
   if (typeof elem !== 'object') {
     append(false, elem);
     return;
   }
-
   const len = elem.interrupt ? 1 : elem.content.length;
-
   function proceed() {
     while (elem.content.length) {
       const value = elem.content.shift();
-
       if (value === undefined) {
         continue;
       }
-
       if (interrupt(value)) {
         return;
       }
-
       format(append, value);
     }
-
     append(false, (len > 1 ? elem.indents : '') + (elem.name ? `</${elem.name}>` : '') + (elem.indent && !end ? '\n' : ''));
   }
-
   function interrupt(value) {
     if (value.interrupt) {
       value.interrupt.append = append;
@@ -198,22 +164,17 @@ function format(append, elem, end) {
       append(true);
       return true;
     }
-
     return false;
   }
-
   append(false, elem.indents + (elem.name ? `<${elem.name}` : '') + (elem.attributes.length ? ` ${elem.attributes.join(' ')}` : '') + (len ? elem.name ? '>' : '' : elem.name ? '/>' : '') + (elem.indent && len > 1 ? '\n' : ''));
-
   if (!len) {
     append(false, elem.indent ? '\n' : '');
     return;
   }
-
   if (!interrupt(elem)) {
     proceed();
   }
 }
-
 function attribute(key, value) {
   return `${key}=` + `"${escapeForXML(value)}"`;
 }