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

package/lib/sidebars/index.js

@@ -1,89 +0,0 @@
-"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

@@ -1,68 +0,0 @@
-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/lib/types.js

@@ -1,8 +0,0 @@
-"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 });