@redocly/openapi-docs 3.0.0-alpha.23 → 3.0.0-alpha.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/console.redocly-openapi-docs.min.js +146 -146
- package/dist/oauth2-redirect.js +4 -4
- package/dist/redocly-openapi-docs.min.js +4042 -4044
- package/lib/components/ApiInfo/ApiInfo.d.ts +1 -0
- package/lib/components/ApiInfo/ApiInfo.js +1 -1
- package/lib/components/Callbacks/CallbackOperation.d.ts +1 -0
- package/lib/components/Callbacks/CallbackSummary.d.ts +1 -0
- package/lib/components/ChangeViewButton/ChangeViewButton.d.ts +1 -0
- package/lib/components/ChangeViewButton/styled.d.ts +1 -0
- package/lib/components/ContentItems/ContentItems.js +1 -1
- package/lib/components/Download/DownloadLink.d.ts +1 -0
- package/lib/components/Endpoint/styled.d.ts +1 -0
- package/lib/components/Fields/Examples.d.ts +1 -0
- package/lib/components/Fields/FieldDetails.js +1 -1
- package/lib/components/Fields/types.d.ts +1 -0
- package/lib/components/GenericChildrenSwitcher/GenericChildrenSwitcher.d.ts +1 -0
- package/lib/components/Loading/Loading.d.ts +1 -0
- package/lib/components/Markdown/Markdown.d.ts +1 -0
- package/lib/components/Markdown/types.d.ts +1 -0
- package/lib/components/NextSectionButton/NextSectionButton.d.ts +1 -0
- package/lib/components/OperationItem/OperationItem.js +1 -1
- package/lib/components/OperationParameters/OperationParameters.d.ts +1 -0
- package/lib/components/Overlay.d.ts +1 -0
- package/lib/components/Parameters/DropdownWithinHeader.d.ts +1 -0
- package/lib/components/Parameters/Parameters.d.ts +1 -0
- package/lib/components/PayloadSamples/Example.d.ts +1 -0
- package/lib/components/PayloadSamples/ExampleValue.d.ts +1 -0
- package/lib/components/PayloadSamples/ExternalExample.d.ts +1 -0
- package/lib/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.d.ts +1 -0
- package/lib/components/RedoclyOpenAPIDocs/types.d.ts +1 -0
- package/lib/components/RenderHook/RenderHook.d.ts +1 -0
- package/lib/components/RequestSamples/useCodeSamples.d.ts +1 -1
- package/lib/components/RequestSamples/useCodeSamples.js +1 -1
- package/lib/components/Responses/Response.d.ts +1 -0
- package/lib/components/Responses/ResponseSummary.d.ts +1 -0
- package/lib/components/Samples/ExampleSwitch.d.ts +1 -0
- package/lib/components/Search/MenuItemSearch.d.ts +1 -0
- package/lib/components/Search/SearchBox.d.ts +1 -0
- package/lib/components/Search/SearchField.d.ts +1 -0
- package/lib/components/SectionContent/SectionContent.d.ts +1 -0
- package/lib/components/SecurityRequirement/PanelDescription.d.ts +1 -0
- package/lib/components/SecurityRequirement/RequiredScopesRow.d.ts +1 -0
- package/lib/components/SecurityRequirement/RequirementElement.d.ts +1 -0
- package/lib/components/SecurityRequirement/SecurityDefs.d.ts +1 -0
- package/lib/components/SeeMore/SeeMore.js +1 -1
- package/lib/components/SideMenu/styled.d.ts +1 -0
- package/lib/components/SourceCodeWithFile/SourceCodeWithFile.d.ts +1 -0
- package/lib/components/TagItem/TagItem.d.ts +1 -0
- package/lib/components/TagItems/TagItems.d.ts +1 -0
- package/lib/components/ToggleRightPanelButton/ToggleRightPanelButton.d.ts +1 -0
- package/lib/components/ToggleRightPanelButton/styled.d.ts +1 -0
- package/lib/components/VersionSwitcher.d.ts +1 -0
- package/lib/components/common/CheckboxList.d.ts +2 -1
- package/lib/components/common/LinearProgress.d.ts +1 -0
- package/lib/components/common/Skeleton/Skeleton.d.ts +1 -0
- package/lib/components/common/TextField.d.ts +1 -1
- package/lib/components/icons/CrossIcon.d.ts +1 -0
- package/lib/components/icons/FileIcon.d.ts +1 -0
- package/lib/components/icons/LinkIcon.d.ts +1 -0
- package/lib/components/icons/LockIcon.d.ts +1 -0
- package/lib/components/icons/SearchIcon.d.ts +1 -0
- package/lib/components/icons/ShelfIcon.d.ts +1 -0
- package/lib/components/icons/Spinner.d.ts +1 -0
- package/lib/components/pluggable/PullRight.d.ts +1 -0
- package/lib/components/pluggable/RedocExample.d.ts +1 -0
- package/lib/components/pluggable/RedocRequestBody.d.ts +1 -0
- package/lib/components/pluggable/RedocResponse.d.ts +1 -0
- package/lib/components/pluggable/RedocSchema.d.ts +1 -0
- package/lib/components/rightPanel/AuthPanel/AuthPanel.d.ts +1 -0
- package/lib/components/rightPanel/Console/Console.js +1 -1
- package/lib/components/rightPanel/Console/ConsoleLazy.d.ts +1 -0
- package/lib/components/rightPanel/ConsoleTabs/ConsoleTabs.d.ts +1 -0
- package/lib/components/rightPanel/OAuth2Flow/Error.d.ts +1 -0
- package/lib/components/rightPanel/OAuth2Flow/OAuth2Flow.d.ts +1 -0
- package/lib/components/rightPanel/OAuth2TokenInput.d.ts +1 -0
- package/lib/components/rightPanel/OpenIDConnect.d.ts +1 -0
- package/lib/components/rightPanel/ParameterArray.d.ts +1 -0
- package/lib/components/rightPanel/ParameterDropdown.d.ts +2 -1
- package/lib/components/rightPanel/ResponseBody.d.ts +1 -0
- package/lib/components/rightPanel/ResponseHeadersList.d.ts +1 -0
- package/lib/components/rightPanel/ResponsePanel.d.ts +1 -0
- package/lib/components/rightPanel/Scope.d.ts +1 -0
- package/lib/components/rightPanel/ServerVariable.d.ts +1 -0
- package/lib/models/example.js +1 -1
- package/lib/models/field.js +1 -1
- package/lib/models/group.js +1 -1
- package/lib/models/operation.js +1 -1
- package/lib/models/request.js +1 -1
- package/lib/models/response.js +1 -1
- package/lib/models/schema.js +1 -1
- package/lib/models/security.js +1 -1
- package/lib/models/types.d.ts +1 -2
- package/lib/recoil/operation.d.ts +1 -2
- package/lib/services/OpenAPIParser.js +1 -1
- package/lib/services/Options/normalizeOptions.js +1 -1
- package/lib/services/Options/types.d.ts +2 -0
- package/lib/services/code-samples/generator.js +1 -1
- package/lib/services/menu/builder.js +1 -1
- package/lib/services/menu/tags.js +1 -1
- package/lib/services/search/SearchStore.js +1 -1
- package/lib/types/open-api.d.ts +35 -29
- package/lib/utils/helpers.d.ts +2 -1
- package/lib/utils/helpers.js +1 -1
- package/lib/utils/highlight.js +1 -1
- package/lib/utils/openapi.d.ts +2 -4
- package/lib/utils/openapi.js +1 -1
- package/lib-esm/components/ApiInfo/ApiInfo.d.ts +1 -0
- package/lib-esm/components/ApiInfo/ApiInfo.js +1 -1
- package/lib-esm/components/Callbacks/CallbackOperation.d.ts +1 -0
- package/lib-esm/components/Callbacks/CallbackSummary.d.ts +1 -0
- package/lib-esm/components/ChangeViewButton/ChangeViewButton.d.ts +1 -0
- package/lib-esm/components/ChangeViewButton/styled.d.ts +1 -0
- package/lib-esm/components/ContentItems/ContentItems.js +1 -1
- package/lib-esm/components/Download/DownloadLink.d.ts +1 -0
- package/lib-esm/components/Endpoint/styled.d.ts +1 -0
- package/lib-esm/components/Fields/Examples.d.ts +1 -0
- package/lib-esm/components/Fields/FieldDetails.js +1 -1
- package/lib-esm/components/Fields/types.d.ts +1 -0
- package/lib-esm/components/GenericChildrenSwitcher/GenericChildrenSwitcher.d.ts +1 -0
- package/lib-esm/components/Loading/Loading.d.ts +1 -0
- package/lib-esm/components/Markdown/Markdown.d.ts +1 -0
- package/lib-esm/components/Markdown/types.d.ts +1 -0
- package/lib-esm/components/NextSectionButton/NextSectionButton.d.ts +1 -0
- package/lib-esm/components/OperationItem/OperationItem.js +2 -2
- package/lib-esm/components/OperationParameters/OperationParameters.d.ts +1 -0
- package/lib-esm/components/Overlay.d.ts +1 -0
- package/lib-esm/components/Parameters/DropdownWithinHeader.d.ts +1 -0
- package/lib-esm/components/Parameters/Parameters.d.ts +1 -0
- package/lib-esm/components/PayloadSamples/Example.d.ts +1 -0
- package/lib-esm/components/PayloadSamples/ExampleValue.d.ts +1 -0
- package/lib-esm/components/PayloadSamples/ExternalExample.d.ts +1 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/RedoclyOpenAPIDocsMultiStandalone.d.ts +1 -0
- package/lib-esm/components/RedoclyOpenAPIDocs/types.d.ts +1 -0
- package/lib-esm/components/RenderHook/RenderHook.d.ts +1 -0
- package/lib-esm/components/RequestSamples/useCodeSamples.d.ts +1 -1
- package/lib-esm/components/RequestSamples/useCodeSamples.js +1 -1
- package/lib-esm/components/Responses/Response.d.ts +1 -0
- package/lib-esm/components/Responses/ResponseSummary.d.ts +1 -0
- package/lib-esm/components/Samples/ExampleSwitch.d.ts +1 -0
- package/lib-esm/components/Search/MenuItemSearch.d.ts +1 -0
- package/lib-esm/components/Search/SearchBox.d.ts +1 -0
- package/lib-esm/components/Search/SearchField.d.ts +1 -0
- package/lib-esm/components/SectionContent/SectionContent.d.ts +1 -0
- package/lib-esm/components/SecurityRequirement/PanelDescription.d.ts +1 -0
- package/lib-esm/components/SecurityRequirement/RequiredScopesRow.d.ts +1 -0
- package/lib-esm/components/SecurityRequirement/RequirementElement.d.ts +1 -0
- package/lib-esm/components/SecurityRequirement/SecurityDefs.d.ts +1 -0
- package/lib-esm/components/SeeMore/SeeMore.js +1 -1
- package/lib-esm/components/SideMenu/styled.d.ts +1 -0
- package/lib-esm/components/SourceCodeWithFile/SourceCodeWithFile.d.ts +1 -0
- package/lib-esm/components/TagItem/TagItem.d.ts +1 -0
- package/lib-esm/components/TagItems/TagItems.d.ts +1 -0
- package/lib-esm/components/ToggleRightPanelButton/ToggleRightPanelButton.d.ts +1 -0
- package/lib-esm/components/ToggleRightPanelButton/styled.d.ts +1 -0
- package/lib-esm/components/VersionSwitcher.d.ts +1 -0
- package/lib-esm/components/common/CheckboxList.d.ts +2 -1
- package/lib-esm/components/common/LinearProgress.d.ts +1 -0
- package/lib-esm/components/common/Skeleton/Skeleton.d.ts +1 -0
- package/lib-esm/components/common/TextField.d.ts +1 -1
- package/lib-esm/components/icons/CrossIcon.d.ts +1 -0
- package/lib-esm/components/icons/FileIcon.d.ts +1 -0
- package/lib-esm/components/icons/LinkIcon.d.ts +1 -0
- package/lib-esm/components/icons/LockIcon.d.ts +1 -0
- package/lib-esm/components/icons/SearchIcon.d.ts +1 -0
- package/lib-esm/components/icons/ShelfIcon.d.ts +1 -0
- package/lib-esm/components/icons/Spinner.d.ts +1 -0
- package/lib-esm/components/pluggable/PullRight.d.ts +1 -0
- package/lib-esm/components/pluggable/RedocExample.d.ts +1 -0
- package/lib-esm/components/pluggable/RedocRequestBody.d.ts +1 -0
- package/lib-esm/components/pluggable/RedocResponse.d.ts +1 -0
- package/lib-esm/components/pluggable/RedocSchema.d.ts +1 -0
- package/lib-esm/components/rightPanel/AuthPanel/AuthPanel.d.ts +1 -0
- package/lib-esm/components/rightPanel/Console/Console.js +1 -1
- package/lib-esm/components/rightPanel/Console/ConsoleLazy.d.ts +1 -0
- package/lib-esm/components/rightPanel/ConsoleTabs/ConsoleTabs.d.ts +1 -0
- package/lib-esm/components/rightPanel/OAuth2Flow/Error.d.ts +1 -0
- package/lib-esm/components/rightPanel/OAuth2Flow/OAuth2Flow.d.ts +1 -0
- package/lib-esm/components/rightPanel/OAuth2TokenInput.d.ts +1 -0
- package/lib-esm/components/rightPanel/OpenIDConnect.d.ts +1 -0
- package/lib-esm/components/rightPanel/ParameterArray.d.ts +1 -0
- package/lib-esm/components/rightPanel/ParameterDropdown.d.ts +2 -1
- package/lib-esm/components/rightPanel/ResponseBody.d.ts +1 -0
- package/lib-esm/components/rightPanel/ResponseHeadersList.d.ts +1 -0
- package/lib-esm/components/rightPanel/ResponsePanel.d.ts +1 -0
- package/lib-esm/components/rightPanel/Scope.d.ts +1 -0
- package/lib-esm/components/rightPanel/ServerVariable.d.ts +1 -0
- package/lib-esm/models/example.js +1 -1
- package/lib-esm/models/field.js +1 -1
- package/lib-esm/models/group.js +1 -1
- package/lib-esm/models/operation.js +1 -1
- package/lib-esm/models/request.js +1 -1
- package/lib-esm/models/response.js +1 -1
- package/lib-esm/models/schema.js +1 -1
- package/lib-esm/models/security.js +1 -1
- package/lib-esm/models/types.d.ts +1 -2
- package/lib-esm/recoil/operation.d.ts +1 -2
- package/lib-esm/services/OpenAPIParser.js +1 -1
- package/lib-esm/services/Options/normalizeOptions.js +1 -1
- package/lib-esm/services/Options/types.d.ts +2 -0
- package/lib-esm/services/code-samples/generator.js +1 -1
- package/lib-esm/services/menu/builder.js +1 -1
- package/lib-esm/services/menu/tags.js +1 -1
- package/lib-esm/services/search/SearchStore.js +1 -1
- package/lib-esm/types/open-api.d.ts +35 -29
- package/lib-esm/utils/helpers.d.ts +2 -1
- package/lib-esm/utils/helpers.js +1 -1
- package/lib-esm/utils/highlight.js +1 -1
- package/lib-esm/utils/openapi.d.ts +2 -4
- package/lib-esm/utils/openapi.js +1 -1
- package/package.json +4 -4
package/lib/utils/openapi.js
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getContentWithLegacyExamples=exports.pluralizeType=exports.extractExtensions=exports.isRedocExtension=exports.shortenHTTPVerb=exports.normalizeServers=exports.expandDefaultServerVariables=exports.mergeSimilarMediaTypes=exports.mergeParams=exports.sortByField=exports.sortByRequired=exports.humanizeConstraints=exports.humanizeNumberRange=exports.getDefinitionName=exports.isNamedDefinition=exports.langFromMime=exports.serializeParameterValue=exports.serializeParameterValueWithMime=exports.serializeQueryParameter=exports.urlFormEncodePayload=exports.isFormUrlEncoded=exports.isJsonLike=exports.isPrimitiveType=exports.detectType=exports.getOperationId=exports.getOperationName=exports.isOperationName=exports.getStatusCodeType=exports.isStatusCode=void 0;const path_1=require("path"),url_template_1=__importDefault(require("url-template")),dom_1=require("./dom"),helpers_1=require("./helpers"),constants_1=require("../constants"),JsonPointer_1=require("./JsonPointer");function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}function isStatusCode(e){return"default"===e||(0,helpers_1.isNumeric)(e)||isWildcardStatusCode(e)}function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}exports.isStatusCode=isStatusCode,exports.getStatusCodeType=getStatusCodeType;const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};function isOperationName(e){return e in operationNames}function getOperationName({operationId:e,description:r,summary:t,pathName:i}){const n=(0,helpers_1.normalizeText)(r);return(0,helpers_1.normalizeText)(t)||e||n&&n.substring(0,50)||i||"<no summary>"}function getOperationId(e,r){return(0,helpers_1.sanitizeItemId)(void 0!==e.operationId?"operation/"+e.operationId:void 0!==r?r.id+e.pointer:e.pointer)}exports.isOperationName=isOperationName,exports.getOperationName=getOperationName,exports.getOperationId=getOperationId;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"};function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties&&void 0===e.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}function isJsonLike(e){return-1!==e.search(/json/i)}function isFormUrlEncoded(e){return e===constants_1.MediaTypes.URL_ENCODED}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${r}${t}${e[r]}`)).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?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 serializeFormValue(e,r,t){const i="__redoc_param_name__",n=r?"*":"";return url_template_1.default.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=url_template_1.default.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:a=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,a,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let a="";"label"===r?a=".":"matrix"===r&&(a=";");const o="__redoc_param_name__";return url_template_1.default.parse(`{${a}${o}${n}}`).expand({[o]:i}).replace(/__redoc_param_name__/g,e)}function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("%20")}`:(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("|")}`:(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return(0,helpers_1.isArrayOfObjects)(i)&&(i=(0,helpers_1.deleteEmptyArrayItem)(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(console.warn("Unexpected style for header: "+e),"")}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:a}=e;if(a)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,a);case"cookie":case"query":return`${t}=${serializeParameterValueWithMime(r,a)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn(`Missing style attribute or content for parameter ${t}`),"";switch(e.in){case"path":return serializePathParameter(t,i,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}exports.detectType=detectType,exports.isPrimitiveType=isPrimitiveType,exports.isJsonLike=isJsonLike,exports.isFormUrlEncoded=isFormUrlEncoded,exports.urlFormEncodePayload=urlFormEncodePayload,exports.serializeQueryParameter=serializeQueryParameter,exports.serializeParameterValueWithMime=serializeParameterValueWithMime,exports.serializeParameterValue=serializeParameterValue,exports.langFromMime=langFromMime;const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0===e)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let i;return void 0!==r&&void 0!==t?i=r===t?`= ${r} ${e}`:`[ ${r} .. ${t} ] ${e}`:void 0!==t?i=`<= ${t} ${e}`:void 0!==r&&(i=1===r?"non-empty":`>= ${r} ${e}`),i}function humanizeNumberRange(e){var r,t;const i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,a="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,o="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${a?"( ":"[ "}${i} .. ${n}${o?" )":" ]"}`:void 0!==n?`${o?"< ":"<= "}${n}`:void 0!==i?`${a?"> ":">= "}${i}`:void 0}function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint("properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const a=humanizeMultipleOfConstraint(e.multipleOf);void 0!==a&&r.push(a);const o=humanizeNumberRange(e);return void 0!==o&&r.push(o),e.uniqueItems&&r.push("unique"),r}function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}function sortByField(e,r){return[...e].sort(((e,t)=>e[r].localeCompare(t[r])))}function mergeParams(e,r=[],t=[],{pathPointer:i,operationPointer:n}){const a={};t.forEach((r=>{({resolved:r}=e.deref(r)),a[r.name+"_"+r.in]=!0}));return[...r.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(i,["parameters",String(r)])}))).filter((({paramOrRef:r})=>(({resolved:r}=e.deref(r)),!a[r.name+"_"+r.in]))),...t.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(n,["parameters",String(r)])})))]}function mergeSimilarMediaTypes(e){const r={};return Object.keys(e).forEach((t=>{const i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=Object.assign(Object.assign({},r[n]),i):r[n]=i})),r}function expandDefaultServerVariables(e,r={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,t)=>r[t]&&r[t].default||e))}function normalizeServers(e,r){const t=void 0===e?(0,helpers_1.removeQueryStringAndHash)((()=>{if(!dom_1.IS_BROWSER)return"";const e=window.location.href;return e.endsWith(".html")?(0,path_1.dirname)(e):e})()):(0,path_1.dirname)(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,(0,helpers_1.resolveUrl)(t,r)),description:e.description||""});var r}))}exports.isNamedDefinition=isNamedDefinition,exports.getDefinitionName=getDefinitionName,exports.humanizeNumberRange=humanizeNumberRange,exports.humanizeConstraints=humanizeConstraints,exports.sortByRequired=sortByRequired,exports.sortByField=sortByField,exports.mergeParams=mergeParams,exports.mergeSimilarMediaTypes=mergeSimilarMediaTypes,exports.expandDefaultServerVariables=expandDefaultServerVariables,exports.normalizeServers=normalizeServers;const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!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-hideTryItPanel":!0,"x-tokenEndpointAuthMethod":!0}}function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}exports.shortenHTTPVerb=shortenHTTPVerb,exports.isRedocExtension=isRedocExtension,exports.extractExtensions=extractExtensions,exports.pluralizeType=pluralizeType,exports.getContentWithLegacyExamples=getContentWithLegacyExamples;
|
|
1
|
+
"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getContentWithLegacyExamples=exports.pluralizeType=exports.extractExtensions=exports.isRedocExtension=exports.shortenHTTPVerb=exports.normalizeServers=exports.expandDefaultServerVariables=exports.mergeSimilarMediaTypes=exports.mergeParams=exports.sortByField=exports.sortByRequired=exports.humanizeConstraints=exports.humanizeNumberRange=exports.getDefinitionName=exports.isNamedDefinition=exports.langFromMime=exports.serializeParameterValue=exports.serializeParameterValueWithMime=exports.serializeQueryParameter=exports.urlFormEncodePayload=exports.isFormUrlEncoded=exports.isJsonLike=exports.isPrimitiveType=exports.detectType=exports.getOperationId=exports.getOperationName=exports.isOperationName=exports.getStatusCodeType=exports.isStatusCode=void 0;const path_1=require("path"),url_template_1=__importDefault(require("url-template")),dom_1=require("./dom"),helpers_1=require("./helpers"),constants_1=require("../constants"),JsonPointer_1=require("./JsonPointer");function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}function isStatusCode(e){return"default"===e||(0,helpers_1.isNumeric)(e)||isWildcardStatusCode(e)}function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}exports.isStatusCode=isStatusCode,exports.getStatusCodeType=getStatusCodeType;const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};function isOperationName(e){return e in operationNames}function getOperationName(e){const{operationId:r,pathName:t}=e,i=(0,helpers_1.normalizeText)((0,helpers_1.getValueFromMdParsedExtension)(e,"description"));return(0,helpers_1.normalizeText)((0,helpers_1.getValueFromMdParsedExtension)(e,"summary"))||r||i&&i.substring(0,50)||t||"<no summary>"}function getOperationId(e,r){return(0,helpers_1.sanitizeItemId)(void 0!==e.operationId?"operation/"+e.operationId:void 0!==r?r.id+e.pointer:e.pointer)}exports.isOperationName=isOperationName,exports.getOperationName=getOperationName,exports.getOperationId=getOperationId;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"};function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties&&void 0===e.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}function isJsonLike(e){return-1!==e.search(/json/i)}function isFormUrlEncoded(e){return e===constants_1.MediaTypes.URL_ENCODED}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${r}${t}${e[r]}`)).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?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 serializeFormValue(e,r,t){const i="__redoc_param_name__",n=r?"*":"";return url_template_1.default.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=url_template_1.default.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:a=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,a,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let a="";"label"===r?a=".":"matrix"===r&&(a=";");const o="__redoc_param_name__";return url_template_1.default.parse(`{${a}${o}${n}}`).expand({[o]:i}).replace(/__redoc_param_name__/g,e)}function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("%20")}`:(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("|")}`:(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return(0,helpers_1.isArrayOfObjects)(i)&&(i=(0,helpers_1.deleteEmptyArrayItem)(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(console.warn("Unexpected style for header: "+e),"")}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:a}=e;if(a)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,a);case"cookie":case"query":return`${t}=${serializeParameterValueWithMime(r,a)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn(`Missing style attribute or content for parameter ${t}`),"";switch(e.in){case"path":return serializePathParameter(t,i,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}exports.detectType=detectType,exports.isPrimitiveType=isPrimitiveType,exports.isJsonLike=isJsonLike,exports.isFormUrlEncoded=isFormUrlEncoded,exports.urlFormEncodePayload=urlFormEncodePayload,exports.serializeQueryParameter=serializeQueryParameter,exports.serializeParameterValueWithMime=serializeParameterValueWithMime,exports.serializeParameterValue=serializeParameterValue,exports.langFromMime=langFromMime;const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0===e)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let i;return void 0!==r&&void 0!==t?i=r===t?`= ${r} ${e}`:`[ ${r} .. ${t} ] ${e}`:void 0!==t?i=`<= ${t} ${e}`:void 0!==r&&(i=1===r?"non-empty":`>= ${r} ${e}`),i}function humanizeNumberRange(e){var r,t;const i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,a="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,o="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${a?"( ":"[ "}${i} .. ${n}${o?" )":" ]"}`:void 0!==n?`${o?"< ":"<= "}${n}`:void 0!==i?`${a?"> ":">= "}${i}`:void 0}function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint("properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const a=humanizeMultipleOfConstraint(e.multipleOf);void 0!==a&&r.push(a);const o=humanizeNumberRange(e);return void 0!==o&&r.push(o),e.uniqueItems&&r.push("unique"),r}function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}function sortByField(e,r){return[...e].sort(((e,t)=>e[r].localeCompare(t[r])))}function mergeParams(e,r=[],t=[],{pathPointer:i,operationPointer:n}){const a={};t.forEach((r=>{({resolved:r}=e.deref(r)),a[r.name+"_"+r.in]=!0}));return[...r.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(i,["parameters",String(r)])}))).filter((({paramOrRef:r})=>(({resolved:r}=e.deref(r)),!a[r.name+"_"+r.in]))),...t.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer_1.JsonPointer.join(n,["parameters",String(r)])})))]}function mergeSimilarMediaTypes(e){const r={};return Object.keys(e).forEach((t=>{const i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=Object.assign(Object.assign({},r[n]),i):r[n]=i})),r}function expandDefaultServerVariables(e,r={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,t)=>r[t]&&r[t].default||e))}function normalizeServers(e,r){const t=void 0===e?(0,helpers_1.removeQueryStringAndHash)((()=>{if(!dom_1.IS_BROWSER)return"";const e=window.location.href;return e.endsWith(".html")?(0,path_1.dirname)(e):e})()):(0,path_1.dirname)(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,(0,helpers_1.resolveUrl)(t,r)),description:e.description||""});var r}))}exports.isNamedDefinition=isNamedDefinition,exports.getDefinitionName=getDefinitionName,exports.humanizeNumberRange=humanizeNumberRange,exports.humanizeConstraints=humanizeConstraints,exports.sortByRequired=sortByRequired,exports.sortByField=sortByField,exports.mergeParams=mergeParams,exports.mergeSimilarMediaTypes=mergeSimilarMediaTypes,exports.expandDefaultServerVariables=expandDefaultServerVariables,exports.normalizeServers=normalizeServers;const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!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-hideTryItPanel":!0,"x-tokenEndpointAuthMethod":!0,"x-feedback":!0}||e.startsWith("x-parsed-md-")}function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}exports.shortenHTTPVerb=shortenHTTPVerb,exports.isRedocExtension=isRedocExtension,exports.extractExtensions=extractExtensions,exports.pluralizeType=pluralizeType,exports.getContentWithLegacyExamples=getContentWithLegacyExamples;
|
|
2
2
|
//# sourceMappingURL=openapi.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React from"react";import{useRecoilValue}from"recoil";import{SamplesMiddlePanel,Row,Section}from"../common";import{ExternalDocumentation}from"../ExternalDocumentation";import{Markdown,StyledMarkdownBlock}from"../Markdown";import{DownloadButtonWithLabel}from"../Download";import{RenderHook}from"../RenderHook";import{ApiHeader,InfoSpan,InfoSpanBox,InfoSpanBoxWrap}from"./styled";import{globalStoreSelector}from"../../recoil/store";import{saveTextBeforeHeading}from"../../utils/saveTextBeforeHeading";export function ApiInfo(){const{options:{markdownHeadingsAnchorLevel:e,hooks:t,hideDownloadButton:n},parser:{definition:o}}=useRecoilValue(globalStoreSelector),a=saveTextBeforeHeading((null==o?void 0:o.info
|
|
1
|
+
import React from"react";import{useRecoilValue}from"recoil";import{SamplesMiddlePanel,Row,Section}from"../common";import{ExternalDocumentation}from"../ExternalDocumentation";import{Markdown,StyledMarkdownBlock}from"../Markdown";import{DownloadButtonWithLabel}from"../Download";import{RenderHook}from"../RenderHook";import{ApiHeader,InfoSpan,InfoSpanBox,InfoSpanBoxWrap}from"./styled";import{globalStoreSelector}from"../../recoil/store";import{saveTextBeforeHeading}from"../../utils/saveTextBeforeHeading";import{getValueFromMdParsedExtension}from"../../utils/helpers";export function ApiInfo(){const{options:{markdownHeadingsAnchorLevel:e,hooks:t,hideDownloadButton:n},parser:{definition:o}}=useRecoilValue(globalStoreSelector),a=saveTextBeforeHeading(getValueFromMdParsedExtension(null==o?void 0:o.info,"description")||"",e),l=getValueFromMdParsedExtension(null==o?void 0:o.info,"summary")||void 0,r=null==o?void 0:o.info,c=null==o?void 0:o.externalDocs;if(!r)return null;const i=r.license&&React.createElement(InfoSpan,null,"License:"," ",r.license.identifier?r.license.identifier:React.createElement("a",{href:r.license.url},r.license.name))||null,m=r.contact&&r.contact.url&&React.createElement(InfoSpan,null,"URL: ",React.createElement("a",{href:r.contact.url},r.contact.url))||null,d=r.contact&&r.contact.email&&React.createElement(InfoSpan,null,r.contact.name||"E-mail",":"," ",React.createElement("a",{href:"mailto:"+r.contact.email},r.contact.email))||null,s=r.termsOfService&&React.createElement(InfoSpan,null,React.createElement("a",{href:r.termsOfService},"Terms of Service"))||null,u=r.version&&React.createElement("span",null,"(",r.version,")")||null;return React.createElement(Section,null,React.createElement(Row,null,React.createElement(SamplesMiddlePanel,{className:"api-info"},React.createElement(ApiHeader,null,r.title," ",u),React.createElement(RenderHook,{Hook:null==t?void 0:t.AfterApiTitle,props:{info:r}}),!n&&React.createElement(DownloadButtonWithLabel,{wrapped:!0}),React.createElement(StyledMarkdownBlock,null,(r.license||r.contact||r.termsOfService)&&React.createElement(InfoSpanBoxWrap,null,React.createElement(InfoSpanBox,null,d," ",m," ",i," ",s))||null),l&&React.createElement(Markdown,{source:l,"data-role":"redoc-summary"}),a&&React.createElement(Markdown,{source:a,"data-role":"redoc-description"}),c&&React.createElement(ExternalDocumentation,{externalDocs:c}))))}
|
|
2
2
|
//# sourceMappingURL=ApiInfo.js.map
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
1
2
|
export declare const StyledChangeViewButton: import("styled-components").StyledComponent<"a", any, {}, never>;
|
|
2
3
|
export declare const ChangeViewSvgRow: import("styled-components").StyledComponent<() => JSX.Element, any, {}, never>;
|
|
3
4
|
export declare const ChangeViewSvgColumn: import("styled-components").StyledComponent<() => JSX.Element, any, {}, never>;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{memo,useMemo,useState,useEffect,useCallback}from"react";import{Navigate,Route,Routes}from"react-router-dom";import{Pagination}from"../../services";import{IS_BROWSER}from"../../utils";import{Skeleton}from"../common";import{getNextSectionLink}from"./helpers";import{SectionContent}from"../SectionContent";import{TagItems}from"../TagItems";import{useAutoScroll}from"./useAutoScroll";import{ContentItem}from"../ContentItem";let isInitialHydrate=!0;function ContentItemsComponent({items:e,root:t=!1,pagination:n,showNextButton:o,showApiInfo:a,disablePaginationLoadingAnimation:i}){const[m,r]=useState(IS_BROWSER&&!isInitialHydrate&&!i);useEffect((()=>{const e=setTimeout((()=>{r(!1)}),200);return isInitialHydrate=!1,()=>{clearTimeout(e)}}),[]),useAutoScroll(m);const c=useMemo((()=>e.filter((e=>"group"===e.type))),[e]),l=useMemo((()=>e.filter((e=>"tag"===e.type))),[e]),s=useCallback(((e,t)=>null==e?void 0:e.map(((e,a)=>{var i;const m=getNextSectionLink({groupItems:c,groupIdx:t,tagIdx:a});switch(n){case Pagination.Item:return React.createElement(Route,{key:e.id,path:e.id},React.createElement(Route,{index:!0,element:React.createElement(TagItems,{tag:e,nextSectionLink:m,pagination:n,showNextButton:o})}),null===(i=e.items)||void 0===i?void 0:i.map((e=>{const i=getNextSectionLink({groupItems:c,groupIdx:t,tagIdx:a});return React.createElement(Route,{key:e.id,path:e.id,element:React.createElement(TagItems,{tag:e,nextSectionLink:i,pagination:n,showNextButton:o})})})));case Pagination.Section:return React.createElement(Route,{key:e.id,path:e.id,element:React.createElement(TagItems,{tag:e,nextSectionLink:m,pagination:n,showNextButton:o})});default:return null}}))),[c,n,o]),
|
|
1
|
+
import React,{memo,useMemo,useState,useEffect,useCallback}from"react";import{Navigate,Route,Routes}from"react-router-dom";import{Pagination}from"../../services";import{IS_BROWSER}from"../../utils";import{Skeleton}from"../common";import{getNextSectionLink}from"./helpers";import{SectionContent}from"../SectionContent";import{TagItems}from"../TagItems";import{useAutoScroll}from"./useAutoScroll";import{ContentItem}from"../ContentItem";let isInitialHydrate=!0;function ContentItemsComponent({items:e,root:t=!1,pagination:n,showNextButton:o,showApiInfo:a,disablePaginationLoadingAnimation:i}){const[m,r]=useState(IS_BROWSER&&!isInitialHydrate&&!i);useEffect((()=>{const e=setTimeout((()=>{r(!1)}),200);return isInitialHydrate=!1,()=>{clearTimeout(e)}}),[]),useAutoScroll(m);const c=useMemo((()=>e.filter((e=>"group"===e.type))),[e]),l=useMemo((()=>e.filter((e=>"tag"===e.type))),[e]),u=useMemo((()=>e.filter((e=>"operation"===e.type))),[e]),s=useCallback(((e,t)=>null==e?void 0:e.map(((e,a)=>{var i;const m=getNextSectionLink({groupItems:c,groupIdx:t,tagIdx:a});switch(n){case Pagination.Item:return React.createElement(Route,{key:e.id,path:e.id},React.createElement(Route,{index:!0,element:"operation"===e.type?React.createElement(ContentItem,{key:e.id,item:e,pagination:n,showNextButton:o}):React.createElement(TagItems,{tag:e,nextSectionLink:m,pagination:n,showNextButton:o})}),null===(i=e.items)||void 0===i?void 0:i.map((e=>{const i=getNextSectionLink({groupItems:c,groupIdx:t,tagIdx:a});return React.createElement(Route,{key:e.id,path:e.id,element:React.createElement(TagItems,{tag:e,nextSectionLink:i,pagination:n,showNextButton:o})})})));case Pagination.Section:return React.createElement(Route,{key:e.id,path:e.id,element:React.createElement(TagItems,{tag:e,nextSectionLink:m,pagination:n,showNextButton:o})});default:return null}}))),[c,n,o]),p=useMemo((()=>React.createElement(Routes,null,React.createElement(Route,{path:"/",element:React.createElement(SectionContent,{items:e,nextSectionLink:getNextSectionLink({groupItems:c,groupIdx:0,tagIdx:0}),pagination:n,showNextButton:o,showApiInfo:a})}),c.length?c.map(((e,t)=>s(e.items,t))):s(l,0),u.length&&s(u,0),React.createElement(Route,{path:"*",element:React.createElement(Navigate,{to:"/",replace:!0})}))),[c,e,u,n,s,a,o,l]);return t&&!e.length?React.createElement(Routes,null,React.createElement(Route,{path:"*",element:React.createElement(SectionContent,{items:[],pagination:n,showNextButton:o,showApiInfo:a})})):e.length?React.createElement(React.Fragment,null,m?React.createElement("div",{style:{flex:1,width:"100%"}},React.createElement(Skeleton,null)):t?React.createElement(React.Fragment,null,p,n===Pagination.Section&&u.length&&u.map((e=>React.createElement(ContentItem,{key:e.id,item:e,pagination:n,showNextButton:o})))):e.map((e=>React.createElement(ContentItem,{key:e.id,item:e,pagination:n,showNextButton:o})))):null}export const ContentItems=memo(ContentItemsComponent);
|
|
2
2
|
//# sourceMappingURL=ContentItems.js.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import React,{memo,useState}from"react";import{useRecoilValue}from"recoil";import{PatternLabel,RecursiveLabel,TypeFormat,TypeName,TypePrefix,TypeTitle,ToggleButton,Badge}from"../common";import{ExternalDocumentation}from"../ExternalDocumentation";import{Markdown}from"../Markdown";import{l}from"../../services";import{FieldDetail}from"./FieldDetail";import{ConstraintsView}from"./ConstraintsView";import{Extensions}from"./Extensions";import{EnumValues}from"./EnumValues";import{Examples,getSerializedValue}from"./Examples";import{TypeWrapper}from"./styled";import{globalOptionsSelector}from"../../recoil/store";const MAX_PATTERN_LENGTH=45;function FieldDetailsComponent({showExamples:e,field:t,renderDiscriminatorSwitch:a}){const[n,r]=useState(!1),{enumSkipQuotes:o,hideSchemaTitles:i,hideSchemaPattern:c}=useRecoilValue(globalOptionsSelector),{schema:m,description:s,example:p,deprecated:u,examples:
|
|
1
|
+
import React,{memo,useState}from"react";import{useRecoilValue}from"recoil";import{PatternLabel,RecursiveLabel,TypeFormat,TypeName,TypePrefix,TypeTitle,ToggleButton,Badge}from"../common";import{ExternalDocumentation}from"../ExternalDocumentation";import{Markdown}from"../Markdown";import{l}from"../../services";import{FieldDetail}from"./FieldDetail";import{ConstraintsView}from"./ConstraintsView";import{Extensions}from"./Extensions";import{EnumValues}from"./EnumValues";import{Examples,getSerializedValue}from"./Examples";import{TypeWrapper}from"./styled";import{globalOptionsSelector}from"../../recoil/store";const MAX_PATTERN_LENGTH=45;function FieldDetailsComponent({showExamples:e,field:t,renderDiscriminatorSwitch:a}){const[n,r]=useState(!1),{enumSkipQuotes:o,hideSchemaTitles:i,hideSchemaPattern:c}=useRecoilValue(globalOptionsSelector),{schema:m,description:s,example:p,deprecated:u,examples:E}=t,d=Boolean(o)||"header"===t.in;let R=null;if(e&&(void 0!==p||void 0!==E))if(void 0!==E)R=React.createElement(Examples,{field:t});else{const e=!!t.in;R=React.createElement(FieldDetail,{label:"example",value:getSerializedValue(t,t.example),raw:e})}return React.createElement("div",null,React.createElement(TypeWrapper,null,React.createElement(TypePrefix,null,m.typePrefix),React.createElement(TypeName,null,m.displayType),m.displayFormat&&React.createElement(TypeFormat,null," ","<",m.displayFormat,">"," "),m.contentEncoding&&React.createElement(TypeFormat,null," ","<",m.contentEncoding,">"," "),m.contentMediaType&&React.createElement(TypeFormat,null," ","<",m.contentMediaType,">"," "),m.title&&!i&&React.createElement(TypeTitle,null," (",m.title,") "),React.createElement(ConstraintsView,{constraints:m.constraints}),m.pattern&&!c&&React.createElement(React.Fragment,null,React.createElement(PatternLabel,null,n||m.pattern.length<MAX_PATTERN_LENGTH?m.pattern:`${m.pattern.substr(0,MAX_PATTERN_LENGTH)}...`),m.pattern.length>MAX_PATTERN_LENGTH&&React.createElement(ToggleButton,{onClick:()=>{r(!n)}},n?"Hide pattern":"Show pattern"))," ",m.isCircular&&React.createElement(RecursiveLabel,null,l("recursive"))),u&&React.createElement("div",null,React.createElement(Badge,{deprecated:!0,style:{marginLeft:0}}," ",l("deprecated")," ")),React.createElement(FieldDetail,{raw:d,label:"default",value:m.default}),React.createElement("div",null,React.createElement(Markdown,{source:s})),!a&&React.createElement(EnumValues,{type:m.type,values:m["x-enumDescriptions"]||m.enum})," ",R,React.createElement(Extensions,{extensions:Object.assign(Object.assign({},t.extensions),m.extensions)}),m.externalDocs&&React.createElement(ExternalDocumentation,{externalDocs:m.externalDocs,compact:!0}),null==a?void 0:a(),t.const&&React.createElement(FieldDetail,{label:"const",value:t.const})||null)}export const FieldDetails=memo(FieldDetailsComponent);
|
|
2
2
|
//# sourceMappingURL=FieldDetails.js.map
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import React,{memo,useCallback}from"react";import styled from"styled-components";import{useRecoilValue,useSetRecoilState}from"recoil";import{H2,useMount}from"@redocly/theme";import{Endpoint}from"../Endpoint";import{Row}from"../common/panels";import{Badge,SamplesMiddlePanel,SamplesPanel,ShareLink}from"../common";import{CallbacksList}from"../Callbacks";import{CallbackSamples}from"../CallbackSamples";import{ExternalDocumentation}from"../ExternalDocumentation";import{Extensions}from"../Fields";import{Markdown}from"../Markdown";import{Parameters}from"../Parameters";import{RequestSamples}from"../RequestSamples";import{ResponsesList}from"../Responses";import{ResponseSamples}from"../ResponseSamples";import{SecurityRequirements}from"../SecurityRequirement";import{ContentPanel}from"../Panel";import{RenderHook}from"../RenderHook";import{l}from"../../services";import{LayoutVariant}from"../../constants";import{creatPanelToggleEvent}from"../../events";import{showRightPanelToggleSelector,layoutSelector}from"../../recoil/app";import{globalStoreSelector}from"../../recoil/store";import{getOperation}from"../../models/operation";import{operationStore}from"../../recoil/operation";const OperationRow=styled(Row)`
|
|
1
|
+
import React,{memo,useCallback}from"react";import styled from"styled-components";import{useRecoilValue,useSetRecoilState}from"recoil";import{H2,useMount,Feedback}from"@redocly/theme";import{Endpoint}from"../Endpoint";import{Row}from"../common/panels";import{Badge,SamplesMiddlePanel,SamplesPanel,ShareLink}from"../common";import{CallbacksList}from"../Callbacks";import{CallbackSamples}from"../CallbackSamples";import{ExternalDocumentation}from"../ExternalDocumentation";import{Extensions}from"../Fields";import{Markdown}from"../Markdown";import{Parameters}from"../Parameters";import{RequestSamples}from"../RequestSamples";import{ResponsesList}from"../Responses";import{ResponseSamples}from"../ResponseSamples";import{SecurityRequirements}from"../SecurityRequirement";import{ContentPanel}from"../Panel";import{RenderHook}from"../RenderHook";import{l}from"../../services";import{LayoutVariant}from"../../constants";import{creatPanelToggleEvent}from"../../events";import{showRightPanelToggleSelector,layoutSelector}from"../../recoil/app";import{globalStoreSelector}from"../../recoil/store";import{getOperation}from"../../models/operation";import{operationStore}from"../../recoil/operation";const OperationRow=styled(Row)`
|
|
2
2
|
align-items: flex-start;
|
|
3
3
|
${H2} {
|
|
4
4
|
position: relative;
|
|
5
5
|
}
|
|
6
6
|
`,Description=styled.div`
|
|
7
7
|
margin-bottom: calc(var(--spacing-unit) * 4);
|
|
8
|
-
`;function OperationItemComponent({item:{operationDefinition:e,parent:t,href:o}}){var a,r,n;const s=useRecoilValue(layoutSelector),c=useRecoilValue(showRightPanelToggleSelector),{parser:
|
|
8
|
+
`;function OperationItemComponent({item:{operationDefinition:e,parent:t,href:o}}){var a,r,n;const s=useRecoilValue(layoutSelector),c=useRecoilValue(showRightPanelToggleSelector),{parser:i,options:m}=useRecoilValue(globalStoreSelector),{hooks:p,events:d,feedback:u,showWebhookVerb:R,pathInMiddlePanel:E,expandDefaultRequest:k,expandDefaultResponse:f}=m,S=getOperation(i,e,t,m,o),{name:g,description:b,deprecated:v,externalDocs:h,isWebhook:y,httpVerb:x}=S,P=useSetRecoilState(operationStore(S.pointer));useMount((()=>{P((e=>Object.assign(Object.assign({},e),{activeExampleName:S.activeExampleName,activeServer:S.activeServer})))}));const C=!(!b&&!h),O=useCallback((e=>t=>{var o;const a=creatPanelToggleEvent({operation:S,isExpanded:t,panelType:e});null===(o=null==d?void 0:d.panelToggle)||void 0===o||o.call(d,a)}),[d,S]);return React.createElement(OperationRow,{layout:s},React.createElement(SamplesMiddlePanel,{isStacked:s===LayoutVariant.STACKED||!c},React.createElement(RenderHook,{Hook:null==p?void 0:p.BeforeOperation,props:{operation:S}}),React.createElement(H2,null,React.createElement(ShareLink,{to:o}),React.createElement(RenderHook,{Hook:null==p?void 0:p.BeforeOperationSummary,props:{operation:S}}),g,React.createElement(RenderHook,{Hook:null==p?void 0:p.AfterOperationSummary,props:{operation:S}}),v&&React.createElement(Badge,{deprecated:!0},"Deprecated"),y&&React.createElement(React.Fragment,null,React.createElement(Badge,null,"Webhook"),R&&x&&React.createElement(Badge,null,x.toUpperCase()))),E&&!y&&React.createElement(Endpoint,{operation:S}),C&&React.createElement(Description,null,void 0!==b&&React.createElement(Markdown,{source:b}),h&&React.createElement(ExternalDocumentation,{externalDocs:h}),Object.keys(S.extensions||{}).length?React.createElement(Extensions,{extensions:S.extensions}):null),React.createElement(SecurityRequirements,{securities:S.security}),(null===(a=S.parameters)||void 0===a?void 0:a.length)||S.requestBody?React.createElement(ContentPanel,{header:l("request"),onToggle:O("request"),expanded:k,className:"panel-request-schemas"},React.createElement(Parameters,{parameters:S.parameters,body:S.requestBody})):null,(null===(r=S.responses)||void 0===r?void 0:r.length)?React.createElement(ContentPanel,{header:l("responses"),onToggle:O("responses"),expanded:f,className:"panel-response-schemas"},React.createElement(ResponsesList,{responses:S.responses})):null,(null===(n=S.callbacks)||void 0===n?void 0:n.length)?React.createElement(ContentPanel,{className:"panel-callback-schemas",header:l("callbacks")},React.createElement(CallbacksList,{callbacks:S.callbacks})):null,React.createElement(RenderHook,{Hook:null==p?void 0:p.AfterOperation,props:{operation:S}}),!1===(null==u?void 0:u.hide)?React.createElement(Feedback,{type:u.type,settings:u.settings,path:S.href}):null),c?React.createElement(SamplesPanel,{"data-cy":"samples-block"},!E&&!y&&React.createElement(Endpoint,{operation:S}),React.createElement(RequestSamples,{operation:S}),React.createElement(ResponseSamples,{operation:S}),React.createElement(CallbackSamples,{callbacks:S.callbacks})):null)}export const OperationItem=memo(OperationItemComponent);
|
|
9
9
|
//# sourceMappingURL=OperationItem.js.map
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { Unstable_ExternalCodeSample } from '../../services';
|
|
2
2
|
import type { OperationModel } from '../../models';
|
|
3
3
|
import type { OpenAPIXCodeSample } from '../../types';
|
|
4
|
-
export declare function useCodeSamples({
|
|
4
|
+
export declare function useCodeSamples({ payload, isWebhook, definitionSamples, pointer, }: OperationModel): {
|
|
5
5
|
payload: OperationModel['payload'];
|
|
6
6
|
samples: Array<{
|
|
7
7
|
key: string;
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export function useCodeSamples({
|
|
1
|
+
import{useRecoilValue}from"recoil";import{getCodeSample}from"../../services";import{globalStoreSelector}from"../../recoil/store";import{operationStore}from"../../recoil/operation";export function useCodeSamples({payload:e,isWebhook:a,definitionSamples:o,pointer:l}){var t;const{parser:i,options:n}=useRecoilValue(globalStoreSelector),r=useRecoilValue(operationStore(l));let s=[];if(!a){const e=n.generateCodeSamples||{},a=new Set(o.map((({lang:e})=>e.toLowerCase())));s=generateCodeSamples((null===(t=e.languages)||void 0===t?void 0:t.filter((({lang:e})=>!a.has(e.toLowerCase()))))||[],e,i.definition,n.generatedPayloadSamplesMaxDepth,r)}const p=[...o,...s],m=Math.min(p.length,n.payloadSampleIdx);e&&!n.hideRequestPayloadSample&&p.splice(m,0,e);const g=p.map((e=>{var a,o;return Object.assign({key:`${e.lang}_${null!==(a=e.label)&&void 0!==a?a:""}`,title:null!==(o=e.label)&&void 0!==o?o:e.lang},e)}));return{payload:e,samples:g}}function generateCodeSamples(e,{skipOptionalParameters:a,withOAuth2Call:o},l,t,i){return e.map((({lang:e,label:n,options:r})=>({lang:e,label:n,get:n=>getCodeSample(Object.assign(Object.assign({},n),{lang:e,options:Object.assign(Object.assign({},r),{skipOptionalParameters:a,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:t,store:i})}))})))}
|
|
2
2
|
//# sourceMappingURL=useCodeSamples.js.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import styled from"styled-components";import React,{createRef,useLayoutEffect,useState}from"react";const TOLERANCE_PX=20;export function SeeMore({children:e,height:t}){const n=createRef(),[r,o]=React.useState(!1),[a,c]=useState(!1);useLayoutEffect((()=>{n.current&&n.current.clientHeight+
|
|
1
|
+
import styled from"styled-components";import React,{createRef,useLayoutEffect,useState}from"react";const TOLERANCE_PX=20;export function SeeMore({children:e,height:t}){const n=createRef(),[r,o]=React.useState(!1),[a,c]=useState(!1);useLayoutEffect((()=>{n.current&&n.current.clientHeight+TOLERANCE_PX<n.current.scrollHeight&&c(!0)}),[n]);return React.createElement(React.Fragment,null,React.createElement(Container,{ref:n,className:r?"":"container",style:{height:r?"auto":t}},e),React.createElement(ButtonContainer,{dimmed:!r},a&&React.createElement(ButtonLinkStyled,{onClick:()=>{o(!r)}},r?"See less":"See more")))}const Container=styled.div`
|
|
2
2
|
overflow-y: hidden;
|
|
3
3
|
`,ButtonContainer=styled.div`
|
|
4
4
|
text-align: center;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
1
2
|
export declare const HideRightPanelSVG: import("styled-components").StyledComponent<() => JSX.Element, any, {}, never>;
|
|
2
3
|
export declare const StyledToggleRightPanelButton: import("styled-components").StyledComponent<"a", any, {}, never>;
|
|
3
4
|
export declare const ShowRightPanelSVG: import("styled-components").StyledComponent<() => JSX.Element, any, {}, never>;
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import React from 'react';
|
|
1
2
|
import type { FieldContext } from 'informed';
|
|
2
3
|
type FieldValue = string[];
|
|
3
4
|
export interface CheckboxListComponentProps {
|
|
@@ -8,5 +9,5 @@ export interface CheckboxListComponentProps {
|
|
|
8
9
|
trimItemsLength?: boolean;
|
|
9
10
|
}
|
|
10
11
|
export declare const CheckboxListComponent: ({ items, fieldApi, validateOnChange, maxDisplayedItems, showControls, trimItemsLength, }: FieldContext<FieldValue> & CheckboxListComponentProps) => JSX.Element;
|
|
11
|
-
export declare const CheckboxList:
|
|
12
|
+
export declare const CheckboxList: React.ComponentType<import("informed").FieldProps<FieldValue, any> & CheckboxListComponentProps>;
|
|
12
13
|
export {};
|
|
@@ -25,4 +25,4 @@ export interface FormDropdownProps extends Partial<DropdownProps> {
|
|
|
25
25
|
options: DropdownOption[];
|
|
26
26
|
initValue?: string;
|
|
27
27
|
}
|
|
28
|
-
export declare const FormDropdown:
|
|
28
|
+
export declare const FormDropdown: React.ComponentType<FieldProps<string, any> & FormDropdownProps>;
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
1
2
|
import type { IconProps } from './types';
|
|
2
3
|
export declare const LockIcon: import("styled-components").StyledComponent<({ className, style, }: Pick<IconProps, 'size' | 'float' | 'color' | 'className' | 'style'>) => JSX.Element, any, Pick<IconProps, "style" | "color" | "className" | "size" | "float">, never>;
|
|
@@ -1,2 +1,3 @@
|
|
|
1
|
+
/// <reference types="react" />
|
|
1
2
|
import type { IconProps } from './types';
|
|
2
3
|
export declare const Spinner: import("styled-components").StyledComponent<({ className }: Pick<IconProps, 'className' | 'color'>) => JSX.Element, any, Pick<IconProps, "color" | "className">, never>;
|