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

package/lib/models/types.d.ts

@@ -1,3 +1,233 @@
-import type { GroupModel } from './Group';
-import type { OperationModel } from './Operation';
-export type ContentItemModel = GroupModel | OperationModel;
+import type { Node } from '@markdoc/markdoc';
+import type { OpenAPISecurityScheme, OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterLocation, OpenAPIParameterStyle, OpenAPIExternalDocumentation, Server, OpenAPIServer, OpenAPIXCodeSample, OpenAPISchema, Referenced } from '../types';
+import type { OpenAPIParser } from '../services/OpenAPIParser';
+import type { Options } from '../services/Options';
+import type { ExtendedOpenAPIOperation, MenuItemGroupType, MenuItemType, MergedOpenAPISchema, Unstable_ExternalCodeSample } from '../services/types';
+export type ContentItemModel = GroupModel | OperationMenuItem;
+export interface ExtendedOpenAPISecurityScheme extends OpenAPISecurityScheme {
+    id: string;
+    sectionId: string;
+    scopes: string[];
+    'x-defaultClientId'?: string;
+}
+export interface SecurityRequirement {
+    schemes: ExtendedOpenAPISecurityScheme[];
+}
+export interface SecurityScheme {
+    id: string;
+    sectionId: string;
+    type: OpenAPISecurityScheme['type'];
+    description: string | GenericObject;
+    apiKey?: {
+        name: string;
+        in: OpenAPISecurityScheme['in'];
+    };
+    http?: {
+        scheme: string;
+        bearerFormat?: string;
+    };
+    openId?: {
+        connectUrl: string;
+    };
+    flows: OpenAPISecurityScheme['flows'];
+}
+export type RequestBodyModel = {
+    description: string | GenericObject;
+    required: boolean;
+    content: MediaContentModel | undefined;
+};
+export type ExampleModel = {
+    value: any;
+    rawValue: any;
+    externalValueUrl?: string;
+    summary?: string;
+    description?: string | GenericObject;
+    mime: string;
+    encoding?: {
+        [field: string]: OpenAPIEncoding;
+    };
+};
+export type MediaTypeModel = {
+    examples?: {
+        [name: string]: ExampleModel;
+    };
+    schema?: SchemaModel;
+    name: string;
+    isRequestType: boolean;
+    onlyRequiredInSamples: boolean;
+    operation: OperationModel;
+};
+export type MediaContentModel = {
+    mediaTypes: MediaTypeModel[];
+    isRequestType: boolean;
+    hasSample: boolean;
+    operation: OperationModel;
+};
+export type MediaContentModelInput = {
+    parser: OpenAPIParser;
+    info: Record<string, OpenAPIMediaType>;
+    isRequestType: boolean;
+    options: Options;
+    data: {
+        operation: OperationModel;
+        type?: 'request' | 'response';
+        response?: ResponseModel;
+        absolutePointer?: string;
+    };
+};
+export type ResponseModel = {
+    expanded: boolean;
+    content?: MediaContentModel;
+    code: string;
+    summary: string | GenericObject;
+    description: string | GenericObject;
+    type: string;
+    headers: FieldModel[];
+};
+export type FieldModel = {
+    schema: SchemaModel;
+    name: string;
+    required: boolean;
+    description: string | GenericObject;
+    example?: string;
+    examples?: Record<string, ExampleModel>;
+    deprecated: boolean;
+    in?: OpenAPIParameterLocation;
+    kind: string;
+    extensions?: GenericObject;
+    explode: boolean;
+    style?: OpenAPIParameterStyle;
+    const?: any;
+    serializationMime?: string;
+    fieldFullPath?: string;
+    deps: Deps;
+    absolutePointer?: string;
+};
+export type CallbackModel = {
+    name: string;
+    operations: OperationModel[];
+};
+export type OperationModel = {
+    id: string;
+    absoluteIdx?: number;
+    name: string;
+    description?: string | GenericObject;
+    ast?: Node[];
+    href: string;
+    type: MenuItemType;
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    items: ContentItemModel[];
+    depth: number;
+    activeExampleName?: string;
+    activeServer: Server;
+    defaultExampleName?: string | false;
+    defaultMimeType?: string;
+    pointer: string;
+    operationId?: string;
+    httpVerb: string;
+    deprecated: boolean;
+    path: string;
+    servers: OpenAPIServer[];
+    security: SecurityRequirement[];
+    extensions: GenericObject;
+    isCallback: boolean;
+    isWebhook: boolean;
+    isEvent: boolean;
+    callbackId: string;
+    requestBody?: RequestBodyModel;
+    payload?: {
+        lang: string;
+        label: string;
+        source: string;
+        requestBodyContent: MediaContentModel;
+    };
+    definitionSamples?: OpenAPIXCodeSample[] | Unstable_ExternalCodeSample[];
+    hasSamples: boolean;
+    allCodeSamples: OpenAPIXCodeSample[];
+    parameters: FieldModel[];
+    responses: ResponseModel[];
+    callbacks: CallbackModel[];
+    hideTryItPanel: boolean;
+};
+export type GroupModel = {
+    id: string;
+    href: string;
+    name: string;
+    description?: string | GenericObject;
+    isSchema?: boolean;
+    type: MenuItemGroupType;
+    items: ContentItemModel[];
+    ast?: Node[];
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    depth: number;
+    level: number;
+};
+export type OperationMenuItem = {
+    id: string;
+    href: string;
+    name: string;
+    operationDefinition: ExtendedOpenAPIOperation;
+    depth: number;
+    items: ContentItemModel[];
+    parent?: GroupModel;
+    deprecated?: boolean;
+    type: 'operation';
+    httpVerb: string;
+    path: string;
+    isWebhook: boolean;
+    operationId?: string;
+};
+export type SchemaModel = {
+    parser: OpenAPIParser;
+    options: Options;
+    deps: Deps;
+    schemaOrRef: Referenced<OpenAPISchema>;
+    isChild: boolean;
+    refsStack: string[];
+    pointer: string;
+    absolutePointer?: string;
+    type: string | string[];
+    displayType: string;
+    typePrefix: string;
+    title: string;
+    description: string | GenericObject;
+    externalDocs?: OpenAPIExternalDocumentation;
+    isPrimitive: boolean;
+    isCircular: boolean;
+    format?: string;
+    displayFormat?: string;
+    nullable: boolean;
+    deprecated: boolean;
+    pattern?: string;
+    example?: any;
+    enum: any[];
+    default?: any;
+    readOnly: boolean;
+    writeOnly: boolean;
+    constraints: string[];
+    fields?: FieldModel[];
+    items?: SchemaModel;
+    oneOf?: SchemaModel[];
+    oneOfType: string;
+    discriminatorProp?: string;
+    rawSchema: OpenAPISchema;
+    schema: MergedOpenAPISchema;
+    extensions?: GenericObject;
+    'x-enumDescriptions'?: {
+        [name: string]: string;
+    };
+    const: any;
+    contentEncoding?: string;
+    contentMediaType?: string;
+    minItems?: number;
+    maxItems?: number;
+};
+export type Deps = {
+    parentFieldFullPath?: string;
+    operation: OperationModel;
+    type?: 'request' | 'response';
+    response?: ResponseModel;
+    in?: string;
+};

package/lib/recoil/app.d.ts

@@ -0,0 +1,29 @@
+import type { CodeSampleConfig } from '../services';
+import { LayoutVariant } from '../constants';
+export type AppSessionStore = {
+    activeVersionIdx: number;
+    showRightPanelToggle: boolean;
+};
+export type AppLocalStore = {
+    layout: LayoutVariant;
+    activeSampleLanguage: CodeSampleConfig['lang'] | string;
+};
+export type AppStore = {
+    isSidebarOpened: boolean;
+    activeMimeName: string;
+};
+export declare const appStore: import("recoil").RecoilState<AppStore>;
+export declare const isSidebarOpenedSelector: import("recoil").RecoilState<boolean>;
+export declare const activeMimeNameSelector: import("recoil").RecoilState<string>;
+/**
+ * appLocalStore saved to local storage
+ */
+export declare const appLocalStore: import("recoil").RecoilState<AppLocalStore>;
+export declare const layoutSelector: import("recoil").RecoilState<LayoutVariant>;
+export declare const activeSampleLanguageSelector: import("recoil").RecoilState<string>;
+/**
+ * appSessionStore saved to session storage
+ */
+export declare const appSessionStore: import("recoil").RecoilState<AppSessionStore>;
+export declare const showRightPanelToggleSelector: import("recoil").RecoilState<boolean>;
+export declare const activeVersionIdxSelector: import("recoil").RecoilState<number>;

package/lib/recoil/app.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.activeVersionIdxSelector=exports.showRightPanelToggleSelector=exports.appSessionStore=exports.activeSampleLanguageSelector=exports.layoutSelector=exports.appLocalStore=exports.activeMimeNameSelector=exports.isSidebarOpenedSelector=exports.appStore=void 0;const recoil_1=require("recoil"),utils_1=require("../utils"),constants_1=require("../constants");exports.appStore=(0,recoil_1.atom)({key:"appStore",default:{isSidebarOpened:!1,activeMimeName:""}}),exports.isSidebarOpenedSelector=(0,recoil_1.selector)({key:"isSidebarOpened",get:({get:e})=>e(exports.appStore).isSidebarOpened,set:({set:e,get:t},o)=>{const s=t(exports.appStore);e(exports.appStore,Object.assign(Object.assign({},s),{isSidebarOpened:o}))}}),exports.activeMimeNameSelector=(0,recoil_1.selector)({key:"activeMimeName",get:({get:e})=>e(exports.appStore).activeMimeName,set:({set:e,get:t},o)=>{const s=t(exports.appStore);e(exports.appStore,Object.assign(Object.assign({},s),{activeMimeName:o}))}}),exports.appLocalStore=(0,recoil_1.atom)({key:"appLocalStore",default:{layout:constants_1.LayoutVariant.THREE_PANEL,activeSampleLanguage:""},effects:[({onSet:e,setSelf:t})=>{const o=(0,utils_1.fromLocalStorage)("appLocalStore");null!=o&&""!==o&&t(JSON.parse(o)),e((e=>{e instanceof recoil_1.DefaultValue?utils_1.IS_BROWSER&&localStorage.removeItem("appLocalStore"):(0,utils_1.toLocalStorage)("appLocalStore",JSON.stringify(e))}))}]}),exports.layoutSelector=(0,recoil_1.selector)({key:"layout",get:({get:e})=>e(exports.appLocalStore).layout,set:({set:e,get:t},o=constants_1.LayoutVariant.STACKED)=>{const s=t(exports.appLocalStore),a=o===constants_1.LayoutVariant.STACKED?constants_1.LayoutVariant.THREE_PANEL:constants_1.LayoutVariant.STACKED;e(exports.appLocalStore,Object.assign(Object.assign({},s),{layout:a}))}}),exports.activeSampleLanguageSelector=(0,recoil_1.selector)({key:"activeSampleLanguage",get:({get:e})=>e(exports.appLocalStore).activeSampleLanguage,set:({set:e,get:t},o)=>{const s=t(exports.appLocalStore);e(exports.appLocalStore,Object.assign(Object.assign({},s),{activeSampleLanguage:o}))}}),exports.appSessionStore=(0,recoil_1.atom)({key:"appSessionStore",default:{activeVersionIdx:0,showRightPanelToggle:!0},effects:[({onSet:e,setSelf:t})=>{const o=(0,utils_1.fromSessionStorage)("appSessionStore");null!=o&&""!==o&&t(JSON.parse(o)),e((e=>{e instanceof recoil_1.DefaultValue?utils_1.IS_BROWSER&&localStorage.removeItem("appSessionStore"):(0,utils_1.toSessionStorage)("appSessionStore",JSON.stringify(e))}))}]}),exports.showRightPanelToggleSelector=(0,recoil_1.selector)({key:"showRightPanelToggle",get:({get:e})=>e(exports.appSessionStore).showRightPanelToggle,set:({set:e,get:t},o)=>{const s=t(exports.appSessionStore);e(exports.appSessionStore,Object.assign(Object.assign({},s),{showRightPanelToggle:o}))}}),exports.activeVersionIdxSelector=(0,recoil_1.selector)({key:"activeVersionIdx",get:({get:e})=>e(exports.appSessionStore).activeVersionIdx,set:({set:e,get:t},o)=>{const s=t(exports.appSessionStore);e(exports.appSessionStore,Object.assign(Object.assign({},s),{activeVersionIdx:o}))}});
+//# sourceMappingURL=app.js.map

package/lib/recoil/operation.d.ts

@@ -0,0 +1,11 @@
+import type { Server } from '../types/server';
+type OperationStore = {
+    activeExampleName?: string;
+    activeOneOf: number;
+    activeServer?: Server;
+    requestValues: {
+        [field: string]: any;
+    };
+};
+export declare const operationStore: (param: string) => import("recoil").RecoilState<OperationStore>;
+export {};

package/lib/recoil/operation.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.operationStore=void 0;const recoil_1=require("recoil");exports.operationStore=(0,recoil_1.atomFamily)({key:"operation",default:{activeExampleName:void 0,activeOneOf:0,activeServer:void 0,requestValues:{}}});
+//# sourceMappingURL=operation.js.map

package/lib/recoil/store.d.ts

@@ -0,0 +1,19 @@
+import type { Options, OpenAPIParser } from '../services';
+export interface OpenAPIDefinitionVersion {
+    id: string;
+    title: string;
+    url?: string;
+    parser: OpenAPIParser;
+}
+export type GlobalStore = {
+    options: Options;
+    versions: Array<OpenAPIDefinitionVersion>;
+};
+export declare const globalStore: import("recoil").RecoilState<GlobalStore>;
+export type GlobalStoreSelector = {
+    parser: OpenAPIParser;
+    options: Options;
+    hasVersions: boolean;
+};
+export declare const globalStoreSelector: import("recoil").RecoilValueReadOnly<GlobalStoreSelector>;
+export declare const globalOptionsSelector: import("recoil").RecoilValueReadOnly<Options>;

package/lib/recoil/store.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.globalOptionsSelector=exports.globalStoreSelector=exports.globalStore=void 0;const recoil_1=require("recoil"),app_1=require("./app");exports.globalStore=(0,recoil_1.atom)({key:"globalStore",default:{options:{},versions:[]}}),exports.globalStoreSelector=(0,recoil_1.selector)({key:"globalStoreSelector",get:({get:e})=>{var o;const{versions:r,options:t}=e(exports.globalStore);return{parser:null===(o=r[e(app_1.activeVersionIdxSelector)||0])||void 0===o?void 0:o.parser,options:t,hasVersions:r.length>1}}}),exports.globalOptionsSelector=(0,recoil_1.selector)({key:"globalOptionsSelector",get:({get:e})=>e(exports.globalStore).options});
+//# sourceMappingURL=store.js.map

package/lib/services/OpenAPIParser.d.ts

@@ -40,7 +40,7 @@ export declare class OpenAPIParser {
      * @param forceCircular whether to dereference children even if it is a circular ref
      * @param used$Refs
      */
-    mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[]): MergedOpenAPISchema;
+    mergeAllOf(schema: MergedOpenAPISchema, $ref: string | undefined, refsStack: string[], absolutePointer?: string): MergedOpenAPISchema;
     /**
      * Find all derived definitions among #/components/schemas from any of $refs
      * returns map of definition pointer to definition name

package/lib/services/OpenAPIParser.js

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

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

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

package/lib/services/Options/index.js

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

package/lib/services/Options/{NormalizedOptions.d.ts → normalizeOptions.d.ts}

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

package/lib/services/Options/normalizeOptions.js

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

package/lib/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/services/code-samples/generator.js

@@ -1,2 +1,2 @@
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,r){void 0===r&&(r=a);var i=Object.getOwnPropertyDescriptor(t,a);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[a]}}),Object.defineProperty(e,r,i)}:function(e,t,a,r){void 0===r&&(r=a),e[r]=t[a]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var a in e)"default"!==a&&Object.prototype.hasOwnProperty.call(e,a)&&__createBinding(t,e,a);return __setModuleDefault(t,e),t},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.capitalizeFirst=exports.isDefined=exports.getCodeSample=void 0;const query_string_1=require("query-string"),Sampler=__importStar(require("openapi-sampler")),deepmerge_1=__importDefault(require("deepmerge")),mobx_1=require("mobx"),utils_1=require("../../utils"),utils_2=require("../utils"),constants_1=require("../../constants"),labels_1=require("../labels"),httpsnippet_1=require("./httpsnippet"),string_utility_1=__importDefault(require("./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,c,d,m,h,_,f,v;const{securityHeaders:y,securityCookies:g,securityQueries:O,securityOAuth2ExtraCalls:b,basicAuth:S}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),T=null===(p=null===(u=e.requestBody)||void 0===u?void 0:u.content)||void 0===p?void 0:p.active,C={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},D={path:(0,mobx_1.toJS)(null===(c=null==e?void 0:e.requestValues)||void 0===c?void 0:c.path),cookie:(0,mobx_1.toJS)(null===(d=null==e?void 0:e.requestValues)||void 0===d?void 0:d.cookie),header:(0,mobx_1.toJS)(null===(m=null==e?void 0:e.requestValues)||void 0===m?void 0:m.header),query:(0,mobx_1.toJS)(null===(h=null==e?void 0:e.requestValues)||void 0===h?void 0:h.query),body:(0,mobx_1.toJS)(null===(_=null==e?void 0:e.requestValues)||void 0===_?void 0:_.body)};let q=!1;const E=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=D.header)||void 0===t?void 0:t[e.name])||(0,utils_1.getParameterValue)("header",e.name)||(0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,C,i))}})).map((e=>((null==T?void 0:T.name)&&"content-type"===e.name.toLowerCase()&&(q=!0,e.value=T.name),e))).concat(y);!q&&(null==T?void 0:T.name)&&E.unshift({name:"Content-Type",value:null==T?void 0:T.name});const j=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,C,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=D.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(g),P=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,C,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:(0,utils_1.isArrayOfObjects)(null===(a=D.query)||void 0===a?void 0:a[s])&&JSON.stringify((0,utils_1.deleteEmptyArrayItem)(null===(r=D.query)||void 0===r?void 0:r[s]))||String((null===(i=D.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(O),w=`${null===(f=e.activeServer)||void 0===f?void 0:f.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,A=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=D.path)||void 0===a?void 0:a[i])||n[i]||(0,utils_1.getParameterValue)(r,i),e}),{}),x=null===(v=null==T?void 0:T.examples)||void 0===v?void 0:v[t],R=(null==T?void 0:T.examples)||{},[k]=Object.values(R),M=D.body||(null==x?void 0:x.value)||(null==k?void 0:k.value)||(null==T?void 0:T.schema)&&Sampler.sample(null==T?void 0:T.schema.rawSchema,C,i),H=null==T?void 0:T.name.toLowerCase();let N="",z=[];switch((0,utils_2.normalizeMimeType)(H)){case constants_1.MediaTypes.JSON:N=JSON.stringify(getDataRequest(M,o));break;case constants_1.MediaTypes.URL_ENCODED:case constants_1.MediaTypes.MULTIPART:N=(0,query_string_1.stringify)(getDataRequest(M,o)),z=objectToHarParams(getDataRequest(M,o));break;default:N=String(M||"")}const U=N?{mimeType:(null==T?void 0:T.name)||constants_1.MediaTypes.OCTET_STREAM,text:N,params:z}:void 0,V=e.responses.map((e=>e.code));return{method:e.httpVerb,url:w,httpVersion:"HTTP/1.1",cookies:j,headers:E,queryString:P,postData:U,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:b,basicAuth:S,pathParameters:A,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)}};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_1.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=(0,utils_1.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||`<${string_utility_1.default.toSnakeCase((0,labels_1.l)("tryItAuthBasicUsername"))}>`,password:e.password||`<${string_utility_1.default.toSnakeCase((0,labels_1.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:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.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:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.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(0,deepmerge_1.default)(e,t,{arrayMerge:utils_2.arrayMergeStrategy});try{return(0,deepmerge_1.default)(JSON.parse(e),t,{arrayMerge:utils_2.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}function isDefined(e){return void 0!==e}function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}exports.getCodeSample=getCodeSample,exports.isDefined=isDefined,exports.capitalizeFirst=capitalizeFirst;
+"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,t,a,r){void 0===r&&(r=a);var i=Object.getOwnPropertyDescriptor(t,a);i&&!("get"in i?!t.__esModule:i.writable||i.configurable)||(i={enumerable:!0,get:function(){return t[a]}}),Object.defineProperty(e,r,i)}:function(e,t,a,r){void 0===r&&(r=a),e[r]=t[a]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,t){Object.defineProperty(e,"default",{enumerable:!0,value:t})}:function(e,t){e.default=t}),__importStar=this&&this.__importStar||function(e){if(e&&e.__esModule)return e;var t={};if(null!=e)for(var a in e)"default"!==a&&Object.prototype.hasOwnProperty.call(e,a)&&__createBinding(t,e,a);return __setModuleDefault(t,e),t},__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.capitalizeFirst=exports.isDefined=exports.getCodeSample=void 0;const query_string_1=require("query-string"),Sampler=__importStar(require("openapi-sampler")),deepmerge_1=__importDefault(require("deepmerge")),recoil_nexus_1=require("recoil-nexus"),utils_1=require("../../utils"),utils_2=require("../utils"),constants_1=require("../../constants"),labels_1=require("../labels"),httpsnippet_1=require("./httpsnippet"),string_utility_1=__importDefault(require("./httpsnippet/helpers/string-utility")),models_1=require("../../models"),operation_1=require("../../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:_}=getSecurityData(null===(l=e.security)||void 0===l?void 0:l[0],r),{activeServer:f,requestValues:v}=(0,recoil_nexus_1.getRecoil)((0,operation_1.operationStore)(e.pointer)),y=(null===(u=null==e?void 0:e.requestBody)||void 0===u?void 0:u.content)&&(0,models_1.getActiveMediaType)(e.requestBody.content),g={skipNonRequired:a,skipReadOnly:!0,maxSampleDepth:s},O={path:null==v?void 0:v.path,cookie:null==v?void 0:v.cookie,header:null==v?void 0:v.header,query:null==v?void 0:v.query,body:null==v?void 0:v.body};let T=!1;const b=e.parameters.filter((e=>"header"===e.in)).filter((e=>!(a&&!e.required))).map((e=>{var t;return{name:e.name,value:(null===(t=O.header)||void 0===t?void 0:t[e.name])||(0,utils_1.getParameterValue)("header",e.name)||(0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,g,i))}})).map((e=>((null==y?void 0:y.name)&&"content-type"===e.name.toLowerCase()&&(T=!0,e.value=y.name),e))).concat(c);!T&&(null==y?void 0:y.name)&&b.unshift({name:"Content-Type",value:null==y?void 0:y.name});const S=e.parameters.filter((e=>"cookie"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,g,i))))).reduce(((e,t)=>{var a;for(const[r,i]of Object.entries(t))e.push({name:r,value:String((null===(a=O.cookie)||void 0===a?void 0:a[r])||i)});return e}),[]).concat(d),C=e.parameters.filter((e=>"query"===e.in)).filter((e=>!(a&&!e.required))).map((e=>(0,query_string_1.parse)((0,utils_1.serializeParameterValue)(e,Sampler.sample(e.schema.rawSchema,g,i))))).reduce(((e,t)=>{var a,r,i;for(const[s,n]of Object.entries(t))e.push({name:s,value:(0,utils_1.isArrayOfObjects)(null===(a=O.query)||void 0===a?void 0:a[s])&&JSON.stringify((0,utils_1.deleteEmptyArrayItem)(null===(r=O.query)||void 0===r?void 0:r[s]))||String((null===(i=O.query)||void 0===i?void 0:i[s])||n)});return e}),[]).concat(m),D=`${null==f?void 0:f.url.replace(/\/$/,"")}/${e.path.replace(/^\//,"")}`,E=e.parameters.filter((e=>"path"===e.in)).reduce(((e,t)=>{var a;const{in:r,name:i}=t;return e[i]=(null===(a=O.path)||void 0===a?void 0:a[i])||n[i]||(0,utils_1.getParameterValue)(r,i),e}),{}),q=null===(p=null==y?void 0:y.examples)||void 0===p?void 0:p[t],j=(null==y?void 0:y.examples)||{},[P]=Object.values(j),A=O.body||(null==q?void 0:q.value)||(null==P?void 0:P.value)||(null==y?void 0:y.schema)&&Sampler.sample(null==y?void 0:y.schema.rawSchema,g,i),w=null==y?void 0:y.name.toLowerCase();let R="",k=[];switch((0,utils_2.normalizeMimeType)(w)){case constants_1.MediaTypes.JSON:R=JSON.stringify(getDataRequest(A,o));break;case constants_1.MediaTypes.URL_ENCODED:case constants_1.MediaTypes.MULTIPART:R=(0,query_string_1.stringify)(getDataRequest(A,o)),k=objectToHarParams(getDataRequest(A,o));break;default:R=String(A||"")}const x=R?{mimeType:(null==y?void 0:y.name)||constants_1.MediaTypes.OCTET_STREAM,text:R,params:k}:void 0,M=e.responses.map((e=>e.code));return{method:e.httpVerb,url:D,httpVersion:"HTTP/1.1",cookies:S,headers:b,queryString:C,postData:x,headersSize:-1,bodySize:-1,securityOAuth2ExtraCalls:h,basicAuth:_,pathParameters:E,serverVariables:(null==f?void 0:f.variables)||e.activeServer.variables,allResponseCodes:M}}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)}};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_1.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=(0,utils_1.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||`<${string_utility_1.default.toSnakeCase((0,labels_1.l)("tryItAuthBasicUsername"))}>`,password:e.password||`<${string_utility_1.default.toSnakeCase((0,labels_1.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:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.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:constants_1.MediaTypes.URL_ENCODED},{name:"Accept",value:constants_1.MediaTypes.JSON}],queryString:[],postData:{mimeType:constants_1.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(0,deepmerge_1.default)(e,t,{arrayMerge:utils_2.arrayMergeStrategy});try{return(0,deepmerge_1.default)(JSON.parse(e),t,{arrayMerge:utils_2.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}function isDefined(e){return void 0!==e}function capitalizeFirst(e){return e.charAt(0).toUpperCase()+e.slice(1)}exports.getCodeSample=getCodeSample,exports.isDefined=isDefined,exports.capitalizeFirst=capitalizeFirst;
 //# sourceMappingURL=generator.js.map

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