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

package/README.md

@@ -121,7 +121,6 @@ The `docusaurus-plugin-openapi-docs` plugin can be configured with the following
 | ---------------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------- |
 | `specPath`       | `string` | `null`  | Designated URL or path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
 | `ouputDir`       | `string` | `null`  | Desired output path for generated MDX files.                                                                                |
-| `ouputDir`       | `string` | `null`  | Desired output path for generated MDX files.                                                                                |
 | `template`       | `string` | `null`  | _Optional:_ Customize MDX content with a desired template.                                                                  |
 | `sidebarOptions` | `object` | `null`  | _Optional:_ Set of options for sidebar configuration. See below for a list of supported options.                            |
 | `version`        | `string` | `null`  | _Optional:_ Version assigned to single or micro-spec API specified in `specPath`.                                           |

package/lib/markdown/createAnyOneOf.d.ts

@@ -0,0 +1 @@
+export declare function createAnyOneOf(anyOneOf: any[], type: string): string | undefined;

package/lib/markdown/createAnyOneOf.js

@@ -0,0 +1,57 @@
+"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.createAnyOneOf = void 0;
+const createSchemaDetails_1 = require("./createSchemaDetails");
+const utils_1 = require("./utils");
+function createAnyOneOf(anyOneOf, type) {
+    if (anyOneOf === undefined) {
+        return undefined;
+    }
+    if (anyOneOf.length === 0) {
+        return undefined;
+    }
+    return (0, utils_1.create)("div", {
+        children: [
+            (0, utils_1.create)("span", {
+                className: "badge badge--info",
+                children: type,
+            }),
+            (0, utils_1.create)("SchemaTabs", {
+                children: anyOneOf.map((schema, index) => {
+                    const label = schema.title ? schema.title : `MOD${index + 1}`;
+                    if (schema.properties !== undefined) {
+                        return (0, utils_1.create)("TabItem", {
+                            label: label,
+                            value: `${index}-properties`,
+                            children: [(0, createSchemaDetails_1.createNodes)(schema)],
+                        });
+                    }
+                    if (schema.allOf !== undefined) {
+                        return (0, utils_1.create)("TabItem", {
+                            label: label,
+                            value: `${index}-allOf`,
+                            children: [(0, createSchemaDetails_1.createNodes)(schema)],
+                        });
+                    }
+                    if (schema.items !== undefined) {
+                        if (schema.items.properties !== undefined) {
+                            return (0, utils_1.create)("TabItem", {
+                                label: label,
+                                value: `${index}-item-properties`,
+                                children: [(0, createSchemaDetails_1.createNodes)(schema.items)],
+                            });
+                        }
+                    }
+                    return undefined;
+                }),
+            }),
+        ],
+    });
+}
+exports.createAnyOneOf = createAnyOneOf;

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

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

package/lib/openapi/utils/loadAndBundleSpec.js

@@ -0,0 +1,79 @@
+"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.
+ * ========================================================================== */
+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
+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 chalk_1 = __importDefault(require("chalk"));
+const swagger2openapi_1 = require("swagger2openapi");
+async function resolveJsonRefs(specUrlOrObject) {
+    var _a, _b;
+    try {
+        let schema = await json_schema_ref_parser_1.default.dereference(specUrlOrObject, {
+            continueOnError: true,
+            resolve: {
+                http: {
+                    timeout: 15000, // 15 sec timeout
+                },
+            },
+            dereference: {
+                circular: "ignore",
+            },
+        });
+        return schema;
+    }
+    catch (err) {
+        console.error(chalk_1.default.yellow((_b = (_a = err.errors[0]) === null || _a === void 0 ? void 0 : _a.message) !== null && _b !== void 0 ? _b : err));
+        return;
+    }
+}
+async function loadAndBundleSpec(specUrlOrObject, parseJsonRefs) {
+    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);
+    if (parseJsonRefs) {
+        const resolved = await resolveJsonRefs(parsed);
+        return typeof resolved === Object
+            ? resolved.swagger !== undefined
+                ? convertSwagger2OpenAPI(resolved)
+                : resolved
+            : parsed;
+    }
+    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;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-397",
+  "version": "0.0.0-402",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -28,8 +28,8 @@
     "watch": "tsc --watch"
   },
   "devDependencies": {
-    "@docusaurus/module-type-aliases": "2.0.0-beta.22",
-    "@docusaurus/types": "2.0.0-beta.22",
+    "@docusaurus/module-type-aliases": "2.0.0-rc.1",
+    "@docusaurus/types": "2.0.0-rc.1",
     "@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.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",
+    "@docusaurus/mdx-loader": "2.0.0-rc.1",
+    "@docusaurus/plugin-content-docs": "2.0.0-rc.1",
+    "@docusaurus/utils": "2.0.0-rc.1",
+    "@docusaurus/utils-validation": "2.0.0-rc.1",
     "@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": "a830bbb4f0c32d17aedebc9503750a6aae9957cd"
+  "gitHead": "0ad47c91138db5b9d06e329fe459b3a04c51c54d"
 }