@camunda8/docusaurus-theme-openapi-docs 4.5.1

package/src/theme/StatusCodes/index.tsx

@@ -0,0 +1,83 @@
+/* ============================================================================
+ * 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 React from "react";
+
+import { translate } from "@docusaurus/Translate";
+
+import ApiTabs from "@theme/ApiTabs";
+import Details from "@theme/Details";
+import Markdown from "@theme/Markdown";
+import ResponseHeaders from "@theme/ResponseHeaders";
+import ResponseSchema from "@theme/ResponseSchema";
+import TabItem from "@theme/TabItem";
+import { OPENAPI_STATUS_CODES } from "@theme/translationIds";
+import { ApiItem } from "@camunda8/docusaurus-plugin-openapi-docs/lib/types";
+
+interface Props {
+  id?: string;
+  label?: string;
+  responses: ApiItem["responses"];
+}
+
+const StatusCodes: React.FC<Props> = ({ label, id, responses }: any) => {
+  if (!responses) return null;
+
+  const codes = Object.keys(responses);
+  if (codes.length === 0) return null;
+
+  return (
+    <ApiTabs label={label} id={id}>
+      {codes.map((code) => {
+        const response = responses[code];
+        const responseHeaders = response.headers;
+
+        return (
+          // @ts-ignore
+          <TabItem key={code} label={code} value={code}>
+            <div>
+              {response.description && (
+                <div style={{ marginTop: ".5rem", marginBottom: ".5rem" }}>
+                  <Markdown>{response.description}</Markdown>
+                </div>
+              )}
+            </div>
+            {responseHeaders && (
+              <Details
+                className="openapi-markdown__details"
+                data-collapsed={true}
+                open={false}
+                style={{ textAlign: "left", marginBottom: "1rem" }}
+                summary={
+                  <summary>
+                    <strong>
+                      {translate({
+                        id: OPENAPI_STATUS_CODES.RESPONSE_HEADERS,
+                        message: "Response Headers",
+                      })}
+                    </strong>
+                  </summary>
+                }
+              >
+                <ResponseHeaders responseHeaders={responseHeaders} />
+              </Details>
+            )}
+            <ResponseSchema
+              title={translate({
+                id: OPENAPI_STATUS_CODES.SCHEMA_TITLE,
+                message: "Schema",
+              })}
+              body={{ content: response.content }}
+            />
+          </TabItem>
+        );
+      })}
+    </ApiTabs>
+  );
+};
+
+export default StatusCodes;

package/src/theme/styles.scss

@@ -0,0 +1,215 @@
+/* ============================================================================
+ * 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 "./CodeSamples/CodeSamples";
+/* 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-curl: var(
+    --openapi-code-tab-shadow-color-bash
+  );
+  --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/translationIds.ts

@@ -0,0 +1,103 @@
+/* ============================================================================
+ * 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.
+ * ========================================================================== */
+
+export const OPENAPI_RESPONSE = {
+  TITLE: "theme.openapi.response.title",
+  CLEAR: "theme.openapi.response.clear",
+  PLACEHOLDER: "theme.openapi.response.placeholder",
+  HEADERS_TAB: "theme.openapi.response.headersTab",
+};
+
+export const OPENAPI_TABS = {
+  RESPONSES_LABEL: "theme.openapi.tabs.responses.label",
+};
+
+export const OPENAPI_REQUEST = {
+  BODY_TITLE: "theme.openapi.request.body.title",
+  ACCEPT_TITLE: "theme.openapi.request.accept.title",
+  SEND_BUTTON: "theme.openapi.request.sendButton",
+  REQUIRED_LABEL: "theme.openapi.request.requiredLabel",
+  REQUEST_TITLE: "theme.openapi.request.title",
+  COLLAPSE_ALL: "theme.openapi.request.collapseAll",
+  EXPAND_ALL: "theme.openapi.request.expandAll",
+  BASE_URL_TITLE: "theme.openapi.request.baseUrl.title",
+  AUTH_TITLE: "theme.openapi.request.auth.title",
+  PARAMETERS_TITLE: "theme.openapi.request.parameters.title",
+  FETCHING_MESSAGE: "theme.openapi.request.fetchingMessage",
+  CONNECTION_FAILED: "theme.openapi.request.connectionFailed",
+};
+
+export const OPENAPI_SERVER = {
+  EDIT_BUTTON: "theme.openapi.server.editButton",
+  HIDE_BUTTON: "theme.openapi.server.hideButton",
+};
+
+export const OPENAPI_PARAM_OPTIONS = {
+  SHOW_OPTIONAL: "theme.openapi.paramOptions.showOptional",
+  HIDE_OPTIONAL: "theme.openapi.paramOptions.hideOptional",
+};
+
+export const OPENAPI_FORM_FILE_UPLOAD = {
+  CLEAR_BUTTON: "theme.openapi.formFileUpload.clearButton",
+};
+
+export const OPENAPI_FORM = {
+  FIELD_REQUIRED: "theme.openapi.form.fieldRequired",
+};
+
+export const OPENAPI_AUTH = {
+  BEARER_TOKEN: "theme.openapi.auth.bearerToken",
+  USERNAME: "theme.openapi.auth.username",
+  PASSWORD: "theme.openapi.auth.password",
+  SECURITY_SCHEME: "theme.openapi.auth.securityScheme",
+};
+
+export const OPENAPI_RESPONSE_EXAMPLES = {
+  EXAMPLE: "theme.openapi.responseExamples.example",
+  AUTO_EXAMPLE: "theme.openapi.responseExamples.autoExample",
+};
+
+export const OPENAPI_BODY = {
+  EXAMPLE_FROM_SCHEMA: "theme.openapi.body.exampleFromSchema",
+};
+
+export const OPENAPI_STATUS_CODES = {
+  RESPONSE_HEADERS: "theme.openapi.statusCodes.responseHeaders",
+  SCHEMA_TITLE: "theme.openapi.statusCodes.schemaTitle",
+};
+
+export const OPENAPI_SCHEMA_ITEM = {
+  REQUIRED: "theme.openapi.schemaItem.required",
+  DEPRECATED: "theme.openapi.schemaItem.deprecated",
+  NULLABLE: "theme.openapi.schemaItem.nullable",
+  DEFAULT_VALUE: "theme.openapi.schemaItem.defaultValue",
+  EXAMPLE: "theme.openapi.schemaItem.example",
+  EXAMPLES: "theme.openapi.schemaItem.examples",
+  DESCRIPTION: "theme.openapi.schemaItem.description",
+  CONSTANT_VALUE: "theme.openapi.schemaItem.constantValue",
+  ENUM_VALUE: "theme.openapi.schemaItem.enumValue",
+  ENUM_DESCRIPTION: "theme.openapi.schemaItem.enumDescription",
+  POSSIBLE_VALUES: "theme.openapi.schemaItem.possibleValues",
+  ONE_OF: "theme.openapi.schemaItem.oneOf",
+  ANY_OF: "theme.openapi.schemaItem.anyOf",
+};
+
+export const OPENAPI_PARAMS_DETAILS = {
+  PARAMETERS_TITLE: "theme.openapi.paramsDetails.parametersTitle",
+};
+
+export const OPENAPI_SECURITY_SCHEMES = {
+  NAME: "theme.openapi.securitySchemes.name",
+  TYPE: "theme.openapi.securitySchemes.type",
+  SCOPES: "theme.openapi.securitySchemes.scopes",
+  IN: "theme.openapi.securitySchemes.in",
+  FLOWS: "theme.openapi.securitySchemes.flows",
+  DESCRIPTION: "theme.openapi.securitySchemes.description",
+  SCHEME: "theme.openapi.securitySchemes.scheme",
+  BEARER_FORMAT: "theme.openapi.securitySchemes.bearerFormat",
+  OPEN_ID_CONNECT_URL: "theme.openapi.securitySchemes.openIdConnectUrl",
+};

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,20 @@
+/* ============================================================================
+ * 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="@camunda8/docusaurus-plugin-openapi-docs" />
+
+export type {
+  PropSidebarItemCategory,
+  SidebarItemLink,
+  PropSidebar,
+  PropSidebarItem,
+  PropSidebars,
+} from "@docusaurus/plugin-content-docs/lib/sidebars/types";
+
+declare module "docusaurus-theme-openapi-docs" {
+  export type ThemeConfig = Partial<import("./types").ThemeConfig>;
+}

package/src/types.ts

@@ -0,0 +1,72 @@
+/* ============================================================================
+ * 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 type { DocFrontMatter as DocusaurusDocFrontMatter } from "@docusaurus/plugin-content-docs";
+import type { JSONSchema4, JSONSchema6, JSONSchema7 } from "json-schema";
+
+export interface ThemeConfig {
+  api?: {
+    proxy?: string;
+    authPersistance?: false | "localStorage" | "sessionStorage";
+  };
+}
+
+export type JSONSchema = JSONSchema4 | JSONSchema6 | JSONSchema7;
+export type SchemaObject = Omit<
+  JSONSchema,
+  | "type"
+  | "allOf"
+  | "oneOf"
+  | "anyOf"
+  | "not"
+  | "items"
+  | "properties"
+  | "additionalProperties"
+> & {
+  // OpenAPI specific overrides
+  type?: "string" | "number" | "integer" | "boolean" | "object" | "array";
+  allOf?: SchemaObject[];
+  oneOf?: SchemaObject[];
+  anyOf?: SchemaObject[];
+  not?: SchemaObject;
+  items?: SchemaObject;
+  properties?: Record<string, SchemaObject>;
+  additionalProperties?: boolean | SchemaObject;
+
+  // OpenAPI additions
+  nullable?: boolean;
+  discriminator?: DiscriminatorObject;
+  readOnly?: boolean;
+  writeOnly?: boolean;
+  xml?: XMLObject;
+  externalDocs?: ExternalDocumentationObject;
+  example?: any;
+  deprecated?: boolean;
+};
+
+export interface DiscriminatorObject {
+  propertyName: string;
+  mapping?: Record<string, string>;
+}
+
+export interface XMLObject {
+  name?: string;
+  namespace?: string;
+  prefix?: string;
+  attribute?: boolean;
+  wrapped?: boolean;
+}
+
+export interface ExternalDocumentationObject {
+  description?: string;
+  url: string;
+}
+
+export interface DocFrontMatter extends DocusaurusDocFrontMatter {
+  /** Provides OpenAPI Docs with a reference path to their respective Info Doc */
+  info_path?: string;
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "lib": ["ESNext", "DOM"],
+    "rootDir": "src",
+    "module": "CommonJS",
+    "target": "ESNext",
+    "noEmit": false,
+    "outDir": "lib",
+    "jsx": "react",
+    "paths": {
+      "@theme/*": ["./src/theme/*"]
+    }
+  },
+  "include": ["src"]
+}