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

package/lib/services/OpenAPIParser.js

@@ -0,0 +1,2 @@
+"use strict";var __rest=this&&this.__rest||function(e,t){var r={};for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&t.indexOf(i)<0&&(r[i]=e[i]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var s=0;for(i=Object.getOwnPropertySymbols(e);s<i.length;s++)t.indexOf(i[s])<0&&Object.prototype.propertyIsEnumerable.call(e,i[s])&&(r[i[s]]=e[i[s]])}return r};Object.defineProperty(exports,"__esModule",{value:!0}),exports.OpenAPIParser=exports.concatRefStacks=exports.pushRef=void 0;const utils_1=require("../utils/"),JsonPointer_1=require("../utils/JsonPointer"),NormalizedOptions_1=require("./Options/NormalizedOptions");function pushRef(e,t){return t&&e[e.length-1]!==t?[...e,t]:e}function concatRefStacks(e,t){return t?e.concat(t):e}exports.pushRef=pushRef,exports.concatRefStacks=concatRefStacks;class OpenAPIParser{constructor(e,t,r=(0,NormalizedOptions_1.NormalizedOptions)({})){Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:r}),Object.defineProperty(this,"definitionUrl",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"allowMergeRefs",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"byRef",{enumerable:!0,configurable:!0,writable:!0,value:e=>{let t;if(this.definition){"#"!==e.charAt(0)&&(e="#"+e),e=decodeURIComponent(e);try{t=JsonPointer_1.JsonPointer.get(this.definition,e)}catch(e){}return t||{}}}}),this.validate(e),this.preprocess(e),this.definition=e,this.allowMergeRefs=e.openapi.startsWith("3.1");const i=utils_1.IS_BROWSER?window.location.href:"";"string"==typeof t&&(this.definitionUrl=new URL(t,i).href)}validate(e){if(void 0===e.openapi)throw new Error("Document must be valid OpenAPI 3.0.0 definition")}preprocess(e){e.info&&this.options.hideInfoDescription&&(e.info.description="")}isRef(e){return!!e&&(void 0!==e.$ref&&null!==e.$ref)}deref(e,t=[],r=!1){const i=null==e?void 0:e["x-refsStack"];if(t=concatRefStacks(t,i),this.isRef(e)){const i=(0,utils_1.getDefinitionName)(e.$ref);if(i&&this.options.ignoreNamedSchemas.has(i))return{resolved:{type:"object",title:i},refsStack:t};let s=this.byRef(e.$ref);if(!s)throw new Error(`Failed to resolve $ref "${e.$ref}"`);let n=t;if(t.includes(e.$ref))s=Object.assign({},s,{"x-circular-ref":!0});else if(this.isRef(s)){const e=this.deref(s,t,r);n=e.refsStack,s=e.resolved}return n=pushRef(t,e.$ref),s=this.allowMergeRefs?this.mergeRefs(e,s,r):s,{resolved:s,refsStack:n}}return{resolved:e,refsStack:concatRefStacks(t,i)}}mergeRefs(e,t,r){const{$ref:i}=e,s=__rest(e,["$ref"]),n=Object.keys(s);if(0===n.length)return t;if(r&&n.some((e=>!["description","title","externalDocs","x-refsStack","x-parentRefs","readOnly","writeOnly"].includes(e)))){const e=s,{description:r,title:i,readOnly:n,writeOnly:o}=e;return{allOf:[{description:r,title:i,readOnly:n,writeOnly:o},t,__rest(e,["description","title","readOnly","writeOnly"])]}}return Object.assign(Object.assign({},t),s)}mergeAllOf(e,t,r){var i;if(e["x-circular-ref"])return e;if(void 0===(e=this.hoistOneOfs(e)).allOf)return e;let s=Object.assign(Object.assign({},e),{"x-parentRefs":[],allOf:void 0,title:e.title||(0,utils_1.getDefinitionName)(t)});void 0!==s.properties&&"object"==typeof s.properties&&(s.properties=Object.assign({},s.properties)),void 0!==s.items&&"object"==typeof s.items&&(s.items=Object.assign({},s.items));const n=e.allOf.map((e=>{var t;const{resolved:i,refsStack:n}=this.deref(e,r,!0),o=e.$ref||void 0,a=this.mergeAllOf(i,o,n);if(!a["x-circular-ref"]||!a.allOf)return o&&(null===(t=s["x-parentRefs"])||void 0===t||t.push(...a["x-parentRefs"]||[],o)),{$ref:o,refsStack:pushRef(n,o),schema:a}})).filter((e=>void 0!==e));for(const{schema:e,refsStack:r}of n){const{type:n,enum:o,properties:a,items:f,required:l,title:c,description:p,readOnly:d,writeOnly:O,oneOf:u,anyOf:y,"x-circular-ref":h}=e,m=__rest(e,["type","enum","properties","items","required","title","description","readOnly","writeOnly","oneOf","anyOf","x-circular-ref"]);if(s.type!==n&&void 0!==s.type&&void 0!==n&&console.warn(`Incompatible types in allOf at "${t}": "${s.type}" and "${n}"`),void 0!==n&&(Array.isArray(n)&&Array.isArray(s.type)?s.type=[...n,...s.type]:s.type=n),void 0!==o&&(Array.isArray(o)&&Array.isArray(s.enum)?s.enum=Array.from(new Set([...o,...s.enum])):s.enum=o),void 0!==a&&"object"==typeof a){s.properties=s.properties||{};for(const e in a){const n=concatRefStacks(r,null===(i=a[e])||void 0===i?void 0:i["x-refsStack"]);if(s.properties[e]){if(!h){const r=this.mergeAllOf({allOf:[s.properties[e],a[e]],"x-refsStack":n},t+"/properties/"+e,n);s.properties[e]=r}}else s.properties[e]=Object.assign(Object.assign({},a[e]),{"x-refsStack":n})}}if(void 0!==f&&!h){const i="boolean"==typeof s.items?{}:Object.assign({},s.items),n="boolean"==typeof e.items?{}:Object.assign({},e.items);s.items=this.mergeAllOf({allOf:[i,n]},t+"/items",r)}void 0!==u&&(s.oneOf=u),void 0!==y&&(s.anyOf=y),void 0!==l&&(s.required=[...s.required||[],...l]),s=Object.assign(Object.assign(Object.assign({},s),{title:s.title||c,description:s.description||p,readOnly:void 0!==s.readOnly?s.readOnly:d,writeOnly:void 0!==s.writeOnly?s.writeOnly:O,"x-circular-ref":s["x-circular-ref"]||h}),m)}return s}findDerived(e){const t={},r=this.definition.components&&this.definition.components.schemas||{};for(const i in r){const{resolved:s}=this.deref(r[i]);void 0!==s.allOf&&s.allOf.find((t=>void 0!==t.$ref&&e.indexOf(t.$ref)>-1))&&(t["#/components/schemas/"+i]=[s["x-discriminator-value"]||i])}return t}hoistOneOfs(e){if(void 0===e.allOf)return e;const t=e.allOf;for(let e=0;e<t.length;e++){const r=t[e];if(Array.isArray(r.oneOf)){const i=t.slice(0,e),s=t.slice(e+1);return{oneOf:r.oneOf.map((e=>({allOf:[...i,e,...s]})))}}}return e}}exports.OpenAPIParser=OpenAPIParser;
+//# sourceMappingURL=OpenAPIParser.js.map

package/lib/services/Options/NormalizedOptions.d.ts

@@ -0,0 +1,2 @@
+import type { Options, RawOptions } from './types';
+export declare function NormalizedOptions(raw: RawOptions, defaultOptions?: RawOptions): Options;

package/lib/services/Options/NormalizedOptions.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.NormalizedOptions=void 0;const theme_1=require("@redocly/theme"),constants_1=require("../../constants"),types_1=require("./types"),utils_1=require("../../utils"),utils_2=require("../utils"),helpers_1=require("./helpers"),types_2=require("../types");function NormalizedOptions(e,a){var o,l,n;e=Object.assign(Object.assign({},a),e);const t=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(o=e.ignoreNamedSchemas)||void 0===o?void 0:o.split(",").map((e=>e.trim())),i={corsProxyUrl:(0,helpers_1.addTrailingSlash)(e.corsProxyUrl),authCorsProxyUrl:(0,helpers_1.addTrailingSlash)(e.authCorsProxyUrl),ctrlFHijack:(0,utils_1.argValueToBoolean)(e.ctrlFHijack,!0),disableDeepLinks:(0,utils_1.argValueToBoolean)(e.disableDeepLinks,!1),disableTryItRequestUrlEncoding:(0,utils_1.argValueToBoolean)(e.disableTryItRequestUrlEncoding,!1),minCharacterLengthToInitSearch:(0,utils_1.argValueToNumber)(e.minCharacterLengthToInitSearch,3),disableSearch:(0,utils_1.argValueToBoolean)(e.disableSearch,!1),disableSidebar:(0,utils_1.argValueToBoolean)(e.disableSidebar,!1),expandResponses:(0,helpers_1.normalizeExpandResponses)(e.expandResponses),jsonSampleExpandLevel:(0,utils_1.argValueToExpandLevel)(e.jsonSampleExpandLevel,2),expandDefaultServerVariables:(0,utils_1.argValueToBoolean)(e.expandDefaultServerVariables,!1),expandDefaultRequest:(0,utils_1.argValueToBoolean)(e.expandDefaultRequest,!0),expandDefaultResponse:(0,utils_1.argValueToBoolean)(e.expandDefaultResponse,!0),expandSingleSchemaField:(0,utils_1.argValueToBoolean)(e.expandSingleSchemaField,!1),generatedPayloadSamplesMaxDepth:(0,utils_1.argValueToInt)(e.generatedPayloadSamplesMaxDepth,8),hideDownloadButton:void 0===e.hideDownloadButton?null:(0,utils_1.argValueToBoolean)(e.hideDownloadButton),hideInfoDescription:(0,utils_1.argValueToBoolean)(e.hideInfoDescription),hideHostname:(0,utils_1.argValueToBoolean)(e.hideHostname,!1),hideInfoSection:(0,utils_1.argValueToBoolean)(e.hideInfoSection,!1),hideLoading:(0,utils_1.argValueToBoolean)(e.hideLoading,!1),hideLogo:(0,utils_1.argValueToBoolean)(e.hideLogo,!1),hideFab:(0,utils_1.argValueToBoolean)(e.hideFab,!1),hideRequestPayloadSample:(0,utils_1.argValueToBoolean)(e.hideRequestPayloadSample,!1),hideRightPanel:(0,utils_1.argValueToBoolean)(e.hideRightPanel,!1),hideSchemaPattern:(0,utils_1.argValueToBoolean)(e.hideSchemaPattern,!1),hideOneOfDescription:(0,utils_1.argValueToBoolean)(e.hideOneOfDescription,!1),hideSchemaTitles:(0,utils_1.argValueToBoolean)(e.hideSchemaTitles,!1),hideSingleRequestSampleTab:(0,utils_1.argValueToBoolean)(e.hideSingleRequestSampleTab,!1),hideTryItPanel:(0,utils_1.argValueToBoolean)(e.hideTryItPanel,!1),showObjectSchemaExamples:(0,utils_1.argValueToBoolean)(e.showObjectSchemaExamples,!1),showAccessMode:(0,utils_1.argValueToBoolean)(e.showAccessMode,!1),maxDisplayedEnumValues:(0,utils_1.argValueToNumber)(e.maxDisplayedEnumValues),maxResponseHeadersToShowInTryIt:(0,utils_1.argValueToNumber)(e.maxResponseHeadersToShowInTryIt,0),menuToggle:(0,utils_1.argValueToBoolean)(e.menuToggle,!0),mockServer:(null===(l=e.mockServer)||void 0===l?void 0:l.url)?{url:e.mockServer.url,position:e.mockServer.position||"first",description:e.mockServer.description||"Mock server"}:void 0,nativeScrollbars:(0,utils_1.argValueToBoolean)(e.nativeScrollbars,!1),oAuth2RedirectURI:e.oAuth2RedirectURI||null,onlyRequiredInSamples:(0,utils_1.argValueToBoolean)(e.onlyRequiredInSamples,!1),pathInMiddlePanel:(0,utils_1.argValueToBoolean)(e.pathInMiddlePanel,!1),onDeepLinkClick:e.onDeepLinkClick||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.ON_DEEP_LINK_CLICK),requestInterceptor:e.requestInterceptor||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.REQUEST_INTERCEPTOR),routingBasePath:e.routingBasePath&&(0,utils_2.normalizePath)(e.routingBasePath)||"",routingStrategy:e.routingStrategy,schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),pagination:e.pagination||"none",payloadSampleIdx:(0,helpers_1.normalizePayloadSampleIdx)(e.payloadSampleIdx,0),requiredPropsFirst:(0,utils_1.argValueToBoolean)(e.requiredPropsFirst,!1),markdownHeadingsAnchorLevel:(0,utils_1.argValueToNumber)(e.markdownHeadingsAnchorLevel,2),samplesTabsMaxCount:(0,utils_1.argValueToInt)(e.samplesTabsMaxCount,5),scrollYOffset:(0,helpers_1.normalizeScrollYOffset)(e.scrollYOffset),searchAutoExpand:(0,utils_1.argValueToBoolean)(e.searchAutoExpand,!0),searchFieldLevelBoost:(0,utils_1.argValueToNumber)(e.searchFieldLevelBoost,.95),searchMaxDepth:(0,utils_1.argValueToNumber)(e.searchMaxDepth,constants_1.DEFAULT_SEARCH_MAX_DEPTH),searchOperationTitleBoost:(0,utils_1.argValueToNumber)(e.searchOperationTitleBoost,4),searchTagTitleBoost:(0,utils_1.argValueToNumber)(e.searchTagTitleBoost,8),sendXUserAgentInTryIt:(0,utils_1.argValueToBoolean)(e.sendXUserAgentInTryIt,!1),showWebhookVerb:(0,utils_1.argValueToBoolean)(e.showWebhookVerb,!1),showChangeLayoutButton:(0,utils_1.argValueToBoolean)(e.showChangeLayoutButton,!0),showConsole:null!=e.hideTryItPanel?!e.hideTryItPanel:null===(n=e.showConsole)||void 0===n||n,showExtensions:(0,helpers_1.normalizeShowExtensions)(e.showExtensions),preserveOriginalExtensionsName:(0,utils_1.argValueToBoolean)(e.preserveOriginalExtensionsName,!1),showNextButton:(0,utils_1.argValueToBoolean)(e.showNextButton,!0),showRightPanelToggle:(0,utils_1.argValueToBoolean)(e.showRightPanelToggle,!0),showSecuritySchemeType:(0,utils_1.argValueToBoolean)(e.showSecuritySchemeType,!0),hideSecuritySection:(0,utils_1.argValueToBoolean)(e.hideSecuritySection,!1),simpleOneOfTypeLabel:(0,utils_1.argValueToBoolean)(e.simpleOneOfTypeLabel,!1),sortEnumValuesAlphabetically:(0,utils_1.argValueToBoolean)(e.sortEnumValuesAlphabetically),sortOperationsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortOperationsAlphabetically),sortPropsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortPropsAlphabetically,!1),sortTagsAlphabetically:(0,utils_1.argValueToBoolean)(e.sortTagsAlphabetically,!1),unstable_ignoreMimeParameters:(0,utils_1.argValueToBoolean)(e.unstable_ignoreMimeParameters,!1),untrustedDefinition:(0,utils_1.argValueToBoolean)(e.untrustedDefinition,!1),enumSkipQuotes:(0,utils_1.argValueToBoolean)(e.enumSkipQuotes),whiteLabel:(0,utils_1.argValueToBoolean)(e.whiteLabel),linkForId:e.linkForId||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.LINK_FOR_ID),generateDeepLink:e.generateDeepLink||(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.GENERATE_DEEP_LINK),skipBundleAndConvert:(0,utils_1.argValueToBoolean)(e.skipBundleAndConvert),disablePaginationLoadingAnimation:(0,utils_1.argValueToBoolean)(!!e.disablePaginationLoadingAnimation),disableErrorBoundary:(0,utils_1.argValueToBoolean)(e.disableErrorBoundary),ignoreNamedSchemas:new Set(t),mediaQueries:(0,theme_1.generateMediaQueries)((null==e?void 0:e.breakpoints)||{}),showAtBreakpoint:e.showAtBreakpoint,allowedMdComponents:(null==e?void 0:e.allowedMdComponents)||{}};null!=e.showConsole&&console.warn('"showConsole" option is deprecated. Please, use "hideTryItPanel" instead.');const s="object"==typeof e.layout?e.layout:null;if(!(null==e?void 0:e.pagination)&&(null==s?void 0:s.scope))switch(console.warn('"layout.scope" and "routingStrategy" settings are deprecated. Please, use "pagination" instead.'),null==s?void 0:s.scope){case"all":default:i.pagination="none",i.routingStrategy="hash";break;case"section":i.pagination="section",i.routingStrategy="browser";break;case"item":i.pagination="item",i.routingStrategy="browser"}return i.routingStrategy=void 0!==e.routingStrategy?e.routingStrategy:"none"===i.pagination?"hash":"browser",i.disablePaginationLoadingAnimation=!!e.disablePaginationLoadingAnimation||"none"===i.pagination,Object.assign(DEFAULT_USER_OPTIONS,e,i)}exports.NormalizedOptions=NormalizedOptions;const DEFAULT_USER_OPTIONS={defaultSampleLanguage:"",generateCodeSamples:{languages:[]},layout:constants_1.LayoutVariant.THREE_PANEL,sideNavStyle:types_2.SideNavStyle.SummaryOnly,searchMode:types_1.SearchMode.Default,sidebarLinks:{},events:{},hooks:(0,utils_1.getWindowReferenceOptions)(constants_1.WindowReferenceOptions.HOOKS)||{},unstable_tryItButtonOverride:null,unstable_externalCodeSamples:[],deepLinkSeparator:"/",deepLinkPrefix:"!",markdownItemsPagination:"none"};
+//# sourceMappingURL=NormalizedOptions.js.map

package/lib/services/Options/helpers.d.ts

@@ -0,0 +1,8 @@
+import type { RawOptions } from './types';
+export declare function normalizeExpandResponses(value: RawOptions['expandResponses']): 'all' | {
+    [code: string]: boolean;
+};
+export declare function addTrailingSlash(url?: string): string | undefined;
+export declare function normalizePayloadSampleIdx(value: RawOptions['payloadSampleIdx'], defaultValue: number): number;
+export declare function normalizeShowExtensions(value: RawOptions['showExtensions']): string[] | boolean;
+export declare function normalizeScrollYOffset(value: RawOptions['scrollYOffset']): () => number;

package/lib/services/Options/helpers.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.normalizeScrollYOffset=exports.normalizeShowExtensions=exports.normalizePayloadSampleIdx=exports.addTrailingSlash=exports.normalizeExpandResponses=void 0;const dom_1=require("../../utils/dom"),helpers_1=require("../../utils/helpers");function normalizeExpandResponses(e){if("all"===e)return"all";if("string"==typeof e){const o={};return e.split(",").forEach((e=>{o[e.trim()]=!0})),o}return void 0!==e&&console.warn(`expandResponses must be a string but received value "${e}" of type ${typeof e}`),{}}function addTrailingSlash(e){return e?e.endsWith("/")?e:e+"/":void 0}function normalizePayloadSampleIdx(e,o){return"number"==typeof e?Math.max(0,e):"string"==typeof e?isFinite(e)?parseInt(e,10):0:o}function normalizeShowExtensions(e){if(void 0===e)return!1;if(""===e)return!0;if("string"!=typeof e)return e;switch(e){case"true":return!0;case"false":return!1;default:return e.split(",").map((e=>e.trim()))}}function normalizeScrollYOffset(e){if("string"==typeof e&&!(0,helpers_1.isNumeric)(e)){const o=(0,dom_1.querySelector)(e);o||console.warn("scrollYOffset value is a selector to non-existing element. Using offset 0 by default");const r=o&&o.getBoundingClientRect().bottom||0;return()=>r}return"number"==typeof e||(0,helpers_1.isNumeric)(e)?()=>"number"==typeof e?e:parseFloat(e):"function"==typeof e?()=>{const o=e();return"number"!=typeof o&&console.warn(`scrollYOffset should return number but returned value "${o}" of type ${typeof o}`),o}:(void 0!==e&&console.warn("Wrong value for scrollYOffset ReDoc option: should be string, number or function"),()=>0)}exports.normalizeExpandResponses=normalizeExpandResponses,exports.addTrailingSlash=addTrailingSlash,exports.normalizePayloadSampleIdx=normalizePayloadSampleIdx,exports.normalizeShowExtensions=normalizeShowExtensions,exports.normalizeScrollYOffset=normalizeScrollYOffset;
+//# sourceMappingURL=helpers.js.map

package/lib/services/Options/index.d.ts

@@ -0,0 +1,2 @@
+export * from './NormalizedOptions';
+export * from './types';

package/lib/services/Options/index.js

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

package/lib/services/Options/types.d.ts

@@ -0,0 +1,258 @@
+import type { LayoutVariant } from 'src/constants';
+import type { CodeSamplesConfig, Languages } from '../code-samples';
+import type { ExternalLink, HooksConfig, MarkdownItemsPagination, MDXComponentMeta, Pagination, SideNavStyle, Unstable_ExternalCodeSample } from '../types';
+import type { Events } from '../../events';
+import type { MediaQueries } from '@redocly/theme';
+import type { OperationModel } from 'src/models/Operation';
+import type { LabelsConfigRaw } from '../labels/types';
+export declare enum SearchMode {
+    Default = "default",
+    PathOnly = "path-only"
+}
+export interface RawOptions {
+    licenseKey?: string;
+    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;
+    searchAutoExpand?: boolean;
+    searchOperationTitleBoost?: number | string;
+    searchTagTitleBoost?: number | string;
+    searchFieldLevelBoost?: number | 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;
+    } | null;
+    mockServer?: {
+        url?: string;
+        position?: 'first' | 'last' | 'replace' | 'off';
+        description?: string;
+    };
+    labels?: LabelsConfigRaw;
+    enumSkipQuotes?: boolean | string;
+    expandDefaultServerVariables?: boolean;
+    expandDefaultRequest?: boolean;
+    expandDefaultResponse?: boolean;
+    maxDisplayedEnumValues?: number;
+    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;
+    /** @deprecated use hideTryItPanel instead */
+    showConsole?: boolean;
+    hideTryItPanel?: boolean;
+    hideRightPanel?: boolean;
+    showRightPanelToggle?: boolean;
+    layout?: LayoutVariant;
+    defaultSampleLanguage?: Languages | string;
+    deepLinkSeparator?: string;
+    deepLinkPrefix?: string;
+    disableDeepLinks?: boolean;
+    sideNavStyle?: SideNavStyle;
+    whiteLabel?: boolean;
+    hideLogo?: boolean;
+    hideInfoSection?: boolean;
+    oAuth2RedirectURI?: string | null;
+    events?: Events;
+    corsProxyUrl?: string;
+    authCorsProxyUrl?: string;
+    linkForId?: ((id: string) => string) | null;
+    generateDeepLink?: ((fieldFragment: string, operationLink: any) => string) | undefined | null;
+    onDeepLinkClick?: ((link: string) => void) | undefined | null;
+    requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
+    sidebarLinks?: {
+        beforeInfo?: Array<ExternalLink>;
+        end?: Array<ExternalLink>;
+    };
+    pagination?: Pagination;
+    showNextButton?: boolean;
+    routingStrategy?: 'hash' | 'browser';
+    markdownItemsPagination?: MarkdownItemsPagination;
+    disableSidebar?: boolean;
+    skipBundleAndConvert?: boolean;
+    routingBasePath?: string;
+    searchMode?: SearchMode;
+    ctrlFHijack?: boolean;
+    disablePaginationLoadingAnimation?: boolean | null;
+    generateCodeSamples?: CodeSamplesConfig;
+    disableErrorBoundary?: boolean;
+    unstable_externalDescription?: string;
+    searchMaxDepth?: number;
+    mediaQueries?: MediaQueries;
+    ignoreNamedSchemas?: string[] | string;
+    breakpoints?: Omit<MediaQueries, 'print'>;
+    allowedMdComponents?: Record<string, MDXComponentMeta>;
+}
+export interface DefaultOptions {
+    mediaQueries?: MediaQueries;
+    ignoreNamedSchemas?: string[] | string;
+    breakpoints?: Omit<MediaQueries, 'print'>;
+    showAtBreakpoint?: {
+        sidebar?: keyof Omit<MediaQueries, 'print'>;
+        samplesPanel?: keyof Omit<MediaQueries, 'print'>;
+    };
+    allowedMdComponents?: Record<string, MDXComponentMeta>;
+}
+export interface Options {
+    showAtBreakpoint: {
+        sidebar: keyof Omit<MediaQueries, 'print'>;
+        samplesPanel: keyof Omit<MediaQueries, 'print'>;
+    };
+    mediaQueries: MediaQueries;
+    scrollYOffset: () => number;
+    hideHostname: boolean;
+    hideInfoDescription: boolean;
+    expandResponses: 'all' | {
+        [code: string]: boolean;
+    };
+    requiredPropsFirst: boolean;
+    sortPropsAlphabetically: boolean;
+    sortEnumValuesAlphabetically: boolean;
+    sortOperationsAlphabetically: boolean;
+    sortTagsAlphabetically: boolean;
+    nativeScrollbars: boolean;
+    pathInMiddlePanel: boolean;
+    untrustedDefinition: boolean;
+    hideLoading: boolean;
+    hideDownloadButton: boolean;
+    downloadDefinitionUrl?: string;
+    disableSearch: boolean;
+    searchAutoExpand: boolean;
+    searchOperationTitleBoost: number;
+    searchTagTitleBoost: number;
+    searchFieldLevelBoost: number;
+    showChangeLayoutButton: boolean;
+    onlyRequiredInSamples: boolean;
+    generatedPayloadSamplesMaxDepth: number;
+    sendXUserAgentInTryIt: boolean;
+    showExtensions: string[] | boolean;
+    preserveOriginalExtensionsName: boolean;
+    hideSingleRequestSampleTab: boolean;
+    hideRequestPayloadSample: boolean;
+    menuToggle: boolean;
+    jsonSampleExpandLevel: number;
+    hideSchemaTitles: boolean;
+    hideSecuritySection: boolean;
+    showSecuritySchemeType: boolean;
+    simpleOneOfTypeLabel: boolean;
+    payloadSampleIdx: number;
+    expandSingleSchemaField: boolean;
+    schemaExpansionLevel: number;
+    samplesTabsMaxCount: number;
+    unstable_tryItButtonOverride?: {
+        label: string;
+        link: string;
+    } | null;
+    mockServer?: {
+        url: string;
+        position: 'first' | 'last' | 'replace' | 'off';
+        description: string;
+    };
+    allowedMdComponents: Record<string, MDXComponentMeta>;
+    labels?: LabelsConfigRaw;
+    enumSkipQuotes: boolean;
+    expandDefaultServerVariables: boolean;
+    expandDefaultRequest: boolean;
+    expandDefaultResponse: boolean;
+    maxDisplayedEnumValues: number;
+    ignoreNamedSchemas: Set<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;
+    /** @deprecated use hideTryItPanel instead */
+    showConsole: boolean;
+    hideTryItPanel: boolean;
+    hideRightPanel: boolean;
+    showRightPanelToggle: boolean;
+    layout: LayoutVariant;
+    defaultSampleLanguage: Languages | string;
+    deepLinkSeparator: string;
+    deepLinkPrefix: string;
+    disableDeepLinks: boolean;
+    sideNavStyle: SideNavStyle;
+    whiteLabel: boolean;
+    hideLogo: boolean;
+    hideInfoSection: boolean;
+    oAuth2RedirectURI: string | null;
+    events: Events;
+    corsProxyUrl?: string;
+    authCorsProxyUrl?: string;
+    linkForId: ((id: string) => string) | null | undefined;
+    generateDeepLink: ((fieldFragment: string, operationLink: any) => string) | undefined | null;
+    onDeepLinkClick: ((link: string) => void) | undefined | null;
+    requestInterceptor: ((req: Request, operation: OperationModel) => void) | undefined | null;
+    sidebarLinks?: {
+        beforeInfo?: Array<ExternalLink>;
+        end?: Array<ExternalLink>;
+    };
+    pagination: Pagination;
+    showNextButton?: boolean;
+    routingStrategy?: 'hash' | 'browser';
+    markdownItemsPagination: MarkdownItemsPagination;
+    disableSidebar: boolean;
+    skipBundleAndConvert: boolean;
+    routingBasePath: string;
+    searchMode: SearchMode;
+    ctrlFHijack?: boolean;
+    disablePaginationLoadingAnimation: boolean;
+    generateCodeSamples: CodeSamplesConfig;
+    disableErrorBoundary: boolean;
+    /** @deprecated */
+    unstable_externalDescription?: string;
+    searchMaxDepth: number;
+}

package/lib/services/Options/types.js

@@ -0,0 +1,2 @@
+"use strict";var SearchMode;Object.defineProperty(exports,"__esModule",{value:!0}),exports.SearchMode=void 0,function(e){e.Default="default",e.PathOnly="path-only"}(SearchMode=exports.SearchMode||(exports.SearchMode={}));
+//# sourceMappingURL=types.js.map

package/lib/services/ProMenu.d.ts

@@ -1,10 +1,13 @@
-import type { IMenuItem, ScrollService, HistoryService, MenuItemType, SchemaModel, SpecStore } from '../redoc-lib';
-import type { RedocProNormalizedOptions } from './ProStore';
+import type { IMenuItem, ScrollService, HistoryService, MenuItemType, SpecStore } from '../services';
+import type { Options } from './Options/types';
+import type { SchemaModel } from '../models';
 import { VersionedSpecStore } from './VersionedSpecStore';
-export declare type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
+export type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
     type: MenuItemType | 'spec';
     linkable?: boolean;
     href?: string;
+    httpVerb?: string;
+    path?: string;
 };
 /**
  * Stores all side-menu related information
@@ -12,7 +15,7 @@ export declare type ExtendedMenuItem = Omit<IMenuItem, 'type'> & {
 export declare class ProMenu {
     definition: SpecStore | VersionedSpecStore;
     scroll: ScrollService;
-    options: RedocProNormalizedOptions;
+    options: Options;
     history: HistoryService;
     /**
      * Statically try update scroll position
@@ -40,7 +43,7 @@ export declare class ProMenu {
      * @param options normalized options
      * @param history
      */
-    constructor(definition: SpecStore | VersionedSpecStore, scroll: ScrollService, options: RedocProNormalizedOptions, history: HistoryService);
+    constructor(definition: SpecStore | VersionedSpecStore, scroll: ScrollService, options: Options, history: HistoryService);
     subscribe(): void;
     toggleSidebar(): void;
     closeSidebar(): void;

package/lib/services/ProMenu.js

@@ -1,2 +1,2 @@
-"use strict";var __decorate=this&&this.__decorate||function(e,t,i,s){var o,n=arguments.length,r=n<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)r=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(o=e[a])&&(r=(n<3?o(r):n>3?o(t,i,r):o(t,i))||r);return n>3&&r&&Object.defineProperty(t,i,r),r};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ProMenu=void 0;const mobx_1=require("mobx"),redoc_lib_1=require("../redoc-lib"),constants_1=require("../redoc-lib/src/services/constants"),HistoryService_1=require("../redoc-lib/src/services/HistoryService"),VersionedSpecStore_1=require("./VersionedSpecStore");class ProMenu{constructor(e,t,i,s){Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"scroll",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"history",{enumerable:!0,configurable:!0,writable:!0,value:s}),Object.defineProperty(this,"flatItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeRenderItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"renderItems",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"activeItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"sideBarOpened",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"_unsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_hashUnsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"getItemById",{enumerable:!0,configurable:!0,writable:!0,value:e=>this.flatItems.find((t=>t.id===e))}),Object.defineProperty(this,"initOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i&&(this.activate(i,!1,!1,!1,e),i.active=!1)}}),Object.defineProperty(this,"updateOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i?this.activateAndScroll(i,!1,void 0,e):(this.scroll.prevOffsetY=0,this.scroll.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,redoc_lib_1.escapeHTMLAttrChars)(t)}"]`))}}),Object.defineProperty(this,"updateVersionOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:e=>{if(!("versionsInfo"in this.definition))return;const[t]=e.split("/");let i=this.definition.versionsInfo.findIndex((e=>e.id===t));i<0&&(i=this.definition.versionsInfo.findIndex((e=>e.isDefault))),this.definition.activeVersionIdx!==i&&(this.definition.changeVersion(i<0?0:i),this.updateItemsByVersionChange(!1,e))}}),Object.defineProperty(this,"updateOnScroll",{enumerable:!0,configurable:!0,writable:!0,value:e=>{const t=e?1:-1;let i=this.activeItemIdx;for(;(-1!==i||e)&&!(i>=this.flatItems.length-1&&e);){if(e){let e=!1;const t=this.flatItems[i+1];switch(this.options.pagination){case"section":e=t&&("spec"===t.type||"group"===t.type||"tag"===t.type);break;case"item":e="section"!==(null==t?void 0:t.type)}const s=this.getElementAt(i+1);if(-1===i&&"tag"===this.flatItems[0].type&&(e=!1),this.scroll.isElementBellow(s)||e)break}else{const e=this.flatItems[i]&&this.flatItems[i].type,t="section"===this.options.pagination&&("spec"===e||"group"===e||"tag"===e)||"item"===this.options.pagination&&"section"!==e,s=this.getElementAt(i);if(this.scroll.isElementAbove(s)||t)break}i+=t}const s=this.flatItems[i];"none"===this.options.pagination||"section"===this.options.pagination?s&&s.active||this.activate(s,!0,!0,!1):s&&"section"===s.type&&(s.active||this.activate(s,!0,!0,!1))}}),(0,mobx_1.makeObservable)(this),this.items=e.contentItems,this.flatItems=(0,redoc_lib_1.flattenByProp)(this.items||[],"items"),this.flatItems.forEach(((e,t)=>e.absoluteIdx=t)),i.disableSidebar||this.subscribe(),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,i.pagination,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore,this.history))),this.renderItems=this.buildRenderItems(0),this.activeItemIdx=-1,this.activeRenderItemIdx=-1,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.subscribe(this.updateVersionOnHistory)}static updateOnHistory(e=HistoryService_1.history.currentId,t){e&&t.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,redoc_lib_1.escapeHTMLAttrChars)(e)}"]`)}subscribe(){this._unsubscribe=this.scroll.subscribe(this.updateOnScroll),this._hashUnsubscribe=this.history.subscribe(this.updateOnHistory)}toggleSidebar(){this.sideBarOpened=!this.sideBarOpened}closeSidebar(){this.sideBarOpened=!1}getElementAt(e){const t=this.flatItems[e];return t&&(0,redoc_lib_1.querySelector)(`[${constants_1.SECTION_ATTR}="${(0,redoc_lib_1.escapeHTMLAttrChars)(t.id)}"]`)||null}getElementAtOrFirstChild(e){let t=this.flatItems[e];return t&&"group"===t.type&&(t=t.items[0]),t&&(0,redoc_lib_1.querySelector)(`[${constants_1.SECTION_ATTR}="${(0,redoc_lib_1.escapeHTMLAttrChars)(t.id)}"]`)||null}get activeItem(){return this.flatItems[this.activeItemIdx]||void 0}updateItemsByVersionChange(e,t){if(!("versionsInfo"in this.definition))return;const i=this.activeItem&&this.activeItem.active?this.activeItem.absoluteIdx:-1;t=t&&withoutVersion(t)||this.activeItem&&this.activeItem.active&&withoutVersion(this.activeItem.id)||"",this.deactivate(this.activeItem),this.items=this.definition.contentItems,this.flatItems=(0,redoc_lib_1.flattenByProp)(this.items||[],"items"),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,this.options.pagination,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore,this.history)));const s=t?(this.flatItems.find((e=>withoutVersion(e.id)===t))||{absoluteIdx:-1}).absoluteIdx:-1;if(-1!==s&&"none"!==this.options.pagination||(this.renderItems=this.buildRenderItems(0)),this.activeItemIdx=-1,-1!==s)this.activate(this.flatItems[s],e);else if(-1!==i)this.activateAndScroll(this.flatItems[0],e);else if(e){const e=this.definition.versionsInfo[this.definition.activeVersionIdx];if(!this.history.currentId&&e.isDefault)return;this.history.replace(e.id)}}buildRenderItems(e){if("none"===this.options.pagination)return this.items;let t=this.flatItems[e];if(t||(t=this.flatItems[0]),"spec"===t.type)return this.buildRenderItems(e+1);if("section"===t.type){const e=[],i=getParentOfType(t,"tag");if("section"===this.options.pagination&&i)return[i];if("item"===this.options.pagination&&i)return[Object.assign(Object.assign({},i),{items:getLeadingSectionItems(i)})];const s=getParentSpecItem(t),o=(null==s?void 0:s.items)||this.items;for(let t=0;t<o.length&&"section"===o[t].type;t++)e.push(o[t]);return e}switch(this.options.pagination){case"section":if(("operation"===t.type||"schema"===t.type)&&t.parent)return[t.parent];if("group"!==t.type)return[t];case"item":return"operation"===t.type||"schema"===t.type?[t]:[Object.assign(Object.assign({},t),{items:getLeadingSectionItems(t)})];default:return[]}}activateBase(e,t=!0,i=!1,s){var o,n,r,a,l;if((null===(o=this.activeItem)||void 0===o?void 0:o.id)===(null==e?void 0:e.id)&&!s)return t&&e&&this.history.replace(encodeURI(e.id),i),void(e&&!e.active&&e.activate());if(e&&"group"===e.type)return;if(this.deactivate(this.activeItem),!e)return void this.history.replace("",i);if(e.depth<=redoc_lib_1.GROUP_DEPTH)return;this.activeItemIdx=e.absoluteIdx,t&&this.history.replace(encodeURI(e.id),i),e.activate(),e.expand();const c=new URLSearchParams(s),d="request"===c.get("t"),h="response"===c.get("t"),u=c.get("c"),p=c.get("ct"),f=c.get("in"),m=c.get("path"),v=(null==m?void 0:m.split(this.options.deepLinkSeparator))||[],b=e;if(f){let e=b.parameters;for(const t of v){const i=null==e?void 0:e.find((e=>e.name===t));null==i||i.expand(),e=null===(n=null==i?void 0:i.schema)||void 0===n?void 0:n.fields}}else if(d){const e=null===(r=b.requestBody)||void 0===r?void 0:r.content;null===(a=b.activateMimeName)||void 0===a||a.call(b,p||b.activeMimeName),setTimeout((()=>{var t;return this.activateField(v,null===(t=null==e?void 0:e.active)||void 0===t?void 0:t.schema)}),0)}else if(h){const e=b.responses.find((e=>e.code===u));(null==e?void 0:e.expanded)||null==e||e.expand(),null===(l=b.activateMimeName)||void 0===l||l.call(b,p||b.activeMimeName),setTimeout((()=>{var t,i;return this.activateField(v,null===(i=null===(t=null==e?void 0:e.content)||void 0===t?void 0:t.active)||void 0===i?void 0:i.schema)}),0)}}activate(e,t=!0,i=!1,s=!0,o){if("none"===this.options.pagination)return this.activateBase(e,t,i,o),void(!e&&this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0));if("group"!==(null==e?void 0:e.type)){if(e&&"item"===this.options.pagination&&"tag"===e.type&&!e.description){if(e.expanded)return void e.collapse();e.expand(),e=this.flatItems[e.absoluteIdx+1]}if(this.activateBase(e,e&&t,i,o),this.activeRenderItemIdx=e?e.absoluteIdx:this.activeRenderItemIdx,this.activeRenderItemIdx>=0){const e=this.buildRenderItems(this.activeRenderItemIdx);e.some(((e,t)=>e.id!==this.renderItems[t].id))&&(this.renderItems=e),this.renderItems[0]&&(this.activeRenderItemIdx=this.renderItems[0].absoluteIdx)}s&&setTimeout((()=>this.scrollToActive())),!e&&this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0)}}activateField(e,t){var i;for(let s=0;s<e.length-1;s++){const o=e[s],n=s===e.length-1;if((null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items),null==t?void 0:t.oneOf){const e=Number(o);if(isNaN(e))return;null==t||t.activateOneOf(e),t=null==t?void 0:t.oneOf[e];continue}(null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items);const r=null===(i=null==t?void 0:t.fields)||void 0===i?void 0:i.find((e=>e.name===o));n||null==r||r.expand(),t=null==r?void 0:r.schema}}deactivate(e){if(void 0!==e)for(e.deactivate();void 0!==e;)e.collapse(),e=e.parent}activateAndScroll(e,t,i,s=""){const[,o]=s.split(this.options.deepLinkPrefix),n=e&&this.getItemById(e.id)||e;this.activate(n,t,i,!1,o),this.scrollToActive(o?s:""),n&&n.items.length||this.closeSidebar()}scrollToActive(e){e?setTimeout((()=>this.scroll.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,redoc_lib_1.escapeHTMLAttrChars)(e)}"]`)),0):this.scroll.scrollIntoView(this.getElementAt(this.activeItemIdx))}dispose(){var e,t;null===(e=this._unsubscribe)||void 0===e||e.call(this),null===(t=this._hashUnsubscribe)||void 0===t||t.call(this)}}function withoutVersion(e){return e.split("/").slice(1).join("/")}function getParentSpecItem(e){for(;e;){if("spec"===e.type)return e;e=e.parent}}function getParentOfType(e,t){if(e&&e.parent)return e.parent.type===t?e.parent:getParentOfType(e.parent,t)}function getLeadingSectionItems(e){const t=[];for(const i of e.items){if("section"!==i.type)break;t.push(i)}return t}function normalizeItem(e,t,i,s,o){if(e.absoluteIdx=t,"none"!==i){const t=getParentOfType(e,"tag");if(e.parent&&t&&!("_id_normalized"in e)){if(s){const[i,s]=e.id.split("/"),o=withoutVersion(e.id);if("operation"===e.type&&!s.startsWith("operation"))return;e.id=i+"/"+withoutVersion(t.id)+"/"+o}else{if("operation"===e.type&&!e.id.startsWith("operation"))return;e.id=t.id+"/"+e.id}e._id_normalized=!0}}"group"!==e.type&&(e.href=o.linkForId(e.id))}__decorate([mobx_1.observable],ProMenu.prototype,"flatItems",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"items",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"activeRenderItemIdx",void 0),__decorate([mobx_1.observable.ref],ProMenu.prototype,"renderItems",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"activeItemIdx",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"sideBarOpened",void 0),__decorate([mobx_1.action],ProMenu.prototype,"toggleSidebar",null),__decorate([mobx_1.action],ProMenu.prototype,"closeSidebar",null),__decorate([mobx_1.action],ProMenu.prototype,"activateBase",null),__decorate([mobx_1.action],ProMenu.prototype,"activate",null),__decorate([mobx_1.action.bound],ProMenu.prototype,"activateAndScroll",null),exports.ProMenu=ProMenu;
+"use strict";var __decorate=this&&this.__decorate||function(e,t,i,s){var n,o=arguments.length,r=o<3?t:null===s?s=Object.getOwnPropertyDescriptor(t,i):s;if("object"==typeof Reflect&&"function"==typeof Reflect.decorate)r=Reflect.decorate(e,t,i,s);else for(var a=e.length-1;a>=0;a--)(n=e[a])&&(r=(o<3?n(r):o>3?n(t,i,r):n(t,i))||r);return o>3&&r&&Object.defineProperty(t,i,r),r};Object.defineProperty(exports,"__esModule",{value:!0}),exports.ProMenu=void 0;const mobx_1=require("mobx"),utils_1=require("../utils"),constants_1=require("../constants"),history_1=require("./history"),VersionedSpecStore_1=require("./VersionedSpecStore");class ProMenu{static updateOnHistory(e=history_1.history.currentId,t){e&&t.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(e)}"]`)}constructor(e,t,i,s){Object.defineProperty(this,"definition",{enumerable:!0,configurable:!0,writable:!0,value:e}),Object.defineProperty(this,"scroll",{enumerable:!0,configurable:!0,writable:!0,value:t}),Object.defineProperty(this,"options",{enumerable:!0,configurable:!0,writable:!0,value:i}),Object.defineProperty(this,"history",{enumerable:!0,configurable:!0,writable:!0,value:s}),Object.defineProperty(this,"flatItems",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"items",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"activeRenderItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"renderItems",{enumerable:!0,configurable:!0,writable:!0,value:[]}),Object.defineProperty(this,"activeItemIdx",{enumerable:!0,configurable:!0,writable:!0,value:-1}),Object.defineProperty(this,"sideBarOpened",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"_unsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"_hashUnsubscribe",{enumerable:!0,configurable:!0,writable:!0,value:void 0}),Object.defineProperty(this,"getItemById",{enumerable:!0,configurable:!0,writable:!0,value:e=>this.flatItems.find((t=>t.id===e))}),Object.defineProperty(this,"initOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i&&(this.activate(i,!1,!1,!1,e),i.active=!1)}}),Object.defineProperty(this,"updateOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:(e=this.history.currentId)=>{const[t]=e.split(this.options.deepLinkPrefix);if(!t)return;const i=this.flatItems.find((e=>e.id===t));i?this.activateAndScroll(i,!1,void 0,e):(this.scroll.prevOffsetY=0,this.scroll.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(t)}"]`))}}),Object.defineProperty(this,"updateVersionOnHistory",{enumerable:!0,configurable:!0,writable:!0,value:e=>{if(!("versionsInfo"in this.definition))return;const[t]=e.split("/");let i=this.definition.versionsInfo.findIndex((e=>e.id===t));i<0&&(i=this.definition.versionsInfo.findIndex((e=>e.isDefault))),this.definition.activeVersionIdx!==i&&(this.definition.changeVersion(i<0?0:i),this.updateItemsByVersionChange(!1,e))}}),Object.defineProperty(this,"updateOnScroll",{enumerable:!0,configurable:!0,writable:!0,value:e=>{const t=e?1:-1;let i=this.activeItemIdx;for(;(-1!==i||e)&&!(i>=this.flatItems.length-1&&e);){if(e){let e=!1;const t=this.flatItems[i+1];switch(this.options.pagination){case"section":e=t&&("spec"===t.type||"group"===t.type||"tag"===t.type);break;case"item":e="section"!==(null==t?void 0:t.type)}const s=this.getElementAt(i+1);if(-1===i&&"tag"===this.flatItems[0].type&&(e=!1),this.scroll.isElementBellow(s)||e)break}else{const e=this.flatItems[i]&&this.flatItems[i].type,t="section"===this.options.pagination&&("spec"===e||"group"===e||"tag"===e)||"item"===this.options.pagination&&"section"!==e,s=this.getElementAt(i);if(this.scroll.isElementAbove(s)||t)break}i+=t}const s=this.flatItems[i];"none"===this.options.pagination||"section"===this.options.pagination?s&&s.active||this.activate(s,!0,!0,!1):s&&"section"===s.type&&(s.active||this.activate(s,!0,!0,!1))}}),(0,mobx_1.makeObservable)(this),this.items=e.contentItems,this.flatItems=(0,utils_1.flattenByProp)(this.items||[],"items"),this.flatItems.forEach(((e,t)=>e.absoluteIdx=t)),i.disableSidebar||this.subscribe(),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,i.pagination,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore,this.history))),this.renderItems=this.buildRenderItems(0),this.activeItemIdx=-1,this.activeRenderItemIdx=-1,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.subscribe(this.updateVersionOnHistory)}subscribe(){this._unsubscribe=this.scroll.subscribe(this.updateOnScroll),this._hashUnsubscribe=this.history.subscribe(this.updateOnHistory)}toggleSidebar(){this.sideBarOpened=!this.sideBarOpened}closeSidebar(){this.sideBarOpened=!1}getElementAt(e){const t=this.flatItems[e];return t&&(0,utils_1.querySelector)(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(t.id)}"]`)||null}getElementAtOrFirstChild(e){let t=this.flatItems[e];return t&&"group"===t.type&&(t=t.items[0]),t&&(0,utils_1.querySelector)(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(t.id)}"]`)||null}get activeItem(){return this.flatItems[this.activeItemIdx]||void 0}updateItemsByVersionChange(e,t){if(!("versionsInfo"in this.definition))return;const i=this.activeItem&&this.activeItem.active?this.activeItem.absoluteIdx:-1;t=t&&withoutVersion(t)||this.activeItem&&this.activeItem.active&&withoutVersion(this.activeItem.id)||"",this.deactivate(this.activeItem),this.items=this.definition.contentItems,this.flatItems=(0,utils_1.flattenByProp)(this.items||[],"items"),this.flatItems.forEach(((e,t)=>normalizeItem(e,t,this.options.pagination,this.definition instanceof VersionedSpecStore_1.VersionedSpecStore,this.history)));const s=t?(this.flatItems.find((e=>withoutVersion(e.id)===t))||{absoluteIdx:-1}).absoluteIdx:-1;if(-1!==s&&"none"!==this.options.pagination||(this.renderItems=this.buildRenderItems(0)),this.activeItemIdx=-1,-1!==s)this.activate(this.flatItems[s],e);else if(-1!==i)this.activateAndScroll(this.flatItems[0],e);else if(e){const e=this.definition.versionsInfo[this.definition.activeVersionIdx];if(!this.history.currentId&&e.isDefault)return;this.history.replace(e.id)}}buildRenderItems(e){if("none"===this.options.pagination)return this.items;let t=this.flatItems[e];if(t||(t=this.flatItems[0]),"spec"===t.type)return this.buildRenderItems(e+1);if("section"===t.type){const e=[],i=getParentOfType(t,"tag");if("section"===this.options.pagination&&i)return[i];if("item"===this.options.pagination&&i)return[Object.assign(Object.assign({},i),{items:getLeadingSectionItems(i)})];const s=getParentSpecItem(t),n=(null==s?void 0:s.items)||this.items;for(let t=0;t<n.length&&"section"===n[t].type;t++)e.push(n[t]);return e}switch(this.options.pagination){case"section":if(("operation"===t.type||"schema"===t.type)&&t.parent)return[t.parent];if("group"!==t.type)return[t];case"item":return"operation"===t.type||"schema"===t.type?[t]:[Object.assign(Object.assign({},t),{items:getLeadingSectionItems(t)})];default:return[]}}activateBase(e,t=!0,i=!1,s){var n,o,r,a,l;if((null===(n=this.activeItem)||void 0===n?void 0:n.id)===(null==e?void 0:e.id)&&!s)return t&&e&&this.history.replace(encodeURI(e.id),i),void(e&&!e.active&&e.activate());if(e&&"group"===e.type)return;if(this.deactivate(this.activeItem),!e)return void this.history.replace("",i);if(e.depth<=constants_1.GROUP_DEPTH)return;this.activeItemIdx=e.absoluteIdx,t&&this.history.replace(encodeURI(e.id),i),e.activate(),e.expand();const c=new URLSearchParams(s),d="request"===c.get("t"),u="response"===c.get("t"),h=c.get("c"),p=c.get("ct"),f=c.get("in"),m=c.get("path"),v=(null==m?void 0:m.split(this.options.deepLinkSeparator))||[],b=e;if(f){let e=b.parameters;for(const t of v){const i=null==e?void 0:e.find((e=>e.name===t));null==i||i.expand(),e=null===(o=null==i?void 0:i.schema)||void 0===o?void 0:o.fields}}else if(d){const e=null===(r=b.requestBody)||void 0===r?void 0:r.content;null===(a=b.activateMimeName)||void 0===a||a.call(b,p||b.activeMimeName),setTimeout((()=>{var t;return this.activateField(v,null===(t=null==e?void 0:e.active)||void 0===t?void 0:t.schema)}),0)}else if(u){const e=b.responses.find((e=>e.code===h));(null==e?void 0:e.expanded)||null==e||e.expand(),null===(l=b.activateMimeName)||void 0===l||l.call(b,p||b.activeMimeName),setTimeout((()=>{var t,i;return this.activateField(v,null===(i=null===(t=null==e?void 0:e.content)||void 0===t?void 0:t.active)||void 0===i?void 0:i.schema)}),0)}}activate(e,t=!0,i=!1,s=!0,n){if("none"===this.options.pagination)return this.activateBase(e,t,i,n),void(!e&&this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0));if("group"!==(null==e?void 0:e.type)){if(e&&"item"===this.options.pagination&&"tag"===e.type&&!e.description){if(e.expanded)return void e.collapse();e.expand(),e=this.flatItems[e.absoluteIdx+1]}if(this.activateBase(e,e&&t,i,n),this.activeRenderItemIdx=e?e.absoluteIdx:this.activeRenderItemIdx,this.activeRenderItemIdx>=0){const e=this.buildRenderItems(this.activeRenderItemIdx);e.some(((e,t)=>e.id!==this.renderItems[t].id))&&(this.renderItems=e),this.renderItems[0]&&(this.activeRenderItemIdx=this.renderItems[0].absoluteIdx)}s&&setTimeout((()=>this.scrollToActive())),!e&&this.definition instanceof VersionedSpecStore_1.VersionedSpecStore&&this.history.replace(this.definition.currentVersionId,!0)}}activateField(e,t){var i;for(let s=0;s<e.length-1;s++){const n=e[s],o=s===e.length-1;if((null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items),null==t?void 0:t.oneOf){const e=Number(n);if(isNaN(e))return;null==t||t.activateOneOf(e),t=null==t?void 0:t.oneOf[e];continue}(null==t?void 0:t.hasType("array"))&&(null==t?void 0:t.items)&&(t=null==t?void 0:t.items);const r=null===(i=null==t?void 0:t.fields)||void 0===i?void 0:i.find((e=>e.name===n));o||null==r||r.expand(),t=null==r?void 0:r.schema}}deactivate(e){if(void 0!==e)for(e.deactivate();void 0!==e;)e.collapse(),e=e.parent}activateAndScroll(e,t,i,s=""){const[,n]=s.split(this.options.deepLinkPrefix),o=e&&this.getItemById(e.id)||e;this.activate(o,t,i,!1,n),this.scrollToActive(n?s:""),o&&o.items.length||this.closeSidebar()}scrollToActive(e){e?setTimeout((()=>this.scroll.scrollIntoViewBySelector(`[${constants_1.SECTION_ATTR}="${(0,utils_1.escapeHTMLAttrChars)(e)}"]`)),0):this.scroll.scrollIntoView(this.getElementAt(this.activeItemIdx))}dispose(){var e,t;null===(e=this._unsubscribe)||void 0===e||e.call(this),null===(t=this._hashUnsubscribe)||void 0===t||t.call(this)}}function withoutVersion(e){return e.split("/").slice(1).join("/")}function getParentSpecItem(e){for(;e;){if("spec"===e.type)return e;e=e.parent}}function getParentOfType(e,t){if(e&&e.parent)return e.parent.type===t?e.parent:getParentOfType(e.parent,t)}function getLeadingSectionItems(e){const t=[];for(const i of e.items){if("section"!==i.type)break;t.push(i)}return t}function normalizeItem(e,t,i,s,n){if(e.absoluteIdx=t,"none"!==i){const t=getParentOfType(e,"tag");if(e.parent&&t&&!("_id_normalized"in e)){if(s){const[i,s]=e.id.split("/"),n=withoutVersion(e.id);if("operation"===e.type&&!s.startsWith("operation"))return;e.id=i+"/"+withoutVersion(t.id)+"/"+n}else{if("operation"===e.type&&!e.id.startsWith("operation"))return;e.id=t.id+"/"+e.id}e._id_normalized=!0}}"group"!==e.type&&(e.href=n.linkForId(e.id))}__decorate([mobx_1.observable],ProMenu.prototype,"flatItems",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"items",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"activeRenderItemIdx",void 0),__decorate([mobx_1.observable.ref],ProMenu.prototype,"renderItems",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"activeItemIdx",void 0),__decorate([mobx_1.observable],ProMenu.prototype,"sideBarOpened",void 0),__decorate([mobx_1.action],ProMenu.prototype,"toggleSidebar",null),__decorate([mobx_1.action],ProMenu.prototype,"closeSidebar",null),__decorate([mobx_1.action],ProMenu.prototype,"activateBase",null),__decorate([mobx_1.action],ProMenu.prototype,"activate",null),__decorate([mobx_1.action.bound],ProMenu.prototype,"activateAndScroll",null),exports.ProMenu=ProMenu;
 //# sourceMappingURL=ProMenu.js.map

package/lib/services/ProStore.d.ts

@@ -1,77 +1,15 @@
 import type { IValueDidChange } from 'mobx';
-import type { ContentItemModel, IMenuItem, OperationModel, RedocRawOptions, SearchStore, OpenAPIExternalDocumentation, OpenAPIDefinition, MediaQueries } from '../redoc-lib';
-import type { SearchResultMeta } from './SearchStore';
+import type { IMenuItem } from '../services';
 import type { LicenseInfo } from './check';
-import type { CodeSamplesConfig, Languages } from './code-samples/';
 import type { SpecVersions } from './VersionedSpecStore';
-import type { ExternalLink, MarkdownItemsPagination, Normalized, Pagination } from './types';
-import type { Events } from '../events';
-import { MarkerService } from '../redoc-lib/src/services/MarkerService';
-import { RedocNormalizedOptions } from '../redoc-lib/src/services/RedocNormalizedOptions';
-import { SpecStore } from '../redoc-lib/src/services/SpecStore';
-import { ProMenu } from './ProMenu';
+import type { OpenAPIDefinition, OpenAPIExternalDocumentation } from '../types';
+import type { OperationModel, ContentItemModel } from '../models';
+import type { Options, RawOptions } from './Options/types';
+import type { SearchResultMeta, SearchStore } from './search';
 import { VersionedSpecStore } from './VersionedSpecStore';
-import { LayoutVariant } from './store-types';
-import { SideNavStyle } from './types';
-export declare type RedocProUserOptionsExt = {
-    breakpoints?: Omit<MediaQueries, 'print'>;
-    showAtBreakpoint?: {
-        sidebar?: keyof Omit<MediaQueries, 'print'>;
-        samplesPanel?: keyof Omit<MediaQueries, 'print'>;
-    };
-    licenseKey?: string;
-    searchMode?: 'default' | 'path-only';
-    searchOperationTitleBoost?: number | string;
-    searchTagTitleBoost?: number | string;
-    searchFieldLevelBoost?: number | string;
-    searchAutoExpand?: boolean;
-    sideNavStyle?: SideNavStyle;
-    /** @deprecated use hideTryItPanel instead */
-    showConsole?: boolean;
-    hideTryItPanel?: boolean;
-    hideLogo?: boolean;
-    whiteLabel?: boolean;
-    disableErrorBoundary?: boolean;
-    hideInfoSection?: boolean;
-    pagination?: Pagination;
-    showNextButton?: boolean;
-    disableSidebar?: boolean;
-    skipBundleAndConvert?: boolean;
-    /** @deprecated */
-    routingStrategy?: 'hash' | 'browser';
-    routingBasePath?: string;
-    downloadDefinitionUrl?: string;
-    ctrlFHijack?: boolean;
-    unstable_externalDescription?: string;
-    linkForId?: ((id: string) => string) | null;
-    generateDeepLink?: ((fieldFragment: string, operationLink: any) => string) | undefined | null;
-    onDeepLinkClick?: ((link: string) => void) | undefined | null;
-    requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
-    oAuth2RedirectURI?: string | null;
-    corsProxyUrl?: string | null;
-    authCorsProxyUrl?: string | null;
-    disablePaginationLoadingAnimation?: boolean | null;
-    generateCodeSamples?: CodeSamplesConfig;
-    showRightPanelToggle?: boolean;
-    showChangeLayoutButton?: boolean;
-    layout?: LayoutVariant;
-    defaultSampleLanguage?: Languages | string;
-    hideRightPanel?: boolean;
-    events?: Events;
-    deepLinkSeparator?: string;
-    deepLinkPrefix?: string;
-    disableDeepLinks?: boolean;
-    sidebarLinks?: {
-        beforeInfo?: Array<ExternalLink>;
-        end?: Array<ExternalLink>;
-    };
-    searchMaxDepth?: number;
-};
-declare type RedocProOptionsInternalExt = Omit<RedocProUserOptionsExt, 'hideTryItPanel'> & {
-    markdownItemsPagination?: MarkdownItemsPagination;
-};
-export declare type RedocProRawOptions = RedocRawOptions & RedocProUserOptionsExt;
-export declare type RedocProNormalizedOptions = RedocNormalizedOptions & Normalized<RedocProOptionsInternalExt>;
+import { SpecStore, MarkerService } from '../services';
+import { LayoutVariant } from '../constants';
+import { ProMenu } from './ProMenu';
 export interface ProStoreState {
     menu: {
         activeItemIdx: number;
@@ -83,7 +21,7 @@ export interface ProStoreState {
     };
     searchIndex?: number;
     tryItOperationId?: string;
-    options: RedocProRawOptions;
+    options: RawOptions;
     searchIndexPath?: string;
     searchIndexExport?: string;
 }
@@ -101,6 +39,8 @@ export declare class NestingGroup implements IMenuItem {
     expanded: boolean;
     depth: number;
     level: number;
+    httpVerb?: string;
+    path?: string;
     constructor(id: string, items: ContentItemModel[], name?: string, linkable?: boolean);
     activate(): void;
     expand(): void;
@@ -108,8 +48,8 @@ export declare class NestingGroup implements IMenuItem {
     deactivate(): void;
 }
 export declare class ProStore {
-    rawOptions: RedocProRawOptions;
-    options: RedocProNormalizedOptions;
+    rawOptions: RawOptions;
+    options: Options;
     menu: ProMenu;
     definition: SpecStore | VersionedSpecStore;
     marker: MarkerService;
@@ -125,9 +65,9 @@ export declare class ProStore {
     constructor(spec: OpenAPIDefinition | SpecVersions | Array<{
         title: string;
         url: string;
-    }> | string, specUrl?: string, options?: RedocProRawOptions, createIndex?: boolean);
-    initProOptions(options: RedocProRawOptions): void;
-    initSearch(options: RedocProNormalizedOptions, createIndex: boolean): void;
+    }> | string, specUrl?: string, options?: RawOptions, createIndex?: boolean);
+    initProOptions(options: RawOptions): void;
+    initSearch(options: Options, createIndex: boolean): void;
     onDidMount(): void;
     toggleRightPanel(value?: boolean): void;
     toggleLayout(layout?: LayoutVariant): void;
@@ -150,4 +90,3 @@ export declare class ProStore {
     dispose(): void;
     private updateMarkOnMenu;
 }
-export {};