docusaurus-plugin-openapi-docs 0.0.0-410 → 0.0.0-411

package/lib/markdown/createLogo.d.ts

@@ -0,0 +1,2 @@
+import { LogoObject } from "../openapi/types";
+export declare function createLogo(logo: LogoObject | undefined, darkLogo: LogoObject | undefined): string;

package/lib/markdown/createLogo.js

@@ -0,0 +1,19 @@
+"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.createLogo = void 0;
+const utils_1 = require("./utils");
+function createLogo(logo, darkLogo) {
+    return (0, utils_1.guard)(logo || darkLogo, () => [
+        (0, utils_1.create)("ApiLogo", {
+            logo: logo,
+            darkLogo: darkLogo,
+        }),
+    ]);
+}
+exports.createLogo = createLogo;

package/lib/markdown/index.d.ts

@@ -1,4 +1,4 @@
 import { ApiPageMetadata, InfoPageMetadata, TagPageMetadata } from "../types";
 export declare function createApiPageMD({ title, api: { deprecated, "x-deprecated-description": deprecatedDescription, description, parameters, requestBody, responses, }, }: ApiPageMetadata): string;
-export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, securitySchemes, }: InfoPageMetadata): string;
+export declare function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, }: InfoPageMetadata): string;
 export declare function createTagPageMD({ tag: { description } }: TagPageMetadata): string;

package/lib/markdown/index.js

@@ -13,6 +13,7 @@ const createContactInfo_1 = require("./createContactInfo");
 const createDeprecationNotice_1 = require("./createDeprecationNotice");
 const createDescription_1 = require("./createDescription");
 const createLicense_1 = require("./createLicense");
+const createLogo_1 = require("./createLogo");
 const createParamsDetails_1 = require("./createParamsDetails");
 const createRequestBodyDetails_1 = require("./createRequestBodyDetails");
 const createStatusCodes_1 = require("./createStatusCodes");
@@ -39,12 +40,14 @@ function createApiPageMD({ title, api: { deprecated, "x-deprecated-description":
     ]);
 }
 exports.createApiPageMD = createApiPageMD;
-function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService }, securitySchemes, }) {
+function createInfoPageMD({ info: { title, version, description, contact, license, termsOfService, logo, darkLogo, }, securitySchemes, }) {
     return (0, utils_1.render)([
+        `import ApiLogo from "@theme/ApiLogo";\n`,
         `import Tabs from "@theme/Tabs";\n`,
         `import TabItem from "@theme/TabItem";\n\n`,
         (0, createVersionBadge_1.createVersionBadge)(version),
         `# ${(0, lodash_1.escape)(title)}\n\n`,
+        (0, createLogo_1.createLogo)(logo, darkLogo),
         (0, createDescription_1.createDescription)(description),
         (0, createAuthentication_1.createAuthentication)(securitySchemes),
         (0, createContactInfo_1.createContactInfo)(contact),

package/lib/openapi/openapi.js

@@ -102,6 +102,8 @@ function createItems(openapiData, sidebarOptions) {
                 ...openapiData.info,
                 tags: (_c = openapiData.tags) === null || _c === void 0 ? void 0 : _c.map((tagName) => { var _a; return getTagDisplayName(tagName.name, (_a = openapiData.tags) !== null && _a !== void 0 ? _a : []); }),
                 title: (_d = openapiData.info.title) !== null && _d !== void 0 ? _d : "Introduction",
+                logo: openapiData.info["x-logo"],
+                darkLogo: openapiData.info["x-dark-logo"],
             },
         };
         items.push(infoPage);

package/lib/openapi/types.d.ts

@@ -31,6 +31,13 @@ export interface InfoObject {
     license?: LicenseObject;
     version: string;
     tags?: String[];
+    "x-logo"?: LogoObject;
+    "x-dark-logo"?: LogoObject;
+    logo?: LogoObject;
+    darkLogo?: LogoObject;
+}
+export interface LogoObject {
+    url?: string;
 }
 export interface ContactObject {
     name?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-410",
+  "version": "0.0.0-411",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -67,5 +67,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "a988ec527e7daefea40dfafa5b7bed404b7d2e0c"
+  "gitHead": "f3967eda19d631760dc9e7f9e5a358897964f0a7"
 }

package/src/markdown/createLogo.ts

@@ -0,0 +1,21 @@
+/* ============================================================================
+ * 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 { LogoObject } from "../openapi/types";
+import { create, guard } from "./utils";
+
+export function createLogo(
+  logo: LogoObject | undefined,
+  darkLogo: LogoObject | undefined
+) {
+  return guard(logo || darkLogo, () => [
+    create("ApiLogo", {
+      logo: logo,
+      darkLogo: darkLogo,
+    }),
+  ]);
+}

package/src/markdown/index.ts

@@ -18,6 +18,7 @@ import { createContactInfo } from "./createContactInfo";
 import { createDeprecationNotice } from "./createDeprecationNotice";
 import { createDescription } from "./createDescription";
 import { createLicense } from "./createLicense";
+import { createLogo } from "./createLogo";
 import { createParamsDetails } from "./createParamsDetails";
 import { createRequestBodyDetails } from "./createRequestBodyDetails";
 import { createStatusCodes } from "./createStatusCodes";
@@ -56,14 +57,26 @@ export function createApiPageMD({
 }
 
 export function createInfoPageMD({
-  info: { title, version, description, contact, license, termsOfService },
+  info: {
+    title,
+    version,
+    description,
+    contact,
+    license,
+    termsOfService,
+    logo,
+    darkLogo,
+  },
   securitySchemes,
 }: InfoPageMetadata) {
   return render([
+    `import ApiLogo from "@theme/ApiLogo";\n`,
     `import Tabs from "@theme/Tabs";\n`,
     `import TabItem from "@theme/TabItem";\n\n`,
+
     createVersionBadge(version),
     `# ${escape(title)}\n\n`,
+    createLogo(logo, darkLogo),
     createDescription(description),
     createAuthentication(securitySchemes as unknown as SecuritySchemeObject),
     createContactInfo(contact as ContactObject),

package/src/openapi/openapi.ts

@@ -128,6 +128,8 @@ function createItems(
           getTagDisplayName(tagName.name!, openapiData.tags ?? [])
         ),
         title: openapiData.info.title ?? "Introduction",
+        logo: openapiData.info["x-logo"]! as any,
+        darkLogo: openapiData.info["x-dark-logo"]! as any,
       },
     };
     items.push(infoPage);

package/src/openapi/types.ts

@@ -42,6 +42,14 @@ export interface InfoObject {
   license?: LicenseObject;
   version: string;
   tags?: String[];
+  "x-logo"?: LogoObject;
+  "x-dark-logo"?: LogoObject;
+  logo?: LogoObject;
+  darkLogo?: LogoObject;
+}
+
+export interface LogoObject {
+  url?: string;
 }
 
 export interface ContactObject {