@redocly/openapi-docs 3.12.0 → 3.12.2

package/lib/utils/openapi.js

@@ -1 +1,592 @@
-import{dirname as y}from"path";import f from"url-template";import{IS_BROWSER as M}from"@redocly/theme/core/openapi";import{deleteEmptyArrayItem as E,isArrayOfObjects as T,isNumeric as S,removeQueryStringAndHash as z,resolveUrl as D,sanitizeItemId as m,normalizeText as b,getValueFromMdParsedExtension as g,isAbsoluteUrl as N}from"./helpers.js";import{DEFAULT_TAG_SLUG as R,MediaTypes as j}from"../constants.js";import{JsonPointer as $}from"./JsonPointer.js";import{joinWithSeparator as _}from"../services/index.js";import{tryDecodeURIComponent as F}from"./string.js";import{getUrlDirname as U}from"./url.js";function P(e){return typeof e=="string"&&/\dxx/i.test(e)}function ne(e){return e==="default"||S(e)||P(e)}function ie(e,r=!1){if(e==="default")return r?"error":"success";let t=typeof e=="string"?parseInt(e,10):e;if(P(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let n="success";return t>=300&&t<400?n="redirect":t>=400?n="error":t<200&&(n="info"),n}const L={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};function oe(e){return e in L}function ue(e){const{operationId:r,pathName:t}=e,n=b(g(e,"description"));return b(g(e,"summary"))||r||n&&n.substring(0,50)||t||"<no summary>"}function se(e,r){return r?.id?_(r.id,m(e.operationId?e.operationId:d(e.pointer))).toLowerCase():e.tags?.length?m(e.operationId?e.operationId:d(e.pointer)):m(e.operationId?_(R,e.operationId):d(e.pointer))}function d(e){return e?.startsWith("/")?e.slice(1,e.length):e}const h={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",patternProperties:"object",properties:"object"};function ae(e){if(e.type!==void 0&&!Array.isArray(e.type))return e.type;const r=Object.keys(h);for(const t of r){const n=h[t];if(e[t]!==void 0)return n}return"any"}function k(e,r=e.type){if(e["x-circular-ref"]||e["x-complex"])return!0;if(e.oneOf!==void 0||e.anyOf!==void 0||e.if&&e.then||e.if&&e.else)return!1;let t=!0;const n=Array.isArray(r);return(r==="object"||n&&r?.includes("object"))&&(t=e.properties!==void 0?Object.keys(e.properties).length===0:e.additionalProperties===void 0&&e.unevaluatedProperties===void 0&&e.patternProperties===void 0),Array.isArray(e.items)||Array.isArray(e.prefixItems)?!1:(e.items!==void 0&&typeof e.items!="boolean"&&(r==="array"||n&&r?.includes("array"))&&(t=k(e.items,e.items.type)),t)}function q(e){return e.search(/json/i)!==-1}function ce(e){return e?.search(/xml/i)!==-1}function pe(e){return e===j.URL_ENCODED}function fe(e){return e===j.MULTIPART}function c(e,r,t){return Array.isArray(e)?e.map(n=>n.toString()).join(t):typeof e=="object"?Object.keys(e).map(n=>`${n}${t}${e[n]}`).join(t):r+"="+e.toString()}function w(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):typeof e=="object"?Object.keys(e).map(t=>e[t]?`${r}[${t}]=${e[t]}`:void 0).filter(Boolean).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function a(e,r,t){const n="__redoc_param_name__",i=r?"*":"";return f.parse(`{?${n}${i}}`).expand({[n]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function O(e,r){const t=e?"*":"",n="__redoc_param_name__",i=f.parse(`{${n}${t}}`);return F(i.expand({[n]:r}))}function me(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map(t=>{const n=e[t],{style:i="form",explode:o=!0}=r[t]||{};switch(i){case"form":return a(t,o,n);case"spaceDelimited":return c(n,t,"%20");case"pipeDelimited":return c(n,t,"|");case"deepObject":return w(n,t);default:return console.warn("Incorrect or unsupported encoding style: "+i),""}}).join("&")}function W(e,r,t,n){const i=t?"*":"";let o="";r==="label"?o=".":r==="matrix"&&(o=";");const s="__redoc_param_name__";return f.parse(`{${o}${s}${i}}`).expand({[s]:n}).replace(/__redoc_param_name__/g,e)}function H(e,r,t,n){const i=o=>{switch(r){case"form":return a(e,t,o);case"spaceDelimited":return!Array.isArray(o)&&typeof o!="object"?(console.warn("The style spaceDelimited is applicable to arrays or objects"),""):t?a(e,t,o):c(n,e,"%20");case"pipeDelimited":return!Array.isArray(o)&&typeof o!="object"?(console.warn("The style pipeDelimited is applicable to arrays or objects"),""):t?a(e,t,o):c(n,e,"|");case"deepObject":return!t||Array.isArray(o)||typeof o!="object"?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):w(o,e);case"simple":return O(t,n);default:return console.warn("Unexpected style for query: "+r),""}};return T(n)&&(n=E(n).map(o=>i(o))),i(n)}function C(e,r,t){switch(e){case"simple":return O(r,t);default:return console.warn("Unexpected style for header: "+e),""}}function B(e,r,t,n){switch(r){case"form":return a(e,t,n);default:return console.warn("Unexpected style for cookie: "+r),""}}function A(e,r){return q(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}function de(e,r){const{name:t,style:n,explode:i=!1,serializationMime:o}=e;if(o)switch(e.in){case"path":case"header":return A(r,o);case"cookie":case"query":return`${t}=${A(r,o)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!n)return console.warn(`Missing style attribute or content for parameter ${t}`),"";switch(e.in){case"path":return W(t,n,i,r);case"query":return H(t,n,i,r);case"header":return C(n,i,r);case"cookie":return B(t,n,i,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}function le(e){return e.search(/xml/i)!==-1?"xml":"clike"}const I=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function xe(e){return I.test(e||"")}function ye(e){return e?.match(I)?.pop()}function G(e){if(e===void 0)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function l(e,r,t){let n;return r!==void 0&&t!==void 0?r===t?n=`= ${r} ${e}`:n=`[ ${r} .. ${t} ] ${e}`:t!==void 0?n=`<= ${t} ${e}`:r!==void 0&&(r===1?n="non-empty":n=`>= ${r} ${e}`),n}function J(e){const r=typeof e.exclusiveMinimum=="number"?Math.min(e.exclusiveMinimum,e.minimum??1/0):e.minimum,t=typeof e.exclusiveMaximum=="number"?Math.max(e.exclusiveMaximum,e.maximum??-1/0):e.maximum,n=typeof e.exclusiveMinimum=="number"||e.exclusiveMinimum,i=typeof e.exclusiveMaximum=="number"||e.exclusiveMaximum;if(r!==void 0&&t!==void 0)return`${n?"( ":"[ "}${r} .. ${t}${i?" )":" ]"}`;if(t!==void 0)return`${i?"< ":"<= "}${t}`;if(r!==void 0)return`${n?"> ":">= "}${r}`}function be(e){const r=[],t=l("characters",e.minLength,e.maxLength);t!==void 0&&r.push(t);const n=l("items",e.minItems,e.maxItems);n!==void 0&&r.push(n);const i=l(e.minProperties===1&&e.maxProperties===1?"property":"properties",e.minProperties,e.maxProperties);i!==void 0&&r.push(i);const o=G(e.multipleOf);o!==void 0&&r.push(o);const s=J(e);return s!==void 0&&r.push(s),e.uniqueItems&&r.push("unique"),r}function ge(e,r=[]){const t=[],n=[],i=[];return e.forEach(o=>{o.required?r.includes(o.name)?n.push(o):i.push(o):t.push(o)}),n.sort((o,s)=>r.indexOf(o.name)-r.indexOf(s.name)),[...n,...i,...t]}function je(e){return e.sort((r,t)=>Number(r.deprecated)-Number(t.deprecated))}function $e(e,r=[],t=[],{pathPointer:n,operationPointer:i}){const o={};t.forEach(u=>{({resolved:u}=e.deref(u)),o[u.name+"_"+u.in]=!0});const s=r.map((u,p)=>({paramOrRef:u,pointer:$.join(n,["parameters",String(p)])})).filter(({paramOrRef:u})=>({resolved:u}=e.deref(u),!o[u.name+"_"+u.in])),x=t.map((u,p)=>({paramOrRef:u,pointer:$.join(i,["parameters",String(p)])}));return[...s,...x]}function _e(e,r){const n=e===void 0?z((()=>{if(!M)return globalThis.SSR_HOSTNAME||"";const i=window.location.href;return i.endsWith(".html")?y(i):i})()):N(e)?U(e):y(e);return r.length===0&&(r=[{url:"/"}]),r.map(i=>({...i,url:n?D(n,i.url):i.url,description:i.description||""}))}const Pe=e=>({delete:"del",options:"opts"})[e]||e;function Q(e){return e in{"x-circular-ref":!0,"x-complex":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-hideReplay":!0,"x-feedback":!0,"x-badges":!0,"x-assertionType":!0,"x-rbac":!0}||e.startsWith("x-parsed-md-")}function he(e,r){return Object.keys(e).filter(t=>r===!0?t.startsWith("x-")&&!Q(t):t.startsWith("x-")&&r.indexOf(t)>-1).reduce((t,n)=>(t[n]=e[n],t),{})}function we(e){return e.split(" or ").map(r=>r.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2")).join(" or ")}function Oe(e){let r=e.content;const t=e["x-examples"],n=e["x-example"];if(t){r={...r};for(const i of Object.keys(t)){const o=t[i];r[i]={...r[i],examples:o}}}else if(n){r={...r};for(const i of Object.keys(n)){const o=n[i];r[i]={...r[i],example:o}}}return r}export{ae as detectType,he as extractExtensions,Oe as getContentWithLegacyExamples,ye as getDefinitionName,se as getOperationId,ue as getOperationName,ie as getStatusCodeType,be as humanizeConstraints,J as humanizeNumberRange,pe as isFormUrlEncoded,q as isJsonLike,fe as isMultipartFormData,xe as isNamedDefinition,oe as isOperationName,k as isPrimitiveType,Q as isRedocExtension,ne as isStatusCode,ce as isXmlLike,le as langFromMime,$e as mergeParams,_e as normalizeServers,we as pluralizeType,de as serializeParameterValue,A as serializeParameterValueWithMime,H as serializeQueryParameter,Pe as shortenHTTPVerb,je as sortByDeprecated,ge as sortByRequired,me as urlFormEncodePayload};
+import { dirname } from 'path';
+import UrlTemplate from 'url-template';
+import { IS_BROWSER } from '@redocly/theme/core/openapi';
+import { deleteEmptyArrayItem, isArrayOfObjects, isNumeric, removeQueryStringAndHash, resolveUrl, sanitizeItemId, normalizeText, getValueFromMdParsedExtension, isAbsoluteUrl, } from './helpers.js';
+import { DEFAULT_TAG_SLUG, MediaTypes } from '../constants.js';
+import { JsonPointer } from './JsonPointer.js';
+import { joinWithSeparator } from '../services/index.js';
+import { tryDecodeURIComponent } from './string.js';
+import { getUrlDirname } from './url.js';
+function isWildcardStatusCode(statusCode) {
+    return typeof statusCode === 'string' && /\dxx/i.test(statusCode);
+}
+export function isStatusCode(statusCode) {
+    return statusCode === 'default' || isNumeric(statusCode) || isWildcardStatusCode(statusCode);
+}
+export function getStatusCodeType(statusCode, defaultAsError = false) {
+    if (statusCode === 'default') {
+        return defaultAsError ? 'error' : 'success';
+    }
+    let code = typeof statusCode === 'string' ? parseInt(statusCode, 10) : statusCode;
+    if (isWildcardStatusCode(statusCode)) {
+        code *= 100; // parseInt('2xx') parses to 2
+    }
+    if (code < 100 || code > 599) {
+        throw new Error('invalid HTTP code');
+    }
+    let res = 'success';
+    if (code >= 300 && code < 400) {
+        res = 'redirect';
+    }
+    else if (code >= 400) {
+        res = 'error';
+    }
+    else if (code < 200) {
+        res = 'info';
+    }
+    return res;
+}
+const operationNames = {
+    get: true,
+    post: true,
+    put: true,
+    head: true,
+    patch: true,
+    delete: true,
+    options: true,
+    $ref: true,
+};
+export function isOperationName(key) {
+    return key in operationNames;
+}
+export function getOperationName(operation) {
+    const { operationId, pathName } = operation;
+    const _description = normalizeText(getValueFromMdParsedExtension(operation, 'description'));
+    return (normalizeText(getValueFromMdParsedExtension(operation, 'summary')) ||
+        operationId ||
+        (_description && _description.substring(0, 50)) ||
+        pathName ||
+        '<no summary>');
+}
+export function getOperationId(operation, parent) {
+    if (parent?.id) {
+        return joinWithSeparator(parent.id, sanitizeItemId(operation.operationId ? operation.operationId : pointerToId(operation.pointer))).toLowerCase();
+    }
+    if (!operation.tags?.length) {
+        return sanitizeItemId(operation.operationId
+            ? joinWithSeparator(DEFAULT_TAG_SLUG, operation.operationId)
+            : pointerToId(operation.pointer));
+    }
+    return sanitizeItemId(operation.operationId ? operation.operationId : pointerToId(operation.pointer));
+}
+function pointerToId(pointer) {
+    return pointer?.startsWith('/') ? pointer.slice(1, pointer.length) : pointer;
+}
+const schemaKeywordTypes = {
+    multipleOf: 'number',
+    maximum: 'number',
+    exclusiveMaximum: 'number',
+    minimum: 'number',
+    exclusiveMinimum: 'number',
+    maxLength: 'string',
+    minLength: 'string',
+    pattern: 'string',
+    contentEncoding: 'string',
+    contentMediaType: 'string',
+    items: 'array',
+    maxItems: 'array',
+    minItems: 'array',
+    uniqueItems: 'array',
+    maxProperties: 'object',
+    minProperties: 'object',
+    required: 'object',
+    additionalProperties: 'object',
+    unevaluatedProperties: 'object',
+    patternProperties: 'object',
+    properties: 'object',
+};
+export function detectType(schema) {
+    if (schema.type !== undefined && !Array.isArray(schema.type)) {
+        return schema.type;
+    }
+    const keywords = Object.keys(schemaKeywordTypes);
+    for (const keyword of keywords) {
+        const type = schemaKeywordTypes[keyword];
+        if (schema[keyword] !== undefined) {
+            return type;
+        }
+    }
+    return 'any';
+}
+export function isPrimitiveType(schema, type = schema.type) {
+    if (schema['x-circular-ref']) {
+        return true;
+    }
+    if (schema['x-complex']) {
+        return true;
+    }
+    if (schema.oneOf !== undefined || schema.anyOf !== undefined) {
+        return false;
+    }
+    if ((schema.if && schema.then) || (schema.if && schema.else)) {
+        return false;
+    }
+    let isPrimitive = true;
+    const isArray = Array.isArray(type);
+    if (type === 'object' || (isArray && type?.includes('object'))) {
+        isPrimitive =
+            schema.properties !== undefined
+                ? Object.keys(schema.properties).length === 0
+                : schema.additionalProperties === undefined &&
+                    schema.unevaluatedProperties === undefined &&
+                    schema.patternProperties === undefined;
+    }
+    if (Array.isArray(schema.items) || Array.isArray(schema.prefixItems)) {
+        return false;
+    }
+    if (schema.items !== undefined &&
+        typeof schema.items !== 'boolean' &&
+        (type === 'array' || (isArray && type?.includes('array')))) {
+        isPrimitive = isPrimitiveType(schema.items, schema.items.type);
+    }
+    return isPrimitive;
+}
+export function isJsonLike(contentType) {
+    return contentType.search(/json/i) !== -1;
+}
+export function isXmlLike(contentType) {
+    return contentType?.search(/xml/i) !== -1;
+}
+export function isFormUrlEncoded(contentType) {
+    return contentType === MediaTypes.URL_ENCODED;
+}
+export function isMultipartFormData(contentType) {
+    return contentType === MediaTypes.MULTIPART;
+}
+function delimitedEncodeField(fieldVal, fieldName, delimiter) {
+    if (Array.isArray(fieldVal)) {
+        return fieldVal.map((v) => v.toString()).join(delimiter);
+    }
+    else if (typeof fieldVal === 'object') {
+        return Object.keys(fieldVal)
+            .map((k) => `${k}${delimiter}${fieldVal[k]}`)
+            .join(delimiter);
+    }
+    else {
+        return fieldName + '=' + fieldVal.toString();
+    }
+}
+function deepObjectEncodeField(fieldVal, fieldName) {
+    if (Array.isArray(fieldVal)) {
+        console.warn('deepObject style cannot be used with array value:' + fieldVal.toString());
+        return '';
+    }
+    else if (typeof fieldVal === 'object') {
+        return Object.keys(fieldVal)
+            .map((k) => (fieldVal[k] ? `${fieldName}[${k}]=${fieldVal[k]}` : undefined))
+            .filter(Boolean)
+            .join('&');
+    }
+    else {
+        console.warn('deepObject style cannot be used with non-object value:' + fieldVal.toString());
+        return '';
+    }
+}
+function serializeFormValue(name, explode, value) {
+    // Use RFC6570 safe name ([a-zA-Z0-9_]) and replace with our name later
+    // e.g. URI.template doesn't parse names with hyphen (-) which are valid query param names
+    const safeName = '__redoc_param_name__';
+    const suffix = explode ? '*' : '';
+    const template = UrlTemplate.parse(`{?${safeName}${suffix}}`);
+    return template
+        .expand({ [safeName]: value })
+        .substring(1)
+        .replace(/__redoc_param_name__/g, name);
+}
+function serializeSimpleValue(explode, value) {
+    const suffix = explode ? '*' : '';
+    // name is not important here, so use RFC6570 safe name ([a-zA-Z0-9_])
+    const name = '__redoc_param_name__';
+    const template = UrlTemplate.parse(`{${name}${suffix}}`);
+    return tryDecodeURIComponent(template.expand({ [name]: value }));
+}
+/*
+ * Should be used only for url-form-encoded body payloads
+ * To be used for parameters should be extended with other style values
+ */
+export function urlFormEncodePayload(payload, encoding = {}) {
+    if (Array.isArray(payload)) {
+        throw new Error('Payload must have fields: ' + payload.toString());
+    }
+    else {
+        return Object.keys(payload)
+            .map((fieldName) => {
+            const fieldVal = payload[fieldName];
+            const { style = 'form', explode = true } = encoding[fieldName] || {};
+            switch (style) {
+                case 'form':
+                    return serializeFormValue(fieldName, explode, fieldVal);
+                case 'spaceDelimited':
+                    return delimitedEncodeField(fieldVal, fieldName, '%20');
+                case 'pipeDelimited':
+                    return delimitedEncodeField(fieldVal, fieldName, '|');
+                case 'deepObject':
+                    return deepObjectEncodeField(fieldVal, fieldName);
+                default:
+                    // TODO implement rest of styles for path parameters
+                    console.warn('Incorrect or unsupported encoding style: ' + style);
+                    return '';
+            }
+        })
+            .join('&');
+    }
+}
+function serializePathParameter(name, style, explode, value) {
+    const suffix = explode ? '*' : '';
+    let prefix = '';
+    if (style === 'label') {
+        prefix = '.';
+    }
+    else if (style === 'matrix') {
+        prefix = ';';
+    }
+    // Use RFC6570 safe name ([a-zA-Z0-9_]) and replace with our name later
+    // e.g. URI.template doesn't parse names with hyphen (-) which are valid query param names
+    const safeName = '__redoc_param_name__';
+    const template = UrlTemplate.parse(`{${prefix}${safeName}${suffix}}`);
+    return template.expand({ [safeName]: value }).replace(/__redoc_param_name__/g, name);
+}
+export function serializeQueryParameter(name, style, explode, value) {
+    const serializationByStyle = (val) => {
+        switch (style) {
+            case 'form':
+                return serializeFormValue(name, explode, val);
+            case 'spaceDelimited':
+                if (!Array.isArray(val) && typeof val !== 'object') {
+                    console.warn('The style spaceDelimited is applicable to arrays or objects');
+                    return '';
+                }
+                if (explode) {
+                    return serializeFormValue(name, explode, val);
+                }
+                return delimitedEncodeField(value, name, '%20');
+            case 'pipeDelimited':
+                if (!Array.isArray(val) && typeof val !== 'object') {
+                    console.warn('The style pipeDelimited is applicable to arrays or objects');
+                    return '';
+                }
+                if (explode) {
+                    return serializeFormValue(name, explode, val);
+                }
+                return delimitedEncodeField(value, name, '|');
+            case 'deepObject':
+                if (!explode || Array.isArray(val) || typeof val !== 'object') {
+                    console.warn('The style deepObject is only applicable for objects with explode=true');
+                    return '';
+                }
+                return deepObjectEncodeField(val, name);
+            case 'simple': {
+                return serializeSimpleValue(explode, value);
+            }
+            default:
+                console.warn('Unexpected style for query: ' + style);
+                return '';
+        }
+    };
+    if (isArrayOfObjects(value)) {
+        value = deleteEmptyArrayItem(value).map((value) => serializationByStyle(value));
+    }
+    return serializationByStyle(value);
+}
+function serializeHeaderParameter(style, explode, value) {
+    switch (style) {
+        case 'simple': {
+            return serializeSimpleValue(explode, value);
+        }
+        default:
+            console.warn('Unexpected style for header: ' + style);
+            return '';
+    }
+}
+function serializeCookieParameter(name, style, explode, value) {
+    switch (style) {
+        case 'form':
+            return serializeFormValue(name, explode, value);
+        default:
+            console.warn('Unexpected style for cookie: ' + style);
+            return '';
+    }
+}
+export function serializeParameterValueWithMime(value, mime) {
+    if (isJsonLike(mime)) {
+        return JSON.stringify(value);
+    }
+    else {
+        console.warn(`Parameter serialization as ${mime} is not supported`);
+        return '';
+    }
+}
+export function serializeParameterValue(parameter, value) {
+    const { name, style, explode = false, serializationMime } = parameter;
+    if (serializationMime) {
+        switch (parameter.in) {
+            case 'path':
+            case 'header':
+                return serializeParameterValueWithMime(value, serializationMime);
+            case 'cookie':
+            case 'query':
+                return `${name}=${serializeParameterValueWithMime(value, serializationMime)}`;
+            default:
+                console.warn('Unexpected parameter location: ' + parameter.in);
+                return '';
+        }
+    }
+    if (!style) {
+        console.warn(`Missing style attribute or content for parameter ${name}`);
+        return '';
+    }
+    switch (parameter.in) {
+        case 'path':
+            return serializePathParameter(name, style, explode, value);
+        case 'query':
+            return serializeQueryParameter(name, style, explode, value);
+        case 'header':
+            return serializeHeaderParameter(style, explode, value);
+        case 'cookie':
+            return serializeCookieParameter(name, style, explode, value);
+        default:
+            console.warn('Unexpected parameter location: ' + parameter.in);
+            return '';
+    }
+}
+export function langFromMime(contentType) {
+    if (contentType.search(/xml/i) !== -1) {
+        return 'xml';
+    }
+    return 'clike';
+}
+const DEFINITION_NAME_REGEX = /^#\/components\/(schemas|pathItems)\/([^/]+)$/;
+export function isNamedDefinition(pointer) {
+    return DEFINITION_NAME_REGEX.test(pointer || '');
+}
+export function getDefinitionName(pointer) {
+    return pointer?.match(DEFINITION_NAME_REGEX)?.pop();
+}
+function humanizeMultipleOfConstraint(multipleOf) {
+    if (multipleOf === undefined) {
+        return;
+    }
+    const strigifiedMultipleOf = multipleOf.toString(10);
+    if (!/^0\.0*1$/.test(strigifiedMultipleOf)) {
+        return `multiple of ${strigifiedMultipleOf}`;
+    }
+    return `decimal places <= ${strigifiedMultipleOf.split('.')[1].length}`;
+}
+function humanizeRangeConstraint(description, min, max) {
+    let stringRange;
+    if (min !== undefined && max !== undefined) {
+        if (min === max) {
+            stringRange = `= ${min} ${description}`;
+        }
+        else {
+            stringRange = `[ ${min} .. ${max} ] ${description}`;
+        }
+    }
+    else if (max !== undefined) {
+        stringRange = `<= ${max} ${description}`;
+    }
+    else if (min !== undefined) {
+        if (min === 1) {
+            stringRange = 'non-empty';
+        }
+        else {
+            stringRange = `>= ${min} ${description}`;
+        }
+    }
+    return stringRange;
+}
+export function humanizeNumberRange(schema) {
+    const minimum = typeof schema.exclusiveMinimum === 'number'
+        ? Math.min(schema.exclusiveMinimum, schema.minimum ?? Infinity)
+        : schema.minimum;
+    const maximum = typeof schema.exclusiveMaximum === 'number'
+        ? Math.max(schema.exclusiveMaximum, schema.maximum ?? -Infinity)
+        : schema.maximum;
+    const exclusiveMinimum = typeof schema.exclusiveMinimum === 'number' || schema.exclusiveMinimum;
+    const exclusiveMaximum = typeof schema.exclusiveMaximum === 'number' || schema.exclusiveMaximum;
+    if (minimum !== undefined && maximum !== undefined) {
+        return `${exclusiveMinimum ? '( ' : '[ '}${minimum} .. ${maximum}${exclusiveMaximum ? ' )' : ' ]'}`;
+    }
+    else if (maximum !== undefined) {
+        return `${exclusiveMaximum ? '< ' : '<= '}${maximum}`;
+    }
+    else if (minimum !== undefined) {
+        return `${exclusiveMinimum ? '> ' : '>= '}${minimum}`;
+    }
+}
+export function humanizeConstraints(schema) {
+    const res = [];
+    const stringRange = humanizeRangeConstraint('characters', schema.minLength, schema.maxLength);
+    if (stringRange !== undefined) {
+        res.push(stringRange);
+    }
+    const arrayRange = humanizeRangeConstraint('items', schema.minItems, schema.maxItems);
+    if (arrayRange !== undefined) {
+        res.push(arrayRange);
+    }
+    const propertiesRange = humanizeRangeConstraint(schema.minProperties === 1 && schema.maxProperties === 1 ? 'property' : 'properties', schema.minProperties, schema.maxProperties);
+    if (propertiesRange !== undefined) {
+        res.push(propertiesRange);
+    }
+    const multipleOfConstraint = humanizeMultipleOfConstraint(schema.multipleOf);
+    if (multipleOfConstraint !== undefined) {
+        res.push(multipleOfConstraint);
+    }
+    const numberRange = humanizeNumberRange(schema);
+    if (numberRange !== undefined) {
+        res.push(numberRange);
+    }
+    if (schema.uniqueItems) {
+        res.push('unique');
+    }
+    return res;
+}
+export function sortByRequired(fields, order = []) {
+    const unrequiredFields = [];
+    const orderedFields = [];
+    const unorderedFields = [];
+    fields.forEach((field) => {
+        if (field.required) {
+            if (order.includes(field.name)) {
+                orderedFields.push(field);
+            }
+            else {
+                unorderedFields.push(field);
+            }
+        }
+        else {
+            unrequiredFields.push(field);
+        }
+    });
+    orderedFields.sort((a, b) => order.indexOf(a.name) - order.indexOf(b.name));
+    return [...orderedFields, ...unorderedFields, ...unrequiredFields];
+}
+export function sortByDeprecated(fields) {
+    return fields.sort((a, b) => Number(a.deprecated) - Number(b.deprecated));
+}
+export function mergeParams(parser, pathParams = [], operationParams = [], { pathPointer, operationPointer }) {
+    const operationParamNames = {};
+    operationParams.forEach((param) => {
+        ({ resolved: param } = parser.deref(param));
+        operationParamNames[param.name + '_' + param.in] = true;
+    });
+    const pathParamsPointer = pathParams
+        .map((paramOrRef, index) => ({
+        paramOrRef,
+        pointer: JsonPointer.join(pathPointer, ['parameters', String(index)]),
+    }))
+        // filter out path params overridden by operation ones with the same name
+        .filter(({ paramOrRef }) => {
+        ({ resolved: paramOrRef } = parser.deref(paramOrRef));
+        return !operationParamNames[paramOrRef.name + '_' + paramOrRef.in];
+    });
+    const operationParamsPointer = operationParams.map((paramOrRef, index) => ({
+        paramOrRef,
+        pointer: JsonPointer.join(operationPointer, ['parameters', String(index)]),
+    }));
+    return [...pathParamsPointer, ...operationParamsPointer];
+}
+export function normalizeServers(specUrl, servers) {
+    const getHref = () => {
+        if (!IS_BROWSER) {
+            return globalThis.SSR_HOSTNAME || '';
+        }
+        const href = window.location.href;
+        return href.endsWith('.html') ? dirname(href) : href;
+    };
+    const baseUrl = specUrl === undefined
+        ? removeQueryStringAndHash(getHref())
+        : isAbsoluteUrl(specUrl)
+            ? getUrlDirname(specUrl)
+            : dirname(specUrl);
+    if (servers.length === 0) {
+        // Behaviour defined in OpenAPI spec: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#openapi-object
+        servers = [
+            {
+                url: '/',
+            },
+        ];
+    }
+    return servers.map((server) => {
+        return {
+            ...server,
+            url: baseUrl ? resolveUrl(baseUrl, server.url) : server.url,
+            description: server.description || '',
+        };
+    });
+}
+export const shortenHTTPVerb = (verb) => ({
+    delete: 'del',
+    options: 'opts',
+})[verb] || verb;
+export function isRedocExtension(key) {
+    const redocExtensions = {
+        'x-circular-ref': true,
+        'x-complex': true,
+        'x-parentRefs': true,
+        'x-refsStack': true,
+        'x-codeSamples': true,
+        'x-displayName': true,
+        'x-examples': true,
+        'x-logo': true,
+        'x-nullable': true,
+        'x-servers': true,
+        'x-tagGroups': true,
+        'x-traitTag': true,
+        'x-additionalPropertiesName': true,
+        'x-explicitMappingOnly': true,
+        'x-enumDescriptions': true,
+        'x-hideReplay': true,
+        'x-feedback': true,
+        'x-badges': true,
+        'x-assertionType': true,
+        'x-rbac': true,
+    };
+    return key in redocExtensions || key.startsWith('x-parsed-md-');
+}
+export function extractExtensions(obj, showExtensions) {
+    return Object.keys(obj)
+        .filter((key) => {
+        if (showExtensions === true) {
+            return key.startsWith('x-') && !isRedocExtension(key);
+        }
+        return key.startsWith('x-') && showExtensions.indexOf(key) > -1;
+    })
+        .reduce((acc, key) => {
+        acc[key] = obj[key];
+        return acc;
+    }, {});
+}
+export function pluralizeType(displayType) {
+    return displayType
+        .split(' or ')
+        .map((type) => type.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/, '$1s$2'))
+        .join(' or ');
+}
+export function getContentWithLegacyExamples(info) {
+    let mediaContent = info.content;
+    const xExamples = info['x-examples']; // converted from OAS2 body param
+    const xExample = info['x-example']; // converted from OAS2 body param
+    if (xExamples) {
+        mediaContent = { ...mediaContent };
+        for (const mime of Object.keys(xExamples)) {
+            const examples = xExamples[mime];
+            mediaContent[mime] = {
+                ...mediaContent[mime],
+                examples,
+            };
+        }
+    }
+    else if (xExample) {
+        mediaContent = { ...mediaContent };
+        for (const mime of Object.keys(xExample)) {
+            const example = xExample[mime];
+            mediaContent[mime] = {
+                ...mediaContent[mime],
+                example,
+            };
+        }
+    }
+    return mediaContent;
+}
+//# sourceMappingURL=openapi.js.map

package/lib/utils/parameters.js

@@ -1 +1,13 @@
-import{fromSessionStorage as o,toSessionStorage as a}from"./session-storage.js";function i(r,e){try{return JSON.parse(o(`${r}.${e}`))}catch{return null}}function s(r,e,t){a(`${r}.${e}`,JSON.stringify(t))}export{i as getParameterValue,s as setParameterValue};
+import { fromSessionStorage, toSessionStorage } from './session-storage.js';
+export function getParameterValue(_in, name) {
+    try {
+        return JSON.parse(fromSessionStorage(`${_in}.${name}`));
+    }
+    catch {
+        return null;
+    }
+}
+export function setParameterValue(_in, name, value) {
+    toSessionStorage(`${_in}.${name}`, JSON.stringify(value));
+}
+//# sourceMappingURL=parameters.js.map

package/lib/utils/path.js

@@ -1 +1,22 @@
-import{tryDecodeURIComponent as n}from"./string.js";function o(e,r){return r?n(e.pathname+e.hash).includes(n(r.toLowerCase())):!1}function a(e,r=""){const t=n(r.toLowerCase());return n(e.pathname)===t||n(e.hash)===t||n(e.pathname+e.hash)===t}function h(e){return e.startsWith("/")||(e="/"+e),e.endsWith("/")&&(e=e.slice(0,-1)),e}export{h as normalizePath,o as pathIncludesLink,a as pathMatchedLink};
+import { tryDecodeURIComponent } from './string.js';
+export function pathIncludesLink(location, link) {
+    return link
+        ? tryDecodeURIComponent(location.pathname + location.hash).includes(tryDecodeURIComponent(link.toLowerCase()))
+        : false;
+}
+export function pathMatchedLink(location, link = '') {
+    const lowercaseLink = tryDecodeURIComponent(link.toLowerCase());
+    return (tryDecodeURIComponent(location.pathname) === lowercaseLink ||
+        tryDecodeURIComponent(location.hash) === lowercaseLink ||
+        tryDecodeURIComponent(location.pathname + location.hash) === lowercaseLink);
+}
+export function normalizePath(path) {
+    if (!path.startsWith('/')) {
+        path = '/' + path;
+    }
+    if (path.endsWith('/')) {
+        path = path.slice(0, -1);
+    }
+    return path;
+}
+//# sourceMappingURL=path.js.map