docusaurus-plugin-openapi-docs 3.0.0-beta.1 → 3.0.0-beta.10

package/lib/markdown/createStatusCodes.js

@@ -11,13 +11,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStatusCodes = exports.createExampleFromSchema = exports.createResponseExample = exports.createResponseExamples = void 0;
 const xml_formatter_1 = __importDefault(require("xml-formatter"));
-const createResponseExample_1 = require("../openapi/createResponseExample");
 const createDescription_1 = require("./createDescription");
 const createDetails_1 = require("./createDetails");
 const createDetailsSummary_1 = require("./createDetailsSummary");
 const createResponseSchema_1 = require("./createResponseSchema");
 const utils_1 = require("./utils");
 const utils_2 = require("./utils");
+const createResponseExample_1 = require("../openapi/createResponseExample");
 function json2xml(o, tab) {
     var toXml = function (v, name, ind) {
         var xml = "";
@@ -118,7 +118,7 @@ function createResponseExamples(responseExamples, mimeType) {
                 value: `${exampleName}`,
                 children: [
                     (0, utils_2.guard)(exampleValue.summary, (summary) => [
-                        (0, utils_1.create)("p", {
+                        (0, utils_1.create)("Markdown", {
                             children: ` ${summary}`,
                         }),
                     ]),
@@ -134,7 +134,7 @@ function createResponseExamples(responseExamples, mimeType) {
             value: `${exampleName}`,
             children: [
                 (0, utils_2.guard)(exampleValue.summary, (summary) => [
-                    (0, utils_1.create)("p", {
+                    (0, utils_1.create)("Markdown", {
                         children: ` ${summary}`,
                     }),
                 ]),
@@ -161,7 +161,7 @@ function createResponseExample(responseExample, mimeType) {
             value: `Example`,
             children: [
                 (0, utils_2.guard)(responseExample.summary, (summary) => [
-                    (0, utils_1.create)("p", {
+                    (0, utils_1.create)("Markdown", {
                         children: ` ${summary}`,
                     }),
                 ]),
@@ -177,7 +177,7 @@ function createResponseExample(responseExample, mimeType) {
         value: `Example`,
         children: [
             (0, utils_2.guard)(responseExample.summary, (summary) => [
-                (0, utils_1.create)("p", {
+                (0, utils_1.create)("Markdown", {
                     children: ` ${summary}`,
                 }),
             ]),
@@ -248,7 +248,7 @@ function createExampleFromSchema(schema, mimeType) {
     return undefined;
 }
 exports.createExampleFromSchema = createExampleFromSchema;
-function createStatusCodes({ responses }) {
+function createStatusCodes({ label, id, responses }) {
     if (responses === undefined) {
         return undefined;
     }
@@ -261,6 +261,8 @@ function createStatusCodes({ responses }) {
             (0, utils_1.create)("div", {
                 children: [
                     (0, utils_1.create)("ApiTabs", {
+                        label,
+                        id,
                         children: codes.map((code) => {
                             const responseHeaders = responses[code].headers;
                             return (0, utils_1.create)("TabItem", {

package/lib/markdown/createVersionBadge.js

@@ -13,7 +13,7 @@ function createVersionBadge(version) {
         (0, utils_1.create)("span", {
             className: "theme-doc-version-badge badge badge--secondary",
             children: `Version: ${escape(version)}`,
-        }),
+        }, { inline: true }),
         `\n\n`,
     ]);
 }

package/lib/markdown/index.d.ts

@@ -1,4 +1,5 @@
-import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
-export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, }, infoPath, frontMatter, }: ApiPageMetadata): string;
+import { ApiPageMetadata, InfoPageMetadata, SchemaPageMetadata, TagPageMetadata } from "../types";
+export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, callbacks, }, infoPath, frontMatter, }: ApiPageMetadata): string;
 export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, downloadUrl, }: InfoPageMetadata): string;
 export declare function createTagPageMD({ tag: { description } }: TagPageMetadata): string;
+export declare function createSchemaPageMD({ schema }: SchemaPageMetadata): string;

package/lib/markdown/index.js

@@ -6,9 +6,10 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createTagPageMD = exports.createInfoPageMD = exports.createApiPageMD = void 0;
+exports.createSchemaPageMD = exports.createTagPageMD = exports.createInfoPageMD = exports.createApiPageMD = void 0;
 const createAuthentication_1 = require("./createAuthentication");
 const createAuthorization_1 = require("./createAuthorization");
+const createCallbacks_1 = require("./createCallbacks");
 const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
@@ -20,12 +21,13 @@ const createMethodEndpoint_1 = require("./createMethodEndpoint");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createRequestHeader_1 = require("./createRequestHeader");
+const createSchema_1 = require("./createSchema");
 const createStatusCodes_1 = require("./createStatusCodes");
 const createTermsOfService_1 = require("./createTermsOfService");
 const createVendorExtensions_1 = require("./createVendorExtensions");
 const createVersionBadge_1 = require("./createVersionBadge");
 const utils_1 = require("./utils");
-function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, }, infoPath, frontMatter, }) {
+function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, method, path, extensions, parameters, requestBody, responses, callbacks, }, infoPath, frontMatter, }) {
     return (0, utils_1.render)([
         `import ApiTabs from "@theme/ApiTabs";\n`,
         `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
@@ -36,14 +38,19 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         `import ResponseSamples from "@theme/ResponseSamples";\n`,
         `import SchemaItem from "@theme/SchemaItem";\n`,
         `import SchemaTabs from "@theme/SchemaTabs";\n`,
+        `import Markdown from "@theme/Markdown";\n`,
+        `import Heading from "@theme/Heading";\n`,
+        `import OperationTabs from "@theme/OperationTabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
-        (0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
+        (0, createHeading_1.createHeading)(title),
         (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
         infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),
-        frontMatter.show_extensions && (0, createVendorExtensions_1.createVendorExtensions)(extensions),
+        frontMatter.show_extensions
+            ? (0, createVendorExtensions_1.createVendorExtensions)(extensions)
+            : undefined,
         (0, createDeprecationNotice_1.createDeprecationNotice)({ deprecated, description: deprecatedDescription }),
         (0, createDescription_1.createDescription)(description),
-        (0, createRequestHeader_1.createRequestHeader)("Request"),
+        requestBody || parameters ? (0, createRequestHeader_1.createRequestHeader)("Request") : undefined,
         (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "path" }),
         (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "query" }),
         (0, createParamsDetails_1.createParamsDetails)({ parameters, type: "header" }),
@@ -53,18 +60,20 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
             body: requestBody,
         }),
         (0, createStatusCodes_1.createStatusCodes)({ responses }),
+        (0, createCallbacks_1.createCallbacks)({ callbacks }),
     ]);
 }
 exports.createApiPageMD = createApiPageMD;
 function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, downloadUrl, }) {
     return (0, utils_1.render)([
         `import ApiLogo from "@theme/ApiLogo";\n`,
+        `import Heading from "@theme/Heading";\n`,
         `import SchemaTabs from "@theme/SchemaTabs";\n`,
         `import TabItem from "@theme/TabItem";\n`,
         `import Export from "@theme/ApiExplorer/Export";\n\n`,
         (0, createVersionBadge_1.createVersionBadge)(version),
         (0, createDownload_1.createDownload)(downloadUrl),
-        (0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
+        (0, createHeading_1.createHeading)(title),
         (0, createLogo_1.createLogo)(logo, darkLogo),
         (0, createDescription_1.createDescription)(description),
         (0, createAuthentication_1.createAuthentication)(securitySchemes),
@@ -78,3 +87,19 @@ function createTagPageMD({ tag: { description } }) {
     return (0, utils_1.render)([(0, createDescription_1.createDescription)(description)]);
 }
 exports.createTagPageMD = createTagPageMD;
+function createSchemaPageMD({ schema }) {
+    const { title = "", description } = schema;
+    return (0, utils_1.render)([
+        `import DiscriminatorTabs from "@theme/DiscriminatorTabs";\n`,
+        `import SchemaItem from "@theme/SchemaItem";\n`,
+        `import SchemaTabs from "@theme/SchemaTabs";\n`,
+        `import Heading from "@theme/Heading";\n`,
+        `import TabItem from "@theme/TabItem";\n\n`,
+        (0, createHeading_1.createHeading)(title.replace(utils_1.lessThan, "<").replace(utils_1.greaterThan, ">")),
+        (0, createDescription_1.createDescription)(description),
+        (0, utils_1.create)("ul", {
+            children: (0, createSchema_1.createNodes)(schema, "response"),
+        }),
+    ]);
+}
+exports.createSchemaPageMD = createSchemaPageMD;

package/lib/markdown/schema.js

@@ -35,6 +35,9 @@ function prettyName(schema, circular) {
         return (_d = (_c = schema.xml) === null || _c === void 0 ? void 0 : _c.name) !== null && _d !== void 0 ? _d : schema.type;
         // return schema.type;
     }
+    if (schema.title && schema.type) {
+        return `${schema.title} (${schema.type})`;
+    }
     return (_e = schema.title) !== null && _e !== void 0 ? _e : schema.type;
 }
 function getSchemaName(schema, circular) {

package/lib/markdown/utils.d.ts

@@ -1,10 +1,16 @@
-export declare type Children = string | undefined | (string | string[] | undefined)[];
-export declare type Props = Record<string, any> & {
+export type Children = string | undefined | (string | string[] | undefined)[];
+export type Props = Record<string, any> & {
     children?: Children;
 };
-export declare function create(tag: string, props: Props): string;
+export type Options = {
+    inline?: boolean;
+};
+export declare function create(tag: string, props: Props, options?: Options): string;
 export declare function guard<T>(value: T | undefined, cb: (value: T) => Children): string;
 export declare function render(children: Children): string;
 export declare const lessThan: RegExp;
 export declare const greaterThan: RegExp;
 export declare const codeFence: RegExp;
+export declare const curlyBrackets: RegExp;
+export declare const codeBlock: RegExp;
+export declare function clean(value: string | undefined): string;

package/lib/markdown/utils.js

@@ -6,21 +6,25 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.codeFence = exports.greaterThan = exports.lessThan = exports.render = exports.guard = exports.create = void 0;
-function create(tag, props) {
+exports.clean = exports.codeBlock = exports.curlyBrackets = exports.codeFence = exports.greaterThan = exports.lessThan = exports.render = exports.guard = exports.create = void 0;
+function create(tag, props, options = {}) {
     const { children, ...rest } = props;
     let propString = "";
     for (const [key, value] of Object.entries(rest)) {
         propString += `\n  ${key}={${JSON.stringify(value)}}`;
     }
-    propString += propString ? "\n" : "";
     let indentedChildren = render(children).replace(/^/gm, "  ");
+    if (options.inline) {
+        propString += `\n  children={${JSON.stringify(children)}}`;
+        indentedChildren = "";
+    }
+    propString += propString ? "\n" : "";
     indentedChildren += indentedChildren ? "\n" : "";
     return `<${tag}${propString}>\n${indentedChildren}</${tag}>`;
 }
 exports.create = create;
 function guard(value, cb) {
-    if (!!value) {
+    if (!!value || value === 0) {
         const children = cb(value);
         return render(children);
     }
@@ -41,3 +45,24 @@ exports.render = render;
 exports.lessThan = /<=?(?!(=|button|\s?\/button|code|\s?\/code|details|\s?\/details|summary|\s?\/summary|hr|\s?\/hr|br|\s?\/br|span|\s?\/span|strong|\s?\/strong|small|\s?\/small|table|\s?\/table|thead|\s?\/thead|tbody|\s?\/tbody|td|\s?\/td|tr|\s?\/tr|th|\s?\/th|h1|\s?\/h1|h2|\s?\/h2|h3|\s?\/h3|h4|\s?\/h4|h5|\s?\/h5|h6|\s?\/h6|title|\s?\/title|p|\s?\/p|em|\s?\/em|b|\s?\/b|i|\s?\/i|u|\s?\/u|strike|\s?\/strike|bold|\s?\/bold|a|\s?\/a|table|\s?\/table|li|\s?\/li|ol|\s?\/ol|ul|\s?\/ul|img|\s?\/img|svg|\s?\/svg|div|\s?\/div|center|\s?\/center))/gu;
 exports.greaterThan = /(?<!(button|code|details|summary|hr|br|span|strong|small|table|thead|tbody|td|tr|th|h1|h2|h3|h4|h5|h6|title|p|em|b|i|u|strike|bold|a|li|ol|ul|img|svg|div|center|\/|\s|"|'))>/gu;
 exports.codeFence = /`{1,3}[\s\S]*?`{1,3}/g;
+exports.curlyBrackets = /([{|}])/g;
+exports.codeBlock = /(^```.*[\s\S]*?```$|`[^`].+?`)/gm;
+function clean(value) {
+    if (!value) {
+        return "";
+    }
+    let sections = value.split(exports.codeBlock);
+    for (let sectionIndex in sections) {
+        if (!sections[sectionIndex].startsWith("`")) {
+            sections[sectionIndex] = sections[sectionIndex]
+                .replace(exports.lessThan, "&lt;")
+                .replace(exports.greaterThan, "&gt;")
+                .replace(exports.codeFence, function (match) {
+                return match.replace(/\\>/g, ">");
+            })
+                .replace(exports.curlyBrackets, "\\$1");
+        }
+    }
+    return sections.join("");
+}
+exports.clean = clean;

package/lib/openapi/openapi.d.ts

@@ -1,12 +1,12 @@
+import { OpenApiObject, TagGroupObject, TagObject } from "./types";
 import { ApiMetadata, APIOptions, SidebarOptions } from "../types";
-import { OpenApiObject, TagObject } from "./types";
 interface OpenApiFiles {
     source: string;
     sourceDirName: string;
     data: OpenApiObject;
 }
 export declare function readOpenapiFiles(openapiPath: string): Promise<OpenApiFiles[]>;
-export declare function processOpenapiFiles(files: OpenApiFiles[], options: APIOptions, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[][]]>;
-export declare function processOpenapiFile(openapiData: OpenApiObject, options: APIOptions, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[]]>;
+export declare function processOpenapiFiles(files: OpenApiFiles[], options: APIOptions, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[][], TagGroupObject[]]>;
+export declare function processOpenapiFile(openapiData: OpenApiObject, options: APIOptions, sidebarOptions: SidebarOptions): Promise<[ApiMetadata[], TagObject[], TagGroupObject[]]>;
 export declare function getTagDisplayName(tagName: string, tags: TagObject[]): string;
 export {};

package/lib/openapi/openapi.js

@@ -20,9 +20,9 @@ const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const kebabCase_1 = __importDefault(require("lodash/kebabCase"));
 const unionBy_1 = __importDefault(require("lodash/unionBy"));
 const uniq_1 = __importDefault(require("lodash/uniq"));
-const index_1 = require("../index");
 const createRequestExample_1 = require("./createRequestExample");
 const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
+const index_1 = require("../index");
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
  */
@@ -61,7 +61,7 @@ async function createPostmanCollection(openapiData) {
     return await jsonToCollection(data);
 }
 function createItems(openapiData, options, sidebarOptions) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4;
     // TODO: Find a better way to handle this
     let items = [];
     const infoIdSpaces = openapiData.info.title.replace(" ", "-").toLowerCase();
@@ -324,9 +324,42 @@ function createItems(openapiData, options, sidebarOptions) {
             items.push(apiPage);
         }
     }
+    if ((options === null || options === void 0 ? void 0 : options.showSchemas) === true) {
+        // Gather schemas
+        for (let [schema, schemaObject] of Object.entries((_1 = (_0 = openapiData === null || openapiData === void 0 ? void 0 : openapiData.components) === null || _0 === void 0 ? void 0 : _0.schemas) !== null && _1 !== void 0 ? _1 : {})) {
+            const baseIdSpaces = (_3 = (_2 = schemaObject === null || schemaObject === void 0 ? void 0 : schemaObject.title) === null || _2 === void 0 ? void 0 : _2.replace(" ", "-").toLowerCase()) !== null && _3 !== void 0 ? _3 : "";
+            const baseId = (0, kebabCase_1.default)(baseIdSpaces);
+            const schemaDescription = schemaObject.description;
+            let splitDescription;
+            if (schemaDescription) {
+                splitDescription = schemaDescription.match(/[^\r\n]+/g);
+            }
+            const schemaPage = {
+                type: "schema",
+                id: baseId,
+                infoId: infoId !== null && infoId !== void 0 ? infoId : "",
+                unversionedId: baseId,
+                title: schemaObject.title
+                    ? schemaObject.title.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                    : schema,
+                description: schemaObject.description
+                    ? schemaObject.description.replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                    : "",
+                frontMatter: {
+                    description: splitDescription
+                        ? splitDescription[0]
+                            .replace(/((?:^|[^\\])(?:\\{2})*)"/g, "$1'")
+                            .replace(/\s+$/, "")
+                        : "",
+                },
+                schema: schemaObject,
+            };
+            items.push(schemaPage);
+        }
+    }
     if ((sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "tag") {
         // Get global tags
-        const tags = (_0 = openapiData.tags) !== null && _0 !== void 0 ? _0 : [];
+        const tags = (_4 = openapiData.tags) !== null && _4 !== void 0 ? _4 : [];
         // Get operation tags
         const apiItems = items.filter((item) => {
             return item.type === "api";
@@ -373,9 +406,11 @@ function bindCollectionToApiItems(items, postmanCollection) {
         const method = item.request.method.toLowerCase();
         const path = item.request.url
             .getPath({ unresolved: true }) // unresolved returns "/:variableName" instead of "/<type>"
-            .replace(/:([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
+            .replace(/(?<![a-z0-9-_]+):([a-z0-9-_]+)/gi, "{$1}"); // replace "/:variableName" with "/{variableName}"
         const apiItem = items.find((item) => {
-            if (item.type === "info" || item.type === "tag") {
+            if (item.type === "info" ||
+                item.type === "tag" ||
+                item.type === "schema") {
                 return false;
             }
             return item.api.path === path && item.api.method === method;
@@ -426,7 +461,8 @@ async function processOpenapiFiles(files, options, sidebarOptions) {
                 ...item,
             }));
             const tags = processedFile[1];
-            return [itemsObjectsArray, tags];
+            const tagGroups = processedFile[2];
+            return [itemsObjectsArray, tags, tagGroups];
         }
         console.warn(chalk_1.default.yellow(`WARNING: the following OpenAPI spec returned undefined: ${file.source}`));
         return [];
@@ -449,7 +485,20 @@ async function processOpenapiFiles(files, options, sidebarOptions) {
         // Remove undefined tags due to transient parsing errors
         return x !== undefined;
     });
-    return [items, tags];
+    const tagGroups = metadata
+        .map(function (x) {
+        return x[2];
+    })
+        .flat()
+        .filter(function (x) {
+        // Remove undefined tags due to transient parsing errors
+        return x !== undefined;
+    });
+    return [
+        items,
+        tags,
+        tagGroups,
+    ];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
 async function processOpenapiFile(openapiData, options, sidebarOptions) {
@@ -460,7 +509,11 @@ async function processOpenapiFile(openapiData, options, sidebarOptions) {
     if (openapiData.tags !== undefined) {
         tags = openapiData.tags;
     }
-    return [items, tags];
+    let tagGroups = [];
+    if (openapiData["x-tagGroups"] !== undefined) {
+        tagGroups = openapiData["x-tagGroups"];
+    }
+    return [items, tags, tagGroups];
 }
 exports.processOpenapiFile = processOpenapiFile;
 // order for picking items as a display name of tags

package/lib/openapi/openapi.test.js

@@ -24,6 +24,8 @@ describe("openapi", () => {
             const yaml = results.find((x) => x.source.endsWith("openapi.yaml"));
             expect(yaml).toBeTruthy();
             expect(yaml === null || yaml === void 0 ? void 0 : yaml.sourceDirName).toBe(".");
+            expect(yaml === null || yaml === void 0 ? void 0 : yaml.data.tags).toBeDefined();
+            expect(yaml === null || yaml === void 0 ? void 0 : yaml.data["x-tagGroups"]).toBeDefined();
         });
     });
 });

package/lib/openapi/types.d.ts

@@ -13,6 +13,7 @@ export interface OpenApiObject {
     externalDocs?: ExternalDocumentationObject;
     swagger?: string;
     "x-webhooks"?: PathsObject;
+    "x-tagGroups"?: TagGroupObject[];
 }
 export interface OpenApiObjectWithRef {
     openapi: string;
@@ -81,8 +82,8 @@ export interface ComponentsObjectWithRef {
     links?: Map<LinkObject | ReferenceObject>;
     callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
 }
-export declare type PathsObject = Map<PathItemObject>;
-export declare type PathsObjectWithRef = Map<PathItemObjectWithRef>;
+export type PathsObject = Map<PathItemObject>;
+export type PathsObjectWithRef = Map<PathItemObjectWithRef>;
 export interface PathItemObject {
     $ref?: string;
     summary?: string;
@@ -214,8 +215,8 @@ export interface EncodingObjectWithRef {
     explode?: boolean;
     allowReserved?: boolean;
 }
-export declare type ResponsesObject = Map<ResponseObject>;
-export declare type ResponsesObjectWithRef = Map<ResponseObjectWithRef | ReferenceObject>;
+export type ResponsesObject = Map<ResponseObject>;
+export type ResponsesObjectWithRef = Map<ResponseObjectWithRef | ReferenceObject>;
 export interface ResponseObject {
     description: string;
     headers?: Map<HeaderObject>;
@@ -228,8 +229,8 @@ export interface ResponseObjectWithRef {
     content?: Map<MediaTypeObjectWithRef>;
     links?: Map<LinkObject | ReferenceObject>;
 }
-export declare type CallbackObject = Map<PathItemObject>;
-export declare type CallbackObjectWithRef = Map<PathItemObjectWithRef>;
+export type CallbackObject = Map<PathItemObject>;
+export type CallbackObjectWithRef = Map<PathItemObjectWithRef>;
 export interface ExampleObject {
     summary?: string;
     description?: string;
@@ -244,19 +245,23 @@ export interface LinkObject {
     description?: string;
     server?: ServerObject;
 }
-export declare type HeaderObject = Omit<ParameterObject, "name" | "in">;
-export declare type HeaderObjectWithRef = Omit<ParameterObjectWithRef, "name" | "in">;
+export type HeaderObject = Omit<ParameterObject, "name" | "in">;
+export type HeaderObjectWithRef = Omit<ParameterObjectWithRef, "name" | "in">;
 export interface TagObject {
     name?: string;
     description?: string;
     externalDocs?: ExternalDocumentationObject;
     "x-displayName"?: string;
 }
+export interface TagGroupObject {
+    name: string;
+    tags: string[];
+}
 export interface ReferenceObject {
     $ref: string;
 }
-export declare type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
-export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
     type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
     allOf?: SchemaObject[];
     oneOf?: SchemaObject[];
@@ -274,7 +279,7 @@ export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" |
     example?: any;
     deprecated?: boolean;
 };
-export declare type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+export type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
     type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
     allOf?: (SchemaObject | ReferenceObject)[];
     oneOf?: (SchemaObject | ReferenceObject)[];
@@ -303,7 +308,7 @@ export interface XMLObject {
     attribute?: boolean;
     wrapped?: boolean;
 }
-export declare type SecuritySchemeObject = ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject;
+export type SecuritySchemeObject = ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject;
 export interface ApiKeySecuritySchemeObject {
     type: "apiKey";
     description?: string;
@@ -340,5 +345,5 @@ export interface OAuthFlowObject {
     refreshUrl?: string;
     scopes: Map<string>;
 }
-export declare type SecurityRequirementObject = Map<string[]>;
+export type SecurityRequirementObject = Map<string[]>;
 export {};

package/lib/openapi/utils/services/OpenAPIParser.d.ts

@@ -1,5 +1,5 @@
 import { OpenAPIRef, OpenAPISchema, OpenAPISpec, Referenced } from "../types";
-export declare type MergedOpenAPISchema = OpenAPISchema & {
+export type MergedOpenAPISchema = OpenAPISchema & {
     parentRefs?: string[];
 };
 /**

package/lib/openapi/utils/services/OpenAPIParser.js

@@ -7,10 +7,11 @@
  * ========================================================================== */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OpenAPIParser = void 0;
+// @ts-nocheck
+const RedocNormalizedOptions_1 = require("./RedocNormalizedOptions");
 const helpers_1 = require("../utils/helpers");
 const JsonPointer_1 = require("../utils/JsonPointer");
 const openapi_1 = require("../utils/openapi");
-const RedocNormalizedOptions_1 = require("./RedocNormalizedOptions");
 /**
  * Helper class to keep track of visited references to avoid
  * endless recursion because of circular refs

package/lib/openapi/utils/services/RedocNormalizedOptions.js

@@ -39,55 +39,6 @@ function argValueToExpandLevel(value, defaultValue = 0) {
     return argValueToNumber(value) || defaultValue;
 }
 class RedocNormalizedOptions {
-    constructor(raw, defaults = {}) {
-        var _a;
-        raw = { ...defaults, ...raw };
-        this.hideHostname = RedocNormalizedOptions.normalizeHideHostname(raw.hideHostname);
-        this.expandResponses = RedocNormalizedOptions.normalizeExpandResponses(raw.expandResponses);
-        this.requiredPropsFirst = argValueToBoolean(raw.requiredPropsFirst);
-        this.sortPropsAlphabetically = argValueToBoolean(raw.sortPropsAlphabetically);
-        this.sortEnumValuesAlphabetically = argValueToBoolean(raw.sortEnumValuesAlphabetically);
-        this.sortOperationsAlphabetically = argValueToBoolean(raw.sortOperationsAlphabetically);
-        this.sortTagsAlphabetically = argValueToBoolean(raw.sortTagsAlphabetically);
-        this.nativeScrollbars = argValueToBoolean(raw.nativeScrollbars);
-        this.pathInMiddlePanel = argValueToBoolean(raw.pathInMiddlePanel);
-        this.untrustedSpec = argValueToBoolean(raw.untrustedSpec);
-        this.hideDownloadButton = argValueToBoolean(raw.hideDownloadButton);
-        this.downloadFileName = raw.downloadFileName;
-        this.downloadDefinitionUrl = raw.downloadDefinitionUrl;
-        this.disableSearch = argValueToBoolean(raw.disableSearch);
-        this.onlyRequiredInSamples = argValueToBoolean(raw.onlyRequiredInSamples);
-        this.showExtensions = RedocNormalizedOptions.normalizeShowExtensions(raw.showExtensions);
-        this.sideNavStyle = RedocNormalizedOptions.normalizeSideNavStyle(raw.sideNavStyle);
-        this.hideSingleRequestSampleTab = argValueToBoolean(raw.hideSingleRequestSampleTab);
-        this.menuToggle = argValueToBoolean(raw.menuToggle, true);
-        this.jsonSampleExpandLevel =
-            RedocNormalizedOptions.normalizeJsonSampleExpandLevel(raw.jsonSampleExpandLevel);
-        this.enumSkipQuotes = argValueToBoolean(raw.enumSkipQuotes);
-        this.hideSchemaTitles = argValueToBoolean(raw.hideSchemaTitles);
-        this.simpleOneOfTypeLabel = argValueToBoolean(raw.simpleOneOfTypeLabel);
-        this.payloadSampleIdx = RedocNormalizedOptions.normalizePayloadSampleIdx(raw.payloadSampleIdx);
-        this.expandSingleSchemaField = argValueToBoolean(raw.expandSingleSchemaField);
-        this.schemaExpansionLevel = argValueToExpandLevel(raw.schemaExpansionLevel);
-        this.showObjectSchemaExamples = argValueToBoolean(raw.showObjectSchemaExamples);
-        this.showSecuritySchemeType = argValueToBoolean(raw.showSecuritySchemeType);
-        this.hideSecuritySection = argValueToBoolean(raw.hideSecuritySection);
-        this.unstable_ignoreMimeParameters = argValueToBoolean(raw.unstable_ignoreMimeParameters);
-        this.expandDefaultServerVariables = argValueToBoolean(raw.expandDefaultServerVariables);
-        this.maxDisplayedEnumValues = argValueToNumber(raw.maxDisplayedEnumValues);
-        const ignoreNamedSchemas = (0, helpers_1.isArray)(raw.ignoreNamedSchemas)
-            ? raw.ignoreNamedSchemas
-            : (_a = raw.ignoreNamedSchemas) === null || _a === void 0 ? void 0 : _a.split(",").map((s) => s.trim());
-        this.ignoreNamedSchemas = new Set(ignoreNamedSchemas);
-        this.hideSchemaPattern = argValueToBoolean(raw.hideSchemaPattern);
-        this.generatedPayloadSamplesMaxDepth =
-            RedocNormalizedOptions.normalizeGeneratedPayloadSamplesMaxDepth(raw.generatedPayloadSamplesMaxDepth);
-        this.nonce = raw.nonce;
-        this.hideFab = argValueToBoolean(raw.hideFab);
-        this.minCharacterLengthToInitSearch =
-            argValueToNumber(raw.minCharacterLengthToInitSearch) || 3;
-        this.showWebhookVerb = argValueToBoolean(raw.showWebhookVerb);
-    }
     static normalizeExpandResponses(value) {
         if (value === "all") {
             return "all";
@@ -166,5 +117,54 @@ class RedocNormalizedOptions {
         }
         return 10;
     }
+    constructor(raw, defaults = {}) {
+        var _a;
+        raw = { ...defaults, ...raw };
+        this.hideHostname = RedocNormalizedOptions.normalizeHideHostname(raw.hideHostname);
+        this.expandResponses = RedocNormalizedOptions.normalizeExpandResponses(raw.expandResponses);
+        this.requiredPropsFirst = argValueToBoolean(raw.requiredPropsFirst);
+        this.sortPropsAlphabetically = argValueToBoolean(raw.sortPropsAlphabetically);
+        this.sortEnumValuesAlphabetically = argValueToBoolean(raw.sortEnumValuesAlphabetically);
+        this.sortOperationsAlphabetically = argValueToBoolean(raw.sortOperationsAlphabetically);
+        this.sortTagsAlphabetically = argValueToBoolean(raw.sortTagsAlphabetically);
+        this.nativeScrollbars = argValueToBoolean(raw.nativeScrollbars);
+        this.pathInMiddlePanel = argValueToBoolean(raw.pathInMiddlePanel);
+        this.untrustedSpec = argValueToBoolean(raw.untrustedSpec);
+        this.hideDownloadButton = argValueToBoolean(raw.hideDownloadButton);
+        this.downloadFileName = raw.downloadFileName;
+        this.downloadDefinitionUrl = raw.downloadDefinitionUrl;
+        this.disableSearch = argValueToBoolean(raw.disableSearch);
+        this.onlyRequiredInSamples = argValueToBoolean(raw.onlyRequiredInSamples);
+        this.showExtensions = RedocNormalizedOptions.normalizeShowExtensions(raw.showExtensions);
+        this.sideNavStyle = RedocNormalizedOptions.normalizeSideNavStyle(raw.sideNavStyle);
+        this.hideSingleRequestSampleTab = argValueToBoolean(raw.hideSingleRequestSampleTab);
+        this.menuToggle = argValueToBoolean(raw.menuToggle, true);
+        this.jsonSampleExpandLevel =
+            RedocNormalizedOptions.normalizeJsonSampleExpandLevel(raw.jsonSampleExpandLevel);
+        this.enumSkipQuotes = argValueToBoolean(raw.enumSkipQuotes);
+        this.hideSchemaTitles = argValueToBoolean(raw.hideSchemaTitles);
+        this.simpleOneOfTypeLabel = argValueToBoolean(raw.simpleOneOfTypeLabel);
+        this.payloadSampleIdx = RedocNormalizedOptions.normalizePayloadSampleIdx(raw.payloadSampleIdx);
+        this.expandSingleSchemaField = argValueToBoolean(raw.expandSingleSchemaField);
+        this.schemaExpansionLevel = argValueToExpandLevel(raw.schemaExpansionLevel);
+        this.showObjectSchemaExamples = argValueToBoolean(raw.showObjectSchemaExamples);
+        this.showSecuritySchemeType = argValueToBoolean(raw.showSecuritySchemeType);
+        this.hideSecuritySection = argValueToBoolean(raw.hideSecuritySection);
+        this.unstable_ignoreMimeParameters = argValueToBoolean(raw.unstable_ignoreMimeParameters);
+        this.expandDefaultServerVariables = argValueToBoolean(raw.expandDefaultServerVariables);
+        this.maxDisplayedEnumValues = argValueToNumber(raw.maxDisplayedEnumValues);
+        const ignoreNamedSchemas = (0, helpers_1.isArray)(raw.ignoreNamedSchemas)
+            ? raw.ignoreNamedSchemas
+            : (_a = raw.ignoreNamedSchemas) === null || _a === void 0 ? void 0 : _a.split(",").map((s) => s.trim());
+        this.ignoreNamedSchemas = new Set(ignoreNamedSchemas);
+        this.hideSchemaPattern = argValueToBoolean(raw.hideSchemaPattern);
+        this.generatedPayloadSamplesMaxDepth =
+            RedocNormalizedOptions.normalizeGeneratedPayloadSamplesMaxDepth(raw.generatedPayloadSamplesMaxDepth);
+        this.nonce = raw.nonce;
+        this.hideFab = argValueToBoolean(raw.hideFab);
+        this.minCharacterLengthToInitSearch =
+            argValueToNumber(raw.minCharacterLengthToInitSearch) || 3;
+        this.showWebhookVerb = argValueToBoolean(raw.showWebhookVerb);
+    }
 }
 exports.RedocNormalizedOptions = RedocNormalizedOptions;

package/lib/openapi/utils/types/index.d.ts

@@ -1,2 +1,2 @@
 export * from "./open-api";
-export declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+export type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;