docusaurus-plugin-openapi-docs 4.5.1 → 4.7.0

package/lib/types.d.ts

@@ -1,135 +0,0 @@
-import { SidebarItemDoc } from "@docusaurus/plugin-content-docs/src/sidebars/types";
-import { InfoObject, OperationObject, SchemaObject, SecuritySchemeObject, TagObject } from "./openapi/types";
-export type { PropSidebarItemCategory, SidebarItemLink, PropSidebar, PropSidebarItem, } from "@docusaurus/plugin-content-docs-types";
-export interface PluginOptions {
-    id?: string;
-    docsPlugin?: string;
-    docsPluginId: string;
-    config: {
-        [key: string]: APIOptions;
-    };
-}
-export interface APIOptions {
-    specPath: string;
-    outputDir: string;
-    template?: string;
-    infoTemplate?: string;
-    tagTemplate?: string;
-    schemaTemplate?: string;
-    downloadUrl?: string;
-    hideSendButton?: boolean;
-    showExtensions?: boolean;
-    sidebarOptions?: SidebarOptions;
-    version?: string;
-    label?: string;
-    baseUrl?: string;
-    versions?: {
-        [key: string]: APIVersionOptions;
-    };
-    proxy?: string;
-    markdownGenerators?: MarkdownGenerator;
-    showSchemas?: boolean;
-    disableCompression?: boolean;
-}
-export interface MarkdownGenerator {
-    createApiPageMD?: (pageData: ApiPageMetadata) => string;
-    createInfoPageMD?: (pageData: InfoPageMetadata) => string;
-    createTagPageMD?: (pageData: TagPageMetadata) => string;
-    createSchemaPageMD?: (pageData: SchemaPageMetadata) => string;
-}
-export type ApiDocItemGenerator = (item: ApiPageMetadata | SchemaPageMetadata, context: {
-    sidebarOptions: SidebarOptions;
-    basePath: string;
-}) => SidebarItemDoc;
-export interface SidebarGenerators {
-    createDocItem?: ApiDocItemGenerator;
-}
-export interface SidebarOptions {
-    groupPathsBy?: string;
-    categoryLinkSource?: "info" | "tag" | "auto";
-    customProps?: {
-        [key: string]: unknown;
-    };
-    sidebarCollapsible?: boolean;
-    sidebarCollapsed?: boolean;
-    sidebarGenerators?: SidebarGenerators;
-}
-export interface APIVersionOptions {
-    specPath: string;
-    outputDir: string;
-    label: string;
-    baseUrl: string;
-    downloadUrl?: string;
-}
-export interface LoadedContent {
-    loadedApi: ApiMetadata[];
-}
-export type ApiMetadata = ApiPageMetadata | InfoPageMetadata | TagPageMetadata | SchemaPageMetadata;
-export interface ApiMetadataBase {
-    sidebar?: string;
-    previous?: ApiNavLink;
-    next?: ApiNavLink;
-    id: string;
-    unversionedId: string;
-    infoId?: string;
-    infoPath?: string;
-    downloadUrl?: string;
-    title: string;
-    description: string;
-    source: string;
-    sourceDirName: string;
-    slug?: string;
-    permalink: string;
-    sidebarPosition?: number;
-    frontMatter: Record<string, unknown>;
-    method?: string;
-    path?: string;
-    position?: number;
-}
-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;
-    proxy?: string;
-    info: InfoObject;
-    extensions?: object;
-}
-export interface InfoPageMetadata extends ApiMetadataBase {
-    type: "info";
-    info: ApiInfo;
-    markdown?: string;
-    securitySchemes?: {
-        [key: string]: SecuritySchemeObject;
-    };
-}
-export interface TagPageMetadata extends ApiMetadataBase {
-    type: "tag";
-    tag: TagObject;
-    markdown?: string;
-}
-export interface SchemaPageMetadata extends ApiMetadataBase {
-    type: "schema";
-    schema: SchemaObject;
-    markdown?: string;
-}
-export interface TagGroupPageMetadata extends ApiMetadataBase {
-    type: "tagGroup";
-    name: string;
-    tags: TagObject[];
-    markdown?: string;
-}
-export type ApiInfo = InfoObject;
-export interface ApiNavLink {
-    title: string;
-    permalink: string;
-}

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 });

package/src/plugin-content-docs-types.d.ts

@@ -1,42 +0,0 @@
-/* ============================================================================
- * 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.
- * ========================================================================== */
-
-declare module "@docusaurus/plugin-content-docs-types" {
-  // Makes all properties visible when hovering over the type
-  type Expand<T extends Record<string, unknown>> = { [P in keyof T]: T[P] };
-
-  export type SidebarItemBase = {
-    className?: string;
-    customProps?: Record<string, unknown>;
-  };
-
-  export type SidebarItemLink = SidebarItemBase & {
-    type: "link";
-    href: string;
-    label: string;
-    docId: string;
-  };
-
-  type SidebarItemCategoryBase = SidebarItemBase & {
-    type: "category";
-    label: string;
-    collapsed: boolean;
-    collapsible: boolean;
-  };
-
-  export type PropSidebarItemCategory = Expand<
-    SidebarItemCategoryBase & {
-      items: PropSidebarItem[];
-    }
-  >;
-
-  export type PropSidebarItem = SidebarItemLink | PropSidebarItemCategory;
-  export type PropSidebar = PropSidebarItem[];
-  export type PropSidebars = {
-    [sidebarId: string]: PropSidebar;
-  };
-}