openapi-explorer 0.9.385 → 0.9.392

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

@@ -11,7 +11,7 @@ var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
 
 var _regexToStrings = require("regex-to-strings");
 
-var _xml = _interopRequireDefault(require("./xml/xml"));
+var _xml = _interopRequireDefault(require("./xml/xml.js"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 
@@ -19,27 +19,34 @@ function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { de
 const IS_MISSING_TYPE_INFO_TYPE = '';
 /* Generates an schema object containing type and constraint info */
 
-function getTypeInfo(schema) {
-  var _schema$items;
+function getTypeInfo(schema, options = {
+  includeNulls: false
+}) {
+  var _schema$items, _schema$const;
 
   if (!schema) {
     return undefined;
   }
 
-  let dataType = '';
-  let constraint = '';
+  let dataType = IS_MISSING_TYPE_INFO_TYPE;
 
   if (schema.circularReference) {
     dataType = `{recursive: ${schema.circularReference.name}} `;
   } else if (schema.type) {
     const arraySchema = Array.isArray(schema.type) ? schema.type : typeof schema.type === 'string' ? schema.type.split('┃') : schema.type;
-    dataType = Array.isArray(arraySchema) ? arraySchema.filter(s => s !== 'null').join('┃') : schema.type;
+    dataType = Array.isArray(arraySchema) ? arraySchema.filter(s => s !== 'null' || options.includeNulls).join('┃') : schema.type;
 
-    if (schema.format || schema.enum) {
-      dataType = dataType.replace('string', schema.enum ? 'enum' : schema.format);
+    if (schema.format || schema.enum || schema.const) {
+      dataType = dataType.replace('string', schema.enum && 'enum' || schema.const && 'const' || schema.format);
+    }
+
+    if (schema.nullable && options.includeNulls) {
+      dataType += '┃null';
+    }
+
+    if (dataType.includes('┃null') && schema.format) {
+      schema.format += '┃null';
     }
-  } else {
-    dataType = IS_MISSING_TYPE_INFO_TYPE;
   }
 
   const info = {
@@ -53,21 +60,18 @@ function getTypeInfo(schema) {
     title: schema.title || '',
     description: schema.description || '',
     constraint: '',
-    allowedValues: '',
-    arrayType: '',
-    html: ''
-  }; // Set Allowed Values
-
-  info.allowedValues = Array.isArray(schema.enum) ? schema.enum.join('┃') : '';
+    allowedValues: (_schema$const = schema.const) !== null && _schema$const !== void 0 ? _schema$const : Array.isArray(schema.enum) ? schema.enum.join('┃') : '',
+    arrayType: ''
+  };
 
   if (dataType === 'array' && schema.items) {
-    var _schema$items$default;
+    var _schema$items$default, _schema$const2;
 
     const arrayItemType = schema.items.type;
     const arrayItemDefault = (_schema$items$default = schema.items.default) !== null && _schema$items$default !== void 0 ? _schema$items$default : '';
     info.arrayType = `${schema.type} of ${Array.isArray(arrayItemType) ? arrayItemType.join('') : arrayItemType}`;
     info.default = arrayItemDefault;
-    info.allowedValues = Array.isArray(schema.items.enum) ? schema.items.enum.join('┃') : '';
+    info.allowedValues = (_schema$const2 = schema.const) !== null && _schema$const2 !== void 0 ? _schema$const2 : Array.isArray(schema.items.enum) ? schema.items.enum.join('┃') : '';
   }
 
   if (dataType.match(/integer|number/g)) {
@@ -79,25 +83,24 @@ function getTypeInfo(schema) {
     const rightBound = schema.maximum !== undefined ? ']' : ')';
 
     if (typeof minimum === 'number' || typeof maximum === 'number') {
-      constraint = `Range: ${leftBound}${minimum !== null && minimum !== void 0 ? minimum : ''},${maximum !== null && maximum !== void 0 ? maximum : ''}${rightBound}`;
+      info.constraint = `Range: ${leftBound}${minimum !== null && minimum !== void 0 ? minimum : ''},${maximum !== null && maximum !== void 0 ? maximum : ''}${rightBound}`;
     }
 
     if (schema.multipleOf !== undefined) {
-      constraint += `${constraint ? ', ' : ''}Multiples: ${schema.multipleOf}`;
+      info.constraint += `${info.constraint ? ', ' : ''}Multiples: ${schema.multipleOf}`;
     }
   }
 
   if (dataType.match(/string/g)) {
     if (schema.minLength !== undefined && schema.maxLength !== undefined) {
-      constraint += `Min length: ${schema.minLength}, Max length: ${schema.maxLength}`;
+      info.constraint += `Min length: ${schema.minLength}, Max length: ${schema.maxLength}`;
     } else if (schema.minLength !== undefined) {
-      constraint += `Min length: ${schema.minLength}`;
+      info.constraint += `Min length: ${schema.minLength}`;
     } else if (schema.maxLength !== undefined) {
-      constraint += `Max length: ${schema.maxLength}`;
+      info.constraint += `Max length: ${schema.maxLength}`;
     }
   }
 
-  info.constraint = constraint;
   info.html = JSON.stringify({
     type: info.type,
     format: info.format,
@@ -175,6 +178,10 @@ function getSampleValueByType(schemaObj, fallbackPropertyName, skipExampleString
   }
 
   if (typeValue.match(/^string/g)) {
+    if (schemaObj.const) {
+      return schemaObj.const;
+    }
+
     if (schemaObj.enum) {
       return schemaObj.enum[0];
     }
@@ -372,13 +379,13 @@ function getExampleValuesFromSchemaRecursive(schema, config = {}) {
  * For changing OpenAPI-Schema to an Object Notation,
  * This Object would further be an input to UI Components to generate an Object-Tree
  * @param {object} schema - Schema object from OpenAPI spec
- * @param {object} obj - recursively pass this object to generate object notation
+ * @param {object} options - recursively pass this object to generate object notation
  * @param {number} level - recursion level
  * @param {string} suffix - used for suffixing property names to avoid duplicate props during object composition
  */
 
 
-function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
+function schemaInObjectNotation(rawSchema, options, level = 0, suffix = '') {
   if (!rawSchema) {
     return undefined;
   }
@@ -396,18 +403,18 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
     allOf.map((v, i) => {
       if (v.type === 'object' || v.properties || v.allOf || v.anyOf || v.oneOf) {
         const propSuffix = (v.anyOf || v.oneOf) && i > 0 ? i : '';
-        const partialObj = schemaInObjectNotation(v, {}, level + 1, propSuffix);
+        const partialObj = schemaInObjectNotation(v, options, level + 1, propSuffix);
         Object.assign(objWithAllProps, partialObj);
       } else if (v.type === 'array' || v.items) {
-        const partialObj = schemaInObjectNotation(v, {}, level + 1);
+        const partialObj = schemaInObjectNotation(v, options, level + 1);
         Object.assign(objWithAllProps, partialObj);
       } else if (v.type) {
         const prop = `prop${Object.keys(objWithAllProps).length}`;
-        const typeObj = getTypeInfo(v);
+        const typeObj = getTypeInfo(v, options);
         objWithAllProps[prop] = `${typeObj.html}`;
       }
     });
-    const obj = schemaInObjectNotation(schema, {}, 0);
+    const obj = schemaInObjectNotation(schema, options, 0);
     return Object.assign({}, objWithAllProps, typeof obj === 'object' && !Array.isArray(obj) ? obj : {});
   } else if (anyOf || oneOf) {
     const objWithAnyOfProps = {};
@@ -417,7 +424,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
       if (v.type === 'object' || v.properties || v.allOf || v.anyOf || v.oneOf) {
         var _partialObj$Flags, _partialObj$Flags2;
 
-        const partialObj = schemaInObjectNotation(v, {});
+        const partialObj = schemaInObjectNotation(v, options);
         objWithAnyOfProps[`::OPTION~${index + 1}${v.title ? `~${v.title}` : ''}`] = partialObj;
         objWithAnyOfProps['::type'] = 'xxx-of-option';
         readOnly = readOnly && ((_partialObj$Flags = partialObj['::flags']) === null || _partialObj$Flags === void 0 ? void 0 : _partialObj$Flags['🆁']);
@@ -426,7 +433,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
         var _partialObj$Flags3, _partialObj$Flags4;
 
         // This else-if block never seems to get executed
-        const partialObj = schemaInObjectNotation(v, {});
+        const partialObj = schemaInObjectNotation(v, options);
         objWithAnyOfProps[`::OPTION~${index + 1}${v.title ? `~${v.title}` : ''}`] = partialObj;
         objWithAnyOfProps['::type'] = 'xxx-of-array';
         readOnly = readOnly && ((_partialObj$Flags3 = partialObj['::flags']) === null || _partialObj$Flags3 === void 0 ? void 0 : _partialObj$Flags3['🆁']);
@@ -435,13 +442,13 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
         var _objWithAnyOfProps$, _objWithAnyOfProps$2;
 
         const prop = `::OPTION~${index + 1}${v.title ? `~${v.title}` : ''}`;
-        objWithAnyOfProps[prop] = `${getTypeInfo(v).html}`;
+        objWithAnyOfProps[prop] = `${getTypeInfo(v, options).html}`;
         objWithAnyOfProps['::type'] = 'xxx-of-option';
         readOnly = readOnly && ((_objWithAnyOfProps$ = objWithAnyOfProps['::flags']) === null || _objWithAnyOfProps$ === void 0 ? void 0 : _objWithAnyOfProps$['🆁']);
         writeOnly = writeOnly && ((_objWithAnyOfProps$2 = objWithAnyOfProps['::flags']) === null || _objWithAnyOfProps$2 === void 0 ? void 0 : _objWithAnyOfProps$2['🆆']);
       }
     });
-    const obj = schemaInObjectNotation(schema, {}, 0);
+    const obj = schemaInObjectNotation(schema, options, 0);
     const resultObj = typeof obj === 'object' && !Array.isArray(obj) ? obj : {};
     resultObj[anyOf ? `::ANY~OF ${suffix}` : `::ONE~OF ${suffix}`] = objWithAnyOfProps;
     resultObj['::type'] = 'xxx-of';
@@ -475,7 +482,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
 
     if (primitiveType.length > 0) {
       subSchema.type = primitiveType.join('┃');
-      multiPrimitiveTypes = getTypeInfo(subSchema);
+      multiPrimitiveTypes = getTypeInfo(subSchema, options);
 
       if (complexTypes.length === 0) {
         return `${multiPrimitiveTypes && multiPrimitiveTypes.html || ''}`;
@@ -493,7 +500,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
           multiTypeOptions[`::OPTION~${i + 1}`] = 'NULL~|~~|~~|~~|~~|~~|~~|~~|~';
         } else if ('integer, number, string, boolean,'.includes(`${v},`)) {
           subSchema.type = Array.isArray(v) ? v.join('┃') : v;
-          const primitiveTypeInfo = getTypeInfo(subSchema);
+          const primitiveTypeInfo = getTypeInfo(subSchema, options);
           multiTypeOptions[`::OPTION~${i + 1}`] = primitiveTypeInfo.html;
         } else if (v === 'object') {
           // If object type iterate all the properties and create an object-type-option
@@ -510,9 +517,9 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
 
           for (const key in schema.properties) {
             if (schema.required && schema.required.includes(key)) {
-              objTypeOption[`${key}*`] = schemaInObjectNotation(schema.properties[key], {}, level + 1);
+              objTypeOption[`${key}*`] = schemaInObjectNotation(schema.properties[key], options, level + 1);
             } else {
-              objTypeOption[key] = schemaInObjectNotation(schema.properties[key], {}, level + 1);
+              objTypeOption[key] = schemaInObjectNotation(schema.properties[key], options, level + 1);
             }
           }
 
@@ -529,7 +536,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
             '::props': schemaInObjectNotation(Object.assign({
               readOnly: schema.readOnly,
               writeOnly: schema.writeOnly
-            }, schema.items), {}, level + 1)
+            }, schema.items), options, level + 1)
           };
         }
       });
@@ -551,14 +558,14 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
 
     for (const key in schema.properties) {
       if (schema.required && schema.required.includes(key)) {
-        obj[`${key}*`] = schemaInObjectNotation(schema.properties[key], {}, level + 1);
+        obj[`${key}*`] = schemaInObjectNotation(schema.properties[key], options, level + 1);
       } else {
-        obj[key] = schemaInObjectNotation(schema.properties[key], {}, level + 1);
+        obj[key] = schemaInObjectNotation(schema.properties[key], options, level + 1);
       }
     }
 
     if (schema.additionalProperties) {
-      obj['<any-key>'] = schemaInObjectNotation(schema.additionalProperties, {});
+      obj['<any-key>'] = schemaInObjectNotation(schema.additionalProperties, options);
     }
 
     return obj;
@@ -579,7 +586,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
       deprecated: schema.deprecated,
       readOnly: schema.readOnly,
       writeOnly: schema.writeOnly
-    }, schema.items), {}, level + 1);
+    }, schema.items), options, level + 1);
 
     if ((_schema$items2 = schema.items) !== null && _schema$items2 !== void 0 && _schema$items2.items) {
       obj['::array-type'] = schema.items.items.type;
@@ -588,7 +595,7 @@ function schemaInObjectNotation(rawSchema, _, level = 0, suffix = '') {
     return obj;
   }
 
-  const typeObj = getTypeInfo(schema);
+  const typeObj = getTypeInfo(schema, options);
   return `${(typeObj === null || typeObj === void 0 ? void 0 : typeObj.html) || ''}`;
 }
 /* Create Example object */

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

@@ -9,6 +9,8 @@ var _marked = require("marked");
 
 var _commonUtils = require("./common-utils");
 
+var _languages = require("../languages");
+
 var _lodash = _interopRequireDefault(require("lodash.clonedeep"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -64,7 +66,7 @@ async function ProcessSpec(specUrlOrObject, serverUrl = '') {
 
   securitySchemes.forEach(v => {
     if (v.type === 'http') {
-      v.typeDisplay = v.scheme === 'basic' ? 'HTTP Basic' : 'HTTP Bearer';
+      v.typeDisplay = v.scheme === 'basic' ? (0, _languages.getI18nText)('authentication.http-basic') : 'HTTP Bearer';
     } else if (v.type === 'apiKey') {
       v.typeDisplay = `API Key (${v.name})`;
     } else if (v.type === 'oauth2') {
@@ -167,7 +169,7 @@ function getComponents(openApiSpec) {
 
     switch (component) {
       case 'schemas':
-        cmpName = 'Schemas';
+        cmpName = (0, _languages.getI18nText)('menu.schemas');
         cmpDescription = '';
         break;
 

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "openapi-explorer",
-  "version": "0.9.385",
+  "version": "0.9.392",
   "description": "OpenAPI Explorer - API viewer with dynamically generated components, documentation, and interaction console",
   "author": "Rhosys Developers <developers@rhosys.ch>",
+  "type": "module",
   "repository": {
     "type": "git",
     "url": "https://github.com/Rhosys/openapi-explorer.git"
@@ -50,6 +51,7 @@
     "buffer": "^6.0.3",
     "color": "^4.2.3",
     "create-hash": "^1.2.0",
+    "i18next": "^21.9.0",
     "lit-element": "^3.2.2",
     "lit-html": "^2.3.1",
     "lodash.clonedeep": "^4.5.0",
@@ -69,7 +71,7 @@
     "start": "webpack serve --mode=development --port=8080",
     "serve": "serve -p 8080 mocks",
     "lint": "eslint --ext .js src",
-    "test": "babel src -d lib && mocha -r esm tests/*.test.js"
+    "test": "ava tests/**/*.test.js"
   },
   "devDependencies": {
     "@babel/cli": "^7.13.14",
@@ -79,6 +81,7 @@
     "@babel/plugin-proposal-optional-chaining": "^7.18.9",
     "@babel/plugin-transform-modules-commonjs": "^7.18.6",
     "@babel/preset-env": "^7.13.12",
+    "ava": "^4.3.3",
     "babel-loader": "^8.2.2",
     "babel-plugin-template-html-minifier": "^4.1.0",
     "chai": "^4.2.0",
@@ -97,13 +100,13 @@
     "eslint-plugin-promise": "^5.1.0",
     "eslint-plugin-vue": "^7.17.0",
     "eslint-webpack-plugin": "2.5.3",
-    "esm": "^3.2.25",
     "file-loader": "^6.2.0",
     "filemanager-webpack-plugin": "^4.0.0",
     "fs-extra": "^8.1.0",
     "glob": "^7.1.6",
     "html-webpack-plugin": "^5.3.1",
     "inspectpack": "^4.7.1",
+    "json-loader": "^0.5.7",
     "mocha": "^7.2.0",
     "npm-run-all": "^4.1.5",
     "sinon": "^7.5.0",
@@ -116,6 +119,6 @@
     "webpack-dev-server": "^3.11.2"
   },
   "engines": {
-    "node": ">=12"
+    "node": ">=14"
   }
 }