docusaurus-plugin-openapi-docs 0.0.0-394 → 0.0.0-397

package/lib/openapi/openapi.js

@@ -16,18 +16,10 @@ const openapi_to_postmanv2_1 = __importDefault(require("@paloaltonetworks/openap
 const postman_collection_1 = __importDefault(require("@paloaltonetworks/postman-collection"));
 const chalk_1 = __importDefault(require("chalk"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
-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.
- */
-async function resolveRefs(openapiData) {
-    const { resolved } = await json_refs_1.default.resolveRefs(openapiData);
-    return resolved;
-}
+const loadAndResolveSpec_1 = require("./utils/loadAndResolveSpec");
 /**
  * Convenience function for converting raw JSON to a Postman Collection object.
  */
@@ -48,7 +40,7 @@ function jsonToCollection(data) {
  */
 async function createPostmanCollection(openapiData) {
     var _a, _b, _c, _d, _e, _f, _g, _h;
-    const data = JSON.parse(JSON.stringify(openapiData));
+    const data = openapiData;
     // Including `servers` breaks postman, so delete all of them.
     delete data.servers;
     for (let pathItemObject of Object.values(data.paths)) {
@@ -189,9 +181,6 @@ function bindCollectionToApiItems(items, postmanCollection) {
     });
 }
 async function readOpenapiFiles(openapiPath, options) {
-    // TODO: determine if this should be an API option
-    // Forces the json-schema-ref-parser
-    const parseJsonRefs = true;
     if (!(0, index_1.isURL)(openapiPath)) {
         const stat = await fs_extra_1.default.lstat(openapiPath);
         if (stat.isDirectory()) {
@@ -206,7 +195,7 @@ async function readOpenapiFiles(openapiPath, options) {
             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, parseJsonRefs));
+                const data = (await (0, loadAndResolveSpec_1.loadAndResolveSpec)(fullPath));
                 return {
                     source: fullPath,
                     sourceDirName: path_1.default.dirname(source),
@@ -215,7 +204,7 @@ async function readOpenapiFiles(openapiPath, options) {
             }));
         }
     }
-    const data = (await (0, loadAndBundleSpec_1.loadAndBundleSpec)(openapiPath, parseJsonRefs));
+    const data = (await (0, loadAndResolveSpec_1.loadAndResolveSpec)(openapiPath));
     return [
         {
             source: openapiPath,
@@ -227,27 +216,39 @@ async function readOpenapiFiles(openapiPath, options) {
 exports.readOpenapiFiles = readOpenapiFiles;
 async function processOpenapiFiles(files, sidebarOptions) {
     const promises = files.map(async (file) => {
-        const processedFile = await processOpenapiFile(file.data, sidebarOptions);
-        const itemsObjectsArray = processedFile[0].map((item) => ({
-            ...item,
-        }));
-        const tags = processedFile[1];
-        return [itemsObjectsArray, tags];
+        if (file.data !== undefined) {
+            const processedFile = await processOpenapiFile(file.data, sidebarOptions);
+            const itemsObjectsArray = processedFile[0].map((item) => ({
+                ...item,
+            }));
+            const tags = processedFile[1];
+            return [itemsObjectsArray, tags];
+        }
+        console.warn(chalk_1.default.yellow(`WARNING: the following OpenAPI spec returned undefined: ${file.source}`));
+        return [];
     });
     const metadata = await Promise.all(promises);
     const items = metadata
         .map(function (x) {
         return x[0];
     })
-        .flat();
-    const tags = metadata.map(function (x) {
+        .flat()
+        .filter(function (x) {
+        // Remove undefined items due to transient parsing errors
+        return x !== undefined;
+    });
+    const tags = metadata
+        .map(function (x) {
         return x[1];
+    })
+        .filter(function (x) {
+        // Remove undefined tags due to transient parsing errors
+        return x !== undefined;
     });
     return [items, tags];
 }
 exports.processOpenapiFiles = processOpenapiFiles;
-async function processOpenapiFile(openapiDataWithRefs, sidebarOptions) {
-    const openapiData = await resolveRefs(openapiDataWithRefs);
+async function processOpenapiFile(openapiData, sidebarOptions) {
     const postmanCollection = await createPostmanCollection(openapiData);
     const items = createItems(openapiData, sidebarOptions);
     bindCollectionToApiItems(items, postmanCollection);

package/lib/openapi/types.d.ts

@@ -11,6 +11,7 @@ export interface OpenApiObject {
     security?: SecurityRequirementObject[];
     tags?: TagObject[];
     externalDocs?: ExternalDocumentationObject;
+    swagger?: string;
 }
 export interface OpenApiObjectWithRef {
     openapi: string;
@@ -255,7 +256,7 @@ export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" |
     not?: SchemaObject;
     items?: SchemaObject;
     properties?: Map<SchemaObject>;
-    additionalProperties?: boolean | SchemaObject;
+    additionalProperties?: Map<SchemaObject>;
     nullable?: boolean;
     discriminator?: DiscriminatorObject;
     readOnly?: boolean;

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

@@ -0,0 +1,2 @@
+export declare function convertSwagger2OpenAPI(spec: object): Promise<unknown>;
+export declare function loadAndResolveSpec(specUrlOrObject: object | string): Promise<any>;

package/lib/openapi/utils/{loadAndBundleSpec.js → loadAndResolveSpec.js}

@@ -9,25 +9,62 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertSwagger2OpenAPI = exports.loadAndBundleSpec = void 0;
-// @ts-nocheck
+exports.loadAndResolveSpec = exports.convertSwagger2OpenAPI = void 0;
 const json_schema_ref_parser_1 = __importDefault(require("@apidevtools/json-schema-ref-parser"));
-const bundle_1 = require("@redocly/openapi-core/lib/bundle");
-const config_1 = require("@redocly/openapi-core/lib/config/config");
+const openapi_core_1 = require("@redocly/openapi-core");
 const chalk_1 = __importDefault(require("chalk"));
+// @ts-ignore
 const swagger2openapi_1 = require("swagger2openapi");
+function serializer(replacer, cycleReplacer) {
+    var stack = [], keys = [];
+    if (cycleReplacer === undefined)
+        cycleReplacer = function (key, value) {
+            if (stack[0] === value)
+                return "circular()";
+            return value.title ? `circular(${value.title})` : "circular()";
+        };
+    return function (key, value) {
+        if (stack.length > 0) {
+            // @ts-ignore
+            var thisPos = stack.indexOf(this);
+            // @ts-ignore
+            ~thisPos ? stack.splice(thisPos + 1) : stack.push(this);
+            ~thisPos ? keys.splice(thisPos, Infinity, key) : keys.push(key);
+            // @ts-ignore
+            if (~stack.indexOf(value))
+                value = cycleReplacer.call(this, key, value);
+        }
+        else
+            stack.push(value);
+        // @ts-ignore
+        return replacer === undefined ? value : replacer.call(this, key, value);
+    };
+}
+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;
 async function resolveJsonRefs(specUrlOrObject) {
     var _a, _b;
     try {
         let schema = await json_schema_ref_parser_1.default.dereference(specUrlOrObject, {
             continueOnError: true,
             resolve: {
+                file: true,
+                external: true,
                 http: {
                     timeout: 15000, // 15 sec timeout
                 },
             },
             dereference: {
-                circular: "ignore",
+                circular: true,
             },
         });
         return schema;
@@ -37,8 +74,8 @@ async function resolveJsonRefs(specUrlOrObject) {
         return;
     }
 }
-async function loadAndBundleSpec(specUrlOrObject, parseJsonRefs) {
-    const config = new config_1.Config({});
+async function loadAndResolveSpec(specUrlOrObject) {
+    const config = new openapi_core_1.Config({});
     const bundleOpts = {
         config,
         base: process.cwd(),
@@ -54,26 +91,22 @@ async function loadAndBundleSpec(specUrlOrObject, parseJsonRefs) {
     }
     // Force dereference ?
     // bundleOpts["dereference"] = true;
-    const { bundle: { parsed }, } = await (0, bundle_1.bundle)(bundleOpts);
-    if (parseJsonRefs) {
-        const resolved = await resolveJsonRefs(parsed);
-        return typeof resolved === Object
-            ? resolved.swagger !== undefined
-                ? convertSwagger2OpenAPI(resolved)
-                : resolved
-            : parsed;
+    const { bundle: { parsed }, } = await (0, openapi_core_1.bundle)(bundleOpts);
+    const resolved = await resolveJsonRefs(parsed);
+    // Force serialization and replace circular $ref pointers
+    // @ts-ignore
+    const serialized = JSON.stringify(resolved, serializer());
+    let decycled;
+    try {
+        decycled = JSON.parse(serialized);
     }
-    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);
-    }));
+    catch (err) {
+        console.error(chalk_1.default.yellow(err));
+    }
+    return decycled !== undefined && typeof decycled === "object"
+        ? decycled.swagger !== undefined
+            ? convertSwagger2OpenAPI(decycled)
+            : decycled
+        : resolved;
 }
-exports.convertSwagger2OpenAPI = convertSwagger2OpenAPI;
+exports.loadAndResolveSpec = loadAndResolveSpec;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-394",
+  "version": "0.0.0-397",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,8 +28,8 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.21",
-    "@docusaurus/types": "2.0.0-beta.21",
+    "@docusaurus/module-type-aliases": "2.0.0-beta.22",
+    "@docusaurus/types": "2.0.0-beta.22",
     "@types/fs-extra": "^9.0.13",
     "@types/js-yaml": "^4.0.5",
     "@types/json-pointer": "^1.0.31",
@@ -40,10 +40,10 @@
   },
   "dependencies": {
     "@apidevtools/json-schema-ref-parser": "^9.0.9",
-    "@docusaurus/mdx-loader": "2.0.0-beta.21",
-    "@docusaurus/plugin-content-docs": "2.0.0-beta.21",
-    "@docusaurus/utils": "2.0.0-beta.21",
-    "@docusaurus/utils-validation": "2.0.0-beta.21",
+    "@docusaurus/mdx-loader": "2.0.0-beta.22",
+    "@docusaurus/plugin-content-docs": "2.0.0-beta.22",
+    "@docusaurus/utils": "2.0.0-beta.22",
+    "@docusaurus/utils-validation": "2.0.0-beta.22",
     "@paloaltonetworks/openapi-to-postmanv2": "3.1.0-hotfix.1",
     "@paloaltonetworks/postman-collection": "^4.1.0",
     "@redocly/openapi-core": "^1.0.0-beta.103",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0644b9a5a16ee0066910a424a0ad293c070eeee0"
+  "gitHead": "a830bbb4f0c32d17aedebc9503750a6aae9957cd"
 }