docusaurus-plugin-openapi-docs 3.0.0-beta.2 → 3.0.0-beta.3

package/lib/index.js

@@ -105,17 +105,19 @@ 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 sidebarSliceTemplate = `module.exports = {{{slice}}};`;
+                let sidebarSliceTemplate = `import {SidebarConfig} from "@docusaurus/plugin-content-docs/src/sidebars/types";\n\n`;
+                sidebarSliceTemplate += `const sidebar: SidebarConfig = {{{slice}}};\n\n`;
+                sidebarSliceTemplate += `export default sidebar;`;
                 const view = (0, mustache_1.render)(sidebarSliceTemplate, {
-                    slice: JSON.stringify(sidebarSlice),
+                    slice: JSON.stringify(sidebarSlice, null, 2),
                 });
-                if (!fs_1.default.existsSync(`${outputDir}/sidebar.js`)) {
+                if (!fs_1.default.existsSync(`${outputDir}/sidebar.ts`)) {
                     try {
-                        fs_1.default.writeFileSync(`${outputDir}/sidebar.js`, view, "utf8");
-                        console.log(chalk_1.default.green(`Successfully created "${outputDir}/sidebar.js"`));
+                        fs_1.default.writeFileSync(`${outputDir}/sidebar.ts`, view, "utf8");
+                        console.log(chalk_1.default.green(`Successfully created "${outputDir}/sidebar.ts"`));
                     }
                     catch (err) {
-                        console.error(chalk_1.default.red(`Failed to write "${outputDir}/sidebar.js"`), chalk_1.default.yellow(err));
+                        console.error(chalk_1.default.red(`Failed to write "${outputDir}/sidebar.ts"`), chalk_1.default.yellow(err));
                     }
                 }
             }
@@ -290,7 +292,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
         });
-        const sidebarFile = await (0, utils_1.Globby)(["sidebar.js"], {
+        const sidebarFile = await (0, utils_1.Globby)(["sidebar.ts"], {
             cwd: path_1.default.resolve(apiDir),
             deep: 1,
         });
@@ -346,7 +348,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
         extendCli(cli) {
             cli
                 .command(`gen-api-docs`)
-                .description(`Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`)
+                .description(`Generates OpenAPI docs in MDX file format and sidebar.ts (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
@@ -394,7 +396,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             });
             cli
                 .command(`gen-api-docs:version`)
-                .description(`Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`)
+                .description(`Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.ts (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
@@ -469,7 +471,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             });
             cli
                 .command(`clean-api-docs`)
-                .description(`Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`)
+                .description(`Clears the generated OpenAPI docs MDX files and sidebar.ts (if enabled).`)
                 .usage("<id>")
                 .arguments("<id>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")
@@ -512,7 +514,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             });
             cli
                 .command(`clean-api-docs:version`)
-                .description(`Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`)
+                .description(`Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.ts (if enabled).`)
                 .usage("<id:version>")
                 .arguments("<id:version>")
                 .option("-p, --plugin-id <plugin>", "OpenAPI docs plugin ID.")

package/lib/markdown/createDeprecationNotice.js

@@ -12,8 +12,11 @@ function createAdmonition({ children }) {
     return `:::caution deprecated\n\n${(0, utils_1.render)(children)}\n\n:::`;
 }
 function createDeprecationNotice({ deprecated, description, }) {
-    return (0, utils_1.guard)(deprecated, () => createAdmonition({
-        children: description !== null && description !== void 0 ? description : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
-    }));
+    return (0, utils_1.guard)(deprecated, () => {
+        var _a;
+        return createAdmonition({
+            children: (_a = (0, utils_1.clean)(description)) !== null && _a !== void 0 ? _a : "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
+        });
+    });
 }
 exports.createDeprecationNotice = createDeprecationNotice;

package/lib/markdown/createDescription.js

@@ -9,14 +9,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createDescription = void 0;
 const utils_1 = require("./utils");
 function createDescription(description) {
-    if (!description) {
-        return "";
-    }
-    return `\n\n${description
-        .replace(utils_1.lessThan, "<")
-        .replace(utils_1.greaterThan, ">")
-        .replace(utils_1.codeFence, function (match) {
-        return match.replace(/\\>/g, ">");
-    })}\n\n`;
+    return `\n\n${(0, utils_1.clean)(description)}\n\n`;
 }
 exports.createDescription = createDescription;

package/lib/markdown/createHeading.js

@@ -12,9 +12,7 @@ function createHeading(heading) {
     return [
         (0, utils_1.create)("h1", {
             className: "openapi__heading",
-            children: `${heading
-                .replace(utils_1.lessThan, "<")
-                .replace(utils_1.greaterThan, ">")}`,
+            children: (0, utils_1.clean)(heading),
         }),
         `\n\n`,
     ];

package/lib/markdown/createSchema.test.js

@@ -32,7 +32,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const prettier = __importStar(require("prettier"));
 const createSchema_1 = require("./createSchema");
 describe("createNodes", () => {
-    it("should create readable MODs for oneOf primitive properties", () => {
+    it("should create readable MODs for oneOf primitive properties", async () => {
         const schema = {
             type: "object",
             properties: {
@@ -68,6 +68,6 @@ describe("createNodes", () => {
                 },
             },
         };
-        expect((0, createSchema_1.createNodes)(schema, "request").map((md) => prettier.format(md, { parser: "babel" }))).toMatchSnapshot();
+        expect(await Promise.all((0, createSchema_1.createNodes)(schema, "request").map(async (md) => await prettier.format(md, { parser: "babel" })))).toMatchSnapshot();
     });
 });

package/lib/markdown/index.js

@@ -37,7 +37,7 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
         `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, createHeading_1.createHeading)(title),
         (0, createMethodEndpoint_1.createMethodEndpoint)(method, path),
         infoPath && (0, createAuthorization_1.createAuthorization)(infoPath),
         frontMatter.show_extensions && (0, createVendorExtensions_1.createVendorExtensions)(extensions),
@@ -64,7 +64,7 @@ function createInfoPageMD({ info: { title, version, description, contact, licens
         `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),

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;
@@ -8,3 +8,6 @@ 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,7 +6,7 @@
  * 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;
+exports.clean = exports.codeBlock = exports.curlyBrackets = exports.codeFence = exports.greaterThan = exports.lessThan = exports.render = exports.guard = exports.create = void 0;
 function create(tag, props) {
     const { children, ...rest } = props;
     let propString = "";
@@ -41,3 +41,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/types.d.ts

@@ -81,8 +81,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 +214,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 +228,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,8 +244,8 @@ 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;
@@ -255,8 +255,8 @@ export interface TagObject {
 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 +274,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 +303,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 +340,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/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;
 }

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

@@ -1,4 +1,4 @@
-declare type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
+type Omit<T, K extends keyof T> = Pick<T, Exclude<keyof T, K>>;
 export interface OpenAPISpec {
     openapi: string;
     info: OpenAPIInfo;
@@ -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;
 }

package/lib/openapi/utils/utils/openapi.js

@@ -534,7 +534,7 @@ exports.setSecuritySchemePrefix = setSecuritySchemePrefix;
 const shortenHTTPVerb = (verb) => ({
     delete: "del",
     options: "opts",
-}[verb] || verb);
+})[verb] || verb;
 exports.shortenHTTPVerb = shortenHTTPVerb;
 function isRedocExtension(key) {
     const redocExtensions = {

package/lib/types.d.ts

@@ -48,7 +48,7 @@ export interface APIVersionOptions {
 export interface LoadedContent {
     loadedApi: ApiMetadata[];
 }
-export declare type ApiMetadata = ApiPageMetadata | InfoPageMetadata | TagPageMetadata;
+export type ApiMetadata = ApiPageMetadata | InfoPageMetadata | TagPageMetadata;
 export interface ApiMetadataBase {
     sidebar?: string;
     previous?: ApiNavLink;
@@ -100,7 +100,7 @@ export interface TagPageMetadata extends ApiMetadataBase {
     tag: TagObject;
     markdown?: string;
 }
-export declare type ApiInfo = InfoObject;
+export type ApiInfo = InfoObject;
 export interface ApiNavLink {
     title: string;
     permalink: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "3.0.0-beta.2",
+  "version": "3.0.0-beta.3",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,18 +28,19 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/types": "^3.0.0",
+    "@docusaurus/types": "^3.0.1",
     "@types/fs-extra": "^9.0.13",
     "@types/json-pointer": "^1.0.31",
     "@types/json-schema": "^7.0.9",
     "@types/lodash": "^4.14.176",
-    "@types/mustache": "^4.1.2"
+    "@types/mustache": "^4.1.2",
+    "eslint-plugin-prettier": "^5.0.1"
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^10.1.0",
-    "@docusaurus/plugin-content-docs": "^3.0.0",
-    "@docusaurus/utils": "^3.0.0",
-    "@docusaurus/utils-validation": "^3.0.0",
+    "@docusaurus/plugin-content-docs": "^3.0.1",
+    "@docusaurus/utils": "^3.0.1",
+    "@docusaurus/utils-validation": "^3.0.1",
     "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.0.0-beta.125",
@@ -60,5 +61,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "9e573198abcfbdd4af3b89f92658d0bf94648cfa"
+  "gitHead": "4836267b8bcc01d496449e6d531663a00dfdb4ed"
 }

package/src/index.ts

@@ -144,21 +144,23 @@ export default function pluginOpenAPIDocs(
           docPath
         );
 
-        const sidebarSliceTemplate = `module.exports = {{{slice}}};`;
+        let sidebarSliceTemplate = `import {SidebarConfig} from "@docusaurus/plugin-content-docs/src/sidebars/types";\n\n`;
+        sidebarSliceTemplate += `const sidebar: SidebarConfig = {{{slice}}};\n\n`;
+        sidebarSliceTemplate += `export default sidebar;`;
 
         const view = render(sidebarSliceTemplate, {
-          slice: JSON.stringify(sidebarSlice),
+          slice: JSON.stringify(sidebarSlice, null, 2),
         });
 
-        if (!fs.existsSync(`${outputDir}/sidebar.js`)) {
+        if (!fs.existsSync(`${outputDir}/sidebar.ts`)) {
           try {
-            fs.writeFileSync(`${outputDir}/sidebar.js`, view, "utf8");
+            fs.writeFileSync(`${outputDir}/sidebar.ts`, view, "utf8");
             console.log(
-              chalk.green(`Successfully created "${outputDir}/sidebar.js"`)
+              chalk.green(`Successfully created "${outputDir}/sidebar.ts"`)
             );
           } catch (err) {
             console.error(
-              chalk.red(`Failed to write "${outputDir}/sidebar.js"`),
+              chalk.red(`Failed to write "${outputDir}/sidebar.ts"`),
               chalk.yellow(err)
             );
           }
@@ -261,8 +263,8 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
           item.type === "api"
             ? apiPageGenerator(item)
             : item.type === "info"
-            ? infoPageGenerator(item)
-            : tagPageGenerator(item);
+              ? infoPageGenerator(item)
+              : tagPageGenerator(item);
         item.markdown = markdown;
         if (item.type === "api") {
           // opportunity to compress JSON
@@ -380,7 +382,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
       cwd: path.resolve(apiDir),
       deep: 1,
     });
-    const sidebarFile = await Globby(["sidebar.js"], {
+    const sidebarFile = await Globby(["sidebar.ts"], {
       cwd: path.resolve(apiDir),
       deep: 1,
     });
@@ -461,7 +463,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
       cli
         .command(`gen-api-docs`)
         .description(
-          `Generates OpenAPI docs in MDX file format and sidebar.js (if enabled).`
+          `Generates OpenAPI docs in MDX file format and sidebar.ts (if enabled).`
         )
         .usage("<id>")
         .arguments("<id>")
@@ -519,7 +521,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
       cli
         .command(`gen-api-docs:version`)
         .description(
-          `Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.js (if enabled).`
+          `Generates versioned OpenAPI docs in MDX file format, versions.js and sidebar.ts (if enabled).`
         )
         .usage("<id:version>")
         .arguments("<id:version>")
@@ -610,7 +612,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
       cli
         .command(`clean-api-docs`)
         .description(
-          `Clears the generated OpenAPI docs MDX files and sidebar.js (if enabled).`
+          `Clears the generated OpenAPI docs MDX files and sidebar.ts (if enabled).`
         )
         .usage("<id>")
         .arguments("<id>")
@@ -661,7 +663,7 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
       cli
         .command(`clean-api-docs:version`)
         .description(
-          `Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.js (if enabled).`
+          `Clears the versioned, generated OpenAPI docs MDX files, versions.json and sidebar.ts (if enabled).`
         )
         .usage("<id:version>")
         .arguments("<id:version>")

package/src/markdown/createDeprecationNotice.ts

@@ -5,7 +5,7 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { guard, Props, render } from "./utils";
+import { clean, guard, Props, render } from "./utils";
 
 function createAdmonition({ children }: Props) {
   return `:::caution deprecated\n\n${render(children)}\n\n:::`;
@@ -23,7 +23,7 @@ export function createDeprecationNotice({
   return guard(deprecated, () =>
     createAdmonition({
       children:
-        description ??
+        clean(description) ??
         "This endpoint has been deprecated and may be replaced or removed in future versions of the API.",
     })
   );

package/src/markdown/createDescription.ts

@@ -5,16 +5,8 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { greaterThan, codeFence, lessThan } from "./utils";
+import { clean } from "./utils";
 
 export function createDescription(description: string | undefined) {
-  if (!description) {
-    return "";
-  }
-  return `\n\n${description
-    .replace(lessThan, "<")
-    .replace(greaterThan, ">")
-    .replace(codeFence, function (match) {
-      return match.replace(/\\>/g, ">");
-    })}\n\n`;
+  return `\n\n${clean(description)}\n\n`;
 }

package/src/markdown/createHeading.ts

@@ -5,15 +5,13 @@
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
 
-import { create, greaterThan, lessThan } from "./utils";
+import { clean, create } from "./utils";
 
 export function createHeading(heading: string) {
   return [
     create("h1", {
       className: "openapi__heading",
-      children: `${heading
-        .replace(lessThan, "<")
-        .replace(greaterThan, ">")}`,
+      children: clean(heading),
     }),
     `\n\n`,
   ];

package/src/markdown/createSchema.test.ts

@@ -11,7 +11,7 @@ import { SchemaObject } from "../openapi/types";
 import { createNodes } from "./createSchema";
 
 describe("createNodes", () => {
-  it("should create readable MODs for oneOf primitive properties", () => {
+  it("should create readable MODs for oneOf primitive properties", async () => {
     const schema: SchemaObject = {
       type: "object",
       properties: {
@@ -48,8 +48,10 @@ describe("createNodes", () => {
       },
     };
     expect(
-      createNodes(schema, "request").map((md: any) =>
-        prettier.format(md, { parser: "babel" })
+      await Promise.all(
+        createNodes(schema, "request").map(
+          async (md: any) => await prettier.format(md, { parser: "babel" })
+        )
       )
     ).toMatchSnapshot();
   });

package/src/markdown/index.ts

@@ -29,7 +29,7 @@ import { createStatusCodes } from "./createStatusCodes";
 import { createTermsOfService } from "./createTermsOfService";
 import { createVendorExtensions } from "./createVendorExtensions";
 import { createVersionBadge } from "./createVersionBadge";
-import { greaterThan, lessThan, render } from "./utils";
+import { render } from "./utils";
 
 interface Props {
   title: string;
@@ -69,7 +69,7 @@ export function createApiPageMD({
     `import SchemaItem from "@theme/SchemaItem";\n`,
     `import SchemaTabs from "@theme/SchemaTabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
-    createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
+    createHeading(title),
     createMethodEndpoint(method, path),
     infoPath && createAuthorization(infoPath),
     frontMatter.show_extensions && createVendorExtensions(extensions),
@@ -110,7 +110,7 @@ export function createInfoPageMD({
 
     createVersionBadge(version),
     createDownload(downloadUrl),
-    createHeading(title.replace(lessThan, "<").replace(greaterThan, ">")),
+    createHeading(title),
     createLogo(logo, darkLogo),
     createDescription(description),
     createAuthentication(securitySchemes as unknown as SecuritySchemeObject),

package/src/markdown/utils.ts

@@ -50,3 +50,25 @@ export const lessThan =
 export const 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;
 export const codeFence = /`{1,3}[\s\S]*?`{1,3}/g;
+export const curlyBrackets = /\{(.*)}/g;
+export const codeBlock = /^(```.*[\s\S]*?```)$/gm;
+
+export function clean(value: string | undefined): string {
+  if (!value) {
+    return "";
+  }
+
+  let sections = value.split(codeBlock);
+  for (let sectionIndex in sections) {
+    if (!sections[sectionIndex].startsWith("```")) {
+      sections[sectionIndex] = sections[sectionIndex]
+        .replace(lessThan, "&lt;")
+        .replace(greaterThan, "&gt;")
+        .replace(codeFence, function (match) {
+          return match.replace(/\\>/g, ">");
+        })
+        .replace(curlyBrackets, "\\{$1\\}");
+    }
+  }
+  return sections.join("");
+}

package/src/openapi/utils/services/OpenAPIParser.ts

@@ -326,8 +326,8 @@ export class OpenAPIParser {
         const receiverItems = isBoolean(receiver.items)
           ? { items: receiver.items }
           : receiver.items
-          ? (Object.assign({}, receiver.items) as OpenAPISchema)
-          : {};
+            ? (Object.assign({}, receiver.items) as OpenAPISchema)
+            : {};
         const subSchemaItems = isBoolean(items)
           ? { items }
           : (Object.assign({}, items) as OpenAPISchema);

package/src/openapi/utils/utils/openapi.ts

@@ -689,7 +689,7 @@ export const shortenHTTPVerb = (verb) =>
   ({
     delete: "del",
     options: "opts",
-  }[verb] || verb);
+  })[verb] || verb;
 
 export function isRedocExtension(key: string): boolean {
   const redocExtensions = {

package/src/sidebars/index.ts

@@ -228,5 +228,6 @@ export default function generateSidebarSlice(
       docPath
     );
   }
+
   return sidebarSlice;
 }