docusaurus-plugin-openapi-docs 0.0.0-615 → 0.0.0-617

package/README.md

@@ -22,7 +22,7 @@ The `docusaurus-plugin-openapi-docs` package extends the Docusaurus CLI with com
 
 Key Features:
 
-- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.x.
+- **Compatible:** Works with Swagger 2.0 and OpenAPI 3.0.
 - **Fast:** Convert large OpenAPI specs into MDX docs in seconds. 🔥
 - **Stylish:** Based on the same [Infima styling framework](https://infima.dev/) that powers the Docusaurus UI.
 - **Capable:** Supports single, multi and _even micro_ OpenAPI specs.
@@ -41,6 +41,13 @@ Theme:
 yarn add docusaurus-theme-openapi-docs
 ```
 
+## Compatibility Matrix
+
+| Docusaurus OpenAPI Docs | Docusaurus       |
+| ----------------------- | ---------------- |
+| 1.x.x                   | `>=2.0.1 <2.3.0` |
+| 2.x.x (beta)            | `>=2.3.0 <2.4.1` |
+
 ## Configuring `docusaurus.config.js` (Plugin and theme usage)
 
 Here is an example of properly configuring your `docusaurus.config.js` file for `docusaurus-plugin-openapi-docs` and `docusaurus-theme-openapi-docs` usage.

package/lib/index.js

@@ -12,6 +12,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDocsPluginConfig = exports.isURL = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const zlib_1 = __importDefault(require("zlib"));
 const utils_1 = require("@docusaurus/utils");
 const chalk_1 = __importDefault(require("chalk"));
 const mustache_1 = require("mustache");
@@ -210,7 +211,16 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
                         : tagPageGenerator(item);
                 item.markdown = markdown;
                 if (item.type === "api") {
-                    item.json = JSON.stringify(item.api);
+                    // opportunity to compress JSON
+                    // const serialize = (o: any) => {
+                    //   return zlib.deflateSync(JSON.stringify(o)).toString("base64");
+                    // };
+                    // const deserialize = (s: any) => {
+                    //   return zlib.inflateSync(Buffer.from(s, "base64")).toString();
+                    // };
+                    item.json = zlib_1.default
+                        .deflateSync(JSON.stringify(item.api))
+                        .toString("base64");
                     let infoBasePath = `${outputDir}/${item.infoId}`;
                     if (docRouteBasePath) {
                         infoBasePath = `${docRouteBasePath}/${outputDir

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-615",
+  "version": "0.0.0-617",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "30b72e4f8f86666ea78d6e298ef2b46eeed443d4"
+  "gitHead": "497549c580de64c1df8b91e6b7a7f283e8defb85"
 }

package/src/index.ts

@@ -7,6 +7,7 @@
 
 import fs from "fs";
 import path from "path";
+import zlib from "zlib";
 
 import type { LoadContext, Plugin } from "@docusaurus/types";
 import { Globby, posixPath } from "@docusaurus/utils";
@@ -264,7 +265,16 @@ import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
             : tagPageGenerator(item);
         item.markdown = markdown;
         if (item.type === "api") {
-          item.json = JSON.stringify(item.api);
+          // opportunity to compress JSON
+          // const serialize = (o: any) => {
+          //   return zlib.deflateSync(JSON.stringify(o)).toString("base64");
+          // };
+          // const deserialize = (s: any) => {
+          //   return zlib.inflateSync(Buffer.from(s, "base64")).toString();
+          // };
+          item.json = zlib
+            .deflateSync(JSON.stringify(item.api))
+            .toString("base64");
           let infoBasePath = `${outputDir}/${item.infoId}`;
           if (docRouteBasePath) {
             infoBasePath = `${docRouteBasePath}/${outputDir