@redocly/openapi-docs 3.0.0-alpha.14.beta.2 → 3.0.0-alpha.15

package/lib-esm/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;
@@ -105,9 +103,6 @@ export interface SecurityPanelHookProps {
     OAuth2: OAuth2;
 }
 export type AuthPanelHookProps = SecurityPanelHookProps;
-export type BeforeSecurityPanelHookProps = Omit<SecurityPanelHookProps, 'OAuth2'> & {
-    value: unknown;
-};
 export interface HookRawHtml {
     html: string;
 }
@@ -115,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;
@@ -129,10 +124,9 @@ export interface HooksConfig {
     AfterOperation?: HookConfig<{
         operation: OperationModel;
     }>;
-    BeforeSecurityPanel?: HookConfig<BeforeSecurityPanelHookProps>;
     ReplaceTryItSecurityPanel?: HookConfig<SecurityPanelHookProps>;
     onInit?: (args: {
-        store: ProStore;
+        store: GenericObject;
     }) => void;
     replaceSecurityLink?: (args: {
         securityRequirementId: string;
@@ -141,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-esm/services/types.js

@@ -1,2 +1,2 @@
-export var SideNavStyle;!function(t){t.SummaryOnly="summary-only",t.PathFirst="path-first",t.IdOnly="id-only"}(SideNavStyle||(SideNavStyle={}));
+export var SideNavStyle;!function(n){n.SummaryOnly="summary-only",n.PathFirst="path-first",n.IdOnly="id-only"}(SideNavStyle||(SideNavStyle={}));export var Pagination;!function(n){n.None="none",n.Section="section",n.Item="item"}(Pagination||(Pagination={}));
 //# sourceMappingURL=types.js.map

package/lib-esm/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-esm/services/utils.js

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

package/lib-esm/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-esm/standalone.js

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

package/lib-esm/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-esm/testProviders.js

@@ -1,2 +1,2 @@
-import React,{Children}from"react";import{ThemeProvider}from"styled-components";import{ProProviders}from"./components";import{defaultTheme}from"./constants";import{generateMediaQueries}from"./utils";export function withTestProviders(e,r){return React.createElement(ProProviders,{store:r},Children.only(e))}export function withTheme(e){const r={mediaQueries:generateMediaQueries(defaultTheme.breakpoints),showAtBreakpoint:defaultTheme.showAtBreakpoint};return React.createElement(ThemeProvider,{theme:r},e)}
+import React,{Children}from"react";import{ThemeProvider}from"styled-components";import{defaultTheme}from"./constants";import{generateMediaQueries}from"./utils";import{StoreProvider}from"./components";export function withTestProviders(e,t){return React.createElement(StoreProvider,Object.assign({},t||{definition:{openapi:"3.0.0"}}),Children.only(e))}export function withTheme(e){const t={mediaQueries:generateMediaQueries(defaultTheme.breakpoints),showAtBreakpoint:defaultTheme.showAtBreakpoint};return React.createElement(ThemeProvider,{theme:t},e)}
 //# sourceMappingURL=testProviders.js.map

package/lib-esm/types/app.d.ts

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

package/lib-esm/types/app.js

@@ -0,0 +1,2 @@
+export{};
+//# sourceMappingURL=app.js.map

package/lib-esm/types/index.d.ts

@@ -1,4 +1,4 @@
 export * from './open-api';
 export * from './server';
 export * from './security';
-export type { SecurityPanelHookProps } from '../services/types';
+export * from './app';

package/lib-esm/types/index.js

@@ -1,2 +1,2 @@
-export*from"./open-api";export*from"./server";export*from"./security";
+export*from"./open-api";export*from"./server";export*from"./security";export*from"./app";
 //# sourceMappingURL=index.js.map

package/lib-esm/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-esm/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-esm/utils/compose.js

@@ -0,0 +1,2 @@
+export const compose=(e,...o)=>o.reduce(((e,o)=>c=>e(o(c))),e);
+//# sourceMappingURL=compose.js.map

package/lib-esm/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-esm/utils/helpers.js

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

package/lib-esm/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-esm/utils/index.js

@@ -1,2 +1,2 @@
-export*from"./JsonPointer";export*from"./openapi";export*from"./helpers";export*from"./highlight";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";export*from"./theme-helpers";export*from"./debounce";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"./JsonPointer";export*from"./openapi";export*from"./helpers";export*from"./highlight";export*from"./loadAndBundleSpec";export*from"./dom";export*from"./decorators";export*from"./debug";export*from"./sort";export*from"./argValuesHelpers";export*from"./media-css";export*from"./theme-helpers";export*from"./debounce";export*from"./security-details";export*from"./session-storage";export*from"./local-storage";export*from"./parameters";export*from"./string";export*from"./test-utils";export*from"./typeGuards";export*from"./compose";export*from"./saveTextBeforeHeading";
 //# sourceMappingURL=index.js.map

package/lib-esm/utils/local-storage.js

@@ -1,2 +1,2 @@
-import{IS_BROWSER}from"./dom";export function toLocalStorage(o,t){window.localStorage.setItem("redoc."+o,t)}export function fromLocalStorage(o){return IS_BROWSER&&window.localStorage.getItem("redoc."+o)||""}
+import{IS_BROWSER}from"./dom";export function toLocalStorage(o,t){IS_BROWSER&&window.localStorage.setItem("redoc."+o,t)}export function fromLocalStorage(o){return IS_BROWSER&&window.localStorage.getItem("redoc."+o)||""}
 //# sourceMappingURL=local-storage.js.map

package/lib-esm/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;

package/lib-esm/utils/openapi.js

@@ -1,2 +1,2 @@
-import{dirname}from"path";import UrlTemplate from"url-template";import{IS_BROWSER}from"./dom";import{deleteEmptyArrayItem,isArrayOfObjects,isNumeric,removeQueryStringAndHash,resolveUrl}from"./helpers";import{MediaTypes}from"../constants";function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}export function isStatusCode(e){return"default"===e||isNumeric(e)||isWildcardStatusCode(e)}export function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};export function isOperationName(e){return e in operationNames}export function getOperationSummary(e){return e.summary||e.operationId||e.description&&e.description.substring(0,50)||e.pathName||"<no summary>"}const schemaKeywordTypes={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",patternProperties:"object",properties:"object"};export function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}export function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties&&void 0===e.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}export function isJsonLike(e){return-1!==e.search(/json/i)}export function isFormUrlEncoded(e){return e===MediaTypes.URL_ENCODED}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${r}${t}${e[r]}`)).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((t=>e[t]?`${r}[${t}]=${e[t]}`:void 0)).filter(Boolean).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function serializeFormValue(e,r,t){const i="__redoc_param_name__",n=r?"*":"";return UrlTemplate.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=UrlTemplate.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}export function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:o=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,o,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let o="";"label"===r?o=".":"matrix"===r&&(o=";");const a="__redoc_param_name__";return UrlTemplate.parse(`{${o}${a}${n}}`).expand({[a]:i}).replace(/__redoc_param_name__/g,e)}export function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("%20")}`:(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("|")}`:(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return isArrayOfObjects(i)&&(i=deleteEmptyArrayItem(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(console.warn("Unexpected style for header: "+e),"")}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}export function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}export function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:o}=e;if(o)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,o);case"cookie":case"query":return`${t}=${serializeParameterValueWithMime(r,o)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn(`Missing style attribute or content for parameter ${t}`),"";switch(e.in){case"path":return serializePathParameter(t,i,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}export function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;export function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}export function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0===e)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let i;return void 0!==r&&void 0!==t?i=r===t?`= ${r} ${e}`:`[ ${r} .. ${t} ] ${e}`:void 0!==t?i=`<= ${t} ${e}`:void 0!==r&&(i=1===r?"non-empty":`>= ${r} ${e}`),i}export function humanizeNumberRange(e){var r,t;const i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,o="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,a="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${o?"( ":"[ "}${i} .. ${n}${a?" )":" ]"}`:void 0!==n?`${a?"< ":"<= "}${n}`:void 0!==i?`${o?"> ":">= "}${i}`:void 0}export function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint("properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const o=humanizeMultipleOfConstraint(e.multipleOf);void 0!==o&&r.push(o);const a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}export function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}export function sortByField(e,r){return[...e].sort(((e,t)=>e[r].localeCompare(t[r])))}export function mergeParams(e,r=[],t=[]){const i={};return t.forEach((r=>{({resolved:r}=e.deref(r)),i[r.name+"_"+r.in]=!0})),(r=r.filter((r=>(({resolved:r}=e.deref(r)),!i[r.name+"_"+r.in])))).concat(t)}export function mergeSimilarMediaTypes(e){const r={};return Object.keys(e).forEach((t=>{const i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=Object.assign(Object.assign({},r[n]),i):r[n]=i})),r}export function expandDefaultServerVariables(e,r={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,t)=>r[t]&&r[t].default||e))}export function normalizeServers(e,r){const t=void 0===e?removeQueryStringAndHash((()=>{if(!IS_BROWSER)return"";const e=window.location.href;return e.endsWith(".html")?dirname(e):e})()):dirname(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,resolveUrl(t,r)),description:e.description||""});var r}))}export const SECURITY_DEFINITIONS_COMPONENT_NAME="security-definitions";export const SECURITY_DEFINITIONS_JSX_NAME="SecurityDefinitions";export const SCHEMA_DEFINITION_JSX_NAME="SchemaDefinition";export const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);export function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-hideTryItPanel":!0,"x-tokenEndpointAuthMethod":!0}}export function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}export function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}export function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}
+import{dirname}from"path";import UrlTemplate from"url-template";import{IS_BROWSER}from"./dom";import{deleteEmptyArrayItem,isArrayOfObjects,isNumeric,removeQueryStringAndHash,resolveUrl,sanitizeItemId,normalizeText}from"./helpers";import{MediaTypes}from"../constants";import{JsonPointer}from"./JsonPointer";function isWildcardStatusCode(e){return"string"==typeof e&&/\dxx/i.test(e)}export function isStatusCode(e){return"default"===e||isNumeric(e)||isWildcardStatusCode(e)}export function getStatusCodeType(e,r=!1){if("default"===e)return r?"error":"success";let t="string"==typeof e?parseInt(e,10):e;if(isWildcardStatusCode(e)&&(t*=100),t<100||t>599)throw new Error("invalid HTTP code");let i="success";return t>=300&&t<400?i="redirect":t>=400?i="error":t<200&&(i="info"),i}const operationNames={get:!0,post:!0,put:!0,head:!0,patch:!0,delete:!0,options:!0,$ref:!0};export function isOperationName(e){return e in operationNames}export function getOperationName({operationId:e,description:r,summary:t,pathName:i}){const n=normalizeText(r);return normalizeText(t)||e||n&&n.substring(0,50)||i||"<no summary>"}export function getOperationId(e,r){return sanitizeItemId(void 0!==e.operationId?"operation/"+e.operationId:void 0!==r?r.id+e.pointer:e.pointer)}const schemaKeywordTypes={multipleOf:"number",maximum:"number",exclusiveMaximum:"number",minimum:"number",exclusiveMinimum:"number",maxLength:"string",minLength:"string",pattern:"string",contentEncoding:"string",contentMediaType:"string",items:"array",maxItems:"array",minItems:"array",uniqueItems:"array",maxProperties:"object",minProperties:"object",required:"object",additionalProperties:"object",unevaluatedProperties:"object",patternProperties:"object",properties:"object"};export function detectType(e){if(void 0!==e.type&&!Array.isArray(e.type))return e.type;const r=Object.keys(schemaKeywordTypes);for(const t of r){const r=schemaKeywordTypes[t];if(void 0!==e[t])return r}return"any"}export function isPrimitiveType(e,r=e.type){if(e["x-circular-ref"])return!0;if(void 0!==e.oneOf||void 0!==e.anyOf)return!1;if(e.if&&e.then||e.if&&e.else)return!1;let t=!0;const i=Array.isArray(r);return("object"===r||i&&(null==r?void 0:r.includes("object")))&&(t=void 0!==e.properties?0===Object.keys(e.properties).length:void 0===e.additionalProperties&&void 0===e.unevaluatedProperties&&void 0===e.patternProperties),!Array.isArray(e.items)&&!Array.isArray(e.prefixItems)&&(void 0!==e.items&&"boolean"!=typeof e.items&&("array"===r||i&&(null==r?void 0:r.includes("array")))&&(t=isPrimitiveType(e.items,e.items.type)),t)}export function isJsonLike(e){return-1!==e.search(/json/i)}export function isFormUrlEncoded(e){return e===MediaTypes.URL_ENCODED}function delimitedEncodeField(e,r,t){return Array.isArray(e)?e.map((e=>e.toString())).join(t):"object"==typeof e?Object.keys(e).map((r=>`${r}${t}${e[r]}`)).join(t):r+"="+e.toString()}function deepObjectEncodeField(e,r){return Array.isArray(e)?(console.warn("deepObject style cannot be used with array value:"+e.toString()),""):"object"==typeof e?Object.keys(e).map((t=>e[t]?`${r}[${t}]=${e[t]}`:void 0)).filter(Boolean).join("&"):(console.warn("deepObject style cannot be used with non-object value:"+e.toString()),"")}function serializeFormValue(e,r,t){const i="__redoc_param_name__",n=r?"*":"";return UrlTemplate.parse(`{?${i}${n}}`).expand({[i]:t}).substring(1).replace(/__redoc_param_name__/g,e)}function serializeSimpleValue(e,r){const t=e?"*":"",i="__redoc_param_name__",n=UrlTemplate.parse(`{${i}${t}}`);return decodeURIComponent(n.expand({[i]:r}))}export function urlFormEncodePayload(e,r={}){if(Array.isArray(e))throw new Error("Payload must have fields: "+e.toString());return Object.keys(e).map((t=>{const i=e[t],{style:n="form",explode:o=!0}=r[t]||{};switch(n){case"form":return serializeFormValue(t,o,i);case"spaceDelimited":return delimitedEncodeField(i,t,"%20");case"pipeDelimited":return delimitedEncodeField(i,t,"|");case"deepObject":return deepObjectEncodeField(i,t);default:return console.warn("Incorrect or unsupported encoding style: "+n),""}})).join("&")}function serializePathParameter(e,r,t,i){const n=t?"*":"";let o="";"label"===r?o=".":"matrix"===r&&(o=";");const a="__redoc_param_name__";return UrlTemplate.parse(`{${o}${a}${n}}`).expand({[a]:i}).replace(/__redoc_param_name__/g,e)}export function serializeQueryParameter(e,r,t,i){const n=n=>{switch(r){case"form":return serializeFormValue(e,t,n);case"spaceDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("%20")}`:(console.warn("The style spaceDelimited is only applicable to arrays"),"");case"pipeDelimited":return Array.isArray(n)?t?serializeFormValue(e,t,n):`${e}=${n.join("|")}`:(console.warn("The style pipeDelimited is only applicable to arrays"),"");case"deepObject":return!t||Array.isArray(n)||"object"!=typeof n?(console.warn("The style deepObject is only applicable for objects with explode=true"),""):deepObjectEncodeField(n,e);case"simple":return serializeSimpleValue(t,i);default:return console.warn("Unexpected style for query: "+r),""}};return isArrayOfObjects(i)&&(i=deleteEmptyArrayItem(i).map((e=>n(e)))),n(i)}function serializeHeaderParameter(e,r,t){return"simple"===e?serializeSimpleValue(r,t):(console.warn("Unexpected style for header: "+e),"")}function serializeCookieParameter(e,r,t,i){return"form"===r?serializeFormValue(e,t,i):(console.warn("Unexpected style for cookie: "+r),"")}export function serializeParameterValueWithMime(e,r){return isJsonLike(r)?JSON.stringify(e):(console.warn(`Parameter serialization as ${r} is not supported`),"")}export function serializeParameterValue(e,r){const{name:t,style:i,explode:n=!1,serializationMime:o}=e;if(o)switch(e.in){case"path":case"header":return serializeParameterValueWithMime(r,o);case"cookie":case"query":return`${t}=${serializeParameterValueWithMime(r,o)}`;default:return console.warn("Unexpected parameter location: "+e.in),""}if(!i)return console.warn(`Missing style attribute or content for parameter ${t}`),"";switch(e.in){case"path":return serializePathParameter(t,i,n,r);case"query":return serializeQueryParameter(t,i,n,r);case"header":return serializeHeaderParameter(i,n,r);case"cookie":return serializeCookieParameter(t,i,n,r);default:return console.warn("Unexpected parameter location: "+e.in),""}}export function langFromMime(e){return-1!==e.search(/xml/i)?"xml":"clike"}const DEFINITION_NAME_REGEX=/^#\/components\/(schemas|pathItems)\/([^/]+)$/;export function isNamedDefinition(e){return DEFINITION_NAME_REGEX.test(e||"")}export function getDefinitionName(e){var r;return null===(r=null==e?void 0:e.match(DEFINITION_NAME_REGEX))||void 0===r?void 0:r.pop()}function humanizeMultipleOfConstraint(e){if(void 0===e)return;const r=e.toString(10);return/^0\.0*1$/.test(r)?`decimal places <= ${r.split(".")[1].length}`:`multiple of ${r}`}function humanizeRangeConstraint(e,r,t){let i;return void 0!==r&&void 0!==t?i=r===t?`= ${r} ${e}`:`[ ${r} .. ${t} ] ${e}`:void 0!==t?i=`<= ${t} ${e}`:void 0!==r&&(i=1===r?"non-empty":`>= ${r} ${e}`),i}export function humanizeNumberRange(e){var r,t;const i="number"==typeof e.exclusiveMinimum?Math.min(e.exclusiveMinimum,null!==(r=e.minimum)&&void 0!==r?r:1/0):e.minimum,n="number"==typeof e.exclusiveMaximum?Math.max(e.exclusiveMaximum,null!==(t=e.maximum)&&void 0!==t?t:-1/0):e.maximum,o="number"==typeof e.exclusiveMinimum||e.exclusiveMinimum,a="number"==typeof e.exclusiveMaximum||e.exclusiveMaximum;return void 0!==i&&void 0!==n?`${o?"( ":"[ "}${i} .. ${n}${a?" )":" ]"}`:void 0!==n?`${a?"< ":"<= "}${n}`:void 0!==i?`${o?"> ":">= "}${i}`:void 0}export function humanizeConstraints(e){const r=[],t=humanizeRangeConstraint("characters",e.minLength,e.maxLength);void 0!==t&&r.push(t);const i=humanizeRangeConstraint("items",e.minItems,e.maxItems);void 0!==i&&r.push(i);const n=humanizeRangeConstraint("properties",e.minProperties,e.maxProperties);void 0!==n&&r.push(n);const o=humanizeMultipleOfConstraint(e.multipleOf);void 0!==o&&r.push(o);const a=humanizeNumberRange(e);return void 0!==a&&r.push(a),e.uniqueItems&&r.push("unique"),r}export function sortByRequired(e,r=[]){const t=[],i=[],n=[];return e.forEach((e=>{e.required?r.includes(e.name)?i.push(e):n.push(e):t.push(e)})),i.sort(((e,t)=>r.indexOf(e.name)-r.indexOf(t.name))),[...i,...n,...t]}export function sortByField(e,r){return[...e].sort(((e,t)=>e[r].localeCompare(t[r])))}export function mergeParams(e,r=[],t=[],{pathPointer:i,operationPointer:n}){const o={};t.forEach((r=>{({resolved:r}=e.deref(r)),o[r.name+"_"+r.in]=!0}));return[...r.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer.join(i,["parameters",String(r)])}))).filter((({paramOrRef:r})=>(({resolved:r}=e.deref(r)),!o[r.name+"_"+r.in]))),...t.map(((e,r)=>({paramOrRef:e,pointer:JsonPointer.join(n,["parameters",String(r)])})))]}export function mergeSimilarMediaTypes(e){const r={};return Object.keys(e).forEach((t=>{const i=e[t],n=t.split(";")[0].trim();r[n]?r[n]=Object.assign(Object.assign({},r[n]),i):r[n]=i})),r}export function expandDefaultServerVariables(e,r={}){return e.replace(/(?:{)([\w-.]+)(?:})/g,((e,t)=>r[t]&&r[t].default||e))}export function normalizeServers(e,r){const t=void 0===e?removeQueryStringAndHash((()=>{if(!IS_BROWSER)return"";const e=window.location.href;return e.endsWith(".html")?dirname(e):e})()):dirname(e);return 0===r.length&&(r=[{url:"/"}]),r.map((e=>{return Object.assign(Object.assign({},e),{url:(r=e.url,resolveUrl(t,r)),description:e.description||""});var r}))}export const shortenHTTPVerb=e=>({delete:"del",options:"opts"}[e]||e);export function isRedocExtension(e){return e in{"x-circular-ref":!0,"x-parentRefs":!0,"x-refsStack":!0,"x-code-samples":!0,"x-codeSamples":!0,"x-displayName":!0,"x-examples":!0,"x-ignoredHeaderParameters":!0,"x-logo":!0,"x-nullable":!0,"x-servers":!0,"x-tagGroups":!0,"x-traitTag":!0,"x-additionalPropertiesName":!0,"x-explicitMappingOnly":!0,"x-enumDescriptions":!0,"x-hideTryItPanel":!0,"x-tokenEndpointAuthMethod":!0}}export function extractExtensions(e,r){return Object.keys(e).filter((e=>!0===r?e.startsWith("x-")&&!isRedocExtension(e):e.startsWith("x-")&&r.indexOf(e)>-1)).reduce(((r,t)=>(r[t]=e[t],r)),{})}export function pluralizeType(e){return e.split(" or ").map((e=>e.replace(/^(string|object|number|integer|array|boolean)s?( ?.*)/,"$1s$2"))).join(" or ")}export function getContentWithLegacyExamples(e){let r=e.content;const t=e["x-examples"],i=e["x-example"];if(t){r=Object.assign({},r);for(const e of Object.keys(t)){const i=t[e];r[e]=Object.assign(Object.assign({},r[e]),{examples:i})}}else if(i){r=Object.assign({},r);for(const e of Object.keys(i)){const t=i[e];r[e]=Object.assign(Object.assign({},r[e]),{example:t})}}return r}
 //# sourceMappingURL=openapi.js.map

package/lib-esm/utils/saveTextBeforeHeading.d.ts

@@ -0,0 +1 @@
+export declare function saveTextBeforeHeading(description: string | GenericObject, markdownHeadingsAnchorLevel: number): any;

package/lib-esm/utils/saveTextBeforeHeading.js

@@ -0,0 +1,2 @@
+import{Ast}from"@markdoc/markdoc";import{isString}from"./typeGuards";import{deepClone}from"../services/utils";export function saveTextBeforeHeading(e,r){if(!isString(e)&&(null==e?void 0:e.result)){const i=deepClone(e),n=Ast.fromJSON(null==i?void 0:i.result);if(Array.isArray(n))for(const e of n)modifyNodeByHeading(e,r);else modifyNodeByHeading(n,r);return i.result=JSON.stringify(n),i.raw=saveTextBeforeHeading(i.raw,r),i}const i=new RegExp(`^#{1,${r}}?\\s+`,"m"),n=e.search(i);return n>-1?e.substring(0,n):e}function modifyNodeByHeading(e,r){const i=e.children.findIndex((e=>"heading"===e.type&&e.attributes.level<=r));return-1===i||(e.children=e.children.slice(0,i)),e}
+//# sourceMappingURL=saveTextBeforeHeading.js.map

package/lib-esm/utils/typeGuards.d.ts

@@ -0,0 +1,3 @@
+export declare function isUndefined<T>(value: T | undefined): value is undefined;
+export declare function isNull<T>(value: T | null): value is null;
+export declare function isString<T>(value: T | string): value is string;