openapi-explorer 0.8.301 → 0.9.305

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openapi-explorer",
-  "version": "0.8.301",
+  "version": "0.9.305",
   "description": "OpenAPI Explorer - API viewer with dynamically generated components, documentation, and interaction console",
   "author": "Rhosys Developers <developers@rhosys.ch>",
   "repository": {
@@ -39,22 +39,20 @@
   ],
   "mode": "production",
   "dependencies": {
-    "authress-login": "^1.1.77",
+    "authress-login": "^1.2.104",
     "base64url": "^3.0.1",
     "buffer": "^6.0.3",
     "color": "^4.2.3",
     "create-hash": "^1.2.0",
-    "js-yaml": "^4.0",
     "lit-element": "2.4.0",
     "lit-html": "^1.1.1",
     "lodash.clonedeep": "^4.5.0",
     "marked": "^4.0.16",
-    "mime-types": "^2.1.32",
+    "mime-db": "^1.52.0",
     "openapi-data-validator": "^2.0.40",
-    "path-browserify": "^1.0.1",
+    "openapi-resolver": "^4.0.17",
     "prismjs": "^1.23.0",
     "regex-to-strings": "^2.0.3",
-    "swagger-client": "^3.13",
     "xml-but-prettier": "^1.0.1"
   },
   "scripts": {
@@ -93,10 +91,12 @@
     "fs-extra": "^8.1.0",
     "glob": "^7.1.6",
     "html-webpack-plugin": "^5.3.1",
+    "https-browserify": "^1.0.0",
     "inspectpack": "^4.7.1",
     "mocha": "^7.2.0",
     "sinon": "^7.5.0",
     "sinon-chai": "^3.3.0",
+    "stream-http": "^3.2.0",
     "style-loader": "^2.0.0",
     "terser-webpack-plugin": "^5.1.1",
     "webpack": "^5.30.0",

package/src/components/api-request.js

@@ -1,7 +1,7 @@
 import { LitElement, html } from 'lit-element';
 import { marked } from 'marked';
 import Prism from 'prismjs';
-import mime from 'mime-types';
+import mimeTypeResolver from './mime-types';
 
 import { unsafeHTML } from 'lit-html/directives/unsafe-html';
 import formatXml from 'xml-but-prettier';
@@ -1103,7 +1103,7 @@ export default class ApiRequest extends LitElement {
           const contentDisposition = fetchResponse.headers.get('content-disposition');
           const filenameRegex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/;
           const filename = filenameRegex.exec(contentDisposition);
-          this.respContentDisposition = filename && filename[1] && filename[1].replace(/['"]/g, '') || `download.${mime.extension(contentType) || 'file'}`;
+          this.respContentDisposition = filename && filename[1] && filename[1].replace(/['"]/g, '') || `download.${mimeTypeResolver.extension(contentType) || 'file'}`;
           respBlob = await fetchResponse.blob();
           this.responseBlobUrl = URL.createObjectURL(respBlob);
         }

package/src/components/mime-types.js

@@ -0,0 +1,67 @@
+const db = require('mime-db');
+
+const EXTRACT_TYPE_REGEXP = /^\s*([^;\s]*)(?:;|\s|$)/;
+/**
+ * Get the default extension for a MIME type.
+ *
+ * @param {string} type
+ * @return {boolean|string}
+ */
+
+export default function extension(type) {
+  if (!type || typeof type !== 'string') {
+    return false;
+  }
+
+  // TODO: use media-typer
+  const match = EXTRACT_TYPE_REGEXP.exec(type);
+
+  // get extensions
+  const exts = match && exports.extensions[match[1].toLowerCase()];
+
+  if (!exts || !exts.length) {
+    return false;
+  }
+
+  return exts[0];
+}
+
+const extensions = {};
+const types = {};
+populateMaps();
+
+function populateMaps() {
+  // source preference (least -> most)
+  const preference = ['nginx', 'apache', undefined, 'iana'];
+
+  Object.keys(db).forEach(function forEachMimeType(type) {
+    const mime = db[type];
+    const exts = mime.extensions;
+
+    if (!exts || !exts.length) {
+      return;
+    }
+
+    // mime -> extensions
+    extensions[type] = exts;
+
+    // extension -> mime
+    for (let i = 0; i < exts.length; i++) {
+      const extensionToTest = exts[i];
+
+      if (types[extensionToTest]) {
+        const from = preference.indexOf(db[types[extensionToTest]].source);
+        const to = preference.indexOf(mime.source);
+
+        if (types[extensionToTest] !== 'application/octet-stream'
+          && (from > to || (from === to && types[extensionToTest].substr(0, 12) === 'application/'))) {
+          // skip the remapping
+          continue;
+        }
+      }
+
+      // set the extension -> mime
+      types[extensionToTest] = type;
+    }
+  });
+}

package/src/openapi-explorer.js

@@ -74,7 +74,6 @@ export default class OpenApiExplorer extends LitElement {
       serverUrl: { type: String, attribute: 'server-url' },
 
       // Hide/Show Sections & Enable Disable actions
-      showSideNav: { type: String, attribute: 'show-side-nav' },
       showInfo: { type: String, attribute: 'show-info' },
       allowAuthentication: { type: String, attribute: 'show-authentication' },
       allowTry: { type: String, attribute: 'enable-console' },
@@ -392,7 +391,6 @@ export default class OpenApiExplorer extends LitElement {
     if (!this.allowServerSelection || !'true, false,'.includes(`${this.allowServerSelection},`)) { this.allowServerSelection = 'true'; }
     if (!this.allowAuthentication || !'true, false,'.includes(`${this.allowAuthentication},`)) { this.allowAuthentication = 'true'; }
 
-    if (!this.showSideNav || !'true false'.includes(this.showSideNav)) { this.showSideNav = 'true'; }
     if (!this.showComponents || !'true false'.includes(this.showComponents)) { this.showComponents = 'false'; }
     if (!this.fetchCredentials || !'omit, same-origin, include,'.includes(`${this.fetchCredentials},`)) { this.fetchCredentials = ''; }
 

package/src/templates/responsiveViewMainBodyTemplate.js

@@ -33,10 +33,7 @@ export default function responsiveViewMainBodyTemplate() {
 
     <div id='the-main-body' class="body">
       <!-- Side Nav -->
-      ${((this.renderStyle === 'read' || this.renderStyle === 'focused')
-          && this.showSideNav === 'true'
-          && this.resolvedSpec
-        ) ? navbarTemplate.call(this) : ''
+      ${(this.renderStyle === 'focused' && this.resolvedSpec) ? navbarTemplate.call(this) : ''
       }
 
       <!-- Main Content -->

package/src/utils/spec-parser.js

@@ -1,30 +1,20 @@
-import SwaggerClient from 'swagger-client';
+import OpenApiResolver from 'openapi-resolver/dist/openapi-resolver.browser';
 import { marked } from 'marked';
-import yaml from 'js-yaml';
 import { invalidCharsRegEx } from './common-utils';
 
 export default async function ProcessSpec(specUrlOrObject, serverUrl = '') {
   const inputSpecIsAUrl = typeof specUrlOrObject === 'string' && specUrlOrObject.match(/^http/) || typeof specUrlOrObject === 'object' && typeof specUrlOrObject.href === 'string';
-  let specMeta;
 
-  // Dynamically resolve non yaml or json files and insert their descriptions where necessary
-  function responseInterceptor(val) {
-    if (val.ok && val.text && val.parseError && val.parseError.name === 'YAMLException' && (!val.headers['content-type'] || val.headers['content-type'].match('text/plain'))) {
-      val.body = val.text;
-    }
-    return val;
-  }
-
-  if (inputSpecIsAUrl) {
-    specMeta = await SwaggerClient({ allowMetaPatches: false, url: specUrlOrObject.toString(), responseInterceptor });
-  } else if (typeof specUrlOrObject === 'string') {
-    specMeta = await SwaggerClient({ allowMetaPatches: false, spec: yaml.load(specUrlOrObject), responseInterceptor });
-  } else {
-    specMeta = await SwaggerClient({ allowMetaPatches: false, spec: specUrlOrObject, responseInterceptor });
+  let jsonParsedSpec;
+  try {
+    jsonParsedSpec = await OpenApiResolver(specUrlOrObject);
+  } catch (error) {
+    // eslint-disable-next-line no-console
+    console.error('Error parsing specification', error);
+    throw Error('SpecificationNotFound');
   }
 
-  const jsonParsedSpec = specMeta.spec;
-  if (specMeta.message === 'Not Found' || !jsonParsedSpec) {
+  if (!jsonParsedSpec) {
     throw Error('SpecificationNotFound');
   }
 
@@ -233,7 +223,7 @@ function groupByTags(openApiSpec) {
       if (pathsAndWebhooks[pathOrHookName][methodName]) {
         const pathOrHookObj = openApiSpec.paths[pathOrHookName][methodName];
         // If path.methods are tagged, else generate it from path
-        const pathTags = pathOrHookObj.tags || [];
+        const pathTags = Array.isArray(pathOrHookObj.tags) ? pathOrHookObj.tags : pathOrHookObj.tags && [pathOrHookObj.tags] || [];
         if (pathTags.length === 0) {
           pathTags.push('General ⦂');
         }

package/src/utils/xml/xml.js

@@ -18,7 +18,7 @@ function escapeForXML(string) {
 
 const DEFAULT_INDENT = '    ';
 
-function xml(input, rawOptions) {
+export default function xml(input, rawOptions) {
   let options = rawOptions;
   if (typeof options !== 'object') {
     options = {
@@ -80,32 +80,6 @@ function xml(input, rawOptions) {
   return output;
 }
 
-function element(/* input, …*/) {
-  const input = Array.prototype.slice.call(arguments);
-  const self = {
-    _elem: resolve(input)
-  };
-
-  self.push = function(pushInput) {
-    if (!this.append) {
-      throw new Error('not assigned to a parent!');
-    }
-    const that = this;
-    const indent = this._elem.indent;
-    format(this.append, resolve(
-      pushInput, indent, this._elem.icount + (indent ? 1 : 0)),
-    function() { that.append(true); });
-  };
-
-  self.close = function(closeInput) {
-    if (closeInput !== undefined) {
-      this.push(closeInput);
-    }
-  };
-
-  return self;
-}
-
 function create_indent(character, count) {
   return (new Array(count || 0).join(character || ''));
 }
@@ -254,5 +228,3 @@ function attribute(key, value) {
   return `${key}=` + `"${escapeForXML(value)}"`;
 }
 
-module.exports = xml;
-module.exports.element = module.exports.Element = element;