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

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

@@ -1,9 +1,11 @@
+import type React from 'react';
+import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
 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 { ExternalLink, HooksConfig, MarkdownItemsPagination, Pagination, SideNavStyle, Unstable_ExternalCodeSample, PaginationType } from '../types';
 import type { Events } from '../../events';
 import type { MediaQueries } from '@redocly/theme';
-import type { OperationModel } from 'src/models/Operation';
+import type { OperationModel } from '../../models/types';
 import type { LabelsConfigRaw } from '../labels/types';
 export declare enum SearchMode {
     Default = "default",
@@ -89,8 +91,6 @@ export interface RawOptions {
     showRightPanelToggle?: boolean;
     layout?: LayoutVariant;
     defaultSampleLanguage?: Languages | string;
-    deepLinkSeparator?: string;
-    deepLinkPrefix?: string;
     disableDeepLinks?: boolean;
     sideNavStyle?: SideNavStyle;
     whiteLabel?: boolean;
@@ -100,17 +100,14 @@ export interface RawOptions {
     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;
+    pagination?: PaginationType;
     showNextButton?: boolean;
-    routingStrategy?: 'hash' | 'browser';
     markdownItemsPagination?: MarkdownItemsPagination;
     disableSidebar?: boolean;
     skipBundleAndConvert?: boolean;
@@ -125,7 +122,15 @@ export interface RawOptions {
     mediaQueries?: MediaQueries;
     ignoreNamedSchemas?: string[] | string;
     breakpoints?: Omit<MediaQueries, 'print'>;
-    allowedMdComponents?: Record<string, MDXComponentMeta>;
+    allowedMdComponents?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, React.ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+    enableRouter?: boolean;
 }
 export interface DefaultOptions {
     mediaQueries?: MediaQueries;
@@ -135,7 +140,14 @@ export interface DefaultOptions {
         sidebar?: keyof Omit<MediaQueries, 'print'>;
         samplesPanel?: keyof Omit<MediaQueries, 'print'>;
     };
-    allowedMdComponents?: Record<string, MDXComponentMeta>;
+    allowedMdComponents?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, React.ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
 }
 export interface Options {
     showAtBreakpoint: {
@@ -158,7 +170,7 @@ export interface Options {
     pathInMiddlePanel: boolean;
     untrustedDefinition: boolean;
     hideLoading: boolean;
-    hideDownloadButton: boolean;
+    hideDownloadButton: boolean | null;
     downloadDefinitionUrl?: string;
     disableSearch: boolean;
     searchAutoExpand: boolean;
@@ -192,7 +204,14 @@ export interface Options {
         position: 'first' | 'last' | 'replace' | 'off';
         description: string;
     };
-    allowedMdComponents: Record<string, MDXComponentMeta>;
+    allowedMdComponents?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, React.ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
     labels?: LabelsConfigRaw;
     enumSkipQuotes: boolean;
     expandDefaultServerVariables: boolean;
@@ -221,8 +240,6 @@ export interface Options {
     showRightPanelToggle: boolean;
     layout: LayoutVariant;
     defaultSampleLanguage: Languages | string;
-    deepLinkSeparator: string;
-    deepLinkPrefix: string;
     disableDeepLinks: boolean;
     sideNavStyle: SideNavStyle;
     whiteLabel: boolean;
@@ -232,8 +249,6 @@ export interface Options {
     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?: {
@@ -242,7 +257,6 @@ export interface Options {
     };
     pagination: Pagination;
     showNextButton?: boolean;
-    routingStrategy?: 'hash' | 'browser';
     markdownItemsPagination: MarkdownItemsPagination;
     disableSidebar: boolean;
     skipBundleAndConvert: boolean;

package/lib-esm/services/code-samples/generator.js

@@ -1,2 +1,2 @@
-import{parse as parseQueryString,stringify as stringifyQueryString}from"query-string";import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{toJS}from"mobx";import{deleteEmptyArrayItem,isArrayOfObjects,serializeParameterValue,getSecurityDetails,getParameterValue}from"../../utils";import{normalizeMimeType,arrayMergeStrategy}from"../utils";import{MediaTypes}from"../../constants";import{l}from"../labels";import{HTTPSnippet}from"./httpsnippet";import StringUtility from"./httpsnippet/helpers/string-utility";function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:n={},properties:o={}}){var l,u,p,d,c,m,h,y,v,f;const{securityHeaders:g,securityCookies:O,securityQueries:S,securityOAuth2ExtraCalls:T,basicAuth:C}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),b=null===(p=null===(u=e.requestBody)||void 0===u?void 0:u.content)||void 0===p?void 0:p.active,E={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},A={path:toJS(null===(d=null==e?void 0:e.requestValues)||void 0===d?void 0:d.path),cookie:toJS(null===(c=null==e?void 0:e.requestValues)||void 0===c?void 0:c.cookie),header:toJS(null===(m=null==e?void 0:e.requestValues)||void 0===m?void 0:m.header),query:toJS(null===(h=null==e?void 0:e.requestValues)||void 0===h?void 0:h.query),body:toJS(null===(y=null==e?void 0:e.requestValues)||void 0===y?void 0:y.body)};let _=!1;const P=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=A.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))}})).map((e=>((null==b?void 0:b.name)&&"content-type"===e.name.toLowerCase()&&(_=!0,e.value=b.name),e))).concat(g);!_&&(null==b?void 0:b.name)&&P.unshift({name:"Content-Type",value:null==b?void 0:b.name});const R=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=A.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(O),w=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,E,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:isArrayOfObjects(null===(a=A.query)||void 0===a?void 0:a[s])&&JSON.stringify(deleteEmptyArrayItem(null===(r=A.query)||void 0===r?void 0:r[s]))||String((null===(i=A.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(S),D=`${null===(v=e.activeServer)||void 0===v?void 0:v.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,j=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=A.path)||void 0===a?void 0:a[i])||n[i]||getParameterValue(r,i),e}),{}),k=null===(f=null==b?void 0:b.examples)||void 0===f?void 0:f[t],q=(null==b?void 0:b.examples)||{},[H]=Object.values(q),x=A.body||(null==k?void 0:k.value)||(null==H?void 0:H.value)||(null==b?void 0:b.schema)&&Sampler.sample(null==b?void 0:b.schema.rawSchema,E,i),M=null==b?void 0:b.name.toLowerCase();let N="",U=[];switch(normalizeMimeType(M)){case MediaTypes.JSON:N=JSON.stringify(getDataRequest(x,o));break;case MediaTypes.URL_ENCODED:case MediaTypes.MULTIPART:N=stringifyQueryString(getDataRequest(x,o)),U=objectToHarParams(getDataRequest(x,o));break;default:N=String(x||"")}const z=N?{mimeType:(null==b?void 0:b.name)||MediaTypes.OCTET_STREAM,text:N,params:U}:void 0,V=e.responses.map((e=>e.code));return{method:e.httpVerb,url:D,httpVersion:"HTTP/1.1",cookies:R,headers:P,queryString:w,postData:z,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:T,basicAuth:C,pathParameters:j,serverVariables:e.activeServer.variables,allResponseCodes:V}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};export function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:i,options:s={}}){try{const{skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}=s,p=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}),d=new HTTPSnippet(p);return langToSnippetConfig[e]?d.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,t){var a,r,i,s;const n={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0};for(const o of(null==e?void 0:e.schemes)||[]){const e=getSecurityDetails(o.id);switch(o.type){case"openIdConnect":null===(a=n.securityHeaders)||void 0===a||a.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";o.flows.clientCredentials&&t?n.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(o.flows.clientCredentials,o.scopes,e)):o.flows.password&&t&&n.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(o.flows.password,o.scopes,e)),null===(r=n.securityHeaders)||void 0===r||r.push({name:"Authorization",value:a});break}case"apiKey":{const t=e.raw||"YOUR_API_KEY_HERE";"header"===o.in&&(null===(i=n.securityHeaders)||void 0===i||i.push({name:o.name,value:t})),"cookie"===o.in&&n.securityCookies.push({name:o.name,value:t}),"query"===o.in&&n.securityQueries.push({name:o.name,value:t});break}case"http":"basic"===o.scheme?n.basicAuth={username:e.username||`<${StringUtility.toSnakeCase(l("tryItAuthBasicUsername"))}>`,password:e.password||`<${StringUtility.toSnakeCase(l("tryItAuthBasicPassword"))}>`}:null===(s=n.securityHeaders)||void 0===s||s.push({name:"Authorization",value:`${capitalizeFirst(o.scheme||"bearer")} <YOUR_${o.bearerFormat||"TOKEN"}_HERE>`})}}return n}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getDataRequest(e,t){if(e){if("object"==typeof e)return merge(e,t,{arrayMerge:arrayMergeStrategy});try{return merge(JSON.parse(e),t,{arrayMerge:arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e){const t=[];for(const[a,r]of Object.entries(e))t.push({name:a,value:String(r)});return t}export function isDefined(e){return void 0!==e}export function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}
+import{parse as parseQueryString,stringify as stringifyQueryString}from"query-string";import*as Sampler from"openapi-sampler";import merge from"deepmerge";import{getRecoil}from"recoil-nexus";import{deleteEmptyArrayItem,isArrayOfObjects,serializeParameterValue,getSecurityDetails,getParameterValue}from"../../utils";import{normalizeMimeType,arrayMergeStrategy}from"../utils";import{MediaTypes}from"../../constants";import{l}from"../labels";import{HTTPSnippet}from"./httpsnippet";import StringUtility from"./httpsnippet/helpers/string-utility";import{getActiveMediaType}from"../../models";import{operationStore}from"../../recoil/operation";function mapOperationToHAR(e,{exampleName:t="",skipOptionalParameters:a=!1,withOAuth2Call:r=!1,spec:i,generatedPayloadSamplesMaxDepth:s=8,pathParams:n={},properties:o={}}){var l,u,p;const{securityHeaders:c,securityCookies:d,securityQueries:m,securityOAuth2ExtraCalls:h,basicAuth:y}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),{activeServer:g,requestValues:f}=getRecoil(operationStore(e.pointer)),v=(null===(u=null==e?void 0:e.requestBody)||void 0===u?void 0:u.content)&&getActiveMediaType(e.requestBody.content),O={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},T={path:null==f?void 0:f.path,cookie:null==f?void 0:f.cookie,header:null==f?void 0:f.header,query:null==f?void 0:f.query,body:null==f?void 0:f.body};let S=!1;const C=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=T.header)||void 0===t?void 0:t[e.name])||getParameterValue("header",e.name)||serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,O,i))}})).map((e=>((null==v?void 0:v.name)&&"content-type"===e.name.toLowerCase()&&(S=!0,e.value=v.name),e))).concat(c);!S&&(null==v?void 0:v.name)&&C.unshift({name:"Content-Type",value:null==v?void 0:v.name});const b=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,O,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=T.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(d),E=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>parseQueryString(serializeParameterValue(e,Sampler.sample(e.schema.rawSchema,O,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:isArrayOfObjects(null===(a=T.query)||void 0===a?void 0:a[s])&&JSON.stringify(deleteEmptyArrayItem(null===(r=T.query)||void 0===r?void 0:r[s]))||String((null===(i=T.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(m),A=`${null==g?void 0:g.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,_=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=T.path)||void 0===a?void 0:a[i])||n[i]||getParameterValue(r,i),e}),{}),P=null===(p=null==v?void 0:v.examples)||void 0===p?void 0:p[t],R=(null==v?void 0:v.examples)||{},[w]=Object.values(R),D=T.body||(null==P?void 0:P.value)||(null==w?void 0:w.value)||(null==v?void 0:v.schema)&&Sampler.sample(null==v?void 0:v.schema.rawSchema,O,i),j=null==v?void 0:v.name.toLowerCase();let k="",M=[];switch(normalizeMimeType(j)){case MediaTypes.JSON:k=JSON.stringify(getDataRequest(D,o));break;case MediaTypes.URL_ENCODED:case MediaTypes.MULTIPART:k=stringifyQueryString(getDataRequest(D,o)),M=objectToHarParams(getDataRequest(D,o));break;default:k=String(D||"")}const H=k?{mimeType:(null==v?void 0:v.name)||MediaTypes.OCTET_STREAM,text:k,params:M}:void 0,q=e.responses.map((e=>e.code));return{method:e.httpVerb,url:A,httpVersion:"HTTP/1.1",cookies:b,headers:C,queryString:E,postData:H,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:h,basicAuth:y,pathParameters:_,serverVariables:(null==g?void 0:g.variables)||e.activeServer.variables,allResponseCodes:q}}const defaultOptions={withImports:!0,withComments:!1},langToSnippetConfig={curl:{code:"shell",defaultTarget:"curl",defaultOptions:Object.assign(Object.assign({},defaultOptions),{short:!0})},JavaScript:{code:"javascript",defaultTarget:"fetch",defaultOptions:Object.assign(Object.assign({},defaultOptions),{withImports:!1})},"Node.js":{code:"node",defaultTarget:"fetch",defaultOptions:Object.assign({},defaultOptions)},Python:{code:"python",defaultTarget:"requests",defaultOptions:Object.assign({},defaultOptions)},"Java8+Apache":{code:"java8",defaultTarget:"apachehttp",defaultOptions:Object.assign({},defaultOptions)},Java:{code:"java",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},"C#":{code:"csharp",defaultTarget:"httpclient",defaultOptions:Object.assign({},defaultOptions)},Go:{code:"go",defaultTarget:"http.DefaultClient",defaultOptions:Object.assign({},defaultOptions)},PHP:{code:"php",defaultTarget:"curl",defaultOptions:Object.assign({},defaultOptions)},Ruby:{code:"ruby",defaultTarget:"net::http",defaultOptions:Object.assign({},defaultOptions)},R:{code:"r",defaultTarget:"httr",defaultOptions:Object.assign({},defaultOptions)}};export function getCodeSample({lang:e,operation:t,exampleName:a,pathParams:r,properties:i,options:s={}}){try{const{skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}=s,p=mapOperationToHAR(t,{exampleName:a,pathParams:r,properties:i,skipOptionalParameters:n,withOAuth2Call:o,spec:l,generatedPayloadSamplesMaxDepth:u}),c=new HTTPSnippet(p);return langToSnippetConfig[e]?c.convert(langToSnippetConfig[e].code,langToSnippetConfig[e].defaultTarget,Object.assign(Object.assign({},langToSnippetConfig[e].defaultOptions),s)):"Language is not supported."}catch(e){return console.error(e),"Failed to generate code sample."}}function getSecurityData(e,t){var a,r,i,s;const n={securityHeaders:[],securityCookies:[],securityQueries:[],securityOAuth2ExtraCalls:[],basicAuth:void 0};for(const o of(null==e?void 0:e.schemes)||[]){const e=getSecurityDetails(o.id);switch(o.type){case"openIdConnect":null===(a=n.securityHeaders)||void 0===a||a.push({name:"Authorization",value:"Bearer <YOUR_TOKEN_HERE>"});break;case"oauth2":{const a=e.token?`${e.token.token_type||"Bearer"} ${e.token.access_token}`:"Bearer <YOUR_TOKEN_HERE>";o.flows.clientCredentials&&t?n.securityOAuth2ExtraCalls.push(getOAuth2ClientCredsCallHar(o.flows.clientCredentials,o.scopes,e)):o.flows.password&&t&&n.securityOAuth2ExtraCalls.push(getOAuth2PasswordCallHar(o.flows.password,o.scopes,e)),null===(r=n.securityHeaders)||void 0===r||r.push({name:"Authorization",value:a});break}case"apiKey":{const t=e.raw||"YOUR_API_KEY_HERE";"header"===o.in&&(null===(i=n.securityHeaders)||void 0===i||i.push({name:o.name,value:t})),"cookie"===o.in&&n.securityCookies.push({name:o.name,value:t}),"query"===o.in&&n.securityQueries.push({name:o.name,value:t});break}case"http":"basic"===o.scheme?n.basicAuth={username:e.username||`<${StringUtility.toSnakeCase(l("tryItAuthBasicUsername"))}>`,password:e.password||`<${StringUtility.toSnakeCase(l("tryItAuthBasicPassword"))}>`}:null===(s=n.securityHeaders)||void 0===s||s.push({name:"Authorization",value:`${capitalizeFirst(o.scheme||"bearer")} <YOUR_${o.bearerFormat||"TOKEN"}_HERE>`})}}return n}function getOAuth2PasswordCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"password"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},{name:"username",value:a.username||"<username>"},{name:"password",value:a.password||"<password>"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getOAuth2ClientCredsCallHar(e,t,a){return{method:"POST",url:e.tokenUrl,httpVersion:"HTTP/1.1",headers:[{name:"Content-Type",value:MediaTypes.URL_ENCODED},{name:"Accept",value:MediaTypes.JSON}],queryString:[],postData:{mimeType:MediaTypes.URL_ENCODED,text:"",params:[{name:"grant_type",value:"client_credentials"},{name:"client_id",value:a.client_id||"YOUR_CLIENT_ID"},{name:"client_secret",value:a.client_secret||"YOUR_CLIENT_SECRET"},t.length?{name:"scope",value:t.join(" ")}:void 0].filter(isDefined)},cookies:[],headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:[]}}function getDataRequest(e,t){if(e){if("object"==typeof e)return merge(e,t,{arrayMerge:arrayMergeStrategy});try{return merge(JSON.parse(e),t,{arrayMerge:arrayMergeStrategy})}catch(e){return!1}}return!1}function objectToHarParams(e){const t=[];for(const[a,r]of Object.entries(e))t.push({name:a,value:String(r)});return t}export function isDefined(e){return void 0!==e}export function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}
 //# sourceMappingURL=generator.js.map

package/lib-esm/services/code-samples/httpsnippet/targets/index.d.ts

@@ -7,7 +7,7 @@ declare const targets: {
             default: string;
         };
         fetch: import("..").LanguageHandler<(import("../..").BasicLanguageOptions & {
-            credentials?: "omit" | "same-origin" | "include" | undefined;
+            credentials?: "same-origin" | "omit" | "include" | undefined;
         }) | undefined>;
     };
     node: {

package/lib-esm/services/code-samples/httpsnippet/targets/javascript/index.d.ts

@@ -6,7 +6,7 @@ declare const _default: {
         default: string;
     };
     fetch: import("../..").LanguageHandler<(import("../../..").BasicLanguageOptions & {
-        credentials?: "omit" | "same-origin" | "include" | undefined;
+        credentials?: "same-origin" | "omit" | "include" | undefined;
     }) | undefined>;
 };
 export default _default;

package/lib-esm/services/code-samples/httpsnippet/targets/shell/curl.d.ts

@@ -1,6 +1,6 @@
 import type { LanguageHandler } from '../..';
-import type { cURULCodeSampleConfig } from '../../../types';
-declare const handler: LanguageHandler<cURULCodeSampleConfig['options']>;
+import type { CurlCodeSampleConfig } from '../../../types';
+declare const handler: LanguageHandler<CurlCodeSampleConfig['options']>;
 export declare const info: {
     key: string;
     title: string;

package/lib-esm/services/code-samples/types.d.ts

@@ -9,7 +9,7 @@ interface CodeSampleBasicConfig {
     label?: string;
     options?: BasicLanguageOptions;
 }
-export interface cURULCodeSampleConfig extends CodeSampleBasicConfig {
+export interface CurlCodeSampleConfig extends CodeSampleBasicConfig {
     lang: 'curl';
     options?: BasicLanguageOptions & {
         binary?: boolean;
@@ -48,7 +48,7 @@ export interface RubyCodeSampleConfig extends CodeSampleBasicConfig {
 export interface RCodeSampleConfig extends CodeSampleBasicConfig {
     lang: 'R';
 }
-export type CodeSampleConfig = cURULCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
+export type CodeSampleConfig = CurlCodeSampleConfig | JavaScriptCodeSampleConfig | NodeJsCodeSampleConfig | PythonCodeSampleConfig | Java8CodeSampleConfig | JavaCodeSampleConfig | CSharpCodeSampleConfig | PHPCodeSampleConfig | GoCodeSampleConfig | RubyCodeSampleConfig | RCodeSampleConfig;
 /**
  * Code Samples Generator rules
  * - Reference docs always displays all user custom x-code-samples

package/lib-esm/services/history/helpers.d.ts

@@ -1,4 +1,4 @@
 import type { FieldModel } from '../../models';
 export declare function isSameHash(a: string, b: string): boolean;
-export declare function constructFieldDeepFragment(field: FieldModel): string | null;
+export declare function constructFieldDeepFragment(field: FieldModel): string;
 export declare function joinWithSeparator(base?: string, path?: string, sep?: string): string;

package/lib-esm/services/history/helpers.js

@@ -1,2 +1,2 @@
-import{stringify as stringifyQueryString}from"query-string";export function isSameHash(e,i){return e===i||"#"+e===i||e==="#"+i}function getContentTypeName(e){var i,n,o,t,d,l,r,s,p,v,u,a,c,y,f;if(!e.in)return"request"===e.deps.type&&(null===(o=null===(n=null===(i=e.deps.operation)||void 0===i?void 0:i.requestBody)||void 0===n?void 0:n.content)||void 0===o?void 0:o.mediaTypes)?(null===(l=null===(d=null===(t=e.deps.operation)||void 0===t?void 0:t.requestBody)||void 0===d?void 0:d.content)||void 0===l?void 0:l.mediaTypes.length)>1?null===(p=null===(s=null===(r=e.deps.operation)||void 0===r?void 0:r.requestBody)||void 0===s?void 0:s.content)||void 0===p?void 0:p.active.name:void 0:"response"===e.deps.type&&(null===(u=null===(v=e.deps.response)||void 0===v?void 0:v.content)||void 0===u?void 0:u.mediaTypes)&&(null===(c=null===(a=e.deps.response)||void 0===a?void 0:a.content)||void 0===c?void 0:c.mediaTypes.length)>1?null===(f=null===(y=e.deps.response)||void 0===y?void 0:y.content)||void 0===f?void 0:f.active.name:void 0}export function constructFieldDeepFragment(e){var i,n,o,t;if(!e)return null;if(!e.deps.operation)return null;if(null===(i=e.deps.operation)||void 0===i?void 0:i.isCallback)return null;const d={t:e.deps.type,in:e.in||e.deps.in,c:"response"===e.deps.type?null===(n=e.deps.response)||void 0===n?void 0:n.code:void 0,cb:(null===(o=e.deps.operation)||void 0===o?void 0:o.isCallback)?null===(t=e.deps.operation)||void 0===t?void 0:t.id:void 0,ct:getContentTypeName(e),path:e.fieldFullPath};return stringifyQueryString(d,{encode:!1})}export function joinWithSeparator(e="",i="",n="/"){return e.endsWith(n)&&(e=e.slice(0,-n.length)),i.startsWith(n)&&(i=i.slice(n.length)),e&&i?e+n+i:e+i}
+import{stringify as stringifyQueryString}from"query-string";import{getActiveMediaType}from"../../models";export function isSameHash(e,o){return e===o||"#"+e===o||e==="#"+o}function getContentTypeName(e){var o,n,t,i,d,s,r,p,l,v,u,a,c;if(!e.in)return"request"===e.deps.type&&(null===(t=null===(n=null===(o=e.deps.operation)||void 0===o?void 0:o.requestBody)||void 0===n?void 0:n.content)||void 0===t?void 0:t.mediaTypes)?(null===(s=null===(d=null===(i=e.deps.operation)||void 0===i?void 0:i.requestBody)||void 0===d?void 0:d.content)||void 0===s?void 0:s.mediaTypes.length)>1?(null===(p=null===(r=e.deps.operation)||void 0===r?void 0:r.requestBody)||void 0===p?void 0:p.content)&&getActiveMediaType(e.deps.operation.requestBody.content).name:void 0:"response"===e.deps.type&&(null===(v=null===(l=e.deps.response)||void 0===l?void 0:l.content)||void 0===v?void 0:v.mediaTypes)&&(null===(a=null===(u=e.deps.response)||void 0===u?void 0:u.content)||void 0===a?void 0:a.mediaTypes.length)>1?(null===(c=e.deps.response)||void 0===c?void 0:c.content)&&getActiveMediaType(e.deps.response.content).name:void 0}export function constructFieldDeepFragment(e){var o,n;if(!e)return"";const t={t:e.deps.type,in:e.in||e.deps.in,c:"response"===e.deps.type?null===(o=e.deps.response)||void 0===o?void 0:o.code:void 0,cb:(null===(n=e.deps.operation)||void 0===n?void 0:n.isCallback)?e.deps.operation.callbackId:void 0,ct:getContentTypeName(e),path:e.fieldFullPath};return stringifyQueryString(t,{encode:!1,sort:!1})}export function joinWithSeparator(e="",o="",n="/"){return e.endsWith(n)&&(e=e.slice(0,-n.length)),o.startsWith(n)&&(o=o.slice(n.length)),e&&o?e+n+o:e+o}
 //# sourceMappingURL=helpers.js.map

package/lib-esm/services/history/index.d.ts

@@ -1,4 +1 @@
-export * from './PushStateHistoryService';
-export * from './ProHashHistoryService';
-export * from './FakeHistoryService';
-export { HistoryService, history } from './HistoryService';
+export * from './helpers';

package/lib-esm/services/history/index.js

@@ -1,2 +1,2 @@
-export*from"./PushStateHistoryService";export*from"./ProHashHistoryService";export*from"./FakeHistoryService";export{HistoryService,history}from"./HistoryService";
+export*from"./helpers";
 //# sourceMappingURL=index.js.map

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

@@ -1,17 +1,12 @@
-export * from './ProStore';
 export * from './history';
 export * from './code-samples';
 export * from './types';
 export * from './labels';
 export { OpenAPIParser } from './OpenAPIParser';
-export { MarkdownRenderer } from './MarkdownRenderer';
-export { ScrollService } from './ScrollService';
-export { SpecStore } from './SpecStore';
-export { MenuBuilder } from './MenuBuilder';
-export { ProMenu } from './ProMenu';
-export type { ExtendedMenuItem } from './ProMenu';
+export { buildContentItems } from './menu';
 export { SearchStore } from './search';
 export type { SearchResultMeta } from './search';
 export { MarkerService } from './MarkerService';
 export * from './types';
 export * from './Options';
+export { deepClone } from './utils';

package/lib-esm/services/index.js

@@ -1,2 +1,2 @@
-export*from"./ProStore";export*from"./history";export*from"./code-samples";export*from"./types";export*from"./labels";export{OpenAPIParser}from"./OpenAPIParser";export{MarkdownRenderer}from"./MarkdownRenderer";export{ScrollService}from"./ScrollService";export{SpecStore}from"./SpecStore";export{MenuBuilder}from"./MenuBuilder";export{ProMenu}from"./ProMenu";export{SearchStore}from"./search";export{MarkerService}from"./MarkerService";export*from"./types";export*from"./Options";
+export*from"./history";export*from"./code-samples";export*from"./types";export*from"./labels";export{OpenAPIParser}from"./OpenAPIParser";export{buildContentItems}from"./menu";export{SearchStore}from"./search";export{MarkerService}from"./MarkerService";export*from"./types";export*from"./Options";export{deepClone}from"./utils";
 //# sourceMappingURL=index.js.map

package/lib-esm/services/menu/builder.d.ts

@@ -0,0 +1,9 @@
+import type { OpenAPIParser } from '../OpenAPIParser';
+import type { Options } from '../Options';
+import type { ContentItemModel } from '../../models';
+import type { ExtendedMenuItem, IMenuItem } from '../types';
+export declare function buildMenuStructure(parser: OpenAPIParser, options: Options): ContentItemModel[];
+export declare function buildContentItems(parser: OpenAPIParser, options: Options): {
+    contentItems: ContentItemModel[];
+    flatItems: (ExtendedMenuItem & IMenuItem)[];
+};

package/lib-esm/services/menu/builder.js

@@ -0,0 +1,2 @@
+import{getTagGroupsItems,getTagsItems,getTagsWithOperations}from"./tags";import{addMarkdownItems}from"./markdown";import{flattenByProp}from"../../utils";export function buildMenuStructure(t,e){const{definition:n}=t,o=[],i=[...n.tags||[]]||[];!i.find((t=>(null==t?void 0:t.name)===e.schemaDefinitionsTagName))&&e.schemaDefinitionsTagName&&i.push({name:e.schemaDefinitionsTagName});const s=getTagsWithOperations(t,i),a=n["x-tagGroups"];return o.push(...addMarkdownItems(n.info.description||"",void 0,1,e.markdownHeadingsAnchorLevel,e.pagination)),a&&a.length>0?o.push(...getTagGroupsItems(t,void 0,a,s,e)):o.push(...getTagsItems(t,s,void 0,void 0,e)),o}export function buildContentItems(t,e){const n=buildMenuStructure(t,e);return{contentItems:n,flatItems:flattenByProp(n||[],"items")}}
+//# sourceMappingURL=builder.js.map

package/lib-esm/services/menu/helpers.d.ts

@@ -0,0 +1,6 @@
+import type { IMenuItem, ExtendedMenuItem } from '../types';
+export declare function getItemById(itemId: string, flatItems: (ExtendedMenuItem & IMenuItem)[]): (ExtendedMenuItem & IMenuItem) | undefined;
+export declare function withoutVersion(path: string): string;
+export declare function getParentSpecItem(item: any): any;
+export declare function getParentOfType(item: ExtendedMenuItem, type: string): any;
+export declare function getLeadingSectionItems(item: ExtendedMenuItem): IMenuItem[];

package/lib-esm/services/menu/helpers.js

@@ -0,0 +1,2 @@
+export function getItemById(t,e){return e.find((({id:e})=>e===t))}export function withoutVersion(t){return t.split("/").slice(1).join("/")}export function getParentSpecItem(t){for(;t;){if("spec"===t.type)return t;t=t.parent}}export function getParentOfType(t,e){if(t&&t.parent)return t.parent.type===e?t.parent:getParentOfType(t.parent,e)}export function getLeadingSectionItems(t){const e=[];for(const n of t.items){if("section"!==n.type)break;e.push(n)}return e}
+//# sourceMappingURL=helpers.js.map

package/lib-esm/services/menu/index.d.ts

@@ -0,0 +1 @@
+export { buildContentItems } from './builder';

package/lib-esm/services/menu/index.js

@@ -0,0 +1,2 @@
+export{buildContentItems}from"./builder";
+//# sourceMappingURL=index.js.map

package/lib-esm/services/menu/markdown.d.ts

@@ -0,0 +1,11 @@
+import type { ContentItemModel, GroupModel } from '../../models';
+import { Pagination } from '../types';
+/**
+ * extracts items from markdown description
+ * @param description - markdown source
+ * @param parent
+ * @param initialDepth - number of items depth
+ * @param markdownHeadingsAnchorLevel - level of headings renders as a section from markdown.
+ * @param pagination
+ */
+export declare function addMarkdownItems(description: string | GenericObject, parent: GroupModel | undefined, initialDepth: number, markdownHeadingsAnchorLevel?: number, pagination?: Pagination): ContentItemModel[];

package/lib-esm/services/menu/markdown.js

@@ -0,0 +1,2 @@
+import{parse,Ast}from"@markdoc/markdoc";import{Pagination}from"../types";import{getGroup}from"../../models";import{isString,safeSlugify,unescapeHTMLChars}from"../../utils";export function addMarkdownItems(t,e,i,n=2,o=Pagination.Section){const r=isString(t)?parse(t):Ast.fromJSON(null==t?void 0:t.result),s=[];let l;const a=(t,e,i=s,n,o)=>{let r;t=unescapeHTMLChars(t),n.attributes.id?r=n.attributes.id:(r=o?`${o}/${safeSlugify(t)}`:`section/${safeSlugify(t)}`,n.attributes.id=r);const l={id:r,name:t,level:e,items:[],ast:[n]};return i.push(l),l},d=(t,e)=>{var i,n;null===(n=null===(i=t[t.length-1])||void 0===i?void 0:i.ast)||void 0===n||n.push(e)},u=t=>{var e;for(const i of t.children){const t=getMarkdownContent(i)||"";"heading"===i.type&&1===i.attributes.level?l=a(t,i.attributes.level,void 0,i):i.attributes.level<=n?a(t,i.attributes.level,null==l?void 0:l.items,i,null==l?void 0:l.id):(null===(e=null==l?void 0:l.items)||void 0===e?void 0:e.length)?d(null==l?void 0:l.items,i):(null==s?void 0:s.length)&&d(s,i)}};if(Array.isArray(r))for(const t of r)u(t);else u(r);return mapHeadingsDeep(e,s,i,{pagination:o,markdownHeadingsAnchorLevel:n})}function mapHeadingsDeep(t,e,i=1,n){return e.map((e=>{const o=getGroup("section",e,n,t);return o.depth=i,e.items&&(o.items=mapHeadingsDeep(o,e.items,i+1,n)),o}))}function getMarkdownContent(t){var e,i;return"string"==typeof(null===(e=null==t?void 0:t.attributes)||void 0===e?void 0:e.content)?null===(i=t.attributes)||void 0===i?void 0:i.content:(null==t?void 0:t.children)?getMarkdownContent(t.children[0]):void 0}
+//# sourceMappingURL=markdown.js.map

package/lib-esm/services/menu/operation.d.ts

@@ -0,0 +1,13 @@
+import type { GroupModel, OperationMenuItem, ContentItemModel } from '../../models';
+import type { TagInfo } from '../types';
+import type { Options } from '../Options';
+import { Pagination } from '../types';
+/**
+ * Returns array of Operation items for the tag
+ * @param parent parent OperationsGroup
+ * @param tag tag info returned from `getTagsWithOperations`
+ * @param depth items depth
+ * @param options - normalized options
+ */
+export declare function getOperationsItems(parent: GroupModel | undefined, tag: TagInfo, depth: number, options: Options): OperationMenuItem[];
+export declare function getHref({ type, id, parent }: Pick<ContentItemModel, 'id' | 'parent' | 'type'>, pagination: Pagination): string;

package/lib-esm/services/menu/operation.js

@@ -0,0 +1,2 @@
+import{alphabeticallyByProp,getOperationId,getOperationName}from"../../utils";import{Pagination}from"../types";import{normalizePath}from"../utils";import{joinWithSeparator}from"../history";export function getOperationsItems(t,e,o,a){if(0===e.operations.length)return[];const i=[];for(const r of e.operations){const e=getOperationId(r,t),n="operation";i.push({id:e,type:n,parent:t,operationDefinition:r,depth:o,name:getOperationName(r),httpVerb:r.httpVerb,path:r.pathName,items:[],isWebhook:r.isWebhook,operationId:r.operationId,href:getHref({id:e,type:n,parent:t},a.pagination)})}return a.sortOperationsAlphabetically&&i.sort(alphabeticallyByProp("name")),i}export function getHref({type:t,id:e,parent:o},a){switch(a){case Pagination.None:return`#${e}`;case Pagination.Item:return"section"===t?"tag"===(null==o?void 0:o.type)?normalizePath(joinWithSeparator(o.id,e,"#")):`#${e}`:o&&"group"!==o.type?normalizePath(joinWithSeparator(o.id,e)):normalizePath(e);case Pagination.Section:return"operation"===t?normalizePath(o?joinWithSeparator(o.id,e,"#"):`#${e}`):"section"===t?o?`#${e}`:normalizePath(`#${e}`):normalizePath(e);default:return""}}
+//# sourceMappingURL=operation.js.map

package/lib-esm/services/menu/tags.d.ts

@@ -0,0 +1,27 @@
+import type { OpenAPIParser } from '../OpenAPIParser';
+import type { ContentItemModel, GroupModel } from '../../models';
+import type { TagGroup, TagsInfoMap } from '../types';
+import type { Options } from '../Options';
+import type { OpenAPITag } from '../../types';
+/**
+ * Returns array of OperationsGroup items for the tags of the group or for all tags
+ * @param parser
+ * @param tagsMap tags info returned from `getTagsWithOperations`
+ * @param parent parent item
+ * @param group group which this tag belongs to. if not provided gets all tags
+ * @param options - normalized options
+ */
+export declare function getTagsItems(parser: OpenAPIParser, tagsMap: TagsInfoMap, parent: GroupModel | undefined, group: TagGroup | undefined, options: Options): ContentItemModel[];
+/**
+ * Returns array of OperationsGroup items for the tag groups (x-tagGroups vendor extension)
+ * @param parser
+ * @param parent
+ * @param groups
+ * @param tags value of `x-tagGroups` vendor extension
+ * @param options - normalized options
+ */
+export declare function getTagGroupsItems(parser: OpenAPIParser, parent: GroupModel | undefined, groups: TagGroup[], tags: TagsInfoMap, options: Options): GroupModel[];
+/**
+ * collects tags and maps each tag to list of operations belonging to this tag
+ */
+export declare function getTagsWithOperations(parser: OpenAPIParser, explicitTags: OpenAPITag[]): TagsInfoMap;

package/lib-esm/services/menu/tags.js

@@ -0,0 +1,2 @@
+import{getGroup}from"../../models";import{GROUP_DEPTH}from"../../constants";import{alphabeticallyByProp,isOperationName,JsonPointer}from"../../utils";import{getOperationsItems}from"./operation";import{addMarkdownItems}from"./markdown";export function getTagsItems(e,t,n,o,a){let s;if(s=void 0===o?Object.keys(t):o.tags,!Array.isArray(s))return console.warn("Unexpected values of tags. Check tags or x-tagGroups in your definition."),[];const i=s.map((e=>t[e]?(t[e].used=!0,t[e]):(console.warn(`Non-existing tag "${e}" is added to the group "${null==o?void 0:o.name}"`),null))),r=[];for(const t of i){if(!t)continue;const o=getGroup("tag",t,{pagination:a.pagination,markdownHeadingsAnchorLevel:a.markdownHeadingsAnchorLevel},n);if(o.depth=GROUP_DEPTH+1,""===t.name){const e=[...addMarkdownItems(t.description||"",o,o.depth+1,a.markdownHeadingsAnchorLevel,a.pagination),...getOperationsItems(void 0,t,o.depth+1,a)];r.push(...e);continue}const s=getTagRelatedSchema({definition:e.definition,tag:t,parent:o,schemaDefinitionsTagName:a.schemaDefinitionsTagName,options:{pagination:a.pagination,markdownHeadingsAnchorLevel:a.markdownHeadingsAnchorLevel}});o.items=[...s,...addMarkdownItems(t.description||"",o,o.depth+1,a.markdownHeadingsAnchorLevel,a.pagination),...getOperationsItems(o,t,o.depth+1,a)],r.push(o)}return a.sortTagsAlphabetically&&r.sort(alphabeticallyByProp("name")),r}export function getTagGroupsItems(e,t,n,o,a){const s=[];for(const i of n){const n=getGroup("group",i,{pagination:a.pagination,markdownHeadingsAnchorLevel:a.markdownHeadingsAnchorLevel},t);n.depth=GROUP_DEPTH,n.items=getTagsItems(e,o,n,i,a),s.push(n)}return s}function getTagRelatedSchema({definition:e,tag:t,parent:n,schemaDefinitionsTagName:o,options:a}){var s;const i=o?[o]:[];return Object.entries((null===(s=e.components)||void 0===s?void 0:s.schemas)||{}).map((([e,o])=>{if(!(o["x-tags"]||i).includes(t.name))return null;const s=getGroup("schema",{name:e,"x-displayName":`${o.title||e}`,description:`{% schemaDefinition showWriteOnly="true" schemaRef="#/components/schemas/${e}" /%}`,isSchema:!0,level:2},a,n);return s.depth=n.depth+1,s})).filter(Boolean)}export function getTagsWithOperations(e,t){const{definition:n}=e,o={},a=n["x-webhooks"]||n.webhooks;for(const e of t||[])o[e.name]=Object.assign(Object.assign({},e),{operations:[]});return n.paths&&getTags(e,n.paths,o),a&&getTags(e,a,o,!0),o}function getTags(e,t,n,o){for(const a of Object.keys(t||{})){const s=t[a],i=Object.keys(s).filter(isOperationName);for(const t of i){const i=s[t];if(s.$ref){const{resolved:t}=e.deref(s);getTags(e,{[a]:t},n,o);continue}let r=null==i?void 0:i.tags;r&&r.length||(r=[""]);for(const e of r){let r=n[e];void 0===r&&(r={name:e,operations:[]},n[e]=r),r["x-traitTag"]||r.operations.push(Object.assign(Object.assign({},i),{pathName:a,pointer:JsonPointer.compile(["paths",a,t]),httpVerb:t,pathParameters:s.parameters||[],pathServers:s.servers,isWebhook:!!o}))}}}}
+//# sourceMappingURL=tags.js.map

package/lib-esm/services/search/DeepSearchStore.d.ts

@@ -1,7 +1,7 @@
 import type { SearchResult, SearchResultMeta } from './types';
-import type { OperationModel } from '../../models';
+import type { OperationMenuItem } from '../../models';
 import type { IMenuItem } from '../types';
-import type { Options } from '../Options/types';
+import type { Options } from '../Options';
 import { SearchStore } from './SearchStore';
 export declare class DeepSearchStore extends SearchStore<SearchResultMeta> {
     operationTitleBoost: number;
@@ -10,7 +10,7 @@ export declare class DeepSearchStore extends SearchStore<SearchResultMeta> {
     pathOnly: boolean;
     searchMaxDepth: number;
     constructor(options: Options);
-    indexItems(groups: Array<IMenuItem | OperationModel>): void;
+    indexItems(groups: Array<IMenuItem | OperationMenuItem>): void;
     private indexSchema;
     add(title: string, body: string, meta?: SearchResultMeta): void;
     search<T = SearchResultMeta>(q: string): Promise<Array<SearchResult<T>>>;

package/lib-esm/services/search/DeepSearchStore.js

@@ -1,2 +1,2 @@
-var __awaiter=this&&this.__awaiter||function(e,t,o,i){return new(o||(o=Promise))((function(r,a){function s(e){try{c(i.next(e))}catch(e){a(e)}}function n(e){try{c(i.throw(e))}catch(e){a(e)}}function c(e){var t;e.done?r(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(s,n)}c((i=i.apply(e,t||[])).next())}))};import{SearchStore}from"./SearchStore";import{DEFAULT_SEARCH_MAX_DEPTH}from"../../constants";function removeMarkdown(e){return e.replace(/\[(.*?)][[(].*?[\])]/g,"$1")}export class DeepSearchStore extends SearchStore{constructor(e){super(),Object.defineProperty(this,"operationTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:4}),Object.defineProperty(this,"tagTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:8}),Object.defineProperty(this,"fieldLevelBoost",{enumerable:!0,configurable:!0,writable:!0,value:.95}),Object.defineProperty(this,"pathOnly",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"searchMaxDepth",{enumerable:!0,configurable:!0,writable:!0,value:DEFAULT_SEARCH_MAX_DEPTH}),e.searchOperationTitleBoost&&(this.operationTitleBoost=e.searchOperationTitleBoost),e.searchTagTitleBoost&&(this.tagTitleBoost=e.searchTagTitleBoost),e.searchFieldLevelBoost&&(this.fieldLevelBoost=e.searchFieldLevelBoost),"path-only"===e.searchMode&&(this.pathOnly=!0),e.searchMaxDepth&&(this.searchMaxDepth=e.searchMaxDepth)}indexItems(e){const t=e=>{e.forEach((e=>{if("operation"===e.type&&this.pathOnly){const t=e;this.add(t.path,"",{menuId:t.id,boost:this.operationTitleBoost})}else{if("group"===e.type||this.pathOnly||(this.add(e.name,"operation"===e.type?e.path:"",{menuId:e.id,boost:"operation"===e.type?this.operationTitleBoost:this.tagTitleBoost}),e.description&&this.add("",removeMarkdown(e.description||""),{menuId:e.id})),"operation"===e.type){const t=e;for(const o of t.parameters||[])this.add(o.name,removeMarkdown(o.description),{menuId:e.id,place:"parameters",path:[o.name]});const o=t.requestBody&&t.requestBody.content&&t.requestBody.content.active&&t.requestBody.content.active.schema;this.indexSchema(o,e.id,"request fields"),t.responses.forEach((t=>{const o=t.content&&t.content.active&&t.content.active.schema;o&&this.indexSchema(o,e.id,`response ${t.code} fields`)}))}t(e.items)}}))};t(e),this.searchWorker.done()}indexSchema(e,t,o,i=[],r=0){if(e&&!(r>this.searchMaxDepth||e.isCircular)){if((e=e.oneOf&&e.oneOf[e.activeOneOf]||e).fields)for(const a of e.fields){const e=i.concat([a.name]);"additionalProperties"!==a.kind&&(this.add(a.name,removeMarkdown(a.description),{menuId:t,place:o,path:e,boost:Math.pow(this.fieldLevelBoost,r)}),this.indexSchema(a.schema,t,o,e,r+1))}e.items&&this.indexSchema(e.items,t,o,i,r+1)}}add(e,t,o){this.searchWorker.add(e,t,o)}search(e){return __awaiter(this,void 0,void 0,(function*(){return yield this.searchWorker.search(e)}))}toJS(){return __awaiter(this,void 0,void 0,(function*(){return this.searchWorker.toJS()}))}dispose(){"terminate"in this.searchWorker&&this.searchWorker.terminate(),this.searchWorker.dispose&&this.searchWorker.dispose()}}
+var __awaiter=this&&this.__awaiter||function(e,t,o,r){return new(o||(o=Promise))((function(i,a){function s(e){try{c(r.next(e))}catch(e){a(e)}}function n(e){try{c(r.throw(e))}catch(e){a(e)}}function c(e){var t;e.done?i(e.value):(t=e.value,t instanceof o?t:new o((function(e){e(t)}))).then(s,n)}c((r=r.apply(e,t||[])).next())}))};import{getRecoil}from"recoil-nexus";import{SearchStore}from"./SearchStore";import{DEFAULT_SEARCH_MAX_DEPTH}from"../../constants";import{globalStoreSelector}from"../../recoil/store";import{getActiveMediaType,getOperation}from"../../models";import{operationStore}from"../../recoil/operation";import{normalizeText}from"../../utils";function removeMarkdown(e){return normalizeText(e).replace(/\[(.*?)][[(].*?[\])]/g,"$1")}export class DeepSearchStore extends SearchStore{constructor(e){super(),Object.defineProperty(this,"operationTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:4}),Object.defineProperty(this,"tagTitleBoost",{enumerable:!0,configurable:!0,writable:!0,value:8}),Object.defineProperty(this,"fieldLevelBoost",{enumerable:!0,configurable:!0,writable:!0,value:.95}),Object.defineProperty(this,"pathOnly",{enumerable:!0,configurable:!0,writable:!0,value:!1}),Object.defineProperty(this,"searchMaxDepth",{enumerable:!0,configurable:!0,writable:!0,value:DEFAULT_SEARCH_MAX_DEPTH}),e.searchOperationTitleBoost&&(this.operationTitleBoost=e.searchOperationTitleBoost),e.searchTagTitleBoost&&(this.tagTitleBoost=e.searchTagTitleBoost),e.searchFieldLevelBoost&&(this.fieldLevelBoost=e.searchFieldLevelBoost),"path-only"===e.searchMode&&(this.pathOnly=!0),e.searchMaxDepth&&(this.searchMaxDepth=e.searchMaxDepth)}indexItems(e){const t=e=>{e&&e.forEach((e=>{if("operation"===e.type&&this.pathOnly){const t=e;this.add(t.path,"",{menuId:t.id,boost:this.operationTitleBoost})}else{if("group"===e.type||this.pathOnly||(this.add(e.name,"operation"===e.type?e.path:"",{menuId:e.id,boost:"operation"===e.type?this.operationTitleBoost:this.tagTitleBoost}),e.description&&this.add("",removeMarkdown(e.description||""),{menuId:e.id})),"operation"===e.type){const t=e.operationDefinition,{parser:o,options:r}=getRecoil(globalStoreSelector),i=getOperation(o,t,void 0,r,e.href);for(const t of i.parameters||[])this.add(t.name,removeMarkdown(t.description),{menuId:e.id,place:"parameters",path:[t.name]});const a=i.requestBody&&i.requestBody.content&&getActiveMediaType(i.requestBody.content).schema;this.indexSchema(a,e.id,"request fields"),i.responses.forEach((t=>{const o=t.content&&getActiveMediaType(t.content).schema;o&&this.indexSchema(o,e.id,`response ${t.code} fields`)}))}t(e.items)}}))};t(e),this.searchWorker.done()}indexSchema(e,t,o,r=[],i=0){if(!e)return;if(i>this.searchMaxDepth||e.isCircular)return;const{activeOneOf:a}=getRecoil(operationStore(e.deps.operation.pointer));if((e=e.oneOf&&e.oneOf[a]||e).fields)for(const a of e.fields){const e=r.concat([a.name]);"additionalProperties"!==a.kind&&(this.add(a.name,removeMarkdown(a.description),{menuId:t,place:o,path:e,boost:Math.pow(this.fieldLevelBoost,i)}),this.indexSchema(a.schema,t,o,e,i+1))}e.items&&this.indexSchema(e.items,t,o,r,i+1)}add(e,t,o){this.searchWorker.add(e,t,o)}search(e){return __awaiter(this,void 0,void 0,(function*(){return yield this.searchWorker.search(e)}))}toJS(){return __awaiter(this,void 0,void 0,(function*(){return this.searchWorker.toJS()}))}dispose(){"terminate"in this.searchWorker&&this.searchWorker.terminate(),this.searchWorker.dispose&&this.searchWorker.dispose()}}
 //# sourceMappingURL=DeepSearchStore.js.map

package/lib-esm/services/search/SearchStore.d.ts

@@ -1,4 +1,4 @@
-import type { OperationModel } from '../../models/Operation';
+import type { OperationModel } from '../../models/types';
 import type { IMenuItem } from '../types';
 import type { SearchResult } from './types';
 import type Worker from './SearchWorker.worker';

package/lib-esm/services/search/useSearch.d.ts

@@ -0,0 +1,13 @@
+import type { Options } from '../Options';
+import type { SearchStore } from './SearchStore';
+import type { SearchResultMeta } from './types';
+import type { ContentItemModel } from '../../models';
+type UseSearchInput = {
+    options: Options;
+    contentItems: ContentItemModel[];
+};
+type UseSearchReturnType = {
+    search?: SearchStore<SearchResultMeta>;
+};
+export declare function useSearch({ options, contentItems }: UseSearchInput): UseSearchReturnType;
+export {};

package/lib-esm/services/search/useSearch.js

@@ -0,0 +1,2 @@
+import{RemoteSearch}from"./RemoteSearch";import{DeepSearchStore}from"./DeepSearchStore";const global="undefined"==typeof window?{__REDOCLY_SEARCH_URL:void 0}:window;export function useSearch({options:e,contentItems:o}){let r;return e.disableSearch||r||(r=initSearch(e),null==r||r.indexItems(o)),{search:r}}function initSearch(e){return global.__REDOCLY_SEARCH_URL?new RemoteSearch(global.__REDOCLY_SEARCH_URL):new DeepSearchStore(e)}
+//# sourceMappingURL=useSearch.js.map