docusaurus-theme-openapi-docs 0.0.0-697 → 0.0.0-699

package/lib/markdown/utils.js

@@ -17,11 +17,11 @@ function create(tag, props) {
 }
 exports.create = create;
 function guard(value, cb) {
-    if (!!value) {
-        const children = cb(value);
-        return render(children);
+    if (value === undefined || value === "") {
+        return "";
     }
-    return "";
+    const children = cb(value);
+    return render(children);
 }
 exports.guard = guard;
 function render(children) {

package/lib/markdown/utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/markdown/utils.test.js

@@ -0,0 +1,43 @@
+"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 });
+const utils_1 = require("./utils");
+describe("guard", () => {
+    it("should guard empty strings", () => {
+        const actual = (0, utils_1.guard)("", (_) => {
+            throw new Error("Should not be called");
+        });
+        expect(actual).toBe("");
+    });
+    it("should guard undefined", () => {
+        const actual = (0, utils_1.guard)(undefined, (value) => {
+            throw new Error("Should not be called");
+        });
+        expect(actual).toBe("");
+    });
+    it("should not guard strings", () => {
+        const actual = (0, utils_1.guard)("hello", (value) => value);
+        expect(actual).toBe("hello");
+    });
+    it("should not guard numbers", () => {
+        const actual = (0, utils_1.guard)(1, (value) => `${value}`);
+        expect(actual).toBe("1");
+    });
+    it("should not guard numbers equals to 0", () => {
+        const actual = (0, utils_1.guard)(0, (value) => `${value}`);
+        expect(actual).toBe("0");
+    });
+    it("should not guard false booleans", () => {
+        const actual = (0, utils_1.guard)(false, (value) => `${value}`);
+        expect(actual).toBe("false");
+    });
+    it("should not guard true booleans", () => {
+        const actual = (0, utils_1.guard)(true, (value) => `${value}`);
+        expect(actual).toBe("true");
+    });
+});

package/lib/theme/ApiItem/index.js

@@ -40,6 +40,7 @@ function ApiItem(props) {
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter;
   let { api } = frontMatter;
+  const { schema } = frontMatter;
   // decompress and parse
   if (api) {
     api = JSON.parse(
@@ -163,6 +164,29 @@ function ApiItem(props) {
         )
       )
     );
+  } else if (schema) {
+    return react_1.default.createElement(
+      DocProvider,
+      { content: props.content },
+      react_1.default.createElement(
+        theme_common_1.HtmlClassNameProvider,
+        { className: docHtmlClassName },
+        react_1.default.createElement(Metadata_1.default, null),
+        react_1.default.createElement(
+          Layout_1.default,
+          null,
+          react_1.default.createElement(
+            "div",
+            { className: (0, clsx_1.default)("row", "theme-api-markdown") },
+            react_1.default.createElement(
+              "div",
+              { className: "col col--12" },
+              react_1.default.createElement(MDXComponent, null)
+            )
+          )
+        )
+      )
+    );
   }
   // Non-API docs
   return react_1.default.createElement(

package/lib/theme/SchemaItem/index.js

@@ -79,14 +79,11 @@ function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(
-    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
-    (value) => (
-      <div className="">
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
-  );
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className="">
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
 
   const schemaContent = (
     <div>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-theme-openapi-docs",
   "description": "OpenAPI theme for Docusaurus.",
-  "version": "0.0.0-697",
+  "version": "0.0.0-699",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -43,7 +43,7 @@
     "clsx": "^1.1.1",
     "copy-text-to-clipboard": "^3.1.0",
     "crypto-js": "^4.1.1",
-    "docusaurus-plugin-openapi-docs": "0.0.0-697",
+    "docusaurus-plugin-openapi-docs": "0.0.0-699",
     "docusaurus-plugin-sass": "^0.2.3",
     "file-saver": "^2.0.5",
     "lodash": "^4.17.20",
@@ -68,5 +68,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "a6bbe786231f3938c6333379a036c614afb27029"
+  "gitHead": "ef318267f54c34bedf50f0b309c9bb30fd665b53"
 }

package/src/markdown/utils.test.ts

@@ -0,0 +1,48 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+import { guard } from "./utils";
+
+describe("guard", () => {
+  it("should guard empty strings", () => {
+    const actual = guard("", (_) => {
+      throw new Error("Should not be called");
+    });
+    expect(actual).toBe("");
+  });
+
+  it("should guard undefined", () => {
+    const actual = guard(undefined, (value) => {
+      throw new Error("Should not be called");
+    });
+    expect(actual).toBe("");
+  });
+
+  it("should not guard strings", () => {
+    const actual = guard("hello", (value) => value);
+    expect(actual).toBe("hello");
+  });
+
+  it("should not guard numbers", () => {
+    const actual = guard(1, (value) => `${value}`);
+    expect(actual).toBe("1");
+  });
+
+  it("should not guard numbers equals to 0", () => {
+    const actual = guard(0, (value) => `${value}`);
+    expect(actual).toBe("0");
+  });
+
+  it("should not guard false booleans", () => {
+    const actual = guard(false, (value) => `${value}`);
+    expect(actual).toBe("false");
+  });
+  it("should not guard true booleans", () => {
+    const actual = guard(true, (value) => `${value}`);
+    expect(actual).toBe("true");
+  });
+});

package/src/markdown/utils.ts

@@ -24,11 +24,11 @@ export function guard<T>(
   value: T | undefined | string,
   cb: (value: T) => Children
 ): string {
-  if (!!value) {
-    const children = cb(value as T);
-    return render(children);
+  if (value === undefined || value === "") {
+    return "";
   }
-  return "";
+  const children = cb(value as T);
+  return render(children);
 }
 
 export function render(children: Children): string {

package/src/theme/ApiItem/index.tsx

@@ -44,12 +44,17 @@ interface ApiFrontMatter extends DocFrontMatter {
   readonly api?: ApiItemType;
 }
 
+interface SchemaFrontMatter extends DocFrontMatter {
+  readonly schema?: boolean;
+}
+
 export default function ApiItem(props: Props): JSX.Element {
   const docHtmlClassName = `docs-doc-id-${props.content.metadata.unversionedId}`;
   const MDXComponent = props.content;
   const { frontMatter } = MDXComponent;
   const { info_path: infoPath } = frontMatter as DocFrontMatter;
   let { api } = frontMatter as ApiFrontMatter;
+  const { schema } = frontMatter as SchemaFrontMatter;
   // decompress and parse
   if (api) {
     api = JSON.parse(
@@ -159,6 +164,21 @@ export default function ApiItem(props: Props): JSX.Element {
         </HtmlClassNameProvider>
       </DocProvider>
     );
+  } else if (schema) {
+    return (
+      <DocProvider content={props.content}>
+        <HtmlClassNameProvider className={docHtmlClassName}>
+          <DocItemMetadata />
+          <DocItemLayout>
+            <div className={clsx("row", "theme-api-markdown")}>
+              <div className="col col--12">
+                <MDXComponent />
+              </div>
+            </div>
+          </DocItemLayout>
+        </HtmlClassNameProvider>
+      </DocProvider>
+    );
   }
 
   // Non-API docs

package/src/theme/SchemaItem/index.js

@@ -79,14 +79,11 @@ function SchemaItem({
     </div>
   ));
 
-  const renderDefaultValue = guard(
-    typeof defaultValue === "boolean" ? defaultValue.toString() : defaultValue,
-    (value) => (
-      <div className="">
-        <ReactMarkdown children={`**Default value:** \`${value}\``} />
-      </div>
-    )
-  );
+  const renderDefaultValue = guard(defaultValue, (value) => (
+    <div className="">
+      <ReactMarkdown children={`**Default value:** \`${value}\``} />
+    </div>
+  ));
 
   const schemaContent = (
     <div>