@redocly/openapi-docs 3.0.0-alpha.12 → 3.0.0-alpha.14

package/lib/services/types.d.ts

@@ -1,10 +1,9 @@
 import type React from 'react';
-import type { ProStore } from './ProStore';
-import type { LabelsConfigRaw } from './labels/types';
-import type { OpenAPIOperation, OpenAPIParameter, OpenAPISchema, OpenAPIServer, OpenAPITag, Referenced, Server } from '../types';
-import type { MediaQueries } from '../utils';
-import type { OperationModel, Sample, ApiInfoModel } from '../models';
+import type { Node } from '@markdoc/markdoc';
+import type { OpenAPIDefinition, OpenAPIInfo, OpenAPIOperation, OpenAPIParameter, OpenAPISchema, OpenAPIServer, OpenAPITag, Referenced, Server } from '../types';
+import type { OperationModel, Sample } from '../models';
 import type { OAuth2 } from './OAuth2';
+import type { GlobalStoreSelector } from '../recoil/store';
 export declare enum SideNavStyle {
     SummaryOnly = "summary-only",
     PathFirst = "path-first",
@@ -14,7 +13,12 @@ export type Normalized<T> = {
     [P in keyof T]-?: T[P];
 };
 export type MarkdownItemsPagination = 'none' | 'section';
-export type Pagination = 'none' | 'section' | 'item';
+export declare enum Pagination {
+    None = "none",
+    Section = "section",
+    Item = "item"
+}
+export type PaginationType = 'none' | 'section' | 'item';
 export type ExternalLink = ExternalLinkLink | ExternalLinkSeparator;
 export type ExternalLinkLink = {
     label: string;
@@ -31,13 +35,10 @@ export type MenuItemType = MenuItemGroupType | 'operation';
 /** Generic interface for MenuItems */
 export interface IMenuItem {
     id: string;
-    absoluteIdx?: number;
+    href: string;
     name: string;
-    description?: string;
-    href?: string;
+    description?: string | GenericObject;
     depth: number;
-    active: boolean;
-    expanded: boolean;
     items: IMenuItem[];
     parent?: IMenuItem;
     deprecated?: boolean;
@@ -45,10 +46,6 @@ export interface IMenuItem {
     isSchema?: boolean;
     httpVerb?: string;
     path?: string;
-    deactivate(): void;
-    activate(): void;
-    collapse(): void;
-    expand(): void;
 }
 export type TagInfo = OpenAPITag & {
     operations: ExtendedOpenAPIOperation[];
@@ -64,7 +61,6 @@ export type ExtendedOpenAPIOperation = {
     pathServers: Array<OpenAPIServer> | undefined;
     isWebhook: boolean;
     defaultSampleName?: string | false;
-    defaultMimeType?: string;
 } & OpenAPIOperation;
 export type TagsInfoMap = Record<string, TagInfo>;
 export interface TagGroup {
@@ -75,10 +71,11 @@ export type MergedOpenAPISchema = OpenAPISchema & {
     'x-refsStack'?: string[];
     'x-parentRefs'?: string[];
     'x-circular-ref'?: boolean;
+    absolutePointer?: string;
 };
 export interface MDXComponentMeta {
     component: React.ComponentType;
-    propsSelector: (store?: ProStore) => GenericObject;
+    propsSelector: (oldStore?: GlobalStoreSelector, store?: GlobalStoreSelector) => GenericObject;
     props?: GenericObject;
 }
 export interface MarkdownHeading {
@@ -86,7 +83,8 @@ export interface MarkdownHeading {
     name: string;
     level: number;
     items?: MarkdownHeading[];
-    description?: string;
+    description?: string | GenericObject;
+    ast?: Node[];
 }
 export type Unstable_ExternalCodeSample = Sample & {
     get: (source: ExternalSource) => string;
@@ -112,7 +110,7 @@ type HookResult = JSX.Element | HookRawHtml | null;
 export type HookConfig<T> = (props: T) => HookResult;
 export interface HooksConfig {
     AfterApiTitle?: HookConfig<{
-        info: ApiInfoModel;
+        info: OpenAPIInfo;
     }>;
     BeforeOperation?: HookConfig<{
         operation: OperationModel;
@@ -128,7 +126,7 @@ export interface HooksConfig {
     }>;
     ReplaceTryItSecurityPanel?: HookConfig<SecurityPanelHookProps>;
     onInit?: (args: {
-        store: ProStore;
+        store: GenericObject;
     }) => void;
     replaceSecurityLink?: (args: {
         securityRequirementId: string;
@@ -137,76 +135,29 @@ export interface HooksConfig {
     /** @deprecated Use ReplaceTryItSecurityPanel instead */
     ReplaceTryItAuthPanel?: HookConfig<SecurityPanelHookProps>;
 }
-export interface RedocRawOptions {
-    breakpoints?: Omit<MediaQueries, 'print'>;
-    showAtBreakpoint?: {
-        sidebar?: keyof Omit<MediaQueries, 'print'>;
-        samplesPanel?: keyof Omit<MediaQueries, 'print'>;
-    };
-    scrollYOffset?: number | string | (() => number);
-    hideHostname?: boolean | string;
-    hideInfoDescription?: boolean | string;
-    expandResponses?: string | 'all';
-    requiredPropsFirst?: boolean | string;
-    sortPropsAlphabetically?: boolean | string;
-    sortEnumValuesAlphabetically?: boolean | string;
-    sortOperationsAlphabetically?: boolean | string;
-    sortTagsAlphabetically?: boolean | string;
-    nativeScrollbars?: boolean | string;
-    pathInMiddlePanel?: boolean | string;
-    untrustedDefinition?: boolean | string;
-    hideLoading?: boolean | string;
-    hideDownloadButton?: boolean | string;
-    downloadDefinitionUrl?: string;
-    disableSearch?: boolean | string;
-    showChangeLayoutButton?: boolean | string;
-    onlyRequiredInSamples?: boolean | string;
-    generatedPayloadSamplesMaxDepth?: number | string;
-    sendXUserAgentInTryIt?: boolean | string;
-    showExtensions?: boolean | string | string[];
-    preserveOriginalExtensionsName?: boolean;
-    hideSingleRequestSampleTab?: boolean | string;
-    hideRequestPayloadSample?: boolean;
-    menuToggle?: boolean | string;
-    jsonSampleExpandLevel?: number | string | 'all';
-    hideSchemaTitles?: boolean | string;
-    hideSecuritySection?: boolean;
-    showSecuritySchemeType?: boolean;
-    simpleOneOfTypeLabel?: boolean | string;
-    payloadSampleIdx?: number;
-    expandSingleSchemaField?: boolean | string;
-    schemaExpansionLevel?: number | string | 'all';
-    samplesTabsMaxCount?: number;
-    unstable_tryItButtonOverride?: {
-        label: string;
-        link: string;
-    };
-    mockServer?: {
-        url?: string;
-        position?: 'first' | 'last' | 'replace' | 'off';
-        description?: string;
-    };
-    allowedMdComponents?: Record<string, MDXComponentMeta>;
-    labels?: LabelsConfigRaw;
-    enumSkipQuotes?: boolean | string;
-    expandDefaultServerVariables?: boolean;
-    expandDefaultRequest?: boolean;
-    expandDefaultResponse?: boolean;
-    maxDisplayedEnumValues?: number;
-    ignoreNamedSchemas?: string[] | string;
-    unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
-    unstable_ignoreMimeParameters?: boolean;
-    hooks?: HooksConfig;
-    hideSchemaPattern?: boolean;
-    hideOneOfDescription?: boolean;
-    hideFab?: boolean;
-    markdownHeadingsAnchorLevel?: number;
-    schemaDefinitionsTagName?: string;
-    minCharacterLengthToInitSearch?: number;
-    maxResponseHeadersToShowInTryIt?: number;
-    showWebhookVerb?: boolean;
-    showObjectSchemaExamples?: boolean;
-    showAccessMode?: boolean;
-    disableTryItRequestUrlEncoding?: boolean;
+export type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
+    type: MenuItemType | 'spec';
+    linkable?: boolean;
+    href?: string;
+    httpVerb?: string;
+    path?: string;
+};
+export interface SpecInfo {
+    id?: string;
+    title?: string;
+    spec?: OpenAPIDefinition;
+    url?: string;
+    items?: SpecInfo[];
+}
+export interface SpecVersions {
+    versions?: Array<VersionInfo>;
+}
+interface VersionInfo {
+    id: string;
+    title: string;
+    url?: string;
+    spec?: OpenAPIDefinition;
+    isDefault?: boolean;
+    _searchIndexName?: string;
 }
 export {};

package/lib/services/types.js

@@ -1,2 +1,2 @@
-"use strict";var SideNavStyle;Object.defineProperty(exports,"__esModule",{value:!0}),exports.SideNavStyle=void 0,function(e){e.SummaryOnly="summary-only",e.PathFirst="path-first",e.IdOnly="id-only"}(SideNavStyle=exports.SideNavStyle||(exports.SideNavStyle={}));
+"use strict";var SideNavStyle,Pagination;Object.defineProperty(exports,"__esModule",{value:!0}),exports.Pagination=exports.SideNavStyle=void 0,function(e){e.SummaryOnly="summary-only",e.PathFirst="path-first",e.IdOnly="id-only"}(SideNavStyle=exports.SideNavStyle||(exports.SideNavStyle={})),function(e){e.None="none",e.Section="section",e.Item="item"}(Pagination=exports.Pagination||(exports.Pagination={}));
 //# sourceMappingURL=types.js.map

package/lib/services/utils.d.ts

@@ -23,3 +23,4 @@ export declare function randString(len?: number): string;
 export declare function encodeState<T extends GenericObject = GenericObject>(params: T): string;
 export declare function sha256(str: string): Promise<ArrayBuffer | undefined>;
 export declare function base64UrlEncode(arrayBuff?: ArrayBuffer): string | undefined;
+export declare function deepClone(inObject: any): any;

package/lib/services/utils.js

@@ -1,2 +1,2 @@
-"use strict";var __awaiter=this&&this.__awaiter||function(e,r,t,n){return new(t||(t=Promise))((function(i,o){function a(e){try{c(n.next(e))}catch(e){o(e)}}function s(e){try{c(n.throw(e))}catch(e){o(e)}}function c(e){var r;e.done?i(e.value):(r=e.value,r instanceof t?r:new t((function(e){e(r)}))).then(a,s)}c((n=n.apply(e,r||[])).next())}))},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.base64UrlEncode=exports.sha256=exports.encodeState=exports.randString=exports.cryptoLib=exports.isEmptyObject=exports.arrayMergeStrategy=exports.unescapeServerVariables=exports.normalizeMimeType=exports.isSameMime=exports.normalizePath=void 0;const deepmerge_1=__importDefault(require("deepmerge")),utils_1=require("../utils");function normalizePath(e){return e.startsWith("/")||(e="/"+e),e.endsWith("/")&&(e=e.slice(0,-1)),e}function isSameMime(e,r){return!(!e||!r)&&normalizeMimeType(e)===normalizeMimeType(r)}function normalizeMimeType(e){if(!e)return;const r=e.split(";")[0].toLowerCase(),[t,n]=r.split("/");if(void 0===n)return t;return`${t}/${n.split("+").pop()}`}function unescapeServerVariables(e){const r=new RegExp("%7B","g"),t=new RegExp("%7D","g");return e.replace(r,"{").replace(t,"}").replace("///","//")}function arrayMergeStrategy(e,r){if(!e.length||!hasObjectOrArray(e))return r;const t=e.filter((e=>Object.keys(e).length>0));return r.forEach((function(r,n){(0,utils_1.isMergeableObject)(r)?t[n]=(0,deepmerge_1.default)(e[n],r,{arrayMerge:arrayMergeStrategy}):Array.isArray(r)?t.push(r):t[n]=r})),t}exports.normalizePath=normalizePath,exports.isSameMime=isSameMime,exports.normalizeMimeType=normalizeMimeType,exports.unescapeServerVariables=unescapeServerVariables,exports.arrayMergeStrategy=arrayMergeStrategy;const hasObjectOrArray=e=>e.some((e=>(0,utils_1.isObject)(e)&&Object.keys(e).length>0));function isEmptyObject(e){return!!e&&0===Object.keys(e).length}function randString(e=32){let r="";for(;r.length<e;)r+=Math.random().toString(32).substring(2);return r.substring(0,e)}function encodeState(e){const r=Object.assign({randomStr:randString()},e);return btoa(JSON.stringify(r))}function sha256(e){return __awaiter(this,void 0,void 0,(function*(){const r=(new TextEncoder).encode(e);return null===exports.cryptoLib||void 0===exports.cryptoLib?void 0:exports.cryptoLib.subtle.digest("SHA-256",r)}))}function base64UrlEncode(e){if(e)return btoa(String.fromCharCode.apply(null,new Uint8Array(e))).replace(/\+/g,"-").replace(/\//g,"_").replace(/=+$/,"")}exports.isEmptyObject=isEmptyObject,exports.cryptoLib="undefined"!=typeof window&&(window.crypto||window.msCrypto)||void 0,exports.randString=randString,exports.encodeState=encodeState,exports.sha256=sha256,exports.base64UrlEncode=base64UrlEncode;
+"use strict";var __awaiter=this&&this.__awaiter||function(e,r,t,n){return new(t||(t=Promise))((function(o,i){function a(e){try{p(n.next(e))}catch(e){i(e)}}function s(e){try{p(n.throw(e))}catch(e){i(e)}}function p(e){var r;e.done?o(e.value):(r=e.value,r instanceof t?r:new t((function(e){e(r)}))).then(a,s)}p((n=n.apply(e,r||[])).next())}))},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.deepClone=exports.base64UrlEncode=exports.sha256=exports.encodeState=exports.randString=exports.cryptoLib=exports.isEmptyObject=exports.arrayMergeStrategy=exports.unescapeServerVariables=exports.normalizeMimeType=exports.isSameMime=exports.normalizePath=void 0;const deepmerge_1=__importDefault(require("deepmerge")),utils_1=require("../utils");function normalizePath(e){return e.startsWith("/")||(e="/"+e),e.endsWith("/")&&(e=e.slice(0,-1)),e}function isSameMime(e,r){return!(!e||!r)&&normalizeMimeType(e)===normalizeMimeType(r)}function normalizeMimeType(e){if(!e)return;const r=e.split(";")[0].toLowerCase(),[t,n]=r.split("/");if(void 0===n)return t;return`${t}/${n.split("+").pop()}`}function unescapeServerVariables(e){const r=new RegExp("%7B","g"),t=new RegExp("%7D","g");return e.replace(r,"{").replace(t,"}").replace("///","//")}function arrayMergeStrategy(e,r){if(!e.length||!hasObjectOrArray(e))return r;const t=e.filter((e=>Object.keys(e).length>0));return r.forEach((function(r,n){(0,utils_1.isMergeableObject)(r)?t[n]=(0,deepmerge_1.default)(e[n],r,{arrayMerge:arrayMergeStrategy}):Array.isArray(r)?t.push(r):t[n]=r})),t}exports.normalizePath=normalizePath,exports.isSameMime=isSameMime,exports.normalizeMimeType=normalizeMimeType,exports.unescapeServerVariables=unescapeServerVariables,exports.arrayMergeStrategy=arrayMergeStrategy;const hasObjectOrArray=e=>e.some((e=>(0,utils_1.isObject)(e)&&Object.keys(e).length>0));function isEmptyObject(e){return!!e&&0===Object.keys(e).length}function randString(e=32){let r="";for(;r.length<e;)r+=Math.random().toString(32).substring(2);return r.substring(0,e)}function encodeState(e){const r=Object.assign({randomStr:randString()},e);return btoa(JSON.stringify(r))}function sha256(e){return __awaiter(this,void 0,void 0,(function*(){const r=(new TextEncoder).encode(e);return null===exports.cryptoLib||void 0===exports.cryptoLib?void 0:exports.cryptoLib.subtle.digest("SHA-256",r)}))}function base64UrlEncode(e){if(e)return btoa(String.fromCharCode.apply(null,new Uint8Array(e))).replace(/\+/g,"-").replace(/\//g,"_").replace(/=+$/,"")}function deepClone(e){if("object"!=typeof e||null===e)return e;const r=Array.isArray(e)?[]:{};for(const t in e){const n=e[t];r[t]=deepClone(n)}return r}exports.isEmptyObject=isEmptyObject,exports.cryptoLib="undefined"!=typeof window&&(window.crypto||window.msCrypto)||void 0,exports.randString=randString,exports.encodeState=encodeState,exports.sha256=sha256,exports.base64UrlEncode=base64UrlEncode,exports.deepClone=deepClone;
 //# sourceMappingURL=utils.js.map

package/lib/standalone.d.ts

@@ -14,14 +14,14 @@ import 'core-js/es/symbol';
 import 'unfetch/polyfill/index';
 import 'url-polyfill';
 import type { OpenAPIDefinition } from './types';
-import type { ProStoreState } from './services';
-import type { SpecVersions } from './services/VersionedSpecStore';
 import type { RawOptions } from './services/Options/types';
-import { LayoutVariant } from './constants';
+import type { StoreProviderProps } from './components';
+import type { LayoutVariant } from './constants';
+import type { SpecVersions } from './services/types';
 export { setSecurityDetails, setParameterValue, setSecurityDetailsVariants } from './utils';
 export declare function toggleLayout(layout?: LayoutVariant): void;
-export declare function toggleRightPanel(value?: boolean): void;
-export declare function hydrate(state: ProStoreState, element?: Element | null): void;
+export declare function toggleRightPanel(showRightPanelToggle?: boolean): void;
+export declare function hydrate(store: StoreProviderProps, element?: Element | null): void;
 export declare function init(definitionOrDefinitionUrl: string | OpenAPIDefinition | SpecVersions, options?: RawOptions, element?: Element | null, callback?: () => void): void;
 export declare function setPublicPath(path: string): void;
 export declare const version: string;

package/lib/standalone.js

@@ -1,2 +1,2 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.revision=exports.version=exports.setPublicPath=exports.init=exports.hydrate=exports.toggleRightPanel=exports.toggleLayout=exports.setSecurityDetailsVariants=exports.setParameterValue=exports.setSecurityDetails=void 0,require("core-js/es/array/find-index"),require("core-js/es/array/find"),require("core-js/es/array/includes"),require("core-js/es/map"),require("core-js/es/number/is-integer"),require("core-js/es/object/assign"),require("core-js/es/object/entries"),require("core-js/es/object/is"),require("core-js/es/object/values"),require("core-js/es/promise"),require("core-js/es/string/ends-with"),require("core-js/es/string/starts-with"),require("core-js/es/symbol"),require("unfetch/polyfill/index"),require("url-polyfill");const path_1=require("path"),react_1=__importDefault(require("react")),react_dom_1=require("react-dom"),utils_1=require("./utils"),services_1=require("./services"),constants_1=require("./constants"),components_1=require("./components");var utils_2=require("./utils");function toggleLayout(e){const t=(0,utils_1.getGlobalStore)();t&&t.toggleLayout((null!=e?e:t.layout===constants_1.LayoutVariant.STACKED)?constants_1.LayoutVariant.THREE_PANEL:constants_1.LayoutVariant.STACKED)}function toggleRightPanel(e){const t=(0,utils_1.getGlobalStore)();t&&t.toggleRightPanel(e)}Object.defineProperty(exports,"setSecurityDetails",{enumerable:!0,get:function(){return utils_2.setSecurityDetails}}),Object.defineProperty(exports,"setParameterValue",{enumerable:!0,get:function(){return utils_2.setParameterValue}}),Object.defineProperty(exports,"setSecurityDetailsVariants",{enumerable:!0,get:function(){return utils_2.setSecurityDetailsVariants}}),exports.toggleLayout=toggleLayout,exports.toggleRightPanel=toggleRightPanel;const url=(0,utils_1.getJsUrl)(),__dirname=url?(0,path_1.dirname)(url)+"/":"";function attributesMap(e){const t={},r=e.attributes;for(let e=0;e<r.length;e++){const o=r[e];t[o.name]=o.value}return t}function parseOptionsFromElement(e){const t=attributesMap(e),r={};for(const e in t){r[e.replace(/-(.)/g,((e,t)=>t.toUpperCase()))]=t[e]}return r}function hydrate(e,t=document.querySelector("redoc")){const r=services_1.ProStore.fromJS(e);(0,react_dom_1.hydrate)(react_1.default.createElement(components_1.RedoclyReferenceDocs,{store:r}),t)}function init(e,t={},r=(0,utils_1.querySelector)("redoc"),o){if(null===r)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');let s,i;"object"==typeof e&&"versions"in e?(0,react_dom_1.render)(react_1.default.createElement(components_1.RedoclyReferenceDocsMultiStandalone,{definitions:e,options:Object.assign(Object.assign({},t),parseOptionsFromElement(r))},["Loading..."]),r,o):("string"==typeof e?s=e:"object"==typeof e&&(i=e),(0,react_dom_1.render)(react_1.default.createElement(components_1.RedoclyReferenceDocsStandalone,{definition:i,definitionUrl:s,options:Object.assign(Object.assign({},t),parseOptionsFromElement(r))},["Loading..."]),r,o))}function setPublicPath(e){__webpack_public_path__=e}function autoInit(){const e=(0,utils_1.querySelector)("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&init(t,{},e)}exports.hydrate=hydrate,exports.init=init,exports.setPublicPath=setPublicPath,exports.version=__REDOCLY_API_REFERENCE_VERSION__,exports.revision=__REDOCLY_API_REFERENCE_REVISION__,utils_1.IS_BROWSER&&setPublicPath(__dirname),autoInit();
+"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.revision=exports.version=exports.setPublicPath=exports.init=exports.hydrate=exports.toggleRightPanel=exports.toggleLayout=exports.setSecurityDetailsVariants=exports.setParameterValue=exports.setSecurityDetails=void 0,require("core-js/es/array/find-index"),require("core-js/es/array/find"),require("core-js/es/array/includes"),require("core-js/es/map"),require("core-js/es/number/is-integer"),require("core-js/es/object/assign"),require("core-js/es/object/entries"),require("core-js/es/object/is"),require("core-js/es/object/values"),require("core-js/es/promise"),require("core-js/es/string/ends-with"),require("core-js/es/string/starts-with"),require("core-js/es/symbol"),require("unfetch/polyfill/index"),require("url-polyfill");const path_1=require("path"),react_1=__importDefault(require("react")),react_dom_1=require("react-dom"),recoil_nexus_1=require("recoil-nexus"),utils_1=require("./utils"),components_1=require("./components"),app_1=require("./recoil/app");var utils_2=require("./utils");function toggleLayout(e){const t=(0,recoil_nexus_1.getRecoil)(app_1.appLocalStore);(0,recoil_nexus_1.setRecoil)(app_1.appLocalStore,Object.assign(Object.assign({},t),{layout:e}))}function toggleRightPanel(e){const t=(0,recoil_nexus_1.getRecoil)(app_1.appSessionStore);(0,recoil_nexus_1.setRecoil)(app_1.appSessionStore,Object.assign(Object.assign({},t),{showRightPanelToggle:e}))}Object.defineProperty(exports,"setSecurityDetails",{enumerable:!0,get:function(){return utils_2.setSecurityDetails}}),Object.defineProperty(exports,"setParameterValue",{enumerable:!0,get:function(){return utils_2.setParameterValue}}),Object.defineProperty(exports,"setSecurityDetailsVariants",{enumerable:!0,get:function(){return utils_2.setSecurityDetailsVariants}}),exports.toggleLayout=toggleLayout,exports.toggleRightPanel=toggleRightPanel;const url=(0,utils_1.getJsUrl)(),__dirname=url?(0,path_1.dirname)(url)+"/":"";function attributesMap(e){const t={},r=e.attributes;for(let e=0;e<r.length;e++){const o=r[e];t[o.name]=o.value}return t}function parseOptionsFromElement(e){const t=attributesMap(e),r={};for(const e in t){r[e.replace(/-(.)/g,((e,t)=>t.toUpperCase()))]=t[e]}return r}function hydrate(e,t=document.querySelector("redoc")){(0,react_dom_1.hydrate)(react_1.default.createElement(components_1.RedoclyOpenAPIDocs,{store:e}),t)}function init(e,t={},r=(0,utils_1.querySelector)("redoc"),o){if(null===r)throw new Error('"element" argument is not provided and <redoc> tag is not found on the page');let s,i;"object"==typeof e&&"versions"in e?(0,react_dom_1.render)(react_1.default.createElement(components_1.RedoclyOpenAPIDocsMultiStandalone,{definitions:e,options:Object.assign(Object.assign({},t),parseOptionsFromElement(r))},["Loading..."]),r,o):("string"==typeof e?s=e:"object"==typeof e&&(i=e),(0,react_dom_1.render)(react_1.default.createElement(components_1.RedoclyOpenAPIDocsStandalone,{definition:i,definitionUrl:s,options:Object.assign(Object.assign({},t),parseOptionsFromElement(r))},["Loading..."]),r,o))}function setPublicPath(e){__webpack_public_path__=e}function autoInit(){const e=(0,utils_1.querySelector)("redoc");if(!e)return;const t=e.getAttribute("spec-url");t&&init(t,{},e)}exports.hydrate=hydrate,exports.init=init,exports.setPublicPath=setPublicPath,exports.version=__REDOCLY_API_REFERENCE_VERSION__,exports.revision=__REDOCLY_API_REFERENCE_REVISION__,utils_1.IS_BROWSER&&setPublicPath(__dirname),autoInit();
 //# sourceMappingURL=standalone.js.map

package/lib/testProviders.d.ts

@@ -1,4 +1,4 @@
 import type { ReactNode } from 'react';
-import type { ProStore } from './services';
-export declare function withTestProviders(children: ReactNode, store: ProStore): JSX.Element;
+import type { StoreProviderProps } from './components';
+export declare function withTestProviders(children: ReactNode, store?: StoreProviderProps): JSX.Element;
 export declare function withTheme(children: ReactNode): JSX.Element;

package/lib/testProviders.js

@@ -1,2 +1,2 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,n){void 0===n&&(n=r);var i=Object.getOwnPropertyDescriptor(t,r);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,n,i)}:function(e,t,r,n){void 0===n&&(n=r),e[n]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.withTheme=exports.withTestProviders=void 0;const react_1=__importStar(require("react")),styled_components_1=require("styled-components"),components_1=require("./components"),constants_1=require("./constants"),utils_1=require("./utils");function withTestProviders(e,t){return react_1.default.createElement(components_1.ProProviders,{store:t},react_1.Children.only(e))}function withTheme(e){const t={mediaQueries:(0,utils_1.generateMediaQueries)(constants_1.defaultTheme.breakpoints),showAtBreakpoint:constants_1.defaultTheme.showAtBreakpoint};return react_1.default.createElement(styled_components_1.ThemeProvider,{theme:t},e)}exports.withTestProviders=withTestProviders,exports.withTheme=withTheme;
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,r,i){void 0===i&&(i=r);var n=Object.getOwnPropertyDescriptor(t,r);n&&!("get"in n?!t.__esModule:n.writable||n.configurable)||(n={enumerable:!0,get:function(){return t[r]}}),Object.defineProperty(e,i,n)}:function(e,t,r,i){void 0===i&&(i=r),e[i]=t[r]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var r in e)"default"!==r&&Object.prototype.hasOwnProperty.call(e,r)&&__createBinding(t,e,r);return __setModuleDefault(t,e),t};Object.defineProperty(exports,"__esModule",{value:!0}),exports.withTheme=exports.withTestProviders=void 0;const react_1=__importStar(require("react")),styled_components_1=require("styled-components"),constants_1=require("./constants"),utils_1=require("./utils"),components_1=require("./components");function withTestProviders(e,t){return react_1.default.createElement(components_1.StoreProvider,Object.assign({},t||{definition:{openapi:"3.0.0"}}),react_1.Children.only(e))}function withTheme(e){const t={mediaQueries:(0,utils_1.generateMediaQueries)(constants_1.defaultTheme.breakpoints),showAtBreakpoint:constants_1.defaultTheme.showAtBreakpoint};return react_1.default.createElement(styled_components_1.ThemeProvider,{theme:t},e)}exports.withTestProviders=withTestProviders,exports.withTheme=withTheme;
 //# sourceMappingURL=testProviders.js.map

package/lib/types/app.d.ts

@@ -0,0 +1 @@
+export type RouterType = 'history' | 'memory' | 'hash';

package/lib/types/app.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});
+//# sourceMappingURL=app.js.map

package/lib/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from './open-api';
 export * from './server';
 export * from './security';
+export * from './app';

package/lib/types/index.js

@@ -1,2 +1,2 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,i){void 0===i&&(i=t);var o=Object.getOwnPropertyDescriptor(r,t);o&&!("get"in o?!r.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,i,o)}:function(e,r,t,i){void 0===i&&(i=t),e[i]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./open-api"),exports),__exportStar(require("./server"),exports),__exportStar(require("./security"),exports);
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,i){void 0===i&&(i=t);var o=Object.getOwnPropertyDescriptor(r,t);o&&!("get"in o?!r.__esModule:o.writable||o.configurable)||(o={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,i,o)}:function(e,r,t,i){void 0===i&&(i=t),e[i]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./open-api"),exports),__exportStar(require("./server"),exports),__exportStar(require("./security"),exports),__exportStar(require("./app"),exports);
 //# sourceMappingURL=index.js.map

package/lib/types/open-api.d.ts

@@ -18,7 +18,7 @@ export interface OpenAPIDefinition {
 export interface OpenAPIInfo {
     title: string;
     version: string;
-    description?: string;
+    description?: string | GenericObject;
     summary?: string;
     termsOfService?: string;
     contact?: OpenAPIContact;
@@ -33,7 +33,7 @@ export interface XLogo {
 }
 export interface OpenAPIServer {
     url: string;
-    description?: string;
+    description?: string | GenericObject;
     variables?: {
         [name: string]: OpenAPIServerVariable;
     };
@@ -41,7 +41,7 @@ export interface OpenAPIServer {
 export interface OpenAPIServerVariable {
     enum?: string[];
     default: string;
-    description?: string;
+    description?: string | GenericObject;
 }
 export interface OpenAPIPaths {
     [path: string]: OpenAPIPath;
@@ -50,12 +50,12 @@ export interface OpenAPIRef {
     $ref: string;
     'x-refsStack'?: string[];
     summary?: string;
-    description?: string;
+    description?: string | GenericObject;
 }
 export type Referenced<T> = T | OpenAPIRef;
 export interface OpenAPIPath extends Partial<OpenAPIRef> {
     summary?: string;
-    description?: string;
+    description?: string | GenericObject;
     get?: OpenAPIOperation;
     put?: OpenAPIOperation;
     post?: OpenAPIOperation;
@@ -72,8 +72,8 @@ export interface OpenAPIXCodeSample extends Sample {
 }
 export interface OpenAPIOperation {
     tags?: string[];
-    summary?: string;
-    description?: string;
+    summary?: string | GenericObject;
+    description?: string | GenericObject;
     externalDocs?: OpenAPIExternalDocumentation;
     operationId?: string;
     parameters?: Array<Referenced<OpenAPIParameter>>;
@@ -91,7 +91,7 @@ export interface OpenAPIOperation {
 export interface OpenAPIParameter {
     name: string;
     in?: OpenAPIParameterLocation;
-    description?: string;
+    description?: string | GenericObject;
     required?: boolean;
     deprecated?: boolean;
     allowEmptyValue?: boolean;
@@ -112,7 +112,7 @@ export interface OpenAPIParameter {
 export interface OpenAPIExample {
     value: any;
     summary?: string;
-    description?: string;
+    description?: string | GenericObject;
     externalValue?: string;
 }
 export interface OpenAPISchema {
@@ -126,7 +126,7 @@ export interface OpenAPISchema {
     };
     additionalProperties?: boolean | OpenAPISchema;
     unevaluatedProperties?: boolean | OpenAPISchema;
-    description?: string;
+    description?: string | GenericObject;
     default?: any;
     items?: OpenAPISchema | OpenAPISchema[] | boolean;
     required?: string[];
@@ -196,7 +196,7 @@ export interface OpenAPIEncoding {
 export type OpenAPIParameterLocation = 'query' | 'header' | 'path' | 'cookie';
 export type OpenAPIParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
 export interface OpenAPIRequestBody {
-    description?: string;
+    description?: string | GenericObject;
     required?: boolean;
     content: {
         [mime: string]: OpenAPIMediaType;
@@ -214,7 +214,7 @@ export interface OpenAPIResponses {
     [code: string]: OpenAPIResponse;
 }
 export interface OpenAPIResponse {
-    description?: string;
+    description?: string | GenericObject;
     headers?: {
         [name: string]: Referenced<OpenAPIHeader>;
     };
@@ -274,7 +274,7 @@ export interface OpenAPISecurityRequirement {
 }
 export interface OpenAPISecurityScheme {
     type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
-    description?: string;
+    description?: string | GenericObject;
     name?: string;
     in?: 'query' | 'header' | 'cookie';
     scheme?: string;
@@ -314,12 +314,12 @@ export interface OpenAPISecurityScheme {
 }
 export interface OpenAPITag {
     name: string;
-    description?: string;
+    description?: string | GenericObject;
     externalDocs?: OpenAPIExternalDocumentation;
     'x-displayName'?: string;
 }
 export interface OpenAPIExternalDocumentation {
-    description?: string;
+    description?: string | GenericObject;
     url: string;
 }
 export interface OpenAPIContact {

package/lib/utils/compose.d.ts

@@ -0,0 +1 @@
+export declare const compose: <T>(fn1: (a: T) => T, ...fns: ((a: T) => T)[]) => (a: T) => T;

package/lib/utils/compose.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.compose=void 0;const compose=(e,...o)=>o.reduce(((e,o)=>s=>e(o(s))),e);exports.compose=compose;
+//# sourceMappingURL=compose.js.map

package/lib/utils/helpers.d.ts

@@ -43,9 +43,10 @@ export declare function removeQueryStringAndHash(serverUrl: string): string;
 export declare function escapeHTMLAttrChars(str: string): string;
 export declare function unescapeHTMLChars(str: string): string;
 export declare function sanitizeItemId(id: string): string;
-export declare function getSchemaTitle(pointer: string, title?: string): string;
+export declare function useSchemaTitle(pointer: string, title?: string): string;
 export declare function get<T>(object: GenericObject | undefined, path: string | Array<string>, defval?: T): GenericObject;
 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;
+export declare const normalizeText: (description?: string | GenericObject) => string;

package/lib/utils/helpers.js

@@ -1,2 +1,2 @@
-"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.getJsUrl=exports.getWindowReferenceOptions=exports.dottedString=exports.joinStringFactory=exports.get=exports.getSchemaTitle=exports.sanitizeItemId=exports.unescapeHTMLChars=exports.escapeHTMLAttrChars=exports.removeQueryStringAndHash=exports.titleize=exports.getBasePath=exports.resolveUrl=exports.isAbsoluteUrl=exports.safeSlugify=exports.isMergeableObject=exports.deleteEmptyArrayItem=exports.isArrayOfObjects=exports.isObject=exports.mergeObjects=exports.appendToMdHeading=exports.isNumeric=exports.stripTrailingSlash=exports.flattenByProp=exports.mapValues=exports.mapWithLast=void 0;const slugify_1=__importDefault(require("slugify")),url_1=require("url"),media_css_1=require("./media-css"),openapi_1=require("./openapi"),JsonPointer_1=require("./JsonPointer"),dom_1=require("./dom");function mapWithLast(e,t){const r=[];for(let s=0;s<e.length-1;s++)r.push(t(e[s],!1));return 0!==e.length&&r.push(t(e[e.length-1],!0)),r}function mapValues(e,t){const r={};for(const s in e)Object.prototype.hasOwnProperty.call(e,s)&&(r[s]=t(e[s],s,e));return r}function flattenByProp(e,t){const r=[],s=e=>{for(const n of e)r.push(n),n[t]&&s(n[t])};return s(e),r}function stripTrailingSlash(e){return e.endsWith("/")?e.substring(0,e.length-1):e}function isNumeric(e){return!isNaN(parseFloat(e))&&isFinite(e)}function appendToMdHeading(e,t,r){const s=new RegExp(`(^|\\n)#\\s?${t}\\s*\\n`,"i"),n=new RegExp(`((\\n|^)#\\s*${t}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`,"i");if(s.test(e))return e.replace(n,`$1\n\n${r}\n$4`);{const s=""===e||e.endsWith("\n\n")?"":e.endsWith("\n")?"\n":"\n\n";return`${e}${s}# ${t}\n\n${r}`}}exports.mapWithLast=mapWithLast,exports.mapValues=mapValues,exports.flattenByProp=flattenByProp,exports.stripTrailingSlash=stripTrailingSlash,exports.isNumeric=isNumeric,exports.appendToMdHeading=appendToMdHeading;const mergeObjects=(e,...t)=>{if(!t.length)return e;const r=t.shift();return void 0===r?e:((0,exports.isMergeableObject)(e)&&(0,exports.isMergeableObject)(r)&&Object.keys(r).forEach((t=>{(0,exports.isMergeableObject)(r[t])?(e[t]||(e[t]={}),["string","number"].includes(typeof e[t])&&(r[t][media_css_1.ZERO_BREAKPOINT]||0===r[t][media_css_1.ZERO_BREAKPOINT]||console.warn(`Theme resolver: using default value of "${e[t]}" for "${t}". This is not recommended. Prefer adding default value by providing "${media_css_1.ZERO_BREAKPOINT}" property to ${JSON.stringify(r[t])}.`),e[t]={[media_css_1.ZERO_BREAKPOINT]:e[t]}),(0,exports.mergeObjects)(e[t],r[t])):e[t]=r[t]})),(0,exports.mergeObjects)(e,...t))};exports.mergeObjects=mergeObjects;const isObject=e=>null!==e&&"object"==typeof e;exports.isObject=isObject;const isArrayOfObjects=e=>Array.isArray(e)&&e.some((e=>(0,exports.isObject)(e)));exports.isArrayOfObjects=isArrayOfObjects;const deleteEmptyArrayItem=e=>e.filter((e=>!!e));exports.deleteEmptyArrayItem=deleteEmptyArrayItem;const isMergeableObject=e=>(0,exports.isObject)(e)&&!Array.isArray(e);function safeSlugify(e){return(0,slugify_1.default)(e)||e.toString().toLowerCase().replace(/\s+/g,"-").replace(/&/g,"-and-").replace(/--+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}function isAbsoluteUrl(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}function resolveUrl(e,t){let r;if(t.startsWith("//")){const{protocol:s}=(0,url_1.parse)(e);r=`${s||"https:"}${t}`}else if(isAbsoluteUrl(t))r=t;else if(t.startsWith("/")){const s=(0,url_1.parse)(e);r=(0,url_1.format)(Object.assign(Object.assign({},s),{pathname:t}))}else r=stripTrailingSlash(e)+"/"+t;return stripTrailingSlash(r)}function getBasePath(e){try{return parseURL(e).pathname}catch(t){return e}}function titleize(e){return e.charAt(0).toUpperCase()+e.slice(1)}function removeQueryStringAndHash(e){try{const t=parseURL(e);return t.search="",t.hash="",t.toString()}catch(t){return e}}function parseURL(e){return"undefined"==typeof URL?new(require("url").URL)(e):new URL(e)}function escapeHTMLAttrChars(e){return e.replace(/["\\]/g,"\\$&")}function unescapeHTMLChars(e){return e.replace(/&#(\d+);/g,((e,t)=>String.fromCharCode(parseInt(t,10)))).replace(/&amp;/g,"&").replace(/&quot;/g,'"')}function sanitizeItemId(e){return e&&e.replace(/#/g,"_")}function getSchemaTitle(e,t){return t||(0,openapi_1.isNamedDefinition)(e)&&JsonPointer_1.JsonPointer.baseName(e)||""}function get(e={},t,r){return"string"==typeof t&&(t=t.split(".")),t.reduce(((e,t)=>e&&e[t]?e[t]:r),e)}function joinStringFactory(e){return(...t)=>t.filter(Boolean).join(e)}function getWindowReferenceOptions(e){var t;return dom_1.IS_BROWSER?null===(t=null===window||void 0===window?void 0:window.REFERENCE_DOCS_OPTIONS)||void 0===t?void 0:t[e]:null}function getJsUrl(){var e;if(!dom_1.IS_BROWSER)return"";const 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""}}exports.isMergeableObject=isMergeableObject,exports.safeSlugify=safeSlugify,exports.isAbsoluteUrl=isAbsoluteUrl,exports.resolveUrl=resolveUrl,exports.getBasePath=getBasePath,exports.titleize=titleize,exports.removeQueryStringAndHash=removeQueryStringAndHash,exports.escapeHTMLAttrChars=escapeHTMLAttrChars,exports.unescapeHTMLChars=unescapeHTMLChars,exports.sanitizeItemId=sanitizeItemId,exports.getSchemaTitle=getSchemaTitle,exports.get=get,exports.joinStringFactory=joinStringFactory,exports.dottedString=joinStringFactory("."),exports.getWindowReferenceOptions=getWindowReferenceOptions,exports.getJsUrl=getJsUrl;
+"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeText=exports.getJsUrl=exports.getWindowReferenceOptions=exports.dottedString=exports.joinStringFactory=exports.get=exports.useSchemaTitle=exports.sanitizeItemId=exports.unescapeHTMLChars=exports.escapeHTMLAttrChars=exports.removeQueryStringAndHash=exports.titleize=exports.getBasePath=exports.resolveUrl=exports.isAbsoluteUrl=exports.safeSlugify=exports.isMergeableObject=exports.deleteEmptyArrayItem=exports.isArrayOfObjects=exports.isObject=exports.mergeObjects=exports.appendToMdHeading=exports.isNumeric=exports.stripTrailingSlash=exports.flattenByProp=exports.mapValues=exports.mapWithLast=void 0;const slugify_1=__importDefault(require("slugify")),url_1=require("url"),media_css_1=require("./media-css"),openapi_1=require("./openapi"),JsonPointer_1=require("./JsonPointer"),dom_1=require("./dom"),typeGuards_1=require("./typeGuards");function mapWithLast(e,t){const r=[];for(let s=0;s<e.length-1;s++)r.push(t(e[s],!1));return 0!==e.length&&r.push(t(e[e.length-1],!0)),r}function mapValues(e,t){const r={};for(const s in e)Object.prototype.hasOwnProperty.call(e,s)&&(r[s]=t(e[s],s,e));return r}function flattenByProp(e,t){const r=[],s=e=>{for(const n of e)r.push(n),n[t]&&s(n[t])};return s(e),r}function stripTrailingSlash(e){return e.endsWith("/")?e.substring(0,e.length-1):e}function isNumeric(e){return!isNaN(parseFloat(e))&&isFinite(e)}function appendToMdHeading(e,t,r){const s=new RegExp(`(^|\\n)#\\s?${t}\\s*\\n`,"i"),n=new RegExp(`((\\n|^)#\\s*${t}\\s*(\\n|$)(?:.|\\n)*?)(\\n#|$)`,"i");if(s.test(e))return e.replace(n,`$1\n\n${r}\n$4`);{const s=""===e||e.endsWith("\n\n")?"":e.endsWith("\n")?"\n":"\n\n";return`${e}${s}# ${t}\n\n${r}`}}exports.mapWithLast=mapWithLast,exports.mapValues=mapValues,exports.flattenByProp=flattenByProp,exports.stripTrailingSlash=stripTrailingSlash,exports.isNumeric=isNumeric,exports.appendToMdHeading=appendToMdHeading;const mergeObjects=(e,...t)=>{if(!t.length)return e;const r=t.shift();return void 0===r?e:((0,exports.isMergeableObject)(e)&&(0,exports.isMergeableObject)(r)&&Object.keys(r).forEach((t=>{(0,exports.isMergeableObject)(r[t])?(e[t]||(e[t]={}),["string","number"].includes(typeof e[t])&&(r[t][media_css_1.ZERO_BREAKPOINT]||0===r[t][media_css_1.ZERO_BREAKPOINT]||console.warn(`Theme resolver: using default value of "${e[t]}" for "${t}". This is not recommended. Prefer adding default value by providing "${media_css_1.ZERO_BREAKPOINT}" property to ${JSON.stringify(r[t])}.`),e[t]={[media_css_1.ZERO_BREAKPOINT]:e[t]}),(0,exports.mergeObjects)(e[t],r[t])):e[t]=r[t]})),(0,exports.mergeObjects)(e,...t))};exports.mergeObjects=mergeObjects;const isObject=e=>null!==e&&"object"==typeof e;exports.isObject=isObject;const isArrayOfObjects=e=>Array.isArray(e)&&e.some((e=>(0,exports.isObject)(e)));exports.isArrayOfObjects=isArrayOfObjects;const deleteEmptyArrayItem=e=>e.filter((e=>!!e));exports.deleteEmptyArrayItem=deleteEmptyArrayItem;const isMergeableObject=e=>(0,exports.isObject)(e)&&!Array.isArray(e);function safeSlugify(e){return(0,slugify_1.default)(e)||e.toString().toLowerCase().replace(/\s+/g,"-").replace(/&/g,"-and-").replace(/--+/g,"-").replace(/^-+/,"").replace(/-+$/,"")}function isAbsoluteUrl(e){return/(?:^[a-z][a-z0-9+.-]*:|\/\/)/i.test(e)}function resolveUrl(e,t){let r;if(t.startsWith("//")){const{protocol:s}=(0,url_1.parse)(e);r=`${s||"https:"}${t}`}else if(isAbsoluteUrl(t))r=t;else if(t.startsWith("/")){const s=(0,url_1.parse)(e);r=(0,url_1.format)(Object.assign(Object.assign({},s),{pathname:t}))}else r=stripTrailingSlash(e)+"/"+t;return stripTrailingSlash(r)}function getBasePath(e){try{return parseURL(e).pathname}catch(t){return e}}function titleize(e){return e.charAt(0).toUpperCase()+e.slice(1)}function removeQueryStringAndHash(e){try{const t=parseURL(e);return t.search="",t.hash="",t.toString()}catch(t){return e}}function parseURL(e){return"undefined"==typeof URL?new(require("url").URL)(e):new URL(e)}function escapeHTMLAttrChars(e){return e.replace(/["\\]/g,"\\$&")}function unescapeHTMLChars(e){return e.replace(/&#(\d+);/g,((e,t)=>String.fromCharCode(parseInt(t,10)))).replace(/&amp;/g,"&").replace(/&quot;/g,'"')}function sanitizeItemId(e){return e&&e.replace(/#/g,"_")}function useSchemaTitle(e,t){return t||(0,openapi_1.isNamedDefinition)(e)&&JsonPointer_1.JsonPointer.baseName(e)||""}function get(e={},t,r){return"string"==typeof t&&(t=t.split(".")),t.reduce(((e,t)=>e&&e[t]?e[t]:r),e)}function joinStringFactory(e){return(...t)=>t.filter(Boolean).join(e)}function getWindowReferenceOptions(e){var t;return dom_1.IS_BROWSER?null===(t=null===window||void 0===window?void 0:window.REFERENCE_DOCS_OPTIONS)||void 0===t?void 0:t[e]:null}function getJsUrl(){var e;if(!dom_1.IS_BROWSER)return"";const 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""}}exports.isMergeableObject=isMergeableObject,exports.safeSlugify=safeSlugify,exports.isAbsoluteUrl=isAbsoluteUrl,exports.resolveUrl=resolveUrl,exports.getBasePath=getBasePath,exports.titleize=titleize,exports.removeQueryStringAndHash=removeQueryStringAndHash,exports.escapeHTMLAttrChars=escapeHTMLAttrChars,exports.unescapeHTMLChars=unescapeHTMLChars,exports.sanitizeItemId=sanitizeItemId,exports.useSchemaTitle=useSchemaTitle,exports.get=get,exports.joinStringFactory=joinStringFactory,exports.dottedString=joinStringFactory("."),exports.getWindowReferenceOptions=getWindowReferenceOptions,exports.getJsUrl=getJsUrl;const normalizeText=e=>(0,typeGuards_1.isString)(e)?e:null==e?void 0:e.raw;exports.normalizeText=normalizeText;
 //# sourceMappingURL=helpers.js.map

package/lib/utils/index.d.ts

@@ -6,7 +6,6 @@ export * from './loadAndBundleSpec';
 export * from './dom';
 export * from './decorators';
 export * from './debug';
-export * from './memoize';
 export * from './sort';
 export * from './argValuesHelpers';
 export * from './media-css';
@@ -16,6 +15,8 @@ export * from './security-details';
 export * from './session-storage';
 export * from './local-storage';
 export * from './parameters';
-export * from './store';
 export * from './string';
 export * from './test-utils';
+export * from './typeGuards';
+export * from './compose';
+export * from './saveTextBeforeHeading';

package/lib/utils/index.js

@@ -1,2 +1,2 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var p=Object.getOwnPropertyDescriptor(r,t);p&&!("get"in p?!r.__esModule:p.writable||p.configurable)||(p={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,p)}:function(e,r,t,o){void 0===o&&(o=t),e[o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./JsonPointer"),exports),__exportStar(require("./openapi"),exports),__exportStar(require("./helpers"),exports),__exportStar(require("./highlight"),exports),__exportStar(require("./loadAndBundleSpec"),exports),__exportStar(require("./dom"),exports),__exportStar(require("./decorators"),exports),__exportStar(require("./debug"),exports),__exportStar(require("./memoize"),exports),__exportStar(require("./sort"),exports),__exportStar(require("./argValuesHelpers"),exports),__exportStar(require("./media-css"),exports),__exportStar(require("./theme-helpers"),exports),__exportStar(require("./debounce"),exports),__exportStar(require("./security-details"),exports),__exportStar(require("./session-storage"),exports),__exportStar(require("./local-storage"),exports),__exportStar(require("./parameters"),exports),__exportStar(require("./store"),exports),__exportStar(require("./string"),exports),__exportStar(require("./test-utils"),exports);
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,r,t,o){void 0===o&&(o=t);var p=Object.getOwnPropertyDescriptor(r,t);p&&!("get"in p?!r.__esModule:p.writable||p.configurable)||(p={enumerable:!0,get:function(){return r[t]}}),Object.defineProperty(e,o,p)}:function(e,r,t,o){void 0===o&&(o=t),e[o]=r[t]}),__exportStar=this&&this.__exportStar||function(e,r){for(var t in e)"default"===t||Object.prototype.hasOwnProperty.call(r,t)||__createBinding(r,e,t)};Object.defineProperty(exports,"__esModule",{value:!0}),__exportStar(require("./JsonPointer"),exports),__exportStar(require("./openapi"),exports),__exportStar(require("./helpers"),exports),__exportStar(require("./highlight"),exports),__exportStar(require("./loadAndBundleSpec"),exports),__exportStar(require("./dom"),exports),__exportStar(require("./decorators"),exports),__exportStar(require("./debug"),exports),__exportStar(require("./sort"),exports),__exportStar(require("./argValuesHelpers"),exports),__exportStar(require("./media-css"),exports),__exportStar(require("./theme-helpers"),exports),__exportStar(require("./debounce"),exports),__exportStar(require("./security-details"),exports),__exportStar(require("./session-storage"),exports),__exportStar(require("./local-storage"),exports),__exportStar(require("./parameters"),exports),__exportStar(require("./string"),exports),__exportStar(require("./test-utils"),exports),__exportStar(require("./typeGuards"),exports),__exportStar(require("./compose"),exports),__exportStar(require("./saveTextBeforeHeading"),exports);
 //# sourceMappingURL=index.js.map

package/lib/utils/local-storage.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.fromLocalStorage=exports.toLocalStorage=void 0;const dom_1=require("./dom");function toLocalStorage(o,e){window.localStorage.setItem("redoc."+o,e)}function fromLocalStorage(o){return dom_1.IS_BROWSER&&window.localStorage.getItem("redoc."+o)||""}exports.toLocalStorage=toLocalStorage,exports.fromLocalStorage=fromLocalStorage;
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.fromLocalStorage=exports.toLocalStorage=void 0;const dom_1=require("./dom");function toLocalStorage(o,e){dom_1.IS_BROWSER&&window.localStorage.setItem("redoc."+o,e)}function fromLocalStorage(o){return dom_1.IS_BROWSER&&window.localStorage.getItem("redoc."+o)||""}exports.toLocalStorage=toLocalStorage,exports.fromLocalStorage=fromLocalStorage;
 //# sourceMappingURL=local-storage.js.map

package/lib/utils/openapi.d.ts

@@ -1,11 +1,12 @@
 import type { OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterStyle, OpenAPIRequestBody, OpenAPIResponse, OpenAPISchema, OpenAPIServer, Referenced } from '../types';
 import type { ExtendedOpenAPIOperation, OpenAPIParser } from '../services';
-import type { FieldModel } from '../models';
+import type { FieldModel, GroupModel } from '../models';
 import { OpenAPIParameter } from '../types';
 export declare function isStatusCode(statusCode: string): boolean;
 export declare function getStatusCodeType(statusCode: string | number, defaultAsError?: boolean): string;
 export declare function isOperationName(key: string): boolean;
-export declare function getOperationSummary(operation: ExtendedOpenAPIOperation): string;
+export declare function getOperationName({ operationId, description, summary, pathName, }: ExtendedOpenAPIOperation): string;
+export declare function getOperationId(operation: ExtendedOpenAPIOperation, parent?: GroupModel): string;
 export declare function detectType(schema: OpenAPISchema): string;
 export declare function isPrimitiveType(schema: OpenAPISchema, type?: string | string[] | undefined): boolean;
 export declare function isJsonLike(contentType: string): boolean;
@@ -24,14 +25,17 @@ export declare function getDefinitionName(pointer?: string): string | undefined;
 export declare function humanizeNumberRange(schema: OpenAPISchema): string | undefined;
 export declare function humanizeConstraints(schema: OpenAPISchema): string[];
 export declare function sortByRequired(fields: FieldModel[], order?: string[]): Array<FieldModel>;
-export declare function sortByField(fields: FieldModel[], param: keyof Pick<FieldModel, 'name' | 'description' | 'kind'>): Array<FieldModel>;
-export declare function mergeParams(parser: OpenAPIParser, pathParams?: Array<Referenced<OpenAPIParameter>>, operationParams?: Array<Referenced<OpenAPIParameter>>): Array<Referenced<OpenAPIParameter>>;
+export declare function sortByField(fields: FieldModel[], param: keyof Pick<FieldModel, 'name' | 'kind'>): Array<FieldModel>;
+export declare function mergeParams(parser: OpenAPIParser, pathParams: Referenced<OpenAPIParameter>[] | undefined, operationParams: Referenced<OpenAPIParameter>[] | undefined, { pathPointer, operationPointer }: {
+    pathPointer: any;
+    operationPointer: any;
+}): Array<{
+    paramOrRef: Referenced<OpenAPIParameter>;
+    pointer: string;
+}>;
 export declare function mergeSimilarMediaTypes(types: Record<string, OpenAPIMediaType>): Record<string, OpenAPIMediaType>;
 export declare function expandDefaultServerVariables(url: string, variables?: GenericObject): string;
 export declare function normalizeServers(specUrl: string | undefined, servers: OpenAPIServer[]): OpenAPIServer[];
-export declare const SECURITY_DEFINITIONS_COMPONENT_NAME = "security-definitions";
-export declare const SECURITY_DEFINITIONS_JSX_NAME = "SecurityDefinitions";
-export declare const SCHEMA_DEFINITION_JSX_NAME = "SchemaDefinition";
 export declare const shortenHTTPVerb: (verb: string) => string;
 export declare function isRedocExtension(key: string): boolean;
 export declare function extractExtensions(obj: GenericObject, showExtensions: string[] | true): GenericObject;