@redocly/reference-docs 2.31.1 → 2.32.0

package/lib-esm/utils.d.ts

@@ -1,4 +1,5 @@
 import type { ProStore } from './services/ProStore';
+import type { SecurityDetails } from './types';
 export declare const getGlobalStore: () => ProStore;
 export declare const setGlobalStore: (store: ProStore) => ProStore;
 export declare function debounce<T extends unknown>(fn: (...args: T[]) => void, threshold: number, leading?: boolean): (...args: T[]) => void;
@@ -8,18 +9,6 @@ export declare function setParameterValue(_in: string, name: string, value: Gene
 export declare function getParameterValue(_in: string, name: string): string | null;
 export declare function toLocalStorage(key: string, value: string): void;
 export declare function fromLocalStorage<T extends string>(key: string): T;
-export declare function useDimensions(node?: HTMLElement | null): [DOMRect | null];
-export declare type SecurityDetails = {
-    password?: string;
-    username?: string;
-    token?: {
-        token_type?: string;
-        access_token: string;
-    };
-    client_id?: string;
-    client_secret?: string;
-    scopes?: string;
-};
 export declare function escapeFormId(id: string): string;
 export declare function unescapeFormId(id: string): string;
 export declare function setSecurityDetails(name: string, details: SecurityDetails | string): void;
@@ -38,3 +27,4 @@ export declare function get<T>(object: GenericObject, path: string | Array<strin
 export declare function joinStringFactory(separator: string): (...args: (string | undefined)[]) => string;
 export declare const dottedString: (...args: (string | undefined)[]) => string;
 export declare function getWindowReferenceOptions<T>(option: string): T | null;
+export declare function getJsUrl(): string;

package/lib-esm/utils.js

@@ -1,2 +1,2 @@
-import*as React from"react";import{IS_BROWSER}from"./redoc-lib/src/utils/";var _store;export var getGlobalStore=function(){return _store};export var setGlobalStore=function(e){return _store=e};export function debounce(e,t,o){var r,n=0;return function(){for(var i=[],a=0;a<arguments.length;a++)i[a]=arguments[a];function s(){n>1&&e.apply(void 0,i),n=0,r=null}n++,r?clearTimeout(r):o&&e.apply(void 0,i),r=setTimeout(s,t)}}export function toSessionStorage(e,t){IS_BROWSER&&window.sessionStorage.setItem("redoc."+e,t)}export function fromSessionStorage(e){return IS_BROWSER&&window.sessionStorage.getItem("redoc."+e)||""}export function setParameterValue(e,t,o){toSessionStorage(e+"."+t,JSON.stringify(o))}export function getParameterValue(e,t){try{return JSON.parse(fromSessionStorage(e+"."+t))}catch(e){return null}}export function toLocalStorage(e,t){window.localStorage.setItem("redoc."+e,t)}export function fromLocalStorage(e){return IS_BROWSER&&window.localStorage.getItem("redoc."+e)||""}export function useDimensions(e){var t=React.useState(null),o=t[0],r=t[1];return React.useLayoutEffect((function(){if(e){var t=function(){return window.requestAnimationFrame((function(){return r(e.getBoundingClientRect())}))};return t(),window.addEventListener("resize",t),function(){window.removeEventListener("resize",t)}}}),[e]),[o]}export function escapeFormId(e){return e.replace(/[.[\]]/g,(function(e){return{".":"%2e","[":"%5b","]":"%5d"}[e]||""}))}export function unescapeFormId(e){return e.replace(/%2e|%5b|%5d/g,(function(e){return{"%2e":".","%5b":"[","%5d":"]"}[e]||""}))}export function setSecurityDetails(e,t){e=escapeFormId(e),"string"==typeof t?toSessionStorage("auth."+e,t):t&&(toSessionStorage("auth."+e+".password",t.password||""),toSessionStorage("auth."+e+".username",t.username||""),toSessionStorage("auth."+e+".token",t.token&&JSON.stringify(t.token)||""),toSessionStorage("auth."+e+".client_id",t.client_id||""),toSessionStorage("auth."+e+".client_secret",t.client_secret||""),toSessionStorage("auth."+e+".scopes",t.scopes&&JSON.stringify(t.scopes)||""))}export function setSecurityDetailsVariants(e,t){toSessionStorage("auth."+(e=escapeFormId(e))+".variants",JSON.stringify(t))}export function getSecurityDetails(e){var t=fromSessionStorage("auth."+(e=escapeFormId(e))),o=fromSessionStorage("auth."+e+".token");return{raw:t,password:fromSessionStorage("auth."+e+".password"),username:fromSessionStorage("auth."+e+".username"),token:o&&JSON.parse(o)||null,client_id:fromSessionStorage("auth."+e+".client_id"),client_secret:fromSessionStorage("auth."+e+".client_secret"),scopes:fromSessionStorage("auth."+e+".scopes")}}export function getSecurityDetailsOptions(e,t){var o=fromSessionStorage("auth."+(e=escapeFormId(e))+".variants");if(!o)return null;var r=JSON.parse(o);return r&&Array.isArray(r)?r.map((function(e){return e.details?""===t&&e.details&&"string"==typeof e.details?{label:e.label,value:e.details}:"object"==typeof e.details?{label:e.label,value:e.details[t]}:null:null})).filter(notNull):null}function notNull(e){return null!==e}export function get(e,t,o){return"string"==typeof t&&(t=t.split(".")),t.reduce((function(e,t){return e&&e[t]?e[t]:o}),e)}export function joinStringFactory(e){return function(){for(var t=[],o=0;o<arguments.length;o++)t[o]=arguments[o];return t.filter(Boolean).join(e)}}export var dottedString=joinStringFactory(".");export function getWindowReferenceOptions(e){var t;return IS_BROWSER?null===(t=null===window||void 0===window?void 0:window.REFERENCE_DOCS_OPTIONS)||void 0===t?void 0:t[e]:null}
+import{IS_BROWSER}from"./redoc-lib/src/utils/";var _store;export var getGlobalStore=function(){return _store};export var setGlobalStore=function(e){return _store=e};export function debounce(e,t,r){var o,n=0;return function(){for(var i=[],a=0;a<arguments.length;a++)i[a]=arguments[a];function s(){n>1&&e.apply(void 0,i),n=0,o=null}n++,o?clearTimeout(o):r&&e.apply(void 0,i),o=setTimeout(s,t)}}export function toSessionStorage(e,t){IS_BROWSER&&window.sessionStorage.setItem("redoc."+e,t)}export function fromSessionStorage(e){return IS_BROWSER&&window.sessionStorage.getItem("redoc."+e)||""}export function setParameterValue(e,t,r){toSessionStorage(e+"."+t,JSON.stringify(r))}export function getParameterValue(e,t){try{return JSON.parse(fromSessionStorage(e+"."+t))}catch(e){return null}}export function toLocalStorage(e,t){window.localStorage.setItem("redoc."+e,t)}export function fromLocalStorage(e){return IS_BROWSER&&window.localStorage.getItem("redoc."+e)||""}export function escapeFormId(e){return e.replace(/[.[\]]/g,(function(e){return{".":"%2e","[":"%5b","]":"%5d"}[e]||""}))}export function unescapeFormId(e){return e.replace(/%2e|%5b|%5d/g,(function(e){return{"%2e":".","%5b":"[","%5d":"]"}[e]||""}))}export function setSecurityDetails(e,t){e=escapeFormId(e),"string"==typeof t?toSessionStorage("auth."+e,t):t&&(toSessionStorage("auth."+e+".password",t.password||""),toSessionStorage("auth."+e+".username",t.username||""),toSessionStorage("auth."+e+".token",t.token&&JSON.stringify(t.token)||""),toSessionStorage("auth."+e+".client_id",t.client_id||""),toSessionStorage("auth."+e+".client_secret",t.client_secret||""),toSessionStorage("auth."+e+".scopes",t.scopes&&JSON.stringify(t.scopes)||""))}export function setSecurityDetailsVariants(e,t){toSessionStorage("auth."+(e=escapeFormId(e))+".variants",JSON.stringify(t))}export function getSecurityDetails(e){var t=fromSessionStorage("auth."+(e=escapeFormId(e))),r=fromSessionStorage("auth."+e+".token");return{raw:t,password:fromSessionStorage("auth."+e+".password"),username:fromSessionStorage("auth."+e+".username"),token:r&&JSON.parse(r)||null,client_id:fromSessionStorage("auth."+e+".client_id"),client_secret:fromSessionStorage("auth."+e+".client_secret"),scopes:fromSessionStorage("auth."+e+".scopes")}}export function getSecurityDetailsOptions(e,t){var r=fromSessionStorage("auth."+(e=escapeFormId(e))+".variants");if(!r)return null;var o=JSON.parse(r);return o&&Array.isArray(o)?o.map((function(e){return e.details?""===t&&e.details&&"string"==typeof e.details?{label:e.label,value:e.details}:"object"==typeof e.details?{label:e.label,value:e.details[t]}:null:null})).filter(notNull):null}function notNull(e){return null!==e}export function get(e,t,r){return"string"==typeof t&&(t=t.split(".")),t.reduce((function(e,t){return e&&e[t]?e[t]:r}),e)}export function joinStringFactory(e){return function(){for(var t=[],r=0;r<arguments.length;r++)t[r]=arguments[r];return t.filter(Boolean).join(e)}}export var dottedString=joinStringFactory(".");export function getWindowReferenceOptions(e){var t;return IS_BROWSER?null===(t=null===window||void 0===window?void 0:window.REFERENCE_DOCS_OPTIONS)||void 0===t?void 0:t[e]:null}export function getJsUrl(){var e;if(!IS_BROWSER)return"";var t=+new Date+Math.random();try{return document.currentScript&&(document.currentScript.async||document.currentScript.defer)||document.write('<script id="dummy'+t+'"><\/script>'),(null===(e=document.getElementById("dummy"+t))||void 0===e?void 0:e.previousSibling).src}catch(e){return""}}
 //# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@redocly/reference-docs",
-  "version": "2.31.1",
+  "version": "2.32.0",
   "description": "Redocly Reference Docs",
   "main": "lib/index.js",
   "module": "lib-esm/index.js",
@@ -105,6 +105,7 @@
     "@types/dompurify": "^2.0.2",
     "@types/enzyme-to-json": "^1.5.3",
     "@types/jest": "^25.1.4",
+    "@types/jest-when": "^3.5.2",
     "@types/json-pointer": "^1.0.30",
     "@types/mark.js": "^8.11.5",
     "@types/marked": "^4.0.1",

package/lib/components/console/ServerDropdown.d.ts

@@ -1,24 +0,0 @@
-import * as React from 'react';
-import type { OperationModel, Server } from '../../redoc-lib';
-import type { DropdownOption } from '../common/Dropdown';
-export interface ServerDropdownProps {
-    operation: OperationModel;
-    onChange: (server: Server) => void;
-}
-export interface ServerDropdownState {
-    activeIdx: number;
-    variables?: {
-        [name: string]: string;
-    };
-}
-export declare class ServerChooser extends React.Component<ServerDropdownProps, ServerDropdownState> {
-    state: {
-        activeIdx: number;
-        variables: {};
-    };
-    static getDerivedStateFromProps(props: ServerDropdownProps): ServerDropdownState;
-    handleServerChange: (option: DropdownOption) => void;
-    handleVariableChange: (name: string, rawValue: string) => void;
-    componentDidMount(): void;
-    render(): JSX.Element;
-}

package/lib/components/console/ServerDropdown.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ServerChooser=void 0;var tslib_1=require("tslib"),React=(0,tslib_1.__importStar)(require("react")),mobx_react_1=require("mobx-react"),redoc_lib_1=require("../../redoc-lib"),utils_1=require("../../utils"),form_1=require("../common/form"),Dropdown_1=require("../common/Dropdown"),utils_2=require("./utils"),ServerVariable_1=(0,tslib_1.__importDefault)(require("./ServerVariable")),ServerChooser=function(e){function r(){var r=null!==e&&e.apply(this,arguments)||this;return Object.defineProperty(r,"state",{enumerable:!0,configurable:!0,writable:!0,value:{activeIdx:0,variables:{}}}),Object.defineProperty(r,"handleServerChange",{enumerable:!0,configurable:!0,writable:!0,value:function(e){var t=r.props.operation.servers.find((function(r){return r.url===e.serverUrl})),a=(0,utils_2.getDefaultOrStoredVariables)(t);r.props.onChange({url:e.serverUrl||"",variables:a}),(0,utils_1.toSessionStorage)("serverUrl",e.serverUrl||""),r.setState({variables:a})}}),Object.defineProperty(r,"handleVariableChange",{enumerable:!0,configurable:!0,writable:!0,value:function(e,t){var a,i=r.props.operation.servers[r.state.activeIdx],l=t||""===t?t:(0,utils_2.getDefaultOrStoredVariables)(i)[e],n=(0,tslib_1.__assign)((0,tslib_1.__assign)({},r.state.variables),((a={})[e]=l,a));r.setState({variables:n}),(0,utils_2.updateVariablesStorage)(e,l),r.props.onChange((0,tslib_1.__assign)((0,tslib_1.__assign)({},i),{variables:n}))}}),r}return(0,tslib_1.__extends)(r,e),Object.defineProperty(r,"getDerivedStateFromProps",{enumerable:!1,configurable:!0,writable:!0,value:function(e){var r=e.operation,t=(0,utils_1.fromSessionStorage)("serverUrl"),a=r.servers.findIndex((function(e){return e.url===t}));return{activeIdx:a<0?0:a}}}),Object.defineProperty(r.prototype,"componentDidMount",{enumerable:!1,configurable:!0,writable:!0,value:function(){var e=(0,utils_2.getServerWithVariables)(this.props.operation.servers,this.state.activeIdx);this.props.onChange(e),this.setState({variables:e.variables})}}),Object.defineProperty(r.prototype,"render",{enumerable:!1,configurable:!0,writable:!0,value:function(){var e=this,r=this.state.activeIdx,t=this.props.operation.servers.map((function(r,t){return{idx:t,serverUrl:r.url,value:"\n          "+(0,utils_2.expandDefaultServerVariables)((0,utils_2.expandVariables)(r.url,e.state.variables),r.variables)+"\n        - "+(r.description||"Default")+"\n      "}})),a=Object.keys(this.state.variables);return React.createElement(ServerDropdownWrap,null,React.createElement(form_1.FormLabel,{htmlFor:"server"},"Target server: "),React.createElement(form_1.FormControl,null,React.createElement(Dropdown_1.Dropdown,{variant:"dark",value:t[r].value,options:t,fullWidth:!0,onChange:this.handleServerChange})),a.length?a.map((function(r){var t,a=null===(t=e.props.operation.servers[e.state.activeIdx].variables)||void 0===t?void 0:t[r];if(a)return React.createElement(ServerVariable_1.default,{key:r,name:r,value:e.state.variables[r],defaultValue:a.default,onChange:function(t){return e.handleVariableChange(r,t)},variableEnum:a.enum,description:a.description})})):null)}}),r=(0,tslib_1.__decorate)([mobx_react_1.observer],r)}(React.Component);exports.ServerChooser=ServerChooser;var templateObject_1,ServerDropdownWrap=redoc_lib_1.styled.div(templateObject_1||(templateObject_1=(0,tslib_1.__makeTemplateObject)(["\n  margin-top: 20px;\n"],["\n  margin-top: 20px;\n"])));
-//# sourceMappingURL=ServerDropdown.js.map

package/lib/redoc-lib/src/components/Responses/styled.elements.js

@@ -1,2 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Wrapper=exports.HeadersCaption=void 0;var templateObject_1,templateObject_2,tslib_1=require("tslib"),common_elements_1=require("../../common-elements"),styled_components_1=(0,tslib_1.__importDefault)(require("../../styled-components"));exports.HeadersCaption=(0,styled_components_1.default)(common_elements_1.FieldsGroupHeader.withComponent("caption"))(templateObject_1||(templateObject_1=(0,tslib_1.__makeTemplateObject)(["\n  text-align: left;\n  margin-top: 1em;\n  caption-side: top;\n"],["\n  text-align: left;\n  margin-top: 1em;\n  caption-side: top;\n"]))),exports.Wrapper=styled_components_1.default.div(templateObject_2||(templateObject_2=(0,tslib_1.__makeTemplateObject)(["\n  margin-bottom: 1em;\n"],["\n  margin-bottom: 1em;\n"])));
-//# sourceMappingURL=styled.elements.js.map

package/lib-esm/components/console/ServerDropdown.d.ts

@@ -1,24 +0,0 @@
-import * as React from 'react';
-import type { OperationModel, Server } from '../../redoc-lib';
-import type { DropdownOption } from '../common/Dropdown';
-export interface ServerDropdownProps {
-    operation: OperationModel;
-    onChange: (server: Server) => void;
-}
-export interface ServerDropdownState {
-    activeIdx: number;
-    variables?: {
-        [name: string]: string;
-    };
-}
-export declare class ServerChooser extends React.Component<ServerDropdownProps, ServerDropdownState> {
-    state: {
-        activeIdx: number;
-        variables: {};
-    };
-    static getDerivedStateFromProps(props: ServerDropdownProps): ServerDropdownState;
-    handleServerChange: (option: DropdownOption) => void;
-    handleVariableChange: (name: string, rawValue: string) => void;
-    componentDidMount(): void;
-    render(): JSX.Element;
-}

package/lib-esm/components/console/ServerDropdown.js

@@ -1,2 +0,0 @@
-import{__assign,__decorate,__extends,__makeTemplateObject}from"tslib";import*as React from"react";import{observer}from"mobx-react";import{styled}from"../../redoc-lib";import{fromSessionStorage,toSessionStorage}from"../../utils";import{FormControl,FormLabel}from"../common/form";import{Dropdown}from"../common/Dropdown";import{expandDefaultServerVariables,expandVariables,getServerWithVariables,getDefaultOrStoredVariables,updateVariablesStorage}from"./utils";import ServerVariable from"./ServerVariable";var ServerChooser=function(e){function r(){var r=null!==e&&e.apply(this,arguments)||this;return Object.defineProperty(r,"state",{enumerable:!0,configurable:!0,writable:!0,value:{activeIdx:0,variables:{}}}),Object.defineProperty(r,"handleServerChange",{enumerable:!0,configurable:!0,writable:!0,value:function(e){var a=r.props.operation.servers.find((function(r){return r.url===e.serverUrl})),t=getDefaultOrStoredVariables(a);r.props.onChange({url:e.serverUrl||"",variables:t}),toSessionStorage("serverUrl",e.serverUrl||""),r.setState({variables:t})}}),Object.defineProperty(r,"handleVariableChange",{enumerable:!0,configurable:!0,writable:!0,value:function(e,a){var t,o=r.props.operation.servers[r.state.activeIdx],n=a||""===a?a:getDefaultOrStoredVariables(o)[e],i=__assign(__assign({},r.state.variables),((t={})[e]=n,t));r.setState({variables:i}),updateVariablesStorage(e,n),r.props.onChange(__assign(__assign({},o),{variables:i}))}}),r}return __extends(r,e),Object.defineProperty(r,"getDerivedStateFromProps",{enumerable:!1,configurable:!0,writable:!0,value:function(e){var r=e.operation,a=fromSessionStorage("serverUrl"),t=r.servers.findIndex((function(e){return e.url===a}));return{activeIdx:t<0?0:t}}}),Object.defineProperty(r.prototype,"componentDidMount",{enumerable:!1,configurable:!0,writable:!0,value:function(){var e=getServerWithVariables(this.props.operation.servers,this.state.activeIdx);this.props.onChange(e),this.setState({variables:e.variables})}}),Object.defineProperty(r.prototype,"render",{enumerable:!1,configurable:!0,writable:!0,value:function(){var e=this,r=this.state.activeIdx,a=this.props.operation.servers.map((function(r,a){return{idx:a,serverUrl:r.url,value:"\n          "+expandDefaultServerVariables(expandVariables(r.url,e.state.variables),r.variables)+"\n        - "+(r.description||"Default")+"\n      "}})),t=Object.keys(this.state.variables);return React.createElement(ServerDropdownWrap,null,React.createElement(FormLabel,{htmlFor:"server"},"Target server: "),React.createElement(FormControl,null,React.createElement(Dropdown,{variant:"dark",value:a[r].value,options:a,fullWidth:!0,onChange:this.handleServerChange})),t.length?t.map((function(r){var a,t=null===(a=e.props.operation.servers[e.state.activeIdx].variables)||void 0===a?void 0:a[r];if(t)return React.createElement(ServerVariable,{key:r,name:r,value:e.state.variables[r],defaultValue:t.default,onChange:function(a){return e.handleVariableChange(r,a)},variableEnum:t.enum,description:t.description})})):null)}}),r=__decorate([observer],r)}(React.Component);export{ServerChooser};var templateObject_1,ServerDropdownWrap=styled.div(templateObject_1||(templateObject_1=__makeTemplateObject(["\n  margin-top: 20px;\n"],["\n  margin-top: 20px;\n"])));
-//# sourceMappingURL=ServerDropdown.js.map

package/lib-esm/redoc-lib/src/components/Responses/styled.elements.js

@@ -1,2 +0,0 @@
-import{__makeTemplateObject}from"tslib";import{FieldsGroupHeader}from"../../common-elements";import styled from"../../styled-components";export var HeadersCaption=styled(FieldsGroupHeader.withComponent("caption"))(templateObject_1||(templateObject_1=__makeTemplateObject(["\n  text-align: left;\n  margin-top: 1em;\n  caption-side: top;\n"],["\n  text-align: left;\n  margin-top: 1em;\n  caption-side: top;\n"])));export var Wrapper=styled.div(templateObject_2||(templateObject_2=__makeTemplateObject(["\n  margin-bottom: 1em;\n"],["\n  margin-bottom: 1em;\n"])));var templateObject_1,templateObject_2;
-//# sourceMappingURL=styled.elements.js.map