docusaurus-plugin-openapi-docs 0.0.0-366 → 0.0.0-370

package/README.md

@@ -103,7 +103,7 @@ Here is an example of properly configuring your `docusaurus.config.js` file for
 
 | Name             | Type     | Default | Description                                                                                                          |
 | ---------------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------- |
-| `specPath`       | `string` | `null`  | Designated path to the source of an OpenAPI specification file or directory of multiple OpenAPI specification files. |
+| `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.                                                                         |
 | `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.                     |

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 import type { LoadContext, Plugin } from "@docusaurus/types";
 import type { PluginOptions, LoadedContent } from "./types";
+export declare function isURL(str: string): boolean;
 export default function pluginOpenAPI(context: LoadContext, options: PluginOptions): Plugin<LoadedContent>;

package/lib/index.js

@@ -9,6 +9,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isURL = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const utils_1 = require("@docusaurus/utils");
@@ -17,12 +18,18 @@ const mustache_1 = require("mustache");
 const markdown_1 = require("./markdown");
 const openapi_1 = require("./openapi");
 const sidebars_1 = __importDefault(require("./sidebars"));
+function isURL(str) {
+    return /^(https?:)\/\//m.test(str);
+}
+exports.isURL = isURL;
 function pluginOpenAPI(context, options) {
     let { config } = options;
     let { siteDir } = context;
     async function generateApiDocs(options) {
         let { specPath, outputDir, template, sidebarOptions } = options;
-        const contentPath = path_1.default.resolve(siteDir, specPath);
+        const contentPath = isURL(specPath)
+            ? specPath
+            : path_1.default.resolve(siteDir, specPath);
         try {
             const openapiFiles = await (0, openapi_1.readOpenapiFiles)(contentPath, {});
             const [loadedApi, tags] = await (0, openapi_1.processOpenapiFiles)(openapiFiles, sidebarOptions);

package/lib/openapi/openapi.js

@@ -18,6 +18,7 @@ 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");
 /**
@@ -188,26 +189,28 @@ 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,
-            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,
-            };
-        }));
+    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 data = (await (0, loadAndBundleSpec_1.loadAndBundleSpec)(openapiPath));
     return [

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-366",
+  "version": "0.0.0-370",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -62,5 +62,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "b05ab424dc11297ef08a42bace80791998f70082"
+  "gitHead": "7e897ad05419c341a0b7fb42eb17d4c2e77b43e7"
 }

package/src/index.ts

@@ -18,6 +18,10 @@ import { readOpenapiFiles, processOpenapiFiles } from "./openapi";
 import generateSidebarSlice from "./sidebars";
 import type { PluginOptions, LoadedContent, APIOptions } from "./types";
 
+export function isURL(str: string): boolean {
+  return /^(https?:)\/\//m.test(str);
+}
+
 export default function pluginOpenAPI(
   context: LoadContext,
   options: PluginOptions
@@ -28,7 +32,9 @@ export default function pluginOpenAPI(
   async function generateApiDocs(options: APIOptions) {
     let { specPath, outputDir, template, sidebarOptions } = options;
 
-    const contentPath = path.resolve(siteDir, specPath);
+    const contentPath = isURL(specPath)
+      ? specPath
+      : path.resolve(siteDir, specPath);
 
     try {
       const openapiFiles = await readOpenapiFiles(contentPath, {});

package/src/openapi/openapi.ts

@@ -16,6 +16,7 @@ import fs from "fs-extra";
 import JsonRefs from "json-refs";
 import { kebabCase } from "lodash";
 
+import { isURL } from "../index";
 import {
   ApiMetadata,
   ApiPageMetadata,
@@ -248,35 +249,37 @@ export async function readOpenapiFiles(
   openapiPath: string,
   _options: {}
 ): Promise<OpenApiFiles[]> {
-  const stat = await fs.lstat(openapiPath);
-  if (stat.isDirectory()) {
-    console.warn(
-      chalk.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 Globby(["**/*.{json,yaml,yml}"], {
-      cwd: openapiPath,
-      ignore: 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.join(openapiPath, source);
-        const data = (await loadAndBundleSpec(
-          fullPath
-        )) as OpenApiObjectWithRef;
-        return {
-          source: fullPath, // This will be aliased in process.
-          sourceDirName: path.dirname(source),
-          data,
-        };
-      })
-    );
+  if (!isURL(openapiPath)) {
+    const stat = await fs.lstat(openapiPath);
+    if (stat.isDirectory()) {
+      console.warn(
+        chalk.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 Globby(["**/*.{json,yaml,yml}"], {
+        cwd: openapiPath,
+        ignore: 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.join(openapiPath, source);
+          const data = (await loadAndBundleSpec(
+            fullPath
+          )) as OpenApiObjectWithRef;
+          return {
+            source: fullPath, // This will be aliased in process.
+            sourceDirName: path.dirname(source),
+            data,
+          };
+        })
+      );
+    }
   }
   const data = (await loadAndBundleSpec(openapiPath)) as OpenApiObjectWithRef;
   return [