docusaurus-plugin-openapi-docs 0.0.0-348 → 0.0.0-351

package/lib/openapi/types.d.ts

@@ -0,0 +1,334 @@
+import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
+interface Map<T> {
+    [key: string]: T;
+}
+export interface OpenApiObject {
+    openapi: string;
+    info: InfoObject;
+    servers?: ServerObject[];
+    paths: PathsObject;
+    components?: ComponentsObject;
+    security?: SecurityRequirementObject[];
+    tags?: TagObject[];
+    externalDocs?: ExternalDocumentationObject;
+}
+export interface OpenApiObjectWithRef {
+    openapi: string;
+    info: InfoObject;
+    servers?: ServerObject[];
+    paths: PathsObjectWithRef;
+    components?: ComponentsObjectWithRef;
+    security?: SecurityRequirementObject[];
+    tags?: TagObject[];
+    externalDocs?: ExternalDocumentationObject;
+}
+export interface InfoObject {
+    title: string;
+    description?: string;
+    termsOfService?: string;
+    contact?: ContactObject;
+    license?: LicenseObject;
+    version: string;
+}
+export interface ContactObject {
+    name?: string;
+    url?: string;
+    email?: string;
+}
+export interface LicenseObject {
+    name: string;
+    url?: string;
+}
+export interface ServerObject {
+    url: string;
+    description?: string;
+    variables?: Map<ServerVariable>;
+}
+export interface ServerVariable {
+    enum?: string[];
+    default: string;
+    description?: string;
+}
+export interface ComponentsObject {
+    schemas?: Map<SchemaObject>;
+    responses?: Map<ResponseObject>;
+    parameters?: Map<ParameterObject>;
+    examples?: Map<ExampleObject>;
+    requestBodies?: Map<RequestBodyObject>;
+    headers?: Map<HeaderObject>;
+    securitySchemes?: Map<SecuritySchemeObject>;
+    links?: Map<LinkObject>;
+    callbacks?: Map<CallbackObject>;
+}
+export interface ComponentsObjectWithRef {
+    schemas?: Map<SchemaObjectWithRef | ReferenceObject>;
+    responses?: Map<ResponseObjectWithRef | ReferenceObject>;
+    parameters?: Map<ParameterObjectWithRef | ReferenceObject>;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    requestBodies?: Map<RequestBodyObjectWithRef | ReferenceObject>;
+    headers?: Map<HeaderObjectWithRef | ReferenceObject>;
+    securitySchemes?: Map<SecuritySchemeObject | ReferenceObject>;
+    links?: Map<LinkObject | ReferenceObject>;
+    callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
+}
+export declare type PathsObject = Map<PathItemObject>;
+export declare type PathsObjectWithRef = Map<PathItemObjectWithRef>;
+export interface PathItemObject {
+    $ref?: string;
+    summary?: string;
+    description?: string;
+    get?: OperationObject;
+    put?: OperationObject;
+    post?: OperationObject;
+    delete?: OperationObject;
+    options?: OperationObject;
+    head?: OperationObject;
+    patch?: OperationObject;
+    trace?: OperationObject;
+    servers?: ServerObject[];
+    parameters?: ParameterObject[];
+}
+export interface PathItemObjectWithRef {
+    $ref?: string;
+    summary?: string;
+    description?: string;
+    get?: OperationObjectWithRef;
+    put?: OperationObjectWithRef;
+    post?: OperationObjectWithRef;
+    delete?: OperationObjectWithRef;
+    options?: OperationObjectWithRef;
+    head?: OperationObjectWithRef;
+    patch?: OperationObjectWithRef;
+    trace?: OperationObjectWithRef;
+    servers?: ServerObject[];
+    parameters?: (ParameterObjectWithRef | ReferenceObject)[];
+}
+export interface OperationObject {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    operationId?: string;
+    parameters?: ParameterObject[];
+    requestBody?: RequestBodyObject;
+    responses: ResponsesObject;
+    callbacks?: Map<CallbackObject>;
+    deprecated?: boolean;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    "x-deprecated-description"?: string;
+}
+export interface OperationObjectWithRef {
+    tags?: string[];
+    summary?: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    operationId?: string;
+    parameters?: (ParameterObjectWithRef | ReferenceObject)[];
+    requestBody?: RequestBodyObjectWithRef | ReferenceObject;
+    responses: ResponsesObjectWithRef;
+    callbacks?: Map<CallbackObjectWithRef | ReferenceObject>;
+    deprecated?: boolean;
+    security?: SecurityRequirementObject[];
+    servers?: ServerObject[];
+    "x-deprecated-description"?: string;
+}
+export interface ExternalDocumentationObject {
+    description?: string;
+    url: string;
+}
+export interface ParameterObject {
+    name: string;
+    in: "query" | "header" | "path" | "cookie";
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: string;
+    allowReserved?: boolean;
+    schema?: SchemaObject;
+    example?: any;
+    examples?: Map<ExampleObject>;
+    content?: Map<MediaTypeObject>;
+    param?: Object;
+}
+export interface ParameterObjectWithRef {
+    name: string;
+    in: string;
+    description?: string;
+    required?: boolean;
+    deprecated?: boolean;
+    allowEmptyValue?: boolean;
+    style?: string;
+    explode?: string;
+    allowReserved?: boolean;
+    schema?: SchemaObjectWithRef | ReferenceObject;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    content?: Map<MediaTypeObjectWithRef>;
+}
+export interface RequestBodyObject {
+    description?: string;
+    content: Map<MediaTypeObject>;
+    required?: boolean;
+}
+export interface RequestBodyObjectWithRef {
+    description?: string;
+    content: Map<MediaTypeObjectWithRef>;
+    required?: boolean;
+}
+export interface MediaTypeObject {
+    schema?: SchemaObject;
+    example?: any;
+    examples?: Map<ExampleObject>;
+    encoding?: Map<EncodingObject>;
+}
+export interface MediaTypeObjectWithRef {
+    schema?: SchemaObjectWithRef | ReferenceObject;
+    example?: any;
+    examples?: Map<ExampleObject | ReferenceObject>;
+    encoding?: Map<EncodingObjectWithRef>;
+}
+export interface EncodingObject {
+    contentType?: string;
+    headers?: Map<HeaderObject>;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+}
+export interface EncodingObjectWithRef {
+    contentType?: string;
+    headers?: Map<HeaderObjectWithRef | ReferenceObject>;
+    style?: string;
+    explode?: boolean;
+    allowReserved?: boolean;
+}
+export declare type ResponsesObject = Map<ResponseObject>;
+export declare type ResponsesObjectWithRef = Map<ResponseObjectWithRef | ReferenceObject>;
+export interface ResponseObject {
+    description: string;
+    headers?: Map<HeaderObject>;
+    content?: Map<MediaTypeObject>;
+    links?: Map<LinkObject>;
+}
+export interface ResponseObjectWithRef {
+    description: string;
+    headers?: Map<HeaderObjectWithRef | ReferenceObject>;
+    content?: Map<MediaTypeObjectWithRef>;
+    links?: Map<LinkObject | ReferenceObject>;
+}
+export declare type CallbackObject = Map<PathItemObject>;
+export declare type CallbackObjectWithRef = Map<PathItemObjectWithRef>;
+export interface ExampleObject {
+    summary?: string;
+    description?: string;
+    value?: any;
+    externalValue?: string;
+}
+export interface LinkObject {
+    operationRef?: string;
+    operationId?: string;
+    parameters?: Map<any>;
+    requestBody?: any;
+    description?: string;
+    server?: ServerObject;
+}
+export declare type HeaderObject = Omit<ParameterObject, "name" | "in">;
+export declare type HeaderObjectWithRef = Omit<ParameterObjectWithRef, "name" | "in">;
+export interface TagObject {
+    name: string;
+    description?: string;
+    externalDocs?: ExternalDocumentationObject;
+    "x-displayName"?: string;
+}
+export interface ReferenceObject {
+    $ref: string;
+}
+export declare type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export declare type SchemaObject = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    allOf?: SchemaObject[];
+    oneOf?: SchemaObject[];
+    anyOf?: SchemaObject[];
+    not?: SchemaObject;
+    items?: SchemaObject;
+    properties?: Map<SchemaObject>;
+    additionalProperties?: boolean | SchemaObject;
+    nullable?: boolean;
+    discriminator?: DiscriminatorObject;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: XMLObject;
+    externalDocs?: ExternalDocumentationObject;
+    example?: any;
+    deprecated?: boolean;
+};
+export declare type SchemaObjectWithRef = Omit<JSONSchema, "type" | "allOf" | "oneOf" | "anyOf" | "not" | "items" | "properties" | "additionalProperties"> & {
+    type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+    allOf?: (SchemaObject | ReferenceObject)[];
+    oneOf?: (SchemaObject | ReferenceObject)[];
+    anyOf?: (SchemaObject | ReferenceObject)[];
+    not?: SchemaObject | ReferenceObject;
+    items?: SchemaObject | ReferenceObject;
+    properties?: Map<SchemaObject | ReferenceObject>;
+    additionalProperties?: boolean | SchemaObject | ReferenceObject;
+    nullable?: boolean;
+    discriminator?: DiscriminatorObject;
+    readOnly?: boolean;
+    writeOnly?: boolean;
+    xml?: XMLObject;
+    externalDocs?: ExternalDocumentationObject;
+    example?: any;
+    deprecated?: boolean;
+};
+export interface DiscriminatorObject {
+    propertyName: string;
+    mapping?: Map<string>;
+}
+export interface XMLObject {
+    name?: string;
+    namespace?: string;
+    prefix?: string;
+    attribute?: boolean;
+    wrapped?: boolean;
+}
+export declare type SecuritySchemeObject = ApiKeySecuritySchemeObject | HttpSecuritySchemeObject | Oauth2SecuritySchemeObject | OpenIdConnectSecuritySchemeObject;
+export interface ApiKeySecuritySchemeObject {
+    type: "apiKey";
+    description?: string;
+    name: string;
+    in: "query" | "header" | "cookie";
+}
+export interface HttpSecuritySchemeObject {
+    type: "http";
+    description?: string;
+    scheme: string;
+    bearerFormat?: string;
+    name?: string;
+    in?: string;
+}
+export interface Oauth2SecuritySchemeObject {
+    type: "oauth2";
+    description?: string;
+    flows: OAuthFlowsObject;
+}
+export interface OpenIdConnectSecuritySchemeObject {
+    type: "openIdConnect";
+    description?: string;
+    openIdConnectUrl: string;
+}
+export interface OAuthFlowsObject {
+    implicit?: OAuthFlowObject;
+    password?: OAuthFlowObject;
+    clientCredentials?: OAuthFlowObject;
+    authorizationCode?: OAuthFlowObject;
+}
+export interface OAuthFlowObject {
+    authorizationUrl?: string;
+    tokenUrl?: string;
+    refreshUrl?: string;
+    scopes: Map<string>;
+}
+export declare type SecurityRequirementObject = Map<string[]>;
+export {};

package/{src/markdown/createRequestBodyTable.ts → lib/openapi/types.js}

@@ -1,17 +1,8 @@
+"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.
  * ========================================================================== */
-
-import { createSchemaTable } from "./createSchemaTable";
-
-interface Props {
-  title: string;
-  body: any;
-}
-
-export function createRequestBodyTable({ title, body }: Props) {
-  return createSchemaTable({ title, body });
-}
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/options.d.ts

@@ -0,0 +1,4 @@
+import { Joi } from "@docusaurus/utils-validation";
+import type { PluginOptions } from "./types";
+export declare const DEFAULT_OPTIONS: PluginOptions;
+export declare const OptionsSchema: Joi.ObjectSchema<any>;

package/lib/options.js

@@ -0,0 +1,18 @@
+"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.OptionsSchema = exports.DEFAULT_OPTIONS = void 0;
+const utils_validation_1 = require("@docusaurus/utils-validation");
+exports.DEFAULT_OPTIONS = {
+    id: "default",
+    config: {},
+};
+exports.OptionsSchema = utils_validation_1.Joi.object({
+    id: utils_validation_1.Joi.string().default(exports.DEFAULT_OPTIONS.id),
+    config: utils_validation_1.Joi.object().default(exports.DEFAULT_OPTIONS.config),
+});

package/lib/sidebars/index.d.ts

@@ -0,0 +1,3 @@
+import { ProcessedSidebar } from "@docusaurus/plugin-content-docs/src/sidebars/types";
+import type { SidebarOptions, APIOptions, ApiMetadata } from "../types";
+export default function generateSidebarSlice(sidebarOptions: SidebarOptions, options: APIOptions, api: ApiMetadata[]): ProcessedSidebar;

package/lib/sidebars/index.js

@@ -0,0 +1,89 @@
+"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 });
+const clsx_1 = __importDefault(require("clsx"));
+const uniq_1 = __importDefault(require("lodash/uniq"));
+function isApiItem(item) {
+    return item.type === "api";
+}
+function groupByTags(items, sidebarOptions, options) {
+    // TODO: Figure out how to handle these
+    // const intros = items.filter(isInfoItem).map((item) => {
+    //   return {
+    //     type: "link" as const,
+    //     label: item.title,
+    //     href: item.permalink,
+    //     docId: item.id,
+    //   };
+    // });
+    const { outputDir } = options;
+    const { sidebarCollapsed, sidebarCollapsible, customProps } = sidebarOptions;
+    const apiItems = items.filter(isApiItem);
+    // TODO: make sure we only take the first tag
+    const tags = (0, uniq_1.default)(apiItems
+        .flatMap((item) => item.api.tags)
+        .filter((item) => !!item));
+    // TODO: optimize this or make it a function
+    const basePath = outputDir
+        .slice(outputDir.indexOf("/", 1))
+        .replace(/^\/+/g, "");
+    function createDocItem(item) {
+        var _a, _b;
+        const sidebar_label = item.frontMatter.sidebar_label;
+        const title = item.title;
+        const id = item.id;
+        return {
+            type: "doc",
+            id: `${basePath}/${item.id}`,
+            label: (_b = (_a = sidebar_label) !== null && _a !== void 0 ? _a : title) !== null && _b !== void 0 ? _b : id,
+            customProps: customProps,
+            className: (0, clsx_1.default)({
+                "menu__list-item--deprecated": item.api.deprecated,
+                "api-method": !!item.api.method,
+            }, item.api.method),
+        };
+    }
+    const tagged = tags
+        .map((tag) => {
+        return {
+            type: "category",
+            label: tag,
+            collapsible: sidebarCollapsible,
+            collapsed: sidebarCollapsed,
+            items: apiItems
+                .filter((item) => { var _a; return !!((_a = item.api.tags) === null || _a === void 0 ? void 0 : _a.includes(tag)); })
+                .map(createDocItem),
+        };
+    })
+        .filter((item) => item.items.length > 0); // Filter out any categories with no items.
+    // const untagged = [
+    //   // TODO: determine if needed and how
+    //   {
+    //     type: "category" as const,
+    //     label: "UNTAGGED",
+    //     // collapsible: options.sidebarCollapsible, TODO: add option
+    //     // collapsed: options.sidebarCollapsed, TODO: add option
+    //     items: apiItems
+    //       //@ts-ignore
+    //       .filter(({ api }) => api.tags === undefined || api.tags.length === 0)
+    //       .map(createDocItem),
+    //   },
+    // ];
+    return [...tagged];
+}
+function generateSidebarSlice(sidebarOptions, options, api) {
+    let sidebarSlice = [];
+    if (sidebarOptions.groupPathsBy === "tags") {
+        sidebarSlice = groupByTags(api, sidebarOptions, options);
+    }
+    return sidebarSlice;
+}
+exports.default = generateSidebarSlice;

package/lib/types.d.ts

@@ -0,0 +1,68 @@
+import type Request from "@paloaltonetworks/postman-collection";
+import { InfoObject, OperationObject, SecuritySchemeObject } from "./openapi/types";
+export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs-types";
+export interface PluginOptions {
+    id?: string;
+    config: {
+        [key: string]: APIOptions;
+    };
+}
+export interface APIOptions {
+    specPath: string;
+    outputDir: string;
+    template?: string;
+    sidebarOptions?: SidebarOptions;
+}
+export interface LoadedContent {
+    loadedApi: ApiMetadata[];
+}
+export declare type ApiMetadata = ApiPageMetadata | InfoPageMetadata;
+export interface ApiMetadataBase {
+    sidebar?: string;
+    previous?: ApiNavLink;
+    next?: ApiNavLink;
+    id: string;
+    unversionedId: string;
+    title: string;
+    description: string;
+    source: string;
+    sourceDirName: string;
+    slug: string;
+    permalink: string;
+    sidebarPosition?: number;
+    frontMatter: Record<string, unknown>;
+}
+export interface ApiPageMetadata extends ApiMetadataBase {
+    json?: string;
+    type: "api";
+    api: ApiItem;
+    markdown?: string;
+}
+export interface ApiItem extends OperationObject {
+    method: string;
+    path: string;
+    jsonRequestBodyExample: string;
+    securitySchemes?: {
+        [key: string]: SecuritySchemeObject;
+    };
+    postman?: Request;
+    info: InfoObject;
+}
+export interface InfoPageMetadata extends ApiMetadataBase {
+    type: "info";
+    info: ApiInfo;
+    markdown?: string;
+}
+export declare type ApiInfo = InfoObject;
+export interface ApiNavLink {
+    title: string;
+    permalink: string;
+}
+export interface SidebarOptions {
+    groupPathsBy?: string;
+    customProps?: {
+        [key: string]: unknown;
+    };
+    sidebarCollapsible?: boolean;
+    sidebarCollapsed?: boolean;
+}

package/{src/markdown/createFullWidthTable.ts → lib/types.js}

@@ -1,16 +1,8 @@
+"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.
  * ========================================================================== */
-
-import { create, Props } from "./utils";
-
-export function createFullWidthTable({ children, style, ...rest }: Props) {
-  return create("table", {
-    style: { display: "table", width: "100%", ...style },
-    ...rest,
-    children,
-  });
-}
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-openapi-docs",
   "description": "OpenAPI plugin for Docusaurus.",
-  "version": "0.0.0-348",
+  "version": "0.0.0-351",
   "license": "MIT",
   "keywords": [
     "openapi",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "0a63473c72f3c60567bae5730ad586f14b2c1080"
+  "gitHead": "475483bcb20b232da5c12ee23c48855dd32ba0d8"
 }

package/src/markdown/createContactInfo.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 { ContactObject } from "../openapi/types";
+import { create } from "./utils";
+
+export function createContactInfo(contact: ContactObject) {
+  if (!contact) return "";
+  const { name, url, email } = contact;
+
+  return create("div", {
+    style: {
+      display: "flex",
+      flexDirection: "column",
+      marginBottom: "var(--ifm-paragraph-margin-bottom)",
+    },
+    children: [
+      create("h3", {
+        style: {
+          marginBottom: "0.25rem",
+        },
+        children: "Contact",
+      }),
+      create("span", {
+        children: [
+          `${name}: `,
+          create("a", {
+            href: `mailto:${email}`,
+            children: `${email}`,
+          }),
+        ],
+      }),
+      create("span", {
+        children: [
+          "URL: ",
+          create("a", {
+            href: `${url}`,
+            children: `${url}`,
+          }),
+        ],
+      }),
+    ],
+  });
+}

package/src/markdown/createLicense.ts

@@ -0,0 +1,32 @@
+/* ============================================================================
+ * 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 { LicenseObject } from "../openapi/types";
+import { create } from "./utils";
+
+export function createLicense(license: LicenseObject) {
+  if (!license) return "";
+  const { name, url } = license;
+
+  return create("div", {
+    style: {
+      marginBottom: "var(--ifm-paragraph-margin-bottom)",
+    },
+    children: [
+      create("h3", {
+        style: {
+          marginBottom: "0.25rem",
+        },
+        children: "License",
+      }),
+      create("a", {
+        href: url,
+        children: name,
+      }),
+    ],
+  });
+}

package/src/markdown/createTermsOfService.ts

@@ -0,0 +1,30 @@
+/* ============================================================================
+ * 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 { create } from "./utils";
+
+export function createTermsOfService(termsOfService: string | undefined) {
+  if (!createTermsOfService) return "";
+
+  return create("div", {
+    style: {
+      marginBottom: "var(--ifm-paragraph-margin-bottom)",
+    },
+    children: [
+      create("h3", {
+        style: {
+          marginBottom: "0.25rem",
+        },
+        children: "Terms of Service",
+      }),
+      create("a", {
+        href: `${termsOfService}`,
+        children: termsOfService,
+      }),
+    ],
+  });
+}