@redocly/openapi-docs 0.0.0-beta-20240215154132

package/lib/models/types.d.ts

@@ -0,0 +1,231 @@
+import type { Node } from '@markdoc/markdoc';
+import type { OpenAPISecurityScheme, OpenAPIEncoding, OpenAPIMediaType, OpenAPIParameterLocation, OpenAPIParameterStyle, OpenAPIExternalDocumentation, Server, OpenAPIServer, OpenAPIXCodeSample, OpenAPISchema, Referenced, OpenAPIInfo } 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 = {
+    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;
+    parameters: FieldModel[];
+    responses: ResponseModel[];
+    callbacks: CallbackModel[];
+};
+export type GroupModel = {
+    id: string;
+    href: string;
+    name: string;
+    description?: string | GenericObject;
+    isSchema?: boolean;
+    type: MenuItemGroupType;
+    items: ContentItemModel[];
+    ast?: Node[];
+    parent?: GroupModel;
+    externalDocs?: OpenAPIExternalDocumentation;
+    infoDefinition?: OpenAPIInfo;
+    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/models/types.js

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

package/lib/services/MarkerService.d.ts

@@ -0,0 +1,11 @@
+import Mark from 'mark.js';
+export declare class MarkerService {
+    map: Map<Element, Mark>;
+    private prevTerm;
+    add(el: HTMLElement): void;
+    delete(el: Element): void;
+    addOnly(elements: Element[]): void;
+    clearAll(): void;
+    mark(term?: string): void;
+    unmark(): void;
+}

package/lib/services/MarkerService.js

@@ -0,0 +1,2 @@
+"use strict";var __importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0}),exports.MarkerService=void 0;const mark_js_1=__importDefault(require("mark.js"));class MarkerService{constructor(){Object.defineProperty(this,"map",{enumerable:!0,configurable:!0,writable:!0,value:new Map}),Object.defineProperty(this,"prevTerm",{enumerable:!0,configurable:!0,writable:!0,value:""})}add(e){this.map.set(e,new mark_js_1.default(e))}delete(e){this.map.delete(e)}addOnly(e){this.map.forEach(((r,t)=>{-1===e.indexOf(t)&&(r.unmark(),this.map.delete(t))}));for(const r of e)this.map.has(r)||this.map.set(r,new mark_js_1.default(r))}clearAll(){this.unmark(),this.map.clear()}mark(e){(e||this.prevTerm)&&(this.map.forEach((r=>{r.unmark(),r.mark(e||this.prevTerm)})),this.prevTerm=e||this.prevTerm)}unmark(){this.map.forEach((e=>e.unmark())),this.prevTerm=""}}exports.MarkerService=MarkerService;
+//# sourceMappingURL=MarkerService.js.map

package/lib/services/OpenAPIParser.d.ts

@@ -0,0 +1,53 @@
+import type { OpenAPIRef, OpenAPIDefinition } from '../types';
+import type { MergedOpenAPISchema } from './types';
+import type { Options } from './Options/types';
+/**
+ * Loads and keeps spec. Provides raw spec operations
+ */
+export declare function pushRef(stack: string[], ref?: string): string[];
+export declare function concatRefStacks(base: string[], stack?: string[]): string[];
+export declare class OpenAPIParser {
+    private options;
+    definitionUrl?: string;
+    definition: OpenAPIDefinition;
+    versionPath?: string;
+    private readonly allowMergeRefs;
+    constructor(definition: OpenAPIDefinition, definitionUrl?: string, options?: Options & {
+        versionId?: string;
+    });
+    validate(spec: GenericObject): void;
+    /**
+     * get spec part by JsonPointer ($ref)
+     */
+    byRef: <T>(ref: string) => T | undefined;
+    /**
+     * checks if the object is OpenAPI reference (contains $ref property)
+     */
+    isRef<T>(obj: OpenAPIRef | T): obj is OpenAPIRef;
+    /**
+     * Resolve given reference object or return as is if it is not a reference
+     * @param obj object to dereference
+     * @param forceCircular whether to dereference even if it is circular ref
+     * @param mergeAsAllOf
+     */
+    deref<T>(obj: OpenAPIRef | T, baseRefsStack?: string[], mergeAsAllOf?: boolean): {
+        resolved: T;
+        refsStack: string[];
+    };
+    mergeRefs<T>(ref: OpenAPIRef, resolved: T, mergeAsAllOf: boolean): T;
+    /**
+     * Merge allOf constraints.
+     * @param schema schema with allOF
+     * @param $ref pointer of the schema
+     * @param forceCircular whether to dereference children even if it is a circular ref
+     * @param used$Refs
+     */
+    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
+     * @param $refs array of references to find derived from
+     */
+    findDerived($refs: string[]): Record<string, string[] | string>;
+    private hoistOneOfs;
+}

package/lib/services/OpenAPIParser.js

@@ -0,0 +1,2 @@
+"use strict";var __rest=this&&this.__rest||function(e,t){var r={};for(var i in e)Object.prototype.hasOwnProperty.call(e,i)&&t.indexOf(i)<0&&(r[i]=e[i]);if(null!=e&&"function"==typeof Object.getOwnPropertySymbols){var 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 theme_1=require("@redocly/theme"),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,"versionPath",{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.definition=Object.assign({},e),this.validate(e),this.versionPath=r.versionId,this.definition=e,this.allowMergeRefs=e.openapi.startsWith("3.1");const i=theme_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")}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:u,readOnly:O,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){if(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||u,readOnly:void 0!==s.readOnly?s.readOnly:O,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/helpers.d.ts

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

package/lib/services/Options/helpers.js

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

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

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

package/lib/services/Options/index.js

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

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

@@ -0,0 +1,2 @@
+import type { Options, RawOptions } from './types';
+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"),helpers_1=require("./helpers"),types_2=require("../types"),constants_2=require("../code-samples/constants");function normalizeOptions(e,a){var o,l,i,s,n,t,r,u,d,c,p;e=Object.assign(Object.assign(Object.assign({},a),e),{markdocOptions:Object.assign(Object.assign({},null==e?void 0:e.markdocOptions),{components:Object.assign(Object.assign({},null===(o=null==a?void 0:a.markdocOptions)||void 0===o?void 0:o.components),null===(l=null==e?void 0:e.markdocOptions)||void 0===l?void 0:l.components),tags:Object.assign(Object.assign({},null===(i=null==a?void 0:a.markdocOptions)||void 0===i?void 0:i.tags),null===(s=null==e?void 0:e.markdocOptions)||void 0===s?void 0:s.tags),nodes:Object.assign(Object.assign(Object.assign({},null===(n=null==a?void 0:a.markdocOptions)||void 0===n?void 0:n.nodes),null===(t=null==e?void 0:e.markdocOptions)||void 0===t?void 0:t.nodes),{heading:(null===(u=null===(r=null==a?void 0:a.markdocOptions)||void 0===r?void 0:r.nodes)||void 0===u?void 0:u.heading)||(null===(d=null==e?void 0:e.markdocOptions)||void 0===d?void 0:d.nodes.heading)})})});const h=Array.isArray(e.ignoreNamedSchemas)?e.ignoreNamedSchemas:null===(c=e.ignoreNamedSchemas)||void 0===c?void 0:c.split(",").map((e=>e.trim()));return{downloadDefinitionUrls:e.downloadDefinitionUrls,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),disableLoadingAnimation:(0,utils_1.argValueToBoolean)(e.disableLoadingAnimation,!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),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:(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),showObjectSchemaExamples:(0,utils_1.argValueToBoolean)(e.showObjectSchemaExamples,!1),showAccessMode:(0,utils_1.argValueToBoolean)(e.showAccessMode,!1),maxDisplayedEnumValues:(0,utils_1.argValueToNumber)(e.maxDisplayedEnumValues),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),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,theme_1.isUndefined)(e.enableRouter)?"":e.routingBasePath&&(0,utils_1.normalizePath)(e.routingBasePath)||"",schemaExpansionLevel:(0,utils_1.argValueToExpandLevel)(e.schemaExpansionLevel),feedback:e.feedback||{hide:!1},payloadSampleIdx:(0,helpers_1.normalizePayloadSampleIdx)(e.payloadSampleIdx,0),requiredPropsFirst:(0,utils_1.argValueToBoolean)(e.requiredPropsFirst,!1),markdownHeadingsAnchorLevel:(0,utils_1.argValueToNumber)(e.markdownHeadingsAnchorLevel,2),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),showWebhookVerb:(0,utils_1.argValueToBoolean)(e.showWebhookVerb,!1),showChangeLayoutButton:(0,utils_1.argValueToBoolean)(e.showChangeLayoutButton,!0),showExtensions:(0,helpers_1.normalizeShowExtensions)(e.showExtensions),preserveOriginalExtensionsName:(0,utils_1.argValueToBoolean)(e.preserveOriginalExtensionsName,!1),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),disableErrorBoundary:(0,utils_1.argValueToBoolean)(e.disableErrorBoundary),ignoreNamedSchemas:new Set(h),markdocOptions:null==e?void 0:e.markdocOptions,defaultSampleLanguage:e.defaultSampleLanguage||"",generateCodeSamples:e.generateCodeSamples||{languages:Object.values(constants_2.Languages).map((e=>({lang:e})))},layout:e.layout||theme_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_externalCodeSamples:e.unstable_externalCodeSamples||[],infoLabel:null==e?void 0:e.infoLabel,showMetadata:(0,utils_1.argValueToBoolean)(null==e?void 0:e.showMetadata,!1)}}exports.normalizeOptions=normalizeOptions;
+//# sourceMappingURL=normalizeOptions.js.map

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

@@ -0,0 +1,225 @@
+import type { ComponentType } from 'react';
+import type { Schema, ConfigFunction } from '@markdoc/markdoc/dist/src/types';
+import type { CodeSamplesConfig, Languages } from '../code-samples';
+import type { ExternalLink, HooksConfig, SideNavStyle, Unstable_ExternalCodeSample } from '../types';
+import type { Events } from '../../events';
+import type { LayoutVariant } from '@redocly/theme';
+import type { OperationModel } from '../../models/types';
+export declare enum SearchMode {
+    Default = "default",
+    PathOnly = "path-only"
+}
+export interface RawOptions {
+    licenseKey?: string;
+    scrollYOffset?: number | string | (() => number);
+    hideHostname?: boolean | string;
+    hideInfoDescription?: boolean | string;
+    requiredPropsFirst?: boolean | string;
+    sortPropsAlphabetically?: boolean | string;
+    sortEnumValuesAlphabetically?: boolean | string;
+    sortOperationsAlphabetically?: boolean | string;
+    sortTagsAlphabetically?: boolean | string;
+    nativeScrollbars?: boolean | string;
+    untrustedDefinition?: boolean | string;
+    hideLoading?: boolean | string;
+    hideDownloadButton?: boolean | string;
+    downloadDefinitionUrls?: {
+        json?: string;
+        yaml?: string;
+    };
+    disableSearch?: boolean | string;
+    searchAutoExpand?: boolean;
+    searchOperationTitleBoost?: number | string;
+    searchTagTitleBoost?: number | string;
+    searchFieldLevelBoost?: number | string;
+    showChangeLayoutButton?: boolean | string;
+    onlyRequiredInSamples?: boolean | string;
+    generatedPayloadSamplesMaxDepth?: number | string;
+    showExtensions?: boolean | string | string[];
+    preserveOriginalExtensionsName?: boolean;
+    hideSingleRequestSampleTab?: boolean | string;
+    hideRequestPayloadSample?: boolean;
+    jsonSampleExpandLevel?: number | string | 'all';
+    hideSchemaTitles?: boolean | string;
+    hideSecuritySection?: boolean;
+    showSecuritySchemeType?: boolean;
+    simpleOneOfTypeLabel?: boolean | string;
+    payloadSampleIdx?: number;
+    expandSingleSchemaField?: boolean | string;
+    schemaExpansionLevel?: number | string | 'all';
+    mockServer?: {
+        url?: string;
+        position?: 'first' | 'last' | 'replace' | 'off';
+        description?: string;
+    };
+    enumSkipQuotes?: boolean | string;
+    expandDefaultServerVariables?: boolean;
+    expandDefaultRequest?: boolean;
+    expandDefaultResponse?: boolean;
+    maxDisplayedEnumValues?: number;
+    unstable_externalCodeSamples?: Unstable_ExternalCodeSample[];
+    unstable_ignoreMimeParameters?: boolean;
+    hooks?: HooksConfig;
+    hideSchemaPattern?: boolean;
+    hideOneOfDescription?: boolean;
+    hideFab?: boolean;
+    markdownHeadingsAnchorLevel?: number;
+    schemaDefinitionsTagName?: string;
+    minCharacterLengthToInitSearch?: number;
+    showWebhookVerb?: boolean;
+    showObjectSchemaExamples?: boolean;
+    showAccessMode?: boolean;
+    hideRightPanel?: boolean;
+    layout?: LayoutVariant;
+    defaultSampleLanguage?: Languages | string;
+    disableDeepLinks?: boolean;
+    disableLoadingAnimation?: boolean;
+    sideNavStyle?: SideNavStyle;
+    whiteLabel?: boolean;
+    hideLogo?: boolean;
+    hideInfoSection?: boolean;
+    oAuth2RedirectURI?: string | null;
+    events?: Events;
+    corsProxyUrl?: string;
+    authCorsProxyUrl?: string;
+    onDeepLinkClick?: ((link: string) => void) | undefined | null;
+    requestInterceptor?: ((req: Request, operation: OperationModel) => void) | undefined | null;
+    sidebarLinks?: {
+        beforeInfo?: Array<ExternalLink>;
+        end?: Array<ExternalLink>;
+    };
+    disableSidebar?: boolean;
+    skipBundleAndConvert?: boolean;
+    routingBasePath?: string;
+    searchMode?: SearchMode;
+    ctrlFHijack?: boolean;
+    generateCodeSamples?: CodeSamplesConfig;
+    disableErrorBoundary?: boolean;
+    unstable_externalDescription?: string;
+    searchMaxDepth?: number;
+    ignoreNamedSchemas?: string[] | string;
+    markdocOptions?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+    enableRouter?: boolean;
+    feedback?: Record<string, any>;
+    infoLabel?: string;
+    showMetadata?: boolean;
+}
+export interface DefaultOptions {
+    ignoreNamedSchemas?: string[] | string;
+    markdocOptions?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+}
+export interface Options {
+    scrollYOffset: () => number;
+    hideHostname: boolean;
+    hideInfoDescription: boolean;
+    requiredPropsFirst: boolean;
+    sortPropsAlphabetically: boolean;
+    sortEnumValuesAlphabetically: boolean;
+    sortOperationsAlphabetically: boolean;
+    sortTagsAlphabetically: boolean;
+    nativeScrollbars: boolean;
+    untrustedDefinition: boolean;
+    hideLoading: boolean;
+    hideDownloadButton: boolean | null;
+    downloadDefinitionUrls?: {
+        json?: string;
+        yaml?: string;
+    };
+    disableSearch: boolean;
+    searchAutoExpand: boolean;
+    searchOperationTitleBoost: number;
+    searchTagTitleBoost: number;
+    searchFieldLevelBoost: number;
+    showChangeLayoutButton: boolean;
+    onlyRequiredInSamples: boolean;
+    generatedPayloadSamplesMaxDepth: number;
+    showExtensions: string[] | boolean;
+    preserveOriginalExtensionsName: boolean;
+    hideSingleRequestSampleTab: boolean;
+    hideRequestPayloadSample: boolean;
+    jsonSampleExpandLevel: number;
+    hideSchemaTitles: boolean;
+    hideSecuritySection: boolean;
+    showSecuritySchemeType: boolean;
+    simpleOneOfTypeLabel: boolean;
+    payloadSampleIdx: number;
+    expandSingleSchemaField: boolean;
+    schemaExpansionLevel: number;
+    mockServer?: {
+        url: string;
+        position: 'first' | 'last' | 'replace' | 'off';
+        description: string;
+    };
+    markdocOptions?: {
+        tags: Record<string, Schema>;
+        nodes: Record<string, Schema>;
+        components: Record<string, ComponentType>;
+        variables?: Record<string, any>;
+        partials?: Record<string, any>;
+        functions?: Record<string, ConfigFunction>;
+    };
+    enumSkipQuotes: boolean;
+    expandDefaultServerVariables: boolean;
+    expandDefaultRequest: boolean;
+    expandDefaultResponse: boolean;
+    maxDisplayedEnumValues: number;
+    ignoreNamedSchemas: Set<string>;
+    unstable_externalCodeSamples: Unstable_ExternalCodeSample[];
+    unstable_ignoreMimeParameters: boolean;
+    hooks: HooksConfig;
+    hideSchemaPattern: boolean;
+    hideOneOfDescription: boolean;
+    hideFab: boolean;
+    markdownHeadingsAnchorLevel: number;
+    schemaDefinitionsTagName?: string;
+    minCharacterLengthToInitSearch: number;
+    showWebhookVerb: boolean;
+    showObjectSchemaExamples: boolean;
+    showAccessMode: boolean;
+    hideRightPanel: boolean;
+    layout: LayoutVariant;
+    defaultSampleLanguage: Languages | string;
+    disableDeepLinks: boolean;
+    disableLoadingAnimation: boolean;
+    sideNavStyle: SideNavStyle;
+    whiteLabel: boolean;
+    hideLogo: boolean;
+    hideInfoSection: boolean;
+    oAuth2RedirectURI: string | null;
+    events: Events;
+    corsProxyUrl?: string;
+    authCorsProxyUrl?: string;
+    onDeepLinkClick: ((link: string) => void) | undefined | null;
+    requestInterceptor: ((req: Request, operation: OperationModel) => void) | undefined | null;
+    sidebarLinks?: {
+        beforeInfo?: Array<ExternalLink>;
+        end?: Array<ExternalLink>;
+    };
+    disableSidebar: boolean;
+    skipBundleAndConvert: boolean;
+    routingBasePath: string;
+    searchMode: SearchMode;
+    ctrlFHijack?: boolean;
+    generateCodeSamples: CodeSamplesConfig;
+    disableErrorBoundary: boolean;
+    /** @deprecated */
+    unstable_externalDescription?: string;
+    searchMaxDepth: number;
+    feedback: Record<string, any>;
+    infoLabel?: string;
+    showMetadata: boolean;
+}

package/lib/services/Options/types.js

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

package/lib/services/check.d.ts

@@ -0,0 +1,13 @@
+export type LicenseInfo = {
+    t?: boolean;
+    i?: number;
+    e?: number;
+    h?: string[] | true;
+    valid?: boolean;
+    expired?: boolean;
+    allowed?: boolean;
+    local?: boolean;
+    cryptoMissing?: boolean;
+};
+export declare function isHostAllowed(hostname: string, hosts: string[] | boolean | undefined): boolean;
+export default function parse(key?: string): Promise<LicenseInfo>;

package/lib/services/check.js

@@ -0,0 +1,2 @@
+"use strict";var __awaiter=this&&this.__awaiter||function(t,e,n,o){return new(n||(n=Promise))((function(i,r){function s(t){try{a(o.next(t))}catch(t){r(t)}}function l(t){try{a(o.throw(t))}catch(t){r(t)}}function a(t){var e;t.done?i(t.value):(e=t.value,e instanceof n?e:new n((function(t){t(e)}))).then(s,l)}a((o=o.apply(t,e||[])).next())}))};Object.defineProperty(exports,"__esModule",{value:!0}),exports.isHostAllowed=void 0;const utils_1=require("./utils");function promisifyIECryptoRes(t){return"then"in t?t:new Promise((e=>{t.oncomplete=t=>{e(t.target.result)}}))}function str2ab(t){const e=new ArrayBuffer(t.length),n=new Uint8Array(e);for(let e=0,o=t.length;e<o;e++)n[e]=t.charCodeAt(e);return e}const getKey=()=>{const t=str2ab(atob("undefined"!=typeof REDOCLY_PUBLIC_KEY?REDOCLY_PUBLIC_KEY:"MFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBAMHjNir5fXx/ZXoaEeXQ5XyxbNJ4YJYczoCRdSkL6NLzw1FHnng5Vfcgk5+bvox9QRYRbuk84mA4f2NhywDbXKECAwEAAQ=="));return promisifyIECryptoRes(null===utils_1.cryptoLib||void 0===utils_1.cryptoLib?void 0:utils_1.cryptoLib.subtle.importKey("spki",t,{name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},!0,["verify"]))};function textEncode(t){if(window.TextEncoder)return(new TextEncoder).encode(t);const e=unescape(encodeURIComponent(t)),n=new Uint8Array(e.length);for(let t=0;t<e.length;t++)n[t]=e.charCodeAt(t);return n}function verify(t,e){return __awaiter(this,void 0,void 0,(function*(){return promisifyIECryptoRes(null===utils_1.cryptoLib||void 0===utils_1.cryptoLib?void 0:utils_1.cryptoLib.subtle.verify({name:"RSASSA-PKCS1-v1_5",hash:"SHA-256"},yield getKey(),str2ab(atob(e)),textEncode(t)))}))}function isHostAllowed(t,e){return!0===e||!(!Array.isArray(e)||"undefined"==typeof window)&&(!("localhost"!==t&&"127.0.0.1"!==t&&!t.endsWith(".localhost")&&!e.find((e=>e===t||t.endsWith("."+e))))||!!e.find((e=>{if(e.indexOf("*")!==e.lastIndexOf("*"))return;const[n,o]=e.split("*");return o&&t.startsWith(n)&&t.endsWith(o)&&o.split(".").length>2})))}function parse(t){return __awaiter(this,void 0,void 0,(function*(){if("development"===process.env.NODE_ENV)return{valid:!0,allowed:!0};const e=window.location.hostname;if(!t)return"localhost"===e||"127.0.0.1"===e||e.endsWith(".localhost")?{local:!0}:{};const[n,o]=t.split(".");let i;try{if(!(yield verify(atob(n),o)))return{valid:!1};i=JSON.parse(atob(n))}catch(t){return{valid:!1,cryptoMissing:!0}}return i.valid=!0,(!i.e||Date.now()/1e3>i.e)&&(i.expired=!0),i.allowed=isHostAllowed(e,i.h),i}))}exports.isHostAllowed=isHostAllowed,exports.default=parse;
+//# sourceMappingURL=check.js.map

package/lib/services/code-samples/constants.d.ts

@@ -0,0 +1,2 @@
+import type { Languages as LanguagesType } from './types';
+export declare const Languages: Record<string, LanguagesType>;

package/lib/services/code-samples/constants.js

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.Languages=void 0,exports.Languages={JavaScript:"JavaScript",NodeJs:"Node.js",curl:"curl",Java8:"Java8+Apache",Java:"Java",Python:"Python",Go:"Go",PHP:"PHP",CSharp:"C#",CSharpNewtonsoft:"C#+Newtonsoft",Ruby:"Ruby",R:"R"};
+//# sourceMappingURL=constants.js.map

package/lib/services/code-samples/generator.d.ts

@@ -0,0 +1,26 @@
+import type { OperationModel } from '../../models';
+import type * as HAR from './har';
+import type { Languages } from './types';
+import type { ServerVariables } from '../../types';
+export type CustomHAR = HAR.Request & {
+    securityOAuth2ExtraCalls?: HAR.Request[];
+    basicAuth?: {
+        username: string;
+        password: string;
+    };
+    pathParameters?: {
+        [key in string]: string;
+    };
+    serverVariables?: ServerVariables;
+    allResponseCodes?: string[];
+};
+export declare function getCodeSample({ lang, operation, exampleName, pathParams, properties, options, }: {
+    lang: Languages;
+    operation: OperationModel;
+    exampleName?: string;
+    pathParams?: GenericObject;
+    properties?: GenericObject;
+    options?: GenericObject;
+}): string;
+export declare function isDefined<T>(arg?: T): arg is T;
+export declare function capitalizeFirst(str: string): string;