docusaurus-plugin-openapi-docs 1.0.0 → 1.0.3

package/lib/openapi/createExample.js

@@ -5,8 +5,12 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  * ========================================================================== */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.sampleFromSchema = void 0;
+const chalk_1 = __importDefault(require("chalk"));
 const primitives = {
     string: {
         default: () => "string",
@@ -31,64 +35,70 @@ const primitives = {
     array: {},
 };
 const sampleFromSchema = (schema = {}) => {
-    let { type, example, allOf, properties, items } = schema;
-    if (example !== undefined) {
-        return example;
-    }
-    if (allOf) {
-        // TODO: We are just assuming it will always be an object for now
-        let obj = {
-            type: "object",
-            properties: {},
-            required: [], // NOTE: We shouldn't need to worry about required
-        };
-        for (let item of allOf) {
-            if (item.properties) {
-                obj.properties = {
-                    ...obj.properties,
-                    ...item.properties,
-                };
-            }
-        }
-        return (0, exports.sampleFromSchema)(obj);
-    }
-    if (!type) {
-        if (properties) {
-            type = "object";
+    try {
+        let { type, example, allOf, properties, items } = schema;
+        if (example !== undefined) {
+            return example;
         }
-        else if (items) {
-            type = "array";
+        if (allOf) {
+            // TODO: We are just assuming it will always be an object for now
+            let obj = {
+                type: "object",
+                properties: {},
+                required: [], // NOTE: We shouldn't need to worry about required
+            };
+            for (let item of allOf) {
+                if (item.properties) {
+                    obj.properties = {
+                        ...obj.properties,
+                        ...item.properties,
+                    };
+                }
+            }
+            return (0, exports.sampleFromSchema)(obj);
         }
-        else {
-            return;
+        if (!type) {
+            if (properties) {
+                type = "object";
+            }
+            else if (items) {
+                type = "array";
+            }
+            else {
+                return;
+            }
         }
-    }
-    if (type === "object") {
-        let obj = {};
-        for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
-            if (prop.deprecated) {
-                continue;
+        if (type === "object") {
+            let obj = {};
+            for (let [name, prop] of Object.entries(properties !== null && properties !== void 0 ? properties : {})) {
+                if (prop.deprecated) {
+                    continue;
+                }
+                obj[name] = (0, exports.sampleFromSchema)(prop);
             }
-            obj[name] = (0, exports.sampleFromSchema)(prop);
+            return obj;
         }
-        return obj;
-    }
-    if (type === "array") {
-        if (Array.isArray(items === null || items === void 0 ? void 0 : items.anyOf)) {
-            return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleFromSchema)(item));
+        if (type === "array") {
+            if (Array.isArray(items === null || items === void 0 ? void 0 : items.anyOf)) {
+                return items === null || items === void 0 ? void 0 : items.anyOf.map((item) => (0, exports.sampleFromSchema)(item));
+            }
+            if (Array.isArray(items === null || items === void 0 ? void 0 : items.oneOf)) {
+                return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleFromSchema)(item));
+            }
+            return [(0, exports.sampleFromSchema)(items)];
         }
-        if (Array.isArray(items === null || items === void 0 ? void 0 : items.oneOf)) {
-            return items === null || items === void 0 ? void 0 : items.oneOf.map((item) => (0, exports.sampleFromSchema)(item));
+        if (schema.enum) {
+            if (schema.default) {
+                return schema.default;
+            }
+            return normalizeArray(schema.enum)[0];
         }
-        return [(0, exports.sampleFromSchema)(items)];
+        return primitive(schema);
     }
-    if (schema.enum) {
-        if (schema.default) {
-            return schema.default;
-        }
-        return normalizeArray(schema.enum)[0];
+    catch (err) {
+        console.error(chalk_1.default.yellow("WARNING: failed to create example from schema object:", err));
+        return;
     }
-    return primitive(schema);
 };
 exports.sampleFromSchema = sampleFromSchema;
 function primitive(schema = {}) {

package/lib/openapi/openapi.d.ts

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

package/lib/openapi/openapi.js

@@ -9,18 +9,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.processOpenapiFile = exports.processOpenapiFiles = exports.readOpenapiFiles = void 0;
+exports.getTagDisplayName = exports.processOpenapiFile = exports.processOpenapiFiles = exports.readOpenapiFiles = void 0;
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
 const openapi_to_postmanv2_1 = __importDefault(require("@paloaltonetworks/openapi-to-postmanv2"));
-// @ts-ignore
 const postman_collection_1 = __importDefault(require("@paloaltonetworks/postman-collection"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-const js_yaml_1 = __importDefault(require("js-yaml"));
 const json_refs_1 = __importDefault(require("json-refs"));
 const lodash_1 = require("lodash");
+const index_1 = require("../index");
 const createExample_1 = require("./createExample");
+const loadAndBundleSpec_1 = require("./utils/loadAndBundleSpec");
 /**
  * Finds any reference objects in the OpenAPI definition and resolves them to a finalized value.
  */
@@ -64,23 +64,52 @@ async function createPostmanCollection(openapiData) {
     }
     return await jsonToCollection(data);
 }
-function createItems(openapiData) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
+function createItems(openapiData, sidebarOptions) {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
     // TODO: Find a better way to handle this
     let items = [];
-    // Only create an info page if we have a description.
+    const infoId = (0, lodash_1.kebabCase)(openapiData.info.title);
+    if ((sidebarOptions === null || sidebarOptions === void 0 ? void 0 : sidebarOptions.categoryLinkSource) === "tag") {
+        // Only create an tag pages if categoryLinkSource set to tag.
+        const tags = (_a = openapiData.tags) !== null && _a !== void 0 ? _a : [];
+        // eslint-disable-next-line array-callback-return
+        tags
+            .filter((tag) => { var _a; return !((_a = tag.description) === null || _a === void 0 ? void 0 : _a.includes("SchemaDefinition")); })
+            // eslint-disable-next-line array-callback-return
+            .map((tag) => {
+            var _a;
+            const description = getTagDisplayName(tag.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []);
+            const tagId = (0, lodash_1.kebabCase)(tag.name);
+            const tagPage = {
+                type: "tag",
+                id: tagId,
+                unversionedId: tagId,
+                title: description !== null && description !== void 0 ? description : "",
+                description: description !== null && description !== void 0 ? description : "",
+                slug: "/" + tagId,
+                frontMatter: {},
+                tag: {
+                    ...tag,
+                },
+            };
+            items.push(tagPage);
+        });
+    }
     if (openapiData.info.description) {
+        // Only create an info page if we have a description.
         const infoPage = {
             type: "info",
-            id: "introduction",
-            unversionedId: "introduction",
-            title: "Introduction",
+            id: infoId,
+            unversionedId: infoId,
+            title: openapiData.info.title,
             description: openapiData.info.description,
-            slug: "/introduction",
+            slug: "/" + infoId,
             frontMatter: {},
+            securitySchemes: (_b = openapiData.components) === null || _b === void 0 ? void 0 : _b.securitySchemes,
             info: {
                 ...openapiData.info,
-                title: (_a = openapiData.info.title) !== null && _a !== void 0 ? _a : "Introduction",
+                tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
             },
         };
         items.push(infoPage);
@@ -88,16 +117,16 @@ function createItems(openapiData) {
     for (let [path, pathObject] of Object.entries(openapiData.paths)) {
         const { $ref, description, parameters, servers, summary, ...rest } = pathObject;
         for (let [method, operationObject] of Object.entries({ ...rest })) {
-            const title = (_c = (_b = operationObject.summary) !== null && _b !== void 0 ? _b : operationObject.operationId) !== null && _c !== void 0 ? _c : "Missing summary";
+            const title = (_f = (_e = operationObject.summary) !== null && _e !== void 0 ? _e : operationObject.operationId) !== null && _f !== void 0 ? _f : "Missing summary";
             if (operationObject.description === undefined) {
                 operationObject.description =
-                    (_e = (_d = operationObject.summary) !== null && _d !== void 0 ? _d : operationObject.operationId) !== null && _e !== void 0 ? _e : "";
+                    (_h = (_g = operationObject.summary) !== null && _g !== void 0 ? _g : operationObject.operationId) !== null && _h !== void 0 ? _h : "";
             }
             const baseId = (0, lodash_1.kebabCase)(title);
-            const servers = (_g = (_f = operationObject.servers) !== null && _f !== void 0 ? _f : pathObject.servers) !== null && _g !== void 0 ? _g : openapiData.servers;
-            const security = (_h = operationObject.security) !== null && _h !== void 0 ? _h : openapiData.security;
+            const servers = (_k = (_j = operationObject.servers) !== null && _j !== void 0 ? _j : pathObject.servers) !== null && _k !== void 0 ? _k : openapiData.servers;
+            const security = (_l = operationObject.security) !== null && _l !== void 0 ? _l : openapiData.security;
             // Add security schemes so we know how to handle security.
-            const securitySchemes = (_j = openapiData.components) === null || _j === void 0 ? void 0 : _j.securitySchemes;
+            const securitySchemes = (_m = openapiData.components) === null || _m === void 0 ? void 0 : _m.securitySchemes;
             // Make sure schemes are lowercase. See: https://github.com/cloud-annotations/docusaurus-plugin-openapi/issues/79
             if (securitySchemes) {
                 for (let securityScheme of Object.values(securitySchemes)) {
@@ -107,7 +136,7 @@ function createItems(openapiData) {
                 }
             }
             let jsonRequestBodyExample;
-            const body = (_l = (_k = operationObject.requestBody) === null || _k === void 0 ? void 0 : _k.content) === null || _l === void 0 ? void 0 : _l["application/json"];
+            const body = (_p = (_o = operationObject.requestBody) === null || _o === void 0 ? void 0 : _o.content) === null || _p === void 0 ? void 0 : _p["application/json"];
             if (body === null || body === void 0 ? void 0 : body.schema) {
                 jsonRequestBodyExample = (0, createExample_1.sampleFromSchema)(body.schema);
             }
@@ -116,6 +145,7 @@ function createItems(openapiData) {
             const apiPage = {
                 type: "api",
                 id: baseId,
+                infoId: infoId !== null && infoId !== void 0 ? infoId : "",
                 unversionedId: baseId,
                 title: title,
                 description: description !== null && description !== void 0 ? description : "",
@@ -123,7 +153,7 @@ function createItems(openapiData) {
                 frontMatter: {},
                 api: {
                     ...defaults,
-                    tags: (_m = operationObject.tags) === null || _m === void 0 ? void 0 : _m.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
+                    tags: (_q = operationObject.tags) === null || _q === void 0 ? void 0 : _q.map((tagName) => { var _a; return getTagDisplayName(tagName, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
                     method,
                     path,
                     servers,
@@ -142,14 +172,13 @@ function createItems(openapiData) {
  * Attach Postman Request objects to the corresponding ApiItems.
  */
 function bindCollectionToApiItems(items, postmanCollection) {
-    // @ts-ignore
     postmanCollection.forEachItem((item) => {
         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}"
         const apiItem = items.find((item) => {
-            if (item.type === "info") {
+            if (item.type === "info" || item.type === "tag") {
                 return false;
             }
             return item.api.path === path && item.api.method === method;
@@ -160,29 +189,30 @@ function bindCollectionToApiItems(items, postmanCollection) {
     });
 }
 async function readOpenapiFiles(openapiPath, _options) {
-    const stat = await fs_extra_1.default.lstat(openapiPath);
-    if (stat.isDirectory()) {
-        console.warn(chalk_1.default.yellow("WARNING: Loading a directory of OpenAPI definitions is experimental and subject to unannounced breaking changes."));
-        // TODO: Add config for inlcude/ignore
-        const allFiles = await (0, utils_1.Globby)(["**/*.{json,yaml,yml}"], {
-            cwd: openapiPath,
-            ignore: utils_1.GlobExcludeDefault,
-        });
-        const sources = allFiles.filter((x) => !x.includes("_category_")); // todo: regex exclude?
-        return Promise.all(sources.map(async (source) => {
-            // TODO: make a function for this
-            const fullPath = path_1.default.join(openapiPath, source);
-            const openapiString = await fs_extra_1.default.readFile(fullPath, "utf-8");
-            const data = js_yaml_1.default.load(openapiString);
-            return {
-                source: fullPath,
-                sourceDirName: path_1.default.dirname(source),
-                data,
-            };
-        }));
+    if (!(0, index_1.isURL)(openapiPath)) {
+        const stat = await fs_extra_1.default.lstat(openapiPath);
+        if (stat.isDirectory()) {
+            console.warn(chalk_1.default.yellow("WARNING: Loading a directory of OpenAPI definitions is experimental and subject to unannounced breaking changes."));
+            // TODO: Add config for inlcude/ignore
+            const allFiles = await (0, utils_1.Globby)(["**/*.{json,yaml,yml}"], {
+                cwd: openapiPath,
+                ignore: utils_1.GlobExcludeDefault,
+                deep: 1,
+            });
+            const sources = allFiles.filter((x) => !x.includes("_category_")); // todo: regex exclude?
+            return Promise.all(sources.map(async (source) => {
+                // TODO: make a function for this
+                const fullPath = path_1.default.join(openapiPath, source);
+                const data = (await (0, loadAndBundleSpec_1.loadAndBundleSpec)(fullPath));
+                return {
+                    source: fullPath,
+                    sourceDirName: path_1.default.dirname(source),
+                    data,
+                };
+            }));
+        }
     }
-    const openapiString = await fs_extra_1.default.readFile(openapiPath, "utf-8");
-    const data = js_yaml_1.default.load(openapiString);
+    const data = (await (0, loadAndBundleSpec_1.loadAndBundleSpec)(openapiPath));
     return [
         {
             source: openapiPath,
@@ -192,24 +222,37 @@ async function readOpenapiFiles(openapiPath, _options) {
     ];
 }
 exports.readOpenapiFiles = readOpenapiFiles;
-async function processOpenapiFiles(files) {
+async function processOpenapiFiles(files, sidebarOptions) {
     const promises = files.map(async (file) => {
-        const items = await processOpenapiFile(file.data);
-        return items.map((item) => ({
+        const processedFile = await processOpenapiFile(file.data, sidebarOptions);
+        const itemsObjectsArray = processedFile[0].map((item) => ({
             ...item,
         }));
+        const tags = processedFile[1];
+        return [itemsObjectsArray, tags];
     });
     const metadata = await Promise.all(promises);
-    const items = metadata.flat();
-    return items;
+    const items = metadata
+        .map(function (x) {
+        return x[0];
+    })
+        .flat();
+    const tags = metadata.map(function (x) {
+        return x[1];
+    });
+    return [items, tags];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
-async function processOpenapiFile(openapiDataWithRefs) {
+async function processOpenapiFile(openapiDataWithRefs, sidebarOptions) {
     const openapiData = await resolveRefs(openapiDataWithRefs);
     const postmanCollection = await createPostmanCollection(openapiData);
-    const items = createItems(openapiData);
+    const items = createItems(openapiData, sidebarOptions);
     bindCollectionToApiItems(items, postmanCollection);
-    return items;
+    let tags = [];
+    if (openapiData.tags !== undefined) {
+        tags = openapiData.tags;
+    }
+    return [items, tags];
 }
 exports.processOpenapiFile = processOpenapiFile;
 // order for picking items as a display name of tags
@@ -231,3 +274,4 @@ function getTagDisplayName(tagName, tags) {
     // always default to the tagName
     return tagName;
 }
+exports.getTagDisplayName = getTagDisplayName;

package/lib/openapi/openapi.test.js

@@ -22,12 +22,6 @@ 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(".");
-            const froyo = results.find((x) => x.source.endsWith("froyo.yaml"));
-            expect(froyo).toBeTruthy();
-            expect(froyo === null || froyo === void 0 ? void 0 : froyo.sourceDirName).toBe("yogurtstore");
-            const nested = results.find((x) => x.source.endsWith("nested.yaml"));
-            expect(nested).toBeTruthy();
-            expect(nested === null || nested === void 0 ? void 0 : nested.sourceDirName).toBe("yogurtstore/nested");
         });
     });
 });

package/lib/openapi/types.d.ts

@@ -29,6 +29,7 @@ export interface InfoObject {
     contact?: ContactObject;
     license?: LicenseObject;
     version: string;
+    tags?: String[];
 }
 export interface ContactObject {
     name?: string;
@@ -151,6 +152,7 @@ export interface ParameterObject {
     example?: any;
     examples?: Map<ExampleObject>;
     content?: Map<MediaTypeObject>;
+    param?: Object;
 }
 export interface ParameterObjectWithRef {
     name: string;
@@ -236,7 +238,7 @@ export interface LinkObject {
 export declare type HeaderObject = Omit<ParameterObject, "name" | "in">;
 export declare type HeaderObjectWithRef = Omit<ParameterObjectWithRef, "name" | "in">;
 export interface TagObject {
-    name: string;
+    name?: string;
     description?: string;
     externalDocs?: ExternalDocumentationObject;
     "x-displayName"?: string;
@@ -304,6 +306,8 @@ export interface HttpSecuritySchemeObject {
     description?: string;
     scheme: string;
     bearerFormat?: string;
+    name?: string;
+    in?: string;
 }
 export interface Oauth2SecuritySchemeObject {
     type: "oauth2";

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

@@ -0,0 +1,3 @@
+import { OpenAPISpec } from "./types";
+export declare function loadAndBundleSpec(specUrlOrObject: object | string): Promise<OpenAPISpec>;
+export declare function convertSwagger2OpenAPI(spec: any): Promise<OpenAPISpec>;

package/lib/openapi/utils/loadAndBundleSpec.js

@@ -0,0 +1,44 @@
+"use strict";
+/* ============================================================================
+ * Copyright (c) Palo Alto Networks
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ * ========================================================================== */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertSwagger2OpenAPI = exports.loadAndBundleSpec = void 0;
+const bundle_1 = require("@redocly/openapi-core/lib/bundle");
+const config_1 = require("@redocly/openapi-core/lib/config/config");
+const swagger2openapi_1 = require("swagger2openapi");
+async function loadAndBundleSpec(specUrlOrObject) {
+    const config = new config_1.Config({});
+    const bundleOpts = {
+        config,
+        base: process.cwd(),
+    };
+    if (typeof specUrlOrObject === "object" && specUrlOrObject !== null) {
+        bundleOpts["doc"] = {
+            source: { absoluteRef: "" },
+            parsed: specUrlOrObject,
+        };
+    }
+    else {
+        bundleOpts["ref"] = specUrlOrObject;
+    }
+    // Force dereference ?
+    // bundleOpts["dereference"] = true;
+    const { bundle: { parsed }, } = await (0, bundle_1.bundle)(bundleOpts);
+    return parsed.swagger !== undefined ? convertSwagger2OpenAPI(parsed) : parsed;
+}
+exports.loadAndBundleSpec = loadAndBundleSpec;
+function convertSwagger2OpenAPI(spec) {
+    console.warn("[ReDoc Compatibility mode]: Converting OpenAPI 2.0 to OpenAPI 3.0");
+    return new Promise((resolve, reject) => (0, swagger2openapi_1.convertObj)(spec, { patch: true, warnOnly: true, text: "{}", anchors: true }, (err, res) => {
+        // TODO: log any warnings
+        if (err) {
+            return reject(err);
+        }
+        resolve(res && res.openapi);
+    }));
+}
+exports.convertSwagger2OpenAPI = convertSwagger2OpenAPI;