docusaurus-theme-openapi-docs 0.0.0-1000

package/src/theme/styles.scss

@@ -0,0 +1,212 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+/* API Demo Panel */
+@use "./ApiExplorer/CodeTabs/CodeTabs";
+@use "./ApiExplorer/FloatingButton/FloatingButton";
+@use "./ApiExplorer/FormFileUpload/FormFileUpload";
+@use "./ApiExplorer/FormItem/FormItem";
+@use "./ApiExplorer/FormMultiSelect/FormMultiSelect";
+@use "./ApiExplorer/FormSelect/FormSelect";
+@use "./ApiExplorer/FormTextInput/FormTextInput";
+@use "./ApiExplorer/LiveEditor/LiveEditor";
+@use "./ApiExplorer/MethodEndpoint/MethodEndpoint";
+@use "./ApiExplorer/ParamOptions/ParamOptions";
+@use "./ApiExplorer/Request/Request";
+@use "./ApiExplorer/Response/Response";
+@use "./ApiExplorer/Server/Server";
+
+/* Api Demo Panel / ApiCodeBlock */
+@use "./ApiExplorer/ApiCodeBlock/Container/Container";
+@use "./ApiExplorer/ApiCodeBlock/Content/Content";
+@use "./ApiExplorer/ApiCodeBlock/CopyButton/CopyButton";
+@use "./ApiExplorer/ApiCodeBlock/ExitButton/ExitButton";
+@use "./ApiExplorer/ApiCodeBlock/ExpandButton/ExpandButton";
+@use "./ApiExplorer/ApiCodeBlock/Line/Line";
+@use "./ApiExplorer/ApiCodeBlock/WordWrapButton/WordWrapButton";
+
+/* Schema Styling */
+@use "./ParamsItem/ParamsItem";
+@use "./SchemaItem/SchemaItem";
+/* Tabs Styling */
+@use "./ApiTabs/ApiTabs";
+@use "./DiscriminatorTabs/DiscriminatorTabs";
+@use "./MimeTabs/MimeTabs";
+@use "./SchemaTabs/SchemaTabs";
+@use "./OperationTabs/OperationTabs";
+/* Code Samples */
+@use "./ResponseSamples/ResponseSamples";
+/* Markdown Styling */
+@use "./Markdown/Details/Details";
+
+:root {
+  --openapi-required: var(--ifm-color-danger);
+  --openapi-deprecated: var(--ifm-color-warning);
+  --openapi-nullable: var(--ifm-color-info);
+  --openapi-code-blue: var(--ifm-color-info);
+  --openapi-code-red: var(--ifm-color-danger);
+  --openapi-code-orange: var(--ifm-color-warning);
+  --openapi-code-green: var(--ifm-color-success);
+  --openapi-card-background-color: var(--ifm-color-gray-100);
+  --openapi-card-border-radius: var(--ifm-pre-border-radius);
+  --openapi-input-border: var(--ifm-color-primary);
+  --openapi-input-background: var(--openapi-card-background-color);
+  --openapi-tree-line-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color: var(--ifm-toc-border-color);
+  --openapi-code-tab-border-color-python: #ffdb50;
+  --openapi-code-tab-border-color-bash: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-go: var(--ifm-color-info);
+  --openapi-code-tab-border-color-js: var(--ifm-color-warning);
+  --openapi-code-tab-border-color-ruby: var(--ifm-color-danger);
+  --openapi-code-tab-border-color-csharp: #9b4f96;
+  --openapi-code-tab-border-color-nodejs: var(--ifm-color-success);
+  --openapi-code-tab-border-color-php: #6181b6;
+  --openapi-code-tab-border-color-java: #0374bd;
+  --openapi-code-tab-border-color-powershell: #00adef;
+  --openapi-code-tab-shadow-color-python: rgba(255, 219, 80, 0.25);
+  --openapi-code-tab-shadow-color-bash: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-go: rgba(84, 199, 236, 0.25);
+  --openapi-code-tab-shadow-color-js: rgba(255, 186, 0, 0.25);
+  --openapi-code-tab-shadow-color-ruby: rgba(250, 56, 62, 0.25);
+  --openapi-code-tab-shadow-color-csharp: rgba(155, 79, 150, 0.25);
+  --opeanpi-code-tab-shadow-color-nodejs: rgba(0, 164, 0, 0.25);
+  --openapi-code-tab-shadow-color-php: rgba(97, 129, 182, 0.25);
+  --openapi-code-tab-shadow-color-java: rgba(3, 116, 189, 0.25);
+  --opeanpi-code-tab-shadow-color-powershell: rgba(3, 116, 189, 0.25);
+  --openapi-explorer-font-size-input: 12px;
+  --openapi-explorer-font-size-code: 12px;
+  --openapi-explorer-padding-input: 0.5rem;
+  --openapi-explorer-border-color: var(--ifm-toc-border-color);
+  --openapi-explorer-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>');
+  --openapi-skeleton-background: var(--ifm-color-emphasis-100);
+}
+
+[data-theme="dark"] {
+  --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+  --openapi-explorer-caret-bg: url('data:image/svg+xml;utf8,<svg xmlns="http://www.w3.org/2000/svg" width="16px" height="16px" viewBox="0 0 24 24" fill="white"><path d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path></svg>') !important;
+}
+
+.docs-wrapper {
+  height: 100%;
+}
+
+// @media (min-width: 997px) {
+//   .docItemCol {
+//     max-width: 75% !important;
+//   }
+
+//   /* Prevent hydration FOUC, as the mobile TOC needs to be server-rendered */
+//   .tocMobile {
+//     display: none;
+//   }
+// }
+
+/* Begin OpenAPI theme styles */
+// [data-theme="dark"] {
+//   --openapi-card-background-color: var(--ifm-color-gray-900) !important;
+// }
+
+// .theme-api-markdown div[class^="collapsibleContent"] {
+//   margin-top: 0 !important;
+//   padding-left: 2px;
+// }
+
+/* Demo panel details */
+
+// .theme-api-markdown .openapi-explorer__details > div > div > pre {
+//   border-top-left-radius: 0;
+//   border-top-right-radius: 0;
+// }
+
+/* Code block */
+
+// .theme-api-markdown code {
+//   max-width: 600px;
+//   max-height: 500px;
+//   overflow: auto;
+// }
+
+/* Version button */
+
+.version-button div {
+  display: block;
+}
+
+.version-button div > button > span::after {
+  border-color: currentcolor transparent;
+  border-style: solid;
+  border-width: 0.4em 0.4em 0;
+  content: "";
+  margin-left: 0.3em;
+  position: relative;
+  transform: translateY(-50%);
+  display: inline-block;
+  font-size: 0.8rem;
+  top: 1px;
+}
+
+.openapi__logo {
+  width: 250px;
+}
+
+.openapi__heading {
+  font-size: 2rem;
+  margin-bottom: 0.5rem !important;
+}
+
+.openapi-left-panel__container {
+  border-right: thin solid var(--ifm-toc-border-color);
+}
+
+@media (max-width: 997px) {
+  .schema {
+    margin-bottom: 1rem;
+  }
+}
+
+.openapi-tabs__heading {
+  margin-bottom: 1rem;
+}
+
+/* Loading Skeleton */
+@keyframes pulsing {
+  0% {
+    opacity: 1;
+    background-color: var(--ifm-color-emphasis-100);
+  }
+  50% {
+    opacity: 0.6;
+    background-color: var(--ifm-toc-border-color);
+  }
+  100% {
+    opacity: 1;
+    background-color: var(--ifm-color-emphasis-100);
+  }
+}
+
+.openapi-skeleton {
+  animation: pulsing 2s infinite ease-in-out;
+}
+
+/* Loading Skeleton */
+.openapi-skeleton {
+  border-radius: var(--ifm-pre-border-radius);
+  background-color: var(--openapi-skeleton-background);
+  max-width: 100%;
+  margin: 1rem auto;
+}
+
+.openapi-skeleton.sm {
+  height: 100px;
+}
+
+.openapi-skeleton.md {
+  height: 350px;
+}
+
+.openapi-skeleton.lg {
+  height: 96.5%;
+}

package/src/theme-classic.d.ts

@@ -0,0 +1,80 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+/// <reference types="@docusaurus/theme-classic" />
+
+declare module "@docusaurus/theme-common/internal" {
+  import { CSSProperties, ReactNode, RefObject } from "react";
+
+  import type { PropDocContent } from "@docusaurus/plugin-content-docs";
+  import { MagicCommentConfig } from "@docusaurus/theme-common/lib/utils/codeBlockUtils";
+  import {
+    TabsProps as ITabsProps,
+    TabValue,
+  } from "@docusaurus/theme-common/lib/utils/tabsUtils";
+  import { Props as ICodeBlockProps } from "@theme/CodeBlock";
+  import { Props as ICopyButtonProps } from "@theme/CodeBlock/CopyButton";
+  import { Props as ILineProps } from "@theme/CodeBlock/Line";
+  import { PrismTheme } from "prism-react-renderer";
+
+  export interface TabProps extends ITabsProps {
+    length?: number;
+  }
+
+  export interface CopyButtonProps extends ICopyButtonProps {}
+  export interface LineProps extends ILineProps {}
+  export interface CodeBlockProps extends ICodeBlockProps {}
+
+  export function usePrismTheme(): PrismTheme;
+
+  export function sanitizeTabsChildren(children: TabProps["children"]);
+
+  export function getPrismCssVariables(prismTheme: PrismTheme): CSSProperties;
+
+  export function parseCodeBlockTitle(metastring?: string): string;
+
+  export function parseLanguage(className: string): string | undefined;
+
+  export function containsLineNumbers(metastring?: string): boolean;
+
+  export function useScrollPositionBlocker(): {
+    blockElementScrollPositionUntilNextRender: (el: HTMLElement) => void;
+  };
+
+  export function DocProvider({
+    children,
+    content,
+  }: {
+    children: ReactNode;
+    content: PropDocContent;
+  });
+
+  export function useTabs(props: TabProps): {
+    selectedValue: string;
+    selectValue: (value: string) => void;
+    tabValues: readonly TabValue[];
+  };
+
+  export function parseLines(
+    content: string,
+    options: {
+      metastring: string | undefined;
+      language: string | undefined;
+      magicComments: MagicCommentConfig[];
+    }
+  ): {
+    lineClassNames: { [lineIndex: number]: string[] };
+    code: string;
+  };
+
+  export function useCodeWordWrap(): {
+    readonly codeBlockRef: RefObject<HTMLPreElement>;
+    readonly isEnabled: boolean;
+    readonly isCodeScrollable: boolean;
+    readonly toggle: () => void;
+  };
+}

package/src/theme-openapi.d.ts

@@ -0,0 +1,288 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+/// <reference types="docusaurus-plugin-openapi-docs" />
+
+/* eslint-disable @typescript-eslint/no-use-before-define */
+
+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;
+  };
+}
+
+declare module "docusaurus-theme-openapi-docs" {
+  export type ThemeConfig = Partial<import("./types").ThemeConfig>;
+}
+
+declare module "@theme/ApiItem/hooks" {
+  export { useTypedDispatch, useTypedSelector };
+}
+
+declare module "@theme/ApiItem/Layout" {
+  export interface Props {
+    readonly children: JSX.Element;
+  }
+
+  export default function Layout(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiItem/store" {
+  export { AppDispatch, RootState };
+}
+
+declare module "@theme/SchemaTabs" {
+  export default function SchemaTabs(props: any): JSX.Element;
+}
+
+declare module "@theme/Markdown" {
+  export default function Markdown(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Accept" {
+  export default function Accept(): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Accept/slice" {
+  export { setAccept };
+  export default accept as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/Authorization" {
+  export default function Authorization(): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Authorization/slice" {
+  export { AuthState, Scheme, setAuthData, setSelectedAuth, createAuth };
+  export default auth as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/Body" {
+  import { Props as BodyProps } from "@theme/ApiExplorer/Body";
+
+  export default function Body(props: BodyProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Body/json2xml" {
+  export default function json2xml(any, any?): any;
+}
+
+declare module "@theme/ApiExplorer/Body/slice" {
+  import { Body, Content, State } from "@theme/ApiExplorer/Body/slice";
+
+  export { Body, Content, State };
+  export function setStringRawBody(any, any?): any;
+  export default body as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/buildPostmanRequest" {
+  export default function buildPostmanRequest(any, any?): any;
+}
+
+declare module "@theme/ApiExplorer/CodeTabs" {
+  import { Props as CodeTabsProps } from "@theme/ApiExplorer/CodeTabs";
+
+  export default function CodeTabs(props: CodeTabsProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ContentType" {
+  export default function ContentType(): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ContentType/slice" {
+  export { setContentType };
+  export default contentType as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/CodeSnippets" {
+  import { Props as CurlProps } from "@theme/ApiExplorer/CodeSnippets";
+
+  export { languageSet, Language } from "@theme/ApiExplorer/CodeSnippets";
+  export default function Curl(props: CurlProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/FloatingButton" {
+  import { Props as FloatingButtonProps } from "@theme/ApiExplorer/FloatingButton";
+
+  export default function FloatingButton(
+    props: FloatingButtonProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/FormItem" {
+  import { Props as FormItemProps } from "@theme/ApiExplorer/FormItem";
+
+  export default function FormItem(props: FormItemProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/FormSelect" {
+  import { Props as FormSelectProps } from "@theme/ApiExplorer/FormSelect";
+
+  export default function FormSelect(props: FormSelectProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/FormTextInput" {
+  import { Props as FormTextInputProps } from "@theme/ApiExplorer/FormTextInput";
+
+  export default function FormTextInput(props: FormTextInputProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/FormFileUpload" {
+  import { Props as FormFileUploadProps } from "@theme/ApiExplorer/FormFileUpload";
+
+  export default function FormFileUpload(
+    props: FormFileUploadProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/FormMultiSelect" {
+  import { Props as FormMultiSelectProps } from "@theme/ApiExplorer/FormMultiSelect";
+
+  export default function FormMultiSelect(
+    props: FormMultiSelectProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Execute" {
+  import { Props as ExecuteProps } from "@theme/ApiExplorer/Execute";
+
+  export default function Execute(props: ExecuteProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/LiveEditor" {
+  export default function LiveEditor(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/MethodEndpoint" {
+  import { Props as MethodEndpointProps } from "@theme/ApiExplorer/MethodEndpoint";
+
+  export default function MethodEndpoint(
+    props: MethodEndpointProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions" {
+  import { ParamProps } from "@theme/ApiExplorer/ParamOptions";
+
+  export default function ParamOptions(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamMultiSelectFormItem" {
+  import { ParamProps } from "@theme/ApiExplorer/ParamOptions";
+
+  export default function ParamMultiSelectFormItem(
+    props: ParamProps
+  ): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamArrayFormItem" {
+  import { ParamProps } from "@theme/ApiExplorer/ParamOptions";
+
+  export default function ParamArrayFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamSelectFormItem" {
+  import { ParamProps } from "@theme/ApiExplorer/ParamOptions";
+
+  export default function ParamSelectFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamBooleanFormItem" {
+  import { ParamProps } from "@theme/ApiExplorer/ParamOptions";
+
+  export default function ParamBooleanFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions/ParamFormItems/ParamTextFormItem" {
+  import { ParamProps } from "@theme/ApiExplorer/ParamOptions";
+
+  export default function ParamTextFormItem(props: ParamProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ParamOptions/slice" {
+  export type { Param };
+  export const setParam;
+  export default params as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/persistanceMiddleware" {
+  export { createPersistanceMiddleware };
+}
+
+declare module "@theme/ApiExplorer/Request" {
+  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
+
+  export interface RequestProps {
+    item: NonNullable<ApiItem>;
+  }
+  export default function Request(props: RequestProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Response" {
+  import { ApiItem } from "docusaurus-plugin-openapi-docs/src/types";
+
+  export interface ResponseProps {
+    item: NonNullable<ApiItem>;
+  }
+
+  export default function Response(props: ResponseProps): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Response/slice" {
+  export { setResponse, setCode, setHeaders, clearCode, clearHeaders };
+  export default response as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/SecuritySchemes" {
+  export default function SecuritySchemes(props: any): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Server" {
+  export default function Server(): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/ApiCodeBlock" {
+  export default function ApiCodeBlock(): JSX.Element;
+}
+
+declare module "@theme/ApiExplorer/Server/slice" {
+  export default server as Reducer<State, AnyAction>;
+}
+
+declare module "@theme/ApiExplorer/storage-utils" {
+  export { createStorage, hashArray };
+}

package/src/theme-translations.d.ts

@@ -0,0 +1,9 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+// TODO: Remove this when https://github.com/facebook/docusaurus/issues/6087 is resolved.
+declare module "@docusaurus/theme-translations";