docusaurus-plugin-openapi-docs 2.0.4 → 2.1.0

package/README.md

@@ -31,6 +31,7 @@ Key Features:
 
 | Docusaurus OpenAPI Docs | Docusaurus      |
 | ----------------------- | --------------- |
+| 3.0.0-beta.x (beta)     | `3.0.1 - 3.1.1` |
 | 2.0.x (current)         | `2.4.1 - 2.4.3` |
 | 1.7.3 (legacy)          | `2.0.1 - 2.2.0` |
 
@@ -159,6 +160,7 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | `baseUrl`            | `string`  | `null`  | _Optional:_ Version base URL used when generating version selector dropdown menu.                                                               |
 | `versions`           | `object`  | `null`  | _Optional:_ Set of options for versioning configuration. See below for a list of supported options.                                             |
 | `markdownGenerators` | `object`  | `null`  | _Optional:_ Customize MDX content with a set of options for specifying markdown generator functions. See below for a list of supported options. |
+| `showSchemas`        | `boolean` | `null`  | _Optional:_ If set to `true`, generates schema pages and adds them to the sidebar.                                                              |
 
 `sidebarOptions` can be configured with the following options:
 

package/lib/index.js

@@ -77,7 +77,7 @@ function pluginOpenAPIDocs(context, options) {
     let docRouteBasePath = docData ? docData.routeBasePath : undefined;
     let docPath = docData ? (docData.path ? docData.path : "docs") : undefined;
     async function generateApiDocs(options, pluginId) {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         let { specPath, outputDir, template, markdownGenerators, downloadUrl, sidebarOptions, } = options;
         // Remove trailing slash before proceeding
         outputDir = outputDir.replace(/\/$/, "");
@@ -92,7 +92,7 @@ function pluginOpenAPIDocs(context, options) {
             : path_1.default.resolve(siteDir, specPath);
         try {
             const openapiFiles = await (0, openapi_1.readOpenapiFiles)(contentPath);
-            const [loadedApi, tags] = await (0, openapi_1.processOpenapiFiles)(openapiFiles, options, sidebarOptions);
+            const [loadedApi, tags, tagGroups] = await (0, openapi_1.processOpenapiFiles)(openapiFiles, options, sidebarOptions);
             if (!fs_1.default.existsSync(outputDir)) {
                 try {
                     fs_1.default.mkdirSync(outputDir, { recursive: true });
@@ -104,7 +104,7 @@ function pluginOpenAPIDocs(context, options) {
             }
             // TODO: figure out better way to set default
             if (Object.keys(sidebarOptions !== null && sidebarOptions !== void 0 ? sidebarOptions : {}).length > 0) {
-                const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, options, loadedApi, tags, docPath);
+                const sidebarSlice = (0, sidebars_1.default)(sidebarOptions, options, loadedApi, tags, docPath, tagGroups);
                 const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
                 const view = (0, mustache_1.render)(sidebarSliceTemplate, {
                     slice: JSON.stringify(sidebarSlice),
@@ -195,20 +195,35 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
 <DocCardList items={useCurrentSidebarCategory().items}/>
 \`\`\`
       `;
+            const schemaMdTemplate = `---
+id: {{{id}}}
+title: "{{{title}}}"
+description: "{{{frontMatter.description}}}"
+sidebar_label: "{{{title}}}"
+hide_title: true
+schema: true
+custom_edit_url: null
+---
+
+{{{markdown}}}
+            `;
             const apiPageGenerator = (_a = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createApiPageMD) !== null && _a !== void 0 ? _a : markdown_1.createApiPageMD;
             const infoPageGenerator = (_b = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createInfoPageMD) !== null && _b !== void 0 ? _b : markdown_1.createInfoPageMD;
             const tagPageGenerator = (_c = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createTagPageMD) !== null && _c !== void 0 ? _c : markdown_1.createTagPageMD;
+            const schemaPageGenerator = (_d = markdownGenerators === null || markdownGenerators === void 0 ? void 0 : markdownGenerators.createSchemaPageMD) !== null && _d !== void 0 ? _d : markdown_1.createSchemaPageMD;
+            const pageGeneratorByType = {
+                api: apiPageGenerator,
+                info: infoPageGenerator,
+                tag: tagPageGenerator,
+                schema: schemaPageGenerator,
+            };
             loadedApi.map(async (item) => {
                 if (item.type === "info") {
                     if (downloadUrl && isURL(downloadUrl)) {
                         item.downloadUrl = downloadUrl;
                     }
                 }
-                const markdown = item.type === "api"
-                    ? apiPageGenerator(item)
-                    : item.type === "info"
-                        ? infoPageGenerator(item)
-                        : tagPageGenerator(item);
+                const markdown = pageGeneratorByType[item.type](item);
                 item.markdown = markdown;
                 if (item.type === "api") {
                     // opportunity to compress JSON
@@ -274,6 +289,32 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                         }
                     }
                 }
+                if (item.type === "schema") {
+                    if (!fs_1.default.existsSync(`${outputDir}/schemas/${item.id}.schema.mdx`)) {
+                        if (!fs_1.default.existsSync(`${outputDir}/schemas`)) {
+                            try {
+                                fs_1.default.mkdirSync(`${outputDir}/schemas`, { recursive: true });
+                                console.log(chalk_1.default.green(`Successfully created "${outputDir}/schemas"`));
+                            }
+                            catch (err) {
+                                console.error(chalk_1.default.red(`Failed to create "${outputDir}/schemas"`), chalk_1.default.yellow(err));
+                            }
+                        }
+                        try {
+                            // kebabCase(arg) returns 0-length string when arg is undefined
+                            if (item.id.length === 0) {
+                                throw Error("Schema must have title defined");
+                            }
+                            // eslint-disable-next-line testing-library/render-result-naming-convention
+                            const schemaView = (0, mustache_1.render)(schemaMdTemplate, item);
+                            fs_1.default.writeFileSync(`${outputDir}/schemas/${item.id}.schema.mdx`, schemaView, "utf8");
+                            console.log(chalk_1.default.green(`Successfully created "${outputDir}/${item.id}.schema.mdx"`));
+                        }
+                        catch (err) {
+                            console.error(chalk_1.default.red(`Failed to write "${outputDir}/${item.id}.schema.mdx"`), chalk_1.default.yellow(err));
+                        }
+                    }
+                }
                 return;
             });
             return;
@@ -290,6 +331,10 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
         });
+        const schemaMdxFiles = await (0, utils_1.Globby)(["*.schema.mdx"], {
+            cwd: path_1.default.resolve(apiDir, "schemas"),
+            deep: 1,
+        });
         const sidebarFile = await (0, utils_1.Globby)(["sidebar.js"], {
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
@@ -302,6 +347,14 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                 console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/${mdx}"`));
             }
         }));
+        schemaMdxFiles.map((mdx) => fs_1.default.unlink(`${apiDir}/schemas/${mdx}`, (err) => {
+            if (err) {
+                console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/schemas/${mdx}"`), chalk_1.default.yellow(err));
+            }
+            else {
+                console.log(chalk_1.default.green(`Cleanup succeeded for "${apiDir}/schemas/${mdx}"`));
+            }
+        }));
         sidebarFile.map((sidebar) => fs_1.default.unlink(`${apiDir}/${sidebar}`, (err) => {
             if (err) {
                 console.error(chalk_1.default.red(`Cleanup failed for "${apiDir}/${sidebar}"`), chalk_1.default.yellow(err));

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 = "";

package/lib/markdown/index.d.ts

@@ -1,4 +1,5 @@
-import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
+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,7 +6,7 @@
  * 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");
@@ -21,6 +21,7 @@ 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");
@@ -48,7 +49,7 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
             : 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" }),
@@ -84,3 +85,18 @@ 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 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/utils.d.ts

@@ -1,5 +1,5 @@
-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;

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";
@@ -375,7 +408,9 @@ function bindCollectionToApiItems(items, postmanCollection) {
             .getPath({ unresolved: true }) // unresolved returns "/:variableName" instead of "/<type>"
             .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>>;

package/lib/openapi/utils/types/open-api.d.ts

@@ -38,7 +38,7 @@ export interface OpenAPIPaths {
 export interface OpenAPIRef {
     $ref: string;
 }
-export declare type Referenced<T> = OpenAPIRef | T;
+export type Referenced<T> = OpenAPIRef | T;
 export interface OpenAPIPath {
     summary?: string;
     description?: string;
@@ -182,8 +182,8 @@ export interface OpenAPIEncoding {
     explode: boolean;
     allowReserved: boolean;
 }
-export declare type OpenAPIParameterLocation = "query" | "header" | "path" | "cookie";
-export declare type OpenAPIParameterStyle = "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+export type OpenAPIParameterLocation = "query" | "header" | "path" | "cookie";
+export type OpenAPIParameterStyle = "matrix" | "label" | "form" | "simple" | "spaceDelimited" | "pipeDelimited" | "deepObject";
 export interface OpenAPIRequestBody {
     description?: string;
     required?: boolean;
@@ -216,7 +216,7 @@ export interface OpenAPIResponse extends Pick<OpenAPIRequestBody, "description"
 export interface OpenAPILink {
     $ref?: string;
 }
-export declare type OpenAPIHeader = Omit<OpenAPIParameter, "in" | "name">;
+export type OpenAPIHeader = Omit<OpenAPIParameter, "in" | "name">;
 export interface OpenAPICallback {
     [name: string]: OpenAPIPath;
 }